tla-ts 0.0.3-dev.3cf2ad0 → 0.0.3-dev.3ef4193

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (84) hide show
  1. package/README.md +16 -2
  2. package/dist/cli.cjs +1 -1
  3. package/dist/cli.js +1 -1
  4. package/dist/index.cjs +1 -1
  5. package/dist/index.d.cts +158 -8
  6. package/dist/index.d.ts +158 -8
  7. package/dist/index.js +1 -1
  8. package/dist/parallel-worker.cjs +1 -1
  9. package/dist/parallel-worker.js +2 -2
  10. package/dist/parallel.cjs +1 -1
  11. package/dist/parallel.js +2 -2
  12. package/dist/run-cli.cjs +1351 -19
  13. package/dist/run-cli.js +1351 -19
  14. package/dist/transfer.cjs +88 -18
  15. package/dist/transfer.js +88 -18
  16. package/package.json +5 -1
  17. package/src/ast.ts +146 -6
  18. package/src/bags.ts +4 -7
  19. package/src/builtins.ts +29 -11
  20. package/src/bundled-modules.ts +3 -3
  21. package/src/canonical.ts +4 -3
  22. package/src/check.ts +1539 -235
  23. package/src/cli-options.ts +11 -5
  24. package/src/cli.ts +8 -1
  25. package/src/codegen.ts +77 -37
  26. package/src/config.ts +252 -179
  27. package/src/dependencies.ts +2 -2
  28. package/src/environment.ts +524 -140
  29. package/src/errors.ts +224 -3
  30. package/src/evaluate.ts +796 -246
  31. package/src/exit-codes.ts +22 -43
  32. package/src/index.ts +1 -0
  33. package/src/instances.ts +19 -16
  34. package/src/java-overrides.ts +104 -25
  35. package/src/levels.ts +191 -45
  36. package/src/lexer.ts +37 -5
  37. package/src/live-check.ts +828 -0
  38. package/src/liveness.ts +218 -572
  39. package/src/obligation-expression.ts +2 -2
  40. package/src/obligation-source.ts +2 -0
  41. package/src/parallel-worker.ts +13 -4
  42. package/src/parallel.ts +73 -6
  43. package/src/parser.ts +436 -144
  44. package/src/pcal-ast.ts +770 -0
  45. package/src/pcal-parse.ts +1523 -0
  46. package/src/pcal-tokenize.ts +516 -0
  47. package/src/pcal-translate.ts +1230 -0
  48. package/src/pcal-validate.ts +454 -0
  49. package/src/randomization.ts +24 -7
  50. package/src/resolve.ts +1424 -415
  51. package/src/run-cli.ts +1200 -143
  52. package/src/runtime.ts +19 -1
  53. package/src/sany-builtins.ts +147 -0
  54. package/src/sany-generator.ts +3112 -0
  55. package/src/sany-levels.ts +1208 -0
  56. package/src/sany-lexer.ts +545 -0
  57. package/src/sany-linter.ts +122 -0
  58. package/src/sany-modules.ts +1398 -0
  59. package/src/sany-nodes.ts +463 -0
  60. package/src/sany-parse-error.ts +2161 -0
  61. package/src/sany-report.ts +354 -0
  62. package/src/sany-selectors.ts +738 -0
  63. package/src/sany-source.ts +248 -0
  64. package/src/sany-xml.ts +1017 -0
  65. package/src/spec-description.ts +42 -11
  66. package/src/standard-modules.ts +200 -148
  67. package/src/standard-ranges.ts +116 -0
  68. package/src/state-graph.ts +180 -0
  69. package/src/subexpressions.ts +231 -171
  70. package/src/substitution-levels.ts +38 -17
  71. package/src/successors.ts +219 -107
  72. package/src/symmetry.ts +189 -53
  73. package/src/tableau.ts +54 -25
  74. package/src/tlc-ext.ts +42 -29
  75. package/src/tlc-messages.ts +329 -0
  76. package/src/tlc-module.ts +52 -43
  77. package/src/tlc-order.ts +73 -9
  78. package/src/tlc-random.ts +37 -9
  79. package/src/tlc-replay.ts +655 -0
  80. package/src/tlc-summary.ts +20 -5
  81. package/src/tlc-version.ts +18 -0
  82. package/src/transfer.ts +15 -3
  83. package/src/value-sources.ts +29 -0
  84. package/src/values.ts +708 -180
