circuitscript 0.0.22 → 0.0.24

package/src/objects/ExecutionScope.ts

@@ -1,201 +0,0 @@
-import { ClassComponent } from './ClassComponent.js';
-import { Net } from './Net.js';
-import { CFunction, ComponentPinNet, ComponentPinNetPair, ValueType } from './types.js';
-import { LayoutDirection } from '../globals.js';
-import { Wire, WireSegment } from './Wire.js';
-import { Frame } from './Frame.js';
-
-export class ExecutionScope {
-    scopeId: number;
-    private nets: ComponentPinNetPair[] = [];
-
-    instances: Map<string, ClassComponent> = new Map();
-
-    functions: Map<string, CFunction> = new Map();
-
-    variables: Map<string, ValueType | ClassComponent> = new Map();
-
-    blockStack: Map<number, any> = new Map();
-
-    wires: Wire[] = [];
-    frames: Frame[] = [];
-
-    indentLevel = 0;
-    netCounter = 1;
-    unnamedCounter = 1;
-
-    currentComponent: ClassComponent | null = null;
-    currentPin: number | null = null;
-
-    currentWireId = -1;
-    currentFrameId = -1;
-
-    netGnd: Net | null = null;
-
-    // This is the main gnd net of the circuit scope
-    componentGnd: ClassComponent | null = null;
-
-    // This is the first component in the circuit scope
-    componentRoot: ClassComponent | null = null;
-    
-    // Tracks the counter for copies of each component instance
-    // Copies are the same component electrically, but different symbols.
-    copyIDs: Map<string, number> = new Map();
-
-    // Determines how components are added/joined on the graph graphically.
-    // This is very important in "building" up the graph
-    // according to the user's order.
-    sequence: any[] = [];
-    
-    constructor(scopeId: number) {
-        this.scopeId = scopeId;
-    }
-
-    static scopeId = 0;
-
-    static create(): ExecutionScope {
-        const scope = new ExecutionScope(ExecutionScope.scopeId);
-        ExecutionScope.scopeId += 1;
-        return scope;
-    }
-
-    private findNet(component: ClassComponent, pin: number): ComponentPinNetPair {
-        return this.nets.find(([tmpComponent, tmpPin]) => {
-            // Use manual equality, much faster than using lodash
-            return tmpComponent.isEqual(component) && tmpPin === pin;
-        });
-    }
-
-    getNetWithName(name: string): Net {
-        const found = this.nets.find(([,, net]) => {
-            return net.name === name;
-        });
-        
-        return found ? found[2]: null;
-    }
-
-    hasNet(component: ClassComponent, pin: number): boolean {
-        return this.findNet(component, pin) !== undefined;
-    }
-
-    getNet(component: ClassComponent, pin: number): Net {
-        const result = this.findNet(component, pin);
-        if (result) {
-            return result[2]; // net
-        }
-
-        return null;
-    }
-
-    setNet(component: ClassComponent, pin: number, net: Net): void {
-        const pair = this.findNet(component, pin);
-        const result = this.nets.indexOf(pair);
-
-        if (result === -1) {
-            this.nets.push([component, pin, net]);
-        } else {
-            this.nets[result][2] = net;
-        }
-
-        component.pinNets.set(pin, net);
-    }
-
-    removeNet(component: ClassComponent, pin: number): void {
-        const pair = this.findNet(component, pin);
-        const result = this.nets.indexOf(pair);
-
-        if (result !== -1) {
-            this.nets.splice(result, 1);
-        }
-
-        component.pinNets.delete(pin);
-    }
-
-    getNets(): ComponentPinNetPair[] {
-        return this.nets;
-    }
-
-    dumpNets(): ComponentPinNet[] {
-        const sortedNet = [...this.nets].sort((a, b) => {
-            const netA = a[2];
-            const netB = b[2];
-
-            const netAId = netA.namespace + netA.name;
-            const netBId = netB.namespace + b[2].name;
-
-            if (netAId > netBId) {
-                return 1;
-            } else if (netAId < netBId) {
-                return -1;
-            } else {
-                return 0;
-            }
-        });
-
-        return sortedNet.map(([component, pin, net]) => {
-            return [net.namespace + net.name, component.instanceName, pin];
-        });
-    }
-
-    printNets(): void {
-        this.dumpNets().forEach(item => {
-            const [netName, instanceName, pin] = item;
-            console.log(netName.padEnd(10), '=>', instanceName, pin);
-        });
-    }
-    
-    setActive(type: ActiveObject, item: any): void {
-        // Reset the state and ensure that only one of the 
-        // active object is selected.
-
-        this.clearActive();
-
-        if (type === ActiveObject.Wire) {
-            this.currentWireId = item;
-        } else if (type === ActiveObject.Frame) {
-            this.currentFrameId = item;
-        }
-    }
-
-    clearActive(): void {
-        // Clears any current selected wire or frame
-        this.currentWireId = -1;
-        this.currentFrameId = -1;
-    }
-}
-
-export enum SequenceAction {
-    // Link current insertion point to component pin
-    To = 'to',
-
-    // Move insertion point at component pin
-    At = 'at',
-
-    // Link current insertion point with wire of given segments
-    Wire = 'wire',
-
-    // Jump to wire with target ID. Pin 0 of wire is the start of the 
-    // wire, pin 1 is the other end of the wire.
-    WireJump = 'wire-jump',
-
-    // Creates a new frame group
-    Frame = 'frame',
-}
-
-export enum FrameAction {
-    Enter = 'enter',
-    Exit = 'exit',
-}
-
-export enum ActiveObject {
-    Frame = 'frame',
-    Wire = 'wire',
-}
-
-
-export type SequenceItem =
-    [SequenceAction.To | SequenceAction.At, ClassComponent, number, LayoutDirection?, string?]
-    | [SequenceAction.Wire, wireId: number, WireSegment[]]
-    | [SequenceAction.WireJump, wireId: number, pinId: number]
-    | [SequenceAction.Frame, Frame, "enter" | "exit"]
-    ;

