Support php 8.0's mixed type (nikic#156)

Fixes nikic#154

- We've preferred AST versions that are multiples of 10 for previous releases.

Author: TysonAndre

README.md

@@ -270,6 +270,7 @@ ast\flags\TYPE_OBJECT
 ast\flags\TYPE_NULL    // php 8.0 union types
 ast\flags\TYPE_FALSE   // php 8.0 union types
 ast\flags\TYPE_STATIC  // php 8.0 static return type
+ast\flags\TYPE_MIXED   // php 8.0 mixed type
 
 // Used by ast\AST_CAST (exclusive)
 ast\flags\TYPE_NULL
@@ -477,6 +478,12 @@ function accepts a boolean argument that determines whether deprecated versions
 In the following the changes in the respective AST versions, as well as their current support state,
 are listed.
 
+### 80 (experimental)
+
+Available since 1.0.7 (XXX).
+
+* `mixed` type hints are now reported as an `AST_TYPE` with type `TYPE_MIXED` instead of an `AST_NAME`.
+
 ### 70 (current)
 
 Supported since 1.0.1 (2019-02-11).

ast.c

@@ -64,6 +64,7 @@
 /* Make IS_STATIC follow IS_ITERABLE in php 7.0 */
 #if PHP_VERSION_ID < 80000
 # define IS_STATIC 20
+# define IS_MIXED 21
 #endif
 
 /* This contains state of the ast Node creator. */
@@ -122,6 +123,7 @@ static const char *type_flags[] = {
 	AST_FLAG(TYPE_VOID),
 	AST_FLAG(TYPE_ITERABLE),
 	AST_FLAG(TYPE_STATIC),
+	AST_FLAG(TYPE_MIXED),
 	NULL
 };
 
