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

StringLiteral - This represents a string literal expression, e.g. More...

#include "clang/AST/Expr.h"

Inheritance diagram for clang::StringLiteral:
Inheritance graph
[legend]
Collaboration diagram for clang::StringLiteral:
Collaboration graph
[legend]

Public Types

enum  StringKind {
  Ascii, Wide, UTF8, UTF16,
  UTF32
}
 
typedef const SourceLocationtokloc_iterator
 
- Public Types inherited from clang::Expr
enum  LValueClassification {
  LV_Valid, LV_NotObjectType, LV_IncompleteVoidType, LV_DuplicateVectorComponents,
  LV_InvalidExpression, LV_InvalidMessageExpression, LV_MemberFunction, LV_SubObjCPropertySetting,
  LV_ClassTemporary, LV_ArrayTemporary
}
 
enum  isModifiableLvalueResult {
  MLV_Valid, MLV_NotObjectType, MLV_IncompleteVoidType, MLV_DuplicateVectorComponents,
  MLV_InvalidExpression, MLV_LValueCast, MLV_IncompleteType, MLV_ConstQualified,
  MLV_ConstAddrSpace, MLV_ArrayType, MLV_NoSetterProperty, MLV_MemberFunction,
  MLV_SubObjCPropertySetting, MLV_InvalidMessageExpression, MLV_ClassTemporary, MLV_ArrayTemporary
}
 
enum  SideEffectsKind { SE_NoSideEffects, SE_AllowUndefinedBehavior, SE_AllowSideEffects }
 
enum  NullPointerConstantKind {
  NPCK_NotNull = 0, NPCK_ZeroExpression, NPCK_ZeroLiteral, NPCK_CXX11_nullptr,
  NPCK_GNUNull
}
 Enumeration used to describe the kind of Null pointer constant returned from isNullPointerConstant(). More...
 
enum  NullPointerConstantValueDependence { NPC_NeverValueDependent = 0, NPC_ValueDependentIsNull, NPC_ValueDependentIsNotNull }
 Enumeration used to describe how isNullPointerConstant() should cope with value-dependent expressions. More...
 
- Public Types inherited from clang::Stmt
enum  StmtClass { NoStmtClass = 0 }
 
typedef StmtIterator child_iterator
 Child Iterators: All subclasses must implement 'children' to permit easy iteration over the substatements/subexpessions of an AST node. More...
 
typedef ConstStmtIterator const_child_iterator
 
typedef llvm::iterator_range< child_iteratorchild_range
 
typedef llvm::iterator_range< const_child_iteratorconst_child_range
 

Public Member Functions

StringRef getString () const
 
StringRef getBytes () const
 Allow access to clients that need the byte representation, such as ASTWriterStmt::VisitStringLiteral(). More...
 
void outputString (raw_ostream &OS) const
 
uint32_t getCodeUnit (size_t i) const
 
unsigned getByteLength () const
 
unsigned getLength () const
 
unsigned getCharByteWidth () const
 
void setString (const ASTContext &C, StringRef Str, StringKind Kind, bool IsPascal)
 Sets the string data to the given string data. More...
 
StringKind getKind () const
 
bool isAscii () const
 
bool isWide () const
 
bool isUTF8 () const
 
bool isUTF16 () const
 
bool isUTF32 () const
 
bool isPascal () const
 
bool containsNonAsciiOrNull () const
 
unsigned getNumConcatenated () const
 getNumConcatenated - Get the number of string literal tokens that were concatenated in translation phase #6 to form this string literal. More...
 
SourceLocation getStrTokenLoc (unsigned TokNum) const
 
void setStrTokenLoc (unsigned TokNum, SourceLocation L)
 
SourceLocation getLocationOfByte (unsigned ByteNo, const SourceManager &SM, const LangOptions &Features, const TargetInfo &Target, unsigned *StartToken=nullptr, unsigned *StartTokenByteOffset=nullptr) const
 getLocationOfByte - Return a source location that points to the specified byte of this string literal. More...
 
tokloc_iterator tokloc_begin () const
 
