php-ast 1.1.0dev: Deprecate AST versions 50 and 60, drop support for php < 7.2 (#185)

* Deprecate AST versions 50 and 60

AST version 70 has been supported since php-ast 1.0.1 (2019-02-11).

Related to #114

* Drop support for php <= 7.1

Update documentation to mention this.

* Update test expectation for AST version 60 deprecation

Author: TysonAndre

.appveyor.yml

@@ -69,46 +69,6 @@ environment:
                   VC: vs16
                   PHP_VER: 8.0.13
                   TS: 0
-                - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2015
-                  ARCH: x64
-                  VC: vc14
-                  PHP_VER: 7.0.33
-                  TS: 0
-                - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2015
-                  ARCH: x64
-                  VC: vc14
-                  PHP_VER: 7.0.33
-                  TS: 1
-                - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2015
-                  ARCH: x86
-                  VC: vc14
-                  PHP_VER: 7.0.33
-                  TS: 0
-                - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2015
-                  ARCH: x86
-                  VC: vc14
-                  PHP_VER: 7.0.33
-                  TS: 1
-                - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2015
-                  ARCH: x64
-                  VC: vc14
-                  PHP_VER: 7.1.33
-                  TS: 0
-                - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2015
-                  ARCH: x64
-                  VC: vc14
-                  PHP_VER: 7.1.33
-                  TS: 1
-                - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2015
-                  ARCH: x86
-                  VC: vc14
-                  PHP_VER: 7.1.33
-                  TS: 0
-                - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2015
-                  ARCH: x86
-                  VC: vc14
-                  PHP_VER: 7.1.33
-                  TS: 1
                 - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2017
                   ARCH: x64
                   VC: vc15

.github/workflows/main.yml

@@ -25,10 +25,8 @@ jobs:
       fail-fast: false
       matrix:
        include:
-         # NOTE: If this is not quoted, the yaml parser will convert 7.0 to the number 7,
-         # and the docker image `php:7` is the latest minor version of php 7.x (7.4).
-         - PHP_VERSION: '7.0'
-         - PHP_VERSION: '7.1'
+         # NOTE: If this is not quoted, the yaml parser will convert 8.0 to the number 8,
+         # and the docker image `php:8` is the latest minor version of php 8.x (8.1).
          - PHP_VERSION: '7.2'
          - PHP_VERSION: '7.3'
          - PHP_VERSION: '7.4'

README.md

@@ -1,9 +1,9 @@
 php-ast
 =======
 
-This extension exposes the abstract syntax tree generated by PHP 7.
+This extension exposes the abstract syntax tree generated by PHP 7 and 8.
 
-**This is the documentation for version 1.0.x. See also [documentation for version 0.1.x][v0_1_x].**
+**This is the documentation for version 1.x.y. See also [documentation for version 0.1.x][v0_1_x].**
 
 Table of Contents
 -----------------
@@ -529,18 +529,20 @@ Supported since 1.0.1 (2019-02-11).
   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 (stable)
+### 60 (deprecated)
 
 Supported since 0.1.7 (2018-10-06).
+Deprecated in php-ast 1.1.0.
 
 * `AST_FUNC_DECL` and `AST_METHOD` no longer generate a `uses` child. Previously this child was
   always `null`.
 * `AST_CONST_ELEM` now always has a `docComment` child. Previously it was absent on PHP 7.0.
   On PHP 7.0 the value is always `null`.
 
-### 50 (stable)
+### 50 (deprecated)
 
 Supported since 0.1.5 (2017-07-19).
+Deprecated in php-ast 1.1.0.
 
 This is the oldest AST version available in 1.0.0. See the
 [0.1.x AST version changelog][v0_1_x_versions] for information on changes prior to this version.
@@ -553,19 +555,19 @@ this extension. This section summarizes the main differences between php-ast and
 may decide which is preferable for your use-case.
 
 The primary difference is that php-ast is a PHP extension (written in C) which exports the AST
-internally used by PHP 7. PHP-Parser on the other hand is library written in PHP. This has a number
+internally used by PHP 7 and 8. PHP-Parser on the other hand is library written in PHP. This has a number
 of consequences:
 
  * php-ast is significantly faster than PHP-Parser, because the AST construction is implemented in
    C.
  * php-ast needs to be installed as an extension, on Linux either by compiling it manually or
    retrieving it from a package manager, on Windows by loading a DLL. PHP-Parser is installed as a
    Composer dependency.
- * php-ast only runs on PHP >= 7.0, as prior versions did not use an internal AST. PHP-Parser
+ * php-ast only runs on PHP >= 7.0 (php-ast 1.0.16 was the last version supporting php <= 7.1), as prior versions did not use an internal AST. PHP-Parser
    supports PHP >= 5.5.
  * php-ast may only parse code that is syntactically valid on the version of PHP it runs on. This
-   means that it's not possible to parse code using features of newer versions (e.g. PHP 7.1 code
-   while running on PHP 7.0). Similarly, it is not possible to parse code that is no longer
+   means that it's not possible to parse code using features of newer versions (e.g. PHP 7.4 code
+   while running on PHP 7.2). Similarly, it is not possible to parse code that is no longer
    syntactically valid on the used version (e.g. some PHP 5 code may no longer be parsed -- however
    most code will work). PHP-Parser supports parsing both newer and older (up to PHP 5.2) versions.
  * php-ast can only parse code which is syntactically valid, while PHP-Parser can provide a partial

