reflex::FuzzyMatcher Class Reference

updated Tue Oct 1 2024 by Robert van Engelen
 
Classes | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
reflex::FuzzyMatcher Class Reference

RE/flex fuzzy matcher engine class, implements reflex::Matcher fuzzy pattern matching interface with scan, find, split functors and iterators. More...

#include <fuzzymatcher.h>

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

Classes

struct  BacktrackPoint
 Backtrack point. More...
 
struct  SaveState
 Save state to restore fuzzy matcher state after a second pass. More...
 

Public Member Functions

 FuzzyMatcher ()
 Default constructor. More...
 
template<typename P >
 FuzzyMatcher (const P *pattern, const Input &input=Input(), const char *opt=NULL)
 Construct matcher engine from a pattern or a string regex, and an input character sequence. More...
 
template<typename P >
 FuzzyMatcher (const P *pattern, uint16_t max, const Input &input=Input(), const char *opt=NULL)
 Construct matcher engine from a pattern or a string regex, and an input character sequence. More...
 
template<typename P >
 FuzzyMatcher (const P &pattern, const Input &input=Input(), const char *opt=NULL)
 Construct matcher engine from a pattern or a string regex, and an input character sequence. More...
 
template<typename P >
 FuzzyMatcher (const P &pattern, uint16_t max, const Input &input=Input(), const char *opt=NULL)
 Construct matcher engine from a pattern or a string regex, and an input character sequence. More...
 
 FuzzyMatcher (const FuzzyMatcher &matcher)
 Copy constructor. More...
 
FuzzyMatcheroperator= (const FuzzyMatcher &matcher)
 Assign a matcher. More...
 
virtual FuzzyMatcherclone ()
 Polymorphic cloning. More...
 
uint8_t edits () const
 Returns the number of edits made for the match, edits() <= max, not guaranteed to be the minimum edit distance. More...
 
void distance (uint16_t max)
 Set or update fuzzy distance parameters. More...
 
uint16_t distance ()
 Get the fuzzy distance parameters, the max is stored in the lower byte and INS, DEL, SUB are hi byte bits. More...
 
- Public Member Functions inherited from reflex::Matcher
 Matcher ()
 Default constructor. More...
 
 Matcher (const Pattern *pattern, const Input &input=Input(), const char *opt=NULL)
 Construct matcher engine from a pattern, and an input character sequence. More...
 
 Matcher (const char *pattern, const Input &input=Input(), const char *opt=NULL)
 Construct matcher engine from a string regex, and an input character sequence. More...
 
 Matcher (const Pattern &pattern, const Input &input=Input(), const char *opt=NULL)
 Construct matcher engine from a pattern, and an input character sequence. More...
 
 Matcher (const std::string &pattern, const Input &input=Input(), const char *opt=NULL)
 Construct matcher engine from a string regex, and an input character sequence. More...
 
 Matcher (const Matcher &matcher)
 Copy constructor. More...
 
Matcheroperator= (const Matcher &matcher)
 Assign a matcher, the underlying pattern string is shared (not deep copied). More...
 
Matcherpattern (const Pattern &pattern)
 Set the pattern to use with this matcher (the given pattern is shared and must be persistent). More...
 
Matcherpattern (const Pattern *pattern)
 Set the pattern to use with this matcher (the given pattern is shared and must be persistent). More...
 
Matcherpattern (const char *pattern)
 Set the pattern from a regex string to use with this matcher. More...
 
Matcherpattern (const std::string &pattern)
 Set the pattern from a regex string to use with this matcher. More...
 
virtual const Patternpattern () const
 Returns a reference to the pattern associated with this matcher. More...
 
virtual void reset (const char *opt=NULL)
 Reset this matcher's state to the initial state. 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 (non-0-terminated) and length. More...
 
virtual std::pair< size_t, const char * > group_id ()
 Returns the group capture identifier containing the group capture index >0 and name (or NULL) of a named group capture, or (1,NULL) by default. More...
 
