3 * Definitions common to by op.h and regexp.h
5 * Copyright (C) 2010, 2011 by Larry Wall and others
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.
12 /* These defines are used in both op.h and regexp.h The definitions use the
13 * shift form so that ext/B/Makefile.PL will pick them up.
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 */
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
21 /* Make sure to update ext/re/re.pm when changing this! */
22 #ifndef RXf_PMf_STD_PMMOD_SHIFT /* Only expand #include of this file once */
24 #define RXf_PMf_STD_PMMOD_SHIFT 0
26 /* The bits need to be ordered so that the msix are contiguous starting at bit
27 * RXf_PMf_STD_PMMOD_SHIFT, followed by the p. See STD_PAT_MODS and
28 * INT_PAT_MODS in regexp.h for the reason contiguity is needed */
29 /* Make sure to update lib/re.pm when changing these! */
30 /* Make sure you keep the pure PMf_ versions below in sync */
31 #define RXf_PMf_MULTILINE (1U << (RXf_PMf_STD_PMMOD_SHIFT+0)) /* /m */
32 #define RXf_PMf_SINGLELINE (1U << (RXf_PMf_STD_PMMOD_SHIFT+1)) /* /s */
33 #define RXf_PMf_FOLD (1U << (RXf_PMf_STD_PMMOD_SHIFT+2)) /* /i */
34 #define RXf_PMf_EXTENDED (1U << (RXf_PMf_STD_PMMOD_SHIFT+3)) /* /x */
35 #define RXf_PMf_EXTENDED_MORE (1U << (RXf_PMf_STD_PMMOD_SHIFT+4)) /* /xx */
36 #define RXf_PMf_KEEPCOPY (1U << (RXf_PMf_STD_PMMOD_SHIFT+5)) /* /p */
38 /* The character set for the regex is stored in a field of more than one bit
39 * using an enum, for reasons of compactness and to ensure that the options are
40 * mutually exclusive */
41 /* Make sure to update ext/re/re.pm and regcomp.sym (as these are used as
42 * offsets for various node types, like POSIXD vs POSIXL, etc) when changing
45 REGEX_DEPENDS_CHARSET = 0,
47 REGEX_UNICODE_CHARSET,
48 REGEX_ASCII_RESTRICTED_CHARSET,
49 REGEX_ASCII_MORE_RESTRICTED_CHARSET
52 #define _RXf_PMf_CHARSET_SHIFT ((RXf_PMf_STD_PMMOD_SHIFT)+6)
53 #define RXf_PMf_CHARSET (7 << (_RXf_PMf_CHARSET_SHIFT)) /* 3 bits */
55 /* Manually decorate these functions here with gcc-style attributes just to
56 * avoid making the regex_charset typedef global, which it would need to be for
57 * proto.h to understand it */
58 PERL_STATIC_INLINE void
59 set_regex_charset(U32 * const flags, const regex_charset cs)
60 __attribute__nonnull__(1);
62 PERL_STATIC_INLINE void
63 set_regex_charset(U32 * const flags, const regex_charset cs)
65 /* Sets the character set portion of 'flags' to 'cs', which is a member of
68 *flags &= ~RXf_PMf_CHARSET;
69 *flags |= (cs << _RXf_PMf_CHARSET_SHIFT);
72 PERL_STATIC_INLINE regex_charset
73 get_regex_charset(const U32 flags)
74 __attribute__warn_unused_result__;
76 PERL_STATIC_INLINE regex_charset
77 get_regex_charset(const U32 flags)
79 /* Returns the enum corresponding to the character set in 'flags' */
81 return (regex_charset) ((flags & RXf_PMf_CHARSET) >> _RXf_PMf_CHARSET_SHIFT);
84 #define _RXf_PMf_SHIFT_COMPILETIME (RXf_PMf_STD_PMMOD_SHIFT+9)
87 Set in Perl_pmruntime if op_flags & OPf_SPECIAL, i.e. split. Will
88 be used by regex engines to check whether they should set
91 #define RXf_PMf_SPLIT (1U<<(RXf_PMf_STD_PMMOD_SHIFT+9))
93 /* Next available bit after the above. Name begins with '_' so won't be
95 #define _RXf_PMf_SHIFT_NEXT (RXf_PMf_STD_PMMOD_SHIFT+10)
97 /* Mask of the above bits. These need to be transferred from op_pmflags to
98 * re->extflags during compilation */
99 #define RXf_PMf_COMPILETIME (RXf_PMf_MULTILINE|RXf_PMf_SINGLELINE|RXf_PMf_FOLD|RXf_PMf_EXTENDED|RXf_PMf_EXTENDED_MORE|RXf_PMf_KEEPCOPY|RXf_PMf_CHARSET)
100 #define RXf_PMf_FLAGCOPYMASK (RXf_PMf_COMPILETIME|RXf_PMf_SPLIT)
102 /* Exclude win32 because it can't cope with I32_MAX definition */
104 # if RXf_PMf_COMPILETIME > I32_MAX
105 # error RXf_PMf_COMPILETIME wont fit in arg2 field of eval node
109 /* These copies need to be numerical or ext/B/Makefile.PL won't think they are
111 #define PMf_MULTILINE 1U<<0
112 #define PMf_SINGLELINE 1U<<1
113 #define PMf_FOLD 1U<<2
114 #define PMf_EXTENDED 1U<<3
115 #define PMf_EXTENDED_MORE 1U<<4
116 #define PMf_KEEPCOPY 1U<<5
117 #define PMf_CHARSET 7U<<6
118 #define PMf_SPLIT 1U<<9
120 #if PMf_MULTILINE != RXf_PMf_MULTILINE || PMf_SINGLELINE != RXf_PMf_SINGLELINE || PMf_FOLD != RXf_PMf_FOLD || PMf_EXTENDED != RXf_PMf_EXTENDED || PMf_EXTENDED_MORE != RXf_PMf_EXTENDED_MORE || PMf_KEEPCOPY != RXf_PMf_KEEPCOPY || PMf_SPLIT != RXf_PMf_SPLIT || PMf_CHARSET != RXf_PMf_CHARSET
121 # error RXf_PMf defines are wrong
124 /* Error check that haven't left something out of this. This isn't done
125 * directly in the #define because doing so confuses regcomp.pl.
126 * (2**n - 1) is n 1 bits, so the below gets the contiguous bits between the
127 * beginning and ending shifts */
128 #if RXf_PMf_COMPILETIME != (((1 << (_RXf_PMf_SHIFT_COMPILETIME))-1) \
129 & (~((1 << RXf_PMf_STD_PMMOD_SHIFT)-1)))
130 # error RXf_PMf_COMPILETIME is invalid
133 #endif /* Include only once */