clang  3.7.0
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
clang::UserDefinedLiteral Class Reference

A call to a literal operator (C++11 [over.literal]) written as a user-defined literal (C++11 [lit.ext]). More...

#include <ExprCXX.h>

Inheritance diagram for clang::UserDefinedLiteral:
[legend]
Collaboration diagram for clang::UserDefinedLiteral:
[legend]

Public Types

enum  LiteralOperatorKind {
  LOK_Raw, LOK_Template, LOK_Integer, LOK_Floating,
  LOK_String, LOK_Character
}
 The kind of literal operator which is invoked. More...
 
- Public Types inherited from clang::CallExpr
typedef ExprIterator arg_iterator
 
typedef ConstExprIterator const_arg_iterator
 
typedef llvm::iterator_range
< arg_iterator
arg_range
 
typedef llvm::iterator_range
< const_arg_iterator
arg_const_range
 
- 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_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 Member Functions

 UserDefinedLiteral (const ASTContext &C, Expr *Fn, ArrayRef< Expr * > Args, QualType T, ExprValueKind VK, SourceLocation LitEndLoc, SourceLocation SuffixLoc)
 
 UserDefinedLiteral (const ASTContext &C, EmptyShell Empty)
 
LiteralOperatorKind getLiteralOperatorKind () const
 Returns the kind of literal operator invocation which this expression represents. More...
 
ExprgetCookedLiteral ()
 If this is not a raw user-defined literal, get the underlying cooked literal (representing the literal with the suffix removed). More...
 
const ExprgetCookedLiteral () const
 
SourceLocation getLocStart () const
 
SourceLocation getLocEnd () const
 
SourceLocation getUDSuffixLoc () const
 Returns the location of a ud-suffix in the expression. More...
 
const IdentifierInfogetUDSuffix () const
 Returns the ud-suffix specified for this literal. More...
 
- Public Member Functions inherited from clang::CallExpr
 CallExpr (const ASTContext &C, Expr *fn, ArrayRef< Expr * > args, QualType t, ExprValueKind VK, SourceLocation rparenloc)
 
 CallExpr (const ASTContext &C, StmtClass SC, EmptyShell Empty)
 Build an empty call expression. More...
 
const ExprgetCallee () const
 
ExprgetCallee ()
 
void setCallee (Expr *F)
 
DeclgetCalleeDecl ()
 
const DeclgetCalleeDecl () const
 
FunctionDeclgetDirectCallee ()
 If the callee is a FunctionDecl, return it. Otherwise return 0. More...
 
const FunctionDeclgetDirectCallee () const
 
unsigned getNumArgs () const
 
Expr ** getArgs ()
 Retrieve the call arguments. More...
 
const Expr *const * getArgs () const
 
ExprgetArg (unsigned Arg)
 getArg - Return the specified argument. More...
 
const ExprgetArg (unsigned Arg) const
 
void setArg (unsigned Arg, Expr *ArgExpr)
 setArg - Set the specified argument. More...
 
void setNumArgs (const ASTContext &C, unsigned NumArgs)
 
arg_range arguments ()
 
arg_const_range arguments () const
 
arg_iterator arg_begin ()
 
arg_iterator arg_end ()
 
const_arg_iterator arg_begin () const
 
const_arg_iterator arg_end () const
 
ArrayRef< Stmt * > getRawSubExprs ()
 
unsigned getNumCommas () const
 
unsigned getBuiltinCallee () const
 
bool isUnevaluatedBuiltinCall (const ASTContext &Ctx) const
 Returns true if this is a call to a builtin which does not evaluate side-effects within its arguments. More...
 
QualType getCallReturnType (const ASTContext &Ctx) const
 
SourceLocation getRParenLoc () const
 
void setRParenLoc (SourceLocation L)
 
SourceLocation getLocStart () const LLVM_READONLY
 
SourceLocation getLocEnd () const LLVM_READONLY
 
child_range children ()
 
- Public Member Functions inherited from clang::Expr
QualType getType () const
 
void setType (QualType t)
 
bool isValueDependent () const
 
void setValueDependent (bool VD)
 Set whether this expression is value-dependent or not. More...
 
bool isTypeDependent () const
 
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
 
