Support parsing php 8.0 TYPE_STATIC, add test of $x::class (nikic#150)

Test ::class on objects

Support parsing php 8.0 TYPE_STATIC

Fixes nikic#149

Author: TysonAndre

README.md

@@ -267,8 +267,9 @@ ast\flags\TYPE_DOUBLE
 ast\flags\TYPE_STRING
 ast\flags\TYPE_ITERABLE
 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_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
 
 // Used by ast\AST_CAST (exclusive)
 ast\flags\TYPE_NULL

ast.c

@@ -61,6 +61,11 @@
 # define ZEND_PARENTHESIZED_CONDITIONAL 1
 #endif
 
+/* Make IS_STATIC follow IS_ITERABLE in php 7.0 */
+#if PHP_VERSION_ID < 80000
+# define IS_STATIC 20
+#endif
+
 /* This contains state of the ast Node creator. */
 typedef struct ast_state_info {
 	zend_long version;
@@ -116,6 +121,7 @@ static const char *type_flags[] = {
 	AST_FLAG(TYPE_CALLABLE),
 	AST_FLAG(TYPE_VOID),
 	AST_FLAG(TYPE_ITERABLE),
+	AST_FLAG(TYPE_STATIC),
 	NULL
 };
 
@@ -1284,6 +1290,7 @@ PHP_MINIT_FUNCTION(ast) {
 	ast_register_flag_constant("TYPE_CALLABLE", IS_CALLABLE);
 	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("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 = 18;
+const TYPE_BOOL = 16;
 const TYPE_LONG = 4;
 const TYPE_DOUBLE = 5;
 const TYPE_STRING = 6;
@@ -138,6 +138,7 @@
 const TYPE_CALLABLE = 12;
 const TYPE_VOID = 14;
 const TYPE_ITERABLE = 13;
+const TYPE_STATIC = 15;
 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>
-- TBD
+- Support TYPE_STATIC for the php 8.0 static return type.
  </notes>
  <contents>
   <dir name="/">
@@ -53,6 +53,7 @@
       <file name="binary_ops.phpt" role="test" />
       <file name="by_ref_destructuring.phpt" role="test" />
       <file name="class_consts.phpt" role="test" />
+      <file name="class_on_objects.phpt" role="test" />
       <file name="class_name_version_50.phpt" role="test" />
       <file name="class_name_version_70.phpt" role="test" />
       <file name="class.phpt" role="test" />
@@ -93,6 +94,7 @@
       <file name="php74_type_hints.phpt" role="test" />
       <file name="php80_union_types.phpt" role="test" />
       <file name="php80_union_types_nullable.phpt" role="test" />
+      <file name="php80_static_type.phpt" role="test" />
       <file name="prop_doc_comments.phpt" role="test" />
       <file name="short_arrow_function.phpt" role="test" />
       <file name="short_arrow_function_return.phpt" role="test" />

tests/class_on_objects.phpt

@@ -0,0 +1,20 @@
+--TEST--
+$x::class in PHP 8.0
+--FILE--
+<?php
+
+require __DIR__ . '/../util.php';
+
+$code = <<<'PHP'
+<?php
+echo $x::class;
+PHP;
+
+$node = ast\parse_code($code, $version=70);
+echo ast_dump($node), "\n";
+--EXPECTF--
+AST_STMT_LIST
+    0: AST_ECHO
+        expr: AST_CLASS_NAME
+            class: AST_VAR
+                name: "x"

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]
+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_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]
+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_EMPTY: []
 AST_ISSET: []
 AST_SHELL_EXEC: []

tests/parse_file_not_existing.phpt

@@ -11,7 +11,7 @@ try {
 
 ?>
 --EXPECTF--
-RuntimeException: ast\parse_file(%stests/non_existing_file.php): failed to open stream: No such file or directory in %s:%d
+RuntimeException: ast\parse_file(%stests/non_existing_file.php): %sailed to open stream: No such file or directory in %s:%d
 Stack trace:
 #0 %s(%d): ast\parse_file('%s', %d)
 #1 {main}

tests/php80_static_type.phpt

@@ -0,0 +1,63 @@
+--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
+class Xyz {
+    public function test() : static {
+        return $this;
+    }
+    public function test2() : static|false|OtherClass {
+        return $this;
+    }
+}
+PHP;
+
+$node = ast\parse_code($code, $version=70);
+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 (1)
+                name: "test"
+                docComment: null
+                params: AST_PARAM_LIST
+                stmts: AST_STMT_LIST
+                    0: AST_RETURN
+                        expr: AST_VAR
+                            name: "this"
+                returnType: AST_TYPE
+                    flags: TYPE_STATIC (%d)
+                __declId: 0
+            1: AST_METHOD
+                flags: MODIFIER_PUBLIC (1)
+                name: "test2"
+                docComment: null
+                params: AST_PARAM_LIST
+                stmts: AST_STMT_LIST
+                    0: AST_RETURN
+                        expr: AST_VAR
+                            name: "this"
+                returnType: AST_TYPE_UNION
+                    0: AST_TYPE
+                        flags: TYPE_STATIC (%d)
+                    1: AST_TYPE
+                        flags: TYPE_FALSE (%d)
+                    2: AST_NAME
+                        flags: NAME_NOT_FQ (%d)
+                        name: "OtherClass"
+                __declId: 1
+        __declId: 2