@xpack/doxygen2docusaurus 1.0.2

package/dist/doxygen/data-model/doxygen-xml-parser.js

@@ -0,0 +1,459 @@
+/*
+ * This file is part of the xPack project (http://xpack.github.io).
+ * Copyright (c) 2025 Liviu Ionescu. All rights reserved.
+ *
+ * Permission to use, copy, modify, and/or distribute this software
+ * for any purpose is hereby granted, under the terms of the MIT license.
+ *
+ * If a copy of the license was not distributed with this file, it can
+ * be obtained from https://opensource.org/licenses/MIT.
+ */
+// ----------------------------------------------------------------------------
+/**
+ * @file doxygen-xml-parser.ts
+ * @brief Provides the DoxygenXmlParser class for parsing Doxygen-generated
+ * XML files.
+ *
+ * This module defines the {@link DoxygenXmlParser} class, which is responsible
+ * for parsing XML output produced by Doxygen and constructing the internal
+ * data model used by doxygen2docusaurus. It supports parsing the main index,
+ * compound files, and configuration files, and provides utility methods for
+ * extracting attributes and inner elements from the XML structure.
+ *
+ * The parser is designed to preserve the original XML content and element
+ * order, ensuring accurate conversion to the documentation model. It is
+ * intended for use within the xPack doxygen2docusaurus CLI tool.
+ */
+import assert from 'node:assert';
+import * as util from 'node:util';
+import { XMLParser } from 'fast-xml-parser';
+// ----------------------------------------------------------------------------
+/**
+ * The DoxygenXmlParser class is responsible for parsing
+ * Doxygen-generated XML files and constructing the internal data model.
+ *
+ * @remarks
+ * This class initialises the XML parser with options that preserve the order
+ * and structure of the original XML content, ensuring accurate conversion
+ * for documentation purposes. It maintains a counter for the number of files
+ * parsed and stores the resulting data model.
+ *
+ * @example
+ * ```typescript
+ * const parser = new DoxygenXmlParser({ options });
+ * const dataModel = await parser.parse();
+ * ```
+ *
+ * @public
+ */
+export class DoxygenXmlParser {
+    /**
+     * The global configuration options.
+     */
+    options;
+    /**
+     * The XML parser instance configured for Doxygen XML.
+     */
+    xmlParser;
+    images = [];
+    /**
+     * Constructs a new instance of the DoxygenXmlParser class.
+     *
+     * @param options - The global configuration options
+     *
+     * @remarks
+     * This constructor initialises the XML parser with settings that preserve the
+     * order and structure of the original XML content, remove namespace prefixes,
+     * and ensure that both tag and attribute values are parsed. The values are
+     * not
+     * trimmed, maintaining fidelity to the source XML. The provided options are
+     * stored for use throughout the parsing process.
+     */
+    constructor(options) {
+        this.options = options;
+        this.xmlParser = new XMLParser({
+            preserveOrder: true,
+            removeNSPrefix: true,
+            ignoreAttributes: false,
+            parseTagValue: true,
+            parseAttributeValue: true,
+            trimValues: false,
+        });
+    }
+    // --------------------------------------------------------------------------
+    /**
+     * Determines whether the specified XML element has any attributes.
+     *
+     * @param element - The XML element to inspect for attributes
+     * @returns True if the element has attributes; otherwise, false
+     *
+     * @remarks
+     * This method checks for the presence of the ':\@' property on the XML
+     * element, which is the convention used by the XML parser for storing
+     * attributes. If this property exists, the element has attributes; if not,
+     * the element has no attributes. This is a prerequisite check before calling
+     * {@link DoxygenXmlParser.getAttributesNames} or other attribute-related
+     * methods.
+     */
+    hasAttributes(element) {
+        return Object.hasOwn(element, ':@');
+    }
+    /**
+     * Retrieves the names of all attributes present on the specified XML element.
+     *
+     * @param element - The XML element to inspect for attribute names
+     * @returns An array of strings containing the names of all attributes
+     *
+     * @remarks
+     * This method accesses the ':\@' property of the XML element, which is the
+     * convention used by the XML parser for storing attributes, and returns the
+     * keys of this object as an array of attribute names. The method assumes the
+     * element has attributes and does not perform validation - use
+     * {@link DoxygenXmlParser.hasAttributes} to check for attribute presence
+     * first.
+     */
+    getAttributesNames(element) {
+        // eslint-disable-next-line @typescript-eslint/no-empty-object-type
+        return Object.keys(element[':@']);
+    }
+    /**
+     * Determines whether the specified attribute exists on the given XML element.
+     *
+     * @param element - The XML element to inspect
+     * @param name - The name of the attribute to check for
+     * @returns True if the attribute exists; otherwise, false
+     *
+     * @remarks
+     * This method checks for the presence of an attribute within the ':\@'
+     * property of the XML element, which is the convention used by the XML
+     * parser for storing attributes. It returns true if the attribute is found,
+     * otherwise false.
+     */
+    hasAttribute(element, name) {
+        if (Object.hasOwn(element, ':@')) {
+            // eslint-disable-next-line @typescript-eslint/no-empty-object-type
+            const elementWithAttributes = element;
+            return Object.hasOwn(elementWithAttributes[':@'], name);
+        }
+        else {
+            return false;
+        }
+    }
+    /**
+     * Retrieves the value of a named attribute as a string.
+     *
+     * @param element - The XML element containing the attribute
+     * @param name - The name of the attribute to retrieve
+     * @returns The attribute value as a string
+     * @throws If the attribute does not exist
+     *
+     * @remarks
+     * This method checks whether the specified attribute exists on the XML
+     * element and returns its value as a string. If the attribute value is
+     * originally a number (as the XML parser may return numeric strings as
+     * numbers), it is converted to a string to maintain consistency with the
+     * DTD specification. If the attribute is missing, an error is thrown to
+     * indicate the absence.
+     */
+    getAttributeStringValue(element, name) {
+        if (this.hasAttribute(element, name)) {
+            const elementWithNamedAttribute = element[':@'];
+            const attributeValue = elementWithNamedAttribute[name];
+            if (typeof attributeValue === 'string') {
+                return attributeValue;
+            }
+            else if (typeof attributeValue === 'number') {
+                // The xml parser returns attributes like `refid="21"` as numbers,
+                // but the DTD defines them as strings and the applications expects
+                // strings.
+                return String(attributeValue);
+            }
+        }
+        throw new Error(`Element ${util.inspect(element)} does not have the ${name} attribute`);
+    }
+    /**
+     * Retrieves the value of a named attribute as a number.
+     *
+     * @param element - The XML element containing the attribute
+     * @param name - The name of the attribute to retrieve
+     * @returns The attribute value as a number
+     * @throws If the attribute does not exist or is not a number
+     *
+     * @remarks
+     * This method checks whether the specified attribute exists on the XML
+     * element and returns its value as a number. If the attribute is missing
+     * or its value is not a number, an error is thrown to indicate the absence
+     * or incorrect type.
+     */
+    getAttributeNumberValue(element, name) {
+        if (this.hasAttribute(element, name)) {
+            const elementWithNamedAttribute = element[':@'];
+            const attributeValue = elementWithNamedAttribute[name];
+            if (typeof attributeValue === 'number') {
+                return attributeValue;
+            }
+        }
+        throw new Error(`Element ${util.inspect(element)} does not have the ${name} number ` +
+            'attribute');
+    }
+    /**
+     * Retrieves the value of a named attribute as a boolean.
+     *
+     * @param element - The XML element containing the attribute
+     * @param name - The name of the attribute to retrieve
+     * @returns True if the attribute value is 'yes' (case-insensitive);
+     * otherwise, false
+     * @throws If the attribute does not exist or is not a string
+     *
+     * @remarks
+     * This method checks whether the specified attribute exists on the XML
+     * element, and returns true if its value is the string 'yes'
+     * (case-insensitive). If the attribute is missing or its value is not a
+     * string, an error is thrown.
+     */
+    getAttributeBooleanValue(element, name) {
+        if (this.hasAttribute(element, name)) {
+            const elementWithNamedAttribute = element[':@'];
+            const attributeValue = elementWithNamedAttribute[name];
+            if (typeof attributeValue === 'string') {
+                return attributeValue.toLowerCase() === 'yes';
+            }
+        }
+        throw new Error(`Element ${util.inspect(element)} does not have the ${name} ` +
+            'boolean attribute');
+    }
+    /**
+     * Determines whether the specified inner element exists on the given XML
+     * element.
+     *
+     * @param element - The XML element to inspect
+     * @param name - The name of the inner element to check for
+     * @returns True if the inner element exists; otherwise, false
+     *
+     * @remarks
+     * This method checks for the presence of a named property on the XML element.
+     * For text nodes ('#text'), it verifies the value is a string, number, or
+     * boolean. For other elements, it confirms the property is an array, as
+     * per the XML parser's convention.
+     */
+    hasInnerElement(element, name) {
+        if (Object.hasOwn(element, name)) {
+            if (name === '#text') {
+                const value = element['#text'];
+                return (typeof value === 'string' ||
+                    typeof value === 'number' ||
+                    typeof value === 'boolean');
+            }
+            else {
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                return Array.isArray(element[name]);
+            }
+        }
+        else {
+            return false;
+        }
+    }
+    /**
+     * Determines whether a named inner element contains text.
+     *
+     * @param element - The XML element to inspect
+     * @param name - The name of the inner element
+     * @returns True if the inner element contains text or is empty;
+     * otherwise, false
+     *
+     * @remarks
+     * This method checks if the specified inner element exists and contains a
+     * single text node, or is an empty array (representing an empty string).
+     * It asserts the expected structure and type of the value for robustness.
+     */
+    isInnerElementText(element, name) {
+        if (Object.hasOwn(element, name)) {
+            const innerElements = element[name];
+            // console.log('isInnerElementText', util.inspect(element,
+            //   { compact: false, depth: 999 })
+            // assert(innerElements !== undefined)
+            if (innerElements.length === 1) {
+                // assert(innerElements[0] !== undefined)
+                if (Object.hasOwn(innerElements[0], '#text')) {
+                    const value = innerElements[0]['#text'];
+                    assert(typeof value === 'string' ||
+                        typeof value === 'number' ||
+                        typeof value === 'boolean');
+                    return true;
+                }
+            }
+            else if (innerElements.length === 0) {
+                // Empty string.
+                return true;
+            }
+        }
+        return false;
+    }
+    /**
+     * Determines whether the XML element contains a text node.
+     *
+     * @param element - The XML element to inspect
+     * @returns True if the element contains a text node; otherwise, false
+     *
+     * @remarks
+     * This method checks for the presence of a '#text' property on the XML
+     * element, and verifies that its value is a string, number, or boolean.
+     */
+    hasInnerText(element) {
+        if (Object.hasOwn(element, '#text')) {
+            const value = element['#text'];
+            return (typeof value === 'string' ||
+                typeof value === 'number' ||
+                typeof value === 'boolean');
+        }
+        else {
+            return false;
+        }
+    }
+    /**
+     * Retrieves an array of named child elements from the given XML element.
+     *
+     * @typeParam T - The expected type of the child elements array
+     * (defaults to XmlElement[])
+     * @param element - The XML element containing the child elements
+     * @param name - The name of the child elements to retrieve
+     * @returns The array of child elements
+     * @throws If the child elements do not exist
+     *
+     * @remarks
+     * This method accesses the specified property on the XML element and
+     * returns it as an array of child elements. If the property is undefined,
+     * an error is thrown indicating the absence of the expected child element.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-parameters
+    getInnerElements(element, name) {
+        // assert(Object.hasOwn(element, name) === true &&
+        //   Array.isArray((element as { [name]: T })[name]))
+        const innerElements = element[name];
+        if (innerElements !== undefined) {
+            return innerElements;
+        }
+        throw new Error(`Element ${util.inspect(element, { compact: false, depth: 999 })} ` +
+            `does not have the ${name} child element`);
+    }
+    /**
+     * Retrieves the text content of a named child element.
+     *
+     * @param element - The XML element containing the child element
+     * @param name - The name of the child element
+     * @returns The text content of the child element
+     * @throws If the child element does not exist or contains more than one
+     * element
+     *
+     * @remarks
+     * This method accesses the specified child element and returns its text
+     * content. If the child element is missing, an error is thrown. If the
+     * child element is empty, an empty string is returned. If there is more
+     * than one child element, an error is thrown to indicate unexpected
+     * structure.
+     */
+    getInnerElementText(element, name) {
+        const innerElements = element[name];
+        // if (innerElements === undefined) {
+        //   throw new Error('No inner elements')
+        // }
+        if (innerElements.length === 1) {
+            const value = innerElements[0]['#text'];
+            return value.toString();
+        }
+        else if (innerElements.length === 0) {
+            return '';
+        }
+        else {
+            throw new Error('Too many elements');
+        }
+    }
+    /**
+     * Retrieves the numeric value of a named child element.
+     *
+     * @param element - The XML element containing the child element
+     * @param name - The name of the child element
+     * @returns The numeric value of the child element
+     * @throws If the child element does not exist or contains more than one
+     * element
+     *
+     * @remarks
+     * This method accesses the specified child element and returns its value
+     * as a number. If the child element is missing, an error is thrown. If the
+     * child element is empty, NaN is returned. If there is more than one child
+     * element, an error is thrown to indicate unexpected structure.
+     */
+    getInnerElementNumber(element, name) {
+        const innerElements = element[name];
+        // if (innerElements === undefined) {
+        //   throw new Error('No inner elements')
+        // }
+        if (innerElements.length === 1) {
+            const value = innerElements[0]['#text'];
+            return parseInt(value.toString());
+        }
+        else if (innerElements.length === 0) {
+            return NaN;
+        }
+        else {
+            throw new Error('Too many elements');
+        }
+    }
+    /**
+     * Retrieves the boolean value of a named child element.
+     *
+     * @param element - The XML element containing the child element
+     * @param name - The name of the child element
+     * @returns True if the child element's text is 'true'
+     * (case-insensitive); otherwise, false
+     * @throws If the child element does not exist or contains more than one
+     * element
+     *
+     * @remarks
+     * This method accesses the specified child element and returns its value
+     * as a boolean. If the child element is missing, an error is thrown. If
+     * the child element is empty, false is returned. If there is more than one
+     * child element, an error is thrown to indicate unexpected structure.
+     */
+    getInnerElementBoolean(element, name) {
+        const innerElements = element[name];
+        // if (innerElements === undefined) {
+        //   throw new Error('No inner elements')
+        // }
+        if (innerElements.length === 1) {
+            const textValue = innerElements[0]['#text'];
+            const value = textValue.toString().trim().toLowerCase();
+            return value === 'true';
+        }
+        else if (innerElements.length === 0) {
+            return false;
+        }
+        else {
+            throw new Error('Too many elements');
+        }
+    }
+    /**
+     * Retrieves the text content of the XML element.
+     *
+     * @param element - The XML element to retrieve text from
+     * @returns The text content of the element
+     * @throws If the element does not contain a valid text node
+     *
+     * @remarks
+     * This method accesses the '#text' property of the XML element and
+     * returns its value as a string. It asserts that the value is of type
+     * string, number, or boolean before converting it to a string. If the
+     * property is missing or the value is of an unexpected type, an error is
+     * thrown.
+     */
+    getInnerText(element) {
+        // assert(Object.hasOwn(element, '#text') === true)
+        const value = element['#text'];
+        assert(typeof value === 'string' ||
+            typeof value === 'number' ||
+            typeof value === 'boolean');
+        return value.toString();
+    }
+}
+// ----------------------------------------------------------------------------
+//# sourceMappingURL=doxygen-xml-parser.js.map

