circuitscript 0.1.17 → 0.1.18

package/dist/cjs/execute.js

@@ -364,13 +364,12 @@ class ExecutionContext {
         if (pinId === null) {
             usePinId = component.getDefaultPin();
         }
+        else if (component.hasPin(pinId)) {
+            usePinId = component.getPin(pinId);
+        }
         else {
-            if (component.hasPin(pinId)) {
-                usePinId = component.getPin(pinId);
-            }
-            else {
-                throw 'Invalid pin number ' + pinId + ' in ' + component;
-            }
+            throw new utils_js_1.RuntimeExecutionError('Invalid pin number '
+                + pinId + ' in ' + component);
         }
         this.scope.setCurrent(component, usePinId);
         if (!this.scope.hasNet(component, pinId)) {

package/dist/cjs/export.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SExpObject = exports._id = exports.IdObject = exports.printTree = exports.generateKiCADNetList = void 0;
+exports.SExpObject = exports._id = exports.IdObject = exports.printTree = exports.generateKiCadNetList = void 0;
 const globals_js_1 = require("./globals.js");
 const ParamDefinition_js_1 = require("./objects/ParamDefinition.js");
-function generateKiCADNetList(netlist) {
+function generateKiCadNetList(netlist) {
     const componentsList = [];
     const nets = {};
     const missingFootprints = [];
@@ -81,7 +81,7 @@ function generateKiCADNetList(netlist) {
         missingFootprints
     };
 }
-exports.generateKiCADNetList = generateKiCADNetList;
+exports.generateKiCadNetList = generateKiCadNetList;
 function printTree(tree, level = 0) {
     const output = [];
     if (!Array.isArray(tree)) {

package/dist/cjs/helpers.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPaperSize = exports.isSupportedPaperSize = exports.PaperGridReferences = exports.pxToMM = exports.milsToMM = exports.UnitDimension = exports.detectJSModuleType = exports.renderScript = exports.validateScript = exports.ParseErrorStrategy = exports.getSemanticTokens = exports.prepareFile = exports.JSModuleType = void 0;
+exports.getPaperSize = exports.isSupportedPaperSize = exports.PaperGridReferences = exports.pxToMM = exports.milsToMM = exports.UnitDimension = exports.detectJSModuleType = exports.KiCadNetListOutputHandler = exports.ParseOutputHandler = exports.renderScriptCustom = exports.renderScript = exports.validateScript = exports.ParseErrorStrategy = exports.getSemanticTokens = exports.prepareFile = exports.JSModuleType = void 0;
 const fs_1 = require("fs");
 const path_1 = __importDefault(require("path"));
 const pdfkit_1 = __importDefault(require("pdfkit"));
@@ -158,6 +158,13 @@ async function validateScript(filePath, scriptData, options) {
 }
 exports.validateScript = validateScript;
 async function renderScript(scriptData, outputPath, options) {
+    const parseHandlers = [
+        new KiCadNetListOutputHandler(),
+    ];
+    return renderScriptCustom(scriptData, outputPath, options, parseHandlers);
+}
+exports.renderScript = renderScript;
+async function renderScriptCustom(scriptData, outputPath, options, parseHandlers) {
     const { dumpNets = false, dumpData = false, showStats = false, environment } = options;
     const errors = [];
     const onErrorHandler = (message, context, error) => {
@@ -206,6 +213,12 @@ async function renderScript(scriptData, outputPath, options) {
     (0, utils_js_1.printWarnings)(visitor.getWarnings());
     showStats && console.log('Lexing took:', lexerTimeTaken);
     showStats && console.log('Parsing took:', parserTimeTaken);
+    try {
+        visitor.annotateComponents();
+    }
+    catch (err) {
+        throw new utils_js_1.RenderError(`Error during component annotation: ${err}`, 'annotation');
+    }
     if (dumpNets) {
         const nets = visitor.dumpNets();
         nets.forEach(item => console.log(item.join(" | ")));
@@ -218,12 +231,6 @@ async function renderScript(scriptData, outputPath, options) {
     let svgOutput = "";
     if (errors.length === 0) {
         const { frameComponent } = visitor.applySheetFrameComponent();
-        try {
-            visitor.annotateComponents();
-        }
-        catch (err) {
-            throw new utils_js_1.RenderError(`Error during component annotation: ${err}`, 'annotation');
-        }
         const { sequence, nets } = visitor.getGraph();
         const tmpSequence = (0, utils_js_1.generateDebugSequenceAction)(sequence).map(item => (0, utils_js_1.sequenceActionString)(item));
         dumpData && (0, fs_1.writeFileSync)(dumpDirectory + 'raw-sequence.txt', tmpSequence.join('\n'));
@@ -232,21 +239,18 @@ async function renderScript(scriptData, outputPath, options) {
             let outputDefaultZoom = globals_js_1.defaultZoomScale;
             if (outputPath) {
                 fileExtension = path_1.default.extname(outputPath).substring(1);
-                if (fileExtension === "pdf") {
-                    outputDefaultZoom = 1;
-                }
             }
-            if (fileExtension === 'net') {
-                const { tree: kicadNetList, missingFootprints } = (0, export_js_1.generateKiCADNetList)(visitor.getNetList());
-                missingFootprints.forEach(entry => {
-                    console.log(`${entry.refdes} (${entry.instanceName}) does not have footprint`);
-                });
-                (0, fs_1.writeFileSync)(outputPath, (0, export_js_1.printTree)(kicadNetList));
-                console.log('Generated file', outputPath);
-                return {
-                    svgOutput: null,
-                    errors,
-                };
+            for (let i = 0; i < parseHandlers.length; i++) {
+                const handler = parseHandlers[i];
+                if (handler.beforeRender) {
+                    const keepParsing = handler.parse(visitor, outputPath, fileExtension);
+                    if (!keepParsing) {
+                        return {
+                            svgOutput: null,
+                            errors
+                        };
+                    }
+                }
             }
             const logger = new logger_js_1.Logger();
             const graphEngine = new graph_js_1.NetGraph(logger);
@@ -275,6 +279,9 @@ async function renderScript(scriptData, outputPath, options) {
             showStats && console.log('Render took:', generateSvgTimer.lap());
             dumpData && (0, fs_1.writeFileSync)(dumpDirectory + 'raw-render.txt', renderLogger.dump());
             try {
+                if (fileExtension === "pdf") {
+                    outputDefaultZoom = 1;
+                }
                 svgOutput = (0, render_js_1.generateSvgOutput)(svgCanvas, outputDefaultZoom);
             }
             catch (err) {
@@ -325,7 +332,33 @@ async function renderScript(scriptData, outputPath, options) {
         errors
     };
 }
-exports.renderScript = renderScript;
+exports.renderScriptCustom = renderScriptCustom;
+class ParseOutputHandler {
+    constructor() {
+        this.beforeRender = false;
+        this.afterRender = false;
+    }
+}
+exports.ParseOutputHandler = ParseOutputHandler;
+class KiCadNetListOutputHandler extends ParseOutputHandler {
+    constructor() {
+        super(...arguments);
+        this.beforeRender = true;
+    }
+    parse(visitor, outputPath, fileExtension) {
+        if (outputPath !== null && fileExtension === "net") {
+            const { tree: kiCadNetList, missingFootprints } = (0, export_js_1.generateKiCadNetList)(visitor.getNetList());
+            missingFootprints.forEach(entry => {
+                console.log(`${entry.refdes} (${entry.instanceName}) does not have footprint`);
+            });
+            (0, fs_1.writeFileSync)(outputPath, (0, export_js_1.printTree)(kiCadNetList));
+            console.log('Generated file', outputPath);
+            return false;
+        }
+        return true;
+    }
+}
+exports.KiCadNetListOutputHandler = KiCadNetListOutputHandler;
 function detectJSModuleType() {
     if (typeof __filename === 'undefined' &&
         typeof __dirname === 'undefined') {

package/dist/cjs/objects/ExecutionScope.js

@@ -87,8 +87,8 @@ class ExecutionScope {
         const sortedNet = [...this.nets].sort((a, b) => {
             const netA = a[2];
             const netB = b[2];
-            const netAId = netA.namespace + netA.name;
-            const netBId = netB.namespace + b[2].name;
+            const netAId = netA.toString();
+            const netBId = netB.toString();
             if (netAId > netBId) {
                 return 1;
             }

package/dist/cjs/objects/Net.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Net = void 0;
+const types_js_1 = require("./types.js");
 class Net {
-    constructor(namespace, name, priority = 0, type = 'any') {
+    constructor(namespace, name, priority = 0, type = types_js_1.NetTypes.Any) {
         this.params = new Map();
         if (namespace.indexOf(' ') !== -1) {
             throw "Invalid net namespace provided";

package/dist/cjs/objects/types.js

@@ -112,6 +112,7 @@ var TypeProps;
     TypeProps["Net"] = "net";
     TypeProps["Port"] = "port";
     TypeProps["Graphic"] = "graphic";
+    TypeProps["Module"] = "module";
     TypeProps["Resistor"] = "res";
     TypeProps["Capacitor"] = "cap";
     TypeProps["Inductor"] = "ind";

package/dist/cjs/visitor.js

@@ -1380,8 +1380,28 @@ class ParserVisitor extends BaseVisitor_js_1.BaseVisitor {
                 this.log('Failed to annotate:', instance.instanceName);
             }
         });
-        this.log('===== annotate done =====');
-        this.log('');
+        this.log('===== annotate components done =====');
+        this.log('===== rename nets =====');
+        this.renameNetsWithRefdes();
+        this.log('===== rename nets done =====');
+    }
+    renameNetsWithRefdes() {
+        const nets = this.getScope().getNets();
+        const seenNets = [];
+        const uniqueNets = new Set(nets.map(([, , net]) => net));
+        const fullNetNames = Array.from(uniqueNets).map(item => item.toString());
+        nets.forEach(([component, pin, net]) => {
+            if (net.priority === 0 && seenNets.indexOf(net) === -1
+                && component.typeProp !== types_js_1.TypeProps.Module
+                && component.typeProp !== types_js_1.TypeProps.Net) {
+                net.name = net.baseName =
+                    `NET-(${component.assignedRefDes}-${pin.toString()})`;
+                if (fullNetNames.indexOf(net.toString()) !== -1) {
+                    throw new utils_js_2.RuntimeExecutionError('Net renaming failed due to clash: ' + net);
+                }
+                seenNets.push(net);
+            }
+        });
     }
     applySheetFrameComponent() {
         const baseScope = this.getScope();

package/dist/esm/execute.js

@@ -369,13 +369,12 @@ export class ExecutionContext {
         if (pinId === null) {
             usePinId = component.getDefaultPin();
         }
+        else if (component.hasPin(pinId)) {
+            usePinId = component.getPin(pinId);
+        }
         else {
-            if (component.hasPin(pinId)) {
-                usePinId = component.getPin(pinId);
-            }
-            else {
-                throw 'Invalid pin number ' + pinId + ' in ' + component;
-            }
+            throw new RuntimeExecutionError('Invalid pin number '
+                + pinId + ' in ' + component);
         }
         this.scope.setCurrent(component, usePinId);
         if (!this.scope.hasNet(component, pinId)) {

package/dist/esm/export.js

@@ -1,6 +1,6 @@
 import { NoNetText } from "./globals.js";
 import { NumericValue } from "./objects/ParamDefinition.js";
-export function generateKiCADNetList(netlist) {
+export function generateKiCadNetList(netlist) {
     const componentsList = [];
     const nets = {};
     const missingFootprints = [];

package/dist/esm/helpers.js

@@ -1,7 +1,7 @@
 import { writeFileSync, createWriteStream, existsSync, mkdirSync } from "fs";
 import path from "path";
 import PDFDocument from "pdfkit";
-import { generateKiCADNetList, printTree } from "./export.js";
+import { generateKiCadNetList, printTree } from "./export.js";
 import { LayoutEngine } from "./layout.js";
 import { parseFileWithVisitor } from "./parser.js";
 import { generatePdfOutput, generateSvgOutput, renderSheetsToSVG } from "./render.js";
@@ -148,6 +148,12 @@ export async function validateScript(filePath, scriptData, options) {
     return visitorResolver;
 }
 export async function renderScript(scriptData, outputPath, options) {
+    const parseHandlers = [
+        new KiCadNetListOutputHandler(),
+    ];
+    return renderScriptCustom(scriptData, outputPath, options, parseHandlers);
+}
+export async function renderScriptCustom(scriptData, outputPath, options, parseHandlers) {
     const { dumpNets = false, dumpData = false, showStats = false, environment } = options;
     const errors = [];
     const onErrorHandler = (message, context, error) => {
@@ -196,6 +202,12 @@ export async function renderScript(scriptData, outputPath, options) {
     printWarnings(visitor.getWarnings());
     showStats && console.log('Lexing took:', lexerTimeTaken);
     showStats && console.log('Parsing took:', parserTimeTaken);
+    try {
+        visitor.annotateComponents();
+    }
+    catch (err) {
+        throw new RenderError(`Error during component annotation: ${err}`, 'annotation');
+    }
     if (dumpNets) {
         const nets = visitor.dumpNets();
         nets.forEach(item => console.log(item.join(" | ")));
@@ -208,12 +220,6 @@ export async function renderScript(scriptData, outputPath, options) {
     let svgOutput = "";
     if (errors.length === 0) {
         const { frameComponent } = visitor.applySheetFrameComponent();
-        try {
-            visitor.annotateComponents();
-        }
-        catch (err) {
-            throw new RenderError(`Error during component annotation: ${err}`, 'annotation');
-        }
         const { sequence, nets } = visitor.getGraph();
         const tmpSequence = generateDebugSequenceAction(sequence).map(item => sequenceActionString(item));
         dumpData && writeFileSync(dumpDirectory + 'raw-sequence.txt', tmpSequence.join('\n'));
@@ -222,21 +228,18 @@ export async function renderScript(scriptData, outputPath, options) {
             let outputDefaultZoom = defaultZoomScale;
             if (outputPath) {
                 fileExtension = path.extname(outputPath).substring(1);
-                if (fileExtension === "pdf") {
-                    outputDefaultZoom = 1;
-                }
             }
-            if (fileExtension === 'net') {
-                const { tree: kicadNetList, missingFootprints } = generateKiCADNetList(visitor.getNetList());
-                missingFootprints.forEach(entry => {
-                    console.log(`${entry.refdes} (${entry.instanceName}) does not have footprint`);
-                });
-                writeFileSync(outputPath, printTree(kicadNetList));
-                console.log('Generated file', outputPath);
-                return {
-                    svgOutput: null,
-                    errors,
-                };
+            for (let i = 0; i < parseHandlers.length; i++) {
+                const handler = parseHandlers[i];
+                if (handler.beforeRender) {
+                    const keepParsing = handler.parse(visitor, outputPath, fileExtension);
+                    if (!keepParsing) {
+                        return {
+                            svgOutput: null,
+                            errors
+                        };
+                    }
+                }
             }
             const logger = new Logger();
             const graphEngine = new NetGraph(logger);
@@ -265,6 +268,9 @@ export async function renderScript(scriptData, outputPath, options) {
             showStats && console.log('Render took:', generateSvgTimer.lap());
             dumpData && writeFileSync(dumpDirectory + 'raw-render.txt', renderLogger.dump());
             try {
+                if (fileExtension === "pdf") {
+                    outputDefaultZoom = 1;
+                }
                 svgOutput = generateSvgOutput(svgCanvas, outputDefaultZoom);
             }
             catch (err) {
@@ -315,6 +321,25 @@ export async function renderScript(scriptData, outputPath, options) {
         errors
     };
 }
+export class ParseOutputHandler {
+    beforeRender = false;
+    afterRender = false;
+}
+export class KiCadNetListOutputHandler extends ParseOutputHandler {
+    beforeRender = true;
+    parse(visitor, outputPath, fileExtension) {
+        if (outputPath !== null && fileExtension === "net") {
+            const { tree: kiCadNetList, missingFootprints } = generateKiCadNetList(visitor.getNetList());
+            missingFootprints.forEach(entry => {
+                console.log(`${entry.refdes} (${entry.instanceName}) does not have footprint`);
+            });
+            writeFileSync(outputPath, printTree(kiCadNetList));
+            console.log('Generated file', outputPath);
+            return false;
+        }
+        return true;
+    }
+}
 export function detectJSModuleType() {
     if (typeof __filename === 'undefined' &&
         typeof __dirname === 'undefined') {

package/dist/esm/objects/ExecutionScope.js

@@ -86,8 +86,8 @@ export class ExecutionScope {
         const sortedNet = [...this.nets].sort((a, b) => {
             const netA = a[2];
             const netB = b[2];
-            const netAId = netA.namespace + netA.name;
-            const netBId = netB.namespace + b[2].name;
+            const netAId = netA.toString();
+            const netBId = netB.toString();
             if (netAId > netBId) {
                 return 1;
             }

package/dist/esm/objects/Net.js

@@ -1,3 +1,4 @@
+import { NetTypes } from "./types.js";
 export class Net {
     name;
     baseName;
@@ -5,7 +6,7 @@ export class Net {
     priority;
     type;
     params = new Map();
-    constructor(namespace, name, priority = 0, type = 'any') {
+    constructor(namespace, name, priority = 0, type = NetTypes.Any) {
         if (namespace.indexOf(' ') !== -1) {
             throw "Invalid net namespace provided";
         }

package/dist/esm/objects/types.js

@@ -111,6 +111,7 @@ export var TypeProps;
     TypeProps["Net"] = "net";
     TypeProps["Port"] = "port";
     TypeProps["Graphic"] = "graphic";
+    TypeProps["Module"] = "module";
     TypeProps["Resistor"] = "res";
     TypeProps["Capacitor"] = "cap";
     TypeProps["Inductor"] = "ind";

package/dist/esm/visitor.js

@@ -1374,8 +1374,28 @@ export class ParserVisitor extends BaseVisitor {
                 this.log('Failed to annotate:', instance.instanceName);
             }
         });
-        this.log('===== annotate done =====');
-        this.log('');
+        this.log('===== annotate components done =====');
+        this.log('===== rename nets =====');
+        this.renameNetsWithRefdes();
+        this.log('===== rename nets done =====');
+    }
+    renameNetsWithRefdes() {
+        const nets = this.getScope().getNets();
+        const seenNets = [];
+        const uniqueNets = new Set(nets.map(([, , net]) => net));
+        const fullNetNames = Array.from(uniqueNets).map(item => item.toString());
+        nets.forEach(([component, pin, net]) => {
+            if (net.priority === 0 && seenNets.indexOf(net) === -1
+                && component.typeProp !== TypeProps.Module
+                && component.typeProp !== TypeProps.Net) {
+                net.name = net.baseName =
+                    `NET-(${component.assignedRefDes}-${pin.toString()})`;
+                if (fullNetNames.indexOf(net.toString()) !== -1) {
+                    throw new RuntimeExecutionError('Net renaming failed due to clash: ' + net);
+                }
+                seenNets.push(net);
+            }
+        });
     }
     applySheetFrameComponent() {
         const baseScope = this.getScope();

package/dist/types/export.d.ts

@@ -1,12 +1,12 @@
 import { NetListItem } from "./visitor.js";
-export declare function generateKiCADNetList(netlist: NetListItem[]): {
+export declare function generateKiCadNetList(netlist: NetListItem[]): {
     tree: SExp;
     missingFootprints: {
         refdes: string;
         instanceName: string;
     }[];
 };
-export declare function printTree(tree: (IdObject | string)[] | string, level?: number): string;
+export declare function printTree(tree: any, level?: number): string;
 export declare class IdObject {
     keyName: string;
     constructor(keyName: string);

package/dist/types/helpers.d.ts

@@ -1,4 +1,5 @@
 import { BaseError } from "./utils.js";
+import { ParserVisitor } from "./visitor.js";
 import { SymbolValidatorVisitor } from "./validate/SymbolValidatorVisitor.js";
 import { CommonTokenStream, DefaultErrorStrategy, Parser } from "antlr4ng";
 import { CircuitScriptParser } from "./antlr/CircuitScriptParser.js";
@@ -32,10 +33,21 @@ export declare class ParseErrorStrategy extends DefaultErrorStrategy {
     reportUnwantedToken(recognizer: Parser): void;
 }
 export declare function validateScript(filePath: string, scriptData: string, options: ScriptOptions): Promise<SymbolValidatorVisitor>;
-export declare function renderScript(scriptData: string, outputPath: string | null, options: ScriptOptions): Promise<{
+type RenderScriptReturn = {
     svgOutput: string | null;
     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 abstract class ParseOutputHandler {
+    beforeRender: boolean;
+    afterRender: boolean;
+    abstract parse(visitor: ParserVisitor, outputPath: string | null, fileExtension: string | null): boolean;
+}
+export declare class KiCadNetListOutputHandler extends ParseOutputHandler {
+    beforeRender: boolean;
+    parse(visitor: ParserVisitor, outputPath: string | null, fileExtension: string | null): boolean;
+}
 export declare function detectJSModuleType(): JSModuleType;
 export declare class UnitDimension {
     type: LengthUnit;
@@ -60,3 +72,4 @@ export declare function getPaperSize(type: string, margin?: number): {
     originalWidthMM: number;
     originalHeightMM: number;
 };
+export {};

package/dist/types/objects/ExecutionScope.d.ts

@@ -28,7 +28,7 @@ export declare class ExecutionScope {
     netCounter: number;
     unnamedCounter: number;
     currentComponent: ClassComponent | null;
-    currentPin: number | null;
+    currentPin: PinId | null;
     currentWireId: number;
     currentFrameId: number;
     componentRoot: ClassComponent | null;
@@ -50,7 +50,7 @@ export declare class ExecutionScope {
     setVariable(name: string, value: any): void;
     setActive(type: ActiveObject, item: any): void;
     clearActive(): void;
-    setCurrent(component: ClassComponent | null, pin?: number | null): void;
+    setCurrent(component: ClassComponent | null, pin?: PinId | null): void;
     enterContext(context: ParserRuleContext): void;
     exitContext(): ParserRuleContext;
     private findPropertyKeyTree;

package/dist/types/objects/Net.d.ts

@@ -1,11 +1,12 @@
+import { NetTypes } from "./types.js";
 export declare class Net {
     name: string;
     baseName: string;
     namespace: string;
     priority: number;
-    type: string;
+    type: NetTypes;
     params: Map<string, any>;
-    constructor(namespace: string, name: string, priority?: number, type?: string);
+    constructor(namespace: string, name: string, priority?: number, type?: NetTypes);
     toString(): string;
     static isSame(netA: Net, netB: Net): boolean;
 }

package/dist/types/objects/types.d.ts

@@ -38,7 +38,7 @@ export type ComponentPinWireId = [
 ];
 export type ComponentPin = [
     component: ClassComponent,
-    pinId: number | string
+    pinId: PinId
 ];
 export type ComplexType = ValueType | ClassComponent | UndeclaredReference | null;
 export type ValueType = boolean | number | string | NumericValue | PercentageValue;
@@ -100,6 +100,7 @@ export declare enum TypeProps {
     Net = "net",
     Port = "port",
     Graphic = "graphic",
+    Module = "module",
     Resistor = "res",
     Capacitor = "cap",
     Inductor = "ind",

package/dist/types/visitor.d.ts

@@ -80,6 +80,7 @@ export declare class ParserVisitor extends BaseVisitor {
         nets: ComponentPinNetPair[];
     };
     annotateComponents(): void;
+    private renameNetsWithRefdes;
     applySheetFrameComponent(): {
         frameComponent: ClassComponent | null;
     };

package/package.json

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