@xpack/doxygen2docusaurus 1.0.2

package/dist/docusaurus/view-model/view-model.js

@@ -0,0 +1,284 @@
+/*
+ * 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 { AbstractCompoundDefType } from '../../doxygen/data-model/compounds/compounddef-dm.js';
+import { TocItemDataModel, TocListDataModel, } from '../../doxygen/data-model/compounds/tableofcontentstype-dm.js';
+import { AbstractDataModelBase } from '../../doxygen/data-model/types.js';
+import { Classes } from './classes-vm.js';
+import { DescriptionAnchor, DescriptionTocItem, DescriptionTocList, } from './description-anchors.js';
+import { FilesAndFolders } from './files-and-folders-vm.js';
+import { Groups } from './groups-vm.js';
+import { Member } from './members-vm.js';
+import { Namespaces } from './namespaces-vm.js';
+import { Pages } from './pages-vm.js';
+import { AbstractDocAnchorType, AbstractDocSectType, } from '../../doxygen/data-model/compounds/descriptiontype-dm.js';
+import { stripPermalinkHexAnchor } from '../utils.js';
+// ----------------------------------------------------------------------------
+/**
+ * @public
+ */
+export class ViewModel {
+    options;
+    workspace;
+    // The key is one of the above collection names.
+    // groups, classes, namespaces, files, pages.
+    collections;
+    // View model objects.
+    compoundsById = new Map();
+    membersById = new Map();
+    descriptionTocLists = [];
+    descriptionTocItemsById = new Map();
+    descriptionAnchorsById = new Map();
+    constructor(workspace) {
+        this.workspace = workspace;
+        this.options = workspace.options;
+        this.collections = new Map();
+    }
+    create() {
+        this.collections.set('groups', new Groups(this.workspace));
+        this.collections.set('namespaces', new Namespaces(this.workspace));
+        this.collections.set('classes', new Classes(this.workspace));
+        this.collections.set('files', new FilesAndFolders(this.workspace));
+        this.collections.set('pages', new Pages(this.workspace));
+        this.createVieModelObjects();
+        this.createCompoundsHierarchies();
+        this.createMembersMap();
+        this.initializeCompoundsLate();
+        this.initializeMemberLate();
+        this.validatePermalinks();
+        this.cleanups();
+    }
+    // --------------------------------------------------------------------------
+    createVieModelObjects() {
+        console.log('Creating view model objects...');
+        for (const compoundDefDataModel of this.workspace.dataModel.compoundDefs) {
+            let compound = undefined;
+            const { kind } = compoundDefDataModel;
+            const collectionName = this.workspace.collectionNamesByKind[kind];
+            const collection = this.collections.get(collectionName);
+            if (collection !== undefined) {
+                // Create the compound object and add it to the parent collection.
+                // console.log(
+                //   compoundDefDataModel.kind, compoundDefDataModel.compoundName
+                // )
+                compound = collection.addChild(compoundDefDataModel);
+                // Also add it to the global compounds map.
+                this.compoundsById.set(compound.id, compound);
+                // console.log('compoundsById.set', compound.kind, compound.id)
+            }
+            if (compound !== undefined) {
+                if (compoundDefDataModel instanceof AbstractCompoundDefType &&
+                    compoundDefDataModel.detailedDescription !== undefined) {
+                    this.findDescriptionIdsRecursively(compound, compoundDefDataModel.detailedDescription);
+                }
+            }
+            else {
+                // console.error(
+                //   util.inspect(compoundDefDataModel, { compact: false, depth: 999 })
+                // )
+                console.error('compoundDefDataModel', compoundDefDataModel.kind, 'not implemented yet in', this.constructor.name, 'createVieModelObjects');
+            }
+        }
+        if (this.options.verbose) {
+            console.log(this.compoundsById.size, 'compound definitions');
+        }
+        // console.log(this.descriptionTocLists)
+    }
+    findDescriptionIdsRecursively(compound, element) {
+        // console.log(compound.id, typeof element)
+        if (element.children === undefined) {
+            return;
+        }
+        for (const childDataModel of element.children) {
+            if (childDataModel instanceof TocListDataModel) {
+                const tocList = new DescriptionTocList(compound);
+                // console.log(elementChild)
+                assert(childDataModel.tocItems !== undefined);
+                for (const tocItemDataModel of childDataModel.tocItems) {
+                    if (tocItemDataModel instanceof TocItemDataModel) {
+                        const tocItem = new DescriptionTocItem(tocItemDataModel.id, tocList);
+                        tocList.tocItems.push(tocItem);
+                        this.descriptionTocItemsById.set(tocItem.id, tocItem);
+                    }
+                }
+                this.descriptionTocLists.push(tocList);
+            }
+            else if (childDataModel instanceof AbstractDocSectType) {
+                if (childDataModel.id !== undefined) {
+                    const anchor = new DescriptionAnchor(compound, childDataModel.id);
+                    this.descriptionAnchorsById.set(anchor.id, anchor);
+                }
+                this.findDescriptionIdsRecursively(compound, childDataModel);
+            }
+            else if (childDataModel instanceof AbstractDocAnchorType) {
+                // console.log(childDataModel)
+                if (childDataModel.id.length > 0) {
+                    const section = new DescriptionAnchor(compound, childDataModel.id);
+                    this.descriptionAnchorsById.set(section.id, section);
+                }
+            }
+            else if (childDataModel instanceof AbstractDataModelBase) {
+                // if (childDataModel instanceof AbstractDocEntryType) {
+                //   console.log(childDataModel)
+                // }
+                this.findDescriptionIdsRecursively(compound, childDataModel);
+            }
+        }
+    }
+    // --------------------------------------------------------------------------
+    createCompoundsHierarchies() {
+        console.log('Creating compounds hierarchies...');
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        for (const [collectionName, collection] of this.collections) {
+            // console.log('createHierarchies:', collectionName)
+            collection.createCompoundsHierarchies();
+        }
+    }
+    // --------------------------------------------------------------------------
+    // Required since references can be resolved only after all objects are in.
+    initializeCompoundsLate() {
+        console.log('Performing compounds late initializations...');
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        for (const [collectionName, collection] of this.collections) {
+            // console.log('createHierarchies:', collectionName)
+            for (const [, compound] of collection.collectionCompoundsById) {
+                if (this.options.debug) {
+                    console.log(compound.kind, compound.compoundName);
+                }
+                compound.initializeLate();
+            }
+        }
+    }
+    // --------------------------------------------------------------------------
+    createMembersMap() {
+        console.log('Creating member definitions map...');
+        for (const [, compound] of this.compoundsById) {
+            // console.log(compound.kind, compound.compoundName, compound.id)
+            for (const section of compound.sections) {
+                // console.log('  ', sectionDef.kind)
+                for (const member of section.indexMembers) {
+                    if (member instanceof Member) {
+                        const memberCompoundId = stripPermalinkHexAnchor(member.id);
+                        if (memberCompoundId !== compound.id) {
+                            // Skip member definitions from different compounds.
+                            // Hopefully they are defined properly there.
+                            // console.log(
+                            //   'member from another compound', compoundId, 'skipped'
+                            // )
+                        }
+                        else {
+                            // console.log('    ', memberDef.kind, memberDef.id)
+                            if (this.membersById.has(member.id)) {
+                                if (this.options.verbose) {
+                                    console.warn('member already in map', member.id, 'in', this.membersById.get(member.id)?.name);
+                                }
+                            }
+                            else {
+                                this.membersById.set(member.id, member);
+                            }
+                        }
+                    }
+                }
+            }
+        }
+        if (this.options.verbose) {
+            console.log(this.membersById.size, 'member definitions');
+        }
+    }
+    // --------------------------------------------------------------------------
+    // Required since references can be resolved only after all objects are in.
+    initializeMemberLate() {
+        console.log('Performing members late initializations...');
+        for (const [, compound] of this.compoundsById) {
+            if (this.options.debug) {
+                console.log(compound.kind, compound.compoundName, compound.id);
+            }
+            for (const section of compound.sections) {
+                section.initializeLate();
+                if (this.options.debug) {
+                    console.log('  ', section.kind);
+                }
+                for (const member of section.indexMembers) {
+                    if (member instanceof Member) {
+                        if (this.options.debug) {
+                            console.log('    ', member.kind, member.id);
+                        }
+                        member.initializeLate();
+                    }
+                }
+            }
+        }
+    }
+    // --------------------------------------------------------------------------
+    /**
+     * @brief Validate the uniqueness of permalinks.
+     */
+    validatePermalinks() {
+        console.log('Validating permalinks...');
+        const pagePermalinksById = new Map();
+        const compoundsByPermalink = new Map();
+        for (const compoundDefDataModel of this.workspace.dataModel.compoundDefs) {
+            // console.log(
+            //   compoundDefDataModel.kind, compoundDefDataModel.compoundName
+            // )
+            const { id } = compoundDefDataModel;
+            if (pagePermalinksById.has(id)) {
+                console.warn('Duplicate id', id);
+            }
+            const compound = this.compoundsById.get(id);
+            if (compound === undefined) {
+                console.error('compoundDefDataModel', id, 'not yet processed in', this.constructor.name, 'validatePermalinks');
+                continue;
+            }
+            const permalink = compound.relativePermalink;
+            if (permalink !== undefined) {
+                // console.log('permalink:', permalink)
+                let compoundsMap = compoundsByPermalink.get(permalink);
+                if (compoundsMap === undefined) {
+                    compoundsMap = new Map();
+                    compoundsByPermalink.set(permalink, compoundsMap);
+                }
+                pagePermalinksById.set(id, permalink);
+                if (!compoundsMap.has(compound.id)) {
+                    compoundsMap.set(compound.id, compound);
+                }
+            }
+        }
+        for (const [permalink, compoundsMap] of compoundsByPermalink) {
+            if (compoundsMap.size > 1) {
+                if (this.options.verbose) {
+                    console.warn('Permalink', permalink, 'has', compoundsMap.size, 'occurrences:');
+                }
+                let count = 1;
+                for (const [, compound] of compoundsMap) {
+                    const suffix = `-${count.toString()}`;
+                    count += 1;
+                    assert(compound.relativePermalink !== undefined);
+                    compound.relativePermalink += suffix;
+                    assert(compound.sidebarId !== undefined);
+                    compound.sidebarId += suffix;
+                    if (this.options.verbose) {
+                        console.warn('-', compound.relativePermalink, compound.id);
+                    }
+                }
+            }
+        }
+    }
+    // --------------------------------------------------------------------------
+    cleanups() {
+        for (const [, compound] of this.compoundsById) {
+            compound._private._compoundDef = undefined;
+        }
+    }
+}
+// ----------------------------------------------------------------------------
+//# sourceMappingURL=view-model.js.map

