clang  8.0.0svn
Public Member Functions | Static Public Member Functions | List of all members
clang::SwitchStmt Class Referencefinal

SwitchStmt - This represents a 'switch' stmt. More...

#include "clang/AST/Stmt.h"

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

Public Member Functions

bool hasInitStorage () const
 True if this SwitchStmt has storage for an init statement. More...
 
bool hasVarStorage () const
 True if this SwitchStmt has storage for a condition variable. More...
 
ExprgetCond ()
 
const ExprgetCond () const
 
void setCond (Expr *Cond)
 
StmtgetBody ()
 
const StmtgetBody () const
 
void setBody (Stmt *Body)
 
StmtgetInit ()
 
const StmtgetInit () const
 
void setInit (Stmt *Init)
 
VarDeclgetConditionVariable ()
 Retrieve the variable declared in this "switch" statement, if any. More...
 
const VarDeclgetConditionVariable () const
 
void setConditionVariable (const ASTContext &Ctx, VarDecl *VD)
 Set the condition variable in this switch statement. More...
 
DeclStmtgetConditionVariableDeclStmt ()
 If this SwitchStmt has a condition variable, return the faux DeclStmt associated with the creation of that condition variable. More...
 
const DeclStmtgetConditionVariableDeclStmt () const
 
SwitchCasegetSwitchCaseList ()
 
const SwitchCasegetSwitchCaseList () const
 
void setSwitchCaseList (SwitchCase *SC)
 
SourceLocation getSwitchLoc () const
 
void setSwitchLoc (SourceLocation L)
 
void setBody (Stmt *S, SourceLocation SL)
 
void addSwitchCase (SwitchCase *SC)
 
void setAllEnumCasesCovered ()
 Set a flag in the SwitchStmt indicating that if the 'switch (X)' is a switch over an enum value then all cases have been explicitly covered. More...
 
bool isAllEnumCasesCovered () const
 Returns true if the SwitchStmt is a switch of an enum value and all cases have been explicitly covered. More...
 
SourceLocation getBeginLoc () const
 
SourceLocation getEndLoc () const LLVM_READONLY
 
child_range children ()
 
- 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 SwitchStmtCreate (const ASTContext &Ctx, Stmt *Init, VarDecl *Var, Expr *Cond)
 Create a switch statement. More...
 
static SwitchStmtCreateEmpty (const ASTContext &Ctx, bool HasInit, bool HasVar)
 Create an empty switch statement optionally with storage for an init expression and a condition variable. More...
 
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

- 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 >
 
- Protected Types inherited from clang::Stmt
enum  { NumStmtBits = 8 }
 
enum  { NumExprBits = 17 }
 
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
 
   CharacterLiteralBitfields   CharacterLiteralBits
 
   FloatingLiteralBitfields   FloatingLiteralBits
 
   UnaryExprOrTypeTraitExprBitfields   UnaryExprOrTypeTraitExprBits
 
   DeclRefExprBitfields   DeclRefExprBits
 
   CastExprBitfields   CastExprBits
 
   CallExprBitfields   CallExprBits
 
   ExprWithCleanupsBitfields   ExprWithCleanupsBits
 
   PseudoObjectExprBitfields   PseudoObjectExprBits
 
   OpaqueValueExprBitfields   OpaqueValueExprBits
 
   ObjCIndirectCopyRestoreExprBitfields   ObjCIndirectCopyRestoreExprBits
 
   InitListExprBitfields   InitListExprBits
 
   TypeTraitExprBitfields   TypeTraitExprBits
 
   CoawaitExprBitfields   CoawaitBits
 
}; 
 

Detailed Description

SwitchStmt - This represents a 'switch' stmt.

Definition at line 1448 of file Stmt.h.

Member Function Documentation

◆ addSwitchCase()

void clang::SwitchStmt::addSwitchCase ( SwitchCase SC)
inline

◆ children()

child_range clang::SwitchStmt::children ( )
inline

Definition at line 1613 of file Stmt.h.

◆ classof()

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

Definition at line 1619 of file Stmt.h.

References clang::Stmt::getStmtClass().

◆ Create()

SwitchStmt * SwitchStmt::Create ( const ASTContext Ctx,
Stmt Init,
VarDecl Var,
Expr Cond 
)
static

Create a switch statement.

Definition at line 942 of file Stmt.cpp.

References clang::ASTContext::Allocate().

Referenced by clang::Sema::ActOnStartOfSwitchStmt().

◆ CreateEmpty()

SwitchStmt * SwitchStmt::CreateEmpty ( const ASTContext Ctx,
bool  HasInit,
bool  HasVar 
)
static

Create an empty switch statement optionally with storage for an init expression and a condition variable.

Definition at line 952 of file Stmt.cpp.

References clang::ASTContext::Allocate().

◆ getBeginLoc()

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

Definition at line 1606 of file Stmt.h.

◆ getBody() [1/2]

Stmt* clang::SwitchStmt::getBody ( )
inline

Definition at line 1520 of file Stmt.h.

Referenced by EvaluateSwitch(), and clang::TreeTransform< Derived >::TransformAttr().

◆ getBody() [2/2]

const Stmt* clang::SwitchStmt::getBody ( ) const
inline

