Merge pull request #2288 from zephir-lang/#2276-mixed-type

#2276 - Add support for `mixed` type
zephir-lang · Oct 5, 2021 · a41cb40 · a41cb40
2 parents 4ef01e4 + 477bc37
commit a41cb40
Show file tree

Hide file tree

Showing 20 changed files with 742 additions and 117 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](http://semver.org).
 ## [Unreleased]
 # Added
 - Added support for `string` type in php.ini [#2280](https://github.com/zephir-lang/zephir/issues/2280)
+- Added support for `mixed` [#2276](https://github.com/zephir-lang/zephir/issues/2276)
 
 ### Fixed
 - Fixed multiple return types in stubs [#2283](https://github.com/zephir-lang/zephir/issues/2283)

diff --git a/Library/ArgInfoDefinition.php b/Library/ArgInfoDefinition.php
@@ -28,7 +28,7 @@ class ArgInfoDefinition
     /**
      * @var string
      */
-    private string $name = '';
+    private string $name;
 
     /**
      * @var ClassMethodParameters|null
@@ -58,14 +58,14 @@ class ArgInfoDefinition
     /**
      * ArgInfoDefinition constructor.
      *
-     * @param $name
+     * @param string $name
      * @param ClassMethod        $functionLike
      * @param CodePrinter        $codePrinter
      * @param CompilationContext $compilationContext
      * @param bool               $returnByRef
      */
     public function __construct(
-        $name,
+        string $name,
         ClassMethod $functionLike,
         CodePrinter $codePrinter,
         CompilationContext $compilationContext,
@@ -205,16 +205,41 @@ private function richRenderStart(): void
             return;
         }
 
-        $this->codePrinter->output(
-            sprintf(
-                'ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(%s, %d, %d, %s, %d)',
-                $this->name,
-                (int) $this->returnByRef,
-                $this->functionLike->getNumberOfRequiredParameters(),
-                $this->getReturnType(),
-                (int) $this->functionLike->areReturnTypesNullCompatible()
-            )
-        );
+        if ($this->functionLike->isMixed()) {
+            $this->codePrinter->output('#if PHP_VERSION_ID >= 80000');
+            $this->codePrinter->output(
+                sprintf(
+                    'ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(%s, %d, %d, IS_MIXED, %d)',
+                    $this->name,
+                    (int) $this->returnByRef,
+                    $this->functionLike->getNumberOfRequiredParameters(),
+                    (int) $this->functionLike->areReturnTypesNullCompatible()
+                )
+            );
+            $this->codePrinter->output('#else');
+            $this->codePrinter->output(
+                sprintf(
+                    'ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(%s, %d, %d, %s, %d)',
+                    $this->name,
+                    (int) $this->returnByRef,
+                    $this->functionLike->getNumberOfRequiredParameters(),
+                    $this->getReturnType(),
+                    (int) $this->functionLike->areReturnTypesNullCompatible()
+                )
+            );
+            $this->codePrinter->output('#endif');
+        } else {
+            $this->codePrinter->output(
+                sprintf(
+                    'ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(%s, %d, %d, %s, %d)',
+                    $this->name,
+                    (int) $this->returnByRef,
+                    $this->functionLike->getNumberOfRequiredParameters(),
+                    $this->getReturnType(),
+                    (int) $this->functionLike->areReturnTypesNullCompatible()
+                )
+            );
+        }
     }
 
     private function renderEnd(): void
@@ -393,6 +418,11 @@ private function passByReference(array $parameter)
 
     private function getReturnType(): string
     {
+        // TODO: Come back here when PHP7.4 is deprecated.
+        /*if (array_key_exists('mixed', $this->functionLike->getReturnTypes())) {
+            return 'IS_MIXED';
+        }*/
+
         if ($this->functionLike->areReturnTypesIntCompatible()) {
             return 'IS_LONG';
         }

diff --git a/Library/Backends/ZendEngine3/Backend.php b/Library/Backends/ZendEngine3/Backend.php
@@ -106,7 +106,7 @@ public function getStringsManager()
     /**
      * {@inheritdoc}
      */
-    public function getTypeDefinition($type)
+    public function getTypeDefinition($type): array
     {
         switch ($type) {
             case 'zend_ulong':
@@ -155,6 +155,7 @@ public function getTypeDefinition($type)
             case 'variable':
             case 'array':
             case 'null':
+            case 'mixed':
                 $pointer = '*';
                 $code = 'zval';
                 break;
@@ -317,7 +318,7 @@ public function onPostCompile(ClassMethod $method, CompilationContext $context)
 
     public function generateInitCode(&$groupVariables, $type, $pointer, Variable $variable)
     {
-        $isComplex = \in_array($type, ['variable', 'string', 'array', 'resource', 'callable', 'object'], true);
+        $isComplex = \in_array($type, ['variable', 'string', 'array', 'resource', 'callable', 'object', 'mixed'], true);
 
         if ($isComplex && !$variable->isDoublePointer()) { /* && $variable->mustInitNull() */
             $groupVariables[] = $variable->getName();
@@ -366,6 +367,7 @@ public function generateInitCode(&$groupVariables, $type, $pointer, Variable $va
                 case 'resource':
                 case 'callable':
                 case 'object':
+                case 'mixed':
                     $groupVariables[] = $pointer.$variable->getName();
                     break;
 
@@ -595,7 +597,7 @@ public function addArrayEntry(Variable $variable, $key, $value, CompilationConte
             $keyType = 'append';
         } elseif ($key instanceof CompiledExpression) {
             $typeKey = $key->getType();
-            if ('variable' == $typeKey) {
+            if ('variable' === $typeKey || 'mixed' === $typeKey) {
                 $var = $context->symbolTable->getVariableForRead($key->getCode(), $context);
                 $typeKey = $var->getType();
             }
@@ -630,6 +632,7 @@ public function addArrayEntry(Variable $variable, $key, $value, CompilationConte
 
             case 'variable':
             case 'array':
+            case 'mixed':
                 $type = 'zval';
                 break;
         }
@@ -847,20 +850,21 @@ public function resolveValue($value, CompilationContext $context, $usePointer =
                 $tempVariable = new Variable('variable', $varName, $context->branchManager->getCurrentBranch());
                 $context->symbolTable->addRawVariable($tempVariable);
             }
+
             $tempVariable = $context->symbolTable->getVariableForWrite($varName, $context);
             $tempVariable->increaseUses();
-            $tempVariable->setUsed(true, null);
+            $tempVariable->setUsed(true);
+
             if ('null' == $value) {
                 $tempVariable->setDynamicTypes('null');
             } else {
                 $tempVariable->setDynamicTypes('bool');
             }
+
             $value = $this->getVariableCode($tempVariable);
         } else {
             if ($value instanceof CompiledExpression) {
-                if ('array' == $value->getType()) {
-                    $value = $context->symbolTable->getVariableForWrite($value->getCode(), $context, null);
-                } elseif ('variable' == $value->getType()) {
+                if (in_array($value->getType(), ['array', 'variable', 'mixed'])) {
                     $value = $context->symbolTable->getVariableForWrite($value->getCode(), $context);
                 } else {
                     return $value->getCode();

diff --git a/Library/ClassMethod.php b/Library/ClassMethod.php
@@ -96,6 +96,15 @@ class ClassMethod
      */
     protected bool $void = false;
 
+    /**
+     * Whether the variable is mixed.
+     *
+     * Only for PHP >= 8.0
+     *
+     * @var bool
+     */
+    protected bool $mixed = false;
+
     /**
      * Whether the method is public or not.
      *
@@ -276,34 +285,42 @@ public function setReturnTypes(?array $returnType = null): void
         $castTypes = [];
 
         foreach ($returnType['list'] as $returnTypeItem) {
-            if (isset($returnTypeItem['cast'])) {
-                if (isset($returnTypeItem['cast']['collection'])) {
-                    continue;
-                }
+            /**
+             * We continue the loop, because it only works for PHP >= 8.0.
+             */
+            if (isset($returnTypeItem['data-type']) && $returnTypeItem['data-type'] === 'mixed') {
+                $this->mixed = true;
+            }
 
-                if (isset($returnTypeItem['collection']) && $returnTypeItem['collection']) {
-                    $types['array'] = [
-                        'type' => 'return-type-parameter',
-                        'data-type' => 'array',
-                        'mandatory' => 0,
-                        'file' => $returnTypeItem['cast']['file'],
-                        'line' => $returnTypeItem['cast']['line'],
-                        'char' => $returnTypeItem['cast']['char'],
-                    ];
-                } else {
-                    $castTypes[$returnTypeItem['cast']['value']] = $returnTypeItem['cast']['value'];
-                }
-            } else {
+            if (!isset($returnTypeItem['cast'])) {
                 $types[$returnTypeItem['data-type']] = $returnTypeItem;
+                continue;
+            }
+
+            if (isset($returnTypeItem['cast']['collection'])) {
+                continue;
+            }
+
+            if (isset($returnTypeItem['collection']) && $returnTypeItem['collection']) {
+                $types['array'] = [
+                    'type' => 'return-type-parameter',
+                    'data-type' => 'array',
+                    'mandatory' => 0,
+                    'file' => $returnTypeItem['cast']['file'],
+                    'line' => $returnTypeItem['cast']['line'],
+                    'char' => $returnTypeItem['cast']['char'],
+                ];
+            } else {
+                $castTypes[$returnTypeItem['cast']['value']] = $returnTypeItem['cast']['value'];
             }
         }
 
-        if (count($castTypes)) {
+        if (count($castTypes) > 0) {
             $types['object'] = [];
             $this->returnClassTypes = $castTypes;
         }
 
-        if (count($types)) {
+        if (count($types) > 0) {
             $this->returnTypes = $types;
         }
     }
@@ -515,7 +532,7 @@ public function setupOptimized(CompilationContext $compilationContext): self
         return $this;
     }
 
-    public function getOptimizedMethod()
+    public function getOptimizedMethod(): ClassMethod
     {
         $optimizedName = $this->getName().'_zephir_internal_call';
         $optimizedMethod = $this->classDefinition->getMethod($optimizedName, false);
@@ -850,6 +867,16 @@ public function isVoid(): bool
         return $this->void;
     }
 
+    /**
+     * Checks if the methods return type is `mixed`.
+     *
+     * @return bool
+     */
+    public function isMixed(): bool
+    {
+        return $this->mixed;
+    }
+
     /**
      * Checks if the method is inline.
      *
@@ -1427,7 +1454,7 @@ public function assignZvalValue(array $parameter, CompilationContext $compilatio
     {
         $dataType = $this->getParamDataType($parameter);
 
-        if (in_array($dataType, ['variable', 'callable', 'object', 'resource'])) {
+        if (in_array($dataType, ['variable', 'callable', 'object', 'resource', 'mixed'])) {
             return '';
         }
 
@@ -1634,6 +1661,7 @@ public function compile(CompilationContext $compilationContext): void
                         case 'callable':
                         case 'resource':
                         case 'variable':
+                        case 'mixed':
                             $symbol = $symbolTable->addVariable($parameter['data-type'], $parameter['name'], $compilationContext);
                             /* TODO: Move this to the respective backend, which requires refactoring how this works */
                             if ($compilationContext->backend->isZE3()) {
@@ -1860,6 +1888,7 @@ public function compile(CompilationContext $compilationContext): void
                     case 'callable':
                     case 'resource':
                     case 'variable':
+                    case 'mixed':
                         $name = $parameter['name'];
                         break;
 

diff --git a/Library/ClassMethodParameters.php b/Library/ClassMethodParameters.php
@@ -115,6 +115,7 @@ public function fetchParameters(bool $isMethodInternal): array
                 case 'callable':
                 case 'resource':
                 case 'variable':
+                case 'mixed':
                     $parameters[] = $isMethodInternal ? $name : '&'.$name;
                     break;
 

diff --git a/Library/Exception/InvalidTypeException.php b/Library/Exception/InvalidTypeException.php
@@ -9,6 +9,8 @@
  * the LICENSE file that was distributed with this source code.
  */
 
+declare(strict_types=1);
+
 namespace Zephir\Exception;
 
 final class InvalidTypeException extends CompilerException
@@ -19,7 +21,7 @@ final class InvalidTypeException extends CompilerException
      * @param string     $type
      * @param array|null $expression
      */
-    public function __construct($type, array $expression = null)
+    public function __construct(string $type, array $expression = null)
     {
         $message = sprintf(
             'Returning type: %s but this type is not compatible with return-type hints declared in the method',

diff --git a/Library/Expression.php b/Library/Expression.php
@@ -189,7 +189,7 @@ public function setEvalMode(bool $evalMode): void
     /**
      * Compiles foo = [].
      *
-     * @param array              $expression
+     * @param array $expression
      * @param CompilationContext $compilationContext
      *
      * @return CompiledExpression
@@ -231,6 +231,8 @@ public function emptyArray(array $expression, CompilationContext $compilationCon
      *
      * @param CompilationContext $compilationContext
      *
+     * @throws CompilerException|Exception
+     *
      * @return CompiledExpression
      *
      * @throws Exception