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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (81) 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 +164 -46
  5. package/dist/index.d.ts +164 -46
  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 -22
  12. package/dist/run-cli.js +1351 -22
  13. package/dist/transfer.cjs +83 -33
  14. package/dist/transfer.js +83 -33
  15. package/package.json +5 -1
  16. package/src/ast.ts +54 -7
  17. package/src/bags.ts +4 -7
  18. package/src/builtins.ts +29 -17
  19. package/src/bundled-modules.ts +3 -3
  20. package/src/canonical.ts +4 -3
  21. package/src/check.ts +1317 -428
  22. package/src/cli.ts +8 -1
  23. package/src/codegen.ts +68 -21
  24. package/src/config.ts +225 -206
  25. package/src/environment.ts +417 -129
  26. package/src/errors.ts +155 -18
  27. package/src/evaluate.ts +713 -259
  28. package/src/exit-codes.ts +6 -24
  29. package/src/fingerprints.ts +1 -2
  30. package/src/index.ts +1 -0
  31. package/src/instances.ts +3 -1
  32. package/src/java-overrides.ts +104 -25
  33. package/src/levels.ts +122 -22
  34. package/src/lexer.ts +32 -4
  35. package/src/live-check.ts +204 -148
  36. package/src/liveness.ts +191 -122
  37. package/src/obligation-expression.ts +2 -2
  38. package/src/obligation-source.ts +2 -0
  39. package/src/parallel-worker.ts +6 -1
  40. package/src/parallel.ts +57 -6
  41. package/src/parser.ts +408 -168
  42. package/src/pcal-ast.ts +770 -0
  43. package/src/pcal-parse.ts +1523 -0
  44. package/src/pcal-tokenize.ts +516 -0
  45. package/src/pcal-translate.ts +1230 -0
  46. package/src/pcal-validate.ts +454 -0
  47. package/src/randomization.ts +24 -7
  48. package/src/resolve.ts +1379 -448
  49. package/src/run-cli.ts +1161 -196
  50. package/src/runtime.ts +16 -0
  51. package/src/sany-builtins.ts +147 -0
  52. package/src/sany-generator.ts +3112 -0
  53. package/src/sany-levels.ts +1208 -0
  54. package/src/sany-lexer.ts +545 -0
  55. package/src/sany-linter.ts +122 -0
  56. package/src/sany-modules.ts +1398 -0
  57. package/src/sany-nodes.ts +463 -0
  58. package/src/sany-parse-error.ts +2161 -0
  59. package/src/sany-report.ts +354 -0
  60. package/src/sany-selectors.ts +738 -0
  61. package/src/sany-source.ts +248 -0
  62. package/src/sany-xml.ts +1017 -0
  63. package/src/spec-description.ts +25 -5
  64. package/src/standard-modules.ts +172 -129
  65. package/src/standard-ranges.ts +116 -0
  66. package/src/state-graph.ts +29 -6
  67. package/src/subexpressions.ts +221 -161
  68. package/src/substitution-levels.ts +5 -8
  69. package/src/successors.ts +141 -173
  70. package/src/symmetry.ts +168 -50
  71. package/src/tableau.ts +3 -1
  72. package/src/tlc-ext.ts +13 -17
  73. package/src/tlc-messages.ts +329 -0
  74. package/src/tlc-module.ts +49 -21
  75. package/src/tlc-modules.ts +0 -4
  76. package/src/tlc-order.ts +55 -9
  77. package/src/tlc-random.ts +28 -3
  78. package/src/tlc-replay.ts +655 -0
  79. package/src/tlc-version.ts +18 -0
  80. package/src/transfer.ts +15 -3
  81. package/src/values.ts +664 -317
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tla-ts",
3
- "version": "0.0.3-dev.3ce2f00",
3
+ "version": "0.0.3-dev.3ef4193",
4
4
  "description": "A TLA+ interpreter and model checker in TypeScript, 2× faster than TLC",