tokloc_iterator tokloc_end () const
 
SourceLocation getLocStart () const LLVM_READONLY
 
SourceLocation getLocEnd () const LLVM_READONLY
 
child_range children ()
 
const_child_range children () const
 
- Public Member Functions inherited from clang::Expr
QualType getType () const
 
void setType (QualType t)
 
bool isValueDependent () const
 isValueDependent - Determines whether this expression is value-dependent (C++ [temp.dep.constexpr]). More...
 
void setValueDependent (bool VD)
 Set whether this expression is value-dependent or not. More...
 
bool isTypeDependent () const
 isTypeDependent - Determines whether this expression is type-dependent (C++ [temp.dep.expr]), which means that its type could change from one template instantiation to the next. More...
 
void setTypeDependent (bool TD)
 Set whether this expression is type-dependent or not. More...
 
bool isInstantiationDependent () const
 Whether this expression is instantiation-dependent, meaning that it depends in some way on a template parameter, even if neither its type nor (constant) value can change due to the template instantiation. More...
 
void setInstantiationDependent (bool ID)
 Set whether this expression is instantiation-dependent or not. More...
 
bool containsUnexpandedParameterPack () const
 Whether this expression contains an unexpanded parameter pack (for C++11 variadic templates). More...
 
void setContainsUnexpandedParameterPack (bool PP=true)
 Set the bit that describes whether this expression contains an unexpanded parameter pack. More...
 
SourceLocation getExprLoc () const LLVM_READONLY
 getExprLoc - Return the preferred location for the arrow when diagnosing a problem with a generic expression. More...
 
bool isUnusedResultAWarning (const Expr *&WarnExpr, SourceLocation &Loc, SourceRange &R1, SourceRange &R2, ASTContext &Ctx) const
 isUnusedResultAWarning - Return true if this immediate expression should be warned about if the result is unused. More...
 
bool isLValue () const
 isLValue - True if this expression is an "l-value" according to the rules of the current language. More...
 
bool isRValue () const
 
bool isXValue () const
 
bool isGLValue () const
 
LValueClassification ClassifyLValue (ASTContext &Ctx) const
 Reasons why an expression might not be an l-value. More...
 
isModifiableLvalueResult isModifiableLvalue (ASTContext &Ctx, SourceLocation *Loc=nullptr) const
 isModifiableLvalue - C99 6.3.2.1: an lvalue that does not have array type, does not have an incomplete type, does not have a const-qualified type, and if it is a structure or union, does not have any member (including, recursively, any member or element of all contained aggregates or unions) with a const-qualified type. More...
 
Classification Classify (ASTContext &Ctx) const
 Classify - Classify this expression according to the C++11 expression taxonomy. More...
 
Classification ClassifyModifiable (ASTContext &Ctx, SourceLocation &Loc) const
 ClassifyModifiable - Classify this expression according to the C++11 expression taxonomy, and see if it is valid on the left side of an assignment. More...
 
ExprValueKind getValueKind () const
 getValueKind - The value kind that this expression produces. More...
 
ExprObjectKind getObjectKind () const
 getObjectKind - The object kind that this expression produces. More...
 
bool isOrdinaryOrBitFieldObject () const
 
void setValueKind (ExprValueKind Cat)
 setValueKind - Set the value kind produced by this expression. More...
 
void setObjectKind (ExprObjectKind Cat)
 setObjectKind - Set the object kind produced by this expression. More...
 
bool refersToBitField () const
 Returns true if this expression is a gl-value that potentially refers to a bit-field. More...
 
FieldDeclgetSourceBitField ()
 If this expression refers to a bit-field, retrieve the declaration of that bit-field. More...
 
const FieldDeclgetSourceBitField () const
 
DeclgetReferencedDeclOfCallee ()
 
const DeclgetReferencedDeclOfCallee () const
 
const ObjCPropertyRefExprgetObjCProperty () const
 If this expression is an l-value for an Objective C property, find the underlying property reference expression. More...
 
bool isObjCSelfExpr () const
 Check if this expression is the ObjC 'self' implicit parameter. More...
 
