tla-ts 0.0.3 → 0.0.4-dev.2a873ee

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 (370) hide show
  1. package/README.md +46 -115
  2. package/dist/cli.cjs +1 -1
  3. package/dist/cli.js +1 -1
  4. package/dist/deciders.cjs +366 -0
  5. package/dist/deciders.js +366 -0
  6. package/dist/index.cjs +1 -1
  7. package/dist/index.d.cts +194 -8
  8. package/dist/index.d.ts +194 -8
  9. package/dist/index.js +1 -1
  10. package/dist/parallel-worker.cjs +1 -4
  11. package/dist/parallel-worker.js +1 -4
  12. package/dist/prove-worker.cjs +9 -0
  13. package/dist/prove-worker.d.cts +9 -0
  14. package/dist/prove-worker.d.ts +9 -0
  15. package/dist/prove-worker.js +9 -0
  16. package/dist/prove.cjs +996 -0
  17. package/dist/prove.js +996 -0
  18. package/dist/run-cli.cjs +37 -20
  19. package/dist/run-cli.js +37 -20
  20. package/dist/tlapm.cjs +10 -0
  21. package/dist/tlapm.js +10 -0
  22. package/dist/transfer.cjs +1387 -18
  23. package/dist/transfer.js +1387 -18
  24. package/dist/worker.cjs +21 -0
  25. package/dist/worker.js +21 -0
  26. package/package.json +24 -11
  27. package/src/ast.ts +149 -8
  28. package/src/bags.ts +4 -7
  29. package/src/builtins.ts +29 -11
  30. package/src/bundled-modules.ts +3 -3
  31. package/src/canonical.ts +4 -3
  32. package/src/check.ts +1540 -235
  33. package/src/cli-options.ts +12 -6
  34. package/src/cli.ts +8 -1
  35. package/src/codegen.ts +98 -39
  36. package/src/config.ts +254 -181
  37. package/src/dependencies.ts +2 -2
  38. package/src/environment.ts +540 -140
  39. package/src/errors.ts +284 -4
  40. package/src/evaluate.ts +1043 -293
  41. package/src/exit-codes.ts +22 -43
  42. package/src/fingerprints.ts +46 -11
  43. package/src/index.ts +11 -0
  44. package/src/instances.ts +19 -16
  45. package/src/java-overrides.ts +104 -25
  46. package/src/levels.ts +191 -45
  47. package/src/lexer.ts +127 -30
  48. package/src/live-check.ts +867 -0
  49. package/src/liveness.ts +218 -572
  50. package/src/{obligation-action.ts → obligations/action.ts} +247 -69
  51. package/src/{obligation-anon.ts → obligations/anon.ts} +49 -47
  52. package/src/obligations/ctx.ts +64 -0
  53. package/src/{obligation-deref.ts → obligations/deref.ts} +51 -92
  54. package/src/{obligation-expression.ts → obligations/expression.ts} +117 -57
  55. package/src/{obligation-format.ts → obligations/format.ts} +7 -8
  56. package/src/{obligation-generate.ts → obligations/generate.ts} +170 -192
  57. package/src/{obligations.ts → obligations/index.ts} +32 -16
  58. package/src/{obligation-levels.ts → obligations/levels.ts} +26 -28
  59. package/src/{obligation-module.ts → obligations/module.ts} +113 -121
  60. package/src/obligations/pickle.ts +98 -0
  61. package/src/obligations/pragma.ts +189 -0
  62. package/src/{obligation-printer.ts → obligations/printer.ts} +22 -80
  63. package/src/{obligation-proof.ts → obligations/proof.ts} +7 -2
  64. package/src/{obligation-source.ts → obligations/source.ts} +156 -99
  65. package/src/obligations/temporal.ts +321 -0
  66. package/src/{obligation-tuples.ts → obligations/tuples.ts} +38 -54
  67. package/src/ocaml-marshal.ts +166 -0
  68. package/src/parallel-worker.ts +169 -224
  69. package/src/parallel.ts +140 -81
  70. package/src/parser.ts +456 -147
  71. package/src/pcal-ast.ts +770 -0
  72. package/src/pcal-parse.ts +1523 -0
  73. package/src/pcal-tokenize.ts +516 -0
  74. package/src/pcal-translate.ts +1230 -0
  75. package/src/pcal-validate.ts +454 -0
  76. package/src/prove/decide-pool.ts +95 -0
  77. package/src/prove/deciders.ts +33 -0
  78. package/src/prove/first-order.ts +78 -0
  79. package/src/prove/isabelle/LICENSE +36 -0
  80. package/src/prove/isabelle/LICENSE-tlapm +26 -0
  81. package/src/prove/isabelle/decide.ts +47 -0
  82. package/src/prove/isabelle/encode.ts +446 -0
  83. package/src/prove/isabelle/isar/inner-syntax.ts +579 -0
  84. package/src/prove/isabelle/isar/method.ts +367 -0
  85. package/src/prove/isabelle/isar/proof.ts +28 -0
  86. package/src/prove/isabelle/isar/statement.ts +57 -0
  87. package/src/prove/isabelle/isar/theory.ts +192 -0
  88. package/src/prove/isabelle/isar/type-check.ts +278 -0
  89. package/src/prove/isabelle/provers/blast/blast.ts +258 -0
  90. package/src/prove/isabelle/provers/blast/branch.ts +322 -0
  91. package/src/prove/isabelle/provers/blast/prove.ts +347 -0
  92. package/src/prove/isabelle/provers/blast/rules.ts +330 -0
  93. package/src/prove/isabelle/provers/blast/state.ts +180 -0
  94. package/src/prove/isabelle/provers/blast/term.ts +546 -0
  95. package/src/prove/isabelle/provers/clasimp.ts +150 -0
  96. package/src/prove/isabelle/provers/classical.ts +389 -0
  97. package/src/prove/isabelle/provers/hypsubst.ts +433 -0
  98. package/src/prove/isabelle/pure/bicompose.ts +174 -0
  99. package/src/prove/isabelle/pure/consts.ts +32 -0
  100. package/src/prove/isabelle/pure/conv.ts +79 -0
  101. package/src/prove/isabelle/pure/drule.ts +264 -0
  102. package/src/prove/isabelle/pure/envir.ts +331 -0
  103. package/src/prove/isabelle/pure/goal.ts +53 -0
  104. package/src/prove/isabelle/pure/interrupt.ts +16 -0
  105. package/src/prove/isabelle/pure/list.ts +12 -0
  106. package/src/prove/isabelle/pure/logic.ts +330 -0
  107. package/src/prove/isabelle/pure/name.ts +98 -0
  108. package/src/prove/isabelle/pure/net.ts +215 -0
  109. package/src/prove/isabelle/pure/object-logic.ts +41 -0
  110. package/src/prove/isabelle/pure/pattern.ts +631 -0
  111. package/src/prove/isabelle/pure/raw-simplifier.ts +338 -0
  112. package/src/prove/isabelle/pure/rewriter.ts +602 -0
  113. package/src/prove/isabelle/pure/search.ts +68 -0
  114. package/src/prove/isabelle/pure/seq.ts +133 -0
  115. package/src/prove/isabelle/pure/simplifier.ts +106 -0
  116. package/src/prove/isabelle/pure/table.ts +201 -0
  117. package/src/prove/isabelle/pure/tactic.ts +168 -0
  118. package/src/prove/isabelle/pure/tactical.ts +264 -0
  119. package/src/prove/isabelle/pure/term-ord.ts +105 -0
  120. package/src/prove/isabelle/pure/term.ts +688 -0
  121. package/src/prove/isabelle/pure/thm.ts +783 -0
  122. package/src/prove/isabelle/pure/type.ts +121 -0
  123. package/src/prove/isabelle/pure/unify.ts +753 -0
  124. package/src/prove/isabelle/pure/variable.ts +25 -0
  125. package/src/prove/isabelle/tla/classical-setup.ts +101 -0
  126. package/src/prove/isabelle/tla/context.ts +74 -0
  127. package/src/prove/isabelle/tla/logic-data.ts +5 -0
  128. package/src/prove/isabelle/tla/logic.ts +215 -0
  129. package/src/prove/isabelle/tla/simpdata.ts +241 -0
  130. package/src/prove/isabelle/tools/intuitionistic.ts +132 -0
  131. package/src/prove/ocaml.ts +22 -0
  132. package/src/prove/prep/action.ts +508 -0
  133. package/src/prove/prep/defs.ts +33 -0
  134. package/src/prove/prep/elab.ts +156 -0
  135. package/src/prove/prep/enabled-axioms.ts +189 -0
  136. package/src/prove/prep/enabled.ts +43 -0
  137. package/src/prove/prep/fingerprint.ts +388 -0
  138. package/src/prove/prep/flatten.ts +70 -0
  139. package/src/prove/prep/level-comparison.ts +529 -0
  140. package/src/prove/prep/md5.ts +67 -0
  141. package/src/prove/prep/pragma.ts +221 -0
  142. package/src/prove/prep/trivial.ts +22 -0
  143. package/src/prove/prove-worker.ts +22 -0
  144. package/src/prove/prove.ts +498 -0
  145. package/src/prove/ptl/decide.ts +68 -0
  146. package/src/prove/ptl/encode.ts +255 -0
  147. package/src/prove/ptl/sat.ts +151 -0
  148. package/src/prove/ptl/tableau.ts +276 -0
  149. package/src/prove/smt/axiomatize.ts +69 -0
  150. package/src/prove/smt/axioms.ts +209 -0
  151. package/src/prove/smt/context.ts +108 -0
  152. package/src/prove/smt/data.ts +636 -0
  153. package/src/prove/smt/encode.ts +164 -0
  154. package/src/prove/smt/extensionality.ts +65 -0
  155. package/src/prove/smt/flatten.ts +112 -0
  156. package/src/prove/smt/format.ts +154 -0
  157. package/src/prove/smt/instances.ts +181 -0
  158. package/src/prove/smt/rewrite.ts +772 -0
  159. package/src/prove/smt/simplify.ts +57 -0
  160. package/src/prove/smt/solver/act-cache.ts +265 -0
  161. package/src/prove/smt/solver/arith-rewriter.ts +962 -0
  162. package/src/prove/smt/solver/array.ts +22 -0
  163. package/src/prove/smt/solver/asserted-formulas.ts +469 -0
  164. package/src/prove/smt/solver/ast-lt.ts +157 -0
  165. package/src/prove/smt/solver/ast-util.ts +91 -0
  166. package/src/prove/smt/solver/ast.ts +1315 -0
  167. package/src/prove/smt/solver/auf-solver.ts +572 -0
  168. package/src/prove/smt/solver/case-split-queue.ts +178 -0
  169. package/src/prove/smt/solver/cg-table.ts +175 -0
  170. package/src/prove/smt/solver/clause.ts +276 -0
  171. package/src/prove/smt/solver/conflict-resolution.ts +343 -0
  172. package/src/prove/smt/solver/context.ts +1292 -0
  173. package/src/prove/smt/solver/ctx-simplify.ts +334 -0
  174. package/src/prove/smt/solver/der.ts +224 -0
  175. package/src/prove/smt/solver/dyn-ack.ts +141 -0
  176. package/src/prove/smt/solver/e-matching.ts +659 -0
  177. package/src/prove/smt/solver/enode.ts +259 -0
  178. package/src/prove/smt/solver/expr-ref.ts +21 -0
  179. package/src/prove/smt/solver/expr-safe-replace.ts +172 -0
  180. package/src/prove/smt/solver/fingerprints.ts +92 -0
  181. package/src/prove/smt/solver/flat-literals.ts +51 -0
  182. package/src/prove/smt/solver/goal.ts +138 -0
  183. package/src/prove/smt/solver/hash.ts +173 -0
  184. package/src/prove/smt/solver/hashtable.ts +166 -0
  185. package/src/prove/smt/solver/internalizer.ts +1381 -0
  186. package/src/prove/smt/solver/lbool.ts +5 -0
  187. package/src/prove/smt/solver/literal.ts +24 -0
  188. package/src/prove/smt/solver/lp/bound-propagator.ts +391 -0
  189. package/src/prove/smt/solver/lp/constraints.ts +78 -0
  190. package/src/prove/smt/solver/lp/containers.ts +296 -0
  191. package/src/prove/smt/solver/lp/core-solver.ts +504 -0
  192. package/src/prove/smt/solver/lp/cross-nested.ts +224 -0
  193. package/src/prove/smt/solver/lp/dep-intervals.ts +642 -0
  194. package/src/prove/smt/solver/lp/dependency.ts +51 -0
  195. package/src/prove/smt/solver/lp/dioph-eq.ts +1181 -0
  196. package/src/prove/smt/solver/lp/explanation.ts +46 -0
  197. package/src/prove/smt/solver/lp/gomory.ts +255 -0
  198. package/src/prove/smt/solver/lp/hnf-cutter.ts +125 -0
  199. package/src/prove/smt/solver/lp/hnf.ts +281 -0
  200. package/src/prove/smt/solver/lp/int-cube.ts +295 -0
  201. package/src/prove/smt/solver/lp/int-solver.ts +514 -0
  202. package/src/prove/smt/solver/lp/lar-solver.ts +816 -0
  203. package/src/prove/smt/solver/lp/lar-term.ts +62 -0
  204. package/src/prove/smt/solver/lp/lp-settings.ts +91 -0
  205. package/src/prove/smt/solver/lp/maximize-term.ts +347 -0
  206. package/src/prove/smt/solver/lp/nex-creator.ts +381 -0
  207. package/src/prove/smt/solver/lp/nex.ts +120 -0
  208. package/src/prove/smt/solver/lp/nla-backoff.ts +43 -0
  209. package/src/prove/smt/solver/lp/nla-basics.ts +398 -0
  210. package/src/prove/smt/solver/lp/nla-core.ts +968 -0
  211. package/src/prove/smt/solver/lp/nla-divisions.ts +332 -0
  212. package/src/prove/smt/solver/lp/nla-emonics.ts +373 -0
  213. package/src/prove/smt/solver/lp/nla-factorization.ts +30 -0
  214. package/src/prove/smt/solver/lp/nla-grobner.ts +904 -0
  215. package/src/prove/smt/solver/lp/nla-horner.ts +126 -0
  216. package/src/prove/smt/solver/lp/nla-intervals.ts +265 -0
  217. package/src/prove/smt/solver/lp/nla-monomial-bounds.ts +715 -0
  218. package/src/prove/smt/solver/lp/nla-monotone.ts +59 -0
  219. package/src/prove/smt/solver/lp/nla-order.ts +307 -0
  220. package/src/prove/smt/solver/lp/nla-patcher.ts +112 -0
  221. package/src/prove/smt/solver/lp/nla-tangents.ts +251 -0
  222. package/src/prove/smt/solver/lp/nla-throttle.ts +85 -0
  223. package/src/prove/smt/solver/lp/nla-types.ts +124 -0
  224. package/src/prove/smt/solver/lp/nla-var-eqs.ts +141 -0
  225. package/src/prove/smt/solver/lp/nra-solver.ts +440 -0
  226. package/src/prove/smt/solver/lp/numeric-pair.ts +65 -0
  227. package/src/prove/smt/solver/lp/pdd-interval.ts +31 -0
  228. package/src/prove/smt/solver/lp/pdd-simplifier.ts +184 -0
  229. package/src/prove/smt/solver/lp/pdd-solver.ts +408 -0
  230. package/src/prove/smt/solver/lp/pdd.ts +971 -0
  231. package/src/prove/smt/solver/lp/random-updater.ts +138 -0
  232. package/src/prove/smt/solver/lp/static-matrix.ts +246 -0
  233. package/src/prove/smt/solver/lp/union-find.ts +96 -0
  234. package/src/prove/smt/solver/mam-compiler.ts +847 -0
  235. package/src/prove/smt/solver/mam-interpreter.ts +400 -0
  236. package/src/prove/smt/solver/maximize-ac-sharing.ts +118 -0
  237. package/src/prove/smt/solver/model-checker.ts +347 -0
  238. package/src/prove/smt/solver/model-evaluator.ts +262 -0
  239. package/src/prove/smt/solver/model-finder.ts +155 -0
  240. package/src/prove/smt/solver/model-generator.ts +97 -0
  241. package/src/prove/smt/solver/model-macro-solver.ts +728 -0
  242. package/src/prove/smt/solver/nlsat/algebraic.ts +1161 -0
  243. package/src/prove/smt/solver/nlsat/atoms.ts +238 -0
  244. package/src/prove/smt/solver/nlsat/evaluator.ts +303 -0
  245. package/src/prove/smt/solver/nlsat/explain.ts +607 -0
  246. package/src/prove/smt/solver/nlsat/interval-set.ts +351 -0
  247. package/src/prove/smt/solver/nlsat/levelwise.ts +737 -0
  248. package/src/prove/smt/solver/nlsat/mpbq.ts +161 -0
  249. package/src/prove/smt/solver/nlsat/polynomial.ts +1722 -0
  250. package/src/prove/smt/solver/nlsat/solver.ts +911 -0
  251. package/src/prove/smt/solver/nlsat/types.ts +43 -0
  252. package/src/prove/smt/solver/nlsat/upolynomial-factorization.ts +648 -0
  253. package/src/prove/smt/solver/nlsat/upolynomial.ts +996 -0
  254. package/src/prove/smt/solver/nnf.ts +469 -0
  255. package/src/prove/smt/solver/pattern-inference.ts +351 -0
  256. package/src/prove/smt/solver/poly-rewriter.ts +477 -0
  257. package/src/prove/smt/solver/propagate-values.ts +83 -0
  258. package/src/prove/smt/solver/proto-model.ts +551 -0
  259. package/src/prove/smt/solver/pull-quant.ts +139 -0
  260. package/src/prove/smt/solver/qe-lite-der.ts +526 -0
  261. package/src/prove/smt/solver/qe-lite-fm.ts +576 -0
  262. package/src/prove/smt/solver/qe-lite.ts +381 -0
  263. package/src/prove/smt/solver/qi-queue.ts +362 -0
  264. package/src/prove/smt/solver/quant-tactics.ts +117 -0
  265. package/src/prove/smt/solver/quantifier-analyzer.ts +562 -0
  266. package/src/prove/smt/solver/quantifier-manager.ts +186 -0
  267. package/src/prove/smt/solver/random-gen.ts +10 -0
  268. package/src/prove/smt/solver/rational.ts +165 -0
  269. package/src/prove/smt/solver/ref-vector.ts +62 -0
  270. package/src/prove/smt/solver/relevancy.ts +247 -0
  271. package/src/prove/smt/solver/rewriter-tpl.ts +1159 -0
  272. package/src/prove/smt/solver/rewriter.ts +843 -0
  273. package/src/prove/smt/solver/rlimit.ts +79 -0
  274. package/src/prove/smt/solver/smtlib-parser.ts +526 -0
  275. package/src/prove/smt/solver/solver.ts +71 -0
  276. package/src/prove/smt/solver/sort.ts +35 -0
  277. package/src/prove/smt/solver/sticky-generations.ts +69 -0
  278. package/src/prove/smt/solver/theory-lra-axioms.ts +340 -0
  279. package/src/prove/smt/solver/theory-lra-bounds.ts +226 -0
  280. package/src/prove/smt/solver/theory-lra-final-check.ts +252 -0
  281. package/src/prove/smt/solver/theory-lra-internalize.ts +476 -0
  282. package/src/prove/smt/solver/theory-lra-model.ts +243 -0
  283. package/src/prove/smt/solver/theory-lra-propagate.ts +405 -0
  284. package/src/prove/smt/solver/theory-lra-state.ts +43 -0
  285. package/src/prove/smt/solver/theory-lra.ts +56 -0
  286. package/src/prove/smt/solver/var-subst.ts +258 -0
  287. package/src/prove/smt/solver/z3-license.txt +10 -0
  288. package/src/prove/smt/table.ts +170 -0
  289. package/src/prove/tlapm/tlapm.ts +96 -0
  290. package/src/prove/tlaps-module.ts +510 -0
  291. package/src/prove/verdict.ts +18 -0
  292. package/src/prove/zenon/LICENSE +32 -0
  293. package/src/prove/zenon/check/check.ts +105 -0
  294. package/src/prove/zenon/check/definitions.ts +144 -0
  295. package/src/prove/zenon/check/equality.ts +182 -0
  296. package/src/prove/zenon/check/functions.ts +62 -0
  297. package/src/prove/zenon/check/keys.ts +125 -0
  298. package/src/prove/zenon/check/propositional.ts +104 -0
  299. package/src/prove/zenon/check/records.ts +188 -0
  300. package/src/prove/zenon/check/relations.ts +121 -0
  301. package/src/prove/zenon/check/rewrites.ts +224 -0
  302. package/src/prove/zenon/check/sets.ts +302 -0
  303. package/src/prove/zenon/check/terms.ts +127 -0
  304. package/src/prove/zenon/check/tla.ts +126 -0
  305. package/src/prove/zenon/decide.ts +113 -0
  306. package/src/prove/zenon/encode.ts +379 -0
  307. package/src/prove/zenon/eqrel.ts +300 -0
  308. package/src/prove/zenon/equality-rules.ts +435 -0
  309. package/src/prove/zenon/expr.ts +551 -0
  310. package/src/prove/zenon/index-table.ts +350 -0
  311. package/src/prove/zenon/isar-case.ts +513 -0
  312. package/src/prove/zenon/isar.ts +1249 -0
  313. package/src/prove/zenon/limits.ts +15 -0
  314. package/src/prove/zenon/llproof.ts +173 -0
  315. package/src/prove/zenon/mltoll.ts +1566 -0
  316. package/src/prove/zenon/node.ts +297 -0
  317. package/src/prove/zenon/ocaml.ts +169 -0
  318. package/src/prove/zenon/parse.ts +247 -0
  319. package/src/prove/zenon/phrase.ts +191 -0
  320. package/src/prove/zenon/proof.ts +198 -0
  321. package/src/prove/zenon/propositional-rules.ts +387 -0
  322. package/src/prove/zenon/rules.ts +94 -0
  323. package/src/prove/zenon/search.ts +288 -0
  324. package/src/prove/zenon/tla/functions.ts +151 -0
  325. package/src/prove/zenon/tla/llproof.ts +480 -0
  326. package/src/prove/zenon/tla/records.ts +225 -0
  327. package/src/prove/zenon/tla/rewrites.ts +447 -0
  328. package/src/prove/zenon/tla/sets.ts +304 -0
  329. package/src/prove/zenon/tla/terms.ts +162 -0
  330. package/src/prove/zenon/tla/tla.ts +506 -0
  331. package/src/randomization.ts +24 -7
  332. package/src/resolve.ts +1481 -426
  333. package/src/run-cli.ts +1483 -212
  334. package/src/runtime.ts +19 -1
  335. package/src/sany-builtins.ts +147 -0
  336. package/src/sany-generator.ts +3128 -0
  337. package/src/sany-levels.ts +1208 -0
  338. package/src/sany-lexer.ts +545 -0
  339. package/src/sany-linter.ts +122 -0
  340. package/src/sany-modules.ts +1398 -0
  341. package/src/sany-nodes.ts +463 -0
  342. package/src/sany-parse-error.ts +2161 -0
  343. package/src/sany-report.ts +356 -0
  344. package/src/sany-selectors.ts +738 -0
  345. package/src/sany-source.ts +248 -0
  346. package/src/sany-xml.ts +1017 -0
  347. package/src/spec-description.ts +42 -11
  348. package/src/standard-modules.ts +203 -148
  349. package/src/standard-ranges.ts +116 -0
  350. package/src/state-graph.ts +180 -0
  351. package/src/subexpressions.ts +231 -171
  352. package/src/substitution-levels.ts +38 -17
  353. package/src/successors.ts +241 -110
  354. package/src/symmetry.ts +194 -54
  355. package/src/tableau.ts +54 -25
  356. package/src/tlapm-cache.ts +236 -0
  357. package/src/tlc-ext.ts +42 -29
  358. package/src/tlc-messages.ts +329 -0
  359. package/src/tlc-module.ts +52 -43
  360. package/src/tlc-modules.ts +4 -0
  361. package/src/tlc-order.ts +78 -10
  362. package/src/tlc-random.ts +84 -33
  363. package/src/tlc-replay.ts +655 -0
  364. package/src/tlc-summary.ts +20 -5
  365. package/src/tlc-version.ts +19 -0
  366. package/src/transfer.ts +15 -3
  367. package/src/values.ts +787 -190
  368. package/src/worker.ts +65 -0
  369. package/dist/parallel.cjs +0 -12
  370. package/dist/parallel.js +0 -12
