[apple/icu.git] / icuSources / i18n / regeximp.h

//
//   Copyright (C) 2002-2012 International Business Machines Corporation
//   and others. All rights reserved.
//
//   file:  regeximp.h
//
//           ICU Regular Expressions,
//               Definitions of constant values used in the compiled form of
//               a regular expression pattern.
//

#ifndef _REGEXIMP_H
#define _REGEXIMP_H

#include "unicode/utypes.h"
#include "unicode/uobject.h"
#include "unicode/uniset.h"
#include "unicode/utext.h"

#include "cmemory.h"
#include "ucase.h"

U_NAMESPACE_BEGIN

// For debugging, define REGEX_DEBUG 
// To define with configure,
//   ./runConfigureICU --enable-debug --disable-release Linux CPPFLAGS="-DREGEX_DEBUG"

#ifdef REGEX_DEBUG   
//
//  debugging options.  Enable one or more of the three #defines immediately following
//

//#define REGEX_SCAN_DEBUG
#define REGEX_DUMP_DEBUG
#define REGEX_RUN_DEBUG

//  End of #defines inteded to be directly set.

#include <stdio.h>
#endif

#ifdef REGEX_SCAN_DEBUG
#define REGEX_SCAN_DEBUG_PRINTF(a) printf a
#else
#define REGEX_SCAN_DEBUG_PRINTF(a)
#endif

#ifdef REGEX_DUMP_DEBUG
#define REGEX_DUMP_DEBUG_PRINTF(a) printf a
#else
#define REGEX_DUMP_DEBUG_PRINTF(a)
#endif

#ifdef REGEX_RUN_DEBUG
#define REGEX_RUN_DEBUG_PRINTF(a) printf a
#define REGEX_DUMP_DEBUG_PRINTF(a) printf a
#else
#define REGEX_RUN_DEBUG_PRINTF(a)
#endif


//
//  Opcode types     In the compiled form of the regexp, these are the type, or opcodes,
//                   of the entries.
//
enum {
     URX_RESERVED_OP   = 0,    // For multi-operand ops, most non-first words.
     URX_RESERVED_OP_N = 255,  // For multi-operand ops, negative operand values.
     URX_BACKTRACK     = 1,    // Force a backtrack, as if a match test had failed.
     URX_END           = 2,
     URX_ONECHAR       = 3,    // Value field is the 21 bit unicode char to match
     URX_STRING        = 4,    // Value field is index of string start
     URX_STRING_LEN    = 5,    // Value field is string length (code units)
     URX_STATE_SAVE    = 6,    // Value field is pattern position to push
     URX_NOP           = 7,
     URX_START_CAPTURE = 8,    // Value field is capture group number.
     URX_END_CAPTURE   = 9,    // Value field is capture group number
     URX_STATIC_SETREF = 10,   // Value field is index of set in array of sets.
     URX_SETREF        = 11,   // Value field is index of set in array of sets.
     URX_DOTANY        = 12,
     URX_JMP           = 13,   // Value field is destination position in
                                                    //   the pattern.
     URX_FAIL          = 14,   // Stop match operation,  No match.

     URX_JMP_SAV       = 15,   // Operand:  JMP destination location
     URX_BACKSLASH_B   = 16,   // Value field:  0:  \b    1:  \B
     URX_BACKSLASH_G   = 17,
     URX_JMP_SAV_X     = 18,   // Conditional JMP_SAV,
                               //    Used in (x)+, breaks loop on zero length match.
                               //    Operand:  Jmp destination.
     URX_BACKSLASH_X   = 19,
     URX_BACKSLASH_Z   = 20,   // \z   Unconditional end of line.

     URX_DOTANY_ALL    = 21,   // ., in the . matches any mode.
     URX_BACKSLASH_D   = 22,   // Value field:  0:  \d    1:  \D
     URX_CARET         = 23,   // Value field:  1:  multi-line mode.
     URX_DOLLAR        = 24,  // Also for \Z

     URX_CTR_INIT      = 25,   // Counter Inits for {Interval} loops.
     URX_CTR_INIT_NG   = 26,   //   2 kinds, normal and non-greedy.
                               //   These are 4 word opcodes.  See description.
                               //    First Operand:  Data loc of counter variable
                               //    2nd   Operand:  Pat loc of the URX_CTR_LOOPx
                               //                    at the end of the loop.
                               //    3rd   Operand:  Minimum count.
                               //    4th   Operand:  Max count, -1 for unbounded.

