Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   

VCF::Regex::Match Class Reference

Contains details of matches found during regex searches, namely the regex object that performed the search, the position in which the match was made and the exact text that triggered the match. More...

#include <RegExKit.h>

List of all members.

Public Member Functions

 Match (const unsigned char *pos=NULL, const String &text="", const Host *const env=NULL)
 Match (const Match &rhs)
Matchoperator= (const Match &rhs)
bool operator== (const Match &rhs) const
bool operator< (const Match &rhs) const
const unsigned char * getPos () const
 Gets a pointer to the beginning of the match.
ptrdiff_t getPosAsOffset () const
 Returns the offset position of the first character of the match.
String::size_type getPosAsCount () const
 Counts the number of characters between the start reference and the match position.
const StringgetText () const
 Returns the text that matched the search expression.

Friends

class Host
class Iterator


Detailed Description

Contains details of matches found during regex searches, namely the regex object that performed the search, the position in which the match was made and the exact text that triggered the match.

This class is for reporting purposes only and as such it is not intended that objects of this type are created by the user.


Constructor & Destructor Documentation

VCF::Regex::Match::Match const unsigned char *  pos = NULL,
const String text = "",
const Host *const   env = NULL
[inline]
 

VCF::Regex::Match::Match const Match rhs  )  [inline]
 


Member Function Documentation

const unsigned char* VCF::Regex::Match::getPos  )  const [inline]
 

Gets a pointer to the beginning of the match.

Returns:
unsigned char* First character of the match.

String::size_type VCF::Regex::Match::getPosAsCount  )  const
 

Counts the number of characters between the start reference and the match position.

Returns:
String::size_type Result of count

ptrdiff_t VCF::Regex::Match::getPosAsOffset  )  const
 

Returns the offset position of the first character of the match.

Returns:
ptrdiff_t Offset position relative to the beginning of the search range.

const String& VCF::Regex::Match::getText  )  const [inline]
 

Returns the text that matched the search expression.

Returns:
String Matching text.

bool VCF::Regex::Match::operator< const Match rhs  )  const [inline]
 

Match& VCF::Regex::Match::operator= const Match rhs  )  [inline]
 

bool VCF::Regex::Match::operator== const Match rhs  )  const [inline]
 


Friends And Related Function Documentation

friend class Host [friend]
 

friend class Iterator [friend]
 


The documentation for this class was generated from the following file:
   Comments or Suggestions?    License Information