Plugins

Plugins are event emitters updated independently from the main container.

vif-sim has a dispatcher that stores each plugin in a different thread.

Plugins have a name and a refresh interval that can be chosen at their creation.

null

Register

To register a plugin, use the Plugin class of sim-web / sim-node.

import {Plugin} from "@vifjs/sim-node/plugin";

A plugin needs a name and a refresh interval (Time in milliseconds).

Once your plugin is registered, you can listen to events.

const MyPlugin = new Plugin("MyPlugin", 100)

Events

messages

• Type: string[]

Displays all recent messages from the last interval.

MyPlugin.on("messages", ev => {
    // ...                             
})

warnings

• Type: string[]

Displays all recent warnings from the last interval.

MyPlugin.on("warnings", ev => {
    // ...
})

error

• Type: ParseError

Non recoverable error, any error is displayed with the following format:

interface ParseError {
    error: string;
    file_stack: FileTrace[]; // File trace
    sim_stack: string[]; // Steps inside the simulation
}

interface FileTrace {
    file: string;
    column: number;
    line: number;
}

MyPlugin.on("error", ev => {
    // ...
})

monitor:changes

• Type: MonitorChange[]

Display all variables changes since the last interval.

interface MonitorChange {
    id: number;
    value: string;
}

MyPlugin.on("monitor:changes", ev => {
    // ...
})

breakpoints:statuses

• Type: BreakPointUpdateStatus[]

Breakpoint status updates.

interface BreakPointUpdateStatus {
    id: number;
    status: BreakPointStatus;
}

enum BreakPointStatus {
    Inactive = 0,
    Active = 1,
    Disabled = 2,
}

MyPlugin.on("breakpoints:statuses", ev => {
    // ...
})

unit-tests:statuses

• Type: UnitTestUpdateStatus[]

Update the status of an unit test.

interface BreakPointUpdateStatus {
    id: number;
    status: BreakPointStatus;
}

enum BreakPointStatus {
    Inactive = 0,
    Active = 1,
    Disabled = 2,
}

MyPlugin.on("unit-tests:statuses", ev => {
    // ...
})

monitor:schemas

• Type: MonitorSchema[]

Get the schemas of the variables that should be monitored.

interface MonitorSchema {
    path: string[];
    value: {id: number, value: string};
}

MyPlugin.on("monitor:schemas", ev => {
    // ...
})

breakpoints

• Type: BreakPoint[]

Get the schemas of the variables which should be monitored.

interface BreakPoint {
    path: FileTrace | null;
    id: number;
    status: BreakPointStatus;
}

interface BreakPointUpdateStatus {
    id: number;
    status: BreakPointStatus;
}

MyPlugin.on("breakpoints", ev => {
    // ...
})

unit-tests

• Type: UnitTest[]

Get the schemas of the variables which should be monitored.

interface UnitTest {
    description: string;
    id: number;
    status: UnitTestStatus;
}

enum UnitTestStatus {
    Unreached = 0,
    Failed = 1,
    Succeed = 2,
}

MyPlugin.on("unit-tests", ev => {
    // ...
})

simulation:stack

• Type: Stack[]

Get the schemas of the variables which should be monitored.

interface Stack {
    root: Section | null;
    current: Section | null;
}

interface Section {
    name: string;
    ty: string;
    content: VecSectionOrLog;
}

type VecSectionOrLog = SectionOrLog[];

type SectionOrLog = { Log: string } | { Section: Section };

MyPlugin.on("simulation:stack", ev => {
    // ...
})

simulation:entry-points

• Type: string[]

Get the schemas of the variables which should be monitored.

MyPlugin.on("simulation:entry-points", ev => {
    // ...
})

simulation:status

• Type: SimulationStatus

Get the schemas of the variables which should be monitored.

MyPlugin.on("simulation:status", ev => {
    // ...
})

parse-provider:status

• Type: ParseStatus

Get the schemas of the variables which should be monitored.

MyPlugin.on("parse-provider:status", ev => {
    // ...
})

parse-program:status

• Type: ParseStatus

Get the schemas of the variables which should be monitored.

MyPlugin.on("parse-program:status", ev => {
    // ...
})