/
Identifier.h
999 lines (806 loc) · 30.9 KB
/
Identifier.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
//===--- Identifier.h - Uniqued Identifier ----------------------*- C++ -*-===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
//
// This file defines the Identifier interface.
//
//===----------------------------------------------------------------------===//
#ifndef SWIFT_AST_IDENTIFIER_H
#define SWIFT_AST_IDENTIFIER_H
#include "swift/Basic/EditorPlaceholder.h"
#include "swift/Basic/Debug.h"
#include "swift/Basic/LLVM.h"
#include "llvm/ADT/FoldingSet.h"
#include "llvm/ADT/PointerUnion.h"
#include "llvm/Support/TrailingObjects.h"
namespace llvm {
class raw_ostream;
}
namespace swift {
class ASTContext;
class ParameterList;
/// DeclRefKind - The kind of reference to an identifier.
enum class DeclRefKind {
/// An ordinary reference to an identifier, e.g. 'foo'.
Ordinary,
/// A reference to an identifier as a binary operator, e.g. '+' in 'a+b'.
BinaryOperator,
/// A reference to an identifier as a postfix unary operator, e.g. '++' in
/// 'a++'.
PostfixOperator,
/// A reference to an identifier as a prefix unary operator, e.g. '--' in
/// '--a'.
PrefixOperator
};
/// Identifier - This is an instance of a uniqued identifier created by
/// ASTContext. It just wraps a nul-terminated "const char*".
class Identifier {
friend class ASTContext;
friend class DeclBaseName;
const char *Pointer;
public:
enum : size_t {
NumLowBitsAvailable = 3,
RequiredAlignment = 1 << NumLowBitsAvailable,
SpareBitMask = ((intptr_t)1 << NumLowBitsAvailable) - 1
};
private:
/// Constructor, only accessible by ASTContext, which handles the uniquing.
explicit Identifier(const char *Ptr) : Pointer(Ptr) {
assert(((uintptr_t)Ptr & SpareBitMask) == 0
&& "Identifier pointer does not use any spare bits");
}
/// A type with the alignment expected of a valid \c Identifier::Pointer .
struct alignas(uint64_t) Aligner {};
static_assert(alignof(Aligner) >= RequiredAlignment,
"Identifier table will provide enough spare bits");
public:
explicit Identifier() : Pointer(nullptr) {}
const char *get() const { return Pointer; }
StringRef str() const { return Pointer; }
explicit operator std::string() const { return std::string(Pointer); }
unsigned getLength() const {
assert(Pointer != nullptr && "Tried getting length of empty identifier");
return ::strlen(Pointer);
}
bool empty() const { return Pointer == nullptr; }
bool is(StringRef string) const { return str().equals(string); }
/// isOperator - Return true if this identifier is an operator, false if it is
/// a normal identifier.
/// FIXME: We should maybe cache this.
bool isOperator() const {
if (empty())
return false;
if (isEditorPlaceholder())
return false;
if ((unsigned char)Pointer[0] < 0x80)
return isOperatorStartCodePoint((unsigned char)Pointer[0]);
// Handle the high unicode case out of line.
return isOperatorSlow();
}
/// isOperatorStartCodePoint - Return true if the specified code point is a
/// valid start of an operator.
static bool isOperatorStartCodePoint(uint32_t C) {
// ASCII operator chars.
static const char OpChars[] = "/=-+*%<>!&|^~.?";
if (C < 0x80)
return memchr(OpChars, C, sizeof(OpChars) - 1) != 0;
// Unicode math, symbol, arrow, dingbat, and line/box drawing chars.
return (C >= 0x00A1 && C <= 0x00A7)
|| C == 0x00A9 || C == 0x00AB || C == 0x00AC || C == 0x00AE
|| C == 0x00B0 || C == 0x00B1 || C == 0x00B6 || C == 0x00BB
|| C == 0x00BF || C == 0x00D7 || C == 0x00F7
|| C == 0x2016 || C == 0x2017 || (C >= 0x2020 && C <= 0x2027)
|| (C >= 0x2030 && C <= 0x203E) || (C >= 0x2041 && C <= 0x2053)
|| (C >= 0x2055 && C <= 0x205E) || (C >= 0x2190 && C <= 0x23FF)
|| (C >= 0x2500 && C <= 0x2775) || (C >= 0x2794 && C <= 0x2BFF)
|| (C >= 0x2E00 && C <= 0x2E7F) || (C >= 0x3001 && C <= 0x3003)
|| (C >= 0x3008 && C <= 0x3030);
}
/// isOperatorContinuationCodePoint - Return true if the specified code point
/// is a valid operator code point.
static bool isOperatorContinuationCodePoint(uint32_t C) {
if (isOperatorStartCodePoint(C))
return true;
// Unicode combining characters and variation selectors.
return (C >= 0x0300 && C <= 0x036F)
|| (C >= 0x1DC0 && C <= 0x1DFF)
|| (C >= 0x20D0 && C <= 0x20FF)
|| (C >= 0xFE00 && C <= 0xFE0F)
|| (C >= 0xFE20 && C <= 0xFE2F)
|| (C >= 0xE0100 && C <= 0xE01EF);
}
static bool isEditorPlaceholder(StringRef name) {
return swift::isEditorPlaceholder(name);
}
bool isEditorPlaceholder() const {
return !empty() && isEditorPlaceholder(str());
}
const void *getAsOpaquePointer() const {
return static_cast<const void *>(Pointer);
}
static Identifier getFromOpaquePointer(void *P) {
return Identifier((const char*)P);
}
/// Compare two identifiers, producing -1 if \c *this comes before \c other,
/// 1 if \c *this comes after \c other, and 0 if they are equal.
///
/// Null identifiers come after all other identifiers.
int compare(Identifier other) const;
friend llvm::hash_code hash_value(Identifier ident) {
return llvm::hash_value(ident.getAsOpaquePointer());
}
bool operator==(Identifier RHS) const { return Pointer == RHS.Pointer; }
bool operator!=(Identifier RHS) const { return !(*this==RHS); }
bool operator<(Identifier RHS) const { return Pointer < RHS.Pointer; }
static Identifier getEmptyKey() {
uintptr_t Val = static_cast<uintptr_t>(-1);
Val <<= NumLowBitsAvailable;
return Identifier((const char*)Val);
}
static Identifier getTombstoneKey() {
uintptr_t Val = static_cast<uintptr_t>(-2);
Val <<= NumLowBitsAvailable;
return Identifier((const char*)Val);
}
private:
bool isOperatorSlow() const;
};
class DeclName;
class DeclNameRef;
class ObjCSelector;
} // end namespace swift
namespace llvm {
raw_ostream &operator<<(raw_ostream &OS, swift::Identifier I);
raw_ostream &operator<<(raw_ostream &OS, swift::DeclName I);
raw_ostream &operator<<(raw_ostream &OS, swift::DeclNameRef I);
raw_ostream &operator<<(raw_ostream &OS, swift::ObjCSelector S);
// Identifiers hash just like pointers.
template<> struct DenseMapInfo<swift::Identifier> {
static swift::Identifier getEmptyKey() {
return swift::Identifier::getEmptyKey();
}
static swift::Identifier getTombstoneKey() {
return swift::Identifier::getTombstoneKey();
}
static unsigned getHashValue(swift::Identifier Val) {
return DenseMapInfo<const void*>::getHashValue(Val.get());
}
static bool isEqual(swift::Identifier LHS, swift::Identifier RHS) {
return LHS == RHS;
}
};
// An Identifier is "pointer like".
template<typename T> struct PointerLikeTypeTraits;
template<>
struct PointerLikeTypeTraits<swift::Identifier> {
public:
static inline void *getAsVoidPointer(swift::Identifier I) {
return const_cast<void *>(I.getAsOpaquePointer());
}
static inline swift::Identifier getFromVoidPointer(void *P) {
return swift::Identifier::getFromOpaquePointer(P);
}
enum { NumLowBitsAvailable = swift::Identifier::NumLowBitsAvailable };
};
} // end namespace llvm
namespace swift {
/// Wrapper that may either be an Identifier or a special name
/// (e.g. for subscripts)
class DeclBaseName {
public:
enum class Kind: uint8_t {
Normal,
Subscript,
Constructor,
Destructor
};
private:
/// In a special DeclName representing a subscript, this opaque pointer
/// is used as the data of the base name identifier.
/// This is an implementation detail that should never leak outside of
/// DeclName.
static const Identifier::Aligner SubscriptIdentifierData;
/// As above, for special constructor DeclNames.
static const Identifier::Aligner ConstructorIdentifierData;
/// As above, for special destructor DeclNames.
static const Identifier::Aligner DestructorIdentifierData;
Identifier Ident;
public:
DeclBaseName() : DeclBaseName(Identifier()) {}
DeclBaseName(Identifier I) : Ident(I) {}
static DeclBaseName createSubscript() {
return DeclBaseName(Identifier((const char *)&SubscriptIdentifierData));
}
static DeclBaseName createConstructor() {
return DeclBaseName(Identifier((const char *)&ConstructorIdentifierData));
}
static DeclBaseName createDestructor() {
return DeclBaseName(Identifier((const char *)&DestructorIdentifierData));
}
Kind getKind() const {
if (Ident.get() == (const char *)&SubscriptIdentifierData) {
return Kind::Subscript;
} else if (Ident.get() == (const char *)&ConstructorIdentifierData) {
return Kind::Constructor;
} else if (Ident.get() == (const char *)&DestructorIdentifierData) {
return Kind::Destructor;
} else {
return Kind::Normal;
}
}
bool isSpecial() const { return getKind() != Kind::Normal; }
bool isSubscript() const { return getKind() == Kind::Subscript; }
/// Return the identifier backing the name. Assumes that the name is not
/// special.
Identifier getIdentifier() const {
assert(!isSpecial() && "Cannot retrieve identifier from special names");
return Ident;
}
bool empty() const { return !isSpecial() && getIdentifier().empty(); }
bool isOperator() const {
return !isSpecial() && getIdentifier().isOperator();
}
bool isEditorPlaceholder() const {
return !isSpecial() && getIdentifier().isEditorPlaceholder();
}
/// A representation of the name to be displayed to users. May be ambiguous
/// between identifiers and special names.
StringRef userFacingName() const {
if (empty())
return "_";
switch (getKind()) {
case Kind::Normal:
return getIdentifier().str();
case Kind::Subscript:
return "subscript";
case Kind::Constructor:
return "init";
case Kind::Destructor:
return "deinit";
}
llvm_unreachable("unhandled kind");
}
int compare(DeclBaseName other) const {
return userFacingName().compare(other.userFacingName());
}
bool operator==(StringRef Str) const {
return !isSpecial() && getIdentifier().is(Str);
}
bool operator!=(StringRef Str) const { return !(*this == Str); }
bool operator==(DeclBaseName RHS) const { return Ident == RHS.Ident; }
bool operator!=(DeclBaseName RHS) const { return !(*this == RHS); }
bool operator<(DeclBaseName RHS) const {
return Ident.get() < RHS.Ident.get();
}
const void *getAsOpaquePointer() const { return Ident.get(); }
static DeclBaseName getFromOpaquePointer(void *P) {
return Identifier::getFromOpaquePointer(P);
}
};
} // end namespace swift
namespace llvm {
raw_ostream &operator<<(raw_ostream &OS, swift::DeclBaseName D);
// DeclBaseNames hash just like pointers.
template<> struct DenseMapInfo<swift::DeclBaseName> {
static swift::DeclBaseName getEmptyKey() {
return swift::Identifier::getEmptyKey();
}
static swift::DeclBaseName getTombstoneKey() {
return swift::Identifier::getTombstoneKey();
}
static unsigned getHashValue(swift::DeclBaseName Val) {
return DenseMapInfo<const void *>::getHashValue(Val.getAsOpaquePointer());
}
static bool isEqual(swift::DeclBaseName LHS, swift::DeclBaseName RHS) {
return LHS == RHS;
}
};
// A DeclBaseName is "pointer like".
template <typename T> struct PointerLikeTypeTraits;
template <> struct PointerLikeTypeTraits<swift::DeclBaseName> {
public:
static inline void *getAsVoidPointer(swift::DeclBaseName D) {
return const_cast<void *>(D.getAsOpaquePointer());
}
static inline swift::DeclBaseName getFromVoidPointer(void *P) {
return swift::DeclBaseName::getFromOpaquePointer(P);
}
enum { NumLowBitsAvailable = PointerLikeTypeTraits<swift::Identifier>::NumLowBitsAvailable };
};
} // end namespace llvm
namespace swift {
/// A declaration name, which may comprise one or more identifier pieces.
class DeclName {
friend class ASTContext;
/// Represents a compound declaration name.
struct alignas(Identifier) CompoundDeclName final : llvm::FoldingSetNode,
private llvm::TrailingObjects<CompoundDeclName, Identifier> {
friend TrailingObjects;
friend class DeclName;
DeclBaseName BaseName;
size_t NumArgs;
explicit CompoundDeclName(DeclBaseName BaseName, size_t NumArgs)
: BaseName(BaseName), NumArgs(NumArgs) { }
ArrayRef<Identifier> getArgumentNames() const {
return {getTrailingObjects<Identifier>(), NumArgs};
}
MutableArrayRef<Identifier> getArgumentNames() {
return {getTrailingObjects<Identifier>(), NumArgs};
}
/// Uniquing for the ASTContext.
static void Profile(llvm::FoldingSetNodeID &id, DeclBaseName baseName,
ArrayRef<Identifier> argumentNames);
void Profile(llvm::FoldingSetNodeID &id) {
Profile(id, BaseName, getArgumentNames());
}
};
/// Either a single identifier piece stored inline, or a reference to a
/// compound declaration name.
llvm::PointerUnion<DeclBaseName, CompoundDeclName *> BaseNameOrCompound;
explicit DeclName(void *Opaque)
: BaseNameOrCompound(decltype(BaseNameOrCompound)::getFromOpaqueValue(Opaque))
{}
void initialize(ASTContext &C, DeclBaseName baseName,
ArrayRef<Identifier> argumentNames);
public:
/// Build a null name.
DeclName() : BaseNameOrCompound(DeclBaseName()) {}
/// Build a simple value name with one component.
/*implicit*/ DeclName(DeclBaseName simpleName)
: BaseNameOrCompound(simpleName) {}
/*implicit*/ DeclName(Identifier simpleName)
: DeclName(DeclBaseName(simpleName)) {}
/// Build a compound value name given a base name and a set of argument names.
DeclName(ASTContext &C, DeclBaseName baseName,
ArrayRef<Identifier> argumentNames) {
initialize(C, baseName, argumentNames);
}
/// Build a compound value name given a base name and a set of argument names
/// extracted from a parameter list.
DeclName(ASTContext &C, DeclBaseName baseName, ParameterList *paramList);
/// Retrieve the 'base' name, i.e., the name that follows the introducer,
/// such as the 'foo' in 'func foo(x:Int, y:Int)' or the 'bar' in
/// 'var bar: Int'.
DeclBaseName getBaseName() const {
if (auto compound = BaseNameOrCompound.dyn_cast<CompoundDeclName*>())
return compound->BaseName;
return BaseNameOrCompound.get<DeclBaseName>();
}
/// Assert that the base name is not special and return its identifier.
Identifier getBaseIdentifier() const {
auto baseName = getBaseName();
assert(!baseName.isSpecial() &&
"Can't retrieve the identifier of a special base name");
return baseName.getIdentifier();
}
/// Retrieve the names of the arguments, if there are any.
ArrayRef<Identifier> getArgumentNames() const {
if (auto compound = BaseNameOrCompound.dyn_cast<CompoundDeclName*>())
return compound->getArgumentNames();
return { };
}
bool isSpecial() const { return getBaseName().isSpecial(); }
explicit operator bool() const {
if (BaseNameOrCompound.dyn_cast<CompoundDeclName*>())
return true;
return !BaseNameOrCompound.get<DeclBaseName>().empty();
}
/// True if this is a simple one-component name.
bool isSimpleName() const {
return BaseNameOrCompound.is<DeclBaseName>();
}
/// True if this is a compound name.
bool isCompoundName() const {
return !isSimpleName();
}
/// True if this name is a simple one-component name identical to the
/// given identifier.
bool isSimpleName(DeclBaseName name) const {
return isSimpleName() && getBaseName() == name;
}
/// True if this name is a simple one-component name equal to the
/// given string.
bool isSimpleName(StringRef name) const {
return isSimpleName() && getBaseName() == name;
}
/// True if this name is a compound name equal to the given base name and
/// argument names.
bool isCompoundName(DeclBaseName base, ArrayRef<StringRef> args) const;
/// True if this name is a compound name equal to the given normal
/// base name and argument names.
bool isCompoundName(StringRef base, ArrayRef<StringRef> args) const;
/// True if this name is an operator.
bool isOperator() const {
return getBaseName().isOperator();
}
/// True if this name should be found by a decl ref or member ref under the
/// name specified by 'refName'.
///
/// We currently match compound names either when their first component
/// matches a simple name lookup or when the full compound name matches.
bool matchesRef(DeclName refName) const {
// Identical names always match.
if (BaseNameOrCompound == refName.BaseNameOrCompound)
return true;
// If the reference is a simple name, try simple name matching.
if (refName.isSimpleName())
return refName.getBaseName() == getBaseName();
// The names don't match.
return false;
}
/// Add a DeclName to a lookup table so that it can be found by its simple
/// name or its compound name.
template<typename LookupTable, typename Element>
void addToLookupTable(LookupTable &table, const Element &elt) {
table[*this].push_back(elt);
if (!isSimpleName()) {
table[getBaseName()].push_back(elt);
}
}
/// Compare two declaration names, producing -1 if \c *this comes before
/// \c other, 1 if \c *this comes after \c other, and 0 if they are equal.
///
/// Null declaration names come after all other declaration names.
int compare(DeclName other) const;
friend bool operator==(DeclName lhs, DeclName rhs) {
return lhs.getOpaqueValue() == rhs.getOpaqueValue();
}
friend bool operator!=(DeclName lhs, DeclName rhs) {
return !(lhs == rhs);
}
friend llvm::hash_code hash_value(DeclName name) {
using llvm::hash_value;
return hash_value(name.getOpaqueValue());
}
friend bool operator<(DeclName lhs, DeclName rhs) {
return lhs.compare(rhs) < 0;
}
friend bool operator<=(DeclName lhs, DeclName rhs) {
return lhs.compare(rhs) <= 0;
}
friend bool operator>(DeclName lhs, DeclName rhs) {
return lhs.compare(rhs) > 0;
}
friend bool operator>=(DeclName lhs, DeclName rhs) {
return lhs.compare(rhs) >= 0;
}
void *getOpaqueValue() const { return BaseNameOrCompound.getOpaqueValue(); }
static DeclName getFromOpaqueValue(void *p) { return DeclName(p); }
/// Get a string representation of the name,
///
/// \param scratch Scratch space to use.
StringRef getString(llvm::SmallVectorImpl<char> &scratch,
bool skipEmptyArgumentNames = false) const;
/// Print the representation of this declaration name to the given
/// stream.
///
/// \param skipEmptyArgumentNames When true, don't print the argument labels
/// if they are all empty.
llvm::raw_ostream &print(llvm::raw_ostream &os,
bool skipEmptyArgumentNames = false) const;
/// Print a "pretty" representation of this declaration name to the given
/// stream.
///
/// This is the name used for diagnostics; it is not necessarily the
/// fully-specified name that would be written in the source.
llvm::raw_ostream &printPretty(llvm::raw_ostream &os) const;
/// Dump this name to standard error.
SWIFT_DEBUG_DUMP;
};
void simple_display(llvm::raw_ostream &out, DeclName name);
/// An in-source reference to another declaration, including qualification
/// information.
class DeclNameRef {
DeclName FullName;
public:
static DeclNameRef createSubscript();
static DeclNameRef createConstructor();
DeclNameRef() : FullName() { }
void *getOpaqueValue() const { return FullName.getOpaqueValue(); }
static DeclNameRef getFromOpaqueValue(void *p);
explicit DeclNameRef(DeclName FullName)
: FullName(FullName) { }
explicit DeclNameRef(DeclBaseName BaseName)
: FullName(BaseName) { }
explicit DeclNameRef(Identifier BaseName)
: FullName(BaseName) { }
/// The name of the declaration being referenced.
DeclName getFullName() const {
return FullName;
}
DeclName &getFullName() {
return FullName;
}
/// The base name of the declaration being referenced.
DeclBaseName getBaseName() const {
return FullName.getBaseName();
}
Identifier getBaseIdentifier() const {
return FullName.getBaseIdentifier();
}
ArrayRef<Identifier> getArgumentNames() const {
return FullName.getArgumentNames();
}
bool isSimpleName() const {
return FullName.isSimpleName();
}
bool isSimpleName(DeclBaseName name) const {
return FullName.isSimpleName(name);
}
bool isSimpleName(StringRef name) const {
return FullName.isSimpleName(name);
}
bool isSpecial() const {
return FullName.isSpecial();
}
bool isOperator() const {
return FullName.isOperator();
}
bool isCompoundName() const {
return FullName.isCompoundName();
}
explicit operator bool() const {
return (bool)FullName;
}
/// Compare two declaration names, producing -1 if \c *this comes before
/// \c other, 1 if \c *this comes after \c other, and 0 if they are equal.
///
/// Null declaration names come after all other declaration names.
int compare(DeclNameRef other) const {
return getFullName().compare(other.getFullName());
}
friend bool operator==(DeclNameRef lhs, DeclNameRef rhs) {
return lhs.getOpaqueValue() == rhs.getOpaqueValue();
}
friend bool operator!=(DeclNameRef lhs, DeclNameRef rhs) {
return !(lhs == rhs);
}
friend llvm::hash_code hash_value(DeclNameRef name) {
using llvm::hash_value;
return hash_value(name.getFullName().getOpaqueValue());
}
friend bool operator<(DeclNameRef lhs, DeclNameRef rhs) {
return lhs.compare(rhs) < 0;
}
friend bool operator<=(DeclNameRef lhs, DeclNameRef rhs) {
return lhs.compare(rhs) <= 0;
}
friend bool operator>(DeclNameRef lhs, DeclNameRef rhs) {
return lhs.compare(rhs) > 0;
}
friend bool operator>=(DeclNameRef lhs, DeclNameRef rhs) {
return lhs.compare(rhs) >= 0;
}
DeclNameRef withoutArgumentLabels() const;
DeclNameRef withArgumentLabels(ASTContext &C,
ArrayRef<Identifier> argumentNames) const;
/// Get a string representation of the name,
///
/// \param scratch Scratch space to use.
StringRef getString(llvm::SmallVectorImpl<char> &scratch,
bool skipEmptyArgumentNames = false) const;
/// Print the representation of this declaration name to the given
/// stream.
///
/// \param skipEmptyArgumentNames When true, don't print the argument labels
/// if they are all empty.
llvm::raw_ostream &print(llvm::raw_ostream &os,
bool skipEmptyArgumentNames = false) const;
/// Print a "pretty" representation of this declaration name to the given
/// stream.
///
/// This is the name used for diagnostics; it is not necessarily the
/// fully-specified name that would be written in the source.
llvm::raw_ostream &printPretty(llvm::raw_ostream &os) const;
/// Dump this name to standard error.
LLVM_ATTRIBUTE_DEPRECATED(void dump() const LLVM_ATTRIBUTE_USED,
"only for use within the debugger");
};
inline DeclNameRef DeclNameRef::getFromOpaqueValue(void *p) {
return DeclNameRef(DeclName::getFromOpaqueValue(p));
}
inline DeclNameRef DeclNameRef::withoutArgumentLabels() const {
return DeclNameRef(getBaseName());
}
inline DeclNameRef DeclNameRef::withArgumentLabels(
ASTContext &C, ArrayRef<Identifier> argumentNames) const {
return DeclNameRef(DeclName(C, getBaseName(), argumentNames));
}
inline DeclNameRef DeclNameRef::createSubscript() {
return DeclNameRef(DeclBaseName::createSubscript());
}
inline DeclNameRef DeclNameRef::createConstructor() {
return DeclNameRef(DeclBaseName::createConstructor());
}
void simple_display(llvm::raw_ostream &out, DeclNameRef name);
enum class ObjCSelectorFamily : unsigned {
None,
#define OBJC_SELECTOR_FAMILY(LABEL, PREFIX) LABEL,
#include "swift/AST/ObjCSelectorFamily.def"
};
/// Represents an Objective-C selector.
class ObjCSelector {
/// The storage for an Objective-C selector.
///
/// A zero-argument selector is represented as simple name.
/// A selector with N arguments is represented as a compound name with
/// N arguments, where the simple name is a placeholder.
DeclName Storage;
explicit ObjCSelector(DeclName storage) : Storage(storage) { }
friend struct llvm::DenseMapInfo<ObjCSelector>;
public:
/// Form a selector with the given number of arguments and the given selector
/// pieces.
ObjCSelector(ASTContext &ctx, unsigned numArgs, ArrayRef<Identifier> pieces);
/// Construct an invalid ObjCSelector.
ObjCSelector() : Storage() {}
/// Convert to true if the decl name is valid.
explicit operator bool() const { return (bool)Storage; }
/// Determine the number of arguments in the selector.
///
/// When this is zero, the number of selector pieces will be one. Otherwise,
/// it equals the number of selector pieces.
unsigned getNumArgs() const {
if (Storage.isSimpleName()) {
return 0;
}
return Storage.getArgumentNames().size();
}
/// Determine the number of selector pieces in the selector.
///
/// When this is one, the number of arguments may either be zero or one.
/// Otherwise, it equals the number of arguments.
unsigned getNumSelectorPieces() const {
return getSelectorPieces().size();
}
/// Retrieve the pieces in this selector.
ArrayRef<Identifier> getSelectorPieces() const {
if (Storage.isSimpleName()) {
return { reinterpret_cast<const Identifier*>(&Storage), 1 };
}
return Storage.getArgumentNames();
}
/// Asserts that this is a nullary selector and returns the single identifier.
Identifier getSimpleName() const {
assert(Storage.isSimpleName() && "not a nullary selector");
return Storage.getBaseIdentifier();
}
/// Get a string representation of the selector.
///
/// \param scratch Scratch space to use.
StringRef getString(llvm::SmallVectorImpl<char> &scratch) const;
ObjCSelectorFamily getSelectorFamily() const;
void *getOpaqueValue() const { return Storage.getOpaqueValue(); }
static ObjCSelector getFromOpaqueValue(void *p) {
return ObjCSelector(DeclName::getFromOpaqueValue(p));
}
/// Dump this selector to standard error.
SWIFT_DEBUG_DUMP;
/// Compare two Objective-C selectors, producing -1 if \c *this comes before
/// \c other, 1 if \c *this comes after \c other, and 0 if they are equal.
int compare(ObjCSelector other) const {
return Storage.compare(other.Storage);
}
friend bool operator==(ObjCSelector lhs, ObjCSelector rhs) {
return lhs.getOpaqueValue() == rhs.getOpaqueValue();
}
friend bool operator!=(ObjCSelector lhs, ObjCSelector rhs) {
return !(lhs == rhs);
}
friend bool operator<(ObjCSelector lhs, ObjCSelector rhs) {
return lhs.compare(rhs) < 0;
}
friend bool operator<=(ObjCSelector lhs, ObjCSelector rhs) {
return lhs.compare(rhs) <= 0;
}
friend bool operator>(ObjCSelector lhs, ObjCSelector rhs) {
return lhs.compare(rhs) > 0;
}
friend bool operator>=(ObjCSelector lhs, ObjCSelector rhs) {
return lhs.compare(rhs) >= 0;
}
friend llvm::hash_code hash_value(ObjCSelector selector) {
using llvm::hash_value;
return hash_value(selector.getOpaqueValue());
}
};
void simple_display(llvm::raw_ostream &out, ObjCSelector selector);
} // end namespace swift
namespace llvm {
// A DeclName is "pointer like".
template<typename T> struct PointerLikeTypeTraits;
template<>
struct PointerLikeTypeTraits<swift::DeclName> {
public:
static inline void *getAsVoidPointer(swift::DeclName name) {
return name.getOpaqueValue();
}
static inline swift::DeclName getFromVoidPointer(void *ptr) {
return swift::DeclName::getFromOpaqueValue(ptr);
}
enum { NumLowBitsAvailable = PointerLikeTypeTraits<swift::DeclBaseName>::NumLowBitsAvailable - 1 };
};
// DeclNames hash just like pointers.
template<> struct DenseMapInfo<swift::DeclName> {
static swift::DeclName getEmptyKey() {
return swift::Identifier::getEmptyKey();
}
static swift::DeclName getTombstoneKey() {
return swift::Identifier::getTombstoneKey();
}
static unsigned getHashValue(swift::DeclName Val) {
return DenseMapInfo<void*>::getHashValue(Val.getOpaqueValue());
}
static bool isEqual(swift::DeclName LHS, swift::DeclName RHS) {
return LHS.getOpaqueValue() == RHS.getOpaqueValue();
}
};
// A DeclNameRef is "pointer like" just like DeclNames.
template<typename T> struct PointerLikeTypeTraits;
template<>
struct PointerLikeTypeTraits<swift::DeclNameRef> {
public:
static inline void *getAsVoidPointer(swift::DeclNameRef name) {
return name.getOpaqueValue();
}
static inline swift::DeclNameRef getFromVoidPointer(void *ptr) {
return swift::DeclNameRef::getFromOpaqueValue(ptr);
}
enum { NumLowBitsAvailable = PointerLikeTypeTraits<swift::DeclName>::NumLowBitsAvailable };
};
// DeclNameRefs hash just like DeclNames.
template<> struct DenseMapInfo<swift::DeclNameRef> {
static swift::DeclNameRef getEmptyKey() {
return swift::DeclNameRef(DenseMapInfo<swift::DeclName>::getEmptyKey());
}
static swift::DeclNameRef getTombstoneKey() {
return swift::DeclNameRef(DenseMapInfo<swift::DeclName>::getTombstoneKey());
}
static unsigned getHashValue(swift::DeclNameRef Val) {
return DenseMapInfo<swift::DeclName>::getHashValue(Val.getFullName());
}
static bool isEqual(swift::DeclNameRef LHS, swift::DeclNameRef RHS) {
return DenseMapInfo<swift::DeclName>::isEqual(LHS.getFullName(),
RHS.getFullName());
}
};
// An ObjCSelector is "pointer like".
template<typename T> struct PointerLikeTypeTraits;
template<>
struct PointerLikeTypeTraits<swift::ObjCSelector> {
public:
static inline void *getAsVoidPointer(swift::ObjCSelector name) {
return name.getOpaqueValue();
}
static inline swift::ObjCSelector getFromVoidPointer(void *ptr) {
return swift::ObjCSelector::getFromOpaqueValue(ptr);
}
enum { NumLowBitsAvailable = 0 };
};
// ObjCSelectors hash just like pointers.
template<> struct DenseMapInfo<swift::ObjCSelector> {
static swift::ObjCSelector getEmptyKey() {
return swift::ObjCSelector(DenseMapInfo<swift::DeclName>::getEmptyKey());
}
static swift::ObjCSelector getTombstoneKey() {
return swift::ObjCSelector(
DenseMapInfo<swift::DeclName>::getTombstoneKey());
}
static unsigned getHashValue(swift::ObjCSelector Val) {
return DenseMapInfo<void*>::getHashValue(Val.getOpaqueValue());
}
static bool isEqual(swift::ObjCSelector LHS, swift::ObjCSelector RHS) {
return LHS.getOpaqueValue() == RHS.getOpaqueValue();
}
};
} // end namespace llvm
#endif