xref: /PHP-7.4/Zend/zend_multibyte.h (revision 92ac598a)
1 /*
2    +----------------------------------------------------------------------+
3    | Zend Engine                                                          |
4    +----------------------------------------------------------------------+
5    | Copyright (c) Zend Technologies Ltd. (http://www.zend.com)           |
6    +----------------------------------------------------------------------+
7    | This source file is subject to version 2.00 of the Zend license,     |
8    | that is bundled with this package in the file LICENSE, and is        |
9    | available through the world-wide-web at                              |
10    | http://www.zend.com/license/2_00.txt.                                |
11    | If you did not receive a copy of the Zend license and are unable to  |
12    | obtain it through the world-wide-web, please send a note to          |
13    | license@zend.com so we can mail you a copy immediately.              |
14    +----------------------------------------------------------------------+
15    | Authors: Masaki Fujimoto <fujimoto@php.net>                          |
16    |          Rui Hirokawa <hirokawa@php.net>                             |
17    +----------------------------------------------------------------------+
18 */
19 
20 #ifndef ZEND_MULTIBYTE_H
21 #define ZEND_MULTIBYTE_H
22 
23 typedef struct _zend_encoding zend_encoding;
24 
25 typedef size_t (*zend_encoding_filter)(unsigned char **str, size_t *str_length, const unsigned char *buf, size_t length);
26 
27 typedef const zend_encoding* (*zend_encoding_fetcher)(const char *encoding_name);
28 typedef const char* (*zend_encoding_name_getter)(const zend_encoding *encoding);
29 typedef int (*zend_encoding_lexer_compatibility_checker)(const zend_encoding *encoding);
30 typedef const zend_encoding *(*zend_encoding_detector)(const unsigned char *string, size_t length, const zend_encoding **list, size_t list_size);
31 typedef size_t (*zend_encoding_converter)(unsigned char **to, size_t *to_length, const unsigned char *from, size_t from_length, const zend_encoding *encoding_to, const zend_encoding *encoding_from);
32 typedef int (*zend_encoding_list_parser)(const char *encoding_list, size_t encoding_list_len, const zend_encoding ***return_list, size_t *return_size, int persistent);
33 typedef const zend_encoding *(*zend_encoding_internal_encoding_getter)(void);
34 typedef int (*zend_encoding_internal_encoding_setter)(const zend_encoding *encoding);
35 
36 typedef struct _zend_multibyte_functions {
37     const char *provider_name;
38     zend_encoding_fetcher encoding_fetcher;
39     zend_encoding_name_getter encoding_name_getter;
40     zend_encoding_lexer_compatibility_checker lexer_compatibility_checker;
41     zend_encoding_detector encoding_detector;
42     zend_encoding_converter encoding_converter;
43     zend_encoding_list_parser encoding_list_parser;
44     zend_encoding_internal_encoding_getter internal_encoding_getter;
45     zend_encoding_internal_encoding_setter internal_encoding_setter;
46 } zend_multibyte_functions;
47 
48 /*
49  * zend multibyte APIs
50  */
51 BEGIN_EXTERN_C()
52 
53 ZEND_API extern const zend_encoding *zend_multibyte_encoding_utf32be;
54 ZEND_API extern const zend_encoding *zend_multibyte_encoding_utf32le;
55 ZEND_API extern const zend_encoding *zend_multibyte_encoding_utf16be;
56 ZEND_API extern const zend_encoding *zend_multibyte_encoding_utf16le;
57 ZEND_API extern const zend_encoding *zend_multibyte_encoding_utf8;
58 
59 /* multibyte utility functions */
60 ZEND_API int zend_multibyte_set_functions(const zend_multibyte_functions *functions);
61 ZEND_API void zend_multibyte_restore_functions(void);
62 ZEND_API const zend_multibyte_functions *zend_multibyte_get_functions(void);
63 
64 ZEND_API const zend_encoding *zend_multibyte_fetch_encoding(const char *name);
65 ZEND_API const char *zend_multibyte_get_encoding_name(const zend_encoding *encoding);
66 ZEND_API int zend_multibyte_check_lexer_compatibility(const zend_encoding *encoding);
67 ZEND_API const zend_encoding *zend_multibyte_encoding_detector(const unsigned char *string, size_t length, const zend_encoding **list, size_t list_size);
68 ZEND_API size_t zend_multibyte_encoding_converter(unsigned char **to, size_t *to_length, const unsigned char *from, size_t from_length, const zend_encoding *encoding_to, const zend_encoding *encoding_from);
69 ZEND_API int zend_multibyte_parse_encoding_list(const char *encoding_list, size_t encoding_list_len, const zend_encoding ***return_list, size_t *return_size, int persistent);
70 
71 ZEND_API const zend_encoding *zend_multibyte_get_internal_encoding(void);
72 ZEND_API const zend_encoding *zend_multibyte_get_script_encoding(void);
73 ZEND_API int zend_multibyte_set_script_encoding(const zend_encoding **encoding_list, size_t encoding_list_size);
74 ZEND_API int zend_multibyte_set_internal_encoding(const zend_encoding *encoding);
75 ZEND_API int zend_multibyte_set_script_encoding_by_string(const char *new_value, size_t new_value_length);
76 
77 END_EXTERN_C()
78 
79 #endif /* ZEND_MULTIBYTE_H */
80