CIndexCodeCompletion.cpp revision 110a68e38bb37526f9bd1d4e8f1b941fe5410b27
1//===- CIndexCodeCompletion.cpp - Code Completion API hooks ---------------===// 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// This file implements the Clang-C Source Indexing library hooks for 11// code completion. 12// 13//===----------------------------------------------------------------------===// 14 15#include "CIndexer.h" 16#include "CXTranslationUnit.h" 17#include "CXString.h" 18#include "CIndexDiagnostic.h" 19#include "clang/Basic/SourceManager.h" 20#include "clang/Basic/FileManager.h" 21#include "clang/Frontend/ASTUnit.h" 22#include "clang/Frontend/CompilerInstance.h" 23#include "clang/Frontend/FrontendDiagnostic.h" 24#include "clang/Sema/CodeCompleteConsumer.h" 25#include "llvm/ADT/SmallString.h" 26#include "llvm/ADT/StringExtras.h" 27#include "llvm/Support/Atomic.h" 28#include "llvm/Support/CrashRecoveryContext.h" 29#include "llvm/Support/MemoryBuffer.h" 30#include "llvm/Support/Timer.h" 31#include "llvm/Support/raw_ostream.h" 32#include "llvm/Support/Program.h" 33#include <cstdlib> 34#include <cstdio> 35 36 37#ifdef UDP_CODE_COMPLETION_LOGGER 38#include "clang/Basic/Version.h" 39#include <arpa/inet.h> 40#include <sys/socket.h> 41#include <sys/types.h> 42#include <unistd.h> 43#endif 44 45using namespace clang; 46using namespace clang::cxstring; 47 48extern "C" { 49 50enum CXCompletionChunkKind 51clang_getCompletionChunkKind(CXCompletionString completion_string, 52 unsigned chunk_number) { 53 CodeCompletionString *CCStr = (CodeCompletionString *)completion_string; 54 if (!CCStr || chunk_number >= CCStr->size()) 55 return CXCompletionChunk_Text; 56 57 switch ((*CCStr)[chunk_number].Kind) { 58 case CodeCompletionString::CK_TypedText: 59 return CXCompletionChunk_TypedText; 60 case CodeCompletionString::CK_Text: 61 return CXCompletionChunk_Text; 62 case CodeCompletionString::CK_Optional: 63 return CXCompletionChunk_Optional; 64 case CodeCompletionString::CK_Placeholder: 65 return CXCompletionChunk_Placeholder; 66 case CodeCompletionString::CK_Informative: 67 return CXCompletionChunk_Informative; 68 case CodeCompletionString::CK_ResultType: 69 return CXCompletionChunk_ResultType; 70 case CodeCompletionString::CK_CurrentParameter: 71 return CXCompletionChunk_CurrentParameter; 72 case CodeCompletionString::CK_LeftParen: 73 return CXCompletionChunk_LeftParen; 74 case CodeCompletionString::CK_RightParen: 75 return CXCompletionChunk_RightParen; 76 case CodeCompletionString::CK_LeftBracket: 77 return CXCompletionChunk_LeftBracket; 78 case CodeCompletionString::CK_RightBracket: 79 return CXCompletionChunk_RightBracket; 80 case CodeCompletionString::CK_LeftBrace: 81 return CXCompletionChunk_LeftBrace; 82 case CodeCompletionString::CK_RightBrace: 83 return CXCompletionChunk_RightBrace; 84 case CodeCompletionString::CK_LeftAngle: 85 return CXCompletionChunk_LeftAngle; 86 case CodeCompletionString::CK_RightAngle: 87 return CXCompletionChunk_RightAngle; 88 case CodeCompletionString::CK_Comma: 89 return CXCompletionChunk_Comma; 90 case CodeCompletionString::CK_Colon: 91 return CXCompletionChunk_Colon; 92 case CodeCompletionString::CK_SemiColon: 93 return CXCompletionChunk_SemiColon; 94 case CodeCompletionString::CK_Equal: 95 return CXCompletionChunk_Equal; 96 case CodeCompletionString::CK_HorizontalSpace: 97 return CXCompletionChunk_HorizontalSpace; 98 case CodeCompletionString::CK_VerticalSpace: 99 return CXCompletionChunk_VerticalSpace; 100 } 101 102 // Should be unreachable, but let's be careful. 103 return CXCompletionChunk_Text; 104} 105 106CXString clang_getCompletionChunkText(CXCompletionString completion_string, 107 unsigned chunk_number) { 108 CodeCompletionString *CCStr = (CodeCompletionString *)completion_string; 109 if (!CCStr || chunk_number >= CCStr->size()) 110 return createCXString((const char*)0); 111 112 switch ((*CCStr)[chunk_number].Kind) { 113 case CodeCompletionString::CK_TypedText: 114 case CodeCompletionString::CK_Text: 115 case CodeCompletionString::CK_Placeholder: 116 case CodeCompletionString::CK_CurrentParameter: 117 case CodeCompletionString::CK_Informative: 118 case CodeCompletionString::CK_LeftParen: 119 case CodeCompletionString::CK_RightParen: 120 case CodeCompletionString::CK_LeftBracket: 121 case CodeCompletionString::CK_RightBracket: 122 case CodeCompletionString::CK_LeftBrace: 123 case CodeCompletionString::CK_RightBrace: 124 case CodeCompletionString::CK_LeftAngle: 125 case CodeCompletionString::CK_RightAngle: 126 case CodeCompletionString::CK_Comma: 127 case CodeCompletionString::CK_ResultType: 128 case CodeCompletionString::CK_Colon: 129 case CodeCompletionString::CK_SemiColon: 130 case CodeCompletionString::CK_Equal: 131 case CodeCompletionString::CK_HorizontalSpace: 132 case CodeCompletionString::CK_VerticalSpace: 133 return createCXString((*CCStr)[chunk_number].Text, false); 134 135 case CodeCompletionString::CK_Optional: 136 // Note: treated as an empty text block. 137 return createCXString(""); 138 } 139 140 // Should be unreachable, but let's be careful. 141 return createCXString((const char*)0); 142} 143 144 145CXCompletionString 146clang_getCompletionChunkCompletionString(CXCompletionString completion_string, 147 unsigned chunk_number) { 148 CodeCompletionString *CCStr = (CodeCompletionString *)completion_string; 149 if (!CCStr || chunk_number >= CCStr->size()) 150 return 0; 151 152 switch ((*CCStr)[chunk_number].Kind) { 153 case CodeCompletionString::CK_TypedText: 154 case CodeCompletionString::CK_Text: 155 case CodeCompletionString::CK_Placeholder: 156 case CodeCompletionString::CK_CurrentParameter: 157 case CodeCompletionString::CK_Informative: 158 case CodeCompletionString::CK_LeftParen: 159 case CodeCompletionString::CK_RightParen: 160 case CodeCompletionString::CK_LeftBracket: 161 case CodeCompletionString::CK_RightBracket: 162 case CodeCompletionString::CK_LeftBrace: 163 case CodeCompletionString::CK_RightBrace: 164 case CodeCompletionString::CK_LeftAngle: 165 case CodeCompletionString::CK_RightAngle: 166 case CodeCompletionString::CK_Comma: 167 case CodeCompletionString::CK_ResultType: 168 case CodeCompletionString::CK_Colon: 169 case CodeCompletionString::CK_SemiColon: 170 case CodeCompletionString::CK_Equal: 171 case CodeCompletionString::CK_HorizontalSpace: 172 case CodeCompletionString::CK_VerticalSpace: 173 return 0; 174 175 case CodeCompletionString::CK_Optional: 176 // Note: treated as an empty text block. 177 return (*CCStr)[chunk_number].Optional; 178 } 179 180 // Should be unreachable, but let's be careful. 181 return 0; 182} 183 184unsigned clang_getNumCompletionChunks(CXCompletionString completion_string) { 185 CodeCompletionString *CCStr = (CodeCompletionString *)completion_string; 186 return CCStr? CCStr->size() : 0; 187} 188 189unsigned clang_getCompletionPriority(CXCompletionString completion_string) { 190 CodeCompletionString *CCStr = (CodeCompletionString *)completion_string; 191 return CCStr? CCStr->getPriority() : unsigned(CCP_Unlikely); 192} 193 194enum CXAvailabilityKind 195clang_getCompletionAvailability(CXCompletionString completion_string) { 196 CodeCompletionString *CCStr = (CodeCompletionString *)completion_string; 197 return CCStr? static_cast<CXAvailabilityKind>(CCStr->getAvailability()) 198 : CXAvailability_Available; 199} 200 201/// \brief The CXCodeCompleteResults structure we allocate internally; 202/// the client only sees the initial CXCodeCompleteResults structure. 203struct AllocatedCXCodeCompleteResults : public CXCodeCompleteResults { 204 AllocatedCXCodeCompleteResults(); 205 ~AllocatedCXCodeCompleteResults(); 206 207 /// \brief Diagnostics produced while performing code completion. 208 llvm::SmallVector<StoredDiagnostic, 8> Diagnostics; 209 210 /// \brief Diag object 211 llvm::IntrusiveRefCntPtr<Diagnostic> Diag; 212 213 /// \brief Language options used to adjust source locations. 214 LangOptions LangOpts; 215 216 FileSystemOptions FileSystemOpts; 217 218 /// \brief File manager, used for diagnostics. 219 FileManager FileMgr; 220 221 /// \brief Source manager, used for diagnostics. 222 SourceManager SourceMgr; 223 224 /// \brief Temporary files that should be removed once we have finished 225 /// with the code-completion results. 226 std::vector<llvm::sys::Path> TemporaryFiles; 227 228 /// \brief Temporary buffers that will be deleted once we have finished with 229 /// the code-completion results. 230 llvm::SmallVector<const llvm::MemoryBuffer *, 1> TemporaryBuffers; 231 232 /// \brief Allocator used to store code completion results. 233 clang::CodeCompletionAllocator CodeCompletionAllocator; 234}; 235 236/// \brief Tracks the number of code-completion result objects that are 237/// currently active. 238/// 239/// Used for debugging purposes only. 240static llvm::sys::cas_flag CodeCompletionResultObjects; 241 242AllocatedCXCodeCompleteResults::AllocatedCXCodeCompleteResults() 243 : CXCodeCompleteResults(), 244 Diag(new Diagnostic( 245 llvm::IntrusiveRefCntPtr<DiagnosticIDs>(new DiagnosticIDs))), 246 FileMgr(FileSystemOpts), 247 SourceMgr(*Diag, FileMgr) { 248 if (getenv("LIBCLANG_OBJTRACKING")) { 249 llvm::sys::AtomicIncrement(&CodeCompletionResultObjects); 250 fprintf(stderr, "+++ %d completion results\n", CodeCompletionResultObjects); 251 } 252} 253 254AllocatedCXCodeCompleteResults::~AllocatedCXCodeCompleteResults() { 255 delete [] Results; 256 257 for (unsigned I = 0, N = TemporaryFiles.size(); I != N; ++I) 258 TemporaryFiles[I].eraseFromDisk(); 259 for (unsigned I = 0, N = TemporaryBuffers.size(); I != N; ++I) 260 delete TemporaryBuffers[I]; 261 262 if (getenv("LIBCLANG_OBJTRACKING")) { 263 llvm::sys::AtomicDecrement(&CodeCompletionResultObjects); 264 fprintf(stderr, "--- %d completion results\n", CodeCompletionResultObjects); 265 } 266} 267 268} // end extern "C" 269 270namespace { 271 class CaptureCompletionResults : public CodeCompleteConsumer { 272 AllocatedCXCodeCompleteResults &AllocatedResults; 273 llvm::SmallVector<CXCompletionResult, 16> StoredResults; 274 public: 275 CaptureCompletionResults(AllocatedCXCodeCompleteResults &Results) 276 : CodeCompleteConsumer(true, false, true, false), 277 AllocatedResults(Results) { } 278 ~CaptureCompletionResults() { Finish(); } 279 280 virtual void ProcessCodeCompleteResults(Sema &S, 281 CodeCompletionContext Context, 282 CodeCompletionResult *Results, 283 unsigned NumResults) { 284 StoredResults.reserve(StoredResults.size() + NumResults); 285 for (unsigned I = 0; I != NumResults; ++I) { 286 CodeCompletionString *StoredCompletion 287 = Results[I].CreateCodeCompletionString(S, 288 AllocatedResults.CodeCompletionAllocator); 289 290 CXCompletionResult R; 291 R.CursorKind = Results[I].CursorKind; 292 R.CompletionString = StoredCompletion; 293 StoredResults.push_back(R); 294 } 295 } 296 297 virtual void ProcessOverloadCandidates(Sema &S, unsigned CurrentArg, 298 OverloadCandidate *Candidates, 299 unsigned NumCandidates) { 300 StoredResults.reserve(StoredResults.size() + NumCandidates); 301 for (unsigned I = 0; I != NumCandidates; ++I) { 302 CodeCompletionString *StoredCompletion 303 = Candidates[I].CreateSignatureString(CurrentArg, S, 304 AllocatedResults.CodeCompletionAllocator); 305 306 CXCompletionResult R; 307 R.CursorKind = CXCursor_NotImplemented; 308 R.CompletionString = StoredCompletion; 309 StoredResults.push_back(R); 310 } 311 } 312 313 virtual CodeCompletionAllocator &getAllocator() { 314 return AllocatedResults.CodeCompletionAllocator; 315 } 316 317 private: 318 void Finish() { 319 AllocatedResults.Results = new CXCompletionResult [StoredResults.size()]; 320 AllocatedResults.NumResults = StoredResults.size(); 321 std::memcpy(AllocatedResults.Results, StoredResults.data(), 322 StoredResults.size() * sizeof(CXCompletionResult)); 323 StoredResults.clear(); 324 } 325 }; 326} 327 328extern "C" { 329struct CodeCompleteAtInfo { 330 CXTranslationUnit TU; 331 const char *complete_filename; 332 unsigned complete_line; 333 unsigned complete_column; 334 struct CXUnsavedFile *unsaved_files; 335 unsigned num_unsaved_files; 336 unsigned options; 337 CXCodeCompleteResults *result; 338}; 339void clang_codeCompleteAt_Impl(void *UserData) { 340 CodeCompleteAtInfo *CCAI = static_cast<CodeCompleteAtInfo*>(UserData); 341 CXTranslationUnit TU = CCAI->TU; 342 const char *complete_filename = CCAI->complete_filename; 343 unsigned complete_line = CCAI->complete_line; 344 unsigned complete_column = CCAI->complete_column; 345 struct CXUnsavedFile *unsaved_files = CCAI->unsaved_files; 346 unsigned num_unsaved_files = CCAI->num_unsaved_files; 347 unsigned options = CCAI->options; 348 CCAI->result = 0; 349 350#ifdef UDP_CODE_COMPLETION_LOGGER 351#ifdef UDP_CODE_COMPLETION_LOGGER_PORT 352 const llvm::TimeRecord &StartTime = llvm::TimeRecord::getCurrentTime(); 353#endif 354#endif 355 356 bool EnableLogging = getenv("LIBCLANG_CODE_COMPLETION_LOGGING") != 0; 357 358 ASTUnit *AST = static_cast<ASTUnit *>(TU->TUData); 359 if (!AST) 360 return; 361 362 ASTUnit::ConcurrencyCheck Check(*AST); 363 364 // Perform the remapping of source files. 365 llvm::SmallVector<ASTUnit::RemappedFile, 4> RemappedFiles; 366 for (unsigned I = 0; I != num_unsaved_files; ++I) { 367 llvm::StringRef Data(unsaved_files[I].Contents, unsaved_files[I].Length); 368 const llvm::MemoryBuffer *Buffer 369 = llvm::MemoryBuffer::getMemBufferCopy(Data, unsaved_files[I].Filename); 370 RemappedFiles.push_back(std::make_pair(unsaved_files[I].Filename, 371 Buffer)); 372 } 373 374 if (EnableLogging) { 375 // FIXME: Add logging. 376 } 377 378 // Parse the resulting source file to find code-completion results. 379 AllocatedCXCodeCompleteResults *Results = new AllocatedCXCodeCompleteResults; 380 Results->Results = 0; 381 Results->NumResults = 0; 382 383 // Create a code-completion consumer to capture the results. 384 CaptureCompletionResults Capture(*Results); 385 386 // Perform completion. 387 AST->CodeComplete(complete_filename, complete_line, complete_column, 388 RemappedFiles.data(), RemappedFiles.size(), 389 (options & CXCodeComplete_IncludeMacros), 390 (options & CXCodeComplete_IncludeCodePatterns), 391 Capture, 392 *Results->Diag, Results->LangOpts, Results->SourceMgr, 393 Results->FileMgr, Results->Diagnostics, 394 Results->TemporaryBuffers); 395 396 397 398#ifdef UDP_CODE_COMPLETION_LOGGER 399#ifdef UDP_CODE_COMPLETION_LOGGER_PORT 400 const llvm::TimeRecord &EndTime = llvm::TimeRecord::getCurrentTime(); 401 llvm::SmallString<256> LogResult; 402 llvm::raw_svector_ostream os(LogResult); 403 404 // Figure out the language and whether or not it uses PCH. 405 const char *lang = 0; 406 bool usesPCH = false; 407 408 for (std::vector<const char*>::iterator I = argv.begin(), E = argv.end(); 409 I != E; ++I) { 410 if (*I == 0) 411 continue; 412 if (strcmp(*I, "-x") == 0) { 413 if (I + 1 != E) { 414 lang = *(++I); 415 continue; 416 } 417 } 418 else if (strcmp(*I, "-include") == 0) { 419 if (I+1 != E) { 420 const char *arg = *(++I); 421 llvm::SmallString<512> pchName; 422 { 423 llvm::raw_svector_ostream os(pchName); 424 os << arg << ".pth"; 425 } 426 pchName.push_back('\0'); 427 struct stat stat_results; 428 if (stat(pchName.data(), &stat_results) == 0) 429 usesPCH = true; 430 continue; 431 } 432 } 433 } 434 435 os << "{ "; 436 os << "\"wall\": " << (EndTime.getWallTime() - StartTime.getWallTime()); 437 os << ", \"numRes\": " << Results->NumResults; 438 os << ", \"diags\": " << Results->Diagnostics.size(); 439 os << ", \"pch\": " << (usesPCH ? "true" : "false"); 440 os << ", \"lang\": \"" << (lang ? lang : "<unknown>") << '"'; 441 const char *name = getlogin(); 442 os << ", \"user\": \"" << (name ? name : "unknown") << '"'; 443 os << ", \"clangVer\": \"" << getClangFullVersion() << '"'; 444 os << " }"; 445 446 llvm::StringRef res = os.str(); 447 if (res.size() > 0) { 448 do { 449 // Setup the UDP socket. 450 struct sockaddr_in servaddr; 451 bzero(&servaddr, sizeof(servaddr)); 452 servaddr.sin_family = AF_INET; 453 servaddr.sin_port = htons(UDP_CODE_COMPLETION_LOGGER_PORT); 454 if (inet_pton(AF_INET, UDP_CODE_COMPLETION_LOGGER, 455 &servaddr.sin_addr) <= 0) 456 break; 457 458 int sockfd = socket(AF_INET, SOCK_DGRAM, 0); 459 if (sockfd < 0) 460 break; 461 462 sendto(sockfd, res.data(), res.size(), 0, 463 (struct sockaddr *)&servaddr, sizeof(servaddr)); 464 close(sockfd); 465 } 466 while (false); 467 } 468#endif 469#endif 470 CCAI->result = Results; 471} 472CXCodeCompleteResults *clang_codeCompleteAt(CXTranslationUnit TU, 473 const char *complete_filename, 474 unsigned complete_line, 475 unsigned complete_column, 476 struct CXUnsavedFile *unsaved_files, 477 unsigned num_unsaved_files, 478 unsigned options) { 479 CodeCompleteAtInfo CCAI = { TU, complete_filename, complete_line, 480 complete_column, unsaved_files, num_unsaved_files, 481 options, 0 }; 482 llvm::CrashRecoveryContext CRC; 483 484 if (!RunSafely(CRC, clang_codeCompleteAt_Impl, &CCAI)) { 485 fprintf(stderr, "libclang: crash detected in code completion\n"); 486 static_cast<ASTUnit *>(TU->TUData)->setUnsafeToFree(true); 487 return 0; 488 } 489 490 return CCAI.result; 491} 492 493unsigned clang_defaultCodeCompleteOptions(void) { 494 return CXCodeComplete_IncludeMacros; 495} 496 497void clang_disposeCodeCompleteResults(CXCodeCompleteResults *ResultsIn) { 498 if (!ResultsIn) 499 return; 500 501 AllocatedCXCodeCompleteResults *Results 502 = static_cast<AllocatedCXCodeCompleteResults*>(ResultsIn); 503 delete Results; 504} 505 506unsigned 507clang_codeCompleteGetNumDiagnostics(CXCodeCompleteResults *ResultsIn) { 508 AllocatedCXCodeCompleteResults *Results 509 = static_cast<AllocatedCXCodeCompleteResults*>(ResultsIn); 510 if (!Results) 511 return 0; 512 513 return Results->Diagnostics.size(); 514} 515 516CXDiagnostic 517clang_codeCompleteGetDiagnostic(CXCodeCompleteResults *ResultsIn, 518 unsigned Index) { 519 AllocatedCXCodeCompleteResults *Results 520 = static_cast<AllocatedCXCodeCompleteResults*>(ResultsIn); 521 if (!Results || Index >= Results->Diagnostics.size()) 522 return 0; 523 524 return new CXStoredDiagnostic(Results->Diagnostics[Index], Results->LangOpts); 525} 526 527 528} // end extern "C" 529 530/// \brief Simple utility function that appends a \p New string to the given 531/// \p Old string, using the \p Buffer for storage. 532/// 533/// \param Old The string to which we are appending. This parameter will be 534/// updated to reflect the complete string. 535/// 536/// 537/// \param New The string to append to \p Old. 538/// 539/// \param Buffer A buffer that stores the actual, concatenated string. It will 540/// be used if the old string is already-non-empty. 541static void AppendToString(llvm::StringRef &Old, llvm::StringRef New, 542 llvm::SmallString<256> &Buffer) { 543 if (Old.empty()) { 544 Old = New; 545 return; 546 } 547 548 if (Buffer.empty()) 549 Buffer.append(Old.begin(), Old.end()); 550 Buffer.append(New.begin(), New.end()); 551 Old = Buffer.str(); 552} 553 554/// \brief Get the typed-text blocks from the given code-completion string 555/// and return them as a single string. 556/// 557/// \param String The code-completion string whose typed-text blocks will be 558/// concatenated. 559/// 560/// \param Buffer A buffer used for storage of the completed name. 561static llvm::StringRef GetTypedName(CodeCompletionString *String, 562 llvm::SmallString<256> &Buffer) { 563 llvm::StringRef Result; 564 for (CodeCompletionString::iterator C = String->begin(), CEnd = String->end(); 565 C != CEnd; ++C) { 566 if (C->Kind == CodeCompletionString::CK_TypedText) 567 AppendToString(Result, C->Text, Buffer); 568 } 569 570 return Result; 571} 572 573namespace { 574 struct OrderCompletionResults { 575 bool operator()(const CXCompletionResult &XR, 576 const CXCompletionResult &YR) const { 577 CodeCompletionString *X 578 = (CodeCompletionString *)XR.CompletionString; 579 CodeCompletionString *Y 580 = (CodeCompletionString *)YR.CompletionString; 581 582 llvm::SmallString<256> XBuffer; 583 llvm::StringRef XText = GetTypedName(X, XBuffer); 584 llvm::SmallString<256> YBuffer; 585 llvm::StringRef YText = GetTypedName(Y, YBuffer); 586 587 if (XText.empty() || YText.empty()) 588 return !XText.empty(); 589 590 int result = XText.compare_lower(YText); 591 if (result < 0) 592 return true; 593 if (result > 0) 594 return false; 595 596 result = XText.compare(YText); 597 return result < 0; 598 } 599 }; 600} 601 602extern "C" { 603 void clang_sortCodeCompletionResults(CXCompletionResult *Results, 604 unsigned NumResults) { 605 std::stable_sort(Results, Results + NumResults, OrderCompletionResults()); 606 } 607} 608