circuitscript 0.1.24 → 0.1.25

package/dist/cjs/helpers.js

@@ -160,15 +160,34 @@ async function validateScript(filePath, scriptData, options) {
     return visitorResolver;
 }
 exports.validateScript = validateScript;
+async function DefaultPostAnnotationCallback(options, scriptData, tree, tokens, componentLinks) {
+    const { inputPath = null, updateSource = false, saveAnnotatedCopy = undefined, } = options;
+    if (inputPath && (updateSource || saveAnnotatedCopy !== undefined)) {
+        const refdesVisitor = new RefdesAnnotationVisitor_js_1.RefdesAnnotationVisitor(true, scriptData, tokens, componentLinks);
+        await refdesVisitor.visitAsync(tree);
+        let usePath = inputPath;
+        if (saveAnnotatedCopy === true) {
+            const dir = path_1.default.dirname(inputPath);
+            const ext = path_1.default.extname(inputPath);
+            const basename = path_1.default.basename(inputPath, ext);
+            usePath = path_1.default.join(dir, `${basename}.annotated${ext}`);
+        }
+        else if (typeof saveAnnotatedCopy === 'string') {
+            usePath = saveAnnotatedCopy;
+        }
+        console.log('Annotations saved to ' + usePath);
+        (0, fs_1.writeFileSync)(usePath, refdesVisitor.getOutput());
+    }
+}
 async function renderScript(scriptData, outputPath, options) {
     const parseHandlers = [
         new KiCadNetListOutputHandler(),
     ];
-    return renderScriptCustom(scriptData, outputPath, options, parseHandlers);
+    return renderScriptCustom(scriptData, outputPath, options, parseHandlers, [DefaultPostAnnotationCallback]);
 }
 exports.renderScript = renderScript;
