salsa/examples/calc/ir.rs

#![allow(clippy::needless_borrow)]

use derive_new::new;
use ordered_float::OrderedFloat;

// ANCHOR: input
#[salsa::input]
pub struct SourceProgram {
    #[return_ref]
    pub text: String,
}
// ANCHOR_END: input

// ANCHOR: interned_ids
#[salsa::interned]
pub struct VariableId<'db> {
    #[return_ref]
    pub text: String,
}

#[salsa::interned]
pub struct FunctionId<'db> {
    #[return_ref]
    pub text: String,
}
// ANCHOR_END: interned_ids

// ANCHOR: program
#[salsa::tracked]
pub struct Program<'db> {
    #[return_ref]
    pub statements: Vec<Statement<'db>>,
}
// ANCHOR_END: program

// ANCHOR: statements_and_expressions
#[derive(Eq, PartialEq, Debug, Hash, new, salsa::Update)]
pub struct Statement<'db> {
    pub span: Span<'db>,

    pub data: StatementData<'db>,
}

#[derive(Eq, PartialEq, Debug, Hash, salsa::Update)]
pub enum StatementData<'db> {
    /// Defines `fn <name>(<args>) = <body>`
    Function(Function<'db>),
    /// Defines `print <expr>`
    Print(Expression<'db>),
}

#[derive(Eq, PartialEq, Debug, Hash, new, salsa::Update)]
pub struct Expression<'db> {
    pub span: Span<'db>,

    pub data: ExpressionData<'db>,
}

#[derive(Eq, PartialEq, Debug, Hash, salsa::Update)]
pub enum ExpressionData<'db> {
    Op(Box<Expression<'db>>, Op, Box<Expression<'db>>),
    Number(OrderedFloat<f64>),
    Variable(VariableId<'db>),
    Call(FunctionId<'db>, Vec<Expression<'db>>),
}

#[derive(Eq, PartialEq, Copy, Clone, Hash, Debug, salsa::Update)]
pub enum Op {
    Add,
    Subtract,
    Multiply,
    Divide,
}
// ANCHOR_END: statements_and_expressions

// ANCHOR: functions
#[salsa::tracked]
pub struct Function<'db> {
    #[id]
    pub name: FunctionId<'db>,

    name_span: Span<'db>,

    #[return_ref]
    pub args: Vec<VariableId<'db>>,

    #[return_ref]
    pub body: Expression<'db>,
}
// ANCHOR_END: functions

#[salsa::tracked]
pub struct Span<'db> {
    pub start: usize,
    pub end: usize,
}

// ANCHOR: diagnostic
#[salsa::accumulator]
#[allow(dead_code)] // Debug impl uses them
#[derive(new)]
pub struct Diagnostic {
    pub start: usize,
    pub end: usize,
    pub message: String,
}
// ANCHOR_END: diagnostic

impl Diagnostic {
    #[cfg(test)]
    pub fn render(&self, db: &dyn crate::Db, src: SourceProgram) -> String {
        use annotate_snippets::*;
        let line_start = src.text(db)[..self.start].lines().count() + 1;
        Renderer::plain()
            .render(
                Level::Error.title(&self.message).snippet(
                    Snippet::source(src.text(db))
                        .line_start(line_start)
                        .origin("input")
                        .annotation(Level::Error.span(self.start..self.end).label("here")),
                ),
            )
            .to_string()
    }
}
Fix clippy issues 2022-08-24 16:43:29 +00:00			`#![allow(clippy::needless_borrow)]`

regular structs for stmt,expr / track span Docs are somewhat out of date. Tracking span should enable re-use of type-check results. 2022-08-19 10:46:54 +00:00			`use derive_new::new;`
entity-based salsa preview 2022-08-01 05:32:47 +00:00			`use ordered_float::OrderedFloat;`

rewrite calc example to use a `salsa::input` 2022-08-03 04:41:36 +00:00			`// ANCHOR: input`
			`#[salsa::input]`
			`pub struct SourceProgram {`
			`#[return_ref]`
Fix field visibilities in `calc-example` 2022-08-31 21:28:01 +00:00			`pub text: String,`
rewrite calc example to use a `salsa::input` 2022-08-03 04:41:36 +00:00			`}`
			`// ANCHOR_END: input`

entity-based salsa preview 2022-08-01 05:32:47 +00:00			`// ANCHOR: interned_ids`
			`#[salsa::interned]`