bool refersToVectorElement () const
 Returns whether this expression refers to a vector element. More...
 
bool refersToGlobalRegisterVar () const
 Returns whether this expression refers to a global register variable. More...
 
bool hasPlaceholderType () const
 Returns whether this expression has a placeholder type. More...
 
bool hasPlaceholderType (BuiltinType::Kind K) const
 Returns whether this expression has a specific placeholder type. More...
 
bool isKnownToHaveBooleanValue () const
 isKnownToHaveBooleanValue - Return true if this is an integer expression that is known to return 0 or 1. More...
 
bool isIntegerConstantExpr (llvm::APSInt &Result, const ASTContext &Ctx, SourceLocation *Loc=nullptr, bool isEvaluated=true) const
 isIntegerConstantExpr - Return true if this expression is a valid integer constant expression, and, if so, return its value in Result. More...
 
bool isIntegerConstantExpr (const ASTContext &Ctx, SourceLocation *Loc=nullptr) const
 
bool isCXX98IntegralConstantExpr (const ASTContext &Ctx) const
 isCXX98IntegralConstantExpr - Return true if this expression is an integral constant expression in C++98. More...
 
bool isCXX11ConstantExpr (const ASTContext &Ctx, APValue *Result=nullptr, SourceLocation *Loc=nullptr) const
 isCXX11ConstantExpr - Return true if this expression is a constant expression in C++11. More...
 
bool isConstantInitializer (ASTContext &Ctx, bool ForRef, const Expr **Culprit=nullptr) const
 isConstantInitializer - Returns true if this expression can be emitted to IR as a constant, and thus can be used as a constant initializer in C. More...
 
bool EvaluateAsRValue (EvalResult &Result, const ASTContext &Ctx) const
 EvaluateAsRValue - Return true if this is a constant which we can fold to an rvalue using any crazy technique (that has nothing to do with language standards) that we want to, even if the expression has side-effects. More...
 
bool EvaluateAsBooleanCondition (bool &Result, const ASTContext &Ctx) const
 EvaluateAsBooleanCondition - Return true if this is a constant which we we can fold and convert to a boolean condition using any crazy technique that we want to, even if the expression has side-effects. More...
 
bool EvaluateAsInt (llvm::APSInt &Result, const ASTContext &Ctx, SideEffectsKind AllowSideEffects=SE_NoSideEffects) const
 EvaluateAsInt - Return true if this is a constant which we can fold and convert to an integer, using any crazy technique that we want to. More...
 
bool EvaluateAsFloat (llvm::APFloat &Result, const ASTContext &Ctx, SideEffectsKind AllowSideEffects=SE_NoSideEffects) const
 EvaluateAsFloat - Return true if this is a constant which we can fold and convert to a floating point value, using any crazy technique that we want to. More...
 
bool isEvaluatable (const ASTContext &Ctx, SideEffectsKind AllowSideEffects=SE_NoSideEffects) const
 isEvaluatable - Call EvaluateAsRValue to see if this expression can be constant folded without side-effects, but discard the result. More...
 
bool HasSideEffects (const ASTContext &Ctx, bool IncludePossibleEffects=true) const
 HasSideEffects - This routine returns true for all those expressions which have any effect other than producing a value. More...
 
bool hasNonTrivialCall (const ASTContext &Ctx) const
 Determine whether this expression involves a call to any function that is not trivial. More...
 
llvm::APSInt EvaluateKnownConstInt (const ASTContext &Ctx, SmallVectorImpl< PartialDiagnosticAt > *Diag=nullptr) const
 EvaluateKnownConstInt - Call EvaluateAsRValue and return the folded integer. More...
 
void EvaluateForOverflow (const ASTContext &Ctx) const
 
bool EvaluateAsLValue (EvalResult &Result, const ASTContext &Ctx) const
 EvaluateAsLValue - Evaluate an expression to see if we can fold it to an lvalue with link time known address, with no side-effects. More...
 
