clang  6.0.0svn
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
clang::Qualifiers Class Reference

The collection of all-type qualifiers we support. More...

#include "clang/AST/Type.h"

Inheritance diagram for clang::Qualifiers:
Inheritance graph
[legend]

Public Types

enum  TQ { Const = 0x1, Restrict = 0x2, Volatile = 0x4, CVRMask = Const | Volatile | Restrict }
 
enum  GC { GCNone = 0, Weak, Strong }
 
enum  ObjCLifetime {
  OCL_None, OCL_ExplicitNone, OCL_Strong, OCL_Weak,
  OCL_Autoreleasing
}
 
enum  { MaxAddressSpace = 0x7fffffu, FastWidth = 3, FastMask = (1 << FastWidth) - 1 }
 

Public Member Functions

unsigned getAsOpaqueValue () const
 
bool hasConst () const
 
void setConst (bool flag)
 
void removeConst ()
 
void addConst ()
 
bool hasVolatile () const
 
void setVolatile (bool flag)
 
void removeVolatile ()
 
void addVolatile ()
 
bool hasRestrict () const
 
void setRestrict (bool flag)
 
void removeRestrict ()
 
void addRestrict ()
 
bool hasCVRQualifiers () const
 
unsigned getCVRQualifiers () const
 
void setCVRQualifiers (unsigned mask)
 
void removeCVRQualifiers (unsigned mask)
 
void removeCVRQualifiers ()
 
void addCVRQualifiers (unsigned mask)
 
void addCVRUQualifiers (unsigned mask)
 
bool hasUnaligned () const
 
void setUnaligned (bool flag)
 
void removeUnaligned ()
 
void addUnaligned ()
 
bool hasObjCGCAttr () const
 
GC getObjCGCAttr () const
 
void setObjCGCAttr (GC type)
 
void removeObjCGCAttr ()
 
void addObjCGCAttr (GC type)
 
Qualifiers withoutObjCGCAttr () const
 
Qualifiers withoutObjCLifetime () const
 
bool hasObjCLifetime () const
 
ObjCLifetime getObjCLifetime () const
 
void setObjCLifetime (ObjCLifetime type)
 
void removeObjCLifetime ()
 
void addObjCLifetime (ObjCLifetime type)
 
bool hasNonTrivialObjCLifetime () const
 True if the lifetime is neither None or ExplicitNone. More...
 
bool hasStrongOrWeakObjCLifetime () const
 True if the lifetime is either strong or weak. More...
 
bool hasAddressSpace () const
 
LangAS getAddressSpace () const
 
bool hasTargetSpecificAddressSpace () const
 
unsigned getAddressSpaceAttributePrintValue () const
 Get the address space attribute value to be printed by diagnostics. More...
 
void setAddressSpace (LangAS space)
 
void removeAddressSpace ()
 
void addAddressSpace (LangAS space)
 
bool hasFastQualifiers () const
 
unsigned getFastQualifiers () const
 
void setFastQualifiers (unsigned mask)
 
void removeFastQualifiers (unsigned mask)
 
void removeFastQualifiers ()
 
void addFastQualifiers (unsigned mask)
 
bool hasNonFastQualifiers () const
 Return true if the set contains any qualifiers which require an ExtQuals node to be allocated. More...
 
Qualifiers getNonFastQualifiers () const
 
bool hasQualifiers () const
 Return true if the set contains any qualifiers. More...
 
bool empty () const
 
void addQualifiers (Qualifiers Q)
 Add the qualifiers from the given set to this set. More...
 
void removeQualifiers (Qualifiers Q)
 Remove the qualifiers from the given set from this set. More...
 
void addConsistentQualifiers (Qualifiers qs)
 Add the qualifiers from the given set to this set, given that they don't conflict. More...
 
bool isAddressSpaceSupersetOf (Qualifiers other) const
 Returns true if this address space is a superset of the other one. More...
 
