Class Stmt::SwitchCase

A C/C++ ‘switch case’ statement.

For example,

case 5:

or

default:

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

getAStmt

Gets a statement belonging under this ‘switch case’ statement.

getChildNum

Gets the 0-based index of this ‘switch case’ statement within its ‘switch’ statement.

getEndExpr

Gets the end of the range, if this is a GNU case range. Otherwise has no result.

getExpr

Gets the expression of this ‘switch case’ statement (or the start of the range if there is a GNU case range). Does not exist for a DefaultCase.

getLabelledStmt

DEPRECATED: use SwitchCase.getAStmt or ControlFlowNode.getASuccessor rather than this predicate.

getLastStmt

Gets the last statement under this ‘switch case’ statement. If the last statement is wrapped in one or more blocks then the result is the last statement in those blocks instead.

getNextSwitchCase

Gets the next SwitchCase belonging to the same ‘switch’ statement, if any.

getPreviousSwitchCase

Gets the previous SwitchCase belonging to the same ‘switch’ statement, if any.

getSwitchStmt

Gets the ‘switch’ statement of this ‘switch case’ statement.

isDefault

Holds if this ‘switch case’ statement is a ‘default’ statement.

mayBeGloballyImpure

Holds if it is possible that this statement is globally impure.

mayBeImpure

Holds if it is possible that this statement is impure. If we are not sure, then it holds.

terminatesInBreakStmt

Holds if the last statement, as determined by getLastStmt, under this ‘switch case’ statement is a ‘break’ statement.

terminatesInReturnStmt

Holds if the last statement, as determined by getLastStmt, under this ‘switch case’ statement is a ‘return’ statement.

terminatesInThrowStmt

Holds if the last statement, as determined by getLastStmt, under this ‘switch case’ statement is a ‘throw’ statement.

toString

Gets a textual representation of this element.

Inherited predicates

findRootCause

Gets the source of this element: either itself or a macro that expanded to this element.

from Element
fromLibrary

Holds if this element may be from a library.

from Element
fromSource

Holds if this element may be from source.

from Element
getAChild

Gets a child of this statement.

from Stmt
getAFalseSuccessor

Gets a node such that the control-flow edge (this, result) may be taken when this expression is false.

from ControlFlowNode
getAPredecessorfrom ControlFlowNode
getASuccessorfrom ControlFlowNode
getATrueSuccessor

Gets a node such that the control-flow edge (this, result) may be taken when this expression is true.

from ControlFlowNode
getAnAttribute

Gets an attribute of this statement, for example [[clang::fallthrough]].

from Stmt
getBasicBlockfrom ControlFlowNode
getChild

Gets the nth child of this statement.

from Stmt
getChildStmt

Gets a child statement of this statement.

from Stmt
getControlFlowScope

Gets the function containing this control-flow node.

from Stmt
getEnclosingBlock

Gets the nearest enclosing block of this statement in the source, if any.

from Stmt
getEnclosingElement

Gets the closest Element enclosing this one.

from Element
getEnclosingFunction

Gets the enclosing function of this statement, if any.

from Stmt
getEnclosingStmt

Gets the smallest statement containing this control-flow node.

from Stmt
getFile

Gets the primary file where this element occurs.

from Element
getFollowingStmt

Gets the statement following this statement in the same block, if any.

from Stmt
getGeneratingMacro

Gets a macro invocation that generates this entire statement.

from Stmt
getKind

Gets an int indicating the type of statement that this represents.

from Stmt
getLocation

Gets the primary location of this element.

from Stmt
getParent

Gets the parent of this statement, if any.

from Stmt
getParentScope

Gets the parent scope of this Element, if any. A scope is a Type (Class / Enum), a Namespace, a Block, a Function, or certain kinds of Statement.

from Element
getParentStmt

Gets the parent statement of this statement, if any.

from Stmt
hasChild

Holds if e is the nth child of this statement.

from Stmt
isAffectedByMacro

Holds if this element is affected in any way by a macro. All elements that are totally or partially generated by a macro are included, so this is a super-set of isInMacroExpansion.

from Element
isCompilerGenerated

Holds if this statement was generated by the compiler.

from Stmt
isCondition

Holds if this node is the top-level expression of a conditional statement, meaning that this.getATrueSuccessor() or this.getAFalseSuccessor() will have a result.

from ControlFlowNode
isFromTemplateInstantiation

Holds if this Element is a part of a template instantiation (but not the template itself).

from Element
isFromUninstantiatedTemplate

Holds if this Element is part of a template template (not if it is part of an instantiation of template). This means it is represented in the database purely as syntax and without guarantees on the presence or correctness of type-based operations such as implicit conversions.

from Element
isInMacroExpansion

Holds if this element comes from a macro expansion. Only elements that are entirely generated by a macro are included - for elements that partially come from a macro, see isAffectedByMacro.

from Element
isPure

Holds if this statement is side-effect free (a conservative approximation; that is, it may be side-effect free even if this predicate doesn’t hold).

from Stmt