Coverage Report

Created: 2021-09-21 08:58

/Users/buildslave/jenkins/workspace/coverage/llvm-project/clang/tools/libclang/CIndexCodeCompletion.cpp
Line
Count
Source (jump to first uncovered line)
1
//===- CIndexCodeCompletion.cpp - Code Completion API hooks ---------------===//
2
//
3
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4
// See https://llvm.org/LICENSE.txt for license information.
5
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6
//
7
//===----------------------------------------------------------------------===//
8
//
9
// This file implements the Clang-C Source Indexing library hooks for
10
// code completion.
11
//
12
//===----------------------------------------------------------------------===//
13
14
#include "CIndexer.h"
15
#include "CIndexDiagnostic.h"
16
#include "CLog.h"
17
#include "CXCursor.h"
18
#include "CXSourceLocation.h"
19
#include "CXString.h"
20
#include "CXTranslationUnit.h"
21
#include "clang/AST/Decl.h"
22
#include "clang/AST/DeclObjC.h"
23
#include "clang/AST/Type.h"
24
#include "clang/Basic/FileManager.h"
25
#include "clang/Basic/SourceManager.h"
26
#include "clang/Frontend/ASTUnit.h"
27
#include "clang/Frontend/CompilerInstance.h"
28
#include "clang/Sema/CodeCompleteConsumer.h"
29
#include "clang/Sema/Sema.h"
30
#include "llvm/ADT/SmallString.h"
31
#include "llvm/ADT/StringExtras.h"
32
#include "llvm/Support/CrashRecoveryContext.h"
33
#include "llvm/Support/FileSystem.h"
34
#include "llvm/Support/FormatVariadic.h"
35
#include "llvm/Support/MemoryBuffer.h"
36
#include "llvm/Support/Program.h"
37
#include "llvm/Support/Timer.h"
38
#include "llvm/Support/raw_ostream.h"
39
#include <atomic>
40
#include <cstdio>
41
#include <cstdlib>
42
#include <string>
43
44
45
#ifdef UDP_CODE_COMPLETION_LOGGER
46
#include "clang/Basic/Version.h"
47
#include <arpa/inet.h>
48
#include <sys/socket.h>
49
#include <sys/types.h>
50
#include <unistd.h>
51
#endif
52
53
using namespace clang;
54
using namespace clang::cxindex;
55
56
enum CXCompletionChunkKind
57
clang_getCompletionChunkKind(CXCompletionString completion_string,
58
144k
                             unsigned chunk_number) {
59
144k
  CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
60
144k
  if (!CCStr || chunk_number >= CCStr->size())
61
0
    return CXCompletionChunk_Text;
62
63
144k
  switch ((*CCStr)[chunk_number].Kind) {
64
114k
  case CodeCompletionString::CK_TypedText:
65
114k
    return CXCompletionChunk_TypedText;
66
1.30k
  case CodeCompletionString::CK_Text:
67
1.30k
    return CXCompletionChunk_Text;
68
70
  case CodeCompletionString::CK_Optional:
69
70
    return CXCompletionChunk_Optional;
70
8.01k
  case CodeCompletionString::CK_Placeholder:
71
8.01k
    return CXCompletionChunk_Placeholder;
72
146
  case CodeCompletionString::CK_Informative:
73
146
    return CXCompletionChunk_Informative;
74
4.88k
  case CodeCompletionString::CK_ResultType:
75
4.88k
    return CXCompletionChunk_ResultType;
76
144
  case CodeCompletionString::CK_CurrentParameter:
77
144
    return CXCompletionChunk_CurrentParameter;
78
5.02k
  case CodeCompletionString::CK_LeftParen:
79
5.02k
    return CXCompletionChunk_LeftParen;
80
5.08k
  case CodeCompletionString::CK_RightParen:
81
5.08k
    return CXCompletionChunk_RightParen;
82
246
  case CodeCompletionString::CK_LeftBracket:
83
246
    return CXCompletionChunk_LeftBracket;
84
291
  case CodeCompletionString::CK_RightBracket:
85
291
    return CXCompletionChunk_RightBracket;
86
62
  case CodeCompletionString::CK_LeftBrace:
87
62
    return CXCompletionChunk_LeftBrace;
88
107
  case CodeCompletionString::CK_RightBrace:
89
107
    return CXCompletionChunk_RightBrace;
90
689
  case CodeCompletionString::CK_LeftAngle:
91
689
    return CXCompletionChunk_LeftAngle;
92
689
  case CodeCompletionString::CK_RightAngle:
93
689
    return CXCompletionChunk_RightAngle;
94
1.33k
  case CodeCompletionString::CK_Comma:
95
1.33k
    return CXCompletionChunk_Comma;
96
51
  case CodeCompletionString::CK_Colon:
97
51
    return CXCompletionChunk_Colon;
98
317
  case CodeCompletionString::CK_SemiColon:
99
317
    return CXCompletionChunk_SemiColon;
100
55
  case CodeCompletionString::CK_Equal:
101
55
    return CXCompletionChunk_Equal;
102
1.83k
  case CodeCompletionString::CK_HorizontalSpace:
103
1.83k
    return CXCompletionChunk_HorizontalSpace;
104
100
  case CodeCompletionString::CK_VerticalSpace:
105
100
    return CXCompletionChunk_VerticalSpace;
106
144k
  }
107
108
0
  llvm_unreachable("Invalid CompletionKind!");
109
0
}
110
111
CXString clang_getCompletionChunkText(CXCompletionString completion_string,
112
144k
                                      unsigned chunk_number) {
113
144k
  CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
114
144k
  if (!CCStr || chunk_number >= CCStr->size())
115
0
    return cxstring::createNull();
116
117
144k
  switch ((*CCStr)[chunk_number].Kind) {
118
114k
  case CodeCompletionString::CK_TypedText:
119
115k
  case CodeCompletionString::CK_Text:
120
123k
  case CodeCompletionString::CK_Placeholder:
121
123k
  case CodeCompletionString::CK_CurrentParameter:
122
123k
  case CodeCompletionString::CK_Informative:
123
128k
  case CodeCompletionString::CK_LeftParen:
124
133k
  case CodeCompletionString::CK_RightParen:
125
134k
  case CodeCompletionString::CK_LeftBracket:
126
134k
  case CodeCompletionString::CK_RightBracket:
127
134k
  case CodeCompletionString::CK_LeftBrace:
128
134k
  case CodeCompletionString::CK_RightBrace:
129
135k
  case CodeCompletionString::CK_LeftAngle:
130
135k
  case CodeCompletionString::CK_RightAngle:
131
137k
  case CodeCompletionString::CK_Comma:
132
142k
  case CodeCompletionString::CK_ResultType:
133
142k
  case CodeCompletionString::CK_Colon:
134
142k
  case CodeCompletionString::CK_SemiColon:
135
142k
  case CodeCompletionString::CK_Equal:
136
144k
  case CodeCompletionString::CK_HorizontalSpace:
137
144k
  case CodeCompletionString::CK_VerticalSpace:
138
144k
    return cxstring::createRef((*CCStr)[chunk_number].Text);
139
      
140
0
  case CodeCompletionString::CK_Optional:
141
    // Note: treated as an empty text block.
142
0
    return cxstring::createEmpty();
143
144k
  }
144
145
0
  llvm_unreachable("Invalid CodeCompletionString Kind!");
146
0
}
147
148
149
CXCompletionString
150
clang_getCompletionChunkCompletionString(CXCompletionString completion_string,
151
70
                                         unsigned chunk_number) {
152
70
  CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
153
70
  if (!CCStr || chunk_number >= CCStr->size())
154
0
    return nullptr;
155
156
70
  switch ((*CCStr)[chunk_number].Kind) {
157
0
  case CodeCompletionString::CK_TypedText:
158
0
  case CodeCompletionString::CK_Text:
159
0
  case CodeCompletionString::CK_Placeholder:
160
0
  case CodeCompletionString::CK_CurrentParameter:
161
0
  case CodeCompletionString::CK_Informative:
162
0
  case CodeCompletionString::CK_LeftParen:
163
0
  case CodeCompletionString::CK_RightParen:
164
0
  case CodeCompletionString::CK_LeftBracket:
165
0
  case CodeCompletionString::CK_RightBracket:
166
0
  case CodeCompletionString::CK_LeftBrace:
167
0
  case CodeCompletionString::CK_RightBrace:
168
0
  case CodeCompletionString::CK_LeftAngle:
169
0
  case CodeCompletionString::CK_RightAngle:
170
0
  case CodeCompletionString::CK_Comma:
171
0
  case CodeCompletionString::CK_ResultType:
172
0
  case CodeCompletionString::CK_Colon:
173
0
  case CodeCompletionString::CK_SemiColon:
174
0
  case CodeCompletionString::CK_Equal:
175
0
  case CodeCompletionString::CK_HorizontalSpace:
176
0
  case CodeCompletionString::CK_VerticalSpace:
177
0
    return nullptr;
178
179
70
  case CodeCompletionString::CK_Optional:
180
    // Note: treated as an empty text block.
181
70
    return (*CCStr)[chunk_number].Optional;
182
70
  }
183
184
0
  llvm_unreachable("Invalid CompletionKind!");
185
0
}
186
187
114k
unsigned clang_getNumCompletionChunks(CXCompletionString completion_string) {
188
114k
  CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
189
114k
  return CCStr? CCStr->size() : 
00
;
190
114k
}
191
192
113k
unsigned clang_getCompletionPriority(CXCompletionString completion_string) {
193
113k
  CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
194
113k
  return CCStr? CCStr->getPriority() : 
unsigned(CCP_Unlikely)0
;
195
113k
}
196
  
