factorio-codegen 0.1.8

Lua code generator for the factorio-rs Rust-to-Lua Factorio mod toolchain
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

mod common;

use common::must_ok;
use factorio_codegen::LuaGenerator;
use factorio_ir::{
    block::Block,
    function::Function,
    module::{ImportedItem, Module, ModuleImport, Symbol},
    scope::Scope,
    stage::Stage,
    statement::Statement,
};

#[test]
fn generates_require_statements() {
    let module = Module {
        name: "on_init".to_string(),
        stage: Stage::Control,
        body: Block { statements: vec![] },
        imports: vec![ModuleImport {
            module: "player".to_string(),
            local: "player".to_string(),
            items: vec![ImportedItem {
                name: "MyPlayer".to_string(),
                local: "MyPlayer".to_string(),
            }],
            factorio_mod: None,
            module_root: None,
        }],
        submodules: vec![],
        locales: vec![],
        pending_locales: vec![],
        symbols: vec![Symbol {
            scope: Scope::Public,
            statement: Statement::FunctionDecl(Function {
                name: "on_init".to_string(),
                params: vec![],
                body: Block { statements: vec![] },
                doc: None,
                debug: None,
                event: None,
                event_filter: None,
                export: None,
            }),
        }],
    };

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

    assert_eq!(
        output,
        concat!(
            "-- Generated by factorio-rs@",
            env!("CARGO_PKG_VERSION"),
            "\n-- Module: `on_init`\n",
            "local player = require(\"__mod__/lua/player\")\n",
            "local MyPlayer = player.MyPlayer\n",
            "\n",
            "local onInit = {}\n",
            "function onInit.on_init()\n",
            "end\n",
            "return onInit\n",
        )
    );
}

#[test]
fn generates_foreign_require_statements() {
    let module = Module {
        name: "on_init".to_string(),
        stage: Stage::Control,
        body: Block { statements: vec![] },
        imports: vec![ModuleImport {
            module: "shared.api".to_string(),
            local: "shared_api".to_string(),
            items: vec![ImportedItem {
                name: "greet".to_string(),
                local: "greet".to_string(),
            }],
            factorio_mod: Some("provider".to_string()),
            module_root: Some("lua".to_string()),
        }],
        submodules: vec![],
        locales: vec![],
        pending_locales: vec![],
        symbols: vec![],
    };

    let output = must_ok(LuaGenerator::with_mod_name("consumer").generate_module(&module));

    assert!(output.contains("local shared_api = require(\"__provider__/lua/shared/api\")"));
    assert!(output.contains("local greet = shared_api.greet"));
}

#[test]
fn generates_foreign_require_with_empty_module_root() {
    let module = Module {
        name: "on_init".to_string(),
        stage: Stage::Control,
        body: Block { statements: vec![] },
        imports: vec![ModuleImport {
            module: "gui".to_string(),
            local: "gui".to_string(),
            items: vec![],
            factorio_mod: Some("flib".to_string()),
            module_root: Some(String::new()),
        }],
        submodules: vec![],
        locales: vec![],
        pending_locales: vec![],
        symbols: vec![],
    };

    let output = must_ok(LuaGenerator::with_mod_name("consumer").generate_module(&module));
    assert!(output.contains("local gui = require(\"__flib__/gui\")"));
}