circuitscript 0.1.31 → 0.1.33

package/dist/esm/BaseVisitor.js

@@ -16,6 +16,7 @@ import { PinId } from './objects/PinDefinition.js';
 export class BaseVisitor extends CircuitScriptVisitor {
     startingContext;
     executionStack;
+    filePathStack = [];
     silent = false;
     logger;
     printStream = [];
@@ -39,6 +40,7 @@ export class BaseVisitor extends CircuitScriptVisitor {
     onImportFile = async (visitor, filePath, fileData, onErrorHandler) => {
         throw "Import file not implemented";
     };
+    refdesFileAnnotations = new Map();
     constructor(silent = false, onErrorHandler = null, environment) {
         super();
         this.silent = silent;
@@ -144,7 +146,18 @@ export class BaseVisitor extends CircuitScriptVisitor {
             specificImports.push(...tmpSpecificImports);
         }
         const id = ctx._moduleName.text;
-        await this.handleImportFile(id, handling, true, ctx, specificImports);
+        const importedFile = await this.handleImportFile(id, handling, true, ctx, specificImports);
+        const ctxImportAnnotation = ctx.import_annotation_expr();
+        if (ctxImportAnnotation) {
+            const textValue = ctxImportAnnotation.getText().replace('#=', '');
+            const { importedModule } = importedFile;
+            if (textValue === 'annotate') {
+                importedModule.enableRefdesAnnotation = true;
+            }
+            else if (textValue === 'annotate-external') {
+                importedModule.enableRefdesAnnotationFile = true;
+            }
+        }
     }
     visitImport_simple = async (ctx) => {
         await this.importCommon(ctx, ImportFunctionHandling.AllWithNamespace);
@@ -410,6 +423,7 @@ export class BaseVisitor extends CircuitScriptVisitor {
                             this.log('create new module context');
                             const importedModule = currentReference.rootValue;
                             const importedModuleContext = importedModule.context;
+                            this.enterFile(importedModule.moduleFilePath);
                             const newExecutor = this.handleEnterContext(this.getExecutor(), this.executionStack, importedModuleContext.name, ctx, {
                                 netNamespace: executor.netNamespace,
                                 namespace: importedModule.moduleNamespace
@@ -421,6 +435,7 @@ export class BaseVisitor extends CircuitScriptVisitor {
                         if (isModuleFunction) {
                             this.log('pop module context scope');
                             this.handlePopContext(this.getExecutor(), this.executionStack, "", false);
+                            this.exitFile();
                         }
                         if (isReference(functionResult)) {
                             currentReference = functionResult;
@@ -679,7 +694,8 @@ export class BaseVisitor extends CircuitScriptVisitor {
         instance.ctxReferences.push({
             ctx,
             indexedStack,
-            creationFlag
+            creationFlag,
+            filePath: this.getCurrentFile(),
         });
         this.componentCtxLinks.set(ctx, instance);
     }
@@ -767,7 +783,7 @@ export class BaseVisitor extends CircuitScriptVisitor {
                 hasParseError = importResult.hasParseError;
                 const importContext = executionStack.pop();
                 this.log(`import handling flag: ${importHandling}`);
-                importedModule = new ImportedModule(name, moduleNamespace, filePathUsed, importContext, importHandling, specificImports);
+                importedModule = new ImportedModule(name, moduleNamespace, filePathUsed, importResult.tree, importResult.tokens, importContext, importHandling, specificImports);
                 if (specificImports.length > 0) {
                     this.log('specific import: ' + specificImports.join(', '));
                 }
@@ -776,6 +792,7 @@ export class BaseVisitor extends CircuitScriptVisitor {
                 importedModule.context.scope.modules.forEach((module, key) => {
                     scope.modules.set(key, module);
                 });
+                await this.checkModuleHasRefdesFile(filePathUsed);
             }
         }
         catch (err) {
@@ -808,6 +825,12 @@ export class BaseVisitor extends CircuitScriptVisitor {
         this.importedFiles.push(newImportedFile);
         return newImportedFile;
     }
+    async checkModuleHasRefdesFile(filePath) {
+        return;
+    }
+    getRefdesFileAnnotation(filePath, startLine, startColumn, stopLine, stopColumn) {
+        return `${filePath}:${startLine}:${startColumn}:${stopLine}:${stopColumn}`;
+    }
     visitRoundedBracketsExpr = (ctx) => {
         const ctxDataExpr = ctx.data_expr();
         this.visit(ctxDataExpr);
@@ -941,4 +964,15 @@ export class BaseVisitor extends CircuitScriptVisitor {
             return (val instanceof NumericValue);
         }, 'numeric value');
     }
+    enterFile(filePath) {
+        this.log(`enter file: ${filePath}`);
+        this.filePathStack.push(filePath);
+    }
+    exitFile() {
+        this.log(`exit file: ${this.getCurrentFile()}`);
+        this.filePathStack.pop();
+    }
+    getCurrentFile() {
+        return this.filePathStack[this.filePathStack.length - 1];
+    }
 }

package/dist/esm/RefdesAnnotationVisitor.js

@@ -22,8 +22,7 @@ export class RefdesAnnotationVisitor extends BaseVisitor {
         return this.sourceText.substring(startIndex, stopIndex + 1);
     }
     visitScript = async (ctx) => {
-        const result = this.runExpressions(this.getExecutor(), ctx.expression());
-        this.setResult(ctx, result);
+        this.runExpressions(this.getExecutor(), ctx.expression());
         this.getExecutor().closeOpenPathBlocks();
         this.resultText = this.generateModifiedText();
     };
@@ -55,8 +54,10 @@ export class RefdesAnnotationVisitor extends BaseVisitor {
         });
         if (allRefdes.length > 0) {
             const originalText = this.getOriginalText(ctx);
-            const annotation = ' #= ' + allRefdes.join(',');
-            this.modifications.set(ctx, originalText + annotation);
+            this.modifications.set(ctx, {
+                originalText,
+                refdes: allRefdes,
+            });
         }
     };
     visitFunction_def_expr = (ctx) => {
@@ -77,10 +78,10 @@ export class RefdesAnnotationVisitor extends BaseVisitor {
             const instance = this.componentCtxLinks.get(ctx);
             const alreadyHaveRefdesAnnotation = instance.assignedRefDes !== null ?
                 (this.addedRefdesAnnotations.indexOf(instance.assignedRefDes) !== -1) : false;
-            if (!instance.hasParam('refdes')
+            const { forceSaveRefdesAnnotation: forceSaveRefdes } = instance;
+            if (!alreadyHaveRefdesAnnotation && (forceSaveRefdes || (!instance.hasParam('refdes')
                 && instance.placeHolderRefDes === null
-                && instance.assignedRefDes
-                && !alreadyHaveRefdesAnnotation) {
+                && instance.assignedRefDes))) {
                 let useRefDes = instance.assignedRefDes;
                 let isPlaceholderRefdes = false;
                 const { ctxReferences } = instance;
@@ -106,13 +107,25 @@ export class RefdesAnnotationVisitor extends BaseVisitor {
         const refdes = this.generateRefdesAnnotationComment(ctx);
         if (refdes !== null) {
             const originalText = this.getOriginalText(ctx);
-            const annotation = ' #= ' + refdes;
-            this.modifications.set(ctx, originalText + annotation);
+            this.modifications.set(ctx, {
+                originalText,
+                refdes: [refdes]
+            });
         }
     }
     getOutput() {
         return this.resultText;
     }
+    getOutputForExternalRefdesFile() {
+        const result = [];
+        this.modifications.forEach((modification, ctx) => {
+            const { line: startLine, column: startColumn } = ctx.start;
+            const { line: stopLine, column: stopColumn } = ctx.stop;
+            const joinedRefdes = modification.refdes.join(',');
+            result.push(`${startLine}:${startColumn}:${stopLine}:${stopColumn}:${joinedRefdes}`);
+        });
+        return result;
+    }
     generateModifiedText() {
         const output = [];
         const allTokens = this.tokenStream.getTokens();
@@ -140,7 +153,7 @@ export class RefdesAnnotationVisitor extends BaseVisitor {
                         output.push(this.sourceText.substring(lastSourcePos, token.start));
                     }
                     if (this.modifications.has(ctx)) {
-                        output.push(this.modifications.get(ctx));
+                        output.push(this.generateReplacementText(this.modifications.get(ctx)));
                         this.markTokensAsProcessed(ctx, processedTokens);
                         if (ctx.stop) {
                             lastSourcePos = ctx.stop.stop + 1;
@@ -193,4 +206,8 @@ export class RefdesAnnotationVisitor extends BaseVisitor {
             console.log(...message);
         }
     }
+    generateReplacementText(modification) {
+        const joinedRefdes = modification.refdes.join(', ');
+        return `${modification.originalText} #= ${joinedRefdes}`;
+    }
 }