1 //===--- Utils.h - Misc utilities for the front-end -------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This header contains miscellaneous utilities for various front-end actions.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CLANG_FRONTEND_UTILS_H
15 #define LLVM_CLANG_FRONTEND_UTILS_H
17 #include "clang/Basic/Diagnostic.h"
18 #include "clang/Basic/VirtualFileSystem.h"
19 #include "llvm/ADT/IntrusiveRefCntPtr.h"
20 #include "llvm/ADT/StringRef.h"
21 #include "llvm/ADT/StringSet.h"
22 #include "llvm/Option/OptSpecifier.h"
37 class CompilerInstance;
38 class CompilerInvocation;
40 class DependencyOutputOptions;
41 class DiagnosticsEngine;
42 class DiagnosticOptions;
43 class ExternalSemaSource;
46 class HeaderSearchOptions;
47 class IdentifierTable;
49 class PCHContainerReader;
51 class PreprocessorOptions;
52 class PreprocessorOutputOptions;
56 class FrontendOptions;
58 /// Apply the header search options to get given HeaderSearch object.
59 void ApplyHeaderSearchOptions(HeaderSearch &HS,
60 const HeaderSearchOptions &HSOpts,
61 const LangOptions &Lang,
62 const llvm::Triple &triple);
64 /// InitializePreprocessor - Initialize the preprocessor getting it and the
65 /// environment ready to process a single file.
66 void InitializePreprocessor(Preprocessor &PP, const PreprocessorOptions &PPOpts,
67 const PCHContainerReader &PCHContainerRdr,
68 const FrontendOptions &FEOpts);
70 /// DoPrintPreprocessedInput - Implement -E mode.
71 void DoPrintPreprocessedInput(Preprocessor &PP, raw_ostream* OS,
72 const PreprocessorOutputOptions &Opts);
74 /// An interface for collecting the dependencies of a compilation. Users should
75 /// use \c attachToPreprocessor and \c attachToASTReader to get all of the
77 /// FIXME: Migrate DependencyFileGen and DependencyGraphGen to use this
79 class DependencyCollector {
81 virtual void attachToPreprocessor(Preprocessor &PP);
82 virtual void attachToASTReader(ASTReader &R);
83 llvm::ArrayRef<std::string> getDependencies() const { return Dependencies; }
85 /// Called when a new file is seen. Return true if \p Filename should be added
86 /// to the list of dependencies.
88 /// The default implementation ignores <built-in> and system files.
89 virtual bool sawDependency(StringRef Filename, bool FromModule,
90 bool IsSystem, bool IsModuleFile, bool IsMissing);
91 /// Called when the end of the main file is reached.
92 virtual void finishedMainFile() { }
93 /// Return true if system files should be passed to sawDependency().
94 virtual bool needSystemDependencies() { return false; }
95 virtual ~DependencyCollector();
97 public: // implementation detail
98 /// Add a dependency \p Filename if it has not been seen before and
99 /// sawDependency() returns true.
100 void maybeAddDependency(StringRef Filename, bool FromModule, bool IsSystem,
101 bool IsModuleFile, bool IsMissing);
103 llvm::StringSet<> Seen;
104 std::vector<std::string> Dependencies;
107 /// Builds a depdenency file when attached to a Preprocessor (for includes) and
108 /// ASTReader (for module imports), and writes it out at the end of processing
109 /// a source file. Users should attach to the ast reader whenever a module is
111 class DependencyFileGenerator {
112 void *Impl; // Opaque implementation
113 DependencyFileGenerator(void *Impl);
115 static DependencyFileGenerator *CreateAndAttachToPreprocessor(
116 Preprocessor &PP, const DependencyOutputOptions &Opts);
117 void AttachToASTReader(ASTReader &R);
120 /// Collects the dependencies for imported modules into a directory. Users
121 /// should attach to the AST reader whenever a module is loaded.
122 class ModuleDependencyCollector : public DependencyCollector {
124 bool HasErrors = false;
125 llvm::StringSet<> Seen;
126 vfs::YAMLVFSWriter VFSWriter;
128 llvm::StringMap<std::string> SymLinkMap;
130 bool getRealPath(StringRef SrcPath, SmallVectorImpl<char> &Result);
131 std::error_code copyToRoot(StringRef Src, StringRef Dst = "");
133 StringRef getDest() { return DestDir; }
134 bool insertSeen(StringRef Filename) { return Seen.insert(Filename).second; }
135 void addFile(StringRef Filename, StringRef FileDst = "");
136 void addFileMapping(StringRef VPath, StringRef RPath) {
137 VFSWriter.addFileMapping(VPath, RPath);
140 void attachToPreprocessor(Preprocessor &PP) override;
141 void attachToASTReader(ASTReader &R) override;
144 bool hasErrors() { return HasErrors; }
145 ModuleDependencyCollector(std::string DestDir)
146 : DestDir(std::move(DestDir)) {}
147 ~ModuleDependencyCollector() { writeFileMap(); }
150 /// AttachDependencyGraphGen - Create a dependency graph generator, and attach
151 /// it to the given preprocessor.
152 void AttachDependencyGraphGen(Preprocessor &PP, StringRef OutputFile,
155 /// AttachHeaderIncludeGen - Create a header include list generator, and attach
156 /// it to the given preprocessor.
158 /// \param DepOpts - Options controlling the output.
159 /// \param ShowAllHeaders - If true, show all header information instead of just
160 /// headers following the predefines buffer. This is useful for making sure
161 /// includes mentioned on the command line are also reported, but differs from
162 /// the default behavior used by -H.
163 /// \param OutputPath - If non-empty, a path to write the header include
164 /// information to, instead of writing to stderr.
165 /// \param ShowDepth - Whether to indent to show the nesting of the includes.
166 /// \param MSStyle - Whether to print in cl.exe /showIncludes style.
167 void AttachHeaderIncludeGen(Preprocessor &PP,
168 const DependencyOutputOptions &DepOpts,
169 bool ShowAllHeaders = false,
170 StringRef OutputPath = "",
171 bool ShowDepth = true, bool MSStyle = false);
173 /// Cache tokens for use with PCH. Note that this requires a seekable stream.
174 void CacheTokens(Preprocessor &PP, raw_pwrite_stream *OS);
176 /// The ChainedIncludesSource class converts headers to chained PCHs in
177 /// memory, mainly for testing.
178 IntrusiveRefCntPtr<ExternalSemaSource>
179 createChainedIncludesSource(CompilerInstance &CI,
180 IntrusiveRefCntPtr<ExternalSemaSource> &Reader);
182 /// createInvocationFromCommandLine - Construct a compiler invocation object for
183 /// a command line argument vector.
185 /// \return A CompilerInvocation, or 0 if none was built for the given
187 std::unique_ptr<CompilerInvocation>
188 createInvocationFromCommandLine(ArrayRef<const char *> Args,
189 IntrusiveRefCntPtr<DiagnosticsEngine> Diags =
190 IntrusiveRefCntPtr<DiagnosticsEngine>());
192 /// Return the value of the last argument as an integer, or a default. If Diags
193 /// is non-null, emits an error if the argument is given, but non-integral.
194 int getLastArgIntValue(const llvm::opt::ArgList &Args,
195 llvm::opt::OptSpecifier Id, int Default,
196 DiagnosticsEngine *Diags = nullptr);
198 inline int getLastArgIntValue(const llvm::opt::ArgList &Args,
199 llvm::opt::OptSpecifier Id, int Default,
200 DiagnosticsEngine &Diags) {
201 return getLastArgIntValue(Args, Id, Default, &Diags);
204 uint64_t getLastArgUInt64Value(const llvm::opt::ArgList &Args,
205 llvm::opt::OptSpecifier Id, uint64_t Default,
206 DiagnosticsEngine *Diags = nullptr);
208 inline uint64_t getLastArgUInt64Value(const llvm::opt::ArgList &Args,
209 llvm::opt::OptSpecifier Id,
211 DiagnosticsEngine &Diags) {
212 return getLastArgUInt64Value(Args, Id, Default, &Diags);
215 // When Clang->getFrontendOpts().DisableFree is set we don't delete some of the
216 // global objects, but we don't want LeakDetectors to complain, so we bury them
217 // in a globally visible array.
218 void BuryPointer(const void *Ptr);
219 template <typename T> void BuryPointer(std::unique_ptr<T> Ptr) {
220 BuryPointer(Ptr.release());
223 } // end namespace clang