tla-ts 0.0.9 → 0.0.10

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 (390) 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 +28 -28
  5. package/dist/deciders.js +43 -43
  6. package/dist/index.cjs +1 -1
  7. package/dist/index.d.cts +72 -10
  8. package/dist/index.d.ts +72 -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 +116 -36
  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 +128 -103
  21. package/dist/transfer.js +128 -103
  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 +7 -21
  26. package/src/bags.ts +99 -99
  27. package/src/builtins.ts +44 -75
  28. package/src/bundled-modules.ts +1 -8
  29. package/src/check.ts +576 -300
  30. package/src/cli/options.ts +11 -6
  31. package/src/cli/run.ts +2 -2
  32. package/src/cli/runtime-invariants.ts +135 -0
  33. package/src/cli/shared.ts +20 -9
  34. package/src/cli/tlapm.ts +0 -12
  35. package/src/cli/tlc-arguments.ts +646 -0
  36. package/src/cli/tlc-usage.ts +362 -0
  37. package/src/cli/tlc.ts +538 -220
  38. package/src/cli/typescript.ts +23 -0
  39. package/src/cli/xml-exporter.ts +4 -16
  40. package/src/cli.ts +0 -1
  41. package/src/codegen.ts +191 -64
  42. package/src/config.ts +140 -109
  43. package/src/coverage.ts +837 -0
  44. package/src/dependencies.ts +6 -40
  45. package/src/dfid.ts +618 -0
  46. package/src/environment.ts +240 -118
  47. package/src/errors.ts +70 -55
  48. package/src/evaluate.ts +630 -297
  49. package/src/exit-codes.ts +37 -3
  50. package/src/fingerprints.ts +10 -10
  51. package/src/index.ts +3 -0
  52. package/src/instances.ts +79 -11
  53. package/src/java-overrides.ts +2 -12
  54. package/src/json-reader.ts +456 -0
  55. package/src/json.ts +262 -139
  56. package/src/levels.ts +2 -3
  57. package/src/lexer.ts +17 -26
  58. package/src/liveness-checker.ts +10 -18
  59. package/src/liveness.ts +121 -49
  60. package/src/obligations/action.ts +4 -28
  61. package/src/obligations/anonymize.ts +84 -80
  62. package/src/obligations/equality.ts +1 -1
  63. package/src/obligations/expression.ts +2 -19
  64. package/src/obligations/format.ts +1 -9
  65. package/src/obligations/generate.ts +1 -11
  66. package/src/obligations/index.ts +0 -11
  67. package/src/obligations/levels.ts +4 -8
  68. package/src/obligations/module.ts +1 -15
  69. package/src/obligations/normalize.ts +5 -24
  70. package/src/obligations/operators.ts +1 -2
  71. package/src/obligations/pragma.ts +1 -10
  72. package/src/obligations/printer.ts +47 -46
  73. package/src/obligations/proof.ts +1 -5
  74. package/src/obligations/regroup.ts +1 -4
  75. package/src/obligations/simplify.ts +3 -14
  76. package/src/obligations/source.ts +1 -21
  77. package/src/obligations/subexpression.ts +5 -11
  78. package/src/obligations/substitution.ts +1 -3
  79. package/src/obligations/temporal.ts +8 -14
  80. package/src/obligations/tuples.ts +3 -9
  81. package/src/parallel-worker.ts +29 -39
  82. package/src/parallel.ts +29 -13
  83. package/src/parser.ts +436 -90
  84. package/src/pcal/ast.ts +7 -28
  85. package/src/pcal/parse.ts +11 -39
  86. package/src/pcal/tokenize.ts +4 -20
  87. package/src/pcal/translate.ts +10 -42
  88. package/src/pcal/validate.ts +3 -21
  89. package/src/pretty-print.ts +1 -2
  90. package/src/prover/decide-pool.ts +5 -10
  91. package/src/prover/deciders.ts +0 -4
  92. package/src/prover/first-order.ts +0 -11
  93. package/src/prover/isabelle/decide.ts +0 -6
  94. package/src/prover/isabelle/encode.ts +11 -23
  95. package/src/prover/isabelle/isar/inner-syntax.ts +108 -114
  96. package/src/prover/isabelle/isar/method.ts +25 -38
  97. package/src/prover/isabelle/isar/proof.ts +1 -10
  98. package/src/prover/isabelle/isar/statement.ts +1 -6
  99. package/src/prover/isabelle/isar/theory.ts +15 -26
  100. package/src/prover/isabelle/isar/type-check.ts +11 -25
  101. package/src/prover/isabelle/provers/blast/blast.ts +10 -41
  102. package/src/prover/isabelle/provers/blast/branch.ts +1 -32
  103. package/src/prover/isabelle/provers/blast/prove.ts +1 -35
  104. package/src/prover/isabelle/provers/blast/rules.ts +6 -44
  105. package/src/prover/isabelle/provers/blast/state.ts +2 -28
  106. package/src/prover/isabelle/provers/blast/term.ts +9 -36
  107. package/src/prover/isabelle/provers/clasimp.ts +1 -13
  108. package/src/prover/isabelle/provers/classical.ts +14 -42
  109. package/src/prover/isabelle/provers/hypsubst.ts +11 -25
  110. package/src/prover/isabelle/pure/bicompose.ts +16 -13
  111. package/src/prover/isabelle/pure/consts.ts +1 -7
  112. package/src/prover/isabelle/pure/conv.ts +1 -9
  113. package/src/prover/isabelle/pure/drule.ts +24 -40
  114. package/src/prover/isabelle/pure/envir.ts +3 -52
  115. package/src/prover/isabelle/pure/goal.ts +1 -7
  116. package/src/prover/isabelle/pure/interrupt.ts +0 -5
  117. package/src/prover/isabelle/pure/list.ts +0 -3
  118. package/src/prover/isabelle/pure/logic.ts +1 -14
  119. package/src/prover/isabelle/pure/name.ts +2 -9
  120. package/src/prover/isabelle/pure/net.ts +3 -59
  121. package/src/prover/isabelle/pure/object-logic.ts +3 -10
  122. package/src/prover/isabelle/pure/pattern.ts +2 -19
  123. package/src/prover/isabelle/pure/raw-simplifier.ts +13 -49
  124. package/src/prover/isabelle/pure/rewriter.ts +26 -58
  125. package/src/prover/isabelle/pure/search.ts +3 -10
  126. package/src/prover/isabelle/pure/seq.ts +1 -10
  127. package/src/prover/isabelle/pure/simplifier.ts +4 -12
  128. package/src/prover/isabelle/pure/table.ts +1 -31
  129. package/src/prover/isabelle/pure/tactic.ts +12 -22
  130. package/src/prover/isabelle/pure/tactical.ts +6 -12
  131. package/src/prover/isabelle/pure/term-ord.ts +2 -6
  132. package/src/prover/isabelle/pure/term.ts +2 -43
  133. package/src/prover/isabelle/pure/thm.ts +13 -36
  134. package/src/prover/isabelle/pure/type.ts +2 -15
  135. package/src/prover/isabelle/pure/unify.ts +20 -30
  136. package/src/prover/isabelle/pure/variable.ts +3 -7
  137. package/src/prover/isabelle/tla/classical-setup.ts +9 -19
  138. package/src/prover/isabelle/tla/context.ts +8 -16
  139. package/src/prover/isabelle/tla/logic.ts +4 -11
  140. package/src/prover/isabelle/tla/simpdata.ts +46 -34
  141. package/src/prover/isabelle/tools/intuitionistic.ts +1 -10
  142. package/src/prover/ocaml.ts +0 -6
  143. package/src/prover/prep/action.ts +4 -36
  144. package/src/prover/prep/enabled-axioms.ts +12 -19
  145. package/src/prover/prep/fingerprint.ts +0 -16
  146. package/src/prover/prep/level-comparison.ts +8 -12
  147. package/src/prover/prep/md5.ts +0 -2
  148. package/src/prover/prep/methods.ts +9 -36
  149. package/src/prover/prep/normalize.ts +4 -28
  150. package/src/prover/prove-worker.ts +0 -2
  151. package/src/prover/prove.ts +0 -36
  152. package/src/prover/ptl/decide.ts +7 -12
  153. package/src/prover/ptl/encode.ts +14 -36
  154. package/src/prover/ptl/sat.ts +24 -32
  155. package/src/prover/ptl/tableau.ts +12 -26
  156. package/src/prover/smt/axioms.ts +0 -7
  157. package/src/prover/smt/context.ts +19 -26
  158. package/src/prover/smt/data.ts +51 -54
  159. package/src/prover/smt/encode.ts +14 -35
  160. package/src/prover/smt/extensionality.ts +0 -10
  161. package/src/prover/smt/flatten.ts +3 -22
  162. package/src/prover/smt/format.ts +5 -10
  163. package/src/prover/smt/instances.ts +0 -10
  164. package/src/prover/smt/rewrite.ts +66 -101
  165. package/src/prover/smt/solver/act-cache.ts +0 -15
  166. package/src/prover/smt/solver/arith-rewriter.ts +3 -48
  167. package/src/prover/smt/solver/array.ts +1 -3
  168. package/src/prover/smt/solver/asserted-formulas.ts +1 -43
  169. package/src/prover/smt/solver/ast-lt.ts +1 -11
  170. package/src/prover/smt/solver/ast-util.ts +1 -6
  171. package/src/prover/smt/solver/ast.ts +1 -143
  172. package/src/prover/smt/solver/auf-solver.ts +6 -39
  173. package/src/prover/smt/solver/case-split-queue.ts +1 -9
  174. package/src/prover/smt/solver/cg-table.ts +1 -18
  175. package/src/prover/smt/solver/clause.ts +1 -27
  176. package/src/prover/smt/solver/conflict-resolution.ts +0 -9
  177. package/src/prover/smt/solver/context.ts +4 -61
  178. package/src/prover/smt/solver/ctx-simplify.ts +14 -41
  179. package/src/prover/smt/solver/der.ts +2 -21
  180. package/src/prover/smt/solver/dyn-ack.ts +1 -11
  181. package/src/prover/smt/solver/e-matching.ts +3 -34
  182. package/src/prover/smt/solver/enode.ts +1 -21
  183. package/src/prover/smt/solver/expr-ref.ts +1 -5
  184. package/src/prover/smt/solver/expr-safe-replace.ts +0 -5
  185. package/src/prover/smt/solver/fingerprints.ts +1 -12
  186. package/src/prover/smt/solver/flat-literals.ts +1 -9
  187. package/src/prover/smt/solver/goal.ts +2 -14
  188. package/src/prover/smt/solver/hash.ts +0 -8
  189. package/src/prover/smt/solver/hashtable.ts +1 -12
  190. package/src/prover/smt/solver/internalizer.ts +6 -98
  191. package/src/prover/smt/solver/lbool.ts +1 -2
  192. package/src/prover/smt/solver/literal.ts +0 -3
  193. package/src/prover/smt/solver/lp/bound-propagator.ts +8 -26
  194. package/src/prover/smt/solver/lp/constraints.ts +2 -8
  195. package/src/prover/smt/solver/lp/containers.ts +12 -30
  196. package/src/prover/smt/solver/lp/core-solver.ts +10 -31
  197. package/src/prover/smt/solver/lp/cross-nested.ts +6 -20
  198. package/src/prover/smt/solver/lp/dep-intervals.ts +7 -22
  199. package/src/prover/smt/solver/lp/dependency.ts +1 -4
  200. package/src/prover/smt/solver/lp/dioph-eq.ts +12 -98
  201. package/src/prover/smt/solver/lp/explanation.ts +1 -6
  202. package/src/prover/smt/solver/lp/gomory.ts +9 -22
  203. package/src/prover/smt/solver/lp/hnf-cutter.ts +17 -23
  204. package/src/prover/smt/solver/lp/hnf.ts +11 -26
  205. package/src/prover/smt/solver/lp/int-cube.ts +15 -36
  206. package/src/prover/smt/solver/lp/int-solver.ts +4 -34
  207. package/src/prover/smt/solver/lp/lar-solver.ts +32 -81
  208. package/src/prover/smt/solver/lp/lar-term.ts +1 -5
  209. package/src/prover/smt/solver/lp/lp-settings.ts +1 -14
  210. package/src/prover/smt/solver/lp/maximize-term.ts +20 -45
  211. package/src/prover/smt/solver/lp/nex-creator.ts +5 -28
  212. package/src/prover/smt/solver/lp/nex.ts +1 -6
  213. package/src/prover/smt/solver/lp/nla-backoff.ts +1 -4
  214. package/src/prover/smt/solver/lp/nla-basics.ts +5 -30
  215. package/src/prover/smt/solver/lp/nla-core.ts +35 -130
  216. package/src/prover/smt/solver/lp/nla-divisions.ts +32 -42
  217. package/src/prover/smt/solver/lp/nla-emonics.ts +4 -21
  218. package/src/prover/smt/solver/lp/nla-factorization.ts +1 -4
  219. package/src/prover/smt/solver/lp/nla-grobner.ts +15 -69
  220. package/src/prover/smt/solver/lp/nla-horner.ts +3 -11
  221. package/src/prover/smt/solver/lp/nla-intervals.ts +2 -12
  222. package/src/prover/smt/solver/lp/nla-monomial-bounds.ts +16 -41
  223. package/src/prover/smt/solver/lp/nla-monotone.ts +2 -6
  224. package/src/prover/smt/solver/lp/nla-order.ts +2 -13
  225. package/src/prover/smt/solver/lp/nla-patcher.ts +4 -7
  226. package/src/prover/smt/solver/lp/nla-tangents.ts +1 -9
  227. package/src/prover/smt/solver/lp/nla-throttle.ts +1 -6
  228. package/src/prover/smt/solver/lp/nla-types.ts +1 -11
  229. package/src/prover/smt/solver/lp/nla-var-eqs.ts +4 -25
  230. package/src/prover/smt/solver/lp/nra-solver.ts +5 -52
  231. package/src/prover/smt/solver/lp/numeric-pair.ts +1 -4
  232. package/src/prover/smt/solver/lp/pdd-interval.ts +1 -3
  233. package/src/prover/smt/solver/lp/pdd-simplifier.ts +2 -14
  234. package/src/prover/smt/solver/lp/pdd-solver.ts +4 -33
  235. package/src/prover/smt/solver/lp/pdd.ts +7 -70
  236. package/src/prover/smt/solver/lp/random-updater.ts +1 -8
  237. package/src/prover/smt/solver/lp/static-matrix.ts +9 -19
  238. package/src/prover/smt/solver/lp/union-find.ts +1 -6
  239. package/src/prover/smt/solver/mam-compiler.ts +14 -56
  240. package/src/prover/smt/solver/mam-interpreter.ts +1 -21
  241. package/src/prover/smt/solver/maximize-ac-sharing.ts +2 -17
  242. package/src/prover/smt/solver/model-checker.ts +2 -36
  243. package/src/prover/smt/solver/model-evaluator.ts +3 -29
  244. package/src/prover/smt/solver/model-finder.ts +3 -15
  245. package/src/prover/smt/solver/model-generator.ts +1 -12
  246. package/src/prover/smt/solver/model-macro-solver.ts +12 -69
  247. package/src/prover/smt/solver/nlsat/algebraic.ts +55 -151
  248. package/src/prover/smt/solver/nlsat/atoms.ts +5 -19
  249. package/src/prover/smt/solver/nlsat/evaluator.ts +17 -22
  250. package/src/prover/smt/solver/nlsat/explain.ts +3 -47
  251. package/src/prover/smt/solver/nlsat/interval-set.ts +9 -50
  252. package/src/prover/smt/solver/nlsat/levelwise.ts +48 -129
  253. package/src/prover/smt/solver/nlsat/mpbq.ts +3 -14
  254. package/src/prover/smt/solver/nlsat/polynomial.ts +17 -156
  255. package/src/prover/smt/solver/nlsat/solver.ts +7 -67
  256. package/src/prover/smt/solver/nlsat/types.ts +1 -8
  257. package/src/prover/smt/solver/nlsat/upolynomial-factorization.ts +1 -44
  258. package/src/prover/smt/solver/nlsat/upolynomial.ts +11 -92
  259. package/src/prover/smt/solver/nnf.ts +3 -38
  260. package/src/prover/smt/solver/pattern-inference.ts +2 -15
  261. package/src/prover/smt/solver/poly-rewriter.ts +3 -23
  262. package/src/prover/smt/solver/propagate-values.ts +1 -10
  263. package/src/prover/smt/solver/proto-model.ts +3 -48
  264. package/src/prover/smt/solver/pull-quant.ts +1 -12
  265. package/src/prover/smt/solver/qe-lite-der.ts +1 -29
  266. package/src/prover/smt/solver/qe-lite-fm.ts +2 -25
  267. package/src/prover/smt/solver/qe-lite.ts +3 -33
  268. package/src/prover/smt/solver/qi-queue.ts +1 -16
  269. package/src/prover/smt/solver/quant-tactics.ts +5 -22
  270. package/src/prover/smt/solver/quantifier-analyzer.ts +17 -37
  271. package/src/prover/smt/solver/quantifier-manager.ts +1 -8
  272. package/src/prover/smt/solver/random-gen.ts +1 -2
  273. package/src/prover/smt/solver/rational.ts +1 -8
  274. package/src/prover/smt/solver/ref-vector.ts +1 -6
  275. package/src/prover/smt/solver/relevancy.ts +2 -15
  276. package/src/prover/smt/solver/rewriter-tpl.ts +3 -147
  277. package/src/prover/smt/solver/rewriter.ts +3 -85
  278. package/src/prover/smt/solver/rlimit.ts +2 -20
  279. package/src/prover/smt/solver/smtlib-parser.ts +2 -37
  280. package/src/prover/smt/solver/solver.ts +23 -34
  281. package/src/prover/smt/solver/sort.ts +1 -5
  282. package/src/prover/smt/solver/sticky-generations.ts +0 -5
  283. package/src/prover/smt/solver/theory-lra-axioms.ts +3 -24
  284. package/src/prover/smt/solver/theory-lra-bounds.ts +0 -5
  285. package/src/prover/smt/solver/theory-lra-final-check.ts +4 -22
  286. package/src/prover/smt/solver/theory-lra-internalize.ts +1 -27
  287. package/src/prover/smt/solver/theory-lra-model.ts +4 -19
  288. package/src/prover/smt/solver/theory-lra-propagate.ts +1 -15
  289. package/src/prover/smt/solver/theory-lra-state.ts +3 -8
  290. package/src/prover/smt/solver/theory-lra.ts +1 -8
  291. package/src/prover/smt/solver/var-subst.ts +2 -26
  292. package/src/prover/smt/table.ts +0 -8
  293. package/src/prover/tlapm/cache.ts +20 -25
  294. package/src/prover/tlapm/ocaml-marshal.ts +19 -21
  295. package/src/prover/tlapm/tlapm.ts +12 -17
  296. package/src/prover/verdict.ts +0 -2
  297. package/src/prover/zenon/check/check.ts +0 -9
  298. package/src/prover/zenon/check/definitions.ts +5 -15
  299. package/src/prover/zenon/check/equality.ts +0 -8
  300. package/src/prover/zenon/check/functions.ts +0 -4
  301. package/src/prover/zenon/check/keys.ts +0 -7
  302. package/src/prover/zenon/check/propositional.ts +0 -3
  303. package/src/prover/zenon/check/records.ts +0 -5
  304. package/src/prover/zenon/check/relations.ts +0 -13
  305. package/src/prover/zenon/check/rewrites.ts +0 -6
  306. package/src/prover/zenon/check/sets.ts +0 -3
  307. package/src/prover/zenon/check/terms.ts +0 -17
  308. package/src/prover/zenon/check/tla.ts +0 -6
  309. package/src/prover/zenon/decide.ts +0 -12
  310. package/src/prover/zenon/encode.ts +1 -8
  311. package/src/prover/zenon/eqrel.ts +0 -13
  312. package/src/prover/zenon/equality-rules.ts +0 -4
  313. package/src/prover/zenon/expr.ts +1 -26
  314. package/src/prover/zenon/index-table.ts +17 -38
  315. package/src/prover/zenon/isar-case.ts +9 -19
  316. package/src/prover/zenon/isar.ts +1 -29
  317. package/src/prover/zenon/limits.ts +0 -4
  318. package/src/prover/zenon/llproof.ts +0 -9
  319. package/src/prover/zenon/mltoll.ts +54 -76
  320. package/src/prover/zenon/node.ts +1 -11
  321. package/src/prover/zenon/ocaml.ts +1 -17
  322. package/src/prover/zenon/parse.ts +2 -7
  323. package/src/prover/zenon/phrase.ts +1 -11
  324. package/src/prover/zenon/proof.ts +0 -9
  325. package/src/prover/zenon/propositional-rules.ts +0 -5
  326. package/src/prover/zenon/rules.ts +2 -6
  327. package/src/prover/zenon/search.ts +1 -17
  328. package/src/prover/zenon/tla/functions.ts +57 -29
  329. package/src/prover/zenon/tla/llproof.ts +63 -70
  330. package/src/prover/zenon/tla/records.ts +56 -27
  331. package/src/prover/zenon/tla/rewrites.ts +12 -19
  332. package/src/prover/zenon/tla/sets.ts +68 -39
  333. package/src/prover/zenon/tla/terms.ts +0 -6
  334. package/src/prover/zenon/tla/tla.ts +59 -58
  335. package/src/randomization.ts +84 -35
  336. package/src/resolve.ts +18 -60
  337. package/src/runtime.ts +11 -4
  338. package/src/sany/builtins.ts +3 -4
  339. package/src/sany/generator.ts +119 -169
  340. package/src/sany/levels.ts +6 -30
  341. package/src/sany/lexer.ts +7 -23
  342. package/src/sany/linter.ts +1 -8
  343. package/src/sany/modules.ts +1 -5
  344. package/src/sany/nodes.ts +0 -31
  345. package/src/sany/parse-error.ts +39 -117
  346. package/src/sany/report.ts +29 -63
  347. package/src/sany/selectors.ts +15 -39
  348. package/src/sany/source.ts +1 -17
  349. package/src/sany/xml.ts +13 -63
  350. package/src/search.ts +494 -154
  351. package/src/simulate.ts +694 -0
  352. package/src/spec-description.ts +166 -48
  353. package/src/standard-definitions.ts +2 -3
  354. package/src/standard-modules.ts +264 -68
  355. package/src/state-graph.ts +51 -18
  356. package/src/subexpressions.ts +31 -5
  357. package/src/substitution-levels.ts +2 -3
  358. package/src/successors.ts +267 -77
  359. package/src/symmetry.ts +31 -8
  360. package/src/tableau.ts +27 -24
  361. package/src/tlc/fingerprint.ts +183 -61
  362. package/src/tlc/jar-data.ts +113 -6
  363. package/src/tlc/messages.ts +122 -37
  364. package/src/tlc/order.ts +33 -38
  365. package/src/tlc/random.ts +16 -16
  366. package/src/tlc/replay.ts +563 -211
  367. package/src/tlc/summary.ts +2 -4
  368. package/src/tlc/tlc-operators.ts +81 -36
  369. package/src/tlc/tlcext-operators.ts +138 -117
  370. package/src/tlc/trace-spec.ts +273 -0
  371. package/src/tlc/value-stream.ts +143 -0
  372. package/src/tlc/version.ts +2 -4
  373. package/src/transfer.ts +22 -25
  374. package/src/typescript/actions.ts +481 -0
  375. package/src/typescript/collections.ts +600 -0
  376. package/src/typescript/compile.ts +65 -0
  377. package/src/typescript/context.ts +94 -0
  378. package/src/typescript/emit.ts +121 -0
  379. package/src/typescript/expressions.ts +496 -0
  380. package/src/typescript/formula.ts +152 -0
  381. package/src/typescript/functions.ts +284 -0
  382. package/src/typescript/model.ts +163 -0
  383. package/src/typescript/names.ts +114 -0
  384. package/src/typescript/program.ts +48 -0
  385. package/src/typescript/properties.ts +139 -0
  386. package/src/typescript/scope.ts +112 -0
  387. package/src/typescript/steps.ts +165 -0
  388. package/src/typescript/types.ts +171 -0
  389. package/src/values.ts +826 -276
  390. package/src/worker.ts +7 -8
