This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
c9742e878a0ba085cee8b5d491df318b4f0f0add
[perl5.git] / regcomp.h
1 /*    regcomp.h
2  */
3
4 typedef OP OP_4tree;                    /* Will be redefined later. */
5
6 /*
7  * The "internal use only" fields in regexp.h are present to pass info from
8  * compile to execute that permits the execute phase to run lots faster on
9  * simple cases.  They are:
10  *
11  * regstart     sv that must begin a match; Nullch if none obvious
12  * reganch      is the match anchored (at beginning-of-line only)?
13  * regmust      string (pointer into program) that match must include, or NULL
14  *  [regmust changed to SV* for bminstr()--law]
15  * regmlen      length of regmust string
16  *  [regmlen not used currently]
17  *
18  * Regstart and reganch permit very fast decisions on suitable starting points
19  * for a match, cutting down the work a lot.  Regmust permits fast rejection
20  * of lines that cannot possibly match.  The regmust tests are costly enough
21  * that pregcomp() supplies a regmust only if the r.e. contains something
22  * potentially expensive (at present, the only such thing detected is * or +
23  * at the start of the r.e., which can involve a lot of backup).  Regmlen is
24  * supplied because the test in pregexec() needs it and pregcomp() is computing
25  * it anyway.
26  * [regmust is now supplied always.  The tests that use regmust have a
27  * heuristic that disables the test if it usually matches.]
28  *
29  * [In fact, we now use regmust in many cases to locate where the search
30  * starts in the string, so if regback is >= 0, the regmust search is never
31  * wasted effort.  The regback variable says how many characters back from
32  * where regmust matched is the earliest possible start of the match.
33  * For instance, /[a-z].foo/ has a regmust of 'foo' and a regback of 2.]
34  */
35
36 /* #ifndef gould */
37 /* #ifndef cray */
38 /* #ifndef eta10 */
39 #define REGALIGN
40 /* #endif */
41 /* #endif */
42 /* #endif */
43
44 #ifdef REGALIGN
45 #  define REGALIGN_STRUCT
46 #endif 
47
48 /*
49  * Structure for regexp "program".  This is essentially a linear encoding
50  * of a nondeterministic finite-state machine (aka syntax charts or
51  * "railroad normal form" in parsing technology).  Each node is an opcode
52  * plus a "next" pointer, possibly plus an operand.  "Next" pointers of
53  * all nodes except BRANCH implement concatenation; a "next" pointer with
54  * a BRANCH on both ends of it is connecting two alternatives.  (Here we
55  * have one of the subtle syntax dependencies:  an individual BRANCH (as
56  * opposed to a collection of them) is never concatenated with anything
57  * because of operator precedence.)  The operand of some types of node is
58  * a literal string; for others, it is a node leading into a sub-FSM.  In
59  * particular, the operand of a BRANCH node is the first node of the branch.
60  * (NB this is *not* a tree structure:  the tail of the branch connects
61  * to the thing following the set of BRANCHes.)  The opcodes are:
62  */
63
64 /* definition   number  opnd?   meaning */
65 #define END      0      /* no   End of program. */
66 #define BOL      1      /* no   Match "" at beginning of line. */
67 #define MBOL     2      /* no   Same, assuming multiline. */
68 #define SBOL     3      /* no   Same, assuming singleline. */
69 #define EOL      4      /* no   Match "" at end of line. */
70 #define MEOL     5      /* no   Same, assuming multiline. */
71 #define SEOL     6      /* no   Same, assuming singleline. */
72 #define ANY      7      /* no   Match any one character (except newline). */
73 #define SANY     8      /* no   Match any one character. */
74 #define ANYOF    9      /* sv   Match character in (or not in) this class. */
75 #define CURLY   10      /* sv   Match this simple thing {n,m} times. */
76 #define CURLYX  11      /* sv   Match this complex thing {n,m} times. */
77 #define BRANCH  12      /* node Match this alternative, or the next... */
78 #define BACK    13      /* no   Match "", "next" ptr points backward. */
79 #define EXACT   14      /* sv   Match this string (preceded by length). */
80 #define EXACTF  15      /* sv   Match this string, folded (prec. by length). */
81 #define EXACTFL 16      /* sv   Match this string, folded in locale (w/len). */
82 #define NOTHING 17      /* no   Match empty string. */
83 #define STAR    18      /* node Match this (simple) thing 0 or more times. */
84 #define PLUS    19      /* node Match this (simple) thing 1 or more times. */
85 #define BOUND   20      /* no   Match "" at any word boundary */
86 #define BOUNDL  21      /* no   Match "" at any word boundary */
87 #define NBOUND  22      /* no   Match "" at any word non-boundary */
88 #define NBOUNDL 23      /* no   Match "" at any word non-boundary */
89 #define REF     24      /* num  Match some already matched string */
90 #define OPEN    25      /* num  Mark this point in input as start of #n. */
91 #define CLOSE   26      /* num  Analogous to OPEN. */
92 #define MINMOD  27      /* no   Next operator is not greedy. */
93 #define GPOS    28      /* no   Matches where last m//g left off. */
94 #define IFMATCH 29      /* off  Succeeds if the following matches. */
95 #define UNLESSM 30      /* off  Fails if the following matches. */
96 #define SUCCEED 31      /* no   Return from a subroutine, basically. */
97 #define WHILEM  32      /* no   Do curly processing and see if rest matches. */
98 #define ALNUM   33      /* no   Match any alphanumeric character */
99 #define ALNUML  34      /* no   Match any alphanumeric char in locale */
100 #define NALNUM  35      /* no   Match any non-alphanumeric character */
101 #define NALNUML 36      /* no   Match any non-alphanumeric char in locale */
102 #define SPACE   37      /* no   Match any whitespace character */
103 #define SPACEL  38      /* no   Match any whitespace char in locale */
104 #define NSPACE  39      /* no   Match any non-whitespace character */
105 #define NSPACEL 40      /* no   Match any non-whitespace char in locale */
106 #define DIGIT   41      /* no   Match any numeric character */
107 #define NDIGIT  42      /* no   Match any non-numeric character */
108 #define CURLYM  43      /* no   Match this medium-complex thing {n,m} times. */
109 #define CURLYN  44      /* no   Match next-after-this simple thing
110                            {n,m} times, set parenths. */
111 #define TAIL    45      /* no   Match empty string. Can jump here from outside. */
112 #define REFF    46      /* num  Match already matched string, folded */
113 #define REFFL   47      /* num  Match already matched string, folded in loc. */
114 #define EVAL    48      /* evl  Execute some Perl code. */
115 #define LONGJMP 49      /* off  Jump far away, requires REGALIGN_STRUCT. */
116 #define BRANCHJ 50      /* off  BRANCH with long offset, requires REGALIGN_STRUCT. */
117 #define IFTHEN  51      /* off  Switch, should be preceeded by switcher . */
118 #define GROUPP  52      /* num  Whether the group matched. */
119 #define LOGICAL 53      /* no   Next opcode should set the flag only. */
120 #define SUSPEND 54      /* off  "Independent" sub-RE. */
121 #define RENUM   55      /* off  Group with independently numbered parens. */
122 #define OPTIMIZED       56      /* off  Placeholder for dump. */
123
124 /*
125  * Opcode notes:
126  *
127  * BRANCH       The set of branches constituting a single choice are hooked
128  *              together with their "next" pointers, since precedence prevents
129  *              anything being concatenated to any individual branch.  The
130  *              "next" pointer of the last BRANCH in a choice points to the
131  *              thing following the whole choice.  This is also where the
132  *              final "next" pointer of each individual branch points; each
133  *              branch starts with the operand node of a BRANCH node.
134  *
135  * BACK         Normal "next" pointers all implicitly point forward; BACK
136  *              exists to make loop structures possible.
137  *
138  * STAR,PLUS    '?', and complex '*' and '+', are implemented as circular
139  *              BRANCH structures using BACK.  Simple cases (one character
140  *              per match) are implemented with STAR and PLUS for speed
141  *              and to minimize recursive plunges.
142  *
143  * OPEN,CLOSE,GROUPP    ...are numbered at compile time.
144  */
145
146 #ifndef DOINIT
147 EXTCONST U8 regkind[];
148 #else
149 EXTCONST U8 regkind[] = {
150         END,
151         BOL,
152         BOL,
153         BOL,
154         EOL,
155         EOL,
156         EOL,
157         ANY,
158         ANY,
159         ANYOF,
160         CURLY,
161         CURLY,
162         BRANCH,
163         BACK,
164         EXACT,
165         EXACT,
166         EXACT,
167         NOTHING,
168         STAR,
169         PLUS,
170         BOUND,
171         BOUND,
172         NBOUND,
173         NBOUND,
174         REF,
175         OPEN,
176         CLOSE,
177         MINMOD,
178         GPOS,
179         BRANCHJ,
180         BRANCHJ,
181         END,
182         WHILEM,
183         ALNUM,
184         ALNUM,
185         NALNUM,
186         NALNUM,
187         SPACE,
188         SPACE,
189         NSPACE,
190         NSPACE,
191         DIGIT,
192         NDIGIT,
193         CURLY,
194         CURLY,
195         NOTHING,
196         REF,
197         REF,
198         EVAL,
199         LONGJMP,
200         BRANCHJ,
201         BRANCHJ,
202         GROUPP,
203         LOGICAL,
204         BRANCHJ,
205         BRANCHJ,
206         NOTHING,
207 };
208 #endif
209
210 /* The following have no fixed length. char* since we do strchr on it. */
211 #ifndef DOINIT
212 EXTCONST char varies[];
213 #else
214 EXTCONST char varies[] = {
215     BRANCH, BACK, STAR, PLUS, CURLY, CURLYX, REF, REFF, REFFL, 
216     WHILEM, CURLYM, CURLYN, BRANCHJ, IFTHEN, SUSPEND, 0
217 };
218 #endif
219
220 /* The following always have a length of 1. char* since we do strchr on it. */
221 #ifndef DOINIT
222 EXTCONST char simple[];
223 #else
224 EXTCONST char simple[] = {
225     ANY, SANY, ANYOF,
226     ALNUM, ALNUML, NALNUM, NALNUML,
227     SPACE, SPACEL, NSPACE, NSPACEL,
228     DIGIT, NDIGIT, 0
229 };
230 #endif
231
232 /*
233  * A node is one char of opcode followed by two chars of "next" pointer.
234  * "Next" pointers are stored as two 8-bit pieces, high order first.  The
235  * value is a positive offset from the opcode of the node containing it.
236  * An operand, if any, simply follows the node.  (Note that much of the
237  * code generation knows about this implicit relationship.)
238  *
239  * Using two bytes for the "next" pointer is vast overkill for most things,
240  * but allows patterns to get big without disasters.
241  *
242  * [If REGALIGN is defined, the "next" pointer is always aligned on an even
243  * boundary, and reads the offset directly as a short.  Also, there is no
244  * special test to reverse the sign of BACK pointers since the offset is
245  * stored negative.]
246  */
247
248 #ifdef REGALIGN_STRUCT
249
250 struct regnode_string {
251     U8  flags;
252     U8  type;
253     U16 next_off;
254     U8 string[1];
255 };
256
257 struct regnode_1 {
258     U8  flags;
259     U8  type;
260     U16 next_off;
261     U32 arg1;
262 };
263
264 struct regnode_2 {
265     U8  flags;
266     U8  type;
267     U16 next_off;
268     U16 arg1;
269     U16 arg2;
270 };
271
272 #endif 
273
274 /* XXX fix this description.
275    Impose a limit of REG_INFTY on various pattern matching operations
276    to limit stack growth and to avoid "infinite" recursions.
277 */
278 /* The default size for REG_INFTY is I16_MAX, which is the same as
279    SHORT_MAX (see perl.h).  Unfortunately I16 isn't necessarily 16 bits
280    (see handy.h).  On the Cray C90, sizeof(short)==4 and hence I16_MAX is
281    ((1<<31)-1), while on the Cray T90, sizeof(short)==8 and I16_MAX is
282    ((1<<63)-1).  To limit stack growth to reasonable sizes, supply a
283    smaller default.
284         --Andy Dougherty  11 June 1998
285 */
286 #if SHORTSIZE > 2
287 #  ifndef REG_INFTY
288 #    define REG_INFTY ((1<<15)-1)
289 #  endif
290 #endif
291
292 #ifndef REG_INFTY
293 #  define REG_INFTY I16_MAX
294 #endif
295
296 #ifdef REGALIGN
297 #  define ARG_VALUE(arg) (arg)
298 #  define ARG__SET(arg,val) ((arg) = (val))
299 #else
300 #  define ARG_VALUE(arg) (((*((char*)&arg)&0377)<<8) + (*(((char*)&arg)+1)&0377))
301 #  define ARG__SET(arg,val) (((char*)&arg)[0] = (val) >> 8; ((char*)&arg)[1] = (val) & 0377;)
302 #endif
303
304 #define ARG(p) ARG_VALUE(ARG_LOC(p))
305 #define ARG1(p) ARG_VALUE(ARG1_LOC(p))
306 #define ARG2(p) ARG_VALUE(ARG2_LOC(p))
307 #define ARG_SET(p, val) ARG__SET(ARG_LOC(p), (val))
308 #define ARG1_SET(p, val) ARG__SET(ARG1_LOC(p), (val))
309 #define ARG2_SET(p, val) ARG__SET(ARG2_LOC(p), (val))
310
311 #ifndef lint
312 #  ifdef REGALIGN
313 #    ifdef REGALIGN_STRUCT
314 #      define NEXT_OFF(p) ((p)->next_off)
315 #      define   NODE_ALIGN(node)
316 #      define   NODE_ALIGN_FILL(node) ((node)->flags = 0xde) /* deadbeef */
317 #    else
318 #      define NEXT_OFF(p) (*(short*)(p+1))
319 #      define   NODE_ALIGN(node)        ((!((long)node & 1)) ? node++ : 0)
320 #      define   NODE_ALIGN_FILL(node)   ((!((long)node & 1)) ? *node++ = 127 : 0)
321 #    endif 
322 #  else
323 #    define     NEXT_OFF(p)     (((*((p)+1)&0377)<<8) + (*((p)+2)&0377))
324 #    define     NODE_ALIGN(node)
325 #    define     NODE_ALIGN_FILL(node)
326 #  endif
327 #else /* lint */
328 #  define NEXT_OFF(p) 0
329 #  define       NODE_ALIGN(node)
330 #  define       NODE_ALIGN_FILL(node)
331 #endif /* lint */
332
333 #define SIZE_ALIGN NODE_ALIGN
334
335 #ifdef REGALIGN_STRUCT
336 #  define       OP(p)   ((p)->type)
337 #  define       OPERAND(p)      (((struct regnode_string *)p)->string)
338 #  define       NODE_ALIGN(node)
339 #  define       ARG_LOC(p) (((struct regnode_1 *)p)->arg1)
340 #  define       ARG1_LOC(p) (((struct regnode_2 *)p)->arg1)
341 #  define       ARG2_LOC(p) (((struct regnode_2 *)p)->arg2)
342 #  define NODE_STEP_REGNODE     1       /* sizeof(regnode)/sizeof(regnode) */
343 #  define EXTRA_STEP_2ARGS      EXTRA_SIZE(struct regnode_2)
344 #else
345 #  define       OP(p)   (*(p))
346 #  define       OPERAND(p)      ((p) + 3)
347 #  define       ARG_LOC(p) (*(unsigned short*)(p+3))
348 #  define       ARG1_LOC(p) (*(unsigned short*)(p+3))
349 #  define       ARG2_LOC(p) (*(unsigned short*)(p+5))
350 typedef char* regnode;
351 #  define NODE_STEP_REGNODE     NODE_STEP_B
352 #  define EXTRA_STEP_2ARGS      4
353 #endif 
354
355 #ifdef REGALIGN
356 #  define NODE_STEP_B   4
357 #else
358 #  define NODE_STEP_B   3
359 #endif
360
361 #define NEXTOPER(p)     ((p) + NODE_STEP_REGNODE)
362 #define PREVOPER(p)     ((p) - NODE_STEP_REGNODE)
363
364 #ifdef REGALIGN_STRUCT
365 #  define FILL_ADVANCE_NODE(ptr, op) STMT_START { \
366     (ptr)->type = op;    (ptr)->next_off = 0;   (ptr)++; } STMT_END
367 #  define FILL_ADVANCE_NODE_ARG(ptr, op, arg) STMT_START { \
368     ARG_SET(ptr, arg);  FILL_ADVANCE_NODE(ptr, op); (ptr) += 1; } STMT_END
369 #else
370 #  define FILL_ADVANCE_NODE(ptr, op) STMT_START { \
371     *(ptr)++ = op;    *(ptr)++ = '\0';    *(ptr)++ = '\0'; } STMT_END
372 #  define FILL_ADVANCE_NODE_ARG(ptr, op, arg) STMT_START { \
373     ARG_SET(ptr, arg);  FILL_ADVANCE_NODE(ptr, op); (ptr) += 2; } STMT_END
374 #endif
375
376 #define MAGIC 0234
377
378 #define SIZE_ONLY (regcode == &regdummy)
379
380 /* Flags for first parameter byte of ANYOF */
381 #define ANYOF_INVERT    0x40
382 #define ANYOF_FOLD      0x20
383 #define ANYOF_LOCALE    0x10
384 #define ANYOF_ISA       0x0F
385 #define ANYOF_ALNUML     0x08
386 #define ANYOF_NALNUML    0x04
387 #define ANYOF_SPACEL     0x02
388 #define ANYOF_NSPACEL    0x01
389
390 /* Utility macros for bitmap of ANYOF */
391 #define ANYOF_BYTE(p,c)     (p)[1 + (((c) >> 3) & 31)]
392 #define ANYOF_BIT(c)        (1 << ((c) & 7))
393 #define ANYOF_SET(p,c)      (ANYOF_BYTE(p,c) |=  ANYOF_BIT(c))
394 #define ANYOF_CLEAR(p,c)    (ANYOF_BYTE(p,c) &= ~ANYOF_BIT(c))
395 #define ANYOF_TEST(p,c)     (ANYOF_BYTE(p,c) &   ANYOF_BIT(c))
396
397 #ifdef REGALIGN_STRUCT
398 #define ANY_SKIP ((33 - 1)/sizeof(regnode) + 1)
399 #else
400 #define ANY_SKIP 32                     /* overwrite the first byte of
401                                          * the next guy.  */
402 #endif 
403
404 /*
405  * Utility definitions.
406  */
407 #ifndef lint
408 #ifndef CHARMASK
409 #define UCHARAT(p)      ((int)*(unsigned char *)(p))
410 #else
411 #define UCHARAT(p)      ((int)*(p)&CHARMASK)
412 #endif
413 #else /* lint */
414 #define UCHARAT(p)      regdummy
415 #endif /* lint */
416
417 #define FAIL(m)         croak    ("/%.127s/: %s",  regprecomp,m)
418 #define FAIL2(pat,m)    re_croak2("/%.127s/: ",pat,regprecomp,m)
419
420 #define EXTRA_SIZE(guy) ((sizeof(guy)-1)/sizeof(struct regnode))
421
422 #ifdef REG_COMP_C
423 const static U8 regarglen[] = {
424 #  ifdef REGALIGN_STRUCT
425     0,0,0,0,0,0,0,0,0,0,
426     /*CURLY*/ EXTRA_SIZE(struct regnode_2), 
427     /*CURLYX*/ EXTRA_SIZE(struct regnode_2),
428     0,0,0,0,0,0,0,0,0,0,0,0,
429     /*REF*/ EXTRA_SIZE(struct regnode_1), 
430     /*OPEN*/ EXTRA_SIZE(struct regnode_1),
431     /*CLOSE*/ EXTRA_SIZE(struct regnode_1),
432     0,0,
433     /*IFMATCH*/ EXTRA_SIZE(struct regnode_1),
434     /*UNLESSM*/ EXTRA_SIZE(struct regnode_1),
435     0,0,0,0,0,0,0,0,0,0,0,0,
436     /*CURLYM*/ EXTRA_SIZE(struct regnode_2),
437     /*CURLYN*/ EXTRA_SIZE(struct regnode_2),
438     0,
439     /*REFF*/ EXTRA_SIZE(struct regnode_1),
440     /*REFFL*/ EXTRA_SIZE(struct regnode_1),
441     /*EVAL*/ EXTRA_SIZE(struct regnode_1),
442     /*LONGJMP*/ EXTRA_SIZE(struct regnode_1),
443     /*BRANCHJ*/ EXTRA_SIZE(struct regnode_1),
444     /*IFTHEN*/ EXTRA_SIZE(struct regnode_1),
445     /*GROUPP*/ EXTRA_SIZE(struct regnode_1),
446     /*LOGICAL*/ 0,
447     /*SUSPEND*/ EXTRA_SIZE(struct regnode_1),
448     /*RENUM*/ EXTRA_SIZE(struct regnode_1), 0,
449 #  else
450     0,0,0,0,0,0,0,0,0,0,
451     /*CURLY*/ 4, /*CURLYX*/ 4,
452     0,0,0,0,0,0,0,0,0,0,0,0,
453     /*REF*/ 2, /*OPEN*/ 2, /*CLOSE*/ 2,
454     0,0, /*IFMATCH*/ 2, /*UNLESSM*/ 2,
455     0,0,0,0,0,0,0,0,0,0,0,0,/*CURLYM*/ 4,/*CURLYN*/ 4,
456     0, /*REFF*/ 2, /*REFFL*/ 2, /*EVAL*/ 2, /*LONGJMP*/ 2, /*BRANCHJ*/ 2,
457     /*IFTHEN*/ 2, /*GROUPP*/ 2, /*LOGICAL*/ 0, /*RENUM*/ 2, /*RENUM*/ 2, 0,
458 #  endif 
459 };
460
461 const static char reg_off_by_arg[] = {
462     0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,    /* 0 .. 15 */
463     0,0,0,0,0,0,0,0,0,0,0,0,0, /*IFMATCH*/ 2, /*UNLESSM*/ 2, 0,
464     0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,    /* 32 .. 47 */
465     0, /*LONGJMP*/ 1, /*BRANCHJ*/ 1, /*IFTHEN*/ 1, 0, 0,
466     /*RENUM*/ 1, /*RENUM*/ 1,0,
467 };
468 #endif
469
470 #define REG_SEEN_ZERO_LEN       1
471 #define REG_SEEN_LOOKBEHIND     2
472 #define REG_SEEN_GPOS           4
473 #define REG_SEEN_EVAL           8