Skip to content
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

support ReturnCompletion AO #605

Merged
merged 1 commit into from
Sep 4, 2024
Merged

support ReturnCompletion AO #605

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion src/typechecker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,8 @@ export function typecheck(spec: Spec) {
const isCompletion =
returnType.kind === 'completion' ||
(returnType.kind === 'union' && returnType.types[0].kind === 'completion');
if (['Completion', 'ThrowCompletion', 'NormalCompletion'].includes(calleeName)) {
// prettier-ignore
if (['Completion', 'ThrowCompletion', 'NormalCompletion', 'ReturnCompletion'].includes(calleeName)) {
if (consumedAsCompletion) {
warn(
`${calleeName} clearly creates a Completion Record; it does not need to be marked as such, and it would not be useful to immediately unwrap its result`,
Expand Down
81 changes: 75 additions & 6 deletions test/typecheck.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,43 @@ describe('typechecking completions', () => {
let biblio;
before(async () => {
biblio = await getBiblio(`
<emu-clause id="normal-completion" type="abstract operation">
<h1>NormalCompletion ( _x_ )</h1>
<dl class="header"></dl>
<emu-clause id="sec-normalcompletion" type="abstract operation">
<h1>
NormalCompletion (
_value_: any value except a Completion Record,
): a normal completion
</h1>
<dl class="header">
</dl>
<emu-alg>
1. Return Completion Record { [[Type]]: ~normal~, [[Value]]: _value_, [[Target]]: ~empty~ }.
</emu-alg>
</emu-clause>

<emu-clause id="sec-throwcompletion" type="abstract operation">
<h1>
ThrowCompletion (
_value_: an ECMAScript language value,
): a throw completion
</h1>
<dl class="header">
</dl>
<emu-alg>
1. Return Completion Record { [[Type]]: ~throw~, [[Value]]: _value_, [[Target]]: ~empty~ }.
</emu-alg>
</emu-clause>

<emu-clause id="sec-returncompletion" type="abstract operation">
<h1>
ReturnCompletion (
_value_: any value except a Completion Record,
): a return completion
</h1>
<dl class="header">
</dl>
<emu-alg>
1. Return Completion Record { [[Type]]: ~return~, [[Value]]: _value_, [[Target]]: ~empty~ }.
</emu-alg>
</emu-clause>

<emu-clause id="sec-completion-ao" type="abstract operation">
Expand All @@ -29,6 +63,17 @@ describe('typechecking completions', () => {
1. Return _completionRecord_.
</emu-alg>
</emu-clause>

<emu-clause id="sec-examplecompletionao" type="abstract operation">
<h1>
ExampleCompletionAO (): a normal completion
</h1>
<dl class="header">
</dl>
<emu-alg>
1. Return Completion Record { [[Type]]: ~normal~, [[Value]]: 0, [[Target]]: ~empty~ }.
</emu-alg>
</emu-clause>
`);
});

Expand Down Expand Up @@ -98,19 +143,43 @@ describe('typechecking completions', () => {
extraBiblios: [biblio],
},
);

await assertLint(
positioned`
<emu-clause id="example" type="abstract operation">
<h1>ExampleAlg ( )</h1>
<dl class="header">
</dl>
<emu-alg>
1. Do something with Completion(${M}NormalCompletion(0)).
</emu-alg>
</emu-clause>
`,
{
ruleId: 'typecheck',
nodeType: 'emu-alg',
message:
'NormalCompletion clearly creates a Completion Record; it does not need to be marked as such, and it would not be useful to immediately unwrap its result',
},
{
extraBiblios: [biblio],
},
);
});

it('negative', async () => {
await assertLintFree(
`
<emu-clause id="example" type="abstract operation">
<h1>
ExampleAlg (): a normal completion containing a Number
ExampleAlg (): a Completion Record
</h1>
<dl class="header">
</dl>
<emu-alg>
1. Return NormalCompletion(0).
1. If some condition holds, return ThrowCompletion(*null*).
1. Else if some other condition holds, return ReturnCompletion(*null*).
1. Return NormalCompletion(*null*).
</emu-alg>
</emu-clause>

Expand Down Expand Up @@ -389,7 +458,7 @@ describe('typechecking completions', () => {
<dl class="header">
</dl>
<emu-alg>
1. Do something with Completion(NormalCompletion(0)).
1. Do something with Completion(ExampleCompletionAO()).
1. NOTE: This will not throw a *TypeError* exception.
1. Consider whether something is a return completion.
</emu-alg>
Expand Down
Loading