/* eslint-disable complexity */
/* eslint-disable max-statements */
/**
 * @module node-opcua-address-space.Private
 */
// tslint:disable:no-bitwise
import chalk from "chalk";
import type {
    BaseNode,
    CloneExtraInfo,
    CloneFilter,
    IAddressSpace,
    ISessionContext,
    UADataType,
    UAMethod,
    UAObject,
    UAObjectType,
    UAReference,
    UAReferenceType,
    UAVariable,
    UAVariableT,
    UAVariableType
} from "node-opcua-address-space-base";
import { CloneHelper, type CloneOptions, type ConstructNodeIdOptions, fullPath2 } from "node-opcua-address-space-base";
import { assert } from "node-opcua-assert";
import type { DataType } from "node-opcua-basic-types";
import { ObjectTypeIds, VariableTypeIds } from "node-opcua-constants";
import {
    AccessLevelFlag,
    BrowseDirection,
    coerceLocalizedText,
    coerceQualifiedName,
    type LocalizedText,
    NodeClass,
    ResultMask
} from "node-opcua-data-model";
import type { DataValue } from "node-opcua-data-value";
import { checkDebugFlag, make_errorLog, make_warningLog } from "node-opcua-debug";
import { ExpandedNodeId, NodeId, resolveNodeId, sameNodeId } from "node-opcua-nodeid";
import { ReferenceDescription, type ReferenceDescriptionOptions } from "node-opcua-types";
import type { AddressSpacePrivate } from "./address_space_private";
import { BaseNodeImpl, getReferenceType } from "./base_node_impl";
import { UANamespace_process_modelling_rule } from "./namespace_private";
import { ReferenceImpl } from "./reference_impl";
import { wipeMemorizedStuff } from "./tool_isSubtypeOf";

// eslint-disable-next-line prefer-const
const errorLog = make_errorLog("address-space:BaseNode");
const doTrace = checkDebugFlag("INSTANTIATE");
const traceLog = errorLog;
const warningLog = make_warningLog("address-space:BaseNode");

const g_weakMap = new WeakMap();

interface BaseNodeCacheInner {
    typeDefinition?: NodeId;
    typeDefinitionObj?: UAVariableType | UAObjectType | null;
    _aggregates?: BaseNode[];
    _components?: BaseNode[];
    _properties?: BaseNode[];
    _children?: BaseNode[];
    _versionNode?: UAVariableT<string, DataType.String> | null;

    _notifiers?: BaseNode[];
    _eventSources?: BaseNode[];
    _methods?: UAMethod[];
    _ref?: Map<string, UAReference[]>;
    _encoding?: Map<string, UAObject | null>;
    _subtype_idx?: Map<string, UAReferenceType> | null;
    _subtype_idxVersion?: number;
    _allSubTypes?: UAReferenceType[] | null;
    _allSubTypesVersion?: number;
    _subtypeOfObj?: BaseNode | null;
}

export type UAReferenceWithNodeRef = UAReference & { node: BaseNode };
export type HierarchicalIndexMap = Map<string, UAReferenceWithNodeRef | UAReferenceWithNodeRef[]>;

interface BaseNodeCache {
    _childByNameMap?: HierarchicalIndexMap;
    __address_space: IAddressSpace | null;
    _browseFilter?: (this: BaseNode, context?: ISessionContext) => boolean;
    _cache: BaseNodeCacheInner;
    _description?: LocalizedText;
    _displayName: LocalizedText[];
    _parent?: BaseNode | null;
    _back_referenceIdx: Map<string, UAReference>;
    _referenceIdx: Map<string, UAReference>;
}

export function BaseNode_initPrivate(self: BaseNode): BaseNodeCache {
    const _private: BaseNodeCache = {
        __address_space: null,

        _referenceIdx: new Map(),
        _back_referenceIdx: new Map(),

        _browseFilter: undefined,
        _cache: {},
        _description: undefined,
        _displayName: [],
        _parent: undefined
    };
    g_weakMap.set(self, _private);
    return _private;
}

export function BaseNode_removePrivate(self: BaseNode): void {
    // there is no need to delete object from weak map
    // the GC will take care of this in due course
    // g_weakMap.delete(self);
    const _private = BaseNode_getPrivate(self);
    _private._cache = {};
    _private.__address_space = null;
    _private._back_referenceIdx = new Map();
    _private._referenceIdx = new Map();
    _private._description = undefined;
    _private._displayName = [];
}

export function BaseNode_getPrivate(self: BaseNode): BaseNodeCache {
    return g_weakMap.get(self);
}

export function BaseNode_getCache(node: BaseNode): BaseNodeCacheInner {
    return BaseNode_getPrivate(node)._cache;
}
export function BaseNode_clearCache(node: BaseNode): void {
    const _private = BaseNode_getPrivate(node);
    if (_private?._cache) {
        _private._cache = {};
    }
    wipeMemorizedStuff(node);
}
const hasTypeDefinition_ReferenceTypeNodeId = resolveNodeId("HasTypeDefinition");

export interface ToStringOptionBase {
    level: number;
    cycleDetector: Record<string, unknown>;
    padding: string;
}
export interface ToStringOption extends ToStringOptionBase {
    add(someLine: string): void;
    indent(a: string, b: string | null): void;
}

export class ToStringBuilder implements ToStringOption {
    public level = 0;
    public cycleDetector: Record<string, unknown> = {};
    public padding = "";

    private str: string[] = [];

    constructor() {
        //
        this.str = [];
    }
    public add(line: string): void {
        this.str.push(line);
    }
    public toString(): string {
        return this.str.join("\n");
    }

    public indent(str: string, padding: string | null): string {
        padding = padding || "          ";
        return str
            .split("\n")
            .map((r) => {
                return padding + r;
            })
            .join("\n");
    }
}