bool EvaluateAsInitializer (APValue &Result, const ASTContext &Ctx, const VarDecl *VD, SmallVectorImpl< PartialDiagnosticAt > &Notes) const
 EvaluateAsInitializer - Evaluate an expression as if it were the initializer of the given declaration. More...
 
bool EvaluateWithSubstitution (APValue &Value, ASTContext &Ctx, const FunctionDecl *Callee, ArrayRef< const Expr *> Args, const Expr *This=nullptr) const
 EvaluateWithSubstitution - Evaluate an expression as if from the context of a call to the given function with the given arguments, inside an unevaluated context. More...
 
bool tryEvaluateObjectSize (uint64_t &Result, ASTContext &Ctx, unsigned Type) const
 If the current Expr is a pointer, this will try to statically determine the number of bytes available where the pointer is pointing. More...
 
NullPointerConstantKind isNullPointerConstant (ASTContext &Ctx, NullPointerConstantValueDependence NPC) const
 isNullPointerConstant - C99 6.3.2.3p3 - Test if this reduces down to a Null pointer constant. More...
 
bool isOBJCGCCandidate (ASTContext &Ctx) const
 isOBJCGCCandidate - Return true if this expression may be used in a read/ write barrier. More...
 
bool isBoundMemberFunction (ASTContext &Ctx) const
 Returns true if this expression is a bound member function. More...
 
ExprIgnoreImpCasts () LLVM_READONLY
 IgnoreImpCasts - Skip past any implicit casts which might surround this expression. More...
 
ExprIgnoreImplicit () LLVM_READONLY
 IgnoreImplicit - Skip past any implicit AST nodes which might surround this expression. More...
 
const ExprIgnoreImplicit () const LLVM_READONLY
 
ExprIgnoreParens () LLVM_READONLY
 IgnoreParens - Ignore parentheses. More...
 
ExprIgnoreParenCasts () LLVM_READONLY
 IgnoreParenCasts - Ignore parentheses and casts. More...
 
ExprIgnoreCasts () LLVM_READONLY
 Ignore casts. Strip off any CastExprs, returning their operand. More...
 
ExprIgnoreParenImpCasts () LLVM_READONLY
 IgnoreParenImpCasts - Ignore parentheses and implicit casts. More...
 
ExprIgnoreConversionOperator () LLVM_READONLY
 IgnoreConversionOperator - Ignore conversion operator. More...
 
const ExprIgnoreConversionOperator () const LLVM_READONLY
 
const ExprIgnoreParenImpCasts () const LLVM_READONLY
 
ExprIgnoreParenLValueCasts () LLVM_READONLY
 Ignore parentheses and lvalue casts. More...
 
const ExprIgnoreParenLValueCasts () const LLVM_READONLY
 
ExprIgnoreParenNoopCasts (ASTContext &Ctx) LLVM_READONLY
 IgnoreParenNoopCasts - Ignore parentheses and casts that do not change the value (including ptr->int casts of the same size). More...
 
ExprignoreParenBaseCasts () LLVM_READONLY
 Ignore parentheses and derived-to-base casts. More...
 
const ExprignoreParenBaseCasts () const LLVM_READONLY
 
bool isDefaultArgument () const
 Determine whether this expression is a default function argument. More...
 
bool isTemporaryObject (ASTContext &Ctx, const CXXRecordDecl *TempTy) const
 Determine whether the result of this expression is a temporary object of the given class type. More...
 
bool isImplicitCXXThis () const
 Whether this expression is an implicit reference to 'this' in C++. More...
 
const ExprIgnoreImpCasts () const LLVM_READONLY
 
const ExprIgnoreParens () const LLVM_READONLY
 
const ExprIgnoreParenCasts () const LLVM_READONLY
 
const ExprIgnoreCasts () const LLVM_READONLY
 Strip off casts, but keep parentheses. More...
 
const ExprIgnoreParenNoopCasts (ASTContext &Ctx) const LLVM_READONLY
 
const CXXRecordDeclgetBestDynamicClassType () const
 For an expression of class type or pointer to class type, return the most derived class decl the expression is known to refer to. More...
 
const ExprgetBestDynamicClassTypeExpr () const
 Get the inner expression that determines the best dynamic class. More...
 
