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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
use proc_macro2::TokenStream;
use quote::{format_ident, quote};
pub mod api;
mod class_docs;
mod classes;
pub mod dependency;
mod documentation;
mod methods;
mod special_methods;
pub use crate::api::*;
pub use crate::class_docs::*;
use crate::classes::*;
pub use crate::dependency::*;
use crate::documentation::*;
use crate::methods::*;
use crate::special_methods::*;
use std::collections::HashMap;
use std::io;
pub type GeneratorResult<T = ()> = Result<T, io::Error>;
pub struct BindingResult {
pub class_bindings: HashMap<String, TokenStream>,
pub icalls: TokenStream,
}
pub fn generate_bindings(api: &Api, docs: Option<&GodotXMLDocs>) -> BindingResult {
let mut icalls = HashMap::new();
let class_bindings = api
.classes
.iter()
.map(|class| {
(
class.name.clone(),
generate_class_bindings(&api, class, &mut icalls, docs),
)
})
.collect();
let icalls = icalls
.into_iter()
.map(|(name, sig)| generate_icall(name, sig))
.collect();
BindingResult {
class_bindings,
icalls,
}
}
pub fn generate_imports() -> TokenStream {
quote! {
use std::os::raw::c_char;
use std::ptr;
use std::mem;
}
}
fn generate_class_bindings(
api: &Api,
class: &GodotClass,
icalls: &mut HashMap<String, MethodSig>,
docs: Option<&GodotXMLDocs>,
) -> TokenStream {
let types_and_methods = {
let documentation = generate_class_documentation(&api, class);
let class_struct = generate_class_struct(class);
let enums = generate_enums(class);
let constants = if !class.constants.is_empty() {
generate_class_constants(class)
} else {
Default::default()
};
let class_impl = generate_class_impl(class, icalls, docs);
quote! {
#documentation
#class_struct
#enums
#constants
#class_impl
}
};
let traits = {
let object_impl = generate_godot_object_impl(class);
let free_impl = generate_queue_free_impl(&api, class);
let base_class = if !class.base_class.is_empty() {
generate_deref_impl(class)
} else {
Default::default()
};
let sub_class = generate_sub_class_impls(&api, class);
let instantiable = if class.instantiable {
generate_instantiable_impl(class)
} else {
Default::default()
};
let send_sync = if class.singleton && class.is_singleton_thread_safe() {
generate_send_sync_impls(class)
} else {
Default::default()
};
quote! {
#object_impl
#free_impl
#base_class
#sub_class
#instantiable
#send_sync
}
};
let method_table = if class.instantiable || !class.methods.is_empty() {
generate_method_table(&api, class)
} else {
Default::default()
};
quote! {
#types_and_methods
#traits
#method_table
}
}
fn rust_safe_name(name: &str) -> proc_macro2::Ident {
match name {
"use" => format_ident!("_use"),
"type" => format_ident!("_type"),
"loop" => format_ident!("_loop"),
"in" => format_ident!("_in"),
"override" => format_ident!("_override"),
"where" => format_ident!("_where"),
name => format_ident!("{}", name),
}
}
#[cfg(feature = "debug")]
#[cfg(test)]
pub(crate) mod test_prelude {
use super::*;
use std::io::{BufWriter, Write};
macro_rules! validate_and_clear_buffer {
($buffer:ident) => {
$buffer.flush().unwrap();
let content = std::str::from_utf8($buffer.get_ref()).unwrap();
if syn::parse_file(&content).is_err() {
let mut code_file = std::env::temp_dir();
code_file.set_file_name("bad_code.rs");
std::fs::write(&code_file, &content).unwrap();
panic!(
"Could not parse generated code. Check {}",
code_file.display()
);
}
$buffer.get_mut().clear();
};
}
#[test]
fn sanity_test_generated_code() {
let api = Api::new(include_str!("../../gdnative-bindings/api.json"));
let mut buffer = BufWriter::new(Vec::with_capacity(16384));
for class in &api.classes {
let mut icalls = HashMap::new();
let code = generate_class_documentation(&api, &class);
write!(&mut buffer, "{}", code).unwrap();
write!(&mut buffer, "{}", quote! { struct Docs {} }).unwrap();
validate_and_clear_buffer!(buffer);
let code = generate_class_struct(&class);
write!(&mut buffer, "{}", code).unwrap();
validate_and_clear_buffer!(buffer);
let code = generate_enums(&class);
write!(&mut buffer, "{}", code).unwrap();
validate_and_clear_buffer!(buffer);
if !class.constants.is_empty() {
let code = generate_class_constants(&class);
write!(&mut buffer, "{}", code).unwrap();
validate_and_clear_buffer!(buffer);
}
let code = generate_class_impl(&class, &mut icalls, None);
write!(&mut buffer, "{}", code).unwrap();
validate_and_clear_buffer!(buffer);
let code = generate_godot_object_impl(&class);
write!(&mut buffer, "{}", code).unwrap();
validate_and_clear_buffer!(buffer);
let code = generate_queue_free_impl(&api, &class);
write!(&mut buffer, "{}", code).unwrap();
validate_and_clear_buffer!(buffer);
if !class.base_class.is_empty() {
let code = generate_deref_impl(&class);
write!(&mut buffer, "{}", code).unwrap();
validate_and_clear_buffer!(buffer);
}
if class.instantiable {
let code = generate_instantiable_impl(&class);
write!(&mut buffer, "{}", code).unwrap();
validate_and_clear_buffer!(buffer);
}
let code = generate_method_table(&api, &class);
write!(&mut buffer, "{}", code).unwrap();
validate_and_clear_buffer!(buffer);
for (name, sig) in icalls {
let code = generate_icall(name, sig);
write!(&mut buffer, "{}", code).unwrap();
validate_and_clear_buffer!(buffer);
}
}
}
}