1 /*
2 * "streamable kanji code filter and converter"
3 * Copyright (c) 1998-2002 HappySize, Inc. All rights reserved.
4 *
5 * LICENSE NOTICES
6 *
7 * This file is part of "streamable kanji code filter and converter",
8 * which is distributed under the terms of GNU Lesser General Public
9 * License (version 2) as published by the Free Software Foundation.
10 *
11 * This software is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with "streamable kanji code filter and converter";
18 * if not, write to the Free Software Foundation, Inc., 59 Temple Place,
19 * Suite 330, Boston, MA 02111-1307 USA
20 *
21 * The author of this file:
22 *
23 */
24 /*
25 * The source code included in this files was separated from mbfilter.h
26 * by Moriyoshi Koizumi <moriyoshi@php.net> on 20 Dec 2002. The file
27 * mbfilter.h is included in this package .
28 *
29 */
30
31 #ifndef MBFL_ENCODING_H
32 #define MBFL_ENCODING_H
33
34 #include "mbfl_defs.h"
35 #include "zend.h"
36
37 enum mbfl_no_encoding {
38 mbfl_no_encoding_invalid = -1,
39 mbfl_no_encoding_pass,
40 mbfl_no_encoding_wchar,
41 mbfl_no_encoding_base64,
42 mbfl_no_encoding_uuencode,
43 mbfl_no_encoding_html_ent,
44 mbfl_no_encoding_qprint,
45 mbfl_no_encoding_7bit,
46 mbfl_no_encoding_8bit,
47 mbfl_no_encoding_charset_min,
48 mbfl_no_encoding_ucs4,
49 mbfl_no_encoding_ucs4be,
50 mbfl_no_encoding_ucs4le,
51 mbfl_no_encoding_ucs2,
52 mbfl_no_encoding_ucs2be,
53 mbfl_no_encoding_ucs2le,
54 mbfl_no_encoding_utf32,
55 mbfl_no_encoding_utf32be,
56 mbfl_no_encoding_utf32le,
57 mbfl_no_encoding_utf16,
58 mbfl_no_encoding_utf16be,
59 mbfl_no_encoding_utf16le,
60 mbfl_no_encoding_utf8,
61 mbfl_no_encoding_utf8_docomo,
62 mbfl_no_encoding_utf8_kddi_a,
63 mbfl_no_encoding_utf8_kddi_b,
64 mbfl_no_encoding_utf8_sb,
65 mbfl_no_encoding_utf7,
66 mbfl_no_encoding_utf7imap,
67 mbfl_no_encoding_ascii,
68 mbfl_no_encoding_euc_jp,
69 mbfl_no_encoding_eucjp2004,
70 mbfl_no_encoding_sjis,
71 mbfl_no_encoding_eucjp_win,
72 mbfl_no_encoding_sjis_docomo,
73 mbfl_no_encoding_sjis_kddi,
74 mbfl_no_encoding_sjis_sb,
75 mbfl_no_encoding_sjis_mac,
76 mbfl_no_encoding_sjis2004,
77 mbfl_no_encoding_cp932,
78 mbfl_no_encoding_sjiswin,
79 mbfl_no_encoding_cp51932,
80 mbfl_no_encoding_jis,
81 mbfl_no_encoding_2022jp,
82 mbfl_no_encoding_2022jp_2004,
83 mbfl_no_encoding_2022jp_kddi,
84 mbfl_no_encoding_2022jpms,
85 mbfl_no_encoding_gb18030,
86 mbfl_no_encoding_cp1252,
87 mbfl_no_encoding_cp1254,
88 mbfl_no_encoding_8859_1,
89 mbfl_no_encoding_8859_2,
90 mbfl_no_encoding_8859_3,
91 mbfl_no_encoding_8859_4,
92 mbfl_no_encoding_8859_5,
93 mbfl_no_encoding_8859_6,
94 mbfl_no_encoding_8859_7,
95 mbfl_no_encoding_8859_8,
96 mbfl_no_encoding_8859_9,
97 mbfl_no_encoding_8859_10,
98 mbfl_no_encoding_8859_13,
99 mbfl_no_encoding_8859_14,
100 mbfl_no_encoding_8859_15,
101 mbfl_no_encoding_euc_cn,
102 mbfl_no_encoding_cp936,
103 mbfl_no_encoding_euc_tw,
104 mbfl_no_encoding_big5,
105 mbfl_no_encoding_cp950,
106 mbfl_no_encoding_euc_kr,
107 mbfl_no_encoding_2022kr,
108 mbfl_no_encoding_uhc,
109 mbfl_no_encoding_hz,
110 mbfl_no_encoding_cp1251,
111 mbfl_no_encoding_cp866,
112 mbfl_no_encoding_koi8r,
113 mbfl_no_encoding_koi8u,
114 mbfl_no_encoding_8859_16,
115 mbfl_no_encoding_armscii8,
116 mbfl_no_encoding_cp850,
117 mbfl_no_encoding_cp50220,
118 mbfl_no_encoding_cp50221,
119 mbfl_no_encoding_cp50222,
120 mbfl_no_encoding_charset_max
121 };
122
123 struct _mbfl_convert_filter;
124 struct mbfl_convert_vtbl {
125 enum mbfl_no_encoding from;
126 enum mbfl_no_encoding to;
127 void (*filter_ctor)(struct _mbfl_convert_filter *filter);
128 void (*filter_dtor)(struct _mbfl_convert_filter *filter);
129 int (*filter_function)(int c, struct _mbfl_convert_filter *filter);
130 int (*filter_flush)(struct _mbfl_convert_filter *filter);
131 void (*filter_copy)(struct _mbfl_convert_filter *src, struct _mbfl_convert_filter *dest);
132 };
133
134 typedef struct {
135 unsigned char *out;
136 unsigned char *limit;
137 uint32_t state;
138 uint32_t errors;
139 uint32_t replacement_char;
140 unsigned int error_mode;
141 zend_string *str;
142 } mb_convert_buf;
143
144 typedef size_t (*mb_to_wchar_fn)(unsigned char **in, size_t *in_len, uint32_t *out, size_t out_len, unsigned int *state);
145 typedef void (*mb_from_wchar_fn)(uint32_t *in, size_t in_len, mb_convert_buf *out, bool end);
146 typedef bool (*mb_check_fn)(unsigned char *in, size_t in_len);
147
148 /* When converting encoded text to a buffer of wchars (Unicode codepoints) using `mb_to_wchar_fn`,
149 * the buffer must be at least this size (to work with all supported text encodings) */
150 #define MBSTRING_MIN_WCHAR_BUFSIZE 5
151
mb_convert_buf_init(mb_convert_buf * buf,size_t initsize,uint32_t repl_char,unsigned int err_mode)152 static inline void mb_convert_buf_init(mb_convert_buf *buf, size_t initsize, uint32_t repl_char, unsigned int err_mode)
153 {
154 buf->state = buf->errors = 0;
155 buf->str = emalloc(_ZSTR_STRUCT_SIZE(initsize));
156 buf->out = (unsigned char*)ZSTR_VAL(buf->str);
157 buf->limit = buf->out + initsize;
158 buf->replacement_char = repl_char;
159 buf->error_mode = err_mode;
160 }
161
162 #define MB_CONVERT_BUF_ENSURE(buf, out, limit, needed) \
163 ZEND_ASSERT(out <= limit); \
164 if ((limit - out) < (needed)) { \
165 size_t oldsize = limit - (unsigned char*)ZSTR_VAL(buf->str); \
166 size_t newsize = oldsize + MAX(oldsize >> 1, needed); \
167 zend_string *newstr = erealloc(buf->str, _ZSTR_STRUCT_SIZE(newsize)); \
168 out = (unsigned char*)ZSTR_VAL(newstr) + (out - (unsigned char*)ZSTR_VAL(buf->str)); \
169 limit = (unsigned char*)ZSTR_VAL(newstr) + newsize; \
170 buf->str = newstr; \
171 }
172
173 #define MB_CONVERT_BUF_STORE(buf, _out, _limit) buf->out = _out; buf->limit = _limit
174
175 #define MB_CONVERT_BUF_LOAD(buf, _out, _limit) _out = buf->out; _limit = buf->limit
176
177 #define MB_CONVERT_ERROR(buf, out, limit, bad_cp, conv_fn) \
178 MB_CONVERT_BUF_STORE(buf, out, limit); \
179 mb_illegal_output(bad_cp, conv_fn, buf); \
180 MB_CONVERT_BUF_LOAD(buf, out, limit)
181
mb_convert_buf_add(unsigned char * out,char c)182 static inline unsigned char* mb_convert_buf_add(unsigned char *out, char c)
183 {
184 *out++ = c;
185 return out;
186 }
187
mb_convert_buf_add2(unsigned char * out,char c1,char c2)188 static inline unsigned char* mb_convert_buf_add2(unsigned char *out, char c1, char c2)
189 {
190 *out++ = c1;
191 *out++ = c2;
192 return out;
193 }
194
mb_convert_buf_add3(unsigned char * out,char c1,char c2,char c3)195 static inline unsigned char* mb_convert_buf_add3(unsigned char *out, char c1, char c2, char c3)
196 {
197 *out++ = c1;
198 *out++ = c2;
199 *out++ = c3;
200 return out;
201 }
202
mb_convert_buf_add4(unsigned char * out,char c1,char c2,char c3,char c4)203 static inline unsigned char* mb_convert_buf_add4(unsigned char *out, char c1, char c2, char c3, char c4)
204 {
205 *out++ = c1;
206 *out++ = c2;
207 *out++ = c3;
208 *out++ = c4;
209 return out;
210 }
211
mb_convert_buf_result(mb_convert_buf * buf)212 static inline zend_string* mb_convert_buf_result(mb_convert_buf *buf)
213 {
214 ZEND_ASSERT(buf->out <= buf->limit);
215 zend_string *ret = buf->str;
216 /* See `zend_string_alloc` in zend_string.h */
217 GC_SET_REFCOUNT(ret, 1);
218 GC_TYPE_INFO(ret) = GC_STRING;
219 ZSTR_H(ret) = 0;
220 ZSTR_LEN(ret) = buf->out - (unsigned char*)ZSTR_VAL(ret);
221 *(buf->out) = '\0';
222 return ret;
223 }
224
225 typedef struct {
226 enum mbfl_no_encoding no_encoding;
227 const char *name;
228 const char *mime_name;
229 const char **aliases;
230 const unsigned char *mblen_table;
231 unsigned int flag;
232 const struct mbfl_convert_vtbl *input_filter;
233 const struct mbfl_convert_vtbl *output_filter;
234 mb_to_wchar_fn to_wchar;
235 mb_from_wchar_fn from_wchar;
236 mb_check_fn check;
237 } mbfl_encoding;
238
239 MBFLAPI extern const mbfl_encoding *mbfl_name2encoding(const char *name);
240 MBFLAPI extern const mbfl_encoding *mbfl_no2encoding(enum mbfl_no_encoding no_encoding);
241 MBFLAPI extern enum mbfl_no_encoding mbfl_name2no_encoding(const char *name);
242 MBFLAPI extern const mbfl_encoding **mbfl_get_supported_encodings(void);
243 MBFLAPI extern const char *mbfl_no_encoding2name(enum mbfl_no_encoding no_encoding);
244 MBFLAPI extern const char *mbfl_no2preferred_mime_name(enum mbfl_no_encoding no_encoding);
245 MBFLAPI extern const char *mbfl_encoding_preferred_mime_name(const mbfl_encoding *encoding);
246
247 #endif /* MBFL_ENCODING_H */
248
