Skip to content

TupleGenerator #59627

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

TupleGenerator #59627

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce1368a
Add TupleGenerator
zojize Aug 14, 2024
2cfc2a2
Test TupleGenerator
zojize Aug 14, 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
54 changes: 54 additions & 0 deletions src/compiler/checker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1185,6 +1185,7 @@ interface IterationTypesResolver {
getGlobalIteratorObjectType: (reportErrors: boolean) => GenericType;
getGlobalGeneratorType: (reportErrors: boolean) => GenericType;
getGlobalBuiltinIteratorTypes: () => readonly GenericType[];
getGlobalTupleGeneratorType: (reportErrors: boolean) => GenericType;
resolveIterationType: (type: Type, errorNode: Node | undefined) => Type | undefined;
mustHaveANextMethodDiagnostic: DiagnosticMessage;
mustBeAMethodDiagnostic: DiagnosticMessage;
Expand Down Expand Up @@ -2171,6 +2172,7 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker {
getGlobalIterableIteratorType: getGlobalAsyncIterableIteratorType,
getGlobalIteratorObjectType: getGlobalAsyncIteratorObjectType,
getGlobalGeneratorType: getGlobalAsyncGeneratorType,
getGlobalTupleGeneratorType,
getGlobalBuiltinIteratorTypes: getGlobalBuiltinAsyncIteratorTypes,
resolveIterationType: (type, errorNode) => getAwaitedType(type, errorNode, Diagnostics.Type_of_await_operand_must_either_be_a_valid_promise_or_must_not_contain_a_callable_then_member),
mustHaveANextMethodDiagnostic: Diagnostics.An_async_iterator_must_have_a_next_method,
Expand All @@ -2187,6 +2189,7 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker {
getGlobalIterableIteratorType,
getGlobalIteratorObjectType,
getGlobalGeneratorType,
getGlobalTupleGeneratorType,
getGlobalBuiltinIteratorTypes,
resolveIterationType: (type, _errorNode) => type,
mustHaveANextMethodDiagnostic: Diagnostics.An_iterator_must_have_a_next_method,
Expand Down Expand Up @@ -2250,6 +2253,7 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker {
var deferredGlobalIterableIteratorType: GenericType | undefined;
var deferredGlobalIteratorObjectType: GenericType | undefined;
var deferredGlobalGeneratorType: GenericType | undefined;
var deferredGlobalTupleGeneratorType: GenericType | undefined;
var deferredGlobalIteratorYieldResultType: GenericType | undefined;
var deferredGlobalIteratorReturnResultType: GenericType | undefined;
var deferredGlobalAsyncIterableType: GenericType | undefined;
Expand Down Expand Up @@ -17044,6 +17048,10 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker {
return (deferredGlobalGeneratorType ||= getGlobalType("Generator" as __String, /*arity*/ 3, reportErrors)) || emptyGenericType;
}

function getGlobalTupleGeneratorType(reportErrors: boolean) {
return (deferredGlobalTupleGeneratorType ||= getGlobalType("TupleGenerator" as __String, /*arity*/ 3, reportErrors)) || emptyGenericType;
}

function getGlobalIteratorYieldResultType(reportErrors: boolean) {
return (deferredGlobalIteratorYieldResultType ||= getGlobalType("IteratorYieldResult" as __String, /*arity*/ 1, reportErrors)) || emptyGenericType;
}
Expand Down Expand Up @@ -32505,10 +32513,15 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker {
checkExternalEmitHelpers(e, compilerOptions.downlevelIteration ? ExternalEmitHelpers.SpreadIncludes : ExternalEmitHelpers.SpreadArray);
}
const spreadType = checkExpression((e as SpreadElement).expression, checkMode, forceTuple);
let maybeTuple: Type | undefined;
if (isArrayLikeType(spreadType)) {
elementTypes.push(spreadType);
elementFlags.push(ElementFlags.Variadic);
}
else if ((maybeTuple = getTupleTypeFromIterableOrUndefined(spreadType))) {
elementTypes.push(maybeTuple);
elementFlags.push(ElementFlags.Variadic);
}
else if (inDestructuringPattern) {
// Given the following situation:
// var c: {};
Expand Down Expand Up @@ -35434,6 +35447,18 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker {
effectiveArgs.push(syntheticArg);
});
}
else if (spreadType) {
const spreadTypeArgs = getTupleTypeFromIterableOrUndefined(spreadType);
if (spreadTypeArgs) {
forEach(getElementTypes(spreadTypeArgs), (t, i) => {
const flags = spreadTypeArgs.target.elementFlags[i];
const syntheticArg = createSyntheticExpression(arg, flags & ElementFlags.Rest ? createArrayType(t) : t, !!(flags & ElementFlags.Variable), spreadTypeArgs.target.labeledElementDeclarations?.[i]);
effectiveArgs.push(syntheticArg);
});
} else {
effectiveArgs.push(arg);
}
}
else {
effectiveArgs.push(arg);
}
Expand All @@ -35443,6 +35468,35 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker {
return args;
}

function getTupleTypeFromIterableOrUndefined(type: Type) {
let maybeTuple = isReferenceToType(type, syncIterationTypesResolver.getGlobalTupleGeneratorType(/*reportErrors*/ false))
? getTypeArguments(type as GenericType)[0]
: undefined;

if (!maybeTuple) {
const method = getPropertyOfType(type, getPropertyNameForKnownSymbolName(syncIterationTypesResolver.iteratorSymbolName));
const methodType = method && !(method.flags & SymbolFlags.Optional) ? getTypeOfSymbol(method) : undefined;

if (isTypeAny(methodType)) {
return;
}

const signatures = methodType && getSignaturesOfType(methodType, SignatureKind.Call);
if (!some(signatures)) {
return;
}

const returnTypes = getIntersectionType(map(signatures, getReturnTypeOfSignature))
if (isReferenceToType(returnTypes, syncIterationTypesResolver.getGlobalTupleGeneratorType(/*reportErrors*/ false))) {
maybeTuple = getTypeArguments(returnTypes as GenericType)[0];
}
}

if (maybeTuple && isTupleType(maybeTuple)) {
return maybeTuple;
}
}

/**
* Returns the synthetic argument list for a decorator invocation.
*/
Expand Down
3 changes: 3 additions & 0 deletions src/lib/es2015.generator.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ interface Generator<T = unknown, TReturn = any, TNext = any> extends IteratorObj
[Symbol.iterator](): Generator<T, TReturn, TNext>;
}

interface TupleGenerator<Tuple extends any[] = unknown[], TReturn = any, TNext = any>
extends Generator<Tuple extends (infer T)[] ? T : unknown, TReturn, TNext> {}

interface GeneratorFunction {
/**
* Creates a new Generator object.
Expand Down
25 changes: 25 additions & 0 deletions tests/baselines/reference/spreadTupleGenerator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
//// [tests/cases/compiler/spreadTupleGenerator.ts] ////

//// [spreadTupleGenerator.ts]
class V {
*[Symbol.iterator](): TupleGenerator<[number, number]> {
yield 1; yield 2;
}
}

declare const v: V;
declare function foo(x: number, y: number): void;

foo(...v);
const a: [number, number] = [...v];


//// [spreadTupleGenerator.js]
class V {
*[Symbol.iterator]() {
yield 1;
yield 2;
}
}
foo(...v);
const a = [...v];
34 changes: 34 additions & 0 deletions tests/baselines/reference/spreadTupleGenerator.symbols
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
//// [tests/cases/compiler/spreadTupleGenerator.ts] ////

=== spreadTupleGenerator.ts ===
class V {
>V : Symbol(V, Decl(spreadTupleGenerator.ts, 0, 0))

*[Symbol.iterator](): TupleGenerator<[number, number]> {
>[Symbol.iterator] : Symbol(V[Symbol.iterator], Decl(spreadTupleGenerator.ts, 0, 9))
>Symbol.iterator : Symbol(SymbolConstructor.iterator, Decl(lib.es2015.iterable.d.ts, --, --))
>Symbol : Symbol(Symbol, Decl(lib.es5.d.ts, --, --), Decl(lib.es2015.symbol.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --), Decl(lib.es2019.symbol.d.ts, --, --))
>iterator : Symbol(SymbolConstructor.iterator, Decl(lib.es2015.iterable.d.ts, --, --))
>TupleGenerator : Symbol(TupleGenerator, Decl(lib.es2015.generator.d.ts, --, --))

yield 1; yield 2;
}
}

declare const v: V;
>v : Symbol(v, Decl(spreadTupleGenerator.ts, 6, 13))
>V : Symbol(V, Decl(spreadTupleGenerator.ts, 0, 0))

declare function foo(x: number, y: number): void;
>foo : Symbol(foo, Decl(spreadTupleGenerator.ts, 6, 19))
>x : Symbol(x, Decl(spreadTupleGenerator.ts, 7, 21))
>y : Symbol(y, Decl(spreadTupleGenerator.ts, 7, 31))

foo(...v);
>foo : Symbol(foo, Decl(spreadTupleGenerator.ts, 6, 19))
>v : Symbol(v, Decl(spreadTupleGenerator.ts, 6, 13))

const a: [number, number] = [...v];
>a : Symbol(a, Decl(spreadTupleGenerator.ts, 10, 5))
>v : Symbol(v, Decl(spreadTupleGenerator.ts, 6, 13))

59 changes: 59 additions & 0 deletions tests/baselines/reference/spreadTupleGenerator.types
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
//// [tests/cases/compiler/spreadTupleGenerator.ts] ////

=== spreadTupleGenerator.ts ===
class V {
>V : V
> : ^

*[Symbol.iterator](): TupleGenerator<[number, number]> {
>[Symbol.iterator] : () => TupleGenerator<[number, number]>
> : ^^^^^^
>Symbol.iterator : unique symbol
> : ^^^^^^^^^^^^^
>Symbol : SymbolConstructor
> : ^^^^^^^^^^^^^^^^^
>iterator : unique symbol
> : ^^^^^^^^^^^^^

yield 1; yield 2;
>yield 1 : any
>1 : 1
> : ^
>yield 2 : any
>2 : 2
> : ^
}
}

declare const v: V;
>v : V
> : ^

declare function foo(x: number, y: number): void;
>foo : (x: number, y: number) => void
> : ^ ^^ ^^ ^^ ^^^^^
>x : number
> : ^^^^^^
>y : number
> : ^^^^^^

foo(...v);
>foo(...v) : void
> : ^^^^
>foo : (x: number, y: number) => void
> : ^ ^^ ^^ ^^ ^^^^^
>...v : number
> : ^^^^^^
>v : V
> : ^

const a: [number, number] = [...v];
>a : [number, number]
> : ^^^^^^^^^^^^^^^^
>[...v] : [number, number]
> : ^^^^^^^^^^^^^^^^
>...v : number
> : ^^^^^^
>v : V
> : ^

14 changes: 14 additions & 0 deletions tests/cases/compiler/spreadTupleGenerator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
// @lib: esnext
// @target: esnext

class V {
*[Symbol.iterator](): TupleGenerator<[number, number]> {
yield 1; yield 2;
}
}

declare const v: V;
declare function foo(x: number, y: number): void;

foo(...v);
const a: [number, number] = [...v];
Loading