circuitscript 0.0.32 → 0.0.35

package/dist/esm/antlr/CircuitScriptVisitor.mjs

@@ -24,11 +24,14 @@ export class CircuitScriptVisitor extends AbstractParseTreeVisitor {
     visitAt_block_pin_expression_simple;
     visitAt_block_pin_expression_complex;
     visitBreak_keyword;
+    visitContinue_keyword;
     visitAssignment_expr;
+    visitOperator_assignment_expr;
     visitKeyword_assignment_expr;
     visitParameters;
     visitProperty_set_expr;
     visitDouble_dot_property_set_expr;
+    visitArrayExpr;
     visitFunctionCallExpr;
     visitAdditionExpr;
     visitMultiplyExpr;
@@ -51,22 +54,26 @@ export class CircuitScriptVisitor extends AbstractParseTreeVisitor {
     visitFunction_return_expr;
     visitProperty_block_expr;
     visitCreate_component_expr;
+    visitGraphic_expressions_block;
     visitCreate_graphic_expr;
     visitCreate_module_expr;
     visitNested_properties_inner;
-    visitGraphic_expr;
+    visitGraphicCommandExpr;
+    visitGraphicForExpr;
     visitProperty_expr;
     visitProperty_key_expr;
     visitNested_properties;
     visitSingle_line_property;
-    visitBlank_expr;
     visitWire_expr_direction_value;
     visitWire_expr_direction_only;
     visitWire_expr;
+    visitArray_expr;
     visitPoint_expr;
     visitImport_expr;
     visitFrame_expr;
     visitIf_expr;
     visitIf_inner_expr;
     visitElse_expr;
+    visitWhile_expr;
+    visitFor_expr;
 }

package/dist/esm/draw_symbols.mjs

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

package/dist/esm/execute.mjs

@@ -443,12 +443,16 @@ export 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);
@@ -780,9 +784,9 @@ export class ExecutionContext {
             }
         }
     }