const ExprskipRValueSubobjectAdjustments (SmallVectorImpl< const Expr *> &CommaLHS, SmallVectorImpl< SubobjectAdjustment > &Adjustments) const
 Walk outwards from an expression we want to bind a reference to and find the expression whose lifetime needs to be extended. More...
 
const ExprskipRValueSubobjectAdjustments () const
 
- Public Member Functions inherited from clang::Stmt
void * operator new (size_t bytes, const ASTContext &C, unsigned alignment=8)
 
void * operator new (size_t bytes, const ASTContext *C, unsigned alignment=8)
 
void * operator new (size_t bytes, void *mem) noexcept
 
void operator delete (void *, const ASTContext &, unsigned) noexcept
 
void operator delete (void *, const ASTContext *, unsigned) noexcept
 
void operator delete (void *, size_t) noexcept
 
void operator delete (void *, void *) noexcept
 
 Stmt (StmtClass SC)
 
StmtClass getStmtClass () const
 
const char * getStmtClassName () const
 
SourceRange getSourceRange () const LLVM_READONLY
 SourceLocation tokens are not useful in isolation - they are low level value objects created/interpreted by SourceManager. More...
 
SourceLocation getLocStart () const LLVM_READONLY
 
SourceLocation getLocEnd () const LLVM_READONLY
 
void dump () const
 Dumps the specified AST fragment and all subtrees to llvm::errs(). More...
 
void dump (SourceManager &SM) const
 
void dump (raw_ostream &OS, SourceManager &SM) const
 
void dump (raw_ostream &OS) const
 
void dumpColor () const
 dumpColor - same as dump(), but forces color highlighting. More...
 
void dumpPretty (const ASTContext &Context) const
 dumpPretty/printPretty - These two methods do a "pretty print" of the AST back to its original source language syntax. More...
 
void printPretty (raw_ostream &OS, PrinterHelper *Helper, const PrintingPolicy &Policy, unsigned Indentation=0, const ASTContext *Context=nullptr) const
 
void viewAST () const
 viewAST - Visualize an AST rooted at this Stmt* using GraphViz. More...
 
StmtIgnoreImplicit ()
 Skip past any implicit AST nodes which might surround this statement, such as ExprWithCleanups or ImplicitCastExpr nodes. More...
 
const StmtIgnoreImplicit () const
 
StmtIgnoreContainers (bool IgnoreCaptured=false)
 Skip no-op (attributed, compound) container stmts and skip captured stmt at the top, if IgnoreCaptured is true. More...
 
const StmtstripLabelLikeStatements () const
 Strip off all label-like statements. More...
 
StmtstripLabelLikeStatements ()
 
child_range children ()
 
const_child_range children () const
 
child_iterator child_begin ()
 
child_iterator child_end ()
 
const_child_iterator child_begin () const
 
const_child_iterator child_end () const
 
void Profile (llvm::FoldingSetNodeID &ID, const ASTContext &Context, bool Canonical) const
 Produce a unique representation of the given statement. More...
 
void ProcessODRHash (llvm::FoldingSetNodeID &ID, ODRHash &Hash) const
 Calculate a unique representation for a statement that is stable across compiler invocations. More...
 

Static Public Member Functions

static StringLiteralCreate (const ASTContext &C, StringRef Str, StringKind Kind, bool Pascal, QualType Ty, const SourceLocation *Loc, unsigned NumStrs)
 This is the "fully general" constructor that allows representation of strings formed from multiple concatenated tokens. More...
 
static StringLiteralCreate (const ASTContext &C, StringRef Str, StringKind Kind, bool Pascal, QualType Ty, SourceLocation Loc)
 Simple constructor for string literals made from one token. More...
 
static StringLiteralCreateEmpty (const ASTContext &C, unsigned NumStrs)
 Construct an empty string literal. More...
 
static bool classof (const Stmt *T)
 
- Static Public Member Functions inherited from clang::Expr
static ExprValueKind getValueKindForType (QualType T)
 getValueKindForType - Given a formal return or parameter type, give its value kind. More...
 
