Coverage Report

Created: 2021-08-24 07:12

/Users/buildslave/jenkins/workspace/coverage/llvm-project/clang/include/clang/Sema/Initialization.h
Line
Count
Source (jump to first uncovered line)
1
//===- Initialization.h - Semantic Analysis for Initializers ----*- 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 provides supporting data types for initialization of objects.
10
//
11
//===----------------------------------------------------------------------===//
12
13
#ifndef LLVM_CLANG_SEMA_INITIALIZATION_H
14
#define LLVM_CLANG_SEMA_INITIALIZATION_H
15
16
#include "clang/AST/ASTContext.h"
17
#include "clang/AST/Attr.h"
18
#include "clang/AST/Decl.h"
19
#include "clang/AST/DeclAccessPair.h"
20
#include "clang/AST/DeclarationName.h"
21
#include "clang/AST/Expr.h"
22
#include "clang/AST/Type.h"
23
#include "clang/Basic/IdentifierTable.h"
24
#include "clang/Basic/LLVM.h"
25
#include "clang/Basic/LangOptions.h"
26
#include "clang/Basic/SourceLocation.h"
27
#include "clang/Basic/Specifiers.h"
28
#include "clang/Sema/Overload.h"
29
#include "clang/Sema/Ownership.h"
30
#include "llvm/ADT/ArrayRef.h"
31
#include "llvm/ADT/SmallVector.h"
32
#include "llvm/ADT/StringRef.h"
33
#include "llvm/ADT/iterator_range.h"
34
#include "llvm/Support/Casting.h"
35
#include <cassert>
36
#include <cstdint>
37
#include <string>
38
39
namespace clang {
40
41
class APValue;
42
class CXXBaseSpecifier;
43
class CXXConstructorDecl;
44
class ObjCMethodDecl;
45
class Sema;
46
47
/// Describes an entity that is being initialized.
48
class alignas(8) InitializedEntity {
49
public:
50
  /// Specifies the kind of entity being initialized.
51
  enum EntityKind {
52
    /// The entity being initialized is a variable.
53
    EK_Variable,
54
55
    /// The entity being initialized is a function parameter.
56
    EK_Parameter,
57
58
    /// The entity being initialized is a non-type template parameter.
59
    EK_TemplateParameter,
60
61
    /// The entity being initialized is the result of a function call.
62
    EK_Result,
63
64
    /// The entity being initialized is the result of a statement expression.
65
    EK_StmtExprResult,
66
67
    /// The entity being initialized is an exception object that
68
    /// is being thrown.
69
    EK_Exception,
70
71
    /// The entity being initialized is a non-static data member
72
    /// subobject.
73
    EK_Member,
74
75
    /// The entity being initialized is an element of an array.
76
    EK_ArrayElement,
77
78
    /// The entity being initialized is an object (or array of
79
    /// objects) allocated via new.
80
    EK_New,
81
82
    /// The entity being initialized is a temporary object.
83
    EK_Temporary,
84
85
    /// The entity being initialized is a base member subobject.
86
    EK_Base,
87
88
    /// The initialization is being done by a delegating constructor.
89
    EK_Delegating,
90
91
    /// The entity being initialized is an element of a vector.
92
    /// or vector.
93
    EK_VectorElement,
94
95
    /// The entity being initialized is a field of block descriptor for
96
    /// the copied-in c++ object.
97
    EK_BlockElement,
98
99
    /// The entity being initialized is a field of block descriptor for the
100
    /// copied-in lambda object that's used in the lambda to block conversion.
101
    EK_LambdaToBlockConversionBlockElement,
102
103
    /// The entity being initialized is the real or imaginary part of a
104
    /// complex number.
105
    EK_ComplexElement,
106
107
    /// The entity being initialized is the field that captures a
108
    /// variable in a lambda.
109
    EK_LambdaCapture,
110
111
    /// The entity being initialized is the initializer for a compound
112
    /// literal.
113
    EK_CompoundLiteralInit,
114
115
    /// The entity being implicitly initialized back to the formal
116
    /// result type.
117
    EK_RelatedResult,
118
119
    /// The entity being initialized is a function parameter; function
120
    /// is member of group of audited CF APIs.
121
    EK_Parameter_CF_Audited,
122
123
    /// The entity being initialized is a structured binding of a
124
    /// decomposition declaration.
125
    EK_Binding,
126
127
    // Note: err_init_conversion_failed in DiagnosticSemaKinds.td uses this
128
    // enum as an index for its first %select.  When modifying this list,
129
    // that diagnostic text needs to be updated as well.
130
  };
131
132
private:
133
  /// The kind of entity being initialized.
134
  EntityKind Kind;
135
136
  /// If non-NULL, the parent entity in which this
137
  /// initialization occurs.
138
  const InitializedEntity *Parent = nullptr;
139
140
  /// The type of the object or reference being initialized.
141
  QualType Type;
142
143
  /// The mangling number for the next reference temporary to be created.
144
  mutable unsigned ManglingNumber = 0;
145
146
  struct LN {
147
    /// When Kind == EK_Result, EK_Exception, EK_New, the
148
    /// location of the 'return', 'throw', or 'new' keyword,
149
    /// respectively. When Kind == EK_Temporary, the location where
150
    /// the temporary is being created.
151
    SourceLocation Location;
152
153
    /// Whether the entity being initialized may end up using the
154
    /// named return value optimization (NRVO).
155
    bool NRVO;
156
  };
157
158
  struct VD {
159
    /// The VarDecl, FieldDecl, or BindingDecl being initialized.
160
    ValueDecl *VariableOrMember;
161
162
    /// When Kind == EK_Member, whether this is an implicit member
163
    /// initialization in a copy or move constructor. These can perform array
164
    /// copies.
165
    bool IsImplicitFieldInit;
166
167
    /// When Kind == EK_Member, whether this is the initial initialization
168
    /// check for a default member initializer.
169
    bool IsDefaultMemberInit;
170
  };
171
172
  struct C {
173
    /// The name of the variable being captured by an EK_LambdaCapture.
174
    IdentifierInfo *VarID;
175
176
    /// The source location at which the capture occurs.
177
    SourceLocation Location;
178
  };
179
180
  union {
181
    /// When Kind == EK_Variable, EK_Member, EK_Binding, or
182
    /// EK_TemplateParameter, the variable, binding, or template parameter.
183
    VD Variable;
184
185
    /// When Kind == EK_RelatedResult, the ObjectiveC method where
186
    /// result type was implicitly changed to accommodate ARC semantics.
187
    ObjCMethodDecl *MethodDecl;
188
189
    /// When Kind == EK_Parameter, the ParmVarDecl, with the
190
    /// integer indicating whether the parameter is "consumed".
191
    llvm::PointerIntPair<ParmVarDecl *, 1> Parameter;
192
193
    /// When Kind == EK_Temporary or EK_CompoundLiteralInit, the type
194
    /// source information for the temporary.
195
    TypeSourceInfo *TypeInfo;
196
197
    struct LN LocAndNRVO;
198
199
    /// When Kind == EK_Base, the base specifier that provides the
200
    /// base class. The integer specifies whether the base is an inherited
201
    /// virtual base.
202
    llvm::PointerIntPair<const CXXBaseSpecifier *, 1> Base;
203
204
    /// When Kind == EK_ArrayElement, EK_VectorElement, or
205
    /// EK_ComplexElement, the index of the array or vector element being
206
    /// initialized.
207
    unsigned Index;
208
209
    struct C Capture;
210
  };
211
212
6.45M
  InitializedEntity() {};
213
214
  /// Create the initialization entity for a variable.
215
  InitializedEntity(VarDecl *Var, EntityKind EK = EK_Variable)
216
2.34M
      : Kind(EK), Type(Var->getType()), Variable{Var, false, false} {}
217
218
  /// Create the initialization entity for the result of a
219
  /// function, throwing an object, performing an explicit cast, or
220
  /// initializing a parameter for which there is no declaration.
221
  InitializedEntity(EntityKind Kind, SourceLocation Loc, QualType Type,
222
                    bool NRVO = false)
223
4.09M
      : Kind(Kind), Type(Type) {
224
4.09M
    new (&LocAndNRVO) LN;
225
4.09M
    LocAndNRVO.Location = Loc;
226
4.09M
    LocAndNRVO.NRVO = NRVO;
227
4.09M
  }
228
229
  /// Create the initialization entity for a member subobject.
230
  InitializedEntity(FieldDecl *Member, const InitializedEntity *Parent,
231
                    bool Implicit, bool DefaultMemberInit)
232
      : Kind(EK_Member), Parent(Parent), Type(Member->getType()),
233
223k
        Variable{Member, Implicit, DefaultMemberInit} {}
234
235
  /// Create the initialization entity for an array element.
236
  InitializedEntity(ASTContext &Context, unsigned Index,
237
                    const InitializedEntity &Parent);
238
239
  /// Create the initialization entity for a lambda capture.
240
  InitializedEntity(IdentifierInfo *VarID, QualType FieldType, SourceLocation Loc)
241
5.86k
      : Kind(EK_LambdaCapture), Type(FieldType) {
242
5.86k
    new (&Capture) C;
243
5.86k
    Capture.VarID = VarID;
244
5.86k
    Capture.Location = Loc;
245
5.86k
  }
246
247
public:
248
  /// Create the initialization entity for a variable.
249
2.34M
  static InitializedEntity InitializeVariable(VarDecl *Var) {
250
2.34M
    return InitializedEntity(Var);
251
2.34M
  }
252
253
  /// Create the initialization entity for a parameter.
254
  static InitializedEntity InitializeParameter(ASTContext &Context,
255
206k
                                               ParmVarDecl *Parm) {
256
206k
    return InitializeParameter(Context, Parm, Parm->getType());
257
206k
  }
258
259
  /// Create the initialization entity for a parameter, but use
260
  /// another type.
261
  static InitializedEntity
262
6.36M
  InitializeParameter(ASTContext &Context, ParmVarDecl *Parm, QualType Type) {
263
6.36M
    bool Consumed = (Context.getLangOpts().ObjCAutoRefCount &&
264
6.36M
                     
Parm->hasAttr<NSConsumedAttr>()17.2k
);
265
266
6.36M
    InitializedEntity Entity;
267
6.36M
    Entity.Kind = EK_Parameter;
268
6.36M
    Entity.Type =
269
6.36M
      Context.getVariableArrayDecayedType(Type.getUnqualifiedType());
270
6.36M
    Entity.Parent = nullptr;
271
6.36M
    Entity.Parameter = {Parm, Consumed};
272
6.36M
    return Entity;
273
6.36M
  }
274
275
  /// Create the initialization entity for a parameter that is
276
  /// only known by its type.
277
  static InitializedEntity InitializeParameter(ASTContext &Context,
278
                                               QualType Type,
279
51.0k
                                               bool Consumed) {
280
51.0k
    InitializedEntity Entity;
281
51.0k
    Entity.Kind = EK_Parameter;
282
51.0k
    Entity.Type = Context.getVariableArrayDecayedType(Type);
283
51.0k
    Entity.Parent = nullptr;
284
51.0k
    Entity.Parameter = {nullptr, Consumed};
285
51.0k
    return Entity;
286
51.0k
  }
287
288
  /// Create the initialization entity for a template parameter.
289
  static InitializedEntity
290
361
  InitializeTemplateParameter(QualType T, NonTypeTemplateParmDecl *Param) {
291
361
    InitializedEntity Entity;
292
361
    Entity.Kind = EK_TemplateParameter;
293
361
    Entity.Type = T;
294
361
    Entity.Parent = nullptr;
295
361
    Entity.Variable = {Param, false, false};
296
361
    return Entity;
297
361
  }
298
299
  /// Create the initialization entity for the result of a function.
300
  static InitializedEntity InitializeResult(SourceLocation ReturnLoc,
301
2.50M
                                            QualType Type, bool NRVO) {
302
2.50M
    return InitializedEntity(EK_Result, ReturnLoc, Type, NRVO);
303
2.50M
  }
304
305
  static InitializedEntity InitializeStmtExprResult(SourceLocation ReturnLoc,
306
7.84k
                                            QualType Type) {
307
7.84k
    return InitializedEntity(EK_StmtExprResult, ReturnLoc, Type);
308
7.84k
  }
309
310
  static InitializedEntity InitializeBlock(SourceLocation BlockVarLoc,
311
472
                                           QualType Type, bool NRVO) {
312
472
    return InitializedEntity(EK_BlockElement, BlockVarLoc, Type, NRVO);
313
472
  }
314
315
  static InitializedEntity InitializeLambdaToBlock(SourceLocation BlockVarLoc,
316
31
                                                   QualType Type, bool NRVO) {
317
31
    return InitializedEntity(EK_LambdaToBlockConversionBlockElement,
318
31
                             BlockVarLoc, Type, NRVO);
319
31
  }
320
321
  /// Create the initialization entity for an exception object.
322
  static InitializedEntity InitializeException(SourceLocation ThrowLoc,
323
6.16k
                                               QualType Type, bool NRVO) {
324
6.16k
    return InitializedEntity(EK_Exception, ThrowLoc, Type, NRVO);
325
6.16k
  }
326
327
  /// Create the initialization entity for an object allocated via new.
328
5.17k
  static InitializedEntity InitializeNew(SourceLocation NewLoc, QualType Type) {
329
5.17k
    return InitializedEntity(EK_New, NewLoc, Type);
330
5.17k
  }
331
332
  /// Create the initialization entity for a temporary.
333
1.12M
  static InitializedEntity InitializeTemporary(QualType Type) {
334
1.12M
    return InitializeTemporary(nullptr, Type);
335
1.12M
  }
336
337
  /// Create the initialization entity for a temporary.
338
393k
  static InitializedEntity InitializeTemporary(TypeSourceInfo *TypeInfo) {
339
393k
    return InitializeTemporary(TypeInfo, TypeInfo->getType());
340
393k
  }
341
342
  /// Create the initialization entity for a temporary.
343
  static InitializedEntity InitializeTemporary(TypeSourceInfo *TypeInfo,
344
1.51M
                                               QualType Type) {
345
1.51M
    InitializedEntity Result(EK_Temporary, SourceLocation(), Type);
346
1.51M
    Result.TypeInfo = TypeInfo;
347
1.51M
    return Result;
348
1.51M
  }
349
350
  /// Create the initialization entity for a related result.
351
  static InitializedEntity InitializeRelatedResult(ObjCMethodDecl *MD,
352
920
                                                   QualType Type) {
353
920
    InitializedEntity Result(EK_RelatedResult, SourceLocation(), Type);
354
920
    Result.MethodDecl = MD;
355
920
    return Result;
356
920
  }
357
358
  /// Create the initialization entity for a base class subobject.
359
  static InitializedEntity
360
  InitializeBase(ASTContext &Context, const CXXBaseSpecifier *Base,
361
                 bool IsInheritedVirtualBase,
362
                 const InitializedEntity *Parent = nullptr);
363
364
  /// Create the initialization entity for a delegated constructor.
365
446
  static InitializedEntity InitializeDelegation(QualType Type) {
366
446
    return InitializedEntity(EK_Delegating, SourceLocation(), Type);
367
446
  }
368
369
  /// Create the initialization entity for a member subobject.
370
  static InitializedEntity
371
  InitializeMember(FieldDecl *Member,
372
                   const InitializedEntity *Parent = nullptr,
373
219k
                   bool Implicit = false) {
374
219k
    return InitializedEntity(Member, Parent, Implicit, false);
375
219k
  }
376
377
  /// Create the initialization entity for a member subobject.
378
  static InitializedEntity
379
  InitializeMember(IndirectFieldDecl *Member,
380
                   const InitializedEntity *Parent = nullptr,
381
253
                   bool Implicit = false) {
382
253
    return InitializedEntity(Member->getAnonField(), Parent, Implicit, false);
383
253
  }
384
385
  /// Create the initialization entity for a default member initializer.
386
  static InitializedEntity
387
3.23k
  InitializeMemberFromDefaultMemberInitializer(FieldDecl *Member) {
388
3.23k
    return InitializedEntity(Member, nullptr, false, true);
389
3.23k
  }
390
391
  /// Create the initialization entity for an array element.
392
  static InitializedEntity InitializeElement(ASTContext &Context,
393
                                             unsigned Index,
394
306k
                                             const InitializedEntity &Parent) {
395
306k
    return InitializedEntity(Context, Index, Parent);
396
306k
  }
397
398
  /// Create the initialization entity for a structured binding.
399
80
  static InitializedEntity InitializeBinding(VarDecl *Binding) {
400
80
    return InitializedEntity(Binding, EK_Binding);
401
80
  }
402
403
  /// Create the initialization entity for a lambda capture.
404
  ///
405
  /// \p VarID The name of the entity being captured, or nullptr for 'this'.
406
  static InitializedEntity InitializeLambdaCapture(IdentifierInfo *VarID,
407
                                                   QualType FieldType,
408
5.86k
                                                   SourceLocation Loc) {
409
5.86k
    return InitializedEntity(VarID, FieldType, Loc);
410
5.86k
  }
411
412
  /// Create the entity for a compound literal initializer.
413
62.0k
  static InitializedEntity InitializeCompoundLiteralInit(TypeSourceInfo *TSI) {
414
62.0k
    InitializedEntity Result(EK_CompoundLiteralInit, SourceLocation(),
415
62.0k
                             TSI->getType());
416
62.0k
    Result.TypeInfo = TSI;
417
62.0k
    return Result;
418
62.0k
  }
419
420
  /// Determine the kind of initialization.
421
87.8M
  EntityKind getKind() const { return Kind; }
422
423
  /// Retrieve the parent of the entity being initialized, when
424
  /// the initialization itself is occurring within the context of a
425
  /// larger initialization.
426
287k
  const InitializedEntity *getParent() const { return Parent; }
427
428
  /// Retrieve type being initialized.
429
46.4M
  QualType getType() const { return Type; }
430
431
  /// Retrieve complete type-source information for the object being
432
  /// constructed, if known.
433
71.0k
  TypeSourceInfo *getTypeSourceInfo() const {
434
71.0k
    if (Kind == EK_Temporary || 
Kind == EK_CompoundLiteralInit8
)
435
71.0k
      return TypeInfo;
436
437
0
    return nullptr;
438
71.0k
  }
439
440
  /// Retrieve the name of the entity being initialized.
441
  DeclarationName getName() const;
442
443
  /// Retrieve the variable, parameter, or field being
444
  /// initialized.
445
  ValueDecl *getDecl() const;
446
447
  /// Retrieve the ObjectiveC method being initialized.
448
6
  ObjCMethodDecl *getMethodDecl() const { return MethodDecl; }
449
450
  /// Determine whether this initialization allows the named return
451
  /// value optimization, which also applies to thrown objects.
452
  bool allowsNRVO() const;
453
454
9.40M
  bool isParameterKind() const {
455
9.40M
    return (getKind() == EK_Parameter  ||
456
9.40M
            
getKind() == EK_Parameter_CF_Audited3.02M
);
457
9.40M
  }
458
459
18.5k
  bool isParamOrTemplateParamKind() const {
460
18.5k
    return isParameterKind() || 
getKind() == EK_TemplateParameter12.2k
;
461
18.5k
  }
462
463
  /// Determine whether this initialization consumes the
464
  /// parameter.
465
17.1k
  bool isParameterConsumed() const {
466
17.1k
    assert(isParameterKind() && "Not a parameter");
467
0
    return Parameter.getInt();
468
17.1k
  }
469
470
  /// Retrieve the base specifier.
471
42.5k
  const CXXBaseSpecifier *getBaseSpecifier() const {
472
42.5k
    assert(getKind() == EK_Base && "Not a base specifier");
473
0
    return Base.getPointer();
474
42.5k
  }
475
476
  /// Return whether the base is an inherited virtual base.
477
2.88k
  bool isInheritedVirtualBase() const {
478
2.88k
    assert(getKind() == EK_Base && "Not a base specifier");
479
0
    return Base.getInt();
480
2.88k
  }
481
482
  /// Determine whether this is an array new with an unknown bound.
483
34.2k
  bool isVariableLengthArrayNew() const {
484
34.2k
    return getKind() == EK_New && dyn_cast_or_null<IncompleteArrayType>(
485
170
                                      getType()->getAsArrayTypeUnsafe());
486
34.2k
  }
487
488
  /// Is this the implicit initialization of a member of a class from
489
  /// a defaulted constructor?
490
781
  bool isImplicitMemberInitializer() const {
491
781
    return getKind() == EK_Member && Variable.IsImplicitFieldInit;
492
781
  }
493
494
  /// Is this the default member initializer of a member (specified inside
495
  /// the class definition)?
496
104k
  bool isDefaultMemberInitializer() const {
497
104k
    return getKind() == EK_Member && Variable.IsDefaultMemberInit;
498
104k
  }
499
500
  /// Determine the location of the 'return' keyword when initializing
501
  /// the result of a function call.
502
1.26k
  SourceLocation getReturnLoc() const {
503
1.26k
    assert(getKind() == EK_Result && "No 'return' location!");
504
0
    return LocAndNRVO.Location;
505
1.26k
  }
506
507
  /// Determine the location of the 'throw' keyword when initializing
508
  /// an exception object.
509
0
  SourceLocation getThrowLoc() const {
510
0
    assert(getKind() == EK_Exception && "No 'throw' location!");
511
0
    return LocAndNRVO.Location;
512
0
  }
513
514
  /// If this is an array, vector, or complex number element, get the
515
  /// element's index.
516
17
  unsigned getElementIndex() const {
517
17
    assert(getKind() == EK_ArrayElement || getKind() == EK_VectorElement ||
518
17
           getKind() == EK_ComplexElement);
519
0
    return Index;
520
17
  }
521
522
  /// If this is already the initializer for an array or vector
523
  /// element, sets the element index.
524
1.55M
  void setElementIndex(unsigned Index) {
525
1.55M
    assert(getKind() == EK_ArrayElement || getKind() == EK_VectorElement ||
526
1.55M
           getKind() == EK_ComplexElement);
527
0
    this->Index = Index;
528
1.55M
  }
529
530
  /// For a lambda capture, return the capture's name.
531
2
  StringRef getCapturedVarName() const {
532
2
    assert(getKind() == EK_LambdaCapture && "Not a lambda capture!");
533
2
    return Capture.VarID ? Capture.VarID->getName() : 
"this"0
;
534
2
  }
535
536
  /// Determine the location of the capture when initializing
537
  /// field from a captured variable in a lambda.
538
0
  SourceLocation getCaptureLoc() const {
539
0
    assert(getKind() == EK_LambdaCapture && "Not a lambda capture!");
540
0
    return Capture.Location;
541
0
  }
542
543
24
  void setParameterCFAudited() {
544
24
    Kind = EK_Parameter_CF_Audited;
545
24
  }
546
547
2.34k
  unsigned allocateManglingNumber() const { return ++ManglingNumber; }
548
549
  /// Dump a representation of the initialized entity to standard error,
550
  /// for debugging purposes.
551
  void dump() const;
552
553
private:
554
  unsigned dumpImpl(raw_ostream &OS) const;
555
};
556
557
/// Describes the kind of initialization being performed, along with
558
/// location information for tokens related to the initialization (equal sign,
559
/// parentheses).
560
class InitializationKind {
561
public:
562
  /// The kind of initialization being performed.
563
  enum InitKind {
564
    /// Direct initialization
565
    IK_Direct,
566
567
    /// Direct list-initialization
568
    IK_DirectList,
569
570
    /// Copy initialization
571
    IK_Copy,
572
573
    /// Default initialization
574
    IK_Default,
575
576
    /// Value initialization
577
    IK_Value
578
  };
579
580
private:
581
  /// The context of the initialization.
582
  enum InitContext {
583
    /// Normal context
584
    IC_Normal,
585
586
    /// Normal context, but allows explicit conversion functionss
587
    IC_ExplicitConvs,
588
589
    /// Implicit context (value initialization)
590
    IC_Implicit,
591
592
    /// Static cast context
593
    IC_StaticCast,
594
595
    /// C-style cast context
596
    IC_CStyleCast,
597
598
    /// Functional cast context
599
    IC_FunctionalCast
600
  };
601
602
  /// The kind of initialization being performed.
603
  InitKind Kind : 8;
604
605
  /// The context of the initialization.
606
  InitContext Context : 8;
607
608
  /// The source locations involved in the initialization.
609
  SourceLocation Locations[3];
610
611
  InitializationKind(InitKind Kind, InitContext Context, SourceLocation Loc1,
612
                     SourceLocation Loc2, SourceLocation Loc3)
613
13.7M
      : Kind(Kind), Context(Context) {
614
13.7M
    Locations[0] = Loc1;
615
13.7M
    Locations[1] = Loc2;
616
13.7M
    Locations[2] = Loc3;
617
13.7M
  }
618
619
public:
620
  /// Create a direct initialization.
621
  static InitializationKind CreateDirect(SourceLocation InitLoc,
622
                                         SourceLocation LParenLoc,
623
440k
                                         SourceLocation RParenLoc) {
624
440k
    return InitializationKind(IK_Direct, IC_Normal,
625
440k
                              InitLoc, LParenLoc, RParenLoc);
626
440k
  }
627
628
48
  static InitializationKind CreateDirectList(SourceLocation InitLoc) {
629
48
    return InitializationKind(IK_DirectList, IC_Normal, InitLoc, InitLoc,
630
48
                              InitLoc);
631
48
  }
632
633
  static InitializationKind CreateDirectList(SourceLocation InitLoc,
634
                                             SourceLocation LBraceLoc,
635
18.0k
                                             SourceLocation RBraceLoc) {
636
18.0k
    return InitializationKind(IK_DirectList, IC_Normal, InitLoc, LBraceLoc,
637
18.0k
                              RBraceLoc);
638
18.0k
  }
639
640
  /// Create a direct initialization due to a cast that isn't a C-style
641
  /// or functional cast.
642
65.5k
  static InitializationKind CreateCast(SourceRange TypeRange) {
643
65.5k
    return InitializationKind(IK_Direct, IC_StaticCast, TypeRange.getBegin(),
644
65.5k
                              TypeRange.getBegin(), TypeRange.getEnd());
645
65.5k
  }
646
647
  /// Create a direct initialization for a C-style cast.
648
  static InitializationKind CreateCStyleCast(SourceLocation StartLoc,
649
                                             SourceRange TypeRange,
650
568k
                                             bool InitList) {
651
    // C++ cast syntax doesn't permit init lists, but C compound literals are
652
    // exactly that.
653
568k
    return InitializationKind(InitList ? 
IK_DirectList62.0k
:
IK_Direct506k
,
654
568k
                              IC_CStyleCast, StartLoc, TypeRange.getBegin(),
655
568k
                              TypeRange.getEnd());
656
568k
  }
657
658
  /// Create a direct initialization for a functional cast.
659
  static InitializationKind CreateFunctionalCast(SourceRange TypeRange,
660
59.3k
                                                 bool InitList) {
661
59.3k
    return InitializationKind(InitList ? 
IK_DirectList0
: IK_Direct,
662
59.3k
                              IC_FunctionalCast, TypeRange.getBegin(),
663
59.3k
                              TypeRange.getBegin(), TypeRange.getEnd());
664
59.3k
  }
665
666
  /// Create a copy initialization.
667
  static InitializationKind CreateCopy(SourceLocation InitLoc,
668
                                       SourceLocation EqualLoc,
669
11.7M
                                       bool AllowExplicitConvs = false) {
670
11.7M
    return InitializationKind(IK_Copy,
671
11.7M
                              AllowExplicitConvs? 
IC_ExplicitConvs24.6k
:
IC_Normal11.7M
,
672
11.7M
                              InitLoc, EqualLoc, EqualLoc);
673
11.7M
  }
674
675
  /// Create a default initialization.
676
589k
  static InitializationKind CreateDefault(SourceLocation InitLoc) {
677
589k
    return InitializationKind(IK_Default, IC_Normal, InitLoc, InitLoc, InitLoc);
678
589k
  }
679
680
  /// Create a value initialization.
681
  static InitializationKind CreateValue(SourceLocation InitLoc,
682
                                        SourceLocation LParenLoc,
683
                                        SourceLocation RParenLoc,
684
210k
                                        bool isImplicit = false) {
685
210k
    return InitializationKind(IK_Value, isImplicit ? 
IC_Implicit42.4k
:
IC_Normal168k
,
686
210k
                              InitLoc, LParenLoc, RParenLoc);
687
210k
  }
688
689
  /// Create an initialization from an initializer (which, for direct
690
  /// initialization from a parenthesized list, will be a ParenListExpr).
691
  static InitializationKind CreateForInit(SourceLocation Loc, bool DirectInit,
692
1.77M
                                          Expr *Init) {
693
1.77M
    if (!Init) 
return CreateDefault(Loc)5
;
694
1.77M
    if (!DirectInit)
695
1.68M
      return CreateCopy(Loc, Init->getBeginLoc());
696
82.7k
    if (isa<InitListExpr>(Init))
697
6.05k
      return CreateDirectList(Loc, Init->getBeginLoc(), Init->getEndLoc());
698
76.7k
    return CreateDirect(Loc, Init->getBeginLoc(), Init->getEndLoc());
699
82.7k
  }
700
701
  /// Determine the initialization kind.
702
53.3M
  InitKind getKind() const {
703
53.3M
    return Kind;
704
53.3M
  }
705
706
  /// Determine whether this initialization is an explicit cast.
707
3.55M
  bool isExplicitCast() const {
708
3.55M
    return Context >= IC_StaticCast;
709
3.55M
  }
710
711
  /// Determine whether this initialization is a static cast.
712
6
  bool isStaticCast() const { return Context == IC_StaticCast; }
713
714
  /// Determine whether this initialization is a C-style cast.
715
4.18M
  bool isCStyleOrFunctionalCast() const {
716
4.18M
    return Context >= IC_CStyleCast;
717
4.18M
  }
718
719
  /// Determine whether this is a C-style cast.
720
3.98M
  bool isCStyleCast() const {
721
3.98M
    return Context == IC_CStyleCast;
722
3.98M
  }
723
724
  /// Determine whether this is a functional-style cast.
725
3.54M
  bool isFunctionalCast() const {
726
3.54M
    return Context == IC_FunctionalCast;
727
3.54M
  }
728
729
  /// Determine whether this initialization is an implicit
730
  /// value-initialization, e.g., as occurs during aggregate
731
  /// initialization.
732
25.5k
  bool isImplicitValueInit() const { return Context == IC_Implicit; }
733
734
  /// Retrieve the location at which initialization is occurring.
735
21.7M
  SourceLocation getLocation() const { return Locations[0]; }
736
737
  /// Retrieve the source range that covers the initialization.
738
11.4k
  SourceRange getRange() const {
739
11.4k
    return SourceRange(Locations[0], Locations[2]);
740
11.4k
  }
741
742
  /// Retrieve the location of the equal sign for copy initialization
743
  /// (if present).
744
197k
  SourceLocation getEqualLoc() const {
745
197k
    assert(Kind == IK_Copy && "Only copy initialization has an '='");
746
0
    return Locations[1];
747
197k
  }
748
749
1.23M
  bool isCopyInit() const { return Kind == IK_Copy; }
750
751
  /// Retrieve whether this initialization allows the use of explicit
752
  ///        constructors.
753
675k
  bool AllowExplicit() const { return !isCopyInit(); }
754
755
  /// Retrieve whether this initialization allows the use of explicit
756
  /// conversion functions when binding a reference. If the reference is the
757
  /// first parameter in a copy or move constructor, such conversions are
758
  /// permitted even though we are performing copy-initialization.
759
2.90k
  bool allowExplicitConversionFunctionsInRefBinding() const {
760
2.90k
    return !isCopyInit() || 
Context == IC_ExplicitConvs2.73k
;
761
2.90k
  }
762
763
  /// Determine whether this initialization has a source range containing the
764
  /// locations of open and closing parentheses or braces.
765
661k
  bool hasParenOrBraceRange() const {
766
661k
    return Kind == IK_Direct || 
Kind == IK_Value339k
||
Kind == IK_DirectList179k
;
767
661k
  }
768
769
  /// Retrieve the source range containing the locations of the open
770
  /// and closing parentheses or braces for value, direct, and direct list
771
  /// initializations.
772
337k
  SourceRange getParenOrBraceRange() const {
773
337k
    assert(hasParenOrBraceRange() && "Only direct, value, and direct-list "
774
337k
                                     "initialization have parentheses or "
775
337k
                                     "braces");
776
0
    return SourceRange(Locations[1], Locations[2]);
777
337k
  }
778
};
779
780
/// Describes the sequence of initializations required to initialize
781
/// a given object or reference with a set of arguments.
782
class InitializationSequence {
783
public:
784
  /// Describes the kind of initialization sequence computed.
785
  enum SequenceKind {
786
    /// A failed initialization sequence. The failure kind tells what
787
    /// happened.
788
    FailedSequence = 0,
789
790
    /// A dependent initialization, which could not be
791
    /// type-checked due to the presence of dependent types or
792
    /// dependently-typed expressions.
793
    DependentSequence,
794
795
    /// A normal sequence.
796
    NormalSequence
797
  };
798
799
  /// Describes the kind of a particular step in an initialization
800
  /// sequence.
801
  enum StepKind {
802
    /// Resolve the address of an overloaded function to a specific
803
    /// function declaration.
804
    SK_ResolveAddressOfOverloadedFunction,
805
806
    /// Perform a derived-to-base cast, producing an rvalue.
807
    SK_CastDerivedToBasePRValue,
808
809
    /// Perform a derived-to-base cast, producing an xvalue.
810
    SK_CastDerivedToBaseXValue,
811
812
    /// Perform a derived-to-base cast, producing an lvalue.
813
    SK_CastDerivedToBaseLValue,
814
815
    /// Reference binding to an lvalue.
816
    SK_BindReference,
817
818
    /// Reference binding to a temporary.
819
    SK_BindReferenceToTemporary,
820
821
    /// An optional copy of a temporary object to another
822
    /// temporary object, which is permitted (but not required) by
823
    /// C++98/03 but not C++0x.
824
    SK_ExtraneousCopyToTemporary,
825
826
    /// Direct-initialization from a reference-related object in the
827
    /// final stage of class copy-initialization.
828
    SK_FinalCopy,
829
830
    /// Perform a user-defined conversion, either via a conversion
831
    /// function or via a constructor.
832
    SK_UserConversion,
833
834
    /// Perform a qualification conversion, producing a prvalue.
835
    SK_QualificationConversionPRValue,
836
837
    /// Perform a qualification conversion, producing an xvalue.
838
    SK_QualificationConversionXValue,
839
840
    /// Perform a qualification conversion, producing an lvalue.
841
    SK_QualificationConversionLValue,
842
843
    /// Perform a function reference conversion, see [dcl.init.ref]p4.
844
    SK_FunctionReferenceConversion,
845
846
    /// Perform a conversion adding _Atomic to a type.
847
    SK_AtomicConversion,
848
849
    /// Perform an implicit conversion sequence.
850
    SK_ConversionSequence,
851
852
    /// Perform an implicit conversion sequence without narrowing.
853
    SK_ConversionSequenceNoNarrowing,
854
855
    /// Perform list-initialization without a constructor.
856
    SK_ListInitialization,
857
858
    /// Unwrap the single-element initializer list for a reference.
859
    SK_UnwrapInitList,
860
861
    /// Rewrap the single-element initializer list for a reference.
862
    SK_RewrapInitList,
863
864
    /// Perform initialization via a constructor.
865
    SK_ConstructorInitialization,
866
867
    /// Perform initialization via a constructor, taking arguments from
868
    /// a single InitListExpr.
869
    SK_ConstructorInitializationFromList,
870
871
    /// Zero-initialize the object
872
    SK_ZeroInitialization,
873
874
    /// C assignment
875
    SK_CAssignment,
876
877
    /// Initialization by string
878
    SK_StringInit,
879
880
    /// An initialization that "converts" an Objective-C object
881
    /// (not a point to an object) to another Objective-C object type.
882
    SK_ObjCObjectConversion,
883
884
    /// Array indexing for initialization by elementwise copy.
885
    SK_ArrayLoopIndex,
886
887
    /// Array initialization by elementwise copy.
888
    SK_ArrayLoopInit,
889
890
    /// Array initialization (from an array rvalue).
891
    SK_ArrayInit,
892
893
    /// Array initialization (from an array rvalue) as a GNU extension.
894
    SK_GNUArrayInit,
895
896
    /// Array initialization from a parenthesized initializer list.
897
    /// This is a GNU C++ extension.
898
    SK_ParenthesizedArrayInit,
899
900
    /// Pass an object by indirect copy-and-restore.
901
    SK_PassByIndirectCopyRestore,
902
903
    /// Pass an object by indirect restore.
904
    SK_PassByIndirectRestore,
905
906
    /// Produce an Objective-C object pointer.
907
    SK_ProduceObjCObject,
908
909
    /// Construct a std::initializer_list from an initializer list.
910
    SK_StdInitializerList,
911
912
    /// Perform initialization via a constructor taking a single
913
    /// std::initializer_list argument.
914
    SK_StdInitializerListConstructorCall,
915
916
    /// Initialize an OpenCL sampler from an integer.
917
    SK_OCLSamplerInit,
918
919
    /// Initialize an opaque OpenCL type (event_t, queue_t, etc.) with zero
920
    SK_OCLZeroOpaqueType
921
  };
922
923
  /// A single step in the initialization sequence.
924
  class Step {
925
  public:
926
    /// The kind of conversion or initialization step we are taking.
927
    StepKind Kind;
928
929
    // The type that results from this initialization.
930
    QualType Type;
931
932
    struct F {
933
      bool HadMultipleCandidates;
934
      FunctionDecl *Function;
935
      DeclAccessPair FoundDecl;
936
    };
937
938
    union {
939
      /// When Kind == SK_ResolvedOverloadedFunction or Kind ==
940
      /// SK_UserConversion, the function that the expression should be
941
      /// resolved to or the conversion function to call, respectively.
942
      /// When Kind == SK_ConstructorInitialization or SK_ListConstruction,
943
      /// the constructor to be called.
944
      ///
945
      /// Always a FunctionDecl, plus a Boolean flag telling if it was
946
      /// selected from an overloaded set having size greater than 1.
947
      /// For conversion decls, the naming class is the source type.
948
      /// For construct decls, the naming class is the target type.
949
      struct F Function;
950
951
      /// When Kind = SK_ConversionSequence, the implicit conversion
952
      /// sequence.
953
      ImplicitConversionSequence *ICS;
954
955
      /// When Kind = SK_RewrapInitList, the syntactic form of the
956
      /// wrapping list.
957
      InitListExpr *WrappingSyntacticList;
958
    };
959
960
    void Destroy();
961
  };
962
963
private:
964
  /// The kind of initialization sequence computed.
965
  enum SequenceKind SequenceKind;
966
967
  /// Steps taken by this initialization.
968
  SmallVector<Step, 4> Steps;
969
970
public:
971
  /// Describes why initialization failed.
972
  enum FailureKind {
973
    /// Too many initializers provided for a reference.
974
    FK_TooManyInitsForReference,
975
976
    /// Reference initialized from a parenthesized initializer list.
977
    FK_ParenthesizedListInitForReference,
978
979
    /// Array must be initialized with an initializer list.
980
    FK_ArrayNeedsInitList,
981
982
    /// Array must be initialized with an initializer list or a
983
    /// string literal.
984
    FK_ArrayNeedsInitListOrStringLiteral,
985
986
    /// Array must be initialized with an initializer list or a
987
    /// wide string literal.
988
    FK_ArrayNeedsInitListOrWideStringLiteral,
989
990
    /// Initializing a wide char array with narrow string literal.
991
    FK_NarrowStringIntoWideCharArray,
992
993
    /// Initializing char array with wide string literal.
994
    FK_WideStringIntoCharArray,
995
996
    /// Initializing wide char array with incompatible wide string
997
    /// literal.
998
    FK_IncompatWideStringIntoWideChar,
999
1000
    /// Initializing char8_t array with plain string literal.
1001
    FK_PlainStringIntoUTF8Char,
1002
1003
    /// Initializing char array with UTF-8 string literal.
1004
    FK_UTF8StringIntoPlainChar,
1005
1006
    /// Array type mismatch.
1007
    FK_ArrayTypeMismatch,
1008
1009
    /// Non-constant array initializer
1010
    FK_NonConstantArrayInit,
1011
1012
    /// Cannot resolve the address of an overloaded function.
1013
    FK_AddressOfOverloadFailed,
1014
1015
    /// Overloading due to reference initialization failed.
1016
    FK_ReferenceInitOverloadFailed,
1017
1018
    /// Non-const lvalue reference binding to a temporary.
1019
    FK_NonConstLValueReferenceBindingToTemporary,
1020
1021
    /// Non-const lvalue reference binding to a bit-field.
1022
    FK_NonConstLValueReferenceBindingToBitfield,
1023
1024
    /// Non-const lvalue reference binding to a vector element.
1025
    FK_NonConstLValueReferenceBindingToVectorElement,
1026
1027
    /// Non-const lvalue reference binding to a matrix element.
1028
    FK_NonConstLValueReferenceBindingToMatrixElement,
1029
1030
    /// Non-const lvalue reference binding to an lvalue of unrelated
1031
    /// type.
1032
    FK_NonConstLValueReferenceBindingToUnrelated,
1033
1034
    /// Rvalue reference binding to an lvalue.
1035
    FK_RValueReferenceBindingToLValue,
1036
1037
    /// Reference binding drops qualifiers.
1038
    FK_ReferenceInitDropsQualifiers,
1039
1040
    /// Reference with mismatching address space binding to temporary.
1041
    FK_ReferenceAddrspaceMismatchTemporary,
1042
1043
    /// Reference binding failed.
1044
    FK_ReferenceInitFailed,
1045
1046
    /// Implicit conversion failed.
1047
    FK_ConversionFailed,
1048
1049
    /// Implicit conversion failed.
1050
    FK_ConversionFromPropertyFailed,
1051
1052
    /// Too many initializers for scalar
1053
    FK_TooManyInitsForScalar,
1054
1055
    /// Scalar initialized from a parenthesized initializer list.
1056
    FK_ParenthesizedListInitForScalar,
1057
1058
    /// Reference initialization from an initializer list
1059
    FK_ReferenceBindingToInitList,
1060
1061
    /// Initialization of some unused destination type with an
1062
    /// initializer list.
1063
    FK_InitListBadDestinationType,
1064
1065
    /// Overloading for a user-defined conversion failed.
1066
    FK_UserConversionOverloadFailed,
1067
1068
    /// Overloading for initialization by constructor failed.
1069
    FK_ConstructorOverloadFailed,
1070
1071
    /// Overloading for list-initialization by constructor failed.
1072
    FK_ListConstructorOverloadFailed,
1073
1074
    /// Default-initialization of a 'const' object.
1075
    FK_DefaultInitOfConst,
1076
1077
    /// Initialization of an incomplete type.
1078
    FK_Incomplete,
1079
1080
    /// Variable-length array must not have an initializer.
1081
    FK_VariableLengthArrayHasInitializer,
1082
1083
    /// List initialization failed at some point.
1084
    FK_ListInitializationFailed,
1085
1086
    /// Initializer has a placeholder type which cannot be
1087
    /// resolved by initialization.
1088
    FK_PlaceholderType,
1089
1090
    /// Trying to take the address of a function that doesn't support
1091
    /// having its address taken.
1092
    FK_AddressOfUnaddressableFunction,
1093
1094
    /// List-copy-initialization chose an explicit constructor.
1095
    FK_ExplicitConstructor,
1096
  };
1097
1098
private:
1099
  /// The reason why initialization failed.
1100
  FailureKind Failure;
1101
1102
  /// The failed result of overload resolution.
1103
  OverloadingResult FailedOverloadResult;
1104
1105
  /// The candidate set created when initialization failed.
1106
  OverloadCandidateSet FailedCandidateSet;
1107
1108
  /// The incomplete type that caused a failure.
1109
  QualType FailedIncompleteType;
1110
1111
  /// The fixit that needs to be applied to make this initialization
1112
  /// succeed.
1113
  std::string ZeroInitializationFixit;
1114
  SourceLocation ZeroInitializationFixitLoc;
1115
1116
public:
1117
  /// Call for initializations are invalid but that would be valid
1118
  /// zero initialzations if Fixit was applied.
1119
74
  void SetZeroInitializationFixit(const std::string& Fixit, SourceLocation L) {
1120
74
    ZeroInitializationFixit = Fixit;
1121
74
    ZeroInitializationFixitLoc = L;
1122
74
  }
1123
1124
private:
1125
  /// Prints a follow-up note that highlights the location of
1126
  /// the initialized entity, if it's remote.
1127
  void PrintInitLocationNote(Sema &S, const InitializedEntity &Entity);
1128
1129
public:
1130
  /// Try to perform initialization of the given entity, creating a
1131
  /// record of the steps required to perform the initialization.
1132
  ///
1133
  /// The generated initialization sequence will either contain enough
1134
  /// information to diagnose
1135
  ///
1136
  /// \param S the semantic analysis object.
1137
  ///
1138
  /// \param Entity the entity being initialized.
1139
  ///
1140
  /// \param Kind the kind of initialization being performed.
1141
  ///
1142
  /// \param Args the argument(s) provided for initialization.
1143
  ///
1144
  /// \param TopLevelOfInitList true if we are initializing from an expression
1145
  ///        at the top level inside an initializer list. This disallows
1146
  ///        narrowing conversions in C++11 onwards.
1147
  /// \param TreatUnavailableAsInvalid true if we want to treat unavailable
1148
  ///        as invalid.
1149
  InitializationSequence(Sema &S,
1150
                         const InitializedEntity &Entity,
1151
                         const InitializationKind &Kind,
1152
                         MultiExprArg Args,
1153
                         bool TopLevelOfInitList = false,
1154
                         bool TreatUnavailableAsInvalid = true);
1155
  void InitializeFrom(Sema &S, const InitializedEntity &Entity,
1156
                      const InitializationKind &Kind, MultiExprArg Args,
1157
                      bool TopLevelOfInitList, bool TreatUnavailableAsInvalid);
1158
1159
  ~InitializationSequence();
1160
1161
  /// Perform the actual initialization of the given entity based on
1162
  /// the computed initialization sequence.
1163
  ///
1164
  /// \param S the semantic analysis object.
1165
  ///
1166
  /// \param Entity the entity being initialized.
1167
  ///
1168
  /// \param Kind the kind of initialization being performed.
1169
  ///
1170
  /// \param Args the argument(s) provided for initialization, ownership of
1171
  /// which is transferred into the routine.
1172
  ///
1173
  /// \param ResultType if non-NULL, will be set to the type of the
1174
  /// initialized object, which is the type of the declaration in most
1175
  /// cases. However, when the initialized object is a variable of
1176
  /// incomplete array type and the initializer is an initializer
1177
  /// list, this type will be set to the completed array type.
1178
  ///
1179
  /// \returns an expression that performs the actual object initialization, if
1180
  /// the initialization is well-formed. Otherwise, emits diagnostics
1181
  /// and returns an invalid expression.
1182
  ExprResult Perform(Sema &S,
1183
                     const InitializedEntity &Entity,
1184
                     const InitializationKind &Kind,
1185
                     MultiExprArg Args,
1186
                     QualType *ResultType = nullptr);
1187
1188
  /// Diagnose an potentially-invalid initialization sequence.
1189
  ///
1190
  /// \returns true if the initialization sequence was ill-formed,
1191
  /// false otherwise.
1192
  bool Diagnose(Sema &S,
1193
                const InitializedEntity &Entity,
1194
                const InitializationKind &Kind,
1195
                ArrayRef<Expr *> Args);
1196
1197
  /// Determine the kind of initialization sequence computed.
1198
12.7M
  enum SequenceKind getKind() const { return SequenceKind; }
1199
1200
  /// Set the kind of sequence computed.
1201
13.0M
  void setSequenceKind(enum SequenceKind SK) { SequenceKind = SK; }
1202
1203
  /// Determine whether the initialization sequence is valid.
1204
465k
  explicit operator bool() const { return !Failed(); }
1205
1206
  /// Determine whether the initialization sequence is invalid.
1207
14.3M
  bool Failed() const { return SequenceKind == FailedSequence; }
1208
1209
  using step_iterator = SmallVectorImpl<Step>::const_iterator;
1210
1211
11.8M
  step_iterator step_begin() const { return Steps.begin(); }
1212
11.8M
  step_iterator step_end()   const { return Steps.end(); }
1213
1214
  using step_range = llvm::iterator_range<step_iterator>;
1215
1216
13.2k
  step_range steps() const { return {step_begin(), step_end()}; }
1217
1218
  /// Determine whether this initialization is a direct reference
1219
  /// binding (C++ [dcl.init.ref]).
1220
  bool isDirectReferenceBinding() const;
1221
1222
  /// Determine whether this initialization failed due to an ambiguity.
1223
  bool isAmbiguous() const;
1224
1225
  /// Determine whether this initialization is direct call to a
1226
  /// constructor.
1227
  bool isConstructorInitialization() const;
1228
1229
  /// Add a new step in the initialization that resolves the address
1230
  /// of an overloaded function to a specific function declaration.
1231
  ///
1232
  /// \param Function the function to which the overloaded function reference
1233
  /// resolves.
1234
  void AddAddressOverloadResolutionStep(FunctionDecl *Function,
1235
                                        DeclAccessPair Found,
1236
                                        bool HadMultipleCandidates);
1237
1238
  /// Add a new step in the initialization that performs a derived-to-
1239
  /// base cast.
1240
  ///
1241
  /// \param BaseType the base type to which we will be casting.
1242
  ///
1243
  /// \param Category Indicates whether the result will be treated as an
1244
  /// rvalue, an xvalue, or an lvalue.
1245
  void AddDerivedToBaseCastStep(QualType BaseType,
1246
                                ExprValueKind Category);
1247
1248
  /// Add a new step binding a reference to an object.
1249
  ///
1250
  /// \param BindingTemporary True if we are binding a reference to a temporary
1251
  /// object (thereby extending its lifetime); false if we are binding to an
1252
  /// lvalue or an lvalue treated as an rvalue.
1253
  void AddReferenceBindingStep(QualType T, bool BindingTemporary);
1254
1255
  /// Add a new step that makes an extraneous copy of the input
1256
  /// to a temporary of the same class type.
1257
  ///
1258
  /// This extraneous copy only occurs during reference binding in
1259
  /// C++98/03, where we are permitted (but not required) to introduce
1260
  /// an extra copy. At a bare minimum, we must check that we could
1261
  /// call the copy constructor, and produce a diagnostic if the copy
1262
  /// constructor is inaccessible or no copy constructor matches.
1263
  //
1264
  /// \param T The type of the temporary being created.
1265
  void AddExtraneousCopyToTemporary(QualType T);
1266
1267
  /// Add a new step that makes a copy of the input to an object of
1268
  /// the given type, as the final step in class copy-initialization.
1269
  void AddFinalCopy(QualType T);
1270
1271
  /// Add a new step invoking a conversion function, which is either
1272
  /// a constructor or a conversion function.
1273
  void AddUserConversionStep(FunctionDecl *Function,
1274
                             DeclAccessPair FoundDecl,
1275
                             QualType T,
1276
                             bool HadMultipleCandidates);
1277
1278
  /// Add a new step that performs a qualification conversion to the
1279
  /// given type.
1280
  void AddQualificationConversionStep(QualType Ty,
1281
                                     ExprValueKind Category);
1282
1283
  /// Add a new step that performs a function reference conversion to the
1284
  /// given type.
1285
  void AddFunctionReferenceConversionStep(QualType Ty);
1286
1287
  /// Add a new step that performs conversion from non-atomic to atomic
1288
  /// type.
1289
  void AddAtomicConversionStep(QualType Ty);
1290
1291
  /// Add a new step that applies an implicit conversion sequence.
1292
  void AddConversionSequenceStep(const ImplicitConversionSequence &ICS,
1293
                                 QualType T, bool TopLevelOfInitList = false);
1294
1295
  /// Add a list-initialization step.
1296
  void AddListInitializationStep(QualType T);
1297
1298
  /// Add a constructor-initialization step.
1299
  ///
1300
  /// \param FromInitList The constructor call is syntactically an initializer
1301
  /// list.
1302
  /// \param AsInitList The constructor is called as an init list constructor.
1303
  void AddConstructorInitializationStep(DeclAccessPair FoundDecl,
1304
                                        CXXConstructorDecl *Constructor,
1305
                                        QualType T,
1306
                                        bool HadMultipleCandidates,
1307
                                        bool FromInitList, bool AsInitList);
1308
1309
  /// Add a zero-initialization step.
1310
  void AddZeroInitializationStep(QualType T);
1311
1312
  /// Add a C assignment step.
1313
  //
1314
  // FIXME: It isn't clear whether this should ever be needed;
1315
  // ideally, we would handle everything needed in C in the common
1316
  // path. However, that isn't the case yet.
1317
  void AddCAssignmentStep(QualType T);
1318
1319
  /// Add a string init step.
1320
  void AddStringInitStep(QualType T);
1321
1322
  /// Add an Objective-C object conversion step, which is
1323
  /// always a no-op.
1324
  void AddObjCObjectConversionStep(QualType T);
1325
1326
  /// Add an array initialization loop step.
1327
  void AddArrayInitLoopStep(QualType T, QualType EltTy);
1328
1329
  /// Add an array initialization step.
1330
  void AddArrayInitStep(QualType T, bool IsGNUExtension);
1331
1332
  /// Add a parenthesized array initialization step.
1333
  void AddParenthesizedArrayInitStep(QualType T);
1334
1335
  /// Add a step to pass an object by indirect copy-restore.
1336
  void AddPassByIndirectCopyRestoreStep(QualType T, bool shouldCopy);
1337
1338
  /// Add a step to "produce" an Objective-C object (by
1339
  /// retaining it).
1340
  void AddProduceObjCObjectStep(QualType T);
1341
1342
  /// Add a step to construct a std::initializer_list object from an
1343
  /// initializer list.
1344
  void AddStdInitializerListConstructionStep(QualType T);
1345
1346
  /// Add a step to initialize an OpenCL sampler from an integer
1347
  /// constant.
1348
  void AddOCLSamplerInitStep(QualType T);
1349
1350
  /// Add a step to initialzie an OpenCL opaque type (event_t, queue_t, etc.)
1351
  /// from a zero constant.
1352
  void AddOCLZeroOpaqueTypeStep(QualType T);
1353
1354
  /// Add steps to unwrap a initializer list for a reference around a
1355
  /// single element and rewrap it at the end.
1356
  void RewrapReferenceInitList(QualType T, InitListExpr *Syntactic);
1357
1358
  /// Note that this initialization sequence failed.
1359
75.9k
  void SetFailed(FailureKind Failure) {
1360
75.9k
    SequenceKind = FailedSequence;
1361
75.9k
    this->Failure = Failure;
1362
75.9k
    assert((Failure != FK_Incomplete || !FailedIncompleteType.isNull()) &&
1363
75.9k
           "Incomplete type failure requires a type!");
1364
75.9k
  }
1365
1366
  /// Note that this initialization sequence failed due to failed
1367
  /// overload resolution.
1368
  void SetOverloadFailure(FailureKind Failure, OverloadingResult Result);
1369
1370
  /// Retrieve a reference to the candidate set when overload
1371
  /// resolution fails.
1372
349k
  OverloadCandidateSet &getFailedCandidateSet() {
1373
349k
    return FailedCandidateSet;
1374
349k
  }
1375
1376
  /// Get the overloading result, for when the initialization
1377
  /// sequence failed due to a bad overload.
1378
18.6k
  OverloadingResult getFailedOverloadResult() const {
1379
18.6k
    return FailedOverloadResult;
1380
18.6k
  }
1381
1382
  /// Note that this initialization sequence failed due to an
1383
  /// incomplete type.
1384
52
  void setIncompleteTypeFailure(QualType IncompleteType) {
1385
52
    FailedIncompleteType = IncompleteType;
1386
52
    SetFailed(FK_Incomplete);
1387
52
  }
1388
1389
  /// Determine why initialization failed.
1390
479
  FailureKind getFailureKind() const {
1391
479
    assert(Failed() && "Not an initialization failure!");
1392
0
    return Failure;
1393
479
  }
1394
1395
  /// Dump a representation of this initialization sequence to
1396
  /// the given stream, for debugging purposes.
1397
  void dump(raw_ostream &OS) const;
1398
1399
  /// Dump a representation of this initialization sequence to
1400
  /// standard error, for debugging purposes.
1401
  void dump() const;
1402
};
1403
1404
} // namespace clang
1405
1406
#endif // LLVM_CLANG_SEMA_INITIALIZATION_H