virtual std::pair< size_t, const char * > group_next_id ()
 Returns the next group capture identifier containing the group capture index >0 and name (or NULL) of a named group capture, or (0,NULL) when no more groups matched. More...
 
size_t last_stop ()
 Returns the position of the last indent stop. More...
 
void insert_stop (size_t n)
 Inserts or appends an indent stop position, keeping indent stops sorted. More...
 
void delete_stop (size_t n)
 Remove all stop positions from position n and up until the last. More...
 
std::vector< size_t > & stops ()
 Returns reference to vector of current indent stop positions. More...
 
void clear_stops ()
 Clear indent stop positions. More...
 
void push_stops ()
 Push current indent stops and clear current indent stops. More...
 
void pop_stops ()
 Pop indent stops. More...
 
void FSM_INIT (int &c)
 FSM code INIT. More...
 
void FSM_FIND ()
 FSM code FIND. More...
 
int FSM_CHAR ()
 FSM code CHAR. More...
 
void FSM_HALT (int c=AbstractMatcher::Const::UNK)
 FSM code HALT. More...
 
void FSM_TAKE (Pattern::Accept cap)
 FSM code TAKE. More...
 
void FSM_TAKE (Pattern::Accept cap, int c)
 FSM code TAKE. More...
 
void FSM_REDO ()
 FSM code REDO. More...
 
void FSM_REDO (int c)
 FSM code REDO. More...
 
void FSM_HEAD (Pattern::Lookahead la)
 FSM code HEAD. More...
 
void FSM_TAIL (Pattern::Lookahead la)
 FSM code TAIL. More...
 
bool FSM_DENT ()
 FSM code DENT. More...
 
size_t FSM_POSN ()
 FSM extra code POSN returns current position. More...
 
void FSM_BACK (size_t pos)
 FSM extra code BACK position to a previous position returned by FSM_POSN(). More...
 
bool FSM_META_DED ()
 FSM code META DED. More...
 
bool FSM_META_IND ()
 FSM code META IND. More...
 
bool FSM_META_UND ()
 FSM code META UND. More...
 
bool FSM_META_EOB (int c)
 FSM code META EOB. More...
 
bool FSM_META_BOB ()
 FSM code META BOB. More...
 
bool FSM_META_EOL (int c)
 FSM code META EOL. More...
 
bool FSM_META_BOL ()
 FSM code META BOL. More...
 
bool FSM_META_EWE (int c)
 FSM code META EWE. More...
 
bool FSM_META_BWE (int c)
 FSM code META BWE. More...
 
bool FSM_META_EWB ()
 FSM code META EWB. More...
 
bool FSM_META_BWB ()
 FSM code META BWB. More...
 
bool FSM_META_NWE (int c)
 FSM code META NWE. More...
 
bool FSM_META_NWB ()
 FSM code META NWB. More...
 
bool FSM_META_WBE (int c)
 FSM code META WBE. More...
 
bool FSM_META_WBB ()
 FSM code META WBB. More...
 
- Public Member Functions inherited from reflex::PatternMatcher< reflex::Pattern >
 PatternMatcher (const PatternMatcher &matcher)
 Copy constructor, the underlying pattern object is shared (not deep copied). More...
 
virtual ~PatternMatcher ()
 Delete matcher, deletes pattern when owned. More...
 
virtual PatternMatcheroperator= (const PatternMatcher &matcher)
 Assign a matcher, the underlying pattern object is shared (not deep copied). More...
 
virtual PatternMatcherpattern (const PatternMatcher &matcher)
 Set the pattern to use with this matcher as a shared pointer to another matcher pattern. 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
 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...
 
virtual ~AbstractMatcher ()
 Delete abstract matcher, deletes this matcher's internal buffer. More...
 
bool buffer (size_t blk=0)
 Set buffer block size for reading: use 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 set_handler (Handler *handler)
 Set event handler functor to invoke when the buffer contents are shifted out, e.g. for logging the data searched. More...
 
