clang
3.9.0
|
StringLiteral - This represents a string literal expression, e.g. More...
#include <Expr.h>
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 () |
![]() | |
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... | |
FieldDecl * | getSourceBitField () |
If this expression refers to a bit-field, retrieve the declaration of that bit-field. More... | |
const FieldDecl * | getSourceBitField () const |
const ObjCPropertyRefExpr * | getObjCProperty () 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 |
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... | |
Expr * | IgnoreImpCasts () LLVM_READONLY |
IgnoreImpCasts - Skip past any implicit casts which might surround this expression. More... | |
Expr * | IgnoreImplicit () LLVM_READONLY |
IgnoreImplicit - Skip past any implicit AST nodes which might surround this expression. More... | |
const Expr * | IgnoreImplicit () const LLVM_READONLY |
Expr * | IgnoreParens () LLVM_READONLY |
IgnoreParens - Ignore parentheses. More... | |
Expr * | IgnoreParenCasts () LLVM_READONLY |
IgnoreParenCasts - Ignore parentheses and casts. More... | |
Expr * | IgnoreCasts () LLVM_READONLY |
Ignore casts. Strip off any CastExprs, returning their operand. More... | |
Expr * | IgnoreParenImpCasts () LLVM_READONLY |
IgnoreParenImpCasts - Ignore parentheses and implicit casts. More... | |
Expr * | IgnoreConversionOperator () LLVM_READONLY |
IgnoreConversionOperator - Ignore conversion operator. More... | |
const Expr * | IgnoreConversionOperator () const LLVM_READONLY |
const Expr * | IgnoreParenImpCasts () const LLVM_READONLY |
Expr * | IgnoreParenLValueCasts () LLVM_READONLY |
Ignore parentheses and lvalue casts. More... | |
const Expr * | IgnoreParenLValueCasts () const LLVM_READONLY |
Expr * | IgnoreParenNoopCasts (ASTContext &Ctx) LLVM_READONLY |
IgnoreParenNoopCasts - Ignore parentheses and casts that do not change the value (including ptr->int casts of the same size). More... | |
Expr * | ignoreParenBaseCasts () LLVM_READONLY |
Ignore parentheses and derived-to-base casts. More... | |
const Expr * | ignoreParenBaseCasts () 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 Expr * | IgnoreImpCasts () const LLVM_READONLY |
const Expr * | IgnoreParens () const LLVM_READONLY |
const Expr * | IgnoreParenCasts () const LLVM_READONLY |
const Expr * | IgnoreCasts () const LLVM_READONLY |
Strip off casts, but keep parentheses. More... | |
const Expr * | IgnoreParenNoopCasts (ASTContext &Ctx) const LLVM_READONLY |
const CXXRecordDecl * | getBestDynamicClassType () 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 Expr * | skipRValueSubobjectAdjustments (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... | |
Static Public Member Functions | |
static StringLiteral * | Create (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 StringLiteral * | Create (const ASTContext &C, StringRef Str, StringKind Kind, bool Pascal, QualType Ty, SourceLocation Loc) |
Simple constructor for string literals made from one token. More... | |
static StringLiteral * | CreateEmpty (const ASTContext &C, unsigned NumStrs) |
Construct an empty string literal. More... | |
static bool | classof (const Stmt *T) |
![]() | |
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) |
Friends | |
class | ASTStmtReader |
Additional Inherited Members | |
![]() | |
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... | |
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]".
typedef const SourceLocation* clang::StringLiteral::tokloc_iterator |
|
inline |
Definition at line 1564 of file Expr.h.
References getString(), and clang::isASCII().
Referenced by GetConstantCFStringEntry().
|
static |
This is the "fully general" constructor that allows representation of strings formed from multiple concatenated tokens.
Definition at line 826 of file Expr.cpp.
References clang::ASTContext::Allocate(), clang::ASTContext::getAsConstantArrayType(), and setString().
Referenced by clang::Sema::ActOnNumericConstant(), clang::Sema::ActOnStringLiteral(), clang::Sema::BuildPredefinedExpr(), Create(), clang::Sema::ParseObjCStringLiteral(), and clang::ASTNodeImporter::VisitStringLiteral().
|
inlinestatic |
|
static |
Construct an empty string literal.
Definition at line 851 of file Expr.cpp.
References clang::ASTContext::Allocate().
|
inline |
Definition at line 1546 of file Expr.h.
Referenced by getBytes(), and getString().
|
inline |
Allow access to clients that need the byte representation, such as ASTWriterStmt::VisitStringLiteral().
Definition at line 1522 of file Expr.h.
References getByteLength().
Referenced by isIdenticalStmt(), and clang::ASTNodeImporter::VisitStringLiteral().
|
inline |
Definition at line 1548 of file Expr.h.
Referenced by expandStringLiteral(), extractStringLiteralCharacter(), and clang::CodeGen::CodeGenModule::GetConstantArrayFromStringLiteral().
|
inline |
Definition at line 1536 of file Expr.h.
Referenced by clang::Sema::ActOnStringLiteral(), expandStringLiteral(), extractStringLiteralCharacter(), clang::CodeGen::CodeGenModule::GetConstantArrayFromStringLiteral(), and outputString().
|
inline |
Definition at line 1554 of file Expr.h.
Referenced by IsStringInit(), outputString(), and clang::ASTNodeImporter::VisitStringLiteral().
|
inline |
Definition at line 1547 of file Expr.h.
Referenced by clang::Sema::ActOnStringLiteral(), diagnoseStringPlusInt(), expandStringLiteral(), clang::CodeGen::CodeGenModule::GetConstantArrayFromStringLiteral(), and outputString().
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 1009 of file Expr.cpp.
References clang::Lexer::AdvanceToTokenCharacter(), Ascii, Buffer, clang::SourceManager::getBufferData(), clang::SourceManager::getDecomposedLoc(), clang::SourceManager::getLocForStartOfFile(), getNumConcatenated(), clang::StringLiteralParser::getOffsetOfStringByte(), clang::SourceManager::getSpellingLoc(), clang::StringLiteralParser::GetStringLength(), getStrTokenLoc(), and UTF8.
Referenced by clang::GCCAsmStmt::AnalyzeAsmString(), getAsmSrcLocInfo(), and clang::Sema::getLocationOfStringLiteralByte().
|
inline |
|
inline |
Definition at line 1602 of file Expr.h.
Referenced by clang::Sema::ActOnGCCAsmStmt(), clang::Sema::ActOnPragmaMSSeg(), clang::Sema::BuildObjCStringLiteral(), CheckFormatString(), clang::Sema::ConversionToObjCStringLiteralCheck(), getAsmSrcLocInfo(), and clang::Sema::ParseObjCStringLiteral().
|
inline |
getNumConcatenated - Get the number of string literal tokens that were concatenated in translation phase #6 to form this string literal.
Definition at line 1574 of file Expr.h.
Referenced by getLocationOfByte(), and clang::ASTNodeImporter::VisitStringLiteral().
|
inline |
Definition at line 1514 of file Expr.h.
References getByteLength().
Referenced by clang::Sema::ActOnFunctionDeclarator(), clang::Sema::ActOnGCCAsmStmt(), clang::Sema::ActOnPragmaMSInitSeg(), clang::Sema::ActOnPragmaMSSection(), clang::Sema::ActOnPragmaMSSeg(), clang::Sema::ActOnStartLinkageSpecification(), clang::Sema::ActOnVariableDeclarator(), clang::GCCAsmStmt::AnalyzeAsmString(), clang::Sema::CheckCompleteVariableDeclaration(), CheckFormatString(), checkFormatStringExpr(), CheckObjCCollectionLiteralElement(), clang::Sema::checkStringLiteralArgumentAttr(), containsNonAsciiOrNull(), DiagnoseCStringFormatDirectiveInCFAPI(), DiagnoseCStringFormatDirectiveInObjCAPI(), clang::Sema::FormatStringHasSArg(), getAsmSrcLocInfo(), clang::GCCAsmStmt::getClobber(), clang::CodeGen::CodeGenModule::GetConstantArrayFromStringLiteral(), GetConstantCFStringEntry(), GetConstantStringEntry(), clang::GCCAsmStmt::getInputConstraint(), clang::GCCAsmStmt::getOutputConstraint(), clang::Sema::ParseObjCStringLiteral(), and TryEvaluateBuiltinNaN().
|
inline |
Definition at line 1576 of file Expr.h.
Referenced by clang::Sema::ActOnFunctionDeclarator(), clang::Sema::ActOnVariableDeclarator(), clang::CodeGen::CodeGenModule::GetAddrOfConstantStringFromLiteral(), and getLocationOfByte().
|
inline |
Definition at line 1557 of file Expr.h.
References Ascii.
Referenced by clang::Sema::ActOnGCCAsmStmt(), clang::Sema::ActOnStartLinkageSpecification(), CheckFormatString(), clang::Sema::checkStringLiteralArgumentAttr(), clang::Sema::ConversionToObjCStringLiteralCheck(), clang::Sema::ParseObjCStringLiteral(), and SemaBuiltinAnnotation().
|
inline |
Definition at line 1562 of file Expr.h.
Referenced by clang::ASTNodeImporter::VisitStringLiteral().
|
inline |
|
inline |
|
inline |
|
inline |
void StringLiteral::outputString | ( | raw_ostream & | OS | ) | const |
Definition at line 863 of file Expr.cpp.
References Ascii, getCodeUnit(), getKind(), getLength(), I, clang::isPrintable(), clang::prec::Shift, UTF16, UTF32, UTF8, and Wide.
void StringLiteral::setString | ( | const ASTContext & | C, |
StringRef | Str, | ||
StringKind | Kind, | ||
bool | IsPascal | ||
) |
Sets the string data to the given string data.
Definition at line 956 of file Expr.cpp.
References clang::ASTContext::getTargetInfo().
Referenced by Create().
|
inline |
|
inline |
Definition at line 1599 of file Expr.h.
Referenced by clang::Sema::ParseObjCStringLiteral(), and clang::ASTNodeImporter::VisitStringLiteral().
|
inline |
Definition at line 1600 of file Expr.h.
Referenced by clang::Sema::ParseObjCStringLiteral(), and clang::ASTNodeImporter::VisitStringLiteral().
|
friend |