This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
ce12da542fc00641bc937a5032520dace794dcc5
[perl5.git] / op_reg_common.h
1 /*    op_reg_common.h
2  *
3  *    Definitions common to by op.h and regexp.h
4  *
5  *    Copyright (C) 2010 by Larry Wall and others
6  *
7  *    You may distribute under the terms of either the GNU General Public
8  *    License or the Artistic License, as specified in the README file.
9  *
10  */
11
12 /* These defines are used in both op.h and regexp.h  The definitions use the
13  * shift form so that ext/B/defsubs_h.PL will pick them up.
14  *
15  * Data structures used in the two headers have common fields, and in fact one
16  * is copied onto the other.  This makes it easy to keep them in sync */
17
18 /* This tells where the first of these bits is.  Setting it to 0 saved cycles
19  * and memory.  I (khw) think the code will work if changed back, but haven't
20  * tested it */
21 #define RXf_PMf_STD_PMMOD_SHIFT 0
22
23 /* The bits need to be ordered so that the msix are contiguous starting at bit
24  * RXf_PMf_STD_PMMOD_SHIFT, followed by the p.  See STD_PAT_MODS and
25  * INT_PAT_MODS in regexp.h for the reason contiguity is needed */
26 #define RXf_PMf_MULTILINE      (1 << (RXf_PMf_STD_PMMOD_SHIFT+0))    /* /m */
27 #define RXf_PMf_SINGLELINE     (1 << (RXf_PMf_STD_PMMOD_SHIFT+1))    /* /s */
28 #define RXf_PMf_FOLD           (1 << (RXf_PMf_STD_PMMOD_SHIFT+2))    /* /i */
29 #define RXf_PMf_EXTENDED       (1 << (RXf_PMf_STD_PMMOD_SHIFT+3))    /* /x */
30 #define RXf_PMf_KEEPCOPY       (1 << (RXf_PMf_STD_PMMOD_SHIFT+4))    /* /p */
31 #define RXf_PMf_LOCALE         (1 << (RXf_PMf_STD_PMMOD_SHIFT+5))
32 #define RXf_PMf_UNICODE        (1 << (RXf_PMf_STD_PMMOD_SHIFT+6))
33
34 /* Next available bit after the above.  Name begins with '_' so won't be
35  * exported by B */
36 #define _RXf_PMf_SHIFT_NEXT (RXf_PMf_STD_PMMOD_SHIFT+7)
37
38 /* Mask of the above bits.  These need to be transferred from op_pmflags to
39  * re->extflags during compilation */
40 #define RXf_PMf_COMPILETIME    (RXf_PMf_MULTILINE|RXf_PMf_SINGLELINE|RXf_PMf_LOCALE|RXf_PMf_FOLD|RXf_PMf_EXTENDED|RXf_PMf_KEEPCOPY|RXf_PMf_UNICODE)
41
42 /* These copies need to be numerical or defsubs_h.PL won't know about them. */
43 #define PMf_MULTILINE    1<<0
44 #define PMf_SINGLELINE   1<<1
45 #define PMf_FOLD         1<<2
46 #define PMf_EXTENDED     1<<3
47 #define PMf_KEEPCOPY     1<<4
48 #define PMf_LOCALE       1<<5
49
50 #if PMf_MULTILINE != RXf_PMf_MULTILINE || PMf_SINGLELINE != RXf_PMf_SINGLELINE || PMf_FOLD != RXf_PMf_FOLD || PMf_EXTENDED != RXf_PMf_EXTENDED || PMf_KEEPCOPY != RXf_PMf_KEEPCOPY || PMf_LOCALE != RXf_PMf_LOCALE
51 #   error RXf_PMf defines are wrong
52 #endif
53
54 #define PMf_COMPILETIME RXf_PMf_COMPILETIME
55
56 /*  Error check that haven't left something out of this.  This isn't done
57  *  directly in the #define because doing so confuses regcomp.pl.
58  *  (2**n - 1) is n 1 bits, so the below gets the contiguous bits between the
59  *  beginning and ending shifts */
60 #if RXf_PMf_COMPILETIME != (((1 << (_RXf_PMf_SHIFT_NEXT))-1) \
61                             & (~((1 << RXf_PMf_STD_PMMOD_SHIFT)-1)))
62 #   error RXf_PMf_COMPILETIME is invalid
63 #endif