package/src/objects/Frame.ts

@@ -1,20 +0,0 @@
-export class Frame {
-    parameters: Map<string, any> = new Map();
-    frameId: number;
-
-    constructor(frameId: number) {
-        this.frameId = frameId;
-    }
-}
-
-export enum FrameParamKeys {
-    Title = 'title',
-    Direction = 'direction',
-    Padding = 'padding',
-    Border = 'border',
-}
-
-export enum FramePlotDirection {
-    Row = 'row',
-    Column = 'column',
-}

package/src/objects/ParamDefinition.ts

@@ -1,49 +0,0 @@
-export class ParamDefinition {
-    paramName: string;
-    paramValue: string | number | any;
-
-    constructor(paramName: string, paramValue: any) {
-        this.paramName = paramName;
-        this.paramValue = paramValue;
-    }
-}
-
-export class NumericValue {
-    value: string | number;
-
-    constructor(value: string | number) {
-        this.value = value;
-    }
-
-    toString(): string {
-        return 'numeric:' + this.value;
-    }
-
-    toDisplayString(): string {
-        if (typeof this.value  === 'number'){
-            return this.value.toString();
-            
-        } else if (typeof this.value === 'string'){
-            return this.value;
-        }
-    }
-}
-export class PercentageValue {
-    value: string | number;
-
-    constructor(value: string | number) {
-        this.value = value;
-    }
-
-    toString(): string {
-        return this.value.toString();
-    }
-}
-
-export class PinBlankValue {
-    blank: number;
-
-    constructor(value: number) {
-        this.blank = value;
-    }
-}

package/src/objects/PinDefinition.ts

