CodeQL library for C/C++

codeql/cpp-all 8.0.3 (changelog, source)

Class GuardCondition

A Boolean condition in the AST that guards one or more basic blocks. This includes operands of logical operators but not switch statements.

Import path

import semmle.code.cpp.controlflow.IRGuards

Direct supertypes

Element

Indirect supertypes

Known direct subtypes

Predicates

comparesEq	Holds if (determined by this guard) `e == k` evaluates to `areEqual` if this expression evaluates to `value`. Note that there’s a 4-argument (“unary”) and a 5-argument (“binary”) version of `comparesEq` and they are not equivalent: - the unary version is suitable for guards where there is no expression representing the right-hand side, such as `if (x)`, and also works for equality with an integer constant (such as `if (x == k)`). - the binary version is the more general case for comparison of any expressions (not necessarily integer).
comparesEq	Holds if (determined by this guard) `left == right + k` evaluates to `areEqual` if this expression evaluates to `testIsTrue`. Note that there’s a 4-argument (“unary”) and a 5-argument (“binary”) version of `comparesEq` and they are not equivalent: - the unary version is suitable for guards where there is no expression representing the right-hand side, such as `if (x)`, and also works for equality with an integer constant (such as `if (x == k)`). - the binary version is the more general case for comparison of any expressions (not necessarily integer).
comparesLt	Holds if (determined by this guard) `e < k` evaluates to `isLessThan` if this expression evaluates to `value`. Note that there’s a 4-argument (“unary”) and a 5-argument (“binary”) version of this predicate (see `comparesEq`).
comparesLt	Holds if (determined by this guard) `left < right + k` evaluates to `isLessThan` if this expression evaluates to `testIsTrue`. Note that there’s a 4-argument (“unary”) and a 5-argument (“binary”) version of this predicate (see `comparesEq`).
controls	Holds if this condition controls `controlled`, meaning that `controlled` is only entered if the value of this condition is `testIsTrue`.
controlsEdge	Holds if the control-flow edge `(pred, succ)` may be taken only if this the value of this condition is `testIsTrue`.
ensuresEq	Holds if (determined by this guard) `e == k` must be `areEqual` in `block`. If `areEqual = false` then this implies `e != k`. Note that there’s a 4-argument (“unary”) and a 5-argument (“binary”) version of this predicate (see `comparesEq`).
ensuresEq	Holds if (determined by this guard) `left == right + k` must be `areEqual` in `block`. If `areEqual = false` then this implies `left != right + k`. Note that there’s a 4-argument (“unary”) and a 5-argument (“binary”) version of this predicate (see `comparesEq`).
ensuresEqEdge	Holds if (determined by this guard) `e == k` must be `areEqual` on the edge from `pred` to `succ`. If `areEqual = false` then this implies `e != k`.
ensuresEqEdge	Holds if (determined by this guard) `left == right + k` must be `areEqual` on the edge from `pred` to `succ`. If `areEqual = false` then this implies `left != right + k`.
ensuresLt	Holds if (determined by this guard) `e < k` must be `isLessThan` in `block`. If `isLessThan = false` then this implies `e >= k`. Note that there’s a 4-argument (“unary”) and a 5-argument (“binary”) version of this predicate (see `comparesEq`).
ensuresLt	Holds if (determined by this guard) `left < right + k` must be `isLessThan` in `block`. If `isLessThan = false` then this implies `left >= right + k`. Note that there’s a 4-argument (“unary”) and a 5-argument (“binary”) version of this predicate (see `comparesEq`).
ensuresLtEdge	Holds if (determined by this guard) `e < k` must be `isLessThan` on the edge from `pred` to `succ`. If `isLessThan = false` then this implies `e >= k`.
ensuresLtEdge	Holds if (determined by this guard) `left < right + k` must be `isLessThan` on the edge from `pred` to `succ`. If `isLessThan = false` then this implies `left >= right + k`.
valueControls	Holds if this condition controls `controlled`, meaning that `controlled` is only entered if the value of this condition is `v`.
valueControlsEdge	Holds if the control-flow edge `(pred, succ)` may be taken only if the value of this condition is `v`.

Inherited predicates

findRootCause	Gets the source of this element: either itself or a macro that expanded to this element.	from Element
fromSource	Holds if this element may be from source. This predicate holds for all elements, except for those in the dummy file, whose name is the empty string. The dummy file contains declarations that are built directly into the compiler.	from Element
getAPrimaryQlClass	Gets the name of a primary CodeQL class to which this element belongs.	from ElementBase
getEnclosingElement	Gets the closest `Element` enclosing this one.	from Element
getFile	Gets the primary file where this element occurs.	from Element
getLocation	Gets the primary location of this element.	from Element
getParentScope	Gets the parent scope of this `Element`, if any. A scope is a `Type` (`Class` / `Enum`), a `Namespace`, a `BlockStmt`, a `Function`, or certain kinds of `Statement`.	from Element
getPrimaryQlClasses	Gets a comma-separated list of the names of the primary CodeQL classes to which this element belongs.	from ElementBase
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
isAffectedByMacro	INTERNAL: Do not use.	from Element
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
toString	Gets a textual representation of this element.	from ElementBase