package/dist/doxygen/data-model/doxygen-xml-parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"doxygen-xml-parser.js","sourceRoot":"","sources":["../../../src/doxygen/data-model/doxygen-xml-parser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E;;;;;;;;;;;;;;GAcG;AAEH,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAEjC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAK3C,+EAA+E;AAE/E;;;;;;;;;;;;;;;;;GAiBG;AAEH,MAAM,OAAO,gBAAgB;IAC3B;;OAEG;IACH,OAAO,CAAY;IAEnB;;OAEG;IACH,SAAS,CAAW;IAEpB,MAAM,GAA2B,EAAE,CAAA;IAEnC;;;;;;;;;;;;OAYG;IACH,YAAY,OAAmB;QAC7B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QAEtB,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC;YAC7B,aAAa,EAAE,IAAI;YACnB,cAAc,EAAE,IAAI;YACpB,gBAAgB,EAAE,KAAK;YACvB,aAAa,EAAE,IAAI;YACnB,mBAAmB,EAAE,IAAI;YACzB,UAAU,EAAE,KAAK;SAClB,CAAC,CAAA;IACJ,CAAC;IAED,6EAA6E;IAE7E;;;;;;;;;;;;;OAaG;IACH,aAAa,CAAC,OAAe;QAC3B,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;IACrC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAAC,OAAe;QAChC,mEAAmE;QACnE,OAAO,MAAM,CAAC,IAAI,CAAE,OAAwB,CAAC,IAAI,CAAC,CAAC,CAAA;IACrD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,OAAe,EAAE,IAAY;QACxC,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YACjC,mEAAmE;YACnE,MAAM,qBAAqB,GAAG,OAAuB,CAAA;YACrD,OAAO,MAAM,CAAC,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAA;QACzD,CAAC;aAAM,CAAC;YACN,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,uBAAuB,CAAC,OAAe,EAAE,IAAY;QACnD,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YACrC,MAAM,yBAAyB,GAC7B,OACD,CAAC,IAAI,CAAC,CAAA;YACP,MAAM,cAAc,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAA;YACtD,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;gBACvC,OAAO,cAAc,CAAA;YACvB,CAAC;iBAAM,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;gBAC9C,kEAAkE;gBAClE,mEAAmE;gBACnE,WAAW;gBACX,OAAO,MAAM,CAAC,cAAc,CAAC,CAAA;YAC/B,CAAC;QACH,CAAC;QACD,MAAM,IAAI,KAAK,CACb,WAAW,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,sBAAsB,IAAI,YAAY,CACvE,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,uBAAuB,CAAC,OAAe,EAAE,IAAY;QACnD,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YACrC,MAAM,yBAAyB,GAC7B,OACD,CAAC,IAAI,CAAC,CAAA;YACP,MAAM,cAAc,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAA;YACtD,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;gBACvC,OAAO,cAAc,CAAA;YACvB,CAAC;QACH,CAAC;QACD,MAAM,IAAI,KAAK,CACb,WAAW,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,sBAAsB,IAAI,UAAU;YAClE,WAAW,CACd,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,wBAAwB,CAAC,OAAe,EAAE,IAAY;QACpD,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YACrC,MAAM,yBAAyB,GAC7B,OACD,CAAC,IAAI,CAAC,CAAA;YACP,MAAM,cAAc,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAA;YACtD,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;gBACvC,OAAO,cAAc,CAAC,WAAW,EAAE,KAAK,KAAK,CAAA;YAC/C,CAAC;QACH,CAAC;QACD,MAAM,IAAI,KAAK,CACb,WAAW,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,sBAAsB,IAAI,GAAG;YAC3D,mBAAmB,CACtB,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,eAAe,CAAC,OAAe,EAAE,IAAY;QAC3C,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YACjC,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;gBACrB,MAAM,KAAK,GAAI,OAAoD,CACjE,OAAO,CACR,CAAA;gBACD,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;oBACzB,OAAO,KAAK,KAAK,QAAQ;oBACzB,OAAO,KAAK,KAAK,SAAS,CAC3B,CAAA;YACH,CAAC;iBAAM,CAAC;gBACN,8DAA8D;gBAC9D,OAAO,KAAK,CAAC,OAAO,CAAE,OAA2B,CAAC,IAAI,CAAC,CAAC,CAAA;YAC1D,CAAC;QACH,CAAC;aAAM,CAAC;YACN,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,OAAe,EAAE,IAAY;QAC9C,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YACjC,MAAM,aAAa,GACjB,OACD,CAAC,IAAI,CAAC,CAAA;YACP,0DAA0D;YAC1D,oCAAoC;YACpC,sCAAsC;YACtC,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC/B,yCAAyC;gBACzC,IAAI,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,CAAC;oBAC7C,MAAM,KAAK,GACT,aAAa,CAAC,CAAC,CAChB,CAAC,OAAO,CAAC,CAAA;oBACV,MAAM,CACJ,OAAO,KAAK,KAAK,QAAQ;wBACvB,OAAO,KAAK,KAAK,QAAQ;wBACzB,OAAO,KAAK,KAAK,SAAS,CAC7B,CAAA;oBACD,OAAO,IAAI,CAAA;gBACb,CAAC;YACH,CAAC;iBAAM,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACtC,gBAAgB;gBAChB,OAAO,IAAI,CAAA;YACb,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CAAC,OAAe;QAC1B,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,CAAC;YACpC,MAAM,KAAK,GAAI,OAAoD,CACjE,OAAO,CACR,CAAA;YACD,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;gBACzB,OAAO,KAAK,KAAK,QAAQ;gBACzB,OAAO,KAAK,KAAK,SAAS,CAC3B,CAAA;QACH,CAAC;aAAM,CAAC;YACN,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,6EAA6E;IAC7E,gBAAgB,CAAmB,OAAe,EAAE,IAAY;QAC9D,kDAAkD;QAClD,qDAAqD;QACrD,MAAM,aAAa,GAAmB,OAAyB,CAAC,IAAI,CAAC,CAAA;QACrE,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,aAAa,CAAA;QACtB,CAAC;QACD,MAAM,IAAI,KAAK,CACb,WAAW,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,GAAG;YACjE,qBAAqB,IAAI,gBAAgB,CAC5C,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,mBAAmB,CAAC,OAAe,EAAE,IAAY;QAC/C,MAAM,aAAa,GACjB,OACD,CAAC,IAAI,CAAC,CAAA;QAEP,qCAAqC;QACrC,yCAAyC;QACzC,IAAI;QACJ,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/B,MAAM,KAAK,GACT,aAAa,CAAC,CAAC,CAChB,CAAC,OAAO,CAAC,CAAA;YACV,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAA;QACzB,CAAC;aAAM,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtC,OAAO,EAAE,CAAA;QACX,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;QACtC,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,qBAAqB,CAAC,OAAe,EAAE,IAAY;QACjD,MAAM,aAAa,GACjB,OACD,CAAC,IAAI,CAAC,CAAA;QAEP,qCAAqC;QACrC,yCAAyC;QACzC,IAAI;QACJ,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/B,MAAM,KAAK,GACT,aAAa,CAAC,CAAC,CAChB,CAAC,OAAO,CAAC,CAAA;YACV,OAAO,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAA;QACnC,CAAC;aAAM,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtC,OAAO,GAAG,CAAA;QACZ,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;QACtC,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,sBAAsB,CAAC,OAAe,EAAE,IAAY;QAClD,MAAM,aAAa,GACjB,OACD,CAAC,IAAI,CAAC,CAAA;QAEP,qCAAqC;QACrC,yCAAyC;QACzC,IAAI;QACJ,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/B,MAAM,SAAS,GACb,aAAa,CAAC,CAAC,CAChB,CAAC,OAAO,CAAC,CAAA;YACV,MAAM,KAAK,GAAG,SAAS,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAA;YACvD,OAAO,KAAK,KAAK,MAAM,CAAA;QACzB,CAAC;aAAM,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtC,OAAO,KAAK,CAAA;QACd,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;QACtC,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,OAAe;QAC1B,mDAAmD;QACnD,MAAM,KAAK,GAAI,OAAoD,CAAC,OAAO,CAAC,CAAA;QAC5E,MAAM,CACJ,OAAO,KAAK,KAAK,QAAQ;YACvB,OAAO,KAAK,KAAK,QAAQ;YACzB,OAAO,KAAK,KAAK,SAAS,CAC7B,CAAA;QACD,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAA;IACzB,CAAC;CACF;AAED,+EAA+E"}