@@ -1,49 +0,0 @@
-import { PinTypes } from './PinTypes.js';
-
-export type PinId = number | string;
-
-export class PinDefinition {
-    id: PinId;
-
-    idType: PinIdType;
-
-    pinType: PinTypes;
-
-    name: string;
-    altNames: string[];
-
-    side: string = PortSide.EAST;
-
-    position = -1;
-
-    constructor(
-        id: PinId,
-        idType: PinIdType,
-        name: string,
-        pinType = PinTypes.Any,
-        altNames = [],
-    ) {
-        this.id = id;
-        this.idType = idType;
-
-        this.pinType = pinType;
-
-        this.name = name;
-        this.altNames = altNames;
-    }
-}
-
-export enum PinIdType {
-    Int = 'int',
-    Str = 'str',
-}
-
-export enum PortSide {
-    WEST = 'WEST',
-    EAST = 'EAST',
-    SOUTH = 'SOUTH',
-    NORTH = 'NORTH'
-}
-
-
-export class PinReference {}

package/src/objects/PinTypes.ts

@@ -1,7 +0,0 @@
-export enum PinTypes {
-    Any = 'any',
-    Input = 'input',
-    Output = 'output',
-    IO = 'io',
-    Power = 'power',
-}

package/src/objects/Wire.ts

@@ -1,19 +0,0 @@
-import { ClassComponent } from "./ClassComponent.js";
-
-export class Wire {
-
-    // Should have some net info too 
-
-    path: WireSegment[]
-
-    constructor(path: WireSegment[]) {
-        this.path = path;
-    }
-}
-
-export type WireSegment = {
-    direction: 'up' | 'down' | 'left' | 'right' | 'auto' | 'auto_';
-    value: number,
-    valueXY?: [x: number, y: number],
-    until?: [instance: ClassComponent, pin: number],
-}

package/src/objects/types.ts

@@ -1,66 +0,0 @@
-import { ExecutionContext } from '../execute.js';
-import { ClassComponent } from './ClassComponent.js';
-import { Net } from './Net.js';
-import { NumericValue, PercentageValue, PinBlankValue } from './ParamDefinition.js';
-
-export type CFunction = (args: CallableParameter[],
-    options?: CFunctionOptions) => CFunctionResult;
-
-export type CFunctionOptions = {
-    netNamespace?: string
-}
-
-export type CFunctionResult = [
-    executionContext: ExecutionContext, 
-    result: ValueType | ClassComponent | null
-];
-
-// export type NetMap = Map<ComponentPin, Net>;
-
-export type ComponentPinNet = [
-    netName: string, instanceName: string, pin: number];
-
-    // Need to improve name...
-export type ComponentPinNetPair = [
-    component: ClassComponent,
-    pin: number,
-    net: Net
-];
-
-export type ComponentPin = [
-    component: ClassComponent,
-    pinId: number|string
-];
-
-export type ComplexType = ValueType 
-                        | ClassComponent 
-                        | UndeclaredReference 
-                        | null;
-
-export type ValueType = boolean | number | string | 
-    NumericValue | PercentageValue | PinBlankValue;
-
-export type CallableParameter = 
-    ['keyword', key: string, value: ValueType] | 
-    ['position', key: number, value: ValueType];
-
-export type FunctionDefinedParameter = [name: string, defaultValue: ValueType] 
-    | [name: string];
-
-
-export class UndeclaredReference {
-    reference: ReferenceType;
-
-    constructor(reference: ReferenceType) {
-        this.reference = reference;
-    }
-}
-
-export type ReferenceType =
-    {
-        found: boolean,
-        name?: string,
-        trailers?: string[],
-        type?: string,
-        value?: any
-    };

package/src/parser.ts

