tla-ts 0.0.3-dev.a57ca4f → 0.0.3-dev.ab42bab

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.
package/src/resolve.ts CHANGED
@@ -13,9 +13,16 @@ import {
13
13
  type Proof,
14
14
  type ProofStep,
15
15
  type SourceLocation,
16
+ type SourceRange,
16
17
  type Theorem,
17
18
  } from "./ast";
18
- import { TlaSyntaxError } from "./errors";
19
+ import {
20
+ createSanyError,
21
+ createSemanticError,
22
+ formatRange,
23
+ TlaSyntaxError,
24
+ type SanyError,
25
+ } from "./errors";
19
26
 
20
27
  export interface ModuleSymbol {
21
28
  key: string;
@@ -103,6 +110,21 @@ const findSymbol = (name: string, unit: Unit): ModuleSymbol | undefined => {
103
110
  : unit.imported.get(name);
104
111
  };
105
112
 
113
+ // SANY reports a name at the range of its text.
114
+ const getNameRange = (location: SourceLocation, name: string): SourceRange => ({
115
+ module: location.range?.module ?? "",
116
+ start: location,
117
+ end: { line: location.line, column: location.column + name.length - 1 },
118
+ });
119
+
120
+ // SANY reports an operator symbol applied to operands as one it cannot resolve.
121
+ const getFixity = (expression: Expression) => {
122
+ if (expression.kind !== "Apply") return undefined;
123
+ if (expression.args.length === 2) return "infix";
124
+ if (expression.args.length !== 1) return undefined;
125
+ return isBefore(expression.location, expression.args[0].location) ? "prefix" : "postfix";
126
+ };
127
+
106
128
  // SANY names an undefined operator symbol such as + differently from an undefined identifier.
107
129
  const isOperatorSymbol = (name: string) =>
108
130
  name[0].toLowerCase() === name[0].toUpperCase() &&
@@ -135,7 +157,7 @@ const getSymbolArity = (
135
157
  }
136
158
  // A name such as Inv!P1 selects the label P1 of a definition or theorem, which takes its own
137
159
  // arguments.
138
- const prefix = name.slice(0, name.indexOf("!"));
160
+ const prefix = name.includes("!") ? name.slice(0, name.indexOf("!")) : "";
139
161
  const isSelected =
140
162
  prefix !== "" &&
141
163
  (lookupLocal(scope, prefix) !== undefined ||
@@ -144,11 +166,23 @@ const getSymbolArity = (
144
166
  if (isSelected) {
145
167
  return expression.kind === "Apply" ? expression.args.length : 0;
146
168
  }
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}`,
169
+ const range = getNameRange(location, name === "-." ? "-" : name);
170
+ if (!isOperatorSymbol(name)) throw createSemanticError(`Unknown operator: \`${name}'.`, range);
171
+ const missing = {
172
+ location: formatRange(range),
173
+ message: `Could not find declaration or definition of symbol '${name}'.`,
174
+ };
175
+ const fixity = getFixity(expression);
176
+ throw createSanyError(
177
+ fixity && location.range
178
+ ? [
179
+ missing,
180
+ {
181
+ location: formatRange(location.range),
182
+ message: `Couldn't resolve ${fixity} operator symbol \`${name}'.`,
183
+ },
184
+ ]
185
+ : [missing],
152
186
  );
153
187
  };
154
188
 
