knave-expand 0.13.2

The reading, scoping and expansion stages of knave
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

use super::Expander;
use super::context::DefinitionContext;
use super::problems::ExpandProblems;
use super::rest_of_body::RestOfBody;
use super::shape::Shape;
use crate::core::{
    BindingKind, Block, BodyItem, Control, ControlForm, DefinitionForm, Expr, ExprKind,
    ExpressionForm, KernelForm, Namespace,
};
use crate::diagnostic::Diagnostic;
use crate::reader::Form;
use crate::source::Span;

impl Expander<'_> {
    pub(super) const DEF_FORM: KernelForm = KernelForm::Definition(DefinitionForm::Def);
    pub(super) const STRUCT_FORM: KernelForm = KernelForm::Definition(DefinitionForm::Struct);
    pub(super) const DO_FORM: KernelForm =
        KernelForm::Expression(ExpressionForm::Control(ControlForm::Do));

    pub(super) fn lower_misplaced_def(
        &mut self,
        form: &Form,
        rest_of_body: &mut RestOfBody,
        context: &DefinitionContext,
    ) -> Result<BodyItem, Diagnostic> {
        let misplaced = self.misplaced_definition(Self::DEF_FORM, form.span());
        let Some((binder, value)) = Self::misplaced_def_parts(form) else {
            return Err(misplaced);
        };
        self.keep_recovered(misplaced)?;
        let scope = self.fresh_local_scope();
        rest_of_body.add_scope(scope);
        let binder = self.lower_binder(&Self::scoped(binder, scope), Some(context))?;
        let value = match value {
            Some(value) => self.lower_misplaced_value(&Self::scoped(value, scope))?,
            None => Self::placeholder(form.span()),
        };
        Ok(BodyItem::Let(binder, value))
    }

    pub(super) fn misplaced_definition(&self, kernel: KernelForm, span: Span) -> Diagnostic {
        let origin = self.tables.macro_origins.get(span);
        let written_definer = origin.as_ref().map_or(kernel.name(), |origin| &origin.name);
        ExpandProblems::module_level_only(written_definer, span)
    }

    fn misplaced_def_parts(form: &Form) -> Option<(&Form, Option<&Form>)> {
        let (binder, value) = match form.as_list()? {
            [_, binder] => (binder, None),
            [_, binder, value, ..] => (binder, Some(value)),
            _ => return None,
        };
        Self::split_binder(binder).0.as_symbol()?;
        Some((binder, value))
    }

    fn lower_misplaced_value(&mut self, value: &Form) -> Result<Expr, Diagnostic> {
        if self.is_kernel_form(value, KernelForm::Macro) {
            return Ok(Self::placeholder(value.span()));
        }
        self.lower_recovered(value)
    }

    pub(super) fn lower_misplaced_struct(
        &mut self,
        form: &Form,
        rest_of_body: &mut RestOfBody,
        context: &DefinitionContext,
    ) -> Result<BodyItem, Diagnostic> {
        let misplaced = self.misplaced_definition(Self::STRUCT_FORM, form.span());
        let shape = Shape::new(Self::STRUCT_FORM, form);
        let Some(name) = shape
            .at_least(2)
            .ok()
            .and_then(|items| self.head_name(&shape, &items[1]).ok())
        else {
            return Err(misplaced);
        };
        self.keep_recovered(misplaced)?;
        let scope = self.fresh_local_scope();
        rest_of_body.add_scope(scope);
        let module = self
            .current_module
            .expect("a body expands while a module expands");
        let scoped_name = Self::scoped(name, scope);
        self.define_local(
            &scoped_name,
            Namespace::Type,
            BindingKind::Struct(module),
            Some(context),
        )?;
        Ok(BodyItem::Expr(Self::placeholder(form.span())))
    }

    pub(super) fn holds_definition(&self, form: &Form) -> bool {
        form.as_list().unwrap_or_default()[1..]
            .iter()
            .any(|item| matches!(self.kernel_head(item), Some(KernelForm::Definition(_))))
    }

    pub(super) fn lower_spliced_do(
        &mut self,
        form: &Form,
        rest_of_body: &mut RestOfBody,
        context: &mut DefinitionContext,
    ) -> Result<BodyItem, Diagnostic> {
        let forms = &form.as_list().unwrap_or_default()[1..];
        let items = self.lower_body_items(&mut rest_of_body.splice(forms), context)?;
        let block = ExprKind::Control(Control::Block(Block { items }));
        Ok(BodyItem::Expr(Expr::new(block, form.span())))
    }
}