circuitscript 0.1.5 → 0.1.7

package/dist/cjs/validate/SymbolValidatorVisitor.js

@@ -0,0 +1,170 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SymbolValidatorVisitor = void 0;
+const builtinMethods_js_1 = require("../builtinMethods.js");
+const types_js_1 = require("../objects/types.js");
+const SymbolTable_js_1 = require("./SymbolTable.js");
+const BaseVisitor_js_1 = require("../BaseVisitor.js");
+const globals_js_1 = require("../globals.js");
+class SymbolValidatorVisitor extends BaseVisitor_js_1.BaseVisitor {
+    constructor() {
+        super(...arguments);
+        this.symbolTable = new SymbolTable_js_1.SymbolTable();
+        this.filePathStack = [];
+        this.visitImport_expr = (ctx) => {
+            const ID = ctx.ID().toString();
+            const { pathExists } = this.handleImportFile(ID, false, ctx);
+            if (!pathExists) {
+                this.symbolTable.addUndefined(this.getCurrentFile(), this.getExecutor(), ID, ctx.ID().getSymbol());
+            }
+        };
+        this.visitAssignment_expr = (ctx) => {
+            const ctxDataExpr = ctx.data_expr();
+            this.visit(ctxDataExpr);
+            const value = this.getResult(ctxDataExpr);
+            const atomId = ctx.atom_expr().ID(0);
+            const atomText = atomId.getText();
+            const executor = this.getExecutor();
+            if (!this.symbolTable.exists(executor, atomText)) {
+                this.addSymbolVariable(atomId.getSymbol(), atomId.getText(), value);
+            }
+            else {
+                const tmpSymbol = this.symbolTable.get(executor, atomText);
+                this.addSymbolInstance(tmpSymbol, atomId.getSymbol());
+            }
+            return null;
+        };
+        this.visitAtom_expr = (ctx) => {
+            const tmpSymbol = this.handleAtomSymbol(ctx.ID(0));
+            this.setResult(ctx, tmpSymbol);
+        };
+        this.visitFunction_call_expr = (ctx) => {
+            this.handleAtomSymbol(ctx.ID());
+            if (ctx.trailer_expr().length > 0) {
+                ctx.trailer_expr().forEach(item => {
+                    if (item.OPEN_PAREN() && item.CLOSE_PAREN()) {
+                        const params = item.parameters();
+                        if (params) {
+                            this.visit(params);
+                        }
+                    }
+                });
+            }
+        };
+        this.visitValueAtomExpr = (ctx) => {
+            let value = null;
+            const ctxValueExpr = ctx.value_expr();
+            const cxtAtomExpr = ctx.atom_expr();
+            if (ctxValueExpr) {
+                this.visit(ctxValueExpr);
+                value = this.getResult(ctxValueExpr);
+            }
+            else if (cxtAtomExpr) {
+                this.visit(cxtAtomExpr);
+                value = this.getResult(cxtAtomExpr);
+            }
+            this.setResult(ctx, value);
+        };
+        this.visitUnaryOperatorExpr = (ctx) => {
+            this.visit(ctx.data_expr());
+        };
+        this.visitMultiplyExpr = (ctx) => {
+            this.visit(ctx.data_expr(0));
+            this.visit(ctx.data_expr(1));
+        };
+        this.visitAdditionExpr = (ctx) => {
+            this.visit(ctx.data_expr(0));
+            this.visit(ctx.data_expr(1));
+        };
+        this.visitBinaryOperatorExpr = (ctx) => {
+            this.visit(ctx.data_expr(0));
+            this.visit(ctx.data_expr(1));
+        };
+        this.visitDataExpr = (ctx) => {
+            return;
+        };
+        this.visitFunction_def_expr = (ctx) => {
+            const functionName = ctx.ID().getText();
+            let funcDefinedParameters = [];
+            const ctxFunctionArgsExpr = ctx.function_args_expr();
+            if (ctxFunctionArgsExpr) {
+                this.visit(ctxFunctionArgsExpr);
+                funcDefinedParameters = this.getResult(ctxFunctionArgsExpr);
+            }
+            this.addSymbolFunction(ctx.ID().getSymbol(), functionName, funcDefinedParameters);
+            const executionContextName = functionName + globals_js_1.SymbolValidatorContext;
+            const passedInParamsNull = funcDefinedParameters.map((param, index) => {
+                return ['position', index, null];
+            });
+            const newExecutor = this.enterNewChildContext(this.executionStack, this.getExecutor(), executionContextName, { netNamespace: "" }, funcDefinedParameters, passedInParamsNull);
+            funcDefinedParameters.forEach(param => {
+                this.addSymbolVariable(param[1], param[0], null, newExecutor);
+            });
+            this.runExpressions(newExecutor, ctx.function_expr());
+            this.executionStack.pop();
+        };
+    }
+    enterFile(filePath) {
+        this.filePathStack.push(filePath);
+    }
+    exitFile() {
+        this.filePathStack.pop();
+    }
+    getCurrentFile() {
+        return this.filePathStack[this.filePathStack.length - 1];
+    }
+    addSymbolVariable(token, name, value, executor = null) {
+        const useExecutor = executor === null ? this.getExecutor() : executor;
+        this.symbolTable.addVariable(token, this.getCurrentFile(), useExecutor, name, value);
+        this.log2('add symbol variable: ' + name);
+    }
+    addSymbolFunction(token, functionName, funcDefinedParameters) {
+        if (!this.symbolTable.exists(this.getExecutor(), functionName)) {
+            this.symbolTable.addFunction(token, this.getCurrentFile(), this.getExecutor(), functionName, funcDefinedParameters);
+            this.log2('add symbol function: ' + functionName);
+        }
+    }
+    handleAtomSymbol(atom) {
+        const atomId = atom.getText();
+        const executor = this.getExecutor();
+        let tmpSymbol;
+        if (this.symbolTable.exists(executor, atomId)) {
+            tmpSymbol = this.symbolTable.get(executor, atomId);
+        }
+        else {
+            if (builtinMethods_js_1.buildInMethodNamesList.indexOf(atomId) !== -1) {
+                tmpSymbol = this.symbolTable.addFunction(null, "<builtIn>", this.getRootExecutor(), atomId, {});
+            }
+            else {
+                const foundContext = this.symbolTable.searchParentContext(executor, atomId);
+                if (foundContext === null) {
+                    tmpSymbol = this.symbolTable.addUndefined(this.getCurrentFile(), executor, atomId, atom.getSymbol());
+                    this.log2('symbol not found: ' + atomId);
+                }
+                else {
+                    tmpSymbol = this.symbolTable.get(foundContext, atomId);
+                }
+            }
+        }
+        if (tmpSymbol.type !== types_js_1.ParseSymbolType.Undefined) {
+            this.addSymbolInstance(tmpSymbol, atom.getSymbol());
+        }
+        return tmpSymbol;
+    }
+    addSymbolInstance(symbol, token) {
+        symbol = symbol;
+        if (symbol.instances.indexOf(token) == -1) {
+            symbol.instances.push(token);
+        }
+    }
+    setSymbols(symbolTable) {
+        this.symbolTable = symbolTable;
+    }
+    getSymbols() {
+        return this.symbolTable;
+    }
+    dumpSymbols() {
+        this.symbolTable.dumpSymbols();
+    }
+}
+exports.SymbolValidatorVisitor = SymbolValidatorVisitor;