ast.c

@@ -19,6 +19,10 @@
 #include "zend_attributes.h"
 #endif
 
+#if PHP_VERSION_ID < 70200
+#error "The php-ast 1.1 release dropped support for php 7.0-7.1. Use php-ast 1.0.16 instead."
+#endif
+
 #ifndef ZEND_THIS
 #define ZEND_THIS getThis()
 #endif
@@ -27,12 +31,6 @@
 #define ZEND_ARG_INFO_WITH_DEFAULT_VALUE(pass_by_ref, name, default_value) \
 	ZEND_ARG_INFO(pass_by_ref, name)
 #endif
-#if PHP_VERSION_ID < 70200
-#undef ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX
-#define ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(name, return_reference, required_num_args, class_name, allow_null) \
-	static const zend_internal_arg_info name[] = { \
-	   	{ (const char*)(zend_uintptr_t)(required_num_args), ( #class_name ), 0, return_reference, allow_null, 0 },
-#endif
 
 #ifndef ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX
 #define ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(name, return_reference, required_num_args, class_name, allow_null) \
@@ -87,16 +85,6 @@
 #define AST_PLUS 261
 #define AST_MINUS 262
 
-/* Define some compatibility constants */
-#if PHP_VERSION_ID < 70100
-# define IS_VOID 18
-# define IS_ITERABLE 19
-# define ZEND_TYPE_NULLABLE (1<<8)
-# define ZEND_ARRAY_SYNTAX_LIST 1
-# define ZEND_ARRAY_SYNTAX_LONG 2
-# define ZEND_ARRAY_SYNTAX_SHORT 3
-#endif
-
 #if PHP_VERSION_ID < 70300
 # define ZEND_BIND_REF 1
 #endif
@@ -764,16 +752,6 @@ static void ast_fill_children_ht(HashTable *ht, zend_ast *ast, ast_state_info_t
 			}
 		}
 #endif
-#endif
-		/* This AST_CATCH check should occur before ast_is_name() */
-#if PHP_VERSION_ID < 70100
-		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);
-			ast_create_virtual_node_ex(
-					&child_zv, ZEND_AST_NAME_LIST, 0, zend_ast_get_lineno(child), state, 1, &tmp);
-		} else
 #endif
 		if (ast_is_name(child, ast, i)) {
 			ast_name_to_zval(child, ast, &child_zv, i, state);
@@ -803,21 +781,9 @@ static void ast_fill_children_ht(HashTable *ht, zend_ast *ast, ast_state_info_t
 			/* Skip "uses" child since it is always empty */
 			continue;
 #endif
-#if PHP_VERSION_ID >= 70100
 		} 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
-				&& ast->attr == ZEND_ARRAY_SYNTAX_LIST && child != NULL) {
-			/* Emulate ARRAY_ELEM list */
-			zval ch0, ch1;
-			ast_to_zval(&ch0, child, state);
-			ZVAL_NULL(&ch1);
-			ast_create_virtual_node_ex(
-				&child_zv, ZEND_AST_ARRAY_ELEM, 0, zend_ast_get_lineno(child), state,
-				2, &ch0, &ch1);
-#endif
 		} else {
 			ast_to_zval(&child_zv, child, state);
 		}
