reflex::BoostMatcher Class Reference

updated Mon Apr 10 2017 by Robert van Engelen
 
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
reflex::BoostMatcher Class Reference

Boost matcher engine class implements reflex::PatternMatcher pattern matching interface with scan, find, split functors and iterators, using the Boost::regex library. More...

#include <boostmatcher.h>

Inheritance diagram for reflex::BoostMatcher:
Inheritance graph
[legend]
Collaboration diagram for reflex::BoostMatcher:
Collaboration graph
[legend]

Public Member Functions

 BoostMatcher ()
 Default constructor. More...
 
template<typename P >
 BoostMatcher (const P *pattern, const Input &input=Input(), const char *opt=NULL)
 Construct matcher engine from a boost::regex object or string regex, and an input character sequence. More...
 
template<typename P >
 BoostMatcher (const P &pattern, const Input &input=Input(), const char *opt=NULL)
 Construct matcher engine from a boost::regex object or string regex, and an input character sequence. More...
 
virtual void reset (const char *opt=NULL)
 Reset this matcher's state to the initial state and when assigned new input. More...
 
virtual PatternMatcherpattern (const BoostMatcher &matcher)
 Set the pattern to use with this matcher as a shared pointer to another matcher pattern. More...
 
virtual PatternMatcherpattern (const Pattern &pattern)
 Set the pattern to use with this matcher (the given pattern is shared and must be persistent). More...
 
virtual PatternMatcherpattern (const Pattern *pattern)
 Set the pattern to use with this matcher (the given pattern is shared and must be persistent). More...
 
virtual PatternMatcherpattern (const char *pattern)
 Set the pattern from a regex string to use with this matcher. More...
 
virtual PatternMatcherpattern (const std::string &pattern)
 Set the pattern from a regex string to use with this matcher. More...
 
virtual std::pair< const char *, size_t > operator[] (size_t n) const
 Returns captured text as a std::pair<const char*,size_t> with string pointer (not NUL-terminated) and length. More...
 
- Public Member Functions inherited from reflex::PatternMatcher< boost::regex >
 PatternMatcher (const PatternMatcher &matcher)
 Copy constructor, the underlying pattern object is shared (not deep copied). More...
 
virtual ~PatternMatcher ()
 Delete matcher, deletes pattern when owned, deletes this matcher's internal buffer. More...
 
virtual PatternMatcherpattern (const PatternMatcher &matcher)
 Set the pattern to use with this matcher as a shared pointer to another matcher pattern. More...
 
const Patternpattern () const
 Returns the pattern object associated with this matcher. More...
 
bool has_pattern () const
 Returns true if this matcher has a pattern. More...
 
bool own_pattern () const
 Returns true if this matcher has its own pattern not received from another matcher (responsible to delete). More...
 
- Public Member Functions inherited from reflex::AbstractMatcher
bool buffer (size_t blk=0)
 Set buffer block size for reading: use 1 for interactive input, 0 (or omit argument) to buffer all input in which case returns true if all the data could be read and false if a read error occurred. More...
 
void interactive ()
 Set buffer to 1 for interactive input. More...
 
void flush ()
 Flush the buffer's remaining content. More...
 
virtual AbstractMatcherinput (const Input &input)
 Set the input character sequence for this matcher and reset/restart the matcher. More...
 
size_t matches ()
 Returns nonzero capture index (i.e. true) if the entire input matches this matcher's pattern (and internally caches the true/false result for repeat invocations). More...
 
size_t accept () const
 Returns a positive integer (true) indicating the capture index of the matched text in the pattern or zero (false) for a mismatch. More...
 
const char * begin () const
 Returns pointer to the begin of the matched text (not NUL-terminated), a fast constant-time operation, use with end() or use size() for text end/length. More...
 
const char * end () const
 Returns pointer to the end of the matched text, a fast constant-time operation. More...
 
const char * text ()
 Returns NUL-terminated string of the text matched, a constant-time operation. More...
 
std::string str () const
 Returns the text matched as a string, a copy of text(). More...
 
std::wstring wstr () const
 Returns the match as a wide string, converted from UTF-8 text(). More...
 
size_t size () const
 Returns the length of the matched text in number of bytes, a constant-time operation. More...
 
size_t wsize () const
 Returns the length of the matched text in number of wide characters. More...
 
size_t lineno () const
 Returns the line number of the match in the input character sequence. More...
 