function set_as_processed(options: ToStringOption, nodeId: NodeId) {
    options.cycleDetector[nodeId.toString()] = nodeId;
}
function is_already_processed(options: ToStringOption, nodeId: NodeId): boolean {
    return !!options.cycleDetector[nodeId.toString()];
}

export function BaseNode_toString(this: BaseNode, options: ToStringOption): void {
    options.level = options.level || 1;

    set_as_processed(options, this.nodeId);

    options.add("");
    options.add(options.padding + chalk.yellow("          nodeId              : ") + this.nodeId.toString());
    options.add(
        `${options.padding + chalk.yellow("          nodeClass           : ")}${NodeClass[this.nodeClass]} (${this.nodeClass})`
    );
    options.add(options.padding + chalk.yellow("          browseName          : ") + this.browseName.toString());
    options.add(
        options.padding +
            chalk.yellow("          displayName         : ") +
            this.displayName.map((f) => `${f.locale} ${f.text}`).join(" | ")
    );

    options.add(
        options.padding + chalk.yellow("          description         : ") + (this.description ? this.description.toString() : "")
    );
}

export function BaseNode_References_toString(this: BaseNode, options: ToStringOption): void {
    const _private = BaseNode_getPrivate(this);

    const displayOptions = {
        addressSpace: this.addressSpace
    };

    const addressSpace = this.addressSpace;

    options.add(`${options.padding + chalk.yellow("    references                : ")}  length =${_private._referenceIdx.size}`);

    function dump_reference(follow: boolean, reference: UAReference | null) {
        if (!reference) {
            return;
        }
        const o = ReferenceImpl.resolveReferenceNode(addressSpace, reference);
        if (!o) {
            warningLog("cannot find reference", reference.toString());
            return;
        }
        const name = o.browseName.toString();
        const modellingRule = o.modellingRule || " ";
        const extra =
            modellingRule[0] +
            (() => {
                switch (o.nodeClass) {
                    case NodeClass.Object:
                        return "[O] ";
                    case NodeClass.Variable:
                        return `[V] ${(o as UAVariable).dataType.toString(displayOptions).padEnd(10)}`;
                    case NodeClass.Method:
                        return "[M] ";
                    case NodeClass.DataType:
                        return "[DT]";
                    case NodeClass.ReferenceType:
                        return "[RT]";
                    case NodeClass.ObjectType:
                        return "[OT]";
                    case NodeClass.VariableType:
                        return "[VT]";
                    case NodeClass.View:
                        return "[V] ";
                }
                return "";
            })();
        options.add(
            options.padding +
                chalk.yellow("      +-> ") +
                reference.toString(displayOptions) +
                " " +
                chalk.cyan(name.padEnd(25, " ")) +
                " " +
                chalk.magentaBright(extra)
        );

        // ignore HasTypeDefinition as it has been already handled
        if (sameNodeId(reference.referenceType, hasTypeDefinition_ReferenceTypeNodeId) && reference.nodeId.namespace === 0) {
            return;
        }
        if (o) {
            if (!is_already_processed(options, o.nodeId)) {
                set_as_processed(options, o.nodeId);
                if (options.level > 1 && follow) {
                    const rr = (o as { toString(options: ToStringOptionBase): string }).toString({
                        cycleDetector: options.cycleDetector,
                        level: options.level - 1,
                        padding: `${options.padding}         `
                    });
                    options.add(rr);
                }
            }
        }
    }

    // direct reference
    for (const r of _private._referenceIdx.values()) {
        dump_reference(false, r);
    }

    options.add(
        options.padding +
            chalk.yellow("    back_references                 : ") +
            chalk.cyan("  length =") +
            _private._back_referenceIdx.size +
            chalk.grey(" ( references held by other nodes involving this node)")
    );
    for (const r of _private._back_referenceIdx.values()) {
        dump_reference(false, r);
    }
    // backward reference
}

function _UAType_toString(this: UAReferenceType | UADataType | UAObjectType | UAVariableType, options: ToStringOption): void {
    if (this.subtypeOfObj) {
        options.add(
            options.padding +
                chalk.yellow("          subtypeOf           : ") +
                this.subtypeOfObj.browseName.toString() +
                " (" +
                this.subtypeOfObj.nodeId.toString() +
                ")"
        );
    }
}

function _UAInstance_toString(this: UAVariable | UAMethod | UAObject, options: ToStringOption): void {
    if (this.typeDefinitionObj) {
        options.add(
            options.padding +
                chalk.yellow("          typeDefinition      : ") +
                this.typeDefinitionObj.browseName.toString() +
                " (" +
                this.typeDefinitionObj.nodeId.toString() +
                ")"
        );
    }
}

export function UAVariableType_toString(this: UAVariableType, options: ToStringOption): void {
    BaseNode_toString.call(this, options);
    _UAType_toString.call(this, options);
    VariableOrVariableType_toString.call(this, options);
    BaseNode_References_toString.call(this, options);
}

export function UAVariable_toString(this: UAVariable, options: ToStringOption): void {
    BaseNode_toString.call(this, options);
    _UAInstance_toString.call(this, options);
    VariableOrVariableType_toString.call(this, options);
    AccessLevelFlags_toString.call(this, options);
    BaseNode_References_toString.call(this, options);
}

export function UAObject_toString(this: UAObject, options: ToStringOption): void {
    BaseNode_toString.call(this, options);
    _UAInstance_toString.call(this, options);
    BaseNode_References_toString.call(this, options);
}

export function UAObjectType_toString(this: UAObjectType, options: ToStringOption): void {
    BaseNode_toString.call(this, options);
    _UAType_toString.call(this, options);
    BaseNode_References_toString.call(this, options);
}

