clang 20.0.0git
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
clang::AsmStmt Class Reference

AsmStmt is the base class for GCCAsmStmt and MSAsmStmt. More...

#include "clang/AST/Stmt.h"

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

Public Types

using inputs_iterator = ExprIterator
 
using const_inputs_iterator = ConstExprIterator
 
using inputs_range = llvm::iterator_range< inputs_iterator >
 
using inputs_const_range = llvm::iterator_range< const_inputs_iterator >
 
using outputs_iterator = ExprIterator
 
using const_outputs_iterator = ConstExprIterator
 
using outputs_range = llvm::iterator_range< outputs_iterator >
 
using outputs_const_range = llvm::iterator_range< const_outputs_iterator >
 
- 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

 AsmStmt (StmtClass SC, EmptyShell Empty)
 Build an empty inline-assembly statement.
 
SourceLocation getAsmLoc () const
 
void setAsmLoc (SourceLocation L)
 
bool isSimple () const
 
void setSimple (bool V)
 
bool isVolatile () const
 
void setVolatile (bool V)
 
SourceLocation getBeginLoc () const LLVM_READONLY
 
SourceLocation getEndLoc () const LLVM_READONLY
 
std::string generateAsmString (const ASTContext &C) const
 Assemble final IR asm string.
 
unsigned getNumOutputs () const
 
StringRef getOutputConstraint (unsigned i) const
 getOutputConstraint - Return the constraint string for the specified output operand.
 
bool isOutputPlusConstraint (unsigned i) const
 isOutputPlusConstraint - Return true if the specified output constraint is a "+" constraint (which is both an input and an output) or false if it is an "=" constraint (just an output).
 
const ExprgetOutputExpr (unsigned i) const
 
unsigned getNumPlusOperands () const
 getNumPlusOperands - Return the number of output operands that have a "+" constraint.
 
unsigned getNumInputs () const
 
StringRef getInputConstraint (unsigned i) const
 getInputConstraint - Return the specified input constraint.
 
const ExprgetInputExpr (unsigned i) const
 
unsigned getNumClobbers () const
 
StringRef getClobber (unsigned i) const
 
inputs_iterator begin_inputs ()
 
inputs_iterator end_inputs ()
 
inputs_range inputs ()
 
const_inputs_iterator begin_inputs () const
 
const_inputs_iterator end_inputs () const
 
inputs_const_range inputs () const
 
outputs_iterator begin_outputs ()
 
outputs_iterator end_outputs ()
 
outputs_range outputs ()
 
const_outputs_iterator begin_outputs () const
 
const_outputs_iterator end_outputs () const
 
outputs_const_range outputs () const
 
child_range children ()
 
const_child_range children () 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 ()=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 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)
 

Protected Member Functions

 AsmStmt (StmtClass SC, SourceLocation asmloc, bool issimple, bool isvolatile, unsigned numoutputs, unsigned numinputs, unsigned numclobbers)
 
- 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

SourceLocation AsmLoc
 
bool IsSimple
 True if the assembly statement does not have any input or output operands.
 
bool IsVolatile
 If true, treat this inline assembly as having side effects.
 
unsigned NumOutputs
 
unsigned NumInputs
 
unsigned NumClobbers
 
Stmt ** Exprs = nullptr
 
- 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
 
}; 
 

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 >
 

Detailed Description

AsmStmt is the base class for GCCAsmStmt and MSAsmStmt.

Definition at line 3105 of file Stmt.h.

Member Typedef Documentation

◆ const_inputs_iterator

Definition at line 3197 of file Stmt.h.

◆ const_outputs_iterator

Definition at line 3226 of file Stmt.h.

◆ inputs_const_range

Definition at line 3199 of file Stmt.h.

◆ inputs_iterator

Definition at line 3196 of file Stmt.h.

◆ inputs_range

using clang::AsmStmt::inputs_range = llvm::iterator_range<inputs_iterator>

Definition at line 3198 of file Stmt.h.

◆ outputs_const_range

Definition at line 3228 of file Stmt.h.

◆ outputs_iterator

Definition at line 3225 of file Stmt.h.

◆ outputs_range

using clang::AsmStmt::outputs_range = llvm::iterator_range<outputs_iterator>

Definition at line 3227 of file Stmt.h.

Constructor & Destructor Documentation

