tla-ts 0.0.3-dev.037ac3b → 0.0.3-dev.0ad0249

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