-
Notifications
You must be signed in to change notification settings - Fork 10.2k
/
Attr.h
1107 lines (899 loc) · 35.2 KB
/
Attr.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//===--- Attr.h - Swift Language Attribute ASTs -----------------*- C++ -*-===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2015 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
//
// This file defines classes related to declaration attributes.
//
//===----------------------------------------------------------------------===//
#ifndef SWIFT_ATTR_H
#define SWIFT_ATTR_H
#include "swift/Basic/Optional.h"
#include "swift/Basic/SourceLoc.h"
#include "swift/AST/Identifier.h"
#include "swift/AST/Ownership.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/ErrorHandling.h"
#include "clang/Basic/VersionTuple.h"
namespace swift {
class ASTPrinter;
class ASTContext;
struct PrintOptions;
class Decl;
class ClassDecl;
/// The associativity of a binary operator.
enum class Associativity {
/// Non-associative operators cannot be written next to other
/// operators with the same precedence. Relational operators are
/// typically non-associative.
None,
/// Left-associative operators associate to the left if written next
/// to other left-associative operators of the same precedence.
Left,
/// Right-associative operators associate to the right if written
/// next to other right-associative operators of the same precedence.
Right
};
/// The kind of unary operator, if any.
enum class UnaryOperatorKind : uint8_t {
None,
Prefix,
Postfix
};
/// Access control levels.
// These are used in diagnostics, so please do not reorder existing values.
enum class Accessibility : uint8_t {
/// Private access is limited to the current file.
Private = 0,
/// Internal access is limited to the current module.
Internal,
/// Public access is not limited.
Public
};
enum class InlineKind : uint8_t {
Never = 0
};
/// This enum represents the possible values of the @effects attribute.
/// These values are ordered from the strongest guarantee to the weakest,
/// so please do not reorder existing values.
enum class EffectsKind : uint8_t {
ReadNone,
ReadOnly,
ReadWrite,
Unspecified
};
class InfixData {
unsigned Precedence : 8;
/// Zero if invalid, or else an Associativity+1.
unsigned InvalidOrAssoc : 2;
unsigned Assignment : 1;
public:
InfixData() : Precedence(0), InvalidOrAssoc(0), Assignment(0) {}
InfixData(unsigned char prec, Associativity assoc, bool isAssignment)
: Precedence(prec), InvalidOrAssoc(unsigned(assoc) + 1),
Assignment((unsigned)isAssignment) {}
bool isValid() const { return InvalidOrAssoc != 0; }
Associativity getAssociativity() const {
assert(isValid());
return Associativity(InvalidOrAssoc - 1);
}
bool isLeftAssociative() const {
return getAssociativity() == Associativity::Left;
}
bool isRightAssociative() const {
return getAssociativity() == Associativity::Right;
}
bool isNonAssociative() const {
return getAssociativity() == Associativity::None;
}
unsigned getPrecedence() const {
assert(isValid());
return Precedence;
}
bool isAssignment() const {
assert(isValid());
return (bool)Assignment;
}
friend bool operator==(InfixData L, InfixData R) {
return L.Precedence == R.Precedence
&& L.InvalidOrAssoc == R.InvalidOrAssoc
&& L.Assignment == R.Assignment;
}
friend bool operator!=(InfixData L, InfixData R) {
return !operator==(L, R);
}
};
/// ABI resilience. Language structures are resilient if the details
/// of their implementation may be changed without requiring
/// associated code to be reprocessed. Different structures are resilient
/// in different ways. For example:
/// - A resilient type does not have a statically fixed size or layout.
/// - A resilient variable must be accessed with getters and setters, even if
/// none are defined for it now.
/// - A resilient function may not be inlined.
///
/// In general, resilience is inherited from the lexical context. For
/// example, a variable declared in a fragile struct is implicitly fragile.
///
/// Some language structures, like tuples, are never themselves
/// resilient (although they may be defined in terms of resilient
/// types). Additionally, code distributed with the component
/// defining a resilient structure need not actually use resilience
/// boundaries.
enum class Resilience : unsigned char {
Default,
/// Inherently fragile language structures are not only resilient,
/// but they have never been exposed as resilient. This permits
/// certain kinds of optimizations that are not otherwise possible
/// because of the need for backward compatibility.
InherentlyFragile,
/// Fragile language structures are non-resilient. They may have
/// been resilient at some point in the past, however.
Fragile,
/// Everything else is resilient. Resilience means different things
/// on different kinds of objects.
Resilient
};
enum class AbstractCC : unsigned char;
enum DeclAttrKind : unsigned {
#define DECL_ATTR(_, NAME, ...) DAK_##NAME,
#include "swift/AST/Attr.def"
DAK_Count
};
// Define enumerators for each type attribute, e.g. TAK_weak.
enum TypeAttrKind {
#define TYPE_ATTR(X) TAK_##X,
#include "swift/AST/Attr.def"
TAK_Count
};
/// TypeAttributes - These are attributes that may be applied to types.
class TypeAttributes {
// Get a SourceLoc for every possible attribute that can be parsed in source.
// the presence of the attribute is indicated by its location being set.
SourceLoc AttrLocs[TAK_Count];
public:
/// AtLoc - This is the location of the first '@' in the attribute specifier.
/// If this is an empty attribute specifier, then this will be an invalid loc.
SourceLoc AtLoc;
Optional<AbstractCC> cc = Nothing;
// For an opened existential type, the known ID.
Optional<unsigned> OpenedID;
TypeAttributes() {}
bool isValid() const { return AtLoc.isValid(); }
void clearAttribute(TypeAttrKind A) {
AttrLocs[A] = SourceLoc();
}
bool has(TypeAttrKind A) const {
return getLoc(A).isValid();
}
SourceLoc getLoc(TypeAttrKind A) const {
return AttrLocs[A];
}
void setAttr(TypeAttrKind A, SourceLoc L) {
assert(!L.isInvalid() && "Cannot clear attribute with this method");
AttrLocs[A] = L;
}
void getAttrRanges(SmallVectorImpl<SourceRange> &Ranges) const {
for (auto Loc : AttrLocs) {
if (Loc.isValid())
Ranges.push_back(Loc);
}
}
// This attribute list is empty if no attributes are specified. Note that
// the presence of the leading @ is not enough to tell, because we want
// clients to be able to remove attributes they process until they get to
// an empty list.
bool empty() const {
for (SourceLoc elt : AttrLocs)
if (elt.isValid()) return false;
return true;
}
bool hasCC() const { return cc.hasValue(); }
AbstractCC getAbstractCC() const { return *cc; }
bool hasOwnership() const { return getOwnership() != Ownership::Strong; }
Ownership getOwnership() const {
if (has(TAK_sil_weak)) return Ownership::Weak;
if (has(TAK_sil_unowned)) return Ownership::Unowned;
if (has(TAK_sil_unmanaged)) return Ownership::Unmanaged;
return Ownership::Strong;
}
void clearOwnership() {
clearAttribute(TAK_sil_weak);
clearAttribute(TAK_sil_unowned);
clearAttribute(TAK_sil_unmanaged);
}
bool hasOpenedID() const { return OpenedID.hasValue(); }
unsigned getOpenedID() const { return *OpenedID; }
/// Given a name like "autoclosure", return the type attribute ID that
/// corresponds to it. This returns TAK_Count on failure.
///
static TypeAttrKind getAttrKindFromString(StringRef Str);
};
class AttributeBase {
public:
/// The location of the '@'.
const SourceLoc AtLoc;
/// The source range of the attribute.
const SourceRange Range;
/// The location of the attribute.
SourceLoc getLocation() const { return Range.Start; }
/// Return the source range of the attribute.
SourceRange getRange() const { return Range; }
SourceRange getRangeWithAt() const {
if (AtLoc.isValid())
return {AtLoc, Range.End};
return Range;
}
// Only allow allocation of attributes using the allocator in ASTContext
// or by doing a placement new.
void *operator new(size_t Bytes, ASTContext &C,
unsigned Alignment = alignof(AttributeBase));
void operator delete(void *Data) throw() { }
void *operator new(size_t Bytes, void *Mem) throw() { return Mem; }
// Make vanilla new/delete illegal for attributes.
void *operator new(size_t Bytes) throw() = delete;
AttributeBase(const AttributeBase &) = delete;
protected:
AttributeBase(SourceLoc AtLoc, SourceRange Range)
: AtLoc(AtLoc), Range(Range) {}
};
class DeclAttributes;
/// Represents one declaration attribute.
class DeclAttribute : public AttributeBase {
friend class DeclAttributes;
protected:
class DeclAttrBitFields {
friend class DeclAttribute;
// The kind.
unsigned Kind : 8;
// Whether this attribute was implicitly added.
unsigned Implicit : 1;
unsigned Invalid : 1;
};
enum { NumDeclAttrBits = 10 };
static_assert(NumDeclAttrBits <= 32, "fits in an unsigned");
class ObjCAttrBitFields {
friend class ObjCAttr;
unsigned : NumDeclAttrBits;
/// Whether this attribute has location information that trails the main
/// record, which contains the locations of the parentheses and any names.
unsigned HasTrailingLocationInfo : 1;
};
enum { NumObjCAttrBits = NumDeclAttrBits + 1 };
static_assert(NumObjCAttrBits <= 32, "fits in an unsigned");
class AccessibilityAttrBitFields {
friend class AbstractAccessibilityAttr;
unsigned : NumDeclAttrBits;
unsigned AccessLevel : 2;
};
enum { NumAccessibilityAttrBits = NumDeclAttrBits + 2 };
static_assert(NumAccessibilityAttrBits <= 32, "fits in an unsigned");
union {
DeclAttrBitFields DeclAttrBits;
ObjCAttrBitFields ObjCAttrBits;
AccessibilityAttrBitFields AccessibilityAttrBits;
};
DeclAttribute *Next = nullptr;
DeclAttribute(DeclAttrKind DK, SourceLoc AtLoc, SourceRange Range,
bool Implicit) : AttributeBase(AtLoc, Range) {
DeclAttrBits.Kind = static_cast<unsigned>(DK);
DeclAttrBits.Implicit = Implicit;
DeclAttrBits.Invalid = 0;
}
public:
enum DeclAttrOptions {
/// True if multiple instances of this attribute are allowed on a single
/// declaration.
AllowMultipleAttributes = 1 << 0,
/// True if this is a decl modifier - i.e., that it should not be spelled
/// with an @.
DeclModifier = 1 << 1,
/// True if this is a long attribute that should be printed on its own line.
///
/// Currently has no effect on DeclModifier attributes.
LongAttribute = 1 << 2,
/// True if this shouldn't be serialized.
NotSerialized = 1 << 3,
/// True if this attribute is only valid when parsing a .sil file.
SILOnly = 1 << 4,
// There is one entry for each DeclKind here, and some higher level buckets
// down below. These are used in Attr.def to control which kinds of
// declarations an attribute can be attached to.
OnImport = 1 << 8,
OnExtension = 1 << 9,
OnPatternBinding = 1 << 10,
OnEnumCase = 1 << 11,
OnTopLevelCode = 1 << 12,
OnIfConfig = 1 << 13,
OnInfixOperator = 1 << 14, // "infix operator"
OnPrefixOperator = 1 << 15, // "prefix operator"
OnPostfixOperator = 1 << 16, // "postfix operator"
OnEnum = 1 << 17,
OnStruct = 1 << 18,
OnClass = 1 << 19,
OnProtocol = 1 << 20,
OnTypeAlias = 1 << 21,
OnVar = 1 << 22,
OnSubscript = 1 << 23,
OnConstructor = 1 << 24,
OnDestructor = 1 << 25,
OnFunc = 1 << 26,
OnEnumElement = 1 << 27,
OnGenericTypeParam = 1 << 28,
OnAssociatedType = 1 << 29,
OnParam = 1 << 30,
// More coarse-grained aggregations for use in Attr.def.
OnOperator = OnInfixOperator|OnPrefixOperator|OnPostfixOperator,
OnAnyDecl = OnImport|OnExtension|OnPatternBinding|OnEnumCase|
OnTopLevelCode|OnIfConfig|OnInfixOperator|OnPrefixOperator|
OnPostfixOperator|OnEnum|OnStruct|OnClass|OnProtocol|
OnTypeAlias|OnVar|OnSubscript|OnConstructor|OnDestructor|
OnFunc|OnEnumElement|OnGenericTypeParam|OnAssociatedType|OnParam
};
static unsigned getOptions(DeclAttrKind DK);
unsigned getOptions() const {
return getOptions(getKind());
}
public:
DeclAttrKind getKind() const {
return static_cast<DeclAttrKind>(DeclAttrBits.Kind);
}
/// Whether this attribute was implicitly added.
bool isImplicit() const { return DeclAttrBits.Implicit; }
/// Set whether this attribute was implicitly added.
void setImplicit(bool Implicit) {
DeclAttrBits.Implicit = Implicit;
}
/// Returns true if this attribute was find to be invalid in some way by
/// semantic analysis. In that case, the attribute should not be considered,
/// the attribute node should be only used to retrieve source information.
bool isInvalid() const { return DeclAttrBits.Invalid; }
void setInvalid() { DeclAttrBits.Invalid = true; }
bool isValid() const { return !isInvalid(); }
/// Returns the address of the next pointer field.
/// Used for object deserialization.
DeclAttribute **getMutableNext() {
return &Next;
}
/// Print the attribute to the provided ASTPrinter.
void print(ASTPrinter &Printer, const PrintOptions &Options) const;
/// Print the attribute to the provided stream.
void print(llvm::raw_ostream &OS) const;
/// Returns true if this attribute can appear on the specified decl. This is
/// controlled by the flags in Attr.def.
bool canAppearOnDecl(const Decl *D) const {
return canAttributeAppearOnDecl(getKind(), D);
}
static bool canAttributeAppearOnDecl(DeclAttrKind DK, const Decl *D);
/// Returns true if multiple instances of an attribute kind
/// can appear on a delcaration.
static bool allowMultipleAttributes(DeclAttrKind DK) {
return getOptions(DK) & AllowMultipleAttributes;
}
bool isLongAttribute() const {
return isLongAttribute(getKind());
}
static bool isLongAttribute(DeclAttrKind DK) {
return getOptions(DK) & LongAttribute;
}
bool isDeclModifier() const {
return isDeclModifier(getKind());
}
static bool isDeclModifier(DeclAttrKind DK) {
return getOptions(DK) & DeclModifier;
}
static bool isNotSerialized(DeclAttrKind DK) {
return getOptions(DK) & NotSerialized;
}
bool isNotSerialized() const {
return isNotSerialized(getKind());
}
/// Returns the source name of the attribute, without the @ or any arguments.
StringRef getAttrName() const;
/// Given a name like "inline", return the decl attribute ID that corresponds
/// to it. Note that this is a many-to-one mapping, and that the identifier
/// passed in may only be the first portion of the attribute (e.g. in the case
/// of the 'unowned(unsafe)' attribute, the string passed in is 'unowned'.
///
/// Also note that this recognizes both attributes like '@inline' (with no @)
/// and decl modifiers like 'final'. This returns DAK_Count on failure.
///
static DeclAttrKind getAttrKindFromString(StringRef Str);
};
/// Describes a "simple" declaration attribute that carries no data.
template<DeclAttrKind Kind>
class SimpleDeclAttr : public DeclAttribute {
public:
SimpleDeclAttr(bool IsImplicit)
: DeclAttribute(Kind, SourceLoc(), SourceLoc(), IsImplicit) {}
SimpleDeclAttr(SourceLoc AtLoc, SourceLoc NameLoc)
: DeclAttribute(Kind, AtLoc,
SourceRange(AtLoc.isValid() ? AtLoc : NameLoc, NameLoc),
/*Implicit=*/false) { }
SimpleDeclAttr(SourceLoc NameLoc)
: DeclAttribute(Kind, SourceLoc(), SourceRange(NameLoc, NameLoc),
/*Implicit=*/false) { }
static bool classof(const DeclAttribute *DA) {
return DA->getKind() == Kind;
}
};
// Declare typedefs for all of the simple declaration attributes.
#define SIMPLE_DECL_ATTR(_, CLASS, ...) \
typedef SimpleDeclAttr<DAK_##CLASS> CLASS##Attr;
#include "swift/AST/Attr.def"
/// Defines the @asmname attribute.
class AsmnameAttr : public DeclAttribute {
public:
AsmnameAttr(StringRef Name, SourceLoc AtLoc, SourceRange Range, bool Implicit)
: DeclAttribute(DAK_Asmname, AtLoc, Range, Implicit),
Name(Name) {}
AsmnameAttr(StringRef Name, bool Implicit)
: AsmnameAttr(Name, SourceLoc(), SourceRange(), /*Implicit=*/true) {}
/// The symbol name.
const StringRef Name;
static bool classof(const DeclAttribute *DA) {
return DA->getKind() == DAK_Asmname;
}
};
/// Defines the @semantics attribute.
class SemanticsAttr : public DeclAttribute {
public:
SemanticsAttr(StringRef Value, SourceLoc AtLoc, SourceRange Range,
bool Implicit)
: DeclAttribute(DAK_Semantics, AtLoc, Range, Implicit),
Value(Value) {}
SemanticsAttr(StringRef Value, bool Implicit)
: SemanticsAttr(Value, SourceLoc(), SourceRange(), /*Implicit=*/true) {}
/// The semantics tag value.
const StringRef Value;
static bool classof(const DeclAttribute *DA) {
return DA->getKind() == DAK_Semantics;
}
};
/// Determine the result of comparing an availabilty attribute to a specific
/// minimum platform version.
enum class MinVersionComparison {
/// The entity is guaranteed to be available.
Available,
/// The entity is never available.
Unavailable,
/// The entity might be unavailable, because it was introduced after
/// the minimimum version.
PotentiallyUnavailable,
/// The entity has been obsoleted.
Obsoleted,
};
/// Defines the @availability attribute.
class AvailabilityAttr : public DeclAttribute {
public:
/// Available platforms for the availability attribute.
enum PlatformKind {
none,
#define AVAILABILITY_PLATFORM(X, PrettyName) X,
#include "swift/AST/Attr.def"
};
#define INIT_VER_TUPLE(X)\
X(X.empty() ? Optional<clang::VersionTuple>() : X)
AvailabilityAttr(SourceLoc AtLoc, SourceRange Range,
PlatformKind Platform,
StringRef Message, StringRef Rename,
const clang::VersionTuple &Introduced,
const clang::VersionTuple &Deprecated,
const clang::VersionTuple &Obsoleted,
bool IsUnavailable,
bool Implicit)
: DeclAttribute(DAK_Availability, AtLoc, Range, Implicit),
Platform(Platform),
Message(Message), Rename(Rename),
IsUnvailable(IsUnavailable),
INIT_VER_TUPLE(Introduced),
INIT_VER_TUPLE(Deprecated),
INIT_VER_TUPLE(Obsoleted)
{}
#undef INIT_VER_TUPLE
/// The platform of the availability.
const PlatformKind Platform;
/// The optional message.
const StringRef Message;
/// An optional replacement string to emit in a fixit. This allows simple
/// declaration renames to be applied by Xcode.
const StringRef Rename;
/// Indicates if the declaration is unconditionally unavailable.
const bool IsUnvailable;
/// Indicates when the symbol was introduced.
const Optional<clang::VersionTuple> Introduced;
/// Indicates when the symbol was deprecated.
const Optional<clang::VersionTuple> Deprecated;
/// Indicates when the symbol was obsoleted.
const Optional<clang::VersionTuple> Obsoleted;
/// Determine if a given declaration should be considered unavailable given
/// the current settings.
///
/// \returns The attribute responsible for making the declaration unavailable.
static const AvailabilityAttr *isUnavailable(const Decl *D);
/// Returns true if the availability applies to a specific
/// platform.
bool hasPlatform() const {
return Platform != PlatformKind::none;
}
/// Returns the string for the specified platform.
static StringRef platformString(PlatformKind Platform);
/// Returns the string for the platform of the attribute.
StringRef platformString() const {
return platformString(Platform);
}
/// Returns the human-readable string for the specified platform.
static StringRef prettyPlatformString(PlatformKind Platform);
/// Returns the human-readable string for the platform of the attribute.
StringRef prettyPlatformString() const {
return prettyPlatformString(Platform);
}
/// Returns true if this attribute is active given the current platform.
bool isActivePlatform(const ASTContext &ctx) const;
/// Compare this attribute's version information against the minimum platform
/// version (assuming the this attribute pertains to the active platform).
MinVersionComparison getMinVersionAvailability(
clang::VersionTuple minVersion) const;
/// Returns the PlatformKind for a given string.
static Optional<PlatformKind> platformFromString(StringRef);
/// Create an AvailabilityAttr that indicates 'unavailable' for all platforms.
static AvailabilityAttr *createUnavailableAttr(ASTContext &C,
StringRef Message,
StringRef Rename = "");
static bool classof(const DeclAttribute *DA) {
return DA->getKind() == DAK_Availability;
}
};
/// Indicates that the given declaration is visible to Objective-C.
class ObjCAttr : public DeclAttribute {
/// The Objective-C name associated with this entity, stored in its opaque
/// representation so that we can use null as an indicator for "no name".
void *NameData;
/// Create an implicit @objc attribute with the given (optional) name.
explicit ObjCAttr(Optional<ObjCSelector> name)
: DeclAttribute(DAK_ObjC, SourceLoc(), SourceRange(), /*Implicit=*/true),
NameData(nullptr)
{
ObjCAttrBits.HasTrailingLocationInfo = false;
if (name) {
NameData = name->getOpaqueValue();
}
}
/// Create an @objc attribute written in the source.
ObjCAttr(SourceLoc atLoc, SourceRange baseRange, Optional<ObjCSelector> name,
SourceRange parenRange, ArrayRef<SourceLoc> nameLocs);
/// Determine whether this attribute has trailing location information.
bool hasTrailingLocationInfo() const {
return ObjCAttrBits.HasTrailingLocationInfo;
}
/// Retrieve the trailing location information.
MutableArrayRef<SourceLoc> getTrailingLocations() {
assert(hasTrailingLocationInfo() && "No trailing location information");
unsigned length = 2;
if (auto name = getName())
length += name->getNumSelectorPieces();
return { reinterpret_cast<SourceLoc *>(this + 1), length };
}
/// Retrieve the trailing location information.
ArrayRef<SourceLoc> getTrailingLocations() const {
assert(hasTrailingLocationInfo() && "No trailing location information");
unsigned length = 2;
if (auto name = getName())
length += name->getNumSelectorPieces();
return { reinterpret_cast<const SourceLoc *>(this + 1), length };
}
public:
/// Create implicit ObjC attribute with a given (optional) name.
static ObjCAttr *create(ASTContext &Ctx, Optional<ObjCSelector> name);
/// Create an unnamed Objective-C attribute, i.e., @objc.
static ObjCAttr *createUnnamed(ASTContext &Ctx, SourceLoc AtLoc,
SourceLoc ObjCLoc);
static ObjCAttr *createUnnamedImplicit(ASTContext &Ctx);
/// Create a nullary Objective-C attribute, which has a single name
/// with no colon following it.
///
/// Note that a nullary Objective-C attribute may represent either a
/// selector for a zero-parameter function or some other Objective-C
/// entity, such as a class or protocol.
static ObjCAttr *createNullary(ASTContext &Ctx, SourceLoc AtLoc,
SourceLoc ObjCLoc, SourceLoc LParenLoc,
SourceLoc NameLoc, Identifier Name,
SourceLoc RParenLoc);
/// Create an implicit nullary Objective-C attribute, which has a
/// single name with no colon following it.
///
/// Note that a nullary Objective-C attribute may represent either a
/// selector for a zero-parameter function or some other Objective-C
/// entity, such as a class or protocol.
static ObjCAttr *createNullary(ASTContext &Ctx, Identifier Name);
/// Create a "selector" Objective-C attribute, which has some number
/// of identifiers followed by colons.
static ObjCAttr *createSelector(ASTContext &Ctx, SourceLoc AtLoc,
SourceLoc ObjCLoc, SourceLoc LParenLoc,
ArrayRef<SourceLoc> NameLocs,
ArrayRef<Identifier> Names,
SourceLoc RParenLoc);
/// Create an implicit "selector" Objective-C attribute, which has
/// some number of identifiers followed by colons.
static ObjCAttr *createSelector(ASTContext &Ctx, ArrayRef<Identifier> Names);
/// Determine whether this attribute has a name associated with it.
bool hasName() const { return NameData != nullptr; }
/// Retrieve the name of this entity, if specified.
Optional<ObjCSelector> getName() const {
if (!hasName())
return Nothing;
return ObjCSelector::getFromOpaqueValue(NameData);
}
/// Set the name of this entity.
void setName(ObjCSelector name) {
// If we already have a name and we have location information, make sure
// drop the location information rather than allowing it to corrupt our
// state
if (hasTrailingLocationInfo() &&
(!hasName() ||
getName()->getNumSelectorPieces() < name.getNumSelectorPieces())) {
ObjCAttrBits.HasTrailingLocationInfo = false;
}
NameData = name.getOpaqueValue();
}
/// Clear the name of this entity.
void clearName() {
NameData = nullptr;
}
/// Retrieve the source locations for the names in a non-implicit
/// nullary or selector attribute.
ArrayRef<SourceLoc> getNameLocs() const;
/// Retrieve the location of the opening parentheses, if there is one.
SourceLoc getLParenLoc() const;
/// Retrieve the location of the closing parentheses, if there is one.
SourceLoc getRParenLoc() const;
/// Clone the given attribute, producing an implicit copy of the
/// original without source location information.
ObjCAttr *clone(ASTContext &context) const;
static bool classof(const DeclAttribute *DA) {
return DA->getKind() == DAK_ObjC;
}
};
/// Represents any sort of accessibility modifier.
class AbstractAccessibilityAttr : public DeclAttribute {
protected:
AbstractAccessibilityAttr(DeclAttrKind DK, SourceLoc atLoc, SourceRange range,
Accessibility access, bool implicit)
: DeclAttribute(DK, atLoc, range, implicit) {
AccessibilityAttrBits.AccessLevel = static_cast<unsigned>(access);
assert(getAccess() == access && "not enough bits for accessibility");
}
public:
Accessibility getAccess() const {
return static_cast<Accessibility>(AccessibilityAttrBits.AccessLevel);
}
static bool classof(const DeclAttribute *DA) {
return DA->getKind() == DAK_Accessibility ||
DA->getKind() == DAK_SetterAccessibility;
}
};
/// Represents a 'private', 'internal', or 'public' marker on a declaration.
class AccessibilityAttr : public AbstractAccessibilityAttr {
public:
AccessibilityAttr(SourceLoc atLoc, SourceRange range, Accessibility access,
bool implicit = false)
: AbstractAccessibilityAttr(DAK_Accessibility, atLoc, range, access,
implicit) {}
static bool classof(const DeclAttribute *DA) {
return DA->getKind() == DAK_Accessibility;
}
};
/// Represents a 'private', 'internal', or 'public' marker for a setter on a
/// declaration.
class SetterAccessibilityAttr : public AbstractAccessibilityAttr {
public:
SetterAccessibilityAttr(SourceLoc atLoc, SourceRange range,
Accessibility access, bool implicit = false)
: AbstractAccessibilityAttr(DAK_SetterAccessibility, atLoc, range, access,
implicit) {}
static bool classof(const DeclAttribute *DA) {
return DA->getKind() == DAK_SetterAccessibility;
}
};
/// Represents an inline attribute.
class InlineAttr : public DeclAttribute {
InlineKind Kind;
public:
InlineAttr(SourceLoc atLoc, SourceRange range, InlineKind kind)
: DeclAttribute(DAK_Inline, atLoc, range, /*Implicit=*/false),
Kind(kind) {}
InlineAttr(InlineKind kind)
: InlineAttr(SourceLoc(), SourceRange(), kind) {}
InlineKind getKind() const { return Kind; }
static bool classof(const DeclAttribute *DA) {
return DA->getKind() == DAK_Inline;
}
};
/// Represents the side effects attribute.
class EffectsAttr : public DeclAttribute {
EffectsKind Kind;
public:
EffectsAttr(SourceLoc atLoc, SourceRange range, EffectsKind kind)
: DeclAttribute(DAK_Effects, atLoc, range, /*Implicit=*/false),
Kind(kind) {}
EffectsAttr(EffectsKind kind)
: EffectsAttr(SourceLoc(), SourceRange(), kind) {}
EffectsKind getKind() const { return Kind; }
static bool classof(const DeclAttribute *DA) {
return DA->getKind() == DAK_Effects;
}
};
/// Represents weak/unowned/unowned(unsafe) decl modifiers.
class OwnershipAttr : public DeclAttribute {
const Ownership ownership;
public:
OwnershipAttr(SourceRange range, Ownership kind)
: DeclAttribute(DAK_Ownership, range.Start, range, /*Implicit=*/false),
ownership(kind) {}
OwnershipAttr(Ownership kind) : OwnershipAttr(SourceRange(), kind) {}
Ownership get() const { return ownership; }
/// Returns a copy of this attribute without any source information.
OwnershipAttr *clone(ASTContext &context) const {
return new (context) OwnershipAttr(get());
}
static bool classof(const DeclAttribute *DA) {
return DA->getKind() == DAK_Ownership;
}
};
/// Defines the attribute that we use to model documentation comments.
class RawDocCommentAttr : public DeclAttribute {
/// Source range of the attached comment. This comment is located before
/// the declaration.
CharSourceRange CommentRange;
public:
RawDocCommentAttr(CharSourceRange CommentRange)
: DeclAttribute(DAK_RawDocComment, SourceLoc(), SourceRange(),
/*Implicit=*/false),
CommentRange(CommentRange) {}
CharSourceRange getCommentRange() const { return CommentRange; }
static bool classof(const DeclAttribute *DA) {
return DA->getKind() == DAK_RawDocComment;
}
};
/// An attribute applied to a CoreFoundation class that is toll-free bridged to
/// an Objective-C class.
///
/// This attribute is introduced by the Clang importer, and is therefore always
/// implicit.
class ObjCBridgedAttr : public DeclAttribute {
ClassDecl *ObjCClass;
public:
ObjCBridgedAttr(ClassDecl *ObjCClass)
: DeclAttribute(DAK_ObjCBridged, SourceLoc(), SourceRange(),
/*Implicit=*/true),
ObjCClass(ObjCClass)
{
}
/// Retrieve the Objective-C class to which this foreign class is toll-free
/// bridged.
ClassDecl *getObjCClass() const { return ObjCClass; }
static bool classof(const DeclAttribute *DA) {
return DA->getKind() == DAK_ObjCBridged;
}
};
/// \brief Attributes that may be applied to declarations.
class DeclAttributes {
/// Linked list of declaration attributes.
DeclAttribute *DeclAttrs;
public:
DeclAttributes() : DeclAttrs(nullptr) {}
bool isEmpty() const {
return DeclAttrs == nullptr;
}
void getAttrRanges(SmallVectorImpl<SourceRange> &Ranges) const {
for (auto Attr : *this) {
auto R = Attr->getRangeWithAt();
if (R.isValid())
Ranges.push_back(R);
}
}
/// If this attribute set has a prefix/postfix attribute on it, return this.
UnaryOperatorKind getUnaryOperatorKind() const {
if (hasAttribute<PrefixAttr>())
return UnaryOperatorKind::Prefix;
if (hasAttribute<PostfixAttr>())
return UnaryOperatorKind::Postfix;
return UnaryOperatorKind::None;