package/dist/docusaurus/view-model/view-model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"view-model.js","sourceRoot":"","sources":["../../../src/docusaurus/view-model/view-model.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAEhC,OAAO,EAAE,uBAAuB,EAAE,MAAM,sDAAsD,CAAA;AAC9F,OAAO,EACL,gBAAgB,EAChB,gBAAgB,GACjB,MAAM,8DAA8D,CAAA;AACrE,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAA;AAEzE,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAGzC,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,GACnB,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAC3D,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AACrC,OAAO,EACL,qBAAqB,EACrB,mBAAmB,GACpB,MAAM,0DAA0D,CAAA;AACjE,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AAGrD,+EAA+E;AAE/E;;GAEG;AACH,MAAM,OAAO,SAAS;IACpB,OAAO,CAAY;IAEnB,SAAS,CAAW;IAEpB,gDAAgD;IAChD,6CAA6C;IAC7C,WAAW,CAA6B;IAExC,sBAAsB;IACtB,aAAa,GAAG,IAAI,GAAG,EAAwB,CAAA;IAE/C,WAAW,GAAG,IAAI,GAAG,EAAkB,CAAA;IAEvC,mBAAmB,GAAyB,EAAE,CAAA;IAC9C,uBAAuB,GAAG,IAAI,GAAG,EAA8B,CAAA;IAE/D,sBAAsB,GAAG,IAAI,GAAG,EAA6B,CAAA;IAE7D,YAAY,SAAoB;QAC9B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,OAAO,CAAA;QAEhC,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,EAAE,CAAA;IAC9B,CAAC;IAED,MAAM;QACJ,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAA;QAC1D,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAA;QAClE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAA;QAC5D,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAA;QAClE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAA;QAExD,IAAI,CAAC,qBAAqB,EAAE,CAAA;QAC5B,IAAI,CAAC,0BAA0B,EAAE,CAAA;QAEjC,IAAI,CAAC,gBAAgB,EAAE,CAAA;QAEvB,IAAI,CAAC,uBAAuB,EAAE,CAAA;QAC9B,IAAI,CAAC,oBAAoB,EAAE,CAAA;QAE3B,IAAI,CAAC,kBAAkB,EAAE,CAAA;QAEzB,IAAI,CAAC,QAAQ,EAAE,CAAA;IACjB,CAAC;IAED,6EAA6E;IAE7E,qBAAqB;QACnB,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAA;QAC7C,KAAK,MAAM,oBAAoB,IAAI,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC;YACzE,IAAI,QAAQ,GAA6B,SAAS,CAAA;YAClD,MAAM,EAAE,IAAI,EAAE,GAAG,oBAAoB,CAAA;YAErC,MAAM,cAAc,GAClB,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAA;YAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;YACvD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;gBAC7B,kEAAkE;gBAClE,eAAe;gBACf,iEAAiE;gBACjE,IAAI;gBACJ,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAA;gBACpD,2CAA2C;gBAC3C,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAA;gBAC7C,+DAA+D;YACjE,CAAC;YAED,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAC3B,IACE,oBAAoB,YAAY,uBAAuB;oBACvD,oBAAoB,CAAC,mBAAmB,KAAK,SAAS,EACtD,CAAC;oBACD,IAAI,CAAC,6BAA6B,CAChC,QAAQ,EACR,oBAAoB,CAAC,mBAAmB,CACzC,CAAA;gBACH,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,iBAAiB;gBACjB,uEAAuE;gBACvE,IAAI;gBACJ,OAAO,CAAC,KAAK,CACX,sBAAsB,EACtB,oBAAoB,CAAC,IAAI,EACzB,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,EACrB,uBAAuB,CACxB,CAAA;YACH,CAAC;QACH,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACzB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,sBAAsB,CAAC,CAAA;QAC9D,CAAC;QACD,wCAAwC;IAC1C,CAAC;IAED,6BAA6B,CAC3B,QAAsB,EACtB,OAA8B;QAE9B,2CAA2C;QAC3C,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACnC,OAAM;QACR,CAAC;QAED,KAAK,MAAM,cAAc,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YAC9C,IAAI,cAAc,YAAY,gBAAgB,EAAE,CAAC;gBAC/C,MAAM,OAAO,GAAG,IAAI,kBAAkB,CAAC,QAAQ,CAAC,CAAA;gBAChD,4BAA4B;gBAC5B,MAAM,CAAC,cAAc,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAA;gBAC7C,KAAK,MAAM,gBAAgB,IAAI,cAAc,CAAC,QAAQ,EAAE,CAAC;oBACvD,IAAI,gBAAgB,YAAY,gBAAgB,EAAE,CAAC;wBACjD,MAAM,OAAO,GAAG,IAAI,kBAAkB,CAAC,gBAAgB,CAAC,EAAE,EAAE,OAAO,CAAC,CAAA;wBACpE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;wBAC9B,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAA;oBACvD,CAAC;gBACH,CAAC;gBACD,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YACxC,CAAC;iBAAM,IAAI,cAAc,YAAY,mBAAmB,EAAE,CAAC;gBACzD,IAAI,cAAc,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;oBACpC,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC,QAAQ,EAAE,cAAc,CAAC,EAAE,CAAC,CAAA;oBACjE,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;gBACpD,CAAC;gBACD,IAAI,CAAC,6BAA6B,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAA;YAC9D,CAAC;iBAAM,IAAI,cAAc,YAAY,qBAAqB,EAAE,CAAC;gBAC3D,8BAA8B;gBAC9B,IAAI,cAAc,CAAC,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACjC,MAAM,OAAO,GAAG,IAAI,iBAAiB,CAAC,QAAQ,EAAE,cAAc,CAAC,EAAE,CAAC,CAAA;oBAClE,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAA;gBACtD,CAAC;YACH,CAAC;iBAAM,IAAI,cAAc,YAAY,qBAAqB,EAAE,CAAC;gBAC3D,wDAAwD;gBACxD,gCAAgC;gBAChC,IAAI;gBACJ,IAAI,CAAC,6BAA6B,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAA;YAC9D,CAAC;QACH,CAAC;IACH,CAAC;IAED,6EAA6E;IAE7E,0BAA0B;QACxB,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAA;QAEhD,6DAA6D;QAC7D,KAAK,MAAM,CAAC,cAAc,EAAE,UAAU,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YAC5D,oDAAoD;YACpD,UAAU,CAAC,0BAA0B,EAAE,CAAA;QACzC,CAAC;IACH,CAAC;IAED,6EAA6E;IAE7E,2EAA2E;IAC3E,uBAAuB;QACrB,OAAO,CAAC,GAAG,CAAC,8CAA8C,CAAC,CAAA;QAE3D,6DAA6D;QAC7D,KAAK,MAAM,CAAC,cAAc,EAAE,UAAU,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YAC5D,oDAAoD;YACpD,KAAK,MAAM,CAAC,EAAE,QAAQ,CAAC,IAAI,UAAU,CAAC,uBAAuB,EAAE,CAAC;gBAC9D,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;oBACvB,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAA;gBACnD,CAAC;gBACD,QAAQ,CAAC,cAAc,EAAE,CAAA;YAC3B,CAAC;QACH,CAAC;IACH,CAAC;IAED,6EAA6E;IAE7E,gBAAgB;QACd,OAAO,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAA;QACjD,KAAK,MAAM,CAAC,EAAE,QAAQ,CAAC,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YAC9C,iEAAiE;YACjE,KAAK,MAAM,OAAO,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;gBACxC,qCAAqC;gBACrC,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;oBAC1C,IAAI,MAAM,YAAY,MAAM,EAAE,CAAC;wBAC7B,MAAM,gBAAgB,GAAG,uBAAuB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;wBAC3D,IAAI,gBAAgB,KAAK,QAAQ,CAAC,EAAE,EAAE,CAAC;4BACrC,oDAAoD;4BACpD,6CAA6C;4BAC7C,eAAe;4BACf,0DAA0D;4BAC1D,IAAI;wBACN,CAAC;6BAAM,CAAC;4BACN,oDAAoD;4BAEpD,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;gCACpC,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;oCACzB,OAAO,CAAC,IAAI,CACV,uBAAuB,EACvB,MAAM,CAAC,EAAE,EACT,IAAI,EACJ,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,IAAI,CACtC,CAAA;gCACH,CAAC;4BACH,CAAC;iCAAM,CAAC;gCACN,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;4BACzC,CAAC;wBACH,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACzB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,oBAAoB,CAAC,CAAA;QAC1D,CAAC;IACH,CAAC;IAED,6EAA6E;IAE7E,2EAA2E;IAC3E,oBAAoB;QAClB,OAAO,CAAC,GAAG,CAAC,4CAA4C,CAAC,CAAA;QACzD,KAAK,MAAM,CAAC,EAAE,QAAQ,CAAC,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YAC9C,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;gBACvB,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAA;YAChE,CAAC;YACD,KAAK,MAAM,OAAO,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;gBACxC,OAAO,CAAC,cAAc,EAAE,CAAA;gBAExB,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;oBACvB,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAA;gBACjC,CAAC;gBACD,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;oBAC1C,IAAI,MAAM,YAAY,MAAM,EAAE,CAAC;wBAC7B,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;4BACvB,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC,CAAA;wBAC7C,CAAC;wBACD,MAAM,CAAC,cAAc,EAAE,CAAA;oBACzB,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,6EAA6E;IAE7E;;OAEG;IACH,kBAAkB;QAChB,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAA;QAEvC,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAkB,CAAA;QACpD,MAAM,oBAAoB,GAAG,IAAI,GAAG,EAAqC,CAAA;QAEzE,KAAK,MAAM,oBAAoB,IAAI,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC;YACzE,eAAe;YACf,iEAAiE;YACjE,IAAI;YACJ,MAAM,EAAE,EAAE,EAAE,GAAG,oBAAoB,CAAA;YACnC,IAAI,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;gBAC/B,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC,CAAA;YAClC,CAAC;YAED,MAAM,QAAQ,GAA6B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;YACrE,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAC3B,OAAO,CAAC,KAAK,CACX,sBAAsB,EACtB,EAAE,EACF,sBAAsB,EACtB,IAAI,CAAC,WAAW,CAAC,IAAI,EACrB,oBAAoB,CACrB,CAAA;gBACD,SAAQ;YACV,CAAC;YAED,MAAM,SAAS,GAAG,QAAQ,CAAC,iBAAiB,CAAA;YAC5C,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC5B,uCAAuC;gBACvC,IAAI,YAAY,GAAG,oBAAoB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;gBACtD,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;oBAC/B,YAAY,GAAG,IAAI,GAAG,EAAE,CAAA;oBACxB,oBAAoB,CAAC,GAAG,CAAC,SAAS,EAAE,YAAY,CAAC,CAAA;gBACnD,CAAC;gBACD,kBAAkB,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,CAAC,CAAA;gBACrC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;oBACnC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAA;gBACzC,CAAC;YACH,CAAC;QACH,CAAC;QAED,KAAK,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,IAAI,oBAAoB,EAAE,CAAC;YAC7D,IAAI,YAAY,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;gBAC1B,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;oBACzB,OAAO,CAAC,IAAI,CACV,WAAW,EACX,SAAS,EACT,KAAK,EACL,YAAY,CAAC,IAAI,EACjB,cAAc,CACf,CAAA;gBACH,CAAC;gBACD,IAAI,KAAK,GAAG,CAAC,CAAA;gBACb,KAAK,MAAM,CAAC,EAAE,QAAQ,CAAC,IAAI,YAAY,EAAE,CAAC;oBACxC,MAAM,MAAM,GAAG,IAAI,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAA;oBACrC,KAAK,IAAI,CAAC,CAAA;oBACV,MAAM,CAAC,QAAQ,CAAC,iBAAiB,KAAK,SAAS,CAAC,CAAA;oBAChD,QAAQ,CAAC,iBAAiB,IAAI,MAAM,CAAA;oBACpC,MAAM,CAAC,QAAQ,CAAC,SAAS,KAAK,SAAS,CAAC,CAAA;oBACxC,QAAQ,CAAC,SAAS,IAAI,MAAM,CAAA;oBAE5B,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;wBACzB,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,iBAAiB,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAA;oBAC5D,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,6EAA6E;IAE7E,QAAQ;QACN,KAAK,MAAM,CAAC,EAAE,QAAQ,CAAC,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YAC9C,QAAQ,CAAC,QAAQ,CAAC,YAAY,GAAG,SAAS,CAAA;QAC5C,CAAC;IACH,CAAC;CACF;AAED,+EAA+E"}