@@ -1,106 +0,0 @@
-import { CharStream, CommonTokenStream, ErrorListener, Token } from 'antlr4';
-
-import CircuitScriptLexer from './antlr/CircuitScriptLexer.js';
-import CircuitScriptParser from './antlr/CircuitScriptParser.js';
-
-import { MainVisitor } from './visitor.js';
-import { MainLexer } from './lexer.js';
-import { SimpleStopwatch } from './utils.js';
-
-export function parseFileWithVisitor(visitor: MainVisitor, data: string) {
-    const chars = new CharStream(data);
-    const lexer = new MainLexer(chars);
-
-    const lexerTimer = new SimpleStopwatch();
-
-    const tokens = new CommonTokenStream(lexer);
-    tokens.fill();
-
-    const lexerTimeTaken = lexerTimer.lap();
-
-    const parserTimer = new SimpleStopwatch();
-    const parser = new CircuitScriptParser(tokens);
-    // Clear any existing error listeners and use the custom one only
-    parser.removeErrorListeners();
-
-    const errorListener = new CircuitscriptParserErrorListener();
-    parser.addErrorListener(errorListener);
-
-    const tree = parser.script();
-
-    let hasError = false;
-
-    try {
-        visitor.visit(tree);
-    } catch (err){
-        // Error should be internally handled in visitor
-        err.print(data);
-        hasError = true;
-    }
-
-    const parserTimeTaken = parserTimer.lap();
-
-    // dumpTokens(tokens.tokens, lexer, data);
-    
-    return {
-        tree, parser,
-        hasParseError: errorListener.hasParseErrors(),
-        hasError,
-        parserTimeTaken,
-        lexerTimeTaken,
-    };
-}
-
-function dumpTokens(tokens:Token[], lexer: CircuitScriptLexer, scriptData: string): void {
-    tokens.forEach(item => {
-        if (item.type !== -1) {
-            let stringValue = "";
-            let textPart = "";
-
-            if (lexer.symbolicNames[item.type] !== null && lexer.symbolicNames[item.type] !== undefined) {
-                stringValue = lexer.symbolicNames[item.type];
-                if (stringValue !== "NEWLINE") {
-                    textPart = scriptData.substring(item.start, item.stop + 1);
-                } else {
-                    textPart = item.text.length-1;
-                }
-            } else if (lexer.literalNames[item.type] !== null && lexer.literalNames[item.type] !== undefined) {
-                stringValue = lexer.literalNames[item.type];
-                textPart = scriptData.substring(item.start, item.stop + 1);
-            } else {
-                stringValue = item._text;
-            }
-
-            console.log('line', item.line + ':' + item.column, `\t${stringValue} (${item.type})`.padEnd(30), textPart);
-        }
-    });
-}
-
-export class CircuitscriptParserErrorListener extends ErrorListener {
-
-    syntaxErrorCounter = 0;
-
-    syntaxError(recognizer: Recognizer<TSymbol>,
-        offendingSymbol: TSymbol,
-        line: number,
-        column: number,
-        msg: string,
-        e: RecognitionException | undefined) {
-        console.log("Syntax error at line", line, ':', column, ' - ', msg);
-
-        this.syntaxErrorCounter++;
-    }
-
-    // reportAmbiguity(recognizer, dfa, startIndex, stopIndex, exact, ambigAlts, configs) {
-    // }
-
-    // reportAttemptingFullContext(recognizer, dfa, startIndex, stopIndex, conflictingAlts, configs) {
-    // }
-
-    // reportContextSensitivity(recognizer, dfa, startIndex, stopIndex, prediction, configs) {
-    // }
-
-    hasParseErrors(): boolean {
-        return (this.syntaxErrorCounter > 0);
-    }
-}

package/src/regenerate-tests.ts

@@ -1,25 +0,0 @@
-import fs from 'fs';
-import { renderScript } from './helpers.js';
-
-const mainDir = './__tests__/renderData/';
-
-const cstFiles = [];
-
-const files = fs.readdirSync(mainDir);
-files.forEach(file => {
-    if (file.endsWith('.cst')){
-        cstFiles.push(file);
-    }
-});
-
-const useCurrentDir = './examples/';
-
-cstFiles.forEach(file => {
-    const inputPath = mainDir + file;
-    const scriptData = fs.readFileSync(inputPath, { encoding: 'utf-8' });
-
-    const outputPath = inputPath + '.svg';
-    renderScript(scriptData, outputPath, { currentDirectory: useCurrentDir });
-
-    console.log('generated ', outputPath);
-});