Use the ref metatype for declaring MAY_BE_ARRAY_OF_REF

kocsismate · kocsismate · commit 3b2f52eee6c0 · 2021-08-30T12:19:16.000+02:00
diff --git a/Zend/zend_builtin_functions.stub.php b/Zend/zend_builtin_functions.stub.php
@@ -45,7 +45,7 @@ function is_subclass_of(mixed $object_or_class, string $class, bool $allow_strin
 function is_a(mixed $object_or_class, string $class, bool $allow_string = false): bool {}
 
 /**
- * @return array-ref<string, mixed>
+ * @return array<string, mixed|ref>
  * @refcount 1
  */
 function get_class_vars(string $class): array {}
@@ -132,7 +132,7 @@ function get_declared_interfaces(): array {}
 function get_defined_functions(bool $exclude_disabled = true): array {}
 
 /**
- * @return array-ref<string, mixed>
+ * @return array<string, mixed|ref>
  * @refcount 1
  */
 function get_defined_vars(): array {}
diff --git a/Zend/zend_builtin_functions_arginfo.h b/Zend/zend_builtin_functions_arginfo.h
@@ -1,5 +1,5 @@
 /* This is a generated file, edit the .stub.php file instead.
- * Stub hash: b2ad660f538e2d5c2c432bb58b037ae5160f8833 */
+ * Stub hash: f87d92c002674c431827895a8d8b3a5da3b95482 */
 
 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_zend_version, 0, 0, IS_STRING, 0)
 ZEND_END_ARG_INFO()
diff --git a/build/gen_stub.php b/build/gen_stub.php
@@ -120,21 +120,17 @@ class ArrayType extends SimpleType {
     /** @var Type */
     public $valueType;
 
-    /** @var bool */
-    public $supportsReferences;
-
     public static function createGenericArray(): self
     {
-        return new ArrayType(Type::fromString("int|string"), Type::fromString("mixed"), false);
+        return new ArrayType(Type::fromString("int|string"), Type::fromString("mixed"));
     }
 
-    public function __construct(Type $keyType, Type $valueType, bool $supportsReferences)
+    public function __construct(Type $keyType, Type $valueType)
     {
         parent::__construct("array", true);
 
         $this->keyType = $keyType;
         $this->valueType = $valueType;
-        $this->supportsReferences = $supportsReferences;
     }
 
     public function toOptimizerTypeMask(): string {
@@ -144,10 +140,6 @@ public function toOptimizerTypeMask(): string {
             $this->valueType->toOptimizerTypeMaskForArrayValue(),
         ];
 
-        if ($this->supportsReferences) {
-            $typeMasks[] = "MAY_BE_ARRAY_OF_REF";
-        }
-
         return implode("|", $typeMasks);
     }
 
@@ -159,8 +151,7 @@ public function equals(SimpleType $other): bool {
         assert(get_class($other) === self::class);
 
         return Type::equals($this->keyType, $other->keyType) &&
-            Type::equals($this->valueType, $other->valueType) &&
-            $this->supportsReferences === $other->supportsReferences;
+            Type::equals($this->valueType, $other->valueType);
     }
 }
 
@@ -224,13 +215,13 @@ public static function fromString(string $typeString): SimpleType
         $matches = [];
         $isArray = preg_match("/(.*)\s*\[\s*\]/", $typeString, $matches);
         if ($isArray) {
-            return new ArrayType(Type::fromString("int"), Type::fromString($matches[1]), false);
+            return new ArrayType(Type::fromString("int"), Type::fromString($matches[1]));
         }
 
         $matches = [];
-        $isArray = preg_match("/array(-ref)?\s*<\s*([A-Za-z0-9_-|]+)\s*,\s*([A-Za-z0-9_-|]+)\s*>/i", $typeString, $matches);
+        $isArray = preg_match("/array\s*<\s*([A-Za-z0-9_-|]+)\s*,\s*([A-Za-z0-9_-|]+)\s*>/i", $typeString, $matches);
         if ($isArray) {
-            return new ArrayType(Type::fromString($matches[2]), Type::fromString($matches[3]), !empty($matches[1]));
+            return new ArrayType(Type::fromString($matches[1]), Type::fromString($matches[2]));
         }
 
         return new SimpleType($typeString, false);
