clang 20.0.0git
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
clang::StringLiteral Class Referencefinal

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

#include "clang/AST/Expr.h"

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

Public Types

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_ConstQualifiedField , 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 class  ConstantExprKind { Normal , NonClassTemplateArgument , ClassTemplateArgument , ImmediateInvocation }
 
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 }
 
enum  Likelihood { LH_Unlikely = -1 , LH_None , LH_Likely }
 The likelihood of a branch being taken. More...
 
using child_iterator = StmtIterator
 Child Iterators: All subclasses must implement 'children' to permit easy iteration over the substatements/subexpressions of an AST node.
 
using const_child_iterator = ConstStmtIterator
 
using child_range = llvm::iterator_range< child_iterator >
 
using const_child_range = llvm::iterator_range< const_child_iterator >
 

Public Member Functions

StringRef getString () const
 
StringRef getBytes () const
 Allow access to clients that need the byte representation, such as ASTWriterStmt::VisitStringLiteral().
 
void outputString (raw_ostream &OS) const
 
uint32_t getCodeUnit (size_t i) const
 
int64_t getCodeUnitS (size_t I, uint64_t BitWidth) const
 
unsigned getByteLength () const
 
unsigned getLength () const
 
unsigned getCharByteWidth () const
 
StringLiteralKind getKind () const
 
bool isOrdinary () const
 
bool isWide () const
 
bool isUTF8 () const
 
bool isUTF16 () const
 
bool isUTF32 () const
 
bool isUnevaluated () const
 
bool isPascal () const
 
bool containsNonAscii () 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.
 
SourceLocation getStrTokenLoc (unsigned TokNum) const
 Get one of the string literal token.
 
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.
 
tokloc_iterator tokloc_begin () const
 
tokloc_iterator tokloc_end () const
 
SourceLocation getBeginLoc () const LLVM_READONLY
 
SourceLocation getEndLoc () const LLVM_READONLY
 
child_range children ()
 
const_child_range children () const
 
- Public Member Functions inherited from clang::Expr
 Expr ()=delete
 
 Expr (const Expr &)=delete
 
 Expr (Expr &&)=delete
 
Exproperator= (const Expr &)=delete
 
Exproperator= (Expr &&)=delete
 
QualType getType () const
 
void setType (QualType t)
 
QualType getEnumCoercedType (const ASTContext &Ctx) const
 If this expression is an enumeration constant, return the enumeration type under which said constant was declared.
 
ExprDependence getDependence () const
 
bool isValueDependent () const
 Determines whether the value of this expression depends on.
 
bool isTypeDependent () const
 Determines whether the type of this expression depends on.
 
bool isInstantiationDependent () const
 Whether this expression is instantiation-dependent, meaning that it depends in some way on.
 
bool containsUnexpandedParameterPack () const
 Whether this expression contains an unexpanded parameter pack (for C++11 variadic templates).
 
bool containsErrors () const
 Whether this expression contains subexpressions which had errors, e.g.
 
SourceLocation getExprLoc () const LLVM_READONLY
 getExprLoc - Return the preferred location for the arrow when diagnosing a problem with a generic expression.
 
bool isReadIfDiscardedInCPlusPlus11 () const
 Determine whether an lvalue-to-rvalue conversion should implicitly be applied to this expression if it appears as a discarded-value expression in C++11 onwards.
 
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.
 
bool isLValue () const
 isLValue - True if this expression is an "l-value" according to the rules of the current language.
 
bool isPRValue () const
 
bool isXValue () const
 
bool isGLValue () const
 
LValueClassification ClassifyLValue (ASTContext &Ctx) const
 Reasons why an expression might not be an l-value.
 
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.
 
Classification Classify (ASTContext &Ctx) const
 Classify - Classify this expression according to the C++11 expression taxonomy.
 
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.
 
FPOptions getFPFeaturesInEffect (const LangOptions &LO) const
 Returns the set of floating point options that apply to this expression.
 
ExprValueKind getValueKind () const
 getValueKind - The value kind that this expression produces.
 
ExprObjectKind getObjectKind () const
 getObjectKind - The object kind that this expression produces.
 