     URX_DOTANY_UNIX   = 27,   // '.' operator in UNIX_LINES mode, only \n marks end of line.

     URX_CTR_LOOP      = 28,   // Loop Ops for {interval} loops.
     URX_CTR_LOOP_NG   = 29,   //   Also in three flavors.
                               //   Operand is loc of corresponding CTR_INIT.

     URX_CARET_M_UNIX  = 30,   // '^' operator, test for start of line in multi-line
                               //      plus UNIX_LINES mode.

     URX_RELOC_OPRND   = 31,   // Operand value in multi-operand ops that refers
                               //   back into compiled pattern code, and thus must
                               //   be relocated when inserting/deleting ops in code.

     URX_STO_SP        = 32,   // Store the stack ptr.  Operand is location within
                               //   matcher data (not stack data) to store it.
     URX_LD_SP         = 33,   // Load the stack pointer.  Operand is location
                               //   to load from.
     URX_BACKREF       = 34,   // Back Reference.  Parameter is the index of the
                               //   capture group variables in the state stack frame.
     URX_STO_INP_LOC   = 35,   // Store the input location.  Operand is location
                               //   within the matcher stack frame.
     URX_JMPX          = 36,  // Conditional JMP.
                               //   First Operand:  JMP target location.
                               //   Second Operand:  Data location containing an
                               //     input position.  If current input position ==
                               //     saved input position, FAIL rather than taking
                               //     the JMP
     URX_LA_START      = 37,   // Starting a LookAround expression.
                               //   Save InputPos and SP in static data.
                               //   Operand:  Static data offset for the save
     URX_LA_END        = 38,   // Ending a Lookaround expression.
                               //   Restore InputPos and Stack to saved values.
                               //   Operand:  Static data offset for saved data.
     URX_ONECHAR_I     = 39,   // Test for case-insensitive match of a literal character.
                               //   Operand:  the literal char.
     URX_STRING_I      = 40,   // Case insensitive string compare.
                               //   First Operand:  Index of start of string in string literals
                               //   Second Operand (next word in compiled code):
                               //     the length of the string.
     URX_BACKREF_I     = 41,   // Case insensitive back reference.
                               //   Parameter is the index of the
                               //   capture group variables in the state stack frame.
     URX_DOLLAR_M      = 42,   // $ in multi-line mode.
     URX_CARET_M       = 43,   // ^ in multi-line mode.
     URX_LB_START      = 44,   // LookBehind Start.
                               //   Paramater is data location
     URX_LB_CONT       = 45,   // LookBehind Continue.
                               //   Param 0:  the data location
                               //   Param 1:  The minimum length of the look-behind match
                               //   Param 2:  The max length of the look-behind match
     URX_LB_END        = 46,   // LookBehind End.
                               //   Parameter is the data location.
                               //     Check that match ended at the right spot,
                               //     Restore original input string len.
     URX_LBN_CONT      = 47,   // Negative LookBehind Continue
                               //   Param 0:  the data location
                               //   Param 1:  The minimum length of the look-behind match
                               //   Param 2:  The max     length of the look-behind match
                               //   Param 3:  The pattern loc following the look-behind block.
     URX_LBN_END       = 48,   // Negative LookBehind end
                               //   Parameter is the data location.
                               //   Check that the match ended at the right spot.
     URX_STAT_SETREF_N = 49,   // Reference to a prebuilt set (e.g. \w), negated
                               //   Operand is index of set in array of sets.
     URX_LOOP_SR_I     = 50,   // Init a [set]* loop.
                               //   Operand is the sets index in array of user sets.
     URX_LOOP_C        = 51,   // Continue a [set]* or OneChar* loop.
                               //   Operand is a matcher static data location.
                               //   Must always immediately follow  LOOP_x_I instruction.
     URX_LOOP_DOT_I    = 52,   // .*, initialization of the optimized loop.
                               //   Operand value:
                               //      bit 0:
                               //         0:  Normal (. doesn't match new-line) mode.
                               //         1:  . matches new-line mode.
                               //      bit 1:  controls what new-lines are recognized by this operation.
                               //         0:  All Unicode New-lines
                               //         1:  UNIX_LINES, \u000a only.
     URX_BACKSLASH_BU  = 53,   // \b or \B in UREGEX_UWORD mode, using Unicode style
                               //   word boundaries.
     URX_DOLLAR_D      = 54,   // $ end of input test, in UNIX_LINES mode.
     URX_DOLLAR_MD     = 55    // $ end of input test, in MULTI_LINE and UNIX_LINES mode.

};

