nodeextractor.h

Go to the documentation of this file.

// Copyright (C) 2026 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
 
#ifndef QDOC_NODEEXTRACTOR_H
#define QDOC_NODEEXTRACTOR_H
 
#include "ir/pagemetadata.h"
#include "ir/signaturespan.h"
#include "sections.h"
 
#include <optional>
 
QT_BEGIN_NAMESPACE
 
class Aggregate;
class CollectionNode;
class HrefResolver;
class Node;
class PageNode;
class QmlTypeNode;
 
enum class MemberExtractionLevel { Summary, Detail };
 
namespace NodeExtractor {
 
IR::PageMetadata extractPageMetadata(const PageNode *pn, const HrefResolver *hrefResolver);
IR::QmlTypeData extractQmlTypeData(const QmlTypeNode *qcn, const HrefResolver *hrefResolver);
IR::CollectionData extractCollectionData(const CollectionNode *cn, const HrefResolver *hrefResolver);
IR::CppReferenceData extractCppReferenceData(const Aggregate *aggregate, const HrefResolver *hrefResolver);
QList<IR::SectionIR> extractSummarySections(const Aggregate *aggregate, const HrefResolver *hrefResolver);
QList<IR::SectionIR> extractDetailSections(const Aggregate *aggregate, const HrefResolver *hrefResolver);
IR::MemberIR extractMemberIR(const Node *node, const HrefResolver *hrefResolver, const Node *relative, MemberExtractionLevel level = MemberExtractionLevel::Summary);
std::optional<IR::AllMembersIR> extractAllMembersIR(const PageNode *pn, const HrefResolver *hrefResolver);
QList<IR::SignatureSpan> buildSignatureSpans(const Node *node, const HrefResolver *hrefResolver, const Node *relative, Section::Style style);
IR::NavigationData extractNavigationData(const PageNode *pn, const HrefResolver *hrefResolver);
 
} // namespace NodeExtractor
 
QT_END_NAMESPACE
 
#endif // QDOC_NODEEXTRACTOR_H