bool compatiblyIncludes (Qualifiers other) const
 Determines if these qualifiers compatibly include another set. More...
 
bool compatiblyIncludesObjCLifetime (Qualifiers other) const
 Determines if these qualifiers compatibly include another set of qualifiers from the narrow perspective of Objective-C ARC lifetime. More...
 
bool isStrictSupersetOf (Qualifiers Other) const
 Determine whether this set of qualifiers is a strict superset of another set of qualifiers, not considering qualifier compatibility. More...
 
bool operator== (Qualifiers Other) const
 
bool operator!= (Qualifiers Other) const
 
 operator bool () const
 
Qualifiersoperator+= (Qualifiers R)
 
Qualifiersoperator-= (Qualifiers R)
 
std::string getAsString () const
 
std::string getAsString (const PrintingPolicy &Policy) const
 
bool isEmptyWhenPrinted (const PrintingPolicy &Policy) const
 
void print (raw_ostream &OS, const PrintingPolicy &Policy, bool appendSpaceIfNonEmpty=false) const
 
void Profile (llvm::FoldingSetNodeID &ID) const
 

Static Public Member Functions

static Qualifiers removeCommonQualifiers (Qualifiers &L, Qualifiers &R)
 Returns the common set of qualifiers while removing them from the given sets. More...
 
static Qualifiers fromFastMask (unsigned Mask)
 
static Qualifiers fromCVRMask (unsigned CVR)
 
static Qualifiers fromCVRUMask (unsigned CVRU)
 
static Qualifiers fromOpaqueValue (unsigned opaque)
 

Friends

Qualifiers operator+ (Qualifiers L, Qualifiers R)
 
Qualifiers operator- (Qualifiers L, Qualifiers R)
 Compute the difference between two qualifier sets. More...
 

Detailed Description

The collection of all-type qualifiers we support.

Clang supports five independent qualifiers:

Definition at line 152 of file Type.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
MaxAddressSpace 

The maximum supported address space number.

23 bits should be enough for anyone.

FastWidth 

The width of the "fast" qualifier mask.

FastMask 

The fast qualifier mask.

Definition at line 189 of file Type.h.

◆ GC

Enumerator
GCNone 
Weak 
Strong 

Definition at line 161 of file Type.h.

◆ ObjCLifetime

Enumerator
OCL_None 

There is no lifetime qualification on this type.

OCL_ExplicitNone 

This object can be modified without requiring retains or releases.

OCL_Strong 

Assigning into this object requires the old value to be released and the new value to be retained.

The timing of the release of the old value is inexact: it may be moved to immediately after the last known point where the value is live.

OCL_Weak 

Reading or writing from this object requires a barrier call.

OCL_Autoreleasing 

Assigning into this object requires a lifetime extension.

Definition at line 167 of file Type.h.

◆ TQ

Enumerator
Const 
Restrict 
Volatile 
CVRMask 

Definition at line 154 of file Type.h.

Member Function Documentation

◆ addAddressSpace()

void clang::Qualifiers::addAddressSpace ( LangAS  space)
inline

◆ addConsistentQualifiers()

void clang::Qualifiers::addConsistentQualifiers ( Qualifiers  qs)
inline

◆ addConst()

void clang::Qualifiers::addConst ( )
inline

Definition at line 274 of file Type.h.

Referenced by clang::Sema::AddBuiltinOperatorCandidates().

◆ addCVRQualifiers()

void clang::Qualifiers::addCVRQualifiers ( unsigned  mask)
inline

◆ addCVRUQualifiers()

void clang::Qualifiers::addCVRUQualifiers ( unsigned  mask)
inline

Definition at line 307 of file Type.h.

Referenced by fromCVRUMask().

◆ addFastQualifiers()

void clang::Qualifiers::addFastQualifiers ( unsigned  mask)
inline

◆ addObjCGCAttr()

