Struct ParsedFile

Source

pub struct ParsedFile { /* private fields */ }

Expand description

An owned typed CST together with the original input.

With the tree-sitter feature, from_source selects that adapter; ParsedFile::from_source_native always selects the direct precedence parser. After parsing, callers may mutate Self::cst_mut or use Self::edit, then project the resulting tree through Self::token_stream or Self::to_source.

The original string is retained as an immutable snapshot for diagnostics. Cell and source-file comment ownership is retained by the typed graph; source-backed layout is recovered from spans during emission.

Implementations§

Source §

impl ParsedFile

Source

pub fn from_source(source: impl Into<String>) -> Result<Self, ParseError>

Parses source with the Tree-sitter adapter.

§Errors

Returns ParseError when Tree-sitter rejects the source or typed migration fails.

Examples found in repository ?

examples/inspect.rs (line 15)

10fn main() -> Result<(), Box<dyn Error>> {
11    let source = match std::env::args_os().nth(1) {
12        Some(path) => fs::read_to_string(path)?,
13        None => SAMPLE.to_owned(),
14    };
15    ParsedFile::from_source(source)?.print_pretty()?;
16    Ok(())
17}

Source

pub fn from_source_native( source: impl Into<String>, ) -> Result<Self, NativeParseError>

Parses source with the native precedence parser.

§Errors

Returns NativeParseError when lexing or native parsing fails.

Source

pub fn original_source(&self) -> &str

Returns the input snapshot exactly as supplied to the parser.

Source

pub fn cst(&self) -> &SourceFile

Borrows the generated typed CST root.

Source

pub fn cst_mut(&mut self) -> &mut SourceFile

Mutably borrows the generated typed CST root.

Source

pub fn edit(self, edit: impl FnOnce(&mut SourceFile)) -> Self

Applies an edit and returns the file for further method chaining.

Source

pub fn into_cst(self) -> SourceFile

Consumes the facade and returns its generated typed CST.

Source

pub fn token_stream(&self) -> TokenStream

Flattens the current CST into one token stream.

Source

pub fn cell_stream(&self) -> CellStream

Projects the current CST as independently parseable cells.

This is the normal macro-facing representation after tokenisation. Use Self::token_stream when a function-like transformation intentionally needs the less structured lexical representation.

Source

pub fn to_source(&self) -> String

Emits the current CST as normalized Macaulay2 source.

Source

pub fn pretty_tokens(&self) -> String

Formats the current raw token representation as a recursively flattened table with explicit group boundaries.

Source

pub fn pretty_cst(&self) -> String

Formats the complete generated typed CST as a Unicode tree.

Source

pub fn pretty_report(&self) -> PrettyReport<'_>

Builds a combined source, flat-token, and typed-CST inspection report.

Source

pub fn print_pretty(&self) -> Result<()>

Prints the combined report to standard output, enabling ANSI styling only when standard output is an interactive terminal.

§Errors

Returns an I/O error when standard output cannot be written.

Examples found in repository ?

examples/inspect.rs (line 15)

10fn main() -> Result<(), Box<dyn Error>> {
11    let source = match std::env::args_os().nth(1) {
12        Some(path) => fs::read_to_string(path)?,
13        None => SAMPLE.to_owned(),
14    };
15    ParsedFile::from_source(source)?.print_pretty()?;
16    Ok(())
17}