Skip to content

Commit 0cec268

Browse files
nikicnikic
committed
Support single class unions in gen stubs
1 parent 468ecf2 commit 0cec268

File tree

7 files changed

+112
-57
lines changed

7 files changed

+112
-57
lines changed

‎Zend/zend_API.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,10 @@ typedef struct _zend_fcall_info_cache {
128128
static const zend_internal_arg_info name[] = { \
129129
{ (const char*)(zend_uintptr_t)(required_num_args), ZEND_TYPE_INIT_MASK(type | _ZEND_ARG_INFO_FLAGS(return_reference, 0)) },
130130

131+
#define ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(name, return_reference, required_num_args, class_name, type) \
132+
static const zend_internal_arg_info name[] = { \
133+
{ (const char*)(zend_uintptr_t)(required_num_args), ZEND_TYPE_INIT_CLASS_CONST_MASK(#class_name, type | _ZEND_ARG_INFO_FLAGS(return_reference, 0)) },
134+
131135
#define ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(name, return_reference, required_num_args, type, allow_null) \
132136
static const zend_internal_arg_info name[] = { \
133137
{ (const char*)(zend_uintptr_t)(required_num_args), ZEND_TYPE_INIT_CODE(type, allow_null, _ZEND_ARG_INFO_FLAGS(return_reference, 0)) },

‎Zend/zend_closures.stub.php

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ function bindTo(?object $newthis, $newscope = UNKNOWN) {}
1212

1313
function call(object $newthis, ...$parameters) {}
1414

15-
/** @return Closure */
16-
function fromCallable(callable $callable) {}
15+
/**
16+
* @param callable $callable Not a proper type annotation due to bug #78770
17+
* @return Closure
18+
*/
19+
function fromCallable($callable) {}
1720
}

‎Zend/zend_types.h

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -269,6 +269,9 @@ typedef struct {
269269
{ (void *) (ptr), \
270270
(type_kind) | ((allow_null) ? _ZEND_TYPE_NULLABLE_BIT : 0) | (extra_flags) }
271271

272+
#define ZEND_TYPE_INIT_PTR_MASK(ptr, type_mask) \
273+
{ (void *) (ptr), (type_mask) }
274+
272275
#define ZEND_TYPE_INIT_CE(_ce, allow_null, extra_flags) \
273276
ZEND_TYPE_INIT_PTR(_ce, _ZEND_TYPE_CE_BIT, allow_null, extra_flags)
274277

@@ -278,6 +281,9 @@ typedef struct {
278281
#define ZEND_TYPE_INIT_CLASS_CONST(class_name, allow_null, extra_flags) \
279282
ZEND_TYPE_INIT_PTR(class_name, _ZEND_TYPE_NAME_BIT, allow_null, extra_flags)
280283

284+
#define ZEND_TYPE_INIT_CLASS_CONST_MASK(class_name, type_mask) \
285+
ZEND_TYPE_INIT_PTR_MASK(class_name, _ZEND_TYPE_NAME_BIT | (type_mask))
286+
281287
typedef union _zend_value {
282288
zend_long lval; /* long value */
283289
double dval; /* double value */

‎ext/date/php_date.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,9 @@ static const zend_function_entry date_functions[] = {
9393

9494
/* Advanced Interface */
9595
PHP_FE(date_create, arginfo_date_create)
96-
PHP_FE(date_create_immutable, arginfo_date_create)
96+
PHP_FE(date_create_immutable, arginfo_date_create_immutable)
9797
PHP_FE(date_create_from_format, arginfo_date_create_from_format)
98-
PHP_FE(date_create_immutable_from_format, arginfo_date_create_from_format)
98+
PHP_FE(date_create_immutable_from_format, arginfo_date_create_immutable_from_format)
9999
PHP_FE(date_parse, arginfo_date_parse)
100100
PHP_FE(date_parse_from_format, arginfo_date_parse_from_format)
101101
PHP_FE(date_get_last_errors, arginfo_date_get_last_errors)

‎ext/date/php_date.stub.php

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -31,18 +31,16 @@ function localtime(int $timestamp = UNKNOWN, bool $associative = false): array {
3131

3232
function getdate(int $timestamp = UNKNOWN): array {}
3333

34-
/** @return DateTime|false */
35-
function date_create(string $time = "now", ?DateTimeZone $timezone = null) {}
34+
function date_create(string $time = "now", ?DateTimeZone $timezone = null): DateTime|false {}
3635

37-
/** @return DateTime|false */
38-
function date_create_immutable(string $time = "now", ?DateTimeZone $timezone = null) {}
36+
function date_create_immutable(
37+
string $time = "now", ?DateTimeZone $timezone = null): DateTimeImmutable|false {}
3938

40-
/** @return DateTime|false */
41-
function date_create_from_format(string $format, string $time, ?DateTimeZone $timezone = null) {}
39+
function date_create_from_format(
40+
string $format, string $time, ?DateTimeZone $timezone = null): DateTime|false {}
4241

43-
/** @return DateTimeImmutable|false */
4442
function date_create_immutable_from_format(
45-
string $format, string $time, ?DateTimeZone $timezone = null) {}
43+
string $format, string $time, ?DateTimeZone $timezone = null): DateTimeImmutable|false {}
4644

4745
function date_parse(string $date): array {}
4846

@@ -52,15 +50,13 @@ function date_get_last_errors(): array|false {}
5250

5351
function date_format(DateTimeInterface $object, string $format): string {}
5452

55-
/** @return DateTime|false */
56-
function date_modify(DateTime $object, string $modify) {}
53+
function date_modify(DateTime $object, string $modify): DateTime|false {}
5754

5855
function date_add(DateTime $object, DateInterval $interval): DateTime {}
5956

6057
function date_sub(DateTime $object, DateInterval $interval): DateTime {}
6158

62-
/** @return DateTimeZone|false */
63-
function date_timezone_get(DateTimeInterface $object) {}
59+
function date_timezone_get(DateTimeInterface $object): DateTimeZone|false {}
6460

6561
function date_timezone_set(DateTimeInterface $object, DateTimeZone $timezone): DateTime {}
6662

@@ -80,8 +76,7 @@ function date_timestamp_set(DateTime $object, int $timestamp): DateTime {}
8076

8177
function date_timestamp_get(DateTimeInterface $object): int|false {}
8278

83-
/** @return DateTimeZone|false */
84-
function timezone_open(string $timezone) {}
79+
function timezone_open(string $timezone): DateTimeZone|false {}
8580

8681
function timezone_name_get(DateTimeZone $object): string {}
8782

@@ -100,8 +95,7 @@ function timezone_abbreviations_list(): array {}
10095

10196
function timezone_version_get(): string {}
10297

103-
/** @return DateInterval|false */
104-
function date_interval_create_from_date_string(string $time) {}
98+
function date_interval_create_from_date_string(string $time): DateInterval|false {}
10599

106100
function date_interval_format(DateInterval $object, string $format): string {}
107101

‎ext/date/php_date_arginfo.h

Lines changed: 32 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -53,20 +53,27 @@ ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_getdate, 0, 0, IS_ARRAY, 0)
5353
ZEND_ARG_TYPE_INFO(0, timestamp, IS_LONG, 0)
5454
ZEND_END_ARG_INFO()
5555

56-
ZEND_BEGIN_ARG_INFO_EX(arginfo_date_create, 0, 0, 0)
56+
ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_date_create, 0, 0, DateTime, MAY_BE_FALSE)
5757
ZEND_ARG_TYPE_INFO(0, time, IS_STRING, 0)
5858
ZEND_ARG_OBJ_INFO(0, timezone, DateTimeZone, 1)
5959
ZEND_END_ARG_INFO()
6060

61-
#define arginfo_date_create_immutable arginfo_date_create
61+
ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_date_create_immutable, 0, 0, DateTimeImmutable, MAY_BE_FALSE)
62+
ZEND_ARG_TYPE_INFO(0, time, IS_STRING, 0)
63+
ZEND_ARG_OBJ_INFO(0, timezone, DateTimeZone, 1)
64+
ZEND_END_ARG_INFO()
6265

63-
ZEND_BEGIN_ARG_INFO_EX(arginfo_date_create_from_format, 0, 0, 2)
66+
ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_date_create_from_format, 0, 2, DateTime, MAY_BE_FALSE)
6467
ZEND_ARG_TYPE_INFO(0, format, IS_STRING, 0)
6568
ZEND_ARG_TYPE_INFO(0, time, IS_STRING, 0)
6669
ZEND_ARG_OBJ_INFO(0, timezone, DateTimeZone, 1)
6770
ZEND_END_ARG_INFO()
6871

69-
#define arginfo_date_create_immutable_from_format arginfo_date_create_from_format
72+
ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_date_create_immutable_from_format, 0, 2, DateTimeImmutable, MAY_BE_FALSE)
73+
ZEND_ARG_TYPE_INFO(0, format, IS_STRING, 0)
74+
ZEND_ARG_TYPE_INFO(0, time, IS_STRING, 0)
75+
ZEND_ARG_OBJ_INFO(0, timezone, DateTimeZone, 1)
76+
ZEND_END_ARG_INFO()
7077

7178
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_date_parse, 0, 1, IS_ARRAY, 0)
7279
ZEND_ARG_TYPE_INFO(0, date, IS_STRING, 0)
@@ -85,7 +92,7 @@ ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_date_format, 0, 2, IS_STRING, 0)
8592
ZEND_ARG_TYPE_INFO(0, format, IS_STRING, 0)
8693
ZEND_END_ARG_INFO()
8794

88-
ZEND_BEGIN_ARG_INFO_EX(arginfo_date_modify, 0, 0, 2)
95+
ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_date_modify, 0, 2, DateTime, MAY_BE_FALSE)
8996
ZEND_ARG_OBJ_INFO(0, object, DateTime, 0)
9097
ZEND_ARG_TYPE_INFO(0, modify, IS_STRING, 0)
9198
ZEND_END_ARG_INFO()
@@ -97,7 +104,7 @@ ZEND_END_ARG_INFO()
97104

98105
#define arginfo_date_sub arginfo_date_add
99106

100-
ZEND_BEGIN_ARG_INFO_EX(arginfo_date_timezone_get, 0, 0, 1)
107+
ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_date_timezone_get, 0, 1, DateTimeZone, MAY_BE_FALSE)
101108
ZEND_ARG_OBJ_INFO(0, object, DateTimeInterface, 0)
102109
ZEND_END_ARG_INFO()
103110