// Keep this list of opcode names in sync with the above enum
//   Used for debug printing only.
#define URX_OPCODE_NAMES       \
        "               ",     \
        "BACKTRACK",           \
        "END",                 \
        "ONECHAR",             \
        "STRING",              \
        "STRING_LEN",          \
        "STATE_SAVE",          \
        "NOP",                 \
        "START_CAPTURE",       \
        "END_CAPTURE",         \
        "URX_STATIC_SETREF",   \
        "SETREF",              \
        "DOTANY",              \
        "JMP",                 \
        "FAIL",                \
        "JMP_SAV",             \
        "BACKSLASH_B",         \
        "BACKSLASH_G",         \
        "JMP_SAV_X",           \
        "BACKSLASH_X",         \
        "BACKSLASH_Z",         \
        "DOTANY_ALL",          \
        "BACKSLASH_D",         \
        "CARET",               \
        "DOLLAR",              \
        "CTR_INIT",            \
        "CTR_INIT_NG",         \
        "DOTANY_UNIX",         \
        "CTR_LOOP",            \
        "CTR_LOOP_NG",         \
        "URX_CARET_M_UNIX",    \
        "RELOC_OPRND",         \
        "STO_SP",              \
        "LD_SP",               \
        "BACKREF",             \
        "STO_INP_LOC",         \
        "JMPX",                \
        "LA_START",            \
        "LA_END",              \
        "ONECHAR_I",           \
        "STRING_I",            \
        "BACKREF_I",           \
        "DOLLAR_M",            \
        "CARET_M",             \
        "LB_START",            \
        "LB_CONT",             \
        "LB_END",              \
        "LBN_CONT",            \
        "LBN_END",             \
        "STAT_SETREF_N",       \
        "LOOP_SR_I",           \
        "LOOP_C",              \
        "LOOP_DOT_I",          \
        "BACKSLASH_BU",        \
        "DOLLAR_D",            \
        "DOLLAR_MD"


//
//  Convenience macros for assembling and disassembling a compiled operation.
//
#define URX_BUILD(type, val) (int32_t)((type << 24) | (val))
#define URX_TYPE(x)          ((uint32_t)(x) >> 24)
#define URX_VAL(x)           ((x) & 0xffffff)


//
//  Access to Unicode Sets composite character properties
//     The sets are accessed by the match engine for things like \w (word boundary)
//
enum {
     URX_ISWORD_SET  = 1,
     URX_ISALNUM_SET = 2,
     URX_ISALPHA_SET = 3,
     URX_ISSPACE_SET = 4,

     URX_GC_NORMAL,          // Sets for finding grapheme cluster boundaries.
     URX_GC_EXTEND,
     URX_GC_CONTROL,
     URX_GC_L,
     URX_GC_LV,
     URX_GC_LVT,
     URX_GC_V,
     URX_GC_T,

     URX_LAST_SET,

     URX_NEG_SET     = 0x800000          // Flag bit to reverse sense of set
                                         //   membership test.
};


//
//  Match Engine State Stack Frame Layout.
//
struct REStackFrame {
    // Header
    int64_t            fInputIdx;        // Position of next character in the input string
    int64_t            fPatIdx;          // Position of next Op in the compiled pattern
                                         // (int64_t for UVector64, values fit in an int32_t)
    // Remainder
    int64_t            fExtra[1];        // Extra state, for capture group start/ends
                                         //   atomic parentheses, repeat counts, etc.
                                         //   Locations assigned at pattern compile time.
                                         //   Variable-length array.
};
// number of UVector elements in the header
#define RESTACKFRAME_HDRCOUNT 2

//
//  Start-Of-Match type.  Used by find() to quickly scan to positions where a
//                        match might start before firing up the full match engine.
//
enum StartOfMatch {
    START_NO_INFO,             // No hint available.
    START_CHAR,                // Match starts with a literal code point.
    START_SET,                 // Match starts with something matching a set.
    START_START,               // Match starts at start of buffer only (^ or \A)
    START_LINE,                // Match starts with ^ in multi-line mode.
    START_STRING               // Match starts with a literal string.
};

#define START_OF_MATCH_STR(v) ((v)==START_NO_INFO? "START_NO_INFO" : \
                               (v)==START_CHAR?    "START_CHAR"    : \
                               (v)==START_SET?     "START_SET"     : \
                               (v)==START_START?   "START_START"   : \
                               (v)==START_LINE?    "START_LINE"    : \
                               (v)==START_STRING?  "START_STRING"  : \
                                                   "ILLEGAL")

