Struct StackGraphLanguage

pub struct StackGraphLanguage { /* private fields */ }

Holds information about how to construct stack graphs for a particular language.

Implementations

impl StackGraphLanguage

pub fn new(language: Language, tsg: File) -> StackGraphLanguage

Creates a new stack graph language for the given language and TSG stack graph construction rules.

pub fn from_str( language: Language, tsg_source: &str, ) -> Result<StackGraphLanguage, LanguageError>

Creates a new stack graph language for the given language, loading the TSG stack graph construction rules from a string. Keeps the source, which can later be used for BuildError::display_pretty.

pub fn from_source( language: Language, tsg_path: PathBuf, tsg_source: &str, ) -> Result<StackGraphLanguage, LanguageError>

Creates a new stack graph language for the given language, loading the TSG stack graph construction rules from the given source. The path is purely for informational purposes, and is not accessed. The source and path are kept, e.g. to use for BuildError::display_pretty.

pub fn set_tsg_info(&mut self, path: PathBuf, source: Cow<'static, str>)

pub fn functions_mut(&mut self) -> &mut Functions

pub fn language(&self) -> &Language

pub fn tsg_path(&self) -> &Path

Returns the original TSG path, if it was provided at construction or set with [set_tsg_info][]. Can be used as input for BuildError::display_pretty.

pub fn tsg_source(&self) -> &Cow<'static, str>

Returns the original TSG source, if it was provided at construction or set with [set_tsg_info][]. Can be used as input for BuildError::display_pretty.

impl StackGraphLanguage

pub fn build_stack_graph_into<'a>( &'a self, stack_graph: &'a mut StackGraph, file: Handle<File>, source: &'a str, globals: &'a Variables<'a>, cancellation_flag: &'a dyn CancellationFlag, ) -> Result<(), BuildError>

Executes the graph construction rules for this language against a source file, creating new nodes and edges in stack_graph. Any new nodes that we create will belong to file. (The source file must be implemented in this language, otherwise you’ll probably get a parse error.)

pub fn builder_into_stack_graph<'a>( &'a self, stack_graph: &'a mut StackGraph, file: Handle<File>, source: &'a str, ) -> Builder<'a>

Create a builder that will execute the graph construction rules for this language against a source file, creating new nodes and edges in stack_graph. Any new nodes created during execution will belong to file. (The source file must be implemented in this language, otherwise you’ll probably get a parse error.)