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