factorio-codegen 0.1.2

Lua code generator for factorio-rs
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

mod common;

use common::must_ok;
use factorio_codegen::LuaGenerator;
use factorio_ir::{
    block::Block,
    debug::FunctionDebug,
    expression::Expression,
    function::{Function, Parameter},
    module::{Module, Symbol},
    scope::Scope,
    stage::Stage,
    statement::Statement,
    r#type::Type,
};

#[test]
fn debug_level_one_adds_type_comments_to_functions() {
    let module = Module {
        name: "math_util".to_string(),
        stage: Stage::Control,
        body: Block { statements: vec![] },
        imports: vec![],
        submodules: vec![],
        locales: vec![],
        symbols: vec![Symbol {
            scope: Scope::Public,
            statement: Statement::FunctionDecl(Function {
                name: "add".to_string(),
                params: vec![
                    Parameter {
                        name: "a".to_string(),
                        r#type: Type::Int,
                        source_type: Some("i64".to_string()),
                    },
                    Parameter {
                        name: "b".to_string(),
                        r#type: Type::Int,
                        source_type: Some("i64".to_string()),
                    },
                ],
                body: Block {
                    statements: vec![Statement::Return(Some(Expression::BinaryOp {
                        lhs: Box::new(Expression::Identifier("a".to_string())),
                        op: factorio_ir::operator::Operator::Add,
                        rhs: Box::new(Expression::Identifier("b".to_string())),
                    }))],
                },
                doc: None,
                debug: Some(FunctionDebug {
                    header_comment: "pub fn add(a: i64, b: i64) -> i64".to_string(),
                    return_type: Some("i64".to_string()),
                }),
                event: None,
                event_filter: None,
            }),
        }],
    };

    let output = must_ok(LuaGenerator::with_debug_level(1).generate_module(&module));

    assert!(output.contains("-- pub fn add(a: i64, b: i64) -> i64"));
    assert!(output.contains("function mathUtil.add(a --[[ i64 ]], b --[[ i64 ]]) --[[ -> i64 ]]"));
}

#[test]
fn debug_level_zero_adds_header_without_inline_types() {
    let module = Module {
        name: "math_util".to_string(),
        stage: Stage::Control,
        body: Block { statements: vec![] },
        imports: vec![],
        submodules: vec![],
        locales: vec![],
        symbols: vec![Symbol {
            scope: Scope::Public,
            statement: Statement::FunctionDecl(Function {
                name: "add".to_string(),
                params: vec![
                    Parameter {
                        name: "a".to_string(),
                        r#type: Type::Int,
                        source_type: Some("i64".to_string()),
                    },
                    Parameter {
                        name: "b".to_string(),
                        r#type: Type::Int,
                        source_type: Some("i64".to_string()),
                    },
                ],
                body: Block { statements: vec![] },
                doc: None,
                debug: Some(FunctionDebug {
                    header_comment: "pub fn add(a: i64, b: i64) -> i64".to_string(),
                    return_type: Some("i64".to_string()),
                }),
                event: None,
                event_filter: None,
            }),
        }],
    };

    let output = must_ok(LuaGenerator::with_debug_level(0).generate_module(&module));

    assert!(output.contains("-- pub fn add(a: i64, b: i64) -> i64"));
    assert!(output.contains("function mathUtil.add(a, b)"));
    assert!(!output.contains("--[[ i64 ]]"));
}