@@ -147,7 +154,7 @@ ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_date_timestamp_get, 0, 1, MAY_BE
147154
ZEND_ARG_OBJ_INFO(0, object, DateTimeInterface, 0)
148155
ZEND_END_ARG_INFO()
149156

150-
ZEND_BEGIN_ARG_INFO_EX(arginfo_timezone_open, 0, 0, 1)
157+
ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_timezone_open, 0, 1, DateTimeZone, MAY_BE_FALSE)
151158
ZEND_ARG_TYPE_INFO(0, timezone, IS_STRING, 0)
152159
ZEND_END_ARG_INFO()
153160

@@ -187,7 +194,7 @@ ZEND_END_ARG_INFO()
187194
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_timezone_version_get, 0, 0, IS_STRING, 0)
188195
ZEND_END_ARG_INFO()
189196

190-
ZEND_BEGIN_ARG_INFO_EX(arginfo_date_interval_create_from_date_string, 0, 0, 1)
197+
ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_date_interval_create_from_date_string, 0, 1, DateInterval, MAY_BE_FALSE)
191198
ZEND_ARG_TYPE_INFO(0, time, IS_STRING, 0)
192199
ZEND_END_ARG_INFO()
193200

@@ -237,7 +244,10 @@ ZEND_END_ARG_INFO()
237244