package/dist/doxygen/data-model/index/indexcompoundtype-dm.d.ts

@@ -0,0 +1,21 @@
+import { DoxygenXmlParser } from '../doxygen-xml-parser.js';
+import { IndexMemberDataModel } from './indexmembertype-dm.js';
+import { AbstractDataModelBase } from '../types.js';
+/**
+ * @public
+ */
+export declare abstract class AbstractIndexCompoundType extends AbstractDataModelBase {
+    name: string;
+    members: IndexMemberDataModel[] | undefined;
+    refid: string;
+    kind: string;
+    constructor(xml: DoxygenXmlParser, element: object, elementName: string);
+}
+export type IndexCompoundKind = 'class' | 'struct' | 'union' | 'interface' | 'protocol' | 'category' | 'exception' | 'file' | 'namespace' | 'group' | 'page' | 'example' | 'dir' | 'type' | 'concept' | 'module';
+/**
+ * @public
+ */
+export declare class IndexCompoundDataModel extends AbstractIndexCompoundType {
+    constructor(xml: DoxygenXmlParser, element: object);
+}
+//# sourceMappingURL=indexcompoundtype-dm.d.ts.map

package/dist/doxygen/data-model/index/indexcompoundtype-dm.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexcompoundtype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/index/indexcompoundtype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAanD;;GAEG;AACH,8BAAsB,yBAA0B,SAAQ,qBAAqB;IAE3E,IAAI,SAAK;IACT,OAAO,EAAE,oBAAoB,EAAE,GAAG,SAAS,CAAA;IAG3C,KAAK,SAAK;IACV,IAAI,SAAK;gBAEG,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA+DxE;AAyBD,MAAM,MAAM,iBAAiB,GACzB,OAAO,GACP,QAAQ,GACR,OAAO,GACP,WAAW,GACX,UAAU,GACV,UAAU,GACV,WAAW,GACX,MAAM,GACN,WAAW,GACX,OAAO,GACP,MAAM,GACN,SAAS,GACT,KAAK,GACL,MAAM,GACN,SAAS,GACT,QAAQ,CAAA;AAMZ;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,yBAAyB;gBACvD,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}