◆ AsmStmt() [1/2]

clang::AsmStmt::AsmStmt ( StmtClass  SC,
SourceLocation  asmloc,
bool  issimple,
bool  isvolatile,
unsigned  numoutputs,
unsigned  numinputs,
unsigned  numclobbers 
)
inlineprotected

Definition at line 3125 of file Stmt.h.

◆ AsmStmt() [2/2]

clang::AsmStmt::AsmStmt ( StmtClass  SC,
EmptyShell  Empty 
)
inlineexplicit

Build an empty inline-assembly statement.

Definition at line 3133 of file Stmt.h.

Member Function Documentation

◆ begin_inputs() [1/2]

inputs_iterator clang::AsmStmt::begin_inputs ( )
inline

Definition at line 3201 of file Stmt.h.

References Exprs, and NumOutputs.

Referenced by inputs().

◆ begin_inputs() [2/2]

const_inputs_iterator clang::AsmStmt::begin_inputs ( ) const
inline

Definition at line 3211 of file Stmt.h.

References Exprs, and NumOutputs.

◆ begin_outputs() [1/2]

outputs_iterator clang::AsmStmt::begin_outputs ( )
inline

Definition at line 3230 of file Stmt.h.

References Exprs.

Referenced by outputs().

◆ begin_outputs() [2/2]

const_outputs_iterator clang::AsmStmt::begin_outputs ( ) const
inline

Definition at line 3242 of file Stmt.h.

References Exprs.

◆ children() [1/2]

child_range clang::AsmStmt::children ( )
inline

Definition at line 3254 of file Stmt.h.

References Exprs, NumInputs, and NumOutputs.

◆ children() [2/2]

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

Definition at line 3258 of file Stmt.h.

References Exprs, NumInputs, and NumOutputs.

◆ classof()

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

Definition at line 3189 of file Stmt.h.

References clang::T.

◆ end_inputs() [1/2]

inputs_iterator clang::AsmStmt::end_inputs ( )
inline

Definition at line 3205 of file Stmt.h.

References Exprs, NumInputs, and NumOutputs.

Referenced by inputs().

◆ end_inputs() [2/2]

const_inputs_iterator clang::AsmStmt::end_inputs ( ) const
inline

Definition at line 3215 of file Stmt.h.

References Exprs, NumInputs, and NumOutputs.

◆ end_outputs() [1/2]

outputs_iterator clang::AsmStmt::end_outputs ( )
inline

Definition at line 3234 of file Stmt.h.

References Exprs, and NumOutputs.

Referenced by outputs().

◆ end_outputs() [2/2]

const_outputs_iterator clang::AsmStmt::end_outputs ( ) const
inline

Definition at line 3246 of file Stmt.h.

References Exprs, and NumOutputs.

◆ generateAsmString()

std::string AsmStmt::generateAsmString ( const ASTContext C) const

Assemble final IR asm string.

Definition at line 442 of file Stmt.cpp.

References clang::C.

◆ getAsmLoc()

SourceLocation clang::AsmStmt::getAsmLoc ( ) const
inline

Definition at line 3135 of file Stmt.h.

References AsmLoc.

◆ getBeginLoc()

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

Definition at line 3144 of file Stmt.h.

◆ getClobber()

StringRef AsmStmt::getClobber ( unsigned  i) const

Definition at line 482 of file Stmt.cpp.

◆ getEndLoc()

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

Definition at line 3145 of file Stmt.h.

◆ getInputConstraint()

StringRef AsmStmt::getInputConstraint ( unsigned  i) const

getInputConstraint - Return the specified input constraint.

Unlike output constraints, these can be empty.

Definition at line 466 of file Stmt.cpp.

◆ getInputExpr()

const Expr * AsmStmt::getInputExpr ( unsigned  i) const

Definition at line 474 of file Stmt.cpp.

◆ getNumClobbers()

unsigned clang::AsmStmt::getNumClobbers ( ) const
inline

Definition at line 3186 of file Stmt.h.

References NumClobbers.

◆ getNumInputs()

unsigned clang::AsmStmt::getNumInputs ( ) const
inline

Definition at line 3176 of file Stmt.h.

References NumInputs.

Referenced by clang::GCCAsmStmt::AnalyzeAsmString(), and clang::GCCAsmStmt::getNamedOperand().