bool isOrdinaryOrBitFieldObject () const
 
void setValueKind (ExprValueKind Cat)
 setValueKind - Set the value kind produced by this expression.
 
void setObjectKind (ExprObjectKind Cat)
 setObjectKind - Set the object kind produced by this expression.
 
bool refersToBitField () const
 Returns true if this expression is a gl-value that potentially refers to a bit-field.
 
FieldDeclgetSourceBitField ()
 If this expression refers to a bit-field, retrieve the declaration of that bit-field.
 
EnumConstantDeclgetEnumConstantDecl ()
 If this expression refers to an enum constant, retrieve its declaration.
 
const EnumConstantDeclgetEnumConstantDecl () const
 
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.
 
bool isObjCSelfExpr () const
 Check if this expression is the ObjC 'self' implicit parameter.
 
bool refersToVectorElement () const
 Returns whether this expression refers to a vector element.
 
bool refersToMatrixElement () const
 Returns whether this expression refers to a matrix element.
 
bool refersToGlobalRegisterVar () const
 Returns whether this expression refers to a global register variable.
 
bool hasPlaceholderType () const
 Returns whether this expression has a placeholder type.
 
bool hasPlaceholderType (BuiltinType::Kind K) const
 Returns whether this expression has a specific placeholder type.
 
bool isKnownToHaveBooleanValue (bool Semantic=true) const
 isKnownToHaveBooleanValue - Return true if this is an integer expression that is known to return 0 or 1.
 
bool isFlexibleArrayMemberLike (ASTContext &Context, LangOptions::StrictFlexArraysLevelKind StrictFlexArraysLevel, bool IgnoreTemplateOrMacroSubstitution=false) const
 Check whether this array fits the idiom of a flexible array member, depending on the value of -fstrict-flex-array.
 
std::optional< llvm::APSInt > getIntegerConstantExpr (const ASTContext &Ctx, SourceLocation *Loc=nullptr) const
 isIntegerConstantExpr - Return the value if this expression is a valid integer constant expression.
 
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.
 
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.
 
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.
 
const ValueDeclgetAsBuiltinConstantDeclRef (const ASTContext &Context) const
 If this expression is an unambiguous reference to a single declaration, in the style of __builtin_function_start, return that declaration.
 
bool EvaluateAsRValue (EvalResult &Result, const ASTContext &Ctx, bool InConstantContext=false) 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.
 
bool EvaluateAsBooleanCondition (bool &Result, const ASTContext &Ctx, bool InConstantContext=false) const
 EvaluateAsBooleanCondition - Return true if this is a constant which we can fold and convert to a boolean condition using any crazy technique that we want to, even if the expression has side-effects.
 
bool EvaluateAsInt (EvalResult &Result, const ASTContext &Ctx, SideEffectsKind AllowSideEffects=SE_NoSideEffects, bool InConstantContext=false) 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.
 
bool EvaluateAsFloat (llvm::APFloat &Result, const ASTContext &Ctx, SideEffectsKind AllowSideEffects=SE_NoSideEffects, bool InConstantContext=false) 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.
 
bool EvaluateAsFixedPoint (EvalResult &Result, const ASTContext &Ctx, SideEffectsKind AllowSideEffects=SE_NoSideEffects, bool InConstantContext=false) const
 EvaluateAsFixedPoint - Return true if this is a constant which we can fold and convert to a fixed point value.
 
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.
 
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.
 
bool hasNonTrivialCall (const ASTContext &Ctx) const
 Determine whether this expression involves a call to any function that is not trivial.
 
llvm::APSInt EvaluateKnownConstInt (const ASTContext &Ctx, SmallVectorImpl< PartialDiagnosticAt > *Diag=nullptr) const
 EvaluateKnownConstInt - Call EvaluateAsRValue and return the folded integer.
 
llvm::APSInt EvaluateKnownConstIntCheckOverflow (const ASTContext &Ctx, SmallVectorImpl< PartialDiagnosticAt > *Diag=nullptr) const
 
void EvaluateForOverflow (const ASTContext &Ctx) const
 
