Merge pull request nikic#137 from TysonAndre/support-union-type

Support PHP 8.0 Union Type RFC

Author: TysonAndre

README.md

@@ -454,6 +454,7 @@ AST_STMT_LIST
 AST_SWITCH_LIST
 AST_TRAIT_ADAPTATIONS
 AST_USE
+AST_TYPE_UNION            // php 8.0+ union types
 ```
 
 AST Versioning

ast.c

@@ -348,13 +348,21 @@ static inline zend_bool ast_kind_is_decl(zend_ast_kind kind) {
 }
 
 static inline zend_bool ast_is_name(zend_ast *ast, zend_ast *parent, uint32_t i) {
-	if (!ast || ast->kind != ZEND_AST_ZVAL || Z_TYPE_P(zend_ast_get_zval(ast)) != IS_STRING) {
+	if (!ast) {
+		return 0;
+	}
+	if (ast->kind != ZEND_AST_ZVAL || Z_TYPE_P(zend_ast_get_zval(ast)) != IS_STRING) {
 		return 0;
 	}
 
 	if (parent->kind == ZEND_AST_NAME_LIST) {
 		return 1;
 	}
+#if PHP_VERSION_ID >= 80000
+	if (parent->kind == ZEND_AST_TYPE_UNION) {
+		return 1;
+	}
+#endif
 
 	if (i == 0) {
 		return parent->kind == ZEND_AST_CATCH || parent->kind == ZEND_AST_CLASS
@@ -383,6 +391,11 @@ static inline zend_bool ast_is_name(zend_ast *ast, zend_ast *parent, uint32_t i)
 
 /* Assumes that ast_is_name is already true */
 static inline zend_bool ast_is_type(zend_ast *ast, zend_ast *parent, uint32_t i) {
+#if PHP_VERSION_ID >= 80000
+	if (parent->kind == ZEND_AST_TYPE_UNION) {
+		return 1;
+	}
+#endif
 	if (i == 0) {
 		return parent->kind == ZEND_AST_PARAM
 #if PHP_VERSION_ID >= 70400
@@ -444,6 +457,8 @@ static const builtin_type_info builtin_types[] = {
 	{ZEND_STRL("void"), IS_VOID},
 	{ZEND_STRL("iterable"), IS_ITERABLE},
 	{ZEND_STRL("object"), IS_OBJECT},
+	{ZEND_STRL("null"), IS_NULL},  /* Null and false for php 8.0 union types */
+	{ZEND_STRL("false"), IS_FALSE},
 	{NULL, 0, IS_UNDEF}
 };
 static inline zend_uchar lookup_builtin_type(const zend_string *name) {
@@ -579,12 +594,13 @@ static void ast_fill_children_ht(HashTable *ht, zend_ast *ast, ast_state_info_t
 	uint32_t i, count;
 	zend_bool is_list = zend_ast_is_list(ast);
 	zend_ast **children = ast_get_children(ast, &count);
+	const zend_ast_kind ast_kind = ast->kind;
 	for (i = 0; i < count; ++i) {
 		zend_ast *child = children[i];
-		zend_string *child_name = !is_list ? ast_kind_child_name(ast->kind, i) : NULL;
+		zend_string *child_name = !is_list ? ast_kind_child_name(ast_kind, i) : NULL;
 		zval child_zv;
 
-		if (ast->kind == ZEND_AST_STMT_LIST) {
+		if (ast_kind == ZEND_AST_STMT_LIST) {
 			if (child != NULL && child->kind == ZEND_AST_STMT_LIST) {
 				ast_fill_children_ht(ht, child, state);
 				continue;
@@ -596,7 +612,7 @@ static void ast_fill_children_ht(HashTable *ht, zend_ast *ast, ast_state_info_t
 
 		/* This AST_CATCH check should occur before ast_is_name() */
 #if PHP_VERSION_ID < 70100
-		if (ast->kind == ZEND_AST_CATCH && i == 0) {
+		if (ast_kind == ZEND_AST_CATCH && i == 0) {
 			/* Emulate PHP 7.1 format (name list) */
 			zval tmp;
 			ast_create_virtual_node(&tmp, AST_NAME, child->attr, child, state);
@@ -609,7 +625,7 @@ static void ast_fill_children_ht(HashTable *ht, zend_ast *ast, ast_state_info_t
 		} else if (child && child->kind == ZEND_AST_TYPE && (child->attr & ZEND_TYPE_NULLABLE)) {
 			child->attr &= ~ZEND_TYPE_NULLABLE;
 			ast_create_virtual_node(&child_zv, AST_NULLABLE_TYPE, 0, child, state);
-		} else if (ast->kind == ZEND_AST_CLOSURE_USES) {
+		} else if (ast_kind == ZEND_AST_CLOSURE_USES) {
 			ast_create_virtual_node(&child_zv, AST_CLOSURE_VAR, child->attr, child, state);
 		} else if (ast_is_var_name(child, ast, i)) {
 			ast_create_virtual_node(&child_zv, ZEND_AST_VAR, 0, child, state);
@@ -624,20 +640,20 @@ static void ast_fill_children_ht(HashTable *ht, zend_ast *ast, ast_state_info_t
 					&child_zv, ZEND_AST_STMT_LIST, 0, zend_ast_get_lineno(ast), state, 0);
 			}
 		} else if (state->version >= 60 && i == 1
-				&& (ast->kind == ZEND_AST_FUNC_DECL || ast->kind == ZEND_AST_METHOD)) {
+				&& (ast_kind == ZEND_AST_FUNC_DECL || ast_kind == ZEND_AST_METHOD)) {
 			/* Skip "uses" child, it is only relevant for closures */
 			continue;
 #if PHP_VERSION_ID >= 70400
-		} else if (i == 1 && ast->kind == ZEND_AST_ARROW_FUNC) {
+		} else if (i == 1 && ast_kind == ZEND_AST_ARROW_FUNC) {
 			/* Skip "uses" child since it is always empty */
 			continue;
 #endif
 #if PHP_VERSION_ID >= 70100
-		} else if (ast->kind == ZEND_AST_LIST && child != NULL) {
+		} else if (ast_kind == ZEND_AST_LIST && child != NULL) {
 			/* Emulate simple variable list */
 			ast_to_zval(&child_zv, child->child[0], state);
 #else
-		} else if (ast->kind == ZEND_AST_ARRAY
+		} else if (ast_kind == ZEND_AST_ARRAY
 				&& ast->attr == ZEND_ARRAY_SYNTAX_LIST && child != NULL) {
 			/* Emulate ARRAY_ELEM list */
 			zval ch0, ch1;
@@ -661,14 +677,14 @@ static void ast_fill_children_ht(HashTable *ht, zend_ast *ast, ast_state_info_t
 
 #if PHP_VERSION_ID < 70100
 	/* Emulate docComment on constants, which is not available in PHP 7.0 */
-	if (state->version >= 60 && ast->kind == ZEND_AST_CONST_ELEM) {
+	if (state->version >= 60 && ast_kind == ZEND_AST_CONST_ELEM) {
 		zval tmp;
 		ZVAL_NULL(&tmp);
 		zend_hash_add_new(ht, AST_STR(str_docComment), &tmp);
 	}
 #endif
 
-	if (ast_kind_is_decl(ast->kind)) {
+	if (ast_kind_is_decl(ast_kind)) {
 		zval id_zval;
 		ZVAL_LONG(&id_zval, state->declIdCounter);
 		state->declIdCounter++;

ast_data.c

@@ -18,6 +18,7 @@ const zend_ast_kind ast_kinds[] = {
 	ZEND_AST_NAME_LIST,
 	ZEND_AST_TRAIT_ADAPTATIONS,
 	ZEND_AST_USE,
+	ZEND_AST_TYPE_UNION,
 	AST_NAME,
 	AST_CLOSURE_VAR,
 	AST_NULLABLE_TYPE,
@@ -118,6 +119,7 @@ const char *ast_kind_to_name(zend_ast_kind kind) {
 		case ZEND_AST_NAME_LIST: return "AST_NAME_LIST";
 		case ZEND_AST_TRAIT_ADAPTATIONS: return "AST_TRAIT_ADAPTATIONS";
 		case ZEND_AST_USE: return "AST_USE";
+		case ZEND_AST_TYPE_UNION: return "AST_TYPE_UNION";
 		case AST_NAME: return "AST_NAME";
 		case AST_CLOSURE_VAR: return "AST_CLOSURE_VAR";
 		case AST_NULLABLE_TYPE: return "AST_NULLABLE_TYPE";
@@ -668,6 +670,7 @@ void ast_register_kind_constants(INIT_FUNC_ARGS) {
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_NAME_LIST", ZEND_AST_NAME_LIST, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_TRAIT_ADAPTATIONS", ZEND_AST_TRAIT_ADAPTATIONS, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_USE", ZEND_AST_USE, CONST_CS | CONST_PERSISTENT);
+	REGISTER_NS_LONG_CONSTANT("ast", "AST_TYPE_UNION", ZEND_AST_TYPE_UNION, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_NAME", AST_NAME, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_CLOSURE_VAR", AST_CLOSURE_VAR, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_NULLABLE_TYPE", AST_NULLABLE_TYPE, CONST_CS | CONST_PERSISTENT);

package.xml

@@ -23,6 +23,7 @@
  </stability>
  <license uri="https://github.com/nikic/php-ast/blob/master/LICENSE">BSD-3-Clause</license>
  <notes>
+- Add AST_TYPE_UNION to support PHP 8.0 Union Types.
 - TBD.
  </notes>
  <contents>

php_ast.h

@@ -57,6 +57,11 @@ extern ast_str_globals str_globals;
 # define ZEND_AST_ARROW_FUNC 0x5ff
 #endif
 
+#if PHP_VERSION_ID < 80000
+/* NOTE: For list nodes, the first set bit is 0x80 */
+# define ZEND_AST_TYPE_UNION ((1 << (ZEND_AST_IS_LIST_SHIFT + 1)) - 2)
+#endif
+
 /* Pretend it still exists */
 #if PHP_VERSION_ID >= 70100
 # define ZEND_AST_LIST ((1 << (ZEND_AST_IS_LIST_SHIFT + 1)) - 1)

scripts/generate_ast_data.php

@@ -161,6 +161,7 @@
 	'ZEND_AST_NAME_LIST',
 	'ZEND_AST_TRAIT_ADAPTATIONS',
 	'ZEND_AST_USE',
+	'ZEND_AST_TYPE_UNION',
 ];
 
 $data = [];

tests/metadata.phpt

@@ -41,6 +41,7 @@ AST_CLASS_CONST_DECL: (combinable) [MODIFIER_PUBLIC, MODIFIER_PROTECTED, MODIFIE
 AST_NAME_LIST: []
 AST_TRAIT_ADAPTATIONS: []
 AST_USE: [USE_NORMAL, USE_FUNCTION, USE_CONST]
+AST_TYPE_UNION: []
 AST_NAME: [NAME_FQ, NAME_NOT_FQ, NAME_RELATIVE]
 AST_CLOSURE_VAR: [CLOSURE_USE_REF]
 AST_NULLABLE_TYPE: []

tests/php80_union_types.phpt

@@ -0,0 +1,147 @@
+--TEST--
+Union types in PHP 8.0
+--SKIPIF--
+<?php if (PHP_VERSION_ID < 80000) die('skip PHP >= 8.0 only'); ?>
+--FILE--
+<?php
+
+require __DIR__ . '/../util.php';
+
+$code = <<<'PHP'
+<?php
+namespace NS;
+function test(OBJECT|array|float|int|String|null $a) : string|false {
+    return json_encode($a);
+}
+class Xyz {
+    public bool|stdClass $x;
+}
+function testClasses(iterable|\stdClass|Xyz $s) : namespace\Xyz|false|null {
+    return new X();
+}
+test([]);
+testClasses([2,3]);
+PHP;
+
+$node = ast\parse_code($code, $version=70);
+echo ast_dump($node), "\n";
+--EXPECTF--
+AST_STMT_LIST
+    0: AST_NAMESPACE
+        name: "NS"
+        stmts: null
+    1: AST_FUNC_DECL
+        flags: 0
+        name: "test"
+        docComment: null
+        params: AST_PARAM_LIST
+            0: AST_PARAM
+                flags: 0
+                type: AST_TYPE_UNION
+                    0: AST_TYPE
+                        flags: TYPE_OBJECT (%d)
+                    1: AST_TYPE
+                        flags: TYPE_ARRAY (%d)
+                    2: AST_TYPE
+                        flags: TYPE_DOUBLE (%d)
+                    3: AST_TYPE
+                        flags: TYPE_LONG (%d)
+                    4: AST_TYPE
+                        flags: TYPE_STRING (%d)
+                    5: AST_TYPE
+                        flags: TYPE_NULL (%d)
+                name: "a"
+                default: null
+        stmts: AST_STMT_LIST
+            0: AST_RETURN
+                expr: AST_CALL
+                    expr: AST_NAME
+                        flags: NAME_NOT_FQ (1)
+                        name: "json_encode"
+                    args: AST_ARG_LIST
+                        0: AST_VAR
+                            name: "a"
+        returnType: AST_TYPE_UNION
+            0: AST_TYPE
+                flags: TYPE_STRING (%d)
+            1: AST_TYPE
+                flags: 2
+        __declId: 0
+    2: AST_CLASS
+        flags: 0
+        name: "Xyz"
+        docComment: null
+        extends: null
+        implements: null
+        stmts: AST_STMT_LIST
+            0: AST_PROP_GROUP
+                flags: MODIFIER_PUBLIC (1)
+                type: AST_TYPE_UNION
+                    0: AST_TYPE
+                        flags: TYPE_BOOL (%d)
+                    1: AST_NAME
+                        flags: NAME_NOT_FQ (1)
+                        name: "stdClass"
+                props: AST_PROP_DECL
+                    flags: 0
+                    0: AST_PROP_ELEM
+                        name: "x"
+                        default: null
+                        docComment: null
+        __declId: 1
+    3: AST_FUNC_DECL
+        flags: 0
+        name: "testClasses"
+        docComment: null
+        params: AST_PARAM_LIST
+            0: AST_PARAM
+                flags: 0
+                type: AST_TYPE_UNION
+                    0: AST_TYPE
+                        flags: TYPE_ITERABLE (%d)
+                    1: AST_NAME
+                        flags: NAME_FQ (0)
+                        name: "stdClass"
+                    2: AST_NAME
+                        flags: NAME_NOT_FQ (1)
+                        name: "Xyz"
+                name: "s"
+                default: null
+        stmts: AST_STMT_LIST
+            0: AST_RETURN
+                expr: AST_NEW
+                    class: AST_NAME
+                        flags: NAME_NOT_FQ (1)
+                        name: "X"
+                    args: AST_ARG_LIST
+        returnType: AST_TYPE_UNION
+            0: AST_NAME
+                flags: NAME_RELATIVE (2)
+                name: "Xyz"
+            1: AST_TYPE
+                flags: 2
+            2: AST_TYPE
+                flags: TYPE_NULL (%d)
+        __declId: 2
+    4: AST_CALL
+        expr: AST_NAME
+            flags: NAME_NOT_FQ (1)
+            name: "test"
+        args: AST_ARG_LIST
+            0: AST_ARRAY
+                flags: ARRAY_SYNTAX_SHORT (3)
+    5: AST_CALL
+        expr: AST_NAME
+            flags: NAME_NOT_FQ (1)
+            name: "testClasses"
+        args: AST_ARG_LIST
+            0: AST_ARRAY
+                flags: ARRAY_SYNTAX_SHORT (3)
+                0: AST_ARRAY_ELEM
+                    flags: 0
+                    value: 2
+                    key: null
+                1: AST_ARRAY_ELEM
+                    flags: 0
+                    value: 3
+                    key: null