tla-ts 0.0.9 → 0.0.10-dev.63a6693bd

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 (400) hide show
  1. package/README.md +29 -1
  2. package/dist/compile.cjs +23 -0
  3. package/dist/compile.js +23 -0
  4. package/dist/deciders.cjs +29 -29
  5. package/dist/deciders.js +42 -42
  6. package/dist/index.cjs +1 -1
  7. package/dist/index.d.cts +106 -10
  8. package/dist/index.d.ts +106 -10
  9. package/dist/index.js +1 -1
  10. package/dist/parallel-worker.cjs +1 -1
  11. package/dist/parallel-worker.js +1 -1
  12. package/dist/prove-worker.cjs +1 -1
  13. package/dist/prove-worker.js +1 -1
  14. package/dist/prove.cjs +117 -37
  15. package/dist/prove.js +116 -36
  16. package/dist/run.cjs +143 -31
  17. package/dist/run.js +143 -31
  18. package/dist/tlapm.cjs +2 -2
  19. package/dist/tlapm.js +2 -2
  20. package/dist/transfer.cjs +129 -104
  21. package/dist/transfer.js +129 -104
  22. package/dist/worker.cjs +7 -7
  23. package/dist/worker.js +7 -7
  24. package/package.json +3 -1
  25. package/src/ast.ts +48 -62
  26. package/src/bags.ts +99 -102
  27. package/src/builtins.ts +28 -75
  28. package/src/bundled-modules.ts +1 -8
  29. package/src/check-failure.ts +116 -0
  30. package/src/check-trace.ts +282 -0
  31. package/src/check.ts +599 -754
  32. package/src/cli/options.ts +12 -32
  33. package/src/cli/run.ts +0 -2
  34. package/src/cli/runtime-invariants.ts +136 -0
  35. package/src/cli/shared.ts +19 -12
  36. package/src/cli/tlapm.ts +14 -25
  37. package/src/cli/tlc-arguments.ts +652 -0
  38. package/src/cli/tlc-output.ts +687 -0
  39. package/src/cli/tlc-usage.ts +361 -0
  40. package/src/cli/tlc.ts +309 -658
  41. package/src/cli/typescript.ts +23 -0
  42. package/src/cli/xml-exporter.ts +27 -49
  43. package/src/cli.ts +0 -1
  44. package/src/codegen.ts +196 -74
  45. package/src/config.ts +140 -109
  46. package/src/coverage.ts +830 -0
  47. package/src/dependencies.ts +14 -53
  48. package/src/dfid.ts +618 -0
  49. package/src/environment-config.ts +315 -0
  50. package/src/environment.ts +169 -335
  51. package/src/errors.ts +71 -55
  52. package/src/evaluate.ts +598 -340
  53. package/src/exit-codes.ts +37 -3
  54. package/src/fingerprints.ts +75 -11
  55. package/src/index.ts +3 -0
  56. package/src/instances.ts +126 -21
  57. package/src/java-hash.ts +7 -0
  58. package/src/java-overrides.ts +4 -19
  59. package/src/json-reader.ts +455 -0
  60. package/src/json.ts +252 -139
  61. package/src/levels.ts +46 -58
  62. package/src/lexer.ts +80 -100
  63. package/src/liveness-checker.ts +103 -153
  64. package/src/liveness.ts +150 -109
  65. package/src/obligations/action.ts +8 -39
  66. package/src/obligations/anonymize.ts +88 -82
  67. package/src/obligations/equality.ts +1 -1
  68. package/src/obligations/expression.ts +20 -21
  69. package/src/obligations/format.ts +1 -9
  70. package/src/obligations/generate.ts +46 -49
  71. package/src/obligations/index.ts +2 -13
  72. package/src/obligations/levels.ts +4 -8
  73. package/src/obligations/module.ts +28 -53
  74. package/src/obligations/normalize.ts +7 -25
  75. package/src/obligations/operators.ts +1 -2
  76. package/src/obligations/pragma.ts +1 -10
  77. package/src/obligations/printer.ts +47 -46
  78. package/src/obligations/proof.ts +1 -5
  79. package/src/obligations/regroup.ts +1 -4
  80. package/src/obligations/simplify.ts +42 -58
  81. package/src/obligations/source.ts +48 -78
  82. package/src/obligations/subexpression.ts +5 -11
  83. package/src/obligations/substitution.ts +1 -3
  84. package/src/obligations/temporal.ts +13 -19
  85. package/src/obligations/tuples.ts +3 -9
  86. package/src/parallel-worker.ts +30 -60
  87. package/src/parallel.ts +57 -71
  88. package/src/parser.ts +584 -316
  89. package/src/pcal/ast.ts +53 -86
  90. package/src/pcal/parse.ts +144 -219
  91. package/src/pcal/tokenize.ts +91 -131
  92. package/src/pcal/translate.ts +83 -130
  93. package/src/pcal/validate.ts +48 -68
  94. package/src/pretty-print.ts +7 -8
  95. package/src/prover/decide-pool.ts +8 -13
  96. package/src/prover/deciders.ts +3 -7
  97. package/src/prover/first-order.ts +0 -11
  98. package/src/prover/isabelle/decide.ts +0 -6
  99. package/src/prover/isabelle/encode.ts +11 -23
  100. package/src/prover/isabelle/isar/inner-syntax.ts +114 -115
  101. package/src/prover/isabelle/isar/method.ts +29 -53
  102. package/src/prover/isabelle/isar/proof.ts +1 -10
  103. package/src/prover/isabelle/isar/statement.ts +1 -6
  104. package/src/prover/isabelle/isar/theory.ts +26 -36
  105. package/src/prover/isabelle/isar/type-check.ts +17 -31
  106. package/src/prover/isabelle/provers/blast/blast.ts +17 -104
  107. package/src/prover/isabelle/provers/blast/branch.ts +1 -32
  108. package/src/prover/isabelle/provers/blast/prove.ts +1 -35
  109. package/src/prover/isabelle/provers/blast/rules.ts +6 -44
  110. package/src/prover/isabelle/provers/blast/state.ts +2 -28
  111. package/src/prover/isabelle/provers/blast/term.ts +9 -36
  112. package/src/prover/isabelle/provers/clasimp.ts +1 -13
  113. package/src/prover/isabelle/provers/classical.ts +14 -42
  114. package/src/prover/isabelle/provers/hypsubst.ts +28 -51
  115. package/src/prover/isabelle/pure/bicompose.ts +25 -38
  116. package/src/prover/isabelle/pure/consts.ts +1 -7
  117. package/src/prover/isabelle/pure/conv.ts +3 -17
  118. package/src/prover/isabelle/pure/drule.ts +33 -42
  119. package/src/prover/isabelle/pure/envir.ts +3 -52
  120. package/src/prover/isabelle/pure/goal.ts +1 -7
  121. package/src/prover/isabelle/pure/interrupt.ts +0 -5
  122. package/src/prover/isabelle/pure/list.ts +0 -3
  123. package/src/prover/isabelle/pure/logic.ts +2 -15
  124. package/src/prover/isabelle/pure/name.ts +2 -9
  125. package/src/prover/isabelle/pure/net.ts +3 -59
  126. package/src/prover/isabelle/pure/object-logic.ts +3 -10
  127. package/src/prover/isabelle/pure/pattern.ts +2 -19
  128. package/src/prover/isabelle/pure/raw-simplifier.ts +17 -62
  129. package/src/prover/isabelle/pure/rewriter.ts +31 -67
  130. package/src/prover/isabelle/pure/search.ts +3 -10
  131. package/src/prover/isabelle/pure/seq.ts +1 -10
  132. package/src/prover/isabelle/pure/simplifier.ts +4 -12
  133. package/src/prover/isabelle/pure/table.ts +3 -32
  134. package/src/prover/isabelle/pure/tactic.ts +12 -22
  135. package/src/prover/isabelle/pure/tactical.ts +48 -47
  136. package/src/prover/isabelle/pure/term-ord.ts +2 -6
  137. package/src/prover/isabelle/pure/term.ts +2 -43
  138. package/src/prover/isabelle/pure/thm.ts +27 -47
  139. package/src/prover/isabelle/pure/type.ts +2 -15
  140. package/src/prover/isabelle/pure/unify.ts +20 -30
  141. package/src/prover/isabelle/pure/variable.ts +3 -7
  142. package/src/prover/isabelle/tla/classical-setup.ts +17 -24
  143. package/src/prover/isabelle/tla/context.ts +15 -18
  144. package/src/prover/isabelle/tla/logic.ts +14 -32
  145. package/src/prover/isabelle/tla/simpdata.ts +46 -43
  146. package/src/prover/isabelle/tools/intuitionistic.ts +1 -10
  147. package/src/prover/ocaml.ts +0 -6
  148. package/src/prover/prep/action.ts +14 -54
  149. package/src/prover/prep/enabled-axioms.ts +12 -19
  150. package/src/prover/prep/fingerprint.ts +2 -21
  151. package/src/prover/prep/level-comparison.ts +8 -12
  152. package/src/prover/prep/md5.ts +0 -2
  153. package/src/prover/prep/methods.ts +33 -39
  154. package/src/prover/prep/normalize.ts +4 -28
  155. package/src/prover/prove-worker.ts +0 -2
  156. package/src/prover/prove.ts +87 -100
  157. package/src/prover/ptl/decide.ts +7 -12
  158. package/src/prover/ptl/encode.ts +14 -36
  159. package/src/prover/ptl/sat.ts +24 -32
  160. package/src/prover/ptl/tableau.ts +12 -26
  161. package/src/prover/smt/axioms.ts +0 -7
  162. package/src/prover/smt/context.ts +20 -28
  163. package/src/prover/smt/data.ts +433 -424
  164. package/src/prover/smt/encode.ts +43 -52
  165. package/src/prover/smt/extensionality.ts +0 -10
  166. package/src/prover/smt/flatten.ts +3 -22
  167. package/src/prover/smt/format.ts +5 -10
  168. package/src/prover/smt/instances.ts +0 -10
  169. package/src/prover/smt/rewrite.ts +663 -667
  170. package/src/prover/smt/solver/act-cache.ts +0 -15
  171. package/src/prover/smt/solver/arith-rewriter.ts +3 -48
  172. package/src/prover/smt/solver/array.ts +1 -3
  173. package/src/prover/smt/solver/asserted-formulas.ts +1 -43
  174. package/src/prover/smt/solver/ast-lt.ts +1 -11
  175. package/src/prover/smt/solver/ast-util.ts +1 -6
  176. package/src/prover/smt/solver/ast.ts +1 -165
  177. package/src/prover/smt/solver/auf-solver.ts +8 -44
  178. package/src/prover/smt/solver/case-split-queue.ts +1 -9
  179. package/src/prover/smt/solver/cg-table.ts +1 -18
  180. package/src/prover/smt/solver/clause.ts +1 -27
  181. package/src/prover/smt/solver/conflict-resolution.ts +0 -9
  182. package/src/prover/smt/solver/context.ts +7 -64
  183. package/src/prover/smt/solver/ctx-simplify.ts +14 -41
  184. package/src/prover/smt/solver/der.ts +2 -21
  185. package/src/prover/smt/solver/dyn-ack.ts +1 -11
  186. package/src/prover/smt/solver/e-matching.ts +4 -35
  187. package/src/prover/smt/solver/enode.ts +1 -21
  188. package/src/prover/smt/solver/expr-ref.ts +1 -5
  189. package/src/prover/smt/solver/expr-safe-replace.ts +1 -6
  190. package/src/prover/smt/solver/fingerprints.ts +1 -12
  191. package/src/prover/smt/solver/flat-literals.ts +1 -9
  192. package/src/prover/smt/solver/goal.ts +2 -14
  193. package/src/prover/smt/solver/hash.ts +0 -8
  194. package/src/prover/smt/solver/hashtable.ts +1 -12
  195. package/src/prover/smt/solver/internalizer.ts +7 -100
  196. package/src/prover/smt/solver/lbool.ts +1 -2
  197. package/src/prover/smt/solver/literal.ts +0 -3
  198. package/src/prover/smt/solver/lp/bound-propagator.ts +8 -26
  199. package/src/prover/smt/solver/lp/constraints.ts +2 -8
  200. package/src/prover/smt/solver/lp/containers.ts +12 -30
  201. package/src/prover/smt/solver/lp/core-solver.ts +10 -31
  202. package/src/prover/smt/solver/lp/cross-nested.ts +6 -20
  203. package/src/prover/smt/solver/lp/dep-intervals.ts +7 -22
  204. package/src/prover/smt/solver/lp/dependency.ts +1 -4
  205. package/src/prover/smt/solver/lp/dioph-eq.ts +9 -102
  206. package/src/prover/smt/solver/lp/explanation.ts +1 -6
  207. package/src/prover/smt/solver/lp/gomory.ts +9 -22
  208. package/src/prover/smt/solver/lp/hnf-cutter.ts +17 -23
  209. package/src/prover/smt/solver/lp/hnf.ts +11 -26
  210. package/src/prover/smt/solver/lp/int-cube.ts +15 -36
  211. package/src/prover/smt/solver/lp/int-solver.ts +4 -34
  212. package/src/prover/smt/solver/lp/lar-solver.ts +32 -81
  213. package/src/prover/smt/solver/lp/lar-term.ts +1 -5
  214. package/src/prover/smt/solver/lp/lp-settings.ts +1 -14
  215. package/src/prover/smt/solver/lp/maximize-term.ts +20 -45
  216. package/src/prover/smt/solver/lp/nex-creator.ts +5 -28
  217. package/src/prover/smt/solver/lp/nex.ts +1 -6
  218. package/src/prover/smt/solver/lp/nla-backoff.ts +1 -4
  219. package/src/prover/smt/solver/lp/nla-basics.ts +5 -30
  220. package/src/prover/smt/solver/lp/nla-core.ts +36 -135
  221. package/src/prover/smt/solver/lp/nla-divisions.ts +32 -42
  222. package/src/prover/smt/solver/lp/nla-emonics.ts +4 -21
  223. package/src/prover/smt/solver/lp/nla-factorization.ts +1 -4
  224. package/src/prover/smt/solver/lp/nla-grobner.ts +15 -69
  225. package/src/prover/smt/solver/lp/nla-horner.ts +3 -11
  226. package/src/prover/smt/solver/lp/nla-intervals.ts +2 -12
  227. package/src/prover/smt/solver/lp/nla-monomial-bounds.ts +16 -41
  228. package/src/prover/smt/solver/lp/nla-monotone.ts +2 -6
  229. package/src/prover/smt/solver/lp/nla-order.ts +2 -13
  230. package/src/prover/smt/solver/lp/nla-patcher.ts +4 -7
  231. package/src/prover/smt/solver/lp/nla-tangents.ts +1 -9
  232. package/src/prover/smt/solver/lp/nla-throttle.ts +1 -6
  233. package/src/prover/smt/solver/lp/nla-types.ts +1 -11
  234. package/src/prover/smt/solver/lp/nla-var-eqs.ts +4 -25
  235. package/src/prover/smt/solver/lp/nra-solver.ts +5 -52
  236. package/src/prover/smt/solver/lp/numeric-pair.ts +1 -4
  237. package/src/prover/smt/solver/lp/pdd-interval.ts +1 -3
  238. package/src/prover/smt/solver/lp/pdd-simplifier.ts +2 -14
  239. package/src/prover/smt/solver/lp/pdd-solver.ts +4 -33
  240. package/src/prover/smt/solver/lp/pdd.ts +7 -70
  241. package/src/prover/smt/solver/lp/random-updater.ts +1 -8
  242. package/src/prover/smt/solver/lp/static-matrix.ts +9 -19
  243. package/src/prover/smt/solver/lp/union-find.ts +1 -6
  244. package/src/prover/smt/solver/mam-compiler.ts +18 -58
  245. package/src/prover/smt/solver/mam-interpreter.ts +1 -21
  246. package/src/prover/smt/solver/maximize-ac-sharing.ts +2 -17
  247. package/src/prover/smt/solver/model-checker.ts +3 -37
  248. package/src/prover/smt/solver/model-evaluator.ts +3 -29
  249. package/src/prover/smt/solver/model-finder.ts +15 -32
  250. package/src/prover/smt/solver/model-generator.ts +1 -12
  251. package/src/prover/smt/solver/model-macro-solver.ts +23 -88
  252. package/src/prover/smt/solver/nlsat/algebraic.ts +63 -159
  253. package/src/prover/smt/solver/nlsat/atoms.ts +25 -23
  254. package/src/prover/smt/solver/nlsat/evaluator.ts +17 -22
  255. package/src/prover/smt/solver/nlsat/explain.ts +10 -69
  256. package/src/prover/smt/solver/nlsat/interval-set.ts +9 -50
  257. package/src/prover/smt/solver/nlsat/levelwise.ts +49 -135
  258. package/src/prover/smt/solver/nlsat/mpbq.ts +3 -14
  259. package/src/prover/smt/solver/nlsat/polynomial.ts +29 -159
  260. package/src/prover/smt/solver/nlsat/solver.ts +18 -90
  261. package/src/prover/smt/solver/nlsat/types.ts +1 -8
  262. package/src/prover/smt/solver/nlsat/upolynomial-factorization.ts +2 -45
  263. package/src/prover/smt/solver/nlsat/upolynomial.ts +11 -92
  264. package/src/prover/smt/solver/nnf.ts +3 -38
  265. package/src/prover/smt/solver/pattern-inference.ts +2 -15
  266. package/src/prover/smt/solver/poly-rewriter.ts +3 -23
  267. package/src/prover/smt/solver/propagate-values.ts +1 -10
  268. package/src/prover/smt/solver/proto-model.ts +3 -52
  269. package/src/prover/smt/solver/pull-quant.ts +1 -12
  270. package/src/prover/smt/solver/qe-lite-der.ts +1 -29
  271. package/src/prover/smt/solver/qe-lite-fm.ts +2 -25
  272. package/src/prover/smt/solver/qe-lite.ts +3 -33
  273. package/src/prover/smt/solver/qi-queue.ts +1 -16
  274. package/src/prover/smt/solver/quant-tactics.ts +5 -22
  275. package/src/prover/smt/solver/quantifier-analyzer.ts +27 -47
  276. package/src/prover/smt/solver/quantifier-manager.ts +2 -13
  277. package/src/prover/smt/solver/random-gen.ts +1 -2
  278. package/src/prover/smt/solver/rational.ts +1 -8
  279. package/src/prover/smt/solver/ref-vector.ts +1 -6
  280. package/src/prover/smt/solver/relevancy.ts +2 -15
  281. package/src/prover/smt/solver/rewriter-tpl.ts +3 -147
  282. package/src/prover/smt/solver/rewriter.ts +3 -85
  283. package/src/prover/smt/solver/rlimit.ts +2 -20
  284. package/src/prover/smt/solver/smtlib-parser.ts +80 -131
  285. package/src/prover/smt/solver/solver.ts +23 -34
  286. package/src/prover/smt/solver/sort.ts +1 -5
  287. package/src/prover/smt/solver/sticky-generations.ts +0 -5
  288. package/src/prover/smt/solver/theory-lra-axioms.ts +3 -24
  289. package/src/prover/smt/solver/theory-lra-bounds.ts +1 -7
  290. package/src/prover/smt/solver/theory-lra-final-check.ts +4 -22
  291. package/src/prover/smt/solver/theory-lra-internalize.ts +6 -43
  292. package/src/prover/smt/solver/theory-lra-model.ts +4 -19
  293. package/src/prover/smt/solver/theory-lra-propagate.ts +1 -15
  294. package/src/prover/smt/solver/theory-lra-state.ts +3 -8
  295. package/src/prover/smt/solver/theory-lra.ts +1 -8
  296. package/src/prover/smt/solver/var-subst.ts +2 -26
  297. package/src/prover/smt/table.ts +0 -8
  298. package/src/prover/tlapm/cache.ts +45 -40
  299. package/src/prover/tlapm/ocaml-marshal.ts +19 -21
  300. package/src/prover/tlapm/tlapm.ts +21 -20
  301. package/src/prover/verdict.ts +7 -2
  302. package/src/prover/zenon/check/check.ts +1 -11
  303. package/src/prover/zenon/check/definitions.ts +5 -15
  304. package/src/prover/zenon/check/equality.ts +0 -8
  305. package/src/prover/zenon/check/functions.ts +0 -4
  306. package/src/prover/zenon/check/keys.ts +0 -7
  307. package/src/prover/zenon/check/propositional.ts +0 -3
  308. package/src/prover/zenon/check/records.ts +1 -6
  309. package/src/prover/zenon/check/relations.ts +2 -14
  310. package/src/prover/zenon/check/rewrites.ts +2 -21
  311. package/src/prover/zenon/check/sets.ts +40 -61
  312. package/src/prover/zenon/check/terms.ts +1 -19
  313. package/src/prover/zenon/check/tla.ts +0 -6
  314. package/src/prover/zenon/decide.ts +0 -12
  315. package/src/prover/zenon/encode.ts +1 -8
  316. package/src/prover/zenon/eqrel.ts +2 -13
  317. package/src/prover/zenon/equality-rules.ts +0 -4
  318. package/src/prover/zenon/expr.ts +8 -26
  319. package/src/prover/zenon/index-table.ts +26 -57
  320. package/src/prover/zenon/isar-case.ts +9 -19
  321. package/src/prover/zenon/isar.ts +36 -64
  322. package/src/prover/zenon/limits.ts +0 -4
  323. package/src/prover/zenon/llproof.ts +2 -20
  324. package/src/prover/zenon/mltoll.ts +66 -104
  325. package/src/prover/zenon/node.ts +1 -11
  326. package/src/prover/zenon/ocaml.ts +1 -17
  327. package/src/prover/zenon/parse.ts +4 -12
  328. package/src/prover/zenon/phrase.ts +1 -11
  329. package/src/prover/zenon/proof.ts +0 -9
  330. package/src/prover/zenon/propositional-rules.ts +0 -5
  331. package/src/prover/zenon/rules.ts +2 -6
  332. package/src/prover/zenon/search.ts +5 -31
  333. package/src/prover/zenon/tla/functions.ts +59 -31
  334. package/src/prover/zenon/tla/llproof.ts +67 -76
  335. package/src/prover/zenon/tla/records.ts +57 -33
  336. package/src/prover/zenon/tla/rewrites.ts +12 -19
  337. package/src/prover/zenon/tla/sets.ts +83 -53
  338. package/src/prover/zenon/tla/terms.ts +0 -6
  339. package/src/prover/zenon/tla/tla.ts +66 -64
  340. package/src/randomization.ts +81 -35
  341. package/src/resolve.ts +67 -184
  342. package/src/runtime.ts +22 -22
  343. package/src/sany/builtins.ts +2 -5
  344. package/src/sany/generation.ts +394 -0
  345. package/src/sany/generator-def-entries.ts +210 -0
  346. package/src/sany/generator-definitions.ts +686 -0
  347. package/src/sany/generator-expressions.ts +1100 -0
  348. package/src/sany/generator-proofs.ts +662 -0
  349. package/src/sany/generator.ts +191 -2764
  350. package/src/sany/levels.ts +6 -34
  351. package/src/sany/lexer.ts +58 -77
  352. package/src/sany/linter.ts +1 -9
  353. package/src/sany/modules.ts +1 -5
  354. package/src/sany/nodes.ts +5 -43
  355. package/src/sany/parse-error.ts +39 -117
  356. package/src/sany/report.ts +32 -69
  357. package/src/sany/selectors.ts +49 -76
  358. package/src/sany/source.ts +1 -17
  359. package/src/sany/xml.ts +35 -117
  360. package/src/search.ts +541 -163
  361. package/src/simulate.ts +709 -0
  362. package/src/spec-description.ts +192 -100
  363. package/src/standard-definitions.ts +0 -4
  364. package/src/standard-modules.ts +264 -95
  365. package/src/state-graph.ts +52 -31
  366. package/src/subexpressions.ts +69 -52
  367. package/src/substitution-levels.ts +7 -7
  368. package/src/successors.ts +266 -99
  369. package/src/symmetry.ts +33 -25
  370. package/src/tableau.ts +27 -24
  371. package/src/tlc/fingerprint.ts +183 -67
  372. package/src/tlc/jar-data.ts +112 -6
  373. package/src/tlc/messages.ts +125 -54
  374. package/src/tlc/order.ts +39 -69
  375. package/src/tlc/random.ts +37 -49
  376. package/src/tlc/replay.ts +553 -228
  377. package/src/tlc/summary.ts +36 -47
  378. package/src/tlc/tlc-operators.ts +78 -44
  379. package/src/tlc/tlcext-operators.ts +139 -122
  380. package/src/tlc/trace-spec.ts +249 -0
  381. package/src/tlc/value-stream.ts +139 -0
  382. package/src/tlc/version.ts +1 -4
  383. package/src/transfer.ts +22 -25
  384. package/src/typescript/actions.ts +479 -0
  385. package/src/typescript/collections.ts +614 -0
  386. package/src/typescript/compile.ts +63 -0
  387. package/src/typescript/context.ts +94 -0
  388. package/src/typescript/emit.ts +121 -0
  389. package/src/typescript/expressions.ts +496 -0
  390. package/src/typescript/formula.ts +154 -0
  391. package/src/typescript/functions.ts +284 -0
  392. package/src/typescript/model.ts +162 -0
  393. package/src/typescript/names.ts +114 -0
  394. package/src/typescript/program.ts +48 -0
  395. package/src/typescript/properties.ts +139 -0
  396. package/src/typescript/scope.ts +112 -0
  397. package/src/typescript/steps.ts +167 -0
  398. package/src/typescript/types.ts +171 -0
  399. package/src/values.ts +832 -484
  400. package/src/worker.ts +7 -8
