gen_stub: Add support for attributes on constants in stubs (#18735)

Update to PHP-Parser 5.5.0 and add support for attributes on constants in
stubs. For now, I have only migrated over E_STRICT, once the support is in
place I'll do a larger migration of the existing deprecated constants.

In the process, fix the logic in `copy_zend_constant()` for copying attributes
when a constant is copied; just increase the reference count for the attributes
table rather than trying to duplicate the contents.

Author: DanielEScherzer

Zend/tests/e_strict-deprecated.phpt

@@ -10,5 +10,5 @@ var_dump(E_STRICT);
 --EXPECTF--
 int(30719)
 
-Deprecated: Constant E_STRICT is deprecated in %s on line %d
+Deprecated: Constant E_STRICT is deprecated since 8.4, the error level was removed in %s on line %d
 int(2048)

Zend/zend_attributes.h

@@ -21,6 +21,7 @@
 #define ZEND_ATTRIBUTES_H
 
 #include "zend_compile.h"
+#include "zend_constants.h"
 
 #define ZEND_ATTRIBUTE_TARGET_CLASS			(1<<0)
 #define ZEND_ATTRIBUTE_TARGET_FUNCTION		(1<<1)
@@ -126,6 +127,12 @@ static zend_always_inline zend_attribute *zend_add_class_constant_attribute(zend
 	return zend_add_attribute(&c->attributes, name, argc, flags, 0, 0);
 }
 
+static zend_always_inline zend_attribute *zend_add_global_constant_attribute(zend_constant *c, zend_string *name, uint32_t argc)
+{
+	uint32_t flags = ZEND_CONSTANT_MODULE_NUMBER(c) == PHP_USER_CONSTANT ? 0 : ZEND_ATTRIBUTE_PERSISTENT;
+	return zend_add_attribute(&c->attributes, name, argc, flags, 0, 0);
+}
+
 void zend_register_attribute_ce(void);
 void zend_attributes_shutdown(void);
 

Zend/zend_constants.c

@@ -85,7 +85,8 @@ static void copy_zend_constant(zval *zv)
 		c->filename = zend_string_copy(c->filename);
 	}
 	if (c->attributes != NULL) {
-		c->attributes = zend_array_dup(c->attributes);
+		// Use the same attributes table
+		GC_ADDREF(c->attributes);
 	}
 	if (Z_TYPE(c->value) == IS_STRING) {
 		Z_STR(c->value) = zend_string_dup(Z_STR(c->value), 1);

Zend/zend_constants.stub.php

@@ -71,9 +71,9 @@
 /**
  * @var int
  * @cvalue E_STRICT
- * @deprecated
  * @todo Remove in PHP 9.0
  */
+#[\Deprecated(since: '8.4', message: 'the error level was removed')]
 const E_STRICT = UNKNOWN;
 
 /**

Zend/zend_constants_arginfo.h

@@ -2622,6 +2622,13 @@ public function __construct(
         ?ExposedDocComment $exposedDocComment,
         bool $isFileCacheAllowed
     ) {
+        foreach ($attributes as $attr) {
+            if ($attr->class === "Deprecated") {
+                $isDeprecated = true;
+                break;
+            }
+        }
+
         $this->name = $name;
         $this->value = $value;
         $this->valueString = $valueString;
@@ -2915,17 +2922,11 @@ protected function getFlagsByPhpVersion(): array
     {
         $flags = parent::getFlagsByPhpVersion();
 
+        // $this->isDeprecated also accounts for any #[\Deprecated] attributes
         if ($this->isDeprecated) {
             $flags = $this->addFlagForVersionsAbove($flags, "ZEND_ACC_DEPRECATED", PHP_80_VERSION_ID);
         }
 
-        foreach ($this->attributes as $attr) {
-            if ($attr->class === "Deprecated") {
-                $flags = $this->addFlagForVersionsAbove($flags, "ZEND_ACC_DEPRECATED", PHP_80_VERSION_ID);
-                break;
-            }
-        }
-
         if ($this->flags & Modifiers::FINAL) {
             $flags = $this->addFlagForVersionsAbove($flags, "ZEND_ACC_FINAL", PHP_81_VERSION_ID);
         }
@@ -4340,7 +4341,7 @@ private function handleStatements(array $stmts, PrettyPrinterAbstract $prettyPri
                         $cond,
                         $this->isUndocumentable,
                         $this->getMinimumPhpVersionIdCompatibility(),
-                        []
+                        AttributeInfo::createFromGroups($stmt->attrGroups)
                     );
                 }
                 continue;
@@ -5177,7 +5178,9 @@ static function (FuncInfo $funcInfo) use ($fileInfo, &$generatedFunctionDeclarat
     $php80MinimumCompatibility = $fileInfo->getMinimumPhpVersionIdCompatibility() === null || $fileInfo->getMinimumPhpVersionIdCompatibility() >= PHP_80_VERSION_ID;
 
     if ($fileInfo->generateClassEntries) {
-        if ($attributeInitializationCode = generateFunctionAttributeInitialization($fileInfo->funcInfos, $allConstInfos, $fileInfo->getMinimumPhpVersionIdCompatibility(), null)) {
+        $attributeInitializationCode = generateFunctionAttributeInitialization($fileInfo->funcInfos, $allConstInfos, $fileInfo->getMinimumPhpVersionIdCompatibility(), null);
+        $attributeInitializationCode .= generateGlobalConstantAttributeInitialization($fileInfo->constInfos, $allConstInfos, $fileInfo->getMinimumPhpVersionIdCompatibility(), null);
+        if ($attributeInitializationCode) {
             if (!$php80MinimumCompatibility) {
                 $attributeInitializationCode = "\n#if (PHP_VERSION_ID >= " . PHP_80_VERSION_ID . ")" . $attributeInitializationCode . "#endif\n";
             }
@@ -5289,6 +5292,51 @@ static function (FuncInfo $funcInfo) use ($allConstInfos, $phpVersionIdMinimumCo
     );
 }
 
+/**
+ * @param iterable<ConstInfo> $constInfos
+ * @param array<string, ConstInfo> $allConstInfos
+ */
+function generateGlobalConstantAttributeInitialization(
+    iterable $constInfos,
+    array $allConstInfos,
+    ?int $phpVersionIdMinimumCompatibility,
+    ?string $parentCond = null
+): string {
+    $isConditional = false;
+    if ($phpVersionIdMinimumCompatibility !== null && $phpVersionIdMinimumCompatibility < PHP_85_VERSION_ID) {
+        $isConditional = true;
+        $phpVersionIdMinimumCompatibility = PHP_85_VERSION_ID;
+    }
+    $code = generateCodeWithConditions(
+        $constInfos,
+        "",
+        static function (ConstInfo $constInfo) use ($allConstInfos, $phpVersionIdMinimumCompatibility) {
+            if ($constInfo->attributes === []) {
+                return null;
+            }
+            $constName = str_replace('\\', '\\\\', $constInfo->name->__toString());
+            $constVarName = 'const_' . $constName;
+
+            $code .= "\tzend_constant *$constVarName = zend_hash_str_find_ptr(EG(zend_constants), \"" . $constName . "\", sizeof(\"" . $constName . "\") - 1);\n";
+            foreach ($constInfo->attributes as $key => $attribute) {
+                $code .= $attribute->generateCode(
+                    "zend_add_global_constant_attribute($constVarName",
+                    $constVarName . "_$key",
+                    $allConstInfos,
+                    $phpVersionIdMinimumCompatibility
+                );
+            }
+
+            return $code;
+        },
+        $parentCond
+    );
+    if ($code && $isConditional) {
+        return "\n#if (PHP_VERSION_ID >= " . PHP_85_VERSION_ID . ")\n" . $code . "#endif\n";
+    }
+    return $code;
+}
+
 /**
  * @param iterable<ConstInfo> $constInfos
  * @param array<string, ConstInfo> $allConstInfos
@@ -6030,7 +6078,7 @@ function initPhpParser() {
     }
 
     $isInitialized = true;
-    $version = "5.3.1";
+    $version = "5.5.0";
     $phpParserDir = __DIR__ . "/PHP-Parser-$version";
     if (!is_dir($phpParserDir)) {
         installPhpParser($version, $phpParserDir);

build/gen_stub.php

@@ -0,0 +1,17 @@
+--TEST--
+ReflectionConstant::getAttributes() with attribute (internal constant)
+--FILE--
+<?php
+
+$reflectionConstant = new ReflectionConstant('E_STRICT');
+var_dump($reflectionConstant->getAttributes());
+
+?>
+--EXPECTF--
+array(1) {
+  [0]=>
+  object(ReflectionAttribute)#%d (1) {
+    ["name"]=>
+    string(10) "Deprecated"
+  }
+}

ext/reflection/tests/ReflectionConstant_getAttributes_internal.phpt

@@ -17,6 +17,12 @@
     /** @var string */
     const ZEND_CONSTANT_A = "global";
 
+    /**
+     * @var int
+     */
+    #[\Deprecated(message: "use something else", since: "version 1.5")]
+    const ZEND_TEST_ATTRIBUTED_CONSTANT = 42;
+
     interface _ZendTestInterface
     {
         /** @var int */

ext/zend_test/test.stub.php

@@ -17,6 +17,12 @@ $reflection = new ReflectionClassConstant('_ZendTestClass', 'ZEND_TEST_DEPRECATE
 var_dump($reflection->getAttributes()[0]->newInstance());
 var_dump($reflection->isDeprecated());
 
+ZEND_TEST_ATTRIBUTED_CONSTANT;
+
+$reflection = new ReflectionConstant('ZEND_TEST_ATTRIBUTED_CONSTANT');
+var_dump($reflection->getAttributes()[0]->newInstance());
+var_dump($reflection->isDeprecated());
+
 ?>
 --EXPECTF--
 Deprecated: Function zend_test_deprecated() is deprecated in %s on line %d
@@ -38,3 +44,12 @@ object(Deprecated)#%d (2) {
   NULL
 }
 bool(true)
+
+Deprecated: Constant ZEND_TEST_ATTRIBUTED_CONSTANT is deprecated since version 1.5, use something else in %s on line %d
+object(Deprecated)#%d (2) {
+  ["message"]=>
+  string(18) "use something else"
+  ["since"]=>
+  string(11) "version 1.5"
+}
+bool(true)