clang API Documentation

Public Types | Public Member Functions | Static Public Member Functions | Friends
clang::Qualifiers Class Reference

#include <Type.h>

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

List of all members.

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 = 0xffffffu, FastWidth = 3, FastMask = (1 << FastWidth) - 1 }

Public Member Functions

 Qualifiers ()
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)
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.
bool hasStrongOrWeakObjCLifetime () const
 True if the lifetime is either strong or weak.
bool hasAddressSpace () const
unsigned getAddressSpace () const
void setAddressSpace (unsigned space)
void removeAddressSpace ()
void addAddressSpace (unsigned space)
bool hasFastQualifiers () const
unsigned getFastQualifiers () const
void setFastQualifiers (unsigned mask)
void removeFastQualifiers (unsigned mask)
void removeFastQualifiers ()
void addFastQualifiers (unsigned mask)
bool hasNonFastQualifiers () const
Qualifiers getNonFastQualifiers () const
bool hasQualifiers () const
 hasQualifiers - Return true if the set contains any qualifiers.
bool empty () const
void addQualifiers (Qualifiers Q)
 Add the qualifiers from the given set to this set.
void removeQualifiers (Qualifiers Q)
 Remove the qualifiers from the given set from this set.
void addConsistentQualifiers (Qualifiers qs)
 Add the qualifiers from the given set to this set, given that they don't conflict.
bool compatiblyIncludes (Qualifiers other) const
 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.
bool compatiblyIncludesObjCLifetime (Qualifiers other) const
 Determines if these qualifiers compatibly include another set of qualifiers from the narrow perspective of Objective-C ARC lifetime.
bool isStrictSupersetOf (Qualifiers Other) const
 Determine whether this set of qualifiers is a strict superset of another set of qualifiers, not considering qualifier compatibility.
bool operator== (Qualifiers Other) const
bool operator!= (Qualifiers Other) const
LLVM_EXPLICIT 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.
static Qualifiers fromFastMask (unsigned Mask)
static Qualifiers fromCVRMask (unsigned CVR)
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.

Detailed Description

Qualifiers - The collection of all-type qualifiers we support. Clang supports five independent qualifiers: C99: const, volatile, and restrict Embedded C (TR18037): address spaces Objective C: the GC attributes (none, weak, or strong)

Definition at line 112 of file Type.h.


Member Enumeration Documentation

anonymous enum
Enumerator:
MaxAddressSpace 

The maximum supported address space number. 24 bits should be enough for anyone.

FastWidth 

The width of the "fast" qualifier mask.

FastMask 

The fast qualifier mask.

Definition at line 149 of file Type.h.

Enumerator:
GCNone 
Weak 
Strong 

Definition at line 121 of file Type.h.

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 127 of file Type.h.

Enumerator:
Const 
Restrict 
Volatile 
CVRMask 

Definition at line 114 of file Type.h.


Constructor & Destructor Documentation

Definition at line 161 of file Type.h.


Member Function Documentation

void clang::Qualifiers::addAddressSpace ( unsigned  space) [inline]

Definition at line 319 of file Type.h.

References setAddressSpace().

Referenced by addQualifiers(), and clang::ASTContext::getAddrSpaceQualType().

Add the qualifiers from the given set to this set, given that they don't conflict.

Definition at line 393 of file Type.h.

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

Referenced by clang::ASTContext::getBaseElementType(), clang::SplitQualType::getSingleStepDesugaredType(), and clang::ASTContext::getUnqualifiedArrayType().

void clang::Qualifiers::addConst ( ) [inline]

Definition at line 230 of file Type.h.

References Const.

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

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

Definition at line 270 of file Type.h.

References setObjCGCAttr().

Referenced by addQualifiers(), and clang::ASTContext::getObjCGCQualType().

Add the qualifiers from the given set to this set.

Definition at line 358 of file Type.h.

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

Referenced by operator+=().

void clang::Qualifiers::addRestrict ( ) [inline]

Definition at line 244 of file Type.h.

References Restrict.

Referenced by CollectVRQualifiers().

void clang::Qualifiers::addVolatile ( ) [inline]

Definition at line 237 of file Type.h.

References Volatile.

Referenced by CollectVRQualifiers().

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 406 of file Type.h.

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

Referenced by AdoptQualifiers(), CheckOriginalCallArgDeduction(), checkPointerTypesForAssignment(), clang::Sema::CompareReferenceRelationship(), clang::QualType::isMoreQualifiedThan(), clang::Sema::isObjCWritebackConversion(), clang::Sema::IsQualificationConversion(), TryReferenceInit(), and TryStaticCast().

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.

Definition at line 426 of file Type.h.

References getObjCLifetime(), hasConst(), and OCL_Weak.