Context before ()
 Get the buffered context before the matching line. More...
 
Context after ()
 Get the buffered context after EOF is reached. More...
 
void interactive ()
 Set interactive input with buffer size of 1 to read data bytewise which is very slow. More...
 
void flush ()
 Flush the buffer's remaining content. More...
 
virtual size_t get (char *s, size_t n)
 Returns more input data directly from the source (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...
 
virtual AbstractMatcherinput (const Input &input)
 Set the input character sequence for this matcher and reset/restart the matcher. More...
 
AbstractMatcherbuffer (char *base, size_t size)
 Set the buffer base containing 0-terminated character data to scan in place (data may be modified), 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 to permit 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 (non-0-terminated), a constant-time operation, use with end() or use size() for text end/length. More...
 
const char * end () const
 Returns pointer to the exclusive end of the matched text, a constant-time operation. More...
 
const char * text ()
 Returns 0-terminated pattern match as a char pointer, does not include matched \0s, this is a constant-time operation. More...
 
std::string str () const
 Returns the text matched as a string, a copy of text(), may include pattern-matched \0s. More...
 
std::wstring wstr () const
 Returns the pattern match as a wide string, converted from UTF-8 text(), may include pattern-matched \0s. More...
 
size_t size () const
 Returns the length of the matched text in number of bytes, including pattern-matched \0s, a constant-time operation. More...
 
size_t wsize () const
 Returns the length of the matched text in number of wide characters. More...
 
int chr () const
 Returns the first 8-bit character of the text matched. More...
 
int wchr () const
 Returns the first wide character of the text matched. More...
 
void lineno_skip (bool f=false)
 Set or reset mode to count matching lines only and skip other (e.g. for speed). More...
 
void lineno (size_t n)
 Set or change the starting line number of the last match. More...
 
size_t lineno ()
 Updates and returns the starting line number of the match in the input character sequence. More...
 
size_t lines ()
 Returns the number of lines that the match spans. More...
 
size_t lineno_end ()
 Returns the inclusive ending line number of the match in the input character sequence. More...
 
void columno (size_t n)
 Set or change the starting column number of the last match. More...
 
size_t columno ()
 Updates and returns the starting column number of the matched text, taking tab spacing into account and counting wide characters as one character each. More...
 
size_t columns ()
 Returns the number of columns of the matched text, taking tab spacing into account and counting wide characters as one character each. More...
 
size_t columno_end ()
 Returns the inclusive ending column number of the matched text on the ending matching line, taking tab spacing into account and counting wide characters as one character each. 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 exclusive position of the last character 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 a buffer to read an input character sequence. Use reset() to restart reading new input. More...
 
void set_bob (bool bob)
 Set/reset the begin of a buffer state. 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/reset the begin of a new line state. More...
 
bool at_bow ()
 Returns true if this matcher matched text that begins an ASCII word. More...
 
bool at_eow ()
 Returns true if this matcher matched text that ends an ASCII word. More...
 
int input ()
 Returns the next 8-bit character (unsigned char 0..255 or EOF) from the input character sequence, while preserving the current text() match (but pointer returned by text() may change; warning: does not preserve the yytext string pointer when options –flex and –bison are used). More...
 
int winput ()
 Returns the next wide character (unsigned 0..U+10FFFF or EOF) from the input character sequence, while preserving the current text() match (but pointer returned by text() may change; warning: does not preserve the yytext string pointer when options –flex and –bison are used). More...
 
void unput (char c)
 Put back one character (8-bit) on the input character sequence for matching, DANGER: invalidates the previous text() pointer and match info, unput is not honored when matching in-place using buffer(base, size) and nothing has been read yet. More...
 
void wunput (int c)
 Put back one (wide) character on the input character sequence for matching, DANGER: invalidates the previous text() pointer and match info, unput is not honored when matching in-place using buffer(base, size) and nothing has been read yet. More...
 
int peek ()
 Peek at the next character available for reading from the current input source. More...
 
const char * bol ()
 Returns pointer to the begin of the line in the buffer containing the matched text. More...
 
const char * eol (bool inclusive=false)
 Returns pointer to the end of the line (last char + 1) in the buffer containing the matched text, DANGER: invalidates previous bol() and text() pointers, use eol() before bol(), text(), begin(), and end() when those are used. More...
 
size_t fetch (size_t len)
 Return number of bytes available given number of bytes to fetch ahead, limited by input size and buffer size. More...
 
size_t avail ()
 Returns the number of bytes in the buffer available to search from the current begin()/text() position. More...
 
size_t border ()
 Returns the byte offset of the match from the start of the line. More...
 
const char * span ()
 Enlarge the match to span the entire line of input (excluding
), return text(). More...
 
std::string line ()
 Returns the line of input (excluding
) as a string containing the matched text as a substring. More...
 
std::wstring wline ()
 Returns the line of input (excluding
) as a wide string containing the matched text as a substring. More...
 
bool skip (char c)
 Skip input until the specified ASCII character is consumed and return true, or EOF is reached and return false. More...
 
bool skip (wchar_t c)
 Skip input until the specified Unicode character is consumed and return true, or EOF is reached and return false. More...
 
bool skip (const char *s)
 Skip input until the specified literal UTF-8 string is consumed and return true, or EOF is reached and return false. 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...
 
void tabs (char n)
 Set tab size 1, 2, 4, or 8. More...
 
char tabs ()
 Returns current tab size 1, 2, 4, or 8. More...
 

Static Public Attributes

static const uint16_t INS = 0x1000
 Optional flags for the max parameter to constrain fuzzy matching, otherwise no constraints. More...
 
static const uint16_t DEL = 0x2000
 fuzzy match allows character deletions (default) More...
 
static const uint16_t SUB = 0x4000
 character substitutions count as one edit, not two (insert+delete) (default) More...
 
static const uint16_t BIN = 0x8000
 

Protected Member Functions

void point (BacktrackPoint &bpt, const Pattern::Opcode *pc, size_t len, bool alternate=true, bool eof=false)
 Set backtrack point. More...
 
const Pattern::Opcodebacktrack (BacktrackPoint &bpt, int &ch)
 backtrack on a backtrack point to insert or substitute a pattern char, restoring current text char matched and errors. More...
 
virtual size_t match (Method method)
 Returns true if input fuzzy-matched the pattern using method Const::SCAN, Const::FIND, Const::SPLIT, or Const::MATCH. More...
 
- Protected Member Functions inherited from reflex::Matcher
bool at_wb ()
 Check if a word begins before a match. More...
 
bool at_we (int c, size_t k)
 Check if a word ends after the match. More...
 
bool at_bw ()
 Check if match begins a word (after split with len_ > 0 or len_ = 0 for find). More...
 
bool at_ew (int c)
 Check if match ends a word. More...
 
bool at_ewe (int c)
 Check end of word at match end boundary MATCH>. More...
 
bool at_bwe (int c)
 Check begin of word at match end boundary MATCH<. More...
 
bool at_ewb ()
 Check end of word at match begin boundary >MATCH (after split with len_ > 0 or len_ = 0 for find). More...
 
bool at_bwb ()
 Check begin of word at match begin boundary <MATCH (after split with len_ > 0 or len_ = 0 for find). More...
 
bool at_nwe (int c)
 Check not a word boundary at match end MATCH. More...
 
bool at_nwb ()
 Check not a word boundary at match begin (after split with len_ > 0 or len_ = 0 for find). More...
 
bool at_wbe (int c)
 Check word boundary at match end MATCH. More...
 
bool at_wbb ()
 Check word boundary at match begin (after split with len_ > 0 or len_ = 0 for find). More...
 
size_t simd_match_avx512bw (Method method)
 match() with optimized AVX512BW string search scheme defined in matcher_avx512bw.cpp More...
 
size_t simd_match_avx2 (Method method)
 match() with optimized AVX2 string search scheme defined in matcher_avx2.cpp More...
 
void init_advance ()
 Initialize specialized (+ SSE2/NEON) pattern search methods to advance the engine to a possible match. More...
 
void simd_init_advance_avx2 ()
 Initialize specialized AVX2 pattern search methods to advance the engine to a possible match. More...
 
void simd_init_advance_avx512bw ()
 Initialize specialized AVX512BW pattern search methods to advance the engine to a possible match. More...
 
bool advance_none (size_t loc)
 Default method is none (unset) More...
 
bool advance_pattern_pin1_pma (size_t loc)
 
bool advance_pattern_pin1_pmh (size_t loc)
 
bool advance_pattern_pin2_one (size_t loc)
 
bool advance_pattern_pin2_pma (size_t loc)
 
bool advance_pattern_pin2_pmh (size_t loc)
 
bool advance_pattern_pin3_one (size_t loc)
 
bool advance_pattern_pin3_pma (size_t loc)
 
bool advance_pattern_pin3_pmh (size_t loc)
 
bool advance_pattern_pin4_one (size_t loc)
 
bool advance_pattern_pin4_pma (size_t loc)
 
bool advance_pattern_pin4_pmh (size_t loc)
 
bool advance_pattern_pin5_one (size_t loc)
 
bool advance_pattern_pin5_pma (size_t loc)
 
bool advance_pattern_pin5_pmh (size_t loc)
 
bool advance_pattern_pin6_one (size_t loc)
 
bool advance_pattern_pin6_pma (size_t loc)
 
bool advance_pattern_pin6_pmh (size_t loc)
 
bool advance_pattern_pin7_one (size_t loc)
 
bool advance_pattern_pin7_pma (size_t loc)
 
bool advance_pattern_pin7_pmh (size_t loc)
 
bool advance_pattern_pin8_one (size_t loc)
 
bool advance_pattern_pin8_pma (size_t loc)
 
bool advance_pattern_pin8_pmh (size_t loc)
 
bool simd_advance_pattern_pin1_pma_avx2 (size_t loc)
 
bool simd_advance_pattern_pin1_pmh_avx2 (size_t loc)
 
bool simd_advance_pattern_pin2_one_avx2 (size_t loc)
 
bool simd_advance_pattern_pin2_pma_avx2 (size_t loc)
 
bool simd_advance_pattern_pin2_pmh_avx2 (size_t loc)
 
bool simd_advance_pattern_pin3_one_avx2 (size_t loc)
 
bool simd_advance_pattern_pin3_pma_avx2 (size_t loc)
 
bool simd_advance_pattern_pin3_pmh_avx2 (size_t loc)
 
bool simd_advance_pattern_pin4_one_avx2 (size_t loc)
 
bool simd_advance_pattern_pin4_pma_avx2 (size_t loc)
 
bool simd_advance_pattern_pin4_pmh_avx2 (size_t loc)
 
bool simd_advance_pattern_pin5_one_avx2 (size_t loc)
 
bool simd_advance_pattern_pin5_pma_avx2 (size_t loc)
 
bool simd_advance_pattern_pin5_pmh_avx2 (size_t loc)
 
bool simd_advance_pattern_pin6_one_avx2 (size_t loc)
 
bool simd_advance_pattern_pin6_pma_avx2 (size_t loc)
 
bool simd_advance_pattern_pin6_pmh_avx2 (size_t loc)
 
bool simd_advance_pattern_pin7_one_avx2 (size_t loc)
 
bool simd_advance_pattern_pin7_pma_avx2 (size_t loc)
 
bool simd_advance_pattern_pin7_pmh_avx2 (size_t loc)
 
bool simd_advance_pattern_pin8_one_avx2 (size_t loc)
 
bool simd_advance_pattern_pin8_pma_avx2 (size_t loc)
 
bool simd_advance_pattern_pin8_pmh_avx2 (size_t loc)
 
bool simd_advance_pattern_pin16_one_avx2 (size_t loc)
 
bool simd_advance_pattern_pin16_pma_avx2 (size_t loc)
 
bool simd_advance_pattern_pin16_pmh_avx2 (size_t loc)
 
bool advance_pattern_min1 (size_t loc)
 
bool advance_pattern_min2 (size_t loc)
 
bool advance_pattern_min3 (size_t loc)
 
bool advance_pattern_min4 (size_t loc)
 
bool advance_pattern (size_t loc)
 
bool advance_char (size_t loc)
 
bool advance_char_pma (size_t loc)
 
bool advance_char_pmh (size_t loc)
 
template<uint8_t LEN>
bool advance_chars (size_t loc)
 
template<uint8_t LEN>
bool advance_chars_pma (size_t loc)
 
template<uint8_t LEN>
bool advance_chars_pmh (size_t loc)
 
template<uint8_t LEN>
bool simd_advance_chars_avx2 (size_t loc)
 
template<uint8_t LEN>
bool simd_advance_chars_pma_avx2 (size_t loc)
 
template<uint8_t LEN>
bool simd_advance_chars_pmh_avx2 (size_t loc)
 
template<uint8_t LEN>
bool simd_advance_chars_avx512bw (size_t loc)
 
template<uint8_t LEN>
bool simd_advance_chars_pma_avx512bw (size_t loc)
 
template<uint8_t LEN>
bool simd_advance_chars_pmh_avx512bw (size_t loc)
 
bool advance_string (size_t loc)
 
bool advance_string_pma (size_t loc)
 
bool advance_string_pmh (size_t loc)
 
bool simd_advance_string_avx2 (size_t loc)
 
bool simd_advance_string_pma_avx2 (size_t loc)
 
bool simd_advance_string_pmh_avx2 (size_t loc)
 
bool simd_advance_string_avx512bw (size_t loc)
 
bool simd_advance_string_pma_avx512bw (size_t loc)
 
bool simd_advance_string_pmh_avx512bw (size_t loc)
 
bool simd_advance_string_neon (const char *&s, const char *e)
 
bool simd_advance_string_pma_neon (const char *&s, const char *e)
 
bool simd_advance_string_pmh_neon (const char *&s, const char *e)
 
bool advance_string_bm (size_t loc)
 
bool advance_string_bm_pma (size_t loc)
 
bool advance_string_bm_pmh (size_t loc)
 
void newline ()
 Update indentation column counter for indent() and dedent(). More...
 
bool indent ()
 Returns true if looking at indent. More...
 
bool dedent ()
 Returns true if looking at dedent. More...
 
bool nodent ()
 Returns true if nodent. More...
 
- Protected Member Functions inherited from reflex::PatternMatcher< reflex::Pattern >
 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)
 Construct a base abstract matcher from a persistent pattern object (that is shared with this class) and an input character sequence. More...
 
 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
