circuitscript 0.0.32 → 0.0.34

package/dist/types/layout.d.ts

@@ -1,5 +1,5 @@
 import { Graph, Edge } from '@dagrejs/graphlib';
-import { SymbolGraphic, SymbolText } from "./draw_symbols.js";
+import { SymbolGraphic, SymbolText, SymbolDrawingCommands } from "./draw_symbols.js";
 import { ClassComponent } from "./objects/ClassComponent.js";
 import { SequenceItem } from "./objects/ExecutionScope.js";
 import { WireAutoDirection } from './globals.js';
@@ -19,14 +19,8 @@ export declare class LayoutEngine {
     protected print(...params: any[]): void;
     protected printLevel(level: number, ...params: any[]): void;
     protected padLevel(value: number): string;
-    runLayout(sequence: SequenceItem[], nets: [ClassComponent, pin: number, net: Net][]): {
-        components: RenderComponent[];
-        wires: RenderWire[];
-        junctions: RenderJunction[];
-        mergedWires: MergedWire[];
-        frameObjects: RenderFrame[];
-        textObjects: RenderText[];
-    };
+    runLayout(sequence: SequenceItem[], nets: [ClassComponent, pin: number, net: Net][]): SheetFrame[];
+    private flattenFrameItems;
     findJunctions(wireGroups: Map<string, RenderWire[]>): {
         junctions: RenderJunction[];
         mergedWires: MergedWire[];
@@ -130,6 +124,7 @@ export declare class RenderFrame extends RenderObject {
     borderWidth: number;
     width: number | null;
     height: number | null;
+    size: string | null;
     subgraphId: string;
     type: RenderFrameType;
     containsTitle: boolean;
@@ -145,11 +140,24 @@ export declare class RenderJunction {
     y: number;
     constructor(x: number, y: number);
 }
+export type SheetFrame = {
+    frame: RenderFrame;
+    frames: RenderFrame[];
+    components: RenderComponent[];
+    wires: RenderWire[];
+    textObjects: RenderText[];
+    junctions: RenderJunction[];
+    mergedWires: MergedWire[];
+};
 export declare function CalculatePinPositions(component: ClassComponent): Map<number, {
     x: number;
     y: number;
     angle: number;
 }>;
+export declare function ExtractDrawingRects(drawing: SymbolDrawingCommands): {
+    width: number;
+    height: number;
+}[];
 type SubGraphInfo = {
     firstNodeId: string;
     components: string[];

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

@@ -42,10 +42,11 @@ export declare class ClassComponent {
     getPin(pinId: number | string): PinId;
     getNextPinAfter(pinIndex: number): number;
     setParam(key: string, value: number | string): void;
+    hasParam(key: string): boolean;
     private refreshParamCache;
     private refreshPinsCache;
     refreshCache(): void;
-    getParam(key: string): number | string;
+    getParam<T>(key: string): T;
     toString(): string;
     static simple(instanceName: string, numPins: number, className: string): ClassComponent;
     isEqual(other: ClassComponent): boolean;

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

@@ -4,6 +4,7 @@ import { CFunction, ComponentPinNet, ComponentPinNetPair, ParseSymbolType, Value
 import { LayoutDirection } from '../globals.js';
 import { Wire, WireSegment } from './Wire.js';
 import { Frame } from './Frame.js';
+import { ParserRuleContext } from 'antlr4ng';
 export declare class ExecutionScope {
     scopeId: number;
     private nets;
@@ -14,6 +15,7 @@ export declare class ExecutionScope {
         type: ParseSymbolType;
     }>;
     blockStack: Map<number, any>;
+    breakStack: ParserRuleContext[];
     wires: Wire[];
     frames: Frame[];
     indentLevel: number;

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

@@ -1,7 +1,9 @@
+import { FrameType } from "src/globals";
 export declare class Frame {
     parameters: Map<string, any>;
     frameId: number;
-    constructor(frameId: number);
+    frameType: FrameType;
+    constructor(frameId: number, frameType: FrameType);
 }
 export declare enum FrameParamKeys {
     Title = "title",
@@ -9,7 +11,9 @@ export declare enum FrameParamKeys {
     Padding = "padding",
     Border = "border",
     Width = "width",
-    Height = "height"
+    Height = "height",
+    PaperSize = "paper_size",
+    SheetFrame = "sheet_frame"
 }
 export declare enum FramePlotDirection {
     Row = "row",

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

@@ -14,7 +14,3 @@ export declare class PercentageValue {
     constructor(value: string | number);
     toString(): string;
 }
-export declare class PinBlankValue {
-    blank: number;
-    constructor(value: number);
-}

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

@@ -1,7 +1,7 @@
 import { ExecutionContext } from '../execute.js';
 import { ClassComponent } from './ClassComponent.js';
 import { Net } from './Net.js';
-import { NumericValue, PercentageValue, PinBlankValue } from './ParamDefinition.js';
+import { NumericValue, PercentageValue } from './ParamDefinition.js';
 export type CFunction = (args: CallableParameter[], options?: CFunctionOptions) => CFunctionResult;
 export type CFunctionOptions = {
     netNamespace?: string;
@@ -25,7 +25,7 @@ export type ComponentPin = [
     pinId: number | string
 ];
 export type ComplexType = ValueType | ClassComponent | UndeclaredReference | null;
-export type ValueType = boolean | number | string | NumericValue | PercentageValue | PinBlankValue;
+export type ValueType = boolean | number | string | NumericValue | PercentageValue;
 export type CallableParameter = [
     'keyword',
     key: string,
@@ -39,6 +39,7 @@ export type FunctionDefinedParameter = [name: string, defaultValue: ValueType] |
 export declare class UndeclaredReference {
     reference: ReferenceType;
     constructor(reference: ReferenceType);
+    throwMessage(): string;
 }
 export declare class DeclaredReference {
     found: boolean;
@@ -47,6 +48,7 @@ export declare class DeclaredReference {
     type?: string;
     value?: any;
     constructor(refType: ReferenceType);
+    toString(): string;
 }
 export type ReferenceType = {
     found: boolean;

package/dist/types/render.d.ts

@@ -1,14 +1,6 @@
-import { BoundBox, MergedWire, RenderComponent, RenderFrame, RenderJunction, RenderText, RenderWire } from "./layout.js";
-export declare function generateSVG2(graph: {
-    components: RenderComponent[];
-    wires: RenderWire[];
-    junctions: RenderJunction[];
-    mergedWires: MergedWire[];
-    debugRects?: BoundBox[];
-    frameObjects: RenderFrame[];
-    textObjects: RenderText[];
-}): {
-    svg: string;
-    width: number;
-    height: number;
-};
+/// <reference types="pdfkit" />
+import { Svg } from '@svgdotjs/svg.js';
+import { SheetFrame } from "./layout.js";
+export declare function renderSheetsToSVG(sheetFrames: SheetFrame[]): Svg;
+export declare function generateSvgOutput(canvas: Svg, zoomScale?: number): string;
+export declare function generatePdfOutput(doc: PDFKit.PDFDocument, canvas: Svg, sheetSize: string, sheetSizeDefined: boolean, zoomScale?: number): void;

package/dist/types/visitor.d.ts

@@ -1,4 +1,4 @@
-import { Add_component_exprContext, AdditionExprContext, At_blockContext, At_block_pin_exprContext, At_block_pin_expression_complexContext, At_block_pin_expression_simpleContext, At_component_exprContext, BinaryOperatorExprContext, Path_blocksContext, Component_select_exprContext, Create_component_exprContext, Create_graphic_exprContext, DataExprContext, Data_expr_with_assignmentContext, Double_dot_property_set_exprContext, Frame_exprContext, Function_def_exprContext, Keyword_assignment_exprContext, MultiplyExprContext, Nested_propertiesContext, Net_namespace_exprContext, Pin_select_expr2Context, Pin_select_exprContext, Point_exprContext, Property_exprContext, Property_key_exprContext, Property_set_exprContext, Single_line_propertyContext, To_component_exprContext, Wire_exprContext, UnaryOperatorExprContext, Wire_expr_direction_onlyContext, Wire_expr_direction_valueContext, Graphic_exprContext, If_exprContext, If_inner_exprContext, LogicalOperatorExprContext, Nested_properties_innerContext, Expressions_blockContext, Create_module_exprContext, Property_block_exprContext } from './antlr/CircuitScriptParser.js';
+import { Add_component_exprContext, AdditionExprContext, At_blockContext, At_block_pin_exprContext, At_block_pin_expression_complexContext, At_block_pin_expression_simpleContext, At_component_exprContext, BinaryOperatorExprContext, Path_blocksContext, Component_select_exprContext, Create_component_exprContext, Create_graphic_exprContext, DataExprContext, Data_expr_with_assignmentContext, Double_dot_property_set_exprContext, Frame_exprContext, Function_def_exprContext, Keyword_assignment_exprContext, MultiplyExprContext, Nested_propertiesContext, Net_namespace_exprContext, Pin_select_expr2Context, Pin_select_exprContext, Point_exprContext, Property_exprContext, Property_key_exprContext, Property_set_exprContext, Single_line_propertyContext, To_component_exprContext, Wire_exprContext, UnaryOperatorExprContext, Wire_expr_direction_onlyContext, Wire_expr_direction_valueContext, If_exprContext, If_inner_exprContext, LogicalOperatorExprContext, Nested_properties_innerContext, Expressions_blockContext, Create_module_exprContext, Property_block_exprContext, While_exprContext, For_exprContext, GraphicCommandExprContext, Graphic_expressions_blockContext, GraphicForExprContext } from './antlr/CircuitScriptParser.js';
 import { ClassComponent } from './objects/ClassComponent.js';
 import { PinTypes } from './objects/PinTypes.js';
 import { ComponentPin, ComponentPinNet } from './objects/types.js';
@@ -15,7 +15,9 @@ export declare class ParserVisitor extends BaseVisitor {
     visitPath_blocks: (ctx: Path_blocksContext) => ComponentPin;
     visitCreate_component_expr: (ctx: Create_component_exprContext) => void;
     visitCreate_graphic_expr: (ctx: Create_graphic_exprContext) => void;
-    visitGraphic_expr: (ctx: Graphic_exprContext) => void;
+    visitGraphic_expressions_block: (ctx: Graphic_expressions_blockContext) => void;
+    visitGraphicCommandExpr: (ctx: GraphicCommandExprContext) => void;
+    visitGraphicForExpr: (ctx: GraphicForExprContext) => void;
     visitCreate_module_expr: (ctx: Create_module_exprContext) => void;
     visitProperty_block_expr: (ctx: Property_block_exprContext) => void;
     visitProperty_expr: (ctx: Property_exprContext) => void;
@@ -50,6 +52,9 @@ export declare class ParserVisitor extends BaseVisitor {
     visitNet_namespace_expr: (ctx: Net_namespace_exprContext) => void;
     visitIf_expr: (ctx: If_exprContext) => void;
     visitIf_inner_expr: (ctx: If_inner_exprContext) => void;
+    visitWhile_expr: (ctx: While_exprContext) => void;
+    visitFor_expr: (ctx: For_exprContext) => void;
+    private resolveDataExpr;
     pinTypes: PinTypes[];
     private parseCreateComponentPins;
     private parseCreateModulePorts;
@@ -71,6 +76,9 @@ export declare class ParserVisitor extends BaseVisitor {
         components: ClassComponent[];
     };
     annotateComponents(): void;
+    applySheetFrameComponent(): {
+        frameComponent: ClassComponent | null;
+    };
     private resolveNets;
     private setComponentOrientation;
     private setComponentFlip;

package/libs/lib.cst

@@ -220,3 +220,286 @@ def arrow_point():
             path: ("M", -10, -5, "L", -5, 0, "L", -10, 5)
             path: ("M", -5, 0, "L", -20, 0)
             hpin: 1, 0, 0, 0, display_pin_id=false
+
+def frame_generator(paper_size_name, paper_width, paper_height, margin_x, margin_y):
+    inner_frame_margin = 50
+    return create component:
+        type: "frame"
+        display: create graphic:
+            fill: "none"
+
+            # outer rect 
+            lineColor: "#cccccc"
+            rect: paper_width/2, paper_height/2, paper_width, paper_height
+
+            # inner rect
+            lineColor: "#111111"
+            rect: paper_width/2, paper_height/2, paper_width - 2 * margin_x, paper_height - 2 * margin_y
+
+            rect: (paper_width/2, paper_height/2, 
+                    paper_width - 2 * margin_x + inner_frame_margin * 2, 
+                    paper_height - 2 * margin_y  + inner_frame_margin * 2)
+
+        params:
+            paper_size: paper_size_name
+            paper_width: paper_width
+            paper_height: paper_height
+            
+            offset_x: margin_x
+            offset_y: margin_y
+            
+            grid_width: paper_width - 2 * margin_x
+            grid_height: paper_height - 2 * margin_y
+
+
+def frame_A4 ():
+    paper_width = 297 / 25.4 * 1000
+    paper_height = 210 / 25.4 * 1000
+    margin_x = 400
+    margin_y = 400
+
+    inner_frame_margin = 50
+
+    horizontal_1 = margin_x - inner_frame_margin
+    horizontal_2 = paper_width - margin_x + inner_frame_margin
+
+    vertical_1 = margin_y - inner_frame_margin
+    vertical_2 = paper_height - margin_y + inner_frame_margin
+
+    tmp_height = paper_height - margin_y * 2 + inner_frame_margin * 2
+    tmp_y = margin_y - inner_frame_margin
+
+    tmp_width = paper_width - margin_x * 2 + inner_frame_margin * 2
+    tmp_x = margin_x - inner_frame_margin
+
+    fontSize = 30
+
+    ratio_x = 0.16667
+    ratio_y = 0.25
+
+    return create component:
+        type: "frame"
+        display: create graphic:
+            fill: "none"
+
+            # outer rect 
+            lineColor: "#cccccc"
+            rect: paper_width/2, paper_height/2, paper_width, paper_height
+
+            # inner rect
+            lineColor: "#111111"
+            rect: paper_width/2, paper_height/2, paper_width - 2 * margin_x, paper_height - 2 * margin_y
+
+            rect: (paper_width/2, paper_height/2, 
+                    paper_width - 2 * margin_x + inner_frame_margin * 2, 
+                    paper_height - 2 * margin_y  + inner_frame_margin * 2)
+
+            hline: horizontal_1, (tmp_y + tmp_height * ratio_y), inner_frame_margin
+            hline: horizontal_1, (tmp_y + tmp_height * ratio_y * 2), inner_frame_margin
+            hline: horizontal_1, (tmp_y + tmp_height * ratio_y * 3), inner_frame_margin
+
+            hline: horizontal_2, (tmp_y + tmp_height * ratio_y), -inner_frame_margin
+            hline: horizontal_2, (tmp_y + tmp_height * ratio_y * 2), -inner_frame_margin
+            hline: horizontal_2, (tmp_y + tmp_height * ratio_y * 3), -inner_frame_margin
+
+            vline: (tmp_x + tmp_width * ratio_x),     vertical_1, inner_frame_margin
+            vline: (tmp_x + tmp_width * ratio_x * 2), vertical_1, inner_frame_margin
+            vline: (tmp_x + tmp_width * ratio_x * 3), vertical_1, inner_frame_margin
+            vline: (tmp_x + tmp_width * ratio_x * 4), vertical_1, inner_frame_margin
+            vline: (tmp_x + tmp_width * ratio_x * 5), vertical_1, inner_frame_margin
+
+            vline: (tmp_x + tmp_width * ratio_x),     vertical_2, -inner_frame_margin
+            vline: (tmp_x + tmp_width * ratio_x * 2), vertical_2, -inner_frame_margin
+            vline: (tmp_x + tmp_width * ratio_x * 3), vertical_2, -inner_frame_margin
+            vline: (tmp_x + tmp_width * ratio_x * 4), vertical_2, -inner_frame_margin
+            vline: (tmp_x + tmp_width * ratio_x * 5), vertical_2, -inner_frame_margin
+
+            # labels on the columns
+            text: 
+                content: "1"
+                offset: tmp_x + tmp_width * ratio_x * 0.5, tmp_y + inner_frame_margin * 0.5 + 2
+                fontSize: fontSize
+                anchor: "middle"
+                vanchor: "middle"
+
+            text: 
+                content: "1"
+                offset: tmp_x + tmp_width * ratio_x * 0.5, tmp_y + tmp_height - inner_frame_margin * 0.5 + 2
+                fontSize: fontSize
+                anchor: "middle"
+                vanchor: "middle"
+
+            text: 
+                content: "2"
+                offset: tmp_x + tmp_width * ratio_x * 1.5, tmp_y + inner_frame_margin * 0.5 + 2
+                fontSize: fontSize
+                anchor: "middle"
+                vanchor: "middle"
+
+            text: 
+                content: "2"
+                offset: tmp_x + tmp_width * ratio_x * 1.5, tmp_y + tmp_height - inner_frame_margin * 0.5 + 2
+                fontSize: fontSize
+                anchor: "middle"
+                vanchor: "middle"
+
+            text: 
+                content: "3"
+                offset: tmp_x + tmp_width * ratio_x * 2.5, tmp_y + inner_frame_margin * 0.5 + 2
+                fontSize: fontSize
+                anchor: "middle"
+                vanchor: "middle"
+
+            text: 
+                content: "3"
+                offset: tmp_x + tmp_width * ratio_x * 2.5, tmp_y + tmp_height - inner_frame_margin * 0.5 + 2
+                fontSize: fontSize
+                anchor: "middle"
+                vanchor: "middle"
+
+            text: 
+                content: "4"
+                offset: tmp_x + tmp_width * ratio_x * 3.5, tmp_y + inner_frame_margin * 0.5 + 2
+                fontSize: fontSize
+                anchor: "middle"
+                vanchor: "middle"
+
+            text: 
+                content: "4"
+                offset: tmp_x + tmp_width * ratio_x * 3.5, tmp_y + tmp_height - inner_frame_margin * 0.5 + 2
+                fontSize: fontSize
+                anchor: "middle"
+                vanchor: "middle"
+        
+            text: 
+                content: "5"
+                offset: tmp_x + tmp_width * ratio_x * 4.5, tmp_y + inner_frame_margin * 0.5 + 2
+                fontSize: fontSize
+                anchor: "middle"
+                vanchor: "middle"
+
+            text: 
+                content: "5"
+                offset: tmp_x + tmp_width * ratio_x * 4.5, tmp_y + tmp_height - inner_frame_margin * 0.5 + 2
+                fontSize: fontSize
+                anchor: "middle"
+                vanchor: "middle"
+
+            text: 
+                content: "6"
+                offset: tmp_x + tmp_width * ratio_x * 5.5, tmp_y + inner_frame_margin * 0.5 + 2
+                fontSize: fontSize
+                anchor: "middle"
+                vanchor: "middle"
+
+            text: 
+                content: "6"
+                offset: tmp_x + tmp_width * ratio_x * 5.5, tmp_y + tmp_height - inner_frame_margin * 0.5 + 2
+                fontSize: fontSize
+                anchor: "middle"
+                vanchor: "middle"
+
+            # labels on the rows
+            text: 
+                content: "A"
+                offset: tmp_x + inner_frame_margin * 0.5, tmp_y + tmp_height * ratio_y * 0.5
+                fontSize: fontSize
+                anchor: "middle"
+                vanchor: "middle"
+
+            text: 
+                content: "A"
+                offset: tmp_x + tmp_width - inner_frame_margin * 0.5, tmp_y + tmp_height * ratio_y * 0.5
+                fontSize: fontSize
+                anchor: "middle"
+                vanchor: "middle"
+
+            text: 
+                content: "B"
+                offset: tmp_x + inner_frame_margin * 0.5, tmp_y + tmp_height * ratio_y * 1.5
+                fontSize: fontSize
+                anchor: "middle"
+                vanchor: "middle"
+
+            text: 
+                content: "B"
+                offset: tmp_x + tmp_width - inner_frame_margin * 0.5, tmp_y + tmp_height * ratio_y * 1.5
+                fontSize: fontSize
+                anchor: "middle"
+                vanchor: "middle"
+
+            text: 
+                content: "C"
+                offset: tmp_x + inner_frame_margin * 0.5, tmp_y + tmp_height * ratio_y * 2.5
+                fontSize: fontSize
+                anchor: "middle"
+                vanchor: "middle"
+
+            text: 
+                content: "C"
+                offset: tmp_x + tmp_width - inner_frame_margin * 0.5, tmp_y + tmp_height * ratio_y * 2.5
+                fontSize: fontSize
+                anchor: "middle"
+                vanchor: "middle"
+
+            text: 
+                content: "D"
+                offset: tmp_x + inner_frame_margin * 0.5, tmp_y + tmp_height * ratio_y * 3.5
+                fontSize: fontSize
+                anchor: "middle"
+                vanchor: "middle"
+
+            text: 
+                content: "D"
+                offset: tmp_x + tmp_width - inner_frame_margin * 0.5, tmp_y + tmp_height * ratio_y * 3.5
+                fontSize: fontSize
+                anchor: "middle"
+                vanchor: "middle"
+
+        params:
+            paper_size: "A4"
+            paper_width: paper_width
+            paper_height: paper_height
+            
+            offset_x: margin_x
+            offset_y: margin_y
+            
+            grid_width: paper_width - 2 * margin_x
+            grid_height: paper_height - 2 * margin_y
+
+
+def frame_generator(paper_size_name, paper_width, paper_height, margin_x, margin_y, inner_frame_margin = 50):
+    return create component:
+        type: "frame"
+        display: create graphic:
+            fill: "none"
+
+            # outer rect 
+            lineColor: "#cccccc"
+            rect: paper_width/2, paper_height/2, paper_width, paper_height
+
+            # inner rect
+            lineColor: "#111111"
+            rect: paper_width/2, paper_height/2, paper_width - 2 * margin_x, paper_height - 2 * margin_y
+
+            rect: (paper_width/2, paper_height/2, 
+                    paper_width - 2 * margin_x + inner_frame_margin * 2, 
+                    paper_height - 2 * margin_y  + inner_frame_margin * 2)
+
+        params:
+            paper_size: paper_size_name
+            paper_width: paper_width
+            paper_height: paper_height
+            
+            offset_x: margin_x
+            offset_y: margin_y
+            
+            grid_width: paper_width - 2 * margin_x
+            grid_height: paper_height - 2 * margin_y
+
+def frame_A6():
+    paper_width = 148 / 25.4 * 1000
+    paper_height = 105 / 25.4 * 1000
+    margin = 400
+
+    return frame_generator("A6", paper_width, paper_height, margin, margin, 20)

package/package.json

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