tla-ts 0.0.3-dev.366c320 → 0.0.3-dev.367c92f

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 (49) hide show
  1. package/README.md +5 -1
  2. package/dist/index.cjs +1 -1
  3. package/dist/index.d.cts +53 -22
  4. package/dist/index.d.ts +53 -22
  5. package/dist/index.js +1 -1
  6. package/dist/parallel-worker.cjs +1 -1
  7. package/dist/parallel-worker.js +2 -2
  8. package/dist/parallel.cjs +1 -1
  9. package/dist/parallel.js +2 -2
  10. package/dist/run-cli.cjs +19 -17
  11. package/dist/run-cli.js +20 -18
  12. package/dist/transfer.cjs +33 -17
  13. package/dist/transfer.js +33 -17
  14. package/package.json +1 -1
  15. package/src/ast.ts +3 -0
  16. package/src/builtins.ts +9 -3
  17. package/src/check.ts +455 -93
  18. package/src/cli-options.ts +11 -5
  19. package/src/codegen.ts +6 -3
  20. package/src/config.ts +224 -170
  21. package/src/environment.ts +114 -19
  22. package/src/errors.ts +78 -1
  23. package/src/evaluate.ts +182 -26
  24. package/src/exit-codes.ts +22 -3
  25. package/src/fingerprints.ts +2 -1
  26. package/src/instances.ts +4 -4
  27. package/src/levels.ts +63 -28
  28. package/src/live-check.ts +132 -70
  29. package/src/liveness.ts +117 -22
  30. package/src/parallel-worker.ts +2 -2
  31. package/src/parallel.ts +5 -2
  32. package/src/parser.ts +57 -16
  33. package/src/resolve.ts +106 -29
  34. package/src/run-cli.ts +103 -18
  35. package/src/runtime.ts +2 -0
  36. package/src/spec-description.ts +12 -6
  37. package/src/standard-modules.ts +54 -45
  38. package/src/state-graph.ts +157 -0
  39. package/src/substitution-levels.ts +17 -9
  40. package/src/successors.ts +169 -33
  41. package/src/symmetry.ts +16 -6
  42. package/src/tableau.ts +51 -24
  43. package/src/tlc-module.ts +11 -5
  44. package/src/tlc-modules.ts +4 -0
  45. package/src/tlc-order.ts +8 -4
  46. package/src/tlc-random.ts +9 -6
  47. package/src/tlc-summary.ts +20 -5
  48. package/src/value-sources.ts +29 -0
  49. package/src/values.ts +242 -61
package/src/evaluate.ts CHANGED
@@ -10,16 +10,16 @@ import {
10
10
  type NumberExpression,
11
11
  type OperatorParam,
12
12
  type RecordField,
13
- type SourceRange,
14
13
  } from "./ast";
15
14
  import { getKindString } from "./builtins";
16
- import { TlaEvaluationError } from "./errors";
17
- import { EXIT_STATUS, setExitCode } from "./exit-codes";
15
+ import { formatRange, TlaEvaluationError, TlaUnassignedError } from "./errors";
16
+ import { EXIT_STATUS, setExitCode, setOwnExitCode } from "./exit-codes";
18
17
  import { generateEvaluator } from "./codegen";
19
18
  import type { CheckerRuntime } from "./runtime";
20
19
  import { getReadVariables } from "./dependencies";
21
20
  import { contextualApplications, mapChildren, substitutedExpressions } from "./instances";
22
21
  import { isEnabled } from "./successors";
