aboutsummaryrefslogtreecommitdiffstats
path: root/src/qmlls/qdochtmlparser_p.h
blob: f66fb0e56b92d4c8a4e7bd973557461cdb06f191 (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
// 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 <QString>

QT_BEGIN_NAMESPACE

class QDocHtmlExtractor
{
public:
    enum class ExtractionMode : char { Simplified, Extended };
    enum class ElementType : char {
        QmlType,
        QmlProperty,
        QmlMethod,
        QmlSignal
    };

    struct Element {
        QString name;
        ElementType type;
    };

    QDocHtmlExtractor(const QString &code);
    QString extract(const Element &element, ExtractionMode extractionMode);

private:
    QString parseForQmlType(const QString &element, ExtractionMode mode);
    QString parseForQmlProperty(const QString &element, ExtractionMode mode = ExtractionMode::Simplified);
    QString parseForQmlMethodOrSignal(const QString &functionName, ExtractionMode mode);

    const QString &m_code;
};

QT_END_NAMESPACE

#endif // QDOCHTMLEXTRACTOR_P_H