197
enum CXAvailabilityKind 
198
113k
clang_getCompletionAvailability(CXCompletionString completion_string) {
199
113k
  CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
200
113k
  return CCStr? static_cast<CXAvailabilityKind>(CCStr->getAvailability())
201
113k
              : 
CXAvailability_Available0
;
202
113k
}
203
204
unsigned clang_getCompletionNumAnnotations(CXCompletionString completion_string)
205
113k
{
206
113k
  CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
207
113k
  return CCStr ? CCStr->getAnnotationCount() : 
00
;
208
113k
}
209
210
CXString clang_getCompletionAnnotation(CXCompletionString completion_string,
211
6
                                       unsigned annotation_number) {
212
6
  CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
213
6
  return CCStr ? cxstring::createRef(CCStr->getAnnotation(annotation_number))
214
6
               : 
cxstring::createNull()0
;
215
6
}
216
217
CXString
218
clang_getCompletionParent(CXCompletionString completion_string,
219
113k
                          CXCursorKind *kind) {
220
113k
  if (kind)
221
113k
    *kind = CXCursor_NotImplemented;
222
  
223
113k
  CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
224
113k
  if (!CCStr)
225
0
    return cxstring::createNull();
226
  
227
113k
  return cxstring::createRef(CCStr->getParentContextName());
228
113k
}
229
230
CXString
231
113k
clang_getCompletionBriefComment(CXCompletionString completion_string) {
232
113k
  CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
233
234
113k
  if (!CCStr)
235
0
    return cxstring::createNull();
236
237
113k
  return cxstring::createRef(CCStr->getBriefComment());
238
113k
}
239
240
namespace {
241
242
/// The CXCodeCompleteResults structure we allocate internally;
243
/// the client only sees the initial CXCodeCompleteResults structure.
244
///
245
/// Normally, clients of CXString shouldn't care whether or not a CXString is
246
/// managed by a pool or by explicitly malloc'ed memory.  But
247
/// AllocatedCXCodeCompleteResults outlives the CXTranslationUnit, so we can
248
/// not rely on the StringPool in the TU.
249
struct AllocatedCXCodeCompleteResults : public CXCodeCompleteResults {
250
  AllocatedCXCodeCompleteResults(IntrusiveRefCntPtr<FileManager> FileMgr);
251
  ~AllocatedCXCodeCompleteResults();
252
  
253
  /// Diagnostics produced while performing code completion.
254
  SmallVector<StoredDiagnostic, 8> Diagnostics;
255
256
  /// Allocated API-exposed wrappters for Diagnostics.
257
  SmallVector<std::unique_ptr<CXStoredDiagnostic>, 8> DiagnosticsWrappers;
258
259
  IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts;
260
  
261
  /// Diag object
262
  IntrusiveRefCntPtr<DiagnosticsEngine> Diag;
263
  
264
  /// Language options used to adjust source locations.
265
  LangOptions LangOpts;
266
267
  /// File manager, used for diagnostics.
268
  IntrusiveRefCntPtr<FileManager> FileMgr;
269
270
  /// Source manager, used for diagnostics.
271
  IntrusiveRefCntPtr<SourceManager> SourceMgr;
272
  
273
  /// Temporary buffers that will be deleted once we have finished with
274
  /// the code-completion results.
275
  SmallVector<const llvm::MemoryBuffer *, 1> TemporaryBuffers;
276
  
277
  /// Allocator used to store globally cached code-completion results.
278
  std::shared_ptr<clang::GlobalCodeCompletionAllocator>
279
      CachedCompletionAllocator;
280
281
  /// Allocator used to store code completion results.
282
  std::shared_ptr<clang::GlobalCodeCompletionAllocator> CodeCompletionAllocator;
283
284
  /// Context under which completion occurred.
285
  enum clang::CodeCompletionContext::Kind ContextKind;
286
  
287
  /// A bitfield representing the acceptable completions for the
288
  /// current context.
289
  unsigned long long Contexts;
290
  
291
  /// The kind of the container for the current context for completions.
292
  enum CXCursorKind ContainerKind;
293
294
  /// The USR of the container for the current context for completions.
295
  std::string ContainerUSR;
296
297
  /// a boolean value indicating whether there is complete information
298
  /// about the container
299
  unsigned ContainerIsIncomplete;
300
  
301
  /// A string containing the Objective-C selector entered thus far for a
302
  /// message send.
303
  std::string Selector;
304
305
  /// Vector of fix-its for each completion result that *must* be applied
306
  /// before that result for the corresponding completion item.
307
  std::vector<std::vector<FixItHint>> FixItsVector;
308
};
309
310
} // end anonymous namespace
311
312
unsigned clang_getCompletionNumFixIts(CXCodeCompleteResults *results,
313
113k
                                      unsigned completion_index) {
314
113k
  AllocatedCXCodeCompleteResults *allocated_results = (AllocatedCXCodeCompleteResults *)results;
315
316
113k
  if (!allocated_results || allocated_results->FixItsVector.size() <= completion_index)
317
113k
    return 0;
318
319
24
  return static_cast<unsigned>(allocated_results->FixItsVector[completion_index].size());
320
113k
}
321
322
CXString clang_getCompletionFixIt(CXCodeCompleteResults *results,
323
                                  unsigned completion_index,
324
                                  unsigned fixit_index,
325
12
                                  CXSourceRange *replacement_range) {
326
12
  AllocatedCXCodeCompleteResults *allocated_results = (AllocatedCXCodeCompleteResults *)results;
327
328
12
  if (!allocated_results || allocated_results->FixItsVector.size() <= completion_index) {
329
0
    if (replacement_range)
330
0
      *replacement_range = clang_getNullRange();
331
0
    return cxstring::createNull();
332
0
  }
333
334
12
  ArrayRef<FixItHint> FixIts = allocated_results->FixItsVector[completion_index];
335
12
  if (FixIts.size() <= fixit_index) {
336
0
    if (replacement_range)
337
0
      *replacement_range = clang_getNullRange();
338
0
    return cxstring::createNull();
339
0
  }
340
341
12
  const FixItHint &FixIt = FixIts[fixit_index];
342
12
  if (replacement_range) {
343
12
    *replacement_range = cxloc::translateSourceRange(
344
12
        *allocated_results->SourceMgr, allocated_results->LangOpts,
345
12
        FixIt.RemoveRange);
346
12
  }
347
348
12
  return cxstring::createRef(FixIt.CodeToInsert.c_str());
349
12
}
350
351
/// Tracks the number of code-completion result objects that are 
352
/// currently active.
353
///
354
/// Used for debugging purposes only.
355
static std::atomic<unsigned> CodeCompletionResultObjects;
356
357
AllocatedCXCodeCompleteResults::AllocatedCXCodeCompleteResults(
358
    IntrusiveRefCntPtr<FileManager> FileMgr)