22
+ import { getFingerprintTrace, valueSources, withSource } from "./value-sources";
23
23
  import {
24
24
  applyFunction,
25
25
  combineHash,
@@ -30,23 +30,28 @@ import {
30
30
  createSortedSet,
31
31
  createWrittenRecord,
32
32
  createTuple,
33
+ describeMissingField,
33
34
  formatValue,
34
35
  getDomain,
35
36
  getFunctionDomain,
36
37
  getIntervalElements,
38
+ getLazySubsets,
37
39
  getSequenceElements,
38
40
  getValueHash,
39
- isEnumerable,
40
41
  isFunctionValue,
41
42
  isOverriddenSet,
43
+ isRecordValue,
42
44
  isSameValue,
43
45
  markLambdaFunction,
46
+ isReducible,
44
47
  isSetValue,
45
48
  MAXIMUM_INTEGER,
46
49
  MINIMUM_INTEGER,
47
50
  toFiniteSet,
48
51
  updateFunction,
49
52
  valuesEqual,
53
+ type FilteredSetValue,
54
+ type FunctionValue,
50
55
  type LazyFunctionSource,
51
56
  type LazyFunctionValue,
52
57
  type Value,
@@ -114,6 +119,7 @@ export interface Environment {
114
119
  definitionValues: Map<Definition, Value>;
115
120
  constantLevels: Map<Definition, boolean>;
116
121
  evaluators: WeakMap<Expression, Evaluator>;
122
+ trace?: Expression[];
117
123
  }
118
124
 
119
125
  export interface Context {
@@ -143,9 +149,6 @@ const EXCEPT_AT = "@";
143
149
  export const describeLocation = (expression: Expression) =>
144
150
  `line ${expression.location.line}, column ${expression.location.column}`;
145
151
 
146
- export const formatRange = (range: SourceRange) =>
147
- `line ${range.start.line}, col ${range.start.column} to line ${range.end.line}, col ${range.end.column} of module ${range.module}`;
148
-
149
152
  export const describeRange = (expression: Expression) => {
150
153
  const range = expression.location.range;
151
154
  return range ? formatRange(range) : describeLocation(expression);
@@ -182,8 +185,17 @@ export const getConjunctError = (
182
185
  };
183
186
 
184
187
  export const getFieldError =
185
- (expression: Expression & { kind: "FieldAccess" }) => (record: Value) =>
186
- `Attempted to select nonexistent field "${expression.field}" from the record\n${formatValue(record)}\n${describeRange(expression)}`;
188
+ (expression: Expression & { kind: "FieldAccess" }) => (record: FunctionValue) =>
189
+ isRecordValue(record)
190
+ ? `Attempted to select nonexistent field "${expression.field}" from the record\n${formatValue(record)}\n${describeRange(expression)}`
191
+ : describeMissingField(record, expression.field);
192
+
193
+ export const getNonFunctionError = (expression: Expression) => (value: Value) =>
194
+ `A non-function (${getKindString(value)}) was applied as a function.\n${describeRange(expression)}`;
195
+
196
+ export const getNonRecordError =
197
+ (expression: Expression & { kind: "FieldAccess" }) => (value: Value) =>
198
+ `Attempted to select field "${expression.field}" from a non-record value ${formatValue(value)}\n${describeRange(expression)}`;
187
199
 
188
200
  export const getDomainOperator = (expression: Expression) => (value: Value) => {
189
201
  if (!isFunctionValue(value)) {
@@ -331,9 +343,8 @@ export const getEnumeratedElements = (set: Value, expression: Expression) => {
331
343
  : `TLC encountered the non-enumerable quantifier bound\n${text}\n${describeRange(expression)}\n${explanation}`,
332
344
  );
333
345
  }
334
- return typeof set === "object" && set.kind === "Interval"
335
- ? getIntervalElements(set)
336
- : toFiniteSet(set).elements;
346
+ if (typeof set === "object" && set.kind === "Interval") return getIntervalElements(set);
347
+ return getLazySubsets(set) ?? toFiniteSet(set).elements;
337
348
  };
338
349
 
339
350
  export const forEachBinding = (
@@ -1011,23 +1022,88 @@ const isStateCached = (expression: Expression, environment: Environment) =>
1011
1022
  getReadVariables(expression, environment) !== undefined &&
1012
1023
  !hasFreeLocals(expression, NO_BOUND_NAMES);
1013
1024
 
1025
+ // CallStackTool also evaluates the predicate of a lazy set filter it returns, even one that TLC
1026
+ // made before the replay.
1027
+ const filteredSetRetracers = new WeakMap<
1028
+ FilteredSetValue,
1029
+ (environment: Environment) => FilteredSetValue
1030
+ >();
1031
+
1032
+ const SOURCED_KINDS = new Set<Expression["kind"]>([
1033
+ "SetEnumeration",
1034
+ "SetMap",
1035
+ "SetFilter",
1036
+ "Tuple",
1037
+ "Record",
1038
+ "RecordSet",
1039
+ "FunctionSet",
1040
+ "Product",
1041
+ ]);
1042
+
1043
+ const SOURCED_OPERATORS = new Set(["SUBSET", "UNION", "DOMAIN", "\\cup", "\\cap", "\\"]);
1044
+
1045
+ // CallStackTool gives a set, tuple or record it builds the expression as its source, but not a lazy
1046
+ // set filter, which it returns as a copy.
1047
+ const isSourced = (expression: Expression, environment: Environment) =>
1048
+ SOURCED_KINDS.has(expression.kind) ||
1049
+ (expression.kind === "Apply" &&
1050
+ SOURCED_OPERATORS.has(expression.operator) &&
1051
+ !isLocallyResolved(expression) &&
1052
+ resolveGlobalOperator(expression.operator, environment)?.kind === "Builtin");
1053
+
1054
+ // When an evaluation fails, CallStackTool freezes the stack at the innermost expression and pushes
1055
+ // the source of each value whose method failed.
1056
+ const evaluateTraced = (
1057
+ evaluator: Evaluator,
1058
+ context: Context,
1059
+ trace: Expression[],
1060
+ depth: number,
1061
+ ) => {
1062
+ try {
1063
+ return evaluator(context);
1064
+ } catch (error) {
1065
+ if (trace.length === depth + 1) trace.push(...(getFingerprintTrace(error) ?? []));
1066
+ throw error;
1067
+ }
1068
+ };
1069
+
1014
1070
  export const getEvaluator = (expression: Expression, environment: Environment): Evaluator => {
1015
1071
  const cached = environment.evaluators.get(expression);
1016
1072
  if (cached) return cached;
1017
1073
  const compiled = compile(expression, environment);
1018
- const evaluator =
1074
+ const cachedEvaluator =
1019
1075
  isWorthCaching(expression) && isClosedConstant(expression, environment)
1020
1076
  ? cacheFirstValue(compiled)
1021
1077
  : isStateCached(expression, environment)
1022
1078
  ? cacheStateValue(compiled)
1023
1079
  : compiled;
1080
+ const trace = environment.trace;
1081
+ const isSourcedExpression = trace !== undefined && isSourced(expression, environment);
1082
+ // TLC's CallStackTool pushes each expression it evaluates and keeps the stack when one fails.
1083
+ const evaluator: Evaluator = trace
1084
+ ? (context) => {
1085
+ const depth = trace.length;
1086
+ trace.push(expression);
1087
+ const value = evaluateTraced(cachedEvaluator, context, trace, depth);
1088
+ trace.length = depth;
1089
+ if (isSourcedExpression && typeof value === "object" && value.kind !== "FilteredSet") {
1090
+ valueSources.current?.set(value, expression);
1091
+ }
1092
+ const retrace =
1093
+ typeof value === "object" && value.kind === "FilteredSet"
1094
+ ? filteredSetRetracers.get(value)
1095
+ : undefined;
1096
+ return retrace ? retrace(environment) : value;
1097
+ }
1098
+ : cachedEvaluator;
1024
1099
  environment.evaluators.set(expression, evaluator);
1025
1100
  return evaluator;
1026
1101
  };
1027
1102
 
1028
1103
  const entryEvaluators = new WeakMap<Expression, Evaluator>();
1029
1104
 
1030
- const getEntryEvaluator = (expression: Expression, environment: Environment) => {
1105
+ export const getEntryEvaluator = (expression: Expression, environment: Environment) => {
1106
+ if (environment.trace) return getEvaluator(expression, environment);
1031
1107
  const cached = entryEvaluators.get(expression);
1032
1108
  if (cached) return cached;
1033
1109
  const evaluator =
@@ -1136,11 +1212,32 @@ const getLazyArguments = (args: Expression[], context: Context): OperatorValue[]
1136
1212
  expression: arg,
1137
1213
  }));
1138
1214
 
1215
+ const RECEIVING_OPERATORS = new Set(["=", "#", "\\in", "\\notin", "\\cup", "\\cap", "\\"]);
1216
+
1217
+ // The argument whose method TLC calls to apply a built-in operator.
1218
+ const getReceiver = (name: string, left: Value, right: Value) =>
1219
+ name === "\\in" ||
1220
+ name === "\\notin" ||
1221
+ ((name === "\\cup" || name === "\\cap") && !isReducible(left))
1222
+ ? right
1223
+ : left;
1224
+
1139
1225
  const compileBuiltinCall = (
1140
1226
  builtin: Builtin,
1141
1227
  args: Expression[],
1142
1228
  environment: Environment,
1143
1229
  ): Evaluator => {
1230
+ if (environment.trace && RECEIVING_OPERATORS.has(builtin.name) && args.length === 2) {
1231
+ const evaluateLeft = getEvaluator(args[0], environment);
1232
+ const evaluateRight = getEvaluator(args[1], environment);
1233
+ return (context) => {
1234
+ const left = evaluateLeft(context);
1235
+ const right = evaluateRight(context);
1236
+ return withSource(getReceiver(builtin.name, left, right), () =>
1237
+ builtin.evaluate([left, right], context),
1238
+ );
1239
+ };
1240
+ }
1144
1241
  if (builtin.isLazy) {
1145
1242
  return (context) => builtin.evaluate(getLazyArguments(args, context), context);
1146
1243
  }
@@ -1300,6 +1397,13 @@ const compileApply = (
1300
1397
  if (global?.kind === "Builtin" && global.name === "DOMAIN") {
1301
1398
  const operand = getEvaluator(args[0], environment);
1302
1399
  const domain = getDomainOperator(expression);
1400
+ // TLC builds a new interval for the domain of a tuple, so the source it gives one stays its own.
1401
+ if (environment.trace) {
1402
+ return (context) => {
1403
+ const value = domain(operand(context));
1404
+ return typeof value === "object" && value.kind === "Interval" ? { ...value } : value;
1405
+ };
1406
+ }
1303
1407
  return (context) => domain(operand(context));
1304
1408
  }
1305
1409
  // TLC sorts the value of a constant TLCEval argument only where no context binds a name.
@@ -1315,6 +1419,13 @@ const compileApply = (
1315
1419
  const left = getEvaluator(args[0], environment);
1316
1420
  const right = getEvaluator(args[1], environment);
1317
1421
  const subset = getSubsetOperator(expression, global);
1422
+ if (environment.trace) {
1423
+ return (context) => {
1424
+ const subsetValue = left(context);
1425
+ const superset = right(context);
1426
+ return withSource(subsetValue, () => subset(subsetValue, superset));
1427
+ };
1428
+ }
1318
1429
  return (context) => subset(left(context), right(context));
1319
1430
  }
1320
1431
  if (global?.kind === "Builtin") return compileBuiltinCall(global, args, environment);
@@ -1325,6 +1436,11 @@ const compileApply = (
1325
1436
  if (definition?.kind === "Function") {
1326
1437
  throw new TlaEvaluationError(`${expression.operator} is a function; apply it with brackets`);
1327
1438
  }
1439
+ if (expression.operator === "\\cdot") {
1440
+ throw new TlaEvaluationError(
1441
+ "The current version of TLC does not support action composition. An incomplete implementation can be enabled via the tlc2.tool.impl.Tool.cdot=true java property.",
1442
+ );
1443
+ }
1328
1444
  throw new TlaEvaluationError(
1329
1445
  `Unknown operator ${expression.operator} at ${describeLocation(expression)}`,
1330
1446
  );
@@ -1420,7 +1536,13 @@ const compileFunctionConstruction = (
1420
1536
  const set = getEvaluator(bound.set, environment);
1421
1537
  return (context) => {
1422
1538
  const domain = isSingleName ? set(context) : getBoundsDomain(bounds, context);
1423
- if (expression.isRecursive || isKeptLazy || !isEnumerable(domain)) {
1539
+ // TLC builds the function only when it reduces every domain, and evaluates the body lazily
1540
+ // otherwise.
1541
+ const domains =
1542
+ typeof domain === "object" && domain.kind === "ProductSet" && bounds.length > 1
1543
+ ? domain.factors
1544
+ : [domain];
1545
+ if (expression.isRecursive || isKeptLazy || !domains.every(isReducible)) {
1424
1546
  const functionValue = createLazyFunction(
1425
1547
  domain,
1426
1548
  (argument) => body(withScope(context, bindArgument(bounds, context.scope, argument))),
@@ -1509,16 +1631,21 @@ const compileSetComprehension = (
1509
1631
  const pattern = expression.bound.pattern;
1510
1632
  return (context) => {
1511
1633
  const base = set(context);
1512
- const test = (element: Value) =>
1634
+ const getTest = (evaluatePredicate: Evaluator) => (element: Value) =>
1513
1635
  expectBoolean(
1514
- predicate(withScope(context, bindPattern(context.scope, pattern, element))),
1636
+ evaluatePredicate(withScope(context, bindPattern(context.scope, pattern, element))),
1515
1637
  "a set filter predicate",
1516
1638
  );
1517
- const isReducible =
1518
- typeof base === "object" &&
1519
- (base.kind === "Set" || base.kind === "MixedSet" || base.kind === "Interval");
1520
- if (!isReducible) {
1521
- if (isSetValue(base)) return { kind: "FilteredSet", base, test };
1639
+ const test = getTest(predicate);
1640
+ if (!isReducible(base)) {
1641
+ if (isSetValue(base)) {
1642
+ const filtered: FilteredSetValue = { kind: "FilteredSet", base, test };
1643
+ filteredSetRetracers.set(filtered, (traced) => ({
1644
+ ...filtered,
1645
+ test: getTest(getEvaluator(expression.predicate, traced)),
1646
+ }));
1647
+ return filtered;
1648
+ }
1522
1649
  throw new TlaEvaluationError(
1523
1650
  `TLC encountered a non-enumerable quantifier bound ${formatValue(base)} at ${describeLocation(expression.bound.set)}`,
1524
1651
  );
@@ -1571,7 +1698,13 @@ export const hasDuplicateFields = (sortedFields: RecordField[]) =>
1571
1698
  sortedFields.some((field, index) => index > 0 && sortedFields[index - 1].name === field.name);
1572
1699
 
1573
1700
  export const createUnassignedError = (name: string, expression: Expression) =>
1574
- new TlaEvaluationError(`The variable ${name} is not assigned at ${describeLocation(expression)}`);
1701
+ setOwnExitCode(
1702
+ new TlaUnassignedError(
1703
+ `In evaluation, the identifier ${name} is either undefined or not an operator.\n${describeRange(expression)}`,
1704
+ name,
1705
+ ),
1706
+ EXIT_STATUS.configParseError,
1707
+ );
1575
1708
 
1576
1709
  export const createPrimeOutsideActionError = (expression: Expression) =>
1577
1710
  new TlaEvaluationError(
@@ -1759,18 +1892,41 @@ const compile = (expression: Expression, environment: Environment): Evaluator =>
1759
1892
  keepLazy(expression.function);
1760
1893
  const evaluateFunction = child(expression.function);
1761
1894
  const args = expression.args.map(child);
1895
+ const describeNonFunction = getNonFunctionError(expression);
1896
+ if (args.length === 1 && environment.trace) {
1897
+ const argument = args[0];
1898
+ return (context) => {
1899
+ const functionValue = evaluateFunction(context);
1900
+ const argumentValue = argument(context);
1901
+ const apply = () =>
1902
+ applyFunction(functionValue, argumentValue, undefined, describeNonFunction);
1903
+ return isFunctionValue(functionValue) ? withSource(functionValue, apply) : apply();
1904
+ };
1905
+ }
1762
1906
  if (args.length === 1) {
1763
1907
  const argument = args[0];
1764
- return (context) => applyFunction(evaluateFunction(context), argument(context));
1908
+ return (context) =>
1909
+ applyFunction(
1910
+ evaluateFunction(context),
1911
+ argument(context),
1912
+ undefined,
1913
+ describeNonFunction,
1914
+ );
1765
1915
  }
1766
1916
  return (context) =>
1767
- applyFunction(evaluateFunction(context), createTuple(args.map((arg) => arg(context))));
1917
+ applyFunction(
1918
+ evaluateFunction(context),
1919
+ createTuple(args.map((arg) => arg(context))),
1920
+ undefined,
1921
+ describeNonFunction,
1922
+ );
1768
1923
  }
1769
1924
  case "FieldAccess": {
1770
1925
  const record = child(expression.record);
1771
1926
  const field = expression.field;
1772
1927
  const describeMissing = getFieldError(expression);
1773
- return (context) => applyFunction(record(context), field, describeMissing);
1928
+ const describeNonRecord = getNonRecordError(expression);
1929
+ return (context) => applyFunction(record(context), field, describeMissing, describeNonRecord);
1774
1930
  }
1775
1931
  case "Product": {
1776
1932
  const factors = expression.factors.map(child);
package/src/exit-codes.ts CHANGED
@@ -26,7 +26,19 @@ export const setExitCode = <Thrown>(error: Thrown, code: number) => {
26
26
 
27
27
  export const getExitCode = (error: Error) => exitCodes.get(error);
28
28
 
29
- // TLC exits with 255 when it fails to process or evaluate a liveness property, in any phase.
29
+ const ownExitCodes = new WeakMap<Error, number>();
30
+
31
+ // The exit status of the error code TLC gives an EvalException, which TLC uses only where it
32
+ // doesn't report the error again as a nested expression.
33
+ export const setOwnExitCode = <Thrown extends Error>(error: Thrown, code: number) => {
34
+ ownExitCodes.set(error, code);
35
+ return error;
36
+ };
37
+
38
+ export const getOwnExitCode = (error: unknown) =>
39
+ error instanceof Error ? ownExitCodes.get(error) : undefined;
40
+
41
+ // TLC exits with 255 when it fails to process or evaluate a liveness property.
30
42
  const withErrorExitCode = <Result>(run: () => Result) => {
31
43
  try {
32
44
  return run();
@@ -41,8 +53,15 @@ export const withLivenessExitCode = (
41
53
  const checker = withErrorExitCode(create);
42
54
  return (
43
55
  checker && {
44
- addInitialState: (index, state) =>
45
- withErrorExitCode(() => checker.addInitialState(index, state)),
56
+ // TLC replays the initial states to report an error, but skips the liveness check of a
57
+ // state it has already seen, so it exits with the status of the error's own code.
58
+ addInitialState: (index, state) => {
59
+ try {
60
+ checker.addInitialState(index, state);
61
+ } catch (error) {
62
+ throw setExitCode(error, getOwnExitCode(error) ?? EXIT_STATUS.error);
63
+ }
64
+ },
46
65
  addState: (index, state, successors) =>
47
66
  withErrorExitCode(() => checker.addState(index, state, successors)),
48
67
  findViolation: () => withErrorExitCode(() => checker.findViolation()),
@@ -1,4 +1,4 @@
1
- import { getValueFingerprint, getValueHash, type Value } from "./values";
1
+ import { assertFingerprintable, getValueFingerprint, getValueHash, type Value } from "./values";
2
2
 
3
3
  const EMPTY = 0;
4
4
  const INITIAL_CAPACITY = 1 << 12;
@@ -20,6 +20,7 @@ export const writeStateFingerprint = (state: Value[], fingerprint: Int32Array) =
20
20
  first = Math.imul(first ^ getValueHash(state[index]), 0x01000193);
21
21
  second = Math.imul(second ^ getValueFingerprint(state[index]), 0x5bd1e995);
22
22
  }
23
+ assertFingerprintable(state);
23
24
  fingerprint[0] = mix(first) || 1;
24
25
  fingerprint[1] = mix(second);
25
26
  };
package/src/instances.ts CHANGED
@@ -164,7 +164,7 @@ export const mapChildren = (
164
164
  case "RecordSet":
165
165
  return {
166
166
  ...expression,
167
- fields: expression.fields.map((field) => ({ name: field.name, value: plain(field.value) })),
167
+ fields: expression.fields.map((field) => ({ ...field, value: plain(field.value) })),
168
168
  };
169
169
  case "Except":
170
170
  return {
@@ -219,7 +219,7 @@ interface Instantiation {
219
219
  variables: Set<string>;
220
220
  getDefinition: (key: string) => Definition | undefined;
221
221
  isParameterized: (key: string) => boolean;
222
- addDefinition: (name: string, create: (key: string) => Definition) => string;
222
+ addDefinition: (source: string, name: string, create: (key: string) => Definition) => string;
223
223
  createName: (name: string) => string;
224
224
  }
225
225
 
@@ -640,7 +640,7 @@ const copyDefinition = (rewrite: Rewrite, key: string): string => {
640
640
  const instantiation = rewrite.instantiation;
641
641
  const definition = instantiation.getDefinition(key);
642
642
  if (!definition) return key;
643
- return instantiation.addDefinition(definition.name, (copyKey) => {
643
+ return instantiation.addDefinition(key, definition.name, (copyKey) => {
644
644
  rewrite.copies.set(key, copyKey);
645
645
  const rename = createRenamer(rewrite);
646
646
  const mapped = renameParams(
@@ -679,7 +679,7 @@ export const createInstantiation = (instantiation: Instantiation) => {
679
679
  if (copy !== undefined) return copy;
680
680
  const definition = instantiation.getDefinition(key);
681
681
  if (!definition) return key;
682
- return instantiation.addDefinition(definition.name, () =>
682
+ return instantiation.addDefinition(key, definition.name, () =>
683
683
  withInstanceParams(definition, instantiation.params, definition.location),
684
684
  );
685
685
  },
package/src/levels.ts CHANGED
@@ -5,11 +5,10 @@ import {
5
5
  type Expression,
6
6
  type Module,
7
7
  type OperatorParam,
8
- type SourceLocation,
9
8
  } from "./ast";
10
- import { TlaSyntaxError } from "./errors";
9
+ import { createSemanticError, TlaSyntaxError } from "./errors";
11
10
  import { mapChildren } from "./instances";
12
- import { getBoundNames, getPatternNames } from "./resolve";
11
+ import { collectSemanticErrors, getBoundNames, getPatternNames } from "./resolve";
13
12
  import { STANDARD_LEVELS } from "./standard-levels";
14
13
 
15
14
  interface LevelData {
@@ -34,6 +33,7 @@ interface LevelContext {
34
33
  constants: Set<string>;
35
34
  variables: Set<string>;
36
35
  getDefinition: (name: string) => Definition | undefined;
36
+ getQualifiedName?: (name: string) => string | undefined;
37
37
  }
38
38
 
39
39
  type ScopeEntry =
@@ -176,8 +176,13 @@ export const ACTION_LEVEL = 2;
176
176
 
177
177
  export const TEMPORAL_LEVEL = 3;
178
178
 
179
- const createLevelError = (message: string, location: SourceLocation) =>
180
- new TlaSyntaxError(`${message} at line ${location.line}, column ${location.column}`);
179
+ // SANY reports a level error at the range of the expression it rejects.
180
+ const createLevelError = (message: string, expression: Expression) =>
181
+ expression.location.range
182
+ ? createSemanticError(`${message}.`, expression.location.range)
183
+ : new TlaSyntaxError(
184
+ `${message} at line ${expression.location.line}, column ${expression.location.column}`,
185
+ );
181
186
 
182
187
  const LOGICAL_OPERATORS = new Set(["/\\", "\\/", "=>", "<=>"]);
183
188
 
@@ -201,7 +206,13 @@ export const createLevelAnalyzer = (context: LevelContext) => {
201
206
  if (context.variables.has(name)) return { kind: "Declared", name, level: 1, arity: 0 };
202
207
  const definition = context.getDefinition(name);
203
208
  if (definition) {
204
- return { kind: "Defined", levels: analyzeDefinition(definition, new Map()) };
209
+ const levels = analyzeDefinition(definition, new Map());
210
+ // SANY names a definition of an instance by its qualified name, as in I!Foo.
211
+ const qualifiedName = context.getQualifiedName?.(name);
212
+ return {
213
+ kind: "Defined",
214
+ levels: qualifiedName ? { ...levels, name: qualifiedName } : levels,
215
+ };
205
216
  }
206
217
  const signature = CORE_SIGNATURES.get(name) ?? STANDARD_LEVELS.get(name);
207
218
  if (signature) return { kind: "Defined", levels: signature };
@@ -237,13 +248,13 @@ export const createLevelAnalyzer = (context: LevelContext) => {
237
248
  if (operand.operator || operand.declared) return;
238
249
  if (operand.data.level > getMaxLevel(operator, index)) {
239
250
  throw new TlaSyntaxError(
240
- `Level error in applying operator ${operator.name}: The level of argument ${index + 1} exceeds the maximum level allowed by the operator.`,
251
+ `Level error in applying operator ${operator.name}:\nThe level of argument ${index + 1} exceeds the maximum level allowed by the operator`,
241
252
  );
242
253
  }
243
254
  });
244
255
  if (ranges.some((range) => range.level > ACTION_LEVEL)) {
245
256
  throw new TlaSyntaxError(
246
- `Level error in applying operator ${operator.name}: The level of the range for a bounded variable exceeds the maximum level allowed by the operator.`,
257
+ `Level error in applying operator ${operator.name}:\nThe level of the range for a bounded variable exceeds the maximum level allowed by the operator`,
247
258
  );
248
259
  }
249
260
  const getOperand = (formal: string) => {
@@ -444,10 +455,13 @@ export const createLevelAnalyzer = (context: LevelContext) => {
444
455
  ? applyDeclared(resolved.name, resolved.level, operands)
445
456
  : applyDefined(resolved.levels, operands);
446
457
 
447
- const checkJunction = (operands: Operand[], location: SourceLocation) => {
458
+ const checkJunction = (operands: Operand[], expression: Expression) => {
448
459
  const levels = operands.map((operand) => operand.data.level);
449
460
  if (levels.includes(ACTION_LEVEL) && levels.includes(TEMPORAL_LEVEL)) {
450
- throw createLevelError("Formula has both temporal formula and action as arguments", location);
461
+ throw createLevelError(
462
+ "Formula has both temporal formula and action as arguments",
463
+ expression,
464
+ );
451
465
  }
452
466
  };
453
467
 
@@ -456,10 +470,10 @@ export const createLevelAnalyzer = (context: LevelContext) => {
456
470
  if (isLeadsTo && operands.some((operand) => operand.data.level === ACTION_LEVEL)) {
457
471
  throw createLevelError(
458
472
  "Action used where only temporal formula or state predicate allowed",
459
- expression.location,
473
+ expression,
460
474
  );
461
475
  }
462
- if (LOGICAL_OPERATORS.has(expression.operator)) checkJunction(operands, expression.location);
476
+ if (LOGICAL_OPERATORS.has(expression.operator)) checkJunction(operands, expression);
463
477
  };
464
478
 
465
479
  const checkTemporal = (
@@ -473,7 +487,7 @@ export const createLevelAnalyzer = (context: LevelContext) => {
473
487
  expression.kind === "Always"
474
488
  ? "[] followed by action not of form [A]_v"
475
489
  : "<> followed by action not of form <<A>>_v",
476
- expression.location,
490
+ expression,
477
491
  );
478
492
  };
479
493
 
@@ -501,7 +515,17 @@ export const createLevelAnalyzer = (context: LevelContext) => {
501
515
  return data;
502
516
  };
503
517
 
518
+ // SANY reports a level error of an operator's arguments at the application.
504
519
  const analyze = (expression: Expression, scope: Scope): LevelData => {
520
+ try {
521
+ return analyzeNode(expression, scope);
522
+ } catch (error) {
523
+ if (!(error instanceof TlaSyntaxError) || error.sany) throw error;
524
+ throw createLevelError(error.message, expression);
525
+ }
526
+ };
527
+
528
+ const analyzeNode = (expression: Expression, scope: Scope): LevelData => {
505
529
  switch (expression.kind) {
506
530
  case "Number":
507
531
  case "Decimal":
@@ -521,7 +545,7 @@ export const createLevelAnalyzer = (context: LevelContext) => {
521
545
  case "And":
522
546
  case "Or": {
523
547
  const operands = toOperands(expression.operands, scope);
524
- checkJunction(operands, expression.location);
548
+ checkJunction(operands, expression);
525
549
  return applyDefined(JUNCTION_LEVELS, operands);
526
550
  }
527
551
  case "Prime":
@@ -561,13 +585,14 @@ export const createLevelAnalyzer = (context: LevelContext) => {
561
585
  expression.bounds.map((bound) => bound.set),
562
586
  getBoundNames(expression.bounds),
563
587
  );
564
- if (
565
- data.level === TEMPORAL_LEVEL &&
566
- expression.bounds.some((bound) => analyze(bound.set, scope).level === ACTION_LEVEL)
567
- ) {
588
+ const actionBound =
589
+ data.level === TEMPORAL_LEVEL
590
+ ? expression.bounds.find((bound) => analyze(bound.set, scope).level === ACTION_LEVEL)
591
+ : undefined;
592
+ if (actionBound) {
568
593
  throw createLevelError(
569
594
  "Action-level bound of quantified temporal formula",
570
- expression.location,
595
+ actionBound.set,
571
596
  );
572
597
  }
573
598
  return data;
@@ -838,13 +863,23 @@ const analyzeAssumeProve = (
838
863
  // SANY checks the level of every definition, assumption, and theorem of a module.
839
864
  export const checkModuleLevels = (module: Module, context: LevelContext) => {
840
865
  const analyzer = createLevelAnalyzer(context);
841
- module.definitions
842
- .filter((definition) => !definition.name.includes("!"))
843
- .forEach((definition) => analyzer.analyzeDefinition(definition, new Map()));
844
- module.assumptions.forEach((assumption) => analyzer.analyze(assumption.expression, new Map()));
845
- module.theorems.forEach((theorem) =>
846
- theorem.statement.kind === "AssumeProve"
847
- ? analyzeAssumeProve(theorem.statement, new Map(), analyzer)
848
- : analyzer.analyze(theorem.statement, new Map()),
849
- );
866
+ collectSemanticErrors([
867
+ ...module.definitions
868
+ .filter((definition) => !definition.name.includes("!"))
869
+ .map((definition) => ({
870
+ location: definition.location,
871
+ check: () => analyzer.analyzeDefinition(definition, new Map()),
872
+ })),
873
+ ...module.assumptions.map((assumption) => ({
874
+ location: assumption.location,
875
+ check: () => analyzer.analyze(assumption.expression, new Map()),
876
+ })),
877
+ ...module.theorems.map((theorem) => ({
878
+ location: theorem.location,
879
+ check: () =>
880
+ theorem.statement.kind === "AssumeProve"
881
+ ? analyzeAssumeProve(theorem.statement, new Map(), analyzer)
882
+ : analyzer.analyze(theorem.statement, new Map()),
883
+ })),
884
+ ]);
850
885
  };