package/dist/doxygen/data-model/index/indexcompoundtype-dm.js

@@ -0,0 +1,96 @@
+/*
+ * This file is part of the xPack project (http://xpack.github.io).
+ * Copyright (c) 2025 Liviu Ionescu. All rights reserved.
+ *
+ * Permission to use, copy, modify, and/or distribute this software
+ * for any purpose is hereby granted, under the terms of the MIT license.
+ *
+ * If a copy of the license was not distributed with this file, it can
+ * be obtained from https://opensource.org/licenses/MIT.
+ */
+// ----------------------------------------------------------------------------
+import assert from 'node:assert';
+import * as util from 'node:util';
+import { IndexMemberDataModel } from './indexmembertype-dm.js';
+import { AbstractDataModelBase } from '../types.js';
+// ----------------------------------------------------------------------------
+// <xsd:complexType name="CompoundType">
+//   <xsd:sequence>
+//     <xsd:element name="name" type="xsd:string"/>
+//     <xsd:element name="member" type="MemberType" minOccurs="0" maxOccurs="unbounded"/>
+//   </xsd:sequence>
+//   <xsd:attribute name="refid" type="xsd:string" use="required"/>
+//   <xsd:attribute name="kind" type="CompoundKind" use="required"/>
+// </xsd:complexType>
+/**
+ * @public
+ */
+export class AbstractIndexCompoundType extends AbstractDataModelBase {
+    // Mandatory elements.
+    name = '';
+    members; // [0-n]
+    // Mandatory attributes.
+    refid = '';
+    kind = ''; // CompoundKind
+    constructor(xml, element, elementName) {
+        super(elementName);
+        // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
+        // ------------------------------------------------------------------------
+        // Process elements.
+        const innerElements = xml.getInnerElements(element, elementName);
+        assert(innerElements.length > 0);
+        for (const innerElement of innerElements) {
+            if (xml.hasInnerText(innerElement)) {
+                // Ignore texts.
+            }
+            else if (xml.isInnerElementText(innerElement, 'name')) {
+                assert(this.name.length === 0);
+                this.name = xml.getInnerElementText(innerElement, 'name');
+            }
+            else if (xml.hasInnerElement(innerElement, 'member')) {
+                this.members ??= [];
+                this.members.push(new IndexMemberDataModel(xml, innerElement));
+            }
+            else {
+                console.error(util.inspect(innerElement));
+                console.error(`index ${elementName} element:`, Object.keys(innerElement), 'not implemented yet in', this.constructor.name);
+            }
+        }
+        // ------------------------------------------------------------------------
+        // Process attributes.
+        assert(xml.hasAttributes(element));
+        const attributesNames = xml.getAttributesNames(element);
+        // console.log(attributesNames)
+        for (const attributeName of attributesNames) {
+            // console.log(attributeName)
+            if (attributeName === '@_refid') {
+                this.refid = xml.getAttributeStringValue(element, '@_refid');
+            }
+            else if (attributeName === '@_kind') {
+                this.kind = xml.getAttributeStringValue(element, '@_kind');
+            }
+            else {
+                console.error(util.inspect(element, { compact: false, depth: 999 }));
+                console.error(`index ${elementName} attribute:`, attributeName, 'not implemented yet in', this.constructor.name);
+            }
+        }
+        assert(this.refid.length > 0);
+        assert(this.kind.length > 0);
+        // ------------------------------------------------------------------------
+        // console.log(util.inspect(this, { compact: false, depth: 999 }))
+        // console.log('compound: ', this.refid)
+    }
+}
+// ----------------------------------------------------------------------------
+// <xsd:element name="compound" type="CompoundType" minOccurs="0" maxOccurs="unbounded"/>
+/**
+ * @public
+ */
+export class IndexCompoundDataModel extends AbstractIndexCompoundType {
+    constructor(xml, element) {
+        // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
+        super(xml, element, 'compound');
+    }
+}
+// ----------------------------------------------------------------------------
+//# sourceMappingURL=indexcompoundtype-dm.js.map