@@ -0,0 +1,356 @@
1
+ import { existsSync, readFileSync } from "node:fs";
2
+ import { basename } from "node:path";
3
+ import type { Module } from "./ast";
4
+ import { TlaSyntaxError, PcalRuntimeError, TlaSanyFatalError } from "./errors";
5
+ import { extractModule, parseSanyModule } from "./parser";
6
+ import { createPcalParams } from "./pcal-ast";
7
+ import { createPcalSession } from "./pcal-parse";
8
+ import { validatePcalModule } from "./pcal-validate";
9
+ import { generateSanySpecification, type SanySpecification } from "./sany-generator";
10
+ import { checkModuleLevels } from "./sany-levels";
11
+ import { getSany174LexicalError } from "./sany-lexer";
12
+ import { lintSanyModule } from "./sany-linter";
13
+ import { getSanyStandardModules } from "./sany-modules";
14
+ import { formatSanyLocation, type SanyMessage } from "./sany-nodes";
15
+ import { getUnboxedSource } from "./sany-source";
16
+ import type { TlcVersion } from "./tlc-version";
17
+
18
+ interface SanyReport {
19
+ text: string;
20
+ isFailed: boolean;
21
+ // The specification SANY analyzes, which has errors when SANY rejects it.
22
+ specification?: SanySpecification;
23
+ }
24
+
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
+ export type SanyModuleOrigin = "file" | "root file" | "standard";
28
+
29
+ export interface SanyReportOptions {
30
+ // The file name SANY's caller gives it, which it prints in its messages about the specification.
31
+ 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
+ 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
+ isXmlExport?: boolean;
38
+ // The TLC whose SANY to reproduce.
39
+ version?: TlcVersion;
40
+ // The modules TLC adds to the root module's EXTENDS for its post conditions.
41
+ rootExtendees?: string[];
42
+ // Prints what SANY prints as it goes, before the report holds all of it.
43
+ onPrint?: (text: string) => void;
44
+ // Prints what TLC 1.7.4's SANY prints to its error stream as it goes.
45
+ onPrintError?: (text: string) => void;
46
+ }
47
+
48
+ interface LoadedModule {
49
+ text: string;
50
+ module: Module;
51
+ }
52
+
53
+ interface Validation {
54
+ text: string;
55
+ isError: boolean;
56
+ }
57
+
58
+ // ErrorDetails.toString.
59
+ const formatMessage = (message: SanyMessage) =>
60
+ `${formatSanyLocation(message.location)}\n\n${message.text}`;
61
+
62
+ // Errors.toString: the errors and then the warnings of a phase of SANY.
63
+ const formatErrors = (messages: SanyMessage[]) => {
64
+ const errors = messages.filter((message) => !message.isWarning);
65
+ const warnings = messages.filter((message) => message.isWarning);
66
+ return [
67
+ errors.length > 0 ? `*** Errors: ${errors.length}\n\n` : "",
68
+ ...errors.map((error) => `${formatMessage(error)}\n\n\n`),
69
+ warnings.length > 0 ? `*** Warnings: ${warnings.length}\n\n` : "",
70
+ ...warnings.map((warning) => `${formatMessage(warning)}\n\n\n`),
71
+ ].join("");
72
+ };
73
+
74
+ // tla2sany.semantic.StandardModules: SANY lints the modules other than these.
75
+ const UNLINTED_MODULES = new Set([
76
+ "FiniteSets",
77
+ "Sequences",
78
+ "Bags",
79
+ "Naturals",
80
+ "Integers",
81
+ "Reals",
82
+ "RealTime",
83
+ "Randomization",
84
+ "TLC",
85
+ ]);
86
+
87
+ // The modules a module and its inner modules extend, other than its inner modules.
88
+ const getExtendees = (module: Module) => {
89
+ const innerNames = new Set<string>();
90
+ const extendees: string[] = [];
91
+ const visit = (current: Module) => {
92
+ innerNames.add(current.name);
93
+ extendees.push(...current.extends);
94
+ current.modules.forEach(visit);
95
+ };
96
+ visit(module);
97
+ return extendees.filter((extendee) => !innerNames.has(extendee));
98
+ };
99
+
100
+ // HACK: the report parses a module to find the lines SANY's validation of its PlusCal reads, and
101
+ // a module that doesn't parse is one SANY stops at before validating it.
102
+ const parseValidatedModule = (text: string) => {
103
+ try {
104
+ return parseSanyModule(getUnboxedSource(text));
105
+ } catch (error) {
106
+ if (error instanceof TlaSyntaxError) return undefined;
107
+ throw error;
108
+ }
109
+ };
110
+
111
+ // ParseUnit.parseFile: SANY names the specification by the root module once it parses it.
112
+ export const getSanyModuleName = (text: string, version?: TlcVersion) =>
113
+ version === "1.7.4" && getSany174LexicalError(text) !== undefined
114
+ ? undefined
115
+ : parseValidatedModule(text)?.name;
116
+
117
+ // What SANY prints while TLC runs it on the specification in rootPath, and whether SANY rejects the
118
+ // specification. loadModule finds the source of the other modules, and SANY's standard modules fill
119
+ // in the rest.
120
+ export const getSanyReport = (
121
+ rootPath: string,
122
+ loadModule: (name: string) => string | undefined = () => undefined,
123
+ options: SanyReportOptions = {},
124
+ ): SanyReport => {
125
+ const rootName = basename(rootPath, ".tla");
126
+ const standardModules = getSanyStandardModules(options.version);
127
+ const name = options.fileName ?? rootName;
128
+ // SANY looks for the root module where it looks for the others, its standard modules among them.
129
+ const source = existsSync(rootPath)
130
+ ? readFileSync(rootPath, "utf8")
131
+ : standardModules.get(rootName);
132
+ const lines: string[] = [];
133
+ const write = (text: string) => {
134
+ lines.push(text);
135
+ options.onPrint?.(text);
136
+ };
137
+ const log = (text: string) => write(`${text}\n`);
138
+ const isTlc174 = options.version === "1.7.4";
139
+ // TLC 1.7.4's XMLExporter discards what SANY prints to ToolIO.out rather than its error stream.
140
+ const isToolOutputDiscarded = isTlc174 && options.isXmlExport;
141
+ const warn = (text: string) => {
142
+ if (!options.isXmlExport) log(text);
143
+ };
144
+ const describeFile = options.describeFile;
145
+ const origins = new Map<string, SanyModuleOrigin>([
146
+ [rootName, existsSync(rootPath) ? "file" : "standard"],
147
+ ]);
148
+ const isFailed = { value: false };
149
+ // The messages of SANY's parsing phase, which come from its validation of PlusCal, and whether
150
+ // SANY has printed them and whether one is an error that ends its run before semantic analysis.
151
+ const parseMessages: SanyMessage[] = [];
152
+ const parsePhase = { isReported: false, isAborted: false };
153
+ const session = createPcalSession(createPcalParams(), log);
154
+ const loadedModules = new Map<string, LoadedModule>();
155
+ // TLC 1.7.4's SpecObj.validateParseUnit prints what it finds, which follows the file SANY parses
156
+ // next, as SANY validates a module once it parses the module or one that extends it.
157
+ const validations: Validation[] = [];
158
+ const printValidations = () =>
159
+ validations
160
+ .splice(0)
161
+ .forEach((validation) =>
162
+ validation.isError ? options.onPrintError?.(`${validation.text}\n`) : log(validation.text),
163
+ );
164
+ // SpecObj.validateParseUnit: Errors.addMessage drops a message it already has.
165
+ const validate = (moduleName: string) => {
166
+ const loaded = loadedModules.get(moduleName);
167
+ const range = loaded?.module.location.range;
168
+ if (loaded === undefined || range === undefined) return;
169
+ const fileLines = loaded.text.split(/\r\n|\r|\n/);
170
+ const results = validatePcalModule(
171
+ session,
172
+ fileLines.slice(range.start.line - 1, range.end.line),
173
+ options.version,
174
+ );
175
+ const isTlaChanged = results.has("TLA_DIVERGENCE_EXISTS");
176
+ const isPcalChanged = results.has("PCAL_DIVERGENCE_EXISTS");
177
+ // Both versions word a change to just one of the algorithm and its translation alike.
178
+ const oneChange =
179
+ isTlaChanged === isPcalChanged
180
+ ? undefined
181
+ : `The ${isTlaChanged ? "TLA+ translation" : "PlusCal algorithm"} in module ${moduleName} has changed since its last translation.`;
182
+ if (isTlc174) {
183
+ const warning =
184
+ isTlaChanged && isPcalChanged
185
+ ? `The PlusCal algorithm and its TLA+ translation in module ${moduleName} filename since the last translation.`
186
+ : oneChange;
187
+ if (warning !== undefined)
188
+ validations.push({ text: `!! WARNING: ${warning}`, isError: false });
189
+ else if (results.has("ERROR_ENCOUNTERED")) {
190
+ validations.push({
191
+ text: `A unexpected problem was encountered attempting to validate the specification for ${moduleName}`,
192
+ isError: true,
193
+ });
194
+ }
195
+ return;
196
+ }
197
+ const text =
198
+ isTlaChanged && isPcalChanged
199
+ ? `Both the PlusCal algorithm and its TLA+ translation in module ${moduleName} have changed since the last translation.`
200
+ : (oneChange ??
201
+ (results.has("ERROR_ENCOUNTERED")
202
+ ? `An unexpected problem was encountered attempting to validate the specification for ${moduleName}`
203
+ : undefined));
204
+ if (text === undefined) return;
205
+ const isWarning = !results.has("ERROR_ENCOUNTERED") || isTlaChanged || isPcalChanged;
206
+ if (parseMessages.some((message) => message.text === text)) return;
207
+ parseMessages.push({ location: moduleName, text, isWarning });
208
+ };
209
+ // SpecObj.loadSpec validates the root module once it parses, and a module each time SANY
210
+ // resolves another module's EXTENDS of it, which the report does when the generator loads it,
211
+ // and for a module loaded earlier, when the generator loads a module that extends it.
212
+ const loadValidatedModule = (moduleName: string, text: string) => {
213
+ if (options.isXmlExport || loadedModules.has(moduleName)) return;
214
+ const module = parseValidatedModule(text);
215
+ if (module === undefined || module.name !== moduleName) return;
216
+ const extenders = [...loadedModules.values()].filter((loaded) =>
217
+ getExtendees(loaded.module).includes(moduleName),
218
+ );
219
+ loadedModules.set(moduleName, { text, module });
220
+ extenders.forEach(() => validate(moduleName));
221
+ getExtendees(module)
222
+ .filter((extendee) => extendee !== moduleName && loadedModules.has(extendee))
223
+ .forEach(validate);
224
+ };
225
+ // SANY.frontEndParse: once SANY has loaded the specification, it prints the warnings of its
226
+ // parsing phase, and when there are errors, every message, and stops.
227
+ const reportParseMessages = () => {
228
+ printValidations();
229
+ if (parsePhase.isReported) return;
230
+ parsePhase.isReported = true;
231
+ const warnings = parseMessages.filter((message) => message.isWarning);
232
+ if (warnings.length > 0) {
233
+ warn(`Warnings (${warnings.length}) during syntax parsing of ${name}:\n\n`);
234
+ warnings.forEach((warning) => warn(`${formatMessage(warning)}\n\n\n`));
235
+ }
236
+ if (warnings.length === parseMessages.length) return;
237
+ log(formatErrors(parseMessages));
238
+ isFailed.value = true;
239
+ parsePhase.isAborted = true;
240
+ };
241
+ const loadSource = (moduleName: string) => {
242
+ const standard = standardModules.get(moduleName);
243
+ const file = loadModule(moduleName);
244
+ // TLC 1.7.4's SANY reads a module only from a file of its own.
245
+ const extracted =
246
+ file === undefined && standard === undefined && source !== undefined && !isTlc174
247
+ ? extractModule(source, moduleName)
248
+ : undefined;
249
+ const text = file ?? extracted;
250
+ origins.set(
251
+ moduleName,
252
+ file !== undefined ? "file" : extracted !== undefined ? "root file" : "standard",
253
+ );
254
+ // The standard modules have no PlusCal, and SANY validates an extracted module's own text.
255
+ if (text !== undefined) loadValidatedModule(moduleName, text);
256
+ return text ?? standard;
257
+ };
258
+ const generate = () => {
259
+ // HACK: SANY reports a fatal error of its parsing phase by the exception it throws, so the
260
+ // report catches the TlaSyntaxError the generator throws for one.
261
+ try {
262
+ if (source === undefined) {
263
+ throw new TlaSanyFatalError(`Cannot find source file for module ${name}`, undefined);
264
+ }
265
+ loadValidatedModule(rootName, source);
266
+ return generateSanySpecification(source, loadSource, {
267
+ rootFileName: rootName,
268
+ // XMLExporter gives SANY the file it is asked for, and TLC the name of the module.
269
+ rootFilePath: options.isXmlExport ? `${name.replace(/\.tla$/, "")}.tla` : undefined,
270
+ version: options.version,
271
+ rootExtendees: options.rootExtendees,
272
+ onParse: (moduleName) => {
273
+ if (describeFile) {
274
+ log(`Parsing file ${describeFile(moduleName, origins.get(moduleName) ?? "file")}`);
275
+ }
276
+ if (moduleName === rootName) validate(rootName);
277
+ printValidations();
278
+ },
279
+ onAnalyze: (moduleName) => {
280
+ reportParseMessages();
281
+ // TLC 1.7.4's XMLExporter prints what SANY prints as it analyzes the modules.
282
+ if ((describeFile || isToolOutputDiscarded) && !parsePhase.isAborted) {
283
+ log(`Semantic processing of module ${moduleName}`);
284
+ }
285
+ },
286
+ // SANY.frontEndSemanticAnalysis: after each module, SANY level-checks it if there are no
287
+ // errors yet, then prints every message so far.
288
+ onModule: (module, messages) => {
289
+ if (parsePhase.isAborted) return;
290
+ if (messages.every((message) => message.isWarning))
291
+ checkModuleLevels(module, { messages, isTlc174 });
292
+ if (messages.length === 0) return;
293
+ if (messages.some((message) => !message.isWarning)) isFailed.value = true;
294
+ // TLC 1.7.4's SANY prints the errors and warnings together.
295
+ if (isTlc174) return log(`Semantic errors:\n\n${formatErrors(messages)}`);
296
+ const warnings = messages.filter((message) => message.isWarning);
297
+ if (warnings.length > 0) {
298
+ warn(`*** Warnings: ${warnings.length}\n`);
299
+ warnings.forEach((warning) => warn(`${formatMessage(warning)}\n\n\n`));
300
+ }
301
+ const errors = messages.filter((message) => !message.isWarning);
302
+ if (errors.length === 0) return;
303
+ log(`Semantic errors:\n\n*** Errors: ${errors.length}\n`);
304
+ errors.forEach((error) => log(`${formatMessage(error)}\n\n`));
305
+ },
306
+ });
307
+ } catch (error) {
308
+ isFailed.value = true;
309
+ // SANY.frontEndParse turns a Java exception of its validation of PlusCal into a fatal
310
+ // error, printing the exception and its messages so far.
311
+ if (error instanceof PcalRuntimeError) {
312
+ log(`\nFatal errors while parsing TLA+ spec in file ${name}\n`);
313
+ log(error.message);
314
+ log(formatErrors(parseMessages));
315
+ return;
316
+ }
317
+ if (!(error instanceof TlaSanyFatalError)) throw error;
318
+ const fatal = { location: error.location, text: error.message, isWarning: false };
319
+ // TLC 1.7.4's ParseException.getShortMessage fails on an error at the first token, which has
320
+ // no image.
321
+ const isImageless = isTlc174 && error.parseError?.includes(' and token "" ');
322
+ if (error.parseError !== undefined && !isImageless && !isToolOutputDiscarded) {
323
+ log(error.parseError);
324
+ }
325
+ log(`\nFatal errors while parsing TLA+ spec in file ${name}\n`);
326
+ if (isImageless) {
327
+ log(
328
+ 'java.lang.NullPointerException: Cannot invoke "String.length()" because "str" is null',
329
+ );
330
+ return;
331
+ }
332
+ // TLC 1.7.4's SANY aborts with an AbortException, and keeps the message as an abort.
333
+ if (isTlc174) {
334
+ log("tla2sany.semantic.AbortException");
335
+ write(`*** Abort messages: 1\n\n${formatMessage(fatal)}\n\n\n`);
336
+ return;
337
+ }
338
+ log(formatMessage(fatal));
339
+ log(formatErrors(parsePhase.isReported ? [fatal] : [...parseMessages, fatal]));
340
+ }
341
+ };
342
+ const specification = generate();
343
+ if (specification !== undefined) reportParseMessages();
344
+ // SANY.frontEndLinting: when SANY accepts the specification, it lints the modules that are not
345
+ // its standard modules, then prints the warnings. TLC 1.7.4's SANY has no linter.
346
+ if (specification !== undefined && !isFailed.value && !options.isXmlExport && !isTlc174) {
347
+ const linted = specification.modules.filter((module) => !UNLINTED_MODULES.has(module.name));
348
+ if (describeFile) linted.forEach((module) => log(`Linting of module ${module.name}`));
349
+ linted.flatMap(lintSanyModule).forEach((warning) => log(`${formatMessage(warning)}\n\n\n`));
350
+ }
351
+ return {
352
+ text: lines.join(""),
353
+ isFailed: isFailed.value,
354
+ specification: parsePhase.isAborted ? undefined : specification,
355
+ };
356
+ };