Struct Context 

pub struct Context {

    pub vars: IndexMap<String, Union>,
    pub assigned_vars: HashSet<String>,
    pub possibly_assigned_vars: HashSet<String>,
    pub self_fqcn: Option<Arc<str>>,
    pub parent_fqcn: Option<Arc<str>>,
    pub static_fqcn: Option<Arc<str>>,
    pub fn_return_type: Option<Union>,
    pub inside_loop: bool,
    pub inside_finally: bool,
    pub inside_constructor: bool,
    pub strict_types: bool,
    pub tainted_vars: HashSet<String>,
    pub read_vars: HashSet<String>,
    pub param_names: HashSet<String>,
    pub diverges: bool,
}

Fields

vars: IndexMap<String, Union>

Types of variables at this point in execution.

assigned_vars: HashSet<String>

Variables that are definitely assigned at this point.

possibly_assigned_vars: HashSet<String>

Variables that might be assigned (e.g. only in one if branch).

self_fqcn: Option<Arc<str>>

The class in whose body we are analysing (self).

parent_fqcn: Option<Arc<str>>

The parent class (parent).

static_fqcn: Option<Arc<str>>

Late-static-binding class (static).

fn_return_type: Option<Union>

Declared return type for the current function/method.

inside_loop: bool

Whether we are currently inside a loop.

inside_finally: bool

Whether we are currently inside a finally block.

inside_constructor: bool

Whether we are inside a constructor.

strict_types: bool

Whether strict_types=1 is declared for this file.

tainted_vars: HashSet<String>

Variables that carry tainted (user-controlled) values at this point. Used by taint analysis (M19).

read_vars: HashSet<String>

Variables that have been read at least once in this scope. Used by UnusedParam detection (M18).

param_names: HashSet<String>

Names of function/method parameters in this scope (stripped of $). Used to exclude parameters from UnusedVariable detection.

diverges: bool

Whether every execution path through this context has diverged (returned, thrown, or exited). Used to detect “all catch branches return” so that variables assigned only in the try body are considered definitely assigned after the try/catch.

Implementations

impl Context

pub fn new() -> Self

pub fn for_function( params: &[FnParam], return_type: Option<Union>, self_fqcn: Option<Arc<str>>, parent_fqcn: Option<Arc<str>>, static_fqcn: Option<Arc<str>>, strict_types: bool, ) -> Self

Create a context seeded with the given parameters.

pub fn for_method( params: &[FnParam], return_type: Option<Union>, self_fqcn: Option<Arc<str>>, parent_fqcn: Option<Arc<str>>, static_fqcn: Option<Arc<str>>, strict_types: bool, inside_constructor: bool, ) -> Self

Like for_function but also sets inside_constructor.

pub fn get_var(&self, name: &str) -> Union

Get the type of a variable. Returns mixed if not found.

pub fn set_var(&mut self, name: impl Into<String>, ty: Union)

Set the type of a variable and mark it as assigned.

pub fn var_is_defined(&self, name: &str) -> bool

Check if a variable is definitely in scope.

pub fn var_possibly_defined(&self, name: &str) -> bool

Check if a variable might be defined (but not certainly).

pub fn taint_var(&mut self, name: &str)

Mark a variable as carrying tainted (user-controlled) data.

pub fn is_tainted(&self, name: &str) -> bool

Returns true if the variable is known to carry tainted data.

pub fn unset_var(&mut self, name: &str)

Remove a variable from the context (after unset).

pub fn fork(&self) -> Context

Fork this context for a branch (e.g. the if branch).

pub fn merge_branches( pre: &Context, if_ctx: Context, else_ctx: Option<Context>, ) -> Context

Merge two branch contexts at a join point (e.g. end of if/else).

• vars present in both: merged union of types
• vars present in only one branch: marked possibly_undefined
• pre-existing vars from before the branch: preserved

Trait Implementations

impl Clone for Context

fn clone(&self) -> Context

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Context

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Context

fn default() -> Self

Returns the “default value” for a type.