@@ -235,13 +269,13 @@ const resolveApply = (
235
269
  scope: LocalName | undefined,
236
270
  unit: Unit,
237
271
  ) => {
238
- const callee = lookupLocal(scope, expression.operator)
239
- ? undefined
240
- : getVisibleDefinition(expression.operator, unit);
241
- const arity = getSymbolArity(expression, expression.operator, scope, unit);
272
+ const operator = expression.operator;
273
+ const callee = lookupLocal(scope, operator) ? undefined : getVisibleDefinition(operator, unit);
274
+ const arity = getSymbolArity(expression, operator, scope, unit);
242
275
  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}`,
276
+ throw createSemanticError(
277
+ `The operator ${operator} requires ${arity} arguments.`,
278
+ expression.argumentsRange ?? getNameRange(expression.location, operator),
245
279
  );
246
280
  }
247
281
  expression.args.forEach((arg, index) => {
@@ -275,10 +309,12 @@ const resolveExpression = (
275
309
  case "ExceptAt":
276
310
  return;
277
311
  case "Identifier": {
278
- const arity = getSymbolArity(expression, expression.name, scope, unit);
312
+ const name = expression.name;
313
+ const arity = getSymbolArity(expression, name, scope, unit);
279
314
  if (arity > 0) {
280
- throw new TlaSyntaxError(
281
- `The operator ${expression.name} requires ${arity} arguments at line ${expression.location.line}, column ${expression.location.column}`,
315
+ throw createSemanticError(
316
+ `The operator ${name} requires ${arity} arguments.`,
317
+ getNameRange(expression.location, name),
282
318
  );
283
319
  }
284
320
  return;
@@ -347,14 +383,21 @@ const resolveExpression = (
347
383
  resolveAll([expression.domain, expression.range]);
348
384
  return;
349
385
  case "Record":
350
- 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}`,
386
+ case "RecordSet": {
387
+ const repeated = expression.fields.filter((field, index) =>
388
+ expression.fields.slice(0, index).some((earlier) => earlier.name === field.name),
389
+ );
390
+ if (repeated.length > 0) {
391
+ throw createSanyError(
392
+ repeated.map((field) => ({
393
+ location: formatRange(field.location.range ?? getNameRange(field.location, field.name)),
394
+ message: "Non-unique fields in constructor.",
395
+ })),
354
396
  );
355
397
  }
356
398
  resolveAll(expression.fields.map((field) => field.value));
357
399
  return;
400
+ }
358
401
  case "Except":
359
402
  resolveAll([
360
403
  expression.function,
@@ -769,6 +812,29 @@ export const resolveSubstitutions = (
769
812
  );
770
813
  };
771
814
 
815
+ // SANY reports the errors of every unit it checks, in the order of the units in the module.
816
+ export const collectSemanticErrors = (units: { location: SourceLocation; check: () => void }[]) => {
817
+ const errors: SanyError[] = [];
818
+ units
819
+ .toSorted((left, right) => (isBefore(left.location, right.location) ? -1 : 1))
820
+ .forEach((unit) => {
821
+ try {
822
+ unit.check();
823
+ } catch (error) {
824
+ if (!(error instanceof TlaSyntaxError) || !error.sany) throw error;
825
+ error.sany.errors
826
+ .filter((item) =>
827
+ errors.every(
828
+ (existing) =>
829
+ existing.location !== item.location || existing.message !== item.message,
830
+ ),
831
+ )
832
+ .forEach((item) => errors.push(item));
833
+ }
834
+ });
835
+ if (errors.length > 0) throw createSanyError(errors);
836
+ };
837
+
772
838
  export const resolveModule = (module: Module, unit: ModuleUnit) => {
773
839
  const symbols = createSymbols(module, unit.imported);
774
840
  const facts = new Set(
@@ -782,13 +848,24 @@ export const resolveModule = (module: Module, unit: ModuleUnit) => {
782
848
  self,
783
849
  facts,
784
850
  });
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)),
793
- );
851
+ collectSemanticErrors([
852
+ ...module.definitions.map((definition) => ({
853
+ location: definition.location,
854
+ check: () =>
855
+ resolveDefinition(definition, undefined, createUnit(definition.location, definition)),
856
+ })),
857
+ ...module.assumptions.map((assumption) => ({
858
+ location: assumption.location,
859
+ check: () =>
860
+ resolveExpression(
861
+ assumption.expression,
862
+ undefined,
863
+ createUnit(assumption.location, undefined),
864
+ ),
865
+ })),
866
+ ...module.theorems.map((theorem) => ({
867
+ location: theorem.location,
868
+ check: () => resolveTheorem(theorem, createUnit(theorem.location, undefined)),
869
+ })),
870
+ ]);
794
871
  };
