node-opcua-address-space 2.97.0 → 2.98.0

package/src/nodeset_tools/dump_to_bsd.ts

@@ -1,198 +0,0 @@
-import { IAddressSpace, INamespace, UADataType } from "node-opcua-address-space-base";
-import { assert } from "node-opcua-assert";
-import { StructureDefinition, EnumDefinition } from "node-opcua-types";
-import { INodeId, NodeId, NodeIdType } from "node-opcua-nodeid";
-import { AddressSpacePrivate } from "../address_space_private";
-import { XmlWriter } from "../../source/xml_writer";
-import { NamespacePrivate } from "../namespace_private";
-import { constructNamespaceDependency } from "./construct_namespace_dependency";
-
-// tslint:disable-next-line: no-var-requires
-const XMLWriter = require("xml-writer");
-
-function dumpEnumeratedType(xw: XmlWriter, e: EnumDefinition, name: string): void {
-    xw.startElement("opc:EnumeratedType");
-    xw.writeAttribute("Name", name);
-    xw.writeAttribute("LengthInBits", "32");
-    for (const f of e.fields || []) {
-        xw.startElement("opc:EnumeratedValue");
-        xw.writeAttribute("Name", f.name!);
-        assert(f.value[0] === 0, "unsupported 64 bit value !");
-        xw.writeAttribute("Value", f.value[1].toString());
-        xw.endElement();
-    }
-    xw.endElement();
-}
-function buildXmlName(addressSpace: AddressSpacePrivate, map: { [key: number]: string }, nodeId: NodeId): string {
-    if (NodeId.sameNodeId(nodeId, NodeId.nullNodeId)) {
-        return "ua:ExtensionObject";
-    }
-    const node = addressSpace.findNode(nodeId);
-    // istanbul ignore next
-    if (!node) {
-        throw new Error("Cannot find Node for" + nodeId?.toString());
-    }
-    const typeName = node.browseName.name!;
-
-    const n = node.nodeId as INodeId;
-    const prefix = (n.identifierType === NodeIdType.NUMERIC && n.namespace === 0) ? (n.value <= 15 ? "opc" : "ua") : map[node.nodeId.namespace];
-    return prefix + ":" + (typeName === "Structure" && prefix === "ua" ? "ExtensionObject" : typeName);
-}
-
-// eslint-disable-next-line max-statements
-function dumpDataTypeStructure(
-    xw: XmlWriter,
-    addressSpace: IAddressSpace,
-    map: { [key: number]: string },
-    structureDefinition: StructureDefinition,
-    structureDefinitionBase: StructureDefinition | undefined | null,
-    name: string,
-    doc?: string
-): void {
-    xw.startElement("opc:StructuredType");
-    xw.writeAttribute("Name", name);
-    xw.writeAttribute("BaseType", buildXmlName(addressSpace as AddressSpacePrivate, map, structureDefinition.baseDataType));
-
-    if (doc) {
-        xw.startElement("opc:Documentation");
-        xw.text(doc);
-        xw.endElement();
-    }
-
-    const fields = structureDefinition.fields || [];
-    // get base class
-    const nbFieldsInBase = structureDefinitionBase ? structureDefinitionBase.fields?.length || 0 : 0;
-
-    let optionalsCount = 0;
-    for (let index = nbFieldsInBase; index < fields.length; index++) {
-        const f = fields[index];
-        if (f.isOptional) {
-            xw.startElement("opc:Field");
-            xw.writeAttribute("Name", f.name + "Specified");
-            xw.writeAttribute("TypeName", "opc:Bit");
-            xw.endElement();
-            optionalsCount++;
-        }
-    }
-
-    // istanbul ignore next
-    if (optionalsCount >= 32) {
-        throw new Error("Too many optionals fields");
-    }
-
-    if (optionalsCount) {
-        /*
-                const padding = optionalsCount <= 8
-                    ? (8 - optionalsCount)
-                    : (optionalsCount <= 16)
-                        ? (16 - optionalsCount)
-                        : (32 - optionalsCount)
-                    ;
-        */
-        const padding = 32 - optionalsCount;
-        if (padding !== 0) {
-            xw.startElement("opc:Field");
-            xw.writeAttribute("Name", "Reserved1");
-            xw.writeAttribute("TypeName", "opc:Bit");
-            xw.writeAttribute("Length", padding.toString());
-            xw.endElement();
-        }
-    }
-    for (let index = nbFieldsInBase; index < fields.length; index++) {
-        const f = fields[index];
-
-        const isArray = f.valueRank > 0 && f.arrayDimensions?.length;
-
-        if (isArray) {
-            xw.startElement("opc:Field");
-            xw.writeAttribute("Name", "NoOf" + f.name!);
-            xw.writeAttribute("TypeName", "opc:Int32");
-            if (f.isOptional) {
-                xw.writeAttribute("SwitchField", f.name + "Specified");
-            }
-            xw.endElement();
-        }
-
-        xw.startElement("opc:Field");
-        xw.writeAttribute("Name", f.name!);
-
-        const typeName = buildXmlName(addressSpace as AddressSpacePrivate, map, f.dataType);
-        xw.writeAttribute("TypeName", typeName);
-        if (isArray) {
-            xw.writeAttribute("LengthField", "NoOf" + f.name!);
-        }
-        if (f.isOptional) {
-            xw.writeAttribute("SwitchField", f.name + "Specified");
-        }
-        xw.endElement();
-    }
-    xw.endElement();
-}
-
-function dumpDataTypeToBSD(xw: XmlWriter, dataType: UADataType, map: { [key: number]: string }) {
-    const addressSpace = dataType.addressSpace;
-
-    const name: string = dataType.browseName.name!;
-
-    const definition = dataType.getDefinition();
-    if (definition instanceof StructureDefinition) {
-        const structureDefinitionBase = dataType.subtypeOfObj?.getStructureDefinition();
-        dumpDataTypeStructure(xw, addressSpace, map, definition, structureDefinitionBase, name);
-    }
-    if (definition instanceof EnumDefinition) {
-        dumpEnumeratedType(xw, definition, name);
-    }
-}
-
-function shortcut(namespace: INamespace) {
-    return "n" + namespace.index;
-}
-export function dumpToBSD(namespace: NamespacePrivate): string {
-    const dependency: INamespace[] = constructNamespaceDependency(namespace);
-
-    const addressSpace = namespace.addressSpace;
-
-    const xw: XmlWriter = new XMLWriter(true);
-
-    //xx xw.startDocument():// { encoding: "utf-8", version: "1.0" });
-
-    xw.startElement("opc:TypeDictionary");
-
-    xw.writeAttribute("xmlns:opc", "http://opcfoundation.org/BinarySchema/");
-    xw.writeAttribute("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance");
-    xw.writeAttribute("xmlns:ua", "http://opcfoundation.org/UA/");
-    xw.writeAttribute("xmlns:tns", namespace.namespaceUri);
-
-    const map: { [key: number]: string } = {};
-
-    map[namespace.index] = "tns";
-
-    for (const dependantNamespace of dependency) {
-        const namespaceIndex = dependantNamespace.index;
-        if (namespaceIndex === 0 || namespaceIndex === namespace.index) {
-            continue;
-        }
-        const ns = shortcut(dependantNamespace);
-        map[namespaceIndex] = ns;
-        xw.writeAttribute(`xmlns:${ns}`, dependantNamespace.namespaceUri);
-    }
-
-    xw.writeAttribute("DefaultByteOrder", "LittleEndian");
-    xw.writeAttribute("TargetNamespace", namespace.namespaceUri);
-
-    // <opc:Import Namespace="http://opcfoundation.org/UA/"/>
-    for (const dependantNamespace of dependency) {
-        if (dependantNamespace.index === namespace.index) {
-            continue;
-        }
-        xw.startElement("opc:Import").writeAttribute("Namespace", dependantNamespace.namespaceUri).endElement();
-    }
-    //
-    for (const dataType of namespace._dataTypeIterator()) {
-        dumpDataTypeToBSD(xw, dataType, map);
-    }
-    xw.endElement();
-    //    xw.endDocument();
-
-    return xw.toString();
-}

