Support php 8.1 read-only properties, first-class callable syntax (#209)

Add php 8.1 readonly property support, first-class callables

And run all tests even after the first case fails

Mark ast version 90 as current and 85 as no longer experimental.

Add date to changelog, bump version in php_ast.h

Author: TysonAndre

.github/workflows/main.yml

@@ -22,6 +22,7 @@ jobs:
 
     # See https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#using-environment-variables-in-a-matrix
     strategy:
+      fail-fast: false
       matrix:
        include:
          # NOTE: If this is not quoted, the yaml parser will convert 7.0 to the number 7,

README.md

@@ -59,7 +59,7 @@ Basic usage
 
 Code can be parsed using either `ast\parse_code()`, which accepts a code string, or
 `ast\parse_file()`, which accepts a file path. Additionally, both functions require a `$version`
-argument to ensure forward-compatibility. The current version is 70.
+argument to ensure forward-compatibility. The current version is 90.
 
 ```php
 $ast = ast\parse_code('<?php ...', $version=70);
@@ -235,6 +235,7 @@ ast\flags\MODIFIER_PRIVATE
 ast\flags\MODIFIER_STATIC
 ast\flags\MODIFIER_ABSTRACT
 ast\flags\MODIFIER_FINAL
+ast\flags\MODIFIER_READONLY
 
 // Used by ast\AST_CLOSURE, ast\AST_ARROW_FUNC (combinable)
 ast\flags\MODIFIER_STATIC
@@ -374,6 +375,7 @@ AST_ATTRIBUTE:            class, args            // php 8.0+ attributes (version
 AST_BINARY_OP:            left, right
 AST_BREAK:                depth
 AST_CALL:                 expr, args
+AST_CALLABLE_CONVERT:                            // php 8.1+ first-class callable syntax
 AST_CAST:                 expr
 AST_CATCH:                class, var, stmts
 AST_CLASS:                name, docComment, extends, implements, stmts, (for enums) type
@@ -495,11 +497,19 @@ 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.
 
-### 85 (experimental)
+### 90 (current)
+
+Supported since 1.0.14 (2021-07-24)
+
+* Same as AST version 85.
+
+### 85 (stable)
+
+Supported since 1.0.11 (2021-04-20)
 
 * Add a `type` child node (for enum type) for all AST_CLASS nodes.
 
-### 80 (current)
+### 80 (stable)
 
 Supported since 1.0.10 (2020-09-12).
 

ast.c

@@ -51,7 +51,7 @@
 #define AST_CACHE_SLOT_LINENO   &AST_G(cache_slots)[3 * 2]
 #define AST_CACHE_SLOT_CHILDREN &AST_G(cache_slots)[3 * 3]
 
-#define AST_CURRENT_VERSION 80
+#define AST_CURRENT_VERSION 90
 
 /* Additional flags for BINARY_OP */
 #define AST_BINARY_IS_GREATER 256
@@ -267,7 +267,8 @@ static const char *closure_use_flags[] = {
 	AST_VISIBILITY_FLAGS, \
 	AST_FLAG(MODIFIER_STATIC), \
 	AST_FLAG(MODIFIER_ABSTRACT), \
-	AST_FLAG(MODIFIER_FINAL)
+	AST_FLAG(MODIFIER_FINAL), \
+	AST_FLAG(MODIFIER_READONLY)
 
 static const char *visibility_flags[] = {
 	AST_VISIBILITY_FLAGS,
@@ -1075,7 +1076,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, 80, 85};
+static const zend_long versions[] = {50, 60, 70, 80, 85, 90};
 static const size_t versions_count = sizeof(versions)/sizeof(versions[0]);
 
 static inline zend_bool ast_version_deprecated(zend_long version) {
@@ -1408,6 +1409,7 @@ PHP_MINIT_FUNCTION(ast) {
 	ast_register_flag_constant("MODIFIER_STATIC", ZEND_ACC_STATIC);
 	ast_register_flag_constant("MODIFIER_ABSTRACT", ZEND_ACC_ABSTRACT);
 	ast_register_flag_constant("MODIFIER_FINAL", ZEND_ACC_FINAL);
+	ast_register_flag_constant("MODIFIER_READONLY", ZEND_ACC_READONLY);
 
 	ast_register_flag_constant("PARAM_MODIFIER_PUBLIC", PARAM_MODIFIER_PUBLIC);
 	ast_register_flag_constant("PARAM_MODIFIER_PROTECTED", PARAM_MODIFIER_PROTECTED);

ast_data.c

@@ -33,6 +33,7 @@ const zend_ast_kind ast_kinds[] = {
 	ZEND_AST_CLASS,
 	ZEND_AST_MAGIC_CONST,
 	ZEND_AST_TYPE,
+	ZEND_AST_CALLABLE_CONVERT,
 	ZEND_AST_VAR,
 	ZEND_AST_CONST,
 	ZEND_AST_UNPACK,
@@ -146,6 +147,7 @@ const char *ast_kind_to_name(zend_ast_kind kind) {
 		case ZEND_AST_CLASS: return "AST_CLASS";
 		case ZEND_AST_MAGIC_CONST: return "AST_MAGIC_CONST";
 		case ZEND_AST_TYPE: return "AST_TYPE";
+		case ZEND_AST_CALLABLE_CONVERT: return "AST_CALLABLE_CONVERT";
 		case ZEND_AST_VAR: return "AST_VAR";
 		case ZEND_AST_CONST: return "AST_CONST";
 		case ZEND_AST_UNPACK: return "AST_UNPACK";
@@ -265,6 +267,7 @@ zend_string *ast_kind_child_name(zend_ast_kind kind, uint32_t child) {
 			return NULL;
 		case ZEND_AST_MAGIC_CONST:
 		case ZEND_AST_TYPE:
+		case ZEND_AST_CALLABLE_CONVERT:
 			return NULL;
 		case ZEND_AST_UNPACK:
 		case ZEND_AST_CAST:
@@ -597,6 +600,7 @@ void ast_register_kind_constants(INIT_FUNC_ARGS) {
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_CLASS", ZEND_AST_CLASS, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_MAGIC_CONST", ZEND_AST_MAGIC_CONST, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_TYPE", ZEND_AST_TYPE, CONST_CS | CONST_PERSISTENT);
+	REGISTER_NS_LONG_CONSTANT("ast", "AST_CALLABLE_CONVERT", ZEND_AST_CALLABLE_CONVERT, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_VAR", ZEND_AST_VAR, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_CONST", ZEND_AST_CONST, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_UNPACK", ZEND_AST_UNPACK, CONST_CS | CONST_PERSISTENT);

ast_stub.php

@@ -39,6 +39,7 @@
 const AST_CLASS = 70;
 const AST_MAGIC_CONST = 0;
 const AST_TYPE = 1;
+const AST_CALLABLE_CONVERT = 3;
 const AST_VAR = 256;
 const AST_CONST = 257;
 const AST_UNPACK = 258;
@@ -127,6 +128,7 @@
 const MODIFIER_STATIC = 16;
 const MODIFIER_ABSTRACT = 64;
 const MODIFIER_FINAL = 32;
+const MODIFIER_READONLY = 128;
 const PARAM_MODIFIER_PUBLIC = 1;
 const PARAM_MODIFIER_PROTECTED = 2;
 const PARAM_MODIFIER_PRIVATE = 4;

package.xml

@@ -18,20 +18,20 @@
   <email>[email protected]</email>
   <active>yes</active>
  </lead>
- <date>2021-07-08</date>
+ <date>2021-07-24</date>
  <version>
-  <release>1.0.13</release>
-  <api>1.0.13</api>
+  <release>1.0.14</release>
+  <api>1.0.14</api>
  </version>
  <stability>
   <release>stable</release>
   <api>stable</api>
  </stability>
  <license uri="https://github.com/nikic/php-ast/blob/master/LICENSE">BSD-3-Clause</license>
  <notes>
-- Indicate in metadata that 'AST_CLASS_CONST_GROUP' and 'AST_CLASS_CONST_DECL' can have MODIFIER_FINAL
-  (and any modifier a class element can have, to reflect what the parser can actually parse)
-- Support php 8.1 intersection types, add node kind 'AST_TYPE_INTERSECTION'
+- Support php 8.1 readonly properties with the flag 'MODIFIER_READONLY'
+- Support php 8.1 first-class callable syntax, add the node kind 'AST_CALLABLE_CONVERT'
+- Change the current AST version from 80 to the new version 90. AST version 85 is no longer experimental.
  </notes>
  <contents>
   <dir name="/">
@@ -113,8 +113,10 @@
       <file name="php80_union_types_nullable.phpt" role="test" />
       <file name="php80_union_types.phpt" role="test" />
       <file name="php81_enums.phpt" role="test" />
+      <file name="php81_first_class_callable_support.phpt" role="test" />
       <file name="php81_final_class_const.phpt" role="test" />
       <file name="php81_intersection_types.phpt" role="test" />
+      <file name="php81_readonly.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" />
@@ -142,6 +144,23 @@
  <providesextension>ast</providesextension>
  <extsrcrelease />
  <changelog>
+  <release>
+   <date>2021-07-08</date>
+   <version>
+    <release>1.0.13</release>
+    <api>1.0.13</api>
+   </version>
+   <stability>
+    <release>stable</release>
+    <api>stable</api>
+   </stability>
+   <license uri="https://github.com/nikic/php-ast/blob/master/LICENSE">BSD-3-Clause</license>
+   <notes>
+  - Indicate in metadata that 'AST_CLASS_CONST_GROUP' and 'AST_CLASS_CONST_DECL' can have 'MODIFIER_FINAL'
+    (and any modifier a class element can have, to reflect what the parser can actually parse)
+  - Support php 8.1 intersection types, add the node kind 'AST_TYPE_INTERSECTION'
+   </notes>
+  </release>
   <release>
    <date>2021-05-16</date>
    <version>
@@ -154,7 +173,7 @@
    </stability>
    <license uri="https://github.com/nikic/php-ast/blob/master/LICENSE">BSD-3-Clause</license>
    <notes>
-- Support parsing 'docComment' on php 8.1 enums
+- Support parsing 'docComment' on php 8.1 enum cases
 - Indicate in metadata that 'AST_CLASS_CONST_GROUP' and 'AST_CLASS_CONST_DECL' can have MODIFIER_FINAL
    </notes>
   </release>

php_ast.h

@@ -7,7 +7,7 @@
 extern zend_module_entry ast_module_entry;
 #define phpext_ast_ptr &ast_module_entry
 
-#define PHP_AST_VERSION "1.0.13"
+#define PHP_AST_VERSION "1.0.14"
 
 #ifdef PHP_WIN32
 #	define PHP_AST_API __declspec(dllexport)
@@ -77,6 +77,10 @@ extern ast_str_globals str_globals;
 
 #if PHP_VERSION_ID < 80100
 # define ZEND_ACC_ENUM (1 << 22)
+# define ZEND_ACC_READONLY (1 << 7)
+
+/* 0 child nodes */
+# define ZEND_AST_CALLABLE_CONVERT 3
 /* 3 child nodes - name, expr, attributes */
 # define ZEND_AST_ENUM_CASE 0x3fe
 # define ZEND_AST_TYPE_INTERSECTION ((1 << (ZEND_AST_IS_LIST_SHIFT + 1)) - 6)

scripts/generate_ast_data.php

@@ -63,6 +63,7 @@
     /* 0 child nodes */
     'ZEND_AST_MAGIC_CONST' => [],
     'ZEND_AST_TYPE' => [],
+    'ZEND_AST_CALLABLE_CONVERT' => [],
 
     /* 1 child node */
     'ZEND_AST_VAR' => ['name'],

tests/get_supported_versions.phpt

@@ -8,7 +8,7 @@ var_dump(ast\get_supported_versions(true));
 
 ?>
 --EXPECT--
-array(5) {
+array(6) {
   [0]=>
   int(50)
   [1]=>
@@ -19,8 +19,10 @@ array(5) {
   int(80)
   [4]=>
   int(85)
+  [5]=>
+  int(90)
 }
-array(5) {
+array(6) {
   [0]=>
   int(50)
   [1]=>
@@ -31,4 +33,6 @@ array(5) {
   int(80)
   [4]=>
   int(85)
+  [5]=>
+  int(90)
 }

tests/metadata.phpt

@@ -37,9 +37,9 @@ AST_SWITCH_LIST: []
 AST_CATCH_LIST: []
 AST_PARAM_LIST: []
 AST_CLOSURE_USES: []
-AST_PROP_DECL: (combinable) [MODIFIER_PUBLIC, MODIFIER_PROTECTED, MODIFIER_PRIVATE, MODIFIER_STATIC, MODIFIER_ABSTRACT, MODIFIER_FINAL]
+AST_PROP_DECL: (combinable) [MODIFIER_PUBLIC, MODIFIER_PROTECTED, MODIFIER_PRIVATE, MODIFIER_STATIC, MODIFIER_ABSTRACT, MODIFIER_FINAL, MODIFIER_READONLY]
 AST_CONST_DECL: []
-AST_CLASS_CONST_DECL: (combinable) [MODIFIER_PUBLIC, MODIFIER_PROTECTED, MODIFIER_PRIVATE, MODIFIER_STATIC, MODIFIER_ABSTRACT, MODIFIER_FINAL]
+AST_CLASS_CONST_DECL: (combinable) [MODIFIER_PUBLIC, MODIFIER_PROTECTED, MODIFIER_PRIVATE, MODIFIER_STATIC, MODIFIER_ABSTRACT, MODIFIER_FINAL, MODIFIER_READONLY]
 AST_NAME_LIST: []
 AST_TRAIT_ADAPTATIONS: []
 AST_USE: [USE_NORMAL, USE_FUNCTION, USE_CONST]
@@ -51,13 +51,14 @@ AST_MATCH_ARM_LIST: []
 AST_NAME: [NAME_FQ, NAME_NOT_FQ, NAME_RELATIVE]
 AST_CLOSURE_VAR: [CLOSURE_USE_REF]
 AST_NULLABLE_TYPE: []
-AST_FUNC_DECL: (combinable) [MODIFIER_PUBLIC, MODIFIER_PROTECTED, MODIFIER_PRIVATE, MODIFIER_STATIC, MODIFIER_ABSTRACT, MODIFIER_FINAL, FUNC_RETURNS_REF, FUNC_GENERATOR]
-AST_CLOSURE: (combinable) [MODIFIER_PUBLIC, MODIFIER_PROTECTED, MODIFIER_PRIVATE, MODIFIER_STATIC, MODIFIER_ABSTRACT, MODIFIER_FINAL, FUNC_RETURNS_REF, FUNC_GENERATOR]
-AST_METHOD: (combinable) [MODIFIER_PUBLIC, MODIFIER_PROTECTED, MODIFIER_PRIVATE, MODIFIER_STATIC, MODIFIER_ABSTRACT, MODIFIER_FINAL, FUNC_RETURNS_REF, FUNC_GENERATOR]
-AST_ARROW_FUNC: (combinable) [MODIFIER_PUBLIC, MODIFIER_PROTECTED, MODIFIER_PRIVATE, MODIFIER_STATIC, MODIFIER_ABSTRACT, MODIFIER_FINAL, FUNC_RETURNS_REF, FUNC_GENERATOR]
+AST_FUNC_DECL: (combinable) [MODIFIER_PUBLIC, MODIFIER_PROTECTED, MODIFIER_PRIVATE, MODIFIER_STATIC, MODIFIER_ABSTRACT, MODIFIER_FINAL, MODIFIER_READONLY, FUNC_RETURNS_REF, FUNC_GENERATOR]
+AST_CLOSURE: (combinable) [MODIFIER_PUBLIC, MODIFIER_PROTECTED, MODIFIER_PRIVATE, MODIFIER_STATIC, MODIFIER_ABSTRACT, MODIFIER_FINAL, MODIFIER_READONLY, FUNC_RETURNS_REF, FUNC_GENERATOR]
+AST_METHOD: (combinable) [MODIFIER_PUBLIC, MODIFIER_PROTECTED, MODIFIER_PRIVATE, MODIFIER_STATIC, MODIFIER_ABSTRACT, MODIFIER_FINAL, MODIFIER_READONLY, FUNC_RETURNS_REF, FUNC_GENERATOR]
+AST_ARROW_FUNC: (combinable) [MODIFIER_PUBLIC, MODIFIER_PROTECTED, MODIFIER_PRIVATE, MODIFIER_STATIC, MODIFIER_ABSTRACT, MODIFIER_FINAL, MODIFIER_READONLY, FUNC_RETURNS_REF, FUNC_GENERATOR]
 AST_CLASS: (combinable) [CLASS_ABSTRACT, CLASS_FINAL, CLASS_TRAIT, CLASS_INTERFACE, CLASS_ANONYMOUS, CLASS_ENUM]
 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, TYPE_MIXED, TYPE_NEVER]
+AST_CALLABLE_CONVERT: []
 AST_VAR: []
 AST_CONST: []
 AST_UNPACK: []
@@ -87,7 +88,7 @@ AST_GOTO: []
 AST_BREAK: []
 AST_CONTINUE: []
 AST_CLASS_NAME: []
-AST_CLASS_CONST_GROUP: (combinable) [MODIFIER_PUBLIC, MODIFIER_PROTECTED, MODIFIER_PRIVATE, MODIFIER_STATIC, MODIFIER_ABSTRACT, MODIFIER_FINAL]
+AST_CLASS_CONST_GROUP: (combinable) [MODIFIER_PUBLIC, MODIFIER_PROTECTED, MODIFIER_PRIVATE, MODIFIER_STATIC, MODIFIER_ABSTRACT, MODIFIER_FINAL, MODIFIER_READONLY]
 AST_DIM: (combinable) [DIM_ALTERNATIVE_SYNTAX]
 AST_PROP: []
 AST_NULLSAFE_PROP: []
@@ -110,14 +111,14 @@ AST_SWITCH: []
 AST_SWITCH_CASE: []
 AST_DECLARE: []
 AST_PROP_ELEM: []
-AST_PROP_GROUP: (combinable) [MODIFIER_PUBLIC, MODIFIER_PROTECTED, MODIFIER_PRIVATE, MODIFIER_STATIC, MODIFIER_ABSTRACT, MODIFIER_FINAL]
+AST_PROP_GROUP: (combinable) [MODIFIER_PUBLIC, MODIFIER_PROTECTED, MODIFIER_PRIVATE, MODIFIER_STATIC, MODIFIER_ABSTRACT, MODIFIER_FINAL, MODIFIER_READONLY]
 AST_CONST_ELEM: []
 AST_USE_TRAIT: []
 AST_TRAIT_PRECEDENCE: []
 AST_METHOD_REFERENCE: []
 AST_NAMESPACE: []
 AST_USE_ELEM: [USE_NORMAL, USE_FUNCTION, USE_CONST]
-AST_TRAIT_ALIAS: (combinable) [MODIFIER_PUBLIC, MODIFIER_PROTECTED, MODIFIER_PRIVATE, MODIFIER_STATIC, MODIFIER_ABSTRACT, MODIFIER_FINAL]
+AST_TRAIT_ALIAS: (combinable) [MODIFIER_PUBLIC, MODIFIER_PROTECTED, MODIFIER_PRIVATE, MODIFIER_STATIC, MODIFIER_ABSTRACT, MODIFIER_FINAL, MODIFIER_READONLY]
 AST_GROUP_USE: [USE_NORMAL, USE_FUNCTION, USE_CONST]
 AST_ATTRIBUTE: []
 AST_MATCH: []