Typed constants

kocsismate · moliata · bwoebi · kocsismate · commit 762f8b983bfd · 2023-01-27T09:36:42.000+01:00
Co-Authored-By: moliata &lt;7127204+moliata@users.noreply.github.com&gt;
Co-Authored-By: Bob Weinand &lt;bobwei9@hotmail.com&gt;
diff --git a/Zend/tests/enum/name-property.phpt b/Zend/tests/enum/name-property.phpt
@@ -33,14 +33,14 @@ array(1) {
 string(3) "Bar"
 array(2) {
   [0]=>
-  object(ReflectionProperty)#3 (2) {
+  object(ReflectionProperty)#4 (2) {
     ["name"]=>
     string(4) "name"
     ["class"]=>
     string(6) "IntFoo"
   }
   [1]=>
-  object(ReflectionProperty)#4 (2) {
+  object(ReflectionProperty)#5 (2) {
     ["name"]=>
     string(5) "value"
     ["class"]=>
diff --git a/Zend/tests/type_declarations/typed_class_constants_001.phpt b/Zend/tests/type_declarations/typed_class_constants_001.phpt
@@ -0,0 +1,40 @@
+--TEST--
+Typed class constants (declaration; simple)
+--FILE--
+<?php
+class A {
+    public const null A = null;
+    public const false B = false;
+    public const true C = true;
+    public const bool D = true;
+    public const int E = 0;
+    public const float F = 3.14;
+    public const string G = "";
+    public const array H = [];
+    public const array|string I = "";
+    public const array|string|null J = null;
+}
+
+var_dump(A::A);
+var_dump(A::B);
+var_dump(A::C);
+var_dump(A::D);
+var_dump(A::E);
+var_dump(A::F);
+var_dump(A::G);
+var_dump(A::H);
+var_dump(A::I);
+var_dump(A::J);
+?>
+--EXPECT--
+NULL
+bool(false)
+bool(true)
+bool(true)
+int(0)
+float(3.14)
+string(0) ""
+array(0) {
+}
+string(0) ""
+NULL
diff --git a/Zend/tests/type_declarations/typed_class_constants_002.phpt b/Zend/tests/type_declarations/typed_class_constants_002.phpt
@@ -0,0 +1,10 @@
+--TEST--
+Typed class constants (type mismatch; compile-time)
+--FILE--
+<?php
+class A {
+    public const string A = 1;
+}
+?>
+--EXPECTF--
+Fatal error: Cannot use int as value for class constant A::A of type string in %s on line %d
diff --git a/Zend/tests/type_declarations/typed_class_constants_003.phpt b/Zend/tests/type_declarations/typed_class_constants_003.phpt
@@ -0,0 +1,17 @@
+--TEST--
+Typed class constants (type mismatch; runtime)
+--FILE--
+<?php
+class A {
+    public const string A = A;
+}
+
+define('A', 1);
+
+echo A::A;
+?>
+--EXPECTF--
+Fatal error: Uncaught TypeError: Cannot assign int to class constant A::A of type string in %s:%d
+Stack trace:
+#0 {main}
+  thrown in %s on line %d
diff --git a/Zend/tests/type_declarations/typed_class_constants_004.phpt b/Zend/tests/type_declarations/typed_class_constants_004.phpt
@@ -0,0 +1,14 @@
+--TEST--
+Typed class constants (inheritance; simple)
+--FILE--
+<?php
+class A {
+    public const int A = 1;
+}
+
+class B extends A {
+    public const string A = 'a';
+}
+?>
+--EXPECTF--
+Fatal error: Declaration of B::A must be compatible with A::A in %s on line %d
diff --git a/Zend/tests/type_declarations/typed_class_constants_005.phpt b/Zend/tests/type_declarations/typed_class_constants_005.phpt
@@ -0,0 +1,14 @@
+--TEST--
+Typed class constants (inheritance; missing type in child)
+--FILE--
+<?php
+class A {
+    public const int A = 1;
+}
+
+class B extends A {
+    public const A = 0;
+}
+?>
+--EXPECTF--
+Fatal error: Declaration of B::A must be compatible with A::A in %s on line %d
diff --git a/Zend/tests/type_declarations/typed_class_constants_006.phpt b/Zend/tests/type_declarations/typed_class_constants_006.phpt
@@ -0,0 +1,10 @@
+--TEST--
+Typed class constants (type not allowed; object)
+--FILE--
+<?php
+class A {
+    public const object A = 1;
+}
+?>
+--EXPECTF--
+Fatal error: Class constant A::A cannot have type object in %s on line %d
diff --git a/Zend/tests/type_declarations/typed_class_constants_007.phpt b/Zend/tests/type_declarations/typed_class_constants_007.phpt
@@ -0,0 +1,10 @@
+--TEST--
+Typed class constants (type not allowed; void)
+--FILE--
+<?php
+class A {
+    public const void A = 1;
+}
+?>
+--EXPECTF--
+Fatal error: Class constant A::A cannot have type void in %s on line %d
diff --git a/Zend/tests/type_declarations/typed_class_constants_008.phpt b/Zend/tests/type_declarations/typed_class_constants_008.phpt
@@ -0,0 +1,10 @@
+--TEST--
+Typed class constants (type not allowed; callable)
+--FILE--
+<?php
+class A {
+    public const callable A = 1;
+}
+?>
+--EXPECTF--
+Fatal error: Class constant A::A cannot have type callable in %s on line %d
diff --git a/Zend/tests/type_declarations/typed_class_constants_009.phpt b/Zend/tests/type_declarations/typed_class_constants_009.phpt
@@ -0,0 +1,16 @@
+--TEST--
+Typed class constants (inheritance; private constants)
+--FILE--
+<?php
+class A {
+    private const int A = 1;
+}
+
+class B extends A {
+    public const string A = 'a';
+}
+
+echo B::A;
+?>
+--EXPECT--
+a
diff --git a/Zend/tests/type_declarations/typed_class_constants_010.phpt b/Zend/tests/type_declarations/typed_class_constants_010.phpt
@@ -0,0 +1,10 @@
+--TEST--
+Typed class constants (type not allowed; class name)
+--FILE--
+<?php
+class A {
+    public const self A = 1;
+}
+?>
+--EXPECTF--
+Fatal error: Class constant A::A cannot have type self in %s on line %d
diff --git a/Zend/tests/type_declarations/typed_class_constants_011.phpt b/Zend/tests/type_declarations/typed_class_constants_011.phpt
@@ -0,0 +1,12 @@
+--TEST--
+Typed class constants (declaration; iterable)
+--FILE--
+<?php
+class A {
+    public const iterable A = [1];
+}
+
+var_dump(A::A);
+?>
+--EXPECTF--
+Fatal error: Class constant A::A cannot have type Traversable|array in %s on line %d
diff --git a/Zend/tests/type_declarations/typed_class_constants_012.phpt b/Zend/tests/type_declarations/typed_class_constants_012.phpt
@@ -0,0 +1,11 @@
+--TEST--
+Typed class constants doesn't support intersection types
+--FILE--
+<?php
+class A {
+    public const stdClass&A A = 1;
+}
+
+?>
+--EXPECTF--
+Fatal error: Class constant A::A cannot have type stdClass&A in %s on line %d
diff --git a/Zend/tests/type_declarations/typed_class_constants_013.phpt b/Zend/tests/type_declarations/typed_class_constants_013.phpt
@@ -0,0 +1,11 @@
+--TEST--
+Typed class constants doesn't support static types
+--FILE--
+<?php
+class A {
+    public const static A = 1;
+}
+
+?>
+--EXPECTF--
+Parse error: syntax error, unexpected identifier "A", expecting "=" in %s on line %d
diff --git a/Zend/tests/type_declarations/typed_class_constants_014.phpt b/Zend/tests/type_declarations/typed_class_constants_014.phpt
@@ -0,0 +1,24 @@
+--TEST--
+Typed class constants (inheritance success)
+--FILE--
+<?php
+class A {
+    public const A = 1;
+    public const B = 1;
+    public const mixed C = 1;
+}
+
+class B extends A {
+    public const int A = 0;
+    public const mixed B = 0;
+    public const mixed C = 0;
+}
+
+var_dump(B::A);
+var_dump(B::B);
+var_dump(B::C);
+?>
+--EXPECT--
+int(0)
+int(0)
+int(0)
diff --git a/Zend/zend_API.c b/Zend/zend_API.c
@@ -1463,6 +1463,10 @@ ZEND_API zend_result zend_update_class_constants(zend_class_entry *class_type) /
 				if (UNEXPECTED(zval_update_constant_ex(val, c->ce) != SUCCESS)) {
 					return FAILURE;
 				}
+
+				if (ZEND_TYPE_IS_SET(c->type) && UNEXPECTED(!zend_verify_class_constant_type(c, val))) {
+					return FAILURE;
+				}
 			}
 		} ZEND_HASH_FOREACH_END();
 	}