static bool isPotentialConstantExpr (const FunctionDecl *FD, SmallVectorImpl< PartialDiagnosticAt > &Diags)
 isPotentialConstantExpr - Return true if this function's definition might be usable in a constant expression in C++11, if it were marked constexpr. More...
 
static bool isPotentialConstantExprUnevaluated (Expr *E, const FunctionDecl *FD, SmallVectorImpl< PartialDiagnosticAt > &Diags)
 isPotentialConstantExprUnevaluted - Return true if this expression might be usable in a constant expression in C++11 in an unevaluated context, if it were in function FD marked constexpr. More...
 
static QualType findBoundMemberType (const Expr *expr)
 Given an expression of bound-member type, find the type of the member. More...
 
static bool hasAnyTypeDependentArguments (ArrayRef< Expr *> Exprs)
 hasAnyTypeDependentArguments - Determines if any of the expressions in Exprs is type-dependent. More...
 
static bool classof (const Stmt *T)
 
- Static Public Member Functions inherited from clang::Stmt
static void addStmtClass (const StmtClass s)
 
static void EnableStatistics ()
 
static void PrintStats ()
 

Friends

class ASTStmtReader
 

Additional Inherited Members

- Protected Types inherited from clang::Stmt
enum  { NumStmtBits = 8 }
 
enum  { NumExprBits = 17 }
 
enum  APFloatSemantics {
  IEEEhalf, IEEEsingle, IEEEdouble, x87DoubleExtended,
  IEEEquad, PPCDoubleDouble
}
 
- Protected Member Functions inherited from clang::Expr
 Expr (StmtClass SC, QualType T, ExprValueKind VK, ExprObjectKind OK, bool TD, bool VD, bool ID, bool ContainsUnexpandedParameterPack)
 
 Expr (StmtClass SC, EmptyShell)
 Construct an empty expression. More...
 
- Protected Member Functions inherited from clang::Stmt
void * operator new (size_t bytes) noexcept
 
void operator delete (void *data) noexcept
 
 Stmt (StmtClass SC, EmptyShell)
 Construct an empty statement. More...
 
- Protected Attributes inherited from clang::Stmt
union {
   StmtBitfields   StmtBits
 
   CompoundStmtBitfields   CompoundStmtBits
 
   IfStmtBitfields   IfStmtBits
 
   ExprBitfields   ExprBits
 
   CharacterLiteralBitfields   CharacterLiteralBits
 
   FloatingLiteralBitfields   FloatingLiteralBits
 
   UnaryExprOrTypeTraitExprBitfields   UnaryExprOrTypeTraitExprBits
 
   DeclRefExprBitfields   DeclRefExprBits
 
   CastExprBitfields   CastExprBits
 
   CallExprBitfields   CallExprBits
 
   ExprWithCleanupsBitfields   ExprWithCleanupsBits
 
   PseudoObjectExprBitfields   PseudoObjectExprBits
 
   ObjCIndirectCopyRestoreExprBitfields   ObjCIndirectCopyRestoreExprBits
 
   InitListExprBitfields   InitListExprBits
 
   TypeTraitExprBitfields   TypeTraitExprBits
 
   CoawaitExprBitfields   CoawaitBits
 
}; 
 

Detailed Description

StringLiteral - This represents a string literal expression, e.g.

"foo" or L"bar" (wide strings). The actual string is returned by getBytes() is NOT null-terminated, and the length of the string is determined by calling getByteLength(). The C type for a string is always a ConstantArrayType. In C++, the char type is const qualified, in C it is not.

Note that strings in C can be formed by concatenation of multiple string literal pptokens in translation phase #6. This keeps track of the locations of each of these pieces.

Strings in C can also be truncated and extended by assigning into arrays, e.g. with constructs like: char X[2] = "foobar"; In this case, getByteLength() will return 6, but the string literal will have type "char[2]".

Definition at line 1507 of file Expr.h.

Member Typedef Documentation

◆ tokloc_iterator

Definition at line 1639 of file Expr.h.

Member Enumeration Documentation

◆ StringKind