@@ -840,15 +806,6 @@ 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) {
-		zval tmp;
-		ZVAL_NULL(&tmp);
-		zend_hash_add_new(ht, AST_STR(str_docComment), &tmp);
-		return;
-	}
-#endif
 #if PHP_VERSION_ID < 80000
 	if (state->version >= 80) {
 		if (ast_kind == ZEND_AST_PARAM) {
@@ -1020,14 +977,6 @@ static void ast_to_zval(zval *zv, zend_ast *ast, ast_state_info_t *state) {
 #endif
 	}
 
-#if PHP_VERSION_ID < 70100
-	/* Normalize to PHP 7.1 format */
-	if (ast->kind == ZEND_AST_LIST) {
-		ast->kind = ZEND_AST_ARRAY;
-		ast->attr = ZEND_ARRAY_SYNTAX_LIST;
-	}
-#endif
-
 	object_init_ex(zv, ast_node_ce);
 
 	zend_object *obj = Z_OBJ_P(zv);
@@ -1065,11 +1014,6 @@ static void ast_to_zval(zval *zv, zend_ast *ast, ast_state_info_t *state) {
 
 		zend_hash_add_new(children, AST_STR(str_docComment), &tmp_zv);
 	} else {
-#if PHP_VERSION_ID < 70100
-		if (ast->kind == ZEND_AST_CLASS_CONST_DECL) {
-			ast->attr = ZEND_ACC_PUBLIC;
-		}
-#endif
 		AST_NODE_SET_PROP_FLAGS(obj, ast->attr);
 	}
 
@@ -1110,8 +1054,7 @@ 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) {
-	/* Currently no deprecated versions */
-	return 0;
+	return version < 70;
 }
 
 static zend_string *ast_version_info() {
@@ -1512,15 +1455,9 @@ PHP_MINIT_FUNCTION(ast) {
 	ast_register_flag_constant("EXEC_REQUIRE", ZEND_REQUIRE);
 	ast_register_flag_constant("EXEC_REQUIRE_ONCE", ZEND_REQUIRE_ONCE);
 
-#if PHP_VERSION_ID >= 70200
 	ast_register_flag_constant("USE_NORMAL", ZEND_SYMBOL_CLASS);
 	ast_register_flag_constant("USE_FUNCTION", ZEND_SYMBOL_FUNCTION);
 	ast_register_flag_constant("USE_CONST", ZEND_SYMBOL_CONST);
-#else
-	ast_register_flag_constant("USE_NORMAL", T_CLASS);
-	ast_register_flag_constant("USE_FUNCTION", T_FUNCTION);
-	ast_register_flag_constant("USE_CONST", T_CONST);
-#endif
 
 	ast_register_flag_constant("MAGIC_LINE", T_LINE);
 	ast_register_flag_constant("MAGIC_FILE", T_FILE);

package.xml

@@ -20,8 +20,8 @@
  </lead>
  <date>2022-02-12</date>
  <version>
-  <release>1.0.17dev</release>
-  <api>1.0.17dev</api>
+  <release>1.1.0dev</release>
+  <api>1.1.0dev</api>
  </version>
  <stability>
   <release>stable</release>
@@ -30,6 +30,8 @@
  <license uri="https://github.com/nikic/php-ast/blob/master/LICENSE">BSD-3-Clause</license>
  <notes>
 - Change documentation files to properly namespace attributes as `#[\AllowDynamicProperties]`. The reflection attributes are already correct.
+- Deprecated AST versions 50 and 60.
+- Drop support for php &lt;= 7.1
  </notes>
  <contents>
   <dir name="/">
@@ -133,7 +135,7 @@
  <dependencies>
   <required>
    <php>
-    <min>7.0.0</min>
+    <min>7.2.0</min>
    </php>
    <pearinstaller>
     <min>1.10.0</min>
@@ -157,6 +159,7 @@
    <notes>
 - Optimize instantiating properties of ast\Node and ast\Metadata.
 - Document that ast\Node implements `#[AllowDynamicProperties]` in php 8.2
+- Allow ast\Node to have dynamic properties without emitting a notice in PHP 8.2.
    </notes>
   </release>
   <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.17dev"
+#define PHP_AST_VERSION "1.1.0dev"
 
 #ifdef PHP_WIN32
 #	define PHP_AST_API __declspec(dllexport)
@@ -82,9 +82,7 @@ extern ast_str_globals str_globals;
 #endif
 
 /* Pretend it still exists */
-#if PHP_VERSION_ID >= 70100
 # define ZEND_AST_LIST ((1 << (ZEND_AST_IS_LIST_SHIFT + 1)) - 1)
-#endif
 
 extern const size_t ast_kinds_count;
 extern const zend_ast_kind ast_kinds[];

tests/001.phpt

@@ -20,7 +20,7 @@ function test(Type $arg = XYZ) : Ret {
 }
 PHP;
 
-echo ast_dump(ast\parse_code($code, $version=50));
+echo ast_dump(ast\parse_code($code, $version=70));
 --EXPECT--
 AST_STMT_LIST
     0: AST_FUNC_DECL
@@ -38,7 +38,6 @@ AST_STMT_LIST
                     name: AST_NAME
                         flags: NAME_NOT_FQ (1)
                         name: "XYZ"
-        uses: null
         stmts: AST_STMT_LIST
             0: AST_IF
                 0: AST_IF_ELEM

tests/array_destructuring.phpt

@@ -1,7 +1,5 @@
 --TEST--
 Array destructuring
---SKIPIF--
-<?php if (PHP_VERSION_ID < 70100) die('skip PHP >= 7.1 only'); ?>
 --FILE--
 <?php
 
@@ -15,7 +13,7 @@ list('foo' => $a, 'bar' => $b) = $x;
 [, [$a]] = $x;
 PHP;
 
-echo ast_dump(ast\parse_code($code, $version=50));
+echo ast_dump(ast\parse_code($code, $version=70));
 
 ?>
 --EXPECT--

tests/array_destructuring_old.phpt

@@ -11,7 +11,7 @@ list($a, $b) = $x;
 list(, $b) = $x;
 PHP;
 
-echo ast_dump(ast\parse_code($code, $version=50));
+echo ast_dump(ast\parse_code($code, $version=70));
 
 ?>
 --EXPECTF--

tests/assign_ops.phpt

@@ -21,7 +21,7 @@ $a <<= $b;
 $a >>= $b;
 PHP;
 
-echo ast_dump(ast\parse_code($code, $version=50)), "\n";
+echo ast_dump(ast\parse_code($code, $version=70)), "\n";
 
 ?>
 --EXPECTF--