#2374 - Implement nullable object return type

CHANGELOG.md

@@ -5,6 +5,8 @@ The format based on [Keep a Changelog](https://keepachangelog.com)
 and this project adheres to [Semantic Versioning](https://semver.org).
 
 ## [Unreleased]
+### Fixed
+- Fixed generation of `ARG_INFO` for nullable object (`?object`) [#2374](https://github.com/zephir-lang/zephir/issues/2374)
 
 ## [0.16.0] - 2022-03-20
 ### Added

Library/ArgInfoDefinition.php

@@ -167,13 +167,9 @@ public function render(): void
 
     private function richRenderStart(): void
     {
-        if (array_key_exists('object', $this->functionLike->getReturnTypes())) {
-            $class = 'NULL';
-
-            if (1 === count($this->functionLike->getReturnClassTypes())) {
-                $class = key($this->functionLike->getReturnClassTypes());
-                $class = escape_class($this->compilationContext->getFullName($class));
-            }
+        if (array_key_exists('object', $this->functionLike->getReturnTypes()) && 1 === count($this->functionLike->getReturnClassTypes())) {
+            $class = key($this->functionLike->getReturnClassTypes());
+            $class = escape_class($this->compilationContext->getFullName($class));
 
             $this->codePrinter->output(
                 sprintf(
@@ -237,6 +233,33 @@ private function richRenderStart(): void
             return;
         }
 
+        if ($this->functionLike->isReturnTypeNullableObject()) {
+            $this->codePrinter->output('#if PHP_VERSION_ID >= 80000');
+            $this->codePrinter->output(
+                sprintf(
+                    'ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(%s, %d, %d, %s)',
+                    $this->name,
+                    (int) $this->returnByRef,
+                    $this->functionLike->getNumberOfRequiredParameters(),
+                    'MAY_BE_NULL|MAY_BE_OBJECT',
+                )
+            );
+            $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(),
+                    'IS_OBJECT',
+                    1,
+                )
+            );
+            $this->codePrinter->output('#endif');
+
+            return;
+        }
+
         if (count($this->functionLike->getReturnTypes()) > 1) {
             $types = [];
             $mayBeTypes = $this->functionLike->getMayBeArgTypes();
@@ -446,7 +469,7 @@ private function allowNull(array $parameter): bool
             return false;
         }
 
-        if ('null' == $parameter['default']['type']) {
+        if ('null' === $parameter['default']['type']) {
             return true;
         }
 

Library/ClassMethod.php

@@ -2340,6 +2340,16 @@ public function isReturnTypesHintDetermined(): bool
         return true;
     }
 
+    /**
+     * Checks if method's return type is nullable object `?object`.
+     *
+     * @return bool
+     */
+    public function isReturnTypeNullableObject(): bool
+    {
+        return count($this->returnTypes) === 2 && isset($this->returnTypes['object']) && isset($this->returnTypes['null']);
+    }
+
     /**
      * Checks if the method have compatible return types.
      *

Library/Expression/NativeArray.php

@@ -221,7 +221,7 @@ public function compile(array $expression, CompilationContext $compilationContex
          */
         $arrayLength = count($expression['left']);
         if ($arrayLength >= 33 && function_exists('gmp_nextprime')) {
-            $arrayLength = gmp_strval(gmp_nextprime($arrayLength - 1));
+            $arrayLength = (int) gmp_strval(gmp_nextprime($arrayLength - 1));
         }
 
         if ($this->expectingVariable && $symbolVariable->getVariantInits() >= 1) {

ext/config.m4

@@ -215,6 +215,7 @@ if test "$PHP_STUB" = "yes"; then
 	stub/typeoff.zep.c
 	stub/types/maybe.zep.c
 	stub/types/mixedtype.zep.c
+	stub/types/obj.zep.c
 	stub/unknownclass.zep.c
 	stub/unsettest.zep.c
 	stub/usetest.zep.c

ext/config.w32

@@ -38,7 +38,7 @@ if (PHP_STUB != "no") {
 	ADD_SOURCES(configure_module_dirname + "/stub/requires", "external3.zep.c", "stub");
 	ADD_SOURCES(configure_module_dirname + "/stub/router", "exception.zep.c route.zep.c", "stub");
 	ADD_SOURCES(configure_module_dirname + "/stub/typehinting", "testabstract.zep.c", "stub");
-	ADD_SOURCES(configure_module_dirname + "/stub/types", "maybe.zep.c mixedtype.zep.c", "stub");
+	ADD_SOURCES(configure_module_dirname + "/stub/types", "maybe.zep.c mixedtype.zep.c obj.zep.c", "stub");
   ADD_FLAG("CFLAGS_STUB", "/D ZEPHIR_RELEASE /Oi /Ot /Oy /Ob2 /Gs /GF /Gy /GL");
   ADD_FLAG("CFLAGS", "/D ZEPHIR_RELEASE /Oi /Ot /Oy /Ob2 /Gs /GF /Gy /GL");
   ADD_FLAG("LDFLAGS", "/LTCG");

ext/stub.c

@@ -243,6 +243,7 @@ zend_class_entry *stub_typeinstances_ce;
 zend_class_entry *stub_typeoff_ce;
 zend_class_entry *stub_types_maybe_ce;
 zend_class_entry *stub_types_mixedtype_ce;
+zend_class_entry *stub_types_obj_ce;
 zend_class_entry *stub_unknownclass_ce;
 zend_class_entry *stub_unsettest_ce;
 zend_class_entry *stub_usetest_ce;
@@ -473,6 +474,7 @@ static PHP_MINIT_FUNCTION(stub)
 	ZEPHIR_INIT(Stub_Typeoff);
 	ZEPHIR_INIT(Stub_Types_MayBe);
 	ZEPHIR_INIT(Stub_Types_MixedType);
+	ZEPHIR_INIT(Stub_Types_Obj);
 	ZEPHIR_INIT(Stub_UnknownClass);
 	ZEPHIR_INIT(Stub_Unsettest);
 	ZEPHIR_INIT(Stub_UseTest);

ext/stub.h

@@ -210,6 +210,7 @@
 #include "stub/typeoff.zep.h"
 #include "stub/types/maybe.zep.h"
 #include "stub/types/mixedtype.zep.h"
+#include "stub/types/obj.zep.h"
 #include "stub/unknownclass.zep.h"
 #include "stub/unsettest.zep.h"
 #include "stub/usetest.zep.h"

stub/types/obj.zep

@@ -0,0 +1,15 @@
+
+namespace Stub\Types;
+
+class Obj
+{
+    public function nullableObjectReturnNull() -> object | null
+    {
+        return null;
+    }
+
+    public function nullableObjectReturnObj() -> object | null
+    {
+        return new \stdClass();
+    }
+}

tests/Extension/Types/ObjTypeTest.php

@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * This file is part of the Zephir.
+ *
+ * (c) Phalcon Team <team@zephir-lang.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Extension\Types;
+
+use PHPUnit\Framework\TestCase;
+use stdClass;
+use Stub\Types\Obj;
+
+final class ObjTypeTest extends TestCase
+{
+    public function testIntFalse(): void
+    {
+        $class = new Obj();
+
+        $this->assertNull($class->nullableObjectReturnNull());
+        $this->assertInstanceOf(stdClass::class, $class->nullableObjectReturnObj());
+    }
+}