359
    : CXCodeCompleteResults(), DiagOpts(new DiagnosticOptions),
360
      Diag(new DiagnosticsEngine(
361
          IntrusiveRefCntPtr<DiagnosticIDs>(new DiagnosticIDs), &*DiagOpts)),
362
      FileMgr(std::move(FileMgr)),
363
      SourceMgr(new SourceManager(*Diag, *this->FileMgr)),
364
      CodeCompletionAllocator(
365
          std::make_shared<clang::GlobalCodeCompletionAllocator>()),
366
      Contexts(CXCompletionContext_Unknown),
367
721
      ContainerKind(CXCursor_InvalidCode), ContainerIsIncomplete(1) {
368
721
  if (getenv("LIBCLANG_OBJTRACKING"))
369
0
    fprintf(stderr, "+++ %u completion results\n",
370
0
            ++CodeCompletionResultObjects);
371
721
}
372
  
373
718
AllocatedCXCodeCompleteResults::~AllocatedCXCodeCompleteResults() {
374
718
  delete [] Results;
375
376
794
  for (unsigned I = 0, N = TemporaryBuffers.size(); I != N; 
++I76
)
377
76
    delete TemporaryBuffers[I];
378
379
718
  if (getenv("LIBCLANG_OBJTRACKING"))
380
0
    fprintf(stderr, "--- %u completion results\n",
381
0
            --CodeCompletionResultObjects);
382
718
}
383
384
static unsigned long long getContextsForContextKind(
385
                                          enum CodeCompletionContext::Kind kind, 
386
716
                                                    Sema &S) {
387
716
  unsigned long long contexts = 0;
388
716
  switch (kind) {
389
0
    case CodeCompletionContext::CCC_OtherWithMacros: {
390
      //We can allow macros here, but we don't know what else is permissible
391
      //So we'll say the only thing permissible are macros
392
0
      contexts = CXCompletionContext_MacroName;
393
0
      break;
394
0
    }
395
40
    case CodeCompletionContext::CCC_TopLevel:
396
41
    case CodeCompletionContext::CCC_ObjCIvarList:
397
44
    case CodeCompletionContext::CCC_ClassStructUnion:
398
53
    case CodeCompletionContext::CCC_Type: {
399
53
      contexts = CXCompletionContext_AnyType | 
400
53
                 CXCompletionContext_ObjCInterface;
401
53
      if (S.getLangOpts().CPlusPlus) {
402
18
        contexts |= CXCompletionContext_EnumTag |
403
18
                    CXCompletionContext_UnionTag |
404
18
                    CXCompletionContext_StructTag |
405
18
                    CXCompletionContext_ClassTag |
406
18
                    CXCompletionContext_NestedNameSpecifier;
407
18
      }
408
53
      break;
409
44
    }
410
75
    case CodeCompletionContext::CCC_Statement: {
411
75
      contexts = CXCompletionContext_AnyType |
412
75
                 CXCompletionContext_ObjCInterface |
413
75
                 CXCompletionContext_AnyValue;
414
75
      if (S.getLangOpts().CPlusPlus) {
415
31
        contexts |= CXCompletionContext_EnumTag |
416
31
                    CXCompletionContext_UnionTag |
417
31
                    CXCompletionContext_StructTag |
418
31
                    CXCompletionContext_ClassTag |
419
31
                    CXCompletionContext_NestedNameSpecifier;
420
31
      }
421
75
      break;
422
44
    }
423
186
    case CodeCompletionContext::CCC_Expression: {
424
186
      contexts = CXCompletionContext_AnyValue;
425
186
      if (S.getLangOpts().CPlusPlus) {
426
106
        contexts |= CXCompletionContext_AnyType |
427
106
                    CXCompletionContext_ObjCInterface |
428
106
                    CXCompletionContext_EnumTag |
429
106
                    CXCompletionContext_UnionTag |
430
106
                    CXCompletionContext_StructTag |
431
106
                    CXCompletionContext_ClassTag |
432
106
                    CXCompletionContext_NestedNameSpecifier;
433
106
      }
434
186
      break;
435
44
    }
436
7
    case CodeCompletionContext::CCC_ObjCMessageReceiver: {
437
7
      contexts = CXCompletionContext_ObjCObjectValue |
438
7
                 CXCompletionContext_ObjCSelectorValue |
439
7
                 CXCompletionContext_ObjCInterface;
440
7
      if (S.getLangOpts().CPlusPlus) {
441
2
        contexts |= CXCompletionContext_CXXClassTypeValue |
442
2
                    CXCompletionContext_AnyType |
443
2
                    CXCompletionContext_EnumTag |
444
2
                    CXCompletionContext_UnionTag |
445
2
                    CXCompletionContext_StructTag |
446
2
                    CXCompletionContext_ClassTag |
447
2
                    CXCompletionContext_NestedNameSpecifier;
448
2
      }
449
7
      break;
450
44
    }
451
22
    case CodeCompletionContext::CCC_DotMemberAccess: {
452
22
      contexts = CXCompletionContext_DotMemberAccess;
453
22
      break;
454
44
    }
455
24
    case CodeCompletionContext::CCC_ArrowMemberAccess: {
456
24
      contexts = CXCompletionContext_ArrowMemberAccess;
457
24
      break;
458
44
    }
459
24
    case CodeCompletionContext::CCC_ObjCPropertyAccess: {
460
24
      contexts = CXCompletionContext_ObjCPropertyAccess;
461
24
      break;
462
44
    }
463
0
    case CodeCompletionContext::CCC_EnumTag: {
464
0
      contexts = CXCompletionContext_EnumTag |
465
0
                 CXCompletionContext_NestedNameSpecifier;
466
0
      break;
467
44
    }
468
0
    case CodeCompletionContext::CCC_UnionTag: {
469
0
      contexts = CXCompletionContext_UnionTag |
470
0
                 CXCompletionContext_NestedNameSpecifier;
471
0
      break;
472
44
    }
473
6
    case CodeCompletionContext::CCC_ClassOrStructTag: {
474
6
      contexts = CXCompletionContext_StructTag |
475
6
                 CXCompletionContext_ClassTag |
476
6
                 CXCompletionContext_NestedNameSpecifier;
477
6
      break;
478
44
    }
479
9
    case CodeCompletionContext::CCC_ObjCProtocolName: {
480
9
      contexts = CXCompletionContext_ObjCProtocol;
481
9
      break;
482
44
    }
483
0
    case CodeCompletionContext::CCC_Namespace: {
484
0
      contexts = CXCompletionContext_Namespace;
485
0
      break;
486
44
    }
487
14
    case CodeCompletionContext::CCC_SymbolOrNewName:
488
49
    case CodeCompletionContext::CCC_Symbol: {
489
49
      contexts = CXCompletionContext_NestedNameSpecifier;
490
49
      break;
491
14
    }
492
8
    case CodeCompletionContext::CCC_MacroNameUse: {
493
8
      contexts = CXCompletionContext_MacroName;
494
8
      break;
495
14
    }
496
45
    case CodeCompletionContext::CCC_NaturalLanguage: {
497
45
      contexts = CXCompletionContext_NaturalLanguage;
498
45
      break;
499
14
    }
500
0
    case CodeCompletionContext::CCC_IncludedFile: {
501
0
      contexts = CXCompletionContext_IncludedFile;
502
0
      break;
503
14
    }
504
2
    case CodeCompletionContext::CCC_SelectorName: {
505
2
      contexts = CXCompletionContext_ObjCSelectorName;
506
2
      break;
507
14
    }
508
13
    case CodeCompletionContext::CCC_ParenthesizedExpression: {
509
13
      contexts = CXCompletionContext_AnyType |
510
13
                 CXCompletionContext_ObjCInterface |
511
13
                 CXCompletionContext_AnyValue;
512
13
      if (S.getLangOpts().CPlusPlus) {
513
0
        contexts |= CXCompletionContext_EnumTag |
514
0
                    CXCompletionContext_UnionTag |
515
0
                    CXCompletionContext_StructTag |
516
0
                    CXCompletionContext_ClassTag |
517
0
                    CXCompletionContext_NestedNameSpecifier;
518
0
      }
519
13
      break;
520
14
    }
521
50
    case CodeCompletionContext::CCC_ObjCInstanceMessage: {
522
50
      contexts = CXCompletionContext_ObjCInstanceMessage;
523
50
      break;
524
14
    }
525
22
    case CodeCompletionContext::CCC_ObjCClassMessage: {
526
22
      contexts = CXCompletionContext_ObjCClassMessage;
527
22
      break;
528
14
    }
529
8
    case CodeCompletionContext::CCC_ObjCInterfaceName: {
530
8
      contexts = CXCompletionContext_ObjCInterface;
531
8
      break;
532
14
    }
533
5
    case CodeCompletionContext::CCC_ObjCCategoryName: {
534
5
      contexts = CXCompletionContext_ObjCCategory;
535
5
      break;
536
14
    }
537
65
    case CodeCompletionContext::CCC_Other:
538
66
    case CodeCompletionContext::CCC_ObjCInterface:
539
70
    case CodeCompletionContext::CCC_ObjCImplementation:
540
87
    case CodeCompletionContext::CCC_NewName:
541
87
    case CodeCompletionContext::CCC_MacroName:
542
93
    case CodeCompletionContext::CCC_PreprocessorExpression:
543
105
    case CodeCompletionContext::CCC_PreprocessorDirective:
544
105
    case CodeCompletionContext::CCC_Attribute:
545
107
    case CodeCompletionContext::CCC_TypeQualifiers: {
546
      //Only Clang results should be accepted, so we'll set all of the other
547
      //context bits to 0 (i.e. the empty set)
548
107
      contexts = CXCompletionContext_Unexposed;
549
107
      break;
550
105
    }
551
1
    case CodeCompletionContext::CCC_Recovery: {
552
      //We don't know what the current context is, so we'll return unknown
553
      //This is the equivalent of setting all of the other context bits
554
1
      contexts = CXCompletionContext_Unknown;
555
1
      break;
556
105
    }
557
716
  }
558
716
  return contexts;
559
716
}
560
561
namespace {
562
  class CaptureCompletionResults : public CodeCompleteConsumer {
563
    AllocatedCXCodeCompleteResults &AllocatedResults;
564
    CodeCompletionTUInfo CCTUInfo;
565
    SmallVector<CXCompletionResult, 16> StoredResults;
566
    CXTranslationUnit *TU;
567
  public:
568
    CaptureCompletionResults(const CodeCompleteOptions &Opts,
569
                             AllocatedCXCodeCompleteResults &Results,
570
                             CXTranslationUnit *TranslationUnit)
571
        : CodeCompleteConsumer(Opts), AllocatedResults(Results),
572
721
          CCTUInfo(Results.CodeCompletionAllocator), TU(TranslationUnit) {}
573
718
    ~CaptureCompletionResults() override { Finish(); }
574
575
    void ProcessCodeCompleteResults(Sema &S, 
576
                                    CodeCompletionContext Context,
577
                                    CodeCompletionResult *Results,
578
716
                                    unsigned NumResults) override {
579
716
      StoredResults.reserve(StoredResults.size() + NumResults);
580
716
      if (includeFixIts())
581
2
        AllocatedResults.FixItsVector.reserve(NumResults);
582
158k
      for (unsigned I = 0; I != NumResults; 
++I158k
) {
583
158k
        CodeCompletionString *StoredCompletion
584
158k
          = Results[I].CreateCodeCompletionString(S, Context, getAllocator(),
585
158k
                                                  getCodeCompletionTUInfo(),
586
158k
                                                  includeBriefComments());
587
        
588
158k
        CXCompletionResult R;
589
158k
        R.CursorKind = Results[I].CursorKind;
590
158k
        R.CompletionString = StoredCompletion;
591
158k
        StoredResults.push_back(R);
592
158k
        if (includeFixIts())
593
12
          AllocatedResults.FixItsVector.emplace_back(std::move(Results[I].FixIts));
594
158k
      }
595
596
716
      enum CodeCompletionContext::Kind contextKind = Context.getKind();
597
      
598
716
      AllocatedResults.ContextKind = contextKind;
599
716
      AllocatedResults.Contexts = getContextsForContextKind(contextKind, S);
600
      
601
716
      AllocatedResults.Selector = "";
602
716
      ArrayRef<IdentifierInfo *> SelIdents = Context.getSelIdents();
603
716
      for (ArrayRef<IdentifierInfo *>::iterator I = SelIdents.begin(),
604
716
                                                E = SelIdents.end();
605
738
           I != E; 
++I22
) {
606
22
        if (IdentifierInfo *selIdent = *I)
607
22
          AllocatedResults.Selector += selIdent->getName();
608
22
        AllocatedResults.Selector += ":";
609
22
      }
610
      
611
716
      QualType baseType = Context.getBaseType();
612
716
      NamedDecl *D = nullptr;
613
614
716
      if (!baseType.isNull()) {
615
        // Get the declaration for a class/struct/union/enum type
616
139
        if (const TagType *Tag = baseType->getAs<TagType>())
617
37
          D = Tag->getDecl();
618
        // Get the @interface declaration for a (possibly-qualified) Objective-C
619
        // object pointer type, e.g., NSString*
620
102
        else if (const ObjCObjectPointerType *ObjPtr = 
621
102
                 baseType->getAs<ObjCObjectPointerType>())
622
80
          D = ObjPtr->getInterfaceDecl();
623
        // Get the @interface declaration for an Objective-C object type
624
22
        else if (const ObjCObjectType *Obj = baseType->getAs<ObjCObjectType>())
625
20
          D = Obj->getInterface();
626
        // Get the class for a C++ injected-class-name
627
2
        else if (const InjectedClassNameType *Injected =
628
2
                 baseType->getAs<InjectedClassNameType>())
629
0
          D = Injected->getDecl();
630
139
      }
631
632
716
      if (D != nullptr) {
633
129
        CXCursor cursor = cxcursor::MakeCXCursor(D, *TU);
634
635
129
        AllocatedResults.ContainerKind = clang_getCursorKind(cursor);
636
637
129
        CXString CursorUSR = clang_getCursorUSR(cursor);
638
129
        AllocatedResults.ContainerUSR = clang_getCString(CursorUSR);
639
129
        clang_disposeString(CursorUSR);
640
641
129
        const Type *type = baseType.getTypePtrOrNull();
642
129
        if (type) {
643
129
          AllocatedResults.ContainerIsIncomplete = type->isIncompleteType();
644
129
        }
645
0
        else {
646
0
          AllocatedResults.ContainerIsIncomplete = 1;
647
0
        }
648
129
      }
649
587
      else {
650
587
        AllocatedResults.ContainerKind = CXCursor_InvalidCode;
651
587
        AllocatedResults.ContainerUSR.clear();
652
587
        AllocatedResults.ContainerIsIncomplete = 1;
653
587
      }
654
716
    }
655
656
    void ProcessOverloadCandidates(Sema &S, unsigned CurrentArg,
657
                                   OverloadCandidate *Candidates,
658
                                   unsigned NumCandidates,
659
101
                                   SourceLocation OpenParLoc) override {
660
101
      StoredResults.reserve(StoredResults.size() + NumCandidates);
661
264
      for (unsigned I = 0; I != NumCandidates; 
++I163
) {
662
163
        CodeCompletionString *StoredCompletion
663
163
          = Candidates[I].CreateSignatureString(CurrentArg, S, getAllocator(),
664
163
                                                getCodeCompletionTUInfo(),
665
163
                                                includeBriefComments());
666
        
667
163
        CXCompletionResult R;
668
163
        R.CursorKind = CXCursor_OverloadCandidate;
669
163
        R.CompletionString = StoredCompletion;
670
163
        StoredResults.push_back(R);
671
163
      }
672
101
    }
673
674
161k
    CodeCompletionAllocator &getAllocator() override {
675
161k
      return *AllocatedResults.CodeCompletionAllocator;
676
161k
    }
677
678
161k
    CodeCompletionTUInfo &getCodeCompletionTUInfo() override { return CCTUInfo;}
679
680
  private:
681
718
    void Finish() {
682
718
      AllocatedResults.Results = new CXCompletionResult [StoredResults.size()];
683
718
      AllocatedResults.NumResults = StoredResults.size();
684
718
      std::memcpy(AllocatedResults.Results, StoredResults.data(), 
685
718
                  StoredResults.size() * sizeof(CXCompletionResult));
686
718
      StoredResults.clear();
687
718
    }
688
  };
689
}
690
691
static CXCodeCompleteResults *
692
clang_codeCompleteAt_Impl(CXTranslationUnit TU, const char *complete_filename,
693
                          unsigned complete_line, unsigned complete_column,
694
                          ArrayRef<CXUnsavedFile> unsaved_files,
695
721
                          unsigned options) {
696
721
  bool IncludeBriefComments = options & CXCodeComplete_IncludeBriefComments;
697
721
  bool SkipPreamble = options & CXCodeComplete_SkipPreamble;
698
721
  bool IncludeFixIts = options & CXCodeComplete_IncludeCompletionsWithFixIts;
699
700
#ifdef UDP_CODE_COMPLETION_LOGGER
701
#ifdef UDP_CODE_COMPLETION_LOGGER_PORT
702
  const llvm::TimeRecord &StartTime =  llvm::TimeRecord::getCurrentTime();
703
#endif
704
#endif
705
721
  bool EnableLogging = getenv("LIBCLANG_CODE_COMPLETION_LOGGING") != nullptr;
706
707
721
  if (cxtu::isNotUsableTU(TU)) {
708
0
    LOG_BAD_TU(TU);
709
0
    return nullptr;
710
0
  }
711
712
721
  ASTUnit *AST = cxtu::getASTUnit(TU);
713
721
  if (!AST)
714
0
    return nullptr;
715
716
721
  CIndexer *CXXIdx = TU->CIdx;
717
721
  if (CXXIdx->isOptEnabled(CXGlobalOpt_ThreadBackgroundPriorityForEditing))
718
0
    setThreadBackgroundPriority();
719
720
721
  ASTUnit::ConcurrencyCheck Check(*AST);
721
722
  // Perform the remapping of source files.
723
721
  SmallVector<ASTUnit::RemappedFile, 4> RemappedFiles;
724
725
721
  for (auto &UF : unsaved_files) {
726
4
    std::unique_ptr<llvm::MemoryBuffer> MB =
727
4
        llvm::MemoryBuffer::getMemBufferCopy(getContents(UF), UF.Filename);
728
4
    RemappedFiles.push_back(std::make_pair(UF.Filename, MB.release()));
729
4
  }
730
731
721
  if (EnableLogging) {
732
    // FIXME: Add logging.
733
0
  }
734
735
  // Parse the resulting source file to find code-completion results.
736
721
  AllocatedCXCodeCompleteResults *Results = new AllocatedCXCodeCompleteResults(
737
721
      &AST->getFileManager());
738
721
  Results->Results = nullptr;
739
721
  Results->NumResults = 0;
740
  
741
  // Create a code-completion consumer to capture the results.
742
721
  CodeCompleteOptions Opts;
743
721
  Opts.IncludeBriefComments = IncludeBriefComments;
744
721
  Opts.LoadExternal = !SkipPreamble;
745
721
  Opts.IncludeFixIts = IncludeFixIts;
746
721
  CaptureCompletionResults Capture(Opts, *Results, &TU);
747
748
  // Perform completion.
749
721
  std::vector<const char *> CArgs;
750
721
  for (const auto &Arg : TU->Arguments)
751
4.70k
    CArgs.push_back(Arg.c_str());
752
721
  std::string CompletionInvocation =
753
721
      llvm::formatv("-code-completion-at={0}:{1}:{2}", complete_filename,
754
721
                    complete_line, complete_column)
755
721
          .str();
756
721
  LibclangInvocationReporter InvocationReporter(
757
721
      *CXXIdx, LibclangInvocationReporter::OperationKind::CompletionOperation,
758
721
      TU->ParsingOptions, CArgs, CompletionInvocation, unsaved_files);
759
721
  AST->CodeComplete(complete_filename, complete_line, complete_column,
760
721
                    RemappedFiles, (options & CXCodeComplete_IncludeMacros),
761
721
                    (options & CXCodeComplete_IncludeCodePatterns),
762
721
                    IncludeBriefComments, Capture,
763
721
                    CXXIdx->getPCHContainerOperations(), *Results->Diag,
764
721
                    Results->LangOpts, *Results->SourceMgr, *Results->FileMgr,
765
721
                    Results->Diagnostics, Results->TemporaryBuffers);
766
767
721
  Results->DiagnosticsWrappers.resize(Results->Diagnostics.size());
768
769
  // Keep a reference to the allocator used for cached global completions, so
770
  // that we can be sure that the memory used by our code completion strings
771
  // doesn't get freed due to subsequent reparses (while the code completion
772
  // results are still active).
773
721
  Results->CachedCompletionAllocator = AST->getCachedCompletionAllocator();
774
775
  
776
777
#ifdef UDP_CODE_COMPLETION_LOGGER
778
#ifdef UDP_CODE_COMPLETION_LOGGER_PORT
779
  const llvm::TimeRecord &EndTime =  llvm::TimeRecord::getCurrentTime();
780
  SmallString<256> LogResult;
781
  llvm::raw_svector_ostream os(LogResult);
782
783
  // Figure out the language and whether or not it uses PCH.
784
  const char *lang = 0;
785
  bool usesPCH = false;
786
787
  for (std::vector<const char*>::iterator I = argv.begin(), E = argv.end();
788
       I != E; ++I) {
789
    if (*I == 0)
790
      continue;
791
    if (strcmp(*I, "-x") == 0) {
792
      if (I + 1 != E) {
793
        lang = *(++I);
794
        continue;
795
      }
796
    }
797
    else if (strcmp(*I, "-include") == 0) {
798
      if (I+1 != E) {
799
        const char *arg = *(++I);
800
        SmallString<512> pchName;
801
        {
802
          llvm::raw_svector_ostream os(pchName);
803
          os << arg << ".pth";
804
        }
805
        pchName.push_back('\0');
806
        llvm::sys::fs::file_status stat_results;
807
        if (!llvm::sys::fs::status(pchName, stat_results))
808
          usesPCH = true;
809
        continue;
810
      }
811
    }
812
  }
813
814
  os << "{ ";
815
  os << "\"wall\": " << (EndTime.getWallTime() - StartTime.getWallTime());
816
  os << ", \"numRes\": " << Results->NumResults;
817
  os << ", \"diags\": " << Results->Diagnostics.size();
818
  os << ", \"pch\": " << (usesPCH ? "true" : "false");
819
  os << ", \"lang\": \"" << (lang ? lang : "<unknown>") << '"';
820
  const char *name = getlogin();
821
  os << ", \"user\": \"" << (name ? name : "unknown") << '"';
822
  os << ", \"clangVer\": \"" << getClangFullVersion() << '"';
823
  os << " }";
824
825
  StringRef res = os.str();
826
  if (res.size() > 0) {
827
    do {
828
      // Setup the UDP socket.
829
      struct sockaddr_in servaddr;
830
      bzero(&servaddr, sizeof(servaddr));
831
      servaddr.sin_family = AF_INET;
832
      servaddr.sin_port = htons(UDP_CODE_COMPLETION_LOGGER_PORT);
833
      if (inet_pton(AF_INET, UDP_CODE_COMPLETION_LOGGER,
834
                    &servaddr.sin_addr) <= 0)
835
        break;
836
837
      int sockfd = socket(AF_INET, SOCK_DGRAM, 0);
838
      if (sockfd < 0)
839
        break;
840
841
      sendto(sockfd, res.data(), res.size(), 0,
842
             (struct sockaddr *)&servaddr, sizeof(servaddr));
843
      close(sockfd);
844
    }
845
    while (false);
846
  }
847
#endif
848
#endif
849
721
  return Results;
850
721
}
851
852
CXCodeCompleteResults *clang_codeCompleteAt(CXTranslationUnit TU,
853
                                            const char *complete_filename,
854
                                            unsigned complete_line,
855
                                            unsigned complete_column,
856
                                            struct CXUnsavedFile *unsaved_files,
857
                                            unsigned num_unsaved_files,
858
721
                                            unsigned options) {
859
721
  LOG_FUNC_SECTION {
860
0
    *Log << TU << ' '
861
0
         << complete_filename << ':' << complete_line << ':' << complete_column;
862
0
  }
863
864
721
  if (num_unsaved_files && 
!unsaved_files4
)
865
0
    return nullptr;
866
867
721
  CXCodeCompleteResults *result;
868
721
  auto CodeCompleteAtImpl = [=, &result]() {
869
721
    result = clang_codeCompleteAt_Impl(
870
721
        TU, complete_filename, complete_line, complete_column,
871
721
        llvm::makeArrayRef(unsaved_files, num_unsaved_files), options);
872
721
  };
873
874
721
  llvm::CrashRecoveryContext CRC;
875
876
721
  if (!RunSafely(CRC, CodeCompleteAtImpl)) {
877
3
    fprintf(stderr, "libclang: crash detected in code completion\n");
878
3
    cxtu::getASTUnit(TU)->setUnsafeToFree(true);
879
3
    return nullptr;
880
718
  } else if (getenv("LIBCLANG_RESOURCE_USAGE"))
881
0
    PrintLibclangResourceUsage(TU);
882
883
718
  return result;
884
721
}
885
886
537
unsigned clang_defaultCodeCompleteOptions(void) {
887
537
  return CXCodeComplete_IncludeMacros;
888
537
}
889
890
718
void clang_disposeCodeCompleteResults(CXCodeCompleteResults *ResultsIn) {
891
718
  if (!ResultsIn)
892
0
    return;
893
894
718
  AllocatedCXCodeCompleteResults *Results
895
718
    = static_cast<AllocatedCXCodeCompleteResults*>(ResultsIn);
896
718
  delete Results;
897
718
}
898
  