238245
#define arginfo_class_DateTimeInterface___wakeup arginfo_class_DateTimeInterface_getTimezone
239246

240-
#define arginfo_class_DateTime___construct arginfo_date_create
247+
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_DateTime___construct, 0, 0, 0)
248+
ZEND_ARG_TYPE_INFO(0, time, IS_STRING, 0)
249+
ZEND_ARG_OBJ_INFO(0, timezone, DateTimeZone, 1)
250+
ZEND_END_ARG_INFO()
241251

242252
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_DateTime___set_state, 0, 0, 1)
243253
ZEND_ARG_TYPE_INFO(0, array, IS_ARRAY, 0)
@@ -247,7 +257,11 @@ ZEND_BEGIN_ARG_INFO_EX(arginfo_class_DateTime_createFromImmutable, 0, 0, 1)
247257
ZEND_ARG_OBJ_INFO(0, object, DateTimeImmutable, 0)
248258
ZEND_END_ARG_INFO()
249259

250-
#define arginfo_class_DateTime_createFromFormat arginfo_date_create_from_format
260+
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_DateTime_createFromFormat, 0, 0, 2)
261+
ZEND_ARG_TYPE_INFO(0, format, IS_STRING, 0)
262+
ZEND_ARG_TYPE_INFO(0, time, IS_STRING, 0)
263+
ZEND_ARG_OBJ_INFO(0, timezone, DateTimeZone, 1)
264+
ZEND_END_ARG_INFO()
251265

