Ruby: regenc.h Source File

Ruby 3.2.5p208 (2024-07-26 revision 31d0f1a2e7dbfb60731d1f05b868e1d578cda493)

regenc.h
1#ifndef ONIGMO_REGENC_H
2#define ONIGMO_REGENC_H
3/**********************************************************************
4 regenc.h - Onigmo (Oniguruma-mod) (regular expression library)
5**********************************************************************/
6/*-
7 * Copyright (c) 2002-2008 K.Kosako <sndgk393 AT ybb DOT ne DOT jp>
8 * Copyright (c) 2011-2016 K.Takata <kentkt AT csc DOT jp>
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
31 */
32
33#if !defined(RUBY) && (defined(RUBY_EXPORT) || defined(ONIG_ENC_REGISTER))
34# define RUBY
35#endif
36#ifdef RUBY
37# ifndef ONIGMO_REGINT_H
38# ifndef RUBY_EXTERN
39# include "ruby/config.h"
40# include "ruby/defines.h"
41# endif
42# endif
43# include "ruby.h"
44#else /* RUBY */
45# ifndef PACKAGE
46/* PACKAGE is defined in config.h */
47# include "config.h"
48# endif
49#endif /* RUBY */
50
51#ifdef ONIG_ESCAPE_UCHAR_COLLISION
52# undef ONIG_ESCAPE_UCHAR_COLLISION
53#endif
54
55#ifdef RUBY
56# include "ruby/onigmo.h"
57#else
58# include "onigmo.h"
59#endif
60
61RUBY_SYMBOL_EXPORT_BEGIN
62
63 typedef struct {
64 OnigCodePoint from;
65 OnigCodePoint to;
66} OnigPairCaseFoldCodes;
67
68
69#ifndef NULL
70# define NULL ((void* )0)
71#endif
72
73#ifndef TRUE
74# define TRUE 1
75#endif
76
77#ifndef FALSE
78# define FALSE 0
79#endif
80
81#ifndef ARG_UNUSED
82# if defined(__GNUC__)
83# define ARG_UNUSED __attribute__ ((unused))
84# else
85# define ARG_UNUSED
86# endif
87#endif
88
89#define ONIG_IS_NULL(p) (((void*)(p)) == (void*)0)
90#define ONIG_IS_NOT_NULL(p) (((void*)(p)) != (void*)0)
91#define ONIG_CHECK_NULL_RETURN(p) if (ONIG_IS_NULL(p)) return NULL
92#define ONIG_CHECK_NULL_RETURN_VAL(p,val) if (ONIG_IS_NULL(p)) return (val)
93
94#define enclen(enc,p,e) ((enc->max_enc_len == enc->min_enc_len) ? (p < e ? enc->min_enc_len : 0) : ONIGENC_MBC_ENC_LEN(enc,p,e))
95
96/* character types bit flag */
97#define BIT_CTYPE_NEWLINE (1<< ONIGENC_CTYPE_NEWLINE)
98#define BIT_CTYPE_ALPHA (1<< ONIGENC_CTYPE_ALPHA)
99#define BIT_CTYPE_BLANK (1<< ONIGENC_CTYPE_BLANK)
100#define BIT_CTYPE_CNTRL (1<< ONIGENC_CTYPE_CNTRL)
101#define BIT_CTYPE_DIGIT (1<< ONIGENC_CTYPE_DIGIT)
102#define BIT_CTYPE_GRAPH (1<< ONIGENC_CTYPE_GRAPH)
103#define BIT_CTYPE_LOWER (1<< ONIGENC_CTYPE_LOWER)
104#define BIT_CTYPE_PRINT (1<< ONIGENC_CTYPE_PRINT)
105#define BIT_CTYPE_PUNCT (1<< ONIGENC_CTYPE_PUNCT)
106#define BIT_CTYPE_SPACE (1<< ONIGENC_CTYPE_SPACE)
107#define BIT_CTYPE_UPPER (1<< ONIGENC_CTYPE_UPPER)
108#define BIT_CTYPE_XDIGIT (1<< ONIGENC_CTYPE_XDIGIT)
109#define BIT_CTYPE_WORD (1<< ONIGENC_CTYPE_WORD)
110#define BIT_CTYPE_ALNUM (1<< ONIGENC_CTYPE_ALNUM)
111#define BIT_CTYPE_ASCII (1<< ONIGENC_CTYPE_ASCII)
112
113#define CTYPE_TO_BIT(ctype) (1<<(ctype))
114#define CTYPE_IS_WORD_GRAPH_PRINT(ctype) \
115 ((ctype) == ONIGENC_CTYPE_WORD || (ctype) == ONIGENC_CTYPE_GRAPH ||\
116 (ctype) == ONIGENC_CTYPE_PRINT)
117
118
119 typedef struct {
120 short int len;
121 const UChar name[6];
122 int ctype;
123} PosixBracketEntryType;
124
125#define POSIX_BRACKET_ENTRY_INIT(name, ctype) \
126 {(short int )(sizeof(name) - 1), name, (ctype)}
127
128#define numberof(array) ((int)(sizeof(array) / sizeof((array)[0])))
129#define roomof(x, y) (((x) + (y) - 1) / (y))
130#define type_roomof(x, y) roomof(sizeof(x), sizeof(y))
131
132#define USE_CRNL_AS_LINE_TERMINATOR
133#define USE_UNICODE_PROPERTIES
134#define USE_UNICODE_AGE_PROPERTIES
135/* #define USE_UNICODE_CASE_FOLD_TURKISH_AZERI */
136/* #define USE_UNICODE_ALL_LINE_TERMINATORS */ /* see Unicode.org UTS #18 */
137
138
139#define ONIG_ENCODING_INIT_DEFAULT ONIG_ENCODING_ASCII
140
141/* for encoding system implementation (internal) */
142ONIG_EXTERN int onigenc_ascii_apply_all_case_fold(OnigCaseFoldType flag, OnigApplyAllCaseFoldFunc f, void* arg, OnigEncoding enc);
143ONIG_EXTERN int onigenc_ascii_get_case_fold_codes_by_str(OnigCaseFoldType flag, const OnigUChar* p, const OnigUChar* end, OnigCaseFoldCodeItem items[], OnigEncoding enc);
144ONIG_EXTERN int onigenc_apply_all_case_fold_with_map(int map_size, const OnigPairCaseFoldCodes map[], int ess_tsett_flag, OnigCaseFoldType flag, OnigApplyAllCaseFoldFunc f, void* arg);
145ONIG_EXTERN int onigenc_get_case_fold_codes_by_str_with_map(int map_size, const OnigPairCaseFoldCodes map[], int ess_tsett_flag, OnigCaseFoldType flag, const OnigUChar* p, const OnigUChar* end, OnigCaseFoldCodeItem items[]);
146ONIG_EXTERN int onigenc_not_support_get_ctype_code_range(OnigCtype ctype, OnigCodePoint* sb_out, const OnigCodePoint* ranges[], OnigEncoding enc);
147ONIG_EXTERN int onigenc_is_mbc_newline_0x0a(const UChar* p, const UChar* end, OnigEncoding enc);
148ONIG_EXTERN int onigenc_single_byte_ascii_only_case_map(OnigCaseFoldType* flagP, const OnigUChar** pp, const OnigUChar* end, OnigUChar* to, OnigUChar* to_end, const struct OnigEncodingTypeST* enc);
149
150
151/* methods for single byte encoding */
152ONIG_EXTERN int onigenc_ascii_mbc_case_fold(OnigCaseFoldType flag, const UChar** p, const UChar* end, UChar* lower, OnigEncoding enc);
153ONIG_EXTERN int onigenc_single_byte_mbc_enc_len(const UChar* p, const UChar* e, OnigEncoding enc);
154ONIG_EXTERN OnigCodePoint onigenc_single_byte_mbc_to_code(const UChar* p, const UChar* end, OnigEncoding enc);
155ONIG_EXTERN int onigenc_single_byte_code_to_mbclen(OnigCodePoint code, OnigEncoding enc);
156ONIG_EXTERN int onigenc_single_byte_code_to_mbc(OnigCodePoint code, UChar *buf, OnigEncoding enc);
157ONIG_EXTERN UChar* onigenc_single_byte_left_adjust_char_head(const UChar* start, const UChar* s, const OnigUChar* end, OnigEncoding enc);
158ONIG_EXTERN int onigenc_always_true_is_allowed_reverse_match(const UChar* s, const UChar* end, OnigEncoding enc);
159ONIG_EXTERN int onigenc_always_false_is_allowed_reverse_match(const UChar* s, const UChar* end, OnigEncoding enc);
160ONIG_EXTERN int onigenc_ascii_is_code_ctype(OnigCodePoint code, unsigned int ctype, OnigEncoding enc);
161
162/* methods for multi byte encoding */
163ONIG_EXTERN OnigCodePoint onigenc_mbn_mbc_to_code(OnigEncoding enc, const UChar* p, const UChar* end);
164ONIG_EXTERN int onigenc_mbn_mbc_case_fold(OnigEncoding enc, OnigCaseFoldType flag, const UChar** p, const UChar* end, UChar* lower);
165ONIG_EXTERN int onigenc_mb2_code_to_mbclen(OnigCodePoint code, OnigEncoding enc);
166ONIG_EXTERN int onigenc_mb2_code_to_mbc(OnigEncoding enc, OnigCodePoint code, UChar *buf);
167ONIG_EXTERN int onigenc_minimum_property_name_to_ctype(OnigEncoding enc, const UChar* p, const UChar* end);
168ONIG_EXTERN int onigenc_unicode_property_name_to_ctype(OnigEncoding enc, const UChar* p, const UChar* end);
169ONIG_EXTERN int onigenc_mb2_is_code_ctype(OnigEncoding enc, OnigCodePoint code, unsigned int ctype);
170ONIG_EXTERN int onigenc_mb4_code_to_mbclen(OnigCodePoint code, OnigEncoding enc);
171ONIG_EXTERN int onigenc_mb4_code_to_mbc(OnigEncoding enc, OnigCodePoint code, UChar *buf);
172ONIG_EXTERN int onigenc_mb4_is_code_ctype(OnigEncoding enc, OnigCodePoint code, unsigned int ctype);
173
174ONIG_EXTERN int onigenc_unicode_case_map(OnigCaseFoldType* flagP, const OnigUChar** pp, const OnigUChar* end, OnigUChar* to, OnigUChar* to_end, const struct OnigEncodingTypeST* enc);
175
176
177/* in enc/unicode.c */
178ONIG_EXTERN int onigenc_unicode_is_code_ctype(OnigCodePoint code, unsigned int ctype, OnigEncoding enc);
179ONIG_EXTERN int onigenc_utf16_32_get_ctype_code_range(OnigCtype ctype, OnigCodePoint *sb_out, const OnigCodePoint* ranges[], OnigEncoding enc);
180ONIG_EXTERN int onigenc_unicode_ctype_code_range(int ctype, const OnigCodePoint* ranges[]);
181ONIG_EXTERN int onigenc_unicode_get_case_fold_codes_by_str(OnigEncoding enc, OnigCaseFoldType flag, const OnigUChar* p, const OnigUChar* end, OnigCaseFoldCodeItem items[]);
182ONIG_EXTERN int onigenc_unicode_mbc_case_fold(OnigEncoding enc, OnigCaseFoldType flag, const UChar** pp, const UChar* end, UChar* fold);
183ONIG_EXTERN int onigenc_unicode_apply_all_case_fold(OnigCaseFoldType flag, OnigApplyAllCaseFoldFunc f, void* arg, OnigEncoding enc);
184
185
186#define UTF16_IS_SURROGATE_FIRST(c) (((c) & 0xfc) == 0xd8)
187#define UTF16_IS_SURROGATE_SECOND(c) (((c) & 0xfc) == 0xdc)
188#define UTF16_IS_SURROGATE(c) (((c) & 0xf8) == 0xd8)
189#define UNICODE_VALID_CODEPOINT_P(c) ( \
190 ((c) <= 0x10ffff) && \
191 !((c) < 0x10000 && UTF16_IS_SURROGATE((c) >> 8)))
192
193#define ONIGENC_ISO_8859_1_TO_LOWER_CASE(c) \
194 OnigEncISO_8859_1_ToLowerCaseTable[c]
195#define ONIGENC_ISO_8859_1_TO_UPPER_CASE(c) \
196 OnigEncISO_8859_1_ToUpperCaseTable[c]
197
198ONIG_EXTERN const UChar OnigEncISO_8859_1_ToLowerCaseTable[];
199ONIG_EXTERN const UChar OnigEncISO_8859_1_ToUpperCaseTable[];
200
201ONIG_EXTERN int
202onigenc_with_ascii_strncmp(OnigEncoding enc, const UChar* p, const UChar* end, const UChar* sascii /* ascii */, int n);
203ONIG_EXTERN int
204onigenc_with_ascii_strnicmp(OnigEncoding enc, const UChar* p, const UChar* end, const UChar* sascii /* ascii */, int n);
205ONIG_EXTERN UChar*
206onigenc_step(OnigEncoding enc, const UChar* p, const UChar* end, int n);
207
208/* defined in regexec.c, but used in enc/xxx.c */
209extern int onig_is_in_code_range(const UChar* p, OnigCodePoint code);
210
211ONIG_EXTERN OnigEncoding OnigEncDefaultCharEncoding;
212ONIG_EXTERN const UChar OnigEncAsciiToLowerCaseTable[];
213ONIG_EXTERN const UChar OnigEncAsciiToUpperCaseTable[];
214ONIG_EXTERN const unsigned short OnigEncAsciiCtypeTable[];
215
216#define ONIGENC_IS_ASCII_CODE(code) ((code) < 0x80)
217#define ONIGENC_ASCII_CODE_TO_LOWER_CASE(c) OnigEncAsciiToLowerCaseTable[c]
218#define ONIGENC_ASCII_CODE_TO_UPPER_CASE(c) OnigEncAsciiToUpperCaseTable[c]
219#define ONIGENC_IS_ASCII_CODE_CTYPE(code,ctype) \
220 ((OnigEncAsciiCtypeTable[code] & CTYPE_TO_BIT(ctype)) != 0)
221#define ONIGENC_IS_ASCII_CODE_CASE_AMBIG(code) \
222 (ONIGENC_IS_ASCII_CODE_CTYPE(code, ONIGENC_CTYPE_UPPER) ||\
223 ONIGENC_IS_ASCII_CODE_CTYPE(code, ONIGENC_CTYPE_LOWER))
224
225/* Check if the code is in the range. (from <= code && code <= to) */
226#define ONIGENC_IS_IN_RANGE(code, from, to) \
227 ((OnigCodePoint )((code) - (from)) <= (OnigCodePoint )((to) - (from)))
228
229
230#ifdef ONIG_ENC_REGISTER
231extern int ONIG_ENC_REGISTER(const char *, OnigEncoding);
232# define OnigEncodingName(n) encoding_##n
233# define OnigEncodingDeclare(n) static const OnigEncodingType OnigEncodingName(n)
234# define OnigEncodingDefine(f,n) \
235 OnigEncodingDeclare(n); \
236 void Init_##f(void) { \
237 ONIG_ENC_REGISTER(OnigEncodingName(n).name, \
238 &OnigEncodingName(n)); \
239 } \
240 OnigEncodingDeclare(n)
241#else
242# define OnigEncodingName(n) OnigEncoding##n
243# define OnigEncodingDeclare(n) const OnigEncodingType OnigEncodingName(n)
244# define OnigEncodingDefine(f,n) OnigEncodingDeclare(n)
245#endif
246
247/* macros for define replica encoding and encoding alias */
248#define ENC_REPLICATE(name, orig)
249#define ENC_ALIAS(name, orig)
250#define ENC_DUMMY(name)
251
252RUBY_SYMBOL_EXPORT_END
253
254#endif /* ONIGMO_REGENC_H */
defines.h
OnigCaseFoldCodeItem
Definition onigmo.h:143
OnigEncodingTypeST
Definition onigmo.h:160
OnigPairCaseFoldCodes
Definition regenc.h:63
PosixBracketEntryType
Definition regenc.h:119