clang  6.0.0svn
Public Member Functions | Static Public Member Functions | List of all members
clang::SwitchStmt Class Reference

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

 SwitchStmt (const ASTContext &C, Stmt *Init, VarDecl *Var, Expr *cond)
 
 SwitchStmt (EmptyShell Empty)
 Build a empty switch statement. More...
 
VarDeclgetConditionVariable () const
 Retrieve the variable declared in this "switch" statement, if any. More...
 
void setConditionVariable (const ASTContext &C, VarDecl *V)
 
const DeclStmtgetConditionVariableDeclStmt () const
 If this SwitchStmt has a condition variable, return the faux DeclStmt associated with the creation of that condition variable. More...
 
StmtgetInit ()
 
const StmtgetInit () const
 
void setInit (Stmt *S)
 
const ExprgetCond () const
 
const StmtgetBody () const
 
const SwitchCasegetSwitchCaseList () const
 
ExprgetCond ()
 
void setCond (Expr *E)
 
StmtgetBody ()
 
void setBody (Stmt *S)
 
SwitchCasegetSwitchCaseList ()
 
void setSwitchCaseList (SwitchCase *SC)
 Set the case list for this switch statement. More...
 
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 getLocStart () const LLVM_READONLY
 
SourceLocation getLocEnd () 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 getLocStart () const LLVM_READONLY
 
SourceLocation getLocEnd () 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
 
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, 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

- 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
 
   CompoundStmtBitfields   CompoundStmtBits
 
   IfStmtBitfields   IfStmtBits
 
   ExprBitfields   ExprBits
 
   CharacterLiteralBitfields   CharacterLiteralBits
 
   FloatingLiteralBitfields   FloatingLiteralBits
 
   UnaryExprOrTypeTraitExprBitfields   UnaryExprOrTypeTraitExprBits
 
   DeclRefExprBitfields   DeclRefExprBits
 
   CastExprBitfields   CastExprBits
 
   CallExprBitfields   CallExprBits
 
   ExprWithCleanupsBitfields   ExprWithCleanupsBits
 
   PseudoObjectExprBitfields   PseudoObjectExprBits
 
   ObjCIndirectCopyRestoreExprBitfields   ObjCIndirectCopyRestoreExprBits
 
   InitListExprBitfields   InitListExprBits
 
   TypeTraitExprBitfields   TypeTraitExprBits
 
   CoawaitExprBitfields   CoawaitBits
 
}; 
 

Detailed Description

SwitchStmt - This represents a 'switch' stmt.

Definition at line 1007 of file Stmt.h.

Constructor & Destructor Documentation

◆ SwitchStmt() [1/2]

SwitchStmt::SwitchStmt ( const ASTContext C,
Stmt Init,
VarDecl Var,
Expr cond 
)

Definition at line 854 of file Stmt.cpp.

References setConditionVariable().

◆ SwitchStmt() [2/2]

clang::SwitchStmt::SwitchStmt ( EmptyShell  Empty)
inlineexplicit

Build a empty switch statement.

Definition at line 1022 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 1088 of file Stmt.h.

◆ classof()

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

Definition at line 1092 of file Stmt.h.

References clang::Stmt::getStmtClass().

◆ getBody() [1/2]

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

Definition at line 1046 of file Stmt.h.

Referenced by EvaluateSwitch().

◆ getBody() [2/2]

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

Definition at line 1051 of file Stmt.h.

◆ getCond() [1/2]

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

◆ getCond() [2/2]

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

Definition at line 1049 of file Stmt.h.

◆ getConditionVariable()

VarDecl * SwitchStmt::getConditionVariable ( ) const

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 863 of file Stmt.cpp.

References clang::DeclStmt::getSingleDecl().

Referenced by EvaluateSwitch().

◆ getConditionVariableDeclStmt()

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

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

Definition at line 1038 of file Stmt.h.

◆ getInit() [1/2]

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

Definition at line 1042 of file Stmt.h.

Referenced by EvaluateSwitch().

◆ getInit() [2/2]

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

Definition at line 1043 of file Stmt.h.

◆ getLocEnd()

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

Definition at line 1083 of file Stmt.h.

References clang::Stmt::getLocEnd().

◆ getLocStart()

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

Definition at line 1081 of file Stmt.h.

◆ getSwitchCaseList() [1/2]

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

Definition at line 1047 of file Stmt.h.

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

◆ getSwitchCaseList() [2/2]

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

Definition at line 1053 of file Stmt.h.

◆ getSwitchLoc()

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

Definition at line 1058 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 1079 of file Stmt.h.

◆ 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 1075 of file Stmt.h.

◆ setBody() [1/2]

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

Definition at line 1052 of file Stmt.h.

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

◆ setBody() [2/2]

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

Definition at line 1061 of file Stmt.h.

◆ setCond()

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

Definition at line 1050 of file Stmt.h.

◆ setConditionVariable()

void SwitchStmt::setConditionVariable ( const ASTContext C,
VarDecl V 
)

◆ setInit()

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

Definition at line 1044 of file Stmt.h.

◆ setSwitchCaseList()

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

Set the case list for this switch statement.

Definition at line 1056 of file Stmt.h.

◆ setSwitchLoc()

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

Definition at line 1059 of file Stmt.h.


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