tla-ts 0.0.3-dev.fd18eec → 0.0.3-dev.fe239f8

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 +167 -36
  5. package/dist/index.d.ts +167 -36
  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 -21
  12. package/dist/run-cli.js +1351 -21
  13. package/dist/transfer.cjs +83 -34
  14. package/dist/transfer.js +83 -34
  15. package/package.json +5 -1
  16. package/src/ast.ts +53 -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 +1344 -285
  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 -124
  26. package/src/errors.ts +168 -9
  27. package/src/evaluate.ts +722 -146
  28. package/src/exit-codes.ts +6 -24
  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 +32 -4
  34. package/src/live-check.ts +204 -148
  35. package/src/liveness.ts +190 -117
  36. package/src/obligation-expression.ts +2 -2
  37. package/src/obligation-source.ts +2 -0
  38. package/src/parallel-worker.ts +6 -1
  39. package/src/parallel.ts +57 -6
  40. package/src/parser.ts +437 -130
  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 +1347 -414
  48. package/src/run-cli.ts +1167 -174
  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 +25 -5
  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 +158 -120
  69. package/src/symmetry.ts +168 -50
  70. package/src/tableau.ts +3 -1
  71. package/src/tlc-ext.ts +13 -17
  72. package/src/tlc-messages.ts +329 -0
  73. package/src/tlc-module.ts +49 -21
  74. package/src/tlc-modules.ts +0 -4
  75. package/src/tlc-order.ts +55 -9
  76. package/src/tlc-random.ts +28 -3
  77. package/src/tlc-replay.ts +655 -0
  78. package/src/tlc-version.ts +18 -0
  79. package/src/transfer.ts +15 -3
  80. package/src/value-sources.ts +29 -0
  81. package/src/values.ts +683 -256
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tla-ts",
3
- "version": "0.0.3-dev.fd18eec",
3
+ "version": "0.0.3-dev.fe239f8",
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,31 @@ 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
56
  // The range of the parenthesized arguments of a named operator, where SANY reports their count.
51
57
  argumentsRange?: SourceRange;
58
+ selectorRanges?: SourceRange[];
59
+ // The range of the arguments of each part of a name like F(x)!l(y), for a part that takes some.
60
+ argumentRanges?: (SourceRange | undefined)[];
52
61
  location: SourceLocation;
53
62
  resolution?: LocalResolution;
54
63
  }
