timed-automata-analyzer 0.9.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Luthium
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,36 @@
+# Analyzer for Timed Automata
+
+This project provides an analyzer for Timed Automata.
+The analyzer is written in Rust and compiled to WebAssembly to offer a fast and efficient tool to implement analyses for websites.
+Currently, the analyzer offers functionality to find unreachable locations in a given TA.
+
+## Getting Started
+
+To use the tool in your JavaScript/TypeScript project, simply install the package `timed-automata-analyzer` with your favorite package manager.
+Then map your Timed Automata into the TA model provided by the analyzer.
+When this is done, you can find unreachable locations by using the function `findUnreachableLocations(ta)`.
+The function returns an array of strings containing the names of all unreachable locations.
+If all locations are reachable, the array is empty.
+
+Note that the analyzer validates the input TA before starting the analysis.
+In case of any validation issues (e.g., missing initial location), `findUnreachableLocations(ta)` throws an error. 
+
+## Developing the Tool
+
+In case you want to contribute to the tool or fork the repository, only few steps are necessary:
+- As a first step, you need to install Rust.
+  See the [Rust website](https://www.rust-lang.org/tools/install) for information on how to do this.
+- Additionally, you need to install _wasm-pack_ with `cargo install wasm-pack` for WebAssembly outputs.
+- The WebAssembly binary (including glue code for JavaScript/TypeScript and an NPM package) is generated by running `wasm-pack build --target bundler`.
+- This project includes an extensive test suite. Tests can be run with `cargo test`.
+- For linting, this project uses the built-in linter of Rust as well as [Clippy](https://github.com/rust-lang/rust-clippy).
+  To run the linters, execute `cargo check` and `cargo clippy`, respectively.
+- For further information on compiling Rust to WebAssembly, see the [MDN Web Docs](https://developer.mozilla.org/en-US/docs/WebAssembly/Rust_to_Wasm).
+
+## Additional Information
+
+- Most of the algorithms for checking reachability are based on the paper [Timed Automata: Semantics, Algorithms and Tools](https://doi.org/10.1007/978-3-540-27755-2_3).
+- In case you want to see the analyzer in action, I built a React app for modeling and analyzing Timed Automata.
+  The React app is available [here](https://luth1um.github.io/timed-automata-analysis/), while the repository for the React app is available [here](https://github.com/luth1um/timed-automata-analysis).
+- An introduction to Timed Automata can be found in [Wikipedia](https://en.wikipedia.org/wiki/Timed_automaton).
+- The original paper on Timed Automata is [Automata for modeling real-time systems](https://doi.org/10.1007/BFb0032042) by Alur and Dill.

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "timed-automata-analyzer",
+  "type": "module",
+  "collaborators": [
+    "luth1um"
+  ],
+  "description": "An analyzer for Timed Automata written in Rust",
+  "version": "0.9.0",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/luth1um/ta-analyzer"
+  },
+  "files": [
+    "timed_automata_analyzer_bg.wasm",
+    "timed_automata_analyzer.js",
+    "timed_automata_analyzer_bg.js",
+    "timed_automata_analyzer.d.ts"
+  ],
+  "main": "timed_automata_analyzer.js",
+  "types": "timed_automata_analyzer.d.ts",
+  "sideEffects": [
+    "./timed_automata_analyzer.js",
+    "./snippets/*"
+  ]
+}

package/timed_automata_analyzer.d.ts

@@ -0,0 +1,79 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+* @param {TimedAutomaton} ta
+* @returns {(string)[]}
+*/
+export function findUnreachableLocations(ta: TimedAutomaton): (string)[];
+/**
+*/
+export enum ClockComparator {
+  LESSER = 0,
+  LEQ = 1,
+  GEQ = 2,
+  GREATER = 3,
+}
+/**
+*/
+export class Clause {
+  free(): void;
+/**
+* @param {Clock} lhs
+* @param {ClockComparator} op
+* @param {number} rhs
+*/
+  constructor(lhs: Clock, op: ClockComparator, rhs: number);
+}
+/**
+*/
+export class Clock {
+  free(): void;
+/**
+* @param {string} name
+*/
+  constructor(name: string);
+}
+/**
+*/
+export class ClockConstraint {
+  free(): void;
+/**
+* @param {(Clause)[]} clauses
+*/
+  constructor(clauses: (Clause)[]);
+}
+/**
+*/
+export class Location {
+  free(): void;
+/**
+* @param {string} name
+* @param {boolean} is_initial
+* @param {ClockConstraint | undefined} [invariant]
+*/
+  constructor(name: string, is_initial: boolean, invariant?: ClockConstraint);
+}
+/**
+*/
+export class Switch {
+  free(): void;
+/**
+* @param {Location} source
+* @param {ClockConstraint | undefined} guard
+* @param {string} action
+* @param {(Clock)[]} reset
+* @param {Location} target
+*/
+  constructor(source: Location, guard: ClockConstraint | undefined, action: string, reset: (Clock)[], target: Location);
+}
+/**
+*/
+export class TimedAutomaton {
+  free(): void;
+/**
+* @param {(Location)[]} locations
+* @param {(Clock)[]} clocks
+* @param {(Switch)[]} switches
+*/
+  constructor(locations: (Location)[], clocks: (Clock)[], switches: (Switch)[]);
+}

package/timed_automata_analyzer.js

@@ -0,0 +1,5 @@
+
+import * as wasm from "./timed_automata_analyzer_bg.wasm";
+import { __wbg_set_wasm } from "./timed_automata_analyzer_bg.js";
+__wbg_set_wasm(wasm);
+export * from "./timed_automata_analyzer_bg.js";

package/timed_automata_analyzer_bg.js

@@ -0,0 +1,450 @@
+let wasm;
+export function __wbg_set_wasm(val) {
+    wasm = val;
+}
+
+
+const lTextDecoder = typeof TextDecoder === 'undefined' ? (0, module.require)('util').TextDecoder : TextDecoder;
+
+let cachedTextDecoder = new lTextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+
+cachedTextDecoder.decode();
+
+let cachedUint8ArrayMemory0 = null;
+
+function getUint8ArrayMemory0() {
+    if (cachedUint8ArrayMemory0 === null || cachedUint8ArrayMemory0.byteLength === 0) {
+        cachedUint8ArrayMemory0 = new Uint8Array(wasm.memory.buffer);
+    }
+    return cachedUint8ArrayMemory0;
+}
+
+function getStringFromWasm0(ptr, len) {
+    ptr = ptr >>> 0;
+    return cachedTextDecoder.decode(getUint8ArrayMemory0().subarray(ptr, ptr + len));
+}
+
+const heap = new Array(128).fill(undefined);
+
+heap.push(undefined, null, true, false);
+
+let heap_next = heap.length;
+
+function addHeapObject(obj) {
+    if (heap_next === heap.length) heap.push(heap.length + 1);
+    const idx = heap_next;
+    heap_next = heap[idx];
+
+    heap[idx] = obj;
+    return idx;
+}
+
+function getObject(idx) { return heap[idx]; }
+
+function dropObject(idx) {
+    if (idx < 132) return;
+    heap[idx] = heap_next;
+    heap_next = idx;
+}
+
+function takeObject(idx) {
+    const ret = getObject(idx);
+    dropObject(idx);
+    return ret;
+}
+
+let WASM_VECTOR_LEN = 0;
+
+const lTextEncoder = typeof TextEncoder === 'undefined' ? (0, module.require)('util').TextEncoder : TextEncoder;
+
+let cachedTextEncoder = new lTextEncoder('utf-8');
+
+const encodeString = (typeof cachedTextEncoder.encodeInto === 'function'
+    ? function (arg, view) {
+    return cachedTextEncoder.encodeInto(arg, view);
+}
+    : function (arg, view) {
+    const buf = cachedTextEncoder.encode(arg);
+    view.set(buf);
+    return {
+        read: arg.length,
+        written: buf.length
+    };
+});
+
+function passStringToWasm0(arg, malloc, realloc) {
+
+    if (realloc === undefined) {
+        const buf = cachedTextEncoder.encode(arg);
+        const ptr = malloc(buf.length, 1) >>> 0;
+        getUint8ArrayMemory0().subarray(ptr, ptr + buf.length).set(buf);
+        WASM_VECTOR_LEN = buf.length;
+        return ptr;
+    }
+
+    let len = arg.length;
+    let ptr = malloc(len, 1) >>> 0;
+
+    const mem = getUint8ArrayMemory0();
+
+    let offset = 0;
+
+    for (; offset < len; offset++) {
+        const code = arg.charCodeAt(offset);
+        if (code > 0x7F) break;
+        mem[ptr + offset] = code;
+    }
+
+    if (offset !== len) {
+        if (offset !== 0) {
+            arg = arg.slice(offset);
+        }
+        ptr = realloc(ptr, len, len = offset + arg.length * 3, 1) >>> 0;
+        const view = getUint8ArrayMemory0().subarray(ptr + offset, ptr + len);
+        const ret = encodeString(arg, view);
+
+        offset += ret.written;
+        ptr = realloc(ptr, len, offset, 1) >>> 0;
+    }
+
+    WASM_VECTOR_LEN = offset;
+    return ptr;
+}
+
+function _assertClass(instance, klass) {
+    if (!(instance instanceof klass)) {
+        throw new Error(`expected instance of ${klass.name}`);
+    }
+    return instance.ptr;
+}
+
+let cachedDataViewMemory0 = null;
+
+function getDataViewMemory0() {
+    if (cachedDataViewMemory0 === null || cachedDataViewMemory0.buffer.detached === true || (cachedDataViewMemory0.buffer.detached === undefined && cachedDataViewMemory0.buffer !== wasm.memory.buffer)) {
+        cachedDataViewMemory0 = new DataView(wasm.memory.buffer);
+    }
+    return cachedDataViewMemory0;
+}
+
+function passArrayJsValueToWasm0(array, malloc) {
+    const ptr = malloc(array.length * 4, 4) >>> 0;
+    const mem = getDataViewMemory0();
+    for (let i = 0; i < array.length; i++) {
+        mem.setUint32(ptr + 4 * i, addHeapObject(array[i]), true);
+    }
+    WASM_VECTOR_LEN = array.length;
+    return ptr;
+}
+
+function isLikeNone(x) {
+    return x === undefined || x === null;
+}
+
+function getArrayJsValueFromWasm0(ptr, len) {
+    ptr = ptr >>> 0;
+    const mem = getDataViewMemory0();
+    const result = [];
+    for (let i = ptr; i < ptr + 4 * len; i += 4) {
+        result.push(takeObject(mem.getUint32(i, true)));
+    }
+    return result;
+}
+/**
+* @param {TimedAutomaton} ta
+* @returns {(string)[]}
+*/
+export function findUnreachableLocations(ta) {
+    try {
+        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+        _assertClass(ta, TimedAutomaton);
+        var ptr0 = ta.__destroy_into_raw();
+        wasm.findUnreachableLocations(retptr, ptr0);
+        var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+        var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+        var v2 = getArrayJsValueFromWasm0(r0, r1).slice();
+        wasm.__wbindgen_free(r0, r1 * 4, 4);
+        return v2;
+    } finally {
+        wasm.__wbindgen_add_to_stack_pointer(16);
+    }
+}
+
+/**
+*/
+export const ClockComparator = Object.freeze({ LESSER:0,"0":"LESSER",LEQ:1,"1":"LEQ",GEQ:2,"2":"GEQ",GREATER:3,"3":"GREATER", });
+
+const ClauseFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(ptr => wasm.__wbg_clause_free(ptr >>> 0, 1));
+/**
+*/
+export class Clause {
+
+    static __unwrap(jsValue) {
+        if (!(jsValue instanceof Clause)) {
+            return 0;
+        }
+        return jsValue.__destroy_into_raw();
+    }
+
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        ClauseFinalization.unregister(this);
+        return ptr;
+    }
+
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_clause_free(ptr, 0);
+    }
+    /**
+    * @param {Clock} lhs
+    * @param {ClockComparator} op
+    * @param {number} rhs
+    */
+    constructor(lhs, op, rhs) {
+        _assertClass(lhs, Clock);
+        const ret = wasm.clause_new(lhs.__wbg_ptr, op, rhs);
+        this.__wbg_ptr = ret >>> 0;
+        ClauseFinalization.register(this, this.__wbg_ptr, this);
+        return this;
+    }
+}
+
+const ClockFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(ptr => wasm.__wbg_clock_free(ptr >>> 0, 1));
+/**
+*/
+export class Clock {
+
+    static __unwrap(jsValue) {
+        if (!(jsValue instanceof Clock)) {
+            return 0;
+        }
+        return jsValue.__destroy_into_raw();
+    }
+
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        ClockFinalization.unregister(this);
+        return ptr;
+    }
+
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_clock_free(ptr, 0);
+    }
+    /**
+    * @param {string} name
+    */
+    constructor(name) {
+        const ptr0 = passStringToWasm0(name, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.clock_new(ptr0, len0);
+        this.__wbg_ptr = ret >>> 0;
+        ClockFinalization.register(this, this.__wbg_ptr, this);
+        return this;
+    }
+}
+
+const ClockConstraintFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(ptr => wasm.__wbg_clockconstraint_free(ptr >>> 0, 1));
+/**
+*/
+export class ClockConstraint {
+
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        ClockConstraintFinalization.unregister(this);
+        return ptr;
+    }
+
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_clockconstraint_free(ptr, 0);
+    }
+    /**
+    * @param {(Clause)[]} clauses
+    */
+    constructor(clauses) {
+        const ptr0 = passArrayJsValueToWasm0(clauses, wasm.__wbindgen_malloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.clockconstraint_new(ptr0, len0);
+        this.__wbg_ptr = ret >>> 0;
+        ClockConstraintFinalization.register(this, this.__wbg_ptr, this);
+        return this;
+    }
+}
+
+const LocationFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(ptr => wasm.__wbg_location_free(ptr >>> 0, 1));
+/**
+*/
+export class Location {
+
+    static __unwrap(jsValue) {
+        if (!(jsValue instanceof Location)) {
+            return 0;
+        }
+        return jsValue.__destroy_into_raw();
+    }
+
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        LocationFinalization.unregister(this);
+        return ptr;
+    }
+
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_location_free(ptr, 0);
+    }
+    /**
+    * @param {string} name
+    * @param {boolean} is_initial
+    * @param {ClockConstraint | undefined} [invariant]
+    */
+    constructor(name, is_initial, invariant) {
+        const ptr0 = passStringToWasm0(name, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        let ptr1 = 0;
+        if (!isLikeNone(invariant)) {
+            _assertClass(invariant, ClockConstraint);
+            ptr1 = invariant.__destroy_into_raw();
+        }
+        const ret = wasm.location_new(ptr0, len0, is_initial, ptr1);
+        this.__wbg_ptr = ret >>> 0;
+        LocationFinalization.register(this, this.__wbg_ptr, this);
+        return this;
+    }
+}
+
+const SwitchFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(ptr => wasm.__wbg_switch_free(ptr >>> 0, 1));
+/**
+*/
+export class Switch {
+
+    static __unwrap(jsValue) {
+        if (!(jsValue instanceof Switch)) {
+            return 0;
+        }
+        return jsValue.__destroy_into_raw();
+    }
+
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        SwitchFinalization.unregister(this);
+        return ptr;
+    }
+
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_switch_free(ptr, 0);
+    }
+    /**
+    * @param {Location} source
+    * @param {ClockConstraint | undefined} guard
+    * @param {string} action
+    * @param {(Clock)[]} reset
+    * @param {Location} target
+    */
+    constructor(source, guard, action, reset, target) {
+        _assertClass(source, Location);
+        let ptr0 = 0;
+        if (!isLikeNone(guard)) {
+            _assertClass(guard, ClockConstraint);
+            ptr0 = guard.__destroy_into_raw();
+        }
+        const ptr1 = passStringToWasm0(action, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len1 = WASM_VECTOR_LEN;
+        const ptr2 = passArrayJsValueToWasm0(reset, wasm.__wbindgen_malloc);
+        const len2 = WASM_VECTOR_LEN;
+        _assertClass(target, Location);
+        const ret = wasm.switch_new(source.__wbg_ptr, ptr0, ptr1, len1, ptr2, len2, target.__wbg_ptr);
+        this.__wbg_ptr = ret >>> 0;
+        SwitchFinalization.register(this, this.__wbg_ptr, this);
+        return this;
+    }
+}
+
+const TimedAutomatonFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(ptr => wasm.__wbg_timedautomaton_free(ptr >>> 0, 1));
+/**
+*/
+export class TimedAutomaton {
+
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        TimedAutomatonFinalization.unregister(this);
+        return ptr;
+    }
+
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_timedautomaton_free(ptr, 0);
+    }
+    /**
+    * @param {(Location)[]} locations
+    * @param {(Clock)[]} clocks
+    * @param {(Switch)[]} switches
+    */
+    constructor(locations, clocks, switches) {
+        const ptr0 = passArrayJsValueToWasm0(locations, wasm.__wbindgen_malloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ptr1 = passArrayJsValueToWasm0(clocks, wasm.__wbindgen_malloc);
+        const len1 = WASM_VECTOR_LEN;
+        const ptr2 = passArrayJsValueToWasm0(switches, wasm.__wbindgen_malloc);
+        const len2 = WASM_VECTOR_LEN;
+        const ret = wasm.timedautomaton_new(ptr0, len0, ptr1, len1, ptr2, len2);
+        this.__wbg_ptr = ret >>> 0;
+        TimedAutomatonFinalization.register(this, this.__wbg_ptr, this);
+        return this;
+    }
+}
+
+export function __wbg_clock_unwrap(arg0) {
+    const ret = Clock.__unwrap(takeObject(arg0));
+    return ret;
+};
+
+export function __wbg_clause_unwrap(arg0) {
+    const ret = Clause.__unwrap(takeObject(arg0));
+    return ret;
+};
+
+export function __wbg_location_unwrap(arg0) {
+    const ret = Location.__unwrap(takeObject(arg0));
+    return ret;
+};
+
+export function __wbg_switch_unwrap(arg0) {
+    const ret = Switch.__unwrap(takeObject(arg0));
+    return ret;
+};
+
+export function __wbindgen_string_new(arg0, arg1) {
+    const ret = getStringFromWasm0(arg0, arg1);
+    return addHeapObject(ret);
+};
+
+export function __wbindgen_object_drop_ref(arg0) {
+    takeObject(arg0);
+};
+
+export function __wbindgen_throw(arg0, arg1) {
+    throw new Error(getStringFromWasm0(arg0, arg1));
+};
+