clang  8.0.0svn
Public Types | Public Member Functions | Static Public Member Functions | List of all members
clang::DeclStmt Class Reference

DeclStmt - Adaptor class for mixing declarations with statements and expressions. More...

#include "clang/AST/Stmt.h"

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

Public Types

using decl_iterator = DeclGroupRef::iterator
 
using const_decl_iterator = DeclGroupRef::const_iterator
 
using decl_range = llvm::iterator_range< decl_iterator >
 
using decl_const_range = llvm::iterator_range< const_decl_iterator >
 
using reverse_decl_iterator = std::reverse_iterator< decl_iterator >
 
- Public Types inherited from clang::Stmt
enum  StmtClass { NoStmtClass = 0 }
 
using child_iterator = StmtIterator
 Child Iterators: All subclasses must implement 'children' to permit easy iteration over the substatements/subexpessions of an AST node. More...
 
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

 DeclStmt (DeclGroupRef dg, SourceLocation startLoc, SourceLocation endLoc)
 
 DeclStmt (EmptyShell Empty)
 Build an empty declaration statement. More...
 
bool isSingleDecl () const
 isSingleDecl - This method returns true if this DeclStmt refers to a single Decl. More...
 
const DeclgetSingleDecl () const
 
DeclgetSingleDecl ()
 
const DeclGroupRef getDeclGroup () const
 
DeclGroupRef getDeclGroup ()
 
void setDeclGroup (DeclGroupRef DGR)
 
void setStartLoc (SourceLocation L)
 
SourceLocation getEndLoc () const
 
void setEndLoc (SourceLocation L)
 
SourceLocation getBeginLoc () const LLVM_READONLY
 
child_range children ()
 
decl_range decls ()
 
decl_const_range decls () const
 
decl_iterator decl_begin ()
 
decl_iterator decl_end ()
 
const_decl_iterator decl_begin () const
 
const_decl_iterator decl_end () const
 
reverse_decl_iterator decl_rbegin ()
 
reverse_decl_iterator decl_rend ()
 
- Public Member Functions inherited from clang::Stmt
void * operator new (size_t bytes, const ASTContext &C, unsigned alignment=8)
 
void * operator new (size_t bytes, const ASTContext *C, unsigned alignment=8)
 
void * operator new (size_t bytes, void *mem) noexcept
 
void operator delete (void *, const ASTContext &, unsigned) noexcept
 
void operator delete (void *, const ASTContext *, unsigned) noexcept
 
void operator delete (void *, size_t) noexcept
 
void operator delete (void *, void *) noexcept
 
 Stmt (StmtClass SC)
 
StmtClass getStmtClass () const
 
const char * getStmtClassName () const
 
SourceRange getSourceRange () const LLVM_READONLY
 SourceLocation tokens are not useful in isolation - they are low level value objects created/interpreted by SourceManager. More...
 
SourceLocation getBeginLoc () const LLVM_READONLY
 
SourceLocation getEndLoc () const LLVM_READONLY
 
void dump () const
 Dumps the specified AST fragment and all subtrees to llvm::errs(). More...
 
void dump (SourceManager &SM) const
 
void dump (raw_ostream &OS, SourceManager &SM) const
 
void dump (raw_ostream &OS) const
 
int64_t getID (const ASTContext &Context) const
 
void dumpColor () const
 dumpColor - same as dump(), but forces color highlighting. More...
 
void dumpPretty (const ASTContext &Context) const
 dumpPretty/printPretty - These two methods do a "pretty print" of the AST back to its original source language syntax. More...
 