'db all the things 2024-05-24 01:16:30 +00:00			`pub struct VariableId<'db> {`
entity-based salsa preview 2022-08-01 05:32:47 +00:00			`#[return_ref]`
			`pub text: String,`
			`}`

			`#[salsa::interned]`
'db all the things 2024-05-24 01:16:30 +00:00			`pub struct FunctionId<'db> {`
entity-based salsa preview 2022-08-01 05:32:47 +00:00			`#[return_ref]`
			`pub text: String,`
			`}`
			`// ANCHOR_END: interned_ids`

regular structs for stmt,expr / track span Docs are somewhat out of date. Tracking span should enable re-use of type-check results. 2022-08-19 10:46:54 +00:00			`// ANCHOR: program`
package up the output into a `Program` 2022-08-19 09:53:33 +00:00			`#[salsa::tracked]`
'db all the things 2024-05-24 01:16:30 +00:00			`pub struct Program<'db> {`
regular structs for stmt,expr / track span Docs are somewhat out of date. Tracking span should enable re-use of type-check results. 2022-08-19 10:46:54 +00:00			`#[return_ref]`
'db all the things 2024-05-24 01:16:30 +00:00			`pub statements: Vec<Statement<'db>>,`
package up the output into a `Program` 2022-08-19 09:53:33 +00:00			`}`
regular structs for stmt,expr / track span Docs are somewhat out of date. Tracking span should enable re-use of type-check results. 2022-08-19 10:46:54 +00:00			`// ANCHOR_END: program`
package up the output into a `Program` 2022-08-19 09:53:33 +00:00
regular structs for stmt,expr / track span Docs are somewhat out of date. Tracking span should enable re-use of type-check results. 2022-08-19 10:46:54 +00:00			`// ANCHOR: statements_and_expressions`
fixup calc example 2024-07-17 13:25:04 +00:00			`#[derive(Eq, PartialEq, Debug, Hash, new, salsa::Update)]`
'db all the things 2024-05-24 01:16:30 +00:00			`pub struct Statement<'db> {`
			`pub span: Span<'db>,`
regular structs for stmt,expr / track span Docs are somewhat out of date. Tracking span should enable re-use of type-check results. 2022-08-19 10:46:54 +00:00
'db all the things 2024-05-24 01:16:30 +00:00			`pub data: StatementData<'db>,`
remove support for interned enums It's nicer to just define a struct with a data field. 2022-08-03 07:43:39 +00:00			`}`

fixup calc example 2024-07-17 13:25:04 +00:00			`#[derive(Eq, PartialEq, Debug, Hash, salsa::Update)]`
'db all the things 2024-05-24 01:16:30 +00:00			`pub enum StatementData<'db> {`
entity-based salsa preview 2022-08-01 05:32:47 +00:00			/// Defines `fn <name>(<args>) = <body>`
'db all the things 2024-05-24 01:16:30 +00:00			`Function(Function<'db>),`
entity-based salsa preview 2022-08-01 05:32:47 +00:00			/// Defines `print <expr>`
'db all the things 2024-05-24 01:16:30 +00:00			`Print(Expression<'db>),`
entity-based salsa preview 2022-08-01 05:32:47 +00:00			`}`

wip 2024-07-15 11:46:23 +00:00			`#[derive(Eq, PartialEq, Debug, Hash, new, salsa::Update)]`
'db all the things 2024-05-24 01:16:30 +00:00			`pub struct Expression<'db> {`
			`pub span: Span<'db>,`
regular structs for stmt,expr / track span Docs are somewhat out of date. Tracking span should enable re-use of type-check results. 2022-08-19 10:46:54 +00:00
'db all the things 2024-05-24 01:16:30 +00:00			`pub data: ExpressionData<'db>,`
remove support for interned enums It's nicer to just define a struct with a data field. 2022-08-03 07:43:39 +00:00			`}`

fixup calc example 2024-07-17 13:25:04 +00:00			`#[derive(Eq, PartialEq, Debug, Hash, salsa::Update)]`
'db all the things 2024-05-24 01:16:30 +00:00			`pub enum ExpressionData<'db> {`
			`Op(Box<Expression<'db>>, Op, Box<Expression<'db>>),`
entity-based salsa preview 2022-08-01 05:32:47 +00:00			`Number(OrderedFloat<f64>),`
'db all the things 2024-05-24 01:16:30 +00:00			`Variable(VariableId<'db>),`
			`Call(FunctionId<'db>, Vec<Expression<'db>>),`
entity-based salsa preview 2022-08-01 05:32:47 +00:00			`}`

fixup calc example 2024-07-17 13:25:04 +00:00			`#[derive(Eq, PartialEq, Copy, Clone, Hash, Debug, salsa::Update)]`
entity-based salsa preview 2022-08-01 05:32:47 +00:00			`pub enum Op {`
			`Add,`
			`Subtract,`
			`Multiply,`
			`Divide,`
			`}`
			`// ANCHOR_END: statements_and_expressions`

			`// ANCHOR: functions`
remove `#[salsa::entity]`, and `#[salsa::tracked]` 2022-08-03 13:09:22 +00:00			`#[salsa::tracked]`
'db all the things 2024-05-24 01:16:30 +00:00			`pub struct Function<'db> {`
entity-based salsa preview 2022-08-01 05:32:47 +00:00			`#[id]`
'db all the things 2024-05-24 01:16:30 +00:00			`pub name: FunctionId<'db>,`
regular structs for stmt,expr / track span Docs are somewhat out of date. Tracking span should enable re-use of type-check results. 2022-08-19 10:46:54 +00:00
'db all the things 2024-05-24 01:16:30 +00:00			`name_span: Span<'db>,`
regular structs for stmt,expr / track span Docs are somewhat out of date. Tracking span should enable re-use of type-check results. 2022-08-19 10:46:54 +00:00
wip type-checking, testing need to cleanup this commit 2022-08-19 12:41:58 +00:00			`#[return_ref]`
'db all the things 2024-05-24 01:16:30 +00:00			`pub args: Vec<VariableId<'db>>,`
regular structs for stmt,expr / track span Docs are somewhat out of date. Tracking span should enable re-use of type-check results. 2022-08-19 10:46:54 +00:00
			`#[return_ref]`
'db all the things 2024-05-24 01:16:30 +00:00			`pub body: Expression<'db>,`
entity-based salsa preview 2022-08-01 05:32:47 +00:00			`}`
			`// ANCHOR_END: functions`

regular structs for stmt,expr / track span Docs are somewhat out of date. Tracking span should enable re-use of type-check results. 2022-08-19 10:46:54 +00:00			`#[salsa::tracked]`
'db all the things 2024-05-24 01:16:30 +00:00			`pub struct Span<'db> {`
regular structs for stmt,expr / track span Docs are somewhat out of date. Tracking span should enable re-use of type-check results. 2022-08-19 10:46:54 +00:00			`pub start: usize,`
			`pub end: usize,`
			`}`

entity-based salsa preview 2022-08-01 05:32:47 +00:00			`// ANCHOR: diagnostic`
			`#[salsa::accumulator]`
squelch final warnings 2024-07-19 13:50:00 +00:00			`#[allow(dead_code)] // Debug impl uses them`
wip: accum, privacy for inputs 2024-07-19 11:08:11 +00:00			`#[derive(new)]`
entity-based salsa preview 2022-08-01 05:32:47 +00:00			`pub struct Diagnostic {`
wip type-checking, testing need to cleanup this commit 2022-08-19 12:41:58 +00:00			`pub start: usize,`
			`pub end: usize,`
entity-based salsa preview 2022-08-01 05:32:47 +00:00			`pub message: String,`
			`}`
			`// ANCHOR_END: diagnostic`
extend calc with annotated snippets 2024-07-19 12:46:14 +00:00
			`impl Diagnostic {`
squelch final warnings 2024-07-19 13:50:00 +00:00			`#[cfg(test)]`
extend calc with annotated snippets 2024-07-19 12:46:14 +00:00			`pub fn render(&self, db: &dyn crate::Db, src: SourceProgram) -> String {`
			`use annotate_snippets::*;`
			`let line_start = src.text(db)[..self.start].lines().count() + 1;`
			`Renderer::plain()`
			`.render(`
			`Level::Error.title(&self.message).snippet(`
			`Snippet::source(src.text(db))`
			`.line_start(line_start)`
			`.origin("input")`
			`.annotation(Level::Error.span(self.start..self.end).label("here")),`
			`),`
			`)`
			`.to_string()`
			`}`
			`}`