1 //===--- NestedNameSpecifier.cpp - C++ nested name specifiers -----*- C++ -*-=//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the NestedNameSpecifier class, which represents
11 // a C++ nested-name-specifier.
13 //===----------------------------------------------------------------------===//
14 #include "clang/AST/NestedNameSpecifier.h"
15 #include "clang/AST/ASTContext.h"
16 #include "clang/AST/Decl.h"
17 #include "clang/AST/DeclCXX.h"
18 #include "clang/AST/PrettyPrinter.h"
19 #include "clang/AST/Type.h"
20 #include "clang/AST/TypeLoc.h"
21 #include "llvm/Support/AlignOf.h"
22 #include "llvm/Support/raw_ostream.h"
25 using namespace clang
;
28 NestedNameSpecifier::FindOrInsert(const ASTContext
&Context
,
29 const NestedNameSpecifier
&Mockup
) {
30 llvm::FoldingSetNodeID ID
;
34 NestedNameSpecifier
*NNS
35 = Context
.NestedNameSpecifiers
.FindNodeOrInsertPos(ID
, InsertPos
);
37 NNS
= new (Context
, llvm::alignOf
<NestedNameSpecifier
>())
38 NestedNameSpecifier(Mockup
);
39 Context
.NestedNameSpecifiers
.InsertNode(NNS
, InsertPos
);
46 NestedNameSpecifier::Create(const ASTContext
&Context
,
47 NestedNameSpecifier
*Prefix
, IdentifierInfo
*II
) {
48 assert(II
&& "Identifier cannot be NULL");
49 assert((!Prefix
|| Prefix
->isDependent()) && "Prefix must be dependent");
51 NestedNameSpecifier Mockup
;
52 Mockup
.Prefix
.setPointer(Prefix
);
53 Mockup
.Prefix
.setInt(StoredIdentifier
);
54 Mockup
.Specifier
= II
;
55 return FindOrInsert(Context
, Mockup
);
59 NestedNameSpecifier::Create(const ASTContext
&Context
,
60 NestedNameSpecifier
*Prefix
, NamespaceDecl
*NS
) {
61 assert(NS
&& "Namespace cannot be NULL");
63 (Prefix
->getAsType() == 0 && Prefix
->getAsIdentifier() == 0)) &&
64 "Broken nested name specifier");
65 NestedNameSpecifier Mockup
;
66 Mockup
.Prefix
.setPointer(Prefix
);
67 Mockup
.Prefix
.setInt(StoredNamespaceOrAlias
);
68 Mockup
.Specifier
= NS
;
69 return FindOrInsert(Context
, Mockup
);
73 NestedNameSpecifier::Create(const ASTContext
&Context
,
74 NestedNameSpecifier
*Prefix
,
75 NamespaceAliasDecl
*Alias
) {
76 assert(Alias
&& "Namespace alias cannot be NULL");
78 (Prefix
->getAsType() == 0 && Prefix
->getAsIdentifier() == 0)) &&
79 "Broken nested name specifier");
80 NestedNameSpecifier Mockup
;
81 Mockup
.Prefix
.setPointer(Prefix
);
82 Mockup
.Prefix
.setInt(StoredNamespaceOrAlias
);
83 Mockup
.Specifier
= Alias
;
84 return FindOrInsert(Context
, Mockup
);
88 NestedNameSpecifier::Create(const ASTContext
&Context
,
89 NestedNameSpecifier
*Prefix
,
90 bool Template
, const Type
*T
) {
91 assert(T
&& "Type cannot be NULL");
92 NestedNameSpecifier Mockup
;
93 Mockup
.Prefix
.setPointer(Prefix
);
94 Mockup
.Prefix
.setInt(Template
? StoredTypeSpecWithTemplate
: StoredTypeSpec
);
95 Mockup
.Specifier
= const_cast<Type
*>(T
);
96 return FindOrInsert(Context
, Mockup
);
100 NestedNameSpecifier::Create(const ASTContext
&Context
, IdentifierInfo
*II
) {
101 assert(II
&& "Identifier cannot be NULL");
102 NestedNameSpecifier Mockup
;
103 Mockup
.Prefix
.setPointer(0);
104 Mockup
.Prefix
.setInt(StoredIdentifier
);
105 Mockup
.Specifier
= II
;
106 return FindOrInsert(Context
, Mockup
);
109 NestedNameSpecifier
*
110 NestedNameSpecifier::GlobalSpecifier(const ASTContext
&Context
) {
111 if (!Context
.GlobalNestedNameSpecifier
)
112 Context
.GlobalNestedNameSpecifier
=
113 new (Context
, llvm::alignOf
<NestedNameSpecifier
>())
114 NestedNameSpecifier();
115 return Context
.GlobalNestedNameSpecifier
;
118 NestedNameSpecifier::SpecifierKind
NestedNameSpecifier::getKind() const {
122 switch (Prefix
.getInt()) {
123 case StoredIdentifier
:
126 case StoredNamespaceOrAlias
:
127 return isa
<NamespaceDecl
>(static_cast<NamedDecl
*>(Specifier
))? Namespace
133 case StoredTypeSpecWithTemplate
:
134 return TypeSpecWithTemplate
;
137 llvm_unreachable("Invalid NNS Kind!");
140 /// \brief Retrieve the namespace stored in this nested name
142 NamespaceDecl
*NestedNameSpecifier::getAsNamespace() const {
143 if (Prefix
.getInt() == StoredNamespaceOrAlias
)
144 return dyn_cast
<NamespaceDecl
>(static_cast<NamedDecl
*>(Specifier
));
149 /// \brief Retrieve the namespace alias stored in this nested name
151 NamespaceAliasDecl
*NestedNameSpecifier::getAsNamespaceAlias() const {
152 if (Prefix
.getInt() == StoredNamespaceOrAlias
)
153 return dyn_cast
<NamespaceAliasDecl
>(static_cast<NamedDecl
*>(Specifier
));
159 /// \brief Whether this nested name specifier refers to a dependent
161 bool NestedNameSpecifier::isDependent() const {
164 // Identifier specifiers always represent dependent types
173 case TypeSpecWithTemplate
:
174 return getAsType()->isDependentType();
177 llvm_unreachable("Invalid NNS Kind!");
180 /// \brief Whether this nested name specifier refers to a dependent
182 bool NestedNameSpecifier::isInstantiationDependent() const {
185 // Identifier specifiers always represent dependent types
194 case TypeSpecWithTemplate
:
195 return getAsType()->isInstantiationDependentType();
198 llvm_unreachable("Invalid NNS Kind!");
201 bool NestedNameSpecifier::containsUnexpandedParameterPack() const {
204 return getPrefix() && getPrefix()->containsUnexpandedParameterPack();
212 case TypeSpecWithTemplate
:
213 return getAsType()->containsUnexpandedParameterPack();
216 llvm_unreachable("Invalid NNS Kind!");
219 /// \brief Print this nested name specifier to the given output
222 NestedNameSpecifier::print(raw_ostream
&OS
,
223 const PrintingPolicy
&Policy
) const {
225 getPrefix()->print(OS
, Policy
);
229 OS
<< getAsIdentifier()->getName();
233 if (getAsNamespace()->isAnonymousNamespace())
236 OS
<< getAsNamespace()->getName();
240 OS
<< getAsNamespaceAlias()->getName();
246 case TypeSpecWithTemplate
:
248 // Fall through to print the type.
252 const Type
*T
= getAsType();
254 PrintingPolicy
InnerPolicy(Policy
);
255 InnerPolicy
.SuppressScope
= true;
257 // Nested-name-specifiers are intended to contain minimally-qualified
258 // types. An actual ElaboratedType will not occur, since we'll store
259 // just the type that is referred to in the nested-name-specifier (e.g.,
260 // a TypedefType, TagType, etc.). However, when we are dealing with
261 // dependent template-id types (e.g., Outer<T>::template Inner<U>),
262 // the type requires its own nested-name-specifier for uniqueness, so we
263 // suppress that nested-name-specifier during printing.
264 assert(!isa
<ElaboratedType
>(T
) &&
265 "Elaborated type in nested-name-specifier");
266 if (const TemplateSpecializationType
*SpecType
267 = dyn_cast
<TemplateSpecializationType
>(T
)) {
268 // Print the template name without its corresponding
269 // nested-name-specifier.
270 SpecType
->getTemplateName().print(OS
, InnerPolicy
, true);
272 // Print the template argument list.
273 TypeStr
= TemplateSpecializationType::PrintTemplateArgumentList(
275 SpecType
->getNumArgs(),
278 // Print the type normally
279 TypeStr
= QualType(T
, 0).getAsString(InnerPolicy
);
289 void NestedNameSpecifier::dump(const LangOptions
&LO
) {
290 print(llvm::errs(), PrintingPolicy(LO
));
294 NestedNameSpecifierLoc::getLocalDataLength(NestedNameSpecifier
*Qualifier
) {
295 assert(Qualifier
&& "Expected a non-NULL qualifier");
297 // Location of the trailing '::'.
298 unsigned Length
= sizeof(unsigned);
300 switch (Qualifier
->getKind()) {
301 case NestedNameSpecifier::Global
:
302 // Nothing more to add.
305 case NestedNameSpecifier::Identifier
:
306 case NestedNameSpecifier::Namespace
:
307 case NestedNameSpecifier::NamespaceAlias
:
308 // The location of the identifier or namespace name.
309 Length
+= sizeof(unsigned);
312 case NestedNameSpecifier::TypeSpecWithTemplate
:
313 case NestedNameSpecifier::TypeSpec
:
314 // The "void*" that points at the TypeLoc data.
315 // Note: the 'template' keyword is part of the TypeLoc.
316 Length
+= sizeof(void *);
324 NestedNameSpecifierLoc::getDataLength(NestedNameSpecifier
*Qualifier
) {
326 for (; Qualifier
; Qualifier
= Qualifier
->getPrefix())
327 Length
+= getLocalDataLength(Qualifier
);
332 /// \brief Load a (possibly unaligned) source location from a given address
334 SourceLocation
LoadSourceLocation(void *Data
, unsigned Offset
) {
336 memcpy(&Raw
, static_cast<char *>(Data
) + Offset
, sizeof(unsigned));
337 return SourceLocation::getFromRawEncoding(Raw
);
340 /// \brief Load a (possibly unaligned) pointer from a given address and
342 void *LoadPointer(void *Data
, unsigned Offset
) {
344 memcpy(&Result
, static_cast<char *>(Data
) + Offset
, sizeof(void*));
349 SourceRange
NestedNameSpecifierLoc::getSourceRange() const {
351 return SourceRange();
353 NestedNameSpecifierLoc First
= *this;
354 while (NestedNameSpecifierLoc Prefix
= First
.getPrefix())
357 return SourceRange(First
.getLocalSourceRange().getBegin(),
358 getLocalSourceRange().getEnd());
361 SourceRange
NestedNameSpecifierLoc::getLocalSourceRange() const {
363 return SourceRange();
365 unsigned Offset
= getDataLength(Qualifier
->getPrefix());
366 switch (Qualifier
->getKind()) {
367 case NestedNameSpecifier::Global
:
368 return LoadSourceLocation(Data
, Offset
);
370 case NestedNameSpecifier::Identifier
:
371 case NestedNameSpecifier::Namespace
:
372 case NestedNameSpecifier::NamespaceAlias
:
373 return SourceRange(LoadSourceLocation(Data
, Offset
),
374 LoadSourceLocation(Data
, Offset
+ sizeof(unsigned)));
376 case NestedNameSpecifier::TypeSpecWithTemplate
:
377 case NestedNameSpecifier::TypeSpec
: {
378 // The "void*" that points at the TypeLoc data.
379 // Note: the 'template' keyword is part of the TypeLoc.
380 void *TypeData
= LoadPointer(Data
, Offset
);
381 TypeLoc
TL(Qualifier
->getAsType(), TypeData
);
382 return SourceRange(TL
.getBeginLoc(),
383 LoadSourceLocation(Data
, Offset
+ sizeof(void*)));
387 llvm_unreachable("Invalid NNS Kind!");
390 TypeLoc
NestedNameSpecifierLoc::getTypeLoc() const {
391 assert((Qualifier
->getKind() == NestedNameSpecifier::TypeSpec
||
392 Qualifier
->getKind() == NestedNameSpecifier::TypeSpecWithTemplate
) &&
393 "Nested-name-specifier location is not a type");
395 // The "void*" that points at the TypeLoc data.
396 unsigned Offset
= getDataLength(Qualifier
->getPrefix());
397 void *TypeData
= LoadPointer(Data
, Offset
);
398 return TypeLoc(Qualifier
->getAsType(), TypeData
);
402 void Append(char *Start
, char *End
, char *&Buffer
, unsigned &BufferSize
,
403 unsigned &BufferCapacity
) {
404 if (BufferSize
+ (End
- Start
) > BufferCapacity
) {
405 // Reallocate the buffer.
407 = std::max((unsigned)(BufferCapacity
? BufferCapacity
* 2
408 : sizeof(void*) * 2),
409 (unsigned)(BufferSize
+ (End
- Start
)));
410 char *NewBuffer
= static_cast<char *>(malloc(NewCapacity
));
411 memcpy(NewBuffer
, Buffer
, BufferSize
);
416 BufferCapacity
= NewCapacity
;
419 memcpy(Buffer
+ BufferSize
, Start
, End
- Start
);
420 BufferSize
+= End
-Start
;
423 /// \brief Save a source location to the given buffer.
424 void SaveSourceLocation(SourceLocation Loc
, char *&Buffer
,
425 unsigned &BufferSize
, unsigned &BufferCapacity
) {
426 unsigned Raw
= Loc
.getRawEncoding();
427 Append(reinterpret_cast<char *>(&Raw
),
428 reinterpret_cast<char *>(&Raw
) + sizeof(unsigned),
429 Buffer
, BufferSize
, BufferCapacity
);
432 /// \brief Save a pointer to the given buffer.
433 void SavePointer(void *Ptr
, char *&Buffer
, unsigned &BufferSize
,
434 unsigned &BufferCapacity
) {
435 Append(reinterpret_cast<char *>(&Ptr
),
436 reinterpret_cast<char *>(&Ptr
) + sizeof(void *),
437 Buffer
, BufferSize
, BufferCapacity
);
441 NestedNameSpecifierLocBuilder::
442 NestedNameSpecifierLocBuilder(const NestedNameSpecifierLocBuilder
&Other
)
443 : Representation(Other
.Representation
), Buffer(0),
444 BufferSize(0), BufferCapacity(0)
449 if (Other
.BufferCapacity
== 0) {
450 // Shallow copy is okay.
451 Buffer
= Other
.Buffer
;
452 BufferSize
= Other
.BufferSize
;
457 BufferSize
= Other
.BufferSize
;
458 BufferCapacity
= Other
.BufferSize
;
459 Buffer
= static_cast<char *>(malloc(BufferCapacity
));
460 memcpy(Buffer
, Other
.Buffer
, BufferSize
);
463 NestedNameSpecifierLocBuilder
&
464 NestedNameSpecifierLocBuilder::
465 operator=(const NestedNameSpecifierLocBuilder
&Other
) {
466 Representation
= Other
.Representation
;
468 if (Buffer
&& Other
.Buffer
&& BufferCapacity
>= Other
.BufferSize
) {
469 // Re-use our storage.
470 BufferSize
= Other
.BufferSize
;
471 memcpy(Buffer
, Other
.Buffer
, BufferSize
);
475 // Free our storage, if we have any.
476 if (BufferCapacity
) {
488 if (Other
.BufferCapacity
== 0) {
489 // Shallow copy is okay.
490 Buffer
= Other
.Buffer
;
491 BufferSize
= Other
.BufferSize
;
496 BufferSize
= Other
.BufferSize
;
497 BufferCapacity
= BufferSize
;
498 Buffer
= static_cast<char *>(malloc(BufferSize
));
499 memcpy(Buffer
, Other
.Buffer
, BufferSize
);
503 void NestedNameSpecifierLocBuilder::Extend(ASTContext
&Context
,
504 SourceLocation TemplateKWLoc
,
506 SourceLocation ColonColonLoc
) {
507 Representation
= NestedNameSpecifier::Create(Context
, Representation
,
508 TemplateKWLoc
.isValid(),
511 // Push source-location info into the buffer.
512 SavePointer(TL
.getOpaqueData(), Buffer
, BufferSize
, BufferCapacity
);
513 SaveSourceLocation(ColonColonLoc
, Buffer
, BufferSize
, BufferCapacity
);
516 void NestedNameSpecifierLocBuilder::Extend(ASTContext
&Context
,
517 IdentifierInfo
*Identifier
,
518 SourceLocation IdentifierLoc
,
519 SourceLocation ColonColonLoc
) {
520 Representation
= NestedNameSpecifier::Create(Context
, Representation
,
523 // Push source-location info into the buffer.
524 SaveSourceLocation(IdentifierLoc
, Buffer
, BufferSize
, BufferCapacity
);
525 SaveSourceLocation(ColonColonLoc
, Buffer
, BufferSize
, BufferCapacity
);
528 void NestedNameSpecifierLocBuilder::Extend(ASTContext
&Context
,
529 NamespaceDecl
*Namespace
,
530 SourceLocation NamespaceLoc
,
531 SourceLocation ColonColonLoc
) {
532 Representation
= NestedNameSpecifier::Create(Context
, Representation
,
535 // Push source-location info into the buffer.
536 SaveSourceLocation(NamespaceLoc
, Buffer
, BufferSize
, BufferCapacity
);
537 SaveSourceLocation(ColonColonLoc
, Buffer
, BufferSize
, BufferCapacity
);
540 void NestedNameSpecifierLocBuilder::Extend(ASTContext
&Context
,
541 NamespaceAliasDecl
*Alias
,
542 SourceLocation AliasLoc
,
543 SourceLocation ColonColonLoc
) {
544 Representation
= NestedNameSpecifier::Create(Context
, Representation
, Alias
);
546 // Push source-location info into the buffer.
547 SaveSourceLocation(AliasLoc
, Buffer
, BufferSize
, BufferCapacity
);
548 SaveSourceLocation(ColonColonLoc
, Buffer
, BufferSize
, BufferCapacity
);
551 void NestedNameSpecifierLocBuilder::MakeGlobal(ASTContext
&Context
,
552 SourceLocation ColonColonLoc
) {
553 assert(!Representation
&& "Already have a nested-name-specifier!?");
554 Representation
= NestedNameSpecifier::GlobalSpecifier(Context
);
556 // Push source-location info into the buffer.
557 SaveSourceLocation(ColonColonLoc
, Buffer
, BufferSize
, BufferCapacity
);
560 void NestedNameSpecifierLocBuilder::MakeTrivial(ASTContext
&Context
,
561 NestedNameSpecifier
*Qualifier
,
563 Representation
= Qualifier
;
565 // Construct bogus (but well-formed) source information for the
566 // nested-name-specifier.
568 SmallVector
<NestedNameSpecifier
*, 4> Stack
;
569 for (NestedNameSpecifier
*NNS
= Qualifier
; NNS
; NNS
= NNS
->getPrefix())
570 Stack
.push_back(NNS
);
571 while (!Stack
.empty()) {
572 NestedNameSpecifier
*NNS
= Stack
.back();
574 switch (NNS
->getKind()) {
575 case NestedNameSpecifier::Identifier
:
576 case NestedNameSpecifier::Namespace
:
577 case NestedNameSpecifier::NamespaceAlias
:
578 SaveSourceLocation(R
.getBegin(), Buffer
, BufferSize
, BufferCapacity
);
581 case NestedNameSpecifier::TypeSpec
:
582 case NestedNameSpecifier::TypeSpecWithTemplate
: {
583 TypeSourceInfo
*TSInfo
584 = Context
.getTrivialTypeSourceInfo(QualType(NNS
->getAsType(), 0),
586 SavePointer(TSInfo
->getTypeLoc().getOpaqueData(), Buffer
, BufferSize
,
591 case NestedNameSpecifier::Global
:
595 // Save the location of the '::'.
596 SaveSourceLocation(Stack
.empty()? R
.getEnd() : R
.getBegin(),
597 Buffer
, BufferSize
, BufferCapacity
);
601 void NestedNameSpecifierLocBuilder::Adopt(NestedNameSpecifierLoc Other
) {
611 // Rather than copying the data (which is wasteful), "adopt" the
612 // pointer (which points into the ASTContext) but set the capacity to zero to
613 // indicate that we don't own it.
614 Representation
= Other
.getNestedNameSpecifier();
615 Buffer
= static_cast<char *>(Other
.getOpaqueData());
616 BufferSize
= Other
.getDataLength();
620 NestedNameSpecifierLoc
621 NestedNameSpecifierLocBuilder::getWithLocInContext(ASTContext
&Context
) const {
623 return NestedNameSpecifierLoc();
625 // If we adopted our data pointer from elsewhere in the AST context, there's
626 // no need to copy the memory.
627 if (BufferCapacity
== 0)
628 return NestedNameSpecifierLoc(Representation
, Buffer
);
630 // FIXME: After copying the source-location information, should we free
631 // our (temporary) buffer and adopt the ASTContext-allocated memory?
632 // Doing so would optimize repeated calls to getWithLocInContext().
633 void *Mem
= Context
.Allocate(BufferSize
, llvm::alignOf
<void *>());
634 memcpy(Mem
, Buffer
, BufferSize
);
635 return NestedNameSpecifierLoc(Representation
, Mem
);