@@ -1,24 +1,24 @@
1
1
  import {
2
- createJavaOverrideError,
3
- defineHigherOrderOperator,
4
2
  defineLazyOperator,
5
3
  defineOperator,
6
4
  defineStateOperator,
5
+ getKindString,
7
6
  getOperator,
8
7
  getThunk,
9
8
  getValue,
10
9
  } from "../builtins";
11
- import { TlaEvaluationError, TlaModuleError, TlaUnsupportedError } from "../errors";
10
+ import { formatRange, TlaEndOfInputError, TlaEvaluationError, TlaModuleError } from "../errors";
12
11
  import { getTlcFingerprint } from "./fingerprint";
13
- import { formatNestedMessage } from "./messages";
12
+ import { formatMessage, formatNestedMessage, MESSAGE_CODE, MESSAGE_LEVEL } from "./messages";
14
13
  import {
14
+ describeRange,
15
15
  evaluate,
16
- expectBoolean,
17
16
  getDefinition,
18
17
  type Builtin,
19
18
  type Environment,
20
19
  } from "../evaluate";
21
20
  import { getChildren, isLocallyResolved, type Definition, type Expression } from "../ast";
21
+ import { ACTION_LEVEL, CONSTANT_LEVEL, VARIABLE_LEVEL } from "../levels";
22
22
  import {
23
23
  getNamedRegisters,
24
24
  getPossibleCounts,
@@ -32,25 +32,13 @@ import {
32
32
  createSet,
33
33
  createTuple,
34
34
  formatValue,
35
- getDomain,
35
+ getFingerprintError,
36
36
  getSequenceElements,
37
37
  getValueKey,
38
- isFunctionValue,
39
38
  toFiniteSet,
40
- valuesEqual,
41
39
  type Value,
42
40
  } from "../values";
43
41
 
44
- const OVERRIDE_PARAMETERS =
45
- "tlc2.tool.impl.Tool,tla2sany.semantic.ExprOrOpArgNode[],tlc2.util.Context,tlc2.tool.TLCState,tlc2.tool.TLCState,int,tlc2.tool.coverage.CostModel";
46
-
47
- const ASSERT_ERROR_METHOD = `public static synchronized tlc2.value.impl.Value tlc2.module.TLCExt.assertError(${OVERRIDE_PARAMETERS})`;
48
-
49
- const TRACE_METHOD = `public static tlc2.value.impl.TupleValue tlc2.module.TLCExt.getTrace(${OVERRIDE_PARAMETERS}) throws java.io.IOException`;
50
-
51
- const PICK_SUCCESSOR_METHOD = `public static synchronized tlc2.value.impl.Value tlc2.module.TLCExt.pickSuccessor(${OVERRIDE_PARAMETERS})`;
52
-
53
- // TLC's record for an action it doesn't store, such as every action in breadth-first search.
54
42
  export const createActionRecord = (action: string | undefined) =>
55
43
  createRecord([
56
44
  ["name", action ?? "UnnamedAction"],
@@ -66,9 +54,17 @@ export const createActionRecord = (action: string | undefined) =>
66
54
  ],
67
55
  ]);