//
//  8 bit set, to fast-path latin-1 set membership tests.
//
struct Regex8BitSet : public UMemory {
    inline Regex8BitSet();
    inline void operator = (const Regex8BitSet &s);
    inline void init(const UnicodeSet *src);
    inline UBool contains(UChar32 c);
    inline void  add(UChar32 c);
    int8_t d[32];
};

inline Regex8BitSet::Regex8BitSet() {
    uprv_memset(d, 0, sizeof(d));
}

inline UBool Regex8BitSet::contains(UChar32 c) {
    // No bounds checking!  This is deliberate.
    return ((d[c>>3] & 1 <<(c&7)) != 0);
}

inline void  Regex8BitSet::add(UChar32 c) {
    d[c>>3] |= 1 << (c&7);
}

inline void Regex8BitSet::init(const UnicodeSet *s) {
    if (s != NULL) {
        for (int32_t i=0; i<=255; i++) {
            if (s->contains(i)) {
                this->add(i);
            }
        }
    }
}

inline void Regex8BitSet::operator = (const Regex8BitSet &s) {
   uprv_memcpy(d, s.d, sizeof(d));
}


//  Case folded UText Iterator helper class.
//  Wraps a UText, provides a case-folded enumeration over its contents.
//  Used in implementing case insensitive matching constructs.
//  Implementation in rematch.cpp

class CaseFoldingUTextIterator: public UMemory {
      public:
        CaseFoldingUTextIterator(UText &text);
        ~CaseFoldingUTextIterator();

        UChar32 next();           // Next case folded character 

        UBool   inExpansion();    // True if last char returned from next() and the 
                                  //  next to be returned both originated from a string
                                  //  folding of the same code point from the orignal UText.
      private:
        UText             &fUText;
        const  UCaseProps *fcsp;
        const  UChar      *fFoldChars;
        int32_t            fFoldLength;
        int32_t            fFoldIndex;

};


// Case folded UChar * string iterator.
//  Wraps a UChar  *, provides a case-folded enumeration over its contents.
//  Used in implementing case insensitive matching constructs.
//  Implementation in rematch.cpp

class CaseFoldingUCharIterator: public UMemory {
      public:
        CaseFoldingUCharIterator(const UChar *chars, int64_t start, int64_t limit);
        ~CaseFoldingUCharIterator();

        UChar32 next();           // Next case folded character 

        UBool   inExpansion();    // True if last char returned from next() and the 
                                  //  next to be returned both originated from a string
                                  //  folding of the same code point from the orignal UText.

        int64_t  getIndex();      // Return the current input buffer index.

      private:
        const  UChar      *fChars;
        int64_t            fIndex;
        int64_t            fLimit;
        const  UCaseProps *fcsp;
        const  UChar      *fFoldChars;
        int32_t            fFoldLength;
        int32_t            fFoldIndex;

};

U_NAMESPACE_END
#endif
Commit	Line	Data
46f4442e	1	//
4388f060	2	// Copyright (C) 2002-2012 International Business Machines Corporation
46f4442e	3	// and others. All rights reserved.
b75a7d8f A	4	//
	5	// file: regeximp.h
	6	//
	7	// ICU Regular Expressions,
	8	// Definitions of constant values used in the compiled form of
	9	// a regular expression pattern.
	10	//
	11
	12	#ifndef _REGEXIMP_H
	13	#define _REGEXIMP_H
	14
4388f060 A	15	#include "unicode/utypes.h"
	16	#include "unicode/uobject.h"
	17	#include "unicode/uniset.h"
	18	#include "unicode/utext.h"
	19
b75a7d8f	20	#include "cmemory.h"
4388f060	21	#include "ucase.h"
b75a7d8f A	22
	23	U_NAMESPACE_BEGIN
	24
4388f060 A	25	// For debugging, define REGEX_DEBUG
	26	// To define with configure,
	27	// ./runConfigureICU --enable-debug --disable-release Linux CPPFLAGS="-DREGEX_DEBUG"
	28
	29	#ifdef REGEX_DEBUG
b75a7d8f	30	//
374ca955	31	// debugging options. Enable one or more of the three #defines immediately following
b75a7d8f	32	//
374ca955	33
b75a7d8f	34	//#define REGEX_SCAN_DEBUG
374ca955 A	35	#define REGEX_DUMP_DEBUG
	36	#define REGEX_RUN_DEBUG
	37
