_ Git - ldk-c-bindings/blob - c-bindings-gen/src/blocks.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE>
   5 // or the MIT license <LICENSE-MIT>, at your option.
   6 // You may not use this file except in accordance with one or both of these
   7 // licenses.
   8
   9 //! Printing logic for basic blocks of Rust-mapped code - parts of functions and declarations but
  10 //! not the full mapping logic.
  11
  12 use std::fs::File;
  13 use std::io::Write;
  14 use proc_macro2::{TokenTree, Span};
  15
  16 use crate::types::*;
  17
  18 /// Writes out a C++ wrapper class for the given type, which contains various utilities to access
  19 /// the underlying C-mapped type safely avoiding some common memory management issues by handling
  20 /// resource-freeing and prevending accidental raw copies.
  21 pub fn write_cpp_wrapper(cpp_header_file: &mut File, ty: &str, has_destructor: bool) {
  22         writeln!(cpp_header_file, "class {} {{", ty).unwrap();
  23         writeln!(cpp_header_file, "private:").unwrap();
  24         writeln!(cpp_header_file, "\tLDK{} self;", ty).unwrap();
  25         writeln!(cpp_header_file, "public:").unwrap();
  26         writeln!(cpp_header_file, "\t{}(const {}&) = delete;", ty, ty).unwrap();
  27         writeln!(cpp_header_file, "\t{}({}&& o) : self(o.self) {{ memset(&o, 0, sizeof({})); }}", ty, ty, ty).unwrap();
  28         writeln!(cpp_header_file, "\t{}(LDK{}&& m_self) : self(m_self) {{ memset(&m_self, 0, sizeof(LDK{})); }}", ty, ty, ty).unwrap();
  29         writeln!(cpp_header_file, "\toperator LDK{}() && {{ LDK{} res = self; memset(&self, 0, sizeof(LDK{})); return res; }}", ty, ty, ty).unwrap();
  30         if has_destructor {
  31                 writeln!(cpp_header_file, "\t~{}() {{ {}_free(self); }}", ty, ty).unwrap();
  32                 writeln!(cpp_header_file, "\t{}& operator=({}&& o) {{ {}_free(self); self = o.self; memset(&o, 0, sizeof({})); return *this; }}", ty, ty, ty, ty).unwrap();
  33         } else {
  34                 writeln!(cpp_header_file, "\t{}& operator=({}&& o) {{ self = o.self; memset(&o, 0, sizeof({})); return *this; }}", ty, ty, ty).unwrap();
  35         }
  36         writeln!(cpp_header_file, "\tLDK{}* operator &() {{ return &self; }}", ty).unwrap();
  37         writeln!(cpp_header_file, "\tLDK{}* operator ->() {{ return &self; }}", ty).unwrap();
  38         writeln!(cpp_header_file, "\tconst LDK{}* operator &() const {{ return &self; }}", ty).unwrap();
  39         writeln!(cpp_header_file, "\tconst LDK{}* operator ->() const {{ return &self; }}", ty).unwrap();
  40         writeln!(cpp_header_file, "}};").unwrap();
  41 }
  42
  43 /// Writes out a C-callable concrete Result<A, B> struct and utility methods
  44 pub fn write_result_block<W: std::io::Write>(w: &mut W, mangled_container: &str, ok_type: &str, err_type: &str, clonable: bool) {
  45         writeln!(w, "#[repr(C)]").unwrap();
  46         writeln!(w, "pub union {}Ptr {{", mangled_container).unwrap();
  47         if ok_type != "()" {
  48                 writeln!(w, "\tpub result: *mut {},", ok_type).unwrap();
  49         } else {
  50                 writeln!(w, "\t/// Note that this value is always NULL, as there are no contents in the OK variant").unwrap();
  51                 writeln!(w, "\tpub result: *mut std::ffi::c_void,").unwrap();
  52         }
  53         if err_type != "()" {
  54                 writeln!(w, "\tpub err: *mut {},", err_type).unwrap();
  55         } else {
  56                 writeln!(w, "\t/// Note that this value is always NULL, as there are no contents in the Err variant").unwrap();
  57                 writeln!(w, "\tpub err: *mut std::ffi::c_void,").unwrap();
  58         }
  59         writeln!(w, "}}").unwrap();
  60         writeln!(w, "#[repr(C)]").unwrap();
  61         writeln!(w, "pub struct {} {{", mangled_container).unwrap();
  62         writeln!(w, "\tpub contents: {}Ptr,", mangled_container).unwrap();
  63         writeln!(w, "\tpub result_ok: bool,").unwrap();
  64         writeln!(w, "}}").unwrap();
  65
  66         writeln!(w, "#[no_mangle]").unwrap();
  67         if ok_type != "()" {
  68                 writeln!(w, "pub extern \"C\" fn {}_ok(o: {}) -> {} {{", mangled_container, ok_type, mangled_container).unwrap();
  69         } else {
  70                 writeln!(w, "pub extern \"C\" fn {}_ok() -> {} {{", mangled_container, mangled_container).unwrap();
  71         }
  72         writeln!(w, "\t{} {{", mangled_container).unwrap();
  73         writeln!(w, "\t\tcontents: {}Ptr {{", mangled_container).unwrap();
  74         if ok_type != "()" {
  75                 writeln!(w, "\t\t\tresult: Box::into_raw(Box::new(o)),").unwrap();
  76         } else {
  77                 writeln!(w, "\t\t\tresult: std::ptr::null_mut(),").unwrap();
  78         }
  79         writeln!(w, "\t\t}},").unwrap();
  80         writeln!(w, "\t\tresult_ok: true,").unwrap();
  81         writeln!(w, "\t}}").unwrap();
  82         writeln!(w, "}}").unwrap();
  83
  84         writeln!(w, "#[no_mangle]").unwrap();
  85         if err_type != "()" {
  86                 writeln!(w, "pub extern \"C\" fn {}_err(e: {}) -> {} {{", mangled_container, err_type, mangled_container).unwrap();
  87         } else {
  88                 writeln!(w, "pub extern \"C\" fn {}_err() -> {} {{", mangled_container, mangled_container).unwrap();
  89         }
  90         writeln!(w, "\t{} {{", mangled_container).unwrap();
  91         writeln!(w, "\t\tcontents: {}Ptr {{", mangled_container).unwrap();
  92         if err_type != "()" {
  93                 writeln!(w, "\t\t\terr: Box::into_raw(Box::new(e)),").unwrap();
  94         } else {
  95                 writeln!(w, "\t\t\terr: std::ptr::null_mut(),").unwrap();
  96         }
  97         writeln!(w, "\t\t}},").unwrap();
  98         writeln!(w, "\t\tresult_ok: false,").unwrap();
  99         writeln!(w, "\t}}").unwrap();
 100         writeln!(w, "}}").unwrap();
 101
 102         writeln!(w, "#[no_mangle]").unwrap();
 103         writeln!(w, "pub extern \"C\" fn {}_free(_res: {}) {{ }}", mangled_container, mangled_container).unwrap();
 104         writeln!(w, "impl Drop for {} {{", mangled_container).unwrap();
 105         writeln!(w, "\tfn drop(&mut self) {{").unwrap();
 106         writeln!(w, "\t\tif self.result_ok {{").unwrap();
 107         if ok_type != "()" {
 108                 writeln!(w, "\t\t\tif unsafe {{ !(self.contents.result as *mut ()).is_null() }} {{").unwrap();
 109                 writeln!(w, "\t\t\t\tlet _ = unsafe {{ Box::from_raw(self.contents.result) }};").unwrap();
 110                 writeln!(w, "\t\t\t}}").unwrap();
 111         }
 112         writeln!(w, "\t\t}} else {{").unwrap();
 113         if err_type != "()" {
 114                 writeln!(w, "\t\t\tif unsafe {{ !(self.contents.err as *mut ()).is_null() }} {{").unwrap();
 115                 writeln!(w, "\t\t\t\tlet _ = unsafe {{ Box::from_raw(self.contents.err) }};").unwrap();
 116                 writeln!(w, "\t\t\t}}").unwrap();
 117         }
 118         writeln!(w, "\t\t}}").unwrap();
 119         writeln!(w, "\t}}").unwrap();
 120         writeln!(w, "}}").unwrap();
 121
 122         // TODO: Templates should use () now that they can, too
 123         let templ_ok_type = if ok_type != "()" { ok_type } else { "u8" };
 124         let templ_err_type = if err_type != "()" { err_type } else { "u8" };
 125
 126         writeln!(w, "impl From<crate::c_types::CResultTempl<{}, {}>> for {} {{", templ_ok_type, templ_err_type, mangled_container).unwrap();
 127         writeln!(w, "\tfn from(mut o: crate::c_types::CResultTempl<{}, {}>) -> Self {{", templ_ok_type, templ_err_type).unwrap();
 128         writeln!(w, "\t\tlet contents = if o.result_ok {{").unwrap();
 129         if ok_type != "()" {
 130                 writeln!(w, "\t\t\tlet result = unsafe {{ o.contents.result }};").unwrap();
 131                 writeln!(w, "\t\t\tunsafe {{ o.contents.result = std::ptr::null_mut() }};").unwrap();
 132                 writeln!(w, "\t\t\t{}Ptr {{ result }}", mangled_container).unwrap();
 133         } else {
 134                 writeln!(w, "\t\t\tlet _ = unsafe {{ Box::from_raw(o.contents.result) }};").unwrap();
 135                 writeln!(w, "\t\t\to.contents.result = std::ptr::null_mut();").unwrap();
 136                 writeln!(w, "\t\t\t{}Ptr {{ result: std::ptr::null_mut() }}", mangled_container).unwrap();
 137         }
 138         writeln!(w, "\t\t}} else {{").unwrap();
 139         if err_type != "()" {
 140                 writeln!(w, "\t\t\tlet err = unsafe {{ o.contents.err }};").unwrap();
 141                 writeln!(w, "\t\t\tunsafe {{ o.contents.err = std::ptr::null_mut(); }}").unwrap();
 142                 writeln!(w, "\t\t\t{}Ptr {{ err }}", mangled_container).unwrap();
 143         } else {
 144                 writeln!(w, "\t\t\tlet _ = unsafe {{ Box::from_raw(o.contents.err) }};").unwrap();
 145                 writeln!(w, "\t\t\to.contents.err = std::ptr::null_mut();").unwrap();
 146                 writeln!(w, "\t\t\t{}Ptr {{ err: std::ptr::null_mut() }}", mangled_container).unwrap();
 147         }
 148         writeln!(w, "\t\t}};").unwrap();
 149         writeln!(w, "\t\tSelf {{").unwrap();
 150         writeln!(w, "\t\t\tcontents,").unwrap();
 151         writeln!(w, "\t\t\tresult_ok: o.result_ok,").unwrap();
 152         writeln!(w, "\t\t}}").unwrap();
 153         writeln!(w, "\t}}").unwrap();
 154         writeln!(w, "}}").unwrap();
 155
 156         if clonable {
 157                 writeln!(w, "impl Clone for {} {{", mangled_container).unwrap();
 158                 writeln!(w, "\tfn clone(&self) -> Self {{").unwrap();
 159                 writeln!(w, "\t\tif self.result_ok {{").unwrap();
 160                 writeln!(w, "\t\t\tSelf {{ result_ok: true, contents: {}Ptr {{", mangled_container).unwrap();
 161                 if ok_type != "()" {
 162                         writeln!(w, "\t\t\t\tresult: Box::into_raw(Box::new(<{}>::clone(unsafe {{ &*self.contents.result }})))", ok_type).unwrap();
 163                 } else {
 164                         writeln!(w, "\t\t\t\tresult: std::ptr::null_mut()").unwrap();
 165                 }
 166                 writeln!(w, "\t\t\t}} }}").unwrap();
 167                 writeln!(w, "\t\t}} else {{").unwrap();
 168                 writeln!(w, "\t\t\tSelf {{ result_ok: false, contents: {}Ptr {{", mangled_container).unwrap();
 169                 if err_type != "()" {
 170                         writeln!(w, "\t\t\t\terr: Box::into_raw(Box::new(<{}>::clone(unsafe {{ &*self.contents.err }})))", err_type).unwrap();
 171                 } else {
 172                         writeln!(w, "\t\t\t\terr: std::ptr::null_mut()").unwrap();
 173                 }
 174                 writeln!(w, "\t\t\t}} }}").unwrap();
 175                 writeln!(w, "\t\t}}").unwrap();
 176                 writeln!(w, "\t}}").unwrap();
 177                 writeln!(w, "}}").unwrap();
 178                 writeln!(w, "#[no_mangle]").unwrap();
 179                 writeln!(w, "pub extern \"C\" fn {}_clone(orig: &{}) -> {} {{ orig.clone() }}", mangled_container, mangled_container, mangled_container).unwrap();
 180         }
 181 }
 182
 183 /// Writes out a C-callable concrete Vec<A> struct and utility methods
 184 pub fn write_vec_block<W: std::io::Write>(w: &mut W, mangled_container: &str, inner_type: &str, clonable: bool) {
 185         writeln!(w, "#[repr(C)]").unwrap();
 186         writeln!(w, "pub struct {} {{", mangled_container).unwrap();
 187         writeln!(w, "\tpub data: *mut {},", inner_type).unwrap();
 188         writeln!(w, "\tpub datalen: usize").unwrap();
 189         writeln!(w, "}}").unwrap();
 190
 191         writeln!(w, "impl {} {{", mangled_container).unwrap();
 192         writeln!(w, "\t#[allow(unused)] pub(crate) fn into_rust(&mut self) -> Vec<{}> {{", inner_type).unwrap();
 193         writeln!(w, "\t\tif self.datalen == 0 {{ return Vec::new(); }}").unwrap();
 194         writeln!(w, "\t\tlet ret = unsafe {{ Box::from_raw(std::slice::from_raw_parts_mut(self.data, self.datalen)) }}.into();").unwrap();
 195         writeln!(w, "\t\tself.data = std::ptr::null_mut();").unwrap();
 196         writeln!(w, "\t\tself.datalen = 0;").unwrap();
 197         writeln!(w, "\t\tret").unwrap();
 198         writeln!(w, "\t}}").unwrap();
 199         writeln!(w, "\t#[allow(unused)] pub(crate) fn as_slice(&self) -> &[{}] {{", inner_type).unwrap();
 200         writeln!(w, "\t\tunsafe {{ std::slice::from_raw_parts_mut(self.data, self.datalen) }}").unwrap();
 201         writeln!(w, "\t}}").unwrap();
 202         writeln!(w, "}}").unwrap();
 203
 204         writeln!(w, "impl From<Vec<{}>> for {} {{", inner_type, mangled_container).unwrap();
 205         writeln!(w, "\tfn from(v: Vec<{}>) -> Self {{", inner_type).unwrap();
 206         writeln!(w, "\t\tlet datalen = v.len();").unwrap();
 207         writeln!(w, "\t\tlet data = Box::into_raw(v.into_boxed_slice());").unwrap();
 208         writeln!(w, "\t\tSelf {{ datalen, data: unsafe {{ (*data).as_mut_ptr() }} }}").unwrap();
 209         writeln!(w, "\t}}").unwrap();
 210         writeln!(w, "}}").unwrap();
 211
 212         writeln!(w, "#[no_mangle]").unwrap();
 213         writeln!(w, "pub extern \"C\" fn {}_free(_res: {}) {{ }}", mangled_container, mangled_container).unwrap();
 214         writeln!(w, "impl Drop for {} {{", mangled_container).unwrap();
 215         writeln!(w, "\tfn drop(&mut self) {{").unwrap();
 216         writeln!(w, "\t\tif self.datalen == 0 {{ return; }}").unwrap();
 217         writeln!(w, "\t\tunsafe {{ Box::from_raw(std::slice::from_raw_parts_mut(self.data, self.datalen)) }};").unwrap();
 218         writeln!(w, "\t}}").unwrap();
 219         writeln!(w, "}}").unwrap();
 220         if clonable {
 221                 writeln!(w, "impl Clone for {} {{", mangled_container).unwrap();
 222                 writeln!(w, "\tfn clone(&self) -> Self {{").unwrap();
 223                 writeln!(w, "\t\tlet mut res = Vec::new();").unwrap();
 224                 writeln!(w, "\t\tif self.datalen == 0 {{ return Self::from(res); }}").unwrap();
 225                 writeln!(w, "\t\tres.extend_from_slice(unsafe {{ std::slice::from_raw_parts_mut(self.data, self.datalen) }});").unwrap();
 226                 writeln!(w, "\t\tSelf::from(res)").unwrap();
 227                 writeln!(w, "\t}}").unwrap();
 228                 writeln!(w, "}}").unwrap();
 229         }
 230 }
 231
 232 /// Writes out a C-callable concrete (A, B, ...) struct and utility methods
 233 pub fn write_tuple_block<W: std::io::Write>(w: &mut W, mangled_container: &str, types: &[String], clonable: bool) {
 234         writeln!(w, "#[repr(C)]").unwrap();
 235         writeln!(w, "pub struct {} {{", mangled_container).unwrap();
 236         for (idx, ty) in types.iter().enumerate() {
 237                 writeln!(w, "\tpub {}: {},", ('a' as u8 + idx as u8) as char, ty).unwrap();
 238         }
 239         writeln!(w, "}}").unwrap();
 240
 241         let mut tuple_str = "(".to_owned();
 242         for (idx, ty) in types.iter().enumerate() {
 243                 if idx != 0 { tuple_str += ", "; }
 244                 tuple_str += ty;
 245         }
 246         tuple_str += ")";
 247
 248         writeln!(w, "impl From<{}> for {} {{", tuple_str, mangled_container).unwrap();
 249         writeln!(w, "\tfn from (tup: {}) -> Self {{", tuple_str).unwrap();
 250         writeln!(w, "\t\tSelf {{").unwrap();
 251         for idx in 0..types.len() {
 252                 writeln!(w, "\t\t\t{}: tup.{},", ('a' as u8 + idx as u8) as char, idx).unwrap();
 253         }
 254         writeln!(w, "\t\t}}").unwrap();
 255         writeln!(w, "\t}}").unwrap();
 256         writeln!(w, "}}").unwrap();
 257         writeln!(w, "impl {} {{", mangled_container).unwrap();
 258         writeln!(w, "\t#[allow(unused)] pub(crate) fn to_rust(mut self) -> {} {{", tuple_str).unwrap();
 259         write!(w, "\t\t(").unwrap();
 260         for idx in 0..types.len() {
 261                 write!(w, "{}self.{}", if idx != 0 {", "} else {""}, ('a' as u8 + idx as u8) as char).unwrap();
 262         }
 263         writeln!(w, ")").unwrap();
 264         writeln!(w, "\t}}").unwrap();
 265         writeln!(w, "}}").unwrap();
 266
 267         if clonable {
 268                 writeln!(w, "impl Clone for {} {{", mangled_container).unwrap();
 269                 writeln!(w, "\tfn clone(&self) -> Self {{").unwrap();
 270                 writeln!(w, "\t\tSelf {{").unwrap();
 271                 for idx in 0..types.len() {
 272                         writeln!(w, "\t\t\t{}: self.{}.clone(),", ('a' as u8 + idx as u8) as char, ('a' as u8 + idx as u8) as char).unwrap();
 273                 }
 274                 writeln!(w, "\t\t}}").unwrap();
 275                 writeln!(w, "\t}}").unwrap();
 276                 writeln!(w, "}}").unwrap();
 277                 writeln!(w, "#[no_mangle]").unwrap();
 278                 writeln!(w, "pub extern \"C\" fn {}_clone(orig: &{}) -> {} {{ orig.clone() }}", mangled_container, mangled_container, mangled_container).unwrap();
 279         }
 280
 281         write!(w, "#[no_mangle]\npub extern \"C\" fn {}_new(", mangled_container).unwrap();
 282         for (idx, gen) in types.iter().enumerate() {
 283                 write!(w, "{}{}: ", if idx != 0 { ", " } else { "" }, ('a' as u8 + idx as u8) as char).unwrap();
 284                 //if !self.write_c_type_intern(&mut created_container, gen, generics, false, false, false) { return false; }
 285                 write!(w, "{}", gen).unwrap();
 286         }
 287         writeln!(w, ") -> {} {{", mangled_container).unwrap();
 288         write!(w, "\t{} {{ ", mangled_container).unwrap();
 289         for idx in 0..types.len() {
 290                 write!(w, "{}, ", ('a' as u8 + idx as u8) as char).unwrap();
 291         }
 292         writeln!(w, "}}\n}}\n").unwrap();
 293
 294         writeln!(w, "#[no_mangle]").unwrap();
 295         writeln!(w, "pub extern \"C\" fn {}_free(_res: {}) {{ }}", mangled_container, mangled_container).unwrap();
 296 }
 297
 298 /// Writes out a C-callable concrete Option<A> struct and utility methods
 299 pub fn write_option_block<W: std::io::Write>(w: &mut W, mangled_container: &str, inner_type: &str, clonable: bool) {
 300         writeln!(w, "#[repr(C)]").unwrap();
 301         if clonable {
 302                 writeln!(w, "#[derive(Clone)]").unwrap();
 303         }
 304         writeln!(w, "pub enum {} {{", mangled_container).unwrap();
 305         writeln!(w, "\tSome({}),", inner_type).unwrap();
 306         writeln!(w, "\tNone").unwrap();
 307         writeln!(w, "}}").unwrap();
 308
 309         writeln!(w, "impl {} {{", mangled_container).unwrap();
 310         writeln!(w, "\t#[allow(unused)] pub(crate) fn is_some(&self) -> bool {{").unwrap();
 311         writeln!(w, "\t\tif let Self::Some(_) = self {{ true }} else {{ false }}").unwrap();
 312         writeln!(w, "\t}}").unwrap();
 313         writeln!(w, "\t#[allow(unused)] pub(crate) fn take(mut self) -> {} {{", inner_type).unwrap();
 314         writeln!(w, "\t\tif let Self::Some(v) = self {{ v }} else {{ unreachable!() }}").unwrap();
 315         writeln!(w, "\t}}").unwrap();
 316         writeln!(w, "}}").unwrap();
 317
 318         writeln!(w, "#[no_mangle]").unwrap();
 319         writeln!(w, "pub extern \"C\" fn {}_free(_res: {}) {{ }}", mangled_container, mangled_container).unwrap();
 320         if clonable {
 321                 writeln!(w, "#[no_mangle]").unwrap();
 322                 writeln!(w, "pub extern \"C\" fn {}_clone(orig: &{}) -> {} {{ orig.clone() }}", mangled_container, mangled_container, mangled_container).unwrap();
 323         }
 324 }
 325
 326 /// Prints the docs from a given attribute list unless its tagged no export
 327 pub fn writeln_docs<W: std::io::Write>(w: &mut W, attrs: &[syn::Attribute], prefix: &str) {
 328         for attr in attrs.iter() {
 329                 let tokens_clone = attr.tokens.clone();
 330                 let mut token_iter = tokens_clone.into_iter();
 331                 if let Some(token) = token_iter.next() {
 332                         match token {
 333                                 TokenTree::Punct(c) if c.as_char() == '=' => {
 334                                         // syn gets '=' from '///' or '//!' as it is syntax for #[doc = ""]
 335                                 },
 336                                 TokenTree::Group(_) => continue, // eg #[derive()]
 337                                 _ => unimplemented!(),
 338                         }
 339                 } else { continue; }
 340                 match attr.style {
 341                         syn::AttrStyle::Inner(_) => {
 342                                 match token_iter.next().unwrap() {
 343                                         TokenTree::Literal(lit) => {
 344                                                 // Drop the first and last chars from lit as they are always "
 345                                                 let doc = format!("{}", lit);
 346                                                 writeln!(w, "{}//!{}", prefix, &doc[1..doc.len() - 1]).unwrap();
 347                                         },
 348                                         _ => unimplemented!(),
 349                                 }
 350                         },
 351                         syn::AttrStyle::Outer => {
 352                                 match token_iter.next().unwrap() {
 353                                         TokenTree::Literal(lit) => {
 354                                                 // Drop the first and last chars from lit as they are always "
 355                                                 let doc = format!("{}", lit);
 356                                                 writeln!(w, "{}///{}", prefix, &doc[1..doc.len() - 1]).unwrap();
 357                                         },
 358                                         _ => unimplemented!(),
 359                                 }
 360                         },
 361                 }
 362         }
 363 }
 364
 365 /// Print the parameters in a method declaration, starting after the open parenthesis, through and
 366 /// including the closing parenthesis and return value, but not including the open bracket or any
 367 /// trailing semicolons.
 368 ///
 369 /// Usable both for a function definition and declaration.
 370 ///
 371 /// this_param is used when returning Self or accepting a self parameter, and should be the
 372 /// concrete, mapped type.
 373 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) {
 374         if sig.constness.is_some() || sig.asyncness.is_some() || sig.unsafety.is_some() ||
 375                         sig.abi.is_some() || sig.variadic.is_some() {
 376                 unimplemented!();
 377         }
 378         if sig.generics.lt_token.is_some() {
 379                 for generic in sig.generics.params.iter() {
 380                         match generic {
 381                                 syn::GenericParam::Type(_)|syn::GenericParam::Lifetime(_) => {
 382                                         // We ignore these, if they're not on skipped args, we'll blow up
 383                                         // later, and lifetimes we just hope the C client enforces.
 384                                 },
 385                                 _ => unimplemented!(),
 386                         }
 387                 }
 388         }
 389
 390         let mut first_arg = true;
 391         let mut num_unused = 0;
 392         for inp in sig.inputs.iter() {
 393                 match inp {
 394                         syn::FnArg::Receiver(recv) => {
 395                                 if !recv.attrs.is_empty() || recv.reference.is_none() { unimplemented!(); }
 396                                 write!(w, "this_arg: {}{}",
 397                                         match (self_ptr, recv.mutability.is_some()) {
 398                                                 (true, true) => "*mut ",
 399                                                 (true, false) => "*const ",
 400                                                 (false, true) => "&mut ",
 401                                                 (false, false) => "&",
 402                                         }, this_param).unwrap();
 403                                 assert!(first_arg);
 404                                 first_arg = false;
 405                         },
 406                         syn::FnArg::Typed(arg) => {
 407                                 if types.skip_arg(&*arg.ty, generics) { continue; }
 408                                 if !arg.attrs.is_empty() { unimplemented!(); }
 409                                 // First get the c type so that we can check if it ends up being a reference:
 410                                 let mut c_type = Vec::new();
 411                                 types.write_c_type(&mut c_type, &*arg.ty, generics, false);
 412                                 match &*arg.pat {
 413                                         syn::Pat::Ident(ident) => {
 414                                                 if !ident.attrs.is_empty() || ident.subpat.is_some() {
 415                                                         unimplemented!();
 416                                                 }
 417                                                 write!(w, "{}{}{}: ", if first_arg { "" } else { ", " }, if !fn_decl || c_type[0] == '&' as u8 || c_type[0] == '*' as u8 { "" } else { "mut " }, ident.ident).unwrap();
 418                                                 first_arg = false;
 419                                         },
 420                                         syn::Pat::Wild(wild) => {
 421                                                 if !wild.attrs.is_empty() { unimplemented!(); }
 422                                                 write!(w, "{}unused_{}: ", if first_arg { "" } else { ", " }, num_unused).unwrap();
 423                                                 num_unused += 1;
 424                                         },
 425                                         _ => unimplemented!(),
 426                                 }
 427                                 w.write(&c_type).unwrap();
 428                         }
 429                 }
 430         }
 431         write!(w, ")").unwrap();
 432         match &sig.output {
 433                 syn::ReturnType::Type(_, rtype) => {
 434                         write!(w, " -> ").unwrap();
 435                         if let Some(mut remaining_path) = first_seg_self(&*rtype) {
 436                                 if remaining_path.next().is_none() {
 437                                         write!(w, "{}", this_param).unwrap();
 438                                         return;
 439                                 }
 440                         }
 441                         if let syn::Type::Reference(r) = &**rtype {
 442                                 // We can't return a reference, cause we allocate things on the stack.
 443                                 types.write_c_type(w, &*r.elem, generics, true);
 444                         } else {
 445                                 types.write_c_type(w, &*rtype, generics, true);
 446                         }
 447                 },
 448                 _ => {},
 449         }
 450 }
 451
 452 /// Print the main part of a method declaration body, starting with a newline after the function
 453 /// open bracket and converting each function parameter to or from C-mapped types. Ends with "let
 454 /// mut ret = " assuming the next print will be the unmapped Rust function to call followed by the
 455 /// parameters we mapped to/from C here.
 456 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) {
 457         let mut num_unused = 0;
 458         for inp in sig.inputs.iter() {
 459                 match inp {
 460                         syn::FnArg::Receiver(_) => {},
 461                         syn::FnArg::Typed(arg) => {
 462                                 if types.skip_arg(&*arg.ty, generics) { continue; }
 463                                 if !arg.attrs.is_empty() { unimplemented!(); }
 464                                 macro_rules! write_new_var {
 465                                         ($ident: expr, $ty: expr) => {
 466                                                 if to_c {
 467                                                         if types.write_to_c_conversion_new_var(w, &$ident, &$ty, generics, false) {
 468                                                                 write!(w, "\n\t{}", extra_indent).unwrap();
 469                                                         }
 470                                                 } else {
 471                                                         if types.write_from_c_conversion_new_var(w, &$ident, &$ty, generics) {
 472                                                                 write!(w, "\n\t{}", extra_indent).unwrap();
 473                                                         }
 474                                                 }
 475                                         }
 476                                 }
 477                                 match &*arg.pat {
 478                                         syn::Pat::Ident(ident) => {
 479                                                 if !ident.attrs.is_empty() || ident.subpat.is_some() {
 480                                                         unimplemented!();
 481                                                 }
 482                                                 write_new_var!(ident.ident, *arg.ty);
 483                                         },
 484                                         syn::Pat::Wild(w) => {
 485                                                 if !w.attrs.is_empty() { unimplemented!(); }
 486                                                 write_new_var!(syn::Ident::new(&format!("unused_{}", num_unused), Span::call_site()), *arg.ty);
 487                                                 num_unused += 1;
 488                                         },
 489                                         _ => unimplemented!(),
 490                                 }
 491                         }
 492                 }
 493         }
 494         match &sig.output {
 495                 syn::ReturnType::Type(_, _) => {
 496                         write!(w, "let mut ret = ").unwrap();
 497                 },
 498                 _ => {},
 499         }
 500 }
 501
 502 /// Prints the parameters in a method call, starting after the open parenthesis and ending with a
 503 /// final return statement returning the method's result. Should be followed by a single closing
 504 /// bracket.
 505 ///
 506 /// The return value is expected to be bound to a variable named `ret` which is available after a
 507 /// method-call-ending semicolon.
 508 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) {
 509         let mut first_arg = true;
 510         let mut num_unused = 0;
 511         for inp in sig.inputs.iter() {
 512                 match inp {
 513                         syn::FnArg::Receiver(recv) => {
 514                                 if !recv.attrs.is_empty() || recv.reference.is_none() { unimplemented!(); }
 515                                 if to_c {
 516                                         write!(w, "self.this_arg").unwrap();
 517                                         first_arg = false;
 518                                 }
 519                         },
 520                         syn::FnArg::Typed(arg) => {
 521                                 if types.skip_arg(&*arg.ty, generics) {
 522                                         if !to_c {
 523                                                 if !first_arg {
 524                                                         write!(w, ", ").unwrap();
 525                                                 }
 526                                                 first_arg = false;
 527                                                 types.no_arg_to_rust(w, &*arg.ty, generics);
 528                                         }
 529                                         continue;
 530                                 }
 531                                 if !arg.attrs.is_empty() { unimplemented!(); }
 532                                 macro_rules! write_ident {
 533                                         ($ident: expr) => {
 534                                                 if !first_arg {
 535                                                         write!(w, ", ").unwrap();
 536                                                 }
 537                                                 first_arg = false;
 538                                                 if to_c {
 539                                                         types.write_to_c_conversion_inline_prefix(w, &*arg.ty, generics, false);
 540                                                         write!(w, "{}", $ident).unwrap();
 541                                                         types.write_to_c_conversion_inline_suffix(w, &*arg.ty, generics, false);
 542                                                 } else {
 543                                                         types.write_from_c_conversion_prefix(w, &*arg.ty, generics);
 544                                                         write!(w, "{}", $ident).unwrap();
 545                                                         types.write_from_c_conversion_suffix(w, &*arg.ty, generics);
 546                                                 }
 547                                         }
 548                                 }
 549                                 match &*arg.pat {
 550                                         syn::Pat::Ident(ident) => {
 551                                                 if !ident.attrs.is_empty() || ident.subpat.is_some() {
 552                                                         unimplemented!();
 553                                                 }
 554                                                 write_ident!(ident.ident);
 555                                         },
 556                                         syn::Pat::Wild(w) => {
 557                                                 if !w.attrs.is_empty() { unimplemented!(); }
 558                                                 write_ident!(format!("unused_{}", num_unused));
 559                                                 num_unused += 1;
 560                                         },
 561                                         _ => unimplemented!(),
 562                                 }
 563                         }
 564                 }
 565         }
 566         write!(w, ")").unwrap();
 567         match &sig.output {
 568                 syn::ReturnType::Type(_, rtype) => {
 569                         write!(w, ";\n\t{}", extra_indent).unwrap();
 570
 571                         let self_segs_iter = first_seg_self(&*rtype);
 572                         if to_c && first_seg_self(&*rtype).is_some() {
 573                                 // Assume rather blindly that we're returning an associated trait from a C fn call to a Rust trait object.
 574                                 write!(w, "ret").unwrap();
 575                         } else if !to_c && self_segs_iter.is_some() && self_segs_iter.unwrap().next().is_none() {
 576                                 // If we're returning "Self" (and not "Self::X"), just do it manually
 577                                 write!(w, "{} {{ inner: Box::into_raw(Box::new(ret)), is_owned: true }}", this_type).unwrap();
 578                         } else if to_c {
 579                                 let new_var = types.write_from_c_conversion_new_var(w, &syn::Ident::new("ret", Span::call_site()), rtype, generics);
 580                                 if new_var {
 581                                         write!(w, "\n\t{}", extra_indent).unwrap();
 582                                 }
 583                                 types.write_from_c_conversion_prefix(w, &*rtype, generics);
 584                                 write!(w, "ret").unwrap();
 585                                 types.write_from_c_conversion_suffix(w, &*rtype, generics);
 586                         } else {
 587                                 let ret_returned = if let syn::Type::Reference(_) = &**rtype { true } else { false };
 588                                 let new_var = types.write_to_c_conversion_new_var(w, &syn::Ident::new("ret", Span::call_site()), &rtype, generics, true);
 589                                 if new_var {
 590                                         write!(w, "\n\t{}", extra_indent).unwrap();
 591                                 }
 592                                 types.write_to_c_conversion_inline_prefix(w, &rtype, generics, true);
 593                                 write!(w, "{}ret", if ret_returned && !new_var { "*" } else { "" }).unwrap();
 594                                 types.write_to_c_conversion_inline_suffix(w, &rtype, generics, true);
 595                         }
 596                 }
 597                 _ => {},
 598         }
 599 }
 600
 601 /// Prints concrete generic parameters for a struct/trait/function, including the less-than and
 602 /// greater-than symbols, if any generic parameters are defined.
 603 pub fn maybe_write_generics<W: std::io::Write>(w: &mut W, generics: &syn::Generics, types: &TypeResolver, concrete_lifetimes: bool) {
 604         let mut gen_types = GenericTypes::new();
 605         assert!(gen_types.learn_generics(generics, types));
 606         if !generics.params.is_empty() {
 607                 write!(w, "<").unwrap();
 608                 for (idx, generic) in generics.params.iter().enumerate() {
 609                         match generic {
 610                                 syn::GenericParam::Type(type_param) => {
 611                                         let mut printed_param = false;
 612                                         for bound in type_param.bounds.iter() {
 613                                                 if let syn::TypeParamBound::Trait(trait_bound) = bound {
 614                                                         assert_simple_bound(&trait_bound);
 615                                                         write!(w, "{}{}", if idx != 0 { ", " } else { "" }, gen_types.maybe_resolve_ident(&type_param.ident).unwrap()).unwrap();
 616                                                         if printed_param {
 617                                                                 unimplemented!("Can't print generic params that have multiple non-lifetime bounds");
 618                                                         }
 619                                                         printed_param = true;
 620                                                 }
 621                                         }
 622                                 },
 623                                 syn::GenericParam::Lifetime(lt) => {
 624                                         if concrete_lifetimes {
 625                                                 write!(w, "'static").unwrap();
 626                                         } else {
 627                                                 write!(w, "{}'{}", if idx != 0 { ", " } else { "" }, lt.lifetime.ident).unwrap();
 628                                         }
 629                                 },
 630                                 _ => unimplemented!(),
 631                         }
 632                 }
 633                 write!(w, ">").unwrap();
 634         }
 635 }
 636
 637