package/src/resolve.ts CHANGED
@@ -1,46 +1,124 @@
1
- import type {
2
- AssumeProve,
3
- Bound,
4
- BoundPattern,
5
- Definition,
6
- Expression,
7
- Instance,
8
- Module,
9
- NewSymbol,
10
- OperatorParam,
11
- Proof,
12
- ProofStep,
13
- SourceLocation,
14
- Theorem,
1
+ import {
2
+ getChildren,
3
+ isLocallyResolved,
4
+ type AssumeProve,
5
+ type Bound,
6
+ type BoundPattern,
7
+ type Declaration,
8
+ type Definition,
9
+ type Expression,
10
+ type Fact,
11
+ type Instance,
12
+ type LabelExpression,
13
+ type Module,
14
+ type NewSymbol,
15
+ type OperatorParam,
16
+ type Proof,
17
+ type ProofStep,
18
+ type Selector,
19
+ type SourceLocation,
20
+ type SourceRange,
21
+ type Theorem,
15
22
  } from "./ast";
16
- import { TlaSyntaxError } from "./errors";
17
- import { getChildren, isLocallyResolved } from "./evaluate";
23
+ import { formatRange, TlaSyntaxError, type SanyError } from "./errors";
18
24
 
19
- export interface ModuleSymbol {
20
- key: string;
25
+ // The kinds of symbol SANY tells apart when it binds a name twice. A parameter is also a bound name,
26
+ // and a NEW symbol has a kind for each level.
27
+ export type SymbolKind =
28
+ | "Builtin"
29
+ | "Constant"
30
+ | "Variable"
31
+ | "Definition"
32
+ | "Instance"
33
+ | "Theorem"
34
+ | "Parameter"
35
+ | `New${NewSymbol["level"]}`;
36
+
37
+ // range is where SANY reports the symbol, and two symbols at one range are one node to SANY. params
38
+ // holds the arity of each parameter of a defined operator.
39
+ export interface Binding {
40
+ kind: SymbolKind;
21
41
  arity: number;
22
- declaration?: "Constant" | "Variable";
42
+ params?: number[];
43
+ range?: SourceRange;
44
+ }
45
+
46
+ export interface ModuleSymbol extends Binding {
47
+ key: string;
23
48
  }
24
49
 
25
50
  export type Symbols = Map<string, ModuleSymbol>;
26
51
 
27
- interface LocalName {
52
+ // A named theorem or proof step whose parts a name such as foo!lab or <1>2!1 selects. isInProof
53
+ // holds while SANY analyzes the proof of the theorem or step.
54
+ interface Goal {
55
+ statement: Expression | AssumeProve;
56
+ isSuffices: boolean;
57
+ isInProof: boolean;
58
+ }
59
+
60
+ // isPending holds for an operator a RECURSIVE declaration names until its definition.
61
+ interface LocalName extends Binding {
28
62
  name: string;
29
- arity: number;
30
63
  parent: LocalName | undefined;
64
+ goal?: Goal;
65
+ isPending?: boolean;
66
+ }
67
+
68
+ // A name the module binds, from position on.
69
+ interface ModuleBinding extends Binding {
70
+ position: SourceLocation;
71
+ isPending?: boolean;
31
72
  }
32
73
 
74
+ // errors and warnings collect what SANY reports while it goes on analyzing the unit, and bindings
75
+ // holds the names the module binds. A label may appear where hasLabelScope holds, in a definition, a
76
+ // named theorem, or a numbered step, except where isLabelForbidden holds, in the scope of a NEW in a
77
+ // nested ASSUME, or where isInExcept holds, in the new value of an EXCEPT. labelParams holds the
78
+ // names bound since the innermost definition, label, or step, which a label must take as parameters,
79
+ // and labels the labels there. isGenerated holds in a definition tla-ts generates for a LET INSTANCE,
80
+ // and in a subexpression that a name selects, which SANY analyzes where it is defined.
81
+ // getInstance gives what an INSTANCE in a LET or a proof instantiates.
33
82
  interface Unit {
34
83
  imported: Symbols;
84
+ getInstance: (instance: Instance) => InstancedModule;
35
85
  definitions: Map<string, Definition>;
36
86
  getKey: (definition: Definition) => string;
37
87
  location: SourceLocation;
38
88
  self: Definition | undefined;
39
89
  facts: Set<string>;
90
+ goals: Map<string, Goal>;
91
+ bindings: Map<string, ModuleBinding>;
92
+ errors: SanyError[];
93
+ warnings: SanyError[];
94
+ hasLabelScope: boolean;
95
+ isLabelForbidden: boolean;
96
+ isInExcept: boolean;
97
+ labelParams: string[];
98
+ labels: Set<string>;
99
+ isGenerated: boolean;
100
+ }
101
+
102
+ interface SelectionError {
103
+ args: Expression[];
104
+ error: SanyError;
40
105
  }
41
106
 
107
+ interface SelectionState {
108
+ node: Expression | NewSymbol | AssumeProve;
109
+ isGoal: boolean;
110
+ isSufficesOpen: boolean;
111
+ }
112
+
113
+ type Reference = Expression & { kind: "Identifier" | "Apply" | "Subexpression" };
114
+
42
115
  export const LOCAL_RESOLUTION = { kind: "Local" } as const;
43
116
 
117
+ // The subexpressions that names select, and for a name that selects none, the error SANY reports and
118
+ // the arguments it analyzes before it.
119
+ export const selections = new WeakSet<Expression>();
120
+ export const selectionErrors = new WeakMap<Expression, SelectionError>();
121
+
44
122
  const renamedArities = new WeakMap<Expression, number>();
45
123
 
46
124
  export const KEY_SEPARATOR = "@";
@@ -52,7 +130,7 @@ const isKey = (name: string) => {
52
130
  };
53
131
 
54
132
  const CORE_SYMBOLS: Symbols = new Map(
55
- ["~>", "-+->", "\\cdot"].map((name) => [name, { key: name, arity: 2 }]),
133
+ ["~>", "-+->", "\\cdot"].map((name) => [name, { key: name, arity: 2, kind: "Builtin" }]),
56
134
  );
57
135
 
58
136
  export const isBefore = (left: SourceLocation, right: SourceLocation) =>
@@ -61,6 +139,9 @@ export const isBefore = (left: SourceLocation, right: SourceLocation) =>
61
139
  export const getArity = (definition: Definition) =>
62
140
  definition.kind === "Operator" ? definition.params.length : 0;
63
141
 
142
+ export const getParamArities = (definition: Definition) =>
143
+ definition.kind === "Operator" ? definition.params.map((param) => param.arity) : [];
144
+
64
145
  const isInstantiated = (definition: Definition) => definition.name.includes("!");
65
146
 
66
147
  const lookupLocal = (scope: LocalName | undefined, name: string) => {
@@ -70,12 +151,99 @@ const lookupLocal = (scope: LocalName | undefined, name: string) => {
70
151
  return undefined;
71
152
  };
72
153
 
73
- const bindNames = (scope: LocalName | undefined, names: string[], arity = 0) =>
74
- names.reduce<LocalName | undefined>((parent, name) => ({ name, arity, parent }), scope);
154
+ // A name the module binds before the unit and before the range, which a copy of a subexpression
155
+ // that a reference selects keeps from its definition.
156
+ const getModuleBinding = (name: string, unit: Unit, range: SourceRange | undefined) => {
157
+ const binding = unit.bindings.get(name);
158
+ return binding &&
159
+ isBefore(binding.position, unit.location) &&
160
+ (!range || isBefore(binding.position, range.start))
161
+ ? binding
162
+ : undefined;
163
+ };
164
+
165
+ const isSameRange = (left: SourceRange | undefined, right: SourceRange | undefined) =>
166
+ left !== undefined && right !== undefined && formatRange(left) === formatRange(right);
167
+
168
+ // SymbolTable.addSymbol binds a name nothing binds yet. It rejects a built-in operator, a parameter
169
+ // or bound name already in use, and a symbol of another kind or arity than the one bound, and warns
170
+ // of any other duplicate. tla-ts binds a symbol SANY never sees, such as one it generates. Tells
171
+ // whether to bind the added symbol.
172
+ const isBindable = (name: string, current: Binding | undefined, added: Binding, unit: Unit) => {
173
+ if (current === undefined) return true;
174
+ if (isSameRange(current.range, added.range)) return false;
175
+ const range = added.range;
176
+ if (range === undefined || unit.isGenerated || (current.kind !== "Builtin" && !current.range)) {
177
+ return true;
178
+ }
179
+ const location = formatRange(range);
180
+ const existing = current.range && formatRange(current.range);
181
+ if (current.kind === "Builtin") {
182
+ unit.errors.push({
183
+ location,
184
+ message: `Symbol ${name} is a built-in operator, and cannot be redefined.`,
185
+ });
186
+ } else if (
187
+ added.kind === "Parameter" ||
188
+ current.kind !== added.kind ||
189
+ current.arity !== added.arity
190
+ ) {
191
+ unit.errors.push({
192
+ location,
193
+ message: `Multiply-defined symbol '${name}': this definition or declaration conflicts \nwith the one at ${existing}.`,
194
+ });
195
+ } else {
196
+ unit.warnings.push({
197
+ location,
198
+ message: `Multiple declarations or definitions for symbol ${name}. \nThis duplicates the one at ${existing}.`,
199
+ });
200
+ }
201
+ return false;
202
+ };
75
203
 
76
- const bindParams = (scope: LocalName | undefined, params: OperatorParam[]) =>
77
- params.reduce<LocalName | undefined>(
78
- (parent, param) => ({ name: param.name, arity: param.arity, parent }),
204
+ const bindName = (
205
+ scope: LocalName | undefined,
206
+ name: string,
207
+ added: Binding,
208
+ unit: Unit,
209
+ ): LocalName | undefined =>
210
+ isBindable(
211
+ name,
212
+ lookupLocal(scope, name) ?? getModuleBinding(name, unit, added.range),
213
+ added,
214
+ unit,
215
+ )
216
+ ? { ...added, name, parent: scope }
217
+ : scope;
218
+
219
+ // Binds the names of a module from the unit on.
220
+ const bindModuleName = (name: string, added: Binding, unit: Unit) => {
221
+ if (isBindable(name, unit.bindings.get(name), added, unit)) {
222
+ unit.bindings.set(name, { ...added, position: unit.location });
223
+ }
224
+ };
225
+
226
+ const bindNames = (
227
+ scope: LocalName | undefined,
228
+ names: string[],
229
+ ranges: SourceRange[] | undefined,
230
+ unit: Unit,
231
+ ) =>
232
+ names.reduce(
233
+ (parent, name, index) =>
234
+ bindName(parent, name, { kind: "Parameter", arity: 0, range: ranges?.[index] }, unit),
235
+ scope,
236
+ );
237
+
238
+ const bindParams = (scope: LocalName | undefined, params: OperatorParam[], unit: Unit) =>
239
+ params.reduce(
240
+ (parent, param) =>
241
+ bindName(
242
+ parent,
243
+ param.name,
244
+ { kind: "Parameter", arity: param.arity, range: param.location?.range },
245
+ unit,
246
+ ),
79
247
  scope,
80
248
  );
81
249
 
@@ -98,10 +266,33 @@ const getVisibleDefinition = (name: string, unit: Unit) => {
98
266
  const findSymbol = (name: string, unit: Unit): ModuleSymbol | undefined => {
99
267
  const definition = getVisibleDefinition(name, unit);
100
268
  return definition
101
- ? { key: unit.getKey(definition), arity: getArity(definition) }
269
+ ? {
270
+ key: unit.getKey(definition),
271
+ arity: getArity(definition),
272
+ params: getParamArities(definition),
273
+ kind: "Definition",
274
+ }
102
275
  : unit.imported.get(name);
103
276
  };
104
277
 
278
+ const findBinding = (name: string, scope: LocalName | undefined, unit: Unit): Binding | undefined =>
279
+ lookupLocal(scope, name) ?? findSymbol(name, unit);
280
+
281
+ // SANY reports a name at the range of its text.
282
+ const getNameRange = (location: SourceLocation, name: string): SourceRange => ({
283
+ module: location.range?.module ?? "",
284
+ start: location,
285
+ end: { line: location.line, column: location.column + name.length - 1 },
286
+ });
287
+
288
+ // SANY reports an operator symbol applied to operands as one it cannot resolve.
289
+ const getFixity = (expression: Expression) => {
290
+ if (expression.kind !== "Apply") return undefined;
291
+ if (expression.args.length === 2) return "infix";
292
+ if (expression.args.length !== 1) return undefined;
293
+ return isBefore(expression.location, expression.args[0].location) ? "prefix" : "postfix";
294
+ };
295
+
105
296
  // SANY names an undefined operator symbol such as + differently from an undefined identifier.
106
297
  const isOperatorSymbol = (name: string) =>
107
298
  name[0].toLowerCase() === name[0].toUpperCase() &&
@@ -111,6 +302,407 @@ const isOperatorSymbol = (name: string) =>
111
302
  const isStepName = (name: string) =>
112
303
  name.startsWith("<") && ((name[1] >= "0" && name[1] <= "9") || name[1] === "*");
113
304
 
305
+ export const getOperandIndex = (operand: number | "<<" | ">>", count: number) => {
306
+ if (typeof operand === "number") return operand >= 1 && operand <= count ? operand - 1 : -1;
307
+ if (operand === "<<") return count > 0 ? 0 : -1;
308
+ return count === 2 ? 1 : -1;
309
+ };
310
+
311
+ // The parts of a name such as F(x)!l(y), each with its own arguments. counts holds the number each
312
+ // part takes, when a part before the last takes some.
313
+ export const getNameSelectors = (
314
+ name: string,
315
+ args: Expression[],
316
+ counts: number[] | undefined,
317
+ ): Selector[] => {
318
+ const parts = name.split("!");
319
+ const partCounts =
320
+ counts ?? parts.map((_, index) => (index === parts.length - 1 ? args.length : 0));
321
+ return parts.map((part, index) => {
322
+ const start = partCounts.slice(0, index).reduce((sum, count) => sum + count, 0);
323
+ return { kind: "Name", name: part, args: args.slice(start, start + partCounts[index]) };
324
+ });
325
+ };
326
+
327
+ const getSelectors = (reference: Reference): Selector[] =>
328
+ reference.kind === "Subexpression"
329
+ ? reference.selectors
330
+ : reference.kind === "Identifier"
331
+ ? getNameSelectors(reference.name, [], undefined)
332
+ : getNameSelectors(reference.operator, reference.args, reference.argumentCounts);
333
+
334
+ const getBoundSets = (bounds: Bound[]) =>
335
+ bounds
336
+ .filter((bound, index) => index === 0 || bounds[index - 1].set !== bound.set)
337
+ .map((bound) => bound.set);
338
+
339
+ // The names a binder binds, its body, and the sets it binds them to, which a selector such as !1
340
+ // chooses from.
341
+ export const getBinder = (
342
+ expression: Expression,
343
+ ): { names: string[]; body: Expression; sets: Expression[] } | undefined => {
344
+ switch (expression.kind) {
345
+ case "Forall":
346
+ case "Exists":
347
+ case "FunctionConstruction":
348
+ return {
349
+ names: getBoundNames(expression.bounds),
350
+ body: expression.body,
351
+ sets: getBoundSets(expression.bounds),
352
+ };
353
+ case "SetMap":
354
+ return {
355
+ names: getBoundNames(expression.bounds),
356
+ body: expression.expression,
357
+ sets: getBoundSets(expression.bounds),
358
+ };
359
+ case "SetFilter":
360
+ return {
361
+ names: getPatternNames(expression.bound.pattern),
362
+ body: expression.predicate,
363
+ sets: [expression.bound.set],
364
+ };
365
+ case "Choose":
366
+ return {
367
+ names: getPatternNames(expression.pattern),
368
+ body: expression.body,
369
+ sets: expression.set ? [expression.set] : [],
370
+ };
371
+ case "UnboundedQuantifier":
372
+ case "Lambda":
373
+ return {
374
+ names: expression.kind === "Lambda" ? expression.params : expression.names,
375
+ body: expression.body,
376
+ sets: [],
377
+ };
378
+ default:
379
+ return undefined;
380
+ }
381
+ };
382
+
383
+ // The operands that a selector such as !1 chooses from, where they do not depend on bound names.
384
+ export const getOperands = (expression: Expression): Expression[] | undefined => {
385
+ switch (expression.kind) {
386
+ case "Apply":
387
+ return expression.args;
388
+ case "And":
389
+ case "Or":
390
+ return expression.operands;
391
+ case "If":
392
+ return [expression.condition, expression.consequent, expression.alternative];
393
+ case "Tuple":
394
+ case "SetEnumeration":
395
+ return expression.elements;
396
+ case "Record":
397
+ case "RecordSet":
398
+ return expression.fields.map((field) => field.value);
399
+ case "FunctionApplication":
400
+ return [
401
+ expression.function,
402
+ expression.args.length === 1
403
+ ? expression.args[0]
404
+ : { kind: "Tuple", elements: expression.args, location: expression.location },
405
+ ];
406
+ case "FieldAccess":
407
+ return [
408
+ expression.record,
409
+ { kind: "String", value: expression.field, location: expression.location },
410
+ ];
411
+ case "Prime":
412
+ case "Unchanged":
413
+ case "Enabled":
414
+ case "Always":
415
+ case "Eventually":
416
+ return [expression.expression];
417
+ case "BoxAction":
418
+ case "AngleAction":
419
+ return [expression.action, expression.subscript];
420
+ case "WeakFairness":
421
+ case "StrongFairness":
422
+ return [expression.subscript, expression.action];
423
+ case "FunctionSet":
424
+ return [expression.domain, expression.range];
425
+ case "Product":
426
+ return expression.factors;
427
+ case "Except":
428
+ return [expression.function];
429
+ default:
430
+ return undefined;
431
+ }
432
+ };
433
+
434
+ const isReference = (expression: Expression): expression is Reference =>
435
+ expression.kind === "Identifier" ||
436
+ expression.kind === "Apply" ||
437
+ expression.kind === "Subexpression";
438
+
439
+ const isInScopeOfDeclaration = (assumeProve: AssumeProve, clause: number) =>
440
+ assumeProve.assumptions.slice(0, clause).some((assumption) => assumption.kind === "NewSymbol");
441
+
442
+ const findLabel = (expression: Expression, name: string): LabelExpression | undefined => {
443
+ if (expression.kind === "Label") return expression.name === name ? expression : undefined;
444
+ if (expression.kind === "Lambda") return undefined;
445
+ if (expression.kind === "Let") return findLabel(expression.body, name);
446
+ return getChildren(expression).reduce<LabelExpression | undefined>(
447
+ (found, child) => found ?? findLabel(child, name),
448
+ undefined,
449
+ );
450
+ };
451
+
452
+ // SANY drops a label in the scope of a NEW in a nested ASSUME, after it reports the label.
453
+ const findClauseLabel = (
454
+ clause: Expression | NewSymbol | AssumeProve,
455
+ name: string,
456
+ isForbidden: boolean,
457
+ ): LabelExpression | undefined => {
458
+ if (clause.kind === "AssumeProve") {
459
+ return [...clause.assumptions, clause.conclusion].reduce<LabelExpression | undefined>(
460
+ (found, inner, index) =>
461
+ found ?? findClauseLabel(inner, name, isForbidden || isInScopeOfDeclaration(clause, index)),
462
+ undefined,
463
+ );
464
+ }
465
+ if (isForbidden) return undefined;
466
+ if (clause.kind === "NewSymbol") return clause.set && findLabel(clause.set, name);
467
+ return findLabel(clause, name);
468
+ };
469
+
470
+ const getLabelBody = (expression: Expression): Expression =>
471
+ expression.kind === "Label" ? getLabelBody(expression.body) : expression;
472
+
473
+ const getOperandName = (operand: number | "<<" | ">>") =>
474
+ typeof operand === "number" ? `argument selector ${operand}` : operand;
475
+
476
+ const SCOPE_MESSAGE = "within the scope of a declaration\n from outside that declaration's scope.";
477
+
478
+ // Generator.selectorToNode for a name that selects part of a theorem or step. A part in the scope of
479
+ // a NEW in its ASSUME may be selected only within the proof of the theorem, or only after the proof
480
+ // of a SUFFICES step. A label takes its own arguments, and an operand must exist, unless the part
481
+ // selected depends on bound names. A fact may select an ASSUME/PROVE or a NEW clause.
482
+ const checkSelection = (
483
+ reference: Reference,
484
+ selectors: Selector[],
485
+ goal: Goal,
486
+ scope: LocalName | undefined,
487
+ unit: Unit,
488
+ isFact: boolean,
489
+ ) => {
490
+ const report = (index: number | undefined, message: string) => {
491
+ const range =
492
+ (index === undefined ? undefined : reference.selectorRanges?.[index]) ??
493
+ reference.location.range;
494
+ if (range) unit.errors.push({ location: formatRange(range), message });
495
+ };
496
+ const isOutOfScope = goal.isSuffices === goal.isInProof;
497
+ const statement = goal.statement;
498
+ const state: SelectionState = {
499
+ node: statement,
500
+ isGoal: true,
501
+ isSufficesOpen: goal.isSuffices,
502
+ };
503
+ for (const [offset, selector] of selectors.slice(1).entries()) {
504
+ const index = offset + 1;
505
+ const node = state.node;
506
+ if (selector.kind === "Name") {
507
+ if (selectors[index - 1].kind !== "Name") {
508
+ const isLet =
509
+ node.kind !== "NewSymbol" &&
510
+ node.kind !== "AssumeProve" &&
511
+ getLabelBody(node).kind === "Let";
512
+ return isLet
513
+ ? undefined
514
+ : report(index - 1, "A name selector here must be from a LET clause.");
515
+ }
516
+ const clauses =
517
+ statement.kind === "AssumeProve"
518
+ ? [...statement.assumptions, statement.conclusion]
519
+ : [statement];
520
+ const found =
521
+ index === 1
522
+ ? clauses
523
+ .map((clause, position) => ({
524
+ position,
525
+ label: findClauseLabel(clause, selector.name, false),
526
+ }))
527
+ .find((item) => item.label !== undefined)
528
+ : {
529
+ position: 0,
530
+ label: node.kind === "Label" ? findLabel(node.body, selector.name) : undefined,
531
+ };
532
+ if (!found?.label) return report(index, `Cannot find label \`${selector.name}'.`);
533
+ if (
534
+ index === 1 &&
535
+ statement.kind === "AssumeProve" &&
536
+ isInScopeOfDeclaration(statement, found.position) &&
537
+ isOutOfScope
538
+ ) {
539
+ return report(
540
+ 1,
541
+ `Accessing subexpression labeled \`${selector.name}' of ASSUME/PROVE clause ${SCOPE_MESSAGE}`,
542
+ );
543
+ }
544
+ if (selector.args.length !== found.label.params.length) {
545
+ return report(index, `Label \`${selector.name}' used with wrong number of arguments.`);
546
+ }
547
+ state.node = found.label;
548
+ state.isGoal = false;
549
+ state.isSufficesOpen = false;
550
+ continue;
551
+ }
552
+ if (selector.kind !== "Operand") return;
553
+ const operand = getOperandName(selector.operand);
554
+ if (state.isSufficesOpen) {
555
+ if (getOperandIndex(selector.operand, 1) !== 0) {
556
+ return report(
557
+ index,
558
+ node.kind === "AssumeProve"
559
+ ? "Accessing non-existent subexpression of a SUFFICES"
560
+ : `Nonexistent operand specified by \`${operand}'.`,
561
+ );
562
+ }
563
+ state.isSufficesOpen = false;
564
+ continue;
565
+ }
566
+ if (node.kind === "NewSymbol") return;
567
+ if (node.kind !== "AssumeProve") {
568
+ const expression = getLabelBody(node);
569
+ if (["Number", "Decimal", "String"].includes(expression.kind)) {
570
+ return report(index, "Selecting subexpression of expression that has none.");
571
+ }
572
+ const kind =
573
+ expression.kind === "Identifier"
574
+ ? findBinding(expression.name, scope, unit)?.kind
575
+ : undefined;
576
+ if (kind === "Variable" || kind?.startsWith("New")) {
577
+ return report(index, `Choosing operand \`${operand}' of subexpression with no operands.`);
578
+ }
579
+ const sets = getBinder(expression)?.sets;
580
+ const operands =
581
+ expression.kind === "Identifier"
582
+ ? []
583
+ : sets
584
+ ? sets.length > 0
585
+ ? sets
586
+ : undefined
587
+ : expression.kind === "Except"
588
+ ? undefined
589
+ : getOperands(expression);
590
+ if (!operands) return;
591
+ const position = getOperandIndex(selector.operand, operands.length);
592
+ if (position === -1) return report(index, `Nonexistent operand specified by \`${operand}'.`);
593
+ state.node = operands[position];
594
+ state.isGoal = false;
595
+ continue;
596
+ }
597
+ const clauses = [...node.assumptions, node.conclusion];
598
+ const position = getOperandIndex(selector.operand, clauses.length);
599
+ if (position === -1) return report(index, `Nonexistent operand specified by \`${operand}'.`);
600
+ if (isInScopeOfDeclaration(node, position) && (!state.isGoal || isOutOfScope)) {
601
+ return report(index, `Accessing ASSUME/PROVE clause ${SCOPE_MESSAGE}`);
602
+ }
603
+ const clause = clauses[position];
604
+ if (clause.kind === "NewSymbol" && index !== selectors.length - 1) {
605
+ return report(index, "Selected a subexpression of a NEW clause of an ASSUME.");
606
+ }
607
+ state.node = clause;
608
+ state.isGoal = false;
609
+ }
610
+ if (isFact) return;
611
+ if (state.node.kind === "AssumeProve") {
612
+ report(undefined, "Selected ASSUME/PROVE instead of expression.");
613
+ }
614
+ if (state.node.kind === "NewSymbol") {
615
+ report(undefined, "Selected a NEW declaration as an expression or operator.");
616
+ }
617
+ };
618
+
619
+ // Generator.generateLabel reports a label where it may not appear, and skips the label's body.
620
+ const isLabelReported = (label: LabelExpression, unit: Unit) => {
621
+ const message = unit.isGenerated
622
+ ? undefined
623
+ : !unit.hasLabelScope
624
+ ? "Label not in definition or proof step."
625
+ : unit.isLabelForbidden
626
+ ? "Label not allowed within scope of declaration in nested ASSUME/PROVE."
627
+ : unit.isInExcept
628
+ ? "Labels inside EXCEPT clauses are not yet implemented."
629
+ : undefined;
630
+ if (message === undefined || !label.location.range) return false;
631
+ unit.errors.push({ location: formatRange(label.location.range), message });
632
+ return true;
633
+ };
634
+
635
+ // Generator.generateLabel reports, after the label's body, each parameter that names no bound name,
636
+ // then formalParamsEqual each parameter given twice, each name bound since the label scope began
637
+ // that the label leaves out, and the parameters it adds, and then a label of a name already used.
638
+ const checkLabel = (label: LabelExpression, scope: LocalName | undefined, unit: Unit) => {
639
+ const range = label.location.range;
640
+ if (!range || unit.isGenerated) return;
641
+ const location = formatRange(range);
642
+ const legal = label.params.filter((param, index) => {
643
+ const isLegal = lookupLocal(scope, param)?.kind === "Parameter";
644
+ const paramRange = label.paramRanges?.[index];
645
+ if (!isLegal && paramRange) {
646
+ unit.errors.push({
647
+ location: formatRange(paramRange),
648
+ message: `Illegal parameter ${param} of label \`${label.name}'.`,
649
+ });
650
+ }
651
+ return isLegal;
652
+ });
653
+ legal
654
+ .filter((param, index) => legal.indexOf(param) !== index)
655
+ .forEach((param) =>
656
+ unit.errors.push({
657
+ location,
658
+ message: `Repeated formal parameter ${param} \nin label \`${label.name}'.`,
659
+ }),
660
+ );
661
+ unit.labelParams
662
+ .filter((param) => !legal.includes(param))
663
+ .forEach((param) =>
664
+ unit.errors.push({
665
+ location,
666
+ message: `Label ${label.name} must contain formal parameter \`${param}'.`,
667
+ }),
668
+ );
669
+ const extra = [
670
+ ...new Set(legal.filter((param) => !unit.labelParams.includes(param))),
671
+ ...label.params.filter((param) => !legal.includes(param)),
672
+ ];
673
+ if (extra.length > 0) {
674
+ unit.errors.push({
675
+ location,
676
+ message: `Label ${label.name} declares extra parameter(s) ${extra.map((param) => `${param} `).join("")}`,
677
+ });
678
+ }
679
+ if (unit.labels.has(label.name)) {
680
+ unit.errors.push({ location, message: `Duplicate label \`${label.name}'.` });
681
+ }
682
+ unit.labels.add(label.name);
683
+ };
684
+
685
+ // Checks a name that selects part of a theorem or step, and tells whether it is one.
686
+ const checkReference = (
687
+ expression: Expression,
688
+ scope: LocalName | undefined,
689
+ unit: Unit,
690
+ isFact: boolean,
691
+ ) => {
692
+ if (!isReference(expression)) return false;
693
+ const selectors = getSelectors(expression);
694
+ const first = selectors[0];
695
+ const goal =
696
+ selectors.length > 1 && first.kind === "Name"
697
+ ? (lookupLocal(scope, first.name)?.goal ?? unit.goals.get(first.name))
698
+ : undefined;
699
+ if (goal) checkSelection(expression, selectors, goal, scope, unit, isFact);
700
+ return goal !== undefined;
701
+ };
702
+
703
+ // Generator.selectorToNode reports an unknown operator and goes on without analyzing its arguments,
704
+ // so its arity is undefined. It does the same for an operator given the wrong number of arguments,
705
+ // and for a name that selects nothing, after the arguments of the parts before.
114
706
  const getSymbolArity = (
115
707
  expression: Expression & { kind: "Identifier" | "Apply" | "OperatorReference" },
116
708
  name: string,
@@ -118,10 +710,13 @@ const getSymbolArity = (
118
710
  unit: Unit,
119
711
  ) => {
120
712
  const location = expression.location;
713
+ if (isSelectionReported(expression, scope, unit)) return undefined;
121
714
  const renamed = renamedArities.get(expression);
122
715
  if (renamed !== undefined) return renamed;
123
716
  if (isKey(name)) return expression.kind === "Apply" ? expression.args.length : 0;
124
- if (isStepName(name)) return 0;
717
+ if (checkReference(expression, scope, unit, false) || isStepName(name)) {
718
+ return expression.kind === "Apply" ? expression.args.length : 0;
719
+ }
125
720
  const local = lookupLocal(scope, name);
126
721
  if (local && expression.kind !== "OperatorReference") expression.resolution = LOCAL_RESOLUTION;
127
722
  if (local) return local.arity;
@@ -134,7 +729,7 @@ const getSymbolArity = (
134
729
  }
135
730
  // A name such as Inv!P1 selects the label P1 of a definition or theorem, which takes its own
136
731
  // arguments.
137
- const prefix = name.slice(0, name.indexOf("!"));
732
+ const prefix = name.includes("!") ? name.slice(0, name.indexOf("!")) : "";
138
733
  const isSelected =
139
734
  prefix !== "" &&
140
735
  (lookupLocal(scope, prefix) !== undefined ||
@@ -143,18 +738,33 @@ const getSymbolArity = (
143
738
  if (isSelected) {
144
739
  return expression.kind === "Apply" ? expression.args.length : 0;
145
740
  }
146
- const position = `at line ${location.line}, column ${location.column}`;
147
- throw new TlaSyntaxError(
148
- isOperatorSymbol(name)
149
- ? `Could not find declaration or definition of symbol '${name}' ${position}`
150
- : `Unknown operator: \`${name}' ${position}`,
741
+ const spelling = (expression.kind === "Identifier" ? undefined : expression.spelling) ?? name;
742
+ const range = formatRange(
743
+ getNameRange(location, expression.kind === "Apply" && spelling === "-." ? "-" : spelling),
151
744
  );
745
+ if (!isOperatorSymbol(name)) {
746
+ unit.errors.push({ location: range, message: `Unknown operator: \`${name}'.` });
747
+ return undefined;
748
+ }
749
+ unit.errors.push({
750
+ location: range,
751
+ message: `Could not find declaration or definition of symbol '${spelling}'.`,
752
+ });
753
+ const fixity = getFixity(expression);
754
+ if (fixity && location.range) {
755
+ unit.errors.push({
756
+ location: formatRange(location.range),
757
+ message: `Couldn't resolve ${fixity} operator symbol \`${spelling}'.`,
758
+ });
759
+ }
760
+ return undefined;
152
761
  };
153
762
 
154
763
  const resolveBounds = (bounds: Bound[], scope: LocalName | undefined, unit: Unit) => {
155
764
  bounds.forEach((bound) => resolveExpression(bound.set, scope, unit));
156
765
  return bounds.reduce(
157
- (current, bound) => bindNames(current, getPatternNames(bound.pattern)),
766
+ (current, bound) =>
767
+ bindNames(current, getPatternNames(bound.pattern), bound.pattern.ranges, unit),
158
768
  scope,
159
769
  );
160
770
  };
@@ -170,94 +780,278 @@ const markRecursiveConstructions = (expression: Expression, name: string): void
170
780
  getChildren(expression).forEach((child) => markRecursiveConstructions(child, name));
171
781
  };
172
782
 
173
- const resolveDefinition = (definition: Definition, scope: LocalName | undefined, unit: Unit) => {
174
- const self = bindNames(scope, definition.kind === "Function" ? [definition.name] : []);
783
+ // Generator.processOperator binds the parameters, reports a name already bound unless a RECURSIVE
784
+ // declaration of this level awaits the definition, analyzes the body, and then binds the name.
785
+ // processFunction binds the bound names before it looks up the name, and binds the name only where
786
+ // nothing else does. recursive holds the declarations of this level. Tells whether to bind the name.
787
+ const resolveDefinition = (
788
+ definition: Definition,
789
+ scope: LocalName | undefined,
790
+ outer: Unit,
791
+ recursive: Set<Binding>,
792
+ ) => {
793
+ const unit = {
794
+ ...outer,
795
+ hasLabelScope: true,
796
+ labelParams: definition.kind === "Function" ? getBoundNames(definition.bounds) : [],
797
+ labels: new Set<string>(),
798
+ };
799
+ const name = definition.name;
800
+ const range = definition.location.range;
801
+ const report = (message: string) => {
802
+ if (range && !unit.isGenerated) unit.errors.push({ location: formatRange(range), message });
803
+ };
804
+ const inner =
805
+ definition.kind === "Function"
806
+ ? resolveBounds(definition.bounds, scope, unit)
807
+ : bindParams(scope, definition.params, unit);
808
+ const current = lookupLocal(inner, name) ?? getModuleBinding(name, unit, range);
809
+ const isDeclared = current?.isPending === true && recursive.has(current);
810
+ if (current?.isPending && !isDeclared) {
811
+ report(
812
+ `Recursive ${definition.kind === "Function" ? "function" : "operator"} ${name} defined at wrong LET/IN level.`,
813
+ );
814
+ } else if (current && !isDeclared) {
815
+ report(
816
+ definition.kind === "Function"
817
+ ? `Function name \`${name}' already defined or declared.`
818
+ : `Operator ${name} already defined or declared.`,
819
+ );
820
+ }
175
821
  if (definition.kind === "Function") {
176
- resolveExpression(definition.body, resolveBounds(definition.bounds, self, unit), unit);
177
- markRecursiveConstructions(definition.body, definition.name);
178
- return;
822
+ resolveExpression(
823
+ definition.body,
824
+ { name, kind: "Parameter", arity: 0, range, parent: inner },
825
+ unit,
826
+ );
827
+ markRecursiveConstructions(definition.body, name);
828
+ definition.isSelfReferential = isReferenced(definition.body, name);
829
+ } else resolveExpression(definition.body, inner, unit);
830
+ if (current && isDeclared) {
831
+ current.isPending = false;
832
+ current.range = range;
833
+ return false;
179
834
  }
180
- resolveExpression(definition.body, bindParams(self, definition.params), unit);
835
+ return definition.kind === "Function"
836
+ ? current === undefined
837
+ : isBindable(
838
+ name,
839
+ lookupLocal(scope, name) ?? getModuleBinding(name, unit, range),
840
+ { kind: "Definition", arity: getArity(definition), range },
841
+ unit,
842
+ );
181
843
  };
182
844
 
845
+ // SANY analyzes an INSTANCE in a LET where it appears, before the definitions that follow it, which
846
+ // tla-ts generates at its location and analyzes without reporting.
183
847
  const resolveDefinitions = (
184
848
  definitions: Definition[],
185
849
  scope: LocalName | undefined,
186
850
  unit: Unit,
851
+ instances: Instance[] = [],
187
852
  ) => {
188
- const recursiveScope = definitions
853
+ const recursive = new Set<Binding>();
854
+ const declared = definitions
189
855
  .filter((definition) => definition.isRecursive)
190
- .reduce<LocalName | undefined>(
191
- (parent, definition) => ({ name: definition.name, arity: getArity(definition), parent }),
192
- scope,
193
- );
194
- return definitions.reduce((current, definition) => {
195
- if (!isInstantiated(definition)) resolveDefinition(definition, current, unit);
196
- return { name: definition.name, arity: getArity(definition), parent: current };
197
- }, recursiveScope);
856
+ .reduce<LocalName | undefined>((parent, definition) => {
857
+ if (lookupLocal(parent, definition.name)?.isPending) return parent;
858
+ const local: LocalName = {
859
+ name: definition.name,
860
+ arity: getArity(definition),
861
+ params: getParamArities(definition),
862
+ kind: "Definition",
863
+ parent,
864
+ isPending: true,
865
+ };
866
+ recursive.add(local);
867
+ return local;
868
+ }, scope);
869
+ const pending = unit.isGenerated ? [] : [...instances];
870
+ const resolveInstances = (
871
+ current: LocalName | undefined,
872
+ isDue: (instance: Instance) => boolean,
873
+ ) => {
874
+ const count = pending.findIndex((instance) => !isDue(instance));
875
+ return pending
876
+ .splice(0, count === -1 ? pending.length : count)
877
+ .reduce((parent, instance) => resolveLocalInstance(instance, parent, unit), current);
878
+ };
879
+ const resolved = definitions.reduce<LocalName | undefined>((previous, definition) => {
880
+ const current = isKey(definition.name)
881
+ ? previous
882
+ : resolveInstances(previous, (instance) => !isBefore(definition.location, instance.location));
883
+ const local: LocalName = {
884
+ name: definition.name,
885
+ arity: getArity(definition),
886
+ kind: "Definition",
887
+ range: definition.location.range,
888
+ parent: current,
889
+ };
890
+ if (isInstantiated(definition)) return local;
891
+ const isInstanced = instances.some((instance) => instance.location === definition.location);
892
+ const isGenerated = unit.isGenerated || definition.isLocal || isKey(definition.name);
893
+ const inner = isInstanced
894
+ ? { ...unit, isGenerated: true, errors: [], warnings: [] }
895
+ : isGenerated
896
+ ? { ...unit, isGenerated }
897
+ : unit;
898
+ return resolveDefinition(definition, current, inner, recursive)
899
+ ? { ...local, params: getParamArities(definition) }
900
+ : current;
901
+ }, declared);
902
+ return resolveInstances(resolved, () => true);
198
903
  };
199
904
 
200
- // OpDefNode#match: a parameter of arity 0 takes an expression, and a parameter of arity n takes an
201
- // operator of arity n whose own parameters take expressions.
202
- const checkArgument = (
203
- definition: Definition,
204
- index: number,
205
- arg: Expression,
206
- argArity: number,
207
- argDefinition: Definition | undefined,
905
+ // The INSTANCE that a name such as K!C starts with, whose arguments SANY requires at its name.
906
+ const findInstance = (name: string, scope: LocalName | undefined, unit: Unit) => {
907
+ const prefix = name.split("!")[0];
908
+ const binding =
909
+ prefix === name
910
+ ? undefined
911
+ : (lookupLocal(scope, prefix) ?? getModuleBinding(prefix, unit, undefined));
912
+ return binding?.kind === "Instance" ? { name: prefix, arity: binding.arity } : undefined;
913
+ };
914
+
915
+ // Generator.selectorToNode reports an INSTANCE given the wrong number of arguments at its name,
916
+ // as in K!C or K(1, 2)!C, and goes on without analyzing them. Tells whether it reports one.
917
+ const isInstanceArityReported = (
918
+ expression: Expression,
919
+ scope: LocalName | undefined,
920
+ unit: Unit,
208
921
  ) => {
209
- const param = definition.kind === "Operator" ? definition.params[index] : undefined;
210
- const location = arg.location;
211
- if (param?.arity === 0 && argArity > 0) {
212
- throw new TlaSyntaxError(
213
- `Operator used in argument number ${index + 1} has incorrect number of arguments at line ${location.line}, column ${location.column}`,
214
- );
215
- }
216
- const isHigherOrder =
217
- argDefinition?.kind === "Operator" && argDefinition.params.some((inner) => inner.arity > 0);
218
- if (param !== undefined && param.arity > 0 && (argArity !== param.arity || isHigherOrder)) {
219
- throw new TlaSyntaxError(
220
- `Argument number ${index + 1} to operator '${definition.name}' should be a ${param.arity}-parameter operator at line ${location.line}, column ${location.column}`,
221
- );
922
+ if (expression.kind !== "Identifier" && expression.kind !== "Apply") return false;
923
+ const instance = findInstance(
924
+ expression.kind === "Identifier" ? expression.name : expression.operator,
925
+ scope,
926
+ unit,
927
+ );
928
+ const count = expression.kind === "Apply" ? (expression.argumentCounts?.[0] ?? 0) : 0;
929
+ if (!instance || count === instance.arity) return false;
930
+ const range =
931
+ (expression.kind === "Apply" ? expression.argumentRanges?.[0] : undefined) ??
932
+ expression.location.range;
933
+ if (range) {
934
+ unit.errors.push({
935
+ location: formatRange(range),
936
+ message: `The operator ${instance.name} requires ${instance.arity} arguments.`,
937
+ });
222
938
  }
939
+ return true;
223
940
  };
224
941
 
225
- const getArgumentName = (arg: Expression) =>
226
- arg.kind === "Identifier"
227
- ? arg.name
228
- : arg.kind === "OperatorReference"
229
- ? arg.operator
230
- : undefined;
231
-
942
+ // Generator.generateExprOrOpArg analyzes an argument as an expression, unless a defined operator
943
+ // takes an operator in its place, which a name, a built-in operator, or a LAMBDA of the parameter's
944
+ // arity must give. OpDefNode#match then reports each argument that gives no such operator, or one
945
+ // whose own parameters take operators. tla-ts lets an operator whose parameters it does not know
946
+ // take any argument.
232
947
  const resolveApply = (
233
948
  expression: Expression & { kind: "Apply" },
234
949
  scope: LocalName | undefined,
235
950
  unit: Unit,
236
951
  ) => {
237
- const callee = lookupLocal(scope, expression.operator)
238
- ? undefined
239
- : getVisibleDefinition(expression.operator, unit);
240
- const arity = getSymbolArity(expression, expression.operator, scope, unit);
952
+ if (isInstanceArityReported(expression, scope, unit)) return;
953
+ const operator = expression.operator;
954
+ const callee = findBinding(operator, scope, unit);
955
+ const arity = getSymbolArity(expression, operator, scope, unit);
956
+ if (arity === undefined) return;
241
957
  if (arity !== expression.args.length) {
242
- throw new TlaSyntaxError(
243
- `The operator ${expression.operator} requires ${arity} arguments at line ${expression.location.line}, column ${expression.location.column}`,
244
- );
958
+ unit.errors.push({
959
+ location: formatRange(
960
+ expression.argumentsRange ?? getNameRange(expression.location, operator),
961
+ ),
962
+ message: `The operator ${operator} requires ${arity - (findInstance(operator, scope, unit)?.arity ?? 0)} arguments.`,
963
+ });
964
+ return;
245
965
  }
246
- expression.args.forEach((arg, index) => {
247
- const name = getArgumentName(arg);
248
- const argDefinition =
249
- name === undefined || lookupLocal(scope, name) ? undefined : getVisibleDefinition(name, unit);
250
- const argArity = resolveArgument(arg, scope, unit);
251
- if (callee) checkArgument(callee, index, arg, argArity, argDefinition);
252
- });
966
+ const params = callee && (callee.kind === "Definition" ? callee.params : []);
967
+ if (params === undefined) {
968
+ expression.args.forEach((arg) => resolveArgument(arg, scope, unit));
969
+ return;
970
+ }
971
+ const report = (range: SourceRange | undefined, message: string) => {
972
+ if (range) unit.errors.push({ location: formatRange(range), message });
973
+ };
974
+ expression.args
975
+ .map((arg, index) => {
976
+ const expected = params[index] ?? 0;
977
+ const range = arg.location.range;
978
+ if (expected === 0) {
979
+ // SANY fails on an operator here with an internal error, so tla-ts words it as it does for
980
+ // a name.
981
+ if (arg.kind === "Lambda" && arg.operator !== undefined) {
982
+ report(range, `The operator ${arg.operator} requires 1 arguments.`);
983
+ } else if (arg.kind === "Lambda" && range) {
984
+ report(range, "LAMBDA expression used where an expression is required.");
985
+ } else if (arg.kind === "OperatorReference") {
986
+ const argArity = getSymbolArity(arg, arg.operator, scope, unit);
987
+ if (argArity !== undefined) {
988
+ report(range, `The operator ${arg.operator} requires ${argArity} arguments.`);
989
+ }
990
+ } else resolveExpression(arg, scope, unit);
991
+ return true;
992
+ }
993
+ // A name that selects a subexpression gives an operator of the names it leaves unbound.
994
+ if (arg.kind === "Lambda") {
995
+ resolveExpression(arg, scope, unit);
996
+ const isMatched = arg.params.length === expected;
997
+ if (!isMatched && selections.has(arg)) {
998
+ report(
999
+ range,
1000
+ `Expected arity ${expected} but found operator of arity ${arg.params.length}.`,
1001
+ );
1002
+ } else if (!isMatched && range && arg.operator === undefined) {
1003
+ report(
1004
+ expression.selectorRanges?.at(-1) ?? getNameRange(expression.location, operator),
1005
+ `Lambda expression with arity ${arg.params.length} used as argument ${index + 1} of operator \`${operator}', \nbut an operator of arity ${expected} is required.`,
1006
+ );
1007
+ }
1008
+ return isMatched;
1009
+ }
1010
+ if (arg.kind === "Subexpression") {
1011
+ resolveExpression(arg, scope, unit);
1012
+ return true;
1013
+ }
1014
+ if (arg.kind !== "Identifier" && arg.kind !== "OperatorReference") {
1015
+ report(
1016
+ range,
1017
+ `An expression appears as argument number ${index + 1} (counting from 1) to operator '${operator}', in a position an operator is required.`,
1018
+ );
1019
+ return false;
1020
+ }
1021
+ const name = arg.kind === "Identifier" ? arg.name : arg.operator;
1022
+ const argParams = findBinding(name, scope, unit)?.params ?? [];
1023
+ const argArity = getSymbolArity(arg, name, scope, unit);
1024
+ if (arg.kind === "Identifier" && argArity !== undefined && argArity !== expected) {
1025
+ report(
1026
+ getNameRange(arg.location, name),
1027
+ `Expected arity ${expected} but found operator of arity ${argArity}.`,
1028
+ );
1029
+ }
1030
+ return argArity === expected && argParams.every((param) => param === 0);
1031
+ })
1032
+ .forEach((isMatched, index) => {
1033
+ if (!isMatched) {
1034
+ report(
1035
+ expression.location.range,
1036
+ `Argument number ${index + 1} to operator '${operator}' \nshould be a ${params[index]}-parameter operator.`,
1037
+ );
1038
+ }
1039
+ });
253
1040
  };
254
1041
 
255
1042
  // An argument may name an operator that takes arguments of its own.
256
1043
  const resolveArgument = (arg: Expression, scope: LocalName | undefined, unit: Unit) => {
257
- if (arg.kind === "Identifier") return getSymbolArity(arg, arg.name, scope, unit);
258
- if (arg.kind === "OperatorReference") return getSymbolArity(arg, arg.operator, scope, unit);
259
- resolveExpression(arg, scope, unit);
260
- return arg.kind === "Lambda" ? arg.params.length : 0;
1044
+ if (arg.kind === "Identifier") getSymbolArity(arg, arg.name, scope, unit);
1045
+ else resolveExpression(arg, scope, unit);
1046
+ };
1047
+
1048
+ // Reports the error of a name that selects nothing, after the arguments SANY analyzes before it.
1049
+ const isSelectionReported = (expression: Expression, scope: LocalName | undefined, unit: Unit) => {
1050
+ const failed = selectionErrors.get(expression);
1051
+ if (!failed) return false;
1052
+ failed.args.forEach((arg) => resolveArgument(arg, scope, unit));
1053
+ unit.errors.push(failed.error);
1054
+ return true;
261
1055
  };
262
1056
 
263
1057
  const resolveExpression = (
@@ -265,8 +1059,16 @@ const resolveExpression = (
265
1059
  scope: LocalName | undefined,
266
1060
  unit: Unit,
267
1061
  ): void => {
1062
+ if (selections.has(expression) && !unit.isGenerated) {
1063
+ resolveExpression(expression, scope, { ...unit, isGenerated: true });
1064
+ return;
1065
+ }
268
1066
  const resolveAll = (expressions: Expression[]) =>
269
1067
  expressions.forEach((child) => resolveExpression(child, scope, unit));
1068
+ const bindLabelParams = (names: string[]) => ({
1069
+ ...unit,
1070
+ labelParams: [...unit.labelParams, ...names],
1071
+ });
270
1072
  switch (expression.kind) {
271
1073
  case "Number":
272
1074
  case "Decimal":
@@ -274,11 +1076,14 @@ const resolveExpression = (
274
1076
  case "ExceptAt":
275
1077
  return;
276
1078
  case "Identifier": {
277
- const arity = getSymbolArity(expression, expression.name, scope, unit);
278
- if (arity > 0) {
279
- throw new TlaSyntaxError(
280
- `The operator ${expression.name} requires ${arity} arguments at line ${expression.location.line}, column ${expression.location.column}`,
281
- );
1079
+ if (isInstanceArityReported(expression, scope, unit)) return;
1080
+ const name = expression.name;
1081
+ const arity = getSymbolArity(expression, name, scope, unit);
1082
+ if (arity !== undefined && arity > 0) {
1083
+ unit.errors.push({
1084
+ location: formatRange(getNameRange(expression.location, name)),
1085
+ message: `The operator ${name} requires ${arity} arguments.`,
1086
+ });
282
1087
  }
283
1088
  return;
284
1089
  }
@@ -289,7 +1094,11 @@ const resolveExpression = (
289
1094
  resolveApply(expression, scope, unit);
290
1095
  return;
291
1096
  case "Lambda":
292
- resolveExpression(expression.body, bindNames(scope, expression.params), unit);
1097
+ resolveExpression(
1098
+ expression.body,
1099
+ bindNames(scope, expression.params, expression.paramRanges, unit),
1100
+ bindLabelParams(expression.params),
1101
+ );
293
1102
  return;
294
1103
  case "And":
295
1104
  case "Or":
@@ -312,24 +1121,32 @@ const resolveExpression = (
312
1121
  case "Let":
313
1122
  resolveExpression(
314
1123
  expression.body,
315
- resolveDefinitions(expression.definitions, scope, unit),
1124
+ resolveDefinitions(expression.definitions, scope, unit, expression.instances),
316
1125
  unit,
317
1126
  );
318
1127
  return;
319
1128
  case "Forall":
320
1129
  case "Exists":
321
1130
  case "FunctionConstruction":
322
- resolveExpression(expression.body, resolveBounds(expression.bounds, scope, unit), unit);
1131
+ resolveExpression(
1132
+ expression.body,
1133
+ resolveBounds(expression.bounds, scope, unit),
1134
+ bindLabelParams(getBoundNames(expression.bounds)),
1135
+ );
323
1136
  return;
324
1137
  case "UnboundedQuantifier":
325
- resolveExpression(expression.body, bindNames(scope, expression.names), unit);
1138
+ resolveExpression(
1139
+ expression.body,
1140
+ bindNames(scope, expression.names, expression.nameRanges, unit),
1141
+ bindLabelParams(expression.names),
1142
+ );
326
1143
  return;
327
1144
  case "Choose":
328
1145
  if (expression.set) resolveExpression(expression.set, scope, unit);
329
1146
  resolveExpression(
330
1147
  expression.body,
331
- bindNames(scope, getPatternNames(expression.pattern)),
332
- unit,
1148
+ bindNames(scope, getPatternNames(expression.pattern), expression.pattern.ranges, unit),
1149
+ bindLabelParams(getPatternNames(expression.pattern)),
333
1150
  );
334
1151
  return;
335
1152
  case "SetEnumeration":
@@ -337,31 +1154,40 @@ const resolveExpression = (
337
1154
  resolveAll(expression.elements);
338
1155
  return;
339
1156
  case "SetFilter":
340
- resolveExpression(expression.predicate, resolveBounds([expression.bound], scope, unit), unit);
1157
+ resolveExpression(
1158
+ expression.predicate,
1159
+ resolveBounds([expression.bound], scope, unit),
1160
+ bindLabelParams(getPatternNames(expression.bound.pattern)),
1161
+ );
341
1162
  return;
342
1163
  case "SetMap":
343
- resolveExpression(expression.expression, resolveBounds(expression.bounds, scope, unit), unit);
1164
+ resolveExpression(
1165
+ expression.expression,
1166
+ resolveBounds(expression.bounds, scope, unit),
1167
+ bindLabelParams(getBoundNames(expression.bounds)),
1168
+ );
344
1169
  return;
345
1170
  case "FunctionSet":
346
1171
  resolveAll([expression.domain, expression.range]);
347
1172
  return;
348
1173
  case "Record":
349
1174
  case "RecordSet":
350
- if (new Set(expression.fields.map((field) => field.name)).size < expression.fields.length) {
351
- throw new TlaSyntaxError(
352
- `Non-unique fields in constructor at line ${expression.location.line}, column ${expression.location.column}`,
353
- );
354
- }
355
- resolveAll(expression.fields.map((field) => field.value));
1175
+ expression.fields.forEach((field, index) => {
1176
+ if (expression.fields.slice(0, index).some((earlier) => earlier.name === field.name)) {
1177
+ unit.errors.push({
1178
+ location: formatRange(field.location.range ?? getNameRange(field.location, field.name)),
1179
+ message: "Non-unique fields in constructor.",
1180
+ });
1181
+ }
1182
+ resolveExpression(field.value, scope, unit);
1183
+ });
356
1184
  return;
357
1185
  case "Except":
358
- resolveAll([
359
- expression.function,
360
- ...expression.updates.flatMap((update) => [
361
- ...update.path.flatMap((step) => (step.kind === "Index" ? step.args : [])),
362
- update.value,
363
- ]),
364
- ]);
1186
+ resolveExpression(expression.function, scope, unit);
1187
+ expression.updates.forEach((update) => {
1188
+ resolveAll(update.path.flatMap((step) => (step.kind === "Index" ? step.args : [])));
1189
+ resolveExpression(update.value, scope, { ...unit, isInExcept: true });
1190
+ });
365
1191
  return;
366
1192
  case "FunctionApplication":
367
1193
  resolveAll([expression.function, ...expression.args]);
@@ -381,34 +1207,72 @@ const resolveExpression = (
381
1207
  resolveAll([expression.subscript, expression.action]);
382
1208
  return;
383
1209
  case "Label":
384
- resolveExpression(expression.body, scope, unit);
1210
+ if (isLabelReported(expression, unit)) return;
1211
+ resolveExpression(expression.body, scope, { ...unit, labelParams: [], labels: new Set() });
1212
+ checkLabel(expression, scope, unit);
385
1213
  return;
386
- case "Subexpression":
1214
+ case "Subexpression": {
1215
+ if (isSelectionReported(expression, scope, unit)) return;
387
1216
  expression.selectors
388
1217
  .flatMap((selector) => ("args" in selector ? selector.args : []))
389
1218
  .forEach((arg) => resolveArgument(arg, scope, unit));
1219
+ checkReference(expression, scope, unit, false);
1220
+ }
390
1221
  }
391
1222
  };
392
1223
 
1224
+ // Generator.generateUseOrHide looks up a fact that is a name as it looks up a name in an expression,
1225
+ // except that the name may select an ASSUME/PROVE or a NEW clause or name a theorem or assumption,
1226
+ // and analyzes any other fact as an expression.
1227
+ const checkFacts = (facts: Fact[], scope: LocalName | undefined, unit: Unit) =>
1228
+ facts.forEach((fact) => {
1229
+ if (
1230
+ fact.kind === "ModuleFact" ||
1231
+ isInstanceArityReported(fact, scope, unit) ||
1232
+ checkReference(fact, scope, unit, true)
1233
+ ) {
1234
+ return;
1235
+ }
1236
+ const name =
1237
+ fact.kind === "Identifier" ? fact.name : fact.kind === "Apply" ? fact.operator : "";
1238
+ if (!unit.facts.has(name)) resolveExpression(fact, scope, unit);
1239
+ });
1240
+
393
1241
  const resolveNewSymbol = (symbol: NewSymbol, scope: LocalName | undefined, unit: Unit) => {
394
1242
  if (symbol.set) resolveExpression(symbol.set, scope, unit);
395
- return { name: symbol.name, arity: symbol.arity, parent: scope };
1243
+ return bindName(
1244
+ scope,
1245
+ symbol.name,
1246
+ { kind: `New${symbol.level}`, arity: symbol.arity, range: symbol.nameRange },
1247
+ unit,
1248
+ );
396
1249
  };
397
1250
 
398
- // The NEW symbols of an ASSUME stay in scope for its conclusion and the proof that follows.
1251
+ // The NEW symbols of an ASSUME stay in scope for its conclusion and the proof that follows. SANY
1252
+ // forbids a label in the scope of a NEW in a nested ASSUME.
399
1253
  const resolveAssumeProve = (
400
1254
  assumeProve: AssumeProve,
401
1255
  scope: LocalName | undefined,
402
1256
  unit: Unit,
1257
+ isNested = false,
403
1258
  ): LocalName | undefined => {
404
- const assumed = assumeProve.assumptions.reduce((current, assumption) => {
405
- if (assumption.kind === "NewSymbol") return resolveNewSymbol(assumption, current, unit);
406
- if (assumption.kind === "AssumeProve") resolveAssumeProve(assumption, current, unit);
407
- else resolveExpression(assumption, current, unit);
408
- return current;
409
- }, scope);
410
- resolveExpression(assumeProve.conclusion, assumed, unit);
411
- return assumed;
1259
+ const assumed = assumeProve.assumptions.reduce(
1260
+ (current, assumption) => {
1261
+ if (assumption.kind === "NewSymbol") {
1262
+ return {
1263
+ scope: resolveNewSymbol(assumption, current.scope, current.unit),
1264
+ unit: isNested ? { ...current.unit, isLabelForbidden: true } : current.unit,
1265
+ };
1266
+ }
1267
+ if (assumption.kind === "AssumeProve") {
1268
+ resolveAssumeProve(assumption, current.scope, current.unit, true);
1269
+ } else resolveExpression(assumption, current.scope, current.unit);
1270
+ return current;
1271
+ },
1272
+ { scope, unit },
1273
+ );
1274
+ resolveExpression(assumeProve.conclusion, assumed.scope, assumed.unit);
1275
+ return assumed.scope;
412
1276
  };
413
1277
 
414
1278
  const resolveStatement = (
@@ -423,44 +1287,92 @@ const resolveStatement = (
423
1287
 
424
1288
  // SANY resolves the expressions of a proof, while its facts and DEF clauses may also name
425
1289
  // theorems, assumptions, and modules.
426
- const resolveProof = (proof: Proof | undefined, scope: LocalName | undefined, unit: Unit) => {
1290
+ const resolveProof = (proof: Proof | undefined, scope: LocalName | undefined, outer: Unit) => {
1291
+ const unit = outer.hasLabelScope ? { ...outer, hasLabelScope: false } : outer;
1292
+ if (proof?.kind === "By") checkFacts(proof.facts, scope, unit);
427
1293
  if (proof?.kind !== "Steps") return;
428
1294
  proof.steps.reduce((current, step) => resolveStep(step, current, unit), scope);
429
1295
  };
430
1296
 
1297
+ // A LET or a step binds the name of the INSTANCE after the names it adds.
1298
+ const resolveLocalInstance = (instance: Instance, scope: LocalName | undefined, unit: Unit) => {
1299
+ const instanced = resolveInstance(instance, scope, unit);
1300
+ return instance.name === undefined
1301
+ ? instanced
1302
+ : bindName(
1303
+ instanced,
1304
+ instance.name,
1305
+ { kind: "Instance", arity: instance.params.length, range: instance.location.range },
1306
+ unit,
1307
+ );
1308
+ };
1309
+
431
1310
  const resolveStep = (
432
1311
  step: ProofStep,
433
1312
  scope: LocalName | undefined,
434
1313
  unit: Unit,
435
1314
  ): LocalName | undefined => {
436
1315
  const body = step.body;
1316
+ const stepUnit =
1317
+ step.name === undefined
1318
+ ? unit
1319
+ : { ...unit, hasLabelScope: true, labelParams: [], labels: new Set<string>() };
437
1320
  switch (body.kind) {
1321
+ // The NEW symbols of a SUFFICES ASSUME are in scope after its proof, and those of any other
1322
+ // ASSUME in its proof.
438
1323
  case "Assert": {
439
- const assumed = resolveStatement(body.statement, scope, unit);
440
- resolveProof(step.proof, assumed, unit);
441
- return body.isSuffices ? assumed : scope;
1324
+ const assumed = resolveStatement(body.statement, scope, stepUnit);
1325
+ const proofScope = body.isSuffices ? scope : assumed;
1326
+ const name = step.name;
1327
+ if (name === undefined) {
1328
+ resolveProof(step.proof, proofScope, unit);
1329
+ return body.isSuffices ? assumed : scope;
1330
+ }
1331
+ const goal = { statement: body.statement, isSuffices: body.isSuffices, isInProof: true };
1332
+ resolveProof(step.proof, { name, arity: 0, kind: "Theorem", parent: proofScope, goal }, unit);
1333
+ goal.isInProof = false;
1334
+ return { name, arity: 0, kind: "Theorem", parent: body.isSuffices ? assumed : scope, goal };
442
1335
  }
1336
+ case "Use":
1337
+ case "Hide":
1338
+ checkFacts(body.facts, scope, unit);
1339
+ return scope;
1340
+ case "Instance":
1341
+ return resolveLocalInstance(body, scope, stepUnit);
443
1342
  case "Define":
444
- return resolveDefinitions(
445
- body.definitions.flatMap((definition) =>
446
- definition.kind === "Instance" ? [] : [definition],
447
- ),
1343
+ return body.definitions.reduce(
1344
+ (current, definition) =>
1345
+ definition.kind === "Instance"
1346
+ ? resolveLocalInstance(definition, current, stepUnit)
1347
+ : resolveDefinitions([definition], current, unit),
448
1348
  scope,
449
- unit,
450
1349
  );
451
1350
  case "Have":
452
1351
  case "Case":
453
- resolveExpression(body.expression, scope, unit);
1352
+ resolveExpression(body.expression, scope, stepUnit);
454
1353
  resolveProof(step.proof, scope, unit);
455
1354
  return scope;
456
1355
  case "Witness":
457
- body.expressions.forEach((expression) => resolveExpression(expression, scope, unit));
1356
+ body.expressions.forEach((expression) => resolveExpression(expression, scope, stepUnit));
458
1357
  return scope;
459
1358
  case "Take":
460
- return bindNames(resolveBounds(body.bounds, scope, unit), body.names);
1359
+ return bindNames(
1360
+ resolveBounds(body.bounds, scope, stepUnit),
1361
+ body.names,
1362
+ body.nameRanges,
1363
+ stepUnit,
1364
+ );
461
1365
  case "Pick": {
462
- const picked = bindNames(resolveBounds(body.bounds, scope, unit), body.names);
463
- resolveExpression(body.body, picked, unit);
1366
+ const picked = bindNames(
1367
+ resolveBounds(body.bounds, scope, stepUnit),
1368
+ body.names,
1369
+ body.nameRanges,
1370
+ stepUnit,
1371
+ );
1372
+ resolveExpression(body.body, picked, {
1373
+ ...stepUnit,
1374
+ labelParams: [...stepUnit.labelParams, ...getBoundNames(body.bounds), ...body.names],
1375
+ });
464
1376
  resolveProof(step.proof, scope, unit);
465
1377
  return picked;
466
1378
  }
@@ -470,324 +1382,421 @@ const resolveStep = (
470
1382
  }
471
1383
  };
472
1384
 
1385
+ // SANY binds the name of a theorem after its statement and before its proof.
473
1386
  const resolveTheorem = (theorem: Theorem, unit: Unit) => {
474
1387
  const isDefinition = theorem.name !== undefined && theorem.statement.kind !== "AssumeProve";
475
1388
  const scope = isDefinition ? undefined : resolveStatement(theorem.statement, undefined, unit);
1389
+ if (theorem.name !== undefined) {
1390
+ bindModuleName(
1391
+ theorem.name,
1392
+ { kind: "Theorem", arity: 0, range: theorem.location.range },
1393
+ unit,
1394
+ );
1395
+ }
1396
+ const goal = unit.goals.get(theorem.name ?? "");
1397
+ if (goal) goal.isInProof = true;
476
1398
  resolveProof(theorem.proof, scope, unit);
1399
+ if (goal) goal.isInProof = false;
477
1400
  };
478
1401
 
479
- interface ModuleUnit {
480
- imported: Symbols;
481
- importedAt: Map<string, SourceLocation>;
482
- definitions: Map<string, Definition>;
483
- getKey: (definition: Definition) => string;
1402
+ // The declarations of the module an INSTANCE instantiates, the names the INSTANCE adds, and the
1403
+ // module that instantiates it.
1404
+ export interface InstancedModule {
1405
+ declarations: Declaration[];
1406
+ symbols: Symbols;
1407
+ instancer: string;
484
1408
  }
485
1409
 
486
- interface ModuleName {
487
- name: string;
488
- kind: "Definition" | "Constant" | "Variable";
1410
+ // What SANY reports at a location as it links a module, such as a conflict between the modules it
1411
+ // extends.
1412
+ export interface ModuleReport {
489
1413
  location: SourceLocation;
490
- isRecursive: boolean;
1414
+ errors: SanyError[];
1415
+ warnings: SanyError[];
491
1416
  }
492
1417
 
493
- type IsDefined = (name: string) => boolean;
1418
+ // bound holds the names in scope where the module starts: the built-in operators, the names of the
1419
+ // module that encloses it, and those of the modules it extends. instanced holds the names each
1420
+ // INSTANCE adds, getInstance what an INSTANCE in a LET or a proof instantiates, facts the theorems
1421
+ // and assumptions the modules it extends or instantiates export, and warnings the warnings SANY
1422
+ // reports for the spec.
1423
+ export interface ModuleUnit {
1424
+ imported: Symbols;
1425
+ getInstance: (instance: Instance) => InstancedModule;
1426
+ bound: Symbols;
1427
+ definitions: Map<string, Definition>;
1428
+ getKey: (definition: Definition) => string;
1429
+ instanced: Map<Instance, Symbols>;
1430
+ facts: Set<string>;
1431
+ reports: ModuleReport[];
1432
+ warnings: SanyError[];
1433
+ }
494
1434
 
495
- const createRedefinitionError = (name: string, location: SourceLocation) =>
496
- new TlaSyntaxError(
497
- `Multiply-defined symbol '${name}' at line ${location.line}, column ${location.column}`,
498
- );
1435
+ export const MODULE_START: SourceLocation = { line: 0, column: 0 };
499
1436
 
500
- const bindUnique = (
501
- scope: LocalName | undefined,
502
- names: string[],
503
- isDefined: IsDefined,
504
- location: SourceLocation,
505
- ) =>
506
- names.reduce<LocalName | undefined>((parent, name) => {
507
- if (lookupLocal(parent, name) || isDefined(name)) throw createRedefinitionError(name, location);
508
- return { name, arity: 0, parent };
509
- }, scope);
1437
+ // A named theorem or assumption is linked as a definition too.
1438
+ export const isTheoremDefinition = (module: Module, definition: Definition) =>
1439
+ [...module.theorems, ...module.assumptions].some(
1440
+ (item) =>
1441
+ item.name === definition.name &&
1442
+ item.location.line === definition.location.line &&
1443
+ item.location.column === definition.location.column,
1444
+ );
510
1445
 
511
- const checkBoundNames = (
512
- bounds: Bound[],
513
- scope: LocalName | undefined,
514
- isDefined: IsDefined,
515
- location: SourceLocation,
516
- ) => {
517
- bounds.forEach((bound) => checkNames(bound.set, scope, isDefined));
518
- return bounds.reduce(
519
- (current, bound) => bindUnique(current, getPatternNames(bound.pattern), isDefined, location),
520
- scope,
1446
+ const createSymbols = (module: Module, imported: Symbols) => {
1447
+ const symbols = new Map([...CORE_SYMBOLS, ...imported]);
1448
+ module.constants.forEach((constant) =>
1449
+ symbols.set(constant.name, { key: constant.name, arity: constant.arity, kind: "Constant" }),
1450
+ );
1451
+ module.variables.forEach((variable) =>
1452
+ symbols.set(variable.name, { key: variable.name, arity: 0, kind: "Variable" }),
521
1453
  );
1454
+ return symbols;
522
1455
  };
523
1456
 
524
- const checkDefinitionNames = (
525
- definition: Definition,
526
- scope: LocalName | undefined,
527
- isDefined: IsDefined,
1457
+ // Generator.processSubst analyzes the explicit substitutions in the order they appear, then the
1458
+ // implicit ones, and then reports each declaration left without one. The parameters of the INSTANCE
1459
+ // are in scope.
1460
+ const checkSubstitutions = (
1461
+ instance: Instance,
1462
+ declarations: Declaration[],
1463
+ instancer: string,
1464
+ outer: LocalName | undefined,
1465
+ unit: Unit,
528
1466
  ) => {
529
- if (definition.kind === "Function") {
530
- const self = bindNames(scope, [definition.name]);
531
- const bound = checkBoundNames(definition.bounds, self, isDefined, definition.location);
532
- checkNames(definition.body, bound, isDefined);
533
- return;
534
- }
535
- const params = bindUnique(
536
- scope,
537
- definition.params.map((param) => param.name),
538
- isDefined,
539
- definition.location,
1467
+ const scope = instance.params.reduce<LocalName | undefined>(
1468
+ (parent, param) => ({ name: param.name, arity: param.arity, kind: "Parameter", parent }),
1469
+ outer,
540
1470
  );
541
- checkNames(definition.body, params, isDefined);
542
- };
543
-
544
- const checkNames = (
545
- expression: Expression,
546
- scope: LocalName | undefined,
547
- isDefined: IsDefined,
548
- ): void => {
549
- const location = expression.location;
550
- switch (expression.kind) {
551
- case "Lambda":
552
- checkNames(
553
- expression.body,
554
- bindUnique(scope, expression.params, isDefined, location),
555
- isDefined,
556
- );
557
- return;
558
- case "Let": {
559
- const recursive = expression.definitions
560
- .filter((definition) => definition.isRecursive)
561
- .map((definition) => definition.name);
562
- const inner = expression.definitions.reduce((current, definition) => {
563
- if (lookupLocal(current, definition.name) || isDefined(definition.name)) {
564
- throw createRedefinitionError(definition.name, definition.location);
565
- }
566
- checkDefinitionNames(definition, bindNames(current, recursive), isDefined);
567
- return bindNames(current, [definition.name]);
568
- }, scope);
569
- checkNames(
570
- expression.body,
571
- bindUnique(
572
- inner,
573
- (expression.instances ?? []).flatMap((instance) =>
574
- instance.name === undefined ? [] : [instance.name],
575
- ),
576
- isDefined,
577
- location,
578
- ),
579
- isDefined,
580
- );
1471
+ const resolveSubstitute = (declaration: Declaration, expression: Expression) => {
1472
+ if (declaration.arity === 0 || expression.kind !== "Identifier") {
1473
+ resolveExpression(expression, scope, unit);
581
1474
  return;
582
1475
  }
583
- case "Forall":
584
- case "Exists":
585
- case "FunctionConstruction":
586
- checkNames(
587
- expression.body,
588
- checkBoundNames(expression.bounds, scope, isDefined, location),
589
- isDefined,
590
- );
591
- return;
592
- case "SetFilter":
593
- checkNames(
594
- expression.predicate,
595
- checkBoundNames([expression.bound], scope, isDefined, location),
596
- isDefined,
597
- );
598
- return;
599
- case "SetMap":
600
- checkNames(
601
- expression.expression,
602
- checkBoundNames(expression.bounds, scope, isDefined, location),
603
- isDefined,
604
- );
605
- return;
606
- case "UnboundedQuantifier":
607
- checkNames(
608
- expression.body,
609
- bindUnique(scope, expression.names, isDefined, location),
610
- isDefined,
611
- );
612
- return;
613
- case "Choose":
614
- if (expression.set) checkNames(expression.set, scope, isDefined);
615
- checkNames(
616
- expression.body,
617
- bindUnique(scope, getPatternNames(expression.pattern), isDefined, location),
618
- isDefined,
1476
+ const arity = getSymbolArity(expression, expression.name, scope, unit);
1477
+ if (arity !== undefined && arity !== declaration.arity) {
1478
+ throw new TlaSyntaxError(
1479
+ `An operator must be substituted for symbol '${declaration.name}', and it must have arity ${declaration.arity} in the instance of ${instance.module} at line ${instance.location.line}, column ${instance.location.column}`,
619
1480
  );
620
- return;
621
- default:
622
- getChildren(expression).forEach((child) => checkNames(child, scope, isDefined));
623
- }
624
- };
625
-
626
- const getModuleNames = (module: Module) => [
627
- ...module.definitions.map((definition): ModuleName => ({
628
- name: definition.name,
629
- kind: "Definition",
630
- location: definition.location,
631
- isRecursive: definition.isRecursive,
632
- })),
633
- ...module.instances.flatMap((instance): ModuleName[] =>
634
- instance.name === undefined
635
- ? []
636
- : [
637
- {
638
- name: instance.name,
639
- kind: "Definition",
640
- location: instance.location,
641
- isRecursive: false,
642
- },
643
- ],
644
- ),
645
- ...module.constants.map((constant): ModuleName => ({
646
- name: constant.name,
647
- kind: "Constant",
648
- location: constant.location,
649
- isRecursive: false,
650
- })),
651
- ...module.variables.map((variable): ModuleName => ({
652
- name: variable.name,
653
- kind: "Variable",
654
- location: variable.location,
655
- isRecursive: false,
656
- })),
657
- ];
658
-
659
- export const checkRedefinitions = (module: Module, unit: ModuleUnit) => {
660
- const byName = new Map<string, ModuleName[]>();
661
- getModuleNames(module)
662
- .sort((left, right) => (isBefore(left.location, right.location) ? -1 : 1))
663
- .forEach((entry) => byName.set(entry.name, [...(byName.get(entry.name) ?? []), entry]));
664
- const isImportedBefore = (name: string, location: SourceLocation) => {
665
- if (!unit.imported.has(name) && !CORE_SYMBOLS.has(name)) return false;
666
- const importedAt = unit.importedAt.get(name);
667
- return importedAt === undefined || isBefore(importedAt, location);
1481
+ }
668
1482
  };
669
- byName.forEach((entries) =>
670
- entries.forEach((entry, index) => {
671
- const isDuplicate = entries
672
- .slice(0, index)
673
- .some(
674
- (earlier) =>
675
- earlier.kind === "Definition" ||
676
- entry.kind === "Definition" ||
677
- earlier.kind !== entry.kind,
678
- );
679
- // A module may declare again a constant or variable that it extends or that encloses it.
680
- const isRedeclared = unit.imported.get(entry.name)?.declaration === entry.kind;
681
- if (isDuplicate || (!isRedeclared && isImportedBefore(entry.name, entry.location)))
682
- throw createRedefinitionError(entry.name, entry.location);
683
- }),
684
- );
685
- const getIsDefined =
686
- (location: SourceLocation): IsDefined =>
687
- (name) =>
688
- (byName.get(name) ?? []).some(
689
- (entry) => entry.isRecursive || isBefore(entry.location, location),
690
- ) || isImportedBefore(name, location);
691
- module.definitions.forEach((definition) =>
692
- checkDefinitionNames(definition, undefined, getIsDefined(definition.location)),
693
- );
694
- module.assumptions.forEach((assumption) =>
695
- checkNames(assumption.expression, undefined, getIsDefined(assumption.location)),
696
- );
697
- module.instances.forEach((instance) => {
698
- const isDefined = getIsDefined(instance.location);
699
- const params = bindUnique(
700
- undefined,
701
- instance.params.map((param) => param.name),
702
- isDefined,
703
- instance.location,
704
- );
705
- instance.substitutions.forEach((substitution) =>
706
- checkNames(substitution.expression, params, isDefined),
707
- );
1483
+ const substitutions = new Map<string, Expression>();
1484
+ instance.substitutions.forEach((substitution) => {
1485
+ const name = substitution.name;
1486
+ const declaration = declarations.find((item) => item.name === name);
1487
+ if (!declaration) {
1488
+ unit.errors.push({
1489
+ location: formatRange(substitution.nameRange),
1490
+ message: `Identifier '${name}' is not a legal target of a substitution. \nA legal target must be a declared CONSTANT or VARIABLE in the module being instantiated. \n(Also, check for warnings about multiple declarations of this same identifier.)`,
1491
+ });
1492
+ return;
1493
+ }
1494
+ const expression = substitution.expression;
1495
+ resolveSubstitute(declaration, expression);
1496
+ const range = expression.location.range;
1497
+ if (!substitutions.has(name)) substitutions.set(name, expression);
1498
+ else if (range) {
1499
+ unit.errors.push({
1500
+ location: formatRange(range),
1501
+ message: `Multiple substitutions for symbol '${name}' in substitution.`,
1502
+ });
1503
+ }
1504
+ });
1505
+ const implicit = declarations.filter((declaration) => !substitutions.has(declaration.name));
1506
+ const isMissing = (declaration: Declaration) =>
1507
+ !lookupLocal(scope, declaration.name) && !findSymbol(declaration.name, unit);
1508
+ implicit
1509
+ .filter((declaration) => !isMissing(declaration))
1510
+ .forEach((declaration) => {
1511
+ const expression: Expression = {
1512
+ kind: "Identifier",
1513
+ name: declaration.name,
1514
+ location: instance.location,
1515
+ };
1516
+ resolveSubstitute(declaration, expression);
1517
+ substitutions.set(declaration.name, expression);
1518
+ });
1519
+ implicit.filter(isMissing).forEach((declaration) => {
1520
+ const range = instance.location.range;
1521
+ const declared = declaration.location.range;
1522
+ if (range && declared) {
1523
+ unit.errors.push({
1524
+ location: formatRange(range),
1525
+ message: `Substitution missing for symbol ${declaration.name} declared at ${formatRange(declared)} \nand instantiated in module ${instancer}.`,
1526
+ });
1527
+ }
708
1528
  });
1529
+ return substitutions;
709
1530
  };
710
1531
 
711
- const createSymbols = (module: Module, imported: Symbols) => {
712
- const symbols = new Map([...CORE_SYMBOLS, ...imported]);
713
- module.constants.forEach((constant) =>
714
- symbols.set(constant.name, { key: constant.name, arity: constant.arity }),
715
- );
716
- module.variables.forEach((variable) =>
717
- symbols.set(variable.name, { key: variable.name, arity: 0 }),
1532
+ // Generator.processSubst analyzes an INSTANCE in a LET or a proof, which then binds the names the
1533
+ // INSTANCE adds.
1534
+ const resolveInstance = (instance: Instance, scope: LocalName | undefined, unit: Unit) => {
1535
+ const instanced = unit.getInstance(instance);
1536
+ checkSubstitutions(instance, instanced.declarations, instanced.instancer, scope, unit);
1537
+ return [...instanced.symbols].reduce(
1538
+ (parent, [name, symbol]) => bindName(parent, name, symbol, unit),
1539
+ scope,
718
1540
  );
719
- return symbols;
720
1541
  };
721
1542
 
1543
+ // tla-ts reports what SANY goes on after with an INSTANCE of the module.
722
1544
  export const resolveSubstitutions = (
723
1545
  instance: Instance,
724
- declarations: OperatorParam[],
1546
+ declarations: Declaration[],
725
1547
  module: Module,
726
1548
  unit: ModuleUnit,
727
1549
  ) => {
728
- const scope = bindParams(undefined, instance.params);
729
- const context: Unit = {
730
- imported: createSymbols(module, unit.imported),
1550
+ const imported = createSymbols(module, unit.imported);
1551
+ const report: ModuleReport = { location: instance.location, errors: [], warnings: [] };
1552
+ unit.reports.push(report);
1553
+ return checkSubstitutions(instance, declarations, module.name, undefined, {
1554
+ imported,
1555
+ getInstance: unit.getInstance,
731
1556
  definitions: unit.definitions,
732
1557
  getKey: unit.getKey,
733
1558
  location: instance.location,
734
1559
  self: undefined,
735
1560
  facts: new Set(),
736
- };
737
- const explicit = new Map(instance.substitutions.map((item) => [item.name, item.expression]));
738
- const position = `in the instance of ${instance.module} at line ${instance.location.line}, column ${instance.location.column}`;
739
- explicit.forEach((_, name) => {
740
- if (declarations.every((declaration) => declaration.name !== name)) {
741
- throw new TlaSyntaxError(
742
- `Identifier '${name}' is not a legal target of a substitution ${position}`,
743
- );
744
- }
1561
+ goals: new Map(),
1562
+ bindings: new Map(
1563
+ [...imported].map(([name, symbol]) => [name, { ...symbol, position: MODULE_START }]),
1564
+ ),
1565
+ errors: report.errors,
1566
+ warnings: report.warnings,
1567
+ hasLabelScope: false,
1568
+ isLabelForbidden: false,
1569
+ isInExcept: false,
1570
+ labelParams: [],
1571
+ labels: new Set(),
1572
+ isGenerated: false,
745
1573
  });
746
- return new Map(
747
- declarations.map((declaration): [string, Expression] => {
748
- const name = declaration.name;
749
- if (!explicit.has(name) && !lookupLocal(scope, name) && !findSymbol(name, context)) {
750
- throw new TlaSyntaxError(`Substitution missing for symbol ${name} ${position}`);
751
- }
752
- const expression: Expression = explicit.get(name) ?? {
753
- kind: "Identifier",
754
- name,
755
- location: instance.location,
756
- };
757
- if (declaration.arity === 0 || expression.kind !== "Identifier") {
758
- resolveExpression(expression, scope, context);
759
- return [name, expression];
760
- }
761
- if (getSymbolArity(expression, expression.name, scope, context) !== declaration.arity) {
762
- throw new TlaSyntaxError(
763
- `An operator must be substituted for symbol '${name}', and it must have arity ${declaration.arity} ${position}`,
764
- );
1574
+ };
1575
+
1576
+ // SANY reports the errors of every unit it checks, in the order of the units in the module, after
1577
+ // the warnings it reports for the spec. A unit reports to its lists what SANY goes on after, and
1578
+ // throws the error that stops it. An error tla-ts cannot word as SANY does yields to the errors the
1579
+ // unit reported before it. Returns the errors.
1580
+ export const collectSemanticErrors = (
1581
+ units: {
1582
+ location: SourceLocation;
1583
+ check: (reported: SanyError[], warned: SanyError[]) => void;
1584
+ }[],
1585
+ warnings: SanyError[],
1586
+ ) => {
1587
+ const errors: SanyError[] = [];
1588
+ const add = (list: SanyError[], item: SanyError) => {
1589
+ if (
1590
+ list.every(
1591
+ (existing) => existing.location !== item.location || existing.message !== item.message,
1592
+ )
1593
+ ) {
1594
+ list.push(item);
1595
+ }
1596
+ };
1597
+ units
1598
+ .toSorted((left, right) =>
1599
+ isBefore(left.location, right.location)
1600
+ ? -1
1601
+ : isBefore(right.location, left.location)
1602
+ ? 1
1603
+ : 0,
1604
+ )
1605
+ .forEach((unit) => {
1606
+ const reported: SanyError[] = [];
1607
+ const warned: SanyError[] = [];
1608
+ try {
1609
+ unit.check(reported, warned);
1610
+ } catch (error) {
1611
+ if (!(error instanceof TlaSyntaxError) || (!error.sany && reported.length === 0)) {
1612
+ throw error;
1613
+ }
1614
+ reported.push(...(error.sany?.errors ?? []));
765
1615
  }
766
- return [name, expression];
767
- }),
768
- );
1616
+ reported.forEach((item) => add(errors, item));
1617
+ warned.forEach((item) => add(warnings, item));
1618
+ });
1619
+ return errors;
769
1620
  };
770
1621
 
1622
+ // SANY binds the names of a module in the order of its units, and reports a RECURSIVE declaration
1623
+ // that no definition follows at the end. Returns the errors.
771
1624
  export const resolveModule = (module: Module, unit: ModuleUnit) => {
772
1625
  const symbols = createSymbols(module, unit.imported);
773
- const facts = new Set(
774
- [...module.theorems, ...module.assumptions].flatMap((fact) => fact.name ?? []),
1626
+ const facts = new Set([
1627
+ ...unit.facts,
1628
+ ...[...module.theorems, ...module.assumptions].flatMap((fact) => fact.name ?? []),
1629
+ ]);
1630
+ const goals = new Map(
1631
+ module.theorems.flatMap((theorem): [string, Goal][] =>
1632
+ theorem.name !== undefined && theorem.statement.kind === "AssumeProve"
1633
+ ? [[theorem.name, { statement: theorem.statement, isSuffices: false, isInProof: false }]]
1634
+ : [],
1635
+ ),
775
1636
  );
776
- const createUnit = (location: SourceLocation, self: Definition | undefined) => ({
1637
+ const bindings = new Map<string, ModuleBinding>(
1638
+ [...CORE_SYMBOLS, ...unit.bound].map(([name, symbol]) => [
1639
+ name,
1640
+ { ...symbol, position: MODULE_START },
1641
+ ]),
1642
+ );
1643
+ const recursive = new Set<Binding>();
1644
+ const declarations: { declaration: Declaration; binding: ModuleBinding | undefined }[] = [];
1645
+ const createUnit = (
1646
+ location: SourceLocation,
1647
+ self: Definition | undefined,
1648
+ errors: SanyError[],
1649
+ warnings: SanyError[],
1650
+ hasLabelScope: boolean,
1651
+ ): Unit => ({
777
1652
  imported: symbols,
1653
+ getInstance: unit.getInstance,
778
1654
  definitions: unit.definitions,
779
1655
  getKey: unit.getKey,
780
1656
  location,
781
1657
  self,
782
1658
  facts,
1659
+ goals,
1660
+ bindings,
1661
+ errors,
1662
+ warnings,
1663
+ hasLabelScope,
1664
+ isLabelForbidden: false,
1665
+ isInExcept: false,
1666
+ labelParams: [],
1667
+ labels: new Set(),
1668
+ isGenerated: false,
783
1669
  });
784
- module.definitions.forEach((definition) =>
785
- resolveDefinition(definition, undefined, createUnit(definition.location, definition)),
786
- );
787
- module.assumptions.forEach((assumption) =>
788
- resolveExpression(assumption.expression, undefined, createUnit(assumption.location, undefined)),
789
- );
790
- module.theorems.forEach((theorem) =>
791
- resolveTheorem(theorem, createUnit(theorem.location, undefined)),
1670
+ const bindDeclarations = (declarations: Declaration[], kind: "Constant" | "Variable") =>
1671
+ declarations.map((declaration) => ({
1672
+ location: declaration.location,
1673
+ check: (errors: SanyError[], warnings: SanyError[]) =>
1674
+ bindModuleName(
1675
+ declaration.name,
1676
+ { kind, arity: declaration.arity, range: declaration.location.range },
1677
+ createUnit(declaration.location, undefined, errors, warnings, false),
1678
+ ),
1679
+ }));
1680
+ return collectSemanticErrors(
1681
+ [
1682
+ ...unit.reports.map((report) => ({
1683
+ location: report.location,
1684
+ check: (errors: SanyError[], warnings: SanyError[]) => {
1685
+ errors.push(...report.errors);
1686
+ warnings.push(...report.warnings);
1687
+ },
1688
+ })),
1689
+ ...bindDeclarations(module.constants, "Constant"),
1690
+ ...bindDeclarations(module.variables, "Variable"),
1691
+ ...module.units
1692
+ .flatMap((item) => (item.kind === "Recursive" ? item.declarations : []))
1693
+ .map((declaration) => ({
1694
+ location: declaration.location,
1695
+ check: (errors: SanyError[], warnings: SanyError[]) => {
1696
+ const binding: ModuleBinding = {
1697
+ kind: "Definition",
1698
+ arity: declaration.arity,
1699
+ range: declaration.location.range,
1700
+ position: declaration.location,
1701
+ isPending: true,
1702
+ };
1703
+ const isBound = isBindable(
1704
+ declaration.name,
1705
+ bindings.get(declaration.name),
1706
+ binding,
1707
+ createUnit(declaration.location, undefined, errors, warnings, false),
1708
+ );
1709
+ if (isBound) {
1710
+ bindings.set(declaration.name, binding);
1711
+ recursive.add(binding);
1712
+ }
1713
+ declarations.push({ declaration, binding: isBound ? binding : undefined });
1714
+ },
1715
+ })),
1716
+ ...module.definitions.map((definition) => ({
1717
+ location: definition.location,
1718
+ check: (errors: SanyError[], warnings: SanyError[]) => {
1719
+ const inner = createUnit(definition.location, definition, errors, warnings, true);
1720
+ if (isTheoremDefinition(module, definition)) {
1721
+ resolveExpression(definition.body, undefined, inner);
1722
+ } else if (resolveDefinition(definition, undefined, inner, recursive)) {
1723
+ bindings.set(definition.name, {
1724
+ kind: "Definition",
1725
+ arity: getArity(definition),
1726
+ range: definition.location.range,
1727
+ position: definition.location,
1728
+ });
1729
+ }
1730
+ },
1731
+ })),
1732
+ ...module.instances.map((instance) => ({
1733
+ location: instance.location,
1734
+ check: (errors: SanyError[], warnings: SanyError[]) => {
1735
+ const inner = createUnit(instance.location, undefined, errors, warnings, false);
1736
+ bindParams(undefined, instance.params, inner);
1737
+ unit.instanced
1738
+ .get(instance)
1739
+ ?.forEach((symbol, name) => bindModuleName(name, symbol, inner));
1740
+ if (instance.name !== undefined) {
1741
+ bindModuleName(
1742
+ instance.name,
1743
+ { kind: "Instance", arity: instance.params.length, range: instance.location.range },
1744
+ inner,
1745
+ );
1746
+ }
1747
+ },
1748
+ })),
1749
+ ...module.assumptions.map((assumption) => ({
1750
+ location: assumption.location,
1751
+ check: (errors: SanyError[], warnings: SanyError[]) => {
1752
+ const inner = createUnit(
1753
+ assumption.location,
1754
+ undefined,
1755
+ errors,
1756
+ warnings,
1757
+ assumption.name !== undefined,
1758
+ );
1759
+ resolveExpression(assumption.expression, undefined, inner);
1760
+ if (assumption.name !== undefined) {
1761
+ bindModuleName(
1762
+ assumption.name,
1763
+ { kind: "Theorem", arity: 0, range: assumption.location.range },
1764
+ inner,
1765
+ );
1766
+ }
1767
+ },
1768
+ })),
1769
+ ...module.theorems.map((theorem) => ({
1770
+ location: theorem.location,
1771
+ check: (errors: SanyError[], warnings: SanyError[]) =>
1772
+ resolveTheorem(
1773
+ theorem,
1774
+ createUnit(theorem.location, undefined, errors, warnings, theorem.name !== undefined),
1775
+ ),
1776
+ })),
1777
+ ...module.uses.map((use) => ({
1778
+ location: use.location,
1779
+ check: (errors: SanyError[], warnings: SanyError[]) =>
1780
+ checkFacts(
1781
+ use.facts,
1782
+ undefined,
1783
+ createUnit(use.location, undefined, errors, warnings, false),
1784
+ ),
1785
+ })),
1786
+ {
1787
+ location: module.location.range?.end ?? module.location,
1788
+ check: (errors: SanyError[]) =>
1789
+ declarations.forEach((item) => {
1790
+ const range = item.declaration.location.range;
1791
+ if (range && (!item.binding || item.binding.isPending)) {
1792
+ errors.push({
1793
+ location: formatRange(range),
1794
+ message: `Symbol ${item.declaration.name} declared in RECURSIVE statement but not defined.`,
1795
+ });
1796
+ }
1797
+ }),
1798
+ },
1799
+ ],
1800
+ unit.warnings,
792
1801
  );
793
1802
  };