export function valueRankToString(valueRank: number): string {
    switch (valueRank) {
        case 1:
            return "OneDimension (1)";
        case 0:
            return "OneOrMoreDimensions (0)"; // The value is an array with one or more dimensions
        case -1:
            return "Scalar (-1)";
        case -2:
            return "Any (-2)"; // The value can be a scalar or an array with any number of dimensions
        case -3:
            return "ScalarOrOneDimension (2)"; // The value can be a scalar or a one dimensional array.
        default:
            if (valueRank > 0) {
                return `${valueRank}-Dimensions`;
            } else {
                return `Invalid (${valueRank})`;
            }
    }
}

function accessLevelFlagToString(flag: AccessLevelFlag): string {
    const str: string[] = [];
    if (flag & AccessLevelFlag.CurrentRead) {
        str.push("CurrentRead");
    }
    if (flag & AccessLevelFlag.CurrentWrite) {
        str.push("CurrentWrite");
    }
    if (flag & AccessLevelFlag.HistoryRead) {
        str.push("HistoryRead");
    }
    if (flag & AccessLevelFlag.HistoryWrite) {
        str.push("HistoryWrite");
    }
    if (flag & AccessLevelFlag.SemanticChange) {
        str.push("SemanticChange");
    }
    if (flag & AccessLevelFlag.StatusWrite) {
        str.push("StatusWrite");
    }
    if (flag & AccessLevelFlag.TimestampWrite) {
        str.push("TimestampWrite");
    }
    return str.join(" | ");
}

function AccessLevelFlags_toString(this: UAVariable, options: ToStringOption) {
    assert(options);
    options.add(
        `${options.padding + chalk.yellow("          accessLevel         : ")} ${accessLevelFlagToString(this.accessLevel)}`
    );
    if (this.userAccessLevel !== undefined) {
        options.add(
            `${options.padding + chalk.yellow("          userAccessLevel     : ")} ${accessLevelFlagToString(this.userAccessLevel)}`
        );
    }
}

interface WithDataValue {
    $dataValue?: DataValue;
}
export function VariableOrVariableType_toString(this: UAVariableType | UAVariable, options: ToStringOption): void {
    assert(options);
    if (this.dataType) {
        const addressSpace = this.addressSpace;
        const d = addressSpace.findNode(this.dataType);
        const n = d ? `(${d.browseName.toString()})` : " (???)";
        options.add(`${options.padding + chalk.yellow("          dataType            : ")} ${this.dataType}  ${n}`);
    }
    if (this.nodeClass === NodeClass.Variable) {
        const _dataValue = (<WithDataValue>this).$dataValue;
        if (_dataValue) {
            options.add(
                options.padding +
                    chalk.yellow("          value               : ") +
                    "\n" +
                    options.indent(_dataValue.toString(), `${options.padding}                        | `)
            );
        }
    }

    if (Object.hasOwn(this, "valueRank")) {
        if (this.valueRank !== undefined) {
            options.add(
                `${options.padding + chalk.yellow("          valueRank           : ")} ${valueRankToString(this.valueRank)}`
            );
        } else {
            options.add(`${options.padding + chalk.yellow("          valueRank           : ")} undefined`);
        }
    }
    if (this.minimumSamplingInterval !== undefined) {
        options.add(
            `${options.padding + chalk.yellow(" minimumSamplingInterval      : ")} ${this.minimumSamplingInterval.toString()} ms`
        );
    }
    if (this.arrayDimensions) {
        options.add(
            `${options.padding + chalk.yellow(" arrayDimension               : ")} [${this.arrayDimensions.join(",").toString()} ]`
        );
    }
}

/**
 *
 *
 *    MyDeriveType  ------------------- -> MyBaseType    --------------> TopologyElementType
 *        |                                   |                                   |
 *        +- ParameterSet                     +-> ParameterSet                    +-> ParameterSet
 *                 |                                   |
 *                  +- Foo1                            |
 *                                                     +- Bar
 *
 *    Instance
 *
 * @param newParent
 * @param node
 * @param copyAlsoModellingRules
 * @param optionalFilter
 * @param extraInfo
 * @param browseNameMap
 * @returns
 */