void clang::Qualifiers::addObjCGCAttr ( GC  type)
inline

Definition at line 325 of file Type.h.

Referenced by clang::ASTContext::getObjCGCQualType().

◆ addObjCLifetime()

void clang::Qualifiers::addObjCLifetime ( ObjCLifetime  type)
inline

◆ addQualifiers()

void clang::Qualifiers::addQualifiers ( Qualifiers  Q)
inline

Add the qualifiers from the given set to this set.

Definition at line 432 of file Type.h.

References getAddressSpace(), getObjCGCAttr(), getObjCLifetime(), hasAddressSpace(), hasObjCGCAttr(), and hasObjCLifetime().

◆ addRestrict()

void clang::Qualifiers::addRestrict ( )
inline

Definition at line 288 of file Type.h.

Referenced by clang::CodeGen::CGOpenMPRuntimeNVPTX::translateParameter().

◆ addUnaligned()

void clang::Qualifiers::addUnaligned ( )
inline

Definition at line 317 of file Type.h.

◆ addVolatile()

void clang::Qualifiers::addVolatile ( )
inline

Definition at line 281 of file Type.h.

◆ compatiblyIncludes()

bool clang::Qualifiers::compatiblyIncludes ( Qualifiers  other) const
inline

Determines if these qualifiers compatibly include another set.

Generally this answers the question of whether an object with the other qualifiers can be safely used as an object with these qualifiers.

Definition at line 497 of file Type.h.

References getObjCGCAttr(), getObjCLifetime(), hasObjCGCAttr(), and hasUnaligned().

Referenced by checkPointerTypesForAssignment(), clang::QualType::isAtLeastAsQualifiedAs(), clang::QualType::isMoreQualifiedThan(), TryReferenceInit(), and TryStaticCast().

◆ compatiblyIncludesObjCLifetime()

bool clang::Qualifiers::compatiblyIncludesObjCLifetime ( Qualifiers  other) const
inline

Determines if these qualifiers compatibly include another set of qualifiers from the narrow perspective of Objective-C ARC lifetime.

One set of Objective-C lifetime qualifiers compatibly includes the other if the lifetime qualifiers match, or if both are non-__weak and the including set also contains the 'const' qualifier, or both are non-__weak and one is None (which can only happen in non-ARC modes).

Definition at line 518 of file Type.h.

References getObjCLifetime().

Referenced by CastsAwayConstness(), checkPointerTypesForAssignment(), and DiagnoseBadFunctionCast().

◆ empty()

bool clang::Qualifiers::empty ( ) const
inline

◆ fromCVRMask()

static Qualifiers clang::Qualifiers::fromCVRMask ( unsigned  CVR)
inlinestatic

◆ fromCVRUMask()

static Qualifiers clang::Qualifiers::fromCVRUMask ( unsigned  CVRU)
inlinestatic

Definition at line 251 of file Type.h.

References addCVRUQualifiers().

Referenced by clang::CXXMethodDecl::getThisType().

◆ fromFastMask()

static Qualifiers clang::Qualifiers::fromFastMask ( unsigned  Mask)
inlinestatic

Definition at line 239 of file Type.h.

References addFastQualifiers().

Referenced by clang::QualType::split().

◆ fromOpaqueValue()

static Qualifiers clang::Qualifiers::fromOpaqueValue ( unsigned  opaque)
inlinestatic

Definition at line 258 of file Type.h.

◆ getAddressSpace()

LangAS clang::Qualifiers::getAddressSpace ( ) const
inline

◆ getAddressSpaceAttributePrintValue()

unsigned clang::Qualifiers::getAddressSpaceAttributePrintValue ( ) const
inline

Get the address space attribute value to be printed by diagnostics.

Definition at line 374 of file Type.h.

References clang::Default, and clang::toTargetAddressSpace().

Referenced by clang::Sema::ActOnCXXDelete(), and clang::Sema::CheckAllocatedType().

