blob: 8d8814522dd2763928e582e7ca9265b000a948af (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#ifndef QQMLLSHELPUTILS_P_H
#define QQMLLSHELPUTILS_P_H
//
// W A R N I N G
// -------------
//
// This file is not part of the Qt API. It exists purely as an
// implementation detail. This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//
#include <QtQmlLS/private/qqmllshelpplugininterface_p.h>
#include <QtQmlLS/private/qqmllsutils_p.h>
#include <QtQmlDom/private/qqmldomtop_p.h>
#include <QtQmlLS/private/qdochtmlparser_p.h>
#include <QtLanguageServer/private/qlanguageserverspectypes_p.h>
#include <vector>
QT_BEGIN_NAMESPACE
class HelpManager final
{
public:
HelpManager();
void setDocumentationRootPath(const QString &path);
[[nodiscard]] QString documentationRootPath() const;
[[nodiscard]] std::optional<QByteArray> documentationForItem(
const QQmlJS::Dom::DomItem &file, QLspSpecification::Position position);
private:
[[nodiscard]] std::optional<QByteArray> extractDocumentationForIdentifiers(const QQmlJS::Dom::DomItem &item,
QQmlLSUtils::ExpressionType expr) const;
[[nodiscard]] std::optional<QByteArray> extractDocumentationForDomElements(
const QQmlJS::Dom::DomItem &item) const;
[[nodiscard]] std::optional<QByteArray> extractDocumentation(
const QQmlJS::Dom::DomItem &item) const;
[[nodiscard]] std::optional<QByteArray> tryExtract(ExtractDocumentation &extractor,
const std::vector<QQmlLSHelpProviderBase::DocumentLink> &links,
const QString &name) const;
[[nodiscard]] std::vector<QQmlLSHelpProviderBase::DocumentLink>
collectDocumentationLinks(const QQmlJS::Dom::DomItem &item, const QQmlJSScope::ConstPtr &scope,
const QString &name) const;
void registerDocumentations(const QStringList &docs) const;
std::unique_ptr<QQmlLSHelpProviderBase> m_helpPlugin;
QString m_docRootPath;
QHash<QString, QString> m_cppTypesToQmlTypes;
};
QT_END_NAMESPACE
#endif // QQMLLSHELPUTILS_P_H
|