package/dist/doxygen/data-model/index/indexcompoundtype-dm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexcompoundtype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/index/indexcompoundtype-dm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAGjC,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEnD,+EAA+E;AAE/E,wCAAwC;AACxC,mBAAmB;AACnB,mDAAmD;AACnD,yFAAyF;AACzF,oBAAoB;AACpB,mEAAmE;AACnE,oEAAoE;AACpE,qBAAqB;AAErB;;GAEG;AACH,MAAM,OAAgB,yBAA0B,SAAQ,qBAAqB;IAC3E,sBAAsB;IACtB,IAAI,GAAG,EAAE,CAAA;IACT,OAAO,CAAoC,CAAC,QAAQ;IAEpD,wBAAwB;IACxB,KAAK,GAAG,EAAE,CAAA;IACV,IAAI,GAAG,EAAE,CAAA,CAAC,eAAe;IAEzB,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,CAAC,CAAA;QAElB,kFAAkF;QAElF,2EAA2E;QAC3E,oBAAoB;QAEpB,MAAM,aAAa,GAAG,GAAG,CAAC,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;QAChE,MAAM,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAEhC,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;YACzC,IAAI,GAAG,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,CAAC;gBACnC,gBAAgB;YAClB,CAAC;iBAAM,IAAI,GAAG,CAAC,kBAAkB,CAAC,YAAY,EAAE,MAAM,CAAC,EAAE,CAAC;gBACxD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAA;gBAC9B,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,mBAAmB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAA;YAC3D,CAAC;iBAAM,IAAI,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,CAAC;gBACvD,IAAI,CAAC,OAAO,KAAK,EAAE,CAAA;gBACnB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,oBAAoB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAA;YAChE,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAA;gBACzC,OAAO,CAAC,KAAK,CACX,SAAS,WAAW,WAAW,EAC/B,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EACzB,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAED,2EAA2E;QAC3E,sBAAsB;QAEtB,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAA;QAElC,MAAM,eAAe,GAAG,GAAG,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;QACvD,+BAA+B;QAC/B,KAAK,MAAM,aAAa,IAAI,eAAe,EAAE,CAAC;YAC5C,6BAA6B;YAC7B,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;gBAChC,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;YAC9D,CAAC;iBAAM,IAAI,aAAa,KAAK,QAAQ,EAAE,CAAC;gBACtC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;YAC5D,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;gBACpE,OAAO,CAAC,KAAK,CACX,SAAS,WAAW,aAAa,EACjC,aAAa,EACb,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC7B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAE5B,2EAA2E;QAE3E,kEAAkE;QAClE,wCAAwC;IAC1C,CAAC;CACF;AA2CD,+EAA+E;AAE/E,yFAAyF;AAEzF;;GAEG;AACH,MAAM,OAAO,sBAAuB,SAAQ,yBAAyB;IACnE,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,UAAU,CAAC,CAAA;IACjC,CAAC;CACF;AAED,+EAA+E"}