@@ -18,29 +18,20 @@ import type { TlcVersion } from "../tlc/version";
18
18
  interface SanyReport {
19
19
  text: string;
20
20
  isFailed: boolean;
21
- // The specification SANY analyzes, which has errors when SANY rejects it.
22
21
  specification?: SanySpecification;
23
22
  }
24
23
 
25
- // Where SANY reads a module from: a file of its own, the file of the root module, which holds the
26
- // root module's inner modules too, or the files of its standard modules.
27
24
  export type SanyModuleOrigin = "file" | "root file" | "standard";
28
25
 
29
26
  export interface SanyReportOptions {
30
- // The file name SANY's caller gives it, which it prints in its messages about the specification.
31
27
  fileName?: string;
32
- // TLC runs SANY to print the file it parses each module from, as describeFile names it, and each
33
- // module it analyzes and lints.
34
28
  describeFile?: (moduleName: string, origin: SanyModuleOrigin) => string;
35
- // tla2sany.xml.XMLExporter runs SANY with its validAstSettings, which neither lint the modules
36
- // nor validate their PlusCal, and prints only SANY's errors.
37
29
  isXmlExport?: boolean;
38
30
  version?: TlcVersion;
39
- // The modules TLC adds to the root module's EXTENDS for its post conditions.
40
31
  rootExtendees?: string[];
41
- // Prints what SANY prints as it goes, before the report holds all of it.
32
+ suppressedCodes?: number[];
33
+ errorCodes?: number[];
42
34
  onPrint?: (text: string) => void;
43
- // Prints what TLC 1.7.4's SANY prints to its error stream as it goes.
44
35
  onPrintError?: (text: string) => void;
45
36
  }