Definition at line 1521 of file Stmt.h.

◆ getCond() [1/2]

Expr* clang::SwitchStmt::getCond ( )
inline

◆ getCond() [2/2]

const Expr* clang::SwitchStmt::getCond ( ) const
inline

Definition at line 1512 of file Stmt.h.

◆ getConditionVariable() [1/2]

VarDecl * SwitchStmt::getConditionVariable ( )

Retrieve the variable declared in this "switch" statement, if any.

In the following example, "x" is the condition variable.

switch (int x = foo()) {
case 0: break;
// ...
}

Definition at line 960 of file Stmt.cpp.

References clang::ForStmt::getConditionVariableDeclStmt().

Referenced by EvaluateSwitch(), and clang::TreeTransform< Derived >::TransformAttr().

◆ getConditionVariable() [2/2]

const VarDecl* clang::SwitchStmt::getConditionVariable ( ) const
inline

Definition at line 1555 of file Stmt.h.

◆ getConditionVariableDeclStmt() [1/2]

DeclStmt* clang::SwitchStmt::getConditionVariableDeclStmt ( )
inline

If this SwitchStmt has a condition variable, return the faux DeclStmt associated with the creation of that condition variable.

Definition at line 1565 of file Stmt.h.

◆ getConditionVariableDeclStmt() [2/2]

const DeclStmt* clang::SwitchStmt::getConditionVariableDeclStmt ( ) const
inline

Definition at line 1571 of file Stmt.h.

◆ getEndLoc()

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

Definition at line 1607 of file Stmt.h.

◆ getInit() [1/2]

Stmt* clang::SwitchStmt::getInit ( )
inline

Definition at line 1529 of file Stmt.h.

Referenced by EvaluateSwitch(), and clang::TreeTransform< Derived >::TransformAttr().

◆ getInit() [2/2]

const Stmt* clang::SwitchStmt::getInit ( ) const
inline

Definition at line 1534 of file Stmt.h.

◆ getSwitchCaseList() [1/2]

SwitchCase* clang::SwitchStmt::getSwitchCaseList ( )
inline

Definition at line 1577 of file Stmt.h.

Referenced by clang::Sema::CodeCompleteCase(), and EvaluateSwitch().

◆ getSwitchCaseList() [2/2]

const SwitchCase* clang::SwitchStmt::getSwitchCaseList ( ) const
inline

Definition at line 1578 of file Stmt.h.

◆ getSwitchLoc()

SourceLocation clang::SwitchStmt::getSwitchLoc ( ) const
inline

Definition at line 1581 of file Stmt.h.

Referenced by clang::TreeTransform< Derived >::TransformAttr().

◆ hasInitStorage()

bool clang::SwitchStmt::hasInitStorage ( ) const
inline

True if this SwitchStmt has storage for an init statement.

Definition at line 1503 of file Stmt.h.

◆ hasVarStorage()

bool clang::SwitchStmt::hasVarStorage ( ) const
inline

True if this SwitchStmt has storage for a condition variable.

Definition at line 1506 of file Stmt.h.

◆ isAllEnumCasesCovered()

bool clang::SwitchStmt::isAllEnumCasesCovered ( ) const
inline

Returns true if the SwitchStmt is a switch of an enum value and all cases have been explicitly covered.

Definition at line 1602 of file Stmt.h.

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

◆ setAllEnumCasesCovered()

void clang::SwitchStmt::setAllEnumCasesCovered ( )
inline

Set a flag in the SwitchStmt indicating that if the 'switch (X)' is a switch over an enum value then all cases have been explicitly covered.

Definition at line 1598 of file Stmt.h.

◆ setBody() [1/2]

void clang::SwitchStmt::setBody ( Stmt Body)
inline

Definition at line 1525 of file Stmt.h.

Referenced by clang::Sema::ActOnFinishSwitchStmt().

◆ setBody() [2/2]

void clang::SwitchStmt::setBody ( Stmt S,
SourceLocation  SL 
)
inline

Definition at line 1584 of file Stmt.h.

◆ setCond()

void clang::SwitchStmt::setCond ( Expr Cond)
inline

Definition at line 1516 of file Stmt.h.

◆ setConditionVariable()

void SwitchStmt::setConditionVariable ( const ASTContext Ctx,
VarDecl VD 
)

Set the condition variable in this switch statement.

The switch statement must have storage for it.

Definition at line 967 of file Stmt.cpp.

References clang::SourceRange::getBegin(), clang::SourceRange::getEnd(), clang::VarDecl::getSourceRange(), clang::ForStmt::setBody(), clang::ForStmt::setCond(), clang::ForStmt::setConditionVariable(), clang::Stmt::Stmt(), and clang::Stmt::WhileStmtBits.

◆ setInit()

void clang::SwitchStmt::setInit ( Stmt Init)
inline

Definition at line 1539 of file Stmt.h.

◆ setSwitchCaseList()

void clang::SwitchStmt::setSwitchCaseList ( SwitchCase SC)
inline

Definition at line 1579 of file Stmt.h.

◆ setSwitchLoc()

void clang::SwitchStmt::setSwitchLoc ( SourceLocation  L)
inline

Definition at line 1582 of file Stmt.h.


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