clang-tools 8.0.0

Headers.h
Go to the documentation of this file.
1 //===--- Headers.h - Include headers -----------------------------*- C++-*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9
10 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANGD_HEADERS_H
11 #define LLVM_CLANG_TOOLS_EXTRA_CLANGD_HEADERS_H
12
13 #include "Path.h"
14 #include "Protocol.h"
15 #include "SourceCode.h"
16 #include "clang/Format/Format.h"
17 #include "clang/Lex/HeaderSearch.h"
18 #include "clang/Lex/PPCallbacks.h"
19 #include "clang/Tooling/Inclusions/HeaderIncludes.h"
20 #include "llvm/ADT/StringRef.h"
21 #include "llvm/ADT/StringSet.h"
22 #include "llvm/Support/Error.h"
23 #include "llvm/Support/VirtualFileSystem.h"
24
25 namespace clang {
26 namespace clangd {
27
28 /// Returns true if \p Include is literal include like "path" or <path>.
29 bool isLiteralInclude(llvm::StringRef Include);
30
31 /// Represents a header file to be #include'd.
32 struct HeaderFile {
33 std::string File;
34 /// If this is true, `File` is a literal string quoted with <> or "" that
35 /// can be #included directly; otherwise, `File` is an absolute file path.
36 bool Verbatim;
37
38 bool valid() const;
39 };
40
41 // An #include directive that we found in the main file.
42 struct Inclusion {
43 Range R; // Inclusion range.
44 std::string Written; // Inclusion name as written e.g. <vector>.
45 Path Resolved; // Resolved path of included file. Empty if not resolved.
46 unsigned HashOffset = 0; // Byte offset from start of file to #.
47 SrcMgr::CharacteristicKind FileKind = SrcMgr::C_User;
48 };
49 llvm::raw_ostream &operator<<(llvm::raw_ostream &, const Inclusion &);
50
51 // Contains information about one file in the build grpah and its direct
52 // dependencies. Doesn't own the strings it references (IncludeGraph is
53 // self-contained).
54 struct IncludeGraphNode {
55 // True if current file is a main file rather than a header.
56 bool IsTU = false;
57 llvm::StringRef URI;
58 FileDigest Digest{{0}};
59 std::vector<llvm::StringRef> DirectIncludes;
60 };
61 // FileURI and FileInclusions are references to keys of the map containing
62 // them.
63 // Important: The graph generated by those callbacks might contain cycles, self
64 // edges and multi edges.
65 using IncludeGraph = llvm::StringMap<IncludeGraphNode>;
66
67 // Information captured about the inclusion graph in a translation unit.
68 // This includes detailed information about the direct #includes, and summary
69 // information about all transitive includes.
70 //
71 // It should be built incrementally with collectIncludeStructureCallback().
72 // When we build the preamble, we capture and store its include structure along
73 // with the preamble data. When we use the preamble, we can copy its
74 // IncludeStructure and use another collectIncludeStructureCallback() to fill
75 // in any non-preamble inclusions.
76 class IncludeStructure {
77 public:
78 std::vector<Inclusion> MainFileIncludes;
79
80 // Return all transitively reachable files, and their minimum include depth.
81 // All transitive includes (absolute paths), with their minimum include depth.
82 // Root --> 0, #included file --> 1, etc.
83 // Root is clang's name for a file, which may not be absolute.
84 // Usually it should be SM.getFileEntryForID(SM.getMainFileID())->getName().
85 llvm::StringMap<unsigned> includeDepth(llvm::StringRef Root) const;
86
87 // This updates IncludeDepth(), but not MainFileIncludes.
88 void recordInclude(llvm::StringRef IncludingName,
89 llvm::StringRef IncludedName,
90 llvm::StringRef IncludedRealName);
91
92 private:
93 // Identifying files in a way that persists from preamble build to subsequent
94 // builds is surprisingly hard. FileID is unavailable in InclusionDirective(),
95 // and RealPathName and UniqueID are not preseved in the preamble.
96 // We use the FileEntry::Name, which is stable, interned into a "file index".
97 // The paths we want to expose are the RealPathName, so store those too.
98 std::vector<std::string> RealPathNames; // In file index order.
99 unsigned fileIndex(llvm::StringRef Name);
100 llvm::StringMap<unsigned> NameToIndex; // Values are file indexes.
101 // Maps a file's index to that of the files it includes.
102 llvm::DenseMap<unsigned, SmallVector<unsigned, 8>> IncludeChildren;
103 };
104
105 /// Returns a PPCallback that visits all inclusions in the main file.
106 std::unique_ptr<PPCallbacks>
107 collectIncludeStructureCallback(const SourceManager &SM, IncludeStructure *Out);
108
109 // Calculates insertion edit for including a new header in a file.
110 class IncludeInserter {
111 public:
112 IncludeInserter(StringRef FileName, StringRef Code,
113 const format::FormatStyle &Style, StringRef BuildDir,
114 HeaderSearch &HeaderSearchInfo)
115 : FileName(FileName), Code(Code), BuildDir(BuildDir),
116 HeaderSearchInfo(HeaderSearchInfo),
117 Inserter(FileName, Code, Style.IncludeStyle) {}
118
119 void addExisting(const Inclusion &Inc);
120
121 /// Checks whether to add an #include of the header into \p File.
122 /// An #include will not be added if:
123 /// - Either \p DeclaringHeader or \p InsertedHeader is already (directly)
124 /// in \p Inclusions (including those included via different paths).
125 /// - \p DeclaringHeader or \p InsertedHeader is the same as \p File.
126 ///
127 /// \param DeclaringHeader is the original header corresponding to \p
128 /// InsertedHeader e.g. the header that declares a symbol.
129 /// \param InsertedHeader The preferred header to be inserted. This could be
130 /// the same as DeclaringHeader but must be provided.
131 bool shouldInsertInclude(const HeaderFile &DeclaringHeader,
132 const HeaderFile &InsertedHeader) const;
133
134 /// Determines the preferred way to #include a file, taking into account the
135 /// search path. Usually this will prefer a shorter representation like
136 /// 'Foo/Bar.h' over a longer one like 'Baz/include/Foo/Bar.h'.
137 ///
138 /// \param DeclaringHeader is the original header corresponding to \p
139 /// InsertedHeader e.g. the header that declares a symbol.
140 /// \param InsertedHeader The preferred header to be inserted. This could be
141 /// the same as DeclaringHeader but must be provided.
142 ///
143 /// \return A quoted "path" or <path> to be included.
144 std::string calculateIncludePath(const HeaderFile &DeclaringHeader,
145 const HeaderFile &InsertedHeader) const;
146
147 /// Calculates an edit that inserts \p VerbatimHeader into code. If the header
148 /// is already included, this returns None.
149 llvm::Optional<TextEdit> insert(llvm::StringRef VerbatimHeader) const;
150
151 private:
152 StringRef FileName;
153 StringRef Code;
154 StringRef BuildDir;
155 HeaderSearch &HeaderSearchInfo;
156 llvm::StringSet<> IncludedHeaders; // Both written and resolved.
157 tooling::HeaderIncludes Inserter; // Computers insertion replacement.
158 };
159
160 } // namespace clangd
161 } // namespace clang
162
163 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANGD_HEADERS_H
clang::clangd::IncludeGraphNode::URI
llvm::StringRef URI
Definition: Headers.h:57
clang::clangd::HeaderFile::valid
bool valid() const
Definition: Headers.cpp:72
clang::clangd::IncludeInserter::IncludeInserter
IncludeInserter(StringRef FileName, StringRef Code, const format::FormatStyle &Style, StringRef BuildDir, HeaderSearch &HeaderSearchInfo)
Definition: Headers.h:112
clang::clangd::HeaderFile::Verbatim
bool Verbatim
If this is true, File is a literal string quoted with <> or "" that can be #included directly; otherw...
Definition: Headers.h:36
clang::clangd::FileDigest
decltype(llvm::SHA1::hash({})) FileDigest
Definition: SourceCode.h:31
SourceCode.h
Protocol.h
clang::clangd::IncludeStructure
Definition: Headers.h:76
clang::clangd::Inclusion
Definition: Headers.h:42
clang::clangd::IncludeGraphNode::DirectIncludes
std::vector< llvm::StringRef > DirectIncludes
Definition: Headers.h:59
clang::clangd::IncludeGraph
llvm::StringMap< IncludeGraphNode > IncludeGraph
Definition: Headers.h:65
clang::clangd::Inclusion::Written
std::string Written
Definition: Headers.h:44
clang::clangd::Range
Definition: Protocol.h:154
clang::clangd::Path
std::string Path
A typedef to represent a file path.
Definition: Path.h:21
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
FileName
PathRef FileName
Definition: CodeComplete.cpp:1004
clang::clangd::IncludeInserter
Definition: Headers.h:110
clang::clangd::IncludeStructure::MainFileIncludes
std::vector< Inclusion > MainFileIncludes
Definition: Headers.h:78
clang::clangd::collectIncludeStructureCallback
std::unique_ptr< PPCallbacks > collectIncludeStructureCallback(const SourceManager &SM, IncludeStructure *Out)
Returns a PPCallback that visits all inclusions in the main file.
Definition: Headers.cpp:78
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ChangeNamespace.cpp:18
Path.h
clang::clangd::HeaderFile::File
std::string File
Definition: Headers.h:33
clang::clangd::IncludeGraphNode
Definition: Headers.h:54
clang::clangd::Inclusion::Resolved
Path Resolved
Definition: Headers.h:45
clang::clangd::Inclusion::R
Range R
Definition: Headers.h:43
clang::clangd::operator<<
llvm::raw_ostream & operator<<(llvm::raw_ostream &OS, const CodeCompletion &C)
Definition: CodeComplete.cpp:1719
clang::clangd::HeaderFile
Represents a header file to be #include&#39;d.
Definition: Headers.h:32
clang::clangd::isLiteralInclude
bool isLiteralInclude(llvm::StringRef Include)
Returns true if Include is literal include like "path" or <path>.
Definition: Headers.cpp:68
FormatStyle
static cl::opt< std::string > FormatStyle("format-style", cl::desc(R"( Style for formatting code around applied fixes: - 'none' (default) turns off formatting - 'file' (literally 'file', not a placeholder) uses .clang-format file in the closest parent directory - '{ <json> }' specifies options inline, e.g. -format-style='{BasedOnStyle: llvm, IndentWidth: 8}' - 'llvm', 'google', 'webkit', 'mozilla' See clang-format documentation for the up-to-date information about formatting styles and options. This option overrides the 'FormatStyle` option in .clang-tidy file, if any. )"), cl::init("none"), cl::cat(ClangTidyCategory))