252266
#define arginfo_class_DateTime_getLastErrors arginfo_class_DateTimeInterface_getTimezone
253267

@@ -288,15 +302,15 @@ ZEND_BEGIN_ARG_INFO_EX(arginfo_class_DateTime_setTimestamp, 0, 0, 1)
288302
ZEND_ARG_TYPE_INFO(0, timestamp, IS_LONG, 0)
289303
ZEND_END_ARG_INFO()
290304

291-
#define arginfo_class_DateTimeImmutable___construct arginfo_date_create
305+
#define arginfo_class_DateTimeImmutable___construct arginfo_class_DateTime___construct
292306

293307
#define arginfo_class_DateTimeImmutable___set_state arginfo_class_DateTime___set_state
294308

295309
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_DateTimeImmutable_createFromMutable, 0, 0, 1)
296310
ZEND_ARG_OBJ_INFO(0, object, DateTime, 0)
297311
ZEND_END_ARG_INFO()
298312

299-
#define arginfo_class_DateTimeImmutable_createFromFormat arginfo_date_create_from_format
313+
#define arginfo_class_DateTimeImmutable_createFromFormat arginfo_class_DateTime_createFromFormat
300314

301315
#define arginfo_class_DateTimeImmutable_getLastErrors arginfo_class_DateTimeInterface_getTimezone
302316

@@ -316,7 +330,9 @@ ZEND_END_ARG_INFO()
316330

317331
#define arginfo_class_DateTimeImmutable_setTimestamp arginfo_class_DateTime_setTimestamp
318332

319-
#define arginfo_class_DateTimeZone___construct arginfo_timezone_open
333+
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_DateTimeZone___construct, 0, 0, 1)
334+
ZEND_ARG_TYPE_INFO(0, timezone, IS_STRING, 0)
335+
ZEND_END_ARG_INFO()
320336

321337
#define arginfo_class_DateTimeZone_getName arginfo_class_DateTimeInterface_getTimezone
322338

@@ -346,7 +362,9 @@ ZEND_BEGIN_ARG_INFO_EX(arginfo_class_DateInterval___construct, 0, 0, 1)
346362
ZEND_ARG_TYPE_INFO(0, interval_spec, IS_STRING, 0)
347363
ZEND_END_ARG_INFO()
348364

349-
#define arginfo_class_DateInterval_createFromDateString arginfo_date_interval_create_from_date_string
365+
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_DateInterval_createFromDateString, 0, 0, 1)
366+
ZEND_ARG_TYPE_INFO(0, time, IS_STRING, 0)
367+
ZEND_END_ARG_INFO()
350368

351369
#define arginfo_class_DateInterval_format arginfo_class_DateTimeInterface_format
352370

‎scripts/dev/gen_stub.php

Lines changed: 53 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,10 @@ public function toTypeMask() {
131131
}
132132
}
133133