function _clone_children_on_template(
    nodeToClone: UAObject | UAVariable | UAMethod | UAObjectType | UAVariableType,
    newParent: BaseNode,
    node: BaseNode,
    copyAlsoModellingRules: boolean,
    optionalFilter: CloneFilter,
    extraInfo: CloneExtraInfo
) {
    /**
     * the type definition node of the node to clone
     */
    const nodeToCloneTypeDefinition =
        nodeToClone.nodeClass === NodeClass.ObjectType || nodeToClone.nodeClass === NodeClass.VariableType
            ? nodeToClone.subtypeOfObj
            : null;
    if (!nodeToCloneTypeDefinition) return;

    // c8 ignore next
    doTrace &&
        traceLog(
            extraInfo?.pad(),
            chalk.gray(
                "-------------------- now cloning children on template ",
                node.browseName.toString(),
                node.nodeId.toString(),
                nodeToCloneTypeDefinition.browseName.toString()
            )
        );

    const namespace = newParent.namespace;

    /**
     * the child node of the new parent that match the node to clone or enrich
     */
    const newParentChild = newParent.getChildByName(node.browseName);
    if (!newParentChild) {
        return;
    }
    // we have found a matching child on the new parent.
    // the mission is to enrich this child node with components and properties that
    // exist also in the template

    let typeDefinitionNode: UAVariableType | UAObjectType | null = nodeToCloneTypeDefinition;
    while (typeDefinitionNode) {
        // c8 ignore next
        doTrace &&
            traceLog(
                extraInfo?.pad(),
                chalk.green(
                    "-------------------- now cloning children on ",
                    newParentChild.browseName.toString(),
                    newParentChild.nodeId.toString(),
                    " (child of ",
                    node.browseName.toString(),
                    node.nodeId.toString(),
                    ") from ",
                    typeDefinitionNode.browseName.toString()
                )
            );

        // Find aggregates with same browseName as node. Do not search children as this includes nodes with HasSubType relation which we do
        // not want. See issue #1326.
        const aggregates = typeDefinitionNode.getAggregates().filter((n) => n.browseName.equals(node.browseName));
        const typeDefinitionChild = aggregates.length > 0 ? aggregates[0] : null;
        if (typeDefinitionChild) {
            const references = typeDefinitionChild.findReferencesEx("Aggregates", BrowseDirection.Forward);

            for (const ref of references) {
                const grandChild = ref.node as UAVariable | UAObject | UAMethod;
                if (grandChild.modellingRule === "MandatoryPlaceholder" || grandChild.modellingRule === "OptionalPlaceholder")
                    continue;
                // if not already node present in new Parent => just ignore
                const hasAlready = newParentChild.getChildByName(grandChild.browseName) !== null;
                if (!hasAlready) {
                    if (optionalFilter && node && !optionalFilter.shouldKeep(node)) {
                        // c8 ignore next
                        doTrace &&
                            traceLog(
                                extraInfo.pad(),
                                "skipping optional ",
                                node.browseName.toString(),
                                "that doesn't appear in the filter"
                            );
                        continue; // skip this node
                    }

                    const options = {
                        namespace,
                        references: [
                            new ReferenceImpl({
                                referenceType: ref.referenceType,
                                isForward: false,
                                nodeId: newParentChild.nodeId
                            })
                        ],
                        copyAlsoModellingRules
                    };

                    const alreadyCloned = extraInfo.getCloned({
                        originalParent: nodeToClone,
                        clonedParent: newParent,
                        originalNode: grandChild
                    });
                    if (alreadyCloned) {
                        alreadyCloned.addReference({
                            referenceType: ref.referenceType,
                            isForward: false,
                            nodeId: newParentChild.nodeId
                        });
                    } else {
                        const clonedGrandChild = grandChild.clone(options, optionalFilter, extraInfo);
                        extraInfo.registerClonedObject({
                            originalNode: grandChild,
                            clonedNode: clonedGrandChild
                        });
                    }
                }
            }
        }
        typeDefinitionNode = typeDefinitionNode.subtypeOfObj;
    }
}

/*
 * clone properties and methods
 * @private
 */
function _clone_collection_new(
    nodeToClone: UAObject | UAVariable | UAMethod | UAObjectType | UAVariableType,
    newParent: BaseNode,
    collectionRef: UAReference[],
    copyAlsoModellingRules: boolean,
    optionalFilter: CloneFilter,
    extraInfo: CloneExtraInfo,
    browseNameMap: Set<string>
): void {
    const namespace = newParent.namespace;
    extraInfo = extraInfo || new CloneHelper();
    const addressSpace = newParent.addressSpace;
    assert(!optionalFilter || (typeof optionalFilter.shouldKeep === "function" && typeof optionalFilter.filterFor === "function"));

    for (const reference of collectionRef) {
        const node = ReferenceImpl.resolveReferenceNode(addressSpace, reference) as UAVariable | UAObject | UAMethod;
        // ensure node is of the correct type,
        // it may happen that the xml nodeset2 file was malformed

        // c8 ignore next
        if (typeof node.clone !== "function") {
            // tslint:disable-next-line:no-console
            warningLog(
                chalk.red("Warning : cannot clone node ") +
                    fullPath2(node) +
                    " of class " +
                    NodeClass[node.nodeClass].toString() +
                    " while cloning " +
                    fullPath2(newParent)
            );
            continue;
        }
        if (node && !node.modellingRule) {
            // c8 ignore next
            doTrace && traceLog(extraInfo.pad(), "skipping  with no modelling rule", fullPath2(node));
            // those node stays in the Type
            continue; // skip this node
        }

        if (optionalFilter && node && !optionalFilter.shouldKeep(node)) {
            // c8 ignore next
            doTrace && traceLog(extraInfo.pad(), "skipping optional that doesn't appear in the filter", fullPath2(node));
            continue; // skip this node
        }
        const key = `${newParent.nodeId.toString()}(${newParent.browseName.toString()})/${node.browseName.toString()}`;
        if (browseNameMap?.has(key)) {
            _clone_children_on_template(nodeToClone, newParent, node, copyAlsoModellingRules, optionalFilter, extraInfo);
            doTrace &&
                traceLog(
                    extraInfo.pad(),
                    "skipping required node with same browseName",
                    fullPath2(node),
                    "because it has already been cloned",
                    "key=",
                    key
                );

            continue; // skipping node with same browseName
        }
        browseNameMap?.add(key);

        // assert(reference.isForward);
        // assert(reference.referenceType instanceof NodeId, "" + reference.referenceType.toString());
        const options = {
            namespace,
            references: [new ReferenceImpl({ referenceType: reference.referenceType, isForward: false, nodeId: newParent.nodeId })],
            copyAlsoModellingRules
        };

        const alreadyCloned = extraInfo.getCloned({ originalParent: nodeToClone, clonedParent: newParent, originalNode: node });
        if (alreadyCloned) {
            // c8 ignore next
            doTrace &&
                traceLog(
                    extraInfo.pad(),
                    "node ",
                    fullPath2(node),
                    "already cloned as",
                    fullPath2(alreadyCloned),
                    "\nnode to clone =",
                    fullPath2(nodeToClone),
                    "\nnew parent   =",
                    fullPath2(newParent)
                );

            const hasReference =
                alreadyCloned.findReferencesExAsObject(reference.referenceType, BrowseDirection.Inverse).length > 0;
            if (!hasReference) {
                alreadyCloned.addReference({
                    referenceType: reference.referenceType,
                    isForward: false,
                    nodeId: newParent.nodeId
                });
            } else {
                // c8 ignore next
                doTrace && traceLog(extraInfo.pad(), "reference to node  ", fullPath2(alreadyCloned), " already exists !");
            }
        } else {
            // c8 ignore next
            doTrace &&
                traceLog(
                    extraInfo.pad(),
                    "cloning => ",
                    reference.referenceType.toString({ addressSpace }),
                    "=>",
                    fullPath2(node),
                    chalk.magentaBright(node.typeDefinitionObj?.browseName.toString())
                );

            extraInfo.level += 1;
            const clonedNode = node.clone(options, optionalFilter, extraInfo);
            extraInfo.level -= 1;

            // c8 ignore next
            doTrace &&
                traceLog(
                    extraInfo.pad(),
                    "cloned => ",
                    fullPath2(node),
                    "",
                    extraInfo.pad(),
                    "    original nodeId",
                    node.nodeId.toString(),
                    "",
                    extraInfo.pad(),
                    "    cloned   nodeId",
                    clonedNode.nodeId.toString(),
                    `${fullPath2(clonedNode)}`
                );

            extraInfo.level++;
            _clone_children_on_template(nodeToClone, newParent, node, copyAlsoModellingRules, optionalFilter, extraInfo);
            extraInfo.level--;

            // also clone or instantiate interface members that may be required in the optionals
            extraInfo.level++;
            _cloneInterface(nodeToClone, newParent, node, optionalFilter, extraInfo, browseNameMap);
            extraInfo.level--;
            // === clone);
            // extraInfo.registerClonedObject(clone, node);
        }
    }
}