-async function renderScriptCustom(scriptData, outputPath, options, parseHandlers) {
-    const { dumpNets = false, dumpData = false, showStats = false, enableErc = false, enableBom = false, bomOutputPath = undefined, environment, inputPath = null, updateSource = false, saveAnnotatedCopy = undefined, } = options;
+async function renderScriptCustom(scriptData, outputPath, options, parseHandlers, postAnnotationCallbacks) {
+    const { dumpNets = false, dumpData = false, showStats = false, enableErc = false, enableBom = false, bomOutputPath = undefined, environment } = options;
     const errors = [];
     const onErrorHandler = (message, context, error) => {
         if (error && error instanceof utils_js_1.RuntimeExecutionError) {
@@ -222,22 +241,9 @@ async function renderScriptCustom(scriptData, outputPath, options, parseHandlers
     catch (err) {
         throw new utils_js_1.RenderError(`Error during component annotation: ${err}`, 'annotation');
     }
-    if (inputPath && (updateSource || saveAnnotatedCopy !== undefined)) {
-        const componentLinks = visitor.getComponentCtxLinks();
-        const refdesVisitor = new RefdesAnnotationVisitor_js_1.RefdesAnnotationVisitor(true, scriptData, tokens, componentLinks);
-        await refdesVisitor.visitAsync(tree);
-        let usePath = inputPath;
-        if (saveAnnotatedCopy === true) {
-            const dir = path_1.default.dirname(inputPath);
-            const ext = path_1.default.extname(inputPath);
-            const basename = path_1.default.basename(inputPath, ext);
-            usePath = path_1.default.join(dir, `${basename}.annotated${ext}`);
-        }
-        else if (typeof saveAnnotatedCopy === 'string') {
-            usePath = saveAnnotatedCopy;
-        }
-        console.log('Annotations saved to ' + usePath);
-        (0, fs_1.writeFileSync)(usePath, refdesVisitor.getOutput());
+    const componentLinks = visitor.getComponentCtxLinks();
+    for (let i = 0; i < postAnnotationCallbacks.length; i++) {
+        await postAnnotationCallbacks[i](options, scriptData, tree, tokens, componentLinks);
     }
     if (dumpNets) {
         const nets = visitor.dumpNets();

package/dist/esm/helpers.js

@@ -150,14 +150,33 @@ export async function validateScript(filePath, scriptData, options) {
     await visitorResolver.visitAsync(tree);
     return visitorResolver;
 }
+async function DefaultPostAnnotationCallback(options, scriptData, tree, tokens, componentLinks) {
+    const { inputPath = null, updateSource = false, saveAnnotatedCopy = undefined, } = options;
+    if (inputPath && (updateSource || saveAnnotatedCopy !== undefined)) {
+        const refdesVisitor = new RefdesAnnotationVisitor(true, scriptData, tokens, componentLinks);
+        await refdesVisitor.visitAsync(tree);
+        let usePath = inputPath;
+        if (saveAnnotatedCopy === true) {
+            const dir = path.dirname(inputPath);
+            const ext = path.extname(inputPath);
+            const basename = path.basename(inputPath, ext);
+            usePath = path.join(dir, `${basename}.annotated${ext}`);
+        }
+        else if (typeof saveAnnotatedCopy === 'string') {
+            usePath = saveAnnotatedCopy;
+        }
+        console.log('Annotations saved to ' + usePath);
+        writeFileSync(usePath, refdesVisitor.getOutput());
+    }
+}
 export async function renderScript(scriptData, outputPath, options) {
     const parseHandlers = [
         new KiCadNetListOutputHandler(),
     ];
-    return renderScriptCustom(scriptData, outputPath, options, parseHandlers);
+    return renderScriptCustom(scriptData, outputPath, options, parseHandlers, [DefaultPostAnnotationCallback]);
 }
-export async function renderScriptCustom(scriptData, outputPath, options, parseHandlers) {
-    const { dumpNets = false, dumpData = false, showStats = false, enableErc = false, enableBom = false, bomOutputPath = undefined, environment, inputPath = null, updateSource = false, saveAnnotatedCopy = undefined, } = options;
+export async function renderScriptCustom(scriptData, outputPath, options, parseHandlers, postAnnotationCallbacks) {
+    const { dumpNets = false, dumpData = false, showStats = false, enableErc = false, enableBom = false, bomOutputPath = undefined, environment } = options;
     const errors = [];
     const onErrorHandler = (message, context, error) => {
         if (error && error instanceof RuntimeExecutionError) {
@@ -211,22 +230,9 @@ export async function renderScriptCustom(scriptData, outputPath, options, parseH
     catch (err) {
         throw new RenderError(`Error during component annotation: ${err}`, 'annotation');
     }
-    if (inputPath && (updateSource || saveAnnotatedCopy !== undefined)) {
-        const componentLinks = visitor.getComponentCtxLinks();
-        const refdesVisitor = new RefdesAnnotationVisitor(true, scriptData, tokens, componentLinks);
-        await refdesVisitor.visitAsync(tree);
-        let usePath = inputPath;
-        if (saveAnnotatedCopy === true) {
-            const dir = path.dirname(inputPath);
-            const ext = path.extname(inputPath);
-            const basename = path.basename(inputPath, ext);
-            usePath = path.join(dir, `${basename}.annotated${ext}`);
-        }
-        else if (typeof saveAnnotatedCopy === 'string') {
-            usePath = saveAnnotatedCopy;
-        }
-        console.log('Annotations saved to ' + usePath);
-        writeFileSync(usePath, refdesVisitor.getOutput());
+    const componentLinks = visitor.getComponentCtxLinks();
+    for (let i = 0; i < postAnnotationCallbacks.length; i++) {
+        await postAnnotationCallbacks[i](options, scriptData, tree, tokens, componentLinks);
     }
     if (dumpNets) {
         const nets = visitor.dumpNets();

package/dist/types/helpers.d.ts

@@ -1,14 +1,16 @@
 import { BaseError } from "./utils.js";
 import { ParserVisitor } from "./visitor.js";
+import { ParserRuleContext } from "antlr4ng";
 import { SymbolValidatorVisitor } from "./validate/SymbolValidatorVisitor.js";
 import { CommonTokenStream, DefaultErrorStrategy, Parser } from "antlr4ng";
-import { CircuitScriptParser } from "./antlr/CircuitScriptParser.js";
+import { CircuitScriptParser, ScriptContext } from "./antlr/CircuitScriptParser.js";
 import { CircuitScriptLexer } from "./antlr/CircuitScriptLexer.js";
 import { IParsedToken, SemanticTokensVisitor } from "./SemanticTokenVisitor.js";
 import { LengthUnit } from "./globals.js";
 export type SVGWindow = any;
 import { NumericValue } from "./objects/ParamDefinition.js";
 import { NodeScriptEnvironment } from "./environment.js";
+import { ClassComponent } from "./objects/ClassComponent.js";
 export declare enum JSModuleType {
     CommonJs = "cjs",
     ESM = "mjs"
@@ -44,7 +46,7 @@ type RenderScriptReturn = {
     errors: BaseError[];
 };
 export declare function renderScript(scriptData: string, outputPath: string | null, options: ScriptOptions): Promise<RenderScriptReturn>;
-export declare function renderScriptCustom(scriptData: string, outputPath: string | null, options: ScriptOptions, parseHandlers: ParseOutputHandler[]): Promise<RenderScriptReturn>;
+export declare function renderScriptCustom(scriptData: string, outputPath: string | null, options: ScriptOptions, parseHandlers: ParseOutputHandler[], postAnnotationCallbacks: ((options: ScriptOptions, scriptData: string, tree: ScriptContext, tokens: CommonTokenStream, componentLinks: Map<ParserRuleContext, ClassComponent>) => void)[]): Promise<RenderScriptReturn>;
 export declare abstract class ParseOutputHandler {
     beforeRender: boolean;
     afterRender: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "circuitscript",
-    "version": "0.1.24",
+    "version": "0.1.25",
     "description": "Interpreter for the circuitscript language",
     "homepage": "https://circuitscript.net",
     "engines": {