@@ -56,13 +65,18 @@ export interface ApplyExpression {
56
65
  export interface OperatorReferenceExpression {
57
66
  kind: "OperatorReference";
58
67
  operator: string;
68
+ spelling?: string;
59
69
  location: SourceLocation;
60
70
  }
61
71
 
72
+ // operator holds the operator, such as SUBSET, that an argument names, which tla-ts reads as a
73
+ // LAMBDA.
62
74
  export interface LambdaExpression {
63
75
  kind: "Lambda";
64
76
  params: string[];
77
+ paramRanges?: SourceRange[];
65
78
  body: Expression;
79
+ operator?: string;
66
80
  location: SourceLocation;
67
81
  }
68
82
 
@@ -70,6 +84,9 @@ export interface JunctionExpression {
70
84
  kind: "And" | "Or";
71
85
  operands: Expression[];
72
86
  isBulleted?: boolean;
87
+ // SANY parses an infix chain such as A /\ B /\ C as (A /\ B) /\ C, whose node of each prefix of
88
+ // two or more operands ends after the parentheses of its last operand.
89
+ prefixEnds?: SourceLocation[];
73
90
  location: SourceLocation;
74
91
  }
75
92
 
@@ -119,7 +136,10 @@ export interface LetExpression {
119
136
  location: SourceLocation;
120
137
  }
121
138
 
122
- export type BoundPattern = { kind: "Name"; name: string } | { kind: "Tuple"; names: string[] };
139
+ // ranges holds the range of each name the pattern binds.
140
+ export type BoundPattern =
141
+ | { kind: "Name"; name: string; ranges?: SourceRange[] }
142
+ | { kind: "Tuple"; names: string[]; ranges?: SourceRange[] };
123
143
 
124
144
  export interface Bound {
125
145
  pattern: BoundPattern;
@@ -137,6 +157,7 @@ export interface UnboundedQuantifierExpression {
137
157
  kind: "UnboundedQuantifier";
138
158
  quantifier: "Forall" | "Exists";
139
159
  names: string[];
160
+ nameRanges?: SourceRange[];
140
161
  isTemporal?: boolean;
141
162
  body: Expression;
142
163
  location: SourceLocation;
@@ -194,6 +215,7 @@ export interface FunctionSetExpression {
194
215
  export interface RecordField {
195
216
  name: string;
196
217
  value: Expression;
218
+ location: SourceLocation;
197
219
  }
198
220
 
199
221
  export interface RecordExpression {
@@ -230,6 +252,14 @@ export interface FunctionApplicationExpression {
230
252
  location: SourceLocation;
231
253
  }
232
254
 
255
+ // SANY parses [e1, ..., en] as a function application without the function, and its semantic
256
+ // checker rejects it.
257
+ export interface BracketExpression {
258
+ kind: "Bracket";
259
+ args: Expression[];
260
+ location: SourceLocation;
261
+ }
262
+
233
263
  export interface FieldAccessExpression {
234
264
  kind: "FieldAccess";
235
265
  record: Expression;
@@ -268,6 +298,7 @@ export interface LabelExpression {
268
298
  kind: "Label";
269
299
  name: string;
270
300
  params: string[];
301
+ paramRanges?: SourceRange[];
271
302
  body: Expression;
272
303
  location: SourceLocation;
273
304
  }
@@ -282,6 +313,8 @@ export type Selector =
282
313
  export interface SubexpressionExpression {
283
314
  kind: "Subexpression";
284
315
  selectors: Selector[];
316
+ selectorRanges?: SourceRange[];
317
+ argumentRanges?: (SourceRange | undefined)[];
285
318
  location: SourceLocation;
286
319
  }
287
320
 
@@ -313,6 +346,7 @@ export type Expression =
313
346
  | ExceptExpression
314
347
  | ExceptAtExpression
315
348
  | FunctionApplicationExpression
349
+ | BracketExpression
316
350
  | FieldAccessExpression
317
351
  | ProductExpression
318
352
  | TemporalExpression
@@ -345,6 +379,8 @@ export interface FunctionDefinition {
345
379
  body: Expression;
346
380
  isLocal: boolean;
347
381
  isRecursive: boolean;
382
+ // Whether the body applies the function, which SANY makes a recursive function definition.
383
+ isSelfReferential?: boolean;
348
384
  location: SourceLocation;
349
385
  }
350
386
 
@@ -365,6 +401,7 @@ export interface Assumption {
365
401
 
366
402
  export interface InstanceSubstitution {
367
403
  name: string;
404
+ nameRange: SourceRange;
368
405
  expression: Expression;
369
406
  }
370
407
 
@@ -386,6 +423,7 @@ export interface NewSymbol {
386
423
  arity: number;
387
424
  level: "Constant" | "Variable" | "State" | "Action" | "Temporal";
388
425
  set: Expression | undefined;
426
+ nameRange?: SourceRange;
389
427
  location: SourceLocation;
390
428
  }
391
429
 
@@ -437,19 +475,27 @@ export type StepBody =
437
475
  | Instance
438
476
  | DefineStep
439
477
  | { kind: "Have"; expression: Expression }
440
- | { kind: "Take"; names: string[]; bounds: Bound[] }
478
+ | { kind: "Take"; names: string[]; nameRanges?: SourceRange[]; bounds: Bound[] }
441
479
  | { kind: "Witness"; expressions: Expression[] }
442
- | { kind: "Pick"; names: string[]; bounds: Bound[]; body: Expression }
480
+ | {
481
+ kind: "Pick";
482
+ names: string[];
483
+ nameRanges?: SourceRange[];
484
+ bounds: Bound[];
485
+ body: Expression;
486
+ }
443
487
  | { kind: "Case"; expression: Expression }
444
488
  | { kind: "Assert"; isSuffices: boolean; statement: Expression | AssumeProve }
445
489
  | { kind: "Qed" };
446
490
 
447
- // head is the range of the step number and its statement, without the proof.
491
+ // head is the range of the step number and its statement, without the proof, and statement is the
492
+ // range of the statement alone.
448
493
  export interface ProofStep {
449
494
  name: string | undefined;
450
495
  token: string;
451
496
  body: StepBody;
452
497
  head: SourceRange;
498
+ statement: SourceRange;
453
499
  proof: Proof | undefined;
454
500
  location: SourceLocation;
455
501
  }
@@ -463,8 +509,7 @@ export interface Theorem {
463
509
 
464
510
  // The units of a module in source order, for consumers that need the order across kinds.
465
511
  export type ModuleUnit =
466
- | { kind: "Constants"; declarations: Declaration[] }
467
- | { kind: "Variables"; declarations: Declaration[] }
512
+ | { kind: "Constants" | "Variables"; declarations: Declaration[]; location: SourceLocation }
468
513
  | { kind: "Recursive"; declarations: Declaration[] }
469
514
  | { kind: "Definition"; definition: Definition }
470
515
  | { kind: "Instance"; instance: Instance }
@@ -558,6 +603,8 @@ export const getChildren = (expression: Expression): Expression[] => {
558
603
  ];
559
604
  case "FunctionApplication":
560
605
  return [expression.function, ...expression.args];
606
+ case "Bracket":
607
+ return expression.args;
561
608
  case "FieldAccess":
562
609
  return [expression.record];
563
610
  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,15 +306,16 @@ export const getJavaInteger = (value: Value, signature: string) => {
297
306
  return value;
298
307
  };
299
308
 
300
- export const getIntegersSignature = (method: string, result: string, arity: number) =>
301
- `public static tlc2.value.impl.${result} tlc2.module.Integers.${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(",")})`;
302
311
 
303
312
  export const defineArithmetic = (
313
+ module: string,
304
314
  name: string,
305
315
  method: string,
306
316
  compute: (left: number, right: number) => number,
307
317
  ) => {
308
- const signature = getIntegersSignature(method, "IntValue", 2);
318
+ const signature = getJavaSignature(module, method, "IntValue", 2);
309
319
  return defineBinary(name, (left, right) => {
310
320
  const leftNumber = getJavaInteger(left, signature);
311
321
  const rightNumber = getJavaInteger(right, signature);
@@ -324,9 +334,17 @@ const getIntegerArgument = (value: Value, position: string, name: string) => {
324
334
  return value;
325
335
  };
326
336
 
327
- 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
+ ) =>
328
343
  defineBinary(name, (left, right) =>
329
- compare(getIntegerArgument(left, "first", name), getIntegerArgument(right, "second", name)),
344
+ compare(
345
+ getIntegerArgument(left, "first", errorName),
346
+ getIntegerArgument(right, "second", errorName),
347
+ ),
330
348
  );
331
349
 
332
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);