type UAInterface = UAObjectType;
function _extractInterfaces2(typeDefinitionNode: UAObjectType | UAVariableType, extraInfo: CloneExtraInfo): UAInterface[] {
    if (
        !typeDefinitionNode ||
        (typeDefinitionNode.nodeId.namespace === 0 &&
            (typeDefinitionNode.nodeId.value === ObjectTypeIds.BaseObjectType ||
                typeDefinitionNode.nodeId.value === VariableTypeIds.BaseVariableType))
    ) {
        return [];
    }

    const addressSpace = typeDefinitionNode.addressSpace;

    const hasInterfaceReference = addressSpace.findReferenceType("HasInterface");
    if (!hasInterfaceReference) {
        // this version of the standard UA namespace doesn't support Interface yet
        return [];
    }
    // example:
    // FolderType
    //   FunctionalGroupType
    //     MachineryItemIdentificationType     : IMachineryItemVendorNameplateType
    //       MachineIdentificationType         : IMachineTagNameplateType, IMachineVendorNamePlateType
    //         MachineToolIdentificationType
    //
    //
    // IMachineTagNameplateType            -subtypeOf-> ITagNameplateType
    // IMachineVendorNamePlateType         -subtypeOf-> IMachineryItemVendorNamePlateType
    // IMachineryItemVendorNamePlateType   -subtypeOf-> IVendorNameplateType
    const interfacesRef = typeDefinitionNode.findReferencesEx("HasInterface", BrowseDirection.Forward);
    const interfaces = interfacesRef.map((r) => addressSpace.findNode(r.nodeId) as UAInterface);

    const baseInterfaces: UAInterface[] = [];
    for (const iface of interfaces) {
        // c8 ignore next
        doTrace &&
            traceLog(
                extraInfo.pad(),
                typeDefinitionNode.browseName.toString(),
                " - has interface -> ",
                iface.browseName.toString()
            );
        baseInterfaces.push(iface);
        if (iface.subtypeOfObj) {
            extraInfo.level++;
            baseInterfaces.push(..._extractInterfaces2(iface.subtypeOfObj, extraInfo));
            extraInfo.level--;
        }
    }
    interfaces.push(...baseInterfaces);
    if (typeDefinitionNode.subtypeOfObj) {
        // c8 ignore next
        doTrace &&
            traceLog(
                extraInfo.pad(),
                typeDefinitionNode.browseName.toString(),
                " - subtypeOf  -> ",
                typeDefinitionNode.subtypeOfObj.browseName.toString()
            );
        extraInfo.level++;
        interfaces.push(..._extractInterfaces2(typeDefinitionNode.subtypeOfObj, extraInfo));
        extraInfo.level--;
    }
    const deduplicatedInterfaces = [...new Set(interfaces)];

    // c8 ignore next
    doTrace &&
        deduplicatedInterfaces.length &&
        traceLog(
            extraInfo.pad(),
            chalk.yellow("Interface for ", typeDefinitionNode.browseName.toString()),
            "=",
            deduplicatedInterfaces.map((x) => x.browseName.toString()).join(" ")
        );
    return deduplicatedInterfaces;
}

function _cloneInterface(
    nodeToClone: UAObject | UAVariable | UAMethod | UAObjectType | UAVariableType,
    _newParent: BaseNode,
    node: UAObject | UAVariable | UAMethod,
    optionalFilter: CloneFilter,
    extraInfo: CloneExtraInfo,
    browseNameMap: Set<string>
): void {
    // c8 ignore next
    doTrace &&
        traceLog(
            extraInfo?.pad(),
            chalk.green("-------------------- now cloning interfaces of ", node.browseName.toString(), node.nodeId.toString())
        );

    extraInfo = extraInfo || new CloneHelper();
    const addressSpace = node.addressSpace;

    if (node.nodeClass !== NodeClass.Object && node.nodeClass !== NodeClass.Variable) {
        return;
    }
    const typeDefinitionNode = node.typeDefinitionObj;
    if (!typeDefinitionNode) {
        return;
    }
    const interfaces = _extractInterfaces2(typeDefinitionNode, extraInfo);
    if (interfaces.length === 0) {
        // c8 ignore next
        doTrace &&
            false &&
            traceLog(extraInfo.pad(), chalk.yellow("No interface for ", node.browseName.toString(), node.nodeId.toString()));
        return;
    }

    // c8 ignore next
    doTrace && traceLog(extraInfo?.pad(), chalk.green("-------------------- interfaces are  ", interfaces.length));

    const localFilter = optionalFilter.filterFor(node);

    for (const iface of interfaces) {
        const aggregates = iface.findReferencesEx("Aggregates", BrowseDirection.Forward);
        if (aggregates.length === 0) continue;
        // c8 ignore next
        doTrace &&
            traceLog(
                extraInfo.pad(),
                chalk.magentaBright("   interface ", iface.browseName.toString()),
                `\n${extraInfo?.pad()}`,
                aggregates.map((r) => r.toString({ addressSpace })).join(`\n${extraInfo?.pad()}`)
            );
        _clone_collection_new(nodeToClone, node, aggregates, false, localFilter, extraInfo, browseNameMap);
    }
}