@@ -4516,7 +4520,7 @@ ZEND_API void zend_declare_property_stringl(zend_class_entry *ce, const char *na
 }
 /* }}} */
 
-ZEND_API zend_class_constant *zend_declare_class_constant_ex(zend_class_entry *ce, zend_string *name, zval *value, int flags, zend_string *doc_comment) /* {{{ */
+ZEND_API zend_class_constant *zend_declare_typed_class_constant(zend_class_entry *ce, zend_string *name, zval *value, int flags, zend_string *doc_comment, zend_type type) /* {{{ */
 {
 	zend_class_constant *c;
 
@@ -4540,11 +4544,15 @@ ZEND_API zend_class_constant *zend_declare_class_constant_ex(zend_class_entry *c
 	} else {
 		c = zend_arena_alloc(&CG(arena), sizeof(zend_class_constant));
 	}
+
 	ZVAL_COPY_VALUE(&c->value, value);
 	ZEND_CLASS_CONST_FLAGS(c) = flags;
+	c->name = name;
 	c->doc_comment = doc_comment;
 	c->attributes = NULL;
 	c->ce = ce;
+	c->type = type;
+
 	if (Z_TYPE_P(value) == IS_CONSTANT_AST) {
 		ce->ce_flags &= ~ZEND_ACC_CONSTANTS_UPDATED;
 		ce->ce_flags |= ZEND_ACC_HAS_AST_CONSTANTS;
@@ -4560,7 +4568,11 @@ ZEND_API zend_class_constant *zend_declare_class_constant_ex(zend_class_entry *c
 
 	return c;
 }
-/* }}} */
+
+ZEND_API zend_class_constant *zend_declare_class_constant_ex(zend_class_entry *ce, zend_string *name, zval *value, int flags, zend_string *doc_comment)
+{
+	return zend_declare_typed_class_constant(ce, name, value, flags, doc_comment, (zend_type) ZEND_TYPE_INIT_NONE(0));
+}
 
 ZEND_API void zend_declare_class_constant(zend_class_entry *ce, const char *name, size_t name_length, zval *value) /* {{{ */
 {
diff --git a/Zend/zend_API.h b/Zend/zend_API.h
@@ -423,6 +423,7 @@ ZEND_API void zend_declare_property_double(zend_class_entry *ce, const char *nam
 ZEND_API void zend_declare_property_string(zend_class_entry *ce, const char *name, size_t name_length, const char *value, int access_type);
 ZEND_API void zend_declare_property_stringl(zend_class_entry *ce, const char *name, size_t name_length, const char *value, size_t value_len, int access_type);
 
+ZEND_API zend_class_constant *zend_declare_typed_class_constant(zend_class_entry *ce, zend_string *name, zval *value, int access_type, zend_string *doc_comment, zend_type type);
 ZEND_API zend_class_constant *zend_declare_class_constant_ex(zend_class_entry *ce, zend_string *name, zval *value, int access_type, zend_string *doc_comment);
 ZEND_API void zend_declare_class_constant(zend_class_entry *ce, const char *name, size_t name_length, zval *value);
 ZEND_API void zend_declare_class_constant_null(zend_class_entry *ce, const char *name, size_t name_length);
diff --git a/Zend/zend_ast.h b/Zend/zend_ast.h
@@ -161,7 +161,6 @@ enum _zend_ast_kind {
 	ZEND_AST_CATCH,
 	ZEND_AST_PROP_GROUP,
 	ZEND_AST_PROP_ELEM,
-	ZEND_AST_CONST_ELEM,
 
 	// Pseudo node for initializing enums
 	ZEND_AST_CONST_ENUM_INIT,
@@ -170,6 +169,7 @@ enum _zend_ast_kind {
 	ZEND_AST_FOR = 4 << ZEND_AST_NUM_CHILDREN_SHIFT,
 	ZEND_AST_FOREACH,
 	ZEND_AST_ENUM_CASE,
+	ZEND_AST_CONST_ELEM,
 
 	/* 5 child nodes */
 	ZEND_AST_PARAM = 5 << ZEND_AST_NUM_CHILDREN_SHIFT,
diff --git a/Zend/zend_compile.c b/Zend/zend_compile.c
@@ -7676,7 +7676,7 @@ static void zend_check_trait_alias_modifiers(uint32_t attr) /* {{{ */
 }
 /* }}} */
 
-static void zend_compile_class_const_decl(zend_ast *ast, uint32_t flags, zend_ast *attr_ast) /* {{{ */
+static void zend_compile_class_const_decl(zend_ast *ast, uint32_t flags, zend_ast *attr_ast)
 {
 	zend_ast_list *list = zend_ast_get_list(ast);
 	zend_class_entry *ce = CG(active_class_entry);
@@ -7688,9 +7688,28 @@ static void zend_compile_class_const_decl(zend_ast *ast, uint32_t flags, zend_as
 		zend_ast *name_ast = const_ast->child[0];
 		zend_ast **value_ast_ptr = &const_ast->child[1];
 		zend_ast *doc_comment_ast = const_ast->child[2];
+		zend_ast *type_ast = const_ast->child[3];
 		zend_string *name = zval_make_interned_string(zend_ast_get_zval(name_ast));
 		zend_string *doc_comment = doc_comment_ast ? zend_string_copy(zend_ast_get_str(doc_comment_ast)) : NULL;
 		zval value_zv;
+		zend_type type = ZEND_TYPE_INIT_NONE(0);
+
+		if (type_ast) {
+			type = zend_compile_typename(type_ast, /* force_allow_null */ 0);
+
+			uint32_t type_mask = ZEND_TYPE_PURE_MASK(type);
+
+			if (ZEND_TYPE_IS_INTERSECTION(type) || (
+					type_mask != MAY_BE_ANY &&
+					(type_mask & (MAY_BE_OBJECT|MAY_BE_CALLABLE|MAY_BE_VOID) || ZEND_TYPE_HAS_NAME(type))
+				)
+			) {
+				zend_string *type_str = zend_type_to_string(type);
+
+				zend_error_noreturn(E_COMPILE_ERROR, "Class constant %s::%s cannot have type %s",
+					ZSTR_VAL(ce->name), ZSTR_VAL(name), ZSTR_VAL(type_str));
+			}
+		}
 
 		if (UNEXPECTED((flags & ZEND_ACC_PRIVATE) && (flags & ZEND_ACC_FINAL))) {
 			zend_error_noreturn(
@@ -7700,14 +7719,21 @@ static void zend_compile_class_const_decl(zend_ast *ast, uint32_t flags, zend_as
 		}
 
 		zend_const_expr_to_zval(&value_zv, value_ast_ptr, /* allow_dynamic */ false);
-		c = zend_declare_class_constant_ex(ce, name, &value_zv, flags, doc_comment);
+
+		if (!Z_CONSTANT(value_zv) && ZEND_TYPE_IS_SET(type) && !zend_is_valid_default_value(type, &value_zv)) {
+			zend_string *type_str = zend_type_to_string(type);
+
+			zend_error_noreturn(E_COMPILE_ERROR, "Cannot use %s as value for class constant %s::%s of type %s",
+				zend_zval_type_name(&value_zv), ZSTR_VAL(ce->name), ZSTR_VAL(name), ZSTR_VAL(type_str));
+		}
+
+		c = zend_declare_typed_class_constant(ce, name, &value_zv, flags, doc_comment, type);
 
 		if (attr_ast) {
 			zend_compile_attributes(&c->attributes, attr_ast, 0, ZEND_ATTRIBUTE_TARGET_CLASS_CONST, 0);
 		}
 	}
 }
-/* }}} */
 
 static void zend_compile_class_const_group(zend_ast *ast) /* {{{ */
 {
diff --git a/Zend/zend_compile.h b/Zend/zend_compile.h
@@ -404,9 +404,11 @@ typedef struct _zend_property_info {
 
 typedef struct _zend_class_constant {
 	zval value; /* flags are stored in u2 */
+	zend_string *name;
 	zend_string *doc_comment;
 	HashTable *attributes;
 	zend_class_entry *ce;
+	zend_type type;
 } zend_class_constant;
 
 #define ZEND_CLASS_CONST_FLAGS(c) Z_CONSTANT_FLAGS((c)->value)
diff --git a/Zend/zend_execute.c b/Zend/zend_execute.c
diff --git a/Zend/zend_execute.h b/Zend/zend_execute.h
diff --git a/Zend/zend_inheritance.c b/Zend/zend_inheritance.c
diff --git a/Zend/zend_language_parser.y b/Zend/zend_language_parser.y
diff --git a/Zend/zend_vm_def.h b/Zend/zend_vm_def.h
diff --git a/Zend/zend_vm_execute.h b/Zend/zend_vm_execute.h
diff --git a/ext/reflection/php_reflection.c b/ext/reflection/php_reflection.c
diff --git a/ext/reflection/php_reflection.stub.php b/ext/reflection/php_reflection.stub.php
diff --git a/ext/reflection/php_reflection_arginfo.h b/ext/reflection/php_reflection_arginfo.h
diff --git a/ext/reflection/tests/ReflectionClassConstant_basic1.phpt b/ext/reflection/tests/ReflectionClassConstant_basic1.phpt
