blob: 6cf3a637acfdafe9514d9ed7fb7db9a6d6f92008 [file] [log] [blame]
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +00001//===- CIndexHigh.cpp - Higher level API functions ------------------------===//
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#include "IndexingContext.h"
11#include "CXCursor.h"
12#include "CXSourceLocation.h"
13#include "CXTranslationUnit.h"
14#include "CXString.h"
Argyrios Kyrtzidisf2d99b02011-12-01 02:42:50 +000015#include "CIndexDiagnostic.h"
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +000016#include "CIndexer.h"
17
18#include "clang/Frontend/ASTUnit.h"
19#include "clang/Frontend/CompilerInvocation.h"
20#include "clang/Frontend/CompilerInstance.h"
Douglas Gregor32fbe312012-01-20 16:28:04 +000021#include "clang/Frontend/FrontendAction.h"
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +000022#include "clang/Frontend/Utils.h"
23#include "clang/Sema/SemaConsumer.h"
24#include "clang/AST/ASTConsumer.h"
25#include "clang/AST/DeclVisitor.h"
26#include "clang/Lex/Preprocessor.h"
27#include "clang/Lex/PPCallbacks.h"
28#include "llvm/Support/MemoryBuffer.h"
29#include "llvm/Support/CrashRecoveryContext.h"
30
31using namespace clang;
32using namespace cxstring;
33using namespace cxtu;
34using namespace cxindex;
35
Argyrios Kyrtzidisf2d99b02011-12-01 02:42:50 +000036static void indexDiagnostics(CXTranslationUnit TU, IndexingContext &IdxCtx);
37
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +000038namespace {
39
40//===----------------------------------------------------------------------===//
41// IndexPPCallbacks
42//===----------------------------------------------------------------------===//
43
44class IndexPPCallbacks : public PPCallbacks {
45 Preprocessor &PP;
46 IndexingContext &IndexCtx;
Argyrios Kyrtzidis7519c5e2011-11-11 00:23:36 +000047 bool IsMainFileEntered;
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +000048
49public:
50 IndexPPCallbacks(Preprocessor &PP, IndexingContext &indexCtx)
Argyrios Kyrtzidis7519c5e2011-11-11 00:23:36 +000051 : PP(PP), IndexCtx(indexCtx), IsMainFileEntered(false) { }
52
53 virtual void FileChanged(SourceLocation Loc, FileChangeReason Reason,
54 SrcMgr::CharacteristicKind FileType, FileID PrevFID) {
55 if (IsMainFileEntered)
56 return;
57
58 SourceManager &SM = PP.getSourceManager();
59 SourceLocation MainFileLoc = SM.getLocForStartOfFile(SM.getMainFileID());
60
61 if (Loc == MainFileLoc && Reason == PPCallbacks::EnterFile) {
62 IsMainFileEntered = true;
63 IndexCtx.enteredMainFile(SM.getFileEntryForID(SM.getMainFileID()));
64 }
65 }
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +000066
67 virtual void InclusionDirective(SourceLocation HashLoc,
68 const Token &IncludeTok,
69 StringRef FileName,
70 bool IsAngled,
Argyrios Kyrtzidis4fcd2882012-09-27 01:42:07 +000071 CharSourceRange FilenameRange,
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +000072 const FileEntry *File,
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +000073 StringRef SearchPath,
Argyrios Kyrtzidis19d78b72012-09-29 01:06:10 +000074 StringRef RelativePath,
75 const Module *Imported) {
Argyrios Kyrtzidis472eda02012-10-02 16:10:38 +000076 if (Imported) {
Argyrios Kyrtzidis184b1442012-10-03 21:05:44 +000077 // We handle implicit imports via ImportDecls.
Argyrios Kyrtzidis472eda02012-10-02 16:10:38 +000078 return;
79 }
80
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +000081 bool isImport = (IncludeTok.is(tok::identifier) &&
82 IncludeTok.getIdentifierInfo()->getPPKeywordID() == tok::pp_import);
83 IndexCtx.ppIncludedFile(HashLoc, FileName, File, isImport, IsAngled);
84 }
85
86 /// MacroDefined - This hook is called whenever a macro definition is seen.
87 virtual void MacroDefined(const Token &Id, const MacroInfo *MI) {
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +000088 }
89
90 /// MacroUndefined - This hook is called whenever a macro #undef is seen.
91 /// MI is released immediately following this callback.
92 virtual void MacroUndefined(const Token &MacroNameTok, const MacroInfo *MI) {
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +000093 }
94
95 /// MacroExpands - This is called by when a macro invocation is found.
96 virtual void MacroExpands(const Token &MacroNameTok, const MacroInfo* MI,
97 SourceRange Range) {
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +000098 }
99
100 /// SourceRangeSkipped - This hook is called when a source range is skipped.
101 /// \param Range The SourceRange that was skipped. The range begins at the
102 /// #if/#else directive and ends after the #endif/#else directive.
103 virtual void SourceRangeSkipped(SourceRange Range) {
104 }
105};
106
107//===----------------------------------------------------------------------===//
108// IndexingConsumer
109//===----------------------------------------------------------------------===//
110
111class IndexingConsumer : public ASTConsumer {
112 IndexingContext &IndexCtx;
113
114public:
115 explicit IndexingConsumer(IndexingContext &indexCtx)
116 : IndexCtx(indexCtx) { }
117
118 // ASTConsumer Implementation
119
120 virtual void Initialize(ASTContext &Context) {
121 IndexCtx.setASTContext(Context);
Argyrios Kyrtzidis3e429e72011-11-12 02:16:30 +0000122 IndexCtx.startedTranslationUnit();
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000123 }
124
125 virtual void HandleTranslationUnit(ASTContext &Ctx) {
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000126 }
127
Argyrios Kyrtzidis841dd882011-11-18 00:26:59 +0000128 virtual bool HandleTopLevelDecl(DeclGroupRef DG) {
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000129 IndexCtx.indexDeclGroupRef(DG);
Argyrios Kyrtzidis841dd882011-11-18 00:26:59 +0000130 return !IndexCtx.shouldAbort();
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000131 }
132
133 /// \brief Handle the specified top-level declaration that occurred inside
134 /// and ObjC container.
135 virtual void HandleTopLevelDeclInObjCContainer(DeclGroupRef D) {
136 // They will be handled after the interface is seen first.
137 IndexCtx.addTUDeclInObjCContainer(D);
138 }
139
140 /// \brief This is called by the AST reader when deserializing things.
141 /// The default implementation forwards to HandleTopLevelDecl but we don't
142 /// care about them when indexing, so have an empty definition.
143 virtual void HandleInterestingDecl(DeclGroupRef D) {}
Argyrios Kyrtzidise5dc5b32012-02-10 20:10:44 +0000144
145 virtual void HandleTagDeclDefinition(TagDecl *D) {
Argyrios Kyrtzidis7e747952012-02-14 22:23:11 +0000146 if (!IndexCtx.shouldIndexImplicitTemplateInsts())
147 return;
148
Argyrios Kyrtzidise5dc5b32012-02-10 20:10:44 +0000149 if (IndexCtx.isTemplateImplicitInstantiation(D))
150 IndexCtx.indexDecl(D);
151 }
152
153 virtual void HandleCXXImplicitFunctionInstantiation(FunctionDecl *D) {
Argyrios Kyrtzidis7e747952012-02-14 22:23:11 +0000154 if (!IndexCtx.shouldIndexImplicitTemplateInsts())
155 return;
156
Argyrios Kyrtzidise5dc5b32012-02-10 20:10:44 +0000157 IndexCtx.indexDecl(D);
158 }
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000159};
160
161//===----------------------------------------------------------------------===//
Argyrios Kyrtzidiseffdbf52011-11-18 00:26:51 +0000162// CaptureDiagnosticConsumer
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000163//===----------------------------------------------------------------------===//
164
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000165class CaptureDiagnosticConsumer : public DiagnosticConsumer {
166 SmallVector<StoredDiagnostic, 4> Errors;
167public:
168
169 virtual void HandleDiagnostic(DiagnosticsEngine::Level level,
170 const Diagnostic &Info) {
171 if (level >= DiagnosticsEngine::Error)
172 Errors.push_back(StoredDiagnostic(level, Info));
173 }
174
175 DiagnosticConsumer *clone(DiagnosticsEngine &Diags) const {
176 return new IgnoringDiagConsumer();
177 }
178};
179
180//===----------------------------------------------------------------------===//
181// IndexingFrontendAction
182//===----------------------------------------------------------------------===//
183
184class IndexingFrontendAction : public ASTFrontendAction {
185 IndexingContext IndexCtx;
Argyrios Kyrtzidisf2d99b02011-12-01 02:42:50 +0000186 CXTranslationUnit CXTU;
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000187
188public:
189 IndexingFrontendAction(CXClientData clientData,
190 IndexerCallbacks &indexCallbacks,
191 unsigned indexOptions,
192 CXTranslationUnit cxTU)
Argyrios Kyrtzidisf2d99b02011-12-01 02:42:50 +0000193 : IndexCtx(clientData, indexCallbacks, indexOptions, cxTU),
Argyrios Kyrtzidisb36ee5c2012-10-02 16:10:41 +0000194 CXTU(cxTU), EnablePPDetailedRecordForModules(false) { }
195
196 bool EnablePPDetailedRecordForModules;
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000197
198 virtual ASTConsumer *CreateASTConsumer(CompilerInstance &CI,
199 StringRef InFile) {
Argyrios Kyrtzidisb36ee5c2012-10-02 16:10:41 +0000200 // We usually disable the preprocessing record for indexing even if the
201 // original preprocessing options had it enabled. Now that the indexing
202 // Preprocessor has been created (without a preprocessing record), re-enable
203 // the option in case modules are enabled, so that the detailed record
204 // option can be propagated when the module file is generated.
205 if (CI.getLangOpts().Modules && EnablePPDetailedRecordForModules)
206 CI.getPreprocessorOpts().DetailedRecord = true;
207
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000208 IndexCtx.setASTContext(CI.getASTContext());
209 Preprocessor &PP = CI.getPreprocessor();
210 PP.addPPCallbacks(new IndexPPCallbacks(PP, IndexCtx));
Argyrios Kyrtzidisda6e0542012-01-17 18:48:07 +0000211 IndexCtx.setPreprocessor(PP);
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000212 return new IndexingConsumer(IndexCtx);
213 }
214
Argyrios Kyrtzidisf2d99b02011-12-01 02:42:50 +0000215 virtual void EndSourceFileAction() {
216 indexDiagnostics(CXTU, IndexCtx);
217 }
218
Argyrios Kyrtzidis7e747952012-02-14 22:23:11 +0000219 virtual TranslationUnitKind getTranslationUnitKind() {
220 if (IndexCtx.shouldIndexImplicitTemplateInsts())
221 return TU_Complete;
222 else
223 return TU_Prefix;
224 }
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000225 virtual bool hasCodeCompletionSupport() const { return false; }
226};
227
228//===----------------------------------------------------------------------===//
Argyrios Kyrtzidisd992e142011-11-15 06:20:16 +0000229// clang_indexSourceFileUnit Implementation
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000230//===----------------------------------------------------------------------===//
231
Argyrios Kyrtzidisd992e142011-11-15 06:20:16 +0000232struct IndexSourceFileInfo {
Argyrios Kyrtzidis4c910b12011-11-22 07:24:51 +0000233 CXIndexAction idxAction;
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000234 CXClientData client_data;
235 IndexerCallbacks *index_callbacks;
236 unsigned index_callbacks_size;
237 unsigned index_options;
238 const char *source_filename;
239 const char *const *command_line_args;
240 int num_command_line_args;
241 struct CXUnsavedFile *unsaved_files;
242 unsigned num_unsaved_files;
243 CXTranslationUnit *out_TU;
244 unsigned TU_options;
245 int result;
246};
247
248struct MemBufferOwner {
249 SmallVector<const llvm::MemoryBuffer *, 8> Buffers;
250
251 ~MemBufferOwner() {
252 for (SmallVectorImpl<const llvm::MemoryBuffer *>::iterator
253 I = Buffers.begin(), E = Buffers.end(); I != E; ++I)
254 delete *I;
255 }
256};
257
258} // anonymous namespace
259
Argyrios Kyrtzidisd992e142011-11-15 06:20:16 +0000260static void clang_indexSourceFile_Impl(void *UserData) {
261 IndexSourceFileInfo *ITUI =
262 static_cast<IndexSourceFileInfo*>(UserData);
Argyrios Kyrtzidis4c910b12011-11-22 07:24:51 +0000263 CXIndex CIdx = (CXIndex)ITUI->idxAction;
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000264 CXClientData client_data = ITUI->client_data;
265 IndexerCallbacks *client_index_callbacks = ITUI->index_callbacks;
266 unsigned index_callbacks_size = ITUI->index_callbacks_size;
267 unsigned index_options = ITUI->index_options;
268 const char *source_filename = ITUI->source_filename;
269 const char * const *command_line_args = ITUI->command_line_args;
270 int num_command_line_args = ITUI->num_command_line_args;
271 struct CXUnsavedFile *unsaved_files = ITUI->unsaved_files;
272 unsigned num_unsaved_files = ITUI->num_unsaved_files;
273 CXTranslationUnit *out_TU = ITUI->out_TU;
274 unsigned TU_options = ITUI->TU_options;
275 ITUI->result = 1; // init as error.
276
277 if (out_TU)
278 *out_TU = 0;
279 bool requestedToGetTU = (out_TU != 0);
280
281 if (!CIdx)
282 return;
283 if (!client_index_callbacks || index_callbacks_size == 0)
284 return;
285
286 IndexerCallbacks CB;
287 memset(&CB, 0, sizeof(CB));
288 unsigned ClientCBSize = index_callbacks_size < sizeof(CB)
289 ? index_callbacks_size : sizeof(CB);
290 memcpy(&CB, client_index_callbacks, ClientCBSize);
291
292 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
293
Argyrios Kyrtzidis7317a5c2012-03-28 02:18:05 +0000294 if (CXXIdx->isOptEnabled(CXGlobalOpt_ThreadBackgroundPriorityForIndexing))
Argyrios Kyrtzidis58d5f3f2012-03-28 02:49:54 +0000295 setThreadBackgroundPriority();
Argyrios Kyrtzidis7317a5c2012-03-28 02:18:05 +0000296
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000297 CaptureDiagnosticConsumer *CaptureDiag = new CaptureDiagnosticConsumer();
298
299 // Configure the diagnostics.
300 DiagnosticOptions DiagOpts;
Dylan Noblesmithc95d8192012-02-20 14:00:23 +0000301 IntrusiveRefCntPtr<DiagnosticsEngine>
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000302 Diags(CompilerInstance::createDiagnostics(DiagOpts, num_command_line_args,
303 command_line_args,
304 CaptureDiag,
Argyrios Kyrtzidis6e210232011-11-29 08:14:50 +0000305 /*ShouldOwnClient=*/true,
306 /*ShouldCloneClient=*/false));
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000307
308 // Recover resources if we crash before exiting this function.
309 llvm::CrashRecoveryContextCleanupRegistrar<DiagnosticsEngine,
310 llvm::CrashRecoveryContextReleaseRefCleanup<DiagnosticsEngine> >
311 DiagCleanup(Diags.getPtr());
312
Dylan Noblesmith1cd10692012-02-13 12:32:21 +0000313 OwningPtr<std::vector<const char *> >
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000314 Args(new std::vector<const char*>());
315
316 // Recover resources if we crash before exiting this method.
317 llvm::CrashRecoveryContextCleanupRegistrar<std::vector<const char*> >
318 ArgsCleanup(Args.get());
319
320 Args->insert(Args->end(), command_line_args,
321 command_line_args + num_command_line_args);
322
323 // The 'source_filename' argument is optional. If the caller does not
324 // specify it then it is assumed that the source file is specified
325 // in the actual argument list.
326 // Put the source file after command_line_args otherwise if '-x' flag is
327 // present it will be unused.
328 if (source_filename)
329 Args->push_back(source_filename);
330
Dylan Noblesmithc95d8192012-02-20 14:00:23 +0000331 IntrusiveRefCntPtr<CompilerInvocation>
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000332 CInvok(createInvocationFromCommandLine(*Args, Diags));
333
334 if (!CInvok)
335 return;
336
337 // Recover resources if we crash before exiting this function.
338 llvm::CrashRecoveryContextCleanupRegistrar<CompilerInvocation,
339 llvm::CrashRecoveryContextReleaseRefCleanup<CompilerInvocation> >
340 CInvokCleanup(CInvok.getPtr());
341
342 if (CInvok->getFrontendOpts().Inputs.empty())
343 return;
344
Dylan Noblesmith1cd10692012-02-13 12:32:21 +0000345 OwningPtr<MemBufferOwner> BufOwner(new MemBufferOwner());
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000346
347 // Recover resources if we crash before exiting this method.
348 llvm::CrashRecoveryContextCleanupRegistrar<MemBufferOwner>
349 BufOwnerCleanup(BufOwner.get());
350
351 for (unsigned I = 0; I != num_unsaved_files; ++I) {
352 StringRef Data(unsaved_files[I].Contents, unsaved_files[I].Length);
353 const llvm::MemoryBuffer *Buffer
354 = llvm::MemoryBuffer::getMemBufferCopy(Data, unsaved_files[I].Filename);
355 CInvok->getPreprocessorOpts().addRemappedFile(unsaved_files[I].Filename, Buffer);
356 BufOwner->Buffers.push_back(Buffer);
357 }
358
359 // Since libclang is primarily used by batch tools dealing with
360 // (often very broken) source code, where spell-checking can have a
361 // significant negative impact on performance (particularly when
362 // precompiled headers are involved), we disable it.
Ted Kremenek8cf47df2011-11-17 23:01:24 +0000363 CInvok->getLangOpts()->SpellChecking = false;
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000364
Argyrios Kyrtzidis6c9ed7d2012-03-27 21:38:03 +0000365 if (index_options & CXIndexOpt_SuppressWarnings)
366 CInvok->getDiagnosticOpts().IgnoreWarnings = true;
367
Argyrios Kyrtzidis67aa7db2011-11-28 04:55:55 +0000368 ASTUnit *Unit = ASTUnit::create(CInvok.getPtr(), Diags,
Argyrios Kyrtzidis6d7833f2012-07-11 20:59:04 +0000369 /*CaptureDiagnostics=*/true,
370 /*UserFilesAreVolatile=*/true);
Argyrios Kyrtzidis7317a5c2012-03-28 02:18:05 +0000371 OwningPtr<CXTUOwner> CXTU(new CXTUOwner(MakeCXTranslationUnit(CXXIdx, Unit)));
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000372
373 // Recover resources if we crash before exiting this method.
374 llvm::CrashRecoveryContextCleanupRegistrar<CXTUOwner>
375 CXTUCleanup(CXTU.get());
376
Dylan Noblesmith1cd10692012-02-13 12:32:21 +0000377 OwningPtr<IndexingFrontendAction> IndexAction;
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000378 IndexAction.reset(new IndexingFrontendAction(client_data, CB,
379 index_options, CXTU->getTU()));
380
381 // Recover resources if we crash before exiting this method.
382 llvm::CrashRecoveryContextCleanupRegistrar<IndexingFrontendAction>
383 IndexActionCleanup(IndexAction.get());
384
Argyrios Kyrtzidisb11f5a42011-11-28 04:56:00 +0000385 bool Persistent = requestedToGetTU;
Argyrios Kyrtzidisb11f5a42011-11-28 04:56:00 +0000386 bool OnlyLocalDecls = false;
Argyrios Kyrtzidisb11f5a42011-11-28 04:56:00 +0000387 bool PrecompilePreamble = false;
388 bool CacheCodeCompletionResults = false;
389 PreprocessorOptions &PPOpts = CInvok->getPreprocessorOpts();
Argyrios Kyrtzidis4a280ff2012-03-07 01:51:17 +0000390 PPOpts.AllowPCHWithCompilerErrors = true;
Argyrios Kyrtzidisb11f5a42011-11-28 04:56:00 +0000391
392 if (requestedToGetTU) {
393 OnlyLocalDecls = CXXIdx->getOnlyLocalDecls();
394 PrecompilePreamble = TU_options & CXTranslationUnit_PrecompiledPreamble;
395 // FIXME: Add a flag for modules.
396 CacheCodeCompletionResults
397 = TU_options & CXTranslationUnit_CacheCompletionResults;
398 if (TU_options & CXTranslationUnit_DetailedPreprocessingRecord) {
399 PPOpts.DetailedRecord = true;
Argyrios Kyrtzidisb11f5a42011-11-28 04:56:00 +0000400 }
401 }
402
Argyrios Kyrtzidisb36ee5c2012-10-02 16:10:41 +0000403 IndexAction->EnablePPDetailedRecordForModules
404 = PPOpts.DetailedRecord ||
405 (TU_options & CXTranslationUnit_DetailedPreprocessingRecord);
406
407 if (!requestedToGetTU)
408 PPOpts.DetailedRecord = false;
409
Argyrios Kyrtzidisac1cc932012-04-11 02:11:16 +0000410 DiagnosticErrorTrap DiagTrap(*Diags);
411 bool Success = ASTUnit::LoadFromCompilerInvocationAction(CInvok.getPtr(), Diags,
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000412 IndexAction.get(),
Argyrios Kyrtzidisb11f5a42011-11-28 04:56:00 +0000413 Unit,
414 Persistent,
Argyrios Kyrtzidis30a24322012-06-28 21:03:08 +0000415 CXXIdx->getClangResourcesPath(),
Argyrios Kyrtzidisb11f5a42011-11-28 04:56:00 +0000416 OnlyLocalDecls,
Argyrios Kyrtzidisf2d99b02011-12-01 02:42:50 +0000417 /*CaptureDiagnostics=*/true,
Argyrios Kyrtzidisb11f5a42011-11-28 04:56:00 +0000418 PrecompilePreamble,
Argyrios Kyrtzidis6d7833f2012-07-11 20:59:04 +0000419 CacheCodeCompletionResults,
420 /*IncludeBriefCommentsInCodeCompletion=*/false,
421 /*UserFilesAreVolatile=*/true);
Argyrios Kyrtzidisac1cc932012-04-11 02:11:16 +0000422 if (DiagTrap.hasErrorOccurred() && CXXIdx->getDisplayDiagnostics())
423 printDiagsToStderr(Unit);
424
425 if (!Success)
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000426 return;
427
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000428 if (out_TU)
429 *out_TU = CXTU->takeTU();
430
431 ITUI->result = 0; // success.
432}
433
434//===----------------------------------------------------------------------===//
Argyrios Kyrtzidisd992e142011-11-15 06:20:16 +0000435// clang_indexTranslationUnit Implementation
436//===----------------------------------------------------------------------===//
437
438namespace {
439
440struct IndexTranslationUnitInfo {
Argyrios Kyrtzidis4c910b12011-11-22 07:24:51 +0000441 CXIndexAction idxAction;
Argyrios Kyrtzidisd992e142011-11-15 06:20:16 +0000442 CXClientData client_data;
443 IndexerCallbacks *index_callbacks;
444 unsigned index_callbacks_size;
445 unsigned index_options;
Argyrios Kyrtzidis4c910b12011-11-22 07:24:51 +0000446 CXTranslationUnit TU;
Argyrios Kyrtzidisd992e142011-11-15 06:20:16 +0000447 int result;
448};
449
450} // anonymous namespace
451
452static void indexPreprocessingRecord(ASTUnit &Unit, IndexingContext &IdxCtx) {
453 Preprocessor &PP = Unit.getPreprocessor();
454 if (!PP.getPreprocessingRecord())
455 return;
456
Argyrios Kyrtzidisd992e142011-11-15 06:20:16 +0000457 // FIXME: Only deserialize inclusion directives.
Argyrios Kyrtzidisd992e142011-11-15 06:20:16 +0000458
Argyrios Kyrtzidisd992e142011-11-15 06:20:16 +0000459 PreprocessingRecord::iterator I, E;
Argyrios Kyrtzidisd4fcf5802012-10-02 16:10:51 +0000460 llvm::tie(I, E) = Unit.getLocalPreprocessingEntities();
Argyrios Kyrtzidisd992e142011-11-15 06:20:16 +0000461
462 for (; I != E; ++I) {
463 PreprocessedEntity *PPE = *I;
464
465 if (InclusionDirective *ID = dyn_cast<InclusionDirective>(PPE)) {
Argyrios Kyrtzidisf590e092012-10-02 16:10:46 +0000466 if (!ID->importedModule())
467 IdxCtx.ppIncludedFile(ID->getSourceRange().getBegin(),ID->getFileName(),
Argyrios Kyrtzidisd992e142011-11-15 06:20:16 +0000468 ID->getFile(), ID->getKind() == InclusionDirective::Import,
469 !ID->wasInQuotes());
470 }
471 }
472}
473
Argyrios Kyrtzidise514b202012-10-03 01:58:28 +0000474static bool topLevelDeclVisitor(void *context, const Decl *D) {
Argyrios Kyrtzidis10e78462012-10-02 21:09:13 +0000475 IndexingContext &IdxCtx = *static_cast<IndexingContext*>(context);
476 IdxCtx.indexTopLevelDecl(D);
477 if (IdxCtx.shouldAbort())
478 return false;
479 return true;
480}
481
Argyrios Kyrtzidisd992e142011-11-15 06:20:16 +0000482static void indexTranslationUnit(ASTUnit &Unit, IndexingContext &IdxCtx) {
Argyrios Kyrtzidise514b202012-10-03 01:58:28 +0000483 Unit.visitLocalTopLevelDecls(&IdxCtx, topLevelDeclVisitor);
Argyrios Kyrtzidisd992e142011-11-15 06:20:16 +0000484}
485
486static void indexDiagnostics(CXTranslationUnit TU, IndexingContext &IdxCtx) {
Argyrios Kyrtzidisf2d99b02011-12-01 02:42:50 +0000487 if (!IdxCtx.hasDiagnosticCallback())
488 return;
489
490 CXDiagnosticSetImpl *DiagSet = cxdiag::lazyCreateDiags(TU);
491 IdxCtx.handleDiagnosticSet(DiagSet);
Argyrios Kyrtzidisd992e142011-11-15 06:20:16 +0000492}
493
494static void clang_indexTranslationUnit_Impl(void *UserData) {
495 IndexTranslationUnitInfo *ITUI =
496 static_cast<IndexTranslationUnitInfo*>(UserData);
497 CXTranslationUnit TU = ITUI->TU;
498 CXClientData client_data = ITUI->client_data;
499 IndexerCallbacks *client_index_callbacks = ITUI->index_callbacks;
500 unsigned index_callbacks_size = ITUI->index_callbacks_size;
501 unsigned index_options = ITUI->index_options;
502 ITUI->result = 1; // init as error.
503
504 if (!TU)
505 return;
506 if (!client_index_callbacks || index_callbacks_size == 0)
507 return;
508
Argyrios Kyrtzidis7317a5c2012-03-28 02:18:05 +0000509 CIndexer *CXXIdx = (CIndexer*)TU->CIdx;
510 if (CXXIdx->isOptEnabled(CXGlobalOpt_ThreadBackgroundPriorityForIndexing))
Argyrios Kyrtzidis58d5f3f2012-03-28 02:49:54 +0000511 setThreadBackgroundPriority();
Argyrios Kyrtzidis7317a5c2012-03-28 02:18:05 +0000512
Argyrios Kyrtzidisd992e142011-11-15 06:20:16 +0000513 IndexerCallbacks CB;
514 memset(&CB, 0, sizeof(CB));
515 unsigned ClientCBSize = index_callbacks_size < sizeof(CB)
516 ? index_callbacks_size : sizeof(CB);
517 memcpy(&CB, client_index_callbacks, ClientCBSize);
518
Dylan Noblesmith1cd10692012-02-13 12:32:21 +0000519 OwningPtr<IndexingContext> IndexCtx;
Argyrios Kyrtzidisd992e142011-11-15 06:20:16 +0000520 IndexCtx.reset(new IndexingContext(client_data, CB, index_options, TU));
521
522 // Recover resources if we crash before exiting this method.
523 llvm::CrashRecoveryContextCleanupRegistrar<IndexingContext>
524 IndexCtxCleanup(IndexCtx.get());
525
Dylan Noblesmith1cd10692012-02-13 12:32:21 +0000526 OwningPtr<IndexingConsumer> IndexConsumer;
Argyrios Kyrtzidisd992e142011-11-15 06:20:16 +0000527 IndexConsumer.reset(new IndexingConsumer(*IndexCtx));
528
529 // Recover resources if we crash before exiting this method.
530 llvm::CrashRecoveryContextCleanupRegistrar<IndexingConsumer>
531 IndexConsumerCleanup(IndexConsumer.get());
532
533 ASTUnit *Unit = static_cast<ASTUnit *>(TU->TUData);
534 if (!Unit)
535 return;
536
Argyrios Kyrtzidis341de092012-09-25 19:29:50 +0000537 ASTUnit::ConcurrencyCheck Check(*Unit);
538
Argyrios Kyrtzidisd992e142011-11-15 06:20:16 +0000539 FileManager &FileMgr = Unit->getFileManager();
540
541 if (Unit->getOriginalSourceFileName().empty())
542 IndexCtx->enteredMainFile(0);
543 else
544 IndexCtx->enteredMainFile(FileMgr.getFile(Unit->getOriginalSourceFileName()));
545
546 IndexConsumer->Initialize(Unit->getASTContext());
547
548 indexPreprocessingRecord(*Unit, *IndexCtx);
549 indexTranslationUnit(*Unit, *IndexCtx);
550 indexDiagnostics(TU, *IndexCtx);
551
552 ITUI->result = 0;
553}
554
555//===----------------------------------------------------------------------===//
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000556// libclang public APIs.
557//===----------------------------------------------------------------------===//
558
559extern "C" {
560
Argyrios Kyrtzidis7519c5e2011-11-11 00:23:36 +0000561int clang_index_isEntityObjCContainerKind(CXIdxEntityKind K) {
562 return CXIdxEntity_ObjCClass <= K && K <= CXIdxEntity_ObjCCategory;
563}
564
Argyrios Kyrtzidis3e429e72011-11-12 02:16:30 +0000565const CXIdxObjCContainerDeclInfo *
566clang_index_getObjCContainerDeclInfo(const CXIdxDeclInfo *DInfo) {
567 if (!DInfo)
568 return 0;
569
Argyrios Kyrtzidis86acd722011-11-14 22:39:19 +0000570 const DeclInfo *DI = static_cast<const DeclInfo *>(DInfo);
571 if (const ObjCContainerDeclInfo *
572 ContInfo = dyn_cast<ObjCContainerDeclInfo>(DI))
573 return &ContInfo->ObjCContDeclInfo;
Argyrios Kyrtzidis7519c5e2011-11-11 00:23:36 +0000574
575 return 0;
576}
577
Argyrios Kyrtzidis3e429e72011-11-12 02:16:30 +0000578const CXIdxObjCInterfaceDeclInfo *
579clang_index_getObjCInterfaceDeclInfo(const CXIdxDeclInfo *DInfo) {
Argyrios Kyrtzidis86acd722011-11-14 22:39:19 +0000580 if (!DInfo)
Argyrios Kyrtzidis3e429e72011-11-12 02:16:30 +0000581 return 0;
Argyrios Kyrtzidis7519c5e2011-11-11 00:23:36 +0000582
Argyrios Kyrtzidis86acd722011-11-14 22:39:19 +0000583 const DeclInfo *DI = static_cast<const DeclInfo *>(DInfo);
584 if (const ObjCInterfaceDeclInfo *
585 InterInfo = dyn_cast<ObjCInterfaceDeclInfo>(DI))
586 return &InterInfo->ObjCInterDeclInfo;
Argyrios Kyrtzidis3e429e72011-11-12 02:16:30 +0000587
588 return 0;
589}
590
591const CXIdxObjCCategoryDeclInfo *
592clang_index_getObjCCategoryDeclInfo(const CXIdxDeclInfo *DInfo){
Argyrios Kyrtzidis86acd722011-11-14 22:39:19 +0000593 if (!DInfo)
Argyrios Kyrtzidis3e429e72011-11-12 02:16:30 +0000594 return 0;
595
Argyrios Kyrtzidis86acd722011-11-14 22:39:19 +0000596 const DeclInfo *DI = static_cast<const DeclInfo *>(DInfo);
597 if (const ObjCCategoryDeclInfo *
598 CatInfo = dyn_cast<ObjCCategoryDeclInfo>(DI))
599 return &CatInfo->ObjCCatDeclInfo;
600
601 return 0;
602}
603
604const CXIdxObjCProtocolRefListInfo *
605clang_index_getObjCProtocolRefListInfo(const CXIdxDeclInfo *DInfo) {
606 if (!DInfo)
607 return 0;
608
609 const DeclInfo *DI = static_cast<const DeclInfo *>(DInfo);
610
611 if (const ObjCInterfaceDeclInfo *
612 InterInfo = dyn_cast<ObjCInterfaceDeclInfo>(DI))
613 return InterInfo->ObjCInterDeclInfo.protocols;
614
615 if (const ObjCProtocolDeclInfo *
616 ProtInfo = dyn_cast<ObjCProtocolDeclInfo>(DI))
617 return &ProtInfo->ObjCProtoRefListInfo;
618
Argyrios Kyrtzidis9b9f7a92011-12-13 18:47:45 +0000619 if (const ObjCCategoryDeclInfo *CatInfo = dyn_cast<ObjCCategoryDeclInfo>(DI))
620 return CatInfo->ObjCCatDeclInfo.protocols;
621
Argyrios Kyrtzidis86acd722011-11-14 22:39:19 +0000622 return 0;
Argyrios Kyrtzidis3e429e72011-11-12 02:16:30 +0000623}
624
Argyrios Kyrtzidis93db2922012-02-28 17:50:33 +0000625const CXIdxObjCPropertyDeclInfo *
626clang_index_getObjCPropertyDeclInfo(const CXIdxDeclInfo *DInfo) {
627 if (!DInfo)
628 return 0;
629
630 const DeclInfo *DI = static_cast<const DeclInfo *>(DInfo);
631 if (const ObjCPropertyDeclInfo *PropInfo = dyn_cast<ObjCPropertyDeclInfo>(DI))
632 return &PropInfo->ObjCPropDeclInfo;
633
634 return 0;
635}
636
Argyrios Kyrtzidiseffdbf52011-11-18 00:26:51 +0000637const CXIdxIBOutletCollectionAttrInfo *
638clang_index_getIBOutletCollectionAttrInfo(const CXIdxAttrInfo *AInfo) {
639 if (!AInfo)
640 return 0;
641
642 const AttrInfo *DI = static_cast<const AttrInfo *>(AInfo);
643 if (const IBOutletCollectionInfo *
644 IBInfo = dyn_cast<IBOutletCollectionInfo>(DI))
645 return &IBInfo->IBCollInfo;
646
647 return 0;
648}
649
Argyrios Kyrtzidis4c910b12011-11-22 07:24:51 +0000650const CXIdxCXXClassDeclInfo *
651clang_index_getCXXClassDeclInfo(const CXIdxDeclInfo *DInfo) {
652 if (!DInfo)
653 return 0;
Argyrios Kyrtzidisd992e142011-11-15 06:20:16 +0000654
Argyrios Kyrtzidis4c910b12011-11-22 07:24:51 +0000655 const DeclInfo *DI = static_cast<const DeclInfo *>(DInfo);
656 if (const CXXClassDeclInfo *ClassInfo = dyn_cast<CXXClassDeclInfo>(DI))
657 return &ClassInfo->CXXClassInfo;
658
659 return 0;
660}
661
662CXIdxClientContainer
663clang_index_getClientContainer(const CXIdxContainerInfo *info) {
664 if (!info)
665 return 0;
Benjamin Kramer7f107ee2011-11-29 12:31:20 +0000666 const ContainerInfo *Container = static_cast<const ContainerInfo *>(info);
Argyrios Kyrtzidis4c910b12011-11-22 07:24:51 +0000667 return Container->IndexCtx->getClientContainerForDC(Container->DC);
668}
669
670void clang_index_setClientContainer(const CXIdxContainerInfo *info,
671 CXIdxClientContainer client) {
672 if (!info)
673 return;
Benjamin Kramer7f107ee2011-11-29 12:31:20 +0000674 const ContainerInfo *Container = static_cast<const ContainerInfo *>(info);
Argyrios Kyrtzidis4c910b12011-11-22 07:24:51 +0000675 Container->IndexCtx->addContainerInMap(Container->DC, client);
676}
677
678CXIdxClientEntity clang_index_getClientEntity(const CXIdxEntityInfo *info) {
679 if (!info)
680 return 0;
Benjamin Kramer7f107ee2011-11-29 12:31:20 +0000681 const EntityInfo *Entity = static_cast<const EntityInfo *>(info);
Argyrios Kyrtzidis4c910b12011-11-22 07:24:51 +0000682 return Entity->IndexCtx->getClientEntity(Entity->Dcl);
683}
684
685void clang_index_setClientEntity(const CXIdxEntityInfo *info,
686 CXIdxClientEntity client) {
687 if (!info)
688 return;
Benjamin Kramer7f107ee2011-11-29 12:31:20 +0000689 const EntityInfo *Entity = static_cast<const EntityInfo *>(info);
Argyrios Kyrtzidis4c910b12011-11-22 07:24:51 +0000690 Entity->IndexCtx->setClientEntity(Entity->Dcl, client);
691}
692
693CXIndexAction clang_IndexAction_create(CXIndex CIdx) {
694 // For now, CXIndexAction is featureless.
695 return CIdx;
696}
697
698void clang_IndexAction_dispose(CXIndexAction idxAction) {
699 // For now, CXIndexAction is featureless.
700}
701
702int clang_indexSourceFile(CXIndexAction idxAction,
703 CXClientData client_data,
704 IndexerCallbacks *index_callbacks,
705 unsigned index_callbacks_size,
706 unsigned index_options,
707 const char *source_filename,
708 const char * const *command_line_args,
709 int num_command_line_args,
710 struct CXUnsavedFile *unsaved_files,
711 unsigned num_unsaved_files,
712 CXTranslationUnit *out_TU,
713 unsigned TU_options) {
714
715 IndexSourceFileInfo ITUI = { idxAction, client_data, index_callbacks,
716 index_callbacks_size, index_options,
717 source_filename, command_line_args,
718 num_command_line_args, unsaved_files,
719 num_unsaved_files, out_TU, TU_options, 0 };
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000720
Argyrios Kyrtzidis97805532011-10-29 19:32:39 +0000721 if (getenv("LIBCLANG_NOTHREADS")) {
Argyrios Kyrtzidisd992e142011-11-15 06:20:16 +0000722 clang_indexSourceFile_Impl(&ITUI);
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000723 return ITUI.result;
724 }
725
726 llvm::CrashRecoveryContext CRC;
727
Argyrios Kyrtzidisd992e142011-11-15 06:20:16 +0000728 if (!RunSafely(CRC, clang_indexSourceFile_Impl, &ITUI)) {
729 fprintf(stderr, "libclang: crash detected during indexing source file: {\n");
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000730 fprintf(stderr, " 'source_filename' : '%s'\n", source_filename);
731 fprintf(stderr, " 'command_line_args' : [");
732 for (int i = 0; i != num_command_line_args; ++i) {
733 if (i)
734 fprintf(stderr, ", ");
735 fprintf(stderr, "'%s'", command_line_args[i]);
736 }
737 fprintf(stderr, "],\n");
738 fprintf(stderr, " 'unsaved_files' : [");
739 for (unsigned i = 0; i != num_unsaved_files; ++i) {
740 if (i)
741 fprintf(stderr, ", ");
742 fprintf(stderr, "('%s', '...', %ld)", unsaved_files[i].Filename,
743 unsaved_files[i].Length);
744 }
745 fprintf(stderr, "],\n");
746 fprintf(stderr, " 'options' : %d,\n", TU_options);
747 fprintf(stderr, "}\n");
748
749 return 1;
750 } else if (getenv("LIBCLANG_RESOURCE_USAGE")) {
751 if (out_TU)
752 PrintLibclangResourceUsage(*out_TU);
753 }
754
755 return ITUI.result;
756}
757
Argyrios Kyrtzidis4c910b12011-11-22 07:24:51 +0000758int clang_indexTranslationUnit(CXIndexAction idxAction,
Argyrios Kyrtzidisd992e142011-11-15 06:20:16 +0000759 CXClientData client_data,
760 IndexerCallbacks *index_callbacks,
761 unsigned index_callbacks_size,
Argyrios Kyrtzidis4c910b12011-11-22 07:24:51 +0000762 unsigned index_options,
763 CXTranslationUnit TU) {
Argyrios Kyrtzidisd992e142011-11-15 06:20:16 +0000764
Argyrios Kyrtzidis4c910b12011-11-22 07:24:51 +0000765 IndexTranslationUnitInfo ITUI = { idxAction, client_data, index_callbacks,
766 index_callbacks_size, index_options, TU,
767 0 };
Argyrios Kyrtzidisd992e142011-11-15 06:20:16 +0000768
769 if (getenv("LIBCLANG_NOTHREADS")) {
770 clang_indexTranslationUnit_Impl(&ITUI);
771 return ITUI.result;
772 }
773
774 llvm::CrashRecoveryContext CRC;
775
776 if (!RunSafely(CRC, clang_indexTranslationUnit_Impl, &ITUI)) {
777 fprintf(stderr, "libclang: crash detected during indexing TU\n");
778
779 return 1;
780 }
781
782 return ITUI.result;
783}
784
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000785void clang_indexLoc_getFileLocation(CXIdxLoc location,
Argyrios Kyrtzidis7519c5e2011-11-11 00:23:36 +0000786 CXIdxClientFile *indexFile,
Argyrios Kyrtzidisdc199a32011-10-17 19:48:19 +0000787 CXFile *file,
788 unsigned *line,
789 unsigned *column,
790 unsigned *offset) {
791 if (indexFile) *indexFile = 0;
792 if (file) *file = 0;
793 if (line) *line = 0;
794 if (column) *column = 0;
795 if (offset) *offset = 0;
796
797 SourceLocation Loc = SourceLocation::getFromRawEncoding(location.int_data);
798 if (!location.ptr_data[0] || Loc.isInvalid())
799 return;
800
801 IndexingContext &IndexCtx =
802 *static_cast<IndexingContext*>(location.ptr_data[0]);
803 IndexCtx.translateLoc(Loc, indexFile, file, line, column, offset);
804}
805
806CXSourceLocation clang_indexLoc_getCXSourceLocation(CXIdxLoc location) {
807 SourceLocation Loc = SourceLocation::getFromRawEncoding(location.int_data);
808 if (!location.ptr_data[0] || Loc.isInvalid())
809 return clang_getNullLocation();
810
811 IndexingContext &IndexCtx =
812 *static_cast<IndexingContext*>(location.ptr_data[0]);
813 return cxloc::translateSourceLocation(IndexCtx.getASTContext(), Loc);
814}
815
816} // end: extern "C"
817