Skip to content

gen_stub: drop support for @refcount 0 with scalar return #16505

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 30, 2024
Merged

gen_stub: drop support for @refcount 0 with scalar return #16505

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3caf15a
gen_stub: drop support for `@refcount 0` with scalar return
DanielEScherzer Oct 19, 2024
5636c59
Revert REFCOUNT_SCALAR name, document redundant refcount
DanielEScherzer Nov 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 9 additions & 12 deletions build/gen_stub.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1155,12 +1155,13 @@ public function isDestructor(): bool {
}

class ReturnInfo {
const REFCOUNT_0 = "0";
// REFCOUNT_SCALAR (formerly REFCOUNT_0) is automatically applied for
// scalars, and not allowed for non-scalars
const REFCOUNT_SCALAR = "0";
const REFCOUNT_1 = "1";
const REFCOUNT_N = "N";

const REFCOUNTS = [
self::REFCOUNT_0,
const REFCOUNTS_NONSCALAR = [
self::REFCOUNT_1,
self::REFCOUNT_N,
];
Expand Down Expand Up @@ -1200,20 +1201,16 @@ private function setRefcount(?string $refcount): void
$isScalarType = $type !== null && $type->isScalar();

if ($refcount === null) {
$this->refcount = $isScalarType ? self::REFCOUNT_0 : self::REFCOUNT_N;
$this->refcount = $isScalarType ? self::REFCOUNT_SCALAR : self::REFCOUNT_N;
return;
}

if (!in_array($refcount, ReturnInfo::REFCOUNTS, true)) {
throw new Exception("@refcount must have one of the following values: \"0\", \"1\", \"N\", $refcount given");
if ($isScalarType) {
throw new Exception("@refcount is not permitted on functions returning scalar values");
}

if ($isScalarType && $refcount !== self::REFCOUNT_0) {
throw new Exception('A scalar return type of "' . $type->__toString() . '" must have a refcount of "' . self::REFCOUNT_0 . '"');
}

if (!$isScalarType && $refcount === self::REFCOUNT_0) {
throw new Exception('A non-scalar return type of "' . $type->__toString() . '" cannot have a refcount of "' . self::REFCOUNT_0 . '"');
if (!in_array($refcount, ReturnInfo::REFCOUNTS_NONSCALAR, true)) {
throw new Exception("@refcount must have one of the following values: \"1\", \"N\", $refcount given");
}

$this->refcount = $refcount;
Expand Down