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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
/*
* Copyright 2014 Olivier de Gaalon <olivier.jg@gmail.com>
* Copyright 2014 Milian Wolff <mail@milianw.de>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of
* the License or (at your option) version 3 or any later version
* accepted by the membership of KDE e.V. (or its successor approved
* by the membership of KDE e.V.), which shall act as a proxy
* defined in Section 14 of version 3 of the license.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef CLANGHELPERS_H
#define CLANGHELPERS_H
#include "clangprivateexport.h"
#include <language/duchain/duchainpointer.h>
#include <language/duchain/topducontext.h>
#include <clang-c/Index.h>
#include <functional>
class ParseSession;
class ClangIndex;
struct Import
{
CXFile file;
KDevelop::CursorInRevision location;
};
Q_DECLARE_TYPEINFO(Import, Q_MOVABLE_TYPE);
using Imports = QMultiHash<CXFile, Import>;
using IncludeFileContexts = QHash<CXFile, KDevelop::ReferencedTopDUContext>;
namespace ClangHelpers {
KDevelop::DeclarationPointer findDeclaration(CXSourceLocation cursor, const KDevelop::QualifiedIdentifier& id, const KDevelop::ReferencedTopDUContext& top);
KDevelop::DeclarationPointer findDeclaration(CXCursor cursor, const IncludeFileContexts& includes);
KDevelop::DeclarationPointer findDeclaration(CXType type, const IncludeFileContexts& includes);
/**
* Try to look up the first reachable forward declaration for type @a type
*
* @param context The context where this search is happening
* @param cursor The location from which we're searching
*/
KDevelop::DeclarationPointer findForwardDeclaration(CXType type, KDevelop::DUContext* context, CXCursor cursor);
/**
* Wrapper for @ref clang_Cursor_getSpellingNameRange which sometimes reports invalid ranges
*/
KDevelop::RangeInRevision cursorSpellingNameRange(CXCursor cursor, const KDevelop::Identifier& id);
/**
* @returns all the Imports for each file in the @a tu
*/
KDEVCLANGPRIVATE_EXPORT Imports tuImports(CXTranslationUnit tu);
/**
* Recursively builds a duchain with the specified @a features for the
* @a file and each of its @a imports using the TU from @a session.
* The resulting contexts are placed in @a includedFiles.
* @returns the context created for @a file
*/
KDEVCLANGPRIVATE_EXPORT KDevelop::ReferencedTopDUContext buildDUChain(
CXFile file, const Imports& imports, const ParseSession& session,
KDevelop::TopDUContext::Features features, IncludeFileContexts& includedFiles,
ClangIndex* index = nullptr, const std::function<bool()>& abortFunction = {});
/**
* @return List of possible header extensions used for definition/declaration fallback switching
*/
QStringList headerExtensions();
/**
* @return List of possible source extensions used for definition/declaration fallback switching
*/
QStringList sourceExtensions();
/**
* @return True if the given file @a path has the extension of a C++ source file
*/
KDEVCLANGPRIVATE_EXPORT bool isSource(const QString& path);
/**
* @return True if the given file @a path has the extension of a C++ header file
*/
KDEVCLANGPRIVATE_EXPORT bool isHeader(const QString& path);
KDEVCLANGPRIVATE_EXPORT QString clangVersion();
/**
* @return The path containing Clang built includes (e.g. stddef.h, stdarg.h, cpuid.h)
*
* Also see: https://clang.llvm.org/docs/FAQ.html
*/
KDEVCLANGPRIVATE_EXPORT QString clangBuiltinIncludePath();
}
#endif //CLANGHELPERS_H
|