68
56
 
69
- // TLC's CounterExample is a graph of the violating behavior: the states numbered from 1, an edge
70
- // for each step, and for a lasso an edge from the last state back to where the loop starts. Each
71
- // edge holds the record of the action TLC found for the step.
57
+ const counterExamples = new WeakSet<Value & object>();
58
+
59
+ const createCounterExampleRecord = (action: Value[], states: Value[]) => {
60
+ const counterExample = createRecord([
61
+ ["action", createSet(action)],
62
+ ["state", createSet(states)],
63
+ ]);
64
+ counterExamples.add(counterExample);
65
+ return counterExample;
66
+ };
67
+
72
68
  export const createCounterExample = (
73
69
  stateRecords: Record<string, Value>[],
74
70
  actions: Value[],
@@ -83,10 +79,7 @@ export const createCounterExample = (
83
79
  const closing = loop
84
80
  ? [createTuple([states[states.length - 1], loop.action, states[loop.start]])]
85
81
  : [];
86
- return createRecord([
87
- ["action", createSet([...steps, ...closing])],
88
- ["state", createSet(states)],
89
- ]);
82
+ return createCounterExampleRecord([...steps, ...closing], states);
90
83
  };
91
84
 
92
85
  const getRegister = (runtime: CheckerRuntime, key: Value) => {
@@ -97,7 +90,6 @@ const getRegister = (runtime: CheckerRuntime, key: Value) => {
97
90
  return undefined;
98
91
  };
99
92
 
100
- // TLC's TLCSet. TLCExt's TLCGetAndSet is a TLA+ definition that calls it.
101
93
  export const setTlcValue = (
102
94
  runtime: CheckerRuntime,
103
95
  print: (text: string) => void,
@@ -113,7 +105,7 @@ export const setTlcValue = (
113
105
  return;
114
106
  }
115
107
  if (key === "pause") {
116
- if (value !== true) return;
108
+ if (value !== true || !runtime.pause) return;
117
109
  print("Press enter to resume model checking.");
118
110
  runtime.pause();
119
111
  return;
@@ -131,33 +123,39 @@ export const setTlcValue = (
131
123
  );
132
124
  };
133
125
 
126
+ const describeNode = (expression: Expression) =>
127
+ expression.kind === "Number"
128
+ ? (expression.text ?? String(expression.value))
129
+ : expression.kind === "Decimal"
130
+ ? expression.text
131
+ : describeRange(expression);
132
+
134
133
  const isCompleteState = (state: (Value | undefined)[]): state is Value[] =>
135
134
  state.every((value) => value !== undefined);
136
135
 
137
- const toStateRecord = (state: Value[], environment: Environment) =>
138
- createRecord(environment.variables.map((name, index): [string, Value] => [name, state[index]]));
139
-
140
- const mentionsVariables = (
136
+ const getMentionedLevel = (
141
137
  expression: Expression,
142
138
  environment: Environment,
143
139
  visited: Set<Definition>,
144
- ): boolean => {
140
+ ): number => {
141
+ if (expression.kind === "Prime" || expression.kind === "Unchanged") return ACTION_LEVEL;
145
142
  const name =
146
143
  expression.kind === "Identifier"
147
144
  ? expression.name
148
145
  : expression.kind === "Apply"
149
146
  ? expression.operator
150
147
  : undefined;
151
- if (expression.kind === "Prime" || expression.kind === "Unchanged") return true;
152
- if (name !== undefined && !isLocallyResolved(expression)) {
153
- if (environment.variableIndex.has(name)) return true;
154
- const definition = getDefinition(name, environment);
155
- if (definition && !visited.has(definition)) {
156
- visited.add(definition);
157
- if (mentionsVariables(definition.body, environment, visited)) return true;
158
- }
148
+ const isGlobal = name !== undefined && !isLocallyResolved(expression);
149
+ if (isGlobal && environment.variableIndex.has(name)) return VARIABLE_LEVEL;
150
+ const levels = getChildren(expression).map((child) =>
151
+ getMentionedLevel(child, environment, visited),
152
+ );
153
+ const definition = isGlobal ? getDefinition(name, environment) : undefined;
154
+ if (definition && !visited.has(definition)) {
155
+ visited.add(definition);
156
+ levels.push(getMentionedLevel(definition.body, environment, visited));
159
157
  }
160
- return getChildren(expression).some((child) => mentionsVariables(child, environment, visited));
158
+ return Math.max(CONSTANT_LEVEL, ...levels);
161
159
  };
162
160
 
163
161
  export const createTlcExtOperators = (
@@ -172,23 +170,11 @@ export const createTlcExtOperators = (
172
170
  return caches;
173
171
  };
174
172
  return [
175
- defineOperator("AssertEq", 2, (args) => {
176
- const left = getValue(args, 0, "AssertEq");
177
- const right = getValue(args, 1, "AssertEq");
178
- const isEqual = valuesEqual(left, right);
179
- if (!isEqual) {
180
- print(formatValue("Assertion failed", true));
181
- print(formatValue(left, true));
182
- print(formatValue(right, true));
183
- }
184
- return isEqual;
185
- }),
186
173
  defineLazyOperator("AssertError", 2, (args) => {
187
174
  const message = getOperator(args, 0, "AssertError").expression;
188
175
  if (message && message.kind !== "String") {
189
- throw createJavaOverrideError(
190
- ASSERT_ERROR_METHOD,
191
- `In computing AssertError, a non-string expression (line ${message.location.line}, col ${message.location.column}) was used as the err of an AssertError(err, exp).`,
176
+ throw new TlaEvaluationError(
177
+ `In computing AssertError, a non-string expression (${describeNode(message)}) was used as the err of an AssertError(err, exp).`,
192
178
  );
193
179
  }
194
180
  const expected = getThunk(args, 0, "AssertError")();
@@ -202,57 +188,43 @@ export const createTlcExtOperators = (
202
188
  }
203
189
  return false;
204
190
  }),
205
- defineStateOperator("TLCGetOrDefault", 2, (args) => {
206
- const key = getValue(args, 0, "TLCGetOrDefault");
207
- return getRegister(runtime, key) ?? getValue(args, 1, "TLCGetOrDefault");
208
- }),
209
- {
210
- ...defineHigherOrderOperator("TLCGetAndSet", 4, (args) => {
211
- const key = getValue(args, 0, "TLCGetAndSet");
212
- const previous = getRegister(runtime, key) ?? getValue(args, 3, "TLCGetAndSet");
213
- const update = getOperator(args, 1, "TLCGetAndSet");
214
- setTlcValue(
215
- runtime,
216
- print,
217
- key,
218
- update.call([previous, getValue(args, 2, "TLCGetAndSet")]),
219
- );
220
- return previous;
221
- }),
222
- isStateLevel: true,
223
- },
224
- defineStateOperator("Trace", 0, (_, context) => {
225
- const state = context?.state;
226
- if (!context || !state || !isCompleteState(state)) {
227
- const unassigned = (context?.environment.variables ?? []).filter(
228
- (_, index) => state?.[index] === undefined,
229
- );
230
- throw createJavaOverrideError(
231
- TRACE_METHOD,
191
+ defineStateOperator(
192
+ "TLCGetOrDefault",
193
+ 2,
194
+ (args) =>
195
+ getRegister(runtime, getValue(args, 0, "TLCGetOrDefault")) ??
196
+ getValue(args, 1, "TLCGetOrDefault"),
197
+ ),
198
+ defineStateOperator("Trace", 0, (_args, context) => {
199
+ const variables = context?.environment.variables ?? [];
200
+ const state = context?.state ?? variables.map(() => undefined);
201
+ if (!context || !isCompleteState(state)) {
202
+ const unassigned = variables.filter((_name, index) => state[index] === undefined);
203
+ throw new TlaEvaluationError(
232
204
  `In evaluating TLCExt!Trace, the state is not completely specified yet (variable${unassigned.length > 1 ? "s" : ""} ${unassigned.join(", ")} undefined).`,
233
205
  );
234
206
  }
207
+ if (!context.state) return createTuple([createRecord([])]);
235
208
  return createTuple(
236
- runtime.getBehavior(state).map((step) => toStateRecord(step, context.environment)),
209
+ runtime.getBehavior(state).map((step) => {
210
+ const fields = context.environment.variables.map((name, index): [string, Value] => [
211
+ name,
212
+ step[index],
213
+ ]);
214
+ const action = runtime.getSimulationValue?.("action", step);
215
+ return createRecord(action === undefined ? fields : [["_action", action], ...fields]);
216
+ }),
237
217
  );
238
218
  }),
239
219
  defineStateOperator(
240
220
  "CounterExample",
241
221
  0,
242
- () =>
243
- runtime.counterExample ??
244
- createRecord([
245
- ["action", createSet([])],
246
- ["state", createSet([])],
247
- ]),
222
+ () => runtime.counterExample ?? createCounterExampleRecord([], []),
248
223
  ),
249
224
  defineOperator("ToTrace", 1, (args) => {
250
225
  const counterExample = getValue(args, 0, "ToTrace");
251
- if (
252
- !isFunctionValue(counterExample) ||
253
- !valuesEqual(getDomain(counterExample), createSet(["action", "state"]))
254
- ) {
255
- throw new TlaEvaluationError(
226
+ if (typeof counterExample !== "object" || !counterExamples.has(counterExample)) {
227
+ throw new TlaModuleError(
256
228
  `The argument of ToTrace should be a CounterExample, but instead it is:\n${formatValue(counterExample)}`,
257
229
  );
258
230
  }
@@ -272,31 +244,59 @@ export const createTlcExtOperators = (
272
244
  }
273
245
  return createModelValue(name);
274
246
  }),
275
- // TLC runs the deferred expression only in simulation, when it extends a behavior.
276
- defineLazyOperator("TLCDefer", 1, () => true),
277
- defineOperator("TLCNoOp", 1, (args) => getValue(args, 0, "TLCNoOp")),
278
- defineLazyOperator("PickSuccessor", 1, (args, context) => {
279
- const next = context?.next;
280
- if (!next || !isCompleteState(next)) {
281
- throw createJavaOverrideError(
282
- PICK_SUCCESSOR_METHOD,
283
- 'Cannot invoke "tlc2.value.IValue.fingerPrint(long)" because "minVals[i]" is null',
284
- );
247
+ defineLazyOperator("TLCDefer", 1, (args, context) => {
248
+ const expression = getOperator(args, 0, "TLCDefer").expression;
249
+ if (context && expression) {
250
+ runtime.deferred = (next) => {
251
+ evaluate(expression, { ...context, next });
252
+ };
285
253
  }
286
- if (runtime.isSeen(next)) return true;
287
- if (expectBoolean(getThunk(args, 0, "PickSuccessor")(), "the condition of PickSuccessor")) {
288
- return true;
289
- }
290
- throw new TlaUnsupportedError(
291
- "PickSuccessor needs interactive input to extend the behavior with a new state",
292
- );
254
+ return true;
293
255
  }),
256
+ defineOperator("TLCNoOp", 1, (args) => getValue(args, 0, "TLCNoOp")),
257
+ {
258
+ ...defineLazyOperator("PickSuccessor", 1, (args, context) => {
259
+ // Deviation from TLC: TLCExt#pickSuccessor fingerprints a partial successor and fails, where TLCExt.tla promises TRUE.
260
+ const next = context?.next ?? (context?.environment.variables ?? []).map(() => undefined);
261
+ if (!isCompleteState(next)) return true;
262
+ if (context?.next && runtime.isSeen(next)) return true;
263
+ const guard = getOperator(args, 0, "PickSuccessor");
264
+ const isPicked = guard.call([]);
265
+ if (typeof isPicked !== "boolean") {
266
+ throw new TlaEvaluationError(
267
+ `In evaluating TLCExt!PickSuccessor, a non-boolean expression (${getKindString(isPicked)}) was used as the condition of an IF.\n${guard.expression ? describeNode(guard.expression) : ""}`,
268
+ );
269
+ }
270
+ if (isPicked || !context?.next || !context.state || !isCompleteState(context.state)) {
271
+ return true;
272
+ }
273
+ const action = runtime.getSuccessorAction(context.state, next);
274
+ print(
275
+ formatMessage(
276
+ runtime.isTool,
277
+ MESSAGE_CODE.moduleOverrideStdout,
278
+ MESSAGE_LEVEL.none,
279
+ `Extend behavior of length ${runtime.getLevel(context.state)} with a "${action?.name}" step [<Action ${action?.location.range && formatRange(action.location.range)}>]? (Yes/no/explored/states/diff):`,
280
+ ),
281
+ );
282
+ // Deviation from TLC: PickSuccessor has no standard input to read an answer from.
283
+ throw new TlaEndOfInputError();
284
+ }),
285
+ isActionLevel: true,
286
+ },
294
287
  defineLazyOperator("TLCCache", 2, (args, context) => {
295
288
  const expression = getOperator(args, 0, "TLCCache");
296
289
  const closure = getValueKey(getThunk(args, 1, "TLCCache")());
297
290
  const source = expression.expression;
298
291
  if (!source || !context) return expression.call([]);
299
- const isStateLevel = mentionsVariables(source, context.environment, new Set());
292
+ const level = getMentionedLevel(source, context.environment, new Set());
293
+ if (level === ACTION_LEVEL) return expression.call([]);
294
+ const isStateLevel = level === VARIABLE_LEVEL;
295
+ // TLC's model checker keeps no cache in a state, so its TLA+ definition evaluates it again.
296
+ if (isStateLevel && context.state && runtime.getSimulationValue === undefined) {
297
+ expression.call([]);
298
+ return expression.call([]);
299
+ }
300
300
  const caches = isStateLevel && context.state ? getStateCaches(context.state) : globalCaches;
301
301
  const cache = caches.get(source) ?? new Map<string, Value>();
302
302
  caches.set(source, cache);
@@ -306,24 +306,41 @@ export const createTlcExtOperators = (
306
306
  cache.set(closure, value);
307
307
  return value;
308
308
  }),
309
- defineOperator("TLCFP", 1, (args) =>
310
- Number(BigInt.asIntN(32, getTlcFingerprint([getValue(args, 0, "TLCFP")]))),
311
- ),
312
- defineStateOperator("TLCEvalDefinition", 1, (args, context) => {
313
- const name = getValue(args, 0, "TLCEvalDefinition");
314
- const definition =
315
- typeof name === "string" && context ? getDefinition(name, context.environment) : undefined;
316
- if (!definition || typeof name !== "string" || !context) {
309
+ defineOperator("TLCFP", 1, (args) => {
310
+ const value = getValue(args, 0, "TLCFP");
311
+ const error = getFingerprintError(value);
312
+ if (error) throw error;
313
+ return Number(BigInt.asIntN(32, getTlcFingerprint([value])));
314
+ }),
315
+ defineLazyOperator("TLCEvalDefinition", 1, (args, context) => {
316
+ const name = getThunk(args, 0, "TLCEvalDefinition")();
317
+ if (typeof name !== "string") {
318
+ throw new TlaModuleError(
319
+ `The argument of TLCEvalDefinition should be a string, but instead it is:\n${formatValue(name)}`,
320
+ );
321
+ }
322
+ const definition = context ? getDefinition(name, context.environment) : undefined;
323
+ const builtin = definition ? undefined : context?.environment.builtins.get(name);
324
+ if (builtin?.arity === 0) return builtin.evaluate([], context);
325
+ if (!definition || !context) {
317
326
  throw new TlaModuleError(
318
327
  `The argument of TLCEvalDefinition should be a name of a definition reachable from the root module, but instead it is:\n${formatValue(name)}`,
319
328
  );
320
329
  }
321
330
  if (definition.kind === "Operator" && definition.params.length > 0) {
331
+ const parameters = definition.params.map((param) =>
332
+ param.arity === 0
333
+ ? param.name
334
+ : `${param.name}(${Array.from({ length: param.arity }, () => "_").join(",")})`,
335
+ );
336
+ // TLC's message template puts another "a" before the expected kind.
322
337
  throw new TlaModuleError(
323
- `The argument of TLCEvalDefinition should be a zero-arity definition, but instead it is:\n${name}`,
338
+ `The argument of TLCEvalDefinition should be a a zero-arity definition, but instead it is:\n${name}(${parameters.join(", ")})`,
324
339
  );
325
340
  }
326
- return evaluate({ kind: "Identifier", name, location: definition.location }, context);
341
+ return definition.kind === "Operator"
342
+ ? evaluate(definition.body, context)
343
+ : evaluate({ kind: "Identifier", name, location: definition.location }, context);
327
344
  }),
328
345
  ];
329
346
  };
@@ -0,0 +1,249 @@
1
+ import { getJavaHashCode } from "../java-hash";
2
+ import { formatValue, type Value } from "../values";
3
+ import { zeroPad } from "./messages";
4
+
5
+ interface TraceSpecInput {
6
+ module: string;
7
+ specName: string;
8
+ rawConstants: string[];
9
+ states: Record<string, Value>[];
10
+ loopStart: number | undefined;
11
+ modelValues: string[];
12
+ isDefined: (name: string) => boolean;
13
+ }
14
+
15
+ const INDENT = " ";
16
+ const SEPARATOR = "\n----\n";
17
+ const CLOSING_TAG = `${"=".repeat(77)}\n`;
18
+ const LASSO_START = "_TTraceLassoStart";
19
+ const LASSO_END = "_TTraceLassoEnd";
20
+
21
+ const getHashMapHash = (text: string) => {
22
+ const hash = getJavaHashCode(text);
23
+ return hash ^ (hash >>> 16);
24
+ };
25
+
26
+ const getHashOrder = (names: string[]) => {
27
+ const unique = [...new Set(names)];
28
+ const capacity = 2 ** Math.max(4, Math.ceil(Math.log2(unique.length / 0.75)));
29
+ return unique
30
+ .map((name, index) => ({ name, index, bucket: getHashMapHash(name) & (capacity - 1) }))
31
+ .sort((left, right) => left.bucket - right.bucket || left.index - right.index)
32
+ .map((entry) => entry.name);
33
+ };
34
+
35
+ const formatJavaDate = (date: Date) => {
36
+ const getPart = (options: Intl.DateTimeFormatOptions, type: Intl.DateTimeFormatPartTypes) =>
37
+ new Intl.DateTimeFormat("en-US", options).formatToParts(date).find((part) => part.type === type)
38
+ ?.value;
39
+ return `${getPart({ weekday: "short" }, "weekday")} ${getPart({ month: "short" }, "month")} ${zeroPad(date.getDate())} ${zeroPad(date.getHours())}:${zeroPad(date.getMinutes())}:${zeroPad(date.getSeconds())} ${getPart({ timeZoneName: "short" }, "timeZoneName")} ${date.getFullYear()}`;
40
+ };
41
+
42
+ const splitLines = (text: string) => {
43
+ const lines = text.split("\n");
44
+ while (lines.length > 1 && lines[lines.length - 1] === "") lines.pop();
45
+ return lines;
46
+ };
47
+
48
+ const indent = (text: string, depth: number) => {
49
+ const prefix = INDENT.repeat(depth);
50
+ return prefix + splitLines(text).join(`\n${prefix}`);
51
+ };
52
+
53
+ const getPrimer = (module: string, extendedModules: string[]) =>
54
+ `---- MODULE ${module} ----\nEXTENDS ${extendedModules.join(", ")}\n\n`;
55
+
56
+ const getConjunction = (state: [string, string][], prefix?: string) =>
57
+ indent(
58
+ [
59
+ ...(prefix === undefined ? [] : [prefix]),
60
+ ...state.map(([name, value]) => `${name} = (${value})`),
61
+ ].join("\n/\\\n"),
62
+ 2,
63
+ );
64
+
65
+ const getInstance = (name: string, module: string, definition: string) =>
66
+ `${name} ==\n${INDENT}LET ${module} == INSTANCE ${module}\n${INDENT}IN ${module}!${definition}\n----\n`;
67
+
68
+ const getExpressionStub = (specName: string, variables: string[]) => {
69
+ const variable = variables[0];
70
+ const examples =
71
+ variable === undefined
72
+ ? ""
73
+ : `\\* ,_${variable}Unchanged |-> ${variable} = ${variable}'
74
+
75
+ \\* Format the \`${variable}\` variable as Json value.
76
+ \\* ,_${variable}Json |->
77
+ \\* LET J == INSTANCE Json
78
+ \\* IN J!ToJson(${variable})
79
+
80
+ \\* Lastly, you may build expressions over arbitrary sets of states by
81
+ \\* leveraging the _TETrace operator. For example, this is how to
82
+ \\* count the number of times a spec variable changed up to the current
83
+ \\* state in the trace.
84
+ \\* ,_${variable}ModCount |->
85
+ \\* LET F[s \\in DOMAIN _TETrace] ==
86
+ \\* IF s = 1 THEN 0
87
+ \\* ELSE IF _TETrace[s].${variable} # _TETrace[s-1].${variable}
88
+ \\* THEN 1 + F[s-1] ELSE F[s-1]
89
+ \\* IN F[_TEPosition - 1]
90
+ `;
91
+ const body = `\\* To hide variables of the \`${specName}\` spec from the error trace,
92
+ \\* remove the variables below. The trace will be written in the order
93
+ \\* of the fields of this record.
94
+ ${variables.map((name) => `${name} |-> ${name}`).join("\n,")}
95
+
96
+ \\* Put additional constant-, state-, and action-level expressions here:
97
+ \\* ,_stateNumber |-> _TEPosition
98
+ ${examples}`;
99
+ return `expression == \n${INDENT}[\n${indent(body, 2)}\n${INDENT}]\n\n`;
100
+ };
101
+
102
+ export const writeTraceSpec = (input: TraceSpecInput) => {
103
+ const loopStart = input.loopStart;
104
+ const states = input.states.map((state) =>
105
+ getHashOrder(Object.keys(state)).map((name): [string, string] => [
106
+ name,
107
+ formatValue(state[name]),
108
+ ]),
109
+ );
110
+ if (states.length + (loopStart === undefined ? 0 : 1) <= 1) return undefined;
111
+ const variables = Object.keys(input.states[0]);
112
+ const specName = input.specName;
113
+ const final = states[states.length - 1];
114
+ const isStuttering = loopStart === states.length - 1;
115
+ const isLasso = loopStart !== undefined && !isStuttering;
116
+
117
+ const declaredNames = new Set(input.rawConstants.map((line) => line.split(" = ")[0]));
118
+ const constantLines = [
119
+ ...input.rawConstants.map((line) => indent(line, 1)),
120
+ ...input.modelValues
121
+ .filter((name) => !declaredNames.has(name))
122
+ .map((name) => indent(`${name} = ${name}`, 1)),
123
+ ...(isLasso ? [`${LASSO_START} = ${loopStart + 1}`, `${LASSO_END} = ${states.length}`] : []),
124
+ ];
125
+ const teConstants = [
126
+ ...input.modelValues.filter((name) => !input.isDefined(name)),
127
+ ...(isLasso ? [LASSO_START, LASSO_END] : []),
128
+ ];
129
+ const teConstantsModule = `${specName}_TEConstants`;
130
+ const constantModules = getHashOrder([
131
+ "TLC",
132
+ ...(teConstants.length > 0 ? [teConstantsModule] : []),
133
+ ]);
134
+ const extendedModules = getHashOrder([
135
+ "Toolbox",
136
+ "TLCExt",
137
+ "Naturals",
138
+ "Sequences",
139
+ ...constantModules,
140
+ specName,
141
+ ]);
142
+ const expressionModule = `${specName}_TEExpression`;
143
+ const traceModule = `${specName}_TETrace`;
144
+
145
+ const property = isStuttering
146
+ ? {
147
+ config: "\nPROPERTY\n _prop\n",
148
+ definition: `\n_prop ==\n${INDENT}~<>[](\n${getConjunction(final)}\n${INDENT})`,
149
+ }
150
+ : isLasso
151
+ ? {
152
+ config: "\nPROPERTY\n _prop\n",
153
+ definition: `\n_prop ==\n${indent(
154
+ `~(([]<>(\n${getConjunction(final)}\n))/\\([]<>(\n${getConjunction(states[loopStart])}\n)))`,
155
+ 1,
156
+ )}`,
157
+ }
158
+ : {
159
+ config: "\nINVARIANT\n _inv\n",
160
+ definition: `\n_inv ==\n${INDENT}~(\n${getConjunction(final, 'TLCGet("level") = Len(_TETrace)')}\n${INDENT})`,
161
+ };
162
+ const lassoStep = isLasso
163
+ ? `${INDENT}${INDENT} \\/ /\\ i = ${LASSO_END}\n${INDENT}${INDENT} /\\ j = ${LASSO_START}\n`
164
+ : "";
165
+ const next = `_next ==
166
+ /\\ \\E i,j \\in DOMAIN _TETrace:
167
+ /\\ \\/ /\\ j = i + 1
168
+ /\\ i = TLCGet("level")
169
+ ${lassoStep}${variables
170
+ .map(
171
+ (name) =>
172
+ ` /\\ ${name} = _TETrace[i].${name}\n /\\ ${name}' = _TETrace[j].${name}\n`,
173
+ )
174
+ .join("")}
175
+ \\* Uncomment the ASSUME below to write the states of the error trace
176
+ \\* to the given file in Json format. Note that you can pass any tuple
177
+ \\* to \`JsonSerialize\`. For example, a sub-sequence of _TETrace.
178
+ \\* ASSUME
179
+ \\* LET J == INSTANCE Json
180
+ \\* IN J!JsonSerialize("${input.module}.json", _TETrace)
181
+
182
+ `;
183
+ const isViewed =
184
+ isLasso && new Set(states.map((state) => JSON.stringify(state))).size < states.length;
185
+ const view = isViewed
186
+ ? {
187
+ config: "\nVIEW\n _view\n",
188
+ definition: `\n_view ==\n${INDENT}<<${variables.join(", ")}, IF TLCGet("level") = ${LASSO_END} + 1 THEN ${LASSO_START} ELSE TLCGet("level")>>\n`,
189
+ }
190
+ : { config: "", definition: "" };
191
+ const deserializedTrace = `\n${getPrimer(traceModule, getHashOrder(["IOUtils", ...constantModules, specName]))}trace == IODeserialize("${input.module}.bin", TRUE)\n\n${CLOSING_TAG}`;
192
+ const traceFunction = `${INDENT}<<\n${states
193
+ .map(
194
+ (state) => `${INDENT}([${state.map(([name, value]) => `${name} |-> ${value}`).join(",")}])`,
195
+ )
196
+ .join(",\n")}\n${INDENT}>>${SEPARATOR}\n`;
197
+
198
+ const tla = [
199
+ getPrimer(input.module, extendedModules),
200
+ `${getInstance("_expression", expressionModule, "expression")}\n`,
201
+ getInstance("_trace", traceModule, "trace"),
202
+ property.definition,
203
+ `${SEPARATOR}\n`,
204
+ "_init ==\n",
205
+ variables.map((name) => `${INDENT}/\\ ${name} = _TETrace[1].${name}\n`).join(""),
206
+ "----\n\n",
207
+ next,
208
+ view.definition,
209
+ CLOSING_TAG,
210
+ "\n",
211
+ ` Note that you can extract this module \`${expressionModule}\`\n`,
212
+ " to a dedicated file to reuse `expression` (the module in the \n",
213
+ ` dedicated \`${expressionModule}.tla\` file takes precedence \n`,
214
+ ` over the module \`${expressionModule}\` below).`,
215
+ `\n\n${getPrimer(expressionModule, extendedModules)}${getExpressionStub(specName, variables)}${CLOSING_TAG}\n\n`,
216
+ "\n",
217
+ "Parsing and semantic processing can take forever if the trace below is long.\n",
218
+ " In this case, it is advised to uncomment the module below to deserialize the\n",
219
+ " trace from a generated binary file.\n",
220
+ `\n\\*${deserializedTrace.replaceAll("\n", "\n\\*")}\n\n`,
221
+ getPrimer(traceModule, getHashOrder([...constantModules, specName])),
222
+ `trace == \n${traceFunction}\n`,
223
+ ...(teConstants.length > 0
224
+ ? [
225
+ CLOSING_TAG,
226
+ "\n",
227
+ getPrimer(teConstantsModule, [specName]),
228
+ `CONSTANTS ${teConstants.join(", ")}\n\n`,
229
+ ]
230
+ : []),
231
+ CLOSING_TAG,
232
+ ].join("");
233
+ const config = [
234
+ `\n---- CONFIG ${input.module} ----\n`,
235
+ constantLines.length > 0
236
+ ? `CONSTANTS\n${constantLines.map((line) => `${line}\n`).join("")}`
237
+ : "",
238
+ property.config,
239
+ "\nCHECK_DEADLOCK\n \\* CHECK_DEADLOCK off because of PROPERTY or INVARIANT above.\n FALSE",
240
+ "\n\nINIT\n _init\n",
241
+ "\nNEXT\n _next\n",
242
+ view.config,
243
+ "\nCONSTANT\n _TETrace <- _trace\n",
244
+ "\nALIAS\n _expression\n",
245
+ CLOSING_TAG,
246
+ `\\* Generated on ${formatJavaDate(new Date())}`,
247
+ ].join("");
248
+ return tla + config;
249
+ };