summaryrefslogtreecommitdiffstats
path: root/src/qdoc/qdoc/src/qdoc/sourcefileparser.h
blob: 95bc71627bcf257d333a5b55f7319110622c2a83 (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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0

#pragma once

#include "clangcodeparser.h"
#include "puredocparser.h"

#include <variant>

#include <QString>
#include <QFileInfo>

struct CppSourceFile {};
struct QDocSourceFile {};
struct JsSourceFile {};
struct UnknownSourceFile {};

using SourceFileTag = std::variant<CppSourceFile, QDocSourceFile, JsSourceFile, UnknownSourceFile>;
using TaggedSourceFile = std::pair<QString, SourceFileTag>;

inline TaggedSourceFile tag_source_file(const QString& path) {
    static QStringList cpp_file_extensions{
        "c++", "cc", "cpp", "cxx", "mm"
    };
    static QStringList qdoc_file_extensions{ "qdoc" };
    static QStringList javascript_file_extensions{ "js" };

    QString extension{QFileInfo(path).suffix()};

    if (cpp_file_extensions.contains(extension)) return TaggedSourceFile{path, CppSourceFile{}};
    else if (qdoc_file_extensions.contains(extension)) return TaggedSourceFile{path, QDocSourceFile{}};
    else if (javascript_file_extensions.contains(extension)) return TaggedSourceFile{path, JsSourceFile{}};

    return TaggedSourceFile{path, UnknownSourceFile{}};
}

class SourceFileParser {
public:
    struct ParseResult {
        std::vector<UntiedDocumentation> untied;
        std::vector<TiedDocumentation> tied;
    };

public:
    SourceFileParser(ClangCodeParser& clang_parser, PureDocParser& pure_parser)
        : cpp_file_parser(clang_parser),
          pure_file_parser(pure_parser)
    {}

    ParseResult operator()(const TaggedSourceFile& source) {
        if (std::holds_alternative<CppSourceFile>(source.second))
            return (*this)(source.first, std::get<CppSourceFile>(source.second));
        else if (std::holds_alternative<QDocSourceFile>(source.second))
            return (*this)(source.first, std::get<QDocSourceFile>(source.second));
        else if (std::holds_alternative<JsSourceFile>(source.second))
            return (*this)(source.first, std::get<JsSourceFile>(source.second));
        else if (std::holds_alternative<UnknownSourceFile>(source.second))
            return {{}, {}};

        Q_UNREACHABLE();
    }

private:
    ParseResult operator()(const QString& path, CppSourceFile) {
         auto [untied, tied] = cpp_file_parser.parse_cpp_file(path);

         return {untied, tied};
    }

    ParseResult operator()(const QString& path, QDocSourceFile) {
        return {pure_file_parser.parse_qdoc_file(path), {}};
    }

    ParseResult operator()(const QString& path, JsSourceFile) {
        return {pure_file_parser.parse_qdoc_file(path), {}};
    }

private:
    ClangCodeParser& cpp_file_parser;
    PureDocParser& pure_file_parser;
};