circuitscript 0.1.31 → 0.1.33

package/dist/types/RefdesAnnotationVisitor.d.ts

@@ -27,9 +27,11 @@ export declare class RefdesAnnotationVisitor extends BaseVisitor {
     private generateRefdesAnnotationComment;
     private addRefdesAnnotationComment;
     getOutput(): string;
+    getOutputForExternalRefdesFile(): string[];
     private generateModifiedText;
     private buildContextTokenRanges;
     private findContextForToken;
     private markTokensAsProcessed;
     private log;
+    private generateReplacementText;
 }

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

@@ -132,20 +132,21 @@ export declare class CircuitScriptParser extends antlr.Parser {
     static readonly RULE_array_expr = 57;
     static readonly RULE_point_expr = 58;
     static readonly RULE_import_expr = 59;
-    static readonly RULE_frame_expr = 60;
-    static readonly RULE_if_expr = 61;
-    static readonly RULE_if_inner_expr = 62;
-    static readonly RULE_else_expr = 63;
-    static readonly RULE_while_expr = 64;
-    static readonly RULE_for_expr = 65;
-    static readonly RULE_part_set_expr = 66;
-    static readonly RULE_part_set_key = 67;
-    static readonly RULE_part_match_block = 68;
-    static readonly RULE_part_sub_expr = 69;
-    static readonly RULE_part_condition_expr = 70;
-    static readonly RULE_part_condition_key_only_expr = 71;
-    static readonly RULE_part_value_expr = 72;
-    static readonly RULE_annotation_comment_expr = 73;
+    static readonly RULE_import_annotation_expr = 60;
+    static readonly RULE_frame_expr = 61;
+    static readonly RULE_if_expr = 62;
+    static readonly RULE_if_inner_expr = 63;
+    static readonly RULE_else_expr = 64;
+    static readonly RULE_while_expr = 65;
+    static readonly RULE_for_expr = 66;
+    static readonly RULE_part_set_expr = 67;
+    static readonly RULE_part_set_key = 68;
+    static readonly RULE_part_match_block = 69;
+    static readonly RULE_part_sub_expr = 70;
+    static readonly RULE_part_condition_expr = 71;
+    static readonly RULE_part_condition_key_only_expr = 72;
+    static readonly RULE_part_value_expr = 73;
+    static readonly RULE_annotation_comment_expr = 74;
     static readonly literalNames: (string | null)[];
     static readonly symbolicNames: (string | null)[];
     static readonly ruleNames: string[];
@@ -217,6 +218,7 @@ export declare class CircuitScriptParser extends antlr.Parser {
     array_expr(): Array_exprContext;
     point_expr(): Point_exprContext;
     import_expr(): Import_exprContext;
+    import_annotation_expr(): Import_annotation_exprContext;
     frame_expr(): Frame_exprContext;
     if_expr(): If_exprContext;
     if_inner_expr(): If_inner_exprContext;
@@ -814,9 +816,12 @@ export declare class GraphicForExprContext extends Graphic_exprContext {
     accept<Result>(visitor: CircuitScriptVisitor<Result>): Result | null;
 }
 export declare class Property_exprContext extends antlr.ParserRuleContext {
+    _extra?: Token | null;
     constructor(parent: antlr.ParserRuleContext | null, invokingState: number);
     property_key_expr(): Property_key_exprContext;
     property_value_expr(): Property_value_exprContext;
+    STRING_VALUE(): antlr.TerminalNode[];
+    STRING_VALUE(i: number): antlr.TerminalNode | null;
     get ruleIndex(): number;
     accept<Result>(visitor: CircuitScriptVisitor<Result>): Result | null;
 }
@@ -898,6 +903,7 @@ export declare class Import_specificContext extends Import_exprContext {
     Import(): antlr.TerminalNode;
     ID(): antlr.TerminalNode[];
     ID(i: number): antlr.TerminalNode | null;
+    import_annotation_expr(): Import_annotation_exprContext | null;
     accept<Result>(visitor: CircuitScriptVisitor<Result>): Result | null;
 }
 export declare class Import_all_simpleContext extends Import_exprContext {
@@ -907,6 +913,7 @@ export declare class Import_all_simpleContext extends Import_exprContext {
     Import(): antlr.TerminalNode;
     Multiply(): antlr.TerminalNode;
     ID(): antlr.TerminalNode;
+    import_annotation_expr(): Import_annotation_exprContext | null;
     accept<Result>(visitor: CircuitScriptVisitor<Result>): Result | null;
 }
 export declare class Import_simpleContext extends Import_exprContext {
@@ -914,6 +921,17 @@ export declare class Import_simpleContext extends Import_exprContext {
     constructor(ctx: Import_exprContext);
     Import(): antlr.TerminalNode;
     ID(): antlr.TerminalNode;
+    import_annotation_expr(): Import_annotation_exprContext | null;
+    accept<Result>(visitor: CircuitScriptVisitor<Result>): Result | null;
+}
+export declare class Import_annotation_exprContext extends antlr.ParserRuleContext {
+    constructor(parent: antlr.ParserRuleContext | null, invokingState: number);
+    ANNOTATION_START(): antlr.TerminalNode;
+    ID(): antlr.TerminalNode[];
+    ID(i: number): antlr.TerminalNode | null;
+    Minus(): antlr.TerminalNode[];
+    Minus(i: number): antlr.TerminalNode | null;
+    get ruleIndex(): number;
     accept<Result>(visitor: CircuitScriptVisitor<Result>): Result | null;
 }
 export declare class Frame_exprContext extends antlr.ParserRuleContext {

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

@@ -74,6 +74,7 @@ import { Point_exprContext } from "./CircuitScriptParser.js";
 import { Import_simpleContext } from "./CircuitScriptParser.js";
 import { Import_all_simpleContext } from "./CircuitScriptParser.js";
 import { Import_specificContext } from "./CircuitScriptParser.js";
+import { Import_annotation_exprContext } from "./CircuitScriptParser.js";
 import { Frame_exprContext } from "./CircuitScriptParser.js";
 import { If_exprContext } from "./CircuitScriptParser.js";
 import { If_inner_exprContext } from "./CircuitScriptParser.js";
@@ -164,6 +165,7 @@ export declare class CircuitScriptVisitor<Result> extends AbstractParseTreeVisit
     visitImport_simple?: (ctx: Import_simpleContext) => Result;
     visitImport_all_simple?: (ctx: Import_all_simpleContext) => Result;
     visitImport_specific?: (ctx: Import_specificContext) => Result;
+    visitImport_annotation_expr?: (ctx: Import_annotation_exprContext) => Result;
     visitFrame_expr?: (ctx: Frame_exprContext) => Result;
     visitIf_expr?: (ctx: If_exprContext) => Result;
     visitIf_inner_expr?: (ctx: If_inner_exprContext) => Result;

package/dist/types/environment.d.ts

@@ -28,7 +28,8 @@ export declare class NodeScriptEnvironment {
     textMeasurementCanvas: Dom | undefined;
     getCanvasWindow(): Dom;
     prepareSVGEnvironment(): Promise<void>;
-    readFile(path: PathOrFileDescriptor, options: any): Promise<string>;
+    readFile(path: PathOrFileDescriptor, options?: any): Promise<string>;
+    writeFileSync(path: PathOrFileDescriptor, data: string): void;
     getAbsolutePath(filePath: string): string;
     getDirPath(filePath: string): string;
     setCurrentFile(filePath: string): string;
@@ -36,4 +37,9 @@ export declare class NodeScriptEnvironment {
     getRelativeToCurrentFolder(filePath: string): string;
     exists(path: PathLike): Promise<boolean>;
     hashStringSHA256(value: string): string;
+    dirname(filePath: string): string;
+    extname(filePath: string): string;
+    basename(filePath: string, ext: string): string;
+    join(...paths: string[]): string;
+    relative(from: string, to: string): string;
 }

package/dist/types/execute.d.ts

@@ -5,7 +5,7 @@ import { ExecutionScope } from './objects/ExecutionScope.js';
 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 { AnyReference, CFunction, CFunctionEntry, CFunctionResult, CallableParameter, ComponentPin, ComponentUnitDefinition } from './objects/types.js';
 import { Wire } from './objects/Wire.js';
 import { Logger } from './logger.js';
 import { UnitDimension } from './helpers.js';
@@ -53,7 +53,10 @@ export declare class ExecutionContext {
         copy: boolean;
         angle?: NumericValue;
         followWireOrientation: boolean;
+        units: [string, ComponentUnitDefinition][];
     }, isModule?: boolean): ClassComponent;
+    private extractPinsFromUnits;
+    private generateComponentUnits;
     private removeArrangePropDuplicates;
     private getArrangePropPins;
     printPoint(extra?: string): void;

package/dist/types/globals.d.ts

@@ -2,6 +2,7 @@ export declare const TOOL_VERSION = "0.1.5";
 export declare const Delimiter1 = "-";
 export declare const DoubleDelimiter1 = "--";
 export declare const BaseNamespace = "--.";
+export declare const RefdesFileSuffix = ".refdes.json";
 export declare enum GlobalNames {
     __root = "--root",
     symbol = "symbol"
@@ -114,3 +115,4 @@ export declare const RenderFlags: {
 };
 export declare const SymbolValidatorContext = "_sym";
 export declare const TrailerArrayIndex = "index";
+export declare const DefaultComponentUnit = "__default";

package/dist/types/graph.d.ts

@@ -1,7 +1,7 @@
 import { Graph } from "@dagrejs/graphlib";
 import { SymbolPinDefintion } from "./draw_symbols.js";
 import { RenderFrame, RenderComponent, RenderWire } from "./layout.js";
-import { ClassComponent } from "./objects/ClassComponent.js";
+import { ClassComponent, ComponentUnit } from "./objects/ClassComponent.js";
 import { SequenceItem } from "./objects/ExecutionScope.js";
 import { Net } from "./objects/Net.js";
 import { Logger } from "./logger.js";
@@ -22,7 +22,7 @@ export declare class NetGraph {
     private getComponentName;
 }
 export declare function getWireName(wireId: number): string;
-export declare function generateLayoutPinDefinition(component: ClassComponent): SymbolPinDefintion[];
+export declare function generateLayoutPinDefinition(componentUnit: ComponentUnit): SymbolPinDefintion[];
 export declare enum RenderItemType {
     Wire = "wire",
     Component = "component"

package/dist/types/helpers.d.ts

@@ -11,6 +11,7 @@ export type SVGWindow = any;
 import { NumericValue } from "./objects/ParamDefinition.js";
 import { NodeScriptEnvironment } from "./environment.js";
 import { ClassComponent } from "./objects/ClassComponent.js";
+import { ImportedModule } from "./objects/types.js";
 export declare enum JSModuleType {
     CommonJs = "cjs",
     ESM = "mjs"
@@ -46,7 +47,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[], postAnnotationCallbacks: ((options: ScriptOptions, scriptData: string, tree: ScriptContext, tokens: CommonTokenStream, componentLinks: Map<ParserRuleContext, ClassComponent>) => void)[]): 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>, importedModule: ImportedModule[], environment: NodeScriptEnvironment) => void)[]): Promise<RenderScriptReturn>;
 export declare abstract class ParseOutputHandler {
     beforeRender: boolean;
     afterRender: boolean;

package/dist/types/layout.d.ts

@@ -1,6 +1,6 @@
 import { Graph } from '@dagrejs/graphlib';
 import { SymbolGraphic, SymbolText, SymbolDrawingCommands, SimplePoint } from "./draw_symbols.js";
-import { ClassComponent } from "./objects/ClassComponent.js";
+import { ClassComponent, ComponentUnit } from "./objects/ClassComponent.js";
 import { WireAutoDirection } from './globals.js';
 import { Wire, WireSegment } from './objects/Wire.js';
 import { Net } from './objects/Net.js';
@@ -41,7 +41,7 @@ export declare class LayoutEngine {
     printWarnings(): void;
 }
 type RenderItem = RenderComponent | RenderWire | RenderText;
-export declare function applyComponentParamsToSymbol(component: ClassComponent, symbol: SymbolGraphic): void;
+export declare function applyComponentParamsToSymbol(componentUnit: ComponentUnit, symbol: SymbolGraphic): void;
 export declare function getBounds(components: (RenderComponent | RenderText)[], wires: RenderWire[], junctions: RenderJunction[], frames: RenderFrame[]): BoundBox;
 export declare class RenderObject {
     x: NumericValue;
@@ -89,11 +89,12 @@ export type MergedWire = {
 };
 export declare class RenderComponent extends RenderObject {
     component: ClassComponent;
+    unitId: string;
     symbol: SymbolGraphic;
     width: number;
     height: number;
     displaySymbol: string | null;
-    constructor(component: ClassComponent, width: number, height: number);
+    constructor(component: ClassComponent, unitId: string, width: number, height: number);
     doesOverlap(other: RenderComponent): boolean;
     toString(): string;
 }
@@ -146,7 +147,7 @@ export type SheetFrame = {
     junctions: RenderJunction[];
     mergedWires: MergedWire[];
 };
-export declare function CalculatePinPositions(component: ClassComponent): Map<number, {
+export declare function CalculatePinPositions(unit: ComponentUnit): Map<number, {
     x: NumericValue;
     y: NumericValue;
     angle: NumericValue;

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

@@ -6,6 +6,32 @@ import { PinDefinition, PinId } from './PinDefinition.js';
 import { WireSegment } from './Wire.js';
 import { ExecutionContext } from '../execute.js';
 import { NumericValue } from './ParamDefinition.js';
+export declare class ComponentUnit {
+    parent: ClassComponent;
+    unitId: string;
+    refdesSuffix: string;
+    suffix: string | null;
+    get instanceName(): string;
+    parameters: Map<string, number | string | NumericValue>;
+    numPins: number;
+    pins: Map<PinId, PinDefinition>;
+    pinsFlat: PinDefinition[];
+    pinsMaxPositions: Map<string, number>;
+    arrangeProps: Map<string, PinId[]> | null;
+    displayProp: SymbolDrawingCommands | null;
+    widthProp: number | null;
+    heightProp: number | null;
+    angleProp: number;
+    followWireOrientationProp: boolean;
+    wireOrientationAngle: number;
+    useWireOrientationAngle: boolean;
+    didSetWireOrientationAngle: boolean;
+    _unplacedPins: PinId[];
+    constructor(unitId: string, parent: ClassComponent);
+    clone(): ComponentUnit;
+    setParam(key: string, value: number | string | NumericValue): void;
+    isEqual(other: ComponentUnit): boolean;
+}
 export declare class ClassComponent {
     instanceName: string;
     numPins: number;
@@ -14,27 +40,21 @@ export declare class ClassComponent {
     pinNets: Map<PinId, Net>;
     pinWires: Map<number, WireSegment[]>;
     pinsMaxPositions: Map<string, number>;
+    units: ComponentUnit[];
     _cachedPins: string;
     _cachedParams: string;
     _copyID?: number;
     _copyFrom?: ClassComponent;
     _pointLinkComponent?: ClassComponent;
     _unplacedPins: PinId[];
-    arrangeProps: Map<string, PinId[]> | null;
-    displayProp: SymbolDrawingCommands | null;
-    widthProp: number | null;
-    heightProp: number | null;
     typeProp: string | null;
     copyProp: boolean;
-    angleProp: number;
-    followWireOrientationProp: boolean;
-    wireOrientationAngle: number;
-    useWireOrientationAngle: boolean;
-    didSetWireOrientationAngle: boolean;
     assignedRefDes: string | null;
     placeHolderRefDes: string | null;
+    forceSaveRefdesAnnotation: boolean;
     ctxReferences: CtxReference[];
     _creationIndex: number;
+    pinUnitMap: Map<PinId, ComponentUnit>;
     constructor(instanceName: string, numPins: number);
     setupPins(): void;
     getDefaultPin(): PinId;
@@ -51,6 +71,10 @@ export declare class ClassComponent {
     static simple(instanceName: string, numPins: number): ClassComponent;
     isEqual(other: ClassComponent): boolean;
     clone(): ClassComponent;
+    getUnit(unitId?: string | null): ComponentUnit;
+    addDefaultUnit(displayProp: SymbolDrawingCommands): void;
+    refreshPinUnitMap(): void;
+    getUnitForPin(pinId: PinId): ComponentUnit;
 }
 export declare class ModuleComponent extends ClassComponent {
     moduleContainsExpressions?: Expressions_blockContext;
@@ -63,4 +87,5 @@ export type CtxReference = {
     ctx: ParserRuleContext;
     indexedStack: [ParserRuleContext, number][];
     creationFlag: boolean;
+    filePath: string;
 };

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

@@ -1,10 +1,12 @@
-import { ParserRuleContext, Token } from 'antlr4ng';
+import { CommonTokenStream, ParserRuleContext, Token } from 'antlr4ng';
 import { ExecutionContext } from '../execute.js';
 import { ClassComponent } from './ClassComponent.js';
 import { Net } from './Net.js';
 import { NumericValue, PercentageValue } from './ParamDefinition.js';
 import { ReferenceTypes } from '../globals.js';
-import { PinId } from './PinDefinition.js';
+import { PinDefinition, PinId } from './PinDefinition.js';
+import { ScriptContext } from 'src/antlr/CircuitScriptParser.js';
+import { SymbolDrawingCommands } from 'src/draw_symbols.js';
 export type CFunction = (args: CallableParameter[], options?: CFunctionOptions) => CFunctionResult;
 export declare class CFunctionEntry {
     name: string;
@@ -127,10 +129,24 @@ export declare class ImportedModule {
     specifiedImports: string[];
     moduleNamespace: string;
     moduleFilePath: string;
-    constructor(moduleName: string, moduleNamespace: string, moduleFilePath: string, context: ExecutionContext, flag: ImportFunctionHandling, specifiedImports: string[]);
+    enableRefdesAnnotation: boolean;
+    enableRefdesAnnotationFile: boolean;
+    tree: ScriptContext;
+    tokens: CommonTokenStream;
+    constructor(moduleName: string, moduleNamespace: string, moduleFilePath: string, tree: ScriptContext, tokens: CommonTokenStream, context: ExecutionContext, flag: ImportFunctionHandling, specifiedImports: string[]);
 }
 export declare enum ImportFunctionHandling {
     AllWithNamespace = "all-with-namespace",
     AllMergeIntoNamespace = "all-merge-into-namespace",
     SpecificMergeIntoNamespace = "specific-merge-into-namespace"
 }
+export type ComponentUnitDefinition = {
+    width: NumericValue | null;
+    height: NumericValue | null;
+    angle: NumericValue | null;
+    followWireOrientation: boolean | null;
+    pins: PinDefinition[];
+    display: SymbolDrawingCommands | null;
+    arrange: any | null;
+    suffix: string | null;
+};

package/dist/types/validate/SymbolValidatorVisitor.d.ts

@@ -7,10 +7,6 @@ import { SymbolTable } from "./SymbolTable.js";
 import { BaseVisitor } from "../BaseVisitor.js";
 export declare class SymbolValidatorVisitor extends BaseVisitor {
     symbolTable: SymbolTable;
-    filePathStack: string[];
-    enterFile(filePath: string): void;
-    exitFile(): void;
-    getCurrentFile(): string;
     protected addSymbolVariable(token: Token, name: string, value: ComplexType, executor?: ExecutionContext | null): void;
     protected addSymbolFunction(token: Token, functionName: string, funcDefinedParameters: FunctionDefinedParameter[]): void;
     protected handleAtomSymbol(atom: TerminalNode): SymbolTableItem;

package/dist/types/visitor.d.ts

@@ -22,6 +22,9 @@ export declare class ParserVisitor extends BaseVisitor {
     visitPath_block: (ctx: Path_blockContext) => void;
     visitGraph_expressions: (ctx: Graph_expressionsContext) => void;
     visitCreate_component_expr: (ctx: Create_component_exprContext) => void;
+    private extractComponentUnitDefinition;
+    private extractComponentUnitProperties;
+    private createComponentPropertyValidator;
     visitCreate_graphic_expr: (ctx: Create_graphic_exprContext) => void;
     visitGraphic_expressions_block: (ctx: Graphic_expressions_blockContext) => void;
     visitGraphicCommandExpr: (ctx: GraphicCommandExprContext) => void;
@@ -63,6 +66,7 @@ export declare class ParserVisitor extends BaseVisitor {
     visitIf_inner_expr: (ctx: If_inner_exprContext) => void;
     visitWhile_expr: (ctx: While_exprContext) => void;
     visitFor_expr: (ctx: For_exprContext) => void;
+    private setCurrentComponentRefdes;
     visitAnnotation_comment_expr: (ctx: Annotation_comment_exprContext) => void;
     visitPart_set_expr: (ctx: Part_set_exprContext) => void;
     visitPart_match_block: (ctx: Part_match_blockContext) => void;
@@ -71,10 +75,11 @@ export declare class ParserVisitor extends BaseVisitor {
     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;
+    checkModuleHasRefdesFile(filePath: string): Promise<void>;
     private resolveDataExpr;
     private resolveDataValue;
     pinTypes: PinTypes[];
-    private parseCreateComponentPins;
+    private extractPinDefintion;
     private parseCreateModulePorts;
     private getArrangePropFromModulePorts;
     private getPortItems;
@@ -95,6 +100,7 @@ export declare class ParserVisitor extends BaseVisitor {
         nets: ComponentPinNetPair[];
     };
     annotateComponents(): void;
+    private setComponentUnitRefdesSuffix;
     private renameNetsWithRefdes;
     applySheetFrameComponent(): {
         frameComponent: ClassComponent | null;

package/package.json

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