@@ -406,31 +397,33 @@ class Type {
     /** @var SimpleType[] */
     public $types;
 
-    /**
-     * @param SimpleType[] $types
-     */
-    public function __construct(array $types) {
-        $this->types = $types;
-    }
+    /** @var bool */
+    public $isReferenceSupported;
 
     public static function fromNode(Node $node): Type {
         if ($node instanceof Node\UnionType) {
-            return new Type(array_map(['SimpleType', 'fromNode'], $node->types));
+            return new Type(array_map(['SimpleType', 'fromNode'], $node->types), false);
         }
+
         if ($node instanceof Node\NullableType) {
-            return new Type([
-                SimpleType::fromNode($node->type),
-                SimpleType::null(),
-            ]);
+            return new Type(
+                [
+                    SimpleType::fromNode($node->type),
+                    SimpleType::null(),
+                ],
+                false
+            );
         }
-        return new Type([SimpleType::fromNode($node)]);
+
+        return new Type([SimpleType::fromNode($node)], false);
     }
 
     public static function fromString(string $typeString): self {
         $typeString .= "|";
         $simpleTypes = [];
         $simpleTypeOffset = 0;
         $inArray = false;
+        $referenceSupported = false;
 
         $typeStringLength = strlen($typeString);
         for ($i = 0; $i < $typeStringLength; $i++) {
@@ -452,13 +445,26 @@ public static function fromString(string $typeString): self {
 
             if ($char === "|") {
                 $simpleTypeName = trim(substr($typeString, $simpleTypeOffset, $i - $simpleTypeOffset));
-                $simpleTypes[] = SimpleType::fromString($simpleTypeName);
+
+                if (strtolower($simpleTypeName) === "ref") {
+                    $referenceSupported = true;
+                } else {
+                    $simpleTypes[] = SimpleType::fromString($simpleTypeName);
+                }
 
                 $simpleTypeOffset = $i + 1;
             }
         }
 
-        return new Type($simpleTypes);
+        return new Type($simpleTypes, $referenceSupported);
+    }
+
+    /**
+     * @param SimpleType[] $types
+     */
+    private function __construct(array $types, bool $isReferenceSupported) {
+        $this->types = $types;
+        $this->isReferenceSupported = $isReferenceSupported;
     }
 
     public function isScalar(): bool {
@@ -482,9 +488,15 @@ public function isNullable(): bool {
     }
 
     public function getWithoutNull(): Type {
-        return new Type(array_filter($this->types, function(SimpleType $type) {
-            return !$type->isNull();
-        }));
+        return new Type(
+            array_filter(
+                $this->types,
+                function(SimpleType $type) {
+                    return !$type->isNull();
+                }
+            ),
+            false
+        );
     }
 
     public function tryToSimpleType(): ?SimpleType {
@@ -535,6 +547,10 @@ public function toOptimizerTypeMaskForArrayValue(): string {
             $typeMasks[] = $type->toOptimizerTypeMaskForArrayValue();
         }
 
+        if ($this->isReferenceSupported) {
+            $typeMasks[] = "MAY_BE_ARRAY_OF_REF";
+        }
+
         return implode("|", $typeMasks);
     }
 
@@ -576,6 +592,10 @@ public static function equals(?Type $a, ?Type $b): bool {
             }
         }
 
+        if ($a->isReferenceSupported !== $b->isReferenceSupported) {
+            return false;
+        }
+
         return true;
     }
 
diff --git a/ext/filter/filter.stub.php b/ext/filter/filter.stub.php
@@ -12,7 +12,7 @@ function filter_var(mixed $value, int $filter = FILTER_DEFAULT, array|int $optio
 function filter_input_array(int $type, array|int $options = FILTER_DEFAULT, bool $add_empty = true): array|false|null {}
 
 /**
- * @return array-ref<int|string, mixed>|false|null
+ * @return array<int|string, mixed|ref>|false|null
  * @refcount 1
  */
 function filter_var_array(array $array, array|int $options = FILTER_DEFAULT, bool $add_empty = true): array|false|null {}
diff --git a/ext/filter/filter_arginfo.h b/ext/filter/filter_arginfo.h
@@ -1,5 +1,5 @@
 /* This is a generated file, edit the .stub.php file instead.
- * Stub hash: a5db1b691947245e9b3458e7a5a1ffe62a802d8b */
+ * Stub hash: 34a64a7c42c7129146fac699c801fe0257fe0d6f */
 
 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_filter_has_var, 0, 2, _IS_BOOL, 0)
 	ZEND_ARG_TYPE_INFO(0, input_type, IS_LONG, 0)
diff --git a/ext/pcre/php_pcre.stub.php b/ext/pcre/php_pcre.stub.php
@@ -38,7 +38,7 @@ function preg_split(string $pattern, string $subject, int $limit = -1, int $flag
 function preg_quote(string $str, ?string $delimiter = null): string {}
 
 /**
- * @return array-ref<int|string, mixed>|false
+ * @return array<int|string, mixed|ref>|false
  * @refcount 1
  */
 function preg_grep(string $pattern, array $array, int $flags = 0): array|false {}
diff --git a/ext/pcre/php_pcre_arginfo.h b/ext/pcre/php_pcre_arginfo.h
@@ -1,5 +1,5 @@
 /* This is a generated file, edit the .stub.php file instead.
- * Stub hash: d0eeb138b997db89537baf129ee6146303dae63d */
+ * Stub hash: 18ea8e0fc49c4daab52d346ba68afc77cc3f1552 */
 
 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_preg_match, 0, 2, MAY_BE_LONG|MAY_BE_FALSE)
 	ZEND_ARG_TYPE_INFO(0, pattern, IS_STRING, 0)
diff --git a/ext/spl/php_spl.stub.php b/ext/spl/php_spl.stub.php
@@ -51,7 +51,7 @@ function iterator_apply(Traversable $iterator, callable $callback, ?array $args
 function iterator_count(Traversable $iterator): int {}
 
 /**
- * @return array-ref<int|string, mixed>
+ * @return array<int|string, mixed|ref>
  * @refcount 1
  */
 function iterator_to_array(Traversable $iterator, bool $preserve_keys = true): array {}
diff --git a/ext/spl/php_spl_arginfo.h b/ext/spl/php_spl_arginfo.h
@@ -1,5 +1,5 @@
 /* This is a generated file, edit the .stub.php file instead.
- * Stub hash: a200c26a76a814b4ac8ab238e884f2d823097b2b */
+ * Stub hash: a3102a82fa37455c2a5941b6e4f56204baa43950 */
 
 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_class_implements, 0, 1, MAY_BE_ARRAY|MAY_BE_FALSE)
 	ZEND_ARG_INFO(0, object_or_class)
