xref: /PHP-7.3/ext/mbstring/libmbfl/mbfl/mbfilter.h (revision bf5a802f)
1 /* charset=UTF-8
2  * vim: encoding=utf-8:
3  * */
4 
5 /*
6  * "streamable kanji code filter and converter"
7  *
8  * Copyright (c) 1998,1999,2000,2001 HappySize, Inc. All rights reserved.
9  *
10  * This software is released under the GNU Lesser General Public License.
11  * (Version 2.1, February 1999)
12  * Please read the following detail of the licence (in japanese).
13  *
14  * ◆使用許諾条件◆
15  *
16  * このソフトウェアは株式会社ハッピーサイズによって開発されました。株式会社ハッ
17  * ピーサイズは、著作権法および万国著作権条約の定めにより、このソフトウェアに関
18  * するすべての権利を留保する権利を持ち、ここに行使します。株式会社ハッピーサイ
19  * ズは以下に明記した条件に従って、このソフトウェアを使用する排他的ではない権利
20  * をお客様に許諾します。何人たりとも、以下の条件に反してこのソフトウェアを使用
21  * することはできません。
22  *
23  * このソフトウェアを「GNU Lesser General Public License (Version 2.1, February
24  * 1999)」に示された条件で使用することを、全ての方に許諾します。「GNU Lesser
25  * General Public License」を満たさない使用には、株式会社ハッピーサイズから書面
26  * による許諾を得る必要があります。
27  *
28  * 「GNU Lesser General Public License」の全文は以下のウェブページから取得でき
29  * ます。「GNU Lesser General Public License」とは、これまでLibrary General
30  * Public Licenseと呼ばれていたものです。
31  *     http://www.gnu.org/ --- GNUウェブサイト
32  *     http://www.gnu.org/copyleft/lesser.html --- ライセンス文面
33  * このライセンスの内容がわからない方、守れない方には使用を許諾しません。
34  *
35  * しかしながら、当社とGNUプロジェクトとの特定の関係を示唆または主張するもので
36  * はありません。
37  *
38  * ◆保証内容◆
39  *
40  * このソフトウェアは、期待された動作・機能・性能を持つことを目標として設計され
41  * 開発されていますが、これを保証するものではありません。このソフトウェアは「こ
42  * のまま」の状態で提供されており、たとえばこのソフトウェアの有用性ないし特定の
43  * 目的に合致することといった、何らかの保証内容が、明示されたり暗黙に示されてい
44  * る場合であっても、その保証は無効です。このソフトウェアを使用した結果ないし使
45  * 用しなかった結果によって、直接あるいは間接に受けた身体的な傷害、財産上の損害
46  * 、データの損失あるいはその他の全ての損害については、その損害の可能性が使用者
47  * 、当社あるいは第三者によって警告されていた場合であっても、当社はその損害の賠
48  * 償および補填を行いません。この規定は他の全ての、書面上または書面に無い保証・
49  * 契約・規定に優先します。
50  *
51  * ◆著作権者の連絡先および使用条件についての問い合わせ先◆
52  *
53  * 〒102-0073
54  * 東京都千代田区九段北1-13-5日本地所第一ビル4F
55  * 株式会社ハッピーサイズ
56  * Phone: 03-3512-3655, Fax: 03-3512-3656
57  * Email: sales@happysize.co.jp
58  * Web: http://happysize.com/
59  *
60  * ◆著者◆
61  *
62  * 金本 茂 <sgk@happysize.co.jp>
63  *
64  * ◆履歴◆
65  *
66  * 1998/11/10 sgk implementation in C++
67  * 1999/4/25  sgk Cで書きなおし。
68  * 1999/4/26  sgk 入力フィルタを実装。漢字コードを推定しながらフィルタを追加。
69  * 1999/6/??      Unicodeサポート。
70  * 1999/6/22  sgk ライセンスをLGPLに変更。
71  *
72  */
73 
74 /*
75  * Unicode support
76  *
77  * Portions copyright (c) 1999,2000,2001 by the PHP3 internationalization team.
78  * All rights reserved.
79  *
80  */
81 
82 /*
83  *
84  * streamable kanji code filter and converter
85  *    mbfl : Multi Byte FiLter Liblary
86  *
87  */
88 
89 #ifndef MBFL_MBFILTER_H
90 #define MBFL_MBFILTER_H
91 
92 #include "mbfl_defs.h"
93 #include "mbfl_consts.h"
94 #include "mbfl_allocators.h"
95 #include "mbfl_encoding.h"
96 #include "mbfl_language.h"
97 #include "mbfl_string.h"
98 #include "mbfl_convert.h"
99 #include "mbfl_ident.h"
100 
101 /* Prefer local fix, otherwise need to include too much. */
102 #ifndef ssize_t
103 #if defined(_WIN64)
104 #define ssize_t __int64
105 #elif defined(_WIN32)
106 #define ssize_t __int32
107 #elif defined(__GNUC__) && __GNUC__ >= 4
108 #define ssize_t long
109 #endif
110 #endif
111 
112 /*
113  * version information
114  */
115 #define MBFL_VERSION_MAJOR 1
116 #define MBFL_VERSION_MINOR 3
117 #define MBFL_VERSION_TEENY 2
118 
119 /*
120  * convert filter
121  */
122 #define MBFL_OUTPUTFILTER_ILLEGAL_MODE_NONE 0
123 #define MBFL_OUTPUTFILTER_ILLEGAL_MODE_CHAR 1
124 #define MBFL_OUTPUTFILTER_ILLEGAL_MODE_LONG 2
125 #define MBFL_OUTPUTFILTER_ILLEGAL_MODE_ENTITY 3
126 
127 /*
128  * convenience macros
129  */
130 #ifndef MIN
131 #define MIN(a,b) ((a)<(b)?(a):(b))
132 #endif
133 
134 /*
135  * buffering converter
136  */
137 typedef struct _mbfl_buffer_converter mbfl_buffer_converter;
138 
139 struct _mbfl_buffer_converter {
140 	mbfl_convert_filter *filter1;
141 	mbfl_convert_filter *filter2;
142 	mbfl_memory_device device;
143 	const mbfl_encoding *from;
144 	const mbfl_encoding *to;
145 };
146 
147 MBFLAPI extern mbfl_buffer_converter * mbfl_buffer_converter_new(const mbfl_encoding *from, const mbfl_encoding *to, size_t buf_initsz);
148 MBFLAPI extern void mbfl_buffer_converter_delete(mbfl_buffer_converter *convd);
149 MBFLAPI extern void mbfl_buffer_converter_reset(mbfl_buffer_converter *convd);
150 MBFLAPI extern int mbfl_buffer_converter_illegal_mode(mbfl_buffer_converter *convd, int mode);
151 MBFLAPI extern int mbfl_buffer_converter_illegal_substchar(mbfl_buffer_converter *convd, int substchar);
152 MBFLAPI extern int mbfl_buffer_converter_strncat(mbfl_buffer_converter *convd, const unsigned char *p, size_t n);
153 MBFLAPI extern int mbfl_buffer_converter_feed(mbfl_buffer_converter *convd, mbfl_string *string);
154 MBFLAPI extern int mbfl_buffer_converter_feed2(mbfl_buffer_converter *convd, mbfl_string *string, size_t *loc);
155 MBFLAPI extern int mbfl_buffer_converter_flush(mbfl_buffer_converter *convd);
156 MBFLAPI extern mbfl_string * mbfl_buffer_converter_getbuffer(mbfl_buffer_converter *convd, mbfl_string *result);
157 MBFLAPI extern mbfl_string * mbfl_buffer_converter_result(mbfl_buffer_converter *convd, mbfl_string *result);
158 MBFLAPI extern mbfl_string * mbfl_buffer_converter_feed_result(mbfl_buffer_converter *convd, mbfl_string *string, mbfl_string *result);
159 MBFLAPI extern size_t mbfl_buffer_illegalchars(mbfl_buffer_converter *convd);
160 
161 /*
162  * encoding detector
163  */
164 typedef struct _mbfl_encoding_detector mbfl_encoding_detector;
165 
166 struct _mbfl_encoding_detector {
167 	mbfl_identify_filter **filter_list;
168 	int filter_list_size;
169 	int strict;
170 };
171 
172 MBFLAPI extern mbfl_encoding_detector * mbfl_encoding_detector_new(const mbfl_encoding **elist, int elistsz, int strict);
173 MBFLAPI extern void mbfl_encoding_detector_delete(mbfl_encoding_detector *identd);
174 MBFLAPI extern int mbfl_encoding_detector_feed(mbfl_encoding_detector *identd, mbfl_string *string);
175 MBFLAPI extern const mbfl_encoding *mbfl_encoding_detector_judge(mbfl_encoding_detector *identd);
176 
177 
178 /*
179  * encoding converter
180  */
181 MBFLAPI extern mbfl_string *
182 mbfl_convert_encoding(mbfl_string *string, mbfl_string *result, const mbfl_encoding *toenc);
183 
184 
185 /*
186  * identify encoding
187  */
188 MBFLAPI extern const mbfl_encoding *
189 mbfl_identify_encoding(mbfl_string *string, const mbfl_encoding **elist, int elistsz, int strict);
190 
191 /* Lengths -1 through -16 are reserved for error return values */
mbfl_is_error(size_t len)192 static inline int mbfl_is_error(size_t len) {
193 	return len >= (size_t) -16;
194 }
195 
196 /*
197  * strlen
198  */
199 MBFLAPI extern size_t
200 mbfl_strlen(mbfl_string *string);
201 
202 /*
203  * oddlen
204  */
205 MBFLAPI extern size_t
206 mbfl_oddlen(mbfl_string *string);
207 
208 /*
209  * strpos
210  */
211 MBFLAPI extern size_t
212 mbfl_strpos(mbfl_string *haystack, mbfl_string *needle, ssize_t offset, int reverse);
213 
214 /*
215  * substr_count
216  */
217 MBFLAPI extern size_t
218 mbfl_substr_count(mbfl_string *haystack, mbfl_string *needle);
219 
220 /*
221  * If specified as length, the substr until the end of the string is taken.
222  */
223 #define MBFL_SUBSTR_UNTIL_END ((size_t) -1)
224 
225 /*
226  * substr
227  */
228 MBFLAPI extern mbfl_string *
229 mbfl_substr(mbfl_string *string, mbfl_string *result, size_t from, size_t length);
230 
231 /*
232  * strcut
233  */
234 MBFLAPI extern mbfl_string *
235 mbfl_strcut(mbfl_string *string, mbfl_string *result, size_t from, size_t length);
236 
237 /*
238  *  strwidth
239  */
240 MBFLAPI extern size_t
241 mbfl_strwidth(mbfl_string *string);
242 
243 /*
244  *  strimwidth
245  */
246 MBFLAPI extern mbfl_string *
247 mbfl_strimwidth(mbfl_string *string, mbfl_string *marker, mbfl_string *result, size_t from, size_t width);
248 
249 /*
250  * MIME header encode
251  */
252 struct mime_header_encoder_data;	/* forward declaration */
253 
254 MBFLAPI extern struct mime_header_encoder_data *
255 mime_header_encoder_new(
256     const mbfl_encoding *incode,
257     const mbfl_encoding *outcode,
258     const mbfl_encoding *encoding);
259 
260 MBFLAPI extern void
261 mime_header_encoder_delete(struct mime_header_encoder_data *pe);
262 
263 MBFLAPI extern int
264 mime_header_encoder_feed(int c, struct mime_header_encoder_data *pe);
265 
266 MBFLAPI extern mbfl_string *
267 mime_header_encoder_result(struct mime_header_encoder_data *pe, mbfl_string *result);
268 
269 MBFLAPI extern mbfl_string *
270 mbfl_mime_header_encode(
271     mbfl_string *string, mbfl_string *result,
272     const mbfl_encoding *outcode,
273     const mbfl_encoding *encoding,
274     const char *linefeed,
275     int indent);
276 
277 /*
278  * MIME header decode
279  */
280 struct mime_header_decoder_data;	/* forward declaration */
281 
282 MBFLAPI extern struct mime_header_decoder_data *
283 mime_header_decoder_new(const mbfl_encoding *outcode);
284 
285 MBFLAPI extern void
286 mime_header_decoder_delete(struct mime_header_decoder_data *pd);
287 
288 MBFLAPI extern int
289 mime_header_decoder_feed(int c, struct mime_header_decoder_data *pd);
290 
291 MBFLAPI extern mbfl_string *
292 mime_header_decoder_result(struct mime_header_decoder_data *pd, mbfl_string *result);
293 
294 MBFLAPI extern mbfl_string *
295 mbfl_mime_header_decode(
296     mbfl_string *string,
297     mbfl_string *result,
298     const mbfl_encoding *outcode);
299 
300 /*
301  * convert HTML numeric entity
302  */
303 MBFLAPI extern mbfl_string *
304 mbfl_html_numeric_entity(mbfl_string *string, mbfl_string *result, int *convmap, int mapsize, int type);
305 
306 /*
307  * convert of harfwidth and fullwidth for japanese
308  */
309 MBFLAPI extern mbfl_string *
310 mbfl_ja_jp_hantozen(mbfl_string *string, mbfl_string *result, int mode);
311 
312 #endif	/* MBFL_MBFILTER_H */
313