Coverage Report

Created: 2018-07-22 10:17

/Users/buildslave/jenkins/workspace/clang-stage2-coverage-R/llvm/tools/clang/include/clang/Sema/CodeCompleteConsumer.h
Line
Count
Source (jump to first uncovered line)
1
//===- CodeCompleteConsumer.h - Code Completion Interface -------*- C++ -*-===//
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 defines the CodeCompleteConsumer class.
11
//
12
//===----------------------------------------------------------------------===//
13
14
#ifndef LLVM_CLANG_SEMA_CODECOMPLETECONSUMER_H
15
#define LLVM_CLANG_SEMA_CODECOMPLETECONSUMER_H
16
17
#include "clang-c/Index.h"
18
#include "clang/AST/Type.h"
19
#include "clang/Basic/LLVM.h"
20
#include "clang/Sema/CodeCompleteOptions.h"
21
#include "clang/Sema/DeclSpec.h"
22
#include "llvm/ADT/ArrayRef.h"
23
#include "llvm/ADT/DenseMap.h"
24
#include "llvm/ADT/None.h"
25
#include "llvm/ADT/Optional.h"
26
#include "llvm/ADT/SmallPtrSet.h"
27
#include "llvm/ADT/SmallVector.h"
28
#include "llvm/ADT/StringRef.h"
29
#include "llvm/Support/Allocator.h"
30
#include "llvm/Support/type_traits.h"
31
#include <cassert>
32
#include <memory>
33
#include <string>
34
#include <utility>
35
36
namespace clang {
37
38
class ASTContext;
39
class Decl;
40
class DeclContext;
41
class FunctionDecl;
42
class FunctionTemplateDecl;
43
class IdentifierInfo;
44
class LangOptions;
45
class NamedDecl;
46
class NestedNameSpecifier;
47
class Preprocessor;
48
class RawComment;
49
class Sema;
50
class UsingShadowDecl;
51
52
/// Default priority values for code-completion results based
53
/// on their kind.
54
enum {
55
  /// Priority for the next initialization in a constructor initializer
56
  /// list.
57
  CCP_NextInitializer = 7,
58
59
  /// Priority for an enumeration constant inside a switch whose
60
  /// condition is of the enumeration type.
61
  CCP_EnumInCase = 7,
62
63
  /// Priority for a send-to-super completion.
64
  CCP_SuperCompletion = 20,
65
66
  /// Priority for a declaration that is in the local scope.
67
  CCP_LocalDeclaration = 34,
68
69
  /// Priority for a member declaration found from the current
70
  /// method or member function.
71
  CCP_MemberDeclaration = 35,
72
73
  /// Priority for a language keyword (that isn't any of the other
74
  /// categories).
75
  CCP_Keyword = 40,
76
77
  /// Priority for a code pattern.
78
  CCP_CodePattern = 40,
79
80
  /// Priority for a non-type declaration.
81
  CCP_Declaration = 50,
82
83
  /// Priority for a type.
84
  CCP_Type = CCP_Declaration,
85
86
  /// Priority for a constant value (e.g., enumerator).
87
  CCP_Constant = 65,
88
89
  /// Priority for a preprocessor macro.
90
  CCP_Macro = 70,
91
92
  /// Priority for a nested-name-specifier.
93
  CCP_NestedNameSpecifier = 75,
94
95
  /// Priority for a result that isn't likely to be what the user wants,
96
  /// but is included for completeness.
97
  CCP_Unlikely = 80,
98
99
  /// Priority for the Objective-C "_cmd" implicit parameter.
100
  CCP_ObjC_cmd = CCP_Unlikely
101
};
102
103
/// Priority value deltas that are added to code-completion results
104
/// based on the context of the result.
105
enum {
106
  /// The result is in a base class.
107
  CCD_InBaseClass = 2,
108
109
  /// The result is a C++ non-static member function whose qualifiers
110
  /// exactly match the object type on which the member function can be called.
111
  CCD_ObjectQualifierMatch = -1,
112
113
  /// The selector of the given message exactly matches the selector
114
  /// of the current method, which might imply that some kind of delegation
115
  /// is occurring.
116
  CCD_SelectorMatch = -3,
117
118
  /// Adjustment to the "bool" type in Objective-C, where the typedef
119
  /// "BOOL" is preferred.
120
  CCD_bool_in_ObjC = 1,
121
122
  /// Adjustment for KVC code pattern priorities when it doesn't look
123
  /// like the
124
  CCD_ProbablyNotObjCCollection = 15,
125
126
  /// An Objective-C method being used as a property.
127
  CCD_MethodAsProperty = 2,
128
129
  /// An Objective-C block property completed as a setter with a
130
  /// block placeholder.
131
  CCD_BlockPropertySetter = 3
132
};
133
134
/// Priority value factors by which we will divide or multiply the
135
/// priority of a code-completion result.
136
enum {
137
  /// Divide by this factor when a code-completion result's type exactly
138
  /// matches the type we expect.
139
  CCF_ExactTypeMatch = 4,
140
141
  /// Divide by this factor when a code-completion result's type is
142
  /// similar to the type we expect (e.g., both arithmetic types, both
143
  /// Objective-C object pointer types).
144
  CCF_SimilarTypeMatch = 2
145
};
146
147
/// A simplified classification of types used when determining
148
/// "similar" types for code completion.
149
enum SimplifiedTypeClass {
150
  STC_Arithmetic,
151
  STC_Array,
152
  STC_Block,
153
  STC_Function,
154
  STC_ObjectiveC,
155
  STC_Other,
156
  STC_Pointer,
157
  STC_Record,
158
  STC_Void
159
};
160
161
/// Determine the simplified type class of the given canonical type.
162
SimplifiedTypeClass getSimplifiedTypeClass(CanQualType T);
163
164
/// Determine the type that this declaration will have if it is used
165
/// as a type or in an expression.
166
QualType getDeclUsageType(ASTContext &C, const NamedDecl *ND);
167
168
/// Determine the priority to be given to a macro code completion result
169
/// with the given name.
170
///
171
/// \param MacroName The name of the macro.
172
///
173
/// \param LangOpts Options describing the current language dialect.
174
///
175
/// \param PreferredTypeIsPointer Whether the preferred type for the context
176
/// of this macro is a pointer type.
177
unsigned getMacroUsagePriority(StringRef MacroName,
178
                               const LangOptions &LangOpts,
179
                               bool PreferredTypeIsPointer = false);
180
181
/// Determine the libclang cursor kind associated with the given
182
/// declaration.
183
CXCursorKind getCursorKindForDecl(const Decl *D);
184
185
/// The context in which code completion occurred, so that the
186
/// code-completion consumer can process the results accordingly.
187
class CodeCompletionContext {
188
public:
189
  enum Kind {
190
    /// An unspecified code-completion context.
191
    CCC_Other,
192
193
    /// An unspecified code-completion context where we should also add
194
    /// macro completions.
195
    CCC_OtherWithMacros,
196
197
    /// Code completion occurred within a "top-level" completion context,
198
    /// e.g., at namespace or global scope.
199
    CCC_TopLevel,
200
201
    /// Code completion occurred within an Objective-C interface,
202
    /// protocol, or category interface.
203
    CCC_ObjCInterface,
204
205
    /// Code completion occurred within an Objective-C implementation
206
    /// or category implementation.
207
    CCC_ObjCImplementation,
208
209
    /// Code completion occurred within the instance variable list of
210
    /// an Objective-C interface, implementation, or category implementation.
211
    CCC_ObjCIvarList,
212
213
    /// Code completion occurred within a class, struct, or union.
214
    CCC_ClassStructUnion,
215
216
    /// Code completion occurred where a statement (or declaration) is
217
    /// expected in a function, method, or block.
218
    CCC_Statement,
219
220
    /// Code completion occurred where an expression is expected.
221
    CCC_Expression,
222
223
    /// Code completion occurred where an Objective-C message receiver
224
    /// is expected.
225
    CCC_ObjCMessageReceiver,
226
227
    /// Code completion occurred on the right-hand side of a member
228
    /// access expression using the dot operator.
229
    ///
230
    /// The results of this completion are the members of the type being
231
    /// accessed. The type itself is available via
232
    /// \c CodeCompletionContext::getType().
233
    CCC_DotMemberAccess,
234
235
    /// Code completion occurred on the right-hand side of a member
236
    /// access expression using the arrow operator.
237
    ///
238
    /// The results of this completion are the members of the type being
239
    /// accessed. The type itself is available via
240
    /// \c CodeCompletionContext::getType().
241
    CCC_ArrowMemberAccess,
242
243
    /// Code completion occurred on the right-hand side of an Objective-C
244
    /// property access expression.
245
    ///
246
    /// The results of this completion are the members of the type being
247
    /// accessed. The type itself is available via
248
    /// \c CodeCompletionContext::getType().
249
    CCC_ObjCPropertyAccess,
250
251
    /// Code completion occurred after the "enum" keyword, to indicate
252
    /// an enumeration name.
253
    CCC_EnumTag,
254
255
    /// Code completion occurred after the "union" keyword, to indicate
256
    /// a union name.
257
    CCC_UnionTag,
258
259
    /// Code completion occurred after the "struct" or "class" keyword,
260
    /// to indicate a struct or class name.
261
    CCC_ClassOrStructTag,
262
263
    /// Code completion occurred where a protocol name is expected.
264
    CCC_ObjCProtocolName,
265
266
    /// Code completion occurred where a namespace or namespace alias
267
    /// is expected.
268
    CCC_Namespace,
269
270
    /// Code completion occurred where a type name is expected.
271
    CCC_Type,
272
273
    /// Code completion occurred where a new name is expected.
274
    CCC_Name,
275
276
    /// Code completion occurred where a new name is expected and a
277
    /// qualified name is permissible.
278
    CCC_PotentiallyQualifiedName,
279
280
    /// Code completion occurred where an macro is being defined.
281
    CCC_MacroName,
282
283
    /// Code completion occurred where a macro name is expected
284
    /// (without any arguments, in the case of a function-like macro).
285
    CCC_MacroNameUse,
286
287
    /// Code completion occurred within a preprocessor expression.
288
    CCC_PreprocessorExpression,
289
290
    /// Code completion occurred where a preprocessor directive is
291
    /// expected.
292
    CCC_PreprocessorDirective,
293
294
    /// Code completion occurred in a context where natural language is
295
    /// expected, e.g., a comment or string literal.
296
    ///
297
    /// This context usually implies that no completions should be added,
298
    /// unless they come from an appropriate natural-language dictionary.
299
    CCC_NaturalLanguage,
300
301
    /// Code completion for a selector, as in an \@selector expression.
302
    CCC_SelectorName,
303
304
    /// Code completion within a type-qualifier list.
305
    CCC_TypeQualifiers,
306
307
    /// Code completion in a parenthesized expression, which means that
308
    /// we may also have types here in C and Objective-C (as well as in C++).
309
    CCC_ParenthesizedExpression,
310
311
    /// Code completion where an Objective-C instance message is
312
    /// expected.
313
    CCC_ObjCInstanceMessage,
314
315
    /// Code completion where an Objective-C class message is expected.
316
    CCC_ObjCClassMessage,
317
318
    /// Code completion where the name of an Objective-C class is
319
    /// expected.
320
    CCC_ObjCInterfaceName,
321
322
    /// Code completion where an Objective-C category name is expected.
323
    CCC_ObjCCategoryName,
324
325
    /// An unknown context, in which we are recovering from a parsing
326
    /// error and don't know which completions we should give.
327
    CCC_Recovery
328
  };
329
330
  using VisitedContextSet = llvm::SmallPtrSet<DeclContext *, 8>;
331
332
private:
333
  Kind CCKind;
334
335
  /// The type that would prefer to see at this point (e.g., the type
336
  /// of an initializer or function parameter).
337
  QualType PreferredType;
338
339
  /// The type of the base object in a member access expression.
340
  QualType BaseType;
341
342
  /// The identifiers for Objective-C selector parts.
343
  ArrayRef<IdentifierInfo *> SelIdents;
344
345
  /// The scope specifier that comes before the completion token e.g.
346
  /// "a::b::"
347
  llvm::Optional<CXXScopeSpec> ScopeSpecifier;
348
349
  /// A set of declaration contexts visited by Sema when doing lookup for
350
  /// code completion.
351
  VisitedContextSet VisitedContexts;
352
353
public:
354
  /// Construct a new code-completion context of the given kind.
355
837
  CodeCompletionContext(Kind CCKind) : CCKind(CCKind), SelIdents(None) {}
356
357
  /// Construct a new code-completion context of the given kind.
358
  CodeCompletionContext(Kind CCKind, QualType T,
359
                        ArrayRef<IdentifierInfo *> SelIdents = None)
360
288
      : CCKind(CCKind), SelIdents(SelIdents) {
361
288
    if (CCKind == CCC_DotMemberAccess || 
CCKind == CCC_ArrowMemberAccess257
||
362
288
        
CCKind == CCC_ObjCPropertyAccess224
||
CCKind == CCC_ObjCClassMessage202
||
363
288
        
CCKind == CCC_ObjCInstanceMessage173
)
364
170
      BaseType = T;
365
118
    else
366
118
      PreferredType = T;
367
288
  }
368
369
  /// Retrieve the kind of code-completion context.
370
62.8k
  Kind getKind() const { return CCKind; }
371
372
  /// Retrieve the type that this expression would prefer to have, e.g.,
373
  /// if the expression is a variable initializer or a function argument, the
374
  /// type of the corresponding variable or function parameter.
375
60.2k
  QualType getPreferredType() const { return PreferredType; }
376
377
  /// Retrieve the type of the base object in a member-access
378
  /// expression.
379
5.69k
  QualType getBaseType() const { return BaseType; }
380
381
  /// Retrieve the Objective-C selector identifiers.
382
  ArrayRef<IdentifierInfo *> getSelIdents() const { return SelIdents; }
383
384
  /// Determines whether we want C++ constructors as results within this
385
  /// context.
386
  bool wantConstructorResults() const;
387
388
  /// Sets the scope specifier that comes before the completion token.
389
  /// This is expected to be set in code completions on qualfied specifiers
390
  /// (e.g. "a::b::").
391
35
  void setCXXScopeSpecifier(CXXScopeSpec SS) {
392
35
    this->ScopeSpecifier = std::move(SS);
393
35
  }
394
395
  /// Adds a visited context.
396
619
  void addVisitedContext(DeclContext *Ctx) {
397
619
    VisitedContexts.insert(Ctx);
398
619
  }
399
400
  /// Retrieves all visited contexts.
401
  const VisitedContextSet &getVisitedContexts() const {
402
    return VisitedContexts;
403
  }
404
405
0
  llvm::Optional<const CXXScopeSpec *> getCXXScopeSpecifier() {
406
0
    if (ScopeSpecifier)
407
0
      return ScopeSpecifier.getPointer();
408
0
    return llvm::None;
409
0
  }
410
};
411
412
/// Get string representation of \p Kind, useful for for debugging.
413
llvm::StringRef getCompletionKindString(CodeCompletionContext::Kind Kind);
414
415
/// A "string" used to describe how code completion can
416
/// be performed for an entity.
417
///
418
/// A code completion string typically shows how a particular entity can be
419
/// used. For example, the code completion string for a function would show
420
/// the syntax to call it, including the parentheses, placeholders for the
421
/// arguments, etc.
422
class CodeCompletionString {
423
public:
424
  /// The different kinds of "chunks" that can occur within a code
425
  /// completion string.
426
  enum ChunkKind {
427
    /// The piece of text that the user is expected to type to
428
    /// match the code-completion string, typically a keyword or the name of a
429
    /// declarator or macro.
430
    CK_TypedText,
431
432
    /// A piece of text that should be placed in the buffer, e.g.,
433
    /// parentheses or a comma in a function call.
434
    CK_Text,
435
436
    /// A code completion string that is entirely optional. For example,
437
    /// an optional code completion string that describes the default arguments
438
    /// in a function call.
439
    CK_Optional,
440
441
    /// A string that acts as a placeholder for, e.g., a function
442
    /// call argument.
443
    CK_Placeholder,
444
445
    /// A piece of text that describes something about the result but
446
    /// should not be inserted into the buffer.
447
    CK_Informative,
448
    /// A piece of text that describes the type of an entity or, for
449
    /// functions and methods, the return type.
450
    CK_ResultType,
451
452
    /// A piece of text that describes the parameter that corresponds
453
    /// to the code-completion location within a function call, message send,
454
    /// macro invocation, etc.
455
    CK_CurrentParameter,
456
457
    /// A left parenthesis ('(').
458
    CK_LeftParen,
459
460
    /// A right parenthesis (')').
461
    CK_RightParen,
462
463
    /// A left bracket ('[').
464
    CK_LeftBracket,
465
466
    /// A right bracket (']').
467
    CK_RightBracket,
468
469
    /// A left brace ('{').
470
    CK_LeftBrace,
471
472
    /// A right brace ('}').
473
    CK_RightBrace,
474
475
    /// A left angle bracket ('<').
476
    CK_LeftAngle,
477
478
    /// A right angle bracket ('>').
479
    CK_RightAngle,
480
481
    /// A comma separator (',').
482
    CK_Comma,
483
484
    /// A colon (':').
485
    CK_Colon,
486
487
    /// A semicolon (';').
488
    CK_SemiColon,
489
490
    /// An '=' sign.
491
    CK_Equal,
492
493
    /// Horizontal whitespace (' ').
494
    CK_HorizontalSpace,
495
496
    /// Vertical whitespace ('\\n' or '\\r\\n', depending on the
497
    /// platform).
498
    CK_VerticalSpace
499
  };
500
501
  /// One piece of the code completion string.
502
  struct Chunk {
503
    /// The kind of data stored in this piece of the code completion
504
    /// string.
505
    ChunkKind Kind = CK_Text;
506
507
    union {
508
      /// The text string associated with a CK_Text, CK_Placeholder,
509
      /// CK_Informative, or CK_Comma chunk.
510
      /// The string is owned by the chunk and will be deallocated
511
      /// (with delete[]) when the chunk is destroyed.
512
      const char *Text;
513
514
      /// The code completion string associated with a CK_Optional chunk.
515
      /// The optional code completion string is owned by the chunk, and will
516
      /// be deallocated (with delete) when the chunk is destroyed.
517
      CodeCompletionString *Optional;
518
    };
519
520
72
    Chunk() : Text(nullptr) {}
521
522
    explicit Chunk(ChunkKind Kind, const char *Text = "");
523
524
    /// Create a new text chunk.
525
    static Chunk CreateText(const char *Text);
526
527
    /// Create a new optional chunk.
528
    static Chunk CreateOptional(CodeCompletionString *Optional);
529
530
    /// Create a new placeholder chunk.
531
    static Chunk CreatePlaceholder(const char *Placeholder);
532
533
    /// Create a new informative chunk.
534
    static Chunk CreateInformative(const char *Informative);
535
536
    /// Create a new result type chunk.
537
    static Chunk CreateResultType(const char *ResultType);
538
539
    /// Create a new current-parameter chunk.
540
    static Chunk CreateCurrentParameter(const char *CurrentParameter);
541
  };
542
543
private:
544
  friend class CodeCompletionBuilder;
545
  friend class CodeCompletionResult;
546
547
  /// The number of chunks stored in this string.
548
  unsigned NumChunks : 16;
549
550
  /// The number of annotations for this code-completion result.
551
  unsigned NumAnnotations : 16;
552
553
  /// The priority of this code-completion string.
554
  unsigned Priority : 16;
555
556
  /// The availability of this code-completion result.
557
  unsigned Availability : 2;
558
559
  /// The name of the parent context.
560
  StringRef ParentName;
561
562
  /// A brief documentation comment attached to the declaration of
563
  /// entity being completed by this result.
564
  const char *BriefComment;
565
566
  CodeCompletionString(const Chunk *Chunks, unsigned NumChunks,
567
                       unsigned Priority, CXAvailabilityKind Availability,
568
                       const char **Annotations, unsigned NumAnnotations,
569
                       StringRef ParentName,
570
                       const char *BriefComment);
571
  ~CodeCompletionString() = default;
572
573
public:
574
  CodeCompletionString(const CodeCompletionString &) = delete;
575
  CodeCompletionString &operator=(const CodeCompletionString &) = delete;
576
577
  using iterator = const Chunk *;
578
579
15.1M
  iterator begin() const { return reinterpret_cast<const Chunk *>(this + 1); }
580
7.37M
  iterator end() const { return begin() + NumChunks; }
581
0
  bool empty() const { return NumChunks == 0; }
582
  unsigned size() const { return NumChunks; }
583
584
  const Chunk &operator[](unsigned I) const {
585
    assert(I < size() && "Chunk index out-of-range");
586
    return begin()[I];
587
  }
588
589
  /// Returns the text in the TypedText chunk.
590
  const char *getTypedText() const;
591
592
  /// Retrieve the priority of this code completion result.
593
  unsigned getPriority() const { return Priority; }
594
595
  /// Retrieve the availability of this code completion result.
596
  unsigned getAvailability() const { return Availability; }
597
598
  /// Retrieve the number of annotations for this code completion result.
599
  unsigned getAnnotationCount() const;
600
601
  /// Retrieve the annotation string specified by \c AnnotationNr.
602
  const char *getAnnotation(unsigned AnnotationNr) const;
603
604
  /// Retrieve the name of the parent context.
605
  StringRef getParentContextName() const {
606
    return ParentName;
607
  }
608
609
111k
  const char *getBriefComment() const {
610
111k
    return BriefComment;
611
111k
  }
612
613
  /// Retrieve a string representation of the code completion string,
614
  /// which is mainly useful for debugging.
615
  std::string getAsString() const;
616
};
617
618
/// An allocator used specifically for the purpose of code completion.
619
class CodeCompletionAllocator : public llvm::BumpPtrAllocator {
620
public:
621
  /// Copy the given string into this allocator.
622
  const char *CopyString(const Twine &String);
623
};
624
625
/// Allocator for a cached set of global code completions.
626
class GlobalCodeCompletionAllocator : public CodeCompletionAllocator {};
627
628
class CodeCompletionTUInfo {
629
  llvm::DenseMap<const DeclContext *, StringRef> ParentNames;
630
  std::shared_ptr<GlobalCodeCompletionAllocator> AllocatorRef;
631
632
public:
633
  explicit CodeCompletionTUInfo(
634
      std::shared_ptr<GlobalCodeCompletionAllocator> Allocator)
635
958
      : AllocatorRef(std::move(Allocator)) {}
636
637
  std::shared_ptr<GlobalCodeCompletionAllocator> getAllocatorRef() const {
638
    return AllocatorRef;
639
  }
640
641
2.26k
  CodeCompletionAllocator &getAllocator() const {
642
2.26k
    assert(AllocatorRef);
643
2.26k
    return *AllocatorRef;
644
2.26k
  }
645
646
  StringRef getParentName(const DeclContext *DC);
647
};
648
649
} // namespace clang
650
651
namespace llvm {
652
653
template <> struct isPodLike<clang::CodeCompletionString::Chunk> {
654
  static const bool value = true;
655
};
656
657
} // namespace llvm
658
659
namespace clang {
660
661
/// A builder class used to construct new code-completion strings.
662
class CodeCompletionBuilder {
663
public:
664
  using Chunk = CodeCompletionString::Chunk;
665
666
private:
667
  CodeCompletionAllocator &Allocator;
668
  CodeCompletionTUInfo &CCTUInfo;
669
  unsigned Priority = 0;
670
  CXAvailabilityKind Availability = CXAvailability_Available;
671
  StringRef ParentName;
672
  const char *BriefComment = nullptr;
673
674
  /// The chunks stored in this string.
675
  SmallVector<Chunk, 4> Chunks;
676
677
  SmallVector<const char *, 2> Annotations;
678
679
public:
680
  CodeCompletionBuilder(CodeCompletionAllocator &Allocator,
681
                        CodeCompletionTUInfo &CCTUInfo)
682
1.27k
      : Allocator(Allocator), CCTUInfo(CCTUInfo) {}
683
684
  CodeCompletionBuilder(CodeCompletionAllocator &Allocator,
685
                        CodeCompletionTUInfo &CCTUInfo,
686
                        unsigned Priority, CXAvailabilityKind Availability)
687
      : Allocator(Allocator), CCTUInfo(CCTUInfo), Priority(Priority),
688
190k
        Availability(Availability) {}
689
690
  /// Retrieve the allocator into which the code completion
691
  /// strings should be allocated.
692
281k
  CodeCompletionAllocator &getAllocator() const { return Allocator; }
693
694
1.74k
  CodeCompletionTUInfo &getCodeCompletionTUInfo() const { return CCTUInfo; }
695
696
  /// Take the resulting completion string.
697
  ///
698
  /// This operation can only be performed once.
699
  CodeCompletionString *TakeString();
700
701
  /// Add a new typed-text chunk.
702
  void AddTypedTextChunk(const char *Text);
703
704
  /// Add a new text chunk.
705
  void AddTextChunk(const char *Text);
706
707
  /// Add a new optional chunk.
708
  void AddOptionalChunk(CodeCompletionString *Optional);
709
710
  /// Add a new placeholder chunk.
711
  void AddPlaceholderChunk(const char *Placeholder);
712
713
  /// Add a new informative chunk.
714
  void AddInformativeChunk(const char *Text);
715
716
  /// Add a new result-type chunk.
717
  void AddResultTypeChunk(const char *ResultType);
718
719
  /// Add a new current-parameter chunk.
720
  void AddCurrentParameterChunk(const char *CurrentParameter);
721
722
  /// Add a new chunk.
723
  void AddChunk(CodeCompletionString::ChunkKind CK, const char *Text = "");
724
725
6
  void AddAnnotation(const char *A) { Annotations.push_back(A); }
726
727
  /// Add the parent context information to this code completion.
728
  void addParentContext(const DeclContext *DC);
729
730
4
  const char *getBriefComment() const { return BriefComment; }
731
  void addBriefComment(StringRef Comment);
732
733
185
  StringRef getParentName() const { return ParentName; }
734
};
735
736
/// Captures a result of code completion.
737
class CodeCompletionResult {
738
public:
739
  /// Describes the kind of result generated.
740
  enum ResultKind {
741
    /// Refers to a declaration.
742
    RK_Declaration = 0,
743
744
    /// Refers to a keyword or symbol.
745
    RK_Keyword,
746
747
    /// Refers to a macro.
748
    RK_Macro,
749
750
    /// Refers to a precomputed pattern.
751
    RK_Pattern
752
  };
753
754
  /// When Kind == RK_Declaration or RK_Pattern, the declaration we are
755
  /// referring to. In the latter case, the declaration might be NULL.
756
  const NamedDecl *Declaration = nullptr;
757
758
  union {
759
    /// When Kind == RK_Keyword, the string representing the keyword
760
    /// or symbol's spelling.
761
    const char *Keyword;
762
763
    /// When Kind == RK_Pattern, the code-completion string that
764
    /// describes the completion text to insert.
765
    CodeCompletionString *Pattern;
766
767
    /// When Kind == RK_Macro, the identifier that refers to a macro.
768
    const IdentifierInfo *Macro;
769
  };
770
771
  /// The priority of this particular code-completion result.
772
  unsigned Priority;
773
774
  /// Specifies which parameter (of a function, Objective-C method,
775
  /// macro, etc.) we should start with when formatting the result.
776
  unsigned StartParameter = 0;
777
778
  /// The kind of result stored here.
779
  ResultKind Kind;
780
781
  /// The cursor kind that describes this result.
782
  CXCursorKind CursorKind;
783
784
  /// The availability of this result.
785
  CXAvailabilityKind Availability = CXAvailability_Available;
786
787
  /// Fix-its that *must* be applied before inserting the text for the
788
  /// corresponding completion.
789
  ///
790
  /// By default, CodeCompletionBuilder only returns completions with empty
791
  /// fix-its. Extra completions with non-empty fix-its should be explicitly
792
  /// requested by setting CompletionOptions::IncludeFixIts.
793
  ///
794
  /// For the clients to be able to compute position of the cursor after
795
  /// applying fix-its, the following conditions are guaranteed to hold for
796
  /// RemoveRange of the stored fix-its:
797
  ///  - Ranges in the fix-its are guaranteed to never contain the completion
798
  ///  point (or identifier under completion point, if any) inside them, except
799
  ///  at the start or at the end of the range.
800
  ///  - If a fix-it range starts or ends with completion point (or starts or
801
  ///  ends after the identifier under completion point), it will contain at
802
  ///  least one character. It allows to unambiguously recompute completion
803
  ///  point after applying the fix-it.
804
  ///
805
  /// The intuition is that provided fix-its change code around the identifier
806
  /// we complete, but are not allowed to touch the identifier itself or the
807
  /// completion point. One example of completions with corrections are the ones
808
  /// replacing '.' with '->' and vice versa:
809
  ///
810
  /// std::unique_ptr<std::vector<int>> vec_ptr;
811
  /// In 'vec_ptr.^', one of the completions is 'push_back', it requires
812
  /// replacing '.' with '->'.
813
  /// In 'vec_ptr->^', one of the completions is 'release', it requires
814
  /// replacing '->' with '.'.
815
  std::vector<FixItHint> FixIts;
816
817
  /// Whether this result is hidden by another name.
818
  bool Hidden : 1;
819
820
  /// Whether this result was found via lookup into a base class.
821
  bool QualifierIsInformative : 1;
822
823
  /// Whether this declaration is the beginning of a
824
  /// nested-name-specifier and, therefore, should be followed by '::'.
825
  bool StartsNestedNameSpecifier : 1;
826
827
  /// Whether all parameters (of a function, Objective-C
828
  /// method, etc.) should be considered "informative".
829
  bool AllParametersAreInformative : 1;
830
831
  /// Whether we're completing a declaration of the given entity,
832
  /// rather than a use of that entity.
833
  bool DeclaringEntity : 1;
834
835
  /// If the result should have a nested-name-specifier, this is it.
836
  /// When \c QualifierIsInformative, the nested-name-specifier is
837
  /// informative rather than required.
838
  NestedNameSpecifier *Qualifier = nullptr;
839
840
  /// If this Decl was unshadowed by using declaration, this can store a
841
  /// pointer to the UsingShadowDecl which was used in the unshadowing process.
842
  /// This information can be used to uprank CodeCompletionResults / which have
843
  /// corresponding `using decl::qualified::name;` nearby.
844
  const UsingShadowDecl *ShadowDecl = nullptr;
845
846
  /// Build a result that refers to a declaration.
847
  CodeCompletionResult(const NamedDecl *Declaration, unsigned Priority,
848
                       NestedNameSpecifier *Qualifier = nullptr,
849
                       bool QualifierIsInformative = false,
850
                       bool Accessible = true,
851
                       std::vector<FixItHint> FixIts = std::vector<FixItHint>())
852
      : Declaration(Declaration), Priority(Priority), Kind(RK_Declaration),
853
        FixIts(std::move(FixIts)), Hidden(false),
854
        QualifierIsInformative(QualifierIsInformative),
855
        StartsNestedNameSpecifier(false), AllParametersAreInformative(false),
856
10.4k
        DeclaringEntity(false), Qualifier(Qualifier) {
857
10.4k
    // FIXME: Add assert to check FixIts range requirements.
858
10.4k
    computeCursorKindAndAvailability(Accessible);
859
10.4k
  }
860
861
  /// Build a result that refers to a keyword or symbol.
862
  CodeCompletionResult(const char *Keyword, unsigned Priority = CCP_Keyword)
863
      : Keyword(Keyword), Priority(Priority), Kind(RK_Keyword),
864
        CursorKind(CXCursor_NotImplemented), Hidden(false),
865
        QualifierIsInformative(false), StartsNestedNameSpecifier(false),
866
7.97k
        AllParametersAreInformative(false), DeclaringEntity(false) {}
867
868
  /// Build a result that refers to a macro.
869
  CodeCompletionResult(const IdentifierInfo *Macro,
870
                       unsigned Priority = CCP_Macro)
871
      : Macro(Macro), Priority(Priority), Kind(RK_Macro),
872
        CursorKind(CXCursor_MacroDefinition), Hidden(false),
873
        QualifierIsInformative(false), StartsNestedNameSpecifier(false),
874
123k
        AllParametersAreInformative(false), DeclaringEntity(false) {}
875
876
  /// Build a result that refers to a pattern.
877
  CodeCompletionResult(CodeCompletionString *Pattern,
878
                       unsigned Priority = CCP_CodePattern,
879
                       CXCursorKind CursorKind = CXCursor_NotImplemented,
880
                   CXAvailabilityKind Availability = CXAvailability_Available,
881
                       const NamedDecl *D = nullptr)
882
      : Declaration(D), Pattern(Pattern), Priority(Priority), Kind(RK_Pattern),
883
        CursorKind(CursorKind), Availability(Availability), Hidden(false),
884
        QualifierIsInformative(false), StartsNestedNameSpecifier(false),
885
55.9k
        AllParametersAreInformative(false), DeclaringEntity(false) {}
886
887
  /// Build a result that refers to a pattern with an associated
888
  /// declaration.
889
  CodeCompletionResult(CodeCompletionString *Pattern, const NamedDecl *D,
890
                       unsigned Priority)
891
      : Declaration(D), Pattern(Pattern), Priority(Priority), Kind(RK_Pattern),
892
        Hidden(false), QualifierIsInformative(false),
893
        StartsNestedNameSpecifier(false), AllParametersAreInformative(false),
894
169
        DeclaringEntity(false) {
895
169
    computeCursorKindAndAvailability();
896
169
  }
897
898
  /// Retrieve the declaration stored in this result. This might be nullptr if
899
  /// Kind is RK_Pattern.
900
0
  const NamedDecl *getDeclaration() const {
901
0
    assert(((Kind == RK_Declaration) || (Kind == RK_Pattern)) &&
902
0
           "Not a declaration or pattern result");
903
0
    return Declaration;
904
0
  }
905
906
  /// Retrieve the keyword stored in this result.
907
0
  const char *getKeyword() const {
908
0
    assert(Kind == RK_Keyword && "Not a keyword result");
909
0
    return Keyword;
910
0
  }
911
912
  /// Create a new code-completion string that describes how to insert
913
  /// this result into a program.
914
  ///
915
  /// \param S The semantic analysis that created the result.
916
  ///
917
  /// \param Allocator The allocator that will be used to allocate the
918
  /// string itself.
919
  CodeCompletionString *CreateCodeCompletionString(Sema &S,
920
                                         const CodeCompletionContext &CCContext,
921
                                           CodeCompletionAllocator &Allocator,
922
                                           CodeCompletionTUInfo &CCTUInfo,
923
                                           bool IncludeBriefComments);
924
  CodeCompletionString *CreateCodeCompletionString(ASTContext &Ctx,
925
                                                   Preprocessor &PP,
926
                                         const CodeCompletionContext &CCContext,
927
                                           CodeCompletionAllocator &Allocator,
928
                                           CodeCompletionTUInfo &CCTUInfo,
929
                                           bool IncludeBriefComments);
930
  /// Creates a new code-completion string for the macro result. Similar to the
931
  /// above overloads, except this only requires preprocessor information.
932
  /// The result kind must be `RK_Macro`.
933
  CodeCompletionString *
934
  CreateCodeCompletionStringForMacro(Preprocessor &PP,
935
                                     CodeCompletionAllocator &Allocator,
936
                                     CodeCompletionTUInfo &CCTUInfo);
937
938
  /// Retrieve the name that should be used to order a result.
939
  ///
940
  /// If the name needs to be constructed as a string, that string will be
941
  /// saved into Saved and the returned StringRef will refer to it.
942
  StringRef getOrderedName(std::string &Saved) const;
943
944
private:
945
  void computeCursorKindAndAvailability(bool Accessible = true);
946
};
947
948
bool operator<(const CodeCompletionResult &X, const CodeCompletionResult &Y);
949
950
inline bool operator>(const CodeCompletionResult &X,
951
0
                      const CodeCompletionResult &Y) {
952
0
  return Y < X;
953
0
}
954
955
inline bool operator<=(const CodeCompletionResult &X,
956
0
                      const CodeCompletionResult &Y) {
957
0
  return !(Y < X);
958
0
}
959
960
inline bool operator>=(const CodeCompletionResult &X,
961
0
                       const CodeCompletionResult &Y) {
962
0
  return !(X < Y);
963
0
}
964
965
raw_ostream &operator<<(raw_ostream &OS,
966
                              const CodeCompletionString &CCS);
967
968
/// Abstract interface for a consumer of code-completion
969
/// information.
970
class CodeCompleteConsumer {
971
protected:
972
  const CodeCompleteOptions CodeCompleteOpts;
973
974
  /// Whether the output format for the code-completion consumer is
975
  /// binary.
976
  bool OutputIsBinary;
977
978
public:
979
  class OverloadCandidate {
980
  public:
981
    /// Describes the type of overload candidate.
982
    enum CandidateKind {
983
      /// The candidate is a function declaration.
984
      CK_Function,
985
986
      /// The candidate is a function template.
987
      CK_FunctionTemplate,
988
989
      /// The "candidate" is actually a variable, expression, or block
990
      /// for which we only have a function prototype.
991
      CK_FunctionType
992
    };
993
994
  private:
995
    /// The kind of overload candidate.
996
    CandidateKind Kind;
997
998
    union {
999
      /// The function overload candidate, available when
1000
      /// Kind == CK_Function.
1001
      FunctionDecl *Function;
1002
1003
      /// The function template overload candidate, available when
1004
      /// Kind == CK_FunctionTemplate.
1005
      FunctionTemplateDecl *FunctionTemplate;
1006
1007
      /// The function type that describes the entity being called,
1008
      /// when Kind == CK_FunctionType.
1009
      const FunctionType *Type;
1010
    };
1011
1012
  public:
1013
    OverloadCandidate(FunctionDecl *Function)
1014
165
        : Kind(CK_Function), Function(Function) {}
1015
1016
    OverloadCandidate(FunctionTemplateDecl *FunctionTemplateDecl)
1017
        : Kind(CK_FunctionTemplate), FunctionTemplate(FunctionTemplateDecl) {}
1018
1019
    OverloadCandidate(const FunctionType *Type)
1020
5
        : Kind(CK_FunctionType), Type(Type) {}
1021
1022
    /// Determine the kind of overload candidate.
1023
175
    CandidateKind getKind() const { return Kind; }
1024
1025
    /// Retrieve the function overload candidate or the templated
1026
    /// function declaration for a function template.
1027
    FunctionDecl *getFunction() const;
1028
1029
    /// Retrieve the function template overload candidate.
1030
    FunctionTemplateDecl *getFunctionTemplate() const {
1031
      assert(getKind() == CK_FunctionTemplate && "Not a function template");
1032
      return FunctionTemplate;
1033
    }
1034
1035
    /// Retrieve the function type of the entity, regardless of how the
1036
    /// function is stored.
1037
    const FunctionType *getFunctionType() const;
1038
1039
    /// Create a new code-completion string that describes the function
1040
    /// signature of this overload candidate.
1041
    CodeCompletionString *CreateSignatureString(unsigned CurrentArg,
1042
                                                Sema &S,
1043
                                      CodeCompletionAllocator &Allocator,
1044
                                      CodeCompletionTUInfo &CCTUInfo,
1045
                                      bool IncludeBriefComments) const;
1046
  };
1047
1048
  CodeCompleteConsumer(const CodeCompleteOptions &CodeCompleteOpts,
1049
                       bool OutputIsBinary)
1050
1.52k
      : CodeCompleteOpts(CodeCompleteOpts), OutputIsBinary(OutputIsBinary) {}
1051
1052
  /// Whether the code-completion consumer wants to see macros.
1053
389
  bool includeMacros() const {
1054
389
    return CodeCompleteOpts.IncludeMacros;
1055
389
  }
1056
1057
  /// Whether the code-completion consumer wants to see code patterns.
1058
404
  bool includeCodePatterns() const {
1059
404
    return CodeCompleteOpts.IncludeCodePatterns;
1060
404
  }
1061
1062
  /// Whether to include global (top-level) declaration results.
1063
502
  bool includeGlobals() const { return CodeCompleteOpts.IncludeGlobals; }
1064
1065
  /// Whether to include declarations in namespace contexts (including
1066
  /// the global namespace). If this is false, `includeGlobals()` will be
1067
  /// ignored.
1068
34
  bool includeNamespaceLevelDecls() const {
1069
34
    return CodeCompleteOpts.IncludeNamespaceLevelDecls;
1070
34
  }
1071
1072
  /// Whether to include brief documentation comments within the set of
1073
  /// code completions returned.
1074
153k
  bool includeBriefComments() const {
1075
153k
    return CodeCompleteOpts.IncludeBriefComments;
1076
153k
  }
1077
1078
  /// Whether to include completion items with small fix-its, e.g. change
1079
  /// '.' to '->' on member access, etc.
1080
152k
  bool includeFixIts() const { return CodeCompleteOpts.IncludeFixIts; }
1081
1082
  /// Hint whether to load data from the external AST in order to provide
1083
  /// full results. If false, declarations from the preamble may be omitted.
1084
1.19k
  bool loadExternal() const {
1085
1.19k
    return CodeCompleteOpts.LoadExternal;
1086
1.19k
  }
1087
1088
  /// Determine whether the output of this consumer is binary.
1089
1.52k
  bool isOutputBinary() const { return OutputIsBinary; }
1090
1091
  /// Deregisters and destroys this code-completion consumer.
1092
  virtual ~CodeCompleteConsumer();
1093
1094
  /// \name Code-completion filtering
1095
  /// Check if the result should be filtered out.
1096
  virtual bool isResultFilteredOut(StringRef Filter,
1097
0
                                   CodeCompletionResult Results) {
1098
0
    return false;
1099
0
  }
1100
1101
  /// \name Code-completion callbacks
1102
  //@{
1103
  /// Process the finalized code-completion results.
1104
  virtual void ProcessCodeCompleteResults(Sema &S,
1105
                                          CodeCompletionContext Context,
1106
                                          CodeCompletionResult *Results,
1107
0
                                          unsigned NumResults) {}
1108
1109
  /// \param S the semantic-analyzer object for which code-completion is being
1110
  /// done.
1111
  ///
1112
  /// \param CurrentArg the index of the current argument.
1113
  ///
1114
  /// \param Candidates an array of overload candidates.
1115
  ///
1116
  /// \param NumCandidates the number of overload candidates
1117
  virtual void ProcessOverloadCandidates(Sema &S, unsigned CurrentArg,
1118
                                         OverloadCandidate *Candidates,
1119
0
                                         unsigned NumCandidates) {}
1120
  //@}
1121
1122
  /// Retrieve the allocator that will be used to allocate
1123
  /// code completion strings.
1124
  virtual CodeCompletionAllocator &getAllocator() = 0;
1125
1126
  virtual CodeCompletionTUInfo &getCodeCompletionTUInfo() = 0;
1127
};
1128
1129
/// Get the documentation comment used to produce
1130
/// CodeCompletionString::BriefComment for RK_Declaration.
1131
const RawComment *getCompletionComment(const ASTContext &Ctx,
1132
                                       const NamedDecl *Decl);
1133
1134
/// Get the documentation comment used to produce
1135
/// CodeCompletionString::BriefComment for RK_Pattern.
1136
const RawComment *getPatternCompletionComment(const ASTContext &Ctx,
1137
                                              const NamedDecl *Decl);
1138
1139
/// Get the documentation comment used to produce
1140
/// CodeCompletionString::BriefComment for OverloadCandidate.
1141
const RawComment *
1142
getParameterComment(const ASTContext &Ctx,
1143
                    const CodeCompleteConsumer::OverloadCandidate &Result,
1144
                    unsigned ArgIndex);
1145
1146
/// A simple code-completion consumer that prints the results it
1147
/// receives in a simple format.
1148
class PrintingCodeCompleteConsumer : public CodeCompleteConsumer {
1149
  /// The raw output stream.
1150
  raw_ostream &OS;
1151
1152
  CodeCompletionTUInfo CCTUInfo;
1153
1154
public:
1155
  /// Create a new printing code-completion consumer that prints its
1156
  /// results to the given raw output stream.
1157
  PrintingCodeCompleteConsumer(const CodeCompleteOptions &CodeCompleteOpts,
1158
                               raw_ostream &OS)
1159
      : CodeCompleteConsumer(CodeCompleteOpts, false), OS(OS),
1160
135
        CCTUInfo(std::make_shared<GlobalCodeCompletionAllocator>()) {}
1161
1162
  /// Prints the finalized code-completion results.
1163
  void ProcessCodeCompleteResults(Sema &S, CodeCompletionContext Context,
1164
                                  CodeCompletionResult *Results,
1165
                                  unsigned NumResults) override;
1166
1167
  void ProcessOverloadCandidates(Sema &S, unsigned CurrentArg,
1168
                                 OverloadCandidate *Candidates,
1169
                                 unsigned NumCandidates) override;
1170
1171
  bool isResultFilteredOut(StringRef Filter, CodeCompletionResult Results) override;
1172
1173
2.15k
  CodeCompletionAllocator &getAllocator() override {
1174
2.15k
    return CCTUInfo.getAllocator();
1175
2.15k
  }
1176
1177
130
  CodeCompletionTUInfo &getCodeCompletionTUInfo() override { return CCTUInfo; }
1178
};
1179
1180
} // namespace clang
1181
1182
#endif // LLVM_CLANG_SEMA_CODECOMPLETECONSUMER_H