Coverage Report

Created: 2021-12-07 08:24

/Users/buildslave/jenkins/workspace/coverage/llvm-project/clang/include/clang/AST/TemplateName.h
Line
Count
Source (jump to first uncovered line)
1
//===- TemplateName.h - C++ Template Name Representation --------*- C++ -*-===//
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 defines the TemplateName interface and subclasses.
10
//
11
//===----------------------------------------------------------------------===//
12
13
#ifndef LLVM_CLANG_AST_TEMPLATENAME_H
14
#define LLVM_CLANG_AST_TEMPLATENAME_H
15
16
#include "clang/AST/DependenceFlags.h"
17
#include "clang/AST/NestedNameSpecifier.h"
18
#include "clang/Basic/LLVM.h"
19
#include "llvm/ADT/FoldingSet.h"
20
#include "llvm/ADT/PointerIntPair.h"
21
#include "llvm/ADT/PointerUnion.h"
22
#include "llvm/Support/PointerLikeTypeTraits.h"
23
#include <cassert>
24
25
namespace clang {
26
27
class ASTContext;
28
class DependentTemplateName;
29
class DiagnosticBuilder;
30
class IdentifierInfo;
31
class NamedDecl;
32
class NestedNameSpecifier;
33
enum OverloadedOperatorKind : int;
34
class OverloadedTemplateStorage;
35
class AssumedTemplateStorage;
36
class PartialDiagnostic;
37
struct PrintingPolicy;
38
class QualifiedTemplateName;
39
class SubstTemplateTemplateParmPackStorage;
40
class SubstTemplateTemplateParmStorage;
41
class TemplateArgument;
42
class TemplateDecl;
43
class TemplateTemplateParmDecl;
44
45
/// Implementation class used to describe either a set of overloaded
46
/// template names or an already-substituted template template parameter pack.
47
class UncommonTemplateNameStorage {
48
protected:
49
  enum Kind {
50
    Overloaded,
51
    Assumed, // defined in DeclarationName.h
52
    SubstTemplateTemplateParm,
53
    SubstTemplateTemplateParmPack
54
  };
55
56
  struct BitsTag {
57
    /// A Kind.
58
    unsigned Kind : 2;
59
60
    /// The number of stored templates or template arguments,
61
    /// depending on which subclass we have.
62
    unsigned Size : 30;
63
  };
64
65
  union {
66
    struct BitsTag Bits;
67
    void *PointerAlignment;
68
  };
69
70
110k
  UncommonTemplateNameStorage(Kind kind, unsigned size) {
71
110k
    Bits.Kind = kind;
72
110k
    Bits.Size = size;
73
110k
  }
74
75
public:
76
12
  unsigned size() const { return Bits.Size; }
77
78
306k
  OverloadedTemplateStorage *getAsOverloadedStorage()  {
79
306k
    return Bits.Kind == Overloaded
80
306k
             ? 
reinterpret_cast<OverloadedTemplateStorage *>(this)218k
81
306k
             : 
nullptr87.8k
;
82
306k
  }
83
84
112k
  AssumedTemplateStorage *getAsAssumedTemplateName()  {
85
112k
    return Bits.Kind == Assumed
86
112k
             ? 
reinterpret_cast<AssumedTemplateStorage *>(this)596
87
112k
             : 
nullptr111k
;
88
112k
  }
89
90
230k
  SubstTemplateTemplateParmStorage *getAsSubstTemplateTemplateParm() {
91
230k
    return Bits.Kind == SubstTemplateTemplateParm
92
230k
             ? 
reinterpret_cast<SubstTemplateTemplateParmStorage *>(this)230k
93
230k
             : 
nullptr67
;
94
230k
  }
95
96
250
  SubstTemplateTemplateParmPackStorage *getAsSubstTemplateTemplateParmPack() {
97
250
    return Bits.Kind == SubstTemplateTemplateParmPack
98
250
             ? 
reinterpret_cast<SubstTemplateTemplateParmPackStorage *>(this)11
99
250
             : 
nullptr239
;
100
250
  }
101
};
102
103
/// A structure for storing the information associated with an
104
/// overloaded template name.
105
class OverloadedTemplateStorage : public UncommonTemplateNameStorage {
106
  friend class ASTContext;
107
108
  OverloadedTemplateStorage(unsigned size)
109
106k
      : UncommonTemplateNameStorage(Overloaded, size) {}
110
111
106k
  NamedDecl **getStorage() {
112
106k
    return reinterpret_cast<NamedDecl **>(this + 1);
113
106k
  }
114
109k
  NamedDecl * const *getStorage() const {
115
109k
    return reinterpret_cast<NamedDecl *const *>(this + 1);
116
109k
  }
117
118
public:
119
  using iterator = NamedDecl *const *;
120
121
109k
  iterator begin() const { return getStorage(); }
122
3
  iterator end() const { return getStorage() + size(); }
123
124
0
  llvm::ArrayRef<NamedDecl*> decls() const {
125
0
    return llvm::makeArrayRef(begin(), end());
126
0
  }
127
};
128
129
/// A structure for storing an already-substituted template template
130
/// parameter pack.
131
///
132
/// This kind of template names occurs when the parameter pack has been
133
/// provided with a template template argument pack in a context where its
134
/// enclosing pack expansion could not be fully expanded.
135
class SubstTemplateTemplateParmPackStorage
136
  : public UncommonTemplateNameStorage, public llvm::FoldingSetNode
137
{
138
  TemplateTemplateParmDecl *Parameter;
139
  const TemplateArgument *Arguments;
140
141
public:
142
  SubstTemplateTemplateParmPackStorage(TemplateTemplateParmDecl *Parameter,
143
                                       unsigned Size,
144
                                       const TemplateArgument *Arguments)
145
      : UncommonTemplateNameStorage(SubstTemplateTemplateParmPack, Size),
146
8
        Parameter(Parameter), Arguments(Arguments) {}
147
148
  /// Retrieve the template template parameter pack being substituted.
149
2
  TemplateTemplateParmDecl *getParameterPack() const {
150
2
    return Parameter;
151
2
  }
152
153
  /// Retrieve the template template argument pack with which this
154
  /// parameter was substituted.
155
  TemplateArgument getArgumentPack() const;
156
157
  void Profile(llvm::FoldingSetNodeID &ID, ASTContext &Context);
158
159
  static void Profile(llvm::FoldingSetNodeID &ID,
160
                      ASTContext &Context,
161
                      TemplateTemplateParmDecl *Parameter,
162
                      const TemplateArgument &ArgPack);
163
};
164
165
/// Represents a C++ template name within the type system.
166
///
167
/// A C++ template name refers to a template within the C++ type
168
/// system. In most cases, a template name is simply a reference to a
169
/// class template, e.g.
170
///
171
/// \code
172
/// template<typename T> class X { };
173
///
174
/// X<int> xi;
175
/// \endcode
176
///
177
/// Here, the 'X' in \c X<int> is a template name that refers to the
178
/// declaration of the class template X, above. Template names can
179
/// also refer to function templates, C++0x template aliases, etc.
180
///
181
/// Some template names are dependent. For example, consider:
182
///
183
/// \code
184
/// template<typename MetaFun, typename T1, typename T2> struct apply2 {
185
///   typedef typename MetaFun::template apply<T1, T2>::type type;
186
/// };
187
/// \endcode
188
///
189
/// Here, "apply" is treated as a template name within the typename
190
/// specifier in the typedef. "apply" is a nested template, and can
191
/// only be understood in the context of
192
class TemplateName {
193
  using StorageType =
194
      llvm::PointerUnion<TemplateDecl *, UncommonTemplateNameStorage *,
195
                         QualifiedTemplateName *, DependentTemplateName *>;
196
197
  StorageType Storage;
198
199
  explicit TemplateName(void *Ptr);
200
201
public:
202
  // Kind of name that is actually stored.
203
  enum NameKind {
204
    /// A single template declaration.
205
    Template,
206
207
    /// A set of overloaded template declarations.
208
    OverloadedTemplate,
209
210
    /// An unqualified-id that has been assumed to name a function template
211
    /// that will be found by ADL.
212
    AssumedTemplate,
213
214
    /// A qualified template name, where the qualification is kept
215
    /// to describe the source code as written.
216
    QualifiedTemplate,
217
218
    /// A dependent template name that has not been resolved to a
219
    /// template (or set of templates).
220
    DependentTemplate,
221
222
    /// A template template parameter that has been substituted
223
    /// for some other template name.
224
    SubstTemplateTemplateParm,
225
226
    /// A template template parameter pack that has been substituted for
227
    /// a template template argument pack, but has not yet been expanded into
228
    /// individual arguments.
229
    SubstTemplateTemplateParmPack
230
  };
231
232
3.06M
  TemplateName() = default;
233
  explicit TemplateName(TemplateDecl *Template);
234
  explicit TemplateName(OverloadedTemplateStorage *Storage);
235
  explicit TemplateName(AssumedTemplateStorage *Storage);
236
  explicit TemplateName(SubstTemplateTemplateParmStorage *Storage);
237
  explicit TemplateName(SubstTemplateTemplateParmPackStorage *Storage);
238
  explicit TemplateName(QualifiedTemplateName *Qual);
239
  explicit TemplateName(DependentTemplateName *Dep);
240
241
  /// Determine whether this template name is NULL.
242
  bool isNull() const;
243
244
  // Get the kind of name that is actually stored.
245
  NameKind getKind() const;
246
247
  /// Retrieve the underlying template declaration that
248
  /// this template name refers to, if known.
249
  ///
250
  /// \returns The template declaration that this template name refers
251
  /// to, if any. If the template name does not refer to a specific
252
  /// declaration because it is a dependent name, or if it refers to a
253
  /// set of function templates, returns NULL.
254
  TemplateDecl *getAsTemplateDecl() const;
255
256
  /// Retrieve the underlying, overloaded function template
257
  /// declarations that this template name refers to, if known.
258
  ///
259
  /// \returns The set of overloaded function templates that this template
260
  /// name refers to, if known. If the template name does not refer to a
261
  /// specific set of function templates because it is a dependent name or
262
  /// refers to a single template, returns NULL.
263
  OverloadedTemplateStorage *getAsOverloadedTemplate() const;
264
265
  /// Retrieve information on a name that has been assumed to be a
266
  /// template-name in order to permit a call via ADL.
267
  AssumedTemplateStorage *getAsAssumedTemplateName() const;
268
269
  /// Retrieve the substituted template template parameter, if
270
  /// known.
271
  ///
272
  /// \returns The storage for the substituted template template parameter,
273
  /// if known. Otherwise, returns NULL.
274
  SubstTemplateTemplateParmStorage *getAsSubstTemplateTemplateParm() const;
275
276
  /// Retrieve the substituted template template parameter pack, if
277
  /// known.
278
  ///
279
  /// \returns The storage for the substituted template template parameter pack,
280
  /// if known. Otherwise, returns NULL.
281
  SubstTemplateTemplateParmPackStorage *
282
  getAsSubstTemplateTemplateParmPack() const;
283
284
  /// Retrieve the underlying qualified template name
285
  /// structure, if any.
286
  QualifiedTemplateName *getAsQualifiedTemplateName() const;
287
288
  /// Retrieve the underlying dependent template name
289
  /// structure, if any.
290
  DependentTemplateName *getAsDependentTemplateName() const;
291
292
  TemplateName getUnderlying() const;
293
294
  /// Get the template name to substitute when this template name is used as a
295
  /// template template argument. This refers to the most recent declaration of
296
  /// the template, including any default template arguments.
297
  TemplateName getNameToSubstitute() const;
298
299
  TemplateNameDependence getDependence() const;
300
301
  /// Determines whether this is a dependent template name.
302
  bool isDependent() const;
303
304
  /// Determines whether this is a template name that somehow
305
  /// depends on a template parameter.
306
  bool isInstantiationDependent() const;
307
308
  /// Determines whether this template name contains an
309
  /// unexpanded parameter pack (for C++0x variadic templates).
310
  bool containsUnexpandedParameterPack() const;
311
312
  enum class Qualified { None, AsWritten, Fully };
313
  /// Print the template name.
314
  ///
315
  /// \param OS the output stream to which the template name will be
316
  /// printed.
317
  ///
318
  /// \param Qual print the (Qualified::None) simple name,
319
  /// (Qualified::AsWritten) any written (possibly partial) qualifier, or
320
  /// (Qualified::Fully) the fully qualified name.
321
  void print(raw_ostream &OS, const PrintingPolicy &Policy,
322
             Qualified Qual = Qualified::AsWritten) const;
323
324
  /// Debugging aid that dumps the template name.
325
  void dump(raw_ostream &OS) const;
326
327
  /// Debugging aid that dumps the template name to standard
328
  /// error.
329
  void dump() const;
330
331
12.3M
  void Profile(llvm::FoldingSetNodeID &ID) {
332
12.3M
    ID.AddPointer(Storage.getOpaqueValue());
333
12.3M
  }
334
335
  /// Retrieve the template name as a void pointer.
336
4.78M
  void *getAsVoidPointer() const { return Storage.getOpaqueValue(); }
337
338
  /// Build a template name from a void pointer.
339
3.35M
  static TemplateName getFromVoidPointer(void *Ptr) {
340
3.35M
    return TemplateName(Ptr);
341
3.35M
  }
342
};
343
344
/// Insertion operator for diagnostics.  This allows sending TemplateName's
345
/// into a diagnostic with <<.
346
const StreamingDiagnostic &operator<<(const StreamingDiagnostic &DB,
347
                                      TemplateName N);
348
349
/// A structure for storing the information associated with a
350
/// substituted template template parameter.
351
class SubstTemplateTemplateParmStorage
352
  : public UncommonTemplateNameStorage, public llvm::FoldingSetNode {
353
  friend class ASTContext;
354
355
  TemplateTemplateParmDecl *Parameter;
356
  TemplateName Replacement;
357
358
  SubstTemplateTemplateParmStorage(TemplateTemplateParmDecl *parameter,
359
                                   TemplateName replacement)
360
      : UncommonTemplateNameStorage(SubstTemplateTemplateParm, 0),
361
3.38k
        Parameter(parameter), Replacement(replacement) {}
362
363
public:
364
108
  TemplateTemplateParmDecl *getParameter() const { return Parameter; }
365
142k
  TemplateName getReplacement() const { return Replacement; }
366
367
  void Profile(llvm::FoldingSetNodeID &ID);
368
369
  static void Profile(llvm::FoldingSetNodeID &ID,
370
                      TemplateTemplateParmDecl *parameter,
371
                      TemplateName replacement);
372
};
373
374
6.34M
inline TemplateName TemplateName::getUnderlying() const {
375
6.34M
  if (SubstTemplateTemplateParmStorage *subst
376
6.34M
        = getAsSubstTemplateTemplateParm())
377
23.8k
    return subst->getReplacement().getUnderlying();
378
6.31M
  return *this;
379
6.34M
}
380
381
/// Represents a template name that was expressed as a
382
/// qualified name.
383
///
384
/// This kind of template name refers to a template name that was
385
/// preceded by a nested name specifier, e.g., \c std::vector. Here,
386
/// the nested name specifier is "std::" and the template name is the
387
/// declaration for "vector". The QualifiedTemplateName class is only
388
/// used to provide "sugar" for template names that were expressed
389
/// with a qualified name, and has no semantic meaning. In this
390
/// manner, it is to TemplateName what ElaboratedType is to Type,
391
/// providing extra syntactic sugar for downstream clients.
392
class QualifiedTemplateName : public llvm::FoldingSetNode {
393
  friend class ASTContext;
394
395
  /// The nested name specifier that qualifies the template name.
396
  ///
397
  /// The bit is used to indicate whether the "template" keyword was
398
  /// present before the template name itself. Note that the
399
  /// "template" keyword is always redundant in this case (otherwise,
400
  /// the template name would be a dependent name and we would express
401
  /// this name with DependentTemplateName).
402
  llvm::PointerIntPair<NestedNameSpecifier *, 1> Qualifier;
403
404
  /// The template declaration or set of overloaded function templates
405
  /// that this qualified name refers to.
406
  TemplateDecl *Template;
407
408
  QualifiedTemplateName(NestedNameSpecifier *NNS, bool TemplateKeyword,
409
                        TemplateDecl *Template)
410
79.1k
      : Qualifier(NNS, TemplateKeyword? 1 : 0), Template(Template) {}
411
412
public:
413
  /// Return the nested name specifier that qualifies this name.
414
452k
  NestedNameSpecifier *getQualifier() const { return Qualifier.getPointer(); }
415
416
  /// Whether the template name was prefixed by the "template"
417
  /// keyword.
418
278k
  bool hasTemplateKeyword() const { return Qualifier.getInt(); }
419
420
  /// The template declaration that this qualified name refers
421
  /// to.
422
48
  TemplateDecl *getDecl() const { return Template; }
423
424
  /// The template declaration to which this qualified name
425
  /// refers.
426
1.12M
  TemplateDecl *getTemplateDecl() const { return Template; }
427
428
278k
  void Profile(llvm::FoldingSetNodeID &ID) {
429
278k
    Profile(ID, getQualifier(), hasTemplateKeyword(), getTemplateDecl());
430
278k
  }
431
432
  static void Profile(llvm::FoldingSetNodeID &ID, NestedNameSpecifier *NNS,
433
495k
                      bool TemplateKeyword, TemplateDecl *Template) {
434
495k
    ID.AddPointer(NNS);
435
495k
    ID.AddBoolean(TemplateKeyword);
436
495k
    ID.AddPointer(Template);
437
495k
  }
438
};
439
440
/// Represents a dependent template name that cannot be
441
/// resolved prior to template instantiation.
442
///
443
/// This kind of template name refers to a dependent template name,
444
/// including its nested name specifier (if any). For example,
445
/// DependentTemplateName can refer to "MetaFun::template apply",
446
/// where "MetaFun::" is the nested name specifier and "apply" is the
447
/// template name referenced. The "template" keyword is implied.
448
class DependentTemplateName : public llvm::FoldingSetNode {
449
  friend class ASTContext;
450
451
  /// The nested name specifier that qualifies the template
452
  /// name.
453
  ///
454
  /// The bit stored in this qualifier describes whether the \c Name field
455
  /// is interpreted as an IdentifierInfo pointer (when clear) or as an
456
  /// overloaded operator kind (when set).
457
  llvm::PointerIntPair<NestedNameSpecifier *, 1, bool> Qualifier;
458
459
  /// The dependent template name.
460
  union {
461
    /// The identifier template name.
462
    ///
463
    /// Only valid when the bit on \c Qualifier is clear.
464
    const IdentifierInfo *Identifier;
465
466
    /// The overloaded operator name.
467
    ///
468
    /// Only valid when the bit on \c Qualifier is set.
469
    OverloadedOperatorKind Operator;
470
  };
471
472
  /// The canonical template name to which this dependent
473
  /// template name refers.
474
  ///
475
  /// The canonical template name for a dependent template name is
476
  /// another dependent template name whose nested name specifier is
477
  /// canonical.
478
  TemplateName CanonicalTemplateName;
479
480
  DependentTemplateName(NestedNameSpecifier *Qualifier,
481
                        const IdentifierInfo *Identifier)
482
      : Qualifier(Qualifier, false), Identifier(Identifier),
483
17.3k
        CanonicalTemplateName(this) {}
484
485
  DependentTemplateName(NestedNameSpecifier *Qualifier,
486
                        const IdentifierInfo *Identifier,
487
                        TemplateName Canon)
488
      : Qualifier(Qualifier, false), Identifier(Identifier),
489
32.4k
        CanonicalTemplateName(Canon) {}
490
491
  DependentTemplateName(NestedNameSpecifier *Qualifier,
492
                        OverloadedOperatorKind Operator)
493
      : Qualifier(Qualifier, true), Operator(Operator),
494
16
        CanonicalTemplateName(this) {}
495
496
  DependentTemplateName(NestedNameSpecifier *Qualifier,
497
                        OverloadedOperatorKind Operator,
498
                        TemplateName Canon)
499
       : Qualifier(Qualifier, true), Operator(Operator),
500
8
         CanonicalTemplateName(Canon) {}
501
502
public:
503
  /// Return the nested name specifier that qualifies this name.
504
116k
  NestedNameSpecifier *getQualifier() const { return Qualifier.getPointer(); }
505
506
  /// Determine whether this template name refers to an identifier.
507
249k
  bool isIdentifier() const { return !Qualifier.getInt(); }
508
509
  /// Returns the identifier to which this template name refers.
510
129k
  const IdentifierInfo *getIdentifier() const {
511
129k
    assert(isIdentifier() && "Template name isn't an identifier?");
512
0
    return Identifier;
513
129k
  }
514
515
  /// Determine whether this template name refers to an overloaded
516
  /// operator.
517
85
  bool isOverloadedOperator() const { return Qualifier.getInt(); }
518
519
  /// Return the overloaded operator to which this template name refers.
520
85
  OverloadedOperatorKind getOperator() const {
521
85
    assert(isOverloadedOperator() &&
522
85
           "Template name isn't an overloaded operator?");
523
0
    return Operator;
524
85
  }
525
526
95.3k
  void Profile(llvm::FoldingSetNodeID &ID) {
527
95.3k
    if (isIdentifier())
528
95.2k
      Profile(ID, getQualifier(), getIdentifier());
529
39
    else
530
39
      Profile(ID, getQualifier(), getOperator());
531
95.3k
  }
532
533
  static void Profile(llvm::FoldingSetNodeID &ID, NestedNameSpecifier *NNS,
534
165k
                      const IdentifierInfo *Identifier) {
535
165k
    ID.AddPointer(NNS);
536
165k
    ID.AddBoolean(false);
537
165k
    ID.AddPointer(Identifier);
538
165k
  }
539
540
  static void Profile(llvm::FoldingSetNodeID &ID, NestedNameSpecifier *NNS,
541
99
                      OverloadedOperatorKind Operator) {
542
99
    ID.AddPointer(NNS);
543
99
    ID.AddBoolean(true);
544
99
    ID.AddInteger(Operator);
545
99
  }
546
};
547
548
} // namespace clang.
549
550
namespace llvm {
551
552
/// The clang::TemplateName class is effectively a pointer.
553
template<>
554
struct PointerLikeTypeTraits<clang::TemplateName> {
555
2.94M
  static inline void *getAsVoidPointer(clang::TemplateName TN) {
556
2.94M
    return TN.getAsVoidPointer();
557
2.94M
  }
558
559
2.95M
  static inline clang::TemplateName getFromVoidPointer(void *Ptr) {
560
2.95M
    return clang::TemplateName::getFromVoidPointer(Ptr);
561
2.95M
  }
562
563
  // No bits are available!
564
  static constexpr int NumLowBitsAvailable = 0;
565
};
566
567
} // namespace llvm.
568
569
#endif // LLVM_CLANG_AST_TEMPLATENAME_H