package/dist/docusaurus/workspace.d.ts

@@ -0,0 +1,65 @@
+import { AbstractDataModelBase } from '../doxygen/data-model/types.js';
+import { type DataModel } from '../doxygen/data-model/data-model.js';
+import { Renderers } from './renderers/renderers.js';
+import type { CliOptions } from './cli-options.js';
+import type { FrontMatter } from './types.js';
+import { type File } from './view-model/files-and-folders-vm.js';
+import { DoxygenFileOptions } from './view-model/options.js';
+import { type Page } from './view-model/pages-vm.js';
+import { ViewModel } from './view-model/view-model.js';
+export declare class Workspace extends Renderers {
+    options: CliOptions;
+    dataModel: DataModel;
+    viewModel: ViewModel;
+    projectPath: string;
+    doxygenOptions: DoxygenFileOptions;
+    absoluteBaseUrl: string;
+    pageBaseUrl: string;
+    slugBaseUrl: string;
+    menuBaseUrl: string;
+    outputFolderPath: string;
+    sidebarBaseId: string;
+    mainPage: Page | undefined;
+    filesByPath: Map<string, File>;
+    /**
+     * @brief Map to keep track of indices that have content.
+     *
+     * @details
+     * The map keys are:
+     * - classes
+     * - namespaces
+     * - files
+     *
+     * and the Set may include:
+     * - all
+     * - classes
+     * - namespaces
+     * - functions
+     * - variables
+     * - typedefs
+     * - enums
+     * - enumvalues
+     */
+    indicesMaps: Map<string, Set<string>>;
+    writtenMdFilesCounter: number;
+    writtenHtmlFilesCounter: number;
+    collectionNamesByKind: Record<string, string>;
+    sidebarCollectionNames: string[];
+    constructor(dataModel: DataModel);
+    writeOutputMdFile({ filePath, bodyLines, frontMatter, frontMatterCodeLines, title, pagePermalink, }: {
+        filePath: string;
+        bodyLines: string[];
+        frontMatter: FrontMatter;
+        frontMatterCodeLines?: string[];
+        title?: string;
+        pagePermalink?: string;
+    }): Promise<void>;
+    skipElementsPara(elements: (AbstractDataModelBase | string)[] | undefined): void;
+    getPermalink({ refid, kindref, }: {
+        refid: string;
+        kindref: string;
+    }): string | undefined;
+    getPagePermalink(refid: string, noWarn?: boolean): string | undefined;
+    getXrefPermalink(id: string): string;
+}
+//# sourceMappingURL=workspace.d.ts.map