function __clone_organizes_references(
    nodeToClone: UAObject | UAVariable | UAMethod | UAObjectType | UAVariableType,
    newParent: UAObject | UAVariable | UAMethod,
    copyAlsoModellingRules: boolean,
    optionalFilter: CloneFilter,
    extraInfo: CloneExtraInfo,
    browseNameMap: Set<string>
): void {
    // find all references that derives from the Organizes
    const organizedRef = nodeToClone.findReferencesEx("Organizes", BrowseDirection.Forward);
    if (organizedRef.length === 0) return;
    _clone_collection_new(nodeToClone, newParent, organizedRef, copyAlsoModellingRules, optionalFilter, extraInfo, browseNameMap);
}

function __clone_children_references(
    nodeToClone: UAObject | UAVariable | UAMethod | UAObjectType | UAVariableType,
    newParent: UAObject | UAVariable | UAMethod,
    copyAlsoModellingRules: boolean,
    optionalFilter: CloneFilter,
    extraInfo: CloneExtraInfo,
    browseNameMap: Set<string>
): void {
    // find all references that derives from the Aggregates
    const aggregatesRef = nodeToClone.findReferencesEx("Aggregates", BrowseDirection.Forward);
    if (aggregatesRef.length === 0) return;
    _clone_collection_new(nodeToClone, newParent, aggregatesRef, copyAlsoModellingRules, optionalFilter, extraInfo, browseNameMap);
}

function __clone_interfaces_related_references(
    nodeToClone: UAObject | UAVariable | UAMethod | UAObjectType | UAVariableType,
    newParent: UAObject | UAVariable | UAMethod,
    copyAlsoModellingRules: boolean,
    optionalFilter: CloneFilter,
    extraInfo: CloneExtraInfo,
    browseNameMap: Set<string>
): void {
    // find all references that derives from the HasInterface
    const hasInterfaceRef = nodeToClone.findReferencesEx("HasInterface", BrowseDirection.Forward);
    if (hasInterfaceRef.length === 0) return;
    for (const ref of hasInterfaceRef) {
        let typeDefinitionNode = ReferenceImpl.resolveReferenceNode(nodeToClone.addressSpace, ref) as UAObjectType | null;
        if (!typeDefinitionNode) {
            continue;
        }
        if (doTrace) traceLog(extraInfo?.pad(), chalk.blueBright(newParent.browseName.toString(), "-----> Exploring interface ", typeDefinitionNode.browseName.toString()));
        while (typeDefinitionNode) {
            // c8 ignore next
            doTrace &&
                traceLog(
                    extraInfo?.pad(),
                    chalk.blueBright(newParent.browseName.toString(), "-----> Exploring ", typeDefinitionNode.browseName.toString())
                );
            __clone_children_references(
                typeDefinitionNode,
                newParent,
                copyAlsoModellingRules,
                optionalFilter,
                extraInfo,
                browseNameMap
            );
            typeDefinitionNode = typeDefinitionNode.subtypeOfObj;
        }
    }
}
export function _clone_hierarchical_references(
    nodeToClone: UAObject | UAVariable | UAMethod | UAObjectType | UAVariableType,
    newParent: UAObject | UAVariable | UAMethod,
    copyAlsoModellingRules: boolean,
    optionalFilter: CloneFilter,
    extraInfo: CloneExtraInfo,
    browseNameMap: Set<string>
) {
    __clone_children_references(nodeToClone, newParent, copyAlsoModellingRules, optionalFilter, extraInfo, browseNameMap);
    __clone_organizes_references(nodeToClone, newParent, copyAlsoModellingRules, optionalFilter, extraInfo, browseNameMap);
 //   __clone_interfaces_related_references(nodeToClone, newParent, copyAlsoModellingRules, optionalFilter, extraInfo, browseNameMap);
}
export function _clone_non_hierarchical_references(
    nodeToClone: UAObject | UAVariable | UAMethod | UAObjectType | UAVariableType,
    newParent: BaseNode,
    copyAlsoModellingRules: boolean,
    optionalFilter: CloneFilter,
    extraInfo: CloneExtraInfo,
    browseNameMap: Set<string>
): void {
    // clone only some non hierarchical_references that we do want to clone
    // such as:
    //   HasSubStateMachine
    //   (may be other as well later ... to do )
    assert(newParent instanceof BaseNodeImpl);
    // find all reference that derives from the HasSubStateMachine
    const references = nodeToClone.findReferencesEx("HasSubStateMachine", BrowseDirection.Forward);
    if (references.length === 0) return;
    _clone_collection_new(nodeToClone, newParent, references, copyAlsoModellingRules, optionalFilter, extraInfo, browseNameMap);
}

/**

 * @private
 */