bool EvaluateAsLValue (EvalResult &Result, const ASTContext &Ctx, bool InConstantContext=false) const
 EvaluateAsLValue - Evaluate an expression to see if we can fold it to an lvalue with link time known address, with no side-effects.
 
bool EvaluateAsInitializer (APValue &Result, const ASTContext &Ctx, const VarDecl *VD, SmallVectorImpl< PartialDiagnosticAt > &Notes, bool IsConstantInitializer) const
 EvaluateAsInitializer - Evaluate an expression as if it were the initializer of the given declaration.
 
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.
 
bool EvaluateAsConstantExpr (EvalResult &Result, const ASTContext &Ctx, ConstantExprKind Kind=ConstantExprKind::Normal) const
 Evaluate an expression that is required to be a constant expression.
 
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.
 
bool tryEvaluateStrLen (uint64_t &Result, ASTContext &Ctx) const
 If the current Expr is a pointer, this will try to statically determine the strlen of the string pointed to.
 
bool EvaluateCharRangeAsString (std::string &Result, const Expr *SizeExpression, const Expr *PtrExpression, ASTContext &Ctx, EvalResult &Status) const
 
std::optional< std::string > tryEvaluateString (ASTContext &Ctx) const
 If the current Expr can be evaluated to a pointer to a null-terminated constant string, return the constant string (without the terminating null).
 
NullPointerConstantKind isNullPointerConstant (ASTContext &Ctx, NullPointerConstantValueDependence NPC) const
 isNullPointerConstant - C99 6.3.2.3p3 - Test if this reduces down to a Null pointer constant.
 
bool isOBJCGCCandidate (ASTContext &Ctx) const
 isOBJCGCCandidate - Return true if this expression may be used in a read/ write barrier.
 
bool isBoundMemberFunction (ASTContext &Ctx) const
 Returns true if this expression is a bound member function.
 
ExprIgnoreUnlessSpelledInSource ()
 Skip past any invisible AST nodes which might surround this statement, such as ExprWithCleanups or ImplicitCastExpr nodes, but also injected CXXMemberExpr and CXXConstructExpr which represent implicit conversions.
 
const ExprIgnoreUnlessSpelledInSource () const
 
ExprIgnoreImpCasts () LLVM_READONLY
 Skip past any implicit casts which might surround this expression until reaching a fixed point.
 
const ExprIgnoreImpCasts () const
 
ExprIgnoreCasts () LLVM_READONLY
 Skip past any casts which might surround this expression until reaching a fixed point.
 
const ExprIgnoreCasts () const
 
ExprIgnoreImplicit () LLVM_READONLY
 Skip past any implicit AST nodes which might surround this expression until reaching a fixed point.
 
const ExprIgnoreImplicit () const
 
ExprIgnoreImplicitAsWritten () LLVM_READONLY
 Skip past any implicit AST nodes which might surround this expression until reaching a fixed point.
 
const ExprIgnoreImplicitAsWritten () const
 
ExprIgnoreParens () LLVM_READONLY
 Skip past any parentheses which might surround this expression until reaching a fixed point.
 
const ExprIgnoreParens () const
 
ExprIgnoreParenImpCasts () LLVM_READONLY
 Skip past any parentheses and implicit casts which might surround this expression until reaching a fixed point.
 
const ExprIgnoreParenImpCasts () const
 
ExprIgnoreParenCasts () LLVM_READONLY
 Skip past any parentheses and casts which might surround this expression until reaching a fixed point.
 
const ExprIgnoreParenCasts () const
 
ExprIgnoreConversionOperatorSingleStep () LLVM_READONLY
 Skip conversion operators.
 
const ExprIgnoreConversionOperatorSingleStep () const
 
ExprIgnoreParenLValueCasts () LLVM_READONLY
 Skip past any parentheses and lvalue casts which might surround this expression until reaching a fixed point.
 
const ExprIgnoreParenLValueCasts () const
 
ExprIgnoreParenNoopCasts (const ASTContext &Ctx) LLVM_READONLY
 Skip past any parentheses and casts which do not change the value (including ptr->int casts of the same size) until reaching a fixed point.
 
