xref: /PHP-7.4/ext/json/php_json.h (revision dee243d4)
1 /*
2   +----------------------------------------------------------------------+
3   | PHP Version 7                                                        |
4   +----------------------------------------------------------------------+
5   | Copyright (c) The PHP Group                                          |
6   +----------------------------------------------------------------------+
7   | This source file is subject to version 3.01 of the PHP license,      |
8   | that is bundled with this package in the file LICENSE, and is        |
9   | available through the world-wide-web at the following url:           |
10   | http://www.php.net/license/3_01.txt                                  |
11   | If you did not receive a copy of the PHP license and are unable to   |
12   | obtain it through the world-wide-web, please send a note to          |
13   | license@php.net so we can mail you a copy immediately.               |
14   +----------------------------------------------------------------------+
15   | Author: Omar Kilani <omar@php.net>                                   |
16   |         Jakub Zelenka <bukka@php.net>                                |
17   +----------------------------------------------------------------------+
18 */
19 
20 #ifndef PHP_JSON_H
21 #define PHP_JSON_H
22 
23 #include "php_version.h"
24 #include "zend_smart_str_public.h"
25 
26 #define PHP_JSON_VERSION PHP_VERSION
27 
28 extern zend_module_entry json_module_entry;
29 #define phpext_json_ptr &json_module_entry
30 
31 #if defined(PHP_WIN32) && defined(JSON_EXPORTS)
32 #define PHP_JSON_API __declspec(dllexport)
33 #else
34 #define PHP_JSON_API PHPAPI
35 #endif
36 
37 #ifdef ZTS
38 #include "TSRM.h"
39 #endif
40 
41 extern PHP_JSON_API zend_class_entry *php_json_serializable_ce;
42 
43 /* error codes */
44 typedef enum {
45 	PHP_JSON_ERROR_NONE = 0,
46 	PHP_JSON_ERROR_DEPTH,
47 	PHP_JSON_ERROR_STATE_MISMATCH,
48 	PHP_JSON_ERROR_CTRL_CHAR,
49 	PHP_JSON_ERROR_SYNTAX,
50 	PHP_JSON_ERROR_UTF8,
51 	PHP_JSON_ERROR_RECURSION,
52 	PHP_JSON_ERROR_INF_OR_NAN,
53 	PHP_JSON_ERROR_UNSUPPORTED_TYPE,
54 	PHP_JSON_ERROR_INVALID_PROPERTY_NAME,
55 	PHP_JSON_ERROR_UTF16
56 } php_json_error_code;
57 
58 /* json_decode() options */
59 #define PHP_JSON_OBJECT_AS_ARRAY            (1<<0)
60 #define PHP_JSON_BIGINT_AS_STRING           (1<<1)
61 
62 /* json_encode() options */
63 #define PHP_JSON_HEX_TAG                    (1<<0)
64 #define PHP_JSON_HEX_AMP                    (1<<1)
65 #define PHP_JSON_HEX_APOS                   (1<<2)
66 #define PHP_JSON_HEX_QUOT                   (1<<3)
67 #define PHP_JSON_FORCE_OBJECT               (1<<4)
68 #define PHP_JSON_NUMERIC_CHECK              (1<<5)
69 #define PHP_JSON_UNESCAPED_SLASHES          (1<<6)
70 #define PHP_JSON_PRETTY_PRINT               (1<<7)
71 #define PHP_JSON_UNESCAPED_UNICODE          (1<<8)
72 #define PHP_JSON_PARTIAL_OUTPUT_ON_ERROR    (1<<9)
73 #define PHP_JSON_PRESERVE_ZERO_FRACTION     (1<<10)
74 #define PHP_JSON_UNESCAPED_LINE_TERMINATORS (1<<11)
75 
76 /* json_decode() and json_encode() common options */
77 #define PHP_JSON_INVALID_UTF8_IGNORE        (1<<20)
78 #define PHP_JSON_INVALID_UTF8_SUBSTITUTE    (1<<21)
79 #define PHP_JSON_THROW_ON_ERROR             (1<<22)
80 
81 /* Internal flags */
82 #define PHP_JSON_OUTPUT_ARRAY	0
83 #define PHP_JSON_OUTPUT_OBJECT	1
84 
85 /* default depth */
86 #define PHP_JSON_PARSER_DEFAULT_DEPTH 512
87 
88 ZEND_BEGIN_MODULE_GLOBALS(json)
89 	int encoder_depth;
90 	int encode_max_depth;
91 	php_json_error_code error_code;
92 ZEND_END_MODULE_GLOBALS(json)
93 
94 PHP_JSON_API ZEND_EXTERN_MODULE_GLOBALS(json)
95 #define JSON_G(v) ZEND_MODULE_GLOBALS_ACCESSOR(json, v)
96 
97 #if defined(ZTS) && defined(COMPILE_DL_JSON)
98 ZEND_TSRMLS_CACHE_EXTERN()
99 #endif
100 
101 PHP_JSON_API int php_json_encode_ex(smart_str *buf, zval *val, int options, zend_long depth);
102 PHP_JSON_API int php_json_encode(smart_str *buf, zval *val, int options);
103 PHP_JSON_API int php_json_decode_ex(zval *return_value, char *str, size_t str_len, zend_long options, zend_long depth);
104 
php_json_decode(zval * return_value,char * str,int str_len,zend_bool assoc,zend_long depth)105 static inline int php_json_decode(zval *return_value, char *str, int str_len, zend_bool assoc, zend_long depth)
106 {
107 	return php_json_decode_ex(return_value, str, str_len, assoc ? PHP_JSON_OBJECT_AS_ARRAY : 0, depth);
108 }
109 
110 #endif  /* PHP_JSON_H */
111