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