46
37
 
@@ -54,11 +45,9 @@ interface Validation {
54
45
  isError: boolean;
55
46
  }
56
47
 
57
- // ErrorDetails.toString.
58
48
  const formatMessage = (message: SanyMessage) =>
59
49
  `${formatSanyLocation(message.location)}\n\n${message.text}`;
60
50
 
61
- // Errors.toString: the errors and then the warnings of a phase of SANY.
62
51
  const formatErrors = (messages: SanyMessage[]) => {
63
52
  const errors = messages.filter((message) => !message.isWarning);
64
53
  const warnings = messages.filter((message) => message.isWarning);
@@ -70,7 +59,8 @@ const formatErrors = (messages: SanyMessage[]) => {
70
59
  ].join("");
71
60
  };
72
61
 
73
- // tla2sany.semantic.StandardModules: SANY lints the modules other than these.
62
+ const RECORD_FIELD_CLASH = 4802;
63
+
74
64
  const UNLINTED_MODULES = new Set([
75
65
  "FiniteSets",
76
66
  "Sequences",
@@ -83,7 +73,6 @@ const UNLINTED_MODULES = new Set([
83
73
  "TLC",
84
74
  ]);
85
75
 
86
- // The modules a module and its inner modules extend, other than its inner modules.
87
76
  const getExtendees = (module: Module) => {
88
77
  const innerNames = new Set<string>();
89
78
  const extendees: string[] = [];
@@ -107,15 +96,11 @@ const parseValidatedModule = (text: string) => {
107
96
  }
108
97
  };
109
98
 
110
- // ParseUnit.parseFile: SANY names the specification by the root module once it parses it.
111
99
  export const getSanyModuleName = (text: string, version?: TlcVersion) =>
112
100
  version === "1.7.4" && getSany174LexicalError(text) !== undefined
113
101
  ? undefined
114
102
  : parseValidatedModule(text)?.name;
115
103
 
116
- // What SANY prints while TLC runs it on the specification in rootPath, and whether SANY rejects the
117
- // specification. loadModule finds the source of the other modules, and SANY's standard modules fill
118
- // in the rest.
119
104
  export const getSanyReport = (
120
105
  rootPath: string,
121
106
  loadModule: (name: string) => string | undefined,
@@ -124,7 +109,6 @@ export const getSanyReport = (
124
109
  const rootName = basename(rootPath, ".tla");
125
110
  const standardModules = getSanyStandardModules(options.version);
126
111
  const name = options.fileName ?? rootName;
127
- // SANY looks for the root module where it looks for the others, its standard modules among them.
128
112
  const source = existsSync(rootPath)
129
113
  ? readFileSync(rootPath, "utf8")
130
114
  : standardModules.get(rootName);
@@ -135,7 +119,6 @@ export const getSanyReport = (
135
119
  };
136
120
  const log = (text: string) => write(`${text}\n`);
137
121
  const isTlc174 = options.version === "1.7.4";
138
- // TLC 1.7.4's XMLExporter discards what SANY prints to ToolIO.out rather than its error stream.
139
122
  const isToolOutputDiscarded = isTlc174 && options.isXmlExport;
140
123
  const warn = (text: string) => {
141
124
  if (!options.isXmlExport) log(text);
@@ -144,15 +127,12 @@ export const getSanyReport = (
144
127
  const origins = new Map<string, SanyModuleOrigin>([
145
128
  [rootName, existsSync(rootPath) ? "file" : "standard"],
146
129
  ]);
147
- const isFailed = { value: false };
148
- // The messages of SANY's parsing phase, which come from its validation of PlusCal, and whether
149
- // SANY has printed them and whether one is an error that ends its run before semantic analysis.
130
+ let isFailed = false;
150
131
  const parseMessages: SanyMessage[] = [];
151
- const parsePhase = { isReported: false, isAborted: false };
132
+ let isParseReported = false;
133
+ let isParseAborted = false;
152
134
  const session = createPcalSession(createPcalParams(), log);
153
135
  const loadedModules = new Map<string, LoadedModule>();
154
- // TLC 1.7.4's SpecObj.validateParseUnit prints what it finds, which follows the file SANY parses
155
- // next, as SANY validates a module once it parses the module or one that extends it.
156
136
  const validations: Validation[] = [];
157
137
  const printValidations = () =>
158
138
  validations
@@ -160,7 +140,6 @@ export const getSanyReport = (
160
140
  .forEach((validation) =>
161
141
  validation.isError ? options.onPrintError?.(`${validation.text}\n`) : log(validation.text),
162
142
  );
163
- // SpecObj.validateParseUnit: Errors.addMessage drops a message it already has.
164
143
  const validate = (moduleName: string) => {
165
144
  const loaded = loadedModules.get(moduleName);
166
145
  const range = loaded?.module.location.range;
@@ -173,7 +152,6 @@ export const getSanyReport = (
173
152
  );
174
153
  const isTlaChanged = results.has("TLA_DIVERGENCE_EXISTS");
175
154
  const isPcalChanged = results.has("PCAL_DIVERGENCE_EXISTS");
176
- // Both versions word a change to just one of the algorithm and its translation alike.
177
155
  const oneChange =
178
156
  isTlaChanged === isPcalChanged
179
157
  ? undefined
@@ -205,9 +183,6 @@ export const getSanyReport = (
205
183
  if (parseMessages.some((message) => message.text === text)) return;
206
184
  parseMessages.push({ location: moduleName, text, isWarning });
207
185
  };
208
- // SpecObj.loadSpec validates the root module once it parses, and a module each time SANY
209
- // resolves another module's EXTENDS of it, which the report does when the generator loads it,
210
- // and for a module loaded earlier, when the generator loads a module that extends it.
211
186
  const loadValidatedModule = (moduleName: string, text: string) => {
212
187
  if (options.isXmlExport || loadedModules.has(moduleName)) return;
213
188
  const module = parseValidatedModule(text);
@@ -221,12 +196,10 @@ export const getSanyReport = (
221
196
  .filter((extendee) => extendee !== moduleName && loadedModules.has(extendee))
222
197
  .forEach(validate);
223
198
  };
224
- // SANY.frontEndParse: once SANY has loaded the specification, it prints the warnings of its
225
- // parsing phase, and when there are errors, every message, and stops.
226
199
  const reportParseMessages = () => {
227
200
  printValidations();
228
- if (parsePhase.isReported) return;
229
- parsePhase.isReported = true;
201
+ if (isParseReported) return;
202
+ isParseReported = true;
230
203
  const warnings = parseMessages.filter((message) => message.isWarning);
231
204
  if (warnings.length > 0) {
232
205
  warn(`Warnings (${warnings.length}) during syntax parsing of ${name}:\n\n`);
@@ -234,13 +207,12 @@ export const getSanyReport = (
234
207
  }
235
208
  if (warnings.length === parseMessages.length) return;
236
209
  log(formatErrors(parseMessages));
237
- isFailed.value = true;
238
- parsePhase.isAborted = true;
210
+ isFailed = true;
211
+ isParseAborted = true;
239
212
  };
240
213
  const loadSource = (moduleName: string) => {
241
214
  const standard = standardModules.get(moduleName);
242
215
  const file = loadModule(moduleName);
243
- // TLC 1.7.4's SANY reads a module only from a file of its own.
244
216
  const extracted =
245
217
  file === undefined && standard === undefined && source !== undefined && !isTlc174
246
218
  ? extractModule(source, moduleName)
@@ -250,13 +222,12 @@ export const getSanyReport = (
250
222
  moduleName,
251
223
  file !== undefined ? "file" : extracted !== undefined ? "root file" : "standard",
252
224
  );
253
- // The standard modules have no PlusCal, and SANY validates an extracted module's own text.
254
225
  if (text !== undefined) loadValidatedModule(moduleName, text);
255
226
  return text ?? standard;
256
227
  };
257
228
  const generate = () => {
258
- // HACK: SANY reports a fatal error of its parsing phase by the exception it throws, so the
259
- // report catches the TlaSyntaxError the generator throws for one.
229
+ // HACK: SANY reports a fatal parsing error by the exception it throws, so the report catches the
230
+ // TlaSyntaxError the generator throws for one.
260
231
  try {
261
232
  if (source === undefined) {
262
233
  throw new TlaSanyFatalError(`Cannot find source file for module ${name}`, undefined);
@@ -264,7 +235,6 @@ export const getSanyReport = (
264
235
  loadValidatedModule(rootName, source);
265
236
  return generateSanySpecification(source, loadSource, {
266
237
  rootFileName: rootName,
267
- // XMLExporter gives SANY the file it is asked for, and TLC the name of the module.
268
238
  rootFilePath: options.isXmlExport ? `${name.replace(/\.tla$/, "")}.tla` : undefined,
269
239
  version: options.version,
270
240
  rootExtendees: options.rootExtendees,
@@ -277,20 +247,16 @@ export const getSanyReport = (
277
247
  },
278
248
  onAnalyze: (moduleName) => {
279
249
  reportParseMessages();
280
- // TLC 1.7.4's XMLExporter prints what SANY prints as it analyzes the modules.
281
- if ((describeFile || isToolOutputDiscarded) && !parsePhase.isAborted) {
250
+ if ((describeFile || isToolOutputDiscarded) && !isParseAborted) {
282
251
  log(`Semantic processing of module ${moduleName}`);
283
252
  }
284
253
  },
285
- // SANY.frontEndSemanticAnalysis: after each module, SANY level-checks it if there are no
286
- // errors yet, then prints every message so far.
287
254
  onModule: (module, messages) => {
288
- if (parsePhase.isAborted) return;
255
+ if (isParseAborted) return;
289
256
  if (messages.every((message) => message.isWarning))
290
257
  checkModuleLevels(module, { messages, isTlc174 });
291
258
  if (messages.length === 0) return;
292
- if (messages.some((message) => !message.isWarning)) isFailed.value = true;
293
- // TLC 1.7.4's SANY prints the errors and warnings together.
259
+ if (messages.some((message) => !message.isWarning)) isFailed = true;
294
260
  if (isTlc174) return log(`Semantic errors:\n\n${formatErrors(messages)}`);
295
261
  const warnings = messages.filter((message) => message.isWarning);
296
262
  if (warnings.length > 0) {
@@ -304,9 +270,7 @@ export const getSanyReport = (
304
270
  },
305
271
  });
306
272
  } catch (error) {
307
- isFailed.value = true;
308
- // SANY.frontEndParse turns a Java exception of its validation of PlusCal into a fatal
309
- // error, printing the exception and its messages so far.
273
+ isFailed = true;
310
274
  if (error instanceof PcalRuntimeError) {
311
275
  log(`\nFatal errors while parsing TLA+ spec in file ${name}\n`);
312
276
  log(error.message);
@@ -315,8 +279,6 @@ export const getSanyReport = (
315
279
  }
316
280
  if (!(error instanceof TlaSanyFatalError)) throw error;
317
281
  const fatal = { location: error.location, text: error.message, isWarning: false };
318
- // TLC 1.7.4's ParseException.getShortMessage fails on an error at the first token, which has
319
- // no image.
320
282
  const isImageless = isTlc174 && error.parseError?.includes(' and token "" ');
321
283
  if (error.parseError !== undefined && !isImageless && !isToolOutputDiscarded) {
322
284
  log(error.parseError);
@@ -328,28 +290,32 @@ export const getSanyReport = (
328
290
  );
329
291
  return;
330
292
  }
331
- // TLC 1.7.4's SANY aborts with an AbortException, and keeps the message as an abort.
332
293
  if (isTlc174) {
333
294
  log("tla2sany.semantic.AbortException");
334
295
  write(`*** Abort messages: 1\n\n${formatMessage(fatal)}\n\n\n`);
335
296
  return;
336
297
  }
337
298
  log(formatMessage(fatal));
338
- log(formatErrors(parsePhase.isReported ? [fatal] : [...parseMessages, fatal]));
299
+ log(formatErrors(isParseReported ? [fatal] : [...parseMessages, fatal]));
339
300
  }
340
301
  };
341
302
  const specification = generate();
342
303
  if (specification !== undefined) reportParseMessages();
343
- // SANY.frontEndLinting: when SANY accepts the specification, it lints the modules that are not
344
- // its standard modules, then prints the warnings. TLC 1.7.4's SANY has no linter.
345
- if (specification !== undefined && !isFailed.value && !options.isXmlExport && !isTlc174) {
304
+ if (specification !== undefined && !isFailed && !options.isXmlExport && !isTlc174) {
346
305
  const linted = specification.modules.filter((module) => !UNLINTED_MODULES.has(module.name));
347
306
  if (describeFile) linted.forEach((module) => log(`Linting of module ${module.name}`));
348
- linted.flatMap(lintSanyModule).forEach((warning) => log(`${formatMessage(warning)}\n\n\n`));
307
+ const warnings = options.suppressedCodes?.includes(RECORD_FIELD_CLASH)
308
+ ? []
309
+ : linted.flatMap(lintSanyModule);
310
+ const prefix = options.errorCodes?.includes(RECORD_FIELD_CLASH)
311
+ ? "Warning treated as error: "
312
+ : "";
313
+ warnings.forEach((warning) => log(`${prefix}${formatMessage(warning)}\n\n\n`));
314
+ if (prefix && warnings.length > 0) isFailed = true;
349
315
  }
350
316
  return {
351
317
  text: lines.join(""),
352
- isFailed: isFailed.value,
353
- specification: parsePhase.isAborted ? undefined : specification,
318
+ isFailed,
319
+ specification: isParseAborted ? undefined : specification,
354
320
  };
355
321
  };
@@ -21,18 +21,12 @@ import {
21
21
  type ThmOrAssumpDefNode,
22
22
  } from "./nodes";
23
23
 
24
- // A port of SANY's Generator.selectorToNode, which turns a name such as Op(a)!lab(b)!:!2 into the
25
- // semantic node it names, following the Subexpression algorithm of SANY's Subexpression.tla.
26
-
27
- // An operand selector !i is the number i, and the other selectors are named after SANY's NameSel,
28
- // NullSel, GGSel, LLSel, ColonSel and AtSel.
29
24
  type SelectorOp = number | "Name" | "Null" | ">>" | "<<" | ":" | "@";
30
25
 
31
26
  export interface SelectorItem {
32
27
  op: SelectorOp;
33
28
  name: string;
34
29
  args: Expression[] | undefined;
35
- // Where SANY locates the selector and its parenthesized arguments, when known.
36
30
  location?: SanyLocation;
37
31
  argsLocation?: SanyLocation;
38
32
  }
@@ -62,10 +56,7 @@ interface SelectorGenerator {
62
56
  createLambda: (params: FormalParamNode[], body: ExprNode, location: SanyLocation) => OpDefNode;
63
57
  copySubstIn: (prefix: SubstInNode, body: ExprNode) => SubstInNode;
64
58
  getBuiltin: (name: string) => OpDefNode;
65
- // Errors.addMessage for an error SANY recovers from, and the null node SANY returns after one.
66
59
  addError: (location: SanyLocation, text: string) => OpApplNode;
67
- // Generator.illegalLabelRef and illegalAPPosRef: whether the node being generated lies outside
68
- // the scope of a declaration that a label or a clause of an ASSUME/PROVE lies in.
69
60
  isOutOfLabelScope: (label: LabelNode) => boolean;
70
61
  isOutOfClauseScope: (assumeProve: AssumeProveNode, position: number) => boolean;
71
62
  }
@@ -80,8 +71,8 @@ const PROOF_STEP_OPERATORS = new Map([
80
71
  ["$Suffices", "SUFFICES"],
81
72
  ]);
82
73
 
83
- // The parts of a name like I!Op or Op!lab, except for an operator such as !! that contains a "!".
84
- const getNameParts = (name: string) => {
74
+ const getNameParts = (name: string): string[] => {
75
+ if (name.length > 3 && name.endsWith("!!!")) return [...getNameParts(name.slice(0, -3)), "!!"];
85
76
  const parts = name.split("!");
86
77
  return parts.some((part) => part.length === 0) ? [name] : parts;
87
78
  };
@@ -94,11 +85,11 @@ export const getSelectorItems = (expression: Expression): SelectorItem[] | undef
94
85
  const parts = getNameParts(expression.operator);
95
86
  const counts =
96
87
  expression.argumentCounts ??
97
- parts.map((_, index) => (index === parts.length - 1 ? expression.args.length : 0));
98
- const cursor = { value: 0 };
88
+ parts.map((_part, index) => (index === parts.length - 1 ? expression.args.length : 0));
89
+ let cursor = 0;
99
90
  return parts.map((name, index) => {
100
- const args = expression.args.slice(cursor.value, cursor.value + counts[index]);
101
- cursor.value += counts[index];
91
+ const args = expression.args.slice(cursor, cursor + counts[index]);
92
+ cursor += counts[index];
102
93
  return { op: "Name", name, args: args.length > 0 ? args : undefined };
103
94
  });
104
95
  }
@@ -125,29 +116,23 @@ export const getSelectorItems = (expression: Expression): SelectorItem[] | undef
125
116
  return undefined;
126
117
  };
127
118
 
128
- // A selector SANY parses as a GeneralId rather than an OpApplication: one whose last part is not a
129
- // name with arguments.
130
119
  export const isGeneralId = (items: SelectorItem[]) => {
131
120
  const last = items[items.length - 1];
132
121
  return last.op !== "Name" || last.args === undefined;
133
122
  };
134
123
 
135
- // SANY's selectorItemToString, which names an operand selector after the argument it selects.
136
124
  const getSelectorItemName = (item: SelectorItem) =>
137
125
  typeof item.op === "number" ? `argument selector ${item.name}` : item.name;
138
126
 
139
- // Subexpression.tla's ArgNum: the human number of the operand that a selector picks out of an
140
- // expression with arity operands, or -1.
141
- const getArgNumber = (op: SelectorOp, arity: number) => {
142
- if (typeof op === "number") return op > 0 && op <= arity ? op : -1;
143
- if (op === "<<") return arity > 0 ? 1 : -1;
144
- if (op === ">>") return arity === 2 ? 2 : -1;
127
+ const getArgNumber = (selector: SelectorOp, arity: number) => {
128
+ if (typeof selector === "number") return selector > 0 && selector <= arity ? selector : -1;
129
+ if (selector === "<<") return arity > 0 ? 1 : -1;
130
+ if (selector === ">>") return arity === 2 ? 2 : -1;
145
131
  return -1;
146
132
  };
147
133
 
148
134
  type Mode = "FindingOpName" | "FollowingLabels" | "FindingSubExpr";
149
135
 
150
- // The state of Generator.selectorToNode as it walks the items.
151
136
  interface SelectorWalk {
152
137
  name: string | undefined;
153
138
  nameLocation: SanyLocation | undefined;
@@ -176,13 +161,9 @@ const isSymbol = (node: LevelNode | SymbolNode): node is SymbolNode =>
176
161
  const getQuantifierSymbols = (node: OpApplNode) =>
177
162
  (node.bounded?.length ?? 0) > 0 ? (node.bounded ?? []).flat() : (node.unbounded ?? []);
178
163
 
179
- // Generator.extendedBy: a name's location grown to the end of its next part.
180
164
  const extendLocation = (name: SanyLocation | undefined, part: SanyLocation): SanyLocation =>
181
165
  name === undefined ? part : { ...name, endLine: part.endLine, endColumn: part.endColumn };
182
166
 
183
- // selectorToNode: with expectedArity 0 the expression a selector names, with a positive one the
184
- // operator argument, and with -1 the definition a DEF clause names. A fact can also be an
185
- // ASSUME/PROVE, a NEW clause or a module instance.
186
167
  export const createSelectorResolver =
187
168
  (generator: SelectorGenerator) =>
188
169
  (
@@ -255,13 +236,11 @@ export const createSelectorResolver =
255
236
  walk.index++;
256
237
  }
257
238
  }
258
- // TLC 1.7.4's SANY names only the last item of a selector it can't resolve, as
259
- // selectorItemToString does, which fails on an argument selector that isn't a number.
260
239
  if (symbol === undefined && generator.version === "1.7.4") {
261
- const last = items.length - 1;
240
+ const lastIndex = items.length - 1;
262
241
  return generator.addError(
263
- getItemLocation(last),
264
- `Unknown operator: \`${getSelectorItemName(items[last])}'.`,
242
+ getItemLocation(lastIndex),
243
+ `Unknown operator: \`${getSelectorItemName(items[lastIndex])}'.`,
265
244
  );
266
245
  }
267
246
  if (symbol === undefined) {
@@ -674,7 +653,7 @@ export const createSelectorResolver =
674
653
  if (params.length + substInPrefix.length > 0) {
675
654
  const operator = current.op;
676
655
  params.push(
677
- ...Array.from({ length: getSymbolArity(operator) }, (_, paramIndex) =>
656
+ ...Array.from({ length: getSymbolArity(operator) }, (_element, paramIndex) =>
678
657
  generator.createFormalParam(`NewParam${paramIndex}`, 0, undefined),
679
658
  ),
680
659
  );
@@ -682,10 +661,7 @@ export const createSelectorResolver =
682
661
  }
683
662
  }
684
663
  if (!isFact) {
685
- const isAssumeProve =
686
- (current.kind === "ThmOrAssumpDef" && current.body.kind === "AssumeProve") ||
687
- (current.kind === "Label" && current.isAssumeProve);
688
- if (isAssumeProve)
664
+ if (current.kind === "ThmOrAssumpDef" && current.body.kind === "AssumeProve")
689
665
  return generator.addError(location, "ASSUME/PROVE used where an expression is required.");
690
666
  if (current.kind === "ThmOrAssumpDef" && current.body.kind === "OpAppl") {
691
667
  const step = PROOF_STEP_OPERATORS.get(current.body.operator.name);
@@ -5,8 +5,6 @@ import { getTabStop } from "./lexer";
5
5
  import { getSanyParseError } from "./parse-error";
6
6
  import type { SanyLocation } from "./nodes";
7
7
 
8
- // The tokens of one file, to find the locations SANY gives to names, brackets and parentheses that
9
- // the syntax tree of tla-ts leaves out, and the comments SANY attaches to definitions.
10
8
  export interface SourceFile {
11
9
  name: string;
12
10
  source: string;
@@ -48,7 +46,6 @@ export const isToken = (file: SourceFile, index: number, text: string) =>
48
46
  file.tokens[index].text === text &&
49
47
  file.tokens[index].kind !== "String";
50
48
 
51
- // The number of tokens, in source order, before a position, or at or before it when isAtCounted.
52
49
  const countTokensBefore = (file: SourceFile, position: SourceLocation, isAtCounted: boolean) => {
53
50
  let low = 0;
54
51
  let high = file.tokens.length;
@@ -65,12 +62,10 @@ const countTokensBefore = (file: SourceFile, position: SourceLocation, isAtCount
65
62
  return low;
66
63
  };
67
64
 
68
- // The index of the first token at or after a position.
69
65
  export const getTokenIndex = (file: SourceFile, position: SourceLocation) =>
70
66
  file.tokenIndexes.get(getPositionKey(position.line, position.column)) ??
71
67
  Math.min(countTokensBefore(file, position, false), file.tokens.length - 1);
72
68
 
73
- // The index of the last token at or before a position.
74
69
  const getEndTokenIndex = (file: SourceFile, position: SourceLocation) =>
75
70
  Math.max(countTokensBefore(file, position, true) - 1, 0);
76
71
 
@@ -99,8 +94,6 @@ export const getRangeSpan = (file: SourceFile, range: SourceRange): TokenSpan =>
99
94
  end: getEndTokenIndex(file, range.end),
100
95
  });
101
96
 
102
- // The tokens of an expression. Some nodes, such as a tuple in a subscript, have no range, so their
103
- // span runs from their first token to the bracket that closes it.
104
97
  export const getExpressionSpan = (file: SourceFile, expression: Expression): TokenSpan => {
105
98
  const range = expression.location.range;
106
99
  if (range) return getRangeSpan(file, range);
@@ -108,8 +101,6 @@ export const getExpressionSpan = (file: SourceFile, expression: Expression): Tok
108
101
  return { start, end: getMatchingIndex(file, start) };
109
102
  };
110
103
 
111
- // The span with the parentheses around it, as SANY locates a parenthesized operand by its
112
- // parentheses.
113
104
  export const getParenthesizedSpan = (file: SourceFile, span: TokenSpan): TokenSpan => {
114
105
  const start = span.start - 1;
115
106
  const end = span.end + 1;
@@ -123,8 +114,6 @@ export const getParenthesizedSpan = (file: SourceFile, span: TokenSpan): TokenSp
123
114
  return span;
124
115
  };
125
116
 
126
- // SANY's parser keeps the parentheses around an argument of an operator, which the span of the
127
- // argument's expression leaves out. Those of the operator's own arguments follow its name.
128
117
  export const getArgumentSpan = (file: SourceFile, span: TokenSpan): TokenSpan => {
129
118
  const start = span.start - 1;
130
119
  const end = span.end + 1;
@@ -157,14 +146,12 @@ const getOffset = (file: SourceFile, line: number, column: number) => {
157
146
  return offset;
158
147
  };
159
148
 
160
- // The token as the source spells it, where the token's text is the name of the operator.
161
149
  export const getTokenSource = (file: SourceFile, index: number) => {
162
150
  const token = file.tokens[index];
163
151
  const start = getOffset(file, token.line, token.column);
164
152
  return file.source.slice(start, getOffset(file, token.line, token.endColumn) + 1);
165
153
  };
166
154
 
167
- // SANY lexes []ASSUME and []PROVE as single tokens.
168
155
  export const isBoxToken = (file: SourceFile, index: number) => {
169
156
  const box = file.tokens[index];
170
157
  const next = file.tokens[index + 1];
@@ -179,8 +166,7 @@ export const isBoxToken = (file: SourceFile, index: number) => {
179
166
  };
180
167
 
181
168
  // HACK: the tla-ts parser has no []ASSUME or []PROVE, so it parses the source with each such []
182
- // blanked out, which keeps every other token where it was. SANY's parser takes them only in an
183
- // ASSUME/PROVE, which unboxing hides.
169
+ // blanked out, which keeps every other token where it was.
184
170
  export const getUnboxedSource = (source: string) => {
185
171
  const file = createSourceFile("", source);
186
172
  const unboxed = file.tokens.reduce((text, token, index) => {
@@ -194,7 +180,6 @@ export const getUnboxedSource = (source: string) => {
194
180
  return unboxed;
195
181
  };
196
182
 
197
- // The comments between a token and the one before it, which SANY's parser attaches to the token.
198
183
  export const getPreComments = (file: SourceFile, index: number) => {
199
184
  const previous = file.tokens[index - 1];
200
185
  const token = file.tokens[index];
@@ -209,7 +194,6 @@ export const getPreComments = (file: SourceFile, index: number) => {
209
194
  comments.push(gap.slice(offset, end));
210
195
  offset = end;
211
196
  } else if (gap.startsWith("(*", offset)) {
212
- // SANY's lexer ends a comment token at each (* and *) nested in a block comment.
213
197
  let depth = 1;
214
198
  let segmentStart = offset;
215
199
  let end = offset + 2;