899
unsigned 
900
534
clang_codeCompleteGetNumDiagnostics(CXCodeCompleteResults *ResultsIn) {
901
534
  AllocatedCXCodeCompleteResults *Results
902
534
    = static_cast<AllocatedCXCodeCompleteResults*>(ResultsIn);
903
534
  if (!Results)
904
0
    return 0;
905
906
534
  return Results->Diagnostics.size();
907
534
}
908
909
CXDiagnostic 
910
clang_codeCompleteGetDiagnostic(CXCodeCompleteResults *ResultsIn,
911
205
                                unsigned Index) {
912
205
  AllocatedCXCodeCompleteResults *Results
913
205
    = static_cast<AllocatedCXCodeCompleteResults*>(ResultsIn);
914
205
  if (!Results || Index >= Results->Diagnostics.size())
915
0
    return nullptr;
916
917
205
  CXStoredDiagnostic *Diag = Results->DiagnosticsWrappers[Index].get();
918
205
  if (!Diag)
919
205
    Diag = (Results->DiagnosticsWrappers[Index] =
920
205
                std::make_unique<CXStoredDiagnostic>(
921
205
                    Results->Diagnostics[Index], Results->LangOpts))
922
205
               .get();
923
205
  return Diag;
924
205
}
925
926
unsigned long long
927
534
clang_codeCompleteGetContexts(CXCodeCompleteResults *ResultsIn) {
928
534
  AllocatedCXCodeCompleteResults *Results
929
534
    = static_cast<AllocatedCXCodeCompleteResults*>(ResultsIn);
930
534
  if (!Results)
931
0
    return 0;
932
  
933
534
  return Results->Contexts;
934
534
}
935
936
enum CXCursorKind clang_codeCompleteGetContainerKind(
937
                                               CXCodeCompleteResults *ResultsIn,
938
534
                                                     unsigned *IsIncomplete) {
939
534
  AllocatedCXCodeCompleteResults *Results =
940
534
    static_cast<AllocatedCXCodeCompleteResults *>(ResultsIn);
941
534
  if (!Results)
942
0
    return CXCursor_InvalidCode;
943
944
534
  if (IsIncomplete != nullptr) {
945
534
    *IsIncomplete = Results->ContainerIsIncomplete;
946
534
  }
947
  
948
534
  return Results->ContainerKind;
949
534
}
950
  
