cairo-lang-parser 2.20.0-rc.0

use cairo_lang_diagnostics::{Diagnostics, DiagnosticsBuilder, Maybe, ToMaybe};
use cairo_lang_filesystem::db::FilesGroup;
use cairo_lang_filesystem::ids::{FileId, FileKind};
use cairo_lang_syntax::node::ast::{Expr, StatementList, SyntaxFile};
use cairo_lang_syntax::node::{SyntaxNode, TypedSyntaxNode};
use salsa::Database;

use crate::diagnostic::ParserDiagnostic;
use crate::parser::Parser;

#[cfg(test)]
#[path = "db_test.rs"]
mod db_test;

/// Interface of the parser database.
pub trait ParserGroup: Database {
    /// Parses a file and returns its AST as a root SyntaxNode.
    fn file_syntax<'db>(&'db self, file_id: FileId<'db>) -> Maybe<SyntaxNode<'db>> {
        file_syntax(self.as_dyn_database(), file_id)
    }

    /// Parses a file and returns its AST as a root SyntaxFile.
    fn file_module_syntax<'db>(&'db self, file_id: FileId<'db>) -> Maybe<SyntaxFile<'db>> {
        file_module_syntax(self.as_dyn_database(), file_id)
    }
    /// Parses a file and returns its AST as an expression. Only used for inline macros expanded
    /// code.
    fn file_expr_syntax<'db>(&'db self, file_id: FileId<'db>) -> Maybe<Expr<'db>> {
        file_expr_syntax(self.as_dyn_database(), file_id)
    }
    /// Parses a file and returns its AST as a list of statements. Only used for inline macros
    /// expanded code.
    fn file_statement_list_syntax<'db>(
        &'db self,
        file_id: FileId<'db>,
    ) -> Maybe<StatementList<'db>> {
        file_statement_list_syntax(self.as_dyn_database(), file_id)
    }
    /// Returns the parser diagnostics for this file.
    fn file_syntax_diagnostics<'db>(
        &'db self,
        file_id: FileId<'db>,
    ) -> &'db Diagnostics<'db, ParserDiagnostic<'db>> {
        file_syntax_diagnostics(self.as_dyn_database(), file_id)
    }
}

impl<T: Database + ?Sized> ParserGroup for T {}

#[salsa::tracked]
struct SyntaxData<'db> {
    diagnostics: Diagnostics<'db, ParserDiagnostic<'db>>,
    syntax: Maybe<SyntaxNode<'db>>,
}

/// Parses a file and returns the result and the generated [ParserDiagnostic].
#[salsa::tracked(returns(ref))]
fn file_syntax_data<'db>(db: &'db dyn Database, file_id: FileId<'db>) -> SyntaxData<'db> {
    let mut diagnostics = DiagnosticsBuilder::default();
    let syntax = db.file_content(file_id).to_maybe().map(|s| {
        let green = match file_id.kind(db) {
            FileKind::Module => Parser::parse_file_green(db, &mut diagnostics, file_id, s).0,
            FileKind::Expr => Parser::parse_file_expr_green(db, &mut diagnostics, file_id, s).0,
            FileKind::StatementList => {
                Parser::parse_file_statement_list_green(db, &mut diagnostics, file_id, s).0
            }
        };
        // Seed the canonical root from this file-keyed query (not a green-keyed detached
        // constructor), so reparsing a changed file reuses the previous node ids. This keeps
        // stable ptrs (and ids derived from them) stable across edits, which early cutoff
        // downstream relies on. This is the *only* place a canonical root is created; every other
        // consumer reaches it via `db.file_syntax(file_id)`.
        SyntaxNode::new_canonical_root(db, file_id, green)
    });
    SyntaxData::new(db, diagnostics.build(), syntax)
}

/// Parses a file and returns its SyntaxNode.
#[salsa::tracked]
fn file_syntax<'db>(db: &'db dyn Database, file_id: FileId<'db>) -> Maybe<SyntaxNode<'db>> {
    file_syntax_data(db, file_id).syntax(db)
}

/// Parses a file and returns its AST as a root SyntaxFile.
/// Requires `file_id.kind()` to be `FileKind::Module`.
fn file_module_syntax<'db>(db: &'db dyn Database, file_id: FileId<'db>) -> Maybe<SyntaxFile<'db>> {
    assert_eq!(file_id.kind(db), FileKind::Module, "file_id must be a module");
    Ok(SyntaxFile::from_syntax_node(db, file_syntax(db, file_id)?))
}

/// Parses a file and returns its AST as an expression. Only used for inline macros expanded code.
/// Requires `file_id.kind()` to be `FileKind::Expr`.
fn file_expr_syntax<'db>(db: &'db dyn Database, file_id: FileId<'db>) -> Maybe<Expr<'db>> {
    assert_eq!(file_id.kind(db), FileKind::Expr, "file_id must be an expr");
    Ok(Expr::from_syntax_node(db, file_syntax(db, file_id)?))
}

/// Parses a file and returns its AST as a list of statements. Only used for inline macros
/// expanded code.
/// Requires `file_id.kind()` to be `FileKind::StatementList`.
fn file_statement_list_syntax<'db>(
    db: &'db dyn Database,
    file_id: FileId<'db>,
) -> Maybe<StatementList<'db>> {
    assert_eq!(file_id.kind(db), FileKind::StatementList, "file_id must be a statement list");
    Ok(StatementList::from_syntax_node(db, file_syntax(db, file_id)?))
}

#[salsa::tracked(returns(ref))]
fn file_syntax_diagnostics<'db>(
    db: &'db dyn Database,
    file_id: FileId<'db>,
) -> Diagnostics<'db, ParserDiagnostic<'db>> {
    file_syntax_data(db, file_id).diagnostics(db)
}