Struct SyntaxGraph 

#[non_exhaustive]
pub struct SyntaxGraph {
    pub nodes: BTreeMap<NodeId, SyntaxNode>,
    pub edges: BTreeMap<NodeId, BTreeMap<NodeId, SyntaxEdge>>,
    pub symbol_index: BTreeMap<String, BTreeMap<NodeId, Vec<NodeId>>>,
    pub scope_parent: BTreeMap<NodeId, NodeId>,
    pub sanitization_index: BTreeMap<String, BTreeMap<NodeId, Vec<SanitizationEvent>>>,
    pub usage_index: BTreeMap<String, BTreeMap<NodeId, Vec<UsageEvent>>>,
    pub subpath_index: BTreeMap<NodeId, Option<NodeId>>,
    pub branch_index: BTreeMap<NodeId, Vec<(NodeId, bool)>>,
    pub call_index: BTreeMap<String, Vec<NodeId>>,
    pub nodes_by_type: BTreeMap<SyntaxKind, Vec<NodeId>>,
}

The syntax graph: every parsed node plus the AST and CFG edges between them.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

nodes: BTreeMap<NodeId, SyntaxNode>

Every node, keyed by id.

edges: BTreeMap<NodeId, BTreeMap<NodeId, SyntaxEdge>>

Adjacency: source id -> target id -> which edge kinds connect them.

symbol_index: BTreeMap<String, BTreeMap<NodeId, Vec<NodeId>>>

Symbol name -> scope id -> definition ids in that scope, most recent first.

scope_parent: BTreeMap<NodeId, NodeId>

Scope id -> its enclosing scope’s id.

sanitization_index: BTreeMap<String, BTreeMap<NodeId, Vec<SanitizationEvent>>>

Symbol name -> scope id -> sanitization events recorded for it.

usage_index: BTreeMap<String, BTreeMap<NodeId, Vec<UsageEvent>>>

Symbol name -> scope id -> usage events recorded for it.

subpath_index: BTreeMap<NodeId, Option<NodeId>>

Node id -> the object path id it was built from, when it has one.

branch_index: BTreeMap<NodeId, Vec<(NodeId, bool)>>

Node id -> enclosing (if id, is true branch) pairs, outermost first.

call_index: BTreeMap<String, Vec<NodeId>>

Callee short name -> invocations of it, used to reach a method’s call sites.

nodes_by_type: BTreeMap<SyntaxKind, Vec<NodeId>>

Syntax kind -> ids of every node of that kind, in insertion order.

Implementations

impl SyntaxGraph

pub fn new() -> Self

An empty syntax graph.

pub fn add_node(&mut self, id: NodeId, node: SyntaxNode)

Inserts node under id, indexing it by its syntax kind.

pub fn register_sanitization( &mut self, symbol: &str, scope: NodeId, event: SanitizationEvent, )

Records a sanitization of symbol as seen within scope.

pub fn register_call(&mut self, name: &str, invocation_id: NodeId)

Records that invocation_id calls a callee named name.

pub fn register_usage(&mut self, symbol: &str, scope: NodeId, event: UsageEvent)

Records a use of symbol as seen within scope.

pub fn add_ast_edge(&mut self, from: NodeId, to: NodeId)

Connects from to to with an AST edge, merging into any existing edge.

pub fn add_cfg_edge(&mut self, from: NodeId, to: NodeId)

Connects from to to with a CFG edge, merging into any existing edge.

pub fn finalize_symbol_index(&mut self)

Reverses each scope’s definition list so lookups see the most recent first.

Call once after the graph is fully built; definitions are appended in parse order, which is the opposite of the shadowing order callers need.

pub fn remove_edge(&mut self, from: NodeId, to: NodeId)

Removes the edge from from to to, if one exists.

Trait Implementations

impl Clone for SyntaxGraph

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CodeGraph for SyntaxGraph

fn children(&self, n_id: NodeId) -> Vec<NodeId>

n_id’s children, following both AST and CFG edges.

fn ast_children(&self, n_id: NodeId) -> Vec<NodeId>

n_id’s children, following AST edges only.

fn parents(&self, n_id: NodeId) -> Vec<NodeId>

n_id’s parents, following both AST and CFG edges.

fn ast_parents(&self, n_id: NodeId) -> Vec<NodeId>

n_id’s parents, following AST edges only.

fn cfg_parents(&self, n_id: NodeId) -> Vec<NodeId>

n_id’s parents, following CFG edges only.

fn cfg_children(&self, n_id: NodeId) -> Vec<NodeId>

n_id’s children, following CFG edges only.

fn label_type(&self, n_id: NodeId) -> Option<&str>

n_id’s syntax-kind label, when the graph has one for it.

impl Debug for SyntaxGraph

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

Formats the value using the given formatter.

impl Default for SyntaxGraph

fn default() -> Self

Returns the “default value” for a type.

impl Eq for SyntaxGraph

impl PartialEq for SyntaxGraph

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for SyntaxGraph