knave 0.14.7

A Lisp programming language for humans and agents that infers types and ownership and compiles to readable Rust
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

use std::rc::Rc;

use rustc_hash::FxHashMap;

use super::problems::{MacroFieldRead, OwnershipProblems};
use crate::core::BindingId;
use crate::diagnostic::Diagnostic;
use crate::types::{
    Borrow, Pipelines, Type, TypedArgument, TypedExpr, TypedExprKind, TypedLeaf, TypedProgram,
    TypedStructExpr,
};

pub struct OwnershipNeeds<'a> {
    program: &'a TypedProgram,
    function_params: &'a FxHashMap<BindingId, Vec<Type>>,
    pipelines: Pipelines<'a>,
    diagnostics: Vec<Diagnostic>,
}

impl<'a> OwnershipNeeds<'a> {
    pub fn new(
        program: &'a TypedProgram,
        function_params: &'a FxHashMap<BindingId, Vec<Type>>,
        pipelines: Pipelines<'a>,
    ) -> Self {
        Self {
            program,
            function_params,
            pipelines,
            diagnostics: Vec::new(),
        }
    }

    pub fn check(mut self, binding: BindingId, value: &TypedExpr) -> Vec<Diagnostic> {
        let current = self.function_params.get(&binding).cloned();
        match &value.kind {
            TypedExprKind::Fn(_) => value
                .children()
                .into_iter()
                .for_each(|child| self.value(child, current.as_deref())),
            _ => self.value(value, current.as_deref()),
        }
        self.diagnostics
    }

    fn value(&mut self, expr: &TypedExpr, current: Option<&[Type]>) {
        match &expr.kind {
            TypedExprKind::Call(callee, arguments) => self.check_arguments(callee, arguments),
            TypedExprKind::Recur(arguments) => self.check_recur(arguments, current),
            _ => {}
        }
        let child_current = match expr.kind {
            TypedExprKind::Fn(_) => None,
            _ => current,
        };
        for child in expr.children() {
            self.value(child, child_current);
        }
    }

    fn check_arguments(&mut self, callee: &TypedExpr, arguments: &[TypedArgument]) {
        let parameters = self.parameters(callee);
        self.check_with_parameters(Some(callee), arguments, &parameters);
    }

    fn check_recur(&mut self, arguments: &[TypedArgument], parameters: Option<&[Type]>) {
        if let Some(parameters) = parameters {
            self.check_with_parameters(None, arguments, parameters);
        }
    }

    fn check_with_parameters(
        &mut self,
        callee: Option<&TypedExpr>,
        arguments: &[TypedArgument],
        parameters: &[Type],
    ) {
        for (position, argument) in arguments.iter().enumerate() {
            let owns = parameters
                .get(position)
                .is_some_and(|parameter| !parameter.is_reference());
            if argument.borrow == Borrow::Passthrough && owns {
                let diagnostic = self.needs_ownership(callee, &argument.value);
                self.diagnostics.push(diagnostic);
            }
        }
    }

    fn needs_ownership(&self, callee: Option<&TypedExpr>, value: &TypedExpr) -> Diagnostic {
        if self.pipelines.is_pipeline(value.ty.referent()) {
            return OwnershipProblems::needs_pipeline_ownership(value.span);
        }
        match self.macro_field_read(callee, value) {
            Some(read) => OwnershipProblems::macro_field_needs_ownership(&read),
            None => OwnershipProblems::needs_ownership(value.span),
        }
    }

    fn macro_field_read(
        &self,
        callee: Option<&TypedExpr>,
        value: &TypedExpr,
    ) -> Option<MacroFieldRead<'a>> {
        let TypedExprKind::Struct(TypedStructExpr::Field(_, label)) = &value.kind else {
            return None;
        };
        let callee = callee.filter(|callee| callee.span != value.span)?;
        let macro_name = self.program.macro_field_reads.get(&value.span)?;
        Some(MacroFieldRead {
            macro_name: Rc::clone(macro_name),
            field: Rc::clone(&label.name),
            field_span: label.span,
            field_type: self.program.show_type(value.ty.referent()),
            callee: self.function_name(callee),
        })
    }

    fn function_name(&self, callee: &TypedExpr) -> Option<&'a str> {
        match callee.kind {
            TypedExprKind::Leaf(TypedLeaf::Global(function) | TypedLeaf::Local(function)) => {
                Some(self.program.bindings.get(function).name())
            }
            _ => None,
        }
    }

    fn parameters(&self, callee: &TypedExpr) -> Vec<Type> {
        if let TypedExprKind::Leaf(TypedLeaf::Global(function) | TypedLeaf::Local(function)) =
            callee.kind
            && let Some(parameters) = self.function_params.get(&function)
        {
            return parameters.clone();
        }
        match &callee.ty {
            Type::Function(_, parameters, _) => parameters.clone(),
            _ => Vec::new(),
        }
    }
}