1 //! Printing logic for basic blocks of Rust-mapped code - parts of functions and declarations but
2 //! not the full mapping logic.
6 use proc_macro2::{TokenTree, Span};
10 /// Writes out a C++ wrapper class for the given type, which contains various utilities to access
11 /// the underlying C-mapped type safely avoiding some common memory management issues by handling
12 /// resource-freeing and prevending accidental raw copies.
13 pub fn write_cpp_wrapper(cpp_header_file: &mut File, ty: &str, has_destructor: bool) {
14 writeln!(cpp_header_file, "class {} {{", ty).unwrap();
15 writeln!(cpp_header_file, "private:").unwrap();
16 writeln!(cpp_header_file, "\tLDK{} self;", ty).unwrap();
17 writeln!(cpp_header_file, "public:").unwrap();
18 writeln!(cpp_header_file, "\t{}(const {}&) = delete;", ty, ty).unwrap();
19 writeln!(cpp_header_file, "\t{}({}&& o) : self(o.self) {{ memset(&o, 0, sizeof({})); }}", ty, ty, ty).unwrap();
20 writeln!(cpp_header_file, "\t{}(LDK{}&& m_self) : self(m_self) {{ memset(&m_self, 0, sizeof(LDK{})); }}", ty, ty, ty).unwrap();
21 writeln!(cpp_header_file, "\toperator LDK{}() && {{ LDK{} res = self; memset(&self, 0, sizeof(LDK{})); return res; }}", ty, ty, ty).unwrap();
23 writeln!(cpp_header_file, "\t~{}() {{ {}_free(self); }}", ty, ty).unwrap();
24 writeln!(cpp_header_file, "\t{}& operator=({}&& o) {{ {}_free(self); self = o.self; memset(&o, 0, sizeof({})); return *this; }}", ty, ty, ty, ty).unwrap();
26 writeln!(cpp_header_file, "\t{}& operator=({}&& o) {{ self = o.self; memset(&o, 0, sizeof({})); return *this; }}", ty, ty, ty).unwrap();
28 writeln!(cpp_header_file, "\tLDK{}* operator &() {{ return &self; }}", ty).unwrap();
29 writeln!(cpp_header_file, "\tLDK{}* operator ->() {{ return &self; }}", ty).unwrap();
30 writeln!(cpp_header_file, "\tconst LDK{}* operator &() const {{ return &self; }}", ty).unwrap();
31 writeln!(cpp_header_file, "\tconst LDK{}* operator ->() const {{ return &self; }}", ty).unwrap();
32 writeln!(cpp_header_file, "}};").unwrap();
35 /// Writes out a C-callable concrete Result<A, B> struct and utility methods
36 pub fn write_result_block<W: std::io::Write>(w: &mut W, mangled_container: &str, ok_type: &str, err_type: &str, clonable: bool) {
37 writeln!(w, "#[repr(C)]").unwrap();
38 writeln!(w, "pub union {}Ptr {{", mangled_container).unwrap();
40 writeln!(w, "\tpub result: *mut {},", ok_type).unwrap();
42 writeln!(w, "\t/// Note that this value is always NULL, as there are no contents in the OK variant").unwrap();
43 writeln!(w, "\tpub result: *mut std::ffi::c_void,").unwrap();
46 writeln!(w, "\tpub err: *mut {},", err_type).unwrap();
48 writeln!(w, "\t/// Note that this value is always NULL, as there are no contents in the Err variant").unwrap();
49 writeln!(w, "\tpub err: *mut std::ffi::c_void,").unwrap();
51 writeln!(w, "}}").unwrap();
52 writeln!(w, "#[repr(C)]").unwrap();
53 writeln!(w, "pub struct {} {{", mangled_container).unwrap();
54 writeln!(w, "\tpub contents: {}Ptr,", mangled_container).unwrap();
55 writeln!(w, "\tpub result_ok: bool,").unwrap();
56 writeln!(w, "}}").unwrap();
58 writeln!(w, "#[no_mangle]").unwrap();
60 writeln!(w, "pub extern \"C\" fn {}_ok(o: {}) -> {} {{", mangled_container, ok_type, mangled_container).unwrap();
62 writeln!(w, "pub extern \"C\" fn {}_ok() -> {} {{", mangled_container, mangled_container).unwrap();
64 writeln!(w, "\t{} {{", mangled_container).unwrap();
65 writeln!(w, "\t\tcontents: {}Ptr {{", mangled_container).unwrap();
67 writeln!(w, "\t\t\tresult: Box::into_raw(Box::new(o)),").unwrap();
69 writeln!(w, "\t\t\tresult: std::ptr::null_mut(),").unwrap();
71 writeln!(w, "\t\t}},").unwrap();
72 writeln!(w, "\t\tresult_ok: true,").unwrap();
73 writeln!(w, "\t}}").unwrap();
74 writeln!(w, "}}").unwrap();
76 writeln!(w, "#[no_mangle]").unwrap();
78 writeln!(w, "pub extern \"C\" fn {}_err(e: {}) -> {} {{", mangled_container, err_type, mangled_container).unwrap();
80 writeln!(w, "pub extern \"C\" fn {}_err() -> {} {{", mangled_container, mangled_container).unwrap();
82 writeln!(w, "\t{} {{", mangled_container).unwrap();
83 writeln!(w, "\t\tcontents: {}Ptr {{", mangled_container).unwrap();
85 writeln!(w, "\t\t\terr: Box::into_raw(Box::new(e)),").unwrap();
87 writeln!(w, "\t\t\terr: std::ptr::null_mut(),").unwrap();
89 writeln!(w, "\t\t}},").unwrap();
90 writeln!(w, "\t\tresult_ok: false,").unwrap();
91 writeln!(w, "\t}}").unwrap();
92 writeln!(w, "}}").unwrap();
94 writeln!(w, "#[no_mangle]").unwrap();
95 writeln!(w, "pub extern \"C\" fn {}_free(_res: {}) {{ }}", mangled_container, mangled_container).unwrap();
96 writeln!(w, "impl Drop for {} {{", mangled_container).unwrap();
97 writeln!(w, "\tfn drop(&mut self) {{").unwrap();
98 writeln!(w, "\t\tif self.result_ok {{").unwrap();
100 writeln!(w, "\t\t\tif unsafe {{ !(self.contents.result as *mut ()).is_null() }} {{").unwrap();
101 writeln!(w, "\t\t\t\tlet _ = unsafe {{ Box::from_raw(self.contents.result) }};").unwrap();
102 writeln!(w, "\t\t\t}}").unwrap();
104 writeln!(w, "\t\t}} else {{").unwrap();
105 if err_type != "()" {
106 writeln!(w, "\t\t\tif unsafe {{ !(self.contents.err as *mut ()).is_null() }} {{").unwrap();
107 writeln!(w, "\t\t\t\tlet _ = unsafe {{ Box::from_raw(self.contents.err) }};").unwrap();
108 writeln!(w, "\t\t\t}}").unwrap();
110 writeln!(w, "\t\t}}").unwrap();
111 writeln!(w, "\t}}").unwrap();
112 writeln!(w, "}}").unwrap();
114 // TODO: Templates should use () now that they can, too
115 let templ_ok_type = if ok_type != "()" { ok_type } else { "u8" };
116 let templ_err_type = if err_type != "()" { err_type } else { "u8" };
118 writeln!(w, "impl From<crate::c_types::CResultTempl<{}, {}>> for {} {{", templ_ok_type, templ_err_type, mangled_container).unwrap();
119 writeln!(w, "\tfn from(mut o: crate::c_types::CResultTempl<{}, {}>) -> Self {{", templ_ok_type, templ_err_type).unwrap();
120 writeln!(w, "\t\tlet contents = if o.result_ok {{").unwrap();
122 writeln!(w, "\t\t\tlet result = unsafe {{ o.contents.result }};").unwrap();
123 writeln!(w, "\t\t\tunsafe {{ o.contents.result = std::ptr::null_mut() }};").unwrap();
124 writeln!(w, "\t\t\t{}Ptr {{ result }}", mangled_container).unwrap();
126 writeln!(w, "\t\t\tlet _ = unsafe {{ Box::from_raw(o.contents.result) }};").unwrap();
127 writeln!(w, "\t\t\to.contents.result = std::ptr::null_mut();").unwrap();
128 writeln!(w, "\t\t\t{}Ptr {{ result: std::ptr::null_mut() }}", mangled_container).unwrap();
130 writeln!(w, "\t\t}} else {{").unwrap();
131 if err_type != "()" {
132 writeln!(w, "\t\t\tlet err = unsafe {{ o.contents.err }};").unwrap();
133 writeln!(w, "\t\t\tunsafe {{ o.contents.err = std::ptr::null_mut(); }}").unwrap();
134 writeln!(w, "\t\t\t{}Ptr {{ err }}", mangled_container).unwrap();
136 writeln!(w, "\t\t\tlet _ = unsafe {{ Box::from_raw(o.contents.err) }};").unwrap();
137 writeln!(w, "\t\t\to.contents.err = std::ptr::null_mut();").unwrap();
138 writeln!(w, "\t\t\t{}Ptr {{ err: std::ptr::null_mut() }}", mangled_container).unwrap();
140 writeln!(w, "\t\t}};").unwrap();
141 writeln!(w, "\t\tSelf {{").unwrap();
142 writeln!(w, "\t\t\tcontents,").unwrap();
143 writeln!(w, "\t\t\tresult_ok: o.result_ok,").unwrap();
144 writeln!(w, "\t\t}}").unwrap();
145 writeln!(w, "\t}}").unwrap();
146 writeln!(w, "}}").unwrap();
149 writeln!(w, "impl Clone for {} {{", mangled_container).unwrap();
150 writeln!(w, "\tfn clone(&self) -> Self {{").unwrap();
151 writeln!(w, "\t\tif self.result_ok {{").unwrap();
152 writeln!(w, "\t\t\tSelf {{ result_ok: true, contents: {}Ptr {{", mangled_container).unwrap();
154 writeln!(w, "\t\t\t\tresult: Box::into_raw(Box::new(<{}>::clone(unsafe {{ &*self.contents.result }})))", ok_type).unwrap();
156 writeln!(w, "\t\t\t\tresult: std::ptr::null_mut()").unwrap();
158 writeln!(w, "\t\t\t}} }}").unwrap();
159 writeln!(w, "\t\t}} else {{").unwrap();
160 writeln!(w, "\t\t\tSelf {{ result_ok: false, contents: {}Ptr {{", mangled_container).unwrap();
161 if err_type != "()" {
162 writeln!(w, "\t\t\t\terr: Box::into_raw(Box::new(<{}>::clone(unsafe {{ &*self.contents.err }})))", err_type).unwrap();
164 writeln!(w, "\t\t\t\terr: std::ptr::null_mut()").unwrap();
166 writeln!(w, "\t\t\t}} }}").unwrap();
167 writeln!(w, "\t\t}}").unwrap();
168 writeln!(w, "\t}}").unwrap();
169 writeln!(w, "}}").unwrap();
170 writeln!(w, "#[no_mangle]").unwrap();
171 writeln!(w, "pub extern \"C\" fn {}_clone(orig: &{}) -> {} {{ orig.clone() }}", mangled_container, mangled_container, mangled_container).unwrap();
175 /// Writes out a C-callable concrete Vec<A> struct and utility methods
176 pub fn write_vec_block<W: std::io::Write>(w: &mut W, mangled_container: &str, inner_type: &str, clonable: bool) {
177 writeln!(w, "#[repr(C)]").unwrap();
178 writeln!(w, "pub struct {} {{", mangled_container).unwrap();
179 writeln!(w, "\tpub data: *mut {},", inner_type).unwrap();
180 writeln!(w, "\tpub datalen: usize").unwrap();
181 writeln!(w, "}}").unwrap();
183 writeln!(w, "impl {} {{", mangled_container).unwrap();
184 writeln!(w, "\t#[allow(unused)] pub(crate) fn into_rust(&mut self) -> Vec<{}> {{", inner_type).unwrap();
185 writeln!(w, "\t\tif self.datalen == 0 {{ return Vec::new(); }}").unwrap();
186 writeln!(w, "\t\tlet ret = unsafe {{ Box::from_raw(std::slice::from_raw_parts_mut(self.data, self.datalen)) }}.into();").unwrap();
187 writeln!(w, "\t\tself.data = std::ptr::null_mut();").unwrap();
188 writeln!(w, "\t\tself.datalen = 0;").unwrap();
189 writeln!(w, "\t\tret").unwrap();
190 writeln!(w, "\t}}").unwrap();
191 writeln!(w, "\t#[allow(unused)] pub(crate) fn as_slice(&self) -> &[{}] {{", inner_type).unwrap();
192 writeln!(w, "\t\tunsafe {{ std::slice::from_raw_parts_mut(self.data, self.datalen) }}").unwrap();
193 writeln!(w, "\t}}").unwrap();
194 writeln!(w, "}}").unwrap();
196 writeln!(w, "impl From<Vec<{}>> for {} {{", inner_type, mangled_container).unwrap();
197 writeln!(w, "\tfn from(v: Vec<{}>) -> Self {{", inner_type).unwrap();
198 writeln!(w, "\t\tlet datalen = v.len();").unwrap();
199 writeln!(w, "\t\tlet data = Box::into_raw(v.into_boxed_slice());").unwrap();
200 writeln!(w, "\t\tSelf {{ datalen, data: unsafe {{ (*data).as_mut_ptr() }} }}").unwrap();
201 writeln!(w, "\t}}").unwrap();
202 writeln!(w, "}}").unwrap();
204 writeln!(w, "#[no_mangle]").unwrap();
205 writeln!(w, "pub extern \"C\" fn {}_free(_res: {}) {{ }}", mangled_container, mangled_container).unwrap();
206 writeln!(w, "impl Drop for {} {{", mangled_container).unwrap();
207 writeln!(w, "\tfn drop(&mut self) {{").unwrap();
208 writeln!(w, "\t\tif self.datalen == 0 {{ return; }}").unwrap();
209 writeln!(w, "\t\tunsafe {{ Box::from_raw(std::slice::from_raw_parts_mut(self.data, self.datalen)) }};").unwrap();
210 writeln!(w, "\t}}").unwrap();
211 writeln!(w, "}}").unwrap();
213 writeln!(w, "impl Clone for {} {{", mangled_container).unwrap();
214 writeln!(w, "\tfn clone(&self) -> Self {{").unwrap();
215 writeln!(w, "\t\tlet mut res = Vec::new();").unwrap();
216 writeln!(w, "\t\tif self.datalen == 0 {{ return Self::from(res); }}").unwrap();
217 writeln!(w, "\t\tres.extend_from_slice(unsafe {{ std::slice::from_raw_parts_mut(self.data, self.datalen) }});").unwrap();
218 writeln!(w, "\t\tSelf::from(res)").unwrap();
219 writeln!(w, "\t}}").unwrap();
220 writeln!(w, "}}").unwrap();
224 /// Writes out a C-callable concrete (A, B, ...) struct and utility methods
225 pub fn write_tuple_block<W: std::io::Write>(w: &mut W, mangled_container: &str, types: &[String], clonable: bool) {
226 writeln!(w, "#[repr(C)]").unwrap();
227 writeln!(w, "pub struct {} {{", mangled_container).unwrap();
228 for (idx, ty) in types.iter().enumerate() {
229 writeln!(w, "\tpub {}: {},", ('a' as u8 + idx as u8) as char, ty).unwrap();
231 writeln!(w, "}}").unwrap();
233 let mut tuple_str = "(".to_owned();
234 for (idx, ty) in types.iter().enumerate() {
235 if idx != 0 { tuple_str += ", "; }
240 writeln!(w, "impl From<{}> for {} {{", tuple_str, mangled_container).unwrap();
241 writeln!(w, "\tfn from (tup: {}) -> Self {{", tuple_str).unwrap();
242 writeln!(w, "\t\tSelf {{").unwrap();
243 for idx in 0..types.len() {
244 writeln!(w, "\t\t\t{}: tup.{},", ('a' as u8 + idx as u8) as char, idx).unwrap();
246 writeln!(w, "\t\t}}").unwrap();
247 writeln!(w, "\t}}").unwrap();
248 writeln!(w, "}}").unwrap();
249 writeln!(w, "impl {} {{", mangled_container).unwrap();
250 writeln!(w, "\t#[allow(unused)] pub(crate) fn to_rust(mut self) -> {} {{", tuple_str).unwrap();
251 write!(w, "\t\t(").unwrap();
252 for idx in 0..types.len() {
253 write!(w, "{}self.{}", if idx != 0 {", "} else {""}, ('a' as u8 + idx as u8) as char).unwrap();
255 writeln!(w, ")").unwrap();
256 writeln!(w, "\t}}").unwrap();
257 writeln!(w, "}}").unwrap();
260 writeln!(w, "impl Clone for {} {{", mangled_container).unwrap();
261 writeln!(w, "\tfn clone(&self) -> Self {{").unwrap();
262 writeln!(w, "\t\tSelf {{").unwrap();
263 for idx in 0..types.len() {
264 writeln!(w, "\t\t\t{}: self.{}.clone(),", ('a' as u8 + idx as u8) as char, ('a' as u8 + idx as u8) as char).unwrap();
266 writeln!(w, "\t\t}}").unwrap();
267 writeln!(w, "\t}}").unwrap();
268 writeln!(w, "}}").unwrap();
269 writeln!(w, "#[no_mangle]").unwrap();
270 writeln!(w, "pub extern \"C\" fn {}_clone(orig: &{}) -> {} {{ orig.clone() }}", mangled_container, mangled_container, mangled_container).unwrap();
273 write!(w, "#[no_mangle]\npub extern \"C\" fn {}_new(", mangled_container).unwrap();
274 for (idx, gen) in types.iter().enumerate() {
275 write!(w, "{}{}: ", if idx != 0 { ", " } else { "" }, ('a' as u8 + idx as u8) as char).unwrap();
276 //if !self.write_c_type_intern(&mut created_container, gen, generics, false, false, false) { return false; }
277 write!(w, "{}", gen).unwrap();
279 writeln!(w, ") -> {} {{", mangled_container).unwrap();
280 write!(w, "\t{} {{ ", mangled_container).unwrap();
281 for idx in 0..types.len() {
282 write!(w, "{}, ", ('a' as u8 + idx as u8) as char).unwrap();
284 writeln!(w, "}}\n}}\n").unwrap();
286 writeln!(w, "#[no_mangle]").unwrap();
287 writeln!(w, "pub extern \"C\" fn {}_free(_res: {}) {{ }}", mangled_container, mangled_container).unwrap();
290 /// Prints the docs from a given attribute list unless its tagged no export
291 pub fn writeln_docs<W: std::io::Write>(w: &mut W, attrs: &[syn::Attribute], prefix: &str) {
292 for attr in attrs.iter() {
293 let tokens_clone = attr.tokens.clone();
294 let mut token_iter = tokens_clone.into_iter();
295 if let Some(token) = token_iter.next() {
297 TokenTree::Punct(c) if c.as_char() == '=' => {
298 // syn gets '=' from '///' or '//!' as it is syntax for #[doc = ""]
300 TokenTree::Group(_) => continue, // eg #[derive()]
301 _ => unimplemented!(),
305 syn::AttrStyle::Inner(_) => {
306 match token_iter.next().unwrap() {
307 TokenTree::Literal(lit) => {
308 // Drop the first and last chars from lit as they are always "
309 let doc = format!("{}", lit);
310 writeln!(w, "{}//!{}", prefix, &doc[1..doc.len() - 1]).unwrap();
312 _ => unimplemented!(),
315 syn::AttrStyle::Outer => {
316 match token_iter.next().unwrap() {
317 TokenTree::Literal(lit) => {
318 // Drop the first and last chars from lit as they are always "
319 let doc = format!("{}", lit);
320 writeln!(w, "{}///{}", prefix, &doc[1..doc.len() - 1]).unwrap();
322 _ => unimplemented!(),
329 /// Print the parameters in a method declaration, starting after the open parenthesis, through and
330 /// including the closing parenthesis and return value, but not including the open bracket or any
331 /// trailing semicolons.
333 /// Usable both for a function definition and declaration.
335 /// this_param is used when returning Self or accepting a self parameter, and should be the
336 /// concrete, mapped type.
337 pub fn write_method_params<W: std::io::Write>(w: &mut W, sig: &syn::Signature, this_param: &str, types: &mut TypeResolver, generics: Option<&GenericTypes>, self_ptr: bool, fn_decl: bool) {
338 if sig.constness.is_some() || sig.asyncness.is_some() || sig.unsafety.is_some() ||
339 sig.abi.is_some() || sig.variadic.is_some() {
342 if sig.generics.lt_token.is_some() {
343 for generic in sig.generics.params.iter() {
345 syn::GenericParam::Type(_)|syn::GenericParam::Lifetime(_) => {
346 // We ignore these, if they're not on skipped args, we'll blow up
347 // later, and lifetimes we just hope the C client enforces.
349 _ => unimplemented!(),
354 let mut first_arg = true;
355 let mut num_unused = 0;
356 for inp in sig.inputs.iter() {
358 syn::FnArg::Receiver(recv) => {
359 if !recv.attrs.is_empty() || recv.reference.is_none() { unimplemented!(); }
360 write!(w, "this_arg: {}{}",
361 match (self_ptr, recv.mutability.is_some()) {
362 (true, true) => "*mut ",
363 (true, false) => "*const ",
364 (false, true) => "&mut ",
365 (false, false) => "&",
366 }, this_param).unwrap();
370 syn::FnArg::Typed(arg) => {
371 if types.skip_arg(&*arg.ty, generics) { continue; }
372 if !arg.attrs.is_empty() { unimplemented!(); }
373 // First get the c type so that we can check if it ends up being a reference:
374 let mut c_type = Vec::new();
375 types.write_c_type(&mut c_type, &*arg.ty, generics, false);
377 syn::Pat::Ident(ident) => {
378 if !ident.attrs.is_empty() || ident.subpat.is_some() {
381 write!(w, "{}{}{}: ", if first_arg { "" } else { ", " }, if !fn_decl || c_type[0] == '&' as u8 || c_type[0] == '*' as u8 { "" } else { "mut " }, ident.ident).unwrap();
384 syn::Pat::Wild(wild) => {
385 if !wild.attrs.is_empty() { unimplemented!(); }
386 write!(w, "{}unused_{}: ", if first_arg { "" } else { ", " }, num_unused).unwrap();
389 _ => unimplemented!(),
391 w.write(&c_type).unwrap();
395 write!(w, ")").unwrap();
397 syn::ReturnType::Type(_, rtype) => {
398 write!(w, " -> ").unwrap();
399 if let Some(mut remaining_path) = first_seg_self(&*rtype) {
400 if remaining_path.next().is_none() {
401 write!(w, "{}", this_param).unwrap();
405 if let syn::Type::Reference(r) = &**rtype {
406 // We can't return a reference, cause we allocate things on the stack.
407 types.write_c_type(w, &*r.elem, generics, true);
409 types.write_c_type(w, &*rtype, generics, true);
416 /// Print the main part of a method declaration body, starting with a newline after the function
417 /// open bracket and converting each function parameter to or from C-mapped types. Ends with "let
418 /// mut ret = " assuming the next print will be the unmapped Rust function to call followed by the
419 /// parameters we mapped to/from C here.
420 pub fn write_method_var_decl_body<W: std::io::Write>(w: &mut W, sig: &syn::Signature, extra_indent: &str, types: &TypeResolver, generics: Option<&GenericTypes>, to_c: bool) {
421 let mut num_unused = 0;
422 for inp in sig.inputs.iter() {
424 syn::FnArg::Receiver(_) => {},
425 syn::FnArg::Typed(arg) => {
426 if types.skip_arg(&*arg.ty, generics) { continue; }
427 if !arg.attrs.is_empty() { unimplemented!(); }
428 macro_rules! write_new_var {
429 ($ident: expr, $ty: expr) => {
431 if types.write_to_c_conversion_new_var(w, &$ident, &$ty, generics, false) {
432 write!(w, "\n\t{}", extra_indent).unwrap();
435 if types.write_from_c_conversion_new_var(w, &$ident, &$ty, generics) {
436 write!(w, "\n\t{}", extra_indent).unwrap();
442 syn::Pat::Ident(ident) => {
443 if !ident.attrs.is_empty() || ident.subpat.is_some() {
446 write_new_var!(ident.ident, *arg.ty);
448 syn::Pat::Wild(w) => {
449 if !w.attrs.is_empty() { unimplemented!(); }
450 write_new_var!(syn::Ident::new(&format!("unused_{}", num_unused), Span::call_site()), *arg.ty);
453 _ => unimplemented!(),
459 syn::ReturnType::Type(_, _) => {
460 write!(w, "let mut ret = ").unwrap();
466 /// Prints the parameters in a method call, starting after the open parenthesis and ending with a
467 /// final return statement returning the method's result. Should be followed by a single closing
470 /// The return value is expected to be bound to a variable named `ret` which is available after a
471 /// method-call-ending semicolon.
472 pub fn write_method_call_params<W: std::io::Write>(w: &mut W, sig: &syn::Signature, extra_indent: &str, types: &TypeResolver, generics: Option<&GenericTypes>, this_type: &str, to_c: bool) {
473 let mut first_arg = true;
474 let mut num_unused = 0;
475 for inp in sig.inputs.iter() {
477 syn::FnArg::Receiver(recv) => {
478 if !recv.attrs.is_empty() || recv.reference.is_none() { unimplemented!(); }
480 write!(w, "self.this_arg").unwrap();
484 syn::FnArg::Typed(arg) => {
485 if types.skip_arg(&*arg.ty, generics) {
488 write!(w, ", ").unwrap();
491 types.no_arg_to_rust(w, &*arg.ty, generics);
495 if !arg.attrs.is_empty() { unimplemented!(); }
496 macro_rules! write_ident {
499 write!(w, ", ").unwrap();
503 types.write_to_c_conversion_inline_prefix(w, &*arg.ty, generics, false);
504 write!(w, "{}", $ident).unwrap();
505 types.write_to_c_conversion_inline_suffix(w, &*arg.ty, generics, false);
507 types.write_from_c_conversion_prefix(w, &*arg.ty, generics);
508 write!(w, "{}", $ident).unwrap();
509 types.write_from_c_conversion_suffix(w, &*arg.ty, generics);
514 syn::Pat::Ident(ident) => {
515 if !ident.attrs.is_empty() || ident.subpat.is_some() {
518 write_ident!(ident.ident);
520 syn::Pat::Wild(w) => {
521 if !w.attrs.is_empty() { unimplemented!(); }
522 write_ident!(format!("unused_{}", num_unused));
525 _ => unimplemented!(),
530 write!(w, ")").unwrap();
532 syn::ReturnType::Type(_, rtype) => {
533 write!(w, ";\n\t{}", extra_indent).unwrap();
535 let self_segs_iter = first_seg_self(&*rtype);
536 if to_c && first_seg_self(&*rtype).is_some() {
537 // Assume rather blindly that we're returning an associated trait from a C fn call to a Rust trait object.
538 write!(w, "ret").unwrap();
539 } else if !to_c && self_segs_iter.is_some() && self_segs_iter.unwrap().next().is_none() {
540 // If we're returning "Self" (and not "Self::X"), just do it manually
541 write!(w, "{} {{ inner: Box::into_raw(Box::new(ret)), is_owned: true }}", this_type).unwrap();
543 let new_var = types.write_from_c_conversion_new_var(w, &syn::Ident::new("ret", Span::call_site()), rtype, generics);
545 write!(w, "\n\t{}", extra_indent).unwrap();
547 types.write_from_c_conversion_prefix(w, &*rtype, generics);
548 write!(w, "ret").unwrap();
549 types.write_from_c_conversion_suffix(w, &*rtype, generics);
551 let ret_returned = if let syn::Type::Reference(_) = &**rtype { true } else { false };
552 let new_var = types.write_to_c_conversion_new_var(w, &syn::Ident::new("ret", Span::call_site()), &rtype, generics, true);
554 write!(w, "\n\t{}", extra_indent).unwrap();
556 types.write_to_c_conversion_inline_prefix(w, &rtype, generics, true);
557 write!(w, "{}ret", if ret_returned && !new_var { "*" } else { "" }).unwrap();
558 types.write_to_c_conversion_inline_suffix(w, &rtype, generics, true);
565 /// Prints concrete generic parameters for a struct/trait/function, including the less-than and
566 /// greater-than symbols, if any generic parameters are defined.
567 pub fn maybe_write_generics<W: std::io::Write>(w: &mut W, generics: &syn::Generics, types: &TypeResolver, concrete_lifetimes: bool) {
568 let mut gen_types = GenericTypes::new();
569 assert!(gen_types.learn_generics(generics, types));
570 if !generics.params.is_empty() {
571 write!(w, "<").unwrap();
572 for (idx, generic) in generics.params.iter().enumerate() {
574 syn::GenericParam::Type(type_param) => {
575 let mut printed_param = false;
576 for bound in type_param.bounds.iter() {
577 if let syn::TypeParamBound::Trait(trait_bound) = bound {
578 assert_simple_bound(&trait_bound);
579 write!(w, "{}{}", if idx != 0 { ", " } else { "" }, gen_types.maybe_resolve_ident(&type_param.ident).unwrap()).unwrap();
581 unimplemented!("Can't print generic params that have multiple non-lifetime bounds");
583 printed_param = true;
587 syn::GenericParam::Lifetime(lt) => {
588 if concrete_lifetimes {
589 write!(w, "'static").unwrap();
591 write!(w, "{}'{}", if idx != 0 { ", " } else { "" }, lt.lifetime.ident).unwrap();
594 _ => unimplemented!(),
597 write!(w, ">").unwrap();