linkresolver.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_LINKRESOLVER_H
#define QDOC_LINKRESOLVER_H
 
#ifdef QDOC_TEMPLATE_GENERATOR_ENABLED
 
#include <QtCore/qlist.h>
 
QT_BEGIN_NAMESPACE
 
class HrefResolver;
class Node;
class QDocDatabase;
 
namespace IR {
struct ContentBlock;
struct InlineContent;
} // namespace IR
 
struct LinkResolverConfig
{
    bool autolinkErrors{false};
    bool noLinkErrors{false};
};
 
/*!
    \class LinkResolver
    \internal
    \brief Walks ContentBlock trees and resolves unresolved Link inlines to URLs.
 
    LinkResolver sits between ContentBuilder and rendering. ContentBuilder
    produces Link inlines with raw target strings (such as "QWidget" or
    "QString::size"). LinkResolver resolves these targets to actual URLs
    using QDocDatabase for node lookup and HrefResolver for URL computation.
 
    External URLs (http, https, ftp, file, mailto) are detected and marked
    without node lookup. Links to deprecated nodes from non-deprecated
    content are suppressed. Suppressed links carry a diagnostic linkState
    string identifying the reason (policy exclusion, self-reference, etc.).
    Unresolvable links emit warnings controlled by the injected
    LinkResolverConfig.
 
    \sa HrefResolver, IR::ContentBuilder
*/
class LinkResolver
{
public:
    LinkResolver(QDocDatabase *qdb, const HrefResolver &hrefResolver,
                 const LinkResolverConfig &config);
 
    void resolve(QList<IR::ContentBlock> &blocks, const Node *relative);
 
private:
    void resolveBlock(IR::ContentBlock &block, const Node *relative);
    void resolveInlines(QList<IR::InlineContent> &inlines, const Node *relative);
    void resolveLink(IR::InlineContent &link, const Node *relative);
 
    QDocDatabase *m_qdb;
    const HrefResolver &m_hrefResolver;
    LinkResolverConfig m_config;
};
 
QT_END_NAMESPACE
 
#endif // QDOC_TEMPLATE_GENERATOR_ENABLED
 
#endif // QDOC_LINKRESOLVER_H