1 //===--- CodeCompleteConsumer.cpp - Code Completion Interface ---*- 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 file implements the CodeCompleteConsumer class.
12 //===----------------------------------------------------------------------===//
13 #include "clang/Sema/CodeCompleteConsumer.h"
14 #include "clang-c/Index.h"
15 #include "clang/AST/DeclCXX.h"
16 #include "clang/AST/DeclObjC.h"
17 #include "clang/AST/DeclTemplate.h"
18 #include "clang/Sema/Scope.h"
19 #include "clang/Sema/Sema.h"
20 #include "llvm/ADT/STLExtras.h"
21 #include "llvm/ADT/SmallString.h"
22 #include "llvm/ADT/Twine.h"
23 #include "llvm/Support/raw_ostream.h"
28 using namespace clang;
30 //===----------------------------------------------------------------------===//
31 // Code completion context implementation
32 //===----------------------------------------------------------------------===//
34 bool CodeCompletionContext::wantConstructorResults() const {
39 case CCC_ObjCMessageReceiver:
40 case CCC_ParenthesizedExpression:
44 case CCC_ObjCInterface:
45 case CCC_ObjCImplementation:
46 case CCC_ObjCIvarList:
47 case CCC_ClassStructUnion:
48 case CCC_DotMemberAccess:
49 case CCC_ArrowMemberAccess:
50 case CCC_ObjCPropertyAccess:
53 case CCC_ClassOrStructTag:
54 case CCC_ObjCProtocolName:
58 case CCC_PotentiallyQualifiedName:
60 case CCC_MacroNameUse:
61 case CCC_PreprocessorExpression:
62 case CCC_PreprocessorDirective:
63 case CCC_NaturalLanguage:
64 case CCC_SelectorName:
65 case CCC_TypeQualifiers:
67 case CCC_OtherWithMacros:
68 case CCC_ObjCInstanceMessage:
69 case CCC_ObjCClassMessage:
70 case CCC_ObjCInterfaceName:
71 case CCC_ObjCCategoryName:
75 llvm_unreachable("Invalid CodeCompletionContext::Kind!");
78 //===----------------------------------------------------------------------===//
79 // Code completion string implementation
80 //===----------------------------------------------------------------------===//
81 CodeCompletionString::Chunk::Chunk(ChunkKind Kind, const char *Text)
82 : Kind(Kind), Text("")
90 case CK_CurrentParameter:
95 llvm_unreachable("Optional strings cannot be created from text");
109 case CK_RightBracket:
145 case CK_HorizontalSpace:
149 case CK_VerticalSpace:
155 CodeCompletionString::Chunk
156 CodeCompletionString::Chunk::CreateText(const char *Text) {
157 return Chunk(CK_Text, Text);
160 CodeCompletionString::Chunk
161 CodeCompletionString::Chunk::CreateOptional(CodeCompletionString *Optional) {
163 Result.Kind = CK_Optional;
164 Result.Optional = Optional;
168 CodeCompletionString::Chunk
169 CodeCompletionString::Chunk::CreatePlaceholder(const char *Placeholder) {
170 return Chunk(CK_Placeholder, Placeholder);
173 CodeCompletionString::Chunk
174 CodeCompletionString::Chunk::CreateInformative(const char *Informative) {
175 return Chunk(CK_Informative, Informative);
178 CodeCompletionString::Chunk
179 CodeCompletionString::Chunk::CreateResultType(const char *ResultType) {
180 return Chunk(CK_ResultType, ResultType);
183 CodeCompletionString::Chunk
184 CodeCompletionString::Chunk::CreateCurrentParameter(
185 const char *CurrentParameter) {
186 return Chunk(CK_CurrentParameter, CurrentParameter);
189 CodeCompletionString::CodeCompletionString(const Chunk *Chunks,
192 CXAvailabilityKind Availability,
193 const char **Annotations,
194 unsigned NumAnnotations,
195 StringRef ParentName,
196 const char *BriefComment)
197 : NumChunks(NumChunks), NumAnnotations(NumAnnotations),
198 Priority(Priority), Availability(Availability),
199 ParentName(ParentName), BriefComment(BriefComment)
201 assert(NumChunks <= 0xffff);
202 assert(NumAnnotations <= 0xffff);
204 Chunk *StoredChunks = reinterpret_cast<Chunk *>(this + 1);
205 for (unsigned I = 0; I != NumChunks; ++I)
206 StoredChunks[I] = Chunks[I];
208 const char **StoredAnnotations = reinterpret_cast<const char **>(StoredChunks + NumChunks);
209 for (unsigned I = 0; I != NumAnnotations; ++I)
210 StoredAnnotations[I] = Annotations[I];
213 unsigned CodeCompletionString::getAnnotationCount() const {
214 return NumAnnotations;
217 const char *CodeCompletionString::getAnnotation(unsigned AnnotationNr) const {
218 if (AnnotationNr < NumAnnotations)
219 return reinterpret_cast<const char * const*>(end())[AnnotationNr];
225 std::string CodeCompletionString::getAsString() const {
227 llvm::raw_string_ostream OS(Result);
229 for (iterator C = begin(), CEnd = end(); C != CEnd; ++C) {
231 case CK_Optional: OS << "{#" << C->Optional->getAsString() << "#}"; break;
232 case CK_Placeholder: OS << "<#" << C->Text << "#>"; break;
236 OS << "[#" << C->Text << "#]";
239 case CK_CurrentParameter: OS << "<#" << C->Text << "#>"; break;
240 default: OS << C->Text; break;
246 const char *CodeCompletionString::getTypedText() const {
247 for (iterator C = begin(), CEnd = end(); C != CEnd; ++C)
248 if (C->Kind == CK_TypedText)
254 const char *CodeCompletionAllocator::CopyString(StringRef String) {
255 char *Mem = (char *)Allocate(String.size() + 1, 1);
256 std::copy(String.begin(), String.end(), Mem);
257 Mem[String.size()] = 0;
261 const char *CodeCompletionAllocator::CopyString(Twine String) {
262 // FIXME: It would be more efficient to teach Twine to tell us its size and
263 // then add a routine there to fill in an allocated char* with the contents
265 SmallString<128> Data;
266 return CopyString(String.toStringRef(Data));
269 StringRef CodeCompletionTUInfo::getParentName(const DeclContext *DC) {
270 const NamedDecl *ND = dyn_cast<NamedDecl>(DC);
274 // Check whether we've already cached the parent name.
275 StringRef &CachedParentName = ParentNames[DC];
276 if (!CachedParentName.empty())
277 return CachedParentName;
279 // If we already processed this DeclContext and assigned empty to it, the
280 // data pointer will be non-null.
281 if (CachedParentName.data() != nullptr)
284 // Find the interesting names.
285 SmallVector<const DeclContext *, 2> Contexts;
286 while (DC && !DC->isFunctionOrMethod()) {
287 if (const NamedDecl *ND = dyn_cast<NamedDecl>(DC)) {
288 if (ND->getIdentifier())
289 Contexts.push_back(DC);
292 DC = DC->getParent();
297 llvm::raw_svector_ostream OS(S);
299 for (unsigned I = Contexts.size(); I != 0; --I) {
306 const DeclContext *CurDC = Contexts[I-1];
307 if (const ObjCCategoryImplDecl *CatImpl = dyn_cast<ObjCCategoryImplDecl>(CurDC))
308 CurDC = CatImpl->getCategoryDecl();
310 if (const ObjCCategoryDecl *Cat = dyn_cast<ObjCCategoryDecl>(CurDC)) {
311 const ObjCInterfaceDecl *Interface = Cat->getClassInterface();
313 // Assign an empty StringRef but with non-null data to distinguish
314 // between empty because we didn't process the DeclContext yet.
315 CachedParentName = StringRef((const char *)~0U, 0);
319 OS << Interface->getName() << '(' << Cat->getName() << ')';
321 OS << cast<NamedDecl>(CurDC)->getName();
325 CachedParentName = AllocatorRef->CopyString(OS.str());
328 return CachedParentName;
331 CodeCompletionString *CodeCompletionBuilder::TakeString() {
332 void *Mem = getAllocator().Allocate(
333 sizeof(CodeCompletionString) + sizeof(Chunk) * Chunks.size()
334 + sizeof(const char *) * Annotations.size(),
335 llvm::alignOf<CodeCompletionString>());
336 CodeCompletionString *Result
337 = new (Mem) CodeCompletionString(Chunks.data(), Chunks.size(),
338 Priority, Availability,
339 Annotations.data(), Annotations.size(),
340 ParentName, BriefComment);
345 void CodeCompletionBuilder::AddTypedTextChunk(const char *Text) {
346 Chunks.push_back(Chunk(CodeCompletionString::CK_TypedText, Text));
349 void CodeCompletionBuilder::AddTextChunk(const char *Text) {
350 Chunks.push_back(Chunk::CreateText(Text));
353 void CodeCompletionBuilder::AddOptionalChunk(CodeCompletionString *Optional) {
354 Chunks.push_back(Chunk::CreateOptional(Optional));
357 void CodeCompletionBuilder::AddPlaceholderChunk(const char *Placeholder) {
358 Chunks.push_back(Chunk::CreatePlaceholder(Placeholder));
361 void CodeCompletionBuilder::AddInformativeChunk(const char *Text) {
362 Chunks.push_back(Chunk::CreateInformative(Text));
365 void CodeCompletionBuilder::AddResultTypeChunk(const char *ResultType) {
366 Chunks.push_back(Chunk::CreateResultType(ResultType));
370 CodeCompletionBuilder::AddCurrentParameterChunk(const char *CurrentParameter) {
371 Chunks.push_back(Chunk::CreateCurrentParameter(CurrentParameter));
374 void CodeCompletionBuilder::AddChunk(CodeCompletionString::ChunkKind CK,
376 Chunks.push_back(Chunk(CK, Text));
379 void CodeCompletionBuilder::addParentContext(const DeclContext *DC) {
380 if (DC->isTranslationUnit()) {
384 if (DC->isFunctionOrMethod())
387 const NamedDecl *ND = dyn_cast<NamedDecl>(DC);
391 ParentName = getCodeCompletionTUInfo().getParentName(DC);
394 void CodeCompletionBuilder::addBriefComment(StringRef Comment) {
395 BriefComment = Allocator.CopyString(Comment);
398 //===----------------------------------------------------------------------===//
399 // Code completion overload candidate implementation
400 //===----------------------------------------------------------------------===//
402 CodeCompleteConsumer::OverloadCandidate::getFunction() const {
403 if (getKind() == CK_Function)
405 else if (getKind() == CK_FunctionTemplate)
406 return FunctionTemplate->getTemplatedDecl();
412 CodeCompleteConsumer::OverloadCandidate::getFunctionType() const {
415 return Function->getType()->getAs<FunctionType>();
417 case CK_FunctionTemplate:
418 return FunctionTemplate->getTemplatedDecl()->getType()
419 ->getAs<FunctionType>();
421 case CK_FunctionType:
425 llvm_unreachable("Invalid CandidateKind!");
428 //===----------------------------------------------------------------------===//
429 // Code completion consumer implementation
430 //===----------------------------------------------------------------------===//
432 CodeCompleteConsumer::~CodeCompleteConsumer() { }
435 PrintingCodeCompleteConsumer::ProcessCodeCompleteResults(Sema &SemaRef,
436 CodeCompletionContext Context,
437 CodeCompletionResult *Results,
438 unsigned NumResults) {
439 std::stable_sort(Results, Results + NumResults);
441 // Print the results.
442 for (unsigned I = 0; I != NumResults; ++I) {
443 OS << "COMPLETION: ";
444 switch (Results[I].Kind) {
445 case CodeCompletionResult::RK_Declaration:
446 OS << *Results[I].Declaration;
447 if (Results[I].Hidden)
449 if (CodeCompletionString *CCS
450 = Results[I].CreateCodeCompletionString(SemaRef, getAllocator(),
452 includeBriefComments())) {
453 OS << " : " << CCS->getAsString();
454 if (const char *BriefComment = CCS->getBriefComment())
455 OS << " : " << BriefComment;
461 case CodeCompletionResult::RK_Keyword:
462 OS << Results[I].Keyword << '\n';
465 case CodeCompletionResult::RK_Macro: {
466 OS << Results[I].Macro->getName();
467 if (CodeCompletionString *CCS
468 = Results[I].CreateCodeCompletionString(SemaRef, getAllocator(),
470 includeBriefComments())) {
471 OS << " : " << CCS->getAsString();
477 case CodeCompletionResult::RK_Pattern: {
479 << Results[I].Pattern->getAsString() << '\n';
487 PrintingCodeCompleteConsumer::ProcessOverloadCandidates(Sema &SemaRef,
489 OverloadCandidate *Candidates,
490 unsigned NumCandidates) {
491 for (unsigned I = 0; I != NumCandidates; ++I) {
492 if (CodeCompletionString *CCS
493 = Candidates[I].CreateSignatureString(CurrentArg, SemaRef,
494 getAllocator(), CCTUInfo)) {
495 OS << "OVERLOAD: " << CCS->getAsString() << "\n";
500 /// \brief Retrieve the effective availability of the given declaration.
501 static AvailabilityResult getDeclAvailability(const Decl *D) {
502 AvailabilityResult AR = D->getAvailability();
503 if (isa<EnumConstantDecl>(D))
504 AR = std::max(AR, cast<Decl>(D->getDeclContext())->getAvailability());
508 void CodeCompletionResult::computeCursorKindAndAvailability(bool Accessible) {
512 // Do nothing: Patterns can come with cursor kinds!
517 case RK_Declaration: {
518 // Set the availability based on attributes.
519 switch (getDeclAvailability(Declaration)) {
521 case AR_NotYetIntroduced:
522 Availability = CXAvailability_Available;
526 Availability = CXAvailability_Deprecated;
530 Availability = CXAvailability_NotAvailable;
534 if (const FunctionDecl *Function = dyn_cast<FunctionDecl>(Declaration))
535 if (Function->isDeleted())
536 Availability = CXAvailability_NotAvailable;
538 CursorKind = getCursorKindForDecl(Declaration);
539 if (CursorKind == CXCursor_UnexposedDecl) {
540 // FIXME: Forward declarations of Objective-C classes and protocols
541 // are not directly exposed, but we want code completion to treat them
542 // like a definition.
543 if (isa<ObjCInterfaceDecl>(Declaration))
544 CursorKind = CXCursor_ObjCInterfaceDecl;
545 else if (isa<ObjCProtocolDecl>(Declaration))
546 CursorKind = CXCursor_ObjCProtocolDecl;
548 CursorKind = CXCursor_NotImplemented;
555 llvm_unreachable("Macro and keyword kinds are handled by the constructors");
559 Availability = CXAvailability_NotAccessible;
562 /// \brief Retrieve the name that should be used to order a result.
564 /// If the name needs to be constructed as a string, that string will be
565 /// saved into Saved and the returned StringRef will refer to it.
566 static StringRef getOrderedName(const CodeCompletionResult &R,
567 std::string &Saved) {
569 case CodeCompletionResult::RK_Keyword:
572 case CodeCompletionResult::RK_Pattern:
573 return R.Pattern->getTypedText();
575 case CodeCompletionResult::RK_Macro:
576 return R.Macro->getName();
578 case CodeCompletionResult::RK_Declaration:
579 // Handle declarations below.
583 DeclarationName Name = R.Declaration->getDeclName();
585 // If the name is a simple identifier (by far the common case), or a
586 // zero-argument selector, just return a reference to that identifier.
587 if (IdentifierInfo *Id = Name.getAsIdentifierInfo())
588 return Id->getName();
589 if (Name.isObjCZeroArgSelector())
590 if (IdentifierInfo *Id
591 = Name.getObjCSelector().getIdentifierInfoForSlot(0))
592 return Id->getName();
594 Saved = Name.getAsString();
598 bool clang::operator<(const CodeCompletionResult &X,
599 const CodeCompletionResult &Y) {
600 std::string XSaved, YSaved;
601 StringRef XStr = getOrderedName(X, XSaved);
602 StringRef YStr = getOrderedName(Y, YSaved);
603 int cmp = XStr.compare_lower(YStr);
607 // If case-insensitive comparison fails, try case-sensitive comparison.
608 cmp = XStr.compare(YStr);