b75a7d8f A	38	// End of #defines inteded to be directly set.
b75a7d8f A	39
b75a7d8f A	40	#include <stdio.h>
	41	#endif
	42
	43	#ifdef REGEX_SCAN_DEBUG
374ca955	44	#define REGEX_SCAN_DEBUG_PRINTF(a) printf a
b75a7d8f	45	#else
374ca955	46	#define REGEX_SCAN_DEBUG_PRINTF(a)
b75a7d8f A	47	#endif
	48
	49	#ifdef REGEX_DUMP_DEBUG
374ca955	50	#define REGEX_DUMP_DEBUG_PRINTF(a) printf a
b75a7d8f	51	#else
374ca955	52	#define REGEX_DUMP_DEBUG_PRINTF(a)
b75a7d8f A	53	#endif
	54
	55	#ifdef REGEX_RUN_DEBUG
374ca955 A	56	#define REGEX_RUN_DEBUG_PRINTF(a) printf a
374ca955 A	57	#define REGEX_DUMP_DEBUG_PRINTF(a) printf a
b75a7d8f	58	#else
374ca955	59	#define REGEX_RUN_DEBUG_PRINTF(a)
b75a7d8f A	60	#endif
	61
	62
	63	//
	64	// Opcode types In the compiled form of the regexp, these are the type, or opcodes,
	65	// of the entries.
	66	//
	67	enum {
	68	URX_RESERVED_OP = 0, // For multi-operand ops, most non-first words.
	69	URX_RESERVED_OP_N = 255, // For multi-operand ops, negative operand values.
46f4442e	70	URX_BACKTRACK = 1, // Force a backtrack, as if a match test had failed.
b75a7d8f A	71	URX_END = 2,
	72	URX_ONECHAR = 3, // Value field is the 21 bit unicode char to match
	73	URX_STRING = 4, // Value field is index of string start
	74	URX_STRING_LEN = 5, // Value field is string length (code units)
	75	URX_STATE_SAVE = 6, // Value field is pattern position to push
	76	URX_NOP = 7,
	77	URX_START_CAPTURE = 8, // Value field is capture group number.
	78	URX_END_CAPTURE = 9, // Value field is capture group number
46f4442e	79	URX_STATIC_SETREF = 10, // Value field is index of set in array of sets.
b75a7d8f	80	URX_SETREF = 11, // Value field is index of set in array of sets.
46f4442e	81	URX_DOTANY = 12,
b75a7d8f A	82	URX_JMP = 13, // Value field is destination position in
	83	// the pattern.
	84	URX_FAIL = 14, // Stop match operation, No match.
	85
	86	URX_JMP_SAV = 15, // Operand: JMP destination location
	87	URX_BACKSLASH_B = 16, // Value field: 0: \b 1: \B
46f4442e	88	URX_BACKSLASH_G = 17,
b75a7d8f A	89	URX_JMP_SAV_X = 18, // Conditional JMP_SAV,
	90	// Used in (x)+, breaks loop on zero length match.
	91	// Operand: Jmp destination.
	92	URX_BACKSLASH_X = 19,
	93	URX_BACKSLASH_Z = 20, // \z Unconditional end of line.
	94
	95	URX_DOTANY_ALL = 21, // ., in the . matches any mode.
	96	URX_BACKSLASH_D = 22, // Value field: 0: \d 1: \D
	97	URX_CARET = 23, // Value field: 1: multi-line mode.
	98	URX_DOLLAR = 24, // Also for \Z
	99
	100	URX_CTR_INIT = 25, // Counter Inits for {Interval} loops.
46f4442e	101	URX_CTR_INIT_NG = 26, // 2 kinds, normal and non-greedy.
b75a7d8f A	102	// These are 4 word opcodes. See description.
b75a7d8f A	103	// First Operand: Data loc of counter variable
46f4442e	104	// 2nd Operand: Pat loc of the URX_CTR_LOOPx
b75a7d8f A	105	// at the end of the loop.
	106	// 3rd Operand: Minimum count.
	107	// 4th Operand: Max count, -1 for unbounded.
	108
46f4442e	109	URX_DOTANY_UNIX = 27, // '.' operator in UNIX_LINES mode, only \n marks end of line.
b75a7d8f A	110
	111	URX_CTR_LOOP = 28, // Loop Ops for {interval} loops.
	112	URX_CTR_LOOP_NG = 29, // Also in three flavors.
	113	// Operand is loc of corresponding CTR_INIT.
	114
46f4442e A	115	URX_CARET_M_UNIX = 30, // '^' operator, test for start of line in multi-line
46f4442e A	116	// plus UNIX_LINES mode.
b75a7d8f A	117
	118	URX_RELOC_OPRND = 31, // Operand value in multi-operand ops that refers
	119	// back into compiled pattern code, and thus must
	120	// be relocated when inserting/deleting ops in code.
	121
	122	URX_STO_SP = 32, // Store the stack ptr. Operand is location within
	123	// matcher data (not stack data) to store it.
	124	URX_LD_SP = 33, // Load the stack pointer. Operand is location
	125	// to load from.
	126	URX_BACKREF = 34, // Back Reference. Parameter is the index of the
	127	// capture group variables in the state stack frame.
	128	URX_STO_INP_LOC = 35, // Store the input location. Operand is location
	129	// within the matcher stack frame.
	130	URX_JMPX = 36, // Conditional JMP.
	131	// First Operand: JMP target location.
46f4442e	132	// Second Operand: Data location containing an
b75a7d8f A	133	// input position. If current input position ==
	134	// saved input position, FAIL rather than taking
	135	// the JMP
	136	URX_LA_START = 37, // Starting a LookAround expression.
	137	// Save InputPos and SP in static data.
	138	// Operand: Static data offset for the save
	139	URX_LA_END = 38, // Ending a Lookaround expression.
	140	// Restore InputPos and Stack to saved values.
	141	// Operand: Static data offset for saved data.
	142	URX_ONECHAR_I = 39, // Test for case-insensitive match of a literal character.
	143	// Operand: the literal char.
	144	URX_STRING_I = 40, // Case insensitive string compare.
	145	// First Operand: Index of start of string in string literals
	146	// Second Operand (next word in compiled code):
	147	// the length of the string.
	148	URX_BACKREF_I = 41, // Case insensitive back reference.
	149	// Parameter is the index of the
	150	// capture group variables in the state stack frame.
	151	URX_DOLLAR_M = 42, // $ in multi-line mode.
	152	URX_CARET_M = 43, // ^ in multi-line mode.
	153	URX_LB_START = 44, // LookBehind Start.
	154	// Paramater is data location
	155	URX_LB_CONT = 45, // LookBehind Continue.
	156	// Param 0: the data location
	157	// Param 1: The minimum length of the look-behind match
	158	// Param 2: The max length of the look-behind match
	159	URX_LB_END = 46, // LookBehind End.
	160	// Parameter is the data location.
	161	// Check that match ended at the right spot,
	162	// Restore original input string len.
	163	URX_LBN_CONT = 47, // Negative LookBehind Continue
	164	// Param 0: the data location
	165	// Param 1: The minimum length of the look-behind match
	166	// Param 2: The max length of the look-behind match
	167	// Param 3: The pattern loc following the look-behind block.
	168	URX_LBN_END = 48, // Negative LookBehind end
	169	// Parameter is the data location.
	170	// Check that the match ended at the right spot.
46f4442e	171	URX_STAT_SETREF_N = 49, // Reference to a prebuilt set (e.g. \w), negated
b75a7d8f A	172	// Operand is index of set in array of sets.
	173	URX_LOOP_SR_I = 50, // Init a [set]* loop.
	174	// Operand is the sets index in array of user sets.
	175	URX_LOOP_C = 51, // Continue a [set]* or OneChar* loop.
	176	// Operand is a matcher static data location.
	177	// Must always immediately follow LOOP_x_I instruction.
374ca955	178	URX_LOOP_DOT_I = 52, // .*, initialization of the optimized loop.
b75a7d8f	179	// Operand value:
46f4442e A	180	// bit 0:
	181	// 0: Normal (. doesn't match new-line) mode.
	182	// 1: . matches new-line mode.
	183	// bit 1: controls what new-lines are recognized by this operation.
	184	// 0: All Unicode New-lines
	185	// 1: UNIX_LINES, \u000a only.
	186	URX_BACKSLASH_BU = 53, // \b or \B in UREGEX_UWORD mode, using Unicode style
374ca955	187	// word boundaries.
46f4442e A	188	URX_DOLLAR_D = 54, // $ end of input test, in UNIX_LINES mode.
46f4442e A	189	URX_DOLLAR_MD = 55 // $ end of input test, in MULTI_LINE and UNIX_LINES mode.
b75a7d8f	190
46f4442e	191	};
b75a7d8f A	192
	193	// Keep this list of opcode names in sync with the above enum
	194	// Used for debug printing only.
	195	#define URX_OPCODE_NAMES \
	196	" ", \
	197	"BACKTRACK", \
	198	"END", \
	199	"ONECHAR", \
	200	"STRING", \
	201	"STRING_LEN", \
	202	"STATE_SAVE", \
	203	"NOP", \
	204	"START_CAPTURE", \
	205	"END_CAPTURE", \
	206	"URX_STATIC_SETREF", \
	207	"SETREF", \
	208	"DOTANY", \
	209	"JMP", \
	210	"FAIL", \
	211	"JMP_SAV", \
	212	"BACKSLASH_B", \
	213	"BACKSLASH_G", \
	214	"JMP_SAV_X", \
	215	"BACKSLASH_X", \
	216	"BACKSLASH_Z", \
	217	"DOTANY_ALL", \
	218	"BACKSLASH_D", \
	219	"CARET", \
	220	"DOLLAR", \
	221	"CTR_INIT", \
	222	"CTR_INIT_NG", \