virtual void init (const char *opt=NULL)
 Initialize the base abstract matcher at construction. 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, change cur_, pos_, end_, max_, ind_, buf_, bol_, lpb_, and txt_. More...
 
int get ()
 Returns the next character read from the current input source. More...
 
void reset_text ()
 Reset the matched text by removing the terminating \0 when applicable, 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...
 
void set_current_and_peek_more (size_t loc)
 Set the current match position in the buffer and peek for more text, allows large buffer shifts that aren't pinned to txt_. More...
 
int get_more ()
 Get the next character and grow the buffer to make more room if necessary. More...
 
int peek_more ()
 Peek at the next character and grow the buffer to make more room if necessary. More...
 

Protected Attributes

std::vector< BacktrackPointbpt_
 vector of backtrack points, max_ size More...
 
uint8_t max_
 max errors More...
 
uint8_t err_
 accumulated edit distance (not guaranteed minimal) More...
 
bool ins_
 fuzzy match permits inserted chars (extra chars in the input) More...
 
bool del_
 fuzzy match permits deleted chars (missing chars in the input) More...
 
bool sub_
 fuzzy match permits substituted chars More...
 
bool bin_
 fuzzy match bytes, not UTF-8 multibyte encodings More...
 
- Protected Attributes inherited from reflex::Matcher
size_t ded_
 dedent count More...
 