package/test_helpers/dump_statemachine.ts

@@ -1,155 +0,0 @@
-// /**
-//  * @module node-opcua-address-space
-//  */
-// // tslint:disable:no-console
-// /*
-//  * class Node {
-//  *     { browseName: "string", nodeId: NodeId}
-//  * }
-//  * Transition {
-//  *     browseName: "String"
-//  *     fromState: Node
-//  *     toState: Node
-//  * }
-//  * class SateMachineType {
-//  *    initialState: Node
-//  *    states: [ Node,Node, ...]
-//  *    transitions: [Transition]
-//  * }
-//  * @param stateMachineType
-//  */
-// import { BaseNode, UAState, UAStateMachineEx, UATransition, UAObject, UATransitionEx } from "..";
-
-// export function dumpStateMachineToPlantUML(stateMachineType: UAStateMachineEx): void {
-//     function w(str: string) {
-//         console.log(str);
-//     }
-
-//     function s(state: BaseNode) {
-//         return state.nodeId.value.toString();
-//     }
-
-//     function n(state: BaseNode) {
-//         return state.browseName.name!.toString();
-//     }
-
-//     w("@startuml "); // + stateMachineType.browseName.toString() + ".png");
-//     // initial state if any
-
-//     if (stateMachineType.initialState) {
-//         w(" [*] --> " + s(stateMachineType.initialState));
-//         w(" " + s(stateMachineType.initialState) + ":" + n(stateMachineType.initialState));
-//     } else {
-//         w("[*] --> [*]");
-//     }
-
-//     function t(transition: BaseNode) {
-//         let name = n(transition);
-//         name = name.replace(":", "");
-//         name = name.replace("To", "\\nTo\\n");
-//         name = name.replace("Transition", "\\nTransition");
-//         return name;
-//     }
-
-//     stateMachineType.states.forEach((state: UAObject) => w(" " + s(state) + ": " + n(state)));
-
-//     stateMachineType.transitions.forEach((transition: UATransitionEx) =>
-//         w("  " + s(transition.fromStateNode!) + " --> " + s(transition.toStateNode!) + " : " + t(transition))
-//     );
-
-//     w("@enduml");
-// }
-
-// /*
-//  @startuml
-
-//  2930: Unshelved
-
-//  2932: TimedShelved
-
-//  2933: OneShotShelved
-
-//  2930 --> 2932 :   "2935\nUnshelvedToTimedShelved"
-
-//  2930 --> 2933 :   "2936\nUnshelvedToOneShotShelved"
-
-//  2932 --> 2930 :   "2940\nTimedShelvedToUnshelved"
-
-//  2932 --> 2933 :   "2942\nTimedShelvedToOneShotShelved"
-
-//  2933 --> 2930 :   "2943\nOneShotShelvedToUnshelved"
-
-//  2933 --> 2932 :   "2945\nOneShotShelvedToTimedShelved"
-
-//  @enduml
-
-//  */
-
-// /*
-//  digraph finite_state_machine {
-//  rankdir=LR;
-//  size="8,5"
-//  node [shape = doublecircle]; LR_0 LR_3 LR_4 LR_8;
-//  node [shape = circle];
-//  LR_0 -> LR_2 [ label = "SS(B)" ];
-//  LR_0 -> LR_1 [ label = "SS(S)" ];
-//  LR_1 -> LR_3 [ label = "S($end)" ];
-//  LR_2 -> LR_6 [ label = "SS(b)" ];
-//  LR_2 -> LR_5 [ label = "SS(a)" ];
-//  LR_2 -> LR_4 [ label = "S(A)" ];
-//  LR_5 -> LR_7 [ label = "S(b)" ];
-//  LR_5 -> LR_5 [ label = "S(a)" ];
-//  LR_6 -> LR_6 [ label = "S(b)" ];
-//  LR_6 -> LR_5 [ label = "S(a)" ];
-//  LR_7 -> LR_8 [ label = "S(b)" ];
-//  LR_7 -> LR_5 [ label = "S(a)" ];
-//  LR_8 -> LR_6 [ label = "S(b)" ];
-//  LR_8 -> LR_5 [ label = "S(a)" ];
-//  }
-//  */
-// export function dumpStateMachineToGraphViz(
-//     /*StateMachineProxy*/
-//     stateMachineType: UAStateMachineEx
-// ): void {
-//     function w(str: string) {
-//         console.log(str);
-//     }
-
-//     function s(state: BaseNode) {
-//         return state.nodeId.value.toString();
-//     }
-
-//     function n(state: BaseNode) {
-//         return state.browseName.name!.toString();
-//     }
-
-//     function s_full(state: BaseNode) {
-//         return s(state) + ' [ label = "' + n(state) + '" ]';
-//     }
-
-//     w("digraph finite_state_machine {");
-//     // initial state if any
-
-//     if (stateMachineType.initialState) {
-//         w("node [ shape = doublecircle];");
-//         w("  _" + s_full(stateMachineType.initialState!) + " ;");
-//     }
-//     w("node [ shape = circle];");
-//     stateMachineType.states.forEach((state: UAState) => w("   _" + s_full(state)));
-
-//     stateMachineType.transitions.forEach((transition) =>
-//         w(
-//             "  _" +
-//                 s(transition.fromStateNode!) +
-//                 " -> _" +
-//                 s(transition.toStateNode!) +
-//                 " [ " +
-//                 //   " labeltooltip = \"" + i(transition) + "\" " +
-//                 ', label = "' +
-//                 n(transition) +
-//                 '" ];'
-//         )
-//     );
-
-//     w("}");
-// }