46f4442e	223	"DOTANY_UNIX", \
b75a7d8f A	224	"CTR_LOOP", \
b75a7d8f A	225	"CTR_LOOP_NG", \
46f4442e	226	"URX_CARET_M_UNIX", \
b75a7d8f A	227	"RELOC_OPRND", \
	228	"STO_SP", \
	229	"LD_SP", \
	230	"BACKREF", \
	231	"STO_INP_LOC", \
	232	"JMPX", \
	233	"LA_START", \
	234	"LA_END", \
	235	"ONECHAR_I", \
	236	"STRING_I", \
	237	"BACKREF_I", \
	238	"DOLLAR_M", \
	239	"CARET_M", \
	240	"LB_START", \
	241	"LB_CONT", \
	242	"LB_END", \
	243	"LBN_CONT", \
	244	"LBN_END", \
	245	"STAT_SETREF_N", \
	246	"LOOP_SR_I", \
	247	"LOOP_C", \
374ca955	248	"LOOP_DOT_I", \
46f4442e A	249	"BACKSLASH_BU", \
	250	"DOLLAR_D", \
	251	"DOLLAR_MD"
b75a7d8f A	252
	253
	254	//
	255	// Convenience macros for assembling and disassembling a compiled operation.
	256	//
	257	#define URX_BUILD(type, val) (int32_t)((type << 24) \| (val))
