This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Bump several file copyright dates
[perl5.git] / op_reg_common.h
CommitLineData
1850c8f9
KW
1/* op_reg_common.h
2 *
3 * Definitions common to by op.h and regexp.h
4 *
2eee27d7 5 * Copyright (C) 2010, 2011 by Larry Wall and others
1850c8f9
KW
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
5b126c84
KW
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 */
da494bb7 21/* Make sure to update ext/re/re.pm when changing this! */
93136d17
KW
22#ifndef RXf_PMf_STD_PMMOD_SHIFT /* Only expand #include of this file once */
23
5b126c84
KW
24#define RXf_PMf_STD_PMMOD_SHIFT 0
25
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 */
1e215989 29/* Make sure to update lib/re.pm when changing these! */
5b126c84
KW
30#define RXf_PMf_MULTILINE (1 << (RXf_PMf_STD_PMMOD_SHIFT+0)) /* /m */
31#define RXf_PMf_SINGLELINE (1 << (RXf_PMf_STD_PMMOD_SHIFT+1)) /* /s */
32#define RXf_PMf_FOLD (1 << (RXf_PMf_STD_PMMOD_SHIFT+2)) /* /i */
33#define RXf_PMf_EXTENDED (1 << (RXf_PMf_STD_PMMOD_SHIFT+3)) /* /x */
34#define RXf_PMf_KEEPCOPY (1 << (RXf_PMf_STD_PMMOD_SHIFT+4)) /* /p */
a62b1201
KW
35
36/* The character set for the regex is stored in a field of more than one bit
37 * using an enum, for reasons of compactness and to ensure that the options are
38 * mutually exclusive */
da494bb7 39/* Make sure to update ext/re/re.pm when changing this! */
a62b1201
KW
40typedef enum {
41 REGEX_DEPENDS_CHARSET = 0,
42 REGEX_LOCALE_CHARSET,
cfaf538b 43 REGEX_UNICODE_CHARSET,
df7a8460
KW
44 REGEX_ASCII_RESTRICTED_CHARSET,
45 REGEX_ASCII_MORE_RESTRICTED_CHARSET
a62b1201
KW
46} regex_charset;
47
48#define _RXf_PMf_CHARSET_SHIFT ((RXf_PMf_STD_PMMOD_SHIFT)+5)
df7a8460 49#define RXf_PMf_CHARSET (7 << (_RXf_PMf_CHARSET_SHIFT)) /* 3 bits */
a62b1201 50
759ba3f2
KW
51/* Manually decorate these functions here with gcc-style attributes just to
52 * avoid making the regex_charset typedef global, which it would need to be for
53 * proto.h to understand it */
a62b1201
KW
54PERL_STATIC_INLINE void
55set_regex_charset(U32 * const flags, const regex_charset cs)
56 __attribute__nonnull__(1);
57
58PERL_STATIC_INLINE void
59set_regex_charset(U32 * const flags, const regex_charset cs)
60{
61 /* Sets the character set portion of 'flags' to 'cs', which is a member of
62 * the above enum */
63
64 *flags &= ~RXf_PMf_CHARSET;
65 *flags |= (cs << _RXf_PMf_CHARSET_SHIFT);
66}
67
68PERL_STATIC_INLINE regex_charset
69get_regex_charset(const U32 flags)
70 __attribute__warn_unused_result__;
71
72PERL_STATIC_INLINE regex_charset
73get_regex_charset(const U32 flags)
74{
75 /* Returns the enum corresponding to the character set in 'flags' */
76
bfba585a 77 return (regex_charset) ((flags & RXf_PMf_CHARSET) >> _RXf_PMf_CHARSET_SHIFT);
a62b1201 78}
1850c8f9 79
3214c85f
KW
80/* Next available bit after the above. Name begins with '_' so won't be
81 * exported by B */
df7a8460 82#define _RXf_PMf_SHIFT_NEXT (RXf_PMf_STD_PMMOD_SHIFT+8)
bb1c6009 83
5b126c84
KW
84/* Mask of the above bits. These need to be transferred from op_pmflags to
85 * re->extflags during compilation */
a62b1201 86#define RXf_PMf_COMPILETIME (RXf_PMf_MULTILINE|RXf_PMf_SINGLELINE|RXf_PMf_CHARSET|RXf_PMf_FOLD|RXf_PMf_EXTENDED|RXf_PMf_KEEPCOPY)
bb1c6009
KW
87
88/* These copies need to be numerical or defsubs_h.PL won't know about them. */
89#define PMf_MULTILINE 1<<0
90#define PMf_SINGLELINE 1<<1
91#define PMf_FOLD 1<<2
92#define PMf_EXTENDED 1<<3
93#define PMf_KEEPCOPY 1<<4
bb1c6009 94
a62b1201 95#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
bb1c6009
KW
96# error RXf_PMf defines are wrong
97#endif
5b126c84
KW
98
99#define PMf_COMPILETIME RXf_PMf_COMPILETIME
100
101/* Error check that haven't left something out of this. This isn't done
102 * directly in the #define because doing so confuses regcomp.pl.
103 * (2**n - 1) is n 1 bits, so the below gets the contiguous bits between the
104 * beginning and ending shifts */
105#if RXf_PMf_COMPILETIME != (((1 << (_RXf_PMf_SHIFT_NEXT))-1) \
106 & (~((1 << RXf_PMf_STD_PMMOD_SHIFT)-1)))
107# error RXf_PMf_COMPILETIME is invalid
108#endif
93136d17
KW
109
110#endif /* Include only once */