Public Member Functions | List of all members
Celartem::Region Class Referenceabstract

This class stores information about matching region. More...

#include <cel_string.h>

Inheritance diagram for Celartem::Region:
Inheritance graph
[legend]

Public Member Functions

virtual size_t getCount () const =0
 
virtual size_t getPos (size_t n=0) const =0
 
virtual size_t getEndPos (size_t n=0) const =0
 
virtual size_t getLength (size_t n=0) const =0
 
virtual const UChar1getPtr (size_t n=0) const =0
 
virtual const UChar1getEndPtr (size_t n=0) const =0
 
virtual const UChar1getBufferPtr () const =0
 
virtual const UChar1getBufferEndPtr () const =0
 
virtual const UChar1getRangePtr () const =0
 
virtual const UChar1getRangeEndPtr () const =0
 
virtual void lockString (const String &inString)=0
 
- Public Member Functions inherited from Celartem::Referable
 Referable ()
 
void addRef () const
 
void releaseRef () const
 
size_t getReferenceCount () const
 

Additional Inherited Members

- Static Public Member Functions inherited from Celartem::Referable
static void dumpDbgAllRefCount ()
 

Detailed Description

This class stores information about matching region.

Usually, 0th elements are the target range and the other elements are the parts that matches to the sets in the regular expression pattern. This class is used by RegEx class.

Member Function Documentation

virtual const UChar1* Celartem::Region::getBufferEndPtr ( ) const
pure virtual

This method returns the pointer to the end of the input string.

Returns
Pointer to the end of the input string.
virtual const UChar1* Celartem::Region::getBufferPtr ( ) const
pure virtual

This method returns the pointer to the input string.

Returns
Pointer to the input string.
virtual size_t Celartem::Region::getCount ( ) const
pure virtual

This method obtains the number of elements.

Returns
The number of elements.
virtual size_t Celartem::Region::getEndPos ( size_t  n = 0) const
pure virtual

This method returns the end position of the matching string as string index. If the element is "cde" in the "abcdefg", this method returns 5.

Parameters
nAn element index.
Returns
The end position of the element.
virtual const UChar1* Celartem::Region::getEndPtr ( size_t  n = 0) const
pure virtual

This method returns the pointer to the end of matching portion. If the element is "cde" in the "abcdefg", this method returns the pointer to "fg".

Parameters
nAn element index.
Returns
Pointer to the end of the string.
virtual size_t Celartem::Region::getLength ( size_t  n = 0) const
pure virtual

This method returns the length of the matching string. If the element is "cde" in the "abcdefg", this method returns 3.

Parameters
nAn element index.
Returns
The length of the element.
virtual size_t Celartem::Region::getPos ( size_t  n = 0) const
pure virtual

This method returns the beginning position of the matching string as string index. If the element is "cde" in the "abcdefg", this method returns 2.

Parameters
nAn element index.
Returns
The beginning position of the element.
virtual const UChar1* Celartem::Region::getPtr ( size_t  n = 0) const
pure virtual

This method returns the pointer to the matching portion. If the element is "cde" in the "abcdefg", this method returns the pointer to "cdefg".

Parameters
nAn element index.
Returns
Pointer to the string.
virtual const UChar1* Celartem::Region::getRangeEndPtr ( ) const
pure virtual

This method return the pointer to the end of the search range in the input string.

Returns
Pointer to the end of the search range.
virtual const UChar1* Celartem::Region::getRangePtr ( ) const
pure virtual

This method return the pointer to the beginning of the search range in the input string.

Returns
Pointer to the beginning of the search range.
virtual void Celartem::Region::lockString ( const String inString)
pure virtual

NOTE: This function is for internal use only.
This function is used to lock the referred string and ensure that the pointers used in this instance is valid for the lifetime of the instance.

Parameters
inStringA String instance to be locked.

The documentation for this class was generated from the following file:

Cuminas DjVu SDK 3.0.33103
This document is made with doxygen 1.8.5 at Sun Dec 15 2013 19:38:06.
Cuminas Logo