circuitscript 0.0.32 → 0.0.34

package/dist/cjs/draw_symbols.js

@@ -605,6 +605,7 @@ var PlaceHolderCommands;
     PlaceHolderCommands["textColor"] = "textColor";
     PlaceHolderCommands["text"] = "text";
     PlaceHolderCommands["units"] = "units";
+    PlaceHolderCommands["for"] = "for";
 })(PlaceHolderCommands || (exports.PlaceHolderCommands = PlaceHolderCommands = {}));
 class SymbolCustom extends SymbolGraphic {
     constructor(pinDefinition) {

package/dist/cjs/execute.js

@@ -439,12 +439,16 @@ class ExecutionContext {
         this.log('did not find block point');
         return null;
     }
-    breakBranch() {
-        this.log('break branch');
-        const branchesInfo = this.scope.blockStack.get(this.scope.indentLevel - 1);
-        const branchIndex = branchesInfo['block_index'];
-        const branchIndexRef = branchesInfo['inner_blocks'].get(branchIndex);
-        branchIndexRef['ignore_last_net'] = true;
+    addBreakContext(ctx) {
+        this.log('add break context');
+        this.scope.breakStack.push(ctx);
+    }
+    popBreakContext() {
+        this.log('pop break context');
+        return this.scope.breakStack.pop();
+    }
+    getBreakContext() {
+        return this.scope.breakStack[this.scope.breakStack.length - 1];
     }
     createFunction(functionName, __runFunc) {
         this.scope.functions.set(functionName, __runFunc);
@@ -776,9 +780,9 @@ class ExecutionContext {
             }
         }
     }
-    enterFrame() {
+    enterFrame(frameType) {
         const frameId = this.scope.frames.length + 1;
-        const frameObject = new Frame_js_1.Frame(frameId);
+        const frameObject = new Frame_js_1.Frame(frameId, frameType);
         this.log('Enter frame', frameId);
         this.scope.frames.push(frameObject);
         this.scope.sequence.push([ExecutionScope_js_1.SequenceAction.Frame,
@@ -843,10 +847,8 @@ function getPortSide(pins, arrangeProps) {
             }
             let position = 0;
             useItems.forEach(item => {
-                if (typeof item === 'object') {
-                    if (item.blank) {
-                        position += item.blank;
-                    }
+                if (typeof item === 'object' && Array.isArray(item)) {
+                    position += item[0];
                 }
                 if (existingPinIds.indexOf(item) !== -1) {
                     result.push({

package/dist/cjs/globals.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BlockTypes = exports.ReferenceTypes = exports.ComponentTypes = exports.ColorScheme = exports.PortPaddingVertical = exports.PortPaddingHorizontal = exports.PortArrowSize = exports.junctionSize = exports.defaultFontSize = exports.defaultFontBold = exports.defaultFont = exports.displayUnits = exports.defaultFrameTitleTextSize = exports.CustomSymbolParamTextSize = exports.CustomSymbolRefDesSize = exports.CustomSymbolPinIdSize = exports.CustomSymbolPinTextSize = exports.defaultPinIdTextSize = exports.defaultPinNameTextSize = exports.defaultWireLineWidth = exports.defaultSymbolLineWidth = exports.fontDisplayScale = exports.defaultZoomScale = exports.defaultGridSizeUnits = exports.portHeight = exports.portWidth = exports.PxToMM = exports.MMToPt = exports.MMToPx = exports.MilsToMM = exports.WireAutoDirection = exports.LengthUnit = exports.SymbolPinSide = exports.LayoutDirection = exports.ParamKeys = exports.NoNetText = exports.GlobalNames = void 0;
+exports.RenderFlags = exports.GlobalDocumentName = exports.FrameType = exports.BlockTypes = exports.ReferenceTypes = exports.ComponentTypes = exports.ColorScheme = exports.PortPaddingVertical = exports.PortPaddingHorizontal = exports.PortArrowSize = exports.junctionSize = exports.defaultFontSize = exports.defaultFontBold = exports.defaultFont = exports.displayUnits = exports.defaultFrameTitleTextSize = exports.CustomSymbolParamTextSize = exports.CustomSymbolRefDesSize = exports.CustomSymbolPinIdSize = exports.CustomSymbolPinTextSize = exports.defaultPageSpacingMM = exports.defaultPageMarginMM = exports.defaultPinIdTextSize = exports.defaultPinNameTextSize = exports.defaultWireLineWidth = exports.defaultSymbolLineWidth = exports.fontDisplayScale = exports.defaultZoomScale = exports.defaultGridSizeUnits = exports.portHeight = exports.portWidth = exports.PxToMM = exports.MMToPt = exports.MMToPx = exports.MilsToMM = exports.WireAutoDirection = exports.LengthUnit = exports.SymbolPinSide = exports.LayoutDirection = exports.ParamKeys = exports.NoNetText = exports.GlobalNames = void 0;
 var GlobalNames;
 (function (GlobalNames) {
     GlobalNames["__root"] = "__root";
@@ -50,6 +50,8 @@ exports.defaultSymbolLineWidth = exports.MilsToMM * 6;
 exports.defaultWireLineWidth = exports.MilsToMM * 6;
 exports.defaultPinNameTextSize = 40;
 exports.defaultPinIdTextSize = 30;
+exports.defaultPageMarginMM = 10;
+exports.defaultPageSpacingMM = 10;
 exports.CustomSymbolPinTextSize = exports.defaultPinNameTextSize;
 exports.CustomSymbolPinIdSize = exports.defaultPinIdTextSize;
 exports.CustomSymbolRefDesSize = 50;
@@ -65,7 +67,7 @@ exports.PortPaddingHorizontal = exports.MilsToMM * 10;
 exports.PortPaddingVertical = exports.MilsToMM * 10;
 exports.ColorScheme = {
     BodyColor: 'rgb(255, 255, 194)',
-    JunctionColor: 'rgba(0, 132, 0)',
+    JunctionColor: 'rgb(0, 132, 0)',
     WireColor: 'rgb(0, 132, 0)',
     PinLineColor: '#333',
     PinNameColor: '#333',
@@ -92,3 +94,13 @@ var BlockTypes;
     BlockTypes[BlockTypes["Parallel"] = 3] = "Parallel";
     BlockTypes[BlockTypes["Point"] = 4] = "Point";
 })(BlockTypes || (exports.BlockTypes = BlockTypes = {}));
+var FrameType;
+(function (FrameType) {
+    FrameType[FrameType["Frame"] = 1] = "Frame";
+    FrameType[FrameType["Sheet"] = 2] = "Sheet";
+})(FrameType || (exports.FrameType = FrameType = {}));
+exports.GlobalDocumentName = 'document';
+exports.RenderFlags = {
+    ShowElementFrames: false,
+    ShowOrigin: false,
+};

package/dist/cjs/helpers.js

@@ -3,10 +3,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.pxToMM = exports.milsToMM = exports.UnitDimension = exports.getPackageVersion = exports.getDefaultLibsPath = exports.getFontsPath = exports.getCurrentPath = exports.detectJSModuleType = exports.renderScript = exports.validateScript = exports.ParseErrorStrategy = exports.getSemanticTokens = exports.getScriptText = exports.prepareFile = exports.JSModuleType = void 0;
+exports.getPaperSize = exports.isSupportedPaperSize = exports.PaperGridReferences = exports.pxToMM = exports.milsToMM = exports.UnitDimension = exports.getPackageVersion = exports.getDefaultLibsPath = exports.getFontsPath = exports.getCurrentPath = exports.detectJSModuleType = exports.renderScript = exports.validateScript = exports.ParseErrorStrategy = exports.getSemanticTokens = exports.getScriptText = exports.prepareFile = exports.JSModuleType = void 0;
 const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
 const pdfkit_1 = __importDefault(require("pdfkit"));
-const svg_to_pdfkit_1 = __importDefault(require("svg-to-pdfkit"));
 const export_js_1 = require("./export.js");
 const layout_js_1 = require("./layout.js");
 const ExecutionScope_js_1 = require("./objects/ExecutionScope.js");
@@ -20,8 +20,8 @@ const antlr4ng_1 = require("antlr4ng");
 const lexer_js_1 = require("./lexer.js");
 const CircuitScriptParser_js_1 = require("./antlr/CircuitScriptParser.js");
 const SemanticTokenVisitor_js_1 = require("./SemanticTokenVisitor.js");
-const path_1 = __importDefault(require("path"));
 const globals_js_1 = require("./globals.js");
+const Frame_js_1 = require("./objects/Frame.js");
 var JSModuleType;
 (function (JSModuleType) {
     JSModuleType["CommonJs"] = "cjs";
@@ -187,6 +187,7 @@ function renderScript(scriptData, outputPath, options) {
         console.log('Error while parsing');
         return null;
     }
+    const { frameComponent } = visitor.applySheetFrameComponent();
     try {
         visitor.annotateComponents();
     }
@@ -219,43 +220,43 @@ function renderScript(scriptData, outputPath, options) {
         return tmp.join(" | ");
     });
     dumpData && (0, fs_1.writeFileSync)('dump/raw-sequence.txt', tmpSequence.join('\n'));
-    let svgOutput = null;
+    let svgOutput = "";
     try {
         let fileExtension = null;
-        let showBaseFrame = false;
+        let outputDefaultZoom = globals_js_1.defaultZoomScale;
         if (outputPath) {
             fileExtension = path_1.default.extname(outputPath).substring(1);
-            if (fileExtension === 'pdf') {
-                showBaseFrame = true;
+            if (fileExtension === "pdf") {
+                outputDefaultZoom = 1;
             }
         }
-        const layoutEngine = new layout_js_1.LayoutEngine({
-            showBaseFrame,
-        });
+        const layoutEngine = new layout_js_1.LayoutEngine();
         const layoutTimer = new utils_js_1.SimpleStopwatch();
-        const graph = layoutEngine.runLayout(sequence, nets);
+        const sheetFrames = layoutEngine.runLayout(sequence, nets);
         layoutEngine.printWarnings();
         showStats && console.log('Layout took:', layoutTimer.lap());
         dumpData && (0, fs_1.writeFileSync)('dump/raw-layout.txt', layoutEngine.logger.dump());
         const generateSvgTimer = new utils_js_1.SimpleStopwatch();
-        const { svg: generatedSvg, width: svgWidth, height: svgHeight } = (0, render_js_1.generateSVG2)(graph);
-        svgOutput = generatedSvg;
+        const svgCanvas = (0, render_js_1.renderSheetsToSVG)(sheetFrames);
         showStats && console.log('Render took:', generateSvgTimer.lap());
+        svgOutput = (0, render_js_1.generateSvgOutput)(svgCanvas, outputDefaultZoom);
         if (outputPath) {
             if (fileExtension === 'svg') {
                 (0, fs_1.writeFileSync)(outputPath, svgOutput);
             }
             else if (fileExtension === 'pdf') {
+                let sheetSize = "A4";
+                let sheetSizeDefined = false;
+                if (frameComponent) {
+                    sheetSize = frameComponent.getParam(Frame_js_1.FrameParamKeys.PaperSize);
+                    sheetSizeDefined = true;
+                }
                 const doc = new pdfkit_1.default({
                     layout: 'landscape',
-                    size: 'A4',
+                    size: sheetSize
                 });
                 const outputStream = (0, fs_1.createWriteStream)(outputPath);
-                const paperWidthMM = 297;
-                const paperHeightMM = 210;
-                const xOffset = (paperWidthMM - svgWidth) / 2;
-                const yOffset = (paperHeightMM - svgHeight) / 2;
-                (0, svg_to_pdfkit_1.default)(doc, svgOutput, xOffset * globals_js_1.MMToPt, yOffset * globals_js_1.MMToPt);
+                (0, render_js_1.generatePdfOutput)(doc, svgCanvas, sheetSize, sheetSizeDefined, outputDefaultZoom);
                 doc.pipe(outputStream);
                 doc.end();
             }
@@ -341,3 +342,45 @@ function pxToMM(value) {
     return value * globals_js_1.PxToMM;
 }
 exports.pxToMM = pxToMM;
+const PaperSizes = {
+    'A0': [1189, 841],
+    'A1': [841, 594],
+    'A2': [594, 420],
+    'A3': [420, 297],
+    'A4': [297, 210],
+    'A5': [210, 148],
+    'A6': [148, 105],
+};
+exports.PaperGridReferences = {
+    'A0': [16, 24],
+    'A1': [12, 16],
+    'A2': [8, 12],
+    'A3': [6, 8],
+    'A4': [4, 6],
+};
+function isSupportedPaperSize(type) {
+    if (PaperSizes[type]) {
+        return true;
+    }
+    return false;
+}
+exports.isSupportedPaperSize = isSupportedPaperSize;
+function getPaperSize(type, margin = globals_js_1.defaultPageMarginMM) {
+    if (PaperSizes[type]) {
+        const [width, height] = PaperSizes[type];
+        const useWidth = width - margin * 2;
+        const useHeight = height - margin * 2;
+        return {
+            width: Math.floor(useWidth * (1 / globals_js_1.MilsToMM)),
+            height: Math.floor(useHeight * (1 / globals_js_1.MilsToMM)),
+            widthMM: useWidth,
+            heightMM: useHeight,
+            originalWidthMM: width,
+            originalHeightMM: height,
+        };
+    }
+    else {
+        return getPaperSize('A4');
+    }
+}
+exports.getPaperSize = getPaperSize;

package/dist/cjs/layout.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CalculatePinPositions = exports.RenderJunction = exports.RenderFrameType = exports.RenderFrame = exports.RenderText = exports.RenderComponent = exports.RenderWire = exports.RenderObject = exports.getBounds = exports.LayoutEngine = void 0;
+exports.ExtractDrawingRects = exports.CalculatePinPositions = exports.RenderJunction = exports.RenderFrameType = exports.RenderFrame = exports.RenderText = exports.RenderComponent = exports.RenderWire = exports.RenderObject = exports.getBounds = exports.LayoutEngine = void 0;
 const graphlib_1 = require("@dagrejs/graphlib");
 const draw_symbols_js_1 = require("./draw_symbols.js");
 const ExecutionScope_js_1 = require("./objects/ExecutionScope.js");
@@ -63,38 +63,51 @@ class LayoutEngine {
                 this.print('-- items:', item.components);
             });
         }
-        const { textObjects, elementFrames } = this.placeFrames(graph, subgraphInfo, containerFrames);
+        const { elementFrames } = this.placeFrames(graph, subgraphInfo, containerFrames);
         const frameObjects = [...elementFrames, ...containerFrames];
-        const placedComponents = [];
-        const placedWires = [];
-        const tmpNodes = graph.nodes();
-        tmpNodes.forEach(item => {
-            const nodeValue = graph.node(item);
-            const [nodeType, nodeItem] = nodeValue;
-            if (nodeType === RenderItemType.Component) {
-                placedComponents.push(nodeItem);
-            }
-            else if (nodeType === RenderItemType.Wire) {
-                placedWires.push(nodeItem);
-            }
+        const sheetFrames = frameObjects.filter(item => {
+            return item.frame.frameType === globals_js_1.FrameType.Sheet;
+        });
+        if (sheetFrames.length === 0) {
+            sheetFrames.push(containerFrames[0]);
+        }
+        const sheetFrameObjects = sheetFrames.map(sheet => {
+            const items = this.flattenFrameItems(sheet);
+            const components = items.filter(item => item instanceof RenderComponent);
+            const wires = items.filter(item => item instanceof RenderWire);
+            const textObjects = items.filter(item => item instanceof RenderText);
+            const frames = items.filter(item => item instanceof RenderFrame);
+            const wireGroups = new Map();
+            wires.forEach(wire => {
+                const { netName } = wire;
+                if (!wireGroups.has(netName)) {
+                    wireGroups.set(netName, []);
+                }
+                wireGroups.get(netName).push(wire);
+            });
+            const { junctions, mergedWires } = this.findJunctions(wireGroups);
+            return {
+                frame: sheet,
+                frames,
+                components,
+                wires,
+                textObjects,
+                junctions,
+                mergedWires,
+            };
         });
-        const wireGroups = new Map();
-        placedWires.forEach(wire => {
-            const { netName } = wire;
-            if (!wireGroups.has(netName)) {
-                wireGroups.set(netName, []);
+        return sheetFrameObjects;
+    }
+    flattenFrameItems(frame) {
+        const items = [];
+        frame.innerItems.forEach(item => {
+            items.push(item);
+            if (item instanceof RenderFrame) {
+                const inner = this.flattenFrameItems(item);
+                items.push(...inner);
             }
-            wireGroups.get(netName).push(wire);
         });
-        const { junctions, mergedWires } = this.findJunctions(wireGroups);
-        return {
-            components: placedComponents,
-            wires: placedWires,
-            mergedWires,
-            junctions,
-            frameObjects,
-            textObjects,
-        };
+        return items;
     }
     findJunctions(wireGroups) {
         const junctions = [];
@@ -178,8 +191,14 @@ class LayoutEngine {
         this.print(level, "".padStart(level * 4), 'frame', frame.x, frame.y);
         const innerItems = frame.innerItems;
         innerItems.forEach(innerFrame => {
-            innerFrame.x += frame.x;
-            innerFrame.y += frame.y;
+            if (innerFrame.frame.frameType === globals_js_1.FrameType.Sheet) {
+                innerFrame.x = 0;
+                innerFrame.y = 0;
+            }
+            else {
+                innerFrame.x += frame.x;
+                innerFrame.y += frame.y;
+            }
             if (innerFrame.type === RenderFrameType.Elements) {
                 this.print(level, "".padStart(level * 4), 'element frame', innerFrame.x, innerFrame.y);
                 innerFrame.innerItems.forEach(item2 => {
@@ -267,12 +286,33 @@ class LayoutEngine {
             }
             boundPoints.push([innerFrame.x, innerFrame.y], [innerFrame.x + frameWidth, innerFrame.y + frameHeight]);
         });
-        frame.bounds = (0, utils_js_1.resizeBounds)(getBoundsFromPoints(boundPoints), frame.padding);
-        if (frame.width !== null) {
-            frame.bounds.xmax = (0, helpers_js_1.milsToMM)(frame.bounds.xmin + frame.width);
+        const contentsBounds = (0, utils_js_1.resizeBounds)(getBoundsFromPoints(boundPoints), frame.padding);
+        if (frame.frame.parameters.has(Frame_js_1.FrameParamKeys.SheetFrame)) {
+            const frameComponent = frame.frame.parameters.get(Frame_js_1.FrameParamKeys.SheetFrame);
+            const rects = ExtractDrawingRects(frameComponent.displayProp);
+            let frameWidth = 0;
+            let frameHeight = 0;
+            if (rects[1]) {
+                frameWidth = (0, helpers_js_1.milsToMM)(rects[1].width);
+                frameHeight = (0, helpers_js_1.milsToMM)(rects[1].height);
+            }
+            const contentsWidth = contentsBounds.xmax - contentsBounds.xmin;
+            const contentsHeight = contentsBounds.ymax - contentsBounds.ymin;
+            const frameOffsetX = (0, utils_js_1.toNearestGrid)((frameWidth - contentsWidth) / 2, gridSize);
+            const frameOffsetY = (0, utils_js_1.toNearestGrid)((frameHeight - contentsHeight) / 2, gridSize);
+            innerFrames.forEach(innerFrame => {
+                innerFrame.x += frameOffsetX;
+                innerFrame.y += frameOffsetY;
+            });
+            frame.bounds = {
+                xmin: 0,
+                ymin: 0,
+                xmax: frameWidth,
+                ymax: frameHeight
+            };
         }
-        if (frame.height !== null) {
-            frame.bounds.ymax = (0, helpers_js_1.milsToMM)(frame.bounds.ymin + frame.height);
+        else {
+            frame.bounds = contentsBounds;
         }
     }
     dumpFrame(frame, level = 0) {
@@ -1261,6 +1301,7 @@ class RenderFrame extends RenderObject {
         this.borderWidth = 5;
         this.width = null;
         this.height = null;
+        this.size = null;
         this.subgraphId = "";
         this.containsTitle = false;
         this.frame = frame;
@@ -1309,6 +1350,17 @@ function CalculatePinPositions(component) {
     return pinPositionMapping;
 }
 exports.CalculatePinPositions = CalculatePinPositions;
+function ExtractDrawingRects(drawing) {
+    return drawing.getCommands().filter(item => {
+        return (item[0] === draw_symbols_js_1.PlaceHolderCommands.rect);
+    }).map(item => {
+        return {
+            width: item[1][2],
+            height: item[1][3],
+        };
+    });
+}
+exports.ExtractDrawingRects = ExtractDrawingRects;
 function isPointOverlap(x, y, other) {
     return (x >= other.x && y >= other.y && x <= (other.x + other.width) && y <= (other.y + other.height));
 }

package/dist/cjs/objects/ClassComponent.js

@@ -79,6 +79,9 @@ class ClassComponent {
         this.parameters.set(key, value);
         this.refreshParamCache();
     }
+    hasParam(key) {
+        return this.parameters.has(key);
+    }
     refreshParamCache() {
         this._cachedParams =
             JSON.stringify(Object.fromEntries(this.parameters));

package/dist/cjs/objects/ExecutionScope.js

@@ -9,6 +9,7 @@ class ExecutionScope {
         this.variables = new Map();
         this.symbols = new Map();
         this.blockStack = new Map();
+        this.breakStack = [];
         this.wires = [];
         this.frames = [];
         this.indentLevel = 0;

package/dist/cjs/objects/Frame.js

@@ -2,9 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FramePlotDirection = exports.FrameParamKeys = exports.Frame = void 0;
 class Frame {
-    constructor(frameId) {
+    constructor(frameId, frameType) {
         this.parameters = new Map();
         this.frameId = frameId;
+        this.frameType = frameType;
     }
 }
 exports.Frame = Frame;
@@ -16,6 +17,8 @@ var FrameParamKeys;
     FrameParamKeys["Border"] = "border";
     FrameParamKeys["Width"] = "width";
     FrameParamKeys["Height"] = "height";
+    FrameParamKeys["PaperSize"] = "paper_size";
+    FrameParamKeys["SheetFrame"] = "sheet_frame";
 })(FrameParamKeys || (exports.FrameParamKeys = FrameParamKeys = {}));
 var FramePlotDirection;
 (function (FramePlotDirection) {

package/dist/cjs/objects/ParamDefinition.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PinBlankValue = exports.PercentageValue = exports.NumericValue = exports.ParamDefinition = void 0;
+exports.PercentageValue = exports.NumericValue = exports.ParamDefinition = void 0;
 class ParamDefinition {
     constructor(paramName, paramValue) {
         this.paramName = paramName;
@@ -34,9 +34,3 @@ class PercentageValue {
     }
 }
 exports.PercentageValue = PercentageValue;
-class PinBlankValue {
-    constructor(value) {
-        this.blank = value;
-    }
-}
-exports.PinBlankValue = PinBlankValue;

package/dist/cjs/objects/types.js

@@ -5,6 +5,9 @@ class UndeclaredReference {
     constructor(reference) {
         this.reference = reference;
     }
+    throwMessage() {
+        return `Unknown symbol: ${this.reference.name}`;
+    }
 }
 exports.UndeclaredReference = UndeclaredReference;
 class DeclaredReference {
@@ -15,6 +18,9 @@ class DeclaredReference {
         this.type = refType.type;
         this.value = refType.value;
     }
+    toString() {
+        return `[DeclaredReference name: ${this.name} trailers:${this.trailers} found: ${this.found}]`;
+    }
 }
 exports.DeclaredReference = DeclaredReference;
 var ParseSymbolType;

package/dist/cjs/regenerate-tests.js

@@ -31,7 +31,8 @@ async function regenerateTests(extra = "") {
     return cstFiles;
 }
 (async () => {
-    const generateDiff = false;
+    const generateDiff = (process.argv.indexOf('-diff') !== -1);
+    console.log('diff flag: ', generateDiff);
     const nextExtra = generateDiff ? '.next' : '';
     const cstFiles = await regenerateTests(nextExtra);
     const allFiles = [];