regexp.h

   1 /*    regexp.h
   2  *
   3  *    Copyright (C) 1993, 1994, 1996, 1997, 1999, 2000, 2001, 2003,
   4  *    2005, 2006 by Larry Wall and others
   5  *
   6  *    You may distribute under the terms of either the GNU General Public
   7  *    License or the Artistic License, as specified in the README file.
   8  *
   9  */
  10
  11 /*
  12  * Definitions etc. for regexp(3) routines.
  13  *
  14  * Caveat:  this is V8 regexp(3) [actually, a reimplementation thereof],
  15  * not the System V one.
  16  */
  17 #ifndef PLUGGABLE_RE_EXTENSION
  18 /* we don't want to include this stuff if we are inside of
  19    an external regex engine based on the core one - like re 'debug'*/
  20
  21 struct regnode {
  22     U8  flags;
  23     U8  type;
  24     U16 next_off;
  25 };
  26
  27 typedef struct regnode regnode;
  28
  29 struct reg_substr_data;
  30
  31 struct reg_data;
  32
  33 struct regexp_engine;
  34 struct regexp;
  35
  36 struct reg_substr_datum {
  37     I32 min_offset;
  38     I32 max_offset;
  39     SV *substr;         /* non-utf8 variant */
  40     SV *utf8_substr;    /* utf8 variant */
  41     I32 end_shift;
  42 };
  43 struct reg_substr_data {
  44     struct reg_substr_datum data[3];    /* Actual array */
  45 };
  46
  47 #ifdef PERL_OLD_COPY_ON_WRITE
  48 #define SV_SAVED_COPY   SV *saved_copy; /* If non-NULL, SV which is COW from original */
  49 #else
  50 #define SV_SAVED_COPY
  51 #endif
  52
  53 typedef struct regexp_paren_pair {
  54     I32 start;
  55     I32 end;
  56 } regexp_paren_pair;
  57
  58 /*
  59   The regexp/REGEXP struct, see L<perlreapi> for further documentation
  60   on the individual fields. The struct is ordered so that the most
  61   commonly used fields are placed at the start.
  62
  63   Any patch that adds items to this struct will need to include
  64   changes to F<sv.c> (C<Perl_re_dup()>) and F<regcomp.c>
  65   (C<pregfree()>). This involves freeing or cloning items in the
  66   regexp's data array based on the data item's type.
  67 */
  68
  69 typedef struct regexp {
  70         /* what engine created this regexp? */
  71         const struct regexp_engine* engine;
  72         struct regexp* mother_re; /* what re is this a lightweight copy of? */
  73
  74         /* Information about the match that the perl core uses to manage things */
  75         U32 extflags;           /* Flags used both externally and internally */
  76         I32 minlen;             /* mininum possible length of string to match */
  77         I32 minlenret;          /* mininum possible length of $& */
  78         U32 gofs;               /* chars left of pos that we search from */
  79         struct reg_substr_data *substrs; /* substring data about strings that must appear
  80                                    in the final match, used for optimisations */
  81         U32 nparens;            /* number of capture buffers */
  82
  83         /* private engine specific data */
  84         U32 intflags;           /* Engine Specific Internal flags */
  85         void *pprivate;         /* Data private to the regex engine which
  86                                    created this object. */
  87
  88         /* Data about the last/current match. These are modified during matching*/
  89         U32 lastparen;          /* last open paren matched */
  90         U32 lastcloseparen;     /* last close paren matched */
  91         regexp_paren_pair *swap;  /* Swap copy of *offs */
  92         regexp_paren_pair *offs;  /* Array of offsets for (@-) and (@+) */
  93
  94         char *subbeg;           /* saved or original string
  95                                    so \digit works forever. */
  96         SV_SAVED_COPY           /* If non-NULL, SV which is COW from original */
  97         I32 sublen;             /* Length of string pointed by subbeg */
  98
  99
 100         /* Information about the match that isn't often used */
 101         I32 prelen;             /* length of precomp */
 102         const char *precomp;    /* pre-compilation regular expression */
 103         /* wrapped can't be const char*, as it is returned by sv_2pv_flags */
 104         char *wrapped;          /* wrapped version of the pattern */
 105         I32 wraplen;            /* length of wrapped */
 106         I32 seen_evals;         /* number of eval groups in the pattern - for security checks */
 107         HV *paren_names;        /* Optional hash of paren names */
 108
 109         /* Refcount of this regexp */
 110         I32 refcnt;             /* Refcount of this regexp */
 111 } regexp;
 112
 113 /* used for high speed searches */
 114 typedef struct re_scream_pos_data_s
 115 {
 116     char **scream_olds;         /* match pos */
 117     I32 *scream_pos;            /* Internal iterator of scream. */
 118 } re_scream_pos_data;
 119
 120 /* regexp_engine structure. This is the dispatch table for regexes.
 121  * Any regex engine implementation must be able to build one of these.
 122  */
 123 typedef struct regexp_engine {
 124     REGEXP* (*comp) (pTHX_ const SV * const pattern, const U32 flags);
 125     I32     (*exec) (pTHX_ REGEXP * const rx, char* stringarg, char* strend,
 126                      char* strbeg, I32 minend, SV* screamer,
 127                      void* data, U32 flags);
 128     char*   (*intuit) (pTHX_ REGEXP * const rx, SV *sv, char *strpos,
 129                        char *strend, const U32 flags,
 130                        re_scream_pos_data *data);
 131     SV*     (*checkstr) (pTHX_ REGEXP * const rx);
 132     void    (*free) (pTHX_ REGEXP * const rx);
 133     void    (*numbered_buff_FETCH) (pTHX_ REGEXP * const rx, const I32 paren,
 134                                     SV * const sv);
 135     void    (*numbered_buff_STORE) (pTHX_ REGEXP * const rx, const I32 paren,
 136                                    SV const * const value);
 137     I32     (*numbered_buff_LENGTH) (pTHX_ REGEXP * const rx, const SV * const sv,
 138                                     const I32 paren);
 139     SV*     (*named_buff) (pTHX_ REGEXP * const rx, SV * const key,
 140                            SV * const value, const U32 flags);
 141     SV*     (*named_buff_iter) (pTHX_ REGEXP * const rx, const SV * const lastkey,
 142                                 const U32 flags);
 143     SV*     (*qr_package)(pTHX_ REGEXP * const rx);
 144 #ifdef USE_ITHREADS
 145     void*   (*dupe) (pTHX_ REGEXP * const rx, CLONE_PARAMS *param);
 146 #endif
 147 } regexp_engine;
 148
 149 /*
 150   These are passed to the numbered capture variable callbacks as the
 151   paren name. >= 1 is reserved for actual numbered captures, i.e. $1,
 152   $2 etc.
 153 */
 154 #define RX_BUFF_IDX_PREMATCH  -2 /* $` / ${^PREMATCH}  */
 155 #define RX_BUFF_IDX_POSTMATCH -1 /* $' / ${^POSTMATCH} */
 156 #define RX_BUFF_IDX_FULLMATCH      0 /* $& / ${^MATCH}     */
 157
 158 /*
 159   Flags that are passed to the named_buff and named_buff_iter
 160   callbacks above. Those routines are called from universal.c via the
 161   Tie::Hash::NamedCapture interface for %+ and %- and the re::
 162   functions in the same file.
 163 */
 164
 165 /* The Tie::Hash::NamedCapture operation this is part of, if any */
 166 #define RXapif_FETCH     0x0001
 167 #define RXapif_STORE     0x0002
 168 #define RXapif_DELETE    0x0004
 169 #define RXapif_CLEAR     0x0008
 170 #define RXapif_EXISTS    0x0010
 171 #define RXapif_SCALAR    0x0020
 172 #define RXapif_FIRSTKEY  0x0040
 173 #define RXapif_NEXTKEY   0x0080
 174
 175 /* Whether %+ or %- is being operated on */
 176 #define RXapif_ONE       0x0100 /* %+ */
 177 #define RXapif_ALL       0x0200 /* %- */
 178
 179 /* Whether this is being called from a re:: function */
 180 #define RXapif_REGNAME         0x0400
 181 #define RXapif_REGNAMES        0x0800
 182 #define RXapif_REGNAMES_COUNT  0x1000
 183
 184 /*
 185 =head1 REGEXP Functions
 186
 187 =for apidoc Am|REGEXP *|SvRX|SV *sv
 188
 189 Convenience macro to get the REGEXP from a SV. This is approximately
 190 equivalent to the following snippet:
 191
 192     if (SvMAGICAL(sv))
 193         mg_get(sv);
 194     if (SvROK(sv) &&
 195         (tmpsv = (SV*)SvRV(sv)) &&
 196         SvTYPE(tmpsv) == SVt_PVMG &&
 197         (tmpmg = mg_find(tmpsv, PERL_MAGIC_qr)))
 198     {
 199         return (REGEXP *)tmpmg->mg_obj;
 200     }
 201
 202 NULL will be returned if a REGEXP* is not found.
 203
 204 =for apidoc Am|bool|SvRXOK|SV* sv
 205
 206 Returns a boolean indicating whether the SV contains qr magic
 207 (PERL_MAGIC_qr).
 208
 209 If you want to do something with the REGEXP* later use SvRX instead
 210 and check for NULL.
 211
 212 =cut
 213 */
 214
 215 #define SvRX(sv)   (Perl_get_re_arg(aTHX_ sv))
 216 #define SvRXOK(sv) (Perl_get_re_arg(aTHX_ sv) ? TRUE : FALSE)
 217
 218
 219 /* Flags stored in regexp->extflags
 220  * These are used by code external to the regexp engine
 221  *
 222  * Note that flags starting with RXf_PMf_ have exact equivalents
 223  * stored in op_pmflags and which are defined in op.h, they are defined
 224  * numerically here only for clarity.
 225  */
 226
 227 /* Anchor and GPOS related stuff */
 228 #define RXf_ANCH_BOL            0x00000001
 229 #define RXf_ANCH_MBOL           0x00000002
 230 #define RXf_ANCH_SBOL           0x00000004
 231 #define RXf_ANCH_GPOS           0x00000008
 232 #define RXf_GPOS_SEEN           0x00000010
 233 #define RXf_GPOS_FLOAT          0x00000020
 234 /* two bits here */
 235 #define RXf_ANCH                (RXf_ANCH_BOL|RXf_ANCH_MBOL|RXf_ANCH_GPOS|RXf_ANCH_SBOL)
 236 #define RXf_GPOS_CHECK          (RXf_GPOS_SEEN|RXf_ANCH_GPOS)
 237 #define RXf_ANCH_SINGLE         (RXf_ANCH_SBOL|RXf_ANCH_GPOS)
 238
 239 /* Flags indicating special patterns */
 240 #define RXf_SKIPWHITE           0x00000100 /* Pattern is for a split / / */
 241 #define RXf_START_ONLY          0x00000200 /* Pattern is /^/ */
 242 #define RXf_WHITE               0x00000400 /* Pattern is /\s+/ */
 243 #define RXf_NULL                0x40000000 /* Pattern is // */
 244
 245 /* 0x1F800 of extflags is used by (RXf_)PMf_COMPILETIME */
 246 #define RXf_PMf_LOCALE          0x00000800 /* use locale */
 247 #define RXf_PMf_MULTILINE       0x00001000 /* /m         */
 248 #define RXf_PMf_SINGLELINE      0x00002000 /* /s         */
 249 #define RXf_PMf_FOLD            0x00004000 /* /i         */
 250 #define RXf_PMf_EXTENDED        0x00008000 /* /x         */
 251 #define RXf_PMf_KEEPCOPY        0x00010000 /* /p         */
 252 /* these flags are transfered from the PMOP->op_pmflags member during compilation */
 253 #define RXf_PMf_STD_PMMOD       (RXf_PMf_MULTILINE|RXf_PMf_SINGLELINE|RXf_PMf_FOLD|RXf_PMf_EXTENDED)
 254 #define RXf_PMf_COMPILETIME     (RXf_PMf_MULTILINE|RXf_PMf_SINGLELINE|RXf_PMf_LOCALE|RXf_PMf_FOLD|RXf_PMf_EXTENDED|RXf_PMf_KEEPCOPY)
 255
 256 #define CASE_STD_PMMOD_FLAGS_PARSE_SET(pmfl)                        \
 257     case IGNORE_PAT_MOD:    *(pmfl) |= RXf_PMf_FOLD;       break;   \
 258     case MULTILINE_PAT_MOD: *(pmfl) |= RXf_PMf_MULTILINE;  break;   \
 259     case SINGLE_PAT_MOD:    *(pmfl) |= RXf_PMf_SINGLELINE; break;   \
 260     case XTENDED_PAT_MOD:   *(pmfl) |= RXf_PMf_EXTENDED;   break
 261
 262 /* chars and strings used as regex pattern modifiers
 263  * Singlular is a 'c'har, plural is a "string"
 264  *
 265  * NOTE, KEEPCOPY was originally 'k', but was changed to 'p' for preserve
 266  * for compatibility reasons with Regexp::Common which highjacked (?k:...)
 267  * for its own uses. So 'k' is out as well.
 268  */
 269 #define EXEC_PAT_MOD         'e'
 270 #define KEEPCOPY_PAT_MOD     'p'
 271 #define ONCE_PAT_MOD         'o'
 272 #define GLOBAL_PAT_MOD       'g'
 273 #define CONTINUE_PAT_MOD     'c'
 274 #define MULTILINE_PAT_MOD    'm'
 275 #define SINGLE_PAT_MOD       's'
 276 #define IGNORE_PAT_MOD       'i'
 277 #define XTENDED_PAT_MOD      'x'
 278
 279 #define ONCE_PAT_MODS        "o"
 280 #define KEEPCOPY_PAT_MODS    "p"
 281 #define EXEC_PAT_MODS        "e"
 282 #define LOOP_PAT_MODS        "gc"
 283
 284 #define STD_PAT_MODS        "msix"
 285
 286 #define INT_PAT_MODS    STD_PAT_MODS    KEEPCOPY_PAT_MODS
 287
 288 #define EXT_PAT_MODS    ONCE_PAT_MODS   KEEPCOPY_PAT_MODS
 289 #define QR_PAT_MODS     STD_PAT_MODS    EXT_PAT_MODS
 290 #define M_PAT_MODS      QR_PAT_MODS     LOOP_PAT_MODS
 291 #define S_PAT_MODS      M_PAT_MODS      EXEC_PAT_MODS
 292
 293
 294 /* What we have seen */
 295 #define RXf_LOOKBEHIND_SEEN     0x00020000
 296 #define RXf_EVAL_SEEN           0x00040000
 297 #define RXf_CANY_SEEN           0x00080000
 298
 299 /* Special */
 300 #define RXf_NOSCAN              0x00100000
 301 #define RXf_CHECK_ALL           0x00200000
 302
 303 /* UTF8 related */
 304 #define RXf_UTF8                0x00400000
 305 #define RXf_MATCH_UTF8          0x00800000
 306
 307 /* Intuit related */
 308 #define RXf_USE_INTUIT_NOML     0x01000000
 309 #define RXf_USE_INTUIT_ML       0x02000000
 310 #define RXf_INTUIT_TAIL         0x04000000
 311
 312 /*
 313   Set in Perl_pmruntime if op_flags & OPf_SPECIAL, i.e. split. Will
 314   be used by regex engines to check whether they should set
 315   RXf_SKIPWHITE
 316 */
 317 #define RXf_SPLIT           0x08000000
 318
 319 #define RXf_USE_INTUIT          (RXf_USE_INTUIT_NOML|RXf_USE_INTUIT_ML)
 320
 321 /* Copy and tainted info */
 322 #define RXf_COPY_DONE           0x10000000
 323 #define RXf_TAINTED_SEEN        0x20000000
 324 #define RXf_TAINTED             0x80000000 /* this pattern is tainted */
 325
 326
 327 #define RX_HAS_CUTGROUP(prog) ((prog)->intflags & PREGf_CUTGROUP_SEEN)
 328 #define RX_MATCH_TAINTED(prog)  ((prog)->extflags & RXf_TAINTED_SEEN)
 329 #define RX_MATCH_TAINTED_on(prog) ((prog)->extflags |= RXf_TAINTED_SEEN)
 330 #define RX_MATCH_TAINTED_off(prog) ((prog)->extflags &= ~RXf_TAINTED_SEEN)
 331 #define RX_MATCH_TAINTED_set(prog, t) ((t) \
 332                                        ? RX_MATCH_TAINTED_on(prog) \
 333                                        : RX_MATCH_TAINTED_off(prog))
 334
 335 #define RX_MATCH_COPIED(prog)           ((prog)->extflags & RXf_COPY_DONE)
 336 #define RX_MATCH_COPIED_on(prog)        ((prog)->extflags |= RXf_COPY_DONE)
 337 #define RX_MATCH_COPIED_off(prog)       ((prog)->extflags &= ~RXf_COPY_DONE)
 338 #define RX_MATCH_COPIED_set(prog,t)     ((t) \
 339                                          ? RX_MATCH_COPIED_on(prog) \
 340                                          : RX_MATCH_COPIED_off(prog))
 341
 342 #endif /* PLUGGABLE_RE_EXTENSION */
 343
 344 /* Stuff that needs to be included in the plugable extension goes below here */
 345
 346 #ifdef PERL_OLD_COPY_ON_WRITE
 347 #define RX_MATCH_COPY_FREE(rx) \
 348         STMT_START {if (rx->saved_copy) { \
 349             SV_CHECK_THINKFIRST_COW_DROP(rx->saved_copy); \
 350         } \
 351         if (RX_MATCH_COPIED(rx)) { \
 352             Safefree(rx->subbeg); \
 353             RX_MATCH_COPIED_off(rx); \
 354         }} STMT_END
 355 #else
 356 #define RX_MATCH_COPY_FREE(rx) \
 357         STMT_START {if (RX_MATCH_COPIED(rx)) { \
 358             Safefree(rx->subbeg); \
 359             RX_MATCH_COPIED_off(rx); \
 360         }} STMT_END
 361 #endif
 362
 363 #define RX_MATCH_UTF8(prog)             ((prog)->extflags & RXf_MATCH_UTF8)
 364 #define RX_MATCH_UTF8_on(prog)          ((prog)->extflags |= RXf_MATCH_UTF8)
 365 #define RX_MATCH_UTF8_off(prog)         ((prog)->extflags &= ~RXf_MATCH_UTF8)
 366 #define RX_MATCH_UTF8_set(prog, t)      ((t) \
 367                         ? (RX_MATCH_UTF8_on(prog), (PL_reg_match_utf8 = 1)) \
 368                         : (RX_MATCH_UTF8_off(prog), (PL_reg_match_utf8 = 0)))
 369
 370 #define REXEC_COPY_STR  0x01            /* Need to copy the string. */
 371 #define REXEC_CHECKED   0x02            /* check_substr already checked. */
 372 #define REXEC_SCREAM    0x04            /* use scream table. */
 373 #define REXEC_IGNOREPOS 0x08            /* \G matches at start. */
 374 #define REXEC_NOT_FIRST 0x10            /* This is another iteration of //g. */
 375
 376 #define ReREFCNT_inc(re) ((void)(re && re->refcnt++), re)
 377 #define ReREFCNT_dec(re) CALLREGFREE(re)
 378
 379 #define FBMcf_TAIL_DOLLAR       1
 380 #define FBMcf_TAIL_DOLLARM      2
 381 #define FBMcf_TAIL_Z            4
 382 #define FBMcf_TAIL_z            8
 383 #define FBMcf_TAIL              (FBMcf_TAIL_DOLLAR|FBMcf_TAIL_DOLLARM|FBMcf_TAIL_Z|FBMcf_TAIL_z)
 384
 385 #define FBMrf_MULTILINE 1
 386
 387 /* an accepting state/position*/
 388 struct _reg_trie_accepted {
 389     U8   *endpos;
 390     U16  wordnum;
 391 };
 392 typedef struct _reg_trie_accepted reg_trie_accepted;
 393
 394 /* some basic information about the current match that is created by
 395  * Perl_regexec_flags and then passed to regtry(), regmatch() etc */
 396
 397 typedef struct {
 398     regexp *prog;
 399     char *bol;
 400     char *till;
 401     SV *sv;
 402     char *ganch;
 403     char *cutpoint;
 404 } regmatch_info;
 405
 406
 407 /* structures for holding and saving the state maintained by regmatch() */
 408
 409 #ifndef MAX_RECURSE_EVAL_NOCHANGE_DEPTH
 410 #define MAX_RECURSE_EVAL_NOCHANGE_DEPTH 1000
 411 #endif
 412
 413 typedef I32 CHECKPOINT;
 414
 415 typedef struct regmatch_state {
 416     int resume_state;           /* where to jump to on return */
 417     char *locinput;             /* where to backtrack in string on failure */
 418
 419     union {
 420
 421         /* this is a fake union member that matches the first element
 422          * of each member that needs to store positive backtrack
 423          * information */
 424         struct {
 425             struct regmatch_state *prev_yes_state;
 426         } yes;
 427
 428         /* branchlike members */
 429         /* this is a fake union member that matches the first elements
 430          * of each member that needs to behave like a branch */
 431         struct {
 432             /* this first element must match u.yes */
 433             struct regmatch_state *prev_yes_state;
 434             U32 lastparen;
 435             CHECKPOINT cp;
 436
 437         } branchlike;
 438
 439         struct {
 440             /* the first elements must match u.branchlike */
 441             struct regmatch_state *prev_yes_state;
 442             U32 lastparen;
 443             CHECKPOINT cp;
 444
 445             regnode *next_branch; /* next branch node */
 446         } branch;
 447
 448         struct {
 449             /* the first elements must match u.branchlike */
 450             struct regmatch_state *prev_yes_state;
 451             U32 lastparen;
 452             CHECKPOINT cp;
 453
 454             reg_trie_accepted *accept_buff; /* accepting states we have seen */
 455             U32         accepted; /* how many accepting states we have seen */
 456             U16         *jump;  /* positive offsets from me */
 457             regnode     *B;     /* node following the trie */
 458             regnode     *me;    /* Which node am I - needed for jump tries*/
 459         } trie;
 460
 461         /* special types - these members are used to store state for special
 462            regops like eval, if/then, lookaround and the markpoint state */
 463         struct {
 464             /* this first element must match u.yes */
 465             struct regmatch_state *prev_yes_state;
 466             struct regmatch_state *prev_eval;
 467             struct regmatch_state *prev_curlyx;
 468             regexp      *prev_rex;
 469             U32         toggle_reg_flags; /* what bits in PL_reg_flags to
 470                                             flip when transitioning between
 471                                             inner and outer rexen */
 472             CHECKPOINT  cp;     /* remember current savestack indexes */
 473             CHECKPOINT  lastcp;
 474             U32        close_paren; /* which close bracket is our end */
 475             regnode     *B;     /* the node following us  */
 476         } eval;
 477
 478         struct {
 479             /* this first element must match u.yes */
 480             struct regmatch_state *prev_yes_state;
 481             I32 wanted;
 482             I32 logical;        /* saved copy of 'logical' var */
 483             regnode  *me; /* the IFMATCH/SUSPEND/UNLESSM node  */
 484         } ifmatch; /* and SUSPEND/UNLESSM */
 485
 486         struct {
 487             /* this first element must match u.yes */
 488             struct regmatch_state *prev_yes_state;
 489             struct regmatch_state *prev_mark;
 490             SV* mark_name;
 491             char *mark_loc;
 492         } mark;
 493
 494         struct {
 495             int val;
 496         } keeper;
 497
 498         /* quantifiers - these members are used for storing state for
 499            for the regops used to implement quantifiers */
 500         struct {
 501             /* this first element must match u.yes */
 502             struct regmatch_state *prev_yes_state;
 503             struct regmatch_state *prev_curlyx; /* previous cur_curlyx */
 504             regnode     *A, *B; /* the nodes corresponding to /A*B/  */
 505             CHECKPOINT  cp;     /* remember current savestack index */
 506             bool        minmod;
 507             int         parenfloor;/* how far back to strip paren data */
 508             int         min;    /* the minimal number of A's to match */
 509             int         max;    /* the maximal number of A's to match */
 510
 511             /* these two are modified by WHILEM */
 512             int         count;  /* how many instances of A we've matched */
 513             char        *lastloc;/* where previous A matched (0-len detect) */
 514         } curlyx;
 515
 516         struct {
 517             /* this first element must match u.yes */
 518             struct regmatch_state *prev_yes_state;
 519             struct regmatch_state *save_curlyx;
 520             CHECKPOINT  cp;     /* remember current savestack indexes */
 521             CHECKPOINT  lastcp;
 522             char        *save_lastloc;  /* previous curlyx.lastloc */
 523             I32         cache_offset;
 524             I32         cache_mask;
 525         } whilem;
 526
 527         struct {
 528             /* this first element must match u.yes */
 529             struct regmatch_state *prev_yes_state;
 530             I32 c1, c2;         /* case fold search */
 531             CHECKPOINT cp;
 532             I32 alen;           /* length of first-matched A string */
 533             I32 count;
 534             bool minmod;
 535             regnode *A, *B;     /* the nodes corresponding to /A*B/  */
 536             regnode *me;        /* the curlym node */
 537         } curlym;
 538
 539         struct {
 540             U32 paren;
 541             CHECKPOINT cp;
 542             I32 c1, c2;         /* case fold search */
 543             char *maxpos;       /* highest possible point in string to match */
 544             char *oldloc;       /* the previous locinput */
 545             int count;
 546             int min, max;       /* {m,n} */
 547             regnode *A, *B;     /* the nodes corresponding to /A*B/  */
 548         } curly; /* and CURLYN/PLUS/STAR */
 549
 550     } u;
 551 } regmatch_state;
 552
 553 /* how many regmatch_state structs to allocate as a single slab.
 554  * We do it in 4K blocks for efficiency. The "3" is 2 for the next/prev
 555  * pointers, plus 1 for any mythical malloc overhead. */
 556
 557 #define PERL_REGMATCH_SLAB_SLOTS \
 558     ((4096 - 3 * sizeof (void*)) / sizeof(regmatch_state))
 559
 560 typedef struct regmatch_slab {
 561     regmatch_state states[PERL_REGMATCH_SLAB_SLOTS];
 562     struct regmatch_slab *prev, *next;
 563 } regmatch_slab;
 564
 565 #define PL_reg_flags            PL_reg_state.re_state_reg_flags
 566 #define PL_bostr                PL_reg_state.re_state_bostr
 567 #define PL_reginput             PL_reg_state.re_state_reginput
 568 #define PL_regeol               PL_reg_state.re_state_regeol
 569 #define PL_regoffs              PL_reg_state.re_state_regoffs
 570 #define PL_reglastparen         PL_reg_state.re_state_reglastparen
 571 #define PL_reglastcloseparen    PL_reg_state.re_state_reglastcloseparen
 572 #define PL_reg_start_tmp        PL_reg_state.re_state_reg_start_tmp
 573 #define PL_reg_start_tmpl       PL_reg_state.re_state_reg_start_tmpl
 574 #define PL_reg_eval_set         PL_reg_state.re_state_reg_eval_set
 575 #define PL_reg_match_utf8       PL_reg_state.re_state_reg_match_utf8
 576 #define PL_reg_magic            PL_reg_state.re_state_reg_magic
 577 #define PL_reg_oldpos           PL_reg_state.re_state_reg_oldpos
 578 #define PL_reg_oldcurpm         PL_reg_state.re_state_reg_oldcurpm
 579 #define PL_reg_curpm            PL_reg_state.re_state_reg_curpm
 580 #define PL_reg_oldsaved         PL_reg_state.re_state_reg_oldsaved
 581 #define PL_reg_oldsavedlen      PL_reg_state.re_state_reg_oldsavedlen
 582 #define PL_reg_maxiter          PL_reg_state.re_state_reg_maxiter
 583 #define PL_reg_leftiter         PL_reg_state.re_state_reg_leftiter
 584 #define PL_reg_poscache         PL_reg_state.re_state_reg_poscache
 585 #define PL_reg_poscache_size    PL_reg_state.re_state_reg_poscache_size
 586 #define PL_regsize              PL_reg_state.re_state_regsize
 587 #define PL_reg_starttry         PL_reg_state.re_state_reg_starttry
 588 #define PL_nrs                  PL_reg_state.re_state_nrs
 589
 590 struct re_save_state {
 591     U32 re_state_reg_flags;             /* from regexec.c */
 592     U32 re_state_reg_start_tmpl;        /* from regexec.c */
 593     I32 re_state_reg_eval_set;          /* from regexec.c */
 594     bool re_state_reg_match_utf8;       /* from regexec.c */
 595     char *re_state_bostr;
 596     char *re_state_reginput;            /* String-input pointer. */
 597     char *re_state_regeol;              /* End of input, for $ check. */
 598     regexp_paren_pair *re_state_regoffs;  /* Pointer to start/end pairs */
 599     U32 *re_state_reglastparen;         /* Similarly for lastparen. */
 600     U32 *re_state_reglastcloseparen;    /* Similarly for lastcloseparen. */
 601     char **re_state_reg_start_tmp;      /* from regexec.c */
 602     MAGIC *re_state_reg_magic;          /* from regexec.c */
 603     PMOP *re_state_reg_oldcurpm;        /* from regexec.c */
 604     PMOP *re_state_reg_curpm;           /* from regexec.c */
 605     char *re_state_reg_oldsaved;        /* old saved substr during match */
 606     STRLEN re_state_reg_oldsavedlen;    /* old length of saved substr during match */
 607     STRLEN re_state_reg_poscache_size;  /* size of pos cache of WHILEM */
 608     I32 re_state_reg_oldpos;            /* from regexec.c */
 609     I32 re_state_reg_maxiter;           /* max wait until caching pos */
 610     I32 re_state_reg_leftiter;          /* wait until caching pos */
 611     U32 re_state_regsize;               /* from regexec.c */
 612     char *re_state_reg_poscache;        /* cache of pos of WHILEM */
 613     char *re_state_reg_starttry;        /* from regexec.c */
 614 #ifdef PERL_OLD_COPY_ON_WRITE
 615     SV *re_state_nrs;                   /* was placeholder: unused since 5.8.0 (5.7.2 patch #12027 for bug ID 20010815.012). Used to save rx->saved_copy */
 616 #endif
 617 };
 618
 619 #define SAVESTACK_ALLOC_FOR_RE_SAVE_STATE \
 620         (1 + ((sizeof(struct re_save_state) - 1) / sizeof(*PL_savestack)))
 621
 622 /*
 623  * Local variables:
 624  * c-indentation-style: bsd
 625  * c-basic-offset: 4
 626  * indent-tabs-mode: t
 627  * End:
 628  *
 629  * ex: set ts=8 sts=4 sw=4 noet:
 630  */