Source-highlight Library
srchilite::HighlightToken Struct Reference

Token containing information for performing the highlight. More...

#include <highlighttoken.h>

Collaboration diagram for srchilite::HighlightToken:

Public Member Functions

 HighlightToken (const HighlightRule *_rule=0)
 
 HighlightToken (const std::string &elem, const std::string &matched, const std::string &_prefix, const HighlightRule *_rule=0)
 
void copyFrom (const HighlightToken &token)
 Copy from the passed toke. More...
 
void clearMatched ()
 Resets the matched related fields (i.e., matched, matchedSize)
 
void addMatched (const std::string &elem, const std::string &s)
 Adds information about a matched element. More...
 

Public Attributes

std::string prefix
 the possible prefix (part before the matched string)
 
bool prefixOnlySpaces
 true if the prefix is empty or contains only spaces
 
std::string suffix
 the possible suffix (part after the matched string)
 
MatchedElements matched
 the matched elements information
 
unsigned int matchedSize
 the size of the whole matched sequence (this is computed automatically when matched elements are set or added)
 
MatchedSubExps matchedSubExps
 The matched subexpressions (in case the rule had subexpressions)
 
const HighlightRulerule
 the matching rule
 

Detailed Description

Token containing information for performing the highlight.

Member Function Documentation

void srchilite::HighlightToken::addMatched ( const std::string &  elem,
const std::string &  s 
)

Adds information about a matched element.

Parameters
elemthe element name
sthe matched string
void srchilite::HighlightToken::copyFrom ( const HighlightToken token)
inline

Copy from the passed toke.

Parameters
token

The documentation for this struct was generated from the following files: