circuitscript 0.1.8 → 0.1.9

package/dist/esm/BaseVisitor.js

@@ -33,6 +33,7 @@ export class BaseVisitor extends CircuitScriptVisitor {
     onErrorHandler = null;
     environment;
     importedFiles = [];
+    warnings = [];
     onImportFile = async (visitor, filePath, fileData, onErrorHandler) => {
         throw "Import file not implemented";
     };
@@ -41,7 +42,7 @@ export class BaseVisitor extends CircuitScriptVisitor {
         this.logger = new Logger();
         this.onErrorHandler = onErrorHandler;
         this.environment = environment;
-        this.startingContext = new ExecutionContext(DoubleDelimiter1, `${DoubleDelimiter1}.`, '/', 0, 0, silent, this.logger, null);
+        this.startingContext = new ExecutionContext(DoubleDelimiter1, `${DoubleDelimiter1}.`, '/', 0, 0, silent, this.logger, this.warnings, null);
         const scope = this.startingContext.scope;
         scope.sequence.push([
             SequenceAction.At, scope.componentRoot, scope.currentPin
@@ -423,7 +424,7 @@ export class BaseVisitor extends CircuitScriptVisitor {
         this.setResult(ctx, returnList);
     };
     visitImport_expr = (ctx) => {
-        throw new RuntimeExecutionError("Cannot parse imports here", ctx.start, ctx.stop);
+        throw new RuntimeExecutionError("Cannot parse imports here", ctx);
     };
     visitFunction_return_expr = (ctx) => {
         const executor = this.getExecutor();
@@ -517,7 +518,7 @@ export class BaseVisitor extends CircuitScriptVisitor {
         }
         catch (err) {
             if (ctx != null) {
-                throw new RuntimeExecutionError("An error occurred while importing file", ctx.start, ctx.stop);
+                throw new RuntimeExecutionError("An error occurred while importing file", ctx);
             }
             else {
                 this.log('An error occurred while importing file:', err.message);
@@ -533,7 +534,7 @@ export class BaseVisitor extends CircuitScriptVisitor {
             }
         }
         if (errorMessage !== null && ctx) {
-            throw new RuntimeExecutionError(errorMessage, ctx.start, ctx.end);
+            throw new RuntimeExecutionError(errorMessage, ctx);
         }
         const newImportedFile = {
             id: name.trim(),
@@ -637,7 +638,7 @@ export class BaseVisitor extends CircuitScriptVisitor {
         const executionLevel = currentExecutionContext.executionLevel;
         const executionContextNamespace = currentExecutionContext.namespace
             + executionContextName + ".";
-        const newExecutor = new ExecutionContext(executionContextName, executionContextNamespace, netNamespace, executionLevel + 1, this.getExecutor().scope.indentLevel + 1, currentExecutionContext.silent, currentExecutionContext.logger, parentContext);
+        const newExecutor = new ExecutionContext(executionContextName, executionContextNamespace, netNamespace, executionLevel + 1, this.getExecutor().scope.indentLevel + 1, currentExecutionContext.silent, currentExecutionContext.logger, currentExecutionContext.warnings, parentContext);
         executionStack.push(newExecutor);
         this.setupDefinedParameters(funcDefinedParameters, passedInParameters, newExecutor);
         return newExecutor;
@@ -654,7 +655,7 @@ export class BaseVisitor extends CircuitScriptVisitor {
         }
         const result = validateFunction(value);
         if (!result) {
-            throw new RuntimeExecutionError(`Invalid ${expectedType}`, context.start, context.stop);
+            throw new RuntimeExecutionError(`Invalid ${expectedType}`, context);
         }
         return result;
     }

package/dist/esm/draw_symbols.js

@@ -2,7 +2,7 @@ import { milsToMM } from "./helpers.js";
 import { ColorScheme, CustomSymbolParamTextSize, CustomSymbolPinIdSize, CustomSymbolPinTextSize, CustomSymbolRefDesSize, PortArrowSize, PortPaddingHorizontal, PortPaddingVertical, ReferenceTypes, RenderFlags, SymbolPinSide, defaultFont, defaultPinIdTextSize, defaultPinNameTextSize, defaultSymbolLineWidth, fontDisplayScale } from "./globals.js";
 import { Geometry, GeometryProp, HorizontalAlign, HorizontalAlignProp, Textbox, VerticalAlign, VerticalAlignProp } from "./geometry.js";
 import { PinTypes } from "./objects/PinTypes.js";
-import { roundValue, throwWithContext } from "./utils.js";
+import { roundValue, RuntimeExecutionError, throwWithContext } from "./utils.js";
 import { DeclaredReference, UndeclaredReference } from "./objects/types.js";
 import { numeric, NumericValue } from "./objects/ParamDefinition.js";
 export class SymbolGraphic {
@@ -81,6 +81,9 @@ export class SymbolGraphic {
     }
     pinPosition(id) {
         const pin = this.drawing.getPinPosition(id);
+        if (pin === null) {
+            throw new RuntimeExecutionError(`Could not determine pin ${id} position`);
+        }
         const [x, y] = pin.start;
         const useX = roundValue(x);
         const useY = roundValue(y);

package/dist/esm/execute.js

@@ -2,7 +2,7 @@ import { BlockTypes, ComponentTypes, Delimiter1, GlobalNames, NoNetText, ParamKe
 import { ClassComponent, ModuleComponent } from './objects/ClassComponent.js';
 import { ActiveObject, ExecutionScope, FrameAction, SequenceAction } from './objects/ExecutionScope.js';
 import { Net } from './objects/Net.js';
-import { numeric } from './objects/ParamDefinition.js';
+import { numeric, NumericValue } from './objects/ParamDefinition.js';
 import { PortSide } from './objects/PinDefinition.js';
 import { DeclaredReference, Direction } from './objects/types.js';
 import { Wire } from './objects/Wire.js';
@@ -27,7 +27,8 @@ export class ExecutionContext {
     __functionCache = {};
     parentContext;
     componentAngleFollowsWire = true;
-    constructor(name, namespace, netNamespace, executionLevel = 0, indentLevel = 0, silent = false, logger, parent) {
+    warnings = [];
+    constructor(name, namespace, netNamespace, executionLevel = 0, indentLevel = 0, silent = false, logger, warnings, parent) {
         this.name = name;
         this.namespace = namespace;
         this.netNamespace = netNamespace;
@@ -39,6 +40,14 @@ export class ExecutionContext {
         this.silent = silent;
         this.log('create new execution context', this.namespace, this.name, this.scope.indentLevel);
         this.parentContext = parent;
+        this.warnings = warnings;
+    }
+    logWarning(message, context, fileName) {
+        this.warnings.push({
+            message,
+            ctx: context,
+            fileName,
+        });
     }
     log(...params) {
         const indentOutput = ''.padStart(this.scope.indentLevel * 4, '    ');
@@ -125,7 +134,6 @@ export class ExecutionContext {
         pins.forEach((pin) => {
             component.pins.set(pin.id, pin);
         });
-        component.arrangeProps = props.arrange ?? null;
         component.displayProp = props.display ?? null;
         component.widthProp = props.width ?? null;
         component.heightProp = props.height ?? null;
@@ -138,6 +146,33 @@ export class ExecutionContext {
                 useAngle += 360;
             }
         }
+        if (props.display === null && props.arrange === null) {
+            const tmpArrangeLeft = [];
+            const tmpArrangeRight = [];
+            pins.forEach((pin, index) => {
+                const useArray = (index % 2 === 0) ? tmpArrangeLeft : tmpArrangeRight;
+                useArray.push(numeric(pin.id));
+            });
+            const arrangeProp = new Map([
+                [SymbolPinSide.Left, tmpArrangeLeft],
+                [SymbolPinSide.Right, tmpArrangeRight]
+            ]);
+            props.arrange = arrangeProp;
+        }
+        if (props.arrange !== null) {
+            component.arrangeProps = this.removeArrangePropDuplicates(props.arrange);
+            const arrangePropPins = this.getArrangePropPins(component.arrangeProps).map(item => {
+                return item.toNumber();
+            });
+            pins.forEach(pin => {
+                if (arrangePropPins.indexOf(pin.id) === -1) {
+                    this.logWarning(`Pin ${pin.id} is not specified in arrange property`);
+                }
+            });
+        }
+        else {
+            component.arrangeProps = null;
+        }
         component.angleProp = useAngle ?? 0;
         component.followWireOrientationProp = props.followWireOrientation;
         const paramsMap = new Map();
@@ -181,6 +216,59 @@ export class ExecutionContext {
         this.log('add symbol', instanceName, '[' + pinsOutput.join(', ') + ']');
         return component;
     }
+    removeArrangePropDuplicates(arrangeProp) {
+        const sides = [
+            SymbolPinSide.Left,
+            SymbolPinSide.Right,
+            SymbolPinSide.Top,
+            SymbolPinSide.Bottom
+        ];
+        const result = new Map();
+        const seenIds = [];
+        sides.forEach(side => {
+            let items = arrangeProp.get(side) ?? [];
+            if (!Array.isArray(items)) {
+                items = [items];
+            }
+            const uniqueItems = [];
+            items.forEach(item => {
+                if (item instanceof NumericValue) {
+                    if (seenIds.indexOf(item.toNumber()) === -1) {
+                        seenIds.push(item.toNumber());
+                        uniqueItems.push(item);
+                    }
+                    else {
+                        this.logWarning(`Pin ${item.toNumber()} specified more than once in arrange property`);
+                    }
+                }
+                else {
+                    uniqueItems.push(item);
+                }
+            });
+            result.set(side, uniqueItems);
+        });
+        return result;
+    }
+    getArrangePropPins(arrangeProps) {
+        const pins = [];
+        const sides = [
+            SymbolPinSide.Left,
+            SymbolPinSide.Right,
+            SymbolPinSide.Top,
+            SymbolPinSide.Bottom
+        ];
+        sides.forEach(side => {
+            const items = arrangeProps.get(side);
+            if (items) {
+                items.forEach(item => {
+                    if (item instanceof NumericValue) {
+                        pins.push(item);
+                    }
+                });
+            }
+        });
+        return pins;
+    }
     printPoint(extra = '') {
         let netString = NoNetText;
         if (this.scope.currentComponent === null || this.scope.currentPin === null) {

package/dist/esm/helpers.js

@@ -5,7 +5,7 @@ import { generateKiCADNetList, printTree } from "./export.js";
 import { LayoutEngine } from "./layout.js";
 import { parseFileWithVisitor } from "./parser.js";
 import { generatePdfOutput, generateSvgOutput, renderSheetsToSVG } from "./render.js";
-import { generateDebugSequenceAction, ParseError, ParseSyntaxError, RenderError, resolveToNumericValue, RuntimeExecutionError, sequenceActionString, SimpleStopwatch } from "./utils.js";
+import { generateDebugSequenceAction, ParseError, ParseSyntaxError, printWarnings, RenderError, resolveToNumericValue, RuntimeExecutionError, sequenceActionString, SimpleStopwatch } from "./utils.js";
 import { ParserVisitor } from "./visitor.js";
 import { SymbolValidatorVisitor } from "./validate/SymbolValidatorVisitor.js";
 import { SymbolValidatorResolveVisitor } from "./validate/SymbolValidatorResolveVisitor.js";
@@ -185,6 +185,7 @@ export async function renderScript(scriptData, outputPath, options) {
     visitor.log('reading file');
     visitor.log('done reading file');
     const { tree, parser, parserTimeTaken, lexerTimeTaken } = await parseFileWithVisitor(visitor, scriptData);
+    printWarnings(visitor.getWarnings());
     showStats && console.log('Lexing took:', lexerTimeTaken);
     showStats && console.log('Parsing took:', parserTimeTaken);
     if (dumpNets) {

package/dist/esm/layout.js

@@ -2,7 +2,7 @@ import graphlib, { Graph } from '@dagrejs/graphlib';
 const { alg } = graphlib;
 import { SymbolCustom, SymbolDrawing, SymbolCustomModule, SymbolPlaceholder, SymbolText, PlaceHolderCommands } from "./draw_symbols.js";
 import { FrameAction, SequenceAction } from "./objects/ExecutionScope.js";
-import { ComponentTypes, defaultFrameTitleTextSize, defaultGridSizeUnits, FrameType, ParamKeys, SymbolPinSide, WireAutoDirection } from './globals.js';
+import { ComponentTypes, defaultFrameTitleTextSize, defaultGridSizeUnits, FrameType, ParamKeys, WireAutoDirection } from './globals.js';
 import { Geometry, HorizontalAlign, VerticalAlign } from './geometry.js';
 import { Logger } from './logger.js';
 import { FixedFrameIds, Frame, FrameParamKeys, FramePlotDirection } from './objects/Frame.js';
@@ -1058,52 +1058,39 @@ function generateLayoutPinDefinition(component) {
     const pins = component.pins;
     const symbolPinDefinitions = [];
     const existingPinIds = Array.from(pins.keys());
-    if (component.arrangeProps === null) {
-        for (let i = 0; i < existingPinIds.length; i++) {
-            const pinPosition = Math.floor(i / 2);
-            const pin = pins.get(existingPinIds[i]);
-            symbolPinDefinitions.push({
-                side: (i % 2 === 0) ? SymbolPinSide.Left : SymbolPinSide.Right,
-                pinId: existingPinIds[i],
-                text: pin.name,
-                position: pinPosition,
-                pinType: pin.pinType,
-            });
+    const arrangeProps = component.arrangeProps ?? [];
+    const addedPins = [];
+    for (const [key, items] of arrangeProps) {
+        let useItems;
+        if (!Array.isArray(items)) {
+            useItems = [items];
         }
-    }
-    else {
-        const addedPins = [];
-        for (const [key, items] of component.arrangeProps) {
-            let useItems;
-            if (!Array.isArray(items)) {
-                useItems = [items];
-            }
-            else {
-                useItems = [...items];
-            }
-            useItems.forEach(pinId => {
-                if (pinId instanceof NumericValue) {
-                    const pinIdValue = pinId.toNumber();
-                    if (existingPinIds.indexOf(pinIdValue) !== -1) {
-                        const pin = pins.get(pinIdValue);
-                        symbolPinDefinitions.push({
-                            side: key,
-                            pinId: pinIdValue,
-                            text: pin.name,
-                            position: pin.position,
-                            pinType: pin.pinType,
-                        });
-                        addedPins.push(pinIdValue);
-                    }
-                }
-            });
+        else {
+            useItems = [...items];
         }
-        const unplacedPins = existingPinIds.filter(pinId => {
-            return addedPins.indexOf(pinId) === -1;
+        useItems.forEach(pinId => {
+            if (pinId instanceof NumericValue) {
+                const pinIdValue = pinId.toNumber();
+                if (existingPinIds.indexOf(pinIdValue) !== -1) {
+                    const pin = pins.get(pinIdValue);
+                    symbolPinDefinitions.push({
+                        side: key,
+                        pinId: pinIdValue,
+                        text: pin.name,
+                        position: pin.position,
+                        pinType: pin.pinType,
+                    });
+                    addedPins.push(pinIdValue);
+                }
+            }
         });
-        if (unplacedPins.length > 0) {
-            throw "'arrange' property is defined, but not all pins are specified: " + unplacedPins.join(",");
-        }
+    }
+    const unplacedPins = existingPinIds.filter(pinId => {
+        return addedPins.indexOf(pinId) === -1;
+    });
+    if (unplacedPins.length > 0) {
+        component._unplacedPins = unplacedPins;
+        console.warn("Warning: There are unplaced pins: " + unplacedPins);
     }
     return symbolPinDefinitions;
 }
@@ -1461,7 +1448,9 @@ export function CalculatePinPositions(component) {
     tmpSymbol.refreshDrawing();
     const pins = component.pins;
     pins.forEach((value, key) => {
-        pinPositionMapping.set(key, tmpSymbol.pinPosition(key));
+        if (component._unplacedPins.indexOf(key) === -1) {
+            pinPositionMapping.set(key, tmpSymbol.pinPosition(key));
+        }
     });
     return pinPositionMapping;
 }

package/dist/esm/objects/ClassComponent.js

@@ -15,6 +15,7 @@ export class ClassComponent {
     _copyID = null;
     _copyFrom = null;
     _pointLinkComponent;
+    _unplacedPins = [];
     arrangeProps = null;
     displayProp = null;
     widthProp = null;

package/dist/esm/objects/ExecutionScope.js

@@ -131,12 +131,13 @@ export class ExecutionScope {
     exitContext() {
         return this.contextStack.pop();
     }
-    findPropertyKeyTree() {
+    findPropertyKeyTree(visitor) {
         const keyNames = [];
         for (let i = this.contextStack.length - 1; i >= 0; i--) {
             const ctx = this.contextStack[i];
             if (ctx instanceof Property_key_exprContext) {
-                keyNames.push([ctx, ctx.getText()]);
+                const result = visitor.visitResult(ctx);
+                keyNames.push([ctx, result]);
             }
             else if (typeof ctx === 'number') {
                 keyNames.push(['index', ctx]);
@@ -150,9 +151,9 @@ export class ExecutionScope {
     popOnPropertyHandler() {
         return this.onPropertyHandler.pop();
     }
-    triggerPropertyHandler(value, valueCtx) {
+    triggerPropertyHandler(visitor, value, valueCtx) {
         const lastHandler = this.onPropertyHandler[this.onPropertyHandler.length - 1];
-        const propertyTree = this.findPropertyKeyTree();
+        const propertyTree = this.findPropertyKeyTree(visitor);
         lastHandler && lastHandler(propertyTree, value, valueCtx);
     }
 }

package/dist/esm/utils.js

@@ -1,4 +1,5 @@
 import { Big } from 'big.js';
+import { ParserRuleContext } from "antlr4ng";
 import { ClassComponent } from "./objects/ClassComponent.js";
 import { NumericValue } from "./objects/ParamDefinition.js";
 import { SequenceAction } from './objects/ExecutionScope.js';
@@ -243,30 +244,52 @@ export class BaseError extends Error {
     startToken;
     endToken;
     filePath;
-    constructor(message, startToken, endToken, filePath) {
+    constructor(message, startTokenOrCtx, endToken, filePath) {
         super(message);
         this.message = message;
-        this.startToken = startToken;
-        this.endToken = endToken;
+        if (startTokenOrCtx instanceof ParserRuleContext) {
+            this.startToken = startTokenOrCtx.start;
+            this.endToken = startTokenOrCtx.stop;
+        }
+        else {
+            this.startToken = startTokenOrCtx;
+            this.endToken = endToken;
+        }
         this.filePath = filePath;
     }
     toString() {
         const parts = [this.name];
-        if (this.startToken) {
-            const { line, column } = this.startToken;
-            if (this.endToken && (this.endToken.line !== this.startToken.line || this.endToken.column !== this.startToken.column)) {
-                const endLine = this.endToken.line;
-                const endColumn = this.endToken.column + (this.endToken.stop - this.endToken.start);
-                parts.push(` at ${line}:${column}-${endLine}:${endColumn}`);
-            }
-            else {
-                parts.push(` at ${line}:${column}`);
-            }
+        const linePosition = getLinePositionAsString({
+            start: this.startToken,
+            stop: this.endToken
+        });
+        if (linePosition !== null) {
+            parts.push(linePosition);
         }
         parts.push(`: ${this.message}`);
         return parts.join('');
     }
 }
+export function getLinePositionAsString(ctx) {
+    if (ctx === null || ctx === undefined) {
+        return null;
+    }
+    const startToken = ctx.start;
+    const endToken = ctx.stop;
+    let result = null;
+    if (startToken) {
+        const { line, column } = startToken;
+        if (endToken && (endToken.line !== startToken.line || endToken.column !== startToken.column)) {
+            const endLine = endToken.line;
+            const endColumn = endToken.column + (endToken.stop - endToken.start);
+            result = ` at ${line}:${column}-${endLine}:${endColumn}`;
+        }
+        else {
+            result = ` at ${line}:${column}`;
+        }
+    }
+    return result;
+}
 export class ParseSyntaxError extends BaseError {
     name = 'ParseSyntaxError';
 }
@@ -284,3 +307,21 @@ export class RenderError extends Error {
         this.stage = stage;
     }
 }
+export function printWarnings(warnings) {
+    const warningMessages = [];
+    warnings.forEach(item => {
+        const { message } = item;
+        const linePosition = getLinePositionAsString(item.ctx);
+        const parts = [message];
+        if (linePosition !== null) {
+            parts.push(linePosition);
+        }
+        const finalMessage = parts.join('');
+        if (warningMessages.indexOf(finalMessage) === -1) {
+            warningMessages.push(finalMessage);
+        }
+    });
+    warningMessages.forEach(message => {
+        console.log(`Warning: ${message}`);
+    });
+}