| 1 | // Copyright (C) 2024 The Qt Company Ltd. |
|---|---|
| 2 | // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only |
| 3 | |
| 4 | #ifndef QDOCHTMLEXTRACTOR_P_H |
| 5 | #define QDOCHTMLEXTRACTOR_P_H |
| 6 | |
| 7 | // |
| 8 | // W A R N I N G |
| 9 | // ------------- |
| 10 | // |
| 11 | // This file is not part of the Qt API. It exists purely as an |
| 12 | // implementation detail. This header file may change from version to |
| 13 | // version without notice, or even be removed. |
| 14 | // |
| 15 | // We mean it. |
| 16 | // |
| 17 | |
| 18 | #include <QtQmlDom/private/qqmldomtop_p.h> |
| 19 | #include <QString> |
| 20 | |
| 21 | QT_BEGIN_NAMESPACE |
| 22 | |
| 23 | class HtmlExtractor |
| 24 | { |
| 25 | public: |
| 26 | enum class ExtractionMode : char { Simplified, Extended }; |
| 27 | |
| 28 | virtual QString extract(const QString &code, const QString &keyword, ExtractionMode mode) = 0; |
| 29 | virtual ~HtmlExtractor() = default; |
| 30 | }; |
| 31 | |
| 32 | class ExtractDocumentation |
| 33 | { |
| 34 | public: |
| 35 | ExtractDocumentation(QQmlJS::Dom::DomType domType); |
| 36 | QString execute(const QString &code, const QString &keyword, HtmlExtractor::ExtractionMode mode); |
| 37 | private: |
| 38 | std::unique_ptr<HtmlExtractor> m_extractor; |
| 39 | }; |
| 40 | |
| 41 | QT_END_NAMESPACE |
| 42 | |
| 43 | #endif // QDOCHTMLEXTRACTOR_P_H |
| 44 |