const ExprIgnoreParenNoopCasts (const ASTContext &Ctx) const
 
ExprIgnoreParenBaseCasts () LLVM_READONLY
 Skip past any parentheses and derived-to-base casts until reaching a fixed point.
 
const ExprIgnoreParenBaseCasts () const
 
bool isDefaultArgument () const
 Determine whether this expression is a default function argument.
 
bool isTemporaryObject (ASTContext &Ctx, const CXXRecordDecl *TempTy) const
 Determine whether the result of this expression is a temporary object of the given class type.
 
bool isImplicitCXXThis () const
 Whether this expression is an implicit reference to 'this' in C++.
 
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.
 
const ExprgetBestDynamicClassTypeExpr () const
 Get the inner expression that determines the best dynamic class.
 
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.
 
const ExprskipRValueSubobjectAdjustments () const
 
- Public Member Functions inherited from clang::ValueStmt
const ExprgetExprStmt () const
 
ExprgetExprStmt ()
 
- 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 ()=delete
 
 Stmt (const Stmt &)=delete
 
 Stmt (Stmt &&)=delete
 
Stmtoperator= (const Stmt &)=delete
 
Stmtoperator= (Stmt &&)=delete
 
 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.
 
SourceLocation getBeginLoc () const LLVM_READONLY
 
SourceLocation getEndLoc () const LLVM_READONLY
 
void dump () const
 Dumps the specified AST fragment and all subtrees to llvm::errs().
 
void dump (raw_ostream &OS, const ASTContext &Context) const
 
int64_t getID (const ASTContext &Context) const
 
void dumpColor () const
 dumpColor - same as dump(), but forces color highlighting.
 
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.
 
void printPretty (raw_ostream &OS, PrinterHelper *Helper, const PrintingPolicy &Policy, unsigned Indentation=0, StringRef NewlineSymbol="\n", const ASTContext *Context=nullptr) const
 
void printPrettyControlled (raw_ostream &OS, PrinterHelper *Helper, const PrintingPolicy &Policy, unsigned Indentation=0, StringRef NewlineSymbol="\n", const ASTContext *Context=nullptr) const
 
void printJson (raw_ostream &Out, PrinterHelper *Helper, const PrintingPolicy &Policy, bool AddQuotes) const
 Pretty-prints in JSON format.
 
void viewAST () const
 viewAST - Visualize an AST rooted at this Stmt* using GraphViz.
 
StmtIgnoreContainers (bool IgnoreCaptured=false)
 Skip no-op (attributed, compound) container stmts and skip captured stmt at the top, if IgnoreCaptured is true.
 
const StmtIgnoreContainers (bool IgnoreCaptured=false) const
 
const StmtstripLabelLikeStatements () const
 Strip off all label-like statements.
 
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, bool ProfileLambdaExpr=false) const
 Produce a unique representation of the given statement.
 
void ProcessODRHash (llvm::FoldingSetNodeID &ID, ODRHash &Hash) const
 Calculate a unique representation for a statement that is stable across compiler invocations.
 

Static Public Member Functions

static StringLiteralCreate (const ASTContext &Ctx, StringRef Str, StringLiteralKind Kind, bool Pascal, QualType Ty, const SourceLocation *Loc, unsigned NumConcatenated)
 This is the "fully general" constructor that allows representation of strings formed from multiple concatenated tokens.
 
static StringLiteralCreate (const ASTContext &Ctx, StringRef Str, StringLiteralKind Kind, bool Pascal, QualType Ty, SourceLocation Loc)
 Simple constructor for string literals made from one token.
 
static StringLiteralCreateEmpty (const ASTContext &Ctx, unsigned NumConcatenated, unsigned Length, unsigned CharByteWidth)
 Construct an empty string literal.
 
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.
 
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.
 
static bool isPotentialConstantExprUnevaluated (Expr *E, const FunctionDecl *FD, SmallVectorImpl< PartialDiagnosticAt > &Diags)
 isPotentialConstantExprUnevaluated - 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.
 
static QualType findBoundMemberType (const Expr *expr)
 Given an expression of bound-member type, find the type of the member.
 
