onig/
flags.rs

1use bitflags::bitflags;
2use std::os::raw::c_uint;
3
4bitflags! {
5    /// Regex parsing and compilation options.
6    #[derive(PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Clone, Copy)]
7    pub struct RegexOptions: onig_sys::OnigOptionType {
8        /// Default options.
9        const REGEX_OPTION_NONE
10            = onig_sys::ONIG_OPTION_NONE;
11        /// Ambiguity match on.
12        const REGEX_OPTION_IGNORECASE
13            = onig_sys::ONIG_OPTION_IGNORECASE;
14        /// Extended pattern form.
15        const REGEX_OPTION_EXTEND
16            = onig_sys::ONIG_OPTION_EXTEND;
17        /// `'.'` match with newline.
18        const REGEX_OPTION_MULTILINE
19            = onig_sys::ONIG_OPTION_MULTILINE;
20        /// `'^'` -> `'\A'`, `'$'` -> `'\Z'`.
21        const REGEX_OPTION_SINGLELINE
22            = onig_sys::ONIG_OPTION_SINGLELINE;
23        /// Find longest match.
24        const REGEX_OPTION_FIND_LONGEST
25            = onig_sys::ONIG_OPTION_FIND_LONGEST;
26        /// Ignore empty match.
27        const REGEX_OPTION_FIND_NOT_EMPTY
28            = onig_sys::ONIG_OPTION_FIND_NOT_EMPTY;
29        /// Clear `OPTION_SINGLELINE` which is enabled on
30        /// `SYNTAX_POSIX_BASIC`, `SYNTAX_POSIX_EXTENDED`,
31        /// `SYNTAX_PERL`, `SYNTAX_PERL_NG`, `SYNTAX_JAVA`.
32        const REGEX_OPTION_NEGATE_SINGLELINE
33            = onig_sys::ONIG_OPTION_NEGATE_SINGLELINE;
34        /// Only named group captured.
35        const REGEX_OPTION_DONT_CAPTURE_GROUP
36            = onig_sys::ONIG_OPTION_DONT_CAPTURE_GROUP;
37        /// Named and no-named group captured.
38        const REGEX_OPTION_CAPTURE_GROUP
39            = onig_sys::ONIG_OPTION_CAPTURE_GROUP;
40    }
41}
42
43bitflags! {
44    /// Regex evaluation options.
45    #[derive(PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Clone, Copy)]
46    pub struct SearchOptions: onig_sys::OnigOptionType {
47        /// Default options.
48        const SEARCH_OPTION_NONE
49            = onig_sys::ONIG_OPTION_NONE;
50        /// String head isn't considered as begin of line.
51        const SEARCH_OPTION_NOTBOL
52            = onig_sys::ONIG_OPTION_NOTBOL;
53        /// String end isn't considered as end of line.
54        const SEARCH_OPTION_NOTEOL
55            = onig_sys::ONIG_OPTION_NOTEOL;
56        /// Try and match the pattern against the whole string.
57        const SEARCH_OPTION_WHOLE_STRING
58            = onig_sys::ONIG_OPTION_MATCH_WHOLE_STRING;
59    }
60}
61
62bitflags! {
63    /// Defines the different operators allowed within a regex syntax.
64    #[derive(PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Clone, Copy)]
65    pub struct SyntaxOperator: u64 {
66        /// `.`
67        const SYNTAX_OPERATOR_DOT_ANYCHAR
68            = (onig_sys::ONIG_SYN_OP_DOT_ANYCHAR as u64);
69        /// `*`
70        const SYNTAX_OPERATOR_ASTERISK_ZERO_INF
71            = (onig_sys::ONIG_SYN_OP_ASTERISK_ZERO_INF as u64);
72        /// `+`
73        const SYNTAX_OPERATOR_PLUS_ONE_INF
74            = (onig_sys::ONIG_SYN_OP_PLUS_ONE_INF as u64);
75        /// `?`
76        const SYNTAX_OPERATOR_QMARK_ZERO_ONE
77            = (onig_sys::ONIG_SYN_OP_QMARK_ZERO_ONE as u64);
78    /// ?P
79    const SYNTAX_OPERATOR_QMARK_CAPITAL_P_NAME
80        = (onig_sys::ONIG_SYN_OP2_QMARK_CAPITAL_P_NAME as u64);
81        /// `{lower,upper}`
82        const SYNTAX_OPERATOR_BRACE_INTERVAL
83            = (onig_sys::ONIG_SYN_OP_BRACE_INTERVAL as u64);
84        /// `\{lower,upper\}`
85        const SYNTAX_OPERATOR_ESC_BRACE_INTERVAL
86            = (onig_sys::ONIG_SYN_OP_ESC_BRACE_INTERVAL as u64);
87        /// `|`
88        const SYNTAX_OPERATOR_VBAR_ALT
89            = (onig_sys::ONIG_SYN_OP_VBAR_ALT as u64);
90        /// `\|`
91        const SYNTAX_OPERATOR_ESC_VBAR_ALT
92            = (onig_sys::ONIG_SYN_OP_ESC_VBAR_ALT as u64);
93        /// `(...)`
94        const SYNTAX_OPERATOR_LPAREN_SUBEXP
95            = (onig_sys::ONIG_SYN_OP_LPAREN_SUBEXP as u64);
96        /// `\(...\)`
97        const SYNTAX_OPERATOR_ESC_LPAREN_SUBEXP
98            = (onig_sys::ONIG_SYN_OP_ESC_LPAREN_SUBEXP as u64);
99        /// `\A, \Z, \z`
100        const SYNTAX_OPERATOR_ESC_AZ_BUF_ANCHOR
101            = (onig_sys::ONIG_SYN_OP_ESC_AZ_BUF_ANCHOR as u64);
102        /// `\G`
103        const SYNTAX_OPERATOR_ESC_CAPITAL_G_BEGIN_ANCHOR
104            = (onig_sys::ONIG_SYN_OP_ESC_CAPITAL_G_BEGIN_ANCHOR as u64);
105        /// `\num`
106        const SYNTAX_OPERATOR_DECIMAL_BACKREF
107            = (onig_sys::ONIG_SYN_OP_DECIMAL_BACKREF as u64);
108        /// `[...]`
109        const SYNTAX_OPERATOR_BRACKET_CC
110            = (onig_sys::ONIG_SYN_OP_BRACKET_CC as u64);
111        /// `\w, \W`
112        const SYNTAX_OPERATOR_ESC_W_WORD
113            = (onig_sys::ONIG_SYN_OP_ESC_W_WORD as u64);
114        /// `\<. \>`
115        const SYNTAX_OPERATOR_ESC_LTGT_WORD_BEGIN_END
116            = (onig_sys::ONIG_SYN_OP_ESC_LTGT_WORD_BEGIN_END as u64);
117        /// `\b, \B`
118        const SYNTAX_OPERATOR_ESC_B_WORD_BOUND
119            = (onig_sys::ONIG_SYN_OP_ESC_B_WORD_BOUND as u64);
120        /// `\s, \S`
121        const SYNTAX_OPERATOR_ESC_S_WHITE_SPACE
122            = (onig_sys::ONIG_SYN_OP_ESC_S_WHITE_SPACE as u64);
123        /// `\d, \D`
124        const SYNTAX_OPERATOR_ESC_D_DIGIT
125            = (onig_sys::ONIG_SYN_OP_ESC_D_DIGIT as u64);
126        /// `^, $`
127        const SYNTAX_OPERATOR_LINE_ANCHOR
128            = (onig_sys::ONIG_SYN_OP_LINE_ANCHOR as u64);
129        /// `[:xxxx:]`
130        const SYNTAX_OPERATOR_POSIX_BRACKET
131            = (onig_sys::ONIG_SYN_OP_POSIX_BRACKET as u64);
132        /// `??,*?,+?,{n,m}?`
133        const SYNTAX_OPERATOR_QMARK_NON_GREEDY
134            = (onig_sys::ONIG_SYN_OP_QMARK_NON_GREEDY as u64);
135        /// `\n,\r,\t,\a ...`
136        const SYNTAX_OPERATOR_ESC_CONTROL_CHARS
137            = (onig_sys::ONIG_SYN_OP_ESC_CONTROL_CHARS as u64);
138        /// `\cx`
139        const SYNTAX_OPERATOR_ESC_C_CONTROL
140            = (onig_sys::ONIG_SYN_OP_ESC_C_CONTROL as u64);
141        /// `\OOO`
142        const SYNTAX_OPERATOR_ESC_OCTAL3
143            = (onig_sys::ONIG_SYN_OP_ESC_OCTAL3 as u64);
144        /// `\xHH`
145        const SYNTAX_OPERATOR_ESC_X_HEX2
146            = (onig_sys::ONIG_SYN_OP_ESC_X_HEX2 as u64);
147        /// `\x{7HHHHHHH}`
148        const SYNTAX_OPERATOR_ESC_X_BRACE_HEX8
149            = (onig_sys::ONIG_SYN_OP_ESC_X_BRACE_HEX8 as u64);
150        /// Variable meta characters
151        const SYNTAX_OPERATOR_VARIABLE_META_CHARACTERS
152            = (onig_sys::ONIG_SYN_OP_VARIABLE_META_CHARACTERS as u64);
153        /// `\Q...\E`
154        const SYNTAX_OPERATOR_ESC_CAPITAL_Q_QUOTE
155            = (onig_sys::ONIG_SYN_OP2_ESC_CAPITAL_Q_QUOTE as u64) << 32;
156        /// `(?...)`
157        const SYNTAX_OPERATOR_QMARK_GROUP_EFFECT
158            = (onig_sys::ONIG_SYN_OP2_QMARK_GROUP_EFFECT as u64) << 32;
159        /// `(?imsx),(?-imsx)`
160        const SYNTAX_OPERATOR_OPTION_PERL
161            = (onig_sys::ONIG_SYN_OP2_OPTION_PERL as u64) << 32;
162        /// `(?imx), (?-imx)`
163        const SYNTAX_OPERATOR_OPTION_RUBY
164            = (onig_sys::ONIG_SYN_OP2_OPTION_RUBY as u64) << 32;
165        /// `?+,*+,++`
166        const SYNTAX_OPERATOR_PLUS_POSSESSIVE_REPEAT
167            = (onig_sys::ONIG_SYN_OP2_PLUS_POSSESSIVE_REPEAT as u64) << 32;
168        /// `{n,m}+`
169        const SYNTAX_OPERATOR_PLUS_POSSESSIVE_INTERVAL
170            = (onig_sys::ONIG_SYN_OP2_PLUS_POSSESSIVE_INTERVAL as u64) << 32;
171        /// `[...&&..[..]..]`
172        const SYNTAX_OPERATOR_CCLASS_SET_OP
173            = (onig_sys::ONIG_SYN_OP2_CCLASS_SET_OP as u64) << 32;
174        /// `(?<name>...)`
175        const SYNTAX_OPERATOR_QMARK_LT_NAMED_GROUP
176            = (onig_sys::ONIG_SYN_OP2_QMARK_LT_NAMED_GROUP as u64) << 32;
177        /// `\k<name>`
178        const SYNTAX_OPERATOR_ESC_K_NAMED_BACKREF
179            = (onig_sys::ONIG_SYN_OP2_ESC_K_NAMED_BACKREF as u64) << 32;
180        /// `\g<name>, \g<n>`
181        const SYNTAX_OPERATOR_ESC_G_SUBEXP_CALL
182            = (onig_sys::ONIG_SYN_OP2_ESC_G_SUBEXP_CALL as u64) << 32;
183        /// `(?@..),(?@<x>..)`
184        const SYNTAX_OPERATOR_ATMARK_CAPTURE_HISTORY
185            = (onig_sys::ONIG_SYN_OP2_ATMARK_CAPTURE_HISTORY as u64) << 32;
186        /// `\C-x`
187        const SYNTAX_OPERATOR_ESC_CAPITAL_C_BAR_CONTROL
188            = (onig_sys::ONIG_SYN_OP2_ESC_CAPITAL_C_BAR_CONTROL as u64) << 32;
189        /// `\M-x`
190        const SYNTAX_OPERATOR_ESC_CAPITAL_M_BAR_META
191            = (onig_sys::ONIG_SYN_OP2_ESC_CAPITAL_M_BAR_META as u64) << 32;
192        /// `\v as VTAB`
193        const SYNTAX_OPERATOR_ESC_V_VTAB
194            = (onig_sys::ONIG_SYN_OP2_ESC_V_VTAB as u64) << 32;
195        /// `\uHHHH`
196        const SYNTAX_OPERATOR_ESC_U_HEX4
197            = (onig_sys::ONIG_SYN_OP2_ESC_U_HEX4 as u64) << 32;
198        /// `\`, \'`
199        const SYNTAX_OPERATOR_ESC_GNU_BUF_ANCHOR
200            = (onig_sys::ONIG_SYN_OP2_ESC_GNU_BUF_ANCHOR as u64) << 32;
201        /// `\p{...}, \P{...}`
202        const SYNTAX_OPERATOR_ESC_P_BRACE_CHAR_PROPERTY
203            = (onig_sys::ONIG_SYN_OP2_ESC_P_BRACE_CHAR_PROPERTY as u64) << 32;
204        /// `\p{^..}, \P{^..}`
205        const SYNTAX_OPERATOR_ESC_P_BRACE_CIRCUMFLEX_NOT
206            = (onig_sys::ONIG_SYN_OP2_ESC_P_BRACE_CIRCUMFLEX_NOT as u64) << 32;
207        /// `\h, \H`
208        const SYNTAX_OPERATOR_ESC_H_XDIGIT
209            = (onig_sys::ONIG_SYN_OP2_ESC_H_XDIGIT as u64) << 32;
210        /// `\`
211        const SYNTAX_OPERATOR_INEFFECTIVE_ESCAPE
212            = (onig_sys::ONIG_SYN_OP2_INEFFECTIVE_ESCAPE as u64) << 32;
213    }
214}
215
216bitflags! {
217    /// Defines the behaviour of regex operators.
218    #[derive(PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Clone, Copy)]
219    pub struct SyntaxBehavior: onig_sys::OnigSyntaxBehavior {
220        /// `?, *, +, {n,m}`
221        const SYNTAX_BEHAVIOR_CONTEXT_INDEP_REPEAT_OPS
222            = onig_sys::ONIG_SYN_CONTEXT_INDEP_REPEAT_OPS;
223        /// `error or ignore`
224        const SYNTAX_BEHAVIOR_CONTEXT_INVALID_REPEAT_OPS
225            = onig_sys::ONIG_SYN_CONTEXT_INVALID_REPEAT_OPS;
226        /// `...)...`
227        const SYNTAX_BEHAVIOR_ALLOW_UNMATCHED_CLOSE_SUBEXP
228            = onig_sys::ONIG_SYN_ALLOW_UNMATCHED_CLOSE_SUBEXP;
229        /// `{???`
230        const SYNTAX_BEHAVIOR_ALLOW_INVALID_INTERVAL
231            = onig_sys::ONIG_SYN_ALLOW_INVALID_INTERVAL;
232        /// `{,n} => {0,n}`
233        const SYNTAX_BEHAVIOR_ALLOW_INTERVAL_LOW_ABBREV
234            = onig_sys::ONIG_SYN_ALLOW_INTERVAL_LOW_ABBREV;
235        /// `/(\1)/,/\1()/ ..`
236        const SYNTAX_BEHAVIOR_STRICT_CHECK_BACKREF
237            = onig_sys::ONIG_SYN_STRICT_CHECK_BACKREF;
238        /// `(?<=a|bc)`
239        const SYNTAX_BEHAVIOR_DIFFERENT_LEN_ALT_LOOK_BEHIND
240            = onig_sys::ONIG_SYN_DIFFERENT_LEN_ALT_LOOK_BEHIND;
241        /// See Oniguruma documenation
242        const SYNTAX_BEHAVIOR_CAPTURE_ONLY_NAMED_GROUP
243            = onig_sys::ONIG_SYN_CAPTURE_ONLY_NAMED_GROUP;
244        /// `(?<x>)(?<x>)`
245        const SYNTAX_BEHAVIOR_ALLOW_MULTIPLEX_DEFINITION_NAME
246            = onig_sys::ONIG_SYN_ALLOW_MULTIPLEX_DEFINITION_NAME;
247        /// `a{n}?=(?:a{n})?`
248        const SYNTAX_BEHAVIOR_FIXED_INTERVAL_IS_GREEDY_ONLY
249            = onig_sys::ONIG_SYN_FIXED_INTERVAL_IS_GREEDY_ONLY;
250        /// `[^...]`
251        const SYNTAX_BEHAVIOR_NOT_NEWLINE_IN_NEGATIVE_CC
252            = onig_sys::ONIG_SYN_NOT_NEWLINE_IN_NEGATIVE_CC;
253        /// `[..\w..] etc..`
254        const SYNTAX_BEHAVIOR_BACKSLASH_ESCAPE_IN_CC
255            = onig_sys::ONIG_SYN_BACKSLASH_ESCAPE_IN_CC;
256        /// `[0-9-a]=[0-9\-a]`
257        const SYNTAX_BEHAVIOR_ALLOW_DOUBLE_RANGE_OP_IN_CC
258            = onig_sys::ONIG_SYN_ALLOW_DOUBLE_RANGE_OP_IN_CC;
259        /// `[,-,]`
260        const SYNTAX_BEHAVIOR_WARN_CC_OP_NOT_ESCAPED
261            = onig_sys::ONIG_SYN_WARN_CC_OP_NOT_ESCAPED;
262        /// `(?:a*)+`
263        const SYNTAX_BEHAVIOR_WARN_REDUNDANT_NESTED_REPEAT
264            = onig_sys::ONIG_SYN_WARN_REDUNDANT_NESTED_REPEAT;
265    }
266}
267
268bitflags! {
269    /// The order in which traverse callbacks are invoked
270    #[derive(PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Clone, Copy)]
271    pub struct TraverseCallbackAt: c_uint {
272        /// Callback before children are wallked
273        const CALLBACK_AT_FIRST =
274            onig_sys::ONIG_TRAVERSE_CALLBACK_AT_FIRST;
275        /// Callback after children are walked
276        const CALLBACK_AT_LAST =
277            onig_sys::ONIG_TRAVERSE_CALLBACK_AT_LAST;
278        /// Callback both before and after children are walked.
279        const CALLBACK_AT_BOTH =
280            onig_sys::ONIG_TRAVERSE_CALLBACK_AT_BOTH;
281    }
282}
283
284bitflags! {
285    /// Syntax meta character types
286    #[derive(PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Clone, Copy)]
287    pub struct MetaCharType: c_uint {
288        /// The escape charater for this syntax
289        const META_CHAR_ESCAPE = onig_sys::ONIG_META_CHAR_ESCAPE;
290        /// The any (.) character for this syntax.
291        const META_CHAR_ANYCHAR =  onig_sys::ONIG_META_CHAR_ANYCHAR;
292        /// The any number of repeats (*) character for this syntax.
293        const META_CHAR_ANYTIME =  onig_sys::ONIG_META_CHAR_ANYTIME;
294        /// The optinoal (?) chracter for this syntax
295        const META_CHAR_ZERO_OR_ONE_TIME =  onig_sys::ONIG_META_CHAR_ZERO_OR_ONE_TIME;
296        /// The at least once (+) character for this syntax
297        const META_CHAR_ONE_OR_MORE_TIME =  onig_sys::ONIG_META_CHAR_ONE_OR_MORE_TIME;
298        /// The glob character for this syntax (.*)
299        const META_CHAR_ANYCHAR_ANYTIME =  onig_sys::ONIG_META_CHAR_ANYCHAR_ANYTIME;
300    }
301}
onig/flags.rs

onig/
flags.rs