size_t columno () const
 Returns the column number of matched text, counting wide characters (unless compiled with WITH_BYTE_COLUMNO). More...
 
std::pair< size_t, std::string > pair () const
 Returns std::pair<size_t,std::string>(accept(), str()), useful for tokenizing input into containers of pairs. More...
 
std::pair< size_t, std::wstring > wpair () const
 Returns std::pair<size_t,std::wstring>(accept(), wstr()), useful for tokenizing input into containers of pairs. More...
 
size_t first () const
 Returns the position of the first character of the match in the input character sequence, a constant-time operation. More...
 
size_t last () const
 Returns the position of the last character + 1 of the match in the input character sequence, a constant-time operation. More...
 
bool at_bob () const
 Returns true if this matcher is at the start of an input character sequence. Use reset() to restart input. More...
 
bool at_end ()
 Returns true if this matcher has no more input to read from the input character sequence. More...
 
bool hit_end () const
 Returns true if this matcher hit the end of the input character sequence. More...
 
void set_end (bool eof)
 Set and force the end of input state. More...
 
bool at_bol () const
 Returns true if this matcher reached the begin of a new line. More...
 
void set_bol (bool bol)
 Set the begin of a new line state. More...
 
int input ()
 Returns the next 8-bit character from the input character sequence, while preserving the current text match. More...
 
int winput ()
 Returns the next wide character from the input character sequence, while preserving the current text match. More...
 
void unput (char c)
 Put back one character (8-bit) on the input character sequence for matching, invalidating the current match info and text. More...
 
const char * rest ()
 Fetch the rest of the input as text, useful for searching/splitting up to n times after which the rest is needed. More...
 
void more ()
 Append the next match to the currently matched text returned by AbstractMatcher::text, when the next match found is adjacent to the current match. More...
 
void less (size_t n)
 Truncate the AbstractMatcher::text length of the match to n characters in length and reposition for next match. More...
 
 operator size_t () const
 Cast this matcher to positive integer indicating the nonzero capture index of the matched text in the pattern, same as AbstractMatcher::accept. More...
 
 operator std::string () const
 Cast this matcher to a std::string of the text matched by this matcher. More...
 
 operator std::wstring () const
 Cast this matcher to a std::wstring of the text matched by this matcher. More...
 
 operator std::pair< size_t, std::string > () const
 Cast the match to std::pair<size_t,std::wstring>(accept(), wstr()), useful for tokenization into containers. More...
 
bool operator== (const char *rhs) const
 Returns true if matched text is equal to a string, useful for std::algorithm. More...
 
bool operator== (const std::string &rhs) const
 Returns true if matched text is equalt to a string, useful for std::algorithm. More...
 
bool operator== (size_t rhs) const
 Returns true if capture index is equal to a given size_t value, useful for std::algorithm. More...
 
bool operator== (int rhs) const
 Returns true if capture index is equal to a given int value, useful for std::algorithm. More...
 
bool operator!= (const char *rhs) const
 Returns true if matched text is not equal to a string, useful for std::algorithm. More...
 
bool operator!= (const std::string &rhs) const
 Returns true if matched text is not equal to a string, useful for std::algorithm. More...
 
bool operator!= (size_t rhs) const
 Returns true if capture index is not equal to a given size_t value, useful for std::algorithm. More...
 
bool operator!= (int rhs) const
 Returns true if capture index is not equal to a given int value, useful for std::algorithm. More...
 

Static Public Member Functions

template<typename T >
static std::string convert (T regex, convert_flag_type flags=convert_flag::none)
 Convert a regex to an acceptable form, given the specified regex library signature "[decls:]escapes[?+]", see reflex::convert. More...
 

Protected Member Functions

virtual size_t match (Method method)
 The match method Const::SCAN, Const::FIND, Const::SPLIT, or Const::MATCH, implemented with boost::regex. More...
 
void new_itr (Method method, bool bob)
 Create a new boost::regex iterator to (continue to) advance over input. More...
 
