CodeQL library for C#
codeql/csharp-all 3.0.2-dev (changelog, source)
Search

Class Guard

An expression whose value may control the execution of another element.

Import path

import semmle.code.csharp.controlflow.Guards

Direct supertypes

Indirect supertypes

Known direct subtypes

    Predicates

    controlsBasicBlock

    Holds if basic block bb is guarded by this expression having value v.

    controlsNode

    Holds if cfn is guarded by this expression having value v.

    controlsNode

    Holds if cfn is guarded by this expression having value v, where sub is a sub expression of this expression that is structurally equal to the expression belonging to cfn.

    getAValue

    Gets a valid value for this guard. For example, if this guard is a test, then it can have Boolean values true and false.

    isEquality

    Holds if this guard is an equality test between e1 and e2. If the test is negated, that is !=, then polarity is false, otherwise polarity is true.

    Inherited predicates

    controlsBlock

    Holds if basic block controlled is controlled by this control flow element with conditional value s. That is, controlled can only be reached from the callable entry point by going via the s edge out of some basic block ending with this element.

    from ControlFlowElement
    fromLibrary

    Holds if this element is from an assembly.

    from Element
    fromSource

    Holds if this element is from source code.

    from Element
    getAChild

    Gets a child of this element, if any.

    from Element
    getAChildExpr

    Gets a child expression of this element, if any.

    from ExprOrStmtParent
    getAChildStmt

    Gets a child statement of this element, if any.

    from ExprOrStmtParent
    getAControlFlowEntryNode

    Gets a first control flow node executed within this element.

    from ControlFlowElement
    getAControlFlowExitNode

    Gets a potential last control flow node executed within this element.

    from ControlFlowElement
    getAControlFlowNode

    Gets a control flow node for this element. That is, a node in the control flow graph that corresponds to this element.

    from ControlFlowElement
    getALocation

    Gets a location of this element, including sources and assemblies.

    from Expr
    getAPrimaryQlClass

    Gets the name of a primary CodeQL class to which this element belongs.

    from Element
    getAReachableElement

    Gets an element that is reachable from this element.

    from ControlFlowElement
    getAnnotatedType

    Gets the annotated type of this expression.

    from Expr
    getAssembly

    Gets the assembly that this element was compiled into.

    from ControlFlowElement
    getChild

    Gets the ith child of this element (zero-based).

    from ExprOrStmtParent
    getChildExpr

    Gets the ith child expression of this element (zero-based).

    from ExprOrStmtParent
    getChildStmt

    Gets the ith child statement of this element (zero-based).

    from ExprOrStmtParent
    getEnclosingCallable

    Gets the enclosing callable of this expression, if any.

    from Expr
    getEnclosingStmt

    Gets the enclosing statement of this expression, if any.

    from Expr
    getExplicitArgumentName

    Gets the explicit parameter name used to pass this expression as an argument for, if any. For example, if this expression is 0 in M(second: 1, first: 0) then the result is "first".

    from Expr
    getFile

    Gets the file containing this element.

    from Element
    getIndex

    Gets the index of this element among its parent’s other children (zero-based).

    from Element
    getLocation

    Gets the location of this element. Where an element has locations in source and assemblies, choose the source location. If there are multiple assembly locations, choose only one.

    from Element
    getNumberOfChildren

    Gets the number of children of this element.

    from Element
    getParent

    Gets the parent of this expression. This is for example the element that uses the result of this expression.

    from Expr
    getPrimaryQlClasses

    Gets a comma-separated list of the names of the primary CodeQL classes to which this element belongs.

    from Element
    getType

    Gets the type of this expression.

    from Expr
    getValue

    Gets the value of this expression, if any

    from Expr
    hasMaybeNullFlowState

    Holds if the nullable flow state of this expression may be null.

    from Expr
    hasNotNullFlowState

    Holds if the nullable flow state of this expression is not null.

    from Expr
    hasValue

    Holds if this expression has a value.

    from Expr
    isImplicit

    Holds if this expression is generated by the compiler and does not appear explicitly in the source code.

    from Expr
    isLive

    Holds if this element is live, that is this element can be reached from the entry point of its enclosing callable.

    from ControlFlowElement
    reachableFrom

    Holds if the current element is reachable from src.

    from ControlFlowElement
    stripCasts

    Gets an expression that is the result of stripping (recursively) all implicit and explicit casts from this expression, if any. For example, the result is reader if this expression is either (IDisposable)reader or reader as IDisposable.

    from Expr
    stripImplicitCasts

    Gets an expression that is the result of stripping (recursively) all implicit casts from this expression, if any.

    from Expr
    toString

    Gets a textual representation of this element.

    from Element
    toStringWithTypes

    Gets the full textual representation of this element, including type information.

    from Element

    Charpred