tla-ts 0.0.1 → 0.0.3-dev.763cc71

package/src/errors.ts

@@ -1,3 +1,5 @@
+import { EXIT_STATUS, getExitCode, setModuleExitCode } from "./exit-codes";
+
 export class TlaError extends Error {
   constructor(message: string, cause?: unknown) {
     super(message, { cause });
@@ -5,10 +7,20 @@ export class TlaError extends Error {
   }
 }
 
+export interface SyntaxFailure {
+  reason: string;
+  line: number;
+  column: number;
+  isEnd: boolean;
+}
+
 export class TlaSyntaxError extends TlaError {
-  constructor(message: string, cause?: unknown) {
+  failure: SyntaxFailure | undefined;
+
+  constructor(message: string, cause?: unknown, failure?: SyntaxFailure) {
     super(message, cause);
     this.name = "TlaSyntaxError";
+    this.failure = failure;
   }
 }
 
@@ -26,9 +38,55 @@ export class TlaEvaluationError extends TlaError {
   }
 }
 
+// An evaluation error that TLC raises as an EvalException from a standard module's Java code. It
+// keeps the name TlaEvaluationError, and index.ts doesn't export it.
+export class TlaModuleError extends TlaEvaluationError {
+  constructor(message: string, exitCode: number = EXIT_STATUS.error) {
+    super(message);
+    this.name = "TlaEvaluationError";
+    setModuleExitCode(this, exitCode);
+  }
+}
+
+export interface TlapmReport {
+  failure?: string;
+  exception?: string;
+}
+
+export class TlaProofError extends TlaError {
+  failure: string | undefined;
+  exception: string;
+
+  constructor(message: string, report: TlapmReport = {}) {
+    super(message);
+    this.name = "TlaProofError";
+    this.failure = report.exception === undefined ? (report.failure ?? message) : undefined;
+    this.exception = report.exception ?? `Failure(${JSON.stringify(this.failure)})`;
+  }
+}
+
+// tlapm fails one of its own assertions, which it reports as a bug in itself. It keeps the name
+// TlaProofError, and index.ts doesn't export it.
+export class TlapmBugError extends TlaProofError {
+  constructor(exception = "Assert_failure") {
+    super("Oops, this seems to be a bug in TLAPM.", { exception });
+    this.name = "TlaProofError";
+  }
+}
+
 export class TlaUnsupportedError extends TlaError {
   constructor(message: string, cause?: unknown) {
     super(message, cause);
     this.name = "TlaUnsupportedError";
   }
 }
+
+export const getErrorExitCode = (error: TlaError) =>
+  getExitCode(error) ??
+  (error instanceof TlaSyntaxError
+    ? EXIT_STATUS.specParseError
+    : error instanceof TlaConfigError
+      ? EXIT_STATUS.configParseError
+      : error instanceof TlaEvaluationError
+        ? EXIT_STATUS.specEvaluationFailure
+        : EXIT_STATUS.error);