size_t col_
 column counter for indent matching, updated by newline(), indent(), and dedent() More...
 
Stops tab_
 tab stops set by detecting indent margins More...
 
std::vector< int > lap_
 lookahead position in input that heads a lookahead match (indexed by lookahead number) More...
 
std::stack< Stopsstk_
 stack to push/pop stops More...
 
FSM fsm_
 local state for FSM code More...
 
bool(Matcher::* adv_ )(size_t loc)
 advance FIND function pointer More...
 
bool mrk_
 indent or dedent in pattern found: should check and update indent stops More...
 
bool anc_
 match is anchored, advance slowly to retry when searching More...
 
- Protected Attributes inherited from reflex::PatternMatcher< reflex::Pattern >
const Patternpat_
 points to the pattern object used by the matcher More...
 
bool own_
 true if PatternMatcher::pat_ was allocated and should be deleted More...
 
- Protected Attributes inherited from reflex::AbstractMatcher
Option opt_
 options for matcher engines More...
 
char * buf_
 input character sequence buffer More...
 
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...
 
const char * bol_
 begin of line pointer in buffer More...
 
Handlerevh_
 event handler functor to invoke when buffer contents are shifted out More...
 
const char * lpb_
 line pointer in buffer, updated when counting line numbers with lineno() More...
 
size_t lno_
 line number count (cached) More...
 
const char * cpb_
 column pointer in buffer, updated when counting column numbers with columno() More...
 
size_t cno_
 column number count (cached) More...
 
size_t num_
 character count of the input till bol_ More...
 
bool own_
 true if AbstractMatcher::buf_ was allocated and should be deleted More...
 
bool eof_
 input has reached EOF More...
 
bool mat_
 true if AbstractMatcher::matches() was successful More...
 
bool cml_
 true when counting matching lines instead of line numbers More...
 

Additional Inherited Members

- Public Types inherited from reflex::PatternMatcher< reflex::Pattern >
typedef reflex::Pattern 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
 
- Static Public Member Functions inherited from reflex::Matcher
template<typename T >
static std::string convert (T regex, convert_flag_type flags=convert_flag::none, bool *multiline=NULL)
 Convert a regex to an acceptable form, given the specified regex library signature "[decls:]escapes[?+]", see reflex::convert. More...
 
- 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::Matcher
typedef std::vector< size_t > Stops
 
- Protected Types inherited from reflex::AbstractMatcher
typedef int Method
 a method is one of Const::SCAN, Const::FIND, Const::SPLIT, Const::MATCH More...
 
- Static Protected Member Functions inherited from reflex::Matcher
static bool iswword (int c)
 Return true if Unicode word character. More...
 

Detailed Description

RE/flex fuzzy matcher engine class, implements reflex::Matcher fuzzy pattern matching interface with scan, find, split functors and iterators.

More info TODO

Constructor & Destructor Documentation

reflex::FuzzyMatcher::FuzzyMatcher ( )
inline

Default constructor.

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

Construct matcher engine from a pattern or a string regex, and an input character sequence.

Template Parameters
<P>a reflex::Pattern or a string regex
Parameters
patternpoints to a reflex::Pattern 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::FuzzyMatcher::FuzzyMatcher ( const P *  pattern,
uint16_t  max,
const Input input = Input(),
const char *  opt = NULL 
)
inline

Construct matcher engine from a pattern or a string regex, and an input character sequence.

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

Construct matcher engine from a pattern or a string regex, and an input character sequence.

Template Parameters
<P>a reflex::Pattern or a string regex
Parameters
patterna reflex::Pattern 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::FuzzyMatcher::FuzzyMatcher ( const P &  pattern,
uint16_t  max,
const Input input = Input(),
const char *  opt = NULL 
)
inline

Construct matcher engine from a pattern or a string regex, and an input character sequence.

Template Parameters
<P>a reflex::Pattern or a string regex
Parameters
patterna reflex::Pattern or a string regex for this matcher
maxmax errors
inputinput character sequence for this matcher
optoption string of the form (A|N|T(=[[:digit:]])?|;)*
reflex::FuzzyMatcher::FuzzyMatcher ( const FuzzyMatcher matcher)
inline

Copy constructor.

Parameters
matchermatcher to copy with pattern (pattern may be shared)

Member Function Documentation

const Pattern::Opcode* reflex::FuzzyMatcher::backtrack ( BacktrackPoint bpt,
int &  ch 
)
inlineprotected

backtrack on a backtrack point to insert or substitute a pattern char, restoring current text char matched and errors.

virtual FuzzyMatcher* reflex::FuzzyMatcher::clone ( )
inlinevirtual

Polymorphic cloning.

Reimplemented from reflex::Matcher.

void reflex::FuzzyMatcher::distance ( uint16_t  max)
inline

Set or update fuzzy distance parameters.

Parameters
maxmax errors, INS, DEL, SUB
uint16_t reflex::FuzzyMatcher::distance ( )
inline

Get the fuzzy distance parameters, the max is stored in the lower byte and INS, DEL, SUB are hi byte bits.

uint8_t reflex::FuzzyMatcher::edits ( ) const
inline

Returns the number of edits made for the match, edits() <= max, not guaranteed to be the minimum edit distance.

Returns
0 to max edit distance
virtual size_t reflex::FuzzyMatcher::match ( Method  method)
inlineprotectedvirtual

Returns true if input fuzzy-matched the pattern using method Const::SCAN, Const::FIND, Const::SPLIT, or Const::MATCH.

Returns
nonzero if input matched the pattern
Parameters
methodConst::SCAN, Const::FIND, Const::SPLIT, or Const::MATCH

Reimplemented from reflex::Matcher.

FuzzyMatcher& reflex::FuzzyMatcher::operator= ( const FuzzyMatcher matcher)
inline

Assign a matcher.

Parameters
matchermatcher to copy
void reflex::FuzzyMatcher::point ( BacktrackPoint bpt,
const Pattern::Opcode pc,
size_t  len,
bool  alternate = true,
bool  eof = false 
)
inlineprotected

Set backtrack point.

Member Data Documentation

const uint16_t reflex::FuzzyMatcher::BIN = 0x8000
static

binary matching without UTF-8 multibyte encodings

bool reflex::FuzzyMatcher::bin_
protected

fuzzy match bytes, not UTF-8 multibyte encodings

std::vector<BacktrackPoint> reflex::FuzzyMatcher::bpt_
protected

vector of backtrack points, max_ size

const uint16_t reflex::FuzzyMatcher::DEL = 0x2000
static

fuzzy match allows character deletions (default)

bool reflex::FuzzyMatcher::del_
protected

fuzzy match permits deleted chars (missing chars in the input)

uint8_t reflex::FuzzyMatcher::err_
protected

accumulated edit distance (not guaranteed minimal)

const uint16_t reflex::FuzzyMatcher::INS = 0x1000
static

Optional flags for the max parameter to constrain fuzzy matching, otherwise no constraints.

fuzzy match allows character insertions (default)

bool reflex::FuzzyMatcher::ins_
protected

fuzzy match permits inserted chars (extra chars in the input)

uint8_t reflex::FuzzyMatcher::max_
protected

max errors

const uint16_t reflex::FuzzyMatcher::SUB = 0x4000
static

character substitutions count as one edit, not two (insert+delete) (default)

bool reflex::FuzzyMatcher::sub_
protected

fuzzy match permits substituted chars


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