package/dist/docusaurus/workspace.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workspace.d.ts","sourceRoot":"","sources":["../../src/docusaurus/workspace.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAA;AACtE,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,qCAAqC,CAAA;AACpE,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AACpD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAE7C,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,sCAAsC,CAAA;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAC5D,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,0BAA0B,CAAA;AAMpD,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAA;AA2BtD,qBAAa,SAAU,SAAQ,SAAS;IAEtC,OAAO,EAAE,UAAU,CAAA;IAGnB,SAAS,EAAE,SAAS,CAAA;IAEpB,SAAS,EAAE,SAAS,CAAA;IAGpB,WAAW,EAAE,MAAM,CAAA;IAGnB,cAAc,EAAE,kBAAkB,CAAA;IAGlC,eAAe,EAAE,MAAM,CAAA;IAGvB,WAAW,EAAE,MAAM,CAAA;IAGnB,WAAW,EAAE,MAAM,CAAA;IAGnB,WAAW,EAAE,MAAM,CAAA;IAGnB,gBAAgB,EAAE,MAAM,CAAA;IAGxB,aAAa,EAAE,MAAM,CAAA;IAErB,QAAQ,EAAE,IAAI,GAAG,SAAS,CAAA;IAE1B,WAAW,oBAA0B;IAErC;;;;;;;;;;;;;;;;;;OAkBG;IACH,WAAW,2BAAiC;IAE5C,qBAAqB,SAAI;IACzB,uBAAuB,SAAI;IAE3B,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAmB5C;IAGD,sBAAsB,EAAE,MAAM,EAAE,CAM/B;gBAIW,SAAS,EAAE,SAAS;IAoD1B,iBAAiB,CAAC,EACtB,QAAQ,EACR,SAAS,EACT,WAAW,EACX,oBAAoB,EACpB,KAAK,EACL,aAAa,GACd,EAAE;QACD,QAAQ,EAAE,MAAM,CAAA;QAChB,SAAS,EAAE,MAAM,EAAE,CAAA;QACnB,WAAW,EAAE,WAAW,CAAA;QACxB,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAA;QAC/B,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,aAAa,CAAC,EAAE,MAAM,CAAA;KACvB,GAAG,OAAO,CAAC,IAAI,CAAC;IAgGjB,gBAAgB,CACd,QAAQ,EAAE,CAAC,qBAAqB,GAAG,MAAM,CAAC,EAAE,GAAG,SAAS,GACvD,IAAI;IAcP,YAAY,CAAC,EACX,KAAK,EACL,OAAO,GACR,EAAE;QACD,KAAK,EAAE,MAAM,CAAA;QACb,OAAO,EAAE,MAAM,CAAA;KAChB,GAAG,MAAM,GAAG,SAAS;IAkGtB,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,UAAQ,GAAG,MAAM,GAAG,SAAS;IAqBnE,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM;CAcrC"}