◆ getAsOpaqueValue()

unsigned clang::Qualifiers::getAsOpaqueValue ( ) const
inline

◆ getAsString() [1/2]

std::string Qualifiers::getAsString ( ) const

Definition at line 1631 of file TypePrinter.cpp.

◆ getAsString() [2/2]

std::string Qualifiers::getAsString ( const PrintingPolicy Policy) const

Definition at line 1639 of file TypePrinter.cpp.

◆ getCVRQualifiers()

unsigned clang::Qualifiers::getCVRQualifiers ( ) const
inline

◆ getFastQualifiers()

unsigned clang::Qualifiers::getFastQualifiers ( ) const
inline

◆ getNonFastQualifiers()

Qualifiers clang::Qualifiers::getNonFastQualifiers ( ) const
inline

Definition at line 421 of file Type.h.

References setFastQualifiers().

◆ getObjCGCAttr()

GC clang::Qualifiers::getObjCGCAttr ( ) const
inline

◆ getObjCLifetime()

ObjCLifetime clang::Qualifiers::getObjCLifetime ( ) const
inline

◆ hasAddressSpace()

bool clang::Qualifiers::hasAddressSpace ( ) const
inline

◆ hasConst()

bool clang::Qualifiers::hasConst ( ) const
inline

◆ hasCVRQualifiers()

bool clang::Qualifiers::hasCVRQualifiers ( ) const
inline

Definition at line 290 of file Type.h.

◆ hasFastQualifiers()

bool clang::Qualifiers::hasFastQualifiers ( ) const
inline

Definition at line 400 of file Type.h.

Referenced by clang::ExtQuals::ExtQuals(), and clang::ExtQuals::Profile().

◆ hasNonFastQualifiers()

bool clang::Qualifiers::hasNonFastQualifiers ( ) const
inline

Return true if the set contains any qualifiers which require an ExtQuals node to be allocated.

Definition at line 420 of file Type.h.

Referenced by clang::ExtQuals::ExtQuals(), clang::ASTContext::getQualifiedType(), and clang::ASTContext::removeAddrSpaceQualType().

◆ hasNonTrivialObjCLifetime()

bool clang::Qualifiers::hasNonTrivialObjCLifetime ( ) const
inline

True if the lifetime is neither None or ExplicitNone.

Definition at line 355 of file Type.h.

Referenced by DeduceTemplateArgumentsByTypeMatch(), and clang::QualType::hasNonTrivialObjCLifetime().

◆ hasObjCGCAttr()

bool clang::Qualifiers::hasObjCGCAttr ( ) const
inline

◆ hasObjCLifetime()

bool clang::Qualifiers::hasObjCLifetime ( ) const
inline

◆ hasQualifiers()

bool clang::Qualifiers::hasQualifiers ( ) const
inline

Return true if the set contains any qualifiers.

Definition at line 428 of file Type.h.

Referenced by AppendTypeQualList().

◆ hasRestrict()

bool clang::Qualifiers::hasRestrict ( ) const
inline

◆ hasStrongOrWeakObjCLifetime()

bool clang::Qualifiers::hasStrongOrWeakObjCLifetime ( ) const
inline

True if the lifetime is either strong or weak.

Definition at line 361 of file Type.h.

Referenced by clang::QualType::hasStrongOrWeakObjCLifetime().

◆ hasTargetSpecificAddressSpace()

bool clang::Qualifiers::hasTargetSpecificAddressSpace ( ) const
inline

Definition at line 370 of file Type.h.

References clang::isTargetAddressSpace().

◆ hasUnaligned()

bool clang::Qualifiers::hasUnaligned ( ) const
inline

◆ hasVolatile()

bool clang::Qualifiers::hasVolatile ( ) const
inline

◆ isAddressSpaceSupersetOf()

bool clang::Qualifiers::isAddressSpaceSupersetOf ( Qualifiers  other) const
inline