package/dist/cjs/validate.js

@@ -1,81 +1,89 @@
 #! /usr/bin/env node
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validate = void 0;
 const commander_1 = require("commander");
-const figlet_1 = __importDefault(require("figlet"));
-const path_1 = __importDefault(require("path"));
 const fs_1 = require("fs");
-const sizing_js_1 = require("./sizing.js");
 const helpers_js_1 = require("./helpers.js");
+const environment_js_1 = require("./environment.js");
+const types_js_1 = require("./objects/types.js");
 async function validate() {
-    const { filePath } = (0, helpers_js_1.getCurrentPath)();
-    const toolSrcPath = filePath;
-    const toolDirectory = path_1.default.dirname(toolSrcPath) + '/../../';
-    const fontsPath = toolDirectory + '/fonts';
-    const defaultLibsPath = toolDirectory + '/libs';
-    const packageJson = JSON.parse((0, fs_1.readFileSync)(toolDirectory + 'package.json').toString());
-    ;
-    const { version } = packageJson;
+    const env = new environment_js_1.NodeScriptEnvironment();
+    environment_js_1.NodeScriptEnvironment.setInstance(env);
+    const version = env.getPackageVersion();
     commander_1.program
-        .description('generate graphical output from circuitscript files')
+        .description('generate validation output circuitscript files')
         .version(version)
+        .argument('[input path]', 'Input path')
+        .argument('[output path]', 'Output path')
         .option('-i, --input text <input text>', 'Input text directly')
-        .option('-f, --input-file <path>', 'Input file')
-        .option('-o, --output <path>', 'Output path')
         .option('-c, --current-directory <path>', 'Set current directory')
-        .option('-k, --kicad-netlist <filename>', 'Create KiCad netlist')
         .option('-w, --watch', 'Watch for file changes')
         .option('-n, --dump-nets', 'Dump out net information')
         .option('-d, --dump-data', 'Dump data during parsing')
-        .option('-s, --stats', 'Show stats during generation');
-    commander_1.program.addHelpText('before', figlet_1.default.textSync('circuitscript', {
-        font: 'Small Slant'
-    }));
+        .option('-s, --stats', 'Show stats during generation')
+        .option('-x, --skip-output', 'Skip output generation');
     if (process.argv.length < 3) {
         commander_1.program.help();
     }
     commander_1.program.parse();
     const options = commander_1.program.opts();
+    const args = commander_1.program.args;
     const watchFileChanges = options.watch;
-    const outputPath = options.output ?? null;
     const dumpNets = options.dumpNets;
     const dumpData = options.dumpData;
-    const kicadNetlist = options.kicadNetlist;
-    let currentDirectory = options.currentDirectory ?? null;
+    if (options.currentDirectory) {
+        env.setModuleDirectory(options.currentDirectory);
+    }
     if (watchFileChanges) {
         console.log('watching for file changes...');
     }
-    await (0, sizing_js_1.prepareSVGEnvironment)(fontsPath);
-    let inputFilePath = null;
+    await env.prepareSVGEnvironment();
+    let inputFilePath = "";
+    if (args.length > 2) {
+        console.log("Error: Extra arguments passed");
+        return;
+    }
     let scriptData;
-    if (options.input) {
+    if (args.length > 0 && args[0]) {
+        inputFilePath = args[0];
+        if ((0, fs_1.existsSync)(inputFilePath)) {
+            scriptData = (0, fs_1.readFileSync)(inputFilePath, { encoding: 'utf-8' });
+        }
+        else {
+            console.error("Error: File could not be found");
+            return;
+        }
+    }
+    else if (options.input) {
         scriptData = options.input;
     }
     else {
-        inputFilePath = options.inputFile;
-        const tmpScriptData = (0, helpers_js_1.getScriptText)(inputFilePath);
-        if (tmpScriptData === null) {
-            throw "File does not exists";
-        }
-        scriptData = tmpScriptData;
-        if (currentDirectory === null) {
-            currentDirectory = path_1.default.dirname(inputFilePath);
-        }
+        console.error("Error: No input provided");
+        return;
     }
     const scriptOptions = {
-        currentDirectory,
-        defaultLibsPath,
         dumpNets,
         dumpData,
-        kicadNetlistPath: kicadNetlist,
         showStats: options.stats,
+        environment: env,
     };
-    const visitor = (0, helpers_js_1.validateScript)(scriptData, scriptOptions);
-    const semanticTokensVisitor = (0, helpers_js_1.getSemanticTokens)(scriptData, scriptOptions);
+    const visitor = await (0, helpers_js_1.validateScript)(inputFilePath, scriptData, scriptOptions);
+    const symbols = visitor.getSymbols().getSymbols();
+    symbols.forEach((value, key) => {
+        if (value.type !== types_js_1.ParseSymbolType.Undefined) {
+            value = value;
+            const token = value.token;
+            console.log(key, value.fileName, token !== null ? (token.line + ":" + token.column) : "");
+            value.instances.forEach(instance => {
+                console.log("    " + instance.line + ":" + instance.column + " " + instance.start);
+            });
+        }
+    });
+    const { parsedTokens } = await (0, helpers_js_1.getSemanticTokens)(scriptData, scriptOptions);
+    parsedTokens.forEach(item => {
+        const { line, column, tokenType, tokenModifiers, textValue } = item;
+        console.log(`${line}:${column} - ${textValue} - ${tokenType} | ${tokenModifiers.join(',')}`);
+    });
 }
-exports.validate = validate;
+exports.default = validate;
 validate();

package/dist/cjs/visitor.js

@@ -46,9 +46,14 @@ class ParserVisitor extends BaseVisitor_js_1.BaseVisitor {
         this.visitTo_component_expr = (ctx) => {
             ctx.component_select_expr().forEach(item => {
                 const [component, pin] = this.visitResult(item);
-                this.getExecutor().toComponent(component, pin, {
-                    addSequence: true
-                });
+                try {
+                    this.getExecutor().toComponent(component, pin, {
+                        addSequence: true
+                    });
+                }
+                catch (err) {
+                    throw new utils_js_1.RuntimeExecutionError(err.message, ctx.start, ctx.stop);
+                }
             });
             return this.getExecutor().getCurrentPoint();
         };
@@ -63,7 +68,10 @@ class ParserVisitor extends BaseVisitor_js_1.BaseVisitor {
                 componentPin = this.visitResult(ctxDataExprWithAssigment);
             }
             else {
-                const component = this.getExecutor().scope.currentComponent;
+                let component = this.getScope().currentComponent;
+                if (component._pointLinkComponent) {
+                    component = component._pointLinkComponent;
+                }
                 let pinId = null;
                 const ctxPinSelectExpr = ctx.pin_select_expr();
                 if (ctxPinSelectExpr) {
@@ -111,6 +119,92 @@ class ParserVisitor extends BaseVisitor_js_1.BaseVisitor {
             return this.getExecutor().getCurrentPoint();
         };
         this.visitCreate_component_expr = (ctx) => {
+            const scope = this.getScope();
+            scope.setOnPropertyHandler((path, value, ctx) => {
+                if (path.length === 1) {
+                    const [, keyName] = path[0];
+                    switch (keyName) {
+                        case 'type':
+                            this.validateString(value, ctx);
+                            break;
+                        case 'angle':
+                        case 'width':
+                        case 'height':
+                            this.validateNumeric(value, ctx);
+                            break;
+                        case 'pins':
+                            if (!(value instanceof Map)) {
+                                this.validateNumeric(value, ctx);
+                            }
+                            break;
+                        case 'copy':
+                            if (value instanceof ParamDefinition_js_1.NumericValue) {
+                                this.validateNumeric(value, ctx);
+                            }
+                            else if (typeof value === 'boolean') {
+                                this.validateBoolean(value, ctx);
+                            }
+                            else {
+                                throw new utils_js_1.RuntimeExecutionError("Invalid value for 'copy' property", ctx.start, ctx.end);
+                            }
+                            break;
+                    }
+                }
+                else {
+                    const [, keyName] = path[0];
+                    if (keyName === 'arrange') {
+                        const [sideKeyCtx, sideKeyName] = path[1];
+                        if (globals_js_1.ValidPinSides.indexOf(sideKeyName) === -1) {
+                            throw new utils_js_1.RuntimeExecutionError(`Invalid side ${sideKeyName} in arrange`, sideKeyCtx.start, sideKeyCtx.stop);
+                        }
+                        else {
+                            if (path.length > 2 && path[2][0] === 'index') {
+                                if (Array.isArray(value)) {
+                                    const goodBlank = value.length === 1 &&
+                                        value[0] instanceof ParamDefinition_js_1.NumericValue;
+                                    if (!goodBlank) {
+                                        throw new utils_js_1.RuntimeExecutionError(`Invalid blank specifier`, ctx.start, ctx.stop);
+                                    }
+                                }
+                                else {
+                                    if (!(value instanceof ParamDefinition_js_1.NumericValue)) {
+                                        throw new utils_js_1.RuntimeExecutionError(`Invalid numeric value for arrange.${sideKeyName}`, ctx.start, ctx.stop);
+                                    }
+                                }
+                            }
+                        }
+                    }
+                    else if (keyName === 'params') {
+                        const [, subKeyName] = path[1];
+                        switch (subKeyName) {
+                            case 'mpn':
+                            case 'refdes':
+                            case 'footprint':
+                                this.validateString(value, ctx);
+                                break;
+                            case 'place':
+                                this.validateBoolean(value, ctx);
+                                break;
+                        }
+                    }
+                    else if (keyName === 'pins') {
+                        if (path.length === 2) {
+                            if (value.length === 2) {
+                                const [pinType,] = value;
+                                if (pinType instanceof types_js_1.UndeclaredReference) {
+                                    throw new utils_js_1.RuntimeExecutionError(`Invalid pin type: ${pinType.reference.name}`, ctx.start, ctx.end);
+                                }
+                            }
+                        }
+                    }
+                }
+            });
+            scope.enterContext(ctx);
+            ctx.property_expr().forEach(item => {
+                this.visitResult(item);
+            });
+            scope.exitContext();
+            scope.popOnPropertyHandler();
             const properties = this.getPropertyExprList(ctx.property_expr());
             const pins = this.parseCreateComponentPins(properties.get('pins'));
             let instanceName = this.getExecutor().getUniqueInstanceName();
@@ -145,8 +239,13 @@ class ParserVisitor extends BaseVisitor_js_1.BaseVisitor {
                 arrange, display, type, width, height, copy,
                 angle, followWireOrientation
             };
-            const createdComponent = this.getExecutor().createComponent(instanceName, pins, params, props);
-            this.setResult(ctx, createdComponent);
+            try {
+                const createdComponent = this.getExecutor().createComponent(instanceName, pins, params, props);
+                this.setResult(ctx, createdComponent);
+            }
+            catch (error) {
+                this.throwWithContext(ctx, error.message);
+            }
         };
         this.visitCreate_graphic_expr = (ctx) => {
             const ctxId = ctx.ID();
@@ -154,7 +253,7 @@ class ParserVisitor extends BaseVisitor_js_1.BaseVisitor {
             if (ctxId !== null) {
                 const varName = ctxId.getText();
                 paramIds.push(varName);
-                this.getExecutor().scope.variables.set(varName, {});
+                this.getScope().variables.set(varName, {});
             }
             const executor = this.getExecutor();
             const stack = [...this.executionStack];
@@ -256,7 +355,7 @@ class ParserVisitor extends BaseVisitor_js_1.BaseVisitor {
                         useValueArray = [useValueArray];
                     }
                     useValueArray.forEach((value, index) => {
-                        this.getExecutor().scope.variables.set(forVariableNames[index], value);
+                        this.getScope().variables.set(forVariableNames[index], value);
                     });
                     const commands = this.visitResult(ctx.graphic_expressions_block());
                     allCommands = allCommands.concat(commands);
@@ -315,8 +414,16 @@ class ParserVisitor extends BaseVisitor_js_1.BaseVisitor {
             this.setResult(ctx, [keyName, expressionsBlock]);
         };
         this.visitProperty_expr = (ctx) => {
-            const keyName = this.visitResult(ctx.property_key_expr());
-            const value = this.visitResult(ctx.property_value_expr());
+            const ctxKey = ctx.property_key_expr();
+            const ctxValue = ctx.property_value_expr();
+            const scope = this.getScope();
+            this.getScope().enterContext(ctxKey);
+            this.getScope().enterContext(ctxValue);
+            const keyName = this.visitResult(ctxKey);
+            const value = this.visitResult(ctxValue);
+            scope.triggerPropertyHandler(value, ctxValue);
+            this.getScope().exitContext();
+            this.getScope().exitContext();
             if (value instanceof types_js_1.UndeclaredReference && (value.reference.parentValue === undefined
                 && value.reference.value === undefined)) {
                 throw value.throwMessage();
@@ -326,15 +433,21 @@ class ParserVisitor extends BaseVisitor_js_1.BaseVisitor {
             this.setResult(ctx, map);
         };
         this.visitSingle_line_property = (ctx) => {
+            this.getScope().enterContext(ctx);
             let value;
             if (ctx.data_expr().length === 1) {
                 value = this.visitResult(ctx.data_expr(0));
             }
             else {
-                value = ctx.data_expr().map(item => {
-                    return this.visitResult(item);
+                value = ctx.data_expr().map((item, index) => {
+                    this.getScope().enterContext(index);
+                    const result = this.visitResult(item);
+                    this.getScope().triggerPropertyHandler(result, item);
+                    this.getScope().exitContext();
+                    return result;
                 });
             }
+            this.getScope().exitContext();
             this.setResult(ctx, value);
         };
         this.visitNested_properties_inner = (ctx) => {
@@ -707,6 +820,9 @@ class ParserVisitor extends BaseVisitor_js_1.BaseVisitor {
                 }
                 else if (ctxDataExpr) {
                     useValue = this.visitResult(ctxDataExpr);
+                    if (useValue instanceof ParamDefinition_js_1.NumericValue) {
+                        useValue = useValue.toNumber();
+                    }
                 }
                 if (useValue !== null) {
                     this.setResult(ctx, [direction, new helpers_js_1.UnitDimension(useValue)]);
@@ -848,7 +964,7 @@ class ParserVisitor extends BaseVisitor_js_1.BaseVisitor {
                         useValueArray = [useValueArray];
                     }
                     useValueArray.forEach((value, index) => {
-                        this.getExecutor().scope.variables.set(forVariableNames[index], value);
+                        this.getScope().variables.set(forVariableNames[index], value);
                     });
                     this.visit(ctx.expressions_block());
                     keepLooping = true;
@@ -1043,32 +1159,32 @@ class ParserVisitor extends BaseVisitor_js_1.BaseVisitor {
         return result;
     }
     printNets() {
-        this.getExecutor().scope.printNets();
+        this.getScope().printNets();
     }
     dumpNets() {
-        return this.getExecutor().scope.dumpNets();
+        return this.getScope().dumpNets();
     }
     dumpUniqueNets() {
-        const nets = this.getExecutor().scope.getNets();
+        const nets = this.getScope().getNets();
         return nets.reduce((accum, [, , net]) => {
             accum.push(net);
             return accum;
         }, []);
     }
     dumpVariables() {
-        return this.getExecutor().scope.variables;
+        return this.getScope().variables;
     }
     dumpInstances() {
-        return this.getExecutor().scope.instances;
+        return this.getScope().instances;
     }
     dump2() {
-        const instances = this.getExecutor().scope.instances;
+        const instances = this.getScope().instances;
         const items = [];
         for (const [instanceName, instance] of instances) {
             if (instance.assignedRefDes === null) {
                 continue;
             }
-            const pinNets = this.resolveNets(this.getExecutor().scope, instance);
+            const pinNets = this.resolveNets(this.getScope(), instance);
             const componentItem = {
                 name: instanceName,
                 refdes: instance.assignedRefDes,
@@ -1083,9 +1199,9 @@ class ParserVisitor extends BaseVisitor_js_1.BaseVisitor {
     }
     getNetList() {
         const netlist = [];
-        const instances = this.getExecutor().scope.instances;
+        const instances = this.getScope().instances;
         for (const [instanceName, instance] of instances) {
-            const pinNets = this.resolveNets(this.getExecutor().scope, instance);
+            const pinNets = this.resolveNets(this.getScope(), instance);
             const componentItem = {
                 instanceName,
                 instance,
@@ -1116,7 +1232,7 @@ class ParserVisitor extends BaseVisitor_js_1.BaseVisitor {
     annotateComponents() {
         this.log('===== annotate components =====');
         const annotater = new ComponentAnnotater();
-        const instances = this.getExecutor().scope.instances;
+        const instances = this.getScope().instances;
         const toAnnotate = [];
         for (const [, instance] of instances) {
             if (instance.typeProp === globals_js_1.ComponentTypes.net
@@ -1153,7 +1269,7 @@ class ParserVisitor extends BaseVisitor_js_1.BaseVisitor {
         this.log('');
     }
     applySheetFrameComponent() {
-        const baseScope = this.getExecutor().scope;
+        const baseScope = this.getScope();
         const document = baseScope.variables.get(globals_js_1.GlobalDocumentName);
         let frameComponent = null;
         if (document && document[Frame_js_1.FrameParamKeys.SheetType]) {