rusteal-codegen 0.8.0

Code generator: UHT JSON to Rust bindings and C++ wrappers for rusteal
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

use std::collections::BTreeMap;

use crate::context::FuncEntry;
use crate::cpp_gen::wrapper::cpp_wrapper_name;

pub fn generate_fill_table(
    prefix: &str,
    entries: &[FuncEntry],
    _by_class: &BTreeMap<(String, String), Vec<&FuncEntry>>,
) -> String {
    let mut out = String::with_capacity(entries.len() * 80 + 1024);

    out.push_str("// Auto-generated by rusteal-codegen. Do not edit.\n\n");
    out.push_str("#include \"RustealFuncIds.h\"\n\n");

    out.push_str("// Forward declarations of wrapper functions\n");

    for entry in entries {
        let c_name = cpp_wrapper_name(prefix, &entry.class_name, &entry.func_name);
        out.push_str(&format!("extern \"C\" uint32_t {c_name}(...);\n"));
    }

    out.push('\n');

    out.push_str("static void* GRustealFuncTable[RustealFuncId::FUNC_COUNT];\n\n");

    out.push_str(&format!("void {prefix}RustealFillFuncTable() {{\n"));

    for entry in entries {
        let const_name =
            crate::rust_gen::func_ids::func_id_const_name(&entry.class_name, &entry.func_name);

        let c_name = cpp_wrapper_name(prefix, &entry.class_name, &entry.func_name);

        out.push_str(&format!(
            "    GRustealFuncTable[RustealFuncId::{const_name}] = (void*)&{c_name};\n"
        ));
    }

    out.push_str("}\n\n");

    out.push_str(&format!("void** {prefix}RustealGetFuncTable() {{\n"));
    out.push_str("    return GRustealFuncTable;\n");
    out.push_str("}\n\n");

    out.push_str(&format!(
        "uint32_t {prefix}RustealGetFuncCount() {{\n    return RustealFuncId::FUNC_COUNT;\n}}\n"
    ));

    out
}

#[cfg(test)]
mod tests {
    use super::*;

    fn entry(func_id: u32, class_name: &str, func_name: &str) -> FuncEntry {
        let func = serde_json::from_value(serde_json::json!({
            "name": func_name,
            "func_flags": 0,
        }))
        .unwrap();

        FuncEntry {
            func_id,
            module_name: "engine".to_string(),
            class_name: class_name.to_string(),
            func_name: func_name.to_string(),
            rust_func_name: func_name.to_string(),
            func,
            cpp_class_name: format!("A{class_name}"),
            header: String::new(),
        }
    }

    #[test]
    fn game_library_keeps_the_unprefixed_names() {
        let code = generate_fill_table("", &[entry(0, "Actor", "GetOwner")], &BTreeMap::new());
        assert!(code.contains("void RustealFillFuncTable()"), "{code}");
        assert!(code.contains("void** RustealGetFuncTable()"), "{code}");
        assert!(code.contains("uint32_t RustealGetFuncCount()"), "{code}");
        assert!(code.contains("= (void*)&Rusteal_Actor_GetOwner;"), "{code}");
    }

    #[test]
    fn plugin_library_prefixes_every_symbol() {
        let code = generate_fill_table(
            "Inventory_",
            &[entry(0, "Actor", "GetOwner")],
            &BTreeMap::new(),
        );

        assert!(
            code.contains("extern \"C\" uint32_t Inventory_Rusteal_Actor_GetOwner(...);"),
            "{code}"
        );

        assert!(
            code.contains("void Inventory_RustealFillFuncTable()"),
            "{code}"
        );

        assert!(
            code.contains("void** Inventory_RustealGetFuncTable()"),
            "{code}"
        );

        assert!(
            code.contains("uint32_t Inventory_RustealGetFuncCount()"),
            "{code}"
        );

        assert!(!code.contains(" RustealFillFuncTable()"), "{code}");
    }
}