1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
|
//===- CodeCompleteConsumer.cpp - Code Completion Interface ---------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
//
// This file implements the CodeCompleteConsumer class.
//
//===----------------------------------------------------------------------===//
#include "clang/Sema/CodeCompleteConsumer.h"
#include "clang-c/Index.h"
#include "clang/AST/Decl.h"
#include "clang/AST/DeclBase.h"
#include "clang/AST/DeclObjC.h"
#include "clang/AST/DeclTemplate.h"
#include "clang/AST/DeclarationName.h"
#include "clang/AST/Type.h"
#include "clang/Basic/IdentifierTable.h"
#include "clang/Lex/Preprocessor.h"
#include "clang/Sema/Sema.h"
#include "llvm/ADT/SmallString.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/StringExtras.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/ADT/Twine.h"
#include "llvm/Support/Casting.h"
#include "llvm/Support/Compiler.h"
#include "llvm/Support/ErrorHandling.h"
#include "llvm/Support/FormatVariadic.h"
#include "llvm/Support/raw_ostream.h"
#include <algorithm>
#include <cassert>
#include <cstdint>
#include <string>
using namespace clang;
//===----------------------------------------------------------------------===//
// Code completion context implementation
//===----------------------------------------------------------------------===//
bool CodeCompletionContext::wantConstructorResults() const {
switch (CCKind) {
case CCC_Recovery:
case CCC_Statement:
case CCC_Expression:
case CCC_ObjCMessageReceiver:
case CCC_ParenthesizedExpression:
case CCC_Symbol:
case CCC_SymbolOrNewName:
case CCC_TopLevelOrExpression:
return true;
case CCC_TopLevel:
case CCC_ObjCInterface:
case CCC_ObjCImplementation:
case CCC_ObjCIvarList:
case CCC_ClassStructUnion:
case CCC_DotMemberAccess:
case CCC_ArrowMemberAccess:
case CCC_ObjCPropertyAccess:
case CCC_EnumTag:
case CCC_UnionTag:
case CCC_ClassOrStructTag:
case CCC_ObjCProtocolName:
case CCC_Namespace:
case CCC_Type:
case CCC_NewName:
case CCC_MacroName:
case CCC_MacroNameUse:
case CCC_PreprocessorExpression:
case CCC_PreprocessorDirective:
case CCC_NaturalLanguage:
case CCC_SelectorName:
case CCC_TypeQualifiers:
case CCC_Other:
case CCC_OtherWithMacros:
case CCC_ObjCInstanceMessage:
case CCC_ObjCClassMessage:
case CCC_ObjCInterfaceName:
case CCC_ObjCCategoryName:
case CCC_IncludedFile:
case CCC_Attribute:
case CCC_ObjCClassForwardDecl:
return false;
}
llvm_unreachable("Invalid CodeCompletionContext::Kind!");
}
StringRef clang::getCompletionKindString(CodeCompletionContext::Kind Kind) {
using CCKind = CodeCompletionContext::Kind;
switch (Kind) {
case CCKind::CCC_Other:
return "Other";
case CCKind::CCC_OtherWithMacros:
return "OtherWithMacros";
case CCKind::CCC_TopLevel:
return "TopLevel";
case CCKind::CCC_ObjCInterface:
return "ObjCInterface";
case CCKind::CCC_ObjCImplementation:
return "ObjCImplementation";
case CCKind::CCC_ObjCIvarList:
return "ObjCIvarList";
case CCKind::CCC_ClassStructUnion:
return "ClassStructUnion";
case CCKind::CCC_Statement:
return "Statement";
case CCKind::CCC_Expression:
return "Expression";
case CCKind::CCC_ObjCMessageReceiver:
return "ObjCMessageReceiver";
case CCKind::CCC_DotMemberAccess:
return "DotMemberAccess";
case CCKind::CCC_ArrowMemberAccess:
return "ArrowMemberAccess";
case CCKind::CCC_ObjCPropertyAccess:
return "ObjCPropertyAccess";
case CCKind::CCC_EnumTag:
return "EnumTag";
case CCKind::CCC_UnionTag:
return "UnionTag";
case CCKind::CCC_ClassOrStructTag:
return "ClassOrStructTag";
case CCKind::CCC_ObjCProtocolName:
return "ObjCProtocolName";
case CCKind::CCC_Namespace:
return "Namespace";
case CCKind::CCC_Type:
return "Type";
case CCKind::CCC_NewName:
return "NewName";
case CCKind::CCC_Symbol:
return "Symbol";
case CCKind::CCC_SymbolOrNewName:
return "SymbolOrNewName";
case CCKind::CCC_MacroName:
return "MacroName";
case CCKind::CCC_MacroNameUse:
return "MacroNameUse";
case CCKind::CCC_PreprocessorExpression:
return "PreprocessorExpression";
case CCKind::CCC_PreprocessorDirective:
return "PreprocessorDirective";
case CCKind::CCC_NaturalLanguage:
return "NaturalLanguage";
case CCKind::CCC_SelectorName:
return "SelectorName";
case CCKind::CCC_TypeQualifiers:
return "TypeQualifiers";
case CCKind::CCC_ParenthesizedExpression:
return "ParenthesizedExpression";
case CCKind::CCC_ObjCInstanceMessage:
return "ObjCInstanceMessage";
case CCKind::CCC_ObjCClassMessage:
return "ObjCClassMessage";
case CCKind::CCC_ObjCInterfaceName:
return "ObjCInterfaceName";
case CCKind::CCC_ObjCCategoryName:
return "ObjCCategoryName";
case CCKind::CCC_IncludedFile:
return "IncludedFile";
case CCKind::CCC_Attribute:
return "Attribute";
case CCKind::CCC_Recovery:
return "Recovery";
case CCKind::CCC_ObjCClassForwardDecl:
return "ObjCClassForwardDecl";
case CCKind::CCC_TopLevelOrExpression:
return "ReplTopLevel";
}
llvm_unreachable("Invalid CodeCompletionContext::Kind!");
}
//===----------------------------------------------------------------------===//
// Code completion string implementation
//===----------------------------------------------------------------------===//
CodeCompletionString::Chunk::Chunk(ChunkKind Kind, const char *Text)
: Kind(Kind), Text("") {
switch (Kind) {
case CK_TypedText:
case CK_Text:
case CK_Placeholder:
case CK_Informative:
case CK_ResultType:
case CK_CurrentParameter:
this->Text = Text;
break;
case CK_Optional:
llvm_unreachable("Optional strings cannot be created from text");
case CK_LeftParen:
this->Text = "(";
break;
case CK_RightParen:
this->Text = ")";
break;
case CK_LeftBracket:
this->Text = "[";
break;
case CK_RightBracket:
this->Text = "]";
break;
case CK_LeftBrace:
this->Text = "{";
break;
case CK_RightBrace:
this->Text = "}";
break;
case CK_LeftAngle:
this->Text = "<";
break;
case CK_RightAngle:
this->Text = ">";
break;
case CK_Comma:
this->Text = ", ";
break;
case CK_Colon:
this->Text = ":";
break;
case CK_SemiColon:
this->Text = ";";
break;
case CK_Equal:
this->Text = " = ";
break;
case CK_HorizontalSpace:
this->Text = " ";
break;
case CK_VerticalSpace:
this->Text = "\n";
break;
}
}
CodeCompletionString::Chunk
CodeCompletionString::Chunk::CreateText(const char *Text) {
return Chunk(CK_Text, Text);
}
CodeCompletionString::Chunk
CodeCompletionString::Chunk::CreateOptional(CodeCompletionString *Optional) {
Chunk Result;
Result.Kind = CK_Optional;
Result.Optional = Optional;
return Result;
}
CodeCompletionString::Chunk
CodeCompletionString::Chunk::CreatePlaceholder(const char *Placeholder) {
return Chunk(CK_Placeholder, Placeholder);
}
CodeCompletionString::Chunk
CodeCompletionString::Chunk::CreateInformative(const char *Informative) {
return Chunk(CK_Informative, Informative);
}
CodeCompletionString::Chunk
CodeCompletionString::Chunk::CreateResultType(const char *ResultType) {
return Chunk(CK_ResultType, ResultType);
}
CodeCompletionString::Chunk CodeCompletionString::Chunk::CreateCurrentParameter(
const char *CurrentParameter) {
return Chunk(CK_CurrentParameter, CurrentParameter);
}
CodeCompletionString::CodeCompletionString(
const Chunk *Chunks, unsigned NumChunks, unsigned Priority,
CXAvailabilityKind Availability, const char **Annotations,
unsigned NumAnnotations, StringRef ParentName, const char *BriefComment)
: NumChunks(NumChunks), NumAnnotations(NumAnnotations), Priority(Priority),
Availability(Availability), ParentName(ParentName),
BriefComment(BriefComment) {
assert(NumChunks <= 0xffff);
assert(NumAnnotations <= 0xffff);
Chunk *StoredChunks = reinterpret_cast<Chunk *>(this + 1);
for (unsigned I = 0; I != NumChunks; ++I)
StoredChunks[I] = Chunks[I];
const char **StoredAnnotations =
reinterpret_cast<const char **>(StoredChunks + NumChunks);
for (unsigned I = 0; I != NumAnnotations; ++I)
StoredAnnotations[I] = Annotations[I];
}
unsigned CodeCompletionString::getAnnotationCount() const {
return NumAnnotations;
}
const char *CodeCompletionString::getAnnotation(unsigned AnnotationNr) const {
if (AnnotationNr < NumAnnotations)
return reinterpret_cast<const char *const *>(end())[AnnotationNr];
else
return nullptr;
}
std::string CodeCompletionString::getAsString() const {
std::string Result;
llvm::raw_string_ostream OS(Result);
for (const Chunk &C : *this) {
switch (C.Kind) {
case CK_Optional:
OS << "{#" << C.Optional->getAsString() << "#}";
break;
case CK_Placeholder:
OS << "<#" << C.Text << "#>";
break;
case CK_Informative:
case CK_ResultType:
OS << "[#" << C.Text << "#]";
break;
case CK_CurrentParameter:
OS << "<#" << C.Text << "#>";
break;
default:
OS << C.Text;
break;
}
}
return Result;
}
const char *CodeCompletionString::getTypedText() const {
for (const Chunk &C : *this)
if (C.Kind == CK_TypedText)
return C.Text;
return nullptr;
}
std::string CodeCompletionString::getAllTypedText() const {
std::string Res;
for (const Chunk &C : *this)
if (C.Kind == CK_TypedText)
Res += C.Text;
return Res;
}
const char *CodeCompletionAllocator::CopyString(const Twine &String) {
SmallString<128> Data;
StringRef Ref = String.toStringRef(Data);
// FIXME: It would be more efficient to teach Twine to tell us its size and
// then add a routine there to fill in an allocated char* with the contents
// of the string.
char *Mem = (char *)Allocate(Ref.size() + 1, 1);
std::copy(Ref.begin(), Ref.end(), Mem);
Mem[Ref.size()] = 0;
return Mem;
}
StringRef CodeCompletionTUInfo::getParentName(const DeclContext *DC) {
if (!isa<NamedDecl>(DC))
return {};
// Check whether we've already cached the parent name.
StringRef &CachedParentName = ParentNames[DC];
if (!CachedParentName.empty())
return CachedParentName;
// If we already processed this DeclContext and assigned empty to it, the
// data pointer will be non-null.
if (CachedParentName.data() != nullptr)
return {};
// Find the interesting names.
SmallVector<const DeclContext *, 2> Contexts;
while (DC && !DC->isFunctionOrMethod()) {
if (const auto *ND = dyn_cast<NamedDecl>(DC)) {
if (ND->getIdentifier())
Contexts.push_back(DC);
}
DC = DC->getParent();
}
{
SmallString<128> S;
llvm::raw_svector_ostream OS(S);
bool First = true;
for (const DeclContext *CurDC : llvm::reverse(Contexts)) {
if (First)
First = false;
else {
OS << "::";
}
if (const auto *CatImpl = dyn_cast<ObjCCategoryImplDecl>(CurDC))
CurDC = CatImpl->getCategoryDecl();
if (const auto *Cat = dyn_cast<ObjCCategoryDecl>(CurDC)) {
const ObjCInterfaceDecl *Interface = Cat->getClassInterface();
if (!Interface) {
// Assign an empty StringRef but with non-null data to distinguish
// between empty because we didn't process the DeclContext yet.
CachedParentName = StringRef((const char *)(uintptr_t)~0U, 0);
return {};
}
OS << Interface->getName() << '(' << Cat->getName() << ')';
} else {
OS << cast<NamedDecl>(CurDC)->getName();
}
}
CachedParentName = AllocatorRef->CopyString(OS.str());
}
return CachedParentName;
}
CodeCompletionString *CodeCompletionBuilder::TakeString() {
void *Mem = getAllocator().Allocate(
sizeof(CodeCompletionString) + sizeof(Chunk) * Chunks.size() +
sizeof(const char *) * Annotations.size(),
alignof(CodeCompletionString));
CodeCompletionString *Result = new (Mem) CodeCompletionString(
Chunks.data(), Chunks.size(), Priority, Availability, Annotations.data(),
Annotations.size(), ParentName, BriefComment);
Chunks.clear();
return Result;
}
void CodeCompletionBuilder::AddTypedTextChunk(const char *Text) {
Chunks.push_back(Chunk(CodeCompletionString::CK_TypedText, Text));
}
void CodeCompletionBuilder::AddTextChunk(const char *Text) {
Chunks.push_back(Chunk::CreateText(Text));
}
void CodeCompletionBuilder::AddOptionalChunk(CodeCompletionString *Optional) {
Chunks.push_back(Chunk::CreateOptional(Optional));
}
void CodeCompletionBuilder::AddPlaceholderChunk(const char *Placeholder) {
Chunks.push_back(Chunk::CreatePlaceholder(Placeholder));
}
void CodeCompletionBuilder::AddInformativeChunk(const char *Text) {
Chunks.push_back(Chunk::CreateInformative(Text));
}
void CodeCompletionBuilder::AddResultTypeChunk(const char *ResultType) {
Chunks.push_back(Chunk::CreateResultType(ResultType));
}
void CodeCompletionBuilder::AddCurrentParameterChunk(
const char *CurrentParameter) {
Chunks.push_back(Chunk::CreateCurrentParameter(CurrentParameter));
}
void CodeCompletionBuilder::AddChunk(CodeCompletionString::ChunkKind CK,
const char *Text) {
Chunks.push_back(Chunk(CK, Text));
}
void CodeCompletionBuilder::addParentContext(const DeclContext *DC) {
if (DC->isTranslationUnit())
return;
if (DC->isFunctionOrMethod())
return;
if (!isa<NamedDecl>(DC))
return;
ParentName = getCodeCompletionTUInfo().getParentName(DC);
}
void CodeCompletionBuilder::addBriefComment(StringRef Comment) {
BriefComment = Allocator.CopyString(Comment);
}
//===----------------------------------------------------------------------===//
// Code completion overload candidate implementation
//===----------------------------------------------------------------------===//
FunctionDecl *CodeCompleteConsumer::OverloadCandidate::getFunction() const {
if (getKind() == CK_Function)
return Function;
else if (getKind() == CK_FunctionTemplate)
return FunctionTemplate->getTemplatedDecl();
else
return nullptr;
}
const FunctionType *
CodeCompleteConsumer::OverloadCandidate::getFunctionType() const {
switch (Kind) {
case CK_Function:
return Function->getType()->getAs<FunctionType>();
case CK_FunctionTemplate:
return FunctionTemplate->getTemplatedDecl()
->getType()
->getAs<FunctionType>();
case CK_FunctionType:
return Type;
case CK_FunctionProtoTypeLoc:
return ProtoTypeLoc.getTypePtr();
case CK_Template:
case CK_Aggregate:
return nullptr;
}
llvm_unreachable("Invalid CandidateKind!");
}
const FunctionProtoTypeLoc
CodeCompleteConsumer::OverloadCandidate::getFunctionProtoTypeLoc() const {
if (Kind == CK_FunctionProtoTypeLoc)
return ProtoTypeLoc;
return FunctionProtoTypeLoc();
}
unsigned CodeCompleteConsumer::OverloadCandidate::getNumParams() const {
if (Kind == CK_Template)
return Template->getTemplateParameters()->size();
if (Kind == CK_Aggregate) {
unsigned Count =
std::distance(AggregateType->field_begin(), AggregateType->field_end());
if (const auto *CRD = dyn_cast<CXXRecordDecl>(AggregateType))
Count += CRD->getNumBases();
return Count;
}
if (const auto *FT = getFunctionType())
if (const auto *FPT = dyn_cast<FunctionProtoType>(FT))
return FPT->getNumParams();
return 0;
}
QualType
CodeCompleteConsumer::OverloadCandidate::getParamType(unsigned N) const {
if (Kind == CK_Aggregate) {
if (const auto *CRD = dyn_cast<CXXRecordDecl>(AggregateType)) {
if (N < CRD->getNumBases())
return std::next(CRD->bases_begin(), N)->getType();
N -= CRD->getNumBases();
}
for (const auto *Field : AggregateType->fields())
if (N-- == 0)
return Field->getType();
return QualType();
}
if (Kind == CK_Template) {
TemplateParameterList *TPL = getTemplate()->getTemplateParameters();
if (N < TPL->size())
if (const auto *D = dyn_cast<NonTypeTemplateParmDecl>(TPL->getParam(N)))
return D->getType();
return QualType();
}
if (const auto *FT = getFunctionType())
if (const auto *FPT = dyn_cast<FunctionProtoType>(FT))
if (N < FPT->getNumParams())
return FPT->getParamType(N);
return QualType();
}
const NamedDecl *
CodeCompleteConsumer::OverloadCandidate::getParamDecl(unsigned N) const {
if (Kind == CK_Aggregate) {
if (const auto *CRD = dyn_cast<CXXRecordDecl>(AggregateType)) {
if (N < CRD->getNumBases())
return std::next(CRD->bases_begin(), N)->getType()->getAsTagDecl();
N -= CRD->getNumBases();
}
for (const auto *Field : AggregateType->fields())
if (N-- == 0)
return Field;
return nullptr;
}
if (Kind == CK_Template) {
TemplateParameterList *TPL = getTemplate()->getTemplateParameters();
if (N < TPL->size())
return TPL->getParam(N);
return nullptr;
}
// Note that if we only have a FunctionProtoType, we don't have param decls.
if (const auto *FD = getFunction()) {
if (N < FD->param_size())
return FD->getParamDecl(N);
} else if (Kind == CK_FunctionProtoTypeLoc) {
if (N < ProtoTypeLoc.getNumParams()) {
return ProtoTypeLoc.getParam(N);
}
}
return nullptr;
}
//===----------------------------------------------------------------------===//
// Code completion consumer implementation
//===----------------------------------------------------------------------===//
CodeCompleteConsumer::~CodeCompleteConsumer() = default;
bool PrintingCodeCompleteConsumer::isResultFilteredOut(
StringRef Filter, CodeCompletionResult Result) {
switch (Result.Kind) {
case CodeCompletionResult::RK_Declaration:
return !(
Result.Declaration->getIdentifier() &&
Result.Declaration->getIdentifier()->getName().starts_with(Filter));
case CodeCompletionResult::RK_Keyword:
return !StringRef(Result.Keyword).starts_with(Filter);
case CodeCompletionResult::RK_Macro:
return !Result.Macro->getName().starts_with(Filter);
case CodeCompletionResult::RK_Pattern:
return !(Result.Pattern->getTypedText() &&
StringRef(Result.Pattern->getTypedText()).starts_with(Filter));
}
llvm_unreachable("Unknown code completion result Kind.");
}
void PrintingCodeCompleteConsumer::ProcessCodeCompleteResults(
Sema &SemaRef, CodeCompletionContext Context, CodeCompletionResult *Results,
unsigned NumResults) {
std::stable_sort(Results, Results + NumResults);
if (!Context.getPreferredType().isNull())
OS << "PREFERRED-TYPE: " << Context.getPreferredType() << '\n';
StringRef Filter = SemaRef.getPreprocessor().getCodeCompletionFilter();
// Print the completions.
for (unsigned I = 0; I != NumResults; ++I) {
if (!Filter.empty() && isResultFilteredOut(Filter, Results[I]))
continue;
OS << "COMPLETION: ";
switch (Results[I].Kind) {
case CodeCompletionResult::RK_Declaration:
OS << *Results[I].Declaration;
{
std::vector<std::string> Tags;
if (Results[I].Hidden)
Tags.push_back("Hidden");
if (Results[I].InBaseClass)
Tags.push_back("InBase");
if (Results[I].Availability ==
CXAvailabilityKind::CXAvailability_NotAccessible)
Tags.push_back("Inaccessible");
if (!Tags.empty())
OS << " (" << llvm::join(Tags, ",") << ")";
}
if (CodeCompletionString *CCS = Results[I].CreateCodeCompletionString(
SemaRef, Context, getAllocator(), CCTUInfo,
includeBriefComments())) {
OS << " : " << CCS->getAsString();
if (const char *BriefComment = CCS->getBriefComment())
OS << " : " << BriefComment;
}
break;
case CodeCompletionResult::RK_Keyword:
OS << Results[I].Keyword;
break;
case CodeCompletionResult::RK_Macro:
OS << Results[I].Macro->getName();
if (CodeCompletionString *CCS = Results[I].CreateCodeCompletionString(
SemaRef, Context, getAllocator(), CCTUInfo,
includeBriefComments())) {
OS << " : " << CCS->getAsString();
}
break;
case CodeCompletionResult::RK_Pattern:
OS << "Pattern : " << Results[I].Pattern->getAsString();
break;
}
for (const FixItHint &FixIt : Results[I].FixIts) {
const SourceLocation BLoc = FixIt.RemoveRange.getBegin();
const SourceLocation ELoc = FixIt.RemoveRange.getEnd();
SourceManager &SM = SemaRef.SourceMgr;
std::pair<FileID, unsigned> BInfo = SM.getDecomposedLoc(BLoc);
std::pair<FileID, unsigned> EInfo = SM.getDecomposedLoc(ELoc);
// Adjust for token ranges.
if (FixIt.RemoveRange.isTokenRange())
EInfo.second += Lexer::MeasureTokenLength(ELoc, SM, SemaRef.LangOpts);
OS << " (requires fix-it:"
<< " {" << SM.getLineNumber(BInfo.first, BInfo.second) << ':'
<< SM.getColumnNumber(BInfo.first, BInfo.second) << '-'
<< SM.getLineNumber(EInfo.first, EInfo.second) << ':'
<< SM.getColumnNumber(EInfo.first, EInfo.second) << "}"
<< " to \"" << FixIt.CodeToInsert << "\")";
}
OS << '\n';
}
}
// This function is used solely to preserve the former presentation of overloads
// by "clang -cc1 -code-completion-at", since CodeCompletionString::getAsString
// needs to be improved for printing the newer and more detailed overload
// chunks.
static std::string getOverloadAsString(const CodeCompletionString &CCS) {
std::string Result;
llvm::raw_string_ostream OS(Result);
for (auto &C : CCS) {
switch (C.Kind) {
case CodeCompletionString::CK_Informative:
case CodeCompletionString::CK_ResultType:
OS << "[#" << C.Text << "#]";
break;
case CodeCompletionString::CK_CurrentParameter:
OS << "<#" << C.Text << "#>";
break;
// FIXME: We can also print optional parameters of an overload.
case CodeCompletionString::CK_Optional:
break;
default:
OS << C.Text;
break;
}
}
return Result;
}
void PrintingCodeCompleteConsumer::ProcessOverloadCandidates(
Sema &SemaRef, unsigned CurrentArg, OverloadCandidate *Candidates,
unsigned NumCandidates, SourceLocation OpenParLoc, bool Braced) {
OS << "OPENING_PAREN_LOC: ";
OpenParLoc.print(OS, SemaRef.getSourceManager());
OS << "\n";
for (unsigned I = 0; I != NumCandidates; ++I) {
if (CodeCompletionString *CCS = Candidates[I].CreateSignatureString(
CurrentArg, SemaRef, getAllocator(), CCTUInfo,
includeBriefComments(), Braced)) {
OS << "OVERLOAD: " << getOverloadAsString(*CCS) << "\n";
}
}
}
/// Retrieve the effective availability of the given declaration.
static AvailabilityResult getDeclAvailability(const Decl *D) {
AvailabilityResult AR = D->getAvailability();
if (isa<EnumConstantDecl>(D))
AR = std::max(AR, cast<Decl>(D->getDeclContext())->getAvailability());
return AR;
}
void CodeCompletionResult::computeCursorKindAndAvailability(bool Accessible) {
switch (Kind) {
case RK_Pattern:
if (!Declaration) {
// Do nothing: Patterns can come with cursor kinds!
break;
}
[[fallthrough]];
case RK_Declaration: {
// Set the availability based on attributes.
switch (getDeclAvailability(Declaration)) {
case AR_Available:
case AR_NotYetIntroduced:
Availability = CXAvailability_Available;
break;
case AR_Deprecated:
Availability = CXAvailability_Deprecated;
break;
case AR_Unavailable:
Availability = CXAvailability_NotAvailable;
break;
}
if (const auto *Function = dyn_cast<FunctionDecl>(Declaration))
if (Function->isDeleted())
Availability = CXAvailability_NotAvailable;
CursorKind = getCursorKindForDecl(Declaration);
if (CursorKind == CXCursor_UnexposedDecl) {
// FIXME: Forward declarations of Objective-C classes and protocols
// are not directly exposed, but we want code completion to treat them
// like a definition.
if (isa<ObjCInterfaceDecl>(Declaration))
CursorKind = CXCursor_ObjCInterfaceDecl;
else if (isa<ObjCProtocolDecl>(Declaration))
CursorKind = CXCursor_ObjCProtocolDecl;
else
CursorKind = CXCursor_NotImplemented;
}
break;
}
case RK_Macro:
case RK_Keyword:
llvm_unreachable("Macro and keyword kinds are handled by the constructors");
}
if (!Accessible)
Availability = CXAvailability_NotAccessible;
}
/// Retrieve the name that should be used to order a result.
///
/// If the name needs to be constructed as a string, that string will be
/// saved into Saved and the returned StringRef will refer to it.
StringRef CodeCompletionResult::getOrderedName(std::string &Saved) const {
switch (Kind) {
case RK_Keyword:
return Keyword;
case RK_Pattern:
return Pattern->getTypedText();
case RK_Macro:
return Macro->getName();
case RK_Declaration:
// Handle declarations below.
break;
}
DeclarationName Name = Declaration->getDeclName();
// If the name is a simple identifier (by far the common case), or a
// zero-argument selector, just return a reference to that identifier.
if (IdentifierInfo *Id = Name.getAsIdentifierInfo())
return Id->getName();
if (Name.isObjCZeroArgSelector())
if (IdentifierInfo *Id = Name.getObjCSelector().getIdentifierInfoForSlot(0))
return Id->getName();
Saved = Name.getAsString();
return Saved;
}
bool clang::operator<(const CodeCompletionResult &X,
const CodeCompletionResult &Y) {
std::string XSaved, YSaved;
StringRef XStr = X.getOrderedName(XSaved);
StringRef YStr = Y.getOrderedName(YSaved);
int cmp = XStr.compare_insensitive(YStr);
if (cmp)
return cmp < 0;
// If case-insensitive comparison fails, try case-sensitive comparison.
return XStr.compare(YStr) < 0;
}
|