circuitscript 0.1.23 → 0.1.25

package/dist/types/antlr/CircuitScriptVisitor.d.ts

@@ -78,6 +78,13 @@ import { If_inner_exprContext } from "./CircuitScriptParser.js";
 import { Else_exprContext } from "./CircuitScriptParser.js";
 import { While_exprContext } from "./CircuitScriptParser.js";
 import { For_exprContext } from "./CircuitScriptParser.js";
+import { Part_set_exprContext } from "./CircuitScriptParser.js";
+import { Part_set_keyContext } from "./CircuitScriptParser.js";
+import { Part_match_blockContext } from "./CircuitScriptParser.js";
+import { Part_sub_exprContext } from "./CircuitScriptParser.js";
+import { Part_condition_exprContext } from "./CircuitScriptParser.js";
+import { Part_condition_key_only_exprContext } from "./CircuitScriptParser.js";
+import { Part_value_exprContext } from "./CircuitScriptParser.js";
 import { Annotation_comment_exprContext } from "./CircuitScriptParser.js";
 export declare class CircuitScriptVisitor<Result> extends AbstractParseTreeVisitor<Result> {
     visitScript?: (ctx: ScriptContext) => Result;
@@ -159,5 +166,12 @@ export declare class CircuitScriptVisitor<Result> extends AbstractParseTreeVisit
     visitElse_expr?: (ctx: Else_exprContext) => Result;
     visitWhile_expr?: (ctx: While_exprContext) => Result;
     visitFor_expr?: (ctx: For_exprContext) => Result;
+    visitPart_set_expr?: (ctx: Part_set_exprContext) => Result;
+    visitPart_set_key?: (ctx: Part_set_keyContext) => Result;
+    visitPart_match_block?: (ctx: Part_match_blockContext) => Result;
+    visitPart_sub_expr?: (ctx: Part_sub_exprContext) => Result;
+    visitPart_condition_expr?: (ctx: Part_condition_exprContext) => Result;
+    visitPart_condition_key_only_expr?: (ctx: Part_condition_key_only_exprContext) => Result;
+    visitPart_value_expr?: (ctx: Part_value_exprContext) => Result;
     visitAnnotation_comment_expr?: (ctx: Annotation_comment_exprContext) => Result;
 }

package/dist/types/execute.d.ts

@@ -6,6 +6,7 @@ import { Net } from './objects/Net.js';
 import { NumericValue, ParamDefinition } from './objects/ParamDefinition.js';
 import { PinDefinition, PinId } from './objects/PinDefinition.js';
 import { AnyReference, CFunction, CFunctionEntry, CFunctionResult, CallableParameter, ComponentPin } from './objects/types.js';
+import { Wire } from './objects/Wire.js';
 import { Logger } from './logger.js';
 import { UnitDimension } from './helpers.js';
 import { ParserRuleContext } from 'antlr4ng';
@@ -85,7 +86,7 @@ export declare class ExecutionContext {
     resolveTrailers(type: ReferenceTypes, item: any, trailers?: string[]): AnyReference;
     callFunction(functionName: string, functionParams: CallableParameter[], executionStack: ExecutionContext[], netNamespace: string): CFunctionResult;
     mergeScope(childScope: ExecutionScope, namespace: string): ClassComponent[];
-    addWire(segments: [string, (number | UnitDimension)?][]): void;
+    addWire(segments: [string, (number | UnitDimension)?][]): Wire;
     addPoint(pointId: string, userDefined?: boolean): ComponentPin;
     private getPointSymbol;
     setProperty(nameWithProp: string, value: any): void;

package/dist/types/graph.d.ts

@@ -1,6 +1,6 @@
 import { Graph } from "@dagrejs/graphlib";
 import { SymbolPinDefintion } from "./draw_symbols.js";
-import { RenderFrame } from "./layout.js";
+import { RenderFrame, RenderComponent, RenderWire } from "./layout.js";
 import { ClassComponent } from "./objects/ClassComponent.js";
 import { SequenceItem } from "./objects/ExecutionScope.js";
 import { Net } from "./objects/Net.js";
@@ -27,3 +27,8 @@ export declare enum RenderItemType {
     Wire = "wire",
     Component = "component"
 }
+export type GraphNodeInfo = [
+    type: RenderItemType,
+    item: RenderComponent | RenderWire,
+    index: number
+];

package/dist/types/helpers.d.ts

@@ -1,14 +1,16 @@
 import { BaseError } from "./utils.js";
 import { ParserVisitor } from "./visitor.js";
+import { ParserRuleContext } from "antlr4ng";
 import { SymbolValidatorVisitor } from "./validate/SymbolValidatorVisitor.js";
 import { CommonTokenStream, DefaultErrorStrategy, Parser } from "antlr4ng";
-import { CircuitScriptParser } from "./antlr/CircuitScriptParser.js";
+import { CircuitScriptParser, ScriptContext } from "./antlr/CircuitScriptParser.js";
 import { CircuitScriptLexer } from "./antlr/CircuitScriptLexer.js";
 import { IParsedToken, SemanticTokensVisitor } from "./SemanticTokenVisitor.js";
 import { LengthUnit } from "./globals.js";
 export type SVGWindow = any;
 import { NumericValue } from "./objects/ParamDefinition.js";
 import { NodeScriptEnvironment } from "./environment.js";
+import { ClassComponent } from "./objects/ClassComponent.js";
 export declare enum JSModuleType {
     CommonJs = "cjs",
     ESM = "mjs"
@@ -17,6 +19,9 @@ export type ScriptOptions = {
     dumpNets: boolean;
     dumpData: boolean;
     showStats: boolean;
+    enableErc: boolean;
+    enableBom: boolean;
+    bomOutputPath?: string;
     environment: NodeScriptEnvironment;
     inputPath?: string;
     updateSource: boolean;
@@ -41,7 +46,7 @@ type RenderScriptReturn = {
     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 function renderScriptCustom(scriptData: string, outputPath: string | null, options: ScriptOptions, parseHandlers: ParseOutputHandler[], postAnnotationCallbacks: ((options: ScriptOptions, scriptData: string, tree: ScriptContext, tokens: CommonTokenStream, componentLinks: Map<ParserRuleContext, ClassComponent>) => void)[]): Promise<RenderScriptReturn>;
 export declare abstract class ParseOutputHandler {
     beforeRender: boolean;
     afterRender: boolean;

package/dist/types/layout.d.ts

@@ -2,7 +2,7 @@ import { Graph } from '@dagrejs/graphlib';
 import { SymbolGraphic, SymbolText, SymbolDrawingCommands, SimplePoint } from "./draw_symbols.js";
 import { ClassComponent } from "./objects/ClassComponent.js";
 import { WireAutoDirection } from './globals.js';
-import { WireSegment } from './objects/Wire.js';
+import { Wire, WireSegment } from './objects/Wire.js';
 import { Net } from './objects/Net.js';
 import { Logger } from './logger.js';
 import { Frame, FramePlotDirection } from './objects/Frame.js';
@@ -67,7 +67,8 @@ export declare class RenderWire extends RenderObject {
     }[];
     netName: string;
     net: Net;
-    constructor(net: Net, x: NumericValue, y: NumericValue, segments: WireSegment[]);
+    wire: Wire;
+    constructor(net: Net, x: NumericValue, y: NumericValue, segments: WireSegment[], wire: Wire);
     refreshPoints(): void;
     getAutoPoints(value: [x: NumericValue, y: NumericValue], direction: WireAutoDirection): [dx: number, dy: number][];
     getWireEnd(): {

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

@@ -58,6 +58,7 @@ export declare class ExecutionScope {
     setOnPropertyHandler(handler: OnPropertyHandler): void;
     popOnPropertyHandler(): OnPropertyHandler;
     triggerPropertyHandler(visitor: BaseVisitor, value: any, valueCtx: ParserRuleContext): void;
+    getInstances(): ClassComponent[];
 }
 export declare enum SequenceAction {
     To = "to",
@@ -82,9 +83,14 @@ export type SequenceActionAtTo = [
     LayoutDirection?,
     string?
 ];
-export type SequenceActionWire = [SequenceAction.Wire, wireId: number, WireSegment[]];
+export type SequenceActionWire = [
+    SequenceAction.Wire,
+    wireId: number,
+    WireSegment[],
+    wire: Wire
+];
 export type SequenceActionAssign = [SequenceAction.Assign, variable: string, ClassComponent];
-export type SequenceItem = SequenceActionAtTo | SequenceActionWire | [SequenceAction.WireJump, wireId: number, pinId: number] | [SequenceAction.Frame, Frame, "enter" | "exit"] | SequenceActionAssign;
+export type SequenceItem = SequenceActionAtTo | SequenceActionWire | [SequenceAction.WireJump, wireId: number, pinId: PinId, wire: Wire] | [SequenceAction.Frame, Frame, "enter" | "exit"] | SequenceActionAssign;
 export type InnerBlockStackEntry = {
     last_net: ComponentPinWireId | null;
     ignore_last_net: boolean;

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

@@ -22,7 +22,7 @@ export declare class NumericValue {
     neg(): NumericValue;
     eq(value: NumericValue): boolean;
 }
-export declare function numeric(value: number): NumericValue;
+export declare function numeric(value: number | string): NumericValue;
 export declare class PercentageValue {
     value: string | number;
     constructor(value: string | number);

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

@@ -10,6 +10,7 @@ export declare class PinId {
     isString(): boolean;
     toString(): string;
     equals(other: PinId | number | string): boolean;
+    getHashValue(): string;
     static from(value: number | string | NumericValue): PinId;
     static isPinIdType(value: number | string): boolean;
 }

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

@@ -61,17 +61,19 @@ export declare class AnyReference {
     found: boolean;
     name?: string;
     trailers: (string | ['index', number])[];
+    trailerIndex: number;
     type: ReferenceTypes;
     value?: any;
-    parentValue?: any;
+    rootValue?: any;
     referenceName: string;
     constructor(refType: {
         found: boolean;
         name?: string;
         trailers?: (string | ['index', number])[];
+        trailerIndex: number;
         type?: ReferenceTypes;
         value?: any;
-        parentValue?: any;
+        rootValue?: any;
     });
     toString(): string;
 }

package/dist/types/rules-check/no-connect-on-connected-pin.d.ts

@@ -0,0 +1,3 @@
+import { Graph } from "@dagrejs/graphlib";
+import { ComponentPinNetPair } from "src/objects/types.js";
+export declare function RuleCheck_NoConnectOnConnectedPin(graph: Graph, nets: ComponentPinNetPair[]): any[];

package/dist/types/rules-check/rules.d.ts

@@ -0,0 +1,15 @@
+import { Graph } from "@dagrejs/graphlib";
+import { ParserVisitor } from "src/visitor";
+import { ComponentPinNetPair } from "src/objects/types";
+import { Token } from "antlr4ng";
+export declare enum ERC_Rules {
+    UnconnectedPin = "UNCONNECTED-PIN",
+    UnconnectedWire = "UNCONNECTED-WIRE",
+    NoConnectOnConnectedPin = "NO-CONNECT-ON-CONNECTED-PIN"
+}
+export type ERCReportItem = {
+    start: Token;
+    type: ERC_Rules;
+    message: string;
+};
+export declare function EvaluateERCRules(visitor: ParserVisitor, graph: Graph, nets: ComponentPinNetPair[]): ERCReportItem[];

package/dist/types/rules-check/unconnected-pins.d.ts

@@ -0,0 +1,2 @@
+import { Graph } from "@dagrejs/graphlib";
+export declare function RuleCheck_UnconnectedPinsWires(graph: Graph): any[];

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, 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, Graph_expressionsContext, Path_blockContext, Annotation_comment_exprContext, At_block_headerContext } 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, 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, Graph_expressionsContext, Path_blockContext, Annotation_comment_exprContext, At_block_headerContext, Part_set_exprContext, Part_set_keyContext, Part_match_blockContext, Part_sub_exprContext, Part_value_exprContext, Part_condition_exprContext, Part_condition_key_only_exprContext } from './antlr/CircuitScriptParser.js';
 import { ClassComponent } from './objects/ClassComponent.js';
 import { PinTypes } from './objects/PinTypes.js';
 import { ComponentPin, ComponentPinNet, ComponentPinNetPair } from './objects/types.js';
@@ -6,8 +6,10 @@ import { ExecutionWarning } from "./utils.js";
 import { Net } from './objects/Net.js';
 import { BaseVisitor } from './BaseVisitor.js';
 import { ParserRuleContext } from 'antlr4ng';
+import { Wire } from './objects/Wire.js';
 export declare class ParserVisitor extends BaseVisitor {
     componentCreationIndex: number;
+    creationCtx: Map<ClassComponent | Wire, ParserRuleContext>;
     visitKeyword_assignment_expr: (ctx: Keyword_assignment_exprContext) => void;
     visitPin_select_expr: (ctx: Pin_select_exprContext) => void;
     trackNewComponentCreated: (callback: () => void) => boolean;
@@ -60,6 +62,13 @@ export declare class ParserVisitor extends BaseVisitor {
     visitWhile_expr: (ctx: While_exprContext) => void;
     visitFor_expr: (ctx: For_exprContext) => void;
     visitAnnotation_comment_expr: (ctx: Annotation_comment_exprContext) => void;
+    visitPart_set_expr: (ctx: Part_set_exprContext) => void;
+    visitPart_match_block: (ctx: Part_match_blockContext) => void;
+    visitPart_sub_expr: (ctx: Part_sub_exprContext) => void;
+    visitPart_set_key: (ctx: Part_set_keyContext) => void;
+    visitPart_value_expr: (ctx: Part_value_exprContext) => void;
+    visitPart_condition_expr: (ctx: Part_condition_exprContext) => void;
+    visitPart_condition_key_only_expr: (ctx: Part_condition_key_only_exprContext) => void;
     private resolveDataExpr;
     private resolveDataValue;
     pinTypes: PinTypes[];

package/libs/std.cst

@@ -65,6 +65,7 @@ def res(value):
             value: value
             size: "0402"
             footprint: "Resistor_SMD:R_0402_1005Metric"
+            description: "RES {value} OHM {size}"
 
 def cap(value):
     width = 120
@@ -146,9 +147,9 @@ def led(color):
         params:
             size: "0603"
             color: color
+            value: color
             footprint: "LED_SMD:LED_0603_1608Metric_Pad1.05x0.95mm_HandSolder"
-
-
+            description: "LED {color} {size}"
 
 def cgnd():
     net_name = "gnd"
@@ -224,6 +225,8 @@ def no_connect(size=20):
             path: "M", -size, -size, "L", size, size
             path: "M", -size, size, "L", size, -size
             pin: 1, 0, 0, 0, 0, display_pin_id=false
+        params:
+            no_connect: true
 
 def dnc(size=20):
     return no_connect(size)
@@ -424,4 +427,5 @@ def sheet_A6(revision="V1"):
 
     return tmp_sheet
 
-document.sheet_type = sheet_A4()
+document.sheet_type = sheet_A4()
+document.bom.columns = ["refdes", "mpn", "manufacturer", "footprint"]

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "circuitscript",
-    "version": "0.1.23",
+    "version": "0.1.25",
     "description": "Interpreter for the circuitscript language",
     "homepage": "https://circuitscript.net",
     "engines": {
@@ -80,6 +80,7 @@
     "license": "MIT",
     "dependencies": {
         "@dagrejs/graphlib": "^2.2.4",
+        "@fast-csv/format": "^5.0.5",
         "@flatten-js/core": "1.5.5",
         "@svgdotjs/svg.js": "3.2.0",
         "antlr4ng": "^3.0.4",