package/src/run-cli.ts CHANGED
@@ -14,12 +14,14 @@ import type { CheckResult, CheckStatus, TraceStep } from "./check";
14
14
  import { defineCommand, type ParsedArgs } from "./cli-options";
15
15
  import { parseConfig } from "./config";
16
16
  import {
17
+ createSanyError,
17
18
  getErrorExitCode,
18
19
  TlaConfigError,
19
20
  TlaError,
20
21
  TlaEvaluationError,
21
22
  TlaProofError,
22
23
  TlaSyntaxError,
24
+ type SanyReport,
23
25
  } from "./errors";
24
26
  import { EXIT_STATUS } from "./exit-codes";
25
27
  import type { LineRange } from "./obligation-generate";
@@ -143,6 +145,15 @@ const printResult = (result: CheckResult) => {
143
145
  printState(result.failure.initialState);
144
146
  }
145
147
  printTrace(result.failure.trace);
148
+ const replay = result.failure.replay;
149
+ replay?.output.forEach((line) => console.log(line));
150
+ if (replay?.callStack) {
151
+ const frames = replay.callStack.map((frame, index) => `${index}. ${frame}\n`).join("");
152
+ console.log(
153
+ `Error: The error occurred when TLC was evaluating the nested\nexpressions at the following positions:\n${frames ? `${frames}\n` : " The error call stack is empty.\n"}`,
154
+ );
155
+ }
156
+ if (result.failure.isWithoutStatistics) return;
146
157
  } else if (result.violation) {
147
158
  const violation = result.violation;
148
159
  const name = violation.name;
@@ -219,8 +230,14 @@ const checkSpec = async (specPath: string, args: ParsedArgs) => {
219
230
  const fileName = basename(specPath, ".tla");
220
231
  const moduleName = parseModule(source).name;
221
232
  if (moduleName !== fileName) {
222
- throw new TlaSyntaxError(
223
- `File name '${fileName}' does not match the name '${moduleName}' of the top level module it contains.`,
233
+ throw createSanyError(
234
+ [
235
+ {
236
+ location: "Unknown location",
237
+ message: `File name '${fileName}' does not match the name '${moduleName}' of the top level module it contains.`,
238
+ },
239
+ ],
240
+ true,
224
241
  );
225
242
  }
226
243
  const configPath =
@@ -286,21 +303,32 @@ const checkSpec = async (specPath: string, args: ParsedArgs) => {
286
303
  return result.failure?.exitCode ?? EXIT_CODES[result.status];
287
304
  };
288
305
 
289
- // TLC prints the errors it raises itself. tla-ts names the others, such as a module SANY rejects.
290
- const printError = (error: TlaError) => {
306
+ const formatSanyErrors = (report: SanyReport) =>
307
+ `*** Errors: ${report.errors.length}\n\n${report.errors.map((error) => `${error.location}\n\n${error.message}\n\n`).join("\n")}`;
308
+
309
+ // TLC prints the errors it raises itself, and SANY's report of a spec it rejects. tla-ts names the
310
+ // others, such as a module it cannot parse.
311
+ const printError = (error: TlaError, path?: string) => {
291
312
  if (error instanceof TlaConfigError || error instanceof TlaEvaluationError) {
292
313
  return console.log(`Error: ${error.message}`);
293
314
  }
294
- console.error(`${error.name}: ${error.message}`);
315
+ const report = error instanceof TlaSyntaxError ? error.sany : undefined;
316
+ if (!report || path === undefined) return console.error(`${error.name}: ${error.message}`);
317
+ console.log(
318
+ report.isFatal
319
+ ? `\nFatal errors while parsing TLA+ spec in file ${basename(path, ".tla")}\n\n${report.errors.map((item) => `${item.location}\n\n${item.message}\n`).join("")}${formatSanyErrors(report)}\n`
320
+ : `Semantic errors:\n\n${formatSanyErrors(report)}`,
321
+ );
322
+ console.log("Error: Parsing or semantic analysis failed.");
295
323
  };
296
324
 
297
325
  // Prints a TlaError and returns its exit code.
298
- const reportErrors = async (run: () => number | Promise<number>) => {
326
+ const reportErrors = async (run: () => number | Promise<number>, path?: string) => {
299
327
  try {
300
328
  return await run();
301
329
  } catch (error) {
302
330
  if (!(error instanceof TlaError)) throw error;
303
- printError(error);
331
+ printError(error, path);
304
332
  return getErrorExitCode(error);
305
333
  }
306
334
  };
@@ -311,7 +339,7 @@ const runEach = async (paths: string[], runPath: (path: string) => number | Prom
311
339
  const exitCodes: number[] = [];
312
340
  for (const [index, path] of paths.entries()) {
313
341
  if (index > 0) console.log("");
314
- exitCodes.push(await reportErrors(() => runPath(path)));
342
+ exitCodes.push(await reportErrors(() => runPath(path), path));
315
343
  }
316
344
  return exitCodes.find((exitCode) => exitCode !== EXIT_STATUS.success) ?? EXIT_STATUS.success;
317
345
  };
@@ -7,13 +7,12 @@ import {
7
7
  } from "./ast";
8
8
  import type { ModelConfig } from "./config";
9
9
  import type { InstanceAction } from "./environment";
10
- import { TlaError } from "./errors";
10
+ import { formatRange, TlaError } from "./errors";
11
11
  import {
12
12
  bindDefinitions,
13
13
  bindOperatorArguments,
14
14
  evaluate,
15
15
  forEachBinding,
16
- formatRange,
17
16
  getDefinition,
18
17
  isConstantLevel,
19
18
  lookupScope,
package/src/successors.ts CHANGED
@@ -7,7 +7,7 @@ import {
7
7
  type QuantifierExpression,
8
8
  } from "./ast";
9
9
  import { getReadVariables } from "./dependencies";
10
- import { TlaEvaluationError, UNEXPECTED_EXCEPTION } from "./errors";
10
+ import { TlaEvaluationError, TlaIllegalStateError, TlaIncompleteStateError } from "./errors";
11
11
  import { EXIT_STATUS, setExitCode } from "./exit-codes";
12
12
  import {
13
13
  describeLocation,
@@ -18,6 +18,7 @@ import {
18
18
  bindValue,
19
19
  compileArgumentScope,
20
20
  evaluate,
21
+ getEntryEvaluator,
21
22
  expectBoolean,
22
23
  forEachBinding,
23
24
  getBoundsDomain,
@@ -29,6 +30,7 @@ import {
29
30
  resolveGlobalOperator,
30
31
  type Context,
31
32
  type Environment,
33
+ type Evaluator,
32
34
  type Scope,
33
35
  type State,
34
36
  } from "./evaluate";
@@ -87,25 +89,54 @@ const assign = (partial: State, index: number, value: Value) => {
87
89
  return copy;
88
90
  };
89
91
 
90
- const holds = (expression: Expression, context: Context) => {
91
- const value = evaluate(expression, context);
92
+ // TLC's Tool.getInitStates and Tool.getNextStates report a value where they expect a formula.
93
+ const expectFormula = (expression: Expression, value: Value, isInit: boolean) => {
92
94
  if (typeof value === "boolean") return value;
93
- try {
94
- return expectBoolean(value, `the action at ${describeLocation(expression)}`);
95
- } catch (error) {
96
- // TLC fails with an unexpected exception when the next-state relation isn't a boolean.
97
- throw context.next === undefined ? error : setExitCode(error, EXIT_STATUS.error);
95
+ throw new TlaEvaluationError(
96
+ `In computing ${isInit ? "initial" : "next"} states, TLC expected a boolean expression,\nbut instead found ${formatValue(value)}.\n${describeRange(expression)}`,
97
+ );
98
+ };
99
+
100
+ const holds = (expression: Expression, context: Context, value = evaluate(expression, context)) => {
101
+ // TLC rejects a number in the next-state relation when it splits the relation into actions.
102
+ if (context.next !== undefined && expression.kind === "Number") {
103
+ throw setExitCode(
104
+ new TlaEvaluationError(
105
+ `The next state relation is not a boolean expression.\n${expression.text ?? expression.value}`,
106
+ ),
107
+ EXIT_STATUS.error,
108
+ );
98
109
  }
110
+ return expectFormula(expression, value, context.next === undefined);
99
111
  };
100
112
 
101
113
  const isAssignmentOperator = (operator: string) =>
102
114
  operator === "=" || operator === "\\in" || operator === "\\subseteq";
103
115
 
116
+ const tracedRunners = new WeakMap<Environment, WeakMap<Expression, Runner>[]>();
117
+
118
+ const getRunners = (environment: Environment, isInit: boolean) => {
119
+ if (!environment.trace) return isInit ? initRunners : nextRunners;
120
+ const runners = tracedRunners.get(environment) ?? [new WeakMap(), new WeakMap()];
121
+ tracedRunners.set(environment, runners);
122
+ return runners[isInit ? 0 : 1];
123
+ };
124
+
104
125
  const getRunner = (expression: Expression, environment: Environment, isInit: boolean): Runner => {
105
- const runners = isInit ? initRunners : nextRunners;
126
+ const runners = getRunners(environment, isInit);
106
127
  const cached = runners.get(expression);
107
128
  if (cached) return cached;
108
- const runner = compileAction(expression, environment, isInit);
129
+ const compiled = compileAction(expression, environment, isInit);
130
+ const trace = environment.trace;
131
+ // TLC's CallStackTool keeps an action's expression on the stack while the rest of the action runs.
132
+ const runner: Runner = trace
133
+ ? (run, scope, partial, action, isFixed, onComplete) => {
134
+ const depth = trace.length;
135
+ trace.push(expression);
136
+ compiled(run, scope, partial, action, isFixed, onComplete);
137
+ trace.length = depth;
138
+ }
139
+ : compiled;
109
140
  runners.set(expression, runner);
110
141
  return runner;
111
142
  };
@@ -189,6 +220,23 @@ const getUnchangedIndices = (
189
220
  return getUnchangedIndices(definition.body, environment, visited);
190
221
  };
191
222
 
223
+ // TLC's CallStackTool keeps each expression that UNCHANGED takes apart on the stack.
224
+ const getUnchangedFrames = (expression: Expression, environment: Environment): Expression[] => {
225
+ if (expression.kind === "Tuple") {
226
+ return [
227
+ expression,
228
+ ...expression.elements.flatMap((element) => getUnchangedFrames(element, environment)),
229
+ ];
230
+ }
231
+ const definition =
232
+ expression.kind === "Identifier" && !environment.variableIndex.has(expression.name)
233
+ ? getZeroArityBody(expression.name, environment)
234
+ : undefined;
235
+ return definition
236
+ ? [expression, ...getUnchangedFrames(definition.body, environment)]
237
+ : [expression];
238
+ };
239
+
192
240
  const ACTION_KINDS = new Set([
193
241
  "Label",
194
242
  "And",
@@ -320,6 +368,8 @@ const compileConjunction = (
320
368
  isInit: boolean,
321
369
  ): Runner => {
322
370
  const conjuncts = operands.map((operand) => toConjunct(operand, environment, isInit));
371
+ const evaluators: (Evaluator | undefined)[] = conjuncts.map(() => undefined);
372
+ const trace = environment.trace;
323
373
  const runFrom = (
324
374
  start: number,
325
375
  run: Run,
@@ -340,14 +390,25 @@ const compileConjunction = (
340
390
  return;
341
391
  }
342
392
  const conjunct = conjuncts[index];
393
+ if (trace) {
394
+ trace.push(conjunct.expression);
395
+ if (conjunct.expression.kind === "Unchanged") {
396
+ trace.push(...getUnchangedFrames(conjunct.expression.expression, environment));
397
+ }
398
+ }
343
399
  if (conjunct.kind === "Guard") {
344
400
  context ??= getContext(run, scope, current);
345
- if (!holds(conjunct.expression, context)) return;
401
+ const evaluator = (evaluators[index] ??= getEntryEvaluator(
402
+ conjunct.expression,
403
+ environment,
404
+ ));
405
+ if (!holds(conjunct.expression, context, evaluator(context))) return;
346
406
  continue;
347
407
  }
348
408
  if (conjunct.kind === "Assign") {
349
409
  context ??= getContext(run, scope, current);
350
- const value = evaluate(conjunct.value, context);
410
+ const evaluator = (evaluators[index] ??= getEntryEvaluator(conjunct.value, environment));
411
+ const value = evaluator(context);
351
412
  const assigned = current[conjunct.index];
352
413
  if (assigned === undefined) {
353
414
  current = assign(current, conjunct.index, value);
@@ -384,10 +445,7 @@ const compileConjunction = (
384
445
  };
385
446
 
386
447
  const holdsInInit = (expression: Expression, context: Context) =>
387
- expectBoolean(
388
- evaluate(expression, context),
389
- `the initial predicate at ${describeLocation(expression)}`,
390
- );
448
+ expectFormula(expression, evaluate(expression, context), true);
391
449
 
392
450
  const compileGuard =
393
451
  (expression: Expression): Runner =>
@@ -412,7 +470,7 @@ const compileMembership = (
412
470
  expression.operator === "\\subseteq" ? { kind: "Subset", base: evaluated } : evaluated;
413
471
  if (!isEnumerable(value)) {
414
472
  throw new TlaEvaluationError(
415
- `In computing next states, the right side of \\in is not enumerable: ${formatValue(value)} at ${describeLocation(expression)}`,
473
+ `In computing ${run.isInit ? "initial" : "next"} states, the right side of \\IN is not enumerable.\n${describeRange(expression)}`,
416
474
  );
417
475
  }
418
476
  const elements = getStreamedElements(value);
@@ -756,7 +814,8 @@ const compileAction = (
756
814
  }
757
815
  };
758
816
  }
759
- const hoisted = isInit ? undefined : getHoistedGuards(expression, environment);
817
+ const hoisted =
818
+ isInit || environment.trace ? undefined : getHoistedGuards(expression, environment);
760
819
  if (hoisted) {
761
820
  const rest = compileConjunction(hoisted.rest, environment, isInit);
762
821
  return (run, scope, partial, action, isFixed, onComplete) => {
@@ -859,7 +918,7 @@ const compileAction = (
859
918
  const body = arm?.body ?? other;
860
919
  if (!body)
861
920
  throw new TlaEvaluationError(
862
- `${UNEXPECTED_EXCEPTION}In computing next states, TLC encountered a CASE with no conditions true.\n${describeRange(expression)}`,
921
+ `In computing ${run.isInit ? "initial" : "next"} states, TLC encountered a CASE with no conditions true.\n${describeRange(expression)}`,
863
922
  );
864
923
  body(run, scope, partial, action, isFixed, onComplete);
865
924
  };
@@ -1000,14 +1059,7 @@ export const forEachInitialState = (
1000
1059
  (partial) => {
1001
1060
  if (run.isStopped) return;
1002
1061
  if (!isComplete(partial)) {
1003
- // TLC reports an initial state that isn't completely specified as an illegal state, not as
1004
- // an evaluation failure.
1005
- throw setExitCode(
1006
- new TlaEvaluationError(
1007
- `The initial predicate does not assign ${getMissingVariables(partial, environment).join(", ")}`,
1008
- ),
1009
- EXIT_STATUS.error,
1010
- );
1062
+ throw setExitCode(new TlaIllegalStateError(partial), EXIT_STATUS.error);
1011
1063
  }
1012
1064
  run.isStopped = onState(partial);
1013
1065
  },
@@ -1050,8 +1102,10 @@ export const forEachSuccessor = (
1050
1102
  (partial, action) => {
1051
1103
  if (run.isStopped) return;
1052
1104
  if (!isComplete(partial)) {
1053
- throw new TlaEvaluationError(
1054
- `Successor state is not completely specified by action ${action ?? "Next"}. The following variables are not assigned: ${getMissingVariables(partial, environment).join(", ")}`,
1105
+ throw new TlaIncompleteStateError(
1106
+ partial,
1107
+ action,
1108
+ getMissingVariables(partial, environment).sort(),
1055
1109
  );
1056
1110
  }
1057
1111
  counter.successors++;
package/src/symmetry.ts CHANGED
@@ -1,5 +1,6 @@
1
- import { TlaConfigError } from "./errors";
1
+ import { TlaConfigError, TlaEvaluationError, UNEXPECTED_EXCEPTION } from "./errors";
2
2
  import { evaluate, type Environment } from "./evaluate";
3
+ import { EXIT_STATUS, setExitCode } from "./exit-codes";
3
4
  import {
4
5
  compareValues,
5
6
  createFunction,
@@ -47,9 +48,13 @@ const composePermutations = (first: Images, second: Images) => {
47
48
  return composed;
48
49
  };
49
50
 
50
- const toImages = (value: Value, name: string) => {
51
+ // TLC checks the symmetry set outside any phase that reports an error itself.
52
+ const createSymmetryError = (message: string) =>
53
+ setExitCode(new TlaEvaluationError(`${UNEXPECTED_EXCEPTION}${message}`), EXIT_STATUS.error);
54
+
55
+ const toImages = (value: Value) => {
51
56
  if (!isFunctionValue(value)) {
52
- throw new TlaConfigError(`The symmetry values of ${name} must be functions`);
57
+ throw createSymmetryError("The symmetry values must be function records.");
53
58
  }
54
59
  const functionValue = toFiniteFunction(value);
55
60
  const permutation: Images = new Map();
@@ -65,8 +70,13 @@ const toImages = (value: Value, name: string) => {
65
70
 
66
71
  export const getSymmetryGroup = (name: string, environment: Environment): Permutation[] => {
67
72
  const definition = environment.definitions.get(name);
73
+ if (definition === undefined && !environment.constants.has(name)) {
74
+ throw new TlaConfigError(
75
+ `The symmetry function ${name} specified in the configuration file\nis not defined in the specification.`,
76
+ );
77
+ }
68
78
  if (definition?.kind !== "Operator" || definition.params.length > 0) {
69
- throw new TlaConfigError(`The symmetry function ${name} must specify a set of permutations`);
79
+ throw createSymmetryError(`The symmetry function ${name} must specify a set of permutations.`);
70
80
  }
71
81
  const value = evaluate(definition.body, {
72
82
  environment,
@@ -75,9 +85,9 @@ export const getSymmetryGroup = (name: string, environment: Environment): Permut
75
85
  next: undefined,
76
86
  });
77
87
  if (!isSetValue(value) || !isEnumerable(value)) {
78
- throw new TlaConfigError("The symmetry operator must specify a set of functions");
88
+ throw createSymmetryError("The symmetry operator must specify a set of functions.");
79
89
  }
80
- const permutations = toFiniteSet(value).elements.map((element) => toImages(element, name));
90
+ const permutations = toFiniteSet(value).elements.map(toImages);
81
91
  const isDisabled =
82
92
  definition.body.kind === "Apply" && definition.body.args.length >= permutations.length;
83
93
  if (isDisabled) return [];