linguini-ir 0.1.0-alpha.4

Intermediate representation and lowering for Linguini
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

use crate::model::{
    IrExpression, IrFunctionBranch, IrFunctionBranchValue, IrModule, IrText, IrTextPart,
};
use std::collections::{BTreeMap, BTreeSet};

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct IrReferenceError {
    pub message: String,
}

pub fn ensure_no_unresolved_references(
    schema: &IrModule,
    locale: &IrModule,
) -> Result<(), Vec<IrReferenceError>> {
    let context = ReferenceContext::new(schema, locale);
    let mut errors = Vec::new();
    let variables: BTreeSet<_> = locale
        .variables
        .iter()
        .map(|variable| variable.name.clone())
        .collect();

    for message in &locale.messages {
        let Some(parameters) = context.message_parameters.get(&message.name) else {
            errors.push(IrReferenceError {
                message: format!("unresolved message `{}`", message.name),
            });
            continue;
        };
        if let Some(body) = &message.body {
            let variables = variables
                .iter()
                .cloned()
                .chain(parameters.iter().cloned())
                .collect();
            check_text(body, &variables, &context, &mut errors);
        }
    }

    for variable in &locale.variables {
        check_text(&variable.value, &variables, &context, &mut errors);
    }

    for function in &locale.functions {
        let variables: BTreeSet<_> = variables
            .iter()
            .cloned()
            .chain(
                function
                    .parameters
                    .iter()
                    .filter_map(|parameter| parameter.name.clone()),
            )
            .collect();
        for branch in &function.branches {
            check_function_branch(branch, &variables, &context, &mut errors);
        }
    }

    if errors.is_empty() {
        Ok(())
    } else {
        Err(errors)
    }
}

fn check_function_branch(
    branch: &IrFunctionBranch,
    variables: &BTreeSet<String>,
    context: &ReferenceContext,
    errors: &mut Vec<IrReferenceError>,
) {
    match &branch.value {
        IrFunctionBranchValue::Text(text) => check_text(text, variables, context, errors),
        IrFunctionBranchValue::Dispatch(branches) => {
            for branch in branches {
                check_function_branch(branch, variables, context, errors);
            }
        }
    }
}

struct ReferenceContext {
    message_parameters: BTreeMap<String, BTreeSet<String>>,
    functions: BTreeSet<String>,
    forms: BTreeSet<String>,
    variables: BTreeSet<String>,
}

impl ReferenceContext {
    fn new(schema: &IrModule, locale: &IrModule) -> Self {
        Self {
            message_parameters: schema
                .messages
                .iter()
                .map(|message| {
                    (
                        message.name.clone(),
                        message
                            .parameters
                            .iter()
                            .map(|parameter| parameter.name.clone())
                            .collect(),
                    )
                })
                .collect(),
            functions: locale
                .functions
                .iter()
                .map(|function| function.name.clone())
                .collect(),
            forms: locale.forms.iter().map(|form| form.name.clone()).collect(),
            variables: locale
                .variables
                .iter()
                .map(|variable| variable.name.clone())
                .collect(),
        }
    }
}

fn check_text(
    text: &IrText,
    variables: &BTreeSet<String>,
    context: &ReferenceContext,
    errors: &mut Vec<IrReferenceError>,
) {
    for part in &text.parts {
        if let IrTextPart::Placeholder(expression) = part {
            check_expression(expression, variables, context, errors);
        }
    }
}

fn check_expression(
    expression: &IrExpression,
    variables: &BTreeSet<String>,
    context: &ReferenceContext,
    errors: &mut Vec<IrReferenceError>,
) {
    let Some(root) = expression.path.first() else {
        errors.push(IrReferenceError {
            message: "unresolved empty expression".to_owned(),
        });
        return;
    };

    let resolved = variables.contains(root)
        || context.forms.contains(root)
        || context.functions.contains(root)
        || context.variables.contains(root)
        || root == "plural";

    if !resolved {
        errors.push(IrReferenceError {
            message: format!("unresolved reference `{}`", expression.path.join(".")),
        });
    }

    for argument in &expression.arguments {
        check_expression(argument, variables, context, errors);
    }
}