951
125
CXString clang_codeCompleteGetContainerUSR(CXCodeCompleteResults *ResultsIn) {
952
125
  AllocatedCXCodeCompleteResults *Results =
953
125
    static_cast<AllocatedCXCodeCompleteResults *>(ResultsIn);
954
125
  if (!Results)
955
0
    return cxstring::createEmpty();
956
957
125
  return cxstring::createRef(Results->ContainerUSR.c_str());
958
125
}
959
960
  
961
534
CXString clang_codeCompleteGetObjCSelector(CXCodeCompleteResults *ResultsIn) {
962
534
  AllocatedCXCodeCompleteResults *Results =
963
534
    static_cast<AllocatedCXCodeCompleteResults *>(ResultsIn);
964
534
  if (!Results)
965
0
    return cxstring::createEmpty();
966
  
967
534
  return cxstring::createDup(Results->Selector);
968
534
}
969
  
970
/// Simple utility function that appends a \p New string to the given
971
/// \p Old string, using the \p Buffer for storage.
972
///
973
/// \param Old The string to which we are appending. This parameter will be
974
/// updated to reflect the complete string.
975
///
976
///
977
/// \param New The string to append to \p Old.
978
///
979
/// \param Buffer A buffer that stores the actual, concatenated string. It will
980
/// be used if the old string is already-non-empty.
981
static void AppendToString(StringRef &Old, StringRef New,
982
7.53M
                           SmallString<256> &Buffer) {
983
7.53M
  if (Old.empty()) {
984
7.52M
    Old = New;
985
7.52M
    return;
986
7.52M
  }
987
  
988
2.16k
  if (Buffer.empty())
989
2.00k
    Buffer.append(Old.begin(), Old.end());
990
2.16k
  Buffer.append(New.begin(), New.end());
991
2.16k
  Old = Buffer.str();
992
2.16k
}
993
994
/// Get the typed-text blocks from the given code-completion string
995
/// and return them as a single string.
996
///
997
/// \param String The code-completion string whose typed-text blocks will be
998
/// concatenated.
999
///
1000
/// \param Buffer A buffer used for storage of the completed name.
1001
static StringRef GetTypedName(CodeCompletionString *String,
1002
7.54M
                                    SmallString<256> &Buffer) {
1003
7.54M
  StringRef Result;
1004
7.54M
  for (CodeCompletionString::iterator C = String->begin(), CEnd = String->end();
1005
17.2M
       C != CEnd; 
++C9.74M
) {
1006
9.74M
    if (C->Kind == CodeCompletionString::CK_TypedText)
1007
7.53M
      AppendToString(Result, C->Text, Buffer);
1008
9.74M
  }
1009
  
1010
7.54M
  return Result;
1011
7.54M
}
1012
1013
namespace {
1014
  struct OrderCompletionResults {
1015
    bool operator()(const CXCompletionResult &XR, 
1016
3.77M
                    const CXCompletionResult &YR) const {
1017
3.77M
      CodeCompletionString *X
1018
3.77M
        = (CodeCompletionString *)XR.CompletionString;
1019
3.77M
      CodeCompletionString *Y
1020
3.77M
        = (CodeCompletionString *)YR.CompletionString;
1021
1022
3.77M
      SmallString<256> XBuffer;
1023
3.77M
      StringRef XText = GetTypedName(X, XBuffer);
1024
3.77M
      SmallString<256> YBuffer;
1025
3.77M
      StringRef YText = GetTypedName(Y, YBuffer);
1026
      
1027
3.77M
      if (XText.empty() || 
YText.empty()3.77M
)
1028
17.7k
        return !XText.empty();
1029
            
1030
3.75M
      int result = XText.compare_insensitive(YText);
1031
3.75M
      if (result < 0)
1032
3.55M
        return true;
1033
201k
      if (result > 0)
1034
195k
        return false;
1035
      
1036
5.71k
      result = XText.compare(YText);
1037
5.71k
      return result < 0;
1038
201k
    }
1039
  };
1040
}
1041
1042
void clang_sortCodeCompletionResults(CXCompletionResult *Results,
1043
534
                                     unsigned NumResults) {
1044
534
  std::stable_sort(Results, Results + NumResults, OrderCompletionResults());
1045
534
}