void printPretty (raw_ostream &OS, PrinterHelper *Helper, const PrintingPolicy &Policy, unsigned Indentation=0, StringRef NewlineSymbol="\, const ASTContext *Context=nullptr) const
 
void viewAST () const
 viewAST - Visualize an AST rooted at this Stmt* using GraphViz. More...
 
StmtIgnoreImplicit ()
 Skip past any implicit AST nodes which might surround this statement, such as ExprWithCleanups or ImplicitCastExpr nodes. More...
 
const StmtIgnoreImplicit () const
 
StmtIgnoreContainers (bool IgnoreCaptured=false)
 Skip no-op (attributed, compound) container stmts and skip captured stmt at the top, if IgnoreCaptured is true. More...
 
const StmtIgnoreContainers (bool IgnoreCaptured=false) const
 
const StmtstripLabelLikeStatements () const
 Strip off all label-like statements. More...
 
StmtstripLabelLikeStatements ()
 
child_range children ()
 
const_child_range children () const
 
child_iterator child_begin ()
 
child_iterator child_end ()
 
const_child_iterator child_begin () const
 
const_child_iterator child_end () const
 
void Profile (llvm::FoldingSetNodeID &ID, const ASTContext &Context, bool Canonical) const
 Produce a unique representation of the given statement. More...
 
void ProcessODRHash (llvm::FoldingSetNodeID &ID, ODRHash &Hash) const
 Calculate a unique representation for a statement that is stable across compiler invocations. More...
 

Static Public Member Functions

static 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 ()
 

Additional Inherited Members

- Protected Types inherited from clang::Stmt
enum  { NumStmtBits = 8 }
 
enum  { NumExprBits = NumStmtBits + 9 }
 
enum  APFloatSemantics {
  IEEEhalf, IEEEsingle, IEEEdouble, x87DoubleExtended,
  IEEEquad, PPCDoubleDouble
}
 
- Protected Member Functions inherited from clang::Stmt
void * operator new (size_t bytes) noexcept
 
void operator delete (void *data) noexcept
 
 Stmt (StmtClass SC, EmptyShell)
 Construct an empty statement. More...
 
- Protected Attributes inherited from clang::Stmt
union {
   StmtBitfields   StmtBits
 
   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
 
   PredefinedExprBitfields   PredefinedExprBits
 
   DeclRefExprBitfields   DeclRefExprBits
 
   FloatingLiteralBitfields   FloatingLiteralBits
 
   StringLiteralBitfields   StringLiteralBits
 
   CharacterLiteralBitfields   CharacterLiteralBits
 
   UnaryOperatorBitfields   UnaryOperatorBits
 
   UnaryExprOrTypeTraitExprBitfields   UnaryExprOrTypeTraitExprBits
 
   ArraySubscriptExprBitfields   ArraySubscriptExprBits
 
   CallExprBitfields   CallExprBits
 
   MemberExprBitfields   MemberExprBits
 
   CastExprBitfields   CastExprBits
 
   BinaryOperatorBitfields   BinaryOperatorBits
 
   InitListExprBitfields   InitListExprBits
 
   ParenListExprBitfields   ParenListExprBits
 
   PseudoObjectExprBitfields   PseudoObjectExprBits
 
   CXXBoolLiteralExprBitfields   CXXBoolLiteralExprBits
 
   CXXNullPtrLiteralExprBitfields   CXXNullPtrLiteralExprBits
 
   CXXThisExprBitfields   CXXThisExprBits
 
   CXXThrowExprBitfields   CXXThrowExprBits
 
   CXXDefaultArgExprBitfields   CXXDefaultArgExprBits
 
   CXXDefaultInitExprBitfields   CXXDefaultInitExprBits
 
   CXXDeleteExprBitfields   CXXDeleteExprBits
 
   TypeTraitExprBitfields   TypeTraitExprBits
 
   ExprWithCleanupsBitfields   ExprWithCleanupsBits
 
   CoawaitExprBitfields   CoawaitBits
 
   ObjCIndirectCopyRestoreExprBitfields   ObjCIndirectCopyRestoreExprBits
 
   OpaqueValueExprBitfields   OpaqueValueExprBits
 
}; 
 

Detailed Description

DeclStmt - Adaptor class for mixing declarations with statements and expressions.

For example, CompoundStmt mixes statements, expressions and declarations (variables, types). Another example is ForStmt, where the first statement can be an expression or a declaration.

Definition at line 923 of file Stmt.h.

Member Typedef Documentation

◆ const_decl_iterator

Definition at line 962 of file Stmt.h.

◆ decl_const_range

Definition at line 964 of file Stmt.h.

◆ decl_iterator

Definition at line 961 of file Stmt.h.

◆ decl_range

using clang::DeclStmt::decl_range = llvm::iterator_range<decl_iterator>

Definition at line 963 of file Stmt.h.

◆ reverse_decl_iterator

using clang::DeclStmt::reverse_decl_iterator = std::reverse_iterator<decl_iterator>

Definition at line 977 of file Stmt.h.

Constructor & Destructor Documentation

◆ DeclStmt() [1/2]

clang::DeclStmt::DeclStmt ( DeclGroupRef  dg,
SourceLocation  startLoc,
SourceLocation  endLoc 
)
inline

Definition at line 928 of file Stmt.h.

◆ DeclStmt() [2/2]

clang::DeclStmt::DeclStmt ( EmptyShell  Empty)
inlineexplicit

Build an empty declaration statement.

Definition at line 932 of file Stmt.h.

Member Function Documentation

◆ children()

child_range clang::DeclStmt::children ( )
inline

Definition at line 956 of file Stmt.h.

References clang::DeclGroupRef::begin(), and clang::DeclGroupRef::end().

◆ classof()

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

Definition at line 951 of file Stmt.h.

References clang::Stmt::getStmtClass().

◆ decl_begin() [1/2]

decl_iterator clang::DeclStmt::decl_begin ( )
inline

Definition at line 972 of file Stmt.h.

References clang::DeclGroupRef::begin().

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

◆ decl_begin() [2/2]

const_decl_iterator clang::DeclStmt::decl_begin ( ) const
inline

Definition at line 974 of file Stmt.h.

References clang::DeclGroupRef::begin().

◆ decl_end() [1/2]

decl_iterator clang::DeclStmt::decl_end ( )
inline

Definition at line 973 of file Stmt.h.

References clang::DeclGroupRef::end().

◆ decl_end() [2/2]

const_decl_iterator clang::DeclStmt::decl_end ( ) const
inline

Definition at line 975 of file Stmt.h.

References clang::DeclGroupRef::end().

◆ decl_rbegin()

reverse_decl_iterator clang::DeclStmt::decl_rbegin ( )
inline

Definition at line 979 of file Stmt.h.

◆ decl_rend()

reverse_decl_iterator clang::DeclStmt::decl_rend ( )
inline

Definition at line 983 of file Stmt.h.

◆ decls() [1/2]

decl_range clang::DeclStmt::decls ( )
inline

◆ decls() [2/2]

decl_const_range clang::DeclStmt::decls ( ) const
inline

Definition at line 968 of file Stmt.h.

◆ getBeginLoc()

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

Definition at line 949 of file Stmt.h.

Referenced by CheckConstexprDeclStmt(), and findBlockLocations().

◆ getDeclGroup() [1/2]

const DeclGroupRef clang::DeclStmt::getDeclGroup ( ) const
inline

Definition at line 941 of file Stmt.h.

Referenced by buildFakeCtorCall().

◆ getDeclGroup() [2/2]

DeclGroupRef clang::DeclStmt::getDeclGroup ( )
inline

Definition at line 942 of file Stmt.h.

◆ getEndLoc()

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

Definition at line 946 of file Stmt.h.

◆ getSingleDecl() [1/2]

const Decl* clang::DeclStmt::getSingleDecl ( ) const
inline

◆ getSingleDecl() [2/2]

Decl* clang::DeclStmt::getSingleDecl ( )
inline

Definition at line 939 of file Stmt.h.

References clang::DeclGroupRef::getSingleDecl().

◆ isSingleDecl()

bool clang::DeclStmt::isSingleDecl ( ) const
inline

isSingleDecl - This method returns true if this DeclStmt refers to a single Decl.

Definition at line 936 of file Stmt.h.

References clang::DeclGroupRef::isSingleDecl().

Referenced by clang::CFG::addSyntheticDeclStmt(), clang::ento::ExprEngine::VisitDeclStmt(), and clang::consumed::ConsumedStmtVisitor::VisitDeclStmt().

◆ setDeclGroup()

void clang::DeclStmt::setDeclGroup ( DeclGroupRef  DGR)
inline

Definition at line 943 of file Stmt.h.

◆ setEndLoc()

void clang::DeclStmt::setEndLoc ( SourceLocation  L)
inline

Definition at line 947 of file Stmt.h.

◆ setStartLoc()

void clang::DeclStmt::setStartLoc ( SourceLocation  L)
inline

Definition at line 945 of file Stmt.h.


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