static bool hasAnyTypeDependentArguments (ArrayRef< Expr * > Exprs)
 hasAnyTypeDependentArguments - Determines if any of the expressions in Exprs is type-dependent.
 
static bool isSameComparisonOperand (const Expr *E1, const Expr *E2)
 Checks that the two Expr's will refer to the same value as a comparison operand.
 
static bool classof (const Stmt *T)
 
- Static Public Member Functions inherited from clang::ValueStmt
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 ()
 
static Likelihood getLikelihood (ArrayRef< const Attr * > Attrs)
 
static Likelihood getLikelihood (const Stmt *S)
 
static const AttrgetLikelihoodAttr (const Stmt *S)
 
static Likelihood getLikelihood (const Stmt *Then, const Stmt *Else)
 
static std::tuple< bool, const Attr *, const Attr * > determineLikelihoodConflict (const Stmt *Then, const Stmt *Else)
 

Friends

class ASTStmtReader
 

Additional Inherited Members

- Protected Types inherited from clang::Stmt
enum  { NumStmtBits = 8 }
 
enum  { NumExprBits = NumStmtBits + 5 + llvm::BitWidth<ExprDependence> }
 
enum  { NumCallExprBits = 32 }
 
enum  { NumOverloadExprBits = NumExprBits + 1 }
 
template<typename T >
using ConstCastIterator = CastIterator< T, const T *const, const Stmt *const >
 Const iterator for iterating over Stmt * arrays that contain only T *.
 
using ExprIterator = CastIterator< Expr >
 
using ConstExprIterator = ConstCastIterator< Expr >
 
- Protected Member Functions inherited from clang::Expr
 Expr (StmtClass SC, QualType T, ExprValueKind VK, ExprObjectKind OK)
 
 Expr (StmtClass SC, EmptyShell)
 Construct an empty expression.
 
void setDependence (ExprDependence Deps)
 Each concrete expr subclass is expected to compute its dependence and call this in the constructor.
 
- Protected Member Functions inherited from clang::ValueStmt
 Stmt (StmtClass SC, EmptyShell)
 Construct an empty statement.
 
 Stmt ()=delete
 
 Stmt (const Stmt &)=delete
 
 Stmt (Stmt &&)=delete
 
 Stmt (StmtClass SC)
 
- 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.
 
- Protected Attributes inherited from clang::Stmt
union {
   StmtBitfields   StmtBits
 
   NullStmtBitfields   NullStmtBits
 
   CompoundStmtBitfields   CompoundStmtBits
 
   LabelStmtBitfields   LabelStmtBits
 
   AttributedStmtBitfields   AttributedStmtBits
 
   IfStmtBitfields   IfStmtBits
 
   SwitchStmtBitfields   SwitchStmtBits
 
   WhileStmtBitfields   WhileStmtBits
 
   DoStmtBitfields   DoStmtBits
 
   ForStmtBitfields   ForStmtBits
 
   GotoStmtBitfields   GotoStmtBits
 
   ContinueStmtBitfields   ContinueStmtBits
 
   BreakStmtBitfields   BreakStmtBits
 
   ReturnStmtBitfields   ReturnStmtBits
 
   SwitchCaseBitfields   SwitchCaseBits
 
   ExprBitfields   ExprBits
 
   ConstantExprBitfields   ConstantExprBits
 
   PredefinedExprBitfields   PredefinedExprBits
 
   DeclRefExprBitfields   DeclRefExprBits
 
   FloatingLiteralBitfields   FloatingLiteralBits
 
   StringLiteralBitfields   StringLiteralBits
 
   CharacterLiteralBitfields   CharacterLiteralBits
 
   UnaryOperatorBitfields   UnaryOperatorBits
 
   UnaryExprOrTypeTraitExprBitfields   UnaryExprOrTypeTraitExprBits
 
   ArrayOrMatrixSubscriptExprBitfields   ArrayOrMatrixSubscriptExprBits
 
   CallExprBitfields   CallExprBits
 
   MemberExprBitfields   MemberExprBits
 
   CastExprBitfields   CastExprBits
 
   BinaryOperatorBitfields   BinaryOperatorBits
 
