regexp.h

   1 /*    regexp.h
   2  *
   3  *    Copyright (C) 1993, 1994, 1996, 1997, 1999, 2000, 2001, 2003,
   4  *    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 Nicholas'
  19  * pluggable regex engine code */
  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
  35 typedef struct regexp_paren_ofs {
  36     I32 *startp;
  37     I32 *endp;
  38 } regexp_paren_ofs;
  39
  40 #ifdef PERL_OLD_COPY_ON_WRITE
  41 #define SV_SAVED_COPY   SV *saved_copy; /* If non-NULL, SV which is COW from original */
  42 #else
  43 #define SV_SAVED_COPY
  44 #endif
  45 /* this is ordered such that the most commonly used
  46    fields are at the start of the struct */
  47 typedef struct regexp {
  48         /* what engine created this regexp? */
  49         const struct regexp_engine* engine;
  50
  51         /* Information about the match that the perl core uses to manage things */
  52         U32 extflags;           /* Flags used both externally and internally */
  53         I32 minlen;             /* mininum possible length of string to match */
  54         I32 minlenret;          /* mininum possible length of $& */
  55         U32 gofs;               /* chars left of pos that we search from */
  56         struct reg_substr_data *substrs; /* substring data about strings that must appear
  57                                    in the final match, used for optimisations */
  58         U32 nparens;            /* number of capture buffers */
  59
  60         /* private engine specific data */
  61         U32 intflags;           /* Engine Specific Internal flags */
  62         void *pprivate;         /* Data private to the regex engine which
  63                                    created this object. */
  64
  65         /* Data about the last/current match. These are modified during matching*/
  66         U32 lastparen;          /* last open paren matched */
  67         U32 lastcloseparen;     /* last close paren matched */
  68         I32 *startp;            /* Array of offsets from start of string (@-) */
  69         I32 *endp;              /* Array of offsets from start of string (@+) */
  70         char *subbeg;           /* saved or original string
  71                                    so \digit works forever. */
  72         I32 sublen;             /* Length of string pointed by subbeg */
  73         SV_SAVED_COPY           /* If non-NULL, SV which is COW from original */
  74
  75
  76         /* Information about the match that isn't often used */
  77         char *precomp;          /* pre-compilation regular expression */
  78         I32 prelen;             /* length of precomp */
  79         I32 seen_evals;         /* number of eval groups in the pattern - for security checks */
  80         HV *paren_names;        /* Optional hash of paren names */
  81
  82         /* Refcount of this regexp */
  83         I32 refcnt;             /* Refcount of this regexp */
  84 } regexp;
  85
  86
  87 typedef struct regexp_internal {
  88         regexp_paren_ofs *swap; /* Swap copy of *startp / *endp */
  89         U32 *offsets;           /* offset annotations 20001228 MJD
  90                                    data about mapping the program to the
  91                                    string*/
  92         regnode *regstclass;    /* Optional startclass as identified or constructed
  93                                    by the optimiser */
  94         struct reg_data *data;  /* Additional miscellaneous data used by the program.
  95                                    Used to make it easier to clone and free arbitrary
  96                                    data that the regops need. Often the ARG field of
  97                                    a regop is an index into this structure */
  98         regnode program[1];     /* Unwarranted chumminess with compiler. */
  99 } regexp_internal;
 100
 101 #define RXi_SET(x,y) (x)->pprivate = (void*)(y)
 102 #define RXi_GET(x)   ((regexp_internal *)((x)->pprivate))
 103 #define RXi_GET_DECL(r,ri) regexp_internal *ri = RXi_GET(r)
 104
 105 typedef struct re_scream_pos_data_s
 106 {
 107     char **scream_olds;         /* match pos */
 108     I32 *scream_pos;            /* Internal iterator of scream. */
 109 } re_scream_pos_data;
 110
 111 typedef struct regexp_engine {
 112     regexp* (*comp) (pTHX_ char* exp, char* xend, PMOP* pm);
 113     I32     (*exec) (pTHX_ regexp* prog, char* stringarg, char* strend,
 114                             char* strbeg, I32 minend, SV* screamer,
 115                             void* data, U32 flags);
 116     char*   (*intuit) (pTHX_ regexp *prog, SV *sv, char *strpos,
 117                             char *strend, U32 flags,
 118                             struct re_scream_pos_data_s *data);
 119     SV*     (*checkstr) (pTHX_ regexp *prog);
 120     void    (*free) (pTHX_ struct regexp* r);
 121 #ifdef USE_ITHREADS
 122     void* (*dupe) (pTHX_ const regexp *r, CLONE_PARAMS *param);
 123 #endif
 124 } regexp_engine;
 125
 126 /*
 127  * Flags stored in regexp->intflags
 128  * These are used only internally to the regexp engine
 129  */
 130 #define PREGf_SKIP              0x00000001
 131 #define PREGf_IMPLICIT          0x00000002 /* Converted .* to ^.* */
 132 #define PREGf_NAUGHTY           0x00000004 /* how exponential is this pattern? */
 133 #define PREGf_VERBARG_SEEN      0x00000008
 134 #define PREGf_CUTGROUP_SEEN     0x00000010
 135
 136
 137 /* Flags stored in regexp->extflags
 138  * These are used by code external to the regexp engine
 139  */
 140
 141 /* Anchor and GPOS related stuff */
 142 #define RXf_ANCH_BOL            0x00000001
 143 #define RXf_ANCH_MBOL           0x00000002
 144 #define RXf_ANCH_SBOL           0x00000004
 145 #define RXf_ANCH_GPOS           0x00000008
 146 #define RXf_GPOS_SEEN           0x00000010
 147 #define RXf_GPOS_FLOAT          0x00000020
 148 /* five bits here */
 149 #define RXf_ANCH                (RXf_ANCH_BOL|RXf_ANCH_MBOL|RXf_ANCH_GPOS|RXf_ANCH_SBOL)
 150 #define RXf_GPOS_CHECK          (RXf_GPOS_SEEN|RXf_ANCH_GPOS)
 151 #define RXf_ANCH_SINGLE         (RXf_ANCH_SBOL|RXf_ANCH_GPOS)
 152 /*
 153  * 0xF800 of extflags is used by PMf_COMPILETIME
 154  * These are the regex equivelent of the PMf_xyz stuff defined
 155  * in op.h
 156  */
 157 #define RXf_PMf_LOCALE          0x00000800
 158 #define RXf_PMf_MULTILINE       0x00001000
 159 #define RXf_PMf_SINGLELINE      0x00002000
 160 #define RXf_PMf_FOLD            0x00004000
 161 #define RXf_PMf_EXTENDED        0x00008000
 162 #define RXf_PMf_COMPILETIME     (RXf_PMf_MULTILINE|RXf_PMf_SINGLELINE|RXf_PMf_LOCALE|RXf_PMf_FOLD|RXf_PMf_EXTENDED)
 163
 164 /* What we have seen */
 165 /* one bit here */
 166 #define RXf_LOOKBEHIND_SEEN     0x00020000
 167 #define RXf_EVAL_SEEN           0x00040000
 168 #define RXf_CANY_SEEN           0x00080000
 169
 170 /* Special */
 171 #define RXf_NOSCAN              0x00100000
 172 #define RXf_CHECK_ALL           0x00200000
 173
 174 /* UTF8 related */
 175 #define RXf_UTF8                0x00400000
 176 #define RXf_MATCH_UTF8          0x00800000
 177
 178 /* Intuit related */
 179 #define RXf_USE_INTUIT_NOML     0x01000000
 180 #define RXf_USE_INTUIT_ML       0x02000000
 181 #define RXf_INTUIT_TAIL         0x04000000
 182 /* one bit here */
 183 #define RXf_USE_INTUIT          (RXf_USE_INTUIT_NOML|RXf_USE_INTUIT_ML)
 184
 185 /* Copy and tainted info */
 186 #define RXf_COPY_DONE           0x10000000
 187 #define RXf_TAINTED_SEEN        0x20000000
 188 /* two bits here  */
 189
 190
 191 #define RX_HAS_CUTGROUP(prog) ((prog)->intflags & PREGf_CUTGROUP_SEEN)
 192 #define RX_MATCH_TAINTED(prog)  ((prog)->extflags & RXf_TAINTED_SEEN)
 193 #define RX_MATCH_TAINTED_on(prog) ((prog)->extflags |= RXf_TAINTED_SEEN)
 194 #define RX_MATCH_TAINTED_off(prog) ((prog)->extflags &= ~RXf_TAINTED_SEEN)
 195 #define RX_MATCH_TAINTED_set(prog, t) ((t) \
 196                                        ? RX_MATCH_TAINTED_on(prog) \
 197                                        : RX_MATCH_TAINTED_off(prog))
 198
 199 #define RX_MATCH_COPIED(prog)           ((prog)->extflags & RXf_COPY_DONE)
 200 #define RX_MATCH_COPIED_on(prog)        ((prog)->extflags |= RXf_COPY_DONE)
 201 #define RX_MATCH_COPIED_off(prog)       ((prog)->extflags &= ~RXf_COPY_DONE)
 202 #define RX_MATCH_COPIED_set(prog,t)     ((t) \
 203                                          ? RX_MATCH_COPIED_on(prog) \
 204                                          : RX_MATCH_COPIED_off(prog))
 205
 206 #endif /* PLUGGABLE_RE_EXTENSION */
 207
 208 /* Stuff that needs to be included in the plugable extension goes below here */
 209
 210 #ifdef PERL_OLD_COPY_ON_WRITE
 211 #define RX_MATCH_COPY_FREE(rx) \
 212         STMT_START {if (rx->saved_copy) { \
 213             SV_CHECK_THINKFIRST_COW_DROP(rx->saved_copy); \
 214         } \
 215         if (RX_MATCH_COPIED(rx)) { \
 216             Safefree(rx->subbeg); \
 217             RX_MATCH_COPIED_off(rx); \
 218         }} STMT_END
 219 #else
 220 #define RX_MATCH_COPY_FREE(rx) \
 221         STMT_START {if (RX_MATCH_COPIED(rx)) { \
 222             Safefree(rx->subbeg); \
 223             RX_MATCH_COPIED_off(rx); \
 224         }} STMT_END
 225 #endif
 226
 227 #define RX_MATCH_UTF8(prog)             ((prog)->extflags & RXf_MATCH_UTF8)
 228 #define RX_MATCH_UTF8_on(prog)          ((prog)->extflags |= RXf_MATCH_UTF8)
 229 #define RX_MATCH_UTF8_off(prog)         ((prog)->extflags &= ~RXf_MATCH_UTF8)
 230 #define RX_MATCH_UTF8_set(prog, t)      ((t) \
 231                         ? (RX_MATCH_UTF8_on(prog), (PL_reg_match_utf8 = 1)) \
 232                         : (RX_MATCH_UTF8_off(prog), (PL_reg_match_utf8 = 0)))
 233
 234 #define REXEC_COPY_STR  0x01            /* Need to copy the string. */
 235 #define REXEC_CHECKED   0x02            /* check_substr already checked. */
 236 #define REXEC_SCREAM    0x04            /* use scream table. */
 237 #define REXEC_IGNOREPOS 0x08            /* \G matches at start. */
 238 #define REXEC_NOT_FIRST 0x10            /* This is another iteration of //g. */
 239
 240 #define ReREFCNT_inc(re) ((void)(re && re->refcnt++), re)
 241 #define ReREFCNT_dec(re) CALLREGFREE(re)
 242
 243 #define FBMcf_TAIL_DOLLAR       1
 244 #define FBMcf_TAIL_DOLLARM      2
 245 #define FBMcf_TAIL_Z            4
 246 #define FBMcf_TAIL_z            8
 247 #define FBMcf_TAIL              (FBMcf_TAIL_DOLLAR|FBMcf_TAIL_DOLLARM|FBMcf_TAIL_Z|FBMcf_TAIL_z)
 248
 249 #define FBMrf_MULTILINE 1
 250
 251 /* an accepting state/position*/
 252 struct _reg_trie_accepted {
 253     U8   *endpos;
 254     U16  wordnum;
 255 };
 256 typedef struct _reg_trie_accepted reg_trie_accepted;
 257
 258 /* some basic information about the current match that is created by
 259  * Perl_regexec_flags and then passed to regtry(), regmatch() etc */
 260
 261 typedef struct {
 262     regexp *prog;
 263     char *bol;
 264     char *till;
 265     SV *sv;
 266     char *ganch;
 267     char *cutpoint;
 268 } regmatch_info;
 269
 270
 271 /* structures for holding and saving the state maintained by regmatch() */
 272
 273 #define MAX_RECURSE_EVAL_NOCHANGE_DEPTH 50
 274
 275 typedef I32 CHECKPOINT;
 276
 277 typedef struct regmatch_state {
 278     int resume_state;           /* where to jump to on return */
 279     char *locinput;             /* where to backtrack in string on failure */
 280
 281     union {
 282
 283         /* this is a fake union member that matches the first element
 284          * of each member that needs to store positive backtrack
 285          * information */
 286         struct {
 287             struct regmatch_state *prev_yes_state;
 288         } yes;
 289
 290         struct {
 291             /* this first element must match u.yes */
 292             struct regmatch_state *prev_yes_state;
 293             reg_trie_accepted *accept_buff;
 294             U32         accepted; /* how many accepting states we have seen */
 295             U16         *jump;  /* positive offsets from me */
 296             regnode     *B;     /* node following the trie */
 297             regnode     *me;    /* Which node am I - needed for jump tries*/
 298         } trie;
 299
 300         struct {
 301             /* this first element must match u.yes */
 302             struct regmatch_state *prev_yes_state;
 303             struct regmatch_state *prev_eval;
 304             struct regmatch_state *prev_curlyx;
 305             regexp      *prev_rex;
 306             U32         toggle_reg_flags; /* what bits in PL_reg_flags to
 307                                             flip when transitioning between
 308                                             inner and outer rexen */
 309             CHECKPOINT  cp;     /* remember current savestack indexes */
 310             CHECKPOINT  lastcp;
 311             regnode     *B;     /* the node following us  */
 312             U32        close_paren; /* which close bracket is our end */
 313         } eval;
 314
 315         struct {
 316             /* this first element must match u.yes */
 317             struct regmatch_state *prev_yes_state;
 318             struct regmatch_state *prev_curlyx; /* previous cur_curlyx */
 319             CHECKPOINT  cp;     /* remember current savestack index */
 320             bool        minmod;
 321             int         parenfloor;/* how far back to strip paren data */
 322             int         min;    /* the minimal number of A's to match */
 323             int         max;    /* the maximal number of A's to match */
 324             regnode     *A, *B; /* the nodes corresponding to /A*B/  */
 325
 326             /* these two are modified by WHILEM */
 327             int         count;  /* how many instances of A we've matched */
 328             char        *lastloc;/* where previous A matched (0-len detect) */
 329         } curlyx;
 330
 331         struct {
 332             /* this first element must match u.yes */
 333             struct regmatch_state *prev_yes_state;
 334             struct regmatch_state *save_curlyx;
 335             CHECKPOINT  cp;     /* remember current savestack indexes */
 336             CHECKPOINT  lastcp;
 337             char        *save_lastloc;  /* previous curlyx.lastloc */
 338             I32         cache_offset;
 339             I32         cache_mask;
 340         } whilem;
 341
 342         struct {
 343             /* this first element must match u.yes */
 344             struct regmatch_state *prev_yes_state;
 345             U32 lastparen;
 346             regnode *next_branch; /* next branch node */
 347             CHECKPOINT cp;
 348         } branch;
 349
 350         struct {
 351             /* this first element must match u.yes */
 352             struct regmatch_state *prev_yes_state;
 353             I32 c1, c2;         /* case fold search */
 354             CHECKPOINT cp;
 355             I32 alen;           /* length of first-matched A string */
 356             I32 count;
 357             bool minmod;
 358             regnode *A, *B;     /* the nodes corresponding to /A*B/  */
 359             regnode *me;        /* the curlym node */
 360         } curlym;
 361
 362         struct {
 363             U32 paren;
 364             CHECKPOINT cp;
 365             I32 c1, c2;         /* case fold search */
 366             char *maxpos;       /* highest possible point in string to match */
 367             char *oldloc;       /* the previous locinput */
 368             int count;
 369             int min, max;       /* {m,n} */
 370             regnode *A, *B;     /* the nodes corresponding to /A*B/  */
 371         } curly; /* and CURLYN/PLUS/STAR */
 372
 373         struct {
 374             /* this first element must match u.yes */
 375             struct regmatch_state *prev_yes_state;
 376             I32 wanted;
 377             I32 logical;        /* saved copy of 'logical' var */
 378             regnode  *me; /* the IFMATCH/SUSPEND/UNLESSM node  */
 379         } ifmatch; /* and SUSPEND/UNLESSM */
 380
 381         struct {
 382             /* this first element must match u.yes */
 383             struct regmatch_state *prev_yes_state;
 384             struct regmatch_state *prev_mark;
 385             SV* mark_name;
 386             char *mark_loc;
 387         } mark;
 388     } u;
 389 } regmatch_state;
 390
 391 /* how many regmatch_state structs to allocate as a single slab.
 392  * We do it in 4K blocks for efficiency. The "3" is 2 for the next/prev
 393  * pointers, plus 1 for any mythical malloc overhead. */
 394
 395 #define PERL_REGMATCH_SLAB_SLOTS \
 396     ((4096 - 3 * sizeof (void*)) / sizeof(regmatch_state))
 397
 398 typedef struct regmatch_slab {
 399     regmatch_state states[PERL_REGMATCH_SLAB_SLOTS];
 400     struct regmatch_slab *prev, *next;
 401 } regmatch_slab;
 402
 403 #define PL_reg_flags            PL_reg_state.re_state_reg_flags
 404 #define PL_bostr                PL_reg_state.re_state_bostr
 405 #define PL_reginput             PL_reg_state.re_state_reginput
 406 #define PL_regeol               PL_reg_state.re_state_regeol
 407 #define PL_regstartp            PL_reg_state.re_state_regstartp
 408 #define PL_regendp              PL_reg_state.re_state_regendp
 409 #define PL_reglastparen         PL_reg_state.re_state_reglastparen
 410 #define PL_reglastcloseparen    PL_reg_state.re_state_reglastcloseparen
 411 #define PL_reg_start_tmp        PL_reg_state.re_state_reg_start_tmp
 412 #define PL_reg_start_tmpl       PL_reg_state.re_state_reg_start_tmpl
 413 #define PL_reg_eval_set         PL_reg_state.re_state_reg_eval_set
 414 #define PL_reg_match_utf8       PL_reg_state.re_state_reg_match_utf8
 415 #define PL_reg_magic            PL_reg_state.re_state_reg_magic
 416 #define PL_reg_oldpos           PL_reg_state.re_state_reg_oldpos
 417 #define PL_reg_oldcurpm         PL_reg_state.re_state_reg_oldcurpm
 418 #define PL_reg_curpm            PL_reg_state.re_state_reg_curpm
 419 #define PL_reg_oldsaved         PL_reg_state.re_state_reg_oldsaved
 420 #define PL_reg_oldsavedlen      PL_reg_state.re_state_reg_oldsavedlen
 421 #define PL_reg_maxiter          PL_reg_state.re_state_reg_maxiter
 422 #define PL_reg_leftiter         PL_reg_state.re_state_reg_leftiter
 423 #define PL_reg_poscache         PL_reg_state.re_state_reg_poscache
 424 #define PL_reg_poscache_size    PL_reg_state.re_state_reg_poscache_size
 425 #define PL_regsize              PL_reg_state.re_state_regsize
 426 #define PL_reg_starttry         PL_reg_state.re_state_reg_starttry
 427 #define PL_nrs                  PL_reg_state.re_state_nrs
 428
 429 struct re_save_state {
 430     U32 re_state_reg_flags;             /* from regexec.c */
 431     char *re_state_bostr;
 432     char *re_state_reginput;            /* String-input pointer. */
 433     char *re_state_regeol;              /* End of input, for $ check. */
 434     I32 *re_state_regstartp;            /* Pointer to startp array. */
 435     I32 *re_state_regendp;              /* Ditto for endp. */
 436     U32 *re_state_reglastparen;         /* Similarly for lastparen. */
 437     U32 *re_state_reglastcloseparen;    /* Similarly for lastcloseparen. */
 438     char **re_state_reg_start_tmp;      /* from regexec.c */
 439     U32 re_state_reg_start_tmpl;        /* from regexec.c */
 440     I32 re_state_reg_eval_set;          /* from regexec.c */
 441     bool re_state_reg_match_utf8;       /* from regexec.c */
 442     MAGIC *re_state_reg_magic;          /* from regexec.c */
 443     I32 re_state_reg_oldpos;            /* from regexec.c */
 444     PMOP *re_state_reg_oldcurpm;        /* from regexec.c */
 445     PMOP *re_state_reg_curpm;           /* from regexec.c */
 446     char *re_state_reg_oldsaved;        /* old saved substr during match */
 447     STRLEN re_state_reg_oldsavedlen;    /* old length of saved substr during match */
 448     I32 re_state_reg_maxiter;           /* max wait until caching pos */
 449     I32 re_state_reg_leftiter;          /* wait until caching pos */
 450     char *re_state_reg_poscache;        /* cache of pos of WHILEM */
 451     STRLEN re_state_reg_poscache_size;  /* size of pos cache of WHILEM */
 452     U32 re_state_regsize;               /* from regexec.c */
 453     char *re_state_reg_starttry;        /* from regexec.c */
 454 #ifdef PERL_OLD_COPY_ON_WRITE
 455     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 */
 456 #endif
 457 };
 458
 459 #define SAVESTACK_ALLOC_FOR_RE_SAVE_STATE \
 460         (1 + ((sizeof(struct re_save_state) - 1) / sizeof(*PL_savestack)))
 461 /*
 462  * Local variables:
 463  * c-indentation-style: bsd
 464  * c-basic-offset: 4
 465  * indent-tabs-mode: t
 466  * End:
 467  *
 468  * ex: set ts=8 sts=4 sw=4 noet:
 469  */