46f4442e	258	#define URX_TYPE(x) ((uint32_t)(x) >> 24)
b75a7d8f A	259	#define URX_VAL(x) ((x) & 0xffffff)
b75a7d8f A	260
46f4442e	261
b75a7d8f A	262	//
	263	// Access to Unicode Sets composite character properties
	264	// The sets are accessed by the match engine for things like \w (word boundary)
46f4442e	265	//
b75a7d8f A	266	enum {
	267	URX_ISWORD_SET = 1,
	268	URX_ISALNUM_SET = 2,
	269	URX_ISALPHA_SET = 3,
	270	URX_ISSPACE_SET = 4,
	271
	272	URX_GC_NORMAL, // Sets for finding grapheme cluster boundaries.
	273	URX_GC_EXTEND,
	274	URX_GC_CONTROL,
	275	URX_GC_L,
	276	URX_GC_LV,
	277	URX_GC_LVT,
	278	URX_GC_V,
	279	URX_GC_T,
	280
	281	URX_LAST_SET,
	282
	283	URX_NEG_SET = 0x800000 // Flag bit to reverse sense of set
	284	// membership test.
	285	};
	286
	287
	288	//
	289	// Match Engine State Stack Frame Layout.
	290	//
	291	struct REStackFrame {
729e4ab9 A	292	// Header
	293	int64_t fInputIdx; // Position of next character in the input string
	294	int64_t fPatIdx; // Position of next Op in the compiled pattern
	295	// (int64_t for UVector64, values fit in an int32_t)
	296	// Remainder
	297	int64_t fExtra[1]; // Extra state, for capture group start/ends
b75a7d8f A	298	// atomic parentheses, repeat counts, etc.
b75a7d8f A	299	// Locations assigned at pattern compile time.
729e4ab9	300	// Variable-length array.
b75a7d8f	301	};
729e4ab9 A	302	// number of UVector elements in the header
729e4ab9 A	303	#define RESTACKFRAME_HDRCOUNT 2
b75a7d8f A	304
	305	//
	306	// Start-Of-Match type. Used by find() to quickly scan to positions where a
	307	// match might start before firing up the full match engine.
	308	//
	309	enum StartOfMatch {
	310	START_NO_INFO, // No hint available.
	311	START_CHAR, // Match starts with a literal code point.
	312	START_SET, // Match starts with something matching a set.
	313	START_START, // Match starts at start of buffer only (^ or \A)
	314	START_LINE, // Match starts with ^ in multi-line mode.
	315	START_STRING // Match starts with a literal string.
	316	};
	317
	318	#define START_OF_MATCH_STR(v) ((v)==START_NO_INFO? "START_NO_INFO" : \
	319	(v)==START_CHAR? "START_CHAR" : \
	320	(v)==START_SET? "START_SET" : \
	321	(v)==START_START? "START_START" : \
	322	(v)==START_LINE? "START_LINE" : \
	323	(v)==START_STRING? "START_STRING" : \
	324	"ILLEGAL")
