Skip to main content

factorio_codegen/generator/
expression.rs

1use std::fmt::Write as _;
2
3use factorio_ir::expression::Expression;
4
5use crate::LuaGenerator;
6
7/// Map a Rust prototype struct name to its fixed Factorio `type` discriminant string.
8/// Returns `None` for non-prototype structs.
9fn prototype_lua_type(struct_name: &str) -> Option<&'static str> {
10    match struct_name {
11        "BoolSetting" => Some("bool-setting"),
12        "IntSetting" => Some("int-setting"),
13        "DoubleSetting" => Some("double-setting"),
14        "StringSetting" => Some("string-setting"),
15        _ => None,
16    }
17}
18
19impl LuaGenerator {
20    #[must_use]
21    pub fn generate_expression(&self, expression: &Expression) -> String {
22        self.generate_expression_prec(expression, 0)
23    }
24
25    pub(crate) fn generate_expression_prec(&self, expression: &Expression, min_prec: u8) -> String {
26        match expression {
27            Expression::BinaryOp { lhs, op, rhs } => {
28                // `0 - x` (or `0.0 - x`) is the frontend's encoding of unary negation.
29                // Emit as Lua `-x` directly.
30                let is_zero_lhs = match lhs.as_ref() {
31                    Expression::Literal(factorio_ir::literal::Literal::Int(0)) => true,
32                    Expression::Literal(factorio_ir::literal::Literal::Float(f)) => *f == 0.0,
33                    _ => false,
34                };
35                if matches!(op, factorio_ir::operator::Operator::Sub) && is_zero_lhs {
36                    let rhs_str = self.generate_expression_prec(rhs, 100);
37                    let result = format!("-{rhs_str}");
38                    return if 0 < min_prec {
39                        format!("({result})")
40                    } else {
41                        result
42                    };
43                }
44
45                let prec = Self::operator_precedence(*op);
46                let lhs_str = self.generate_expression_prec(lhs, prec);
47                let rhs_str = self.generate_expression_prec(rhs, prec.saturating_add(1));
48                let result = format!("{} {} {}", lhs_str, Self::generate_operator(*op), rhs_str);
49
50                if prec < min_prec {
51                    format!("({result})")
52                } else {
53                    result
54                }
55            }
56            _ => self.generate_atom(expression),
57        }
58    }
59
60    /// Generate the smallest level of code (an atom).
61    pub(crate) fn generate_atom(&self, expression: &Expression) -> String {
62        match expression {
63            Expression::Literal(literal) => Self::generate_literal(literal),
64            Expression::Identifier(name) => self.generate_identifier(name),
65            Expression::FieldAccess { base, field } => {
66                let base = self.generate_expression(base);
67                format!("{base}.{field}")
68            }
69            Expression::QualifiedPath { segments } => self.generate_qualified_path(segments),
70            Expression::Call { func, args } => self.generate_call(func, args),
71            Expression::MethodCall {
72                receiver,
73                method,
74                args,
75            } => self.generate_method_call(receiver, method, args),
76            Expression::StructLiteral {
77                struct_name,
78                fields,
79            } => self.generate_struct_literal(struct_name.as_deref(), fields),
80            Expression::FormatConcat { parts } => parts
81                .iter()
82                .map(|part| self.generate_expression(part))
83                .collect::<Vec<_>>()
84                .join(" .. "),
85            Expression::Array { elements } => {
86                let elements = elements
87                    .iter()
88                    .map(|element| self.generate_expression(element))
89                    .collect::<Vec<_>>()
90                    .join(", ");
91                format!("{{ {elements} }}")
92            }
93            Expression::Index { base, key } => self.generate_index(base, key),
94            Expression::Not(inner) => self.generate_not(inner),
95            Expression::Len(inner) => {
96                let inner = self.generate_expression(inner);
97                format!("#{inner}")
98            }
99            Expression::If {
100                condition,
101                then_expr,
102                else_expr,
103            } => self.generate_if_expr(condition, then_expr, else_expr),
104            Expression::Closure { params, body } => self.generate_closure(params, body),
105            Expression::BinaryOp { .. } => {
106                unreachable!("binary operators are handled by generate_expression_prec")
107            }
108        }
109    }
110
111    /// Resolve a bare name: exported `pub fn`s become `module.name`, locals stay bare.
112    fn generate_identifier(&self, name: &str) -> String {
113        if self.exported_functions.contains(name)
114            && let Some(module_table) = &self.current_module_table
115        {
116            return format!("{module_table}.{name}");
117        }
118        name.to_string()
119    }
120
121    fn generate_qualified_path(&self, segments: &[String]) -> String {
122        if let Some((struct_name, table_path)) = &self.struct_table_context
123            && segments
124                .first()
125                .is_some_and(|segment| segment == struct_name)
126        {
127            let suffix = segments
128                .get(1..)
129                .map_or_else(String::new, |rest| rest.join("."));
130            if suffix.is_empty() {
131                return table_path.clone();
132            }
133            return format!("{table_path}.{suffix}");
134        }
135
136        segments.join(".")
137    }
138
139    fn generate_call(&self, func: &Expression, args: &[Expression]) -> String {
140        if let Expression::QualifiedPath { segments } = func
141            && args.is_empty()
142            && segments
143                .last()
144                .is_some_and(|s| s == "new" || s == "default")
145        {
146            match segments[0].as_str() {
147                "LuaAny" => return "nil".to_string(),
148                "Vec" if segments.last().is_some_and(|s| s == "new") => {
149                    return "{}".to_string();
150                }
151                _ if segments.last().is_some_and(|s| s == "default") => {
152                    return "{}".to_string();
153                }
154                _ => {}
155            }
156        }
157
158        let func_is_closure = matches!(func, Expression::Closure { .. });
159        let func = self.generate_expression(func);
160        let args = self.generate_arg_list(args);
161        if func_is_closure {
162            format!("({func})({args})")
163        } else {
164            format!("{func}({args})")
165        }
166    }
167
168    fn generate_method_call(
169        &self,
170        receiver: &Expression,
171        method: &str,
172        args: &[Expression],
173    ) -> String {
174        if method == "get" && args.len() == 1 {
175            let receiver = self.generate_expression(receiver);
176            let key = self.generate_expression(&args[0]);
177            return format!("{receiver}[{key}].value");
178        }
179
180        // `storage.set(key, value)` -> `storage[key] = value` (Factorio persistent table).
181        if method == "set" && args.len() == 2 && is_storage_receiver(receiver) {
182            let receiver = self.generate_expression(receiver);
183            let key = self.generate_expression(&args[0]);
184            let value = self.generate_expression(&args[1]);
185            return format!("{receiver}[{key}] = {value}");
186        }
187
188        if method == "len" && args.is_empty() {
189            let receiver = self.generate_expression(receiver);
190            return format!("#{receiver}");
191        }
192
193        if method == "push" && args.len() == 1 {
194            let receiver = self.generate_expression(receiver);
195            let item = self.generate_expression(&args[0]);
196            return format!("table.insert({receiver}, {item})");
197        }
198
199        if method == "is_empty" && args.is_empty() {
200            let receiver = self.generate_expression(receiver);
201            return format!("#{receiver} == 0");
202        }
203
204        let trimmed = trim_trailing_nils(args);
205        if trimmed.is_empty() {
206            let receiver = self.generate_expression(receiver);
207            // Zero-arg API attributes are property reads (`entity.surface`).
208            // Calls that only passed trailing `None`s stay invocations (`entity.die()`).
209            if args.is_empty() {
210                return format!("{receiver}.{method}");
211            }
212            return format!("{receiver}.{method}()");
213        }
214
215        let receiver = self.generate_expression(receiver);
216        let args_lua = self.generate_arg_list(trimmed);
217        format!("{receiver}.{method}({args_lua})")
218    }
219
220    /// Join call arguments, omitting trailing `nil` so Factorio optional params stay unset.
221    fn generate_arg_list(&self, args: &[Expression]) -> String {
222        trim_trailing_nils(args)
223            .iter()
224            .map(|arg| self.generate_expression(arg))
225            .collect::<Vec<_>>()
226            .join(", ")
227    }
228
229    fn generate_struct_literal(
230        &self,
231        struct_name: Option<&str>,
232        fields: &[(String, Expression)],
233    ) -> String {
234        let injected_type = struct_name.and_then(prototype_lua_type);
235        let type_prefix = injected_type.map(|t| format!("type = \"{t}\", "));
236
237        let field_strs = fields
238            .iter()
239            .filter(|(name, value)| {
240                if matches!(
241                    value,
242                    Expression::Literal(factorio_ir::literal::Literal::Nil)
243                ) {
244                    return false;
245                }
246                injected_type.is_none() || (name != "type" && name != "r#type")
247            })
248            .map(|(name, value)| {
249                let lua_name = if name == "r#type" {
250                    "type"
251                } else {
252                    name.as_str()
253                };
254                format!("{lua_name} = {}", self.generate_expression(value))
255            })
256            .collect::<Vec<_>>()
257            .join(", ");
258
259        let inner = match type_prefix {
260            Some(prefix) if !field_strs.is_empty() => format!("{prefix}{field_strs}"),
261            Some(prefix) => prefix.trim_end_matches(", ").to_string(),
262            None => field_strs,
263        };
264        let literal = format!("{{ {inner} }}");
265
266        if let Some((_, table_path)) = &self.struct_table_context {
267            format!("setmetatable({literal}, {{ __index = {table_path} }})")
268        } else {
269            literal
270        }
271    }
272
273    fn generate_index(&self, base: &Expression, key: &Expression) -> String {
274        let base = self.generate_expression(base);
275
276        // Lua is 1-indexed: shift Rust integer literals (`0` -> `1`, `1` -> `2`, ...).
277        // Variable indices are left as-is (callers should use 1-based values).
278        let key = match key {
279            Expression::Literal(factorio_ir::literal::Literal::Int(index)) => {
280                (*index + 1).to_string()
281            }
282            _ => self.generate_expression(key),
283        };
284        format!("{base}[{key}]")
285    }
286
287    fn generate_not(&self, inner: &Expression) -> String {
288        if let Expression::MethodCall {
289            receiver,
290            method,
291            args,
292        } = inner
293            && method == "is_empty"
294            && args.is_empty()
295        {
296            let receiver = self.generate_expression(receiver);
297            return format!("#{receiver} ~= 0");
298        }
299
300        let needs_parens = matches!(inner, Expression::BinaryOp { .. });
301        let inner_str = self.generate_expression(inner);
302        if needs_parens {
303            format!("not ({inner_str})")
304        } else {
305            format!("not {inner_str}")
306        }
307    }
308
309    /// Emit a real Lua if/else inside an IIFE so falsey then-arms stay correct.
310    fn generate_if_expr(
311        &self,
312        condition: &Expression,
313        then_expr: &Expression,
314        else_expr: &Expression,
315    ) -> String {
316        let condition = self.generate_expression(condition);
317        let then_expr = self.generate_expression(then_expr);
318        let else_expr = self.generate_expression(else_expr);
319        format!(
320            "(function() if {condition} then return {then_expr} else return {else_expr} end end)()"
321        )
322    }
323
324    fn generate_closure(&self, params: &[String], body: &factorio_ir::block::Block) -> String {
325        let params = params.join(", ");
326        // Single-statement `return expr` -> compact one-liner.
327        if let [factorio_ir::statement::Statement::Return(Some(expr))] = body.statements.as_slice()
328        {
329            let expr = self.generate_expression(expr);
330            return format!("function({params}) return {expr} end");
331        }
332
333        let mut temp = self.fork_expr_emitter();
334        let _ = writeln!(temp.output, "function({params})");
335        temp.indent_level = 1;
336        let _ = temp.generate_block(body, None);
337        temp.indent_level = 0;
338        temp.write_line("end");
339        // Drop the trailing newline so call-sites can append `)` cleanly.
340        while temp.output.ends_with('\n') {
341            temp.output.pop();
342        }
343        temp.output
344    }
345}
346
347fn is_storage_receiver(receiver: &Expression) -> bool {
348    match receiver {
349        Expression::Identifier(name) => name == "storage",
350        Expression::QualifiedPath { segments } => {
351            segments.last().is_some_and(|name| name == "storage")
352        }
353        _ => false,
354    }
355}
356
357/// Drop trailing `nil` literals from call/method argument lists.
358fn trim_trailing_nils(args: &[Expression]) -> &[Expression] {
359    let mut end = args.len();
360    while end > 0 {
361        match &args[end - 1] {
362            Expression::Literal(factorio_ir::literal::Literal::Nil) => end -= 1,
363            _ => break,
364        }
365    }
366    &args[..end]
367}