5
5
  "keywords": [
6
6
  "formal verification",
@@ -54,6 +54,9 @@
54
54
  "publishConfig": {
55
55
  "access": "public"
56
56
  },
57
+ "dependencies": {
58
+ "fflate": "^0.8.3"
59
+ },
57
60
  "devDependencies": {
58
61
  "@types/node": "^22",
59
62
  "publint": "^0.3.0",
@@ -71,6 +74,7 @@
71
74
  "conformance:sany": "tsx scripts/proof-conformance.ts",
72
75
  "conformance:record": "tsx scripts/record-tlc.ts",
73
76
  "conformance:record-sany": "tsx scripts/record-sany.ts",
77
+ "conformance:record-statechart": "tsx scripts/record-statechart.ts",
74
78
  "conformance:record-tlapm": "tsx scripts/record-tlapm.ts",
75
79
  "conformance:tlapm": "tsx scripts/tlapm-conformance.ts",
76
80
  "publint": "publint",
package/src/ast.ts CHANGED
@@ -33,22 +33,32 @@ export interface StringExpression {
33
33
  location: SourceLocation;
34
34
  }
35
35
 
36
+ // selectorRanges holds the range of each part of a name such as foo!lab, where SANY reports an
37
+ // error in selecting that part.
36
38
  export interface IdentifierExpression {
37
39
  kind: "Identifier";
38
40
  name: string;
41
+ selectorRanges?: SourceRange[];
39
42
  location: SourceLocation;
40
43
  resolution?: LocalResolution;
41
44
  }
42
45
 
46
+ // spelling holds the text of an operator written as a synonym, such as (+) for \oplus, which SANY
47
+ // reports as written.
43
48
  export interface ApplyExpression {
44
49
  kind: "Apply";
45
50
  operator: string;
51
+ spelling?: string;
46
52
  args: Expression[];
47
53
  // The number of args each part of a name like F(x)!l(y) takes, when a part before the last takes
48
54
  // some.
49
55
  argumentCounts?: number[];
50
- // The range of the parenthesized arguments of a named operator, where SANY reports their count.
56
+ // The range of the parenthesized arguments of a named operator, or of the whole name when its
57
+ // last part takes none, where SANY reports their count.
51
58
  argumentsRange?: SourceRange;
59
+ selectorRanges?: SourceRange[];
60
+ // The range of the arguments of each part of a name like F(x)!l(y), for a part that takes some.
61
+ argumentRanges?: (SourceRange | undefined)[];
52
62
  location: SourceLocation;
53
63
  resolution?: LocalResolution;
54
64
  }
@@ -56,13 +66,18 @@ export interface ApplyExpression {
56
66
  export interface OperatorReferenceExpression {
57
67
  kind: "OperatorReference";
58
68
  operator: string;
69
+ spelling?: string;
59
70
  location: SourceLocation;
60
71
  }
61
72
 
73
+ // operator holds the operator, such as SUBSET, that an argument names, which tla-ts reads as a
74
+ // LAMBDA.
62
75
  export interface LambdaExpression {
63
76
  kind: "Lambda";
64
77
  params: string[];
78
+ paramRanges?: SourceRange[];
65
79
  body: Expression;
80
+ operator?: string;
66
81
  location: SourceLocation;
67
82
  }
68
83
 
@@ -70,6 +85,9 @@ export interface JunctionExpression {
70
85
  kind: "And" | "Or";
71
86
  operands: Expression[];
72
87
  isBulleted?: boolean;
88
+ // SANY parses an infix chain such as A /\ B /\ C as (A /\ B) /\ C, whose node of each prefix of
89
+ // two or more operands ends after the parentheses of its last operand.
90
+ prefixEnds?: SourceLocation[];
73
91
  location: SourceLocation;
74
92
  }
75
93
 
@@ -119,7 +137,10 @@ export interface LetExpression {
119
137
  location: SourceLocation;
120
138
  }
121
139
 
122
- export type BoundPattern = { kind: "Name"; name: string } | { kind: "Tuple"; names: string[] };
140
+ // ranges holds the range of each name the pattern binds.
141
+ export type BoundPattern =
142
+ | { kind: "Name"; name: string; ranges?: SourceRange[] }
143
+ | { kind: "Tuple"; names: string[]; ranges?: SourceRange[] };
123
144
 
124
145
  export interface Bound {
125
146
  pattern: BoundPattern;
@@ -137,6 +158,7 @@ export interface UnboundedQuantifierExpression {
137
158
  kind: "UnboundedQuantifier";
138
159
  quantifier: "Forall" | "Exists";
139
160
  names: string[];
161
+ nameRanges?: SourceRange[];
140
162
  isTemporal?: boolean;
141
163
  body: Expression;
142
164
  location: SourceLocation;
@@ -231,6 +253,14 @@ export interface FunctionApplicationExpression {
231
253
  location: SourceLocation;
232
254
  }
233
255
 
256
+ // SANY parses [e1, ..., en] as a function application without the function, and its semantic
257
+ // checker rejects it.
258
+ export interface BracketExpression {
259
+ kind: "Bracket";
260
+ args: Expression[];
261
+ location: SourceLocation;
262
+ }
263
+
234
264
  export interface FieldAccessExpression {
235
265
  kind: "FieldAccess";
236
266
  record: Expression;
@@ -269,6 +299,7 @@ export interface LabelExpression {
269
299
  kind: "Label";
270
300
  name: string;
271
301
  params: string[];
302
+ paramRanges?: SourceRange[];
272
303
  body: Expression;
273
304
  location: SourceLocation;
274
305
  }
@@ -283,6 +314,8 @@ export type Selector =
283
314
  export interface SubexpressionExpression {
284
315
  kind: "Subexpression";
285
316
  selectors: Selector[];
317
+ selectorRanges?: SourceRange[];
318
+ argumentRanges?: (SourceRange | undefined)[];
286
319
  location: SourceLocation;
287
320
  }
288
321
 
@@ -314,6 +347,7 @@ export type Expression =
314
347
  | ExceptExpression
315
348
  | ExceptAtExpression
316
349
  | FunctionApplicationExpression
350
+ | BracketExpression
317
351
  | FieldAccessExpression
318
352
  | ProductExpression
319
353
  | TemporalExpression
@@ -346,6 +380,8 @@ export interface FunctionDefinition {
346
380
  body: Expression;
347
381
  isLocal: boolean;
348
382
  isRecursive: boolean;
383
+ // Whether the body applies the function, which SANY makes a recursive function definition.
384
+ isSelfReferential?: boolean;
349
385
  location: SourceLocation;
350
386
  }
351
387
 
@@ -366,6 +402,7 @@ export interface Assumption {
366
402
 
367
403
  export interface InstanceSubstitution {
368
404
  name: string;
405
+ nameRange: SourceRange;
369
406
  expression: Expression;
370
407
  }
371
408
 
@@ -387,6 +424,7 @@ export interface NewSymbol {
387
424
  arity: number;
388
425
  level: "Constant" | "Variable" | "State" | "Action" | "Temporal";
389
426
  set: Expression | undefined;
427
+ nameRange?: SourceRange;
390
428
  location: SourceLocation;
391
429
  }
392
430
 
@@ -438,19 +476,27 @@ export type StepBody =
438
476
  | Instance
439
477
  | DefineStep
440
478
  | { kind: "Have"; expression: Expression }
441
- | { kind: "Take"; names: string[]; bounds: Bound[] }
479
+ | { kind: "Take"; names: string[]; nameRanges?: SourceRange[]; bounds: Bound[] }
442
480
  | { kind: "Witness"; expressions: Expression[] }
443
- | { kind: "Pick"; names: string[]; bounds: Bound[]; body: Expression }
481
+ | {
482
+ kind: "Pick";
483
+ names: string[];
484
+ nameRanges?: SourceRange[];
485
+ bounds: Bound[];
486
+ body: Expression;
487
+ }
444
488
  | { kind: "Case"; expression: Expression }
445
489
  | { kind: "Assert"; isSuffices: boolean; statement: Expression | AssumeProve }
446
490
  | { kind: "Qed" };
447
491
 
448
- // head is the range of the step number and its statement, without the proof.
492
+ // head is the range of the step number and its statement, without the proof, and statement is the
493
+ // range of the statement alone.
449
494
  export interface ProofStep {
450
495
  name: string | undefined;
451
496
  token: string;
452
497
  body: StepBody;
453
498
  head: SourceRange;
499
+ statement: SourceRange;
454
500
  proof: Proof | undefined;
455
501
  location: SourceLocation;
456
502
  }
@@ -464,8 +510,7 @@ export interface Theorem {
464
510
 
465
511
  // The units of a module in source order, for consumers that need the order across kinds.
466
512
  export type ModuleUnit =
467
- | { kind: "Constants"; declarations: Declaration[] }
468
- | { kind: "Variables"; declarations: Declaration[] }
513
+ | { kind: "Constants" | "Variables"; declarations: Declaration[]; location: SourceLocation }
469
514
  | { kind: "Recursive"; declarations: Declaration[] }
470
515
  | { kind: "Definition"; definition: Definition }
471
516
  | { kind: "Instance"; instance: Instance }
@@ -559,6 +604,8 @@ export const getChildren = (expression: Expression): Expression[] => {
559
604
  ];
560
605
  case "FunctionApplication":
561
606
  return [expression.function, ...expression.args];
607
+ case "Bracket":
608
+ return expression.args;
562
609
  case "FieldAccess":
563
610
  return [expression.record];
564
611
  case "Product":
package/src/bags.ts CHANGED
@@ -123,7 +123,8 @@ const mergeBags = (bags: FunctionValue[], method: string) =>
123
123
 
124
124
  const EMPTY_BAG = createSortedFunction([], []);
125
125
 
126
- export const BAGS_OPERATORS: Builtin[] = [
126
+ // SubBag compares the counts with the >= of Naturals, which Integers replaces when TLC loads it.
127
+ export const createBagsOperators = (builtins: ReadonlyMap<string, Builtin>): Builtin[] => [
127
128
  defineConstant("EmptyBag", EMPTY_BAG),
128
129
  defineOperator("IsABag", 1, (args) => {
129
130
  const functionValue = toFunction(getValue(args, 0, "IsABag"));
@@ -228,12 +229,8 @@ export const BAGS_OPERATORS: Builtin[] = [
228
229
  const functionValue = toFiniteFunction(value);
229
230
  const range = createSet(functionValue.range).elements;
230
231
  const invalid = range.find((count) => typeof count !== "number");
231
- if (invalid !== undefined) {
232
- const isFirst = typeof range[0] !== "number";
233
- throw new TlaEvaluationError(
234
- `The ${isFirst ? "first" : "second"} argument of >= should be an integer, but instead it is:\n${formatValue(isFirst ? range[0] : invalid)}`,
235
- );
236
- }
232
+ // A count that isn't an integer fails the comparison.
233
+ if (invalid !== undefined) builtins.get(">=")?.evaluateBinary?.(range[0], invalid);
237
234
  const counts = functionValue.range.filter((count) => typeof count === "number");
238
235
  if (counts.some((count) => count < 1)) {
239
236
  throw new TlaEvaluationError(
package/src/builtins.ts CHANGED
@@ -2,6 +2,7 @@ import { TlaEvaluationError, TlaModuleError } from "./errors";
2
2
  import type { Builtin, BuiltinArgument, Context, OperatorValue } from "./evaluate";
3
3
  import {
4
4
  formatValue,
5
+ getFunctionClass,
5
6
  getSequenceElements,
6
7
  isEnumerable,
7
8
  isFunctionValue,
@@ -9,6 +10,7 @@ import {
9
10
  toFiniteFunction,
10
11
  MAXIMUM_INTEGER,
11
12
  MINIMUM_INTEGER,
13
+ setTrace,
12
14
  toFiniteSet,
13
15
  type Value,
14
16
  } from "./values";
@@ -243,17 +245,20 @@ const KIND_STRINGS: Record<string, string> = {
243
245
  UnionValue: "a set of the form UNION S",
244
246
  };
245
247
 
246
- // TLC stores a function as a TupleValue or a RecordValue when it has that shape, so the
247
- // shape stands in for how TLC built the value.
248
+ const FUNCTION_CLASSES = {
249
+ lambda: "FcnLambdaValue",
250
+ tuple: "TupleValue",
251
+ record: "RecordValue",
252
+ };
253
+
248
254
  export const getJavaClassName = (value: Value) => {
249
255
  if (typeof value === "number") return "IntValue";
250
256
  if (typeof value === "string") return "StringValue";
251
257
  if (typeof value === "boolean") return "BoolValue";
252
258
  if (value.kind === "SetOperation") return SET_OPERATION_CLASSES[value.operator];
253
259
  if (value.kind !== "Function") return JAVA_CLASSES[value.kind];
254
- const domain = value.domain;
255
- if (domain.every((key, index) => key === index + 1)) return "TupleValue";
256
- return domain.every((key) => typeof key === "string") ? "RecordValue" : "FcnRcdValue";
260
+ const functionClass = getFunctionClass(value);
261
+ return functionClass === undefined ? "FcnRcdValue" : FUNCTION_CLASSES[functionClass];
257
262
  };
258
263
 
259
264
  export const getKindString = (value: Value) => KIND_STRINGS[getJavaClassName(value)];
@@ -270,13 +275,17 @@ export const overrideWithJava = (builtin: Builtin, signature: string): Builtin =
270
275
  const guard =
271
276
  <Arguments extends unknown[]>(compute: (...args: Arguments) => Value) =>
272
277
  (...args: Arguments) => {
278
+ const depth = setTrace.sets?.length ?? 0;
273
279
  try {
274
280
  return compute(...args);
275
281
  } catch (error) {
276
282
  const isWrapped =
277
283
  error instanceof TlaEvaluationError &&
278
284
  (builtin.isLazy === true || !(error instanceof TlaModuleError));
279
- throw isWrapped ? createJavaOverrideError(signature, error.message) : error;
285
+ if (!isWrapped) throw error;
286
+ // The wrapping error replaces a FingerprintException that a set with a source raised.
287
+ if (setTrace.sets) setTrace.sets.length = depth;
288
+ throw createJavaOverrideError(signature, error.message);
280
289
  }
281
290
  };
282
291
  return {
@@ -297,21 +306,16 @@ export const getJavaInteger = (value: Value, signature: string) => {
297
306
  return value;
298
307
  };
299
308
 
300
- export const getArithmeticSignature = (
301
- javaClass: "Naturals" | "Integers",
302
- method: string,
303
- result: string,
304
- arity: number,
305
- ) =>
306
- `public static tlc2.value.impl.${result} tlc2.module.${javaClass}.${method}(${Array.from({ length: arity }, () => "tlc2.value.impl.IntValue").join(",")})`;
309
+ export const getJavaSignature = (module: string, method: string, result: string, arity: number) =>
310
+ `public static tlc2.value.impl.${result} tlc2.module.${module}.${method}(${Array.from({ length: arity }, () => "tlc2.value.impl.IntValue").join(",")})`;
307
311
 
308
312
  export const defineArithmetic = (
309
- javaClass: "Naturals" | "Integers",
313
+ module: string,
310
314
  name: string,
311
315
  method: string,
312
316
  compute: (left: number, right: number) => number,
313
317
  ) => {
314
- const signature = getArithmeticSignature(javaClass, method, "IntValue", 2);
318
+ const signature = getJavaSignature(module, method, "IntValue", 2);
315
319
  return defineBinary(name, (left, right) => {
316
320
  const leftNumber = getJavaInteger(left, signature);
317
321
  const rightNumber = getJavaInteger(right, signature);
@@ -330,9 +334,17 @@ const getIntegerArgument = (value: Value, position: string, name: string) => {
330
334
  return value;
331
335
  };
332
336
 
333
- export const defineComparison = (name: string, compare: (left: number, right: number) => boolean) =>
337
+ // The error of an argument that isn't an integer names the operator as TLC's method does.
338
+ export const defineComparison = (
339
+ name: string,
340
+ compare: (left: number, right: number) => boolean,
341
+ errorName = name,
342
+ ) =>
334
343
  defineBinary(name, (left, right) =>
335
- compare(getIntegerArgument(left, "first", name), getIntegerArgument(right, "second", name)),
344
+ compare(
345
+ getIntegerArgument(left, "first", errorName),
346
+ getIntegerArgument(right, "second", errorName),
347
+ ),
336
348
  );
337
349
 
338
350
  export const defineLazyOperator = (
@@ -1,6 +1,6 @@
1
1
  // TLC's Reals.tla, RealTime.tla, and Toolbox.tla, verbatim, so that errors inside them name the same
2
2
  // lines as TLC's errors.
3
- const REALS = `-------------------------------- MODULE Reals -------------------------------
3
+ export const REALS = `-------------------------------- MODULE Reals -------------------------------
4
4
  (***************************************************************************)
5
5
  (* This module provides dummy definitions of the operators that are *)
6
6
  (* defined by the real Reals module. It is expected that any tool that *)
@@ -19,7 +19,7 @@ a / b == CHOOSE m \\in Real : m * b = a
19
19
  Infinity == CHOOSE i : (i \\notin Real) /\\ (\\A r \\in Real : i > r)
20
20
  =============================================================================`;
21
21
 
22
- const REAL_TIME = `----------------------------- MODULE RealTime -------------------------------
22
+ export const REAL_TIME = `----------------------------- MODULE RealTime -------------------------------
23
23
  (***************************************************************************)
24
24
  (* This standard module is described in Chapter 9 of the book "Specifying *)
25
25
  (* Systems". The type of specification described there cannot be handled *)
@@ -47,7 +47,7 @@ RTnow(v) == LET NowNext == /\\ now' \\in {r \\in Real : r > now}
47
47
  /\\ \\A r \\in Real : WF_now(NowNext /\\ (now'>r))
48
48
  =============================================================================`;
49
49
 
50
- const TOOLBOX = `----------------------------- MODULE Toolbox --------------------------------
50
+ export const TOOLBOX = `----------------------------- MODULE Toolbox --------------------------------
51
51
  (***************************************************************************)
52
52
  (* *)
53
53
  (***************************************************************************)
package/src/canonical.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { getValueHash, isSameValue, type Value } from "./values";
1
+ import { getValueHash, isInterchangeableValue, type Value } from "./values";
2
2
 
3
3
  const canonicalizeElements = (elements: Value[], canonicalize: (value: Value) => Value) => {
4
4
  for (let index = 0; index < elements.length; index++) {
@@ -15,11 +15,12 @@ export const createCanonicalizer = () => {
15
15
  const hash = getValueHash(value);
16
16
  const bucket = canonicalValues.get(hash);
17
17
  if (bucket !== undefined && !Array.isArray(bucket)) {
18
- if (bucket === value || isSameValue(bucket, value)) return bucket;
18
+ if (bucket === value || isInterchangeableValue(bucket, value)) return bucket;
19
19
  }
20
20
  if (Array.isArray(bucket)) {
21
21
  for (let index = 0; index < bucket.length; index++) {
22
- if (bucket[index] === value || isSameValue(bucket[index], value)) return bucket[index];
22
+ if (bucket[index] === value || isInterchangeableValue(bucket[index], value))
23
+ return bucket[index];
23
24
  }
24
25
  }
25
26
  if (value.kind === "Set") canonicalizeElements(value.elements, canonicalize);