Struct ParsedFile 

pub struct ParsedFile { /* private fields */ }

An owned typed CST together with the source identity and original input.

ParsedFile::from_source selects the Tree-sitter adapter, while ParsedFile::from_source_native 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, Self::cell_stream, or Self::to_source.

The original string is retained as an immutable snapshot for diagnostics. Current emission is normalized by ToTokens; it will become lossless as trivia ownership is completed in the typed graph.

Implementations

impl ParsedFile

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

Parses source with the Tree-sitter adapter and a fresh source identity.

Examples found in repository

examples/inspect.rs (line 15)

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

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

Parses source with the Tree-sitter adapter and an explicit source id.

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

Parses source with the native precedence parser and a fresh source identity.

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

Parses source with the native precedence parser and an explicit source id.

pub fn original_source(&self) -> &str

Returns the input snapshot exactly as supplied to the parser.

pub fn source_id(&self) -> SourceId

Returns the source identity attached to parsed spans.

pub fn cst(&self) -> &SourceFile

Borrows the generated typed CST root.

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

Mutably borrows the generated typed CST root.

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

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

pub fn into_cst(self) -> SourceFile

Consumes the facade and returns its generated typed CST.

pub fn token_stream(&self) -> TokenStream

Flattens the current CST into one token stream.

pub fn cell_stream(&self) -> CellStream

Flattens the current CST into its linearly ordered cells.

pub fn to_source(&self) -> String

Emits the current CST as normalized Macaulay2 source.

pub fn pretty_tokens(&self) -> String

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

pub fn pretty_cst(&self) -> String

Formats the complete generated typed CST as a Unicode tree.

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

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

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

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

Examples found in repository

examples/inspect.rs (line 15)

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

Trait Implementations

impl AsMut<SourceFile> for ParsedFile

fn as_mut(&mut self) -> &mut SourceFile

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<SourceFile> for ParsedFile

fn as_ref(&self) -> &SourceFile

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for ParsedFile

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

Formats the value using the given formatter.

impl Display for ParsedFile

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

Formats the value using the given formatter.

impl Spanned for ParsedFile

fn span(&self) -> Span

impl ToCells for ParsedFile

fn to_cells(&self, output: &mut CellStream)

Appends this value’s global cells to output.

fn to_cell_stream(&self, source_id: SourceId) -> CellStream

Emits this value into a fresh cell stream with the requested identity.

impl ToTokens for ParsedFile

fn to_tokens(&self, output: &mut TokenStream)

fn to_token_stream(&self) -> TokenStream

fn to_m2(&self) -> String

fn to_code(&self) -> String