2018-02-16 22:15:55 +08:00
|
|
|
//===--- Headers.h - Include headers -----------------------------*- C++-*-===//
|
|
|
|
//
|
2019-01-19 16:50:56 +08:00
|
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
2018-02-16 22:15:55 +08:00
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANGD_HEADERS_H
|
|
|
|
#define LLVM_CLANG_TOOLS_EXTRA_CLANGD_HEADERS_H
|
|
|
|
|
|
|
|
#include "Path.h"
|
2018-05-14 20:19:16 +08:00
|
|
|
#include "Protocol.h"
|
2018-05-15 23:29:32 +08:00
|
|
|
#include "SourceCode.h"
|
2019-02-28 21:23:03 +08:00
|
|
|
#include "index/Symbol.h"
|
2018-05-15 23:29:32 +08:00
|
|
|
#include "clang/Format/Format.h"
|
|
|
|
#include "clang/Lex/HeaderSearch.h"
|
2018-05-14 20:19:16 +08:00
|
|
|
#include "clang/Lex/PPCallbacks.h"
|
2018-06-04 17:04:28 +08:00
|
|
|
#include "clang/Tooling/Inclusions/HeaderIncludes.h"
|
2019-01-28 22:01:55 +08:00
|
|
|
#include "llvm/ADT/ArrayRef.h"
|
2018-02-16 22:15:55 +08:00
|
|
|
#include "llvm/ADT/StringRef.h"
|
2018-05-15 23:29:32 +08:00
|
|
|
#include "llvm/ADT/StringSet.h"
|
2018-02-16 22:15:55 +08:00
|
|
|
#include "llvm/Support/Error.h"
|
2018-10-10 21:27:25 +08:00
|
|
|
#include "llvm/Support/VirtualFileSystem.h"
|
2018-02-16 22:15:55 +08:00
|
|
|
|
|
|
|
namespace clang {
|
|
|
|
namespace clangd {
|
2018-02-20 02:48:44 +08:00
|
|
|
|
2018-02-26 16:32:13 +08:00
|
|
|
/// Returns true if \p Include is literal include like "path" or <path>.
|
|
|
|
bool isLiteralInclude(llvm::StringRef Include);
|
|
|
|
|
|
|
|
/// Represents a header file to be #include'd.
|
|
|
|
struct HeaderFile {
|
|
|
|
std::string File;
|
|
|
|
/// If this is true, `File` is a literal string quoted with <> or "" that
|
|
|
|
/// can be #included directly; otherwise, `File` is an absolute file path.
|
|
|
|
bool Verbatim;
|
|
|
|
|
|
|
|
bool valid() const;
|
|
|
|
};
|
|
|
|
|
2019-01-28 22:01:55 +08:00
|
|
|
/// Creates a `HeaderFile` from \p Header which can be either a URI or a literal
|
|
|
|
/// include.
|
|
|
|
llvm::Expected<HeaderFile> toHeaderFile(llvm::StringRef Header,
|
|
|
|
llvm::StringRef HintPath);
|
|
|
|
|
|
|
|
// Returns include headers for \p Sym sorted by popularity. If two headers are
|
|
|
|
// equally popular, prefer the shorter one.
|
|
|
|
llvm::SmallVector<llvm::StringRef, 1> getRankedIncludes(const Symbol &Sym);
|
|
|
|
|
2018-05-14 20:19:16 +08:00
|
|
|
// An #include directive that we found in the main file.
|
|
|
|
struct Inclusion {
|
|
|
|
Range R; // Inclusion range.
|
|
|
|
std::string Written; // Inclusion name as written e.g. <vector>.
|
|
|
|
Path Resolved; // Resolved path of included file. Empty if not resolved.
|
2018-11-20 18:58:48 +08:00
|
|
|
unsigned HashOffset = 0; // Byte offset from start of file to #.
|
|
|
|
SrcMgr::CharacteristicKind FileKind = SrcMgr::C_User;
|
2018-05-14 20:19:16 +08:00
|
|
|
};
|
2018-12-01 00:59:00 +08:00
|
|
|
llvm::raw_ostream &operator<<(llvm::raw_ostream &, const Inclusion &);
|
2018-05-14 20:19:16 +08:00
|
|
|
|
2018-11-28 00:08:53 +08:00
|
|
|
// Contains information about one file in the build grpah and its direct
|
|
|
|
// dependencies. Doesn't own the strings it references (IncludeGraph is
|
|
|
|
// self-contained).
|
|
|
|
struct IncludeGraphNode {
|
|
|
|
// True if current file is a main file rather than a header.
|
2018-12-04 19:31:57 +08:00
|
|
|
bool IsTU = false;
|
2018-11-28 00:08:53 +08:00
|
|
|
llvm::StringRef URI;
|
2018-12-04 22:07:29 +08:00
|
|
|
FileDigest Digest{{0}};
|
2018-11-28 00:08:53 +08:00
|
|
|
std::vector<llvm::StringRef> DirectIncludes;
|
|
|
|
};
|
|
|
|
// FileURI and FileInclusions are references to keys of the map containing
|
|
|
|
// them.
|
2018-12-01 00:59:00 +08:00
|
|
|
// Important: The graph generated by those callbacks might contain cycles, self
|
|
|
|
// edges and multi edges.
|
2018-11-28 00:08:53 +08:00
|
|
|
using IncludeGraph = llvm::StringMap<IncludeGraphNode>;
|
|
|
|
|
2018-07-03 16:09:29 +08:00
|
|
|
// Information captured about the inclusion graph in a translation unit.
|
|
|
|
// This includes detailed information about the direct #includes, and summary
|
|
|
|
// information about all transitive includes.
|
|
|
|
//
|
|
|
|
// It should be built incrementally with collectIncludeStructureCallback().
|
|
|
|
// When we build the preamble, we capture and store its include structure along
|
|
|
|
// with the preamble data. When we use the preamble, we can copy its
|
|
|
|
// IncludeStructure and use another collectIncludeStructureCallback() to fill
|
|
|
|
// in any non-preamble inclusions.
|
|
|
|
class IncludeStructure {
|
|
|
|
public:
|
|
|
|
std::vector<Inclusion> MainFileIncludes;
|
|
|
|
|
|
|
|
// Return all transitively reachable files, and their minimum include depth.
|
|
|
|
// All transitive includes (absolute paths), with their minimum include depth.
|
|
|
|
// Root --> 0, #included file --> 1, etc.
|
|
|
|
// Root is clang's name for a file, which may not be absolute.
|
|
|
|
// Usually it should be SM.getFileEntryForID(SM.getMainFileID())->getName().
|
|
|
|
llvm::StringMap<unsigned> includeDepth(llvm::StringRef Root) const;
|
|
|
|
|
|
|
|
// This updates IncludeDepth(), but not MainFileIncludes.
|
|
|
|
void recordInclude(llvm::StringRef IncludingName,
|
|
|
|
llvm::StringRef IncludedName,
|
|
|
|
llvm::StringRef IncludedRealName);
|
|
|
|
|
|
|
|
private:
|
|
|
|
// Identifying files in a way that persists from preamble build to subsequent
|
|
|
|
// builds is surprisingly hard. FileID is unavailable in InclusionDirective(),
|
|
|
|
// and RealPathName and UniqueID are not preseved in the preamble.
|
|
|
|
// We use the FileEntry::Name, which is stable, interned into a "file index".
|
|
|
|
// The paths we want to expose are the RealPathName, so store those too.
|
|
|
|
std::vector<std::string> RealPathNames; // In file index order.
|
|
|
|
unsigned fileIndex(llvm::StringRef Name);
|
|
|
|
llvm::StringMap<unsigned> NameToIndex; // Values are file indexes.
|
|
|
|
// Maps a file's index to that of the files it includes.
|
|
|
|
llvm::DenseMap<unsigned, SmallVector<unsigned, 8>> IncludeChildren;
|
|
|
|
};
|
|
|
|
|
2018-05-14 20:19:16 +08:00
|
|
|
/// Returns a PPCallback that visits all inclusions in the main file.
|
|
|
|
std::unique_ptr<PPCallbacks>
|
2018-07-03 16:09:29 +08:00
|
|
|
collectIncludeStructureCallback(const SourceManager &SM, IncludeStructure *Out);
|
2018-05-14 20:19:16 +08:00
|
|
|
|
2018-05-15 23:29:32 +08:00
|
|
|
// Calculates insertion edit for including a new header in a file.
|
|
|
|
class IncludeInserter {
|
|
|
|
public:
|
2019-04-11 17:36:36 +08:00
|
|
|
// If \p HeaderSearchInfo is nullptr (e.g. when compile command is
|
|
|
|
// infeasible), this will only try to insert verbatim headers, and
|
|
|
|
// include path of non-verbatim header will not be shortened.
|
2018-05-15 23:29:32 +08:00
|
|
|
IncludeInserter(StringRef FileName, StringRef Code,
|
|
|
|
const format::FormatStyle &Style, StringRef BuildDir,
|
2019-04-11 17:36:36 +08:00
|
|
|
HeaderSearch *HeaderSearchInfo)
|
2018-05-15 23:29:32 +08:00
|
|
|
: FileName(FileName), Code(Code), BuildDir(BuildDir),
|
|
|
|
HeaderSearchInfo(HeaderSearchInfo),
|
|
|
|
Inserter(FileName, Code, Style.IncludeStyle) {}
|
|
|
|
|
2018-09-27 22:27:02 +08:00
|
|
|
void addExisting(const Inclusion &Inc);
|
2018-05-15 23:29:32 +08:00
|
|
|
|
2018-06-15 21:34:18 +08:00
|
|
|
/// Checks whether to add an #include of the header into \p File.
|
|
|
|
/// An #include will not be added if:
|
|
|
|
/// - Either \p DeclaringHeader or \p InsertedHeader is already (directly)
|
|
|
|
/// in \p Inclusions (including those included via different paths).
|
|
|
|
/// - \p DeclaringHeader or \p InsertedHeader is the same as \p File.
|
|
|
|
///
|
2019-04-16 22:35:49 +08:00
|
|
|
/// \param DeclaringHeader is path of the original header corresponding to \p
|
2018-06-15 21:34:18 +08:00
|
|
|
/// InsertedHeader e.g. the header that declares a symbol.
|
|
|
|
/// \param InsertedHeader The preferred header to be inserted. This could be
|
2018-06-27 01:00:43 +08:00
|
|
|
/// the same as DeclaringHeader but must be provided.
|
2019-04-16 22:35:49 +08:00
|
|
|
bool shouldInsertInclude(PathRef DeclaringHeader,
|
2018-06-15 21:34:18 +08:00
|
|
|
const HeaderFile &InsertedHeader) const;
|
|
|
|
|
|
|
|
/// Determines the preferred way to #include a file, taking into account the
|
|
|
|
/// search path. Usually this will prefer a shorter representation like
|
|
|
|
/// 'Foo/Bar.h' over a longer one like 'Baz/include/Foo/Bar.h'.
|
2018-05-15 23:29:32 +08:00
|
|
|
///
|
|
|
|
/// \param InsertedHeader The preferred header to be inserted. This could be
|
|
|
|
/// the same as DeclaringHeader but must be provided.
|
2018-06-15 21:34:18 +08:00
|
|
|
///
|
|
|
|
/// \return A quoted "path" or <path> to be included.
|
2019-04-16 22:35:49 +08:00
|
|
|
std::string calculateIncludePath(const HeaderFile &InsertedHeader) const;
|
2018-06-15 21:34:18 +08:00
|
|
|
|
|
|
|
/// Calculates an edit that inserts \p VerbatimHeader into code. If the header
|
|
|
|
/// is already included, this returns None.
|
|
|
|
llvm::Optional<TextEdit> insert(llvm::StringRef VerbatimHeader) const;
|
2018-05-15 23:29:32 +08:00
|
|
|
|
|
|
|
private:
|
|
|
|
StringRef FileName;
|
|
|
|
StringRef Code;
|
|
|
|
StringRef BuildDir;
|
2019-04-11 17:36:36 +08:00
|
|
|
HeaderSearch *HeaderSearchInfo = nullptr;
|
2018-09-27 22:27:02 +08:00
|
|
|
llvm::StringSet<> IncludedHeaders; // Both written and resolved.
|
|
|
|
tooling::HeaderIncludes Inserter; // Computers insertion replacement.
|
2018-05-15 23:29:32 +08:00
|
|
|
};
|
2018-02-16 22:15:55 +08:00
|
|
|
|
|
|
|
} // namespace clangd
|
|
|
|
} // namespace clang
|
|
|
|
|
|
|
|
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANGD_HEADERS_H
|