package/dist/doxygen/data-model/index/indexdoxygentype-dm.d.ts

@@ -0,0 +1,20 @@
+import { DoxygenXmlParser } from '../doxygen-xml-parser.js';
+import { IndexCompoundDataModel } from './indexcompoundtype-dm.js';
+import { AbstractDataModelBase } from '../types.js';
+/**
+ * @public
+ */
+export declare abstract class AbstractIndexDoxygenType extends AbstractDataModelBase {
+    version: string;
+    lang: string;
+    compounds?: IndexCompoundDataModel[] | undefined;
+    noNamespaceSchemaLocation?: string | undefined;
+    constructor(xml: DoxygenXmlParser, element: object, elementName: string);
+}
+/**
+ * @public
+ */
+export declare class DoxygenIndexDataModel extends AbstractIndexDoxygenType {
+    constructor(xml: DoxygenXmlParser, element: object);
+}
+//# sourceMappingURL=indexdoxygentype-dm.d.ts.map

package/dist/doxygen/data-model/index/indexdoxygentype-dm.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexdoxygentype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/index/indexdoxygentype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAA;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAanD;;GAEG;AACH,8BAAsB,wBAAyB,SAAQ,qBAAqB;IAE1E,OAAO,SAAK;IACZ,IAAI,SAAK;IAGT,SAAS,CAAC,EAAE,sBAAsB,EAAE,GAAG,SAAS,CAAA;IAGhD,yBAAyB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;gBAElC,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA4DxE;AAMD;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,wBAAwB;gBACrD,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}