Oniguruma
🔠 The regular expression library that powered Ruby & PHP
Loading...
Searching...
No Matches
oniguruma.h
Go to the documentation of this file.
1#ifndef ONIGURUMA_H
2#define ONIGURUMA_H
10#ifdef __cplusplus
11extern "C" {
12#endif
13
14#define ONIGURUMA
15#define ONIGURUMA_VERSION_MAJOR 6
16#define ONIGURUMA_VERSION_MINOR 9
18#define ONIGURUMA_VERSION_TEENY 8
19#define ONIGURUMA_VERSION_PATCH 8
20#define ONIGURUMA_VERSION_INT 60908
21
22#ifndef P_
23#if defined(__STDC__) || defined(_WIN32)
24#define P_(args) args
25#else
26#define P_(args) ()
27#endif
28#endif
29
30#ifndef PV_
31#define PV_(args) args
32#endif
33
34#ifndef ONIG_STATIC
35#ifndef ONIG_EXTERN
36#if defined(_WIN32) && !defined(__GNUC__)
37#if defined(ONIGURUMA_EXPORT)
38#define ONIG_EXTERN extern __declspec(dllexport)
39#else
40#define ONIG_EXTERN extern __declspec(dllimport)
41#endif
42#endif
43#endif
44
45#ifndef ONIG_EXTERN
46#define ONIG_EXTERN extern
47#endif
48#else
49#define ONIG_EXTERN extern
50#endif
51
52#ifndef ONIG_VARIADIC_FUNC_ATTR
53#define ONIG_VARIADIC_FUNC_ATTR
54#endif
55
56/* PART: character encoding */
57
58#ifndef ONIG_ESCAPE_UCHAR_COLLISION
60#define UChar OnigUChar
61#endif
62
64typedef unsigned int OnigCodePoint;
66typedef unsigned char OnigUChar;
68typedef unsigned int OnigCtype;
70typedef unsigned int OnigLen;
71
72#define ONIG_INFINITE_DISTANCE ~((OnigLen)0)
73
74typedef unsigned int OnigCaseFoldType; /* case fold flag */
75
76ONIG_EXTERN OnigCaseFoldType OnigDefaultCaseFoldFlag;
77
78#define ONIGENC_CASE_FOLD_ASCII_ONLY (1)
79/* #define ONIGENC_CASE_FOLD_HIRAGANA_KATAKANA (1<<1) */
80/* #define ONIGENC_CASE_FOLD_KATAKANA_WIDTH (1<<2) */
81#define ONIGENC_CASE_FOLD_TURKISH_AZERI (1 << 20)
82#define INTERNAL_ONIGENC_CASE_FOLD_MULTI_CHAR (1 << 30)
83
84#define ONIGENC_CASE_FOLD_MIN INTERNAL_ONIGENC_CASE_FOLD_MULTI_CHAR
85#define ONIGENC_CASE_FOLD_DEFAULT OnigDefaultCaseFoldFlag
86
87#define ONIGENC_MAX_COMP_CASE_FOLD_CODE_LEN 3
88#define ONIGENC_GET_CASE_FOLD_CODES_MAX_NUM 13
89/* 13 => Unicode:0x1ffc */
90
91/* code range */
92#define ONIGENC_CODE_RANGE_NUM(range) ((int)range[0])
93#define ONIGENC_CODE_RANGE_FROM(range, i) range[((i)*2) + 1]
94#define ONIGENC_CODE_RANGE_TO(range, i) range[((i)*2) + 2]
95
96typedef struct {
97 int byte_len; /* argument(original) character(s) byte length */
98 int code_len; /* number of code */
99 OnigCodePoint code[ONIGENC_MAX_COMP_CASE_FOLD_CODE_LEN];
101
102typedef struct {
103 OnigCodePoint esc;
104 OnigCodePoint anychar;
105 OnigCodePoint anytime;
106 OnigCodePoint zero_or_one_time;
107 OnigCodePoint one_or_more_time;
108 OnigCodePoint anychar_anytime;
110
111typedef int (*OnigApplyAllCaseFoldFunc)(OnigCodePoint from, OnigCodePoint *to,
112 int to_len, void *arg);
113
114typedef struct OnigEncodingTypeST {
115 int (*mbc_enc_len)(const OnigUChar *p);
116 const char *name;
117 int max_enc_len;
118 int min_enc_len;
119 int (*is_mbc_newline)(const OnigUChar *p, const OnigUChar *end);
120 OnigCodePoint (*mbc_to_code)(const OnigUChar *p, const OnigUChar *end);
121 int (*code_to_mbclen)(OnigCodePoint code);
122 int (*code_to_mbc)(OnigCodePoint code, OnigUChar *buf);
123 int (*mbc_case_fold)(OnigCaseFoldType flag, const OnigUChar **pp,
124 const OnigUChar *end, OnigUChar *to);
125 int (*apply_all_case_fold)(OnigCaseFoldType flag, OnigApplyAllCaseFoldFunc f,
126 void *arg);
127 int (*get_case_fold_codes_by_str)(OnigCaseFoldType flag, const OnigUChar *p,
128 const OnigUChar *end,
130 int (*property_name_to_ctype)(struct OnigEncodingTypeST *enc, OnigUChar *p,
131 OnigUChar *end);
132 int (*is_code_ctype)(OnigCodePoint code, OnigCtype ctype);
133 int (*get_ctype_code_range)(OnigCtype ctype, OnigCodePoint *sb_out,
134 const OnigCodePoint *ranges[]);
135 OnigUChar *(*left_adjust_char_head)(const OnigUChar *start,
136 const OnigUChar *p);
137 int (*is_allowed_reverse_match)(const OnigUChar *p, const OnigUChar *end);
138 int (*init)(void);
139 int (*is_initialized)(void);
140 int (*is_valid_mbc_string)(const OnigUChar *s, const OnigUChar *end);
141 unsigned int flag;
142 OnigCodePoint sb_range;
143 int index;
145
147
148ONIG_EXTERN OnigEncodingType OnigEncodingASCII;
149ONIG_EXTERN OnigEncodingType OnigEncodingISO_8859_1;
150ONIG_EXTERN OnigEncodingType OnigEncodingISO_8859_2;
151ONIG_EXTERN OnigEncodingType OnigEncodingISO_8859_3;
152ONIG_EXTERN OnigEncodingType OnigEncodingISO_8859_4;
153ONIG_EXTERN OnigEncodingType OnigEncodingISO_8859_5;
154ONIG_EXTERN OnigEncodingType OnigEncodingISO_8859_6;
155ONIG_EXTERN OnigEncodingType OnigEncodingISO_8859_7;
156ONIG_EXTERN OnigEncodingType OnigEncodingISO_8859_8;
157ONIG_EXTERN OnigEncodingType OnigEncodingISO_8859_9;
158ONIG_EXTERN OnigEncodingType OnigEncodingISO_8859_10;
159ONIG_EXTERN OnigEncodingType OnigEncodingISO_8859_11;
160ONIG_EXTERN OnigEncodingType OnigEncodingISO_8859_13;
161ONIG_EXTERN OnigEncodingType OnigEncodingISO_8859_14;
162ONIG_EXTERN OnigEncodingType OnigEncodingISO_8859_15;
163ONIG_EXTERN OnigEncodingType OnigEncodingISO_8859_16;
164ONIG_EXTERN OnigEncodingType OnigEncodingUTF8;
165ONIG_EXTERN OnigEncodingType OnigEncodingUTF16_BE;
166ONIG_EXTERN OnigEncodingType OnigEncodingUTF16_LE;
167ONIG_EXTERN OnigEncodingType OnigEncodingUTF32_BE;
168ONIG_EXTERN OnigEncodingType OnigEncodingUTF32_LE;
169ONIG_EXTERN OnigEncodingType OnigEncodingEUC_JP;
170ONIG_EXTERN OnigEncodingType OnigEncodingEUC_TW;
171ONIG_EXTERN OnigEncodingType OnigEncodingEUC_KR;
172ONIG_EXTERN OnigEncodingType OnigEncodingEUC_CN;
173ONIG_EXTERN OnigEncodingType OnigEncodingSJIS;
174ONIG_EXTERN OnigEncodingType OnigEncodingKOI8;
175ONIG_EXTERN OnigEncodingType OnigEncodingKOI8_R;
176ONIG_EXTERN OnigEncodingType OnigEncodingCP1251;
177ONIG_EXTERN OnigEncodingType OnigEncodingBIG5;
178ONIG_EXTERN OnigEncodingType OnigEncodingGB18030;
179
180#define ONIG_ENCODING_ASCII (&OnigEncodingASCII)
181#define ONIG_ENCODING_ISO_8859_1 (&OnigEncodingISO_8859_1)
182#define ONIG_ENCODING_ISO_8859_2 (&OnigEncodingISO_8859_2)
183#define ONIG_ENCODING_ISO_8859_3 (&OnigEncodingISO_8859_3)
184#define ONIG_ENCODING_ISO_8859_4 (&OnigEncodingISO_8859_4)
185#define ONIG_ENCODING_ISO_8859_5 (&OnigEncodingISO_8859_5)
186#define ONIG_ENCODING_ISO_8859_6 (&OnigEncodingISO_8859_6)
187#define ONIG_ENCODING_ISO_8859_7 (&OnigEncodingISO_8859_7)
188#define ONIG_ENCODING_ISO_8859_8 (&OnigEncodingISO_8859_8)
189#define ONIG_ENCODING_ISO_8859_9 (&OnigEncodingISO_8859_9)
190#define ONIG_ENCODING_ISO_8859_10 (&OnigEncodingISO_8859_10)
191#define ONIG_ENCODING_ISO_8859_11 (&OnigEncodingISO_8859_11)
192#define ONIG_ENCODING_ISO_8859_13 (&OnigEncodingISO_8859_13)
193#define ONIG_ENCODING_ISO_8859_14 (&OnigEncodingISO_8859_14)
194#define ONIG_ENCODING_ISO_8859_15 (&OnigEncodingISO_8859_15)
195#define ONIG_ENCODING_ISO_8859_16 (&OnigEncodingISO_8859_16)
196#define ONIG_ENCODING_UTF8 (&OnigEncodingUTF8)
197#define ONIG_ENCODING_UTF16_BE (&OnigEncodingUTF16_BE)
198#define ONIG_ENCODING_UTF16_LE (&OnigEncodingUTF16_LE)
199#define ONIG_ENCODING_UTF32_BE (&OnigEncodingUTF32_BE)
200#define ONIG_ENCODING_UTF32_LE (&OnigEncodingUTF32_LE)
201#define ONIG_ENCODING_EUC_JP (&OnigEncodingEUC_JP)
202#define ONIG_ENCODING_EUC_TW (&OnigEncodingEUC_TW)
203#define ONIG_ENCODING_EUC_KR (&OnigEncodingEUC_KR)
204#define ONIG_ENCODING_EUC_CN (&OnigEncodingEUC_CN)
205#define ONIG_ENCODING_SJIS (&OnigEncodingSJIS)
206#define ONIG_ENCODING_KOI8 (&OnigEncodingKOI8)
207#define ONIG_ENCODING_KOI8_R (&OnigEncodingKOI8_R)
208#define ONIG_ENCODING_CP1251 (&OnigEncodingCP1251)
209#define ONIG_ENCODING_BIG5 (&OnigEncodingBIG5)
210#define ONIG_ENCODING_GB18030 (&OnigEncodingGB18030)
211
212#define ONIG_ENCODING_UNDEF ((OnigEncoding)0)
213
214/* work size */
215#define ONIGENC_CODE_TO_MBC_MAXLEN 7
216#define ONIGENC_MBC_CASE_FOLD_MAXLEN 18
217/* 18: 6(max-byte) * 3(case-fold chars) */
218
219/* character types */
220typedef enum {
221 ONIGENC_CTYPE_NEWLINE = 0,
222 ONIGENC_CTYPE_ALPHA = 1,
223 ONIGENC_CTYPE_BLANK = 2,
224 ONIGENC_CTYPE_CNTRL = 3,
225 ONIGENC_CTYPE_DIGIT = 4,
226 ONIGENC_CTYPE_GRAPH = 5,
227 ONIGENC_CTYPE_LOWER = 6,
228 ONIGENC_CTYPE_PRINT = 7,
229 ONIGENC_CTYPE_PUNCT = 8,
230 ONIGENC_CTYPE_SPACE = 9,
231 ONIGENC_CTYPE_UPPER = 10,
232 ONIGENC_CTYPE_XDIGIT = 11,
233 ONIGENC_CTYPE_WORD = 12,
234 ONIGENC_CTYPE_ALNUM = 13, /* alpha || digit */
235 ONIGENC_CTYPE_ASCII = 14
236} OnigEncCtype;
237
238#define ONIGENC_MAX_STD_CTYPE ONIGENC_CTYPE_ASCII
239
240#define onig_enc_len(enc, p, end) ONIGENC_MBC_ENC_LEN(enc, p)
241
242#define ONIGENC_IS_UNDEF(enc) ((enc) == ONIG_ENCODING_UNDEF)
243#define ONIGENC_IS_SINGLEBYTE(enc) (ONIGENC_MBC_MAXLEN(enc) == 1)
244#define ONIGENC_IS_MBC_HEAD(enc, p) (ONIGENC_MBC_ENC_LEN(enc, p) != 1)
245#define ONIGENC_IS_MBC_ASCII(p) (*(p) < 128)
246#define ONIGENC_IS_CODE_ASCII(code) ((code) < 128)
247#define ONIGENC_IS_MBC_WORD(enc, s, end) \
248 ONIGENC_IS_CODE_WORD(enc, ONIGENC_MBC_TO_CODE(enc, s, end))
249#define ONIGENC_IS_MBC_WORD_ASCII(enc, s, end) \
250 onigenc_is_mbc_word_ascii(enc, s, end)
251
252#define ONIGENC_NAME(enc) ((enc)->name)
253
254#define ONIGENC_MBC_CASE_FOLD(enc, flag, pp, end, buf) \
255 (enc)->mbc_case_fold(flag, (const OnigUChar **)pp, end, buf)
256#define ONIGENC_IS_ALLOWED_REVERSE_MATCH(enc, s, end) \
257 (enc)->is_allowed_reverse_match(s, end)
258#define ONIGENC_LEFT_ADJUST_CHAR_HEAD(enc, start, s) \
259 (enc)->left_adjust_char_head(start, s)
260#define ONIGENC_IS_VALID_MBC_STRING(enc, s, end) \
261 (enc)->is_valid_mbc_string(s, end)
262#define ONIGENC_APPLY_ALL_CASE_FOLD(enc, case_fold_flag, f, arg) \
263 (enc)->apply_all_case_fold(case_fold_flag, f, arg)
264#define ONIGENC_GET_CASE_FOLD_CODES_BY_STR(enc, case_fold_flag, p, end, acs) \
265 (enc)->get_case_fold_codes_by_str(case_fold_flag, p, end, acs)
266#define ONIGENC_STEP_BACK(enc, start, s, n) \
267 onigenc_step_back((enc), (start), (s), (n))
268
269#define ONIGENC_MBC_ENC_LEN(enc, p) (enc)->mbc_enc_len(p)
270#define ONIGENC_MBC_MAXLEN(enc) ((enc)->max_enc_len)
271#define ONIGENC_MBC_MAXLEN_DIST(enc) ONIGENC_MBC_MAXLEN(enc)
272#define ONIGENC_MBC_MINLEN(enc) ((enc)->min_enc_len)
273#define ONIGENC_IS_MBC_NEWLINE(enc, p, end) (enc)->is_mbc_newline((p), (end))
274#define ONIGENC_MBC_TO_CODE(enc, p, end) (enc)->mbc_to_code((p), (end))
275#define ONIGENC_CODE_TO_MBCLEN(enc, code) (enc)->code_to_mbclen(code)
276#define ONIGENC_CODE_TO_MBC(enc, code, buf) (enc)->code_to_mbc(code, buf)
277#define ONIGENC_PROPERTY_NAME_TO_CTYPE(enc, p, end) \
278 (enc)->property_name_to_ctype(enc, p, end)
279
280#define ONIGENC_IS_CODE_CTYPE(enc, code, ctype) \
281 (enc)->is_code_ctype(code, ctype)
282
283#define ONIGENC_IS_CODE_NEWLINE(enc, code) \
284 ONIGENC_IS_CODE_CTYPE(enc, code, ONIGENC_CTYPE_NEWLINE)
285#define ONIGENC_IS_CODE_GRAPH(enc, code) \
286 ONIGENC_IS_CODE_CTYPE(enc, code, ONIGENC_CTYPE_GRAPH)
287#define ONIGENC_IS_CODE_PRINT(enc, code) \
288 ONIGENC_IS_CODE_CTYPE(enc, code, ONIGENC_CTYPE_PRINT)
289#define ONIGENC_IS_CODE_ALNUM(enc, code) \
290 ONIGENC_IS_CODE_CTYPE(enc, code, ONIGENC_CTYPE_ALNUM)
291#define ONIGENC_IS_CODE_ALPHA(enc, code) \
292 ONIGENC_IS_CODE_CTYPE(enc, code, ONIGENC_CTYPE_ALPHA)
293#define ONIGENC_IS_CODE_LOWER(enc, code) \
294 ONIGENC_IS_CODE_CTYPE(enc, code, ONIGENC_CTYPE_LOWER)
295#define ONIGENC_IS_CODE_UPPER(enc, code) \
296 ONIGENC_IS_CODE_CTYPE(enc, code, ONIGENC_CTYPE_UPPER)
297#define ONIGENC_IS_CODE_CNTRL(enc, code) \
298 ONIGENC_IS_CODE_CTYPE(enc, code, ONIGENC_CTYPE_CNTRL)
299#define ONIGENC_IS_CODE_PUNCT(enc, code) \
300 ONIGENC_IS_CODE_CTYPE(enc, code, ONIGENC_CTYPE_PUNCT)
301#define ONIGENC_IS_CODE_SPACE(enc, code) \
302 ONIGENC_IS_CODE_CTYPE(enc, code, ONIGENC_CTYPE_SPACE)
303#define ONIGENC_IS_CODE_BLANK(enc, code) \
304 ONIGENC_IS_CODE_CTYPE(enc, code, ONIGENC_CTYPE_BLANK)
305#define ONIGENC_IS_CODE_DIGIT(enc, code) \
306 ONIGENC_IS_CODE_CTYPE(enc, code, ONIGENC_CTYPE_DIGIT)
307#define ONIGENC_IS_CODE_XDIGIT(enc, code) \
308 ONIGENC_IS_CODE_CTYPE(enc, code, ONIGENC_CTYPE_XDIGIT)
309#define ONIGENC_IS_CODE_WORD(enc, code) \
310 ONIGENC_IS_CODE_CTYPE(enc, code, ONIGENC_CTYPE_WORD)
311
312#define ONIGENC_GET_CTYPE_CODE_RANGE(enc, ctype, sbout, ranges) \
313 (enc)->get_ctype_code_range(ctype, sbout, ranges)
314
315ONIG_EXTERN
316OnigUChar *onigenc_step_back P_((OnigEncoding enc, const OnigUChar *start,
317 const OnigUChar *s, int n));
318
319/* encoding API */
320ONIG_EXTERN
321int onigenc_init P_((void));
322ONIG_EXTERN
323int onig_initialize_encoding P_((OnigEncoding enc));
324ONIG_EXTERN
325int onigenc_set_default_encoding P_((OnigEncoding enc));
326ONIG_EXTERN
327OnigEncoding onigenc_get_default_encoding P_((void));
328ONIG_EXTERN
329void onigenc_set_default_caseconv_table P_((const OnigUChar *table));
330ONIG_EXTERN
331OnigUChar *onigenc_get_right_adjust_char_head_with_prev
332 P_((OnigEncoding enc, const OnigUChar *start, const OnigUChar *s,
333 const OnigUChar **prev));
334ONIG_EXTERN
335OnigUChar *onigenc_get_prev_char_head P_((OnigEncoding enc,
336 const OnigUChar *start,
337 const OnigUChar *s));
338ONIG_EXTERN
339OnigUChar *onigenc_get_left_adjust_char_head P_((OnigEncoding enc,
340 const OnigUChar *start,
341 const OnigUChar *s));
342ONIG_EXTERN
343OnigUChar *onigenc_get_right_adjust_char_head P_((OnigEncoding enc,
344 const OnigUChar *start,
345 const OnigUChar *s));
346ONIG_EXTERN
347int onigenc_strlen P_((OnigEncoding enc, const OnigUChar *p,
348 const OnigUChar *end));
349ONIG_EXTERN
350int onigenc_strlen_null P_((OnigEncoding enc, const OnigUChar *p));
351ONIG_EXTERN
352int onigenc_str_bytelen_null P_((OnigEncoding enc, const OnigUChar *p));
353ONIG_EXTERN
354int onigenc_is_valid_mbc_string P_((OnigEncoding enc, const OnigUChar *s,
355 const OnigUChar *end));
356ONIG_EXTERN
357OnigUChar *onigenc_strdup P_((OnigEncoding enc, const OnigUChar *s,
358 const OnigUChar *end));
359
360/* PART: regular expression */
361
362/* config parameters */
363#define ONIG_NREGION 10
364#define ONIG_MAX_CAPTURE_NUM 2147483647 /* 2**31 - 1 */
365#define ONIG_MAX_BACKREF_NUM 1000
366#define ONIG_MAX_REPEAT_NUM 100000
367#define ONIG_MAX_MULTI_BYTE_RANGES_NUM 10000
368/* constants */
369#define ONIG_MAX_ERROR_MESSAGE_LEN 90
370
371typedef unsigned int OnigOptionType;
372
373#define ONIG_OPTION_DEFAULT ONIG_OPTION_NONE
374
375/* options */
376#define ONIG_OPTION_NONE 0U
377/* options (compile time) */
378#define ONIG_OPTION_IGNORECASE 1U
379#define ONIG_OPTION_EXTEND (ONIG_OPTION_IGNORECASE << 1)
380#define ONIG_OPTION_MULTILINE (ONIG_OPTION_EXTEND << 1)
381#define ONIG_OPTION_SINGLELINE (ONIG_OPTION_MULTILINE << 1)
382#define ONIG_OPTION_FIND_LONGEST (ONIG_OPTION_SINGLELINE << 1)
383#define ONIG_OPTION_FIND_NOT_EMPTY (ONIG_OPTION_FIND_LONGEST << 1)
384#define ONIG_OPTION_NEGATE_SINGLELINE (ONIG_OPTION_FIND_NOT_EMPTY << 1)
385#define ONIG_OPTION_DONT_CAPTURE_GROUP (ONIG_OPTION_NEGATE_SINGLELINE << 1)
386#define ONIG_OPTION_CAPTURE_GROUP (ONIG_OPTION_DONT_CAPTURE_GROUP << 1)
387/* options (search time) */
388#define ONIG_OPTION_NOTBOL (ONIG_OPTION_CAPTURE_GROUP << 1)
389#define ONIG_OPTION_NOTEOL (ONIG_OPTION_NOTBOL << 1)
390#define ONIG_OPTION_POSIX_REGION (ONIG_OPTION_NOTEOL << 1)
391#define ONIG_OPTION_CHECK_VALIDITY_OF_STRING (ONIG_OPTION_POSIX_REGION << 1)
392/* options (compile time) */
393#define ONIG_OPTION_IGNORECASE_IS_ASCII \
394 (ONIG_OPTION_CHECK_VALIDITY_OF_STRING << 3)
395#define ONIG_OPTION_WORD_IS_ASCII (ONIG_OPTION_IGNORECASE_IS_ASCII << 1)
396#define ONIG_OPTION_DIGIT_IS_ASCII (ONIG_OPTION_WORD_IS_ASCII << 1)
397#define ONIG_OPTION_SPACE_IS_ASCII (ONIG_OPTION_DIGIT_IS_ASCII << 1)
398#define ONIG_OPTION_POSIX_IS_ASCII (ONIG_OPTION_SPACE_IS_ASCII << 1)
399#define ONIG_OPTION_TEXT_SEGMENT_EXTENDED_GRAPHEME_CLUSTER \
400 (ONIG_OPTION_POSIX_IS_ASCII << 1)
401#define ONIG_OPTION_TEXT_SEGMENT_WORD \
402 (ONIG_OPTION_TEXT_SEGMENT_EXTENDED_GRAPHEME_CLUSTER << 1)
403/* options (search time) */
404#define ONIG_OPTION_NOT_BEGIN_STRING (ONIG_OPTION_TEXT_SEGMENT_WORD << 1)
405#define ONIG_OPTION_NOT_END_STRING (ONIG_OPTION_NOT_BEGIN_STRING << 1)
406#define ONIG_OPTION_NOT_BEGIN_POSITION (ONIG_OPTION_NOT_END_STRING << 1)
407#define ONIG_OPTION_CALLBACK_EACH_MATCH (ONIG_OPTION_NOT_BEGIN_POSITION << 1)
408#define ONIG_OPTION_MATCH_WHOLE_STRING (ONIG_OPTION_CALLBACK_EACH_MATCH << 1)
409
410#define ONIG_OPTION_MAXBIT ONIG_OPTION_MATCH_WHOLE_STRING
411
412#define ONIG_OPTION_ON(options, regopt) ((options) |= (regopt))
413#define ONIG_OPTION_OFF(options, regopt) ((options) &= ~(regopt))
414#define ONIG_IS_OPTION_ON(options, option) ((options) & (option))
415
416/* syntax */
417typedef struct {
418 unsigned int op;
419 unsigned int op2;
420 unsigned int behavior;
421 OnigOptionType options; /* default option */
422 OnigMetaCharTableType meta_char_table;
424
425ONIG_EXTERN OnigSyntaxType OnigSyntaxASIS;
426ONIG_EXTERN OnigSyntaxType OnigSyntaxPosixBasic;
427ONIG_EXTERN OnigSyntaxType OnigSyntaxPosixExtended;
428ONIG_EXTERN OnigSyntaxType OnigSyntaxEmacs;
429ONIG_EXTERN OnigSyntaxType OnigSyntaxGrep;
430ONIG_EXTERN OnigSyntaxType OnigSyntaxGnuRegex;
431ONIG_EXTERN OnigSyntaxType OnigSyntaxJava;
432ONIG_EXTERN OnigSyntaxType OnigSyntaxPerl;
433ONIG_EXTERN OnigSyntaxType OnigSyntaxPerl_NG;
434ONIG_EXTERN OnigSyntaxType OnigSyntaxRuby;
435ONIG_EXTERN OnigSyntaxType OnigSyntaxPython;
436ONIG_EXTERN OnigSyntaxType OnigSyntaxOniguruma;
437
438/* predefined syntaxes (see regsyntax.c) */
439#define ONIG_SYNTAX_ASIS (&OnigSyntaxASIS)
440#define ONIG_SYNTAX_POSIX_BASIC (&OnigSyntaxPosixBasic)
441#define ONIG_SYNTAX_POSIX_EXTENDED (&OnigSyntaxPosixExtended)
442#define ONIG_SYNTAX_EMACS (&OnigSyntaxEmacs)
443#define ONIG_SYNTAX_GREP (&OnigSyntaxGrep)
444#define ONIG_SYNTAX_GNU_REGEX (&OnigSyntaxGnuRegex)
445#define ONIG_SYNTAX_JAVA (&OnigSyntaxJava)
446#define ONIG_SYNTAX_PERL (&OnigSyntaxPerl)
447#define ONIG_SYNTAX_PERL_NG (&OnigSyntaxPerl_NG)
448#define ONIG_SYNTAX_RUBY (&OnigSyntaxRuby)
449#define ONIG_SYNTAX_PYTHON (&OnigSyntaxPython)
450#define ONIG_SYNTAX_ONIGURUMA (&OnigSyntaxOniguruma)
451
452/* default syntax */
453ONIG_EXTERN OnigSyntaxType *OnigDefaultSyntax;
454#define ONIG_SYNTAX_DEFAULT OnigDefaultSyntax
455
456/* syntax (operators) */
457#define ONIG_SYN_OP_VARIABLE_META_CHARACTERS (1U << 0)
458#define ONIG_SYN_OP_DOT_ANYCHAR (1U << 1) /* . */
459#define ONIG_SYN_OP_ASTERISK_ZERO_INF (1U << 2) /* * */
460#define ONIG_SYN_OP_ESC_ASTERISK_ZERO_INF (1U << 3)
461#define ONIG_SYN_OP_PLUS_ONE_INF (1U << 4) /* + */
462#define ONIG_SYN_OP_ESC_PLUS_ONE_INF (1U << 5)
463#define ONIG_SYN_OP_QMARK_ZERO_ONE (1U << 6) /* ? */
464#define ONIG_SYN_OP_ESC_QMARK_ZERO_ONE (1U << 7)
465#define ONIG_SYN_OP_BRACE_INTERVAL (1U << 8) /* {lower,upper} */
466#define ONIG_SYN_OP_ESC_BRACE_INTERVAL (1U << 9) /* \{lower,upper\} */
467#define ONIG_SYN_OP_VBAR_ALT (1U << 10) /* | */
468#define ONIG_SYN_OP_ESC_VBAR_ALT (1U << 11) /* \| */
469#define ONIG_SYN_OP_LPAREN_SUBEXP (1U << 12) /* (...) */
470#define ONIG_SYN_OP_ESC_LPAREN_SUBEXP (1U << 13) /* \‍(...\‍) */
471#define ONIG_SYN_OP_ESC_AZ_BUF_ANCHOR (1U << 14) /* \A, \Z, \z */
472#define ONIG_SYN_OP_ESC_CAPITAL_G_BEGIN_ANCHOR (1U << 15) /* \G */
473#define ONIG_SYN_OP_DECIMAL_BACKREF (1U << 16) /* \num */
474#define ONIG_SYN_OP_BRACKET_CC (1U << 17) /* [...] */
475#define ONIG_SYN_OP_ESC_W_WORD (1U << 18) /* \w, \W */
476#define ONIG_SYN_OP_ESC_LTGT_WORD_BEGIN_END (1U << 19) /* <. > */
477#define ONIG_SYN_OP_ESC_B_WORD_BOUND (1U << 20) /* \b, \B */
478#define ONIG_SYN_OP_ESC_S_WHITE_SPACE (1U << 21) /* \s, \S */
479#define ONIG_SYN_OP_ESC_D_DIGIT (1U << 22) /* \d, \D */
480#define ONIG_SYN_OP_LINE_ANCHOR (1U << 23) /* ^, $ */
481#define ONIG_SYN_OP_POSIX_BRACKET (1U << 24) /* [:xxxx:] */
482#define ONIG_SYN_OP_QMARK_NON_GREEDY (1U << 25) /* ??,*?,+?,{n,m}? */
483#define ONIG_SYN_OP_ESC_CONTROL_CHARS (1U << 26) /* \n,\r,\t,\a ... */
484#define ONIG_SYN_OP_ESC_C_CONTROL (1U << 27) /* \cx */
485#define ONIG_SYN_OP_ESC_OCTAL3 (1U << 28) /* \OOO */
486#define ONIG_SYN_OP_ESC_X_HEX2 (1U << 29) /* \xHH */
487#define ONIG_SYN_OP_ESC_X_BRACE_HEX8 (1U << 30) /* \x{7HHHHHHH} */
488#define ONIG_SYN_OP_ESC_O_BRACE_OCTAL (1U << 31) /* \o{1OOOOOOOOOO} */
489
490#define ONIG_SYN_OP2_ESC_CAPITAL_Q_QUOTE (1U << 0) /* \Q...\E */
491#define ONIG_SYN_OP2_QMARK_GROUP_EFFECT (1U << 1) /* (?...) */
492#define ONIG_SYN_OP2_OPTION_PERL (1U << 2) /* (?imsx),(?-imsx) */
493#define ONIG_SYN_OP2_OPTION_RUBY (1U << 3) /* (?imx), (?-imx) */
494#define ONIG_SYN_OP2_PLUS_POSSESSIVE_REPEAT (1U << 4) /* ?+,*+,++ */
495#define ONIG_SYN_OP2_PLUS_POSSESSIVE_INTERVAL (1U << 5) /* {n,m}+ */
496#define ONIG_SYN_OP2_CCLASS_SET_OP (1U << 6) /* [...&&..[..]..] */
497#define ONIG_SYN_OP2_QMARK_LT_NAMED_GROUP (1U << 7) /* (?<name>...) */
498#define ONIG_SYN_OP2_ESC_K_NAMED_BACKREF (1U << 8) /* \k<name> */
499#define ONIG_SYN_OP2_ESC_G_SUBEXP_CALL (1U << 9) /* \g<name>, \g<n> */
500#define ONIG_SYN_OP2_ATMARK_CAPTURE_HISTORY (1U << 10) /* (?@..),(?@<x>..) */
501#define ONIG_SYN_OP2_ESC_CAPITAL_C_BAR_CONTROL (1U << 11) /* \C-x */
502#define ONIG_SYN_OP2_ESC_CAPITAL_M_BAR_META (1U << 12) /* \M-x */
503#define ONIG_SYN_OP2_ESC_V_VTAB (1U << 13) /* \v as VTAB */
504#define ONIG_SYN_OP2_ESC_U_HEX4 (1U << 14) /* \uHHHH */
505#define ONIG_SYN_OP2_ESC_GNU_BUF_ANCHOR (1U << 15) /* \`, \' */
506#define ONIG_SYN_OP2_ESC_P_BRACE_CHAR_PROPERTY \
507 (1U << 16) /* \p{...}, \P{...} \
508 */
509#define ONIG_SYN_OP2_ESC_P_BRACE_CIRCUMFLEX_NOT \
510 (1U << 17) /* \p{^..}, \P{^..} */
511/* #define ONIG_SYN_OP2_CHAR_PROPERTY_PREFIX_IS (1U<<18) */
512#define ONIG_SYN_OP2_ESC_H_XDIGIT (1U << 19) /* \h, \H */
513#define ONIG_SYN_OP2_INEFFECTIVE_ESCAPE (1U << 20) /* \ */
514#define ONIG_SYN_OP2_QMARK_LPAREN_IF_ELSE \
515 (1U << 21) /* (?(n)) (?(...)...|...) */
516#define ONIG_SYN_OP2_ESC_CAPITAL_K_KEEP (1U << 22) /* \K */
517#define ONIG_SYN_OP2_ESC_CAPITAL_R_GENERAL_NEWLINE \
518 (1U << 23) /* \R \r\n else [\x0a-\x0d] */
519#define ONIG_SYN_OP2_ESC_CAPITAL_N_O_SUPER_DOT \
520 (1U << 24) /* \N (?-m:.), \O (?m:.) */
521#define ONIG_SYN_OP2_QMARK_TILDE_ABSENT_GROUP (1U << 25) /* (?~...) */
522#define ONIG_SYN_OP2_ESC_X_Y_GRAPHEME_CLUSTER \
523 (1U << 26) /* obsoleted: use next */
524#define ONIG_SYN_OP2_ESC_X_Y_TEXT_SEGMENT (1U << 26) /* \X \y \Y */
525#define ONIG_SYN_OP2_QMARK_PERL_SUBEXP_CALL (1U << 27) /* (?R), (?&name)... */
526#define ONIG_SYN_OP2_QMARK_BRACE_CALLOUT_CONTENTS \
527 (1U << 28) /* (?{...}) (?{{...}}) */
528#define ONIG_SYN_OP2_ASTERISK_CALLOUT_NAME \
529 (1U << 29) /* (*name) (*name{a,..}) */
530#define ONIG_SYN_OP2_OPTION_ONIGURUMA (1U << 30) /* (?imxWDSPy) */
531#define ONIG_SYN_OP2_QMARK_CAPITAL_P_NAME \
532 (1U << 31) /* (?P<name>...) (?P=name) */
533
534/* syntax (behavior) */
535#define ONIG_SYN_CONTEXT_INDEP_ANCHORS (1U << 31) /* not implemented */
536#define ONIG_SYN_CONTEXT_INDEP_REPEAT_OPS (1U << 0) /* ?, *, +, {n,m} */
537#define ONIG_SYN_CONTEXT_INVALID_REPEAT_OPS (1U << 1) /* error or ignore */
538#define ONIG_SYN_ALLOW_UNMATCHED_CLOSE_SUBEXP (1U << 2) /* ...)... */
539#define ONIG_SYN_ALLOW_INVALID_INTERVAL (1U << 3) /* {??? */
540#define ONIG_SYN_ALLOW_INTERVAL_LOW_ABBREV (1U << 4) /* {,n} => {0,n} */
541#define ONIG_SYN_STRICT_CHECK_BACKREF (1U << 5) /* /(\1)/,/\1()/ ..*/
542#define ONIG_SYN_DIFFERENT_LEN_ALT_LOOK_BEHIND (1U << 6) /* (?<=a|bc) */
543#define ONIG_SYN_CAPTURE_ONLY_NAMED_GROUP (1U << 7) /* see doc/RE */
544#define ONIG_SYN_ALLOW_MULTIPLEX_DEFINITION_NAME (1U << 8) /* (?<x>)(?<x>) */
545#define ONIG_SYN_FIXED_INTERVAL_IS_GREEDY_ONLY (1U << 9) /* a{n}?=(?:a{n})? */
546#define ONIG_SYN_ISOLATED_OPTION_CONTINUE_BRANCH \
547 (1U << 10) /* ..(?i)...|... \
548 */
549#define ONIG_SYN_VARIABLE_LEN_LOOK_BEHIND (1U << 11) /* (?<=a+|..) */
550#define ONIG_SYN_PYTHON (1U << 12) /* \UHHHHHHHH */
551#define ONIG_SYN_WHOLE_OPTIONS (1U << 13) /* (?Ie) */
552#define ONIG_SYN_BRE_ANCHOR_AT_EDGE_OF_SUBEXP (1U << 14) /* \‍(^abc$\‍) */
553
554/* syntax (behavior) in char class [...] */
555#define ONIG_SYN_NOT_NEWLINE_IN_NEGATIVE_CC (1U << 20) /* [^...] */
556#define ONIG_SYN_BACKSLASH_ESCAPE_IN_CC (1U << 21) /* [..\w..] etc.. */
557#define ONIG_SYN_ALLOW_EMPTY_RANGE_IN_CC (1U << 22)
558#define ONIG_SYN_ALLOW_DOUBLE_RANGE_OP_IN_CC (1U << 23) /* [0-9-a]=[0-9\-a] */
559#define ONIG_SYN_ALLOW_INVALID_CODE_END_OF_RANGE_IN_CC (1U << 26)
560/* syntax (behavior) warning */
561#define ONIG_SYN_WARN_CC_OP_NOT_ESCAPED (1U << 24) /* [,-,] */
562#define ONIG_SYN_WARN_REDUNDANT_NESTED_REPEAT (1U << 25) /* (?:a*)+ */
563
564/* meta character specifiers (onig_set_meta_char()) */
565#define ONIG_META_CHAR_ESCAPE 0
566#define ONIG_META_CHAR_ANYCHAR 1
567#define ONIG_META_CHAR_ANYTIME 2
568#define ONIG_META_CHAR_ZERO_OR_ONE_TIME 3
569#define ONIG_META_CHAR_ONE_OR_MORE_TIME 4
570#define ONIG_META_CHAR_ANYCHAR_ANYTIME 5
571
572#define ONIG_INEFFECTIVE_META_CHAR 0
573
574/* error codes */
575#define ONIG_IS_PATTERN_ERROR(ecode) ((ecode) <= -100 && (ecode) > -1000)
576
577/* normal return */
578#define ONIG_NORMAL 0
579#define ONIG_VALUE_IS_NOT_SET 1
580#define ONIG_MISMATCH -1
581#define ONIG_NO_SUPPORT_CONFIG -2
582#define ONIG_ABORT -3
583
584/* internal error */
585#define ONIGERR_MEMORY -5
586#define ONIGERR_TYPE_BUG -6
587#define ONIGERR_PARSER_BUG -11
588#define ONIGERR_STACK_BUG -12
589#define ONIGERR_UNDEFINED_BYTECODE -13
590#define ONIGERR_UNEXPECTED_BYTECODE -14
591#define ONIGERR_MATCH_STACK_LIMIT_OVER -15
592#define ONIGERR_PARSE_DEPTH_LIMIT_OVER -16
593#define ONIGERR_RETRY_LIMIT_IN_MATCH_OVER -17
594#define ONIGERR_RETRY_LIMIT_IN_SEARCH_OVER -18
595#define ONIGERR_SUBEXP_CALL_LIMIT_IN_SEARCH_OVER -19
596#define ONIGERR_DEFAULT_ENCODING_IS_NOT_SETTED -21 /*dont use*/
597#define ONIGERR_DEFAULT_ENCODING_IS_NOT_SET -21
598#define ONIGERR_SPECIFIED_ENCODING_CANT_CONVERT_TO_WIDE_CHAR -22
599#define ONIGERR_FAIL_TO_INITIALIZE -23
600/* general error */
601#define ONIGERR_INVALID_ARGUMENT -30
602/* syntax error */
603#define ONIGERR_END_PATTERN_AT_LEFT_BRACE -100
604#define ONIGERR_END_PATTERN_AT_LEFT_BRACKET -101
605#define ONIGERR_EMPTY_CHAR_CLASS -102
606#define ONIGERR_PREMATURE_END_OF_CHAR_CLASS -103
607#define ONIGERR_END_PATTERN_AT_ESCAPE -104
608#define ONIGERR_END_PATTERN_AT_META -105
609#define ONIGERR_END_PATTERN_AT_CONTROL -106
610#define ONIGERR_META_CODE_SYNTAX -108
611#define ONIGERR_CONTROL_CODE_SYNTAX -109
612#define ONIGERR_CHAR_CLASS_VALUE_AT_END_OF_RANGE -110
613#define ONIGERR_CHAR_CLASS_VALUE_AT_START_OF_RANGE -111
614#define ONIGERR_UNMATCHED_RANGE_SPECIFIER_IN_CHAR_CLASS -112
615#define ONIGERR_TARGET_OF_REPEAT_OPERATOR_NOT_SPECIFIED -113
616#define ONIGERR_TARGET_OF_REPEAT_OPERATOR_INVALID -114
617#define ONIGERR_NESTED_REPEAT_OPERATOR -115
618#define ONIGERR_UNMATCHED_CLOSE_PARENTHESIS -116
619#define ONIGERR_END_PATTERN_WITH_UNMATCHED_PARENTHESIS -117
620#define ONIGERR_END_PATTERN_IN_GROUP -118
621#define ONIGERR_UNDEFINED_GROUP_OPTION -119
622#define ONIGERR_INVALID_GROUP_OPTION -120
623#define ONIGERR_INVALID_POSIX_BRACKET_TYPE -121
624#define ONIGERR_INVALID_LOOK_BEHIND_PATTERN -122
625#define ONIGERR_INVALID_REPEAT_RANGE_PATTERN -123
626/* values error (syntax error) */
627#define ONIGERR_TOO_BIG_NUMBER -200
628#define ONIGERR_TOO_BIG_NUMBER_FOR_REPEAT_RANGE -201
629#define ONIGERR_UPPER_SMALLER_THAN_LOWER_IN_REPEAT_RANGE -202
630#define ONIGERR_EMPTY_RANGE_IN_CHAR_CLASS -203
631#define ONIGERR_MISMATCH_CODE_LENGTH_IN_CLASS_RANGE -204
632#define ONIGERR_TOO_MANY_MULTI_BYTE_RANGES -205
633#define ONIGERR_TOO_SHORT_MULTI_BYTE_STRING -206
634#define ONIGERR_TOO_BIG_BACKREF_NUMBER -207
635#define ONIGERR_INVALID_BACKREF -208
636#define ONIGERR_NUMBERED_BACKREF_OR_CALL_NOT_ALLOWED -209
637#define ONIGERR_TOO_MANY_CAPTURES -210
638#define ONIGERR_TOO_LONG_WIDE_CHAR_VALUE -212
639#define ONIGERR_UNDEFINED_OPERATOR -213
640#define ONIGERR_EMPTY_GROUP_NAME -214
641#define ONIGERR_INVALID_GROUP_NAME -215
642#define ONIGERR_INVALID_CHAR_IN_GROUP_NAME -216
643#define ONIGERR_UNDEFINED_NAME_REFERENCE -217
644#define ONIGERR_UNDEFINED_GROUP_REFERENCE -218
645#define ONIGERR_MULTIPLEX_DEFINED_NAME -219
646#define ONIGERR_MULTIPLEX_DEFINITION_NAME_CALL -220
647#define ONIGERR_NEVER_ENDING_RECURSION -221
648#define ONIGERR_GROUP_NUMBER_OVER_FOR_CAPTURE_HISTORY -222
649#define ONIGERR_INVALID_CHAR_PROPERTY_NAME -223
650#define ONIGERR_INVALID_IF_ELSE_SYNTAX -224
651#define ONIGERR_INVALID_ABSENT_GROUP_PATTERN -225
652#define ONIGERR_INVALID_ABSENT_GROUP_GENERATOR_PATTERN -226
653#define ONIGERR_INVALID_CALLOUT_PATTERN -227
654#define ONIGERR_INVALID_CALLOUT_NAME -228
655#define ONIGERR_UNDEFINED_CALLOUT_NAME -229
656#define ONIGERR_INVALID_CALLOUT_BODY -230
657#define ONIGERR_INVALID_CALLOUT_TAG_NAME -231
658#define ONIGERR_INVALID_CALLOUT_ARG -232
659#define ONIGERR_INVALID_CODE_POINT_VALUE -400
660#define ONIGERR_INVALID_WIDE_CHAR_VALUE -400
661#define ONIGERR_TOO_BIG_WIDE_CHAR_VALUE -401
662#define ONIGERR_NOT_SUPPORTED_ENCODING_COMBINATION -402
663#define ONIGERR_INVALID_COMBINATION_OF_OPTIONS -403
664#define ONIGERR_TOO_MANY_USER_DEFINED_OBJECTS -404
665#define ONIGERR_TOO_LONG_PROPERTY_NAME -405
666#define ONIGERR_VERY_INEFFICIENT_PATTERN -406
667#define ONIGERR_LIBRARY_IS_NOT_INITIALIZED -500
668
669/* errors related to thread */
670/* #define ONIGERR_OVER_THREAD_PASS_LIMIT_COUNT -1001 */
671
672/* must be smaller than MEM_STATUS_BITS_NUM (unsigned int * 8) */
673#define ONIG_MAX_CAPTURE_HISTORY_GROUP 31
674#define ONIG_IS_CAPTURE_HISTORY_GROUP(r, i) \
675 ((i) <= ONIG_MAX_CAPTURE_HISTORY_GROUP && (r)->list && (r)->list[i])
676
677typedef struct OnigCaptureTreeNodeStruct {
678 int group; /* group number */
679 int beg;
680 int end;
681 int allocated;
682 int num_childs;
683 struct OnigCaptureTreeNodeStruct **childs;
686/* match result region type */
687struct re_registers {
688 int allocated;
689 int num_regs;
690 int *beg;
691 int *end;
692 /* extended */
693 OnigCaptureTreeNode *history_root; /* capture history tree root */
694};
695
696/* capture tree traverse */
697#define ONIG_TRAVERSE_CALLBACK_AT_FIRST 1
698#define ONIG_TRAVERSE_CALLBACK_AT_LAST 2
699#define ONIG_TRAVERSE_CALLBACK_AT_BOTH \
700 (ONIG_TRAVERSE_CALLBACK_AT_FIRST | ONIG_TRAVERSE_CALLBACK_AT_LAST)
701
702#define ONIG_REGION_NOTPOS -1
703
705
706typedef struct {
707 OnigEncoding enc;
708 OnigUChar *par;
709 OnigUChar *par_end;
711
712typedef struct {
713 int lower;
714 int upper;
716
717typedef void(*OnigWarnFunc) P_((const char *s));
718extern void onig_null_warn P_((const char *s));
719#define ONIG_NULL_WARN onig_null_warn
720
721#define ONIG_CHAR_TABLE_SIZE 256
722
723struct re_pattern_buffer;
724typedef struct re_pattern_buffer OnigRegexType;
725typedef OnigRegexType *OnigRegex;
726
727#ifndef ONIG_ESCAPE_REGEX_T_COLLISION
728typedef OnigRegexType regex_t;
729#endif
730
731struct OnigRegSetStruct;
732typedef struct OnigRegSetStruct OnigRegSet;
733
734typedef enum {
735 ONIG_REGSET_POSITION_LEAD = 0,
736 ONIG_REGSET_REGEX_LEAD = 1,
737 ONIG_REGSET_PRIORITY_TO_REGEX_ORDER = 2
738} OnigRegSetLead;
739
740typedef struct {
741 int num_of_elements;
742 OnigEncoding pattern_enc;
743 OnigEncoding target_enc;
744 OnigSyntaxType *syntax;
745 OnigOptionType option;
746 OnigCaseFoldType case_fold_flag;
748
749typedef int (*OnigCallbackEachMatchFunc)(const OnigUChar *str,
750 const OnigUChar *end,
751 const OnigUChar *match_start,
752 OnigRegion *region, void *user_data);
753
754/* types for callout */
755typedef enum {
756 ONIG_CALLOUT_IN_PROGRESS = 1, /* 1<<0 */
757 ONIG_CALLOUT_IN_RETRACTION = 2 /* 1<<1 */
758} OnigCalloutIn;
759
760#define ONIG_CALLOUT_IN_BOTH \
761 (ONIG_CALLOUT_IN_PROGRESS | ONIG_CALLOUT_IN_RETRACTION)
762
763typedef enum {
764 ONIG_CALLOUT_OF_CONTENTS = 0,
765 ONIG_CALLOUT_OF_NAME = 1
766} OnigCalloutOf;
767
768typedef enum {
769 ONIG_CALLOUT_TYPE_SINGLE = 0,
770 ONIG_CALLOUT_TYPE_START_CALL = 1,
771 ONIG_CALLOUT_TYPE_BOTH_CALL = 2,
772 ONIG_CALLOUT_TYPE_START_MARK_END_CALL = 3,
773} OnigCalloutType;
774
775#define ONIG_NON_NAME_ID -1
776#define ONIG_NON_CALLOUT_NUM 0
777
778#define ONIG_CALLOUT_MAX_ARGS_NUM 4
779#define ONIG_CALLOUT_DATA_SLOT_NUM 5
780
781struct OnigCalloutArgsStruct;
782typedef struct OnigCalloutArgsStruct OnigCalloutArgs;
783
784typedef int (*OnigCalloutFunc)(OnigCalloutArgs *args, void *user_data);
785
786/* callout function return values (less than -1: error code) */
787typedef enum {
788 ONIG_CALLOUT_FAIL = 1,
789 ONIG_CALLOUT_SUCCESS = 0
790} OnigCalloutResult;
791
792typedef enum {
793 ONIG_TYPE_VOID = 0,
794 ONIG_TYPE_LONG = 1 << 0,
795 ONIG_TYPE_CHAR = 1 << 1,
796 ONIG_TYPE_STRING = 1 << 2,
797 ONIG_TYPE_POINTER = 1 << 3,
798 ONIG_TYPE_TAG = 1 << 4,
799} OnigType;
800
801typedef union {
802 long l;
804 struct {
805 OnigUChar *start;
806 OnigUChar *end;
807 } s;
808 void *p;
809 int tag; /* tag -> callout_num */
810} OnigValue;
811
812struct OnigMatchParamStruct;
813typedef struct OnigMatchParamStruct OnigMatchParam;
814
815/* Oniguruma Native API */
816
832ONIG_EXTERN
833int onig_initialize(OnigEncoding encodings[], int number_of_encodings);
834
836ONIG_EXTERN
837int onig_init();
838
839ONIG_EXTERN
840int ONIG_VARIADIC_FUNC_ATTR onig_error_code_to_str PV_((OnigUChar * s,
841 int err_code, ...));
842ONIG_EXTERN
843int onig_is_error_code_needs_param PV_((int code));
844ONIG_EXTERN
845void onig_set_warn_func P_((OnigWarnFunc f));
846ONIG_EXTERN
847void onig_set_verb_warn_func P_((OnigWarnFunc f));
848ONIG_EXTERN
849int onig_new P_((OnigRegex *, const OnigUChar *pattern,
850 const OnigUChar *pattern_end, OnigOptionType option,
851 OnigEncoding enc, OnigSyntaxType *syntax,
852 OnigErrorInfo *einfo));
853ONIG_EXTERN
854int onig_reg_init P_((OnigRegex reg, OnigOptionType option,
855 OnigCaseFoldType case_fold_flag, OnigEncoding enc,
856 OnigSyntaxType *syntax));
857int onig_new_without_alloc P_((OnigRegex, const OnigUChar *pattern,
858 const OnigUChar *pattern_end,
859 OnigOptionType option, OnigEncoding enc,
860 OnigSyntaxType *syntax, OnigErrorInfo *einfo));
861ONIG_EXTERN
862int onig_new_deluxe P_((OnigRegex * reg, const OnigUChar *pattern,
863 const OnigUChar *pattern_end, OnigCompileInfo *ci,
864 OnigErrorInfo *einfo));
865ONIG_EXTERN
866void onig_free P_((OnigRegex));
867ONIG_EXTERN
868void onig_free_body P_((OnigRegex));
869ONIG_EXTERN
870int onig_scan(OnigRegex reg, const OnigUChar *str, const OnigUChar *end,
871 OnigRegion *region, OnigOptionType option,
872 int (*scan_callback)(int, int, OnigRegion *, void *),
873 void *callback_arg);
874ONIG_EXTERN
875int onig_search P_((OnigRegex, const OnigUChar *str, const OnigUChar *end,
876 const OnigUChar *start, const OnigUChar *range,
877 OnigRegion *region, OnigOptionType option));
878ONIG_EXTERN
879int onig_search_with_param P_((OnigRegex, const OnigUChar *str,
880 const OnigUChar *end, const OnigUChar *start,
881 const OnigUChar *range, OnigRegion *region,
882 OnigOptionType option, OnigMatchParam *mp));
883ONIG_EXTERN
884int onig_match P_((OnigRegex, const OnigUChar *str, const OnigUChar *end,
885 const OnigUChar *at, OnigRegion *region,
886 OnigOptionType option));
887ONIG_EXTERN
888int onig_match_with_param P_((OnigRegex, const OnigUChar *str,
889 const OnigUChar *end, const OnigUChar *at,
890 OnigRegion *region, OnigOptionType option,
891 OnigMatchParam *mp));
892
893ONIG_EXTERN
894int onig_regset_new P_((OnigRegSet * *rset, int n, OnigRegex regs[]));
895ONIG_EXTERN
896int onig_regset_add P_((OnigRegSet * set, OnigRegex reg));
897ONIG_EXTERN
898int onig_regset_replace P_((OnigRegSet * set, int at, OnigRegex reg));
899ONIG_EXTERN
900void onig_regset_free P_((OnigRegSet * set));
901ONIG_EXTERN
902int onig_regset_number_of_regex P_((OnigRegSet * set));
903ONIG_EXTERN
904OnigRegex onig_regset_get_regex P_((OnigRegSet * set, int at));
905ONIG_EXTERN
906OnigRegion *onig_regset_get_region P_((OnigRegSet * set, int at));
907ONIG_EXTERN
908int onig_regset_search P_((OnigRegSet * set, const OnigUChar *str,
909 const OnigUChar *end, const OnigUChar *start,
910 const OnigUChar *range, OnigRegSetLead lead,
911 OnigOptionType option, int *rmatch_pos));
912ONIG_EXTERN
913int onig_regset_search_with_param
914 P_((OnigRegSet * set, const OnigUChar *str, const OnigUChar *end,
915 const OnigUChar *start, const OnigUChar *range, OnigRegSetLead lead,
916 OnigOptionType option, OnigMatchParam *mps[], int *rmatch_pos));
917
918ONIG_EXTERN
919OnigRegion *onig_region_new P_((void));
920ONIG_EXTERN
921void onig_region_init P_((OnigRegion * region));
922ONIG_EXTERN
923void onig_region_free P_((OnigRegion * region, int free_self));
924ONIG_EXTERN
925void onig_region_copy P_((OnigRegion * to, OnigRegion *from));
926ONIG_EXTERN
927void onig_region_clear P_((OnigRegion * region));
928ONIG_EXTERN
929int onig_region_resize P_((OnigRegion * region, int n));
930ONIG_EXTERN
931int onig_region_set P_((OnigRegion * region, int at, int beg, int end));
932ONIG_EXTERN
933int onig_name_to_group_numbers P_((OnigRegex reg, const OnigUChar *name,
934 const OnigUChar *name_end, int **nums));
935ONIG_EXTERN
936int onig_name_to_backref_number P_((OnigRegex reg, const OnigUChar *name,
937 const OnigUChar *name_end,
938 OnigRegion *region));
939ONIG_EXTERN
940int onig_foreach_name P_((OnigRegex reg,
941 int (*func)(const OnigUChar *, const OnigUChar *, int,
942 int *, OnigRegex, void *),
943 void *arg));
944ONIG_EXTERN
945int onig_number_of_names P_((OnigRegex reg));
946ONIG_EXTERN
947int onig_number_of_captures P_((OnigRegex reg));
948ONIG_EXTERN
949int onig_number_of_capture_histories P_((OnigRegex reg));
950ONIG_EXTERN
951OnigCaptureTreeNode *onig_get_capture_tree P_((OnigRegion * region));
952ONIG_EXTERN
953int onig_capture_tree_traverse
954 P_((OnigRegion * region, int at,
955 int (*callback_func)(int, int, int, int, int, void *), void *arg));
956ONIG_EXTERN
957int onig_noname_group_capture_is_active P_((OnigRegex reg));
958ONIG_EXTERN
959OnigEncoding onig_get_encoding P_((OnigRegex reg));
960ONIG_EXTERN
961OnigOptionType onig_get_options P_((OnigRegex reg));
962ONIG_EXTERN
963OnigCaseFoldType onig_get_case_fold_flag P_((OnigRegex reg));
964ONIG_EXTERN
965OnigSyntaxType *onig_get_syntax P_((OnigRegex reg));
966ONIG_EXTERN
967int onig_set_default_syntax P_((OnigSyntaxType * syntax));
968ONIG_EXTERN
969void onig_copy_syntax P_((OnigSyntaxType * to, OnigSyntaxType *from));
970ONIG_EXTERN
971unsigned int onig_get_syntax_op P_((OnigSyntaxType * syntax));
972ONIG_EXTERN
973unsigned int onig_get_syntax_op2 P_((OnigSyntaxType * syntax));
974ONIG_EXTERN
975unsigned int onig_get_syntax_behavior P_((OnigSyntaxType * syntax));
976ONIG_EXTERN
977OnigOptionType onig_get_syntax_options P_((OnigSyntaxType * syntax));
978ONIG_EXTERN
979void onig_set_syntax_op P_((OnigSyntaxType * syntax, unsigned int op));
980ONIG_EXTERN
981void onig_set_syntax_op2 P_((OnigSyntaxType * syntax, unsigned int op2));
982ONIG_EXTERN
983void onig_set_syntax_behavior P_((OnigSyntaxType * syntax,
984 unsigned int behavior));
985ONIG_EXTERN
986void onig_set_syntax_options P_((OnigSyntaxType * syntax,
987 OnigOptionType options));
988ONIG_EXTERN
989int onig_set_meta_char P_((OnigSyntaxType * syntax, unsigned int what,
990 OnigCodePoint code));
991ONIG_EXTERN
992void onig_copy_encoding P_((OnigEncoding to, OnigEncoding from));
993ONIG_EXTERN
994OnigCaseFoldType onig_get_default_case_fold_flag P_((void));
995ONIG_EXTERN
996int onig_set_default_case_fold_flag P_((OnigCaseFoldType case_fold_flag));
997ONIG_EXTERN
998unsigned int onig_get_match_stack_limit_size P_((void));
999ONIG_EXTERN
1000int onig_set_match_stack_limit_size P_((unsigned int size));
1001ONIG_EXTERN
1002unsigned long onig_get_retry_limit_in_match P_((void));
1003ONIG_EXTERN
1004int onig_set_retry_limit_in_match P_((unsigned long n));
1005ONIG_EXTERN
1006unsigned long onig_get_retry_limit_in_search P_((void));
1007ONIG_EXTERN
1008int onig_set_retry_limit_in_search P_((unsigned long n));
1009ONIG_EXTERN
1010unsigned int onig_get_parse_depth_limit P_((void));
1011ONIG_EXTERN
1012int onig_set_capture_num_limit P_((int num));
1013ONIG_EXTERN
1014int onig_set_parse_depth_limit P_((unsigned int depth));
1015ONIG_EXTERN
1016unsigned long onig_get_subexp_call_limit_in_search P_((void));
1017ONIG_EXTERN
1018int onig_set_subexp_call_limit_in_search P_((unsigned long n));
1019ONIG_EXTERN
1020int onig_get_subexp_call_max_nest_level P_((void));
1021ONIG_EXTERN
1022int onig_set_subexp_call_max_nest_level P_((int level));
1023ONIG_EXTERN
1024int onig_unicode_define_user_property P_((const char *name,
1025 OnigCodePoint *ranges));
1026ONIG_EXTERN
1027int onig_end P_((void));
1028ONIG_EXTERN
1029const char *onig_version P_((void));
1030ONIG_EXTERN
1031const char *onig_copyright P_((void));
1032
1033/* for callback each match */
1034ONIG_EXTERN
1035OnigCallbackEachMatchFunc onig_get_callback_each_match P_((void));
1036ONIG_EXTERN
1037int onig_set_callback_each_match P_((OnigCallbackEachMatchFunc f));
1038
1039/* for OnigMatchParam */
1040ONIG_EXTERN
1041OnigMatchParam *onig_new_match_param P_((void));
1042ONIG_EXTERN
1043void onig_free_match_param P_((OnigMatchParam * p));
1044ONIG_EXTERN
1045void onig_free_match_param_content P_((OnigMatchParam * p));
1046ONIG_EXTERN
1047int onig_initialize_match_param P_((OnigMatchParam * mp));
1048ONIG_EXTERN
1049int onig_set_match_stack_limit_size_of_match_param P_((OnigMatchParam * param,
1050 unsigned int limit));
1051ONIG_EXTERN
1052int onig_set_retry_limit_in_match_of_match_param P_((OnigMatchParam * param,
1053 unsigned long limit));
1054ONIG_EXTERN
1055int onig_set_retry_limit_in_search_of_match_param P_((OnigMatchParam * param,
1056 unsigned long limit));
1057ONIG_EXTERN
1058int onig_set_progress_callout_of_match_param P_((OnigMatchParam * param,
1059 OnigCalloutFunc f));
1060ONIG_EXTERN
1061int onig_set_retraction_callout_of_match_param P_((OnigMatchParam * param,
1062 OnigCalloutFunc f));
1063ONIG_EXTERN
1064int onig_set_callout_user_data_of_match_param P_((OnigMatchParam * param,
1065 void *user_data));
1066
1067/* for callout functions */
1068ONIG_EXTERN
1069OnigCalloutFunc onig_get_progress_callout P_((void));
1070ONIG_EXTERN
1071int onig_set_progress_callout P_((OnigCalloutFunc f));
1072ONIG_EXTERN
1073OnigCalloutFunc onig_get_retraction_callout P_((void));
1074ONIG_EXTERN
1075int onig_set_retraction_callout P_((OnigCalloutFunc f));
1076ONIG_EXTERN
1077int onig_set_callout_of_name P_((OnigEncoding enc, OnigCalloutType type,
1078 OnigUChar *name, OnigUChar *name_end,
1079 int callout_in, OnigCalloutFunc callout,
1080 OnigCalloutFunc end_callout, int arg_num,
1081 unsigned int arg_types[], int optional_arg_num,
1082 OnigValue opt_defaults[]));
1083ONIG_EXTERN
1084OnigUChar *onig_get_callout_name_by_name_id P_((int id));
1085ONIG_EXTERN
1086int onig_get_callout_num_by_tag P_((OnigRegex reg, const OnigUChar *tag,
1087 const OnigUChar *tag_end));
1088ONIG_EXTERN
1089int onig_get_callout_data_by_tag P_((OnigRegex reg, OnigMatchParam *mp,
1090 const OnigUChar *tag,
1091 const OnigUChar *tag_end, int slot,
1092 OnigType *type, OnigValue *val));
1093ONIG_EXTERN
1094int onig_set_callout_data_by_tag P_((OnigRegex reg, OnigMatchParam *mp,
1095 const OnigUChar *tag,
1096 const OnigUChar *tag_end, int slot,
1097 OnigType type, OnigValue *val));
1098ONIG_EXTERN
1099int onig_get_callout_data_by_tag_dont_clear_old
1100 P_((OnigRegex reg, OnigMatchParam *mp, const OnigUChar *tag,
1101 const OnigUChar *tag_end, int slot, OnigType *type, OnigValue *val));
1102
1103/* used in callout functions */
1104ONIG_EXTERN
1105int onig_get_callout_num_by_callout_args P_((OnigCalloutArgs * args));
1106ONIG_EXTERN
1107OnigCalloutIn onig_get_callout_in_by_callout_args P_((OnigCalloutArgs * args));
1108ONIG_EXTERN
1109int onig_get_name_id_by_callout_args P_((OnigCalloutArgs * args));
1110ONIG_EXTERN
1111const OnigUChar *onig_get_contents_by_callout_args P_((OnigCalloutArgs * args));
1112ONIG_EXTERN
1113const OnigUChar *onig_get_contents_end_by_callout_args P_((OnigCalloutArgs *
1114 args));
1115ONIG_EXTERN
1116int onig_get_args_num_by_callout_args P_((OnigCalloutArgs * args));
1117ONIG_EXTERN
1118int onig_get_passed_args_num_by_callout_args P_((OnigCalloutArgs * args));
1119ONIG_EXTERN
1120int onig_get_arg_by_callout_args P_((OnigCalloutArgs * args, int index,
1121 OnigType *type, OnigValue *val));
1122ONIG_EXTERN
1123const OnigUChar *onig_get_string_by_callout_args P_((OnigCalloutArgs * args));
1124ONIG_EXTERN
1125const OnigUChar *onig_get_string_end_by_callout_args P_((OnigCalloutArgs *
1126 args));
1127ONIG_EXTERN
1128const OnigUChar *onig_get_start_by_callout_args P_((OnigCalloutArgs * args));
1129ONIG_EXTERN
1130const OnigUChar *onig_get_right_range_by_callout_args P_((OnigCalloutArgs *
1131 args));
1132ONIG_EXTERN
1133const OnigUChar *onig_get_current_by_callout_args P_((OnigCalloutArgs * args));
1134ONIG_EXTERN
1135OnigRegex onig_get_regex_by_callout_args P_((OnigCalloutArgs * args));
1136ONIG_EXTERN
1137unsigned long onig_get_retry_counter_by_callout_args P_((OnigCalloutArgs *
1138 args));
1139ONIG_EXTERN
1140int onig_callout_tag_is_exist_at_callout_num P_((OnigRegex reg,
1141 int callout_num));
1142ONIG_EXTERN
1143const OnigUChar *onig_get_callout_tag_start P_((OnigRegex reg,
1144 int callout_num));
1145ONIG_EXTERN
1146const OnigUChar *onig_get_callout_tag_end P_((OnigRegex reg, int callout_num));
1147ONIG_EXTERN
1148int onig_get_callout_data_dont_clear_old P_((OnigRegex reg, OnigMatchParam *mp,
1149 int callout_num, int slot,
1150 OnigType *type, OnigValue *val));
1151ONIG_EXTERN
1152int onig_get_callout_data_by_callout_args_self_dont_clear_old
1153 P_((OnigCalloutArgs * args, int slot, OnigType *type, OnigValue *val));
1154ONIG_EXTERN
1155int onig_get_callout_data P_((OnigRegex reg, OnigMatchParam *mp,
1156 int callout_num, int slot, OnigType *type,
1157 OnigValue *val));
1158ONIG_EXTERN
1159int onig_get_callout_data_by_callout_args P_((OnigCalloutArgs * args,
1160 int callout_num, int slot,
1161 OnigType *type, OnigValue *val));
1162ONIG_EXTERN
1163int onig_get_callout_data_by_callout_args_self P_((OnigCalloutArgs * args,
1164 int slot, OnigType *type,
1165 OnigValue *val));
1166ONIG_EXTERN
1167int onig_set_callout_data P_((OnigRegex reg, OnigMatchParam *mp,
1168 int callout_num, int slot, OnigType type,
1169 OnigValue *val));
1170ONIG_EXTERN
1171int onig_set_callout_data_by_callout_args P_((OnigCalloutArgs * args,
1172 int callout_num, int slot,
1173 OnigType type, OnigValue *val));
1174ONIG_EXTERN
1175int onig_set_callout_data_by_callout_args_self P_((OnigCalloutArgs * args,
1176 int slot, OnigType type,
1177 OnigValue *val));
1178ONIG_EXTERN
1179int onig_get_capture_range_in_callout P_((OnigCalloutArgs * args, int mem_num,
1180 int *begin, int *end));
1181ONIG_EXTERN
1182int onig_get_used_stack_size_in_callout P_((OnigCalloutArgs * args,
1183 int *used_num, int *used_bytes));
1184
1185/* builtin callout functions */
1186ONIG_EXTERN
1187int onig_builtin_fail P_((OnigCalloutArgs * args, void *user_data));
1188ONIG_EXTERN
1189int onig_builtin_mismatch P_((OnigCalloutArgs * args, void *user_data));
1190ONIG_EXTERN
1191int onig_builtin_error P_((OnigCalloutArgs * args, void *user_data));
1192ONIG_EXTERN
1193int onig_builtin_count P_((OnigCalloutArgs * args, void *user_data));
1194ONIG_EXTERN
1195int onig_builtin_total_count P_((OnigCalloutArgs * args, void *user_data));
1196ONIG_EXTERN
1197int onig_builtin_max P_((OnigCalloutArgs * args, void *user_data));
1198ONIG_EXTERN
1199int onig_builtin_cmp P_((OnigCalloutArgs * args, void *user_data));
1200
1201ONIG_EXTERN
1202int onig_setup_builtin_monitors_by_ascii_encoded_name P_((void *fp));
1203
1204#ifdef __cplusplus
1205}
1206#endif
1207
1208#endif /* ONIGURUMA_H */
unsigned int OnigCtype
Definition oniguruma.h:68
unsigned char OnigUChar
Definition oniguruma.h:66
unsigned int OnigCodePoint
Definition oniguruma.h:64
ONIG_EXTERN int onig_init()
ONIG_EXTERN int onig_initialize(OnigEncoding encodings[], int number_of_encodings)
unsigned int OnigLen
Definition oniguruma.h:70
Definition oniguruma.h:675
Definition oniguruma.h:96
Definition oniguruma.h:738
Definition oniguruma.h:114
Definition oniguruma.h:704
Definition oniguruma.h:102
Definition oniguruma.h:710
Definition onigposix.h:99
Definition oniguruma.h:685
Definition oniguruma.h:799