Skip to content

Implement ReflectionConstant #13669

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

Closed
wants to merge 2 commits into from
Closed

Implement ReflectionConstant #13669

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
51626dd
Implement reflection constant
iluuu1994 Mar 11, 2024
ec751aa
Unify with _const_string
iluuu1994 Mar 20, 2024
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
6 changes: 3 additions & 3 deletions Zend/zend_constants.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ ZEND_API zval *zend_get_constant_str(const char *name, size_t name_len)
return NULL;
}

static zend_constant *zend_get_constant_impl(zend_string *name)
ZEND_API zend_constant *zend_get_constant_ptr(zend_string *name)
{
zend_constant *c = zend_hash_find_ptr(EG(zend_constants), name);
if (c) {
Expand All @@ -292,7 +292,7 @@ static zend_constant *zend_get_constant_impl(zend_string *name)

ZEND_API zval *zend_get_constant(zend_string *name)
{
zend_constant *c = zend_get_constant_impl(name);
zend_constant *c = zend_get_constant_ptr(name);
if (c) {
return &c->value;
}
Expand Down Expand Up @@ -521,7 +521,7 @@ ZEND_API zval *zend_get_constant_ex(zend_string *cname, zend_class_entry *scope,
}
} else {
if (cname) {
c = zend_get_constant_impl(cname);
c = zend_get_constant_ptr(cname);
} else {
c = zend_get_constant_str_impl(name, name_len);
}
Expand Down
1 change: 1 addition & 0 deletions Zend/zend_constants.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ void zend_shutdown_constants(void);
void zend_register_standard_constants(void);
ZEND_API bool zend_verify_const_access(zend_class_constant *c, zend_class_entry *ce);
ZEND_API zval *zend_get_constant(zend_string *name);
ZEND_API zend_constant *zend_get_constant_ptr(zend_string *name);
ZEND_API zval *zend_get_constant_str(const char *name, size_t name_len);
ZEND_API zval *zend_get_constant_ex(zend_string *name, zend_class_entry *scope, uint32_t flags);
ZEND_API zval *zend_get_class_constant_ex(zend_string *class_name, zend_string *constant_name, zend_class_entry *scope, uint32_t flags);
Expand Down
181 changes: 174 additions & 7 deletions ext/reflection/php_reflection.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ PHPAPI zend_class_entry *reflection_enum_ptr;
PHPAPI zend_class_entry *reflection_enum_unit_case_ptr;
PHPAPI zend_class_entry *reflection_enum_backed_case_ptr;
PHPAPI zend_class_entry *reflection_fiber_ptr;
PHPAPI zend_class_entry *reflection_constant_ptr;

/* Exception throwing macro */
#define _DO_THROW(msg) \
Expand Down Expand Up @@ -538,20 +539,48 @@ static void _class_string(smart_str *str, zend_class_entry *ce, zval *obj, char
static void _const_string(smart_str *str, char *name, zval *value, char *indent)
{
const char *type = zend_zval_type_name(value);
uint32_t flags = Z_CONSTANT_FLAGS_P(value);

smart_str_appends(str, indent);
smart_str_appends(str, "Constant [ ");

if (flags & (CONST_PERSISTENT|CONST_NO_FILE_CACHE|CONST_DEPRECATED)) {
bool first = true;
smart_str_appends(str, "<");

#define DUMP_CONST_FLAG(flag, output) \
do { \
if (flags & flag) { \
if (!first) smart_str_appends(str, ", "); \
smart_str_appends(str, output); \
first = false; \
} \
} while (0)
DUMP_CONST_FLAG(CONST_PERSISTENT, "persistent");
DUMP_CONST_FLAG(CONST_NO_FILE_CACHE, "no_file_cache");
DUMP_CONST_FLAG(CONST_DEPRECATED, "deprecated");
#undef DUMP_CONST_FLAG

smart_str_appends(str, "> ");
}

smart_str_appends(str, type);
smart_str_appendc(str, ' ');
smart_str_appends(str, name);
smart_str_appends(str, " ] { ");

if (Z_TYPE_P(value) == IS_ARRAY) {
smart_str_append_printf(str, "%s Constant [ %s %s ] { Array }\n",
indent, type, name);
smart_str_appends(str, "Array");
} else if (Z_TYPE_P(value) == IS_STRING) {
smart_str_append_printf(str, "%s Constant [ %s %s ] { %s }\n",
indent, type, name, Z_STRVAL_P(value));
smart_str_appends(str, Z_STRVAL_P(value));
} else {
zend_string *tmp_value_str;
zend_string *value_str = zval_get_tmp_string(value, &tmp_value_str);
smart_str_append_printf(str, "%s Constant [ %s %s ] { %s }\n",
indent, type, name, ZSTR_VAL(value_str));
smart_str_appends(str, ZSTR_VAL(value_str));
zend_tmp_string_release(tmp_value_str);
}

smart_str_appends(str, " }\n");
}
/* }}} */

Expand Down Expand Up @@ -1059,7 +1088,7 @@ static void _extension_string(smart_str *str, zend_module_entry *module, char *i

ZEND_HASH_MAP_FOREACH_PTR(EG(zend_constants), constant) {
if (ZEND_CONSTANT_MODULE_NUMBER(constant) == module->module_number) {
_const_string(&str_constants, ZSTR_VAL(constant->name), &constant->value, indent);
_const_string(&str_constants, ZSTR_VAL(constant->name), &constant->value, " ");
num_constants++;
}
} ZEND_HASH_FOREACH_END();
Expand Down Expand Up @@ -7207,6 +7236,140 @@ static zval *_reflection_write_property(zend_object *object, zend_string *name,
}
/* }}} */

ZEND_METHOD(ReflectionConstant, __construct)
{
zend_string *name;

zval *object = ZEND_THIS;
reflection_object *intern = Z_REFLECTION_P(object);

ZEND_PARSE_PARAMETERS_START(1, 1)
Z_PARAM_STR(name)
ZEND_PARSE_PARAMETERS_END();

/* Build name with lowercased ns. */
bool backslash_prefixed = ZSTR_VAL(name)[0] == '\\';
char *source = ZSTR_VAL(name) + backslash_prefixed;
size_t source_len = ZSTR_LEN(name) - backslash_prefixed;
zend_string *lc_name = zend_string_alloc(source_len, /* persistent */ false);
const char *ns_end = zend_memrchr(source, '\\', source_len);
size_t ns_len = 0;
if (ns_end) {
ns_len = ns_end - ZSTR_VAL(name);
zend_str_tolower_copy(ZSTR_VAL(lc_name), source, ns_len);
}
memcpy(ZSTR_VAL(lc_name) + ns_len, source + ns_len, source_len - ns_len);

zend_constant *const_ = zend_get_constant_ptr(lc_name);
zend_string_release_ex(lc_name, /* persistent */ false);
if (!const_) {
zend_throw_exception_ex(reflection_exception_ptr, 0, "Constant \"%s\" does not exist", ZSTR_VAL(name));
RETURN_THROWS();
}

intern->ptr = const_;
intern->ref_type = REF_TYPE_OTHER;

zval *name_zv = reflection_prop_name(object);
zval_ptr_dtor(name_zv);
ZVAL_STR_COPY(name_zv, name);
}

ZEND_METHOD(ReflectionConstant, getName)
{
reflection_object *intern;
zend_constant *const_;

if (zend_parse_parameters_none() == FAILURE) {
RETURN_THROWS();
}

GET_REFLECTION_OBJECT_PTR(const_);
RETURN_STR_COPY(const_->name);
}

ZEND_METHOD(ReflectionConstant, getNamespaceName)
{
reflection_object *intern;
zend_constant *const_;

if (zend_parse_parameters_none() == FAILURE) {
RETURN_THROWS();
}

GET_REFLECTION_OBJECT_PTR(const_);

const char *backslash = zend_memrchr(ZSTR_VAL(const_->name), '\\', ZSTR_LEN(const_->name));
if (backslash) {
size_t length = backslash - ZSTR_VAL(const_->name);
RETURN_STRINGL(ZSTR_VAL(const_->name), length);
} else {
RETURN_EMPTY_STRING();
}
}

ZEND_METHOD(ReflectionConstant, getShortName)
{
reflection_object *intern;
zend_constant *const_;

if (zend_parse_parameters_none() == FAILURE) {
RETURN_THROWS();
}

GET_REFLECTION_OBJECT_PTR(const_);

const char *backslash = zend_memrchr(ZSTR_VAL(const_->name), '\\', ZSTR_LEN(const_->name));
if (backslash) {
size_t prefix = backslash - ZSTR_VAL(const_->name) + 1;
size_t length = ZSTR_LEN(const_->name) - prefix;
RETURN_STRINGL(ZSTR_VAL(const_->name) + prefix, length);
} else {
RETURN_STR_COPY(const_->name);
}
}

ZEND_METHOD(ReflectionConstant, getValue)
{
reflection_object *intern;
zend_constant *const_;

if (zend_parse_parameters_none() == FAILURE) {
RETURN_THROWS();
}

GET_REFLECTION_OBJECT_PTR(const_);
RETURN_COPY(&const_->value);
}

ZEND_METHOD(ReflectionConstant, isDeprecated)
{
reflection_object *intern;
zend_constant *const_;

if (zend_parse_parameters_none() == FAILURE) {
RETURN_THROWS();
}

GET_REFLECTION_OBJECT_PTR(const_);
RETURN_BOOL(ZEND_CONSTANT_FLAGS(const_) & CONST_DEPRECATED);
}

ZEND_METHOD(ReflectionConstant, __toString)
{
reflection_object *intern;
zend_constant *const_;
smart_str str = {0};

if (zend_parse_parameters_none() == FAILURE) {
RETURN_THROWS();
}

GET_REFLECTION_OBJECT_PTR(const_);
_const_string(&str, ZSTR_VAL(const_->name), &const_->value, "");
RETURN_STR(smart_str_extract(&str));
}

PHP_MINIT_FUNCTION(reflection) /* {{{ */
{
memcpy(&reflection_object_handlers, &std_object_handlers, sizeof(zend_object_handlers));
Expand Down Expand Up @@ -7306,6 +7469,10 @@ PHP_MINIT_FUNCTION(reflection) /* {{{ */
reflection_fiber_ptr->create_object = reflection_objects_new;
reflection_fiber_ptr->default_object_handlers = &reflection_object_handlers;

reflection_constant_ptr = register_class_ReflectionConstant(reflector_ptr);
reflection_constant_ptr->create_object = reflection_objects_new;
reflection_constant_ptr->default_object_handlers = &reflection_object_handlers;

REFLECTION_G(key_initialized) = 0;

return SUCCESS;
Expand Down
23 changes: 23 additions & 0 deletions ext/reflection/php_reflection.stub.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -826,3 +826,26 @@ public function getCallable(): callable {}

public function getTrace(int $options = DEBUG_BACKTRACE_PROVIDE_OBJECT): array {}
}

/**
* @strict-properties
* @not-serializable
*/
final class ReflectionConstant implements Reflector
{
public string $name;

public function __construct(string $name) {}

public function getName(): string {}

public function getNamespaceName(): string {}

public function getShortName(): string {}

public function getValue(): mixed {}

public function isDeprecated(): bool {}

public function __toString(): string {}
}
53 changes: 52 additions & 1 deletion ext/reflection/php_reflection_arginfo.h
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

24 changes: 24 additions & 0 deletions ext/reflection/tests/ReflectionConstant_double_construct.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
--TEST--
ReflectionConstant double construct call
--FILE--
<?php

const C1 = 42;
const C2 = 43;

$r = new ReflectionConstant('C' . mt_rand(1, 1));
var_dump($r);

$r->__construct('C' . mt_rand(2, 2));
var_dump($r);

?>
--EXPECT--
object(ReflectionConstant)#1 (1) {
["name"]=>
string(2) "C1"
}
object(ReflectionConstant)#1 (1) {
["name"]=>
string(2) "C2"
}
Loading