@andrivet/z80-assembler 1.0.0

package/lib/types/Error.d.ts

@@ -0,0 +1,63 @@
+/**
+ * Z80 Assembler in Typescript
+ *
+ * File:        Error.ts
+ * Description: Compilation errors
+ * Author:			Sebastien Andrivet
+ * License:			GPLv3
+ * Copyrights: 	Copyright (C) 2023 Sebastien Andrivet
+ */
+import { PosInfo, SyntaxErr } from "../grammar/z80";
+/**
+ * A compilation error.
+ */
+declare class CompilationError extends Error {
+    readonly filename: string;
+    readonly pos: PosInfo;
+    /**
+     * Constructor.
+     * @param filename Filename where the error occurred.
+     * @param pos Position (line, offset) here the error occurred.
+     * @param message Description of the error.
+     */
+    constructor(filename: string, pos: PosInfo, message: string);
+    /**
+     * Format the error.
+     */
+    toString(): string;
+    /**
+     * Format internal MatchAttempt
+     * @param match The MatchAttempt to format.
+     * @private
+     */
+    private static formatMatch;
+    /**
+     * Format a syntax error.
+     * @param err a syntax error.
+     * @private
+     */
+    private static formatError;
+    /**
+     * Create a compilation error from a syntax error.
+     * @param filename Filename where the error occurred.
+     * @param e Syntax error.
+     */
+    static fromSyntaxErr(filename: string, e: SyntaxErr): CompilationError;
+    /**
+     * Create a compilation error from different errors.
+     * @param filename Filename where the error occurred.
+     * @param e The error
+     */
+    static fromAny(filename: string, e: any): CompilationError;
+    /**
+     * Check if an error is a compilation error (and cast the result in this case)
+     * @param err
+     */
+    static is(err: any): err is CompilationError;
+    /**
+     * Check if an error is an array of compilation errors (and cast the result in this case)
+     * @param err
+     */
+    static isArray(err: any): err is CompilationError[];
+}
+export { CompilationError };

package/lib/types/Types.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Z80 Assembler in Typescript
+ *
+ * File:        Types.ts
+ * Description: Common types
+ * Author:			Sebastien Andrivet
+ * License:			GPLv3
+ * Copyrights: 	Copyright (C) 2023 Sebastien Andrivet
+ */
+import { Line } from "../grammar/z80";
+import { CompilationError } from "./Error";
+/**
+ * A byte is represented by a number.
+ */
+type byte = number;
+/**
+ * An array of bytes.
+ */
+type bytes = byte[];
+/**
+ * An address is either a number (known) or null (unknown)
+ */
+type Address = number | null;
+/**
+ * Information about lines.
+ */
+interface LinesInfo {
+    lines: Line[];
+    filename: string;
+}
+/**
+ * The result of a compilation.
+ */
+interface CompilationInfo {
+    outputName: string;
+    bytes: bytes;
+    sld: string;
+    errs: CompilationError[];
+}
+export { byte, bytes, Address, LinesInfo, CompilationInfo };

package/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@andrivet/z80-assembler",
+  "version": "1.0.0",
+  "author": "Sebastien Andrivet",
+  "license": "GPLv3",
+  "type": "commonjs",
+  "keywords": ["z80", "assembler", "ZX81"],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/andrivet/z80-assembler"
+  }
+}