   InitListExprBitfields   InitListExprBits
 
   ParenListExprBitfields   ParenListExprBits
 
   GenericSelectionExprBitfields   GenericSelectionExprBits
 
   PseudoObjectExprBitfields   PseudoObjectExprBits
 
   SourceLocExprBitfields   SourceLocExprBits
 
   StmtExprBitfields   StmtExprBits
 
   CXXOperatorCallExprBitfields   CXXOperatorCallExprBits
 
   CXXRewrittenBinaryOperatorBitfields   CXXRewrittenBinaryOperatorBits
 
   CXXBoolLiteralExprBitfields   CXXBoolLiteralExprBits
 
   CXXNullPtrLiteralExprBitfields   CXXNullPtrLiteralExprBits
 
   CXXThisExprBitfields   CXXThisExprBits
 
   CXXThrowExprBitfields   CXXThrowExprBits
 
   CXXDefaultArgExprBitfields   CXXDefaultArgExprBits
 
   CXXDefaultInitExprBitfields   CXXDefaultInitExprBits
 
   CXXScalarValueInitExprBitfields   CXXScalarValueInitExprBits
 
   CXXNewExprBitfields   CXXNewExprBits
 
   CXXDeleteExprBitfields   CXXDeleteExprBits
 
   TypeTraitExprBitfields   TypeTraitExprBits
 
   DependentScopeDeclRefExprBitfields   DependentScopeDeclRefExprBits
 
   CXXConstructExprBitfields   CXXConstructExprBits
 
   ExprWithCleanupsBitfields   ExprWithCleanupsBits
 
   CXXUnresolvedConstructExprBitfields   CXXUnresolvedConstructExprBits
 
   CXXDependentScopeMemberExprBitfields   CXXDependentScopeMemberExprBits
 
   OverloadExprBitfields   OverloadExprBits
 
   UnresolvedLookupExprBitfields   UnresolvedLookupExprBits
 
   UnresolvedMemberExprBitfields   UnresolvedMemberExprBits
 
   CXXNoexceptExprBitfields   CXXNoexceptExprBits
 
   SubstNonTypeTemplateParmExprBitfields   SubstNonTypeTemplateParmExprBits
 
   LambdaExprBitfields   LambdaExprBits
 
   RequiresExprBitfields   RequiresExprBits
 
   CoawaitExprBitfields   CoawaitBits
 
   ObjCIndirectCopyRestoreExprBitfields   ObjCIndirectCopyRestoreExprBits
 
   OpaqueValueExprBitfields   OpaqueValueExprBits
 
}; 
 

Detailed Description

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

"foo" or L"bar" (wide strings). The actual string data can be obtained with getBytes() and is NOT null-terminated. The length of the string data 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]".

Examples
/home/buildbot/as-worker-4/publish-doxygen-docs/llvm-project/clang/lib/StaticAnalyzer/Core/RegionStore.cpp.

Definition at line 1775 of file Expr.h.

Member Typedef Documentation

◆ tokloc_iterator

Definition at line 1949 of file Expr.h.

Member Function Documentation

◆ children() [1/2]

child_range clang::StringLiteral::children ( )
inline

Definition at line 1967 of file Expr.h.

◆ children() [2/2]

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

Definition at line 1970 of file Expr.h.

◆ classof()

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

Definition at line 1962 of file Expr.h.

References clang::T.

◆ containsNonAscii()

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

Definition at line 1910 of file Expr.h.

References c, getString(), and clang::isASCII().

◆ containsNonAsciiOrNull()

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

Definition at line 1917 of file Expr.h.

References c, getString(), and clang::isASCII().

◆ Create() [1/2]

StringLiteral * StringLiteral::Create ( const ASTContext Ctx,
StringRef  Str,
StringLiteralKind  Kind,
bool  Pascal,
QualType  Ty,
const SourceLocation Loc,
unsigned  NumConcatenated 
)
static

◆ Create() [2/2]

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

Simple constructor for string literals made from one token.

Definition at line 1844 of file Expr.h.

References clang::Create, Kind, and Loc.

◆ CreateEmpty()