export function _clone<T extends UAObject | UAVariable | UAMethod, O>(
    originalNode: T,
    Constructor: new (options: O) => T,
    options: CloneOptions,
    optionalFilter: CloneFilter,
    extraInfo: CloneExtraInfo
): T {
    assert(typeof Constructor === "function");
    assert(options !== null && typeof options === "object");
    assert(
        !extraInfo || (extraInfo !== null && typeof extraInfo === "object" && typeof extraInfo.registerClonedObject === "function")
    );
    const namespace = options.namespace;
    const constructorOptions = {
        ...options,
        addressSpace: namespace.addressSpace,
        browseName: originalNode.browseName,
        description: originalNode.description,
        displayName: originalNode.displayName,
        nodeClass: originalNode.nodeClass
    };
    constructorOptions.references = options.references || [];

    if (originalNode.nodeClass === NodeClass.Variable || originalNode.nodeClass === NodeClass.Object) {
        const voThis = originalNode as UAObject | UAVariable;
        if (voThis.typeDefinition) {
            constructorOptions.references.push(
                new ReferenceImpl({
                    isForward: true,
                    nodeId: voThis.typeDefinition,
                    referenceType: resolveNodeId("HasTypeDefinition")
                })
            );
        }
    }

    if (!constructorOptions.modellingRule) {
        if (originalNode.modellingRule && options.copyAlsoModellingRules) {
            const modellingRuleNode = originalNode.findReferencesAsObject("HasModellingRule", true)[0];
            assert(modellingRuleNode);
            constructorOptions.references.push(
                new ReferenceImpl({
                    isForward: true,
                    nodeId: modellingRuleNode.nodeId,
                    referenceType: resolveNodeId("HasModellingRule")
                })
            );
        }
    } else {
        UANamespace_process_modelling_rule(constructorOptions.references, constructorOptions.modellingRule);
    }

    constructorOptions.nodeId = namespace.constructNodeId(constructorOptions as ConstructNodeIdOptions);

    assert(constructorOptions.nodeId instanceof NodeId);

    const clonedNode = new Constructor(constructorOptions as unknown as O);
    (originalNode.addressSpace as AddressSpacePrivate)._register(clonedNode);

    extraInfo.registerClonedObject({
        originalNode,
        clonedNode
    });

    if (!options.ignoreChildren) {
        // clone children and the rest ....
        options.copyAlsoModellingRules = options.copyAlsoModellingRules || false;

        const newFilter = optionalFilter.filterFor(clonedNode);

        const browseNameMap = new Set<string>();
        _clone_hierarchical_references(
            originalNode,
            clonedNode,
            options.copyAlsoModellingRules,
            newFilter,
            extraInfo,
            browseNameMap
        );

        if (originalNode.nodeClass === NodeClass.Object || originalNode.nodeClass === NodeClass.Variable) {
            let typeDefinitionNode: UAVariableType | UAObjectType | null = originalNode.typeDefinitionObj;

            extraInfo.pushContext({
                clonedParent: clonedNode,
                originalParent: originalNode
            });

            while (typeDefinitionNode) {
                // c8 ignore next
                doTrace &&
                    traceLog(
                        extraInfo?.pad(),
                        chalk.blueBright(
                            originalNode.browseName.toString(),
                            "-----> Exploring ",
                            typeDefinitionNode.browseName.toString()
                        )
                    );
                _clone_hierarchical_references(
                    typeDefinitionNode,
                    clonedNode,
                    options.copyAlsoModellingRules,
                    newFilter,
                    extraInfo,
                    browseNameMap
                );
                typeDefinitionNode = typeDefinitionNode.subtypeOfObj;
            }

            extraInfo.popContext();
        }
        _clone_non_hierarchical_references(
            originalNode,
            clonedNode,
            options.copyAlsoModellingRules,
            newFilter,
            extraInfo,
            browseNameMap
        );
    }
    clonedNode.propagate_back_references();
    clonedNode.install_extra_properties();

    return clonedNode;
}

function _add(_childByNameMap: HierarchicalIndexMap, reference: UAReferenceWithNodeRef) {
    assert(reference.node); // const targetNode = ReferenceImpl.resolveReferenceNode(addressSpace, reference);
    const targetNode = reference.node;
    const hash = targetNode.browseName?.name || "";
    const existing = _childByNameMap.get(hash);
    if (existing) {
        if (Array.isArray(existing)) {
            existing.push(reference);
        } else {
            _childByNameMap.set(hash, [existing, reference as UAReferenceWithNodeRef]);
        }
    } else {
        _childByNameMap.set(hash, reference as UAReferenceWithNodeRef);
    }
}

function sameRef(a: UAReference, b: UAReference) {
    if (a.isForward !== b.isForward) return false;
    if (!sameNodeId(a.nodeId, b.nodeId)) return false;
    if (!sameNodeId(a.referenceType, b.referenceType)) return false;
    return true;
}
function _remove(_childByNameMap: HierarchicalIndexMap, reference: UAReferenceWithNodeRef) {
    const target = reference.node;
    const hash = target.browseName.name || "";
    const existing = _childByNameMap.get(hash);
    if (Array.isArray(existing)) {
        const remaining = existing.filter((r) => !sameRef(r, reference));
        if (remaining.length === 0) {
            _childByNameMap.delete(hash);
        } else if (remaining.length === 1) {
            _childByNameMap.set(hash, remaining[0]);
        } else {
            _childByNameMap.set(hash, remaining);
        }
    } else {
        _childByNameMap.delete(hash);
    }
}
export function _handle_HierarchicalReference(node: BaseNode, reference: UAReference): void {
    const _private = BaseNode_getPrivate(node);
    if (!reference.isForward) return;
    if (_private._childByNameMap) {
        const addressSpace = node.addressSpace;
        const referenceType = ReferenceImpl.resolveReferenceType(addressSpace, reference);

        if (referenceType) {
            const HierarchicalReferencesType = addressSpace.findReferenceType("HierarchicalReferences");
            if (!HierarchicalReferencesType) return;

            if (referenceType.isSubtypeOf(HierarchicalReferencesType)) {
                ReferenceImpl.resolveReferenceNode(addressSpace, reference);
                _add(_private._childByNameMap, reference as UAReferenceWithNodeRef);
            }
        }
    }
}