46f4442e	325
b75a7d8f A	326	//
	327	// 8 bit set, to fast-path latin-1 set membership tests.
	328	//
	329	struct Regex8BitSet : public UMemory {
	330	inline Regex8BitSet();
	331	inline void operator = (const Regex8BitSet &s);
	332	inline void init(const UnicodeSet *src);
	333	inline UBool contains(UChar32 c);
	334	inline void add(UChar32 c);
	335	int8_t d[32];
	336	};
	337
	338	inline Regex8BitSet::Regex8BitSet() {
	339	uprv_memset(d, 0, sizeof(d));
	340	}
	341
	342	inline UBool Regex8BitSet::contains(UChar32 c) {
	343	// No bounds checking! This is deliberate.
	344	return ((d[c>>3] & 1 <<(c&7)) != 0);
73c04bcf	345	}
b75a7d8f A	346
	347	inline void Regex8BitSet::add(UChar32 c) {
	348	d[c>>3] \|= 1 << (c&7);
73c04bcf	349	}
b75a7d8f A	350
	351	inline void Regex8BitSet::init(const UnicodeSet *s) {
	352	if (s != NULL) {
73c04bcf	353	for (int32_t i=0; i<=255; i++) {
b75a7d8f A	354	if (s->contains(i)) {
	355	this->add(i);
	356	}
	357	}
	358	}
	359	}
	360
	361	inline void Regex8BitSet::operator = (const Regex8BitSet &s) {
	362	uprv_memcpy(d, s.d, sizeof(d));
	363	}
	364
4388f060 A	365
	366	// Case folded UText Iterator helper class.
	367	// Wraps a UText, provides a case-folded enumeration over its contents.
	368	// Used in implementing case insensitive matching constructs.
	369	// Implementation in rematch.cpp
	370
	371	class CaseFoldingUTextIterator: public UMemory {
	372	public:
	373	CaseFoldingUTextIterator(UText &text);
	374	~CaseFoldingUTextIterator();
	375
	376	UChar32 next(); // Next case folded character
	377
	378	UBool inExpansion(); // True if last char returned from next() and the
	379	// next to be returned both originated from a string
	380	// folding of the same code point from the orignal UText.
	381	private:
	382	UText &fUText;
	383	const UCaseProps *fcsp;
	384	const UChar *fFoldChars;
	385	int32_t fFoldLength;
	386	int32_t fFoldIndex;
	387
	388	};
	389
	390
	391	// Case folded UChar * string iterator.
	392	// Wraps a UChar *, provides a case-folded enumeration over its contents.
	393	// Used in implementing case insensitive matching constructs.
	394	// Implementation in rematch.cpp
	395
	396	class CaseFoldingUCharIterator: public UMemory {
	397	public:
	398	CaseFoldingUCharIterator(const UChar *chars, int64_t start, int64_t limit);
	399	~CaseFoldingUCharIterator();
	400
	401	UChar32 next(); // Next case folded character
	402
	403	UBool inExpansion(); // True if last char returned from next() and the
	404	// next to be returned both originated from a string
	405	// folding of the same code point from the orignal UText.
	406
	407	int64_t getIndex(); // Return the current input buffer index.
	408
	409	private:
	410	const UChar *fChars;
	411	int64_t fIndex;
	412	int64_t fLimit;
	413	const UCaseProps *fcsp;
	414	const UChar *fFoldChars;
	415	int32_t fFoldLength;
	416	int32_t fFoldIndex;
	417
	418	};
	419
b75a7d8f A	420	U_NAMESPACE_END
	421	#endif
	422