Enumerator
Ascii 
Wide 
UTF8 
UTF16 
UTF32 

Definition at line 1509 of file Expr.h.

Member Function Documentation

◆ children() [1/2]

child_range clang::StringLiteral::children ( )
inline

Definition at line 1653 of file Expr.h.

◆ children() [2/2]

const_child_range clang::StringLiteral::children ( ) const
inline

Definition at line 1656 of file Expr.h.

◆ classof()

static bool clang::StringLiteral::classof ( const Stmt T)
inlinestatic

Definition at line 1648 of file Expr.h.

References clang::Stmt::getStmtClass().

◆ containsNonAsciiOrNull()

bool clang::StringLiteral::containsNonAsciiOrNull ( ) const
inline

Definition at line 1605 of file Expr.h.

References clang::isASCII().

Referenced by GetConstantCFStringEntry().

◆ Create() [1/2]

StringLiteral * StringLiteral::Create ( const ASTContext C,
StringRef  Str,
StringKind  Kind,
bool  Pascal,
QualType  Ty,
const SourceLocation Loc,
unsigned  NumStrs 
)
static

This is the "fully general" constructor that allows representation of strings formed from multiple concatenated tokens.

Definition at line 854 of file Expr.cpp.

References clang::ASTContext::Allocate(), clang::ASTContext::getAsConstantArrayType(), and setString().

◆ Create() [2/2]

static StringLiteral* clang::StringLiteral::Create ( const ASTContext C,
StringRef  Str,
StringKind  Kind,
bool  Pascal,
QualType  Ty,
SourceLocation  Loc 
)
inlinestatic

Simple constructor for string literals made from one token.

Definition at line 1546 of file Expr.h.

References clang::Create(), and clang::CreateEmpty().

◆ CreateEmpty()

StringLiteral * StringLiteral::CreateEmpty ( const ASTContext C,
unsigned  NumStrs 
)
static

Construct an empty string literal.

Definition at line 879 of file Expr.cpp.

References clang::ASTContext::Allocate().

◆ getByteLength()

unsigned clang::StringLiteral::getByteLength ( ) const
inline

Definition at line 1587 of file Expr.h.

Referenced by mangleThunkThisAdjustment(), and sumOffsets().

◆ getBytes()

StringRef clang::StringLiteral::getBytes ( ) const
inline

Allow access to clients that need the byte representation, such as ASTWriterStmt::VisitStringLiteral().

Definition at line 1563 of file Expr.h.

Referenced by isIdenticalStmt().

◆ getCharByteWidth()

unsigned clang::StringLiteral::getCharByteWidth ( ) const
inline

Definition at line 1589 of file Expr.h.

Referenced by mangleThunkThisAdjustment(), and sumOffsets().

◆ getCodeUnit()

uint32_t clang::StringLiteral::getCodeUnit ( size_t  i) const
inline

Definition at line 1577 of file Expr.h.

Referenced by getExistingLazyBinding(), and mangleThunkThisAdjustment().

◆ getKind()

StringKind clang::StringLiteral::getKind ( ) const
inline

Definition at line 1595 of file Expr.h.

References clang::SubobjectAdjustment::Kind.

Referenced by sumOffsets().

◆ getLength()

unsigned clang::StringLiteral::getLength ( ) const
inline

Definition at line 1588 of file Expr.h.

Referenced by diagnoseStringPlusInt(), getExistingLazyBinding(), and sumOffsets().

◆ getLocationOfByte()

SourceLocation StringLiteral::getLocationOfByte ( unsigned  ByteNo,
const SourceManager SM,
const LangOptions Features,
const TargetInfo Target,
unsigned *  StartToken = nullptr,
unsigned *  StartTokenByteOffset = nullptr 
) const

getLocationOfByte - Return a source location that points to the specified byte of this string literal.

Strings are amazingly complex. They can be formed from multiple tokens and can have escape sequences in them in addition to the usual trigraph and escaped newline business. This routine handles this complexity.

Strings are amazingly complex. They can be formed from multiple tokens and can have escape sequences in them in addition to the usual trigraph and escaped newline business. This routine handles this complexity.