StringLiteral * StringLiteral::CreateEmpty ( const ASTContext Ctx,
unsigned  NumConcatenated,
unsigned  Length,
unsigned  CharByteWidth 
)
static

Construct an empty string literal.

Definition at line 1202 of file Expr.cpp.

References clang::ASTContext::Allocate().

◆ getBeginLoc()

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

Definition at line 1959 of file Expr.h.

References tokloc_begin().

Referenced by clang::Sema::ActOnPragmaMSSeg(), getAsmSrcLocInfo(), and getClobberConflictLocation().

◆ getByteLength()

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

Definition at line 1894 of file Expr.h.

References getCharByteWidth(), and getLength().

Referenced by getBytes(), clang::EmbedDataStorage::getDataElementCount(), and getString().

◆ getBytes()

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

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

Definition at line 1863 of file Expr.h.

References getByteLength().

Referenced by clang::ODRHash::AddFunctionDecl(), isIdenticalStmt(), and clang::EmbedExpr::ChildElementIter< Const >::operator*().

◆ getCharByteWidth()

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

Definition at line 1896 of file Expr.h.

References clang::Stmt::StringLiteralBits.

Referenced by getByteLength(), getCodeUnit(), getCodeUnitS(), and getString().

◆ getCodeUnit()

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

◆ getCodeUnitS()

int64_t clang::StringLiteral::getCodeUnitS ( size_t  I,
uint64_t  BitWidth 
) const
inline

Definition at line 1884 of file Expr.h.

References getCharByteWidth(), getCodeUnit(), isOrdinary(), isWide(), and V.

Referenced by CheckC23ConstexprInitStringLiteral().

◆ getEndLoc()

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

Definition at line 1960 of file Expr.h.

References tokloc_end().

◆ getKind()

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

◆ getLength()

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

◆ 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 1329 of file Expr.cpp.

References clang::Lexer::AdvanceToTokenCharacter(), getKind(), getNumConcatenated(), clang::StringLiteralParser::getOffsetOfStringByte(), clang::StringLiteralParser::GetStringLength(), getStrTokenLoc(), clang::Invalid, clang::Lexer::LexFromRawLexer(), clang::Ordinary, SM, clang::Unevaluated, and clang::UTF8.

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

◆ 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 1926 of file Expr.h.

References clang::Stmt::StringLiteralBits.

Referenced by getLocationOfByte(), getStrTokenLoc(), and tokloc_end().

◆ getString()

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

◆ getStrTokenLoc()

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

Get one of the string literal token.

Definition at line 1931 of file Expr.h.

References getNumConcatenated().

Referenced by clang::Sema::ActOnFunctionDeclarator(), clang::Sema::ActOnVariableDeclarator(), and getLocationOfByte().

◆ isOrdinary()

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

◆ isPascal()

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

Definition at line 1908 of file Expr.h.

References clang::Stmt::StringLiteralBits.

◆ isUnevaluated()

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

Definition at line 1907 of file Expr.h.

References getKind(), and clang::Unevaluated.

Referenced by clang::Sema::ActOnStartLinkageSpecification(), and getString().

◆ isUTF16()

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

Definition at line 1905 of file Expr.h.

References getKind(), and clang::UTF16.

◆ isUTF32()

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

Definition at line 1906 of file Expr.h.

References getKind(), and clang::UTF32.

◆ isUTF8()

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

Definition at line 1904 of file Expr.h.

References getKind(), and clang::UTF8.

Referenced by clang::analyze_os_log::computeOSLogBufferLayout().

◆ isWide()

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

Definition at line 1903 of file Expr.h.

References getKind(), and clang::Wide.

Referenced by getCodeUnitS().

◆ outputString()

void StringLiteral::outputString ( raw_ostream &  OS) const

◆ tokloc_begin()

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

Definition at line 1951 of file Expr.h.

Referenced by getBeginLoc().

◆ tokloc_end()

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

Definition at line 1955 of file Expr.h.

References getNumConcatenated().

Referenced by getEndLoc().

Friends And Related Function Documentation

◆ ASTStmtReader

friend class ASTStmtReader
friend

Definition at line 1779 of file Expr.h.


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