- Protected Member Functions inherited from reflex::PatternMatcher< boost::regex >
 PatternMatcher (const Pattern *pattern=NULL, const Input &input=Input(), const char *opt=NULL)
 Construct a base abstract matcher from a pointer to a persistent pattern object (that is shared with this class) and an input character sequence. More...
 
 PatternMatcher (const Pattern &pattern, const Input &input=Input(), const char *opt=NULL)
 
 PatternMatcher (const char *pattern, const Input &input=Input(), const char *opt=NULL)
 Construct a base abstract matcher from a regex pattern string and an input character sequence. More...
 
 PatternMatcher (const std::string &pattern, const Input &input=Input(), const char *opt=NULL)
 Construct a base abstract matcher from a regex pattern string and an input character sequence. More...
 
- Protected Member Functions inherited from reflex::AbstractMatcher
 AbstractMatcher (const Input &input, const char *opt)
 Construct a base abstract matcher. More...
 
 AbstractMatcher (const Input &input, const Option &opt)
 Construct a base abstract matcher. More...
 
void init (const char *opt=NULL)
 Initialize the base abstract matcher at construction. More...
 
virtual size_t get (char *s, size_t n)
 Returns more input (method can be overriden, as by reflex::FlexLexer::get(s, n) for example that invokes reflex::FlexLexer::LexerInput(s, n)). More...
 
virtual bool wrap ()
 Returns true if wrapping of input after EOF is supported. More...
 
bool grow (size_t need=Const::BLOCK)
 Shift or expand the internal buffer when it is too small to accommodate more input, where the buffer size is doubled when needed. More...
 
int get ()
 Returns the next character read from the current input source. More...
 
int peek ()
 Peek at the next character available for reading from the current input source. More...
 
void reset_text ()
 Reset the matched text by removing the terminating NUL, which is needed to search for a new match. More...
 
void set_current (size_t loc)
 Set the current position in the buffer for the next match. More...
 

Protected Attributes

boost::match_flag_type flg_
 boost::regex match flags More...
 
boost::cregex_iterator itr_
 const boost::regex iterator More...
 
boost::cregex_iterator fin_
 const boost::regex iterator final end More...
 
- Protected Attributes inherited from reflex::PatternMatcher< boost::regex >
bool own_
 true if PatternMatcher::pat_ was internally allocated More...
 
const Patternpat_
 points to the pattern object used by the matcher More...
 
- Protected Attributes inherited from reflex::AbstractMatcher
Option opt_
 options for matcher engines More...
 
char * buf_
 input character sequence buffer More...
 
const char * txt_
 points to the matched text in buffer AbstractMatcher::buf_ More...
 
size_t len_
 size of the matched text More...
 
size_t cap_
 nonzero capture index of an accepted match or zero More...
 
size_t cur_
 next position in AbstractMatcher::buf_ to assign to AbstractMatcher::txt_ More...
 
size_t pos_
 position in AbstractMatcher::buf_ after AbstractMatcher::txt_ More...
 
size_t end_
 ending position of the input buffered in AbstractMatcher::buf_ More...
 
size_t max_
 total buffer size and max position + 1 to fill More...
 
size_t ind_
 current indent position More...
 
size_t blk_
 block size for block-based input reading, as set by AbstractMatcher::buffer More...
 
int got_
 last unsigned character we looked at (to determine anchors and boundaries) More...
 
int chr_
 the character located at AbstractMatcher::txt_[AbstractMatcher::len_] More...
 
size_t lno_
 line number count (prior to this buffered input) More...
 
size_t cno_
 column number count (prior to this buffered input) More...
 
size_t num_
 character count (number of characters flushed prior to this buffered input) More...
 
bool eof_
 input has reached EOF More...
 
bool mat_
 true if AbstractMatcher::matches() was successful More...
 

Additional Inherited Members

- Public Types inherited from reflex::PatternMatcher< boost::regex >
typedef boost::regex Pattern
 
- Public Types inherited from reflex::AbstractMatcher
typedef AbstractMatcher::Iterator< AbstractMatcheriterator
 std::input_iterator for scanning, searching, and splitting input character sequences More...
 
typedef AbstractMatcher::Iterator< const AbstractMatcherconst_iterator
 
- Public Attributes inherited from reflex::AbstractMatcher
Operation scan
 functor to scan input (to tokenize input) More...
 
Operation find
 functor to search input More...
 
Operation split
 functor to split input More...
 
Input in
 input character sequence being matched by this matcher More...
 
- Protected Types inherited from reflex::AbstractMatcher
typedef int Method
 

Detailed Description

Boost matcher engine class implements reflex::PatternMatcher pattern matching interface with scan, find, split functors and iterators, using the Boost::regex library.

More info TODO