The *StartToken sets the first token to be searched in this function and the *StartTokenByteOffset is the byte offset of the first token. Before returning, it updates the *StartToken to the TokNo of the token being found and sets *StartTokenByteOffset to the byte offset of the token in the string. Using these two parameters can reduce the time complexity from O(n^2) to O(n) if one wants to get the location of byte for all the tokens in a string.

Definition at line 1040 of file Expr.cpp.

References Ascii, clang::SourceManager::getDecomposedLoc(), clang::SourceManager::getSpellingLoc(), and UTF8.

Referenced by getAsmSrcLocInfo(), clang::Sema::getLocationOfStringLiteralByte(), and sumOffsets().

◆ getLocEnd()

SourceLocation clang::StringLiteral::getLocEnd ( ) const
inline

Definition at line 1644 of file Expr.h.

Referenced by sumOffsets().

◆ getLocStart()

SourceLocation clang::StringLiteral::getLocStart ( ) const
inline

◆ getNumConcatenated()

unsigned clang::StringLiteral::getNumConcatenated ( ) const
inline

getNumConcatenated - Get the number of string literal tokens that were concatenated in translation phase #6 to form this string literal.

Definition at line 1615 of file Expr.h.

◆ getString()

StringRef clang::StringLiteral::getString ( ) const
inline

◆ getStrTokenLoc()

SourceLocation clang::StringLiteral::getStrTokenLoc ( unsigned  TokNum) const
inline

Definition at line 1617 of file Expr.h.

◆ isAscii()

bool clang::StringLiteral::isAscii ( ) const
inline

◆ isPascal()

bool clang::StringLiteral::isPascal ( ) const
inline

Definition at line 1603 of file Expr.h.

Referenced by sumOffsets().

◆ isUTF16()

bool clang::StringLiteral::isUTF16 ( ) const
inline

Definition at line 1601 of file Expr.h.

Referenced by sumOffsets().

◆ isUTF32()

bool clang::StringLiteral::isUTF32 ( ) const
inline

Definition at line 1602 of file Expr.h.

Referenced by sumOffsets().

◆ isUTF8()

bool clang::StringLiteral::isUTF8 ( ) const
inline

Definition at line 1600 of file Expr.h.

Referenced by sumOffsets().

◆ isWide()

bool clang::StringLiteral::isWide ( ) const
inline

Definition at line 1599 of file Expr.h.

Referenced by mangleThunkThisAdjustment(), and sumOffsets().

◆ outputString()

void StringLiteral::outputString ( raw_ostream &  OS) const

Definition at line 891 of file Expr.cpp.

References getKind().

Referenced by PrintFloatingLiteral().

◆ setString()

void StringLiteral::setString ( const ASTContext C,
StringRef  Str,
StringKind  Kind,
bool  IsPascal 
)

Sets the string data to the given string data.

Definition at line 987 of file Expr.cpp.

References clang::ASTContext::getTargetInfo().

Referenced by Create().

◆ setStrTokenLoc()

void clang::StringLiteral::setStrTokenLoc ( unsigned  TokNum,
SourceLocation  L 
)
inline

Definition at line 1621 of file Expr.h.

References SM.

◆ tokloc_begin()

tokloc_iterator clang::StringLiteral::tokloc_begin ( ) const
inline

Definition at line 1640 of file Expr.h.

◆ tokloc_end()

tokloc_iterator clang::StringLiteral::tokloc_end ( ) const
inline

Definition at line 1641 of file Expr.h.

Friends And Related Function Documentation

◆ ASTStmtReader

friend class ASTStmtReader
friend

Definition at line 1518 of file Expr.h.

Member Data Documentation

◆ asChar

const char* clang::StringLiteral::asChar

Definition at line 1521 of file Expr.h.

◆ asUInt16

const uint16_t* clang::StringLiteral::asUInt16

Definition at line 1522 of file Expr.h.

◆ asUInt32

const uint32_t* clang::StringLiteral::asUInt32

Definition at line 1523 of file Expr.h.


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