◆ getNumOutputs()

unsigned clang::AsmStmt::getNumOutputs ( ) const
inline

◆ getNumPlusOperands()

unsigned AsmStmt::getNumPlusOperands ( ) const

getNumPlusOperands - Return the number of output operands that have a "+" constraint.

Definition at line 492 of file Stmt.cpp.

References getNumOutputs(), and isOutputPlusConstraint().

Referenced by clang::GCCAsmStmt::AnalyzeAsmString(), and clang::GCCAsmStmt::getNamedOperand().

◆ getOutputConstraint()

StringRef AsmStmt::getOutputConstraint ( unsigned  i) const

getOutputConstraint - Return the constraint string for the specified output operand.

All output constraints are known to be non-empty (either '=' or '+').

Definition at line 450 of file Stmt.cpp.

Referenced by isOutputPlusConstraint().

◆ getOutputExpr()

const Expr * AsmStmt::getOutputExpr ( unsigned  i) const

Definition at line 458 of file Stmt.cpp.

◆ inputs() [1/2]

inputs_range clang::AsmStmt::inputs ( )
inline

Definition at line 3209 of file Stmt.h.

References begin_inputs(), and end_inputs().

◆ inputs() [2/2]

inputs_const_range clang::AsmStmt::inputs ( ) const
inline

Definition at line 3219 of file Stmt.h.

References begin_inputs(), and end_inputs().

◆ isOutputPlusConstraint()

bool clang::AsmStmt::isOutputPlusConstraint ( unsigned  i) const
inline

isOutputPlusConstraint - Return true if the specified output constraint is a "+" constraint (which is both an input and an output) or false if it is an "=" constraint (just an output).

Definition at line 3164 of file Stmt.h.

References getOutputConstraint().

Referenced by getNumPlusOperands().

◆ isSimple()

bool clang::AsmStmt::isSimple ( ) const
inline

Definition at line 3138 of file Stmt.h.

References IsSimple.

Referenced by clang::GCCAsmStmt::AnalyzeAsmString().

◆ isVolatile()

bool clang::AsmStmt::isVolatile ( ) const
inline

Definition at line 3141 of file Stmt.h.

References IsVolatile.

◆ outputs() [1/2]

outputs_range clang::AsmStmt::outputs ( )
inline

Definition at line 3238 of file Stmt.h.

References begin_outputs(), and end_outputs().

Referenced by clang::ento::ExprEngine::VisitGCCAsmStmt().

◆ outputs() [2/2]

outputs_const_range clang::AsmStmt::outputs ( ) const
inline

Definition at line 3250 of file Stmt.h.

References begin_outputs(), and end_outputs().

◆ setAsmLoc()

void clang::AsmStmt::setAsmLoc ( SourceLocation  L)
inline

Definition at line 3136 of file Stmt.h.

References AsmLoc.

◆ setSimple()

void clang::AsmStmt::setSimple ( bool  V)
inline

Definition at line 3139 of file Stmt.h.

References IsSimple, and V.

◆ setVolatile()

void clang::AsmStmt::setVolatile ( bool  V)
inline

Definition at line 3142 of file Stmt.h.

References IsVolatile, and V.

Friends And Related Function Documentation

◆ ASTStmtReader

friend class ASTStmtReader
friend

Definition at line 3107 of file Stmt.h.

Member Data Documentation

◆ AsmLoc

SourceLocation clang::AsmStmt::AsmLoc
protected

◆ Exprs

Stmt** clang::AsmStmt::Exprs = nullptr
protected

◆ IsSimple

bool clang::AsmStmt::IsSimple
protected

True if the assembly statement does not have any input or output operands.

Definition at line 3113 of file Stmt.h.

Referenced by isSimple(), and setSimple().

◆ IsVolatile

bool clang::AsmStmt::IsVolatile
protected

If true, treat this inline assembly as having side effects.

This assembly statement should not be optimized, deleted or moved.

Definition at line 3117 of file Stmt.h.

Referenced by isVolatile(), and setVolatile().

◆ NumClobbers

unsigned clang::AsmStmt::NumClobbers
protected

◆ NumInputs

unsigned clang::AsmStmt::NumInputs
protected

◆ NumOutputs

unsigned clang::AsmStmt::NumOutputs
protected

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