bool isUnusedResultAWarning (const Expr *&WarnExpr, SourceLocation &Loc, SourceRange &R1, SourceRange &R2, ASTContext &Ctx) const
 
bool isLValue () const
 
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
 
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
 
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
 
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 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
 
bool isIntegerConstantExpr (llvm::APSInt &Result, const ASTContext &Ctx, SourceLocation *Loc=nullptr, bool isEvaluated=true) const
 
bool isIntegerConstantExpr (const ASTContext &Ctx, SourceLocation *Loc=nullptr) const
 
bool isCXX98IntegralConstantExpr (const ASTContext &Ctx) const
 
bool isCXX11ConstantExpr (const ASTContext &Ctx, APValue *Result=nullptr, SourceLocation *Loc=nullptr) const
 
bool isConstantInitializer (ASTContext &Ctx, bool ForRef, const Expr **Culprit=nullptr) const
 
bool EvaluateAsRValue (EvalResult &Result, const ASTContext &Ctx) const
 
bool EvaluateAsBooleanCondition (bool &Result, const ASTContext &Ctx) const
 
bool EvaluateAsInt (llvm::APSInt &Result, const ASTContext &Ctx, SideEffectsKind AllowSideEffects=SE_NoSideEffects) const
 
bool isEvaluatable (const ASTContext &Ctx) const
 
bool HasSideEffects (const ASTContext &Ctx, bool IncludePossibleEffects=true) const
 
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
 
void EvaluateForOverflow (const ASTContext &Ctx) const
 
bool EvaluateAsLValue (EvalResult &Result, const ASTContext &Ctx) const
 
bool EvaluateAsInitializer (APValue &Result, const ASTContext &Ctx, const VarDecl *VD, SmallVectorImpl< PartialDiagnosticAt > &Notes) const
 
bool EvaluateWithSubstitution (APValue &Value, ASTContext &Ctx, const FunctionDecl *Callee, ArrayRef< const Expr * > Args) const
 
NullPointerConstantKind isNullPointerConstant (ASTContext &Ctx, NullPointerConstantValueDependence NPC) const
 
bool isOBJCGCCandidate (ASTContext &Ctx) const
 
bool isBoundMemberFunction (ASTContext &Ctx) const
 Returns true if this expression is a bound member function. More...
 
ExprIgnoreImpCasts () LLVM_READONLY
 
ExprIgnoreImplicit () LLVM_READONLY
 
const ExprIgnoreImplicit () const LLVM_READONLY
 
ExprIgnoreParens () LLVM_READONLY
 
ExprIgnoreParenCasts () LLVM_READONLY
 
ExprIgnoreCasts () LLVM_READONLY
 Ignore casts. Strip off any CastExprs, returning their operand. More...
 
ExprIgnoreParenImpCasts () LLVM_READONLY
 
ExprIgnoreConversionOperator () LLVM_READONLY
 
const ExprIgnoreConversionOperator () const LLVM_READONLY
 
const ExprIgnoreParenImpCasts () const LLVM_READONLY
 
ExprIgnoreParenLValueCasts () LLVM_READONLY
 
const ExprIgnoreParenLValueCasts () const LLVM_READONLY
 
ExprIgnoreParenNoopCasts (ASTContext &Ctx) LLVM_READONLY
 
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 ExprskipRValueSubobjectAdjustments (SmallVectorImpl< const Expr * > &CommaLHS, SmallVectorImpl< SubobjectAdjustment > &Adjustments) const
 

Static Public Member Functions

static bool classof (const Stmt *S)
 
- Static Public Member Functions inherited from clang::CallExpr
static bool classof (const Stmt *T)
 
- Static Public Member Functions inherited from clang::Expr
static ExprValueKind getValueKindForType (QualType T)
 
static bool isPotentialConstantExpr (const FunctionDecl *FD, SmallVectorImpl< PartialDiagnosticAt > &Diags)
 
static bool isPotentialConstantExprUnevaluated (Expr *E, const FunctionDecl *FD, SmallVectorImpl< PartialDiagnosticAt > &Diags)
 
static QualType findBoundMemberType (const Expr *expr)
 Given an expression of bound-member type, find the type of the member. Returns null if this is an overloaded bound member expression. More...
 
