diff options
Diffstat (limited to 'src/qdoc/tree.h')
| -rw-r--r-- | src/qdoc/tree.h | 221 |
1 files changed, 0 insertions, 221 deletions
diff --git a/src/qdoc/tree.h b/src/qdoc/tree.h deleted file mode 100644 index 850055eaf..000000000 --- a/src/qdoc/tree.h +++ /dev/null @@ -1,221 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2021 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the tools applications of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:GPL-EXCEPT$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#ifndef TREE_H -#define TREE_H - -#include "examplenode.h" -#include "namespacenode.h" -#include "node.h" -#include "propertynode.h" -#include "proxynode.h" -#include "qmltypenode.h" - -#include <QtCore/qstack.h> - -#include <utility> - -QT_BEGIN_NAMESPACE - -class CollectionNode; -class FunctionNode; -class QDocDatabase; - -struct TargetRec -{ -public: - enum TargetType { Unknown, Target, Keyword, Contents, Class, Function, Page, Subtitle }; - - TargetRec(QString name, TargetRec::TargetType type, Node *node, int priority) - : m_node(node), m_ref(std::move(name)), m_priority(priority) - { - // Discard the dedicated ref for keywords - they always - // link to the top of the QDoc comment they appear in - if (type == Keyword) - m_ref.clear(); - } - - [[nodiscard]] bool isEmpty() const { return m_ref.isEmpty(); } - [[nodiscard]] Node::Genus genus() const { return (m_node ? m_node->genus() : Node::DontCare); } - - Node *m_node { nullptr }; - QString m_ref {}; - int m_priority {}; -}; - -struct TargetLoc -{ -public: - TargetLoc() = default; -}; - -typedef QMultiMap<QString, TargetRec *> TargetMap; -typedef QMultiMap<QString, PageNode *> PageNodeMultiMap; -typedef QMap<QString, QmlTypeNode *> QmlTypeMap; -typedef QMultiMap<QString, const ExampleNode *> ExampleNodeMap; -typedef QList<TargetLoc *> TargetList; - -class Tree -{ - friend class QDocForest; - friend class QDocDatabase; - -private: // Note the constructor and destructor are private. - typedef QMap<PropertyNode::FunctionRole, QString> RoleMap; - typedef QMap<PropertyNode *, RoleMap> PropertyMap; - - Tree(const QString &camelCaseModuleName, QDocDatabase *qdb); - ~Tree(); - -public: // Of necessity, a few public functions remain. - [[nodiscard]] const QString &camelCaseModuleName() const { return m_camelCaseModuleName; } - [[nodiscard]] const QString &physicalModuleName() const { return m_physicalModuleName; } - [[nodiscard]] const QString &indexFileName() const { return m_indexFileName; } - [[nodiscard]] const QString &indexTitle() const { return m_indexTitle; } - void setIndexTitle(const QString &t) { m_indexTitle = t; } - NodeList &proxies() { return m_proxies; } - void appendProxy(ProxyNode *t) { m_proxies.append(t); } - void addToDontDocumentMap(QString &arg); - void markDontDocumentNodes(); - -private: // The rest of the class is private. - Aggregate *findAggregate(const QString &name); - [[nodiscard]] Node *findNodeForInclude(const QStringList &path) const; - ClassNode *findClassNode(const QStringList &path, const Node *start = nullptr) const; - [[nodiscard]] NamespaceNode *findNamespaceNode(const QStringList &path) const; - const FunctionNode *findFunctionNode(const QStringList &path, const Parameters ¶meters, - const Node *relative, Node::Genus genus) const; - Node *findNodeRecursive(const QStringList &path, int pathIndex, const Node *start, - bool (Node::*)() const) const; - const Node *findNodeForTarget(const QStringList &path, const QString &target, const Node *node, - int flags, Node::Genus genus, QString &ref) const; - const Node *matchPathAndTarget(const QStringList &path, int idx, const QString &target, - const Node *node, int flags, Node::Genus genus, - QString &ref) const; - - const Node *findNode(const QStringList &path, const Node *relative, int flags, - Node::Genus genus) const; - - [[nodiscard]] Node *findNodeByNameAndType(const QStringList &path, - bool (Node::*isMatch)() const) const; - Aggregate *findRelatesNode(const QStringList &path); - const Node *findEnumNode(const Node *node, const Node *aggregate, const QStringList &path, int offset) const; - QString getRef(const QString &target, const Node *node) const; - void insertTarget(const QString &name, const QString &title, TargetRec::TargetType type, - Node *node, int priority); - void resolveTargets(Aggregate *root); - const Node *findUnambiguousTarget(const QString &target, Node::Genus genus, QString &ref) const; - [[nodiscard]] const PageNode *findPageNodeByTitle(const QString &title) const; - - void addPropertyFunction(PropertyNode *property, const QString &funcName, - PropertyNode::FunctionRole funcRole); - void resolveBaseClasses(Aggregate *n); - void resolvePropertyOverriddenFromPtrs(Aggregate *n); - void resolveProperties(); - void resolveCppToQmlLinks(); - void resolveUsingClauses(Aggregate *parent = nullptr); - void removePrivateAndInternalBases(NamespaceNode *rootNode); - NamespaceNode *root() { return &m_root; } - [[nodiscard]] const NamespaceNode *root() const { return &m_root; } - - ClassList allBaseClasses(const ClassNode *classe) const; - QString refForAtom(const Atom *atom); - - CNMap *getCollectionMap(Node::NodeType type); - [[nodiscard]] const CNMap &groups() const { return m_groups; } - [[nodiscard]] const CNMap &modules() const { return m_modules; } - [[nodiscard]] const CNMap &qmlModules() const { return m_qmlModules; } - [[nodiscard]] const CNMap &jsModules() const { return m_jsModules; } - - CollectionNode *getCollection(const QString &name, Node::NodeType type); - CollectionNode *findCollection(const QString &name, Node::NodeType type); - - CollectionNode *findGroup(const QString &name) { return findCollection(name, Node::Group); } - CollectionNode *findModule(const QString &name) { return findCollection(name, Node::Module); } - CollectionNode *findQmlModule(const QString &name) - { - return findCollection(name, Node::QmlModule); - } - CollectionNode *findJsModule(const QString &name) - { - return findCollection(name, Node::JsModule); - } - - CollectionNode *addGroup(const QString &name) { return findGroup(name); } - CollectionNode *addModule(const QString &name) { return findModule(name); } - CollectionNode *addQmlModule(const QString &name) { return findQmlModule(name); } - CollectionNode *addJsModule(const QString &name) { return findJsModule(name); } - - CollectionNode *addToGroup(const QString &name, Node *node); - CollectionNode *addToModule(const QString &name, Node *node); - CollectionNode *addToQmlModule(const QString &name, Node *node); - CollectionNode *addToJsModule(const QString &name, Node *node); - - [[nodiscard]] QmlTypeNode *lookupQmlType(const QString &name) const - { - return m_qmlTypeMap.value(name); - } - [[nodiscard]] Aggregate *lookupQmlBasicType(const QString &name) const - { - return m_qmlTypeMap.value(name); - } - void insertQmlType(const QString &key, QmlTypeNode *n); - void addExampleNode(ExampleNode *n) { m_exampleNodeMap.insert(n->title(), n); } - ExampleNodeMap &exampleNodeMap() { return m_exampleNodeMap; } - void setIndexFileName(const QString &t) { m_indexFileName = t; } - - [[nodiscard]] bool treeHasBeenAnalyzed() const { return m_treeHasBeenAnalyzed; } - void setTreeHasBeenAnalyzed() { m_treeHasBeenAnalyzed = true; } - FunctionNode *findFunctionNodeForTag(const QString &tag, Aggregate *parent = nullptr); - FunctionNode *findMacroNode(const QString &t, const Aggregate *parent = nullptr); - -private: - bool m_treeHasBeenAnalyzed {}; - QString m_camelCaseModuleName {}; - QString m_physicalModuleName {}; - QString m_indexFileName {}; - QString m_indexTitle {}; - QDocDatabase *m_qdb { nullptr }; - NamespaceNode m_root; - PropertyMap m_unresolvedPropertyMap {}; - PageNodeMultiMap m_pageNodesByTitle {}; - TargetMap m_nodesByTargetRef {}; - TargetMap m_nodesByTargetTitle {}; - CNMap m_groups {}; - CNMap m_modules {}; - CNMap m_qmlModules {}; - CNMap m_jsModules {}; - QmlTypeMap m_qmlTypeMap {}; - ExampleNodeMap m_exampleNodeMap {}; - NodeList m_proxies {}; - NodeMap m_dontDocumentMap {}; -}; - -QT_END_NAMESPACE - -#endif |