134+
public function toEscapedName(): string {
135+
return str_replace('\\', '\\\\', $this->name);
136+
}
137+
134138
public function equals(SimpleType $other) {
135139
return $this->name === $other->name
136140
&& $this->isBuiltin === $other->isBuiltin;
@@ -167,15 +171,6 @@ public function isNullable(): bool {
167171
return false;
168172
}
169173

170-
public function isBuiltinOnly(): bool {
171-
foreach ($this->types as $type) {
172-
if (!$type->isBuiltin) {
173-
return false;
174-
}
175-
}
176-
return true;
177-
}
178-
179174
public function getWithoutNull(): Type {
180175
return new Type(array_filter($this->types, function(SimpleType $type) {
181176
return !$type->isNull();
@@ -190,10 +185,20 @@ public function tryToSimpleType(): ?SimpleType {
190185
return null;
191186
}
192187

193-
public function toTypeMask(): string {
194-
return implode('|', array_map(function(SimpleType $type) {
195-
return $type->toTypeMask();
196-
}, $this->types));
188+
public function tryToRepresentableType(): ?RepresentableType {
189+
$classType = null;
190+
$builtinTypes = [];
191+
foreach ($this->types as $type) {
192+
if ($type->isBuiltin) {
193+
$builtinTypes[] = $type;
194+
} else if ($classType === null) {
195+
$classType = $type;
196+
} else {
197+
// We can only represent a single class type.
198+
return false;
199+
}
200+
}
201+
return new RepresentableType($classType, $builtinTypes);
197202
}
198203

199204
public static function equals(?Type $a, ?Type $b): bool {
@@ -215,6 +220,24 @@ public static function equals(?Type $a, ?Type $b): bool {
215220
}
216221
}
217222

223+
class RepresentableType {
224+
/** @var ?SimpleType $classType */
225+
public $classType;
226+
/** @var SimpleType[] $builtinTypes */
227+
public $builtinTypes;
228+
229+
public function __construct(?SimpleType $classType, array $builtinTypes) {
230+
$this->classType = $classType;
231+
$this->builtinTypes = $builtinTypes;
232+
}
233+
234+
public function toTypeMask(): string {
235+
return implode('|', array_map(function(SimpleType $type) {
236+
return $type->toTypeMask();
237+
}, $this->builtinTypes));
238+
}
239+
}
240+
218241
class ArgInfo {
219242
const SEND_BY_VAL = 0;
220243
const SEND_BY_REF = 1;
@@ -467,8 +490,7 @@ function funcInfoToCode(FuncInfo $funcInfo): string {
467490
$code = '';
468491
$returnType = $funcInfo->return->type;
469492
if ($returnType !== null) {
470-
$simpleReturnType = $returnType->tryToSimpleType();
471-
if ($simpleReturnType !== null) {
493+
if (null !== $simpleReturnType = $returnType->tryToSimpleType()) {
472494
if ($simpleReturnType->isBuiltin) {
473495
$code .= sprintf(
474496
"ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_%s, %d, %d, %s, %d)\n",
@@ -479,15 +501,23 @@ function funcInfoToCode(FuncInfo $funcInfo): string {
479501
$code .= sprintf(
480502
"ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(arginfo_%s, %d, %d, %s, %d)\n",
481503
$funcInfo->name, $funcInfo->return->byRef, $funcInfo->numRequiredArgs,
482-
str_replace('\\', '\\\\', $simpleReturnType->name), $returnType->isNullable()
504+
$simpleReturnType->toEscapedName(), $returnType->isNullable()
505+
);
506+
}
507+
} else if (null !== $representableType = $returnType->tryToRepresentableType()) {
508+
if ($representableType->classType !== null) {
509+
$code .= sprintf(
510+
"ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_%s, %d, %d, %s, %s)\n",
511+
$funcInfo->name, $funcInfo->return->byRef, $funcInfo->numRequiredArgs,
512+
$representableType->classType->toEscapedName(), $representableType->toTypeMask()
513+
);
514+
} else {
515+
$code .= sprintf(
516+
"ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_%s, %d, %d, %s)\n",
517+
$funcInfo->name, $funcInfo->return->byRef, $funcInfo->numRequiredArgs,
518+
$representableType->toTypeMask()
483519
);
484520
}
485-
} else if ($returnType->isBuiltinOnly()) {
486-
$code .= sprintf(
487-
"ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_%s, %d, %d, %s)\n",
488-
$funcInfo->name, $funcInfo->return->byRef, $funcInfo->numRequiredArgs,
489-
$returnType->toTypeMask()
490-
);
491521
} else {
492522
throw new Exception('Unimplemented');
493523
}
@@ -514,7 +544,7 @@ function funcInfoToCode(FuncInfo $funcInfo): string {
514544
$code .= sprintf(
515545
"\tZEND_%s_OBJ_INFO(%s, %s, %s, %d)\n",
516546
$argKind, $argInfo->getSendByString(), $argInfo->name,
517-
str_replace('\\', '\\\\', $simpleArgType->name), $argType->isNullable()
547+
$simpleArgType->toEscapedName(), $argType->isNullable()
518548
);
519549
}
520550
} else {

0 commit comments

Comments
 (0)