Add AST_CLASS_NAME in AST version 70 (nikic#111)

Add AST_CLASS_NAME in AST version 70

Fixes nikic#109

Tests pass with a local PHP 7.4 installation

Author: TysonAndre

README.md

@@ -361,6 +361,7 @@ AST_CAST:             expr
 AST_CATCH:            class, var, stmts
 AST_CLASS:            name, docComment, extends, implements, stmts
 AST_CLASS_CONST:      class, const
+AST_CLASS_NAME:       class                  // version 70+
 AST_CLONE:            expr
 AST_CLOSURE:          name, docComment, params, uses, stmts, returnType
 AST_CLOSURE_VAR:      name
@@ -472,6 +473,7 @@ are listed.
   The property visibility modifiers are now part of `AST_PROP_GROUP` instead of `AST_PROP_DECL`.
 
   Note that property group type information is only available with AST versions 70+.
+* `AST_CLASS_NAME` is created instead of `AST_CLASS_CONST` for `SomeClass::class`.
 
 ### 60 (current)
 

ast.c

@@ -312,9 +312,7 @@ static inline zend_bool ast_kind_uses_attr(zend_ast_kind kind) {
 		|| kind == ZEND_AST_UNARY_OP || kind == ZEND_AST_BINARY_OP || kind == ZEND_AST_ASSIGN_OP
 		|| kind == ZEND_AST_CAST || kind == ZEND_AST_MAGIC_CONST || kind == ZEND_AST_ARRAY_ELEM
 		|| kind == ZEND_AST_INCLUDE_OR_EVAL || kind == ZEND_AST_USE || kind == ZEND_AST_PROP_DECL
-#if PHP_VERSION_ID >= 70400
 		|| kind == ZEND_AST_PROP_GROUP
-#endif
 		|| kind == ZEND_AST_GROUP_USE || kind == ZEND_AST_USE_ELEM
 		|| kind == AST_NAME || kind == AST_CLOSURE_VAR || kind == ZEND_AST_CLASS_CONST_DECL
 		|| kind == ZEND_AST_ARRAY;
@@ -340,9 +338,7 @@ static inline zend_bool ast_is_name(zend_ast *ast, zend_ast *parent, uint32_t i)
 			|| parent->kind == ZEND_AST_CALL || parent->kind == ZEND_AST_CONST
 			|| parent->kind == ZEND_AST_NEW || parent->kind == ZEND_AST_STATIC_CALL
 			|| parent->kind == ZEND_AST_CLASS_CONST || parent->kind == ZEND_AST_STATIC_PROP
-#if PHP_VERSION_ID >= 70400
-			|| parent->kind == ZEND_AST_PROP_GROUP
-#endif
+			|| parent->kind == ZEND_AST_PROP_GROUP || parent->kind == ZEND_AST_CLASS_NAME
 			;
 	}
 
@@ -724,6 +720,46 @@ static void ast_to_zval(zval *zv, zend_ast *ast, ast_state_info_t *state) {
 			ast->kind = ZEND_AST_ASSIGN_OP;
 			ast->attr = AST_BINARY_COALESCE;
 			break;
+		case ZEND_AST_CLASS_NAME:
+			if (state->version < 70) {
+				zval name_zval;
+				ast_to_zval(&name_zval, ast->child[0], state);
+				zval class_name_zval;
+				ast_create_virtual_node_ex(
+						&class_name_zval, AST_NAME, ast->child[0]->attr, zend_ast_get_lineno(ast), state, 1, &name_zval);
+				zval const_zval;
+				ZVAL_STR_COPY(&const_zval, AST_STR(str_class));
+				ast_create_virtual_node_ex(
+						zv, ZEND_AST_CLASS_CONST, 0, zend_ast_get_lineno(ast), state, 2, &class_name_zval, &const_zval);
+				return;
+			}
+			break;
+#else
+		case ZEND_AST_CLASS_CONST:
+			if (state->version >= 70) {
+				// Convert to an AST_CLASS_NAME instead. This is the opposite of the work done in the ZEND_AST_CLASS_NAME case.
+				zend_ast *const_name_ast = ast->child[1];
+				zend_string *str = zend_ast_get_str(const_name_ast);
+				if (zend_string_equals_ci(AST_STR(str_class), str)) {
+					zend_ast *class_name_ast = ast->child[0];
+					zval class_name_zval;
+					if (class_name_ast->kind == ZEND_AST_ZVAL) {
+						// e.g. Foo::class
+						zval class_name_raw_zval;
+						ZVAL_COPY(&class_name_raw_zval, zend_ast_get_zval(class_name_ast));
+						ast_create_virtual_node_ex(
+								&class_name_zval, AST_NAME, class_name_ast->attr, zend_ast_get_lineno(class_name_ast), state, 1, &class_name_raw_zval);
+					} else {
+						// e.g. []::class (not a parse error, but a runtime error)
+						ast_to_zval(&class_name_zval, class_name_ast, state);
+					}
+
+					ast_create_virtual_node_ex(
+							zv, ZEND_AST_CLASS_NAME, 0, zend_ast_get_lineno(ast), state, 1, &class_name_zval);
+					return;
+				}
+			}
+			break;
 #endif
 	}
 

ast_data.c

@@ -55,6 +55,7 @@ const zend_ast_kind ast_kinds[] = {
 	ZEND_AST_GOTO,
 	ZEND_AST_BREAK,
 	ZEND_AST_CONTINUE,
+	ZEND_AST_CLASS_NAME,
 	ZEND_AST_DIM,
 	ZEND_AST_PROP,
 	ZEND_AST_STATIC_PROP,
@@ -153,6 +154,7 @@ const char *ast_kind_to_name(zend_ast_kind kind) {
 		case ZEND_AST_GOTO: return "AST_GOTO";
 		case ZEND_AST_BREAK: return "AST_BREAK";
 		case ZEND_AST_CONTINUE: return "AST_CONTINUE";
+		case ZEND_AST_CLASS_NAME: return "AST_CLASS_NAME";
 		case ZEND_AST_DIM: return "AST_DIM";
 		case ZEND_AST_PROP: return "AST_PROP";
 		case ZEND_AST_STATIC_PROP: return "AST_STATIC_PROP";
@@ -388,6 +390,11 @@ zend_string *ast_kind_child_name(zend_ast_kind kind, uint32_t child) {
 				case 0: return AST_STR(str_depth);
 			}
 			return NULL;
+		case ZEND_AST_CLASS_NAME:
+			switch (child) {
+				case 0: return AST_STR(str_class);
+			}
+			return NULL;
 		case ZEND_AST_DIM:
 			switch (child) {
 				case 0: return AST_STR(str_expr);
@@ -688,6 +695,7 @@ void ast_register_kind_constants(INIT_FUNC_ARGS) {
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_GOTO", ZEND_AST_GOTO, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_BREAK", ZEND_AST_BREAK, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_CONTINUE", ZEND_AST_CONTINUE, CONST_CS | CONST_PERSISTENT);
+	REGISTER_NS_LONG_CONSTANT("ast", "AST_CLASS_NAME", ZEND_AST_CLASS_NAME, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_DIM", ZEND_AST_DIM, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_PROP", ZEND_AST_PROP, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_STATIC_PROP", ZEND_AST_STATIC_PROP, CONST_CS | CONST_PERSISTENT);

ast_str_defs.h

@@ -23,9 +23,9 @@
 	X(offset) \
 	X(label) \
 	X(depth) \
+	X(class) \
 	X(dim) \
 	X(prop) \
-	X(class) \
 	X(args) \
 	X(const) \
 	X(left) \

package.xml

@@ -24,8 +24,10 @@
  <license uri="https://github.com/nikic/php-ast/blob/master/LICENSE">BSD-3-Clause</license>
  <notes>
 - Fix a segfault in PHP 7.4-dev after typed properties support was added.
-- Add AST version 70 (experimental): This adds AST_PROP_GROUP with type information for property groups.
 - Support BINARY_COALESCE as a flag of AST_ASSIGN_OP for the `??=` operator in PHP 7.4-dev.
+- Add AST version 70 (experimental):
+- Version 70 adds AST_PROP_GROUP with type information for property groups.
+- Version 70 adds AST_CLASS_CONST for `Foo::class`
  </notes>
  <contents>
   <dir name="/">

php_ast.h

@@ -51,6 +51,8 @@ extern ast_str_globals str_globals;
 
 // 544 is already taken by ZEND_AST_GROUP_USE
 #if PHP_VERSION_ID < 70400
+// NOTE: The first hex digit is the number of child nodes a given kind has
+# define ZEND_AST_CLASS_NAME 0x1ff
 # define ZEND_AST_PROP_GROUP 0x2ff
 #endif
 

scripts/generate_ast_data.php

@@ -93,6 +93,7 @@
     'ZEND_AST_GOTO' => ['label'],
     'ZEND_AST_BREAK' => ['depth'],
     'ZEND_AST_CONTINUE' => ['depth'],
+    'ZEND_AST_CLASS_NAME' => ['class'],
 
     /* 2 child nodes */
     'ZEND_AST_DIM' => ['expr', 'dim'],

tests/class_name_version_50.phpt

@@ -0,0 +1,41 @@
+--TEST--
+Class properties in AST version 50
+--FILE--
+<?php
+
+require __DIR__ . '/../util.php';
+
+$code = <<<'PHP'
+<?php
+namespace Foo;
+echo Bar::class;
+echo namespace\Bat::class;
+echo \Baz::class;
+PHP;
+
+$node = ast\parse_code($code, $version=50);
+echo ast_dump($node), "\n";
+?>
+--EXPECTF--
+AST_STMT_LIST
+    0: AST_NAMESPACE
+        name: "Foo"
+        stmts: null
+    1: AST_ECHO
+        expr: AST_CLASS_CONST
+            class: AST_NAME
+                flags: NAME_NOT_FQ (1)
+                name: "Bar"
+            const: "class"
+    2: AST_ECHO
+        expr: AST_CLASS_CONST
+            class: AST_NAME
+                flags: NAME_RELATIVE (2)
+                name: "Bat"
+            const: "class"
+    3: AST_ECHO
+        expr: AST_CLASS_CONST
+            class: AST_NAME
+                flags: NAME_FQ (0)
+                name: "Baz"
+            const: "class"

tests/class_name_version_70.phpt

@@ -0,0 +1,64 @@
+--TEST--
+Class properties in AST version 70
+--FILE--
+<?php
+
+require __DIR__ . '/../util.php';
+
+$code = <<<'PHP'
+<?php
+namespace Foo;
+echo Bar::class,
+namespace\Bat::class,
+Bat::class_,  // this is a regular class constant
+\Baz::CLASS;
+echo []::class;  // this is a runtime error, not a syntax error
+echo 'foo'::class;  // this is valid but rare
+echo (new \stdClass())::class;  // this is a runtime error, not a syntax error
+PHP;
+
+$node = ast\parse_code($code, $version=70);
+echo ast_dump($node), "\n";
+?>
+--EXPECTF--
+AST_STMT_LIST
+    0: AST_NAMESPACE
+        name: "Foo"
+        stmts: null
+    1: AST_ECHO
+        expr: AST_CLASS_NAME
+            class: AST_NAME
+                flags: NAME_NOT_FQ (%d)
+                name: "Bar"
+    2: AST_ECHO
+        expr: AST_CLASS_NAME
+            class: AST_NAME
+                flags: NAME_RELATIVE (%d)
+                name: "Bat"
+    3: AST_ECHO
+        expr: AST_CLASS_CONST
+            class: AST_NAME
+                flags: NAME_NOT_FQ (%d)
+                name: "Bat"
+            const: "class_"
+    4: AST_ECHO
+        expr: AST_CLASS_NAME
+            class: AST_NAME
+                flags: NAME_FQ (%d)
+                name: "Baz"
+    5: AST_ECHO
+        expr: AST_CLASS_NAME
+            class: AST_ARRAY
+                flags: %s
+    6: AST_ECHO
+        expr: AST_CLASS_NAME
+            class: AST_NAME
+                flags: NAME_FQ (%d)
+                name: "foo"
+    7: AST_ECHO
+        expr: AST_CLASS_NAME
+            class: AST_NEW
+                class: AST_NAME
+                    flags: NAME_FQ (0)
+                    name: "stdClass"
+                args: AST_ARG_LIST

tests/metadata.phpt

@@ -72,6 +72,7 @@ AST_THROW: []
 AST_GOTO: []
 AST_BREAK: []
 AST_CONTINUE: []
+AST_CLASS_NAME: []
 AST_DIM: []
 AST_PROP: []
 AST_STATIC_PROP: []