export function _get_HierarchicalReference(node: BaseNode): HierarchicalIndexMap {
    const addressSpace = node.addressSpace;
    const _private = BaseNode_getPrivate(node);
    if (!_private._childByNameMap) {
        _private._childByNameMap = new Map();
        const references = node.findReferencesEx("HierarchicalReferences");
        for (const reference of references) {
            ReferenceImpl.resolveReferenceNode(addressSpace, reference);
            _add(_private._childByNameMap, reference as UAReferenceWithNodeRef);
        }
    }
    return _private._childByNameMap;
}
export function _remove_HierarchicalReference(node: BaseNodeImpl, reference: UAReference) {
    const _private = BaseNode_getPrivate(node);
    if (_private._childByNameMap && reference.isForward) {
        const addressSpace = node.addressSpace;
        const referenceType = ReferenceImpl.resolveReferenceType(addressSpace, reference);

        if (referenceType) {
            const HierarchicalReferencesType = addressSpace.findReferenceType("HierarchicalReferences");
            if (HierarchicalReferencesType && referenceType.isSubtypeOf(HierarchicalReferencesType)) {
                ReferenceImpl.resolveReferenceNode(addressSpace, reference);
                _remove(_private._childByNameMap, reference as UAReferenceWithNodeRef);
            }
        }
    }
}

function _makeReferenceDescription(addressSpace: IAddressSpace, reference: UAReference, resultMask: number): ReferenceDescription {
    const isForward = reference.isForward;

    const referenceTypeId = ReferenceImpl.resolveReferenceType(addressSpace, reference).nodeId;
    assert(referenceTypeId instanceof NodeId);

    const obj = ReferenceImpl.resolveReferenceNode(addressSpace, reference);

    let data: ReferenceDescriptionOptions = {};

    if (!obj) {
        // cannot find reference node
        data = {
            isForward,
            nodeId: reference.nodeId as ExpandedNodeId,
            referenceTypeId: resultMask & ResultMask.ReferenceType ? referenceTypeId : null,
            typeDefinition: undefined
        };
    } else {
        const obj2 = obj;

        const objOrVar = (obj2.nodeClass === NodeClass.Object || obj2.nodeClass === NodeClass.Variable ) 
        ? (obj2 as UAVariable | UAObject) : null;

        assert(reference.nodeId, " obj.nodeId");
        data = {
            browseName: resultMask & ResultMask.BrowseName ? coerceQualifiedName(obj.browseName) : null,
            displayName: resultMask & ResultMask.DisplayName ? coerceLocalizedText(obj.displayName[0]) : null,
            isForward: resultMask & ResultMask.IsForward ? isForward : false,
            nodeClass: resultMask & ResultMask.NodeClass ? obj.nodeClass : NodeClass.Unspecified,
            nodeId: obj.nodeId as ExpandedNodeId,
            referenceTypeId: resultMask & ResultMask.ReferenceType ? referenceTypeId : null,
            typeDefinition: resultMask & ResultMask.TypeDefinition ? (objOrVar?.typeDefinition as ExpandedNodeId) : undefined
        };
    }
    if (data.typeDefinition === null) {
        data.typeDefinition = ExpandedNodeId.nullNodeId as ExpandedNodeId;
    }
    const referenceDescription = new ReferenceDescription(data);
    return referenceDescription;
}

export function _constructReferenceDescription(
    addressSpace: IAddressSpace,
    references: UAReference[],
    resultMask: number
): ReferenceDescription[] {
    assert(Array.isArray(references));
    return references.map((reference: UAReference) => _makeReferenceDescription(addressSpace, reference, resultMask));
}

export function BaseNode_remove_backward_reference(this: BaseNodeImpl, reference: UAReference): void {
    const _private = BaseNode_getPrivate(this);
    _remove_HierarchicalReference(this, reference);
    const h = (<ReferenceImpl>reference).hash;
    if (_private._back_referenceIdx?.has(h)) {
        // note : h may not exist in _back_referenceIdx since we are not indexing
        //        _back_referenceIdx to UAObjectType and UAVariableType for performance reasons
        (<ReferenceImpl>_private._back_referenceIdx.get(h)).dispose();
        _private._back_referenceIdx.delete(h);
    }
    (<ReferenceImpl>reference).dispose();
}

export function BaseNode_add_backward_reference(this: BaseNodeImpl, reference: UAReference): void {
    const _private = BaseNode_getPrivate(this);
    const h = (<ReferenceImpl>reference).hash;
    assert(typeof h === "string");
    // c8 ignore next
    if (_private._referenceIdx.has(h)) {
        //  the reference exists already in the forward references
        //  this append for instance when the XML NotSetFile has redundant <UAReference>
        //  in this case there is nothing to do
        return;
    }
    // c8 ignore next
    if (_private._back_referenceIdx.has(h)) {
        const opts = { addressSpace: this.addressSpace };
        warningLog(" Warning !", this.browseName.toString());
        warningLog("    ", reference.toString(opts));
        warningLog(" already found in ===>");
        warningLog([..._private._back_referenceIdx.values()].map((c: UAReference) => c.toString(opts)).join("\n"));
        // tslint:disable-next-line:no-console
        warningLog("===>");
        throw new Error("reference exists already in _back_references");
    }

    if (!getReferenceType(reference)) {
        const _stop_here = 1;
    }
    //  assert(reference._referenceType instanceof ReferenceType);
    _private._back_referenceIdx.set(h, reference);
    _handle_HierarchicalReference(this, reference);
    BaseNode_clearCache(this);
}