Constructor & Destructor Documentation

reflex::BoostMatcher::BoostMatcher ( )
inline

Default constructor.

template<typename P >
reflex::BoostMatcher::BoostMatcher ( const P *  pattern,
const Input input = Input(),
const char *  opt = NULL 
)
inline

Construct matcher engine from a boost::regex object or string regex, and an input character sequence.

Template Parameters
<P>pattern is a boost::regex or a string regex
Parameters
patternpoints to a boost::regex or a string regex for this matcher
inputinput character sequence for this matcher
optoption string of the form (A|N|T(=[[:digit:]])?|;)*
template<typename P >
reflex::BoostMatcher::BoostMatcher ( const P &  pattern,
const Input input = Input(),
const char *  opt = NULL 
)
inline

Construct matcher engine from a boost::regex object or string regex, and an input character sequence.

Template Parameters
<P>pattern is a boost::regex or a string regex
Parameters
patterna boost::regex or a string regex for this matcher
inputinput character sequence for this matcher
optoption string of the form (A|N|T(=[[:digit:]])?|;)*

Member Function Documentation

template<typename T >
static std::string reflex::BoostMatcher::convert ( regex,
convert_flag_type  flags = convert_flag::none 
)
inlinestatic

Convert a regex to an acceptable form, given the specified regex library signature "[decls:]escapes[?+]", see reflex::convert.

virtual size_t reflex::BoostMatcher::match ( Method  method)
inlineprotectedvirtual

The match method Const::SCAN, Const::FIND, Const::SPLIT, or Const::MATCH, implemented with boost::regex.

Returns
nonzero when input matched the pattern using method Const::SCAN, Const::FIND, Const::SPLIT, or Const::MATCH.

Implements reflex::AbstractMatcher.

void reflex::BoostMatcher::new_itr ( Method  method,
bool  bob 
)
inlineprotected

Create a new boost::regex iterator to (continue to) advance over input.

virtual std::pair<const char*,size_t> reflex::BoostMatcher::operator[] ( size_t  n) const
inlinevirtual

Returns captured text as a std::pair<const char*,size_t> with string pointer (not NUL-terminated) and length.

Returns
std::pair of string pointer and length in the captured text, where [0] returns std::pair(begin(), size()).

Implements reflex::AbstractMatcher.

virtual PatternMatcher& reflex::BoostMatcher::pattern ( const BoostMatcher matcher)
inlinevirtual

Set the pattern to use with this matcher as a shared pointer to another matcher pattern.

Returns
this matcher.
Parameters
matcherthe other matcher
virtual PatternMatcher& reflex::BoostMatcher::pattern ( const Pattern pattern)
inlinevirtual

Set the pattern to use with this matcher (the given pattern is shared and must be persistent).

Returns
this matcher.
Parameters
patternboost::regex for this matcher

Reimplemented from reflex::PatternMatcher< boost::regex >.

virtual PatternMatcher& reflex::BoostMatcher::pattern ( const Pattern pattern)
inlinevirtual

Set the pattern to use with this matcher (the given pattern is shared and must be persistent).

Returns
this matcher.
Parameters
patternboost::regex for this matcher

Reimplemented from reflex::PatternMatcher< boost::regex >.

virtual PatternMatcher& reflex::BoostMatcher::pattern ( const char *  pattern)
inlinevirtual

Set the pattern from a regex string to use with this matcher.

Returns
this matcher.
Parameters
patternregex string to instantiate internal pattern object

Reimplemented from reflex::PatternMatcher< boost::regex >.

virtual PatternMatcher& reflex::BoostMatcher::pattern ( const std::string &  pattern)
inlinevirtual

Set the pattern from a regex string to use with this matcher.

Returns
this matcher.
Parameters
patternregex string to instantiate internal pattern object

Reimplemented from reflex::PatternMatcher< boost::regex >.

virtual void reflex::BoostMatcher::reset ( const char *  opt = NULL)
inlinevirtual

Reset this matcher's state to the initial state and when assigned new input.

Reimplemented from reflex::AbstractMatcher.

Member Data Documentation

boost::cregex_iterator reflex::BoostMatcher::fin_
protected

const boost::regex iterator final end

boost::match_flag_type reflex::BoostMatcher::flg_
protected

boost::regex match flags

boost::cregex_iterator reflex::BoostMatcher::itr_
protected

const boost::regex iterator


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