Support PARAM_MODIFIER_PUBLIC on AST_PARAM nodes (nikic#168)

Fixes nikic#167

Author: TysonAndre

README.md

@@ -256,9 +256,9 @@ ast\flags\CLASS_ANONYMOUS
 // Used by ast\AST_PARAM (combinable)
 ast\flags\PARAM_REF
 ast\flags\PARAM_VARIADIC
-ast\flags\MODIFIER_PUBLIC (only in php 8.0+)
-ast\flags\MODIFIER_PROTECTED (only in php 8.0+)
-ast\flags\MODIFIER_PRIVATE (only in php 8.0+)
+ast\flags\PARAM_MODIFIER_PUBLIC (available since 1.0.8, same as ast\flags\MODIFIER_* in PHP >= 8.0)
+ast\flags\PARAM_MODIFIER_PROTECTED (available since 1.0.8)
+ast\flags\PARAM_MODIFIER_PRIVATE (available since 1.0.8)
 
 // Used by ast\AST_TYPE (exclusive)
 ast\flags\TYPE_ARRAY

ast.c

@@ -65,6 +65,14 @@
 #if PHP_VERSION_ID < 80000
 # define IS_STATIC 20
 # define IS_MIXED 21
+/* In PHP 7.0-7.4, PARAM_REF and PARAM_VARIADIC were 1 and 2. */
+# define PARAM_MODIFIER_PUBLIC    (1 << 2)
+# define PARAM_MODIFIER_PROTECTED (1 << 3)
+# define PARAM_MODIFIER_PRIVATE   (1 << 4)
+#else
+# define PARAM_MODIFIER_PUBLIC    ZEND_ACC_PUBLIC
+# define PARAM_MODIFIER_PROTECTED ZEND_ACC_PROTECTED
+# define PARAM_MODIFIER_PRIVATE   ZEND_ACC_PRIVATE
 #endif
 
 /* This contains state of the ast Node creator. */
@@ -107,11 +115,9 @@ static const char *class_flags[] = {
 static const char *param_flags[] = {
 	AST_FLAG(PARAM_REF),
 	AST_FLAG(PARAM_VARIADIC),
-#if PHP_VERSION_ID >= 80000
-	AST_FLAG(MODIFIER_PUBLIC),
-	AST_FLAG(MODIFIER_PROTECTED),
-	AST_FLAG(MODIFIER_PRIVATE),
-#endif
+	AST_FLAG(PARAM_MODIFIER_PUBLIC),
+	AST_FLAG(PARAM_MODIFIER_PROTECTED),
+	AST_FLAG(PARAM_MODIFIER_PRIVATE),
 	NULL
 };
 
@@ -1368,6 +1374,10 @@ PHP_MINIT_FUNCTION(ast) {
 	ast_register_flag_constant("MODIFIER_ABSTRACT", ZEND_ACC_ABSTRACT);
 	ast_register_flag_constant("MODIFIER_FINAL", ZEND_ACC_FINAL);
 
+	ast_register_flag_constant("PARAM_MODIFIER_PUBLIC", PARAM_MODIFIER_PUBLIC);
+	ast_register_flag_constant("PARAM_MODIFIER_PROTECTED", PARAM_MODIFIER_PROTECTED);
+	ast_register_flag_constant("PARAM_MODIFIER_PRIVATE", PARAM_MODIFIER_PRIVATE);
+
 	ast_register_flag_constant("RETURNS_REF", ZEND_ACC_RETURN_REFERENCE);
 	ast_register_flag_constant("FUNC_RETURNS_REF", ZEND_ACC_RETURN_REFERENCE);
 	ast_register_flag_constant("FUNC_GENERATOR", ZEND_ACC_GENERATOR);

ast_stub.php

@@ -66,45 +66,45 @@
 const AST_BREAK = 286;
 const AST_CONTINUE = 287;
 const AST_CLASS_NAME = 276;
-const AST_CLASS_CONST_GROUP = 545;
+const AST_CLASS_CONST_GROUP = 546;
 const AST_DIM = 512;
 const AST_PROP = 513;
-const AST_STATIC_PROP = 514;
-const AST_CALL = 515;
-const AST_CLASS_CONST = 516;
-const AST_ASSIGN = 517;
-const AST_ASSIGN_REF = 518;
-const AST_ASSIGN_OP = 519;
-const AST_BINARY_OP = 520;
-const AST_ARRAY_ELEM = 525;
-const AST_NEW = 526;
-const AST_INSTANCEOF = 527;
-const AST_YIELD = 528;
-const AST_STATIC = 531;
-const AST_WHILE = 532;
-const AST_DO_WHILE = 533;
-const AST_IF_ELEM = 534;
-const AST_SWITCH = 535;
-const AST_SWITCH_CASE = 536;
-const AST_DECLARE = 537;
-const AST_PROP_ELEM = 774;
-const AST_PROP_GROUP = 773;
-const AST_CONST_ELEM = 775;
-const AST_USE_TRAIT = 538;
-const AST_TRAIT_PRECEDENCE = 539;
-const AST_METHOD_REFERENCE = 540;
-const AST_NAMESPACE = 541;
-const AST_USE_ELEM = 542;
-const AST_TRAIT_ALIAS = 543;
-const AST_GROUP_USE = 544;
-const AST_ATTRIBUTE = 546;
-const AST_MATCH = 547;
-const AST_MATCH_ARM = 548;
+const AST_STATIC_PROP = 515;
+const AST_CALL = 516;
+const AST_CLASS_CONST = 517;
+const AST_ASSIGN = 518;
+const AST_ASSIGN_REF = 519;
+const AST_ASSIGN_OP = 520;
+const AST_BINARY_OP = 521;
+const AST_ARRAY_ELEM = 526;
+const AST_NEW = 527;
+const AST_INSTANCEOF = 528;
+const AST_YIELD = 529;
+const AST_STATIC = 532;
+const AST_WHILE = 533;
+const AST_DO_WHILE = 534;
+const AST_IF_ELEM = 535;
+const AST_SWITCH = 536;
+const AST_SWITCH_CASE = 537;
+const AST_DECLARE = 538;
+const AST_PROP_ELEM = 775;
+const AST_PROP_GROUP = 774;
+const AST_CONST_ELEM = 776;
+const AST_USE_TRAIT = 539;
+const AST_TRAIT_PRECEDENCE = 540;
+const AST_METHOD_REFERENCE = 541;
+const AST_NAMESPACE = 542;
+const AST_USE_ELEM = 543;
+const AST_TRAIT_ALIAS = 544;
+const AST_GROUP_USE = 545;
+const AST_ATTRIBUTE = 547;
+const AST_MATCH = 548;
+const AST_MATCH_ARM = 549;
 const AST_METHOD_CALL = 768;
-const AST_STATIC_CALL = 769;
-const AST_CONDITIONAL = 770;
-const AST_TRY = 771;
-const AST_CATCH = 772;
+const AST_STATIC_CALL = 770;
+const AST_CONDITIONAL = 771;
+const AST_TRY = 772;
+const AST_CATCH = 773;
 const AST_FOR = 1024;
 const AST_FOREACH = 1025;
 const AST_PARAM = 1280;
@@ -121,6 +121,9 @@
 const MODIFIER_STATIC = 16;
 const MODIFIER_ABSTRACT = 64;
 const MODIFIER_FINAL = 32;
+const PARAM_MODIFIER_PUBLIC = 1;
+const PARAM_MODIFIER_PROTECTED = 2;
+const PARAM_MODIFIER_PRIVATE = 4;
 const RETURNS_REF = 4096;
 const FUNC_RETURNS_REF = 4096;
 const FUNC_GENERATOR = 16777216;
@@ -184,14 +187,14 @@
 const USE_NORMAL = 1;
 const USE_FUNCTION = 2;
 const USE_CONST = 4;
-const MAGIC_LINE = 372;
-const MAGIC_FILE = 373;
-const MAGIC_DIR = 374;
-const MAGIC_NAMESPACE = 379;
-const MAGIC_FUNCTION = 378;
-const MAGIC_METHOD = 377;
-const MAGIC_CLASS = 375;
-const MAGIC_TRAIT = 376;
+const MAGIC_LINE = 375;
+const MAGIC_FILE = 376;
+const MAGIC_DIR = 377;
+const MAGIC_NAMESPACE = 382;
+const MAGIC_FUNCTION = 381;
+const MAGIC_METHOD = 380;
+const MAGIC_CLASS = 378;
+const MAGIC_TRAIT = 379;
 const ARRAY_SYNTAX_LIST = 1;
 const ARRAY_SYNTAX_LONG = 2;
 const ARRAY_SYNTAX_SHORT = 3;

package.xml

@@ -29,7 +29,10 @@
  </stability>
  <license uri="https://github.com/nikic/php-ast/blob/master/LICENSE">BSD-3-Clause</license>
  <notes>
-- TBD
+- Recommend using the new constant `ast\flags\PARAM_MODIFIER_*` when checking if parameters use constructor property promotion.
+  The values of `ast\flags\MODIFIER_*` and `ast\flags\PARAM_VARIADIC` had some overlap in some php 7 versions.
+  The new constants will have the same values as `ast\flags\MODIFIER_*` in PHP 8.0+, but different values in PHP 7
+  (and these flags will never be set in php 7).
  </notes>
  <contents>
   <dir name="/">

tests/metadata.phpt

@@ -126,4 +126,4 @@ AST_TRY: []
 AST_CATCH: []
 AST_FOR: []
 AST_FOREACH: []
-AST_PARAM: (combinable) [PARAM_REF, PARAM_VARIADIC%S]
+AST_PARAM: (combinable) [PARAM_REF, PARAM_VARIADIC, PARAM_MODIFIER_PUBLIC, PARAM_MODIFIER_PROTECTED, PARAM_MODIFIER_PRIVATE]

tests/php80_promotion.phpt

@@ -38,13 +38,13 @@ AST_STMT_LIST
                 docComment: "/** Doc comment for __construct */"
                 params: AST_PARAM_LIST
                     0: AST_PARAM
-                        flags: MODIFIER_PUBLIC (%d)
+                        flags: PARAM_MODIFIER_PUBLIC (%d)
                         type: AST_TYPE
                             flags: TYPE_LONG (4)
                         name: "a"
                         default: null
                     1: AST_PARAM
-                        flags: PARAM_REF | MODIFIER_PRIVATE (%d)
+                        flags: PARAM_REF | PARAM_MODIFIER_PRIVATE (%d)
                         type: AST_NAME
                             flags: NAME_NOT_FQ (1)
                             name: "stdClass"
@@ -54,7 +54,7 @@ AST_STMT_LIST
                                 flags: NAME_NOT_FQ (1)
                                 name: "null"
                     2: AST_PARAM
-                        flags: MODIFIER_PROTECTED (%d)
+                        flags: PARAM_MODIFIER_PROTECTED (%d)
                         type: AST_TYPE
                             flags: TYPE_ITERABLE (13)
                         name: "c"