Skip to content

ext/json: Various refactorings #18427

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

ext/json: Various refactorings #18427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
941b07f
ext/json: Various small refactorings
Girgias Apr 25, 2025
c275f91
ext/json: Refactor php_json_encode_array()
Girgias Apr 26, 2025
9863f62
ext/json: Refactor parser methods
Girgias Apr 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 15 additions & 31 deletions ext/json/json_encoder.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,18 +41,6 @@ static zend_always_inline bool php_json_check_stack_limit(void)
#endif
}

static int php_json_determine_array_type(zval *val) /* {{{ */
{
zend_array *myht = Z_ARRVAL_P(val);

if (myht) {
return zend_array_is_list(myht) ? PHP_JSON_OUTPUT_ARRAY : PHP_JSON_OUTPUT_OBJECT;
}

return PHP_JSON_OUTPUT_ARRAY;
}
/* }}} */

/* {{{ Pretty printing support functions */

static inline void php_json_pretty_print_char(smart_str *buf, int options, char c) /* {{{ */
Expand All @@ -63,12 +51,10 @@ static inline void php_json_pretty_print_char(smart_str *buf, int options, char
}
/* }}} */

static inline void php_json_pretty_print_indent(smart_str *buf, int options, php_json_encoder *encoder) /* {{{ */
static inline void php_json_pretty_print_indent(smart_str *buf, int options, const php_json_encoder *encoder) /* {{{ */
{
int i;

if (options & PHP_JSON_PRETTY_PRINT) {
for (i = 0; i < encoder->depth; ++i) {
for (int i = 0; i < encoder->depth; ++i) {
smart_str_appendl(buf, " ", 4);
}
}
Expand Down Expand Up @@ -122,7 +108,8 @@ static inline void php_json_encode_double(smart_str *buf, double d, int options)

static zend_result php_json_encode_array(smart_str *buf, zval *val, int options, php_json_encoder *encoder) /* {{{ */
{
int r, need_comma = 0;
bool encode_as_object = options & PHP_JSON_FORCE_OBJECT;
bool need_comma = false;
HashTable *myht, *prop_ht;
zend_refcounted *recursion_rc;

Expand All @@ -138,17 +125,15 @@ static zend_result php_json_encode_array(smart_str *buf, zval *val, int options,
myht = Z_ARRVAL_P(val);
recursion_rc = (zend_refcounted *)myht;
prop_ht = NULL;
r = (options & PHP_JSON_FORCE_OBJECT) ? PHP_JSON_OUTPUT_OBJECT : php_json_determine_array_type(val);
encode_as_object = encode_as_object || !zend_array_is_list(myht);
} else if (Z_OBJ_P(val)->properties == NULL
&& Z_OBJ_HT_P(val)->get_properties_for == NULL
&& Z_OBJ_HT_P(val)->get_properties == zend_std_get_properties
&& Z_OBJ_P(val)->ce->num_hooked_props == 0
&& !zend_object_is_lazy(Z_OBJ_P(val))) {
/* Optimized version without rebuilding properties HashTable */
zend_object *obj = Z_OBJ_P(val);
zend_class_entry *ce = obj->ce;
zend_property_info *prop_info;
zval *prop;
const zend_class_entry *ce = obj->ce;

if (GC_IS_RECURSIVE(obj)) {
encoder->error_code = PHP_JSON_ERROR_RECURSION;
Expand All @@ -163,15 +148,15 @@ static zend_result php_json_encode_array(smart_str *buf, zval *val, int options,
++encoder->depth;

for (int i = 0; i < ce->default_properties_count; i++) {
prop_info = ce->properties_info_table[i];
zend_property_info *prop_info = ce->properties_info_table[i];
if (!prop_info) {
continue;
}
if (ZSTR_VAL(prop_info->name)[0] == '\0' && ZSTR_LEN(prop_info->name) > 0) {
/* Skip protected and private members. */
continue;
}
prop = OBJ_PROP(obj, prop_info->offset);
zval *prop = OBJ_PROP(obj, prop_info->offset);
if (Z_TYPE_P(prop) == IS_UNDEF) {
continue;
}
Expand Down Expand Up @@ -228,7 +213,7 @@ static zend_result php_json_encode_array(smart_str *buf, zval *val, int options,
* referenced from a different place in the object graph. */
recursion_rc = (zend_refcounted *)obj;
}
r = PHP_JSON_OUTPUT_OBJECT;
encode_as_object = true;
}

if (recursion_rc && GC_IS_RECURSIVE(recursion_rc)) {
Expand All @@ -240,7 +225,7 @@ static zend_result php_json_encode_array(smart_str *buf, zval *val, int options,

PHP_JSON_HASH_PROTECT_RECURSION(recursion_rc);

if (r == PHP_JSON_OUTPUT_ARRAY) {
if (!encode_as_object) {
smart_str_appendc(buf, '[');
} else {
smart_str_appendc(buf, '{');
Expand All @@ -259,7 +244,7 @@ static zend_result php_json_encode_array(smart_str *buf, zval *val, int options,
zval tmp;
ZVAL_UNDEF(&tmp);

if (r == PHP_JSON_OUTPUT_ARRAY) {
if (!encode_as_object) {
ZEND_ASSERT(Z_TYPE_P(data) != IS_PTR);

if (need_comma) {
Expand All @@ -270,7 +255,7 @@ static zend_result php_json_encode_array(smart_str *buf, zval *val, int options,

php_json_pretty_print_char(buf, options, '\n');
php_json_pretty_print_indent(buf, options, encoder);
} else if (r == PHP_JSON_OUTPUT_OBJECT) {
} else {
if (key) {
if (ZSTR_VAL(key)[0] == '\0' && ZSTR_LEN(key) > 0 && Z_TYPE_P(val) == IS_OBJECT) {
/* Skip protected and private members. */
Expand Down Expand Up @@ -354,7 +339,7 @@ static zend_result php_json_encode_array(smart_str *buf, zval *val, int options,
php_json_pretty_print_indent(buf, options, encoder);
}

if (r == PHP_JSON_OUTPUT_ARRAY) {
if (!encode_as_object) {
smart_str_appendc(buf, ']');
} else {
smart_str_appendc(buf, '}');
Expand All @@ -369,7 +354,6 @@ zend_result php_json_escape_string(
smart_str *buf, const char *s, size_t len,
int options, php_json_encoder *encoder) /* {{{ */
{
unsigned int us;
size_t pos, checkpoint;
char *dst;

Expand Down Expand Up @@ -407,7 +391,7 @@ zend_result php_json_escape_string(
0xffffffff, 0x500080c4, 0x10000000, 0x00000000,
0xffffffff, 0xffffffff, 0xffffffff, 0xffffffff};

us = (unsigned char)s[pos];
unsigned int us = (unsigned char)s[pos];
if (EXPECTED(!ZEND_BIT_TEST(charmap, us))) {
pos++;
len--;
Expand Down Expand Up @@ -626,7 +610,7 @@ static zend_result php_json_encode_serializable_object(smart_str *buf, zend_obje

static zend_result php_json_encode_serializable_enum(smart_str *buf, zval *val, int options, php_json_encoder *encoder)
{
zend_class_entry *ce = Z_OBJCE_P(val);
const zend_class_entry *ce = Z_OBJCE_P(val);
if (ce->enum_backing_type == IS_UNDEF) {
encoder->error_code = PHP_JSON_ERROR_NON_BACKED_ENUM;
smart_str_appendc(buf, '0');
Expand Down
46 changes: 10 additions & 36 deletions ext/json/json_parser.y
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,8 @@ int json_yydebug = 1;
%code {
static int php_json_yylex(union YYSTYPE *value, php_json_parser *parser);
static void php_json_yyerror(php_json_parser *parser, char const *msg);
static int php_json_parser_array_create(php_json_parser *parser, zval *array);
static int php_json_parser_object_create(php_json_parser *parser, zval *array);
static void php_json_parser_array_create(php_json_parser *parser, zval *array);
static void php_json_parser_object_create(php_json_parser *parser, zval *array);

}

Expand All @@ -89,17 +89,11 @@ object:
'{'
{
PHP_JSON_DEPTH_INC;
if (parser->methods.object_start && FAILURE == parser->methods.object_start(parser)) {
YYERROR;
}
}
members object_end
{
ZVAL_COPY_VALUE(&$$, &$3);
PHP_JSON_DEPTH_DEC;
if (parser->methods.object_end && FAILURE == parser->methods.object_end(parser, &$$)) {
YYERROR;
}
}
;

Expand Down Expand Up @@ -145,17 +139,11 @@ array:
'['
{
PHP_JSON_DEPTH_INC;
if (parser->methods.array_start && FAILURE == parser->methods.array_start(parser)) {
YYERROR;
}
}
elements array_end
{
ZVAL_COPY_VALUE(&$$, &$3);
PHP_JSON_DEPTH_DEC;
if (parser->methods.array_end && FAILURE == parser->methods.array_end(parser, &$$)) {
YYERROR;
}
}
;

Expand Down Expand Up @@ -212,29 +200,26 @@ value:

%% /* Functions */

static int php_json_parser_array_create(php_json_parser *parser, zval *array)
static void php_json_parser_array_create(php_json_parser *parser, zval *array)
{
array_init(array);
return SUCCESS;
}

static int php_json_parser_array_append(php_json_parser *parser, zval *array, zval *zvalue)
static void php_json_parser_array_append(php_json_parser *parser, zval *array, zval *zvalue)
{
zend_hash_next_index_insert(Z_ARRVAL_P(array), zvalue);
return SUCCESS;
}

static int php_json_parser_object_create(php_json_parser *parser, zval *object)
static void php_json_parser_object_create(php_json_parser *parser, zval *object)
{
if (parser->scanner.options & PHP_JSON_OBJECT_AS_ARRAY) {
array_init(object);
} else {
object_init(object);
}
return SUCCESS;
}

static int php_json_parser_object_update(php_json_parser *parser, zval *object, zend_string *key, zval *zvalue)
static zend_result php_json_parser_object_update(php_json_parser *parser, zval *object, zend_string *key, zval *zvalue)
{
/* if JSON_OBJECT_AS_ARRAY is set */
if (Z_TYPE_P(object) == IS_ARRAY) {
Expand All @@ -255,24 +240,21 @@ static int php_json_parser_object_update(php_json_parser *parser, zval *object,
return SUCCESS;
}

static int php_json_parser_array_create_validate(php_json_parser *parser, zval *array)
static void php_json_parser_array_create_validate(php_json_parser *parser, zval *array)
{
ZVAL_NULL(array);
return SUCCESS;
}

static int php_json_parser_array_append_validate(php_json_parser *parser, zval *array, zval *zvalue)
static void php_json_parser_array_append_validate(php_json_parser *parser, zval *array, zval *zvalue)
{
return SUCCESS;
}

static int php_json_parser_object_create_validate(php_json_parser *parser, zval *object)
static void php_json_parser_object_create_validate(php_json_parser *parser, zval *object)
{
ZVAL_NULL(object);
return SUCCESS;
}

static int php_json_parser_object_update_validate(php_json_parser *parser, zval *object, zend_string *key, zval *zvalue)
static zend_result php_json_parser_object_update_validate(php_json_parser *parser, zval *object, zend_string *key, zval *zvalue)
{
return SUCCESS;
}
Expand Down Expand Up @@ -312,24 +294,16 @@ static const php_json_parser_methods default_parser_methods =
{
php_json_parser_array_create,
php_json_parser_array_append,
NULL,
NULL,
php_json_parser_object_create,
php_json_parser_object_update,
NULL,
NULL,
};

static const php_json_parser_methods validate_parser_methods =
{
php_json_parser_array_create_validate,
php_json_parser_array_append_validate,
NULL,
NULL,
php_json_parser_object_create_validate,
php_json_parser_object_update_validate,
NULL,
NULL,
};

PHP_JSON_API void php_json_parser_init_ex(php_json_parser *parser,
Expand Down
4 changes: 0 additions & 4 deletions ext/json/php_json.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,10 +79,6 @@ typedef enum {
#define PHP_JSON_INVALID_UTF8_SUBSTITUTE (1<<21)
#define PHP_JSON_THROW_ON_ERROR (1<<22)

/* Internal flags */
#define PHP_JSON_OUTPUT_ARRAY 0
#define PHP_JSON_OUTPUT_OBJECT 1

/* default depth */
#define PHP_JSON_PARSER_DEFAULT_DEPTH 512

Expand Down
20 changes: 4 additions & 16 deletions ext/json/php_json_parser.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,32 +22,20 @@

typedef struct _php_json_parser php_json_parser;

typedef int (*php_json_parser_func_array_create_t)(
typedef void (*php_json_parser_func_array_create_t)(
php_json_parser *parser, zval *array);
typedef int (*php_json_parser_func_array_append_t)(
typedef void (*php_json_parser_func_array_append_t)(
php_json_parser *parser, zval *array, zval *zvalue);
typedef int (*php_json_parser_func_array_start_t)(
php_json_parser *parser);
typedef int (*php_json_parser_func_array_end_t)(
typedef void (*php_json_parser_func_object_create_t)(
php_json_parser *parser, zval *object);
typedef int (*php_json_parser_func_object_create_t)(
php_json_parser *parser, zval *object);
typedef int (*php_json_parser_func_object_update_t)(
typedef zend_result (*php_json_parser_func_object_update_t)(
php_json_parser *parser, zval *object, zend_string *key, zval *zvalue);
typedef int (*php_json_parser_func_object_start_t)(
php_json_parser *parser);
typedef int (*php_json_parser_func_object_end_t)(
php_json_parser *parser, zval *object);

typedef struct _php_json_parser_methods {
php_json_parser_func_array_create_t array_create;
php_json_parser_func_array_append_t array_append;
php_json_parser_func_array_start_t array_start;
php_json_parser_func_array_end_t array_end;
php_json_parser_func_object_create_t object_create;
php_json_parser_func_object_update_t object_update;
php_json_parser_func_object_start_t object_start;
php_json_parser_func_object_end_t object_end;
} php_json_parser_methods;

struct _php_json_parser {
Expand Down
Loading