Referenced by CastsAwayConstness(), checkPointerTypesForAssignment(), clang::Sema::CompareReferenceRelationship(), and clang::Sema::IsQualificationConversion().

bool clang::Qualifiers::empty ( ) const [inline]
static Qualifiers clang::Qualifiers::fromCVRMask ( unsigned  CVR) [inline, static]
static Qualifiers clang::Qualifiers::fromFastMask ( unsigned  Mask) [inline, static]

Definition at line 201 of file Type.h.

References addFastQualifiers().

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

static Qualifiers clang::Qualifiers::fromOpaqueValue ( unsigned  opaque) [inline, static]

Definition at line 214 of file Type.h.

Definition at line 221 of file Type.h.

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

Definition at line 1443 of file TypePrinter.cpp.

Definition at line 347 of file Type.h.

References setFastQualifiers().

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

Definition at line 246 of file Type.h.

References getCVRQualifiers().

Definition at line 326 of file Type.h.

References getFastQualifiers().

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

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

Definition at line 346 of file Type.h.

References FastMask.

Referenced by clang::QualifierCollector::apply(), and clang::ASTContext::getQualifiedType().

True if the lifetime is neither None or ExplicitNone.

Definition at line 300 of file Type.h.

References getObjCLifetime(), and OCL_ExplicitNone.

hasQualifiers - Return true if the set contains any qualifiers.

Definition at line 354 of file Type.h.

Referenced by operator bool().

True if the lifetime is either strong or weak.

Definition at line 306 of file Type.h.

References getObjCLifetime(), OCL_Strong, and OCL_Weak.

Referenced by clang::CodeGen::CodeGenFunction::GenerateDestroyHelperFunction().

Definition at line 1450 of file TypePrinter.cpp.

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

Definition at line 31 of file Type.cpp.

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

Referenced by clang::Sema::CXXCheckConditionalOperands(), and DeduceTemplateArgumentsByTypeMatch().

LLVM_EXPLICIT clang::Qualifiers::operator bool ( ) const [inline]

Definition at line 443 of file Type.h.

References hasQualifiers().

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

Definition at line 441 of file Type.h.

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

Definition at line 445 of file Type.h.

References addQualifiers().

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

Definition at line 457 of file Type.h.

References removeQualifiers().

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

Definition at line 440 of file Type.h.

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

Definition at line 1470 of file TypePrinter.cpp.

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

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

Definition at line 475 of file Type.h.

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

static Qualifiers clang::Qualifiers::removeCommonQualifiers ( Qualifiers L,
Qualifiers R 
) [inline, static]
void clang::Qualifiers::removeConst ( ) [inline]

Definition at line 229 of file Type.h.

References Const.

Referenced by BuildFieldReferenceExpr(), clang::Sema::CheckMain(), and TypeInfoIsInStandardLibrary().

Definition at line 256 of file Type.h.

References CVRMask.

Definition at line 332 of file Type.h.

References FastMask.

Definition at line 336 of file Type.h.

References FastMask.

Remove the qualifiers from the given set from this set.

Definition at line 375 of file Type.h.

References CVRMask, getAddressSpace(), getObjCGCAttr(), getObjCLifetime(), removeAddressSpace(), removeObjCGCAttr(), and removeObjCLifetime().

Referenced by operator-=().

Definition at line 243 of file Type.h.

References Restrict.

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

Definition at line 236 of file Type.h.

References Volatile.

void clang::Qualifiers::setAddressSpace ( unsigned  space) [inline]

Definition at line 313 of file Type.h.

References MaxAddressSpace.

Referenced by addAddressSpace(), removeAddressSpace(), and removeCommonQualifiers().

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

Definition at line 226 of file Type.h.

References Const.

Definition at line 248 of file Type.h.

References CVRMask.

Referenced by CastsAwayConstness(), and DeduceTemplateArgumentsByTypeMatch().

Definition at line 328 of file Type.h.

References FastMask.

Referenced by getNonFastQualifiers().

void clang::Qualifiers::setObjCGCAttr ( GC  type) [inline]
void clang::Qualifiers::setRestrict ( bool  flag) [inline]

Definition at line 240 of file Type.h.

References Restrict.

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

Definition at line 233 of file Type.h.

References Volatile.

Referenced by clang::CodeGen::AggValueSlot::setVolatile().

Definition at line 274 of file Type.h.

References removeObjCGCAttr().

Referenced by checkPointerTypesForAssignment().


Friends And Related Function Documentation

Qualifiers operator+ ( Qualifiers  L,
Qualifiers  R 
) [friend]

Definition at line 452 of file Type.h.

Qualifiers operator- ( Qualifiers  L,
Qualifiers  R 
) [friend]

Compute the difference between two qualifier sets.

Definition at line 463 of file Type.h.


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