source/strings/regex.h

   1 #ifndef MSP_STRINGS_REGEX_H_
   2 #define MSP_STRINGS_REGEX_H_
   3
   4 #include <string>
   5 #include "regmatch.h"
   6
   7 namespace Msp {
   8
   9 /**
  10 This class provides regular expression matching.  It supports a subset of
  11 POSIX.2 extended regex syntax.  Character classes, equivalence classes and
  12 collating elements are not supported.  Refer to the regex(7) manpage for more
  13 details.
  14
  15 A description of the internal workings of the class follows.  You may skip this
  16 if you are not a developer or otherwise interested.
  17
  18 The core of this class is a virtual machine running a non-deterministic finite
  19 automaton (NFA).  The state of the automaton is represented by an iterator into
  20 the code.  Transitions between states are represented by instructions.
  21 Instructions may take multiple bytes, so a valid code iterator may not be a
  22 valid NFA state.
  23
  24 The virtual machine may have any number of execution contexts at any one time.
  25 On every cycle, each context is advanced until an input-consuming instruction
  26 is encountered, keeping the input positions in sync with each other.  Execution
  27 continues as long as there's at least one context remaining.
  28
  29 The GROUP_BEGIN and GROUP_END instructions record the begin and end offset of a
  30 match group, respectively.  The GROUP_END instruction also marks the group as
  31 successfully matched.  If the target group was already matched, these
  32 instructions do nothing.
  33
  34 The JUMP instruction causes the execution iterator to be modified by an offset.
  35
  36 The ND_JUMP instruction causes the execution context to be split in two.  One
  37 continues directly after the instruction and the other continues at an offset.
  38
  39 The NEGATE instruction causes the result of the next match instruction to be
  40 negated.
  41
  42 Match instructions compare the input against a condition.  If the match
  43 succeeds, execution continues at the next instruction.  If the match fails,
  44 execution of that context is terminated.
  45
  46 The MATCH_BEGIN and MATCH_END instructions match the beginning and end of
  47 the input string, respectively.  They do not consume input.
  48
  49 The MATCH_CHAR instruction consumes the input character and matches it against
  50 a single character.  Since regexes often match sequences of printable character,
  51 a match for a non-opcode character may be encoded as the character itself.
  52
  53 The MATCH_RANGE instruction consumes the input character and matches it against
  54 an inclusive character range.
  55
  56 The MATCH_MASK instruction consumes the input character and matches it against
  57 a bitmask.
  58
  59 The MATCH_ANY instruction consumes the input character and always succeeds.
  60 */
  61 class Regex
  62 {
  63 private:
  64         typedef std::string Code;
  65         typedef unsigned short Count;
  66         typedef short Offset;
  67         typedef unsigned short Index;
  68
  69         enum Instruction
  70         {
  71                 FIRST_INSTRUCTION_ = 0,
  72
  73                 JUMP,
  74                 ND_JUMP,
  75
  76                 GROUP_BEGIN,
  77                 GROUP_END,
  78
  79                 NEGATE,
  80
  81                 MATCH_BEGIN,
  82                 MATCH_END,
  83                 MATCH_CHAR,
  84                 MATCH_RANGE,
  85                 MATCH_MASK,
  86                 MATCH_ANY,
  87
  88                 LAST_INSTRUCTION_ = 31
  89         };
  90
  91         struct RunContext
  92         {
  93                 Code::const_iterator citer;
  94                 RegMatch::GroupArray groups;
  95         };
  96
  97         Code code;
  98         unsigned n_groups;
  99
 100 public:
 101         /** Constructs a new Regex object from a string representation. */
 102         Regex(const std::string &expr);
 103
 104 private:
 105         /** Compiles a regular expression into NFA bytecode.  , 2011The iterator will be
 106         advanced to the first unused character in the string. */
 107         Code compile(const std::string &expr, std::string::const_iterator &iter, unsigned &group, bool branch);
 108
 109         Code parse_atom(const std::string &, std::string::const_iterator &i, unsigned &);
 110         Code parse_brackets(const std::string &, std::string::const_iterator &);
 111         bool parse_repeat(std::string::const_iterator &, Count &, Count &);
 112
 113 public:
 114         /** Matches the regex against a string.  Refer to RegMatch documentation for
 115         more information on the resulting object. */
 116         RegMatch match(const std::string &str) const;
 117
 118 private:
 119         bool run(const std::string &, const std::string::const_iterator &, RegMatch::GroupArray &) const;
 120         bool group_compare(const RegMatch::Group &, const RegMatch::Group &) const;
 121
 122 public:
 123         /** Returns a disassembled representation of the NFA bytecode.  For debugging
 124         purposes. */
 125         std::string disassemble() const;
 126 private:
 127         std::string disassemble_instruction(Code::const_iterator &) const;
 128 };
 129
 130 } // namespace Msp
 131
 132 #endif