Coverage Report

Created: 2019-07-24 05:18

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