-    enterFrame() {
+    enterFrame(frameType) {
         const frameId = this.scope.frames.length + 1;
-        const frameObject = new Frame(frameId);
+        const frameObject = new Frame(frameId, frameType);
         this.log('Enter frame', frameId);
         this.scope.frames.push(frameObject);
         this.scope.sequence.push([SequenceAction.Frame,
@@ -846,10 +850,8 @@ export 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/esm/globals.mjs

@@ -47,6 +47,8 @@ export const defaultSymbolLineWidth = MilsToMM * 6;
 export const defaultWireLineWidth = MilsToMM * 6;
 export const defaultPinNameTextSize = 40;
 export const defaultPinIdTextSize = 30;
+export const defaultPageMarginMM = 10;
+export const defaultPageSpacingMM = 10;
 export const CustomSymbolPinTextSize = defaultPinNameTextSize;
 export const CustomSymbolPinIdSize = defaultPinIdTextSize;
 export const CustomSymbolRefDesSize = 50;
@@ -62,7 +64,7 @@ export const PortPaddingHorizontal = MilsToMM * 10;
 export const PortPaddingVertical = MilsToMM * 10;
 export const 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',
@@ -89,3 +91,13 @@ export var BlockTypes;
     BlockTypes[BlockTypes["Parallel"] = 3] = "Parallel";
     BlockTypes[BlockTypes["Point"] = 4] = "Point";
 })(BlockTypes || (BlockTypes = {}));
+export var FrameType;
+(function (FrameType) {
+    FrameType[FrameType["Frame"] = 1] = "Frame";
+    FrameType[FrameType["Sheet"] = 2] = "Sheet";
+})(FrameType || (FrameType = {}));
+export const GlobalDocumentName = 'document';
+export const RenderFlags = {
+    ShowElementFrames: false,
+    ShowOrigin: false,
+};

package/dist/esm/helpers.mjs

@@ -1,11 +1,11 @@
 import { readFileSync, writeFileSync, createWriteStream } from "fs";
+import path from "path";
 import PDFDocument from "pdfkit";
-import SVGtoPDF from "svg-to-pdfkit";
 import { generateKiCADNetList, printTree } from "./export.mjs";
 import { LayoutEngine } from "./layout.mjs";
 import { SequenceAction } from "./objects/ExecutionScope.mjs";
 import { parseFileWithVisitor } from "./parser.mjs";
-import { generateSVG2 } from "./render.mjs";
+import { generatePdfOutput, generateSvgOutput, renderSheetsToSVG } from "./render.mjs";
 import { SimpleStopwatch } from "./utils.mjs";
 import { ParserVisitor, VisitorExecutionException } from "./visitor.mjs";
 import { createContext } from "this-file";
@@ -14,8 +14,8 @@ import { BaseErrorListener, CharStream, CommonTokenStream, DefaultErrorStrategy
 import { MainLexer } from "./lexer.mjs";
 import { CircuitScriptParser } from "./antlr/CircuitScriptParser.mjs";
 import { prepareTokens, SemanticTokensVisitor } from "./SemanticTokenVisitor.mjs";
-import path from "path";
-import { LengthUnit, MilsToMM, MMToPt, PxToMM } from "./globals.mjs";
+import { defaultPageMarginMM, defaultZoomScale, LengthUnit, MilsToMM, PxToMM } from "./globals.mjs";
+import { FrameParamKeys } from "./objects/Frame.mjs";
 export var JSModuleType;
 (function (JSModuleType) {
     JSModuleType["CommonJs"] = "cjs";
@@ -176,6 +176,7 @@ export function renderScript(scriptData, outputPath, options) {
         console.log('Error while parsing');
         return null;
     }
+    const { frameComponent } = visitor.applySheetFrameComponent();
     try {
         visitor.annotateComponents();
     }
@@ -208,43 +209,43 @@ export function renderScript(scriptData, outputPath, options) {
         return tmp.join(" | ");
     });
     dumpData && writeFileSync('dump/raw-sequence.txt', tmpSequence.join('\n'));
-    let svgOutput = null;
+    let svgOutput = "";
     try {
         let fileExtension = null;
-        let showBaseFrame = false;
+        let outputDefaultZoom = defaultZoomScale;
         if (outputPath) {
             fileExtension = path.extname(outputPath).substring(1);
-            if (fileExtension === 'pdf') {
-                showBaseFrame = true;
+            if (fileExtension === "pdf") {
+                outputDefaultZoom = 1;
             }
         }
-        const layoutEngine = new LayoutEngine({
-            showBaseFrame,
-        });
+        const layoutEngine = new LayoutEngine();
         const layoutTimer = new SimpleStopwatch();
-        const graph = layoutEngine.runLayout(sequence, nets);
+        const sheetFrames = layoutEngine.runLayout(sequence, nets);
         layoutEngine.printWarnings();
         showStats && console.log('Layout took:', layoutTimer.lap());
         dumpData && writeFileSync('dump/raw-layout.txt', layoutEngine.logger.dump());
         const generateSvgTimer = new SimpleStopwatch();
-        const { svg: generatedSvg, width: svgWidth, height: svgHeight } = generateSVG2(graph);
-        svgOutput = generatedSvg;
+        const svgCanvas = renderSheetsToSVG(sheetFrames);
         showStats && console.log('Render took:', generateSvgTimer.lap());
+        svgOutput = generateSvgOutput(svgCanvas, outputDefaultZoom);
         if (outputPath) {
             if (fileExtension === 'svg') {
                 writeFileSync(outputPath, svgOutput);
             }
             else if (fileExtension === 'pdf') {
+                let sheetSize = "A4";
+                let sheetSizeDefined = false;
+                if (frameComponent) {
+                    sheetSize = frameComponent.getParam(FrameParamKeys.PaperSize);
+                    sheetSizeDefined = true;
+                }
                 const doc = new PDFDocument({
                     layout: 'landscape',
-                    size: 'A4',
+                    size: sheetSize
                 });
                 const outputStream = createWriteStream(outputPath);
-                const paperWidthMM = 297;
-                const paperHeightMM = 210;
-                const xOffset = (paperWidthMM - svgWidth) / 2;
-                const yOffset = (paperHeightMM - svgHeight) / 2;
-                SVGtoPDF(doc, svgOutput, xOffset * MMToPt, yOffset * MMToPt);
+                generatePdfOutput(doc, svgCanvas, sheetSize, sheetSizeDefined, outputDefaultZoom);
                 doc.pipe(outputStream);
                 doc.end();
             }
@@ -323,3 +324,43 @@ export function milsToMM(value) {
 export function pxToMM(value) {
     return value * PxToMM;
 }
+const PaperSizes = {
+    'A0': [1189, 841],
+    'A1': [841, 594],
+    'A2': [594, 420],
+    'A3': [420, 297],
+    'A4': [297, 210],
+    'A5': [210, 148],
+    'A6': [148, 105],
+};
+export const PaperGridReferences = {
+    'A0': [16, 24],
+    'A1': [12, 16],
+    'A2': [8, 12],
+    'A3': [6, 8],
+    'A4': [4, 6],
+};
+export function isSupportedPaperSize(type) {
+    if (PaperSizes[type]) {
+        return true;
+    }
+    return false;
+}
+export function getPaperSize(type, margin = 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 / MilsToMM)),
+            height: Math.floor(useHeight * (1 / MilsToMM)),
+            widthMM: useWidth,
+            heightMM: useHeight,
+            originalWidthMM: width,
+            originalHeightMM: height,
+        };
+    }
+    else {
+        return getPaperSize('A4');
+    }
+}

package/dist/esm/layout.mjs

@@ -1,7 +1,7 @@
 import { Graph, alg } from '@dagrejs/graphlib';
-import { SymbolCustom, SymbolDrawing, SymbolFactory, SymbolCustomModule, SymbolPlaceholder, SymbolText } from "./draw_symbols.mjs";
+import { SymbolCustom, SymbolDrawing, SymbolFactory, SymbolCustomModule, SymbolPlaceholder, SymbolText, PlaceHolderCommands } from "./draw_symbols.mjs";
 import { FrameAction, SequenceAction } from "./objects/ExecutionScope.mjs";
-import { defaultFrameTitleTextSize, defaultGridSizeUnits, GlobalNames, ParamKeys, WireAutoDirection } from './globals.mjs';
+import { defaultFrameTitleTextSize, defaultGridSizeUnits, FrameType, GlobalNames, ParamKeys, WireAutoDirection } from './globals.mjs';
 import { NumericValue } from './objects/ParamDefinition.mjs';
 import { Geometry } from './geometry.mjs';
 import { Logger } from './logger.mjs';
@@ -61,38 +61,51 @@ export 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 === 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 = [];
@@ -176,8 +189,14 @@ export 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 === 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 => {
@@ -265,12 +284,33 @@ export class LayoutEngine {
             }
             boundPoints.push([innerFrame.x, innerFrame.y], [innerFrame.x + frameWidth, innerFrame.y + frameHeight]);
         });
-        frame.bounds = resizeBounds(getBoundsFromPoints(boundPoints), frame.padding);
-        if (frame.width !== null) {
-            frame.bounds.xmax = milsToMM(frame.bounds.xmin + frame.width);
+        const contentsBounds = resizeBounds(getBoundsFromPoints(boundPoints), frame.padding);
+        if (frame.frame.parameters.has(FrameParamKeys.SheetFrame)) {
+            const frameComponent = frame.frame.parameters.get(FrameParamKeys.SheetFrame);
+            const rects = ExtractDrawingRects(frameComponent.displayProp);
+            let frameWidth = 0;
+            let frameHeight = 0;
+            if (rects[1]) {
+                frameWidth = milsToMM(rects[1].width);
+                frameHeight = milsToMM(rects[1].height);
+            }
+            const contentsWidth = contentsBounds.xmax - contentsBounds.xmin;
+            const contentsHeight = contentsBounds.ymax - contentsBounds.ymin;
+            const frameOffsetX = toNearestGrid((frameWidth - contentsWidth) / 2, gridSize);
+            const frameOffsetY = 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 = milsToMM(frame.bounds.ymin + frame.height);
+        else {
+            frame.bounds = contentsBounds;
         }
     }
     dumpFrame(frame, level = 0) {
@@ -1257,6 +1297,7 @@ export class RenderFrame extends RenderObject {
     borderWidth = 5;
     width = null;
     height = null;
+    size = null;
     subgraphId = "";
     type;
     containsTitle = false;
@@ -1307,6 +1348,16 @@ export function CalculatePinPositions(component) {
     });
     return pinPositionMapping;
 }
+export function ExtractDrawingRects(drawing) {
+    return drawing.getCommands().filter(item => {
+        return (item[0] === PlaceHolderCommands.rect);
+    }).map(item => {
+        return {
+            width: item[1][2],
+            height: item[1][3],
+        };
+    });
+}
 function isPointOverlap(x, y, other) {
     return (x >= other.x && y >= other.y && x <= (other.x + other.width) && y <= (other.y + other.height));
 }

package/dist/esm/objects/ClassComponent.mjs

@@ -85,6 +85,9 @@ export 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/esm/objects/ExecutionScope.mjs

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

package/dist/esm/objects/Frame.mjs

@@ -1,8 +1,10 @@
 export class Frame {
     parameters = new Map();
     frameId;
-    constructor(frameId) {
+    frameType;
+    constructor(frameId, frameType) {
         this.frameId = frameId;
+        this.frameType = frameType;
     }
 }
 export var FrameParamKeys;
@@ -13,6 +15,8 @@ export var FrameParamKeys;
     FrameParamKeys["Border"] = "border";
     FrameParamKeys["Width"] = "width";
     FrameParamKeys["Height"] = "height";
+    FrameParamKeys["PaperSize"] = "paper_size";
+    FrameParamKeys["SheetFrame"] = "sheet_frame";
 })(FrameParamKeys || (FrameParamKeys = {}));
 export var FramePlotDirection;
 (function (FramePlotDirection) {

package/dist/esm/objects/ParamDefinition.mjs

@@ -32,9 +32,3 @@ export class PercentageValue {
         return this.value.toString();
     }
 }
-export class PinBlankValue {
-    blank;
-    constructor(value) {
-        this.blank = value;
-    }
-}

package/dist/esm/objects/types.mjs

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

package/dist/esm/regenerate-tests.mjs

@@ -26,7 +26,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 = [];