circuitscript 0.0.24 → 0.0.26

package/dist/types/visitor.d.ts

@@ -1,101 +1,51 @@
-import { ParseTreeVisitor, ParserRuleContext } from 'antlr4';
-import { Add_component_exprContext, AdditionExprContext, Assignment_exprContext, At_blockContext, At_block_pin_exprContext, At_block_pin_expression_complexContext, At_block_pin_expression_simpleContext, At_component_exprContext, Atom_exprContext, BinaryOperatorExprContext, Blank_exprContext, Path_blocksContext, Component_select_exprContext, Create_component_exprContext, Create_graphic_exprContext, DataExprContext, Data_expr_with_assignmentContext, Double_dot_property_set_exprContext, Frame_exprContext, Function_args_exprContext, Function_def_exprContext, Function_return_exprContext, Import_exprContext, Keyword_assignment_exprContext, MultiplyExprContext, Nested_propertiesContext, Net_namespace_exprContext, ParametersContext, Pin_select_expr2Context, Pin_select_exprContext, Point_exprContext, Property_exprContext, Property_key_exprContext, Property_set_exprContext, RoundedBracketsExprContext, ScriptContext, Single_line_propertyContext, Sub_exprContext, To_component_exprContext, Value_exprContext, Wire_exprContext, ValueAtomExprContext, UnaryOperatorExprContext } from './antlr/CircuitScriptParser.js';
-import { ExecutionContext } from './execute.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, Graphic_exprContext, If_exprContext, If_inner_exprContext, LogicalOperatorExprContext } from './antlr/CircuitScriptParser.js';
 import { ClassComponent } from './objects/ClassComponent.js';
-import { PinBlankValue } from './objects/ParamDefinition.js';
 import { PinTypes } from './objects/PinTypes.js';
-import { CallableParameter, ComplexType, ComponentPin, ComponentPinNet, FunctionDefinedParameter, ReferenceType, ValueType } from './objects/types.js';
-import { Logger } from './logger.js';
+import { ComponentPin, ComponentPinNet } from './objects/types.js';
 import { Net } from './objects/Net.js';
-import { SymbolDrawingCommands } from './draw_symbols.js';
-export declare class MainVisitor extends ParseTreeVisitor<any> {
-    indentLevel: number;
-    startingContext: ExecutionContext;
-    executionStack: ExecutionContext[];
-    silent: boolean;
-    logger: Logger;
-    printStream: string[];
-    printToConsole: boolean;
-    acceptedDirections: string[];
-    pinTypesList: string[];
-    onImportFile: (visitor: MainVisitor, filePath: string) => {
-        hasError: boolean;
-        hasParseError: boolean;
-    };
-    constructor(silent?: boolean);
-    getExecutor(): ExecutionContext;
-    visit(ctx: ParserRuleContext): any;
-    handleError(ctx: ParserRuleContext, err: string | VisitorExecutionException): void;
-    visitScript(ctx: ScriptContext): any;
-    visitParameters(ctx: ParametersContext): CallableParameter[];
-    visitKeyword_assignment_expr(ctx: Keyword_assignment_exprContext): [
-        key: string,
-        value: any
-    ];
-    visitAssignment_expr(ctx: Assignment_exprContext): ComplexType;
-    setInstanceParam(object: ClassComponent, trailers: string[], value: any): void;
-    visitValue_expr(ctx: Value_exprContext): ValueType;
-    visitBlank_expr(ctx: Blank_exprContext): PinBlankValue;
-    visitPin_select_expr(ctx: Pin_select_exprContext): string | number | null;
-    visitAdd_component_expr(ctx: Add_component_exprContext): ComponentPin;
-    visitAt_component_expr(ctx: At_component_exprContext): ComponentPin;
-    visitTo_component_expr(ctx: To_component_exprContext): ComponentPin;
-    visitComponent_select_expr(ctx: Component_select_exprContext): ComponentPin;
-    visitPath_blocks(ctx: Path_blocksContext): ComponentPin;
-    visitBreak_keyword(): number;
-    visitCreate_component_expr(ctx: Create_component_exprContext): ClassComponent;
-    visitCreate_graphic_expr(ctx: Create_graphic_exprContext): SymbolDrawingCommands;
-    visitSub_expr(ctx: Sub_exprContext): [
-        id: string,
-        parameters: CallableParameter[]
-    ];
-    visitProperty_expr(ctx: Property_exprContext): Map<string, any>;
-    visitSingle_line_property(ctx: Single_line_propertyContext): any | any[];
-    visitNested_properties(ctx: Nested_propertiesContext): Map<string, any>;
-    visitProperty_key_expr(ctx: Property_key_exprContext): string | number;
-    visitData_expr_with_assignment(ctx: Data_expr_with_assignmentContext): [
-        component: ComplexType,
-        pin: string | number | null
-    ];
-    visitValueAtomExpr(ctx: ValueAtomExprContext): ComplexType;
-    visitUnaryOperatorExpr(ctx: UnaryOperatorExprContext): ComplexType;
-    visitDataExpr(ctx: DataExprContext): ComplexType;
-    visitBinaryOperatorExpr(ctx: BinaryOperatorExprContext): boolean | number;
-    visitMultiplyExpr(ctx: MultiplyExprContext): number;
-    visitAdditionExpr(ctx: AdditionExprContext): number;
-    visitFunction_args_expr(ctx: Function_args_exprContext): FunctionDefinedParameter[];
-    createNetResolver(executionStack: ExecutionContext[]): (netName: string, netNamespace: string) => {
-        found: boolean;
-        net?: Net;
-    };
-    visitFunction_def_expr(ctx: Function_def_exprContext): void;
-    private setupDefinedParameters;
-    visitFunction_return_expr(ctx: Function_return_exprContext): ComplexType;
-    visitAtom_expr(ctx: Atom_exprContext): ReferenceType;
-    visitPin_select_expr2(ctx: Pin_select_expr2Context): string | number;
-    visitAt_block_pin_expr(ctx: At_block_pin_exprContext): ComponentPin;
-    visitAt_block(ctx: At_blockContext): ComponentPin;
-    visitAt_block_pin_expression_simple(ctx: At_block_pin_expression_simpleContext): void;
-    visitAt_block_pin_expression_complex(ctx: At_block_pin_expression_complexContext): ComponentPin;
-    visitWire_expr(ctx: Wire_exprContext): void;
-    visitPoint_expr(ctx: Point_exprContext): ComponentPin;
-    visitImport_expr(ctx: Import_exprContext): void;
-    visitProperty_set_expr(ctx: Property_set_exprContext): void;
-    visitDouble_dot_property_set_expr(ctx: Double_dot_property_set_exprContext): void;
-    visitRoundedBracketsExpr(ctx: RoundedBracketsExprContext): any;
-    visitFrame_expr(ctx: Frame_exprContext): void;
-    visitNet_namespace_expr(ctx: Net_namespace_exprContext): string;
+import { BaseVisitor } from './BaseVisitor.js';
+import { ParserRuleContext } from 'antlr4ng';
+export declare class ParserVisitor extends BaseVisitor {
+    visitKeyword_assignment_expr: (ctx: Keyword_assignment_exprContext) => void;
+    visitPin_select_expr: (ctx: Pin_select_exprContext) => void;
+    visitAdd_component_expr: (ctx: Add_component_exprContext) => ComponentPin;
+    visitAt_component_expr: (ctx: At_component_exprContext) => ComponentPin;
+    visitTo_component_expr: (ctx: To_component_exprContext) => ComponentPin;
+    visitComponent_select_expr: (ctx: Component_select_exprContext) => void;
+    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;
+    visitProperty_expr: (ctx: Property_exprContext) => void;
+    visitSingle_line_property: (ctx: Single_line_propertyContext) => void;
+    visitNested_properties: (ctx: Nested_propertiesContext) => void;
+    visitProperty_key_expr: (ctx: Property_key_exprContext) => void;
+    visitData_expr_with_assignment: (ctx: Data_expr_with_assignmentContext) => void;
+    visitUnaryOperatorExpr: (ctx: UnaryOperatorExprContext) => void;
+    visitDataExpr: (ctx: DataExprContext) => void;
+    visitBinaryOperatorExpr: (ctx: BinaryOperatorExprContext) => void;
+    visitLogicalOperatorExpr: (ctx: LogicalOperatorExprContext) => void;
+    visitMultiplyExpr: (ctx: MultiplyExprContext) => void;
+    visitAdditionExpr: (ctx: AdditionExprContext) => void;
+    visitFunction_def_expr: (ctx: Function_def_exprContext) => void;
+    visitPin_select_expr2: (ctx: Pin_select_expr2Context) => void;
+    visitAt_block_pin_expr: (ctx: At_block_pin_exprContext) => void;
+    visitAt_block: (ctx: At_blockContext) => void;
+    visitAt_block_pin_expression_simple: (ctx: At_block_pin_expression_simpleContext) => void;
+    visitAt_block_pin_expression_complex: (ctx: At_block_pin_expression_complexContext) => void;
+    visitWire_expr_direction_only: (ctx: Wire_expr_direction_onlyContext) => void;
+    visitWire_expr_direction_value: (ctx: Wire_expr_direction_valueContext) => void;
+    visitWire_expr: (ctx: Wire_exprContext) => void;
+    visitPoint_expr: (ctx: Point_exprContext) => ComponentPin;
+    visitProperty_set_expr: (ctx: Property_set_exprContext) => void;
+    visitDouble_dot_property_set_expr: (ctx: Double_dot_property_set_exprContext) => void;
+    visitFrame_expr: (ctx: Frame_exprContext) => void;
+    visitNet_namespace_expr: (ctx: Net_namespace_exprContext) => void;
+    visitIf_expr: (ctx: If_exprContext) => void;
+    visitIf_inner_expr: (ctx: If_inner_exprContext) => void;
     pinTypes: PinTypes[];
-    createImportFileHandler(directory: string, defaultLibsPath: string): ((visitor: MainVisitor, importPath: string) => {
-        hasError: boolean;
-        hasParseError: boolean;
-        pathExists: boolean;
-    });
-    private importLib;
     private parseCreateComponentPins;
     private parseCreateComponentParams;
-    private prepareStringValue;
-    print(...params: any[]): void;
     printNets(): void;
     dumpNets(): ComponentPinNet[];
     dumpUniqueNets(): Net[];
@@ -115,10 +65,8 @@ export declare class MainVisitor extends ParseTreeVisitor<any> {
     annotateComponents(): void;
     private resolveNets;
     private setComponentOrientation;
+    private setComponentFlip;
     private getPropertyExprList;
-    private runExpressions;
-    private setupPrintFunction;
-    private getNetNamespace;
 }
 export type NetListItem = {
     instanceName: string;

package/libs/lib.cst

@@ -0,0 +1,184 @@
+# Circuitscript default lib
+
+def net(net_name):
+    return create component:
+        pins: 1
+        copy: true
+        display: create graphic:
+            hline: -15, 0, 30
+            vpin: 1, 0, 10, -10, display_pin_id=0
+            label: "net_name", 0, -5, net_name, fontSize=10, anchor="middle"
+        type: "net"
+        params:
+            net_name: net_name
+            priority: 10
+
+def supply(net_name):
+    return create component:
+        pins: 1
+        copy: true
+        display: create graphic:
+            hline: -15, 0, 30
+            vpin: 1, 0, 10, -10, display_pin_id=0
+            label: "net_name", 0, -5, net_name, fontSize=10, anchor="middle"
+        type: "net"
+        params:
+            net_name: net_name
+            priority: 20
+
+def label(value):
+    return create component:
+        pins: 1
+        copy: true
+        display: create graphic:
+            label: "value", 0, -2, "?", fontSize=10, anchor="left"
+            pin: 1, 0, 0, 0, 0, display_pin_id=0
+        type: "label"
+        params:
+            net_name: value
+            value: value
+            priority: 5
+
+def res(value):
+    width = 40
+    height = 20
+ 
+    return create component:
+        pins: 2
+        display: create graphic:
+            rect: 0, 0, width, height
+            hpin: 1, -width/2 - 20, 0, 20
+            hpin: 2, width/2 + 20, 0, -20
+            label: ("value", 0, 1, value, fontSize=10, anchor="middle", vanchor="middle")
+            label: ("refdes", -width/2, -height/2 -5 , "?", fontSize=10, anchor="left")
+        type: "res"
+        params:
+            value: value
+            size: "0402"
+            footprint: "Resistor_SMD:R_0402_1005Metric"
+
+def cap(value):
+    width = 20
+    height = 40
+
+    return create component:
+        pins: 2
+        display: create graphic:
+            hline: -width/2, -3, width
+            hline: -width/2, 3, width
+            vpin: 1, 0, -height/2, 20-3
+            vpin: 2, 0, height/2, -20+3
+            label: "refdes", width/2+2, 0, "?", fontSize = 10, anchor="left"
+            label: "value", width/2+2, 5, value, fontSize = 10, anchor = "left", vanchor="top"
+        type: "cap"
+        params:
+            value: value
+            size: "0402"
+            footprint: "Capacitor_SMD:C_0402_1005Metric"
+
+def ind(value):
+    width = 40
+    height = 20
+
+    return create component:
+        pins: 2
+        type: "ind"
+        display: create graphic:
+            arc: -15, 0, 5, 180, 360
+            arc: -5, 0, 5, 180, 360
+            arc: 5, 0, 5, 180, 360
+            arc: 15, 0, 5, 180, 360
+            hpin: 1, -width/2 - 20, 0, 20
+            hpin: 2, width/2 + 20, 0, -20
+            label: ("value", 0, 10, value, fontSize=10, anchor="middle", vanchor="middle")
+            label: ("refdes", -width/2, -height/2 -5 , "?", fontSize=10, anchor="left")
+        params:
+            value: value
+
+def diode():
+    width = 20
+    height = 20
+
+    # Diode is drawn horizontally
+    #  -|>|-
+    return create component:
+        pins: 2
+        type: "diode"
+        display: create graphic:
+            triangle: -width/2, 0, width/2, 0, height
+            vline: width/2, -height/2, height
+            hpin: 1, -width/2-20, 0, 20    # anode
+            hpin: 2, width/2 + 20, 0, -20  # cathode
+            label: "refdes", width/2 + 5, 5, "?", fontSize=10, anchor="left", vanchor="top"
+
+def led(color):
+    width = 20
+    height = 20
+
+    return create component:
+        pins:   
+            1: "cathode"
+            2: "anode"
+        type: "diode"
+        display: create graphic:
+            triangle: -width/2, 0, width/2, 0, height
+            vline: width/2, -height/2, height
+            path: ("M", 0, 8, "L", 5, 18, 
+                   "M", 3, 8, "L", 8, 18)
+            hpin: 1, -width/2-20, 0, 20    # anode
+            hpin: 2, width/2 + 20, 0, -20  # cathode
+            label: "refdes", width/2 + 5, 5, "?", fontSize=10, anchor="left", vanchor="top"
+            label: "color", width/2 + 5, 25, color
+        params:
+            size: "0603"
+            footprint: "LED_SMD:LED_0603_1608Metric_Pad1.05x0.95mm_HandSolder"
+
+
+def cgnd():
+    net_name = "gnd"
+    return create component:
+        pins: 1
+        copy: true
+        display: create graphic:
+            hline: -15, 0, 30
+            hline: -10, 5, 20
+            hline: -5, 10, 10
+            vpin: 1, 0, -10, 10, display_pin_id=0
+            label: "net_name", 0, 22, net_name, fontSize=10, anchor="middle"
+        type: "net"
+        params:
+            net_name: net_name
+            priority: 100
+
+def dgnd(net_name="GND"):
+    height = 10
+    width = 20
+
+    return create component:
+        pins: 1
+        copy: true
+        display: create graphic:
+            triangle: 0, 0, 0, height, width
+            vpin: 1, 0, -10, 10, display_pin_id=0
+            label: "net_name", 0, height + 10, net_name, fontSize=10, anchor="middle"
+        type: "net"
+        params:
+            net_name: net_name
+            priority: 100
+
+def marker_point():
+    return create component:
+        pins: 1
+        display: create graphic:
+            hline: -5, 0, 10
+            vline: 0, -5, 10
+            pin: 1, 0, 0, 0, 0, display_pin_id=0
+        type: "net"
+
+def arrow_point():
+    return create component:
+        pins: 1
+        display: create graphic:
+            path: ("M", 15, -5, "L", 20, 0, "L", 15, 5)
+            hpin: 1, 0, 0, 20
+        type: "net"

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "circuitscript",
-    "version": "0.0.24",
+    "version": "0.0.26",
     "description": "Interpreter for the circuitscript language",
     "homepage": "https://circuitscript.net",
     "engines": {
@@ -10,7 +10,7 @@
     "module": "./dist/esm/index.mjs",
     "types": "./dist/types/index.d.ts",
     "bin": {
-        "circuitscript": "./dist/esm/main.mjs"
+        "circuitscript": "./dist/cjs/main.js"
     },
     "exports": {
         ".": {
@@ -19,7 +19,9 @@
         }
     },
     "files": [
-        "dist"
+        "dist",
+        "fonts",
+        "libs"
     ],
     "devDependencies": {
         "@types/figlet": "^1.5.8",
@@ -28,6 +30,7 @@
         "@types/svgdom": "^0.1.2",
         "@typescript-eslint/eslint-plugin": "~5.59",
         "@typescript-eslint/parser": "~5.59",
+        "antlr4ng-cli": "^2.0.0",
         "eslint": "~8.38",
         "eslint-config-prettier": "~8.8",
         "eslint-plugin-jest": "~27.2",
@@ -59,9 +62,11 @@
         "prettier": "prettier --config .prettierrc --write .",
         "test:watch": "jest --watch",
         "antlr": "antlr4 -Dlanguage=TypeScript ./src/antlr/CircuitScript.g4 -no-listener -visitor",
+        "antlr4ng": "npx antlr4ng -Dlanguage=TypeScript -o src/antlr -visitor -no-listener -Xexact-output-dir src/antlr/CircuitScript.g4",
         "profile": "node --prof build/src/main.js examples/example_garden_pump.cst",
         "profile-flame": "node --prof-process --preprocess -j isolate*.log | flamebearer",
-        "server": "node server.js"
+        "server": "node server.js",
+        "pack-local": "npm pack; rm circuitscript-install.tgz; mv `ls | grep circuitscript` circuitscript-install.tgz; cp circuitscript-install.tgz ../circuitscript-vscode/client; cp circuitscript-install.tgz ../circuitscript-vscode/server"
     },
     "boilerplate_author": "Jakub Synowiec <jsynowiec@users.noreply.github.com>",
     "license": "MIT",
@@ -69,12 +74,12 @@
         "@dagrejs/graphlib": "2.1.13",
         "@flatten-js/core": "1.5.5",
         "@svgdotjs/svg.js": "3.2.0",
-        "antlr4": "^4.13.0",
+        "antlr4ng": "^3.0.4",
         "commander": "^11.1.0",
         "express": "^4.18.2",
         "figlet": "^1.7.0",
         "lodash": "^4.17.21",
-        "svgdom": "^0.1.14",
+        "svgdom": "0.1.14",
         "this-file": "^2.0.3",
         "tslib": "~2.5",
         "ws": "^8.14.2"