@@ -466,6 +468,8 @@ static const builtin_type_info builtin_types[] = {
 	{ZEND_STRL("object"), IS_OBJECT},
 	{ZEND_STRL("null"), IS_NULL},  /* Null and false for php 8.0 union types */
 	{ZEND_STRL("false"), IS_FALSE},
+	// {ZEND_STRL("static"), IS_STATIC},  /* Impossible to be parsed before php 8 */
+	{ZEND_STRL("mixed"), IS_MIXED},
 	{NULL, 0, IS_UNDEF}
 };
 static inline zend_uchar lookup_builtin_type(const zend_string *name) {
@@ -580,6 +584,7 @@ static inline void ast_name_to_zval(zend_ast *child, zend_ast *ast, zval *child_
 	if (child->attr == ZEND_NAME_NOT_FQ
 			&& ast_is_type(child, ast, i)
 			&& (type = lookup_builtin_type(zend_ast_get_str(child)))
+			&& (type != IS_MIXED || state->version >= 80)
 	) {
 		/* Convert "int" etc typehints to TYPE nodes */
 		ast_create_virtual_node_ex(
@@ -881,7 +886,7 @@ static void ast_to_zval(zval *zv, zend_ast *ast, ast_state_info_t *state) {
 #endif
 }
 
-static const zend_long versions[] = {50, 60, 70};
+static const zend_long versions[] = {50, 60, 70, 80};
 static const size_t versions_count = sizeof(versions)/sizeof(versions[0]);
 
 static inline zend_bool ast_version_deprecated(zend_long version) {
@@ -1291,6 +1296,7 @@ PHP_MINIT_FUNCTION(ast) {
 	ast_register_flag_constant("TYPE_VOID", IS_VOID);
 	ast_register_flag_constant("TYPE_ITERABLE", IS_ITERABLE);
 	ast_register_flag_constant("TYPE_STATIC", IS_STATIC);
+	ast_register_flag_constant("TYPE_MIXED", IS_MIXED);
 
 	ast_register_flag_constant("UNARY_BOOL_NOT", ZEND_BOOL_NOT);
 	ast_register_flag_constant("UNARY_BITWISE_NOT", ZEND_BW_NOT);

ast_stub.php

@@ -129,7 +129,7 @@
 const PARAM_VARIADIC = 2;
 const TYPE_NULL = 1;
 const TYPE_FALSE = 2;
-const TYPE_BOOL = 16;
+const TYPE_BOOL = 17;
 const TYPE_LONG = 4;
 const TYPE_DOUBLE = 5;
 const TYPE_STRING = 6;
@@ -139,6 +139,7 @@
 const TYPE_VOID = 14;
 const TYPE_ITERABLE = 13;
 const TYPE_STATIC = 15;
+const TYPE_MIXED = 16;
 const UNARY_BOOL_NOT = 14;
 const UNARY_BITWISE_NOT = 13;
 const UNARY_SILENCE = 260;

package.xml

@@ -29,7 +29,7 @@
  </stability>
  <license uri="https://github.com/nikic/php-ast/blob/master/LICENSE">BSD-3-Clause</license>
  <notes>
-- Support TYPE_STATIC for the php 8.0 static return type.
+- Add the experimental version 80, which returns `mixed` types as an `AST_TYPE` with type `TYPE_MIXED` instead of an `AST_NAME`.
  </notes>
  <contents>
   <dir name="/">

tests/get_supported_versions.phpt

@@ -8,19 +8,23 @@ var_dump(ast\get_supported_versions(true));
 
 ?>
 --EXPECT--
-array(3) {
+array(4) {
   [0]=>
   int(50)
   [1]=>
   int(60)
   [2]=>
   int(70)
+  [3]=>
+  int(80)
 }
-array(3) {
+array(4) {
   [0]=>
   int(50)
   [1]=>
   int(60)
   [2]=>
   int(70)
+  [3]=>
+  int(80)
 }

tests/metadata.phpt

@@ -51,11 +51,11 @@ AST_METHOD: (combinable) [MODIFIER_PUBLIC, MODIFIER_PROTECTED, MODIFIER_PRIVATE,
 AST_ARROW_FUNC: (combinable) [MODIFIER_PUBLIC, MODIFIER_PROTECTED, MODIFIER_PRIVATE, MODIFIER_STATIC, MODIFIER_ABSTRACT, MODIFIER_FINAL, FUNC_RETURNS_REF, FUNC_GENERATOR]
 AST_CLASS: [CLASS_ABSTRACT, CLASS_FINAL, CLASS_TRAIT, CLASS_INTERFACE, CLASS_ANONYMOUS]
 AST_MAGIC_CONST: [MAGIC_LINE, MAGIC_FILE, MAGIC_DIR, MAGIC_NAMESPACE, MAGIC_FUNCTION, MAGIC_METHOD, MAGIC_CLASS, MAGIC_TRAIT]
-AST_TYPE: [TYPE_NULL, TYPE_FALSE, TYPE_BOOL, TYPE_LONG, TYPE_DOUBLE, TYPE_STRING, TYPE_ARRAY, TYPE_OBJECT, TYPE_CALLABLE, TYPE_VOID, TYPE_ITERABLE, TYPE_STATIC]
+AST_TYPE: [TYPE_NULL, TYPE_FALSE, TYPE_BOOL, TYPE_LONG, TYPE_DOUBLE, TYPE_STRING, TYPE_ARRAY, TYPE_OBJECT, TYPE_CALLABLE, TYPE_VOID, TYPE_ITERABLE, TYPE_STATIC, TYPE_MIXED]
 AST_VAR: []
 AST_CONST: []
 AST_UNPACK: []
-AST_CAST: [TYPE_NULL, TYPE_FALSE, TYPE_BOOL, TYPE_LONG, TYPE_DOUBLE, TYPE_STRING, TYPE_ARRAY, TYPE_OBJECT, TYPE_CALLABLE, TYPE_VOID, TYPE_ITERABLE, TYPE_STATIC]
+AST_CAST: [TYPE_NULL, TYPE_FALSE, TYPE_BOOL, TYPE_LONG, TYPE_DOUBLE, TYPE_STRING, TYPE_ARRAY, TYPE_OBJECT, TYPE_CALLABLE, TYPE_VOID, TYPE_ITERABLE, TYPE_STATIC, TYPE_MIXED]
 AST_EMPTY: []
 AST_ISSET: []
 AST_SHELL_EXEC: []

tests/mixed_type.phpt

@@ -0,0 +1,77 @@
+--TEST--
+Mixed types in PHP 8.0
+--FILE--
+<?php
+
+require __DIR__ . '/../util.php';
+
+$code = <<<'PHP'
+<?php
+class Xyz {
+    public function test(mixed $x) : mixed {
+        return $this;
+    }
+}
+PHP;
+
+$node = ast\parse_code($code, $version=70);
+echo ast_dump($node), "\n";
+$node = ast\parse_code($code, $version=80);
+echo ast_dump($node), "\n";
+--EXPECTF--
+AST_STMT_LIST
+    0: AST_CLASS
+        flags: 0
+        name: "Xyz"
+        docComment: null
+        extends: null
+        implements: null
+        stmts: AST_STMT_LIST
+            0: AST_METHOD
+                flags: MODIFIER_PUBLIC (%d)
+                name: "test"
+                docComment: null
+                params: AST_PARAM_LIST
+                    0: AST_PARAM
+                        flags: 0
+                        type: AST_NAME
+                            flags: NAME_NOT_FQ (1)
+                            name: "mixed"
+                        name: "x"
+                        default: null
+                stmts: AST_STMT_LIST
+                    0: AST_RETURN
+                        expr: AST_VAR
+                            name: "this"
+                returnType: AST_NAME
+                    flags: NAME_NOT_FQ (1)
+                    name: "mixed"
+                __declId: 0
+        __declId: 1
+AST_STMT_LIST
+    0: AST_CLASS
+        flags: 0
+        name: "Xyz"
+        docComment: null
+        extends: null
+        implements: null
+        stmts: AST_STMT_LIST
+            0: AST_METHOD
+                flags: MODIFIER_PUBLIC (%d)
+                name: "test"
+                docComment: null
+                params: AST_PARAM_LIST
+                    0: AST_PARAM
+                        flags: 0
+                        type: AST_TYPE
+                            flags: TYPE_MIXED (%d)
+                        name: "x"
+                        default: null
+                stmts: AST_STMT_LIST
+                    0: AST_RETURN
+                        expr: AST_VAR
+                            name: "this"
+                returnType: AST_TYPE
+                    flags: TYPE_MIXED (%d)
+                __declId: 0
+        __declId: 1