aboutsummaryrefslogtreecommitdiffstats
path: root/src/qmlls/qdochtmlparser_p.h
blob: d09f2f882eb5373e240ba8fec81f6de091a7f0b9 (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
// 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 QDOCHTMLEXTRACTOR_P_H
#define QDOCHTMLEXTRACTOR_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 <QtQmlDom/private/qqmldomtop_p.h>
#include <QString>

QT_BEGIN_NAMESPACE

class HtmlExtractor
{
public:
    enum class ExtractionMode : char { Simplified, Extended };

    virtual QString extract(const QString &code, const QString &keyword, ExtractionMode mode) = 0;
    virtual ~HtmlExtractor() = default;
};

class ExtractDocumentation
{
public:
    ExtractDocumentation(QQmlJS::Dom::DomType domType);
    QString execute(const QString &code, const QString &keyword, HtmlExtractor::ExtractionMode mode);
private:
    std::unique_ptr<HtmlExtractor> m_extractor;
};

QT_END_NAMESPACE

#endif // QDOCHTMLEXTRACTOR_P_H