static bool hasAnyTypeDependentArguments (ArrayRef< Expr * > Exprs)
 
static bool classof (const Stmt *T)
 

Friends

class ASTStmtReader
 
class ASTStmtWriter
 

Additional Inherited Members

- Protected Member Functions inherited from clang::CallExpr
 CallExpr (const ASTContext &C, StmtClass SC, Expr *fn, unsigned NumPreArgs, ArrayRef< Expr * > args, QualType t, ExprValueKind VK, SourceLocation rparenloc)
 
 CallExpr (const ASTContext &C, StmtClass SC, unsigned NumPreArgs, EmptyShell Empty)
 
StmtgetPreArg (unsigned i)
 
const StmtgetPreArg (unsigned i) const
 
void setPreArg (unsigned i, Stmt *PreArg)
 
unsigned getNumPreArgs () const
 
- 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...
 

Detailed Description

A call to a literal operator (C++11 [over.literal]) written as a user-defined literal (C++11 [lit.ext]).

Represents a user-defined literal, e.g. "foo"_bar or 1.23_xyz. While this is semantically equivalent to a normal call, this AST node provides better information about the syntactic representation of the literal.

Since literal operators are never found by ADL and can only be declared at namespace scope, a user-defined literal is never dependent.

Definition at line 372 of file ExprCXX.h.

Member Enumeration Documentation

The kind of literal operator which is invoked.

Enumerator
LOK_Raw 

Raw form: operator "" X (const char *)

LOK_Template 

Raw form: operator "" X<cs...> ()

LOK_Integer 

operator "" X (unsigned long long)

LOK_Floating 

operator "" X (long double)

LOK_String 

operator "" X (const CharT *, size_t)

LOK_Character 

operator "" X (CharT)

Definition at line 386 of file ExprCXX.h.

Constructor & Destructor Documentation

clang::UserDefinedLiteral::UserDefinedLiteral ( const ASTContext C,
Expr Fn,
ArrayRef< Expr * >  Args,
QualType  T,
ExprValueKind  VK,
SourceLocation  LitEndLoc,
SourceLocation  SuffixLoc 
)
inline

Definition at line 377 of file ExprCXX.h.

clang::UserDefinedLiteral::UserDefinedLiteral ( const ASTContext C,
EmptyShell  Empty 
)
inlineexplicit

Definition at line 382 of file ExprCXX.h.

Member Function Documentation

static bool clang::UserDefinedLiteral::classof ( const Stmt S)
inlinestatic

Definition at line 424 of file ExprCXX.h.

Expr * UserDefinedLiteral::getCookedLiteral ( )

If this is not a raw user-defined literal, get the underlying cooked literal (representing the literal with the suffix removed).

Definition at line 752 of file ExprCXX.cpp.

References clang::CallExpr::getArg(), getLiteralOperatorKind(), LOK_Raw, and LOK_Template.

Referenced by getCookedLiteral().

const Expr* clang::UserDefinedLiteral::getCookedLiteral ( ) const
inline

Definition at line 403 of file ExprCXX.h.

References getCookedLiteral().

UserDefinedLiteral::LiteralOperatorKind UserDefinedLiteral::getLiteralOperatorKind ( ) const
SourceLocation clang::UserDefinedLiteral::getLocEnd ( ) const
inline

Definition at line 412 of file ExprCXX.h.

References clang::CallExpr::getRParenLoc().

SourceLocation clang::UserDefinedLiteral::getLocStart ( ) const
inline
const IdentifierInfo * UserDefinedLiteral::getUDSuffix ( ) const

Returns the ud-suffix specified for this literal.

Definition at line 760 of file ExprCXX.cpp.

References clang::CallExpr::getCalleeDecl().

SourceLocation clang::UserDefinedLiteral::getUDSuffixLoc ( ) const
inline

Returns the location of a ud-suffix in the expression.

For a string literal, there may be multiple identical suffixes. This returns the first.

Definition at line 419 of file ExprCXX.h.

Friends And Related Function Documentation

friend class ASTStmtReader
friend

Definition at line 428 of file ExprCXX.h.

friend class ASTStmtWriter
friend

Definition at line 429 of file ExprCXX.h.


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