Returns true if this address space is a superset of the other one.

OpenCL v2.0 defines conversion rules (OpenCLC v2.0 s6.5.5) and notion of overlapping address spaces. CL1.1 or CL1.2: every address space is a superset of itself. CL2.0 adds: __generic is a superset of any address space except for __constant.

Definition at line 484 of file Type.h.

References getAddressSpace(), clang::opencl_constant, and clang::opencl_generic.

Referenced by checkConditionalPointerCompatibility(), checkPointerTypesForAssignment(), clang::PointerType::isAddressSpaceOverlapping(), and clang::ASTContext::mergeTypes().

◆ isEmptyWhenPrinted()

bool Qualifiers::isEmptyWhenPrinted ( const PrintingPolicy Policy) const

Definition at line 1646 of file TypePrinter.cpp.

Referenced by AppendTypeQualList().

◆ isStrictSupersetOf()

bool Qualifiers::isStrictSupersetOf ( Qualifiers  Other) const

Determine whether this set of qualifiers is a strict superset of another set of qualifiers, not considering qualifier compatibility.

Definition at line 55 of file Type.cpp.

References CVRMask, getAddressSpace(), getObjCGCAttr(), getObjCLifetime(), hasAddressSpace(), hasObjCGCAttr(), and hasObjCLifetime().

Referenced by DeduceTemplateArgumentsByTypeMatch().

◆ operator bool()

clang::Qualifiers::operator bool ( ) const
inlineexplicit

Definition at line 538 of file Type.h.

◆ operator!=()

bool clang::Qualifiers::operator!= ( Qualifiers  Other) const
inline

Definition at line 536 of file Type.h.

◆ operator+=()

Qualifiers& clang::Qualifiers::operator+= ( Qualifiers  R)
inline

Definition at line 540 of file Type.h.

◆ operator-=()

Qualifiers& clang::Qualifiers::operator-= ( Qualifiers  R)
inline

Definition at line 552 of file Type.h.

◆ operator==()

bool clang::Qualifiers::operator== ( Qualifiers  Other) const
inline

Definition at line 535 of file Type.h.

◆ print()

void Qualifiers::print ( raw_ostream &  OS,
const PrintingPolicy Policy,
bool  appendSpaceIfNonEmpty = false 
) const

Definition at line 1666 of file TypePrinter.cpp.

Referenced by AppendTypeQualList().

◆ Profile()

void clang::Qualifiers::Profile ( llvm::FoldingSetNodeID &  ID) const
inline

Definition at line 570 of file Type.h.

Referenced by clang::ExtQuals::Profile().

◆ removeAddressSpace()

void clang::Qualifiers::removeAddressSpace ( )
inline

◆ removeCommonQualifiers()

static Qualifiers clang::Qualifiers::removeCommonQualifiers ( Qualifiers L,
Qualifiers R 
)
inlinestatic

Returns the common set of qualifiers while removing them from the given sets.

Definition at line 203 of file Type.h.

References addCVRQualifiers(), getAddressSpace(), getCVRQualifiers(), getObjCGCAttr(), getObjCLifetime(), removeAddressSpace(), removeCVRQualifiers(), removeObjCGCAttr(), removeObjCLifetime(), setAddressSpace(), setObjCGCAttr(), and setObjCLifetime().

Referenced by UnwrapTypeForDebugInfo().

◆ removeConst()

void clang::Qualifiers::removeConst ( )
inline

◆ removeCVRQualifiers() [1/2]

void clang::Qualifiers::removeCVRQualifiers ( unsigned  mask)
inline

◆ removeCVRQualifiers() [2/2]

void clang::Qualifiers::removeCVRQualifiers ( )
inline

Definition at line 300 of file Type.h.

◆ removeFastQualifiers() [1/2]

void clang::Qualifiers::removeFastQualifiers ( unsigned  mask)
inline

Definition at line 406 of file Type.h.

Referenced by clang::ASTContext::getASTObjCImplementationLayout().

◆ removeFastQualifiers() [2/2]

void clang::Qualifiers::removeFastQualifiers ( )
inline

Definition at line 410 of file Type.h.

◆ removeObjCGCAttr()

void clang::Qualifiers::removeObjCGCAttr ( )
inline

◆ removeObjCLifetime()

void clang::Qualifiers::removeObjCLifetime ( )
inline

◆ removeQualifiers()

void clang::Qualifiers::removeQualifiers ( Qualifiers  Q)
inline

Remove the qualifiers from the given set from this set.

Definition at line 449 of file Type.h.

References getAddressSpace(), getObjCGCAttr(), and getObjCLifetime().

◆ removeRestrict()

void clang::Qualifiers::removeRestrict ( )
inline

Definition at line 287 of file Type.h.

Referenced by clang::Sema::BuildQualifiedType().

◆ removeUnaligned()

void clang::Qualifiers::removeUnaligned ( )
inline

Definition at line 316 of file Type.h.

Referenced by clang::QualType::isAtLeastAsQualifiedAs(), and TryReferenceInit().

◆ removeVolatile()

void clang::Qualifiers::removeVolatile ( )
inline

Definition at line 280 of file Type.h.

Referenced by clang::Sema::BuildQualifiedType().

◆ setAddressSpace()

void clang::Qualifiers::setAddressSpace ( LangAS  space)
inline

◆ setConst()

void clang::Qualifiers::setConst ( bool  flag)
inline

Definition at line 270 of file Type.h.

◆ setCVRQualifiers()

void clang::Qualifiers::setCVRQualifiers ( unsigned  mask)
inline

Definition at line 292 of file Type.h.

Referenced by CastsAwayConstness(), and DeduceTemplateArgumentsByTypeMatch().

◆ setFastQualifiers()

void clang::Qualifiers::setFastQualifiers ( unsigned  mask)
inline

Definition at line 402 of file Type.h.

Referenced by getNonFastQualifiers().

◆ setObjCGCAttr()

void clang::Qualifiers::setObjCGCAttr ( GC  type)
inline

Definition at line 321 of file Type.h.

Referenced by removeCommonQualifiers().

◆ setObjCLifetime()

void clang::Qualifiers::setObjCLifetime ( ObjCLifetime  type)
inline

Definition at line 344 of file Type.h.

Referenced by DeduceTemplateArgumentsByTypeMatch(), and removeCommonQualifiers().

◆ setRestrict()

void clang::Qualifiers::setRestrict ( bool  flag)
inline

Definition at line 284 of file Type.h.

◆ setUnaligned()

void clang::Qualifiers::setUnaligned ( bool  flag)
inline

Definition at line 313 of file Type.h.

Referenced by clang::Sema::BuildQualifiedType().

◆ setVolatile()

void clang::Qualifiers::setVolatile ( bool  flag)
inline

◆ withoutObjCGCAttr()

Qualifiers clang::Qualifiers::withoutObjCGCAttr ( ) const
inline

Definition at line 329 of file Type.h.

References removeObjCGCAttr().

Referenced by checkPointerTypesForAssignment().

◆ withoutObjCLifetime()

Qualifiers clang::Qualifiers::withoutObjCLifetime ( ) const
inline

Definition at line 334 of file Type.h.

References removeObjCLifetime().

Referenced by checkPointerTypesForAssignment(), and DeduceTemplateArgumentsByTypeMatch().

Friends And Related Function Documentation

◆ operator+

Qualifiers operator+ ( Qualifiers  L,
Qualifiers  R 
)
friend

Definition at line 547 of file Type.h.

◆ operator-

Qualifiers operator- ( Qualifiers  L,
Qualifiers  R 
)
friend

Compute the difference between two qualifier sets.

Definition at line 558 of file Type.h.


The documentation for this class was generated from the following files: