Merge pull request #40 from TheBlueMatt/main
[ldk-c-bindings] / c-bindings-gen / src / main.rs
index 1f17fef9ead0dba1887eedd2134d6e3ce37eaa00..ce69294928af16714f3e7b645d34cbc2faa9f510 100644 (file)
@@ -180,7 +180,7 @@ eprintln!("{}", trait_path);
 // *** Per-Type Printing Logic ***
 // *******************************
 
-macro_rules! walk_supertraits { ($t: expr, $types: expr, ($( $pat: pat => $e: expr),*) ) => { {
+macro_rules! walk_supertraits { ($t: expr, $types: expr, ($( $($pat: pat)|* => $e: expr),*) ) => { {
        if $t.colon_token.is_some() {
                for st in $t.supertraits.iter() {
                        match st {
@@ -194,14 +194,14 @@ macro_rules! walk_supertraits { ($t: expr, $types: expr, ($( $pat: pat => $e: ex
                                        if let Some(types) = types_opt {
                                                if let Some(path) = types.maybe_resolve_path(&supertrait.path, None) {
                                                        match (&path as &str, &supertrait.path.segments.iter().last().unwrap().ident) {
-                                                               $( $pat => $e, )*
+                                                               $( $($pat)|* => $e, )*
                                                        }
                                                        continue;
                                                }
                                        }
                                        if let Some(ident) = supertrait.path.get_ident() {
                                                match (&format!("{}", ident) as &str, &ident) {
-                                                       $( $pat => $e, )*
+                                                       $( $($pat)|* => $e, )*
                                                }
                                        } else if types_opt.is_some() {
                                                panic!("Supertrait unresolvable and not single-ident");
@@ -221,8 +221,10 @@ macro_rules! walk_supertraits { ($t: expr, $types: expr, ($( $pat: pat => $e: ex
 /// a concrete Deref to the Rust trait.
 fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, types: &mut TypeResolver<'b, 'a>, extra_headers: &mut File, cpp_headers: &mut File) {
        let trait_name = format!("{}", t.ident);
+       let implementable;
        match export_status(&t.attrs) {
-               ExportStatus::Export => {},
+               ExportStatus::Export => { implementable = true; }
+               ExportStatus::NotImplementable => { implementable = false; },
                ExportStatus::NoExport|ExportStatus::TestOnly => return,
        }
        writeln_docs(w, &t.attrs, "");
@@ -235,7 +237,9 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty
        writeln!(w, "\t/// An opaque pointer which is passed to your function implementations as an argument.").unwrap();
        writeln!(w, "\t/// This has no meaning in the LDK, and can be NULL or any other value.").unwrap();
        writeln!(w, "\tpub this_arg: *mut c_void,").unwrap();
-       let mut generated_fields = Vec::new(); // Every field's (name, is_clonable) except this_arg, used in Clone generation
+       // We store every field's (name, Option<clone_fn>, docs) except this_arg, used in Clone generation
+       // docs is only set if its a function which should be callable on the object itself in C++
+       let mut generated_fields = Vec::new();
        for item in t.items.iter() {
                match item {
                        &syn::TraitItem::Method(ref m) => {
@@ -247,13 +251,14 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty
                                        },
                                        ExportStatus::Export => {},
                                        ExportStatus::TestOnly => continue,
+                                       ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
                                }
                                if m.default.is_some() { unimplemented!(); }
 
                                let mut meth_gen_types = gen_types.push_ctx();
                                assert!(meth_gen_types.learn_generics(&m.sig.generics, types));
 
-                               writeln_docs(w, &m.attrs, "\t");
+                               writeln_fn_docs(w, &m.attrs, "\t", types, Some(&meth_gen_types), m.sig.inputs.iter(), &m.sig.output);
 
                                if let syn::ReturnType::Type(_, rtype) = &m.sig.output {
                                        if let syn::Type::Reference(r) = &**rtype {
@@ -268,19 +273,18 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty
                                                // happen) as well as provide an Option<>al function pointer which is
                                                // called when the trait method is called which allows updating on the fly.
                                                write!(w, "\tpub {}: ", m.sig.ident).unwrap();
-                                               generated_fields.push((format!("{}", m.sig.ident), true));
+                                               generated_fields.push((format!("{}", m.sig.ident), None, None));
                                                types.write_c_type(w, &*r.elem, Some(&meth_gen_types), false);
                                                writeln!(w, ",").unwrap();
                                                writeln!(w, "\t/// Fill in the {} field as a reference to it will be given to Rust after this returns", m.sig.ident).unwrap();
                                                writeln!(w, "\t/// Note that this takes a pointer to this object, not the this_ptr like other methods do").unwrap();
                                                writeln!(w, "\t/// This function pointer may be NULL if {} is filled in when this object is created and never needs updating.", m.sig.ident).unwrap();
                                                writeln!(w, "\tpub set_{}: Option<extern \"C\" fn(&{})>,", m.sig.ident, trait_name).unwrap();
-                                               generated_fields.push((format!("set_{}", m.sig.ident), true));
+                                               generated_fields.push((format!("set_{}", m.sig.ident), None, None));
                                                // Note that cbindgen will now generate
-                                               // typedef struct Thing {..., set_thing: (const Thing*), ...} Thing;
+                                               // typedef struct Thing {..., set_thing: (const struct Thing*), ...} Thing;
                                                // which does not compile since Thing is not defined before it is used.
                                                writeln!(extra_headers, "struct LDK{};", trait_name).unwrap();
-                                               writeln!(extra_headers, "typedef struct LDK{} LDK{};", trait_name, trait_name).unwrap();
                                                continue;
                                        }
                                        // Sadly, this currently doesn't do what we want, but it should be easy to get
@@ -288,8 +292,12 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty
                                        writeln!(w, "\t#[must_use]").unwrap();
                                }
 
+                               let mut cpp_docs = Vec::new();
+                               writeln_fn_docs(&mut cpp_docs, &m.attrs, "\t * ", types, Some(&meth_gen_types), m.sig.inputs.iter(), &m.sig.output);
+                               let docs_string = "\t/**\n".to_owned() + &String::from_utf8(cpp_docs).unwrap().replace("///", "") + "\t */\n";
+
                                write!(w, "\tpub {}: extern \"C\" fn (", m.sig.ident).unwrap();
-                               generated_fields.push((format!("{}", m.sig.ident), true));
+                               generated_fields.push((format!("{}", m.sig.ident), None, Some(docs_string)));
                                write_method_params(w, &m.sig, "c_void", types, Some(&meth_gen_types), true, false);
                                writeln!(w, ",").unwrap();
                        },
@@ -298,56 +306,53 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty
                }
        }
        // Add functions which may be required for supertrait implementations.
-       let mut requires_clone = false;
-       walk_supertraits!(t, Some(&types), (
-               ("Clone", _) => requires_clone = true,
-               (_, _) => {}
-       ) );
        walk_supertraits!(t, Some(&types), (
                ("Clone", _) => {
-                       writeln!(w, "\t/// Creates a copy of the object pointed to by this_arg, for a copy of this {}.", trait_name).unwrap();
-                       writeln!(w, "\t/// Note that the ultimate copy of the {} will have all function pointers the same as the original.", trait_name).unwrap();
-                       writeln!(w, "\t/// May be NULL if no action needs to be taken, the this_arg pointer will be copied into the new {}.", trait_name).unwrap();
-                       writeln!(w, "\tpub clone: Option<extern \"C\" fn (this_arg: *const c_void) -> *mut c_void>,").unwrap();
-                       generated_fields.push(("clone".to_owned(), true));
+                       writeln!(w, "\t/// Called, if set, after this {} has been cloned into a duplicate object.", trait_name).unwrap();
+                       writeln!(w, "\t/// The new {} is provided, and should be mutated as needed to perform a", trait_name).unwrap();
+                       writeln!(w, "\t/// deep copy of the object pointed to by this_arg or avoid any double-freeing.").unwrap();
+                       writeln!(w, "\tpub cloned: Option<extern \"C\" fn (new_{}: &mut {})>,", trait_name, trait_name).unwrap();
+                       generated_fields.push(("cloned".to_owned(), None, None));
                },
-               ("std::cmp::Eq", _) => {
-                       writeln!(w, "\t/// Checks if two objects are equal given this object's this_arg pointer and another object.").unwrap();
+               ("std::cmp::Eq", _)|("core::cmp::Eq", _) => {
+                       let eq_docs = "Checks if two objects are equal given this object's this_arg pointer and another object.";
+                       writeln!(w, "\t/// {}", eq_docs).unwrap();
                        writeln!(w, "\tpub eq: extern \"C\" fn (this_arg: *const c_void, other_arg: &{}) -> bool,", trait_name).unwrap();
-                       writeln!(extra_headers, "typedef struct LDK{} LDK{};", trait_name, trait_name).unwrap();
-                       generated_fields.push(("eq".to_owned(), true));
+                       generated_fields.push(("eq".to_owned(), None, Some(format!("\t/** {} */\n", eq_docs))));
                },
-               ("std::hash::Hash", _) => {
-                       writeln!(w, "\t/// Calculate a succinct non-cryptographic hash for an object given its this_arg pointer.").unwrap();
-                       writeln!(w, "\t/// This is used, for example, for inclusion of this object in a hash map.").unwrap();
+               ("std::hash::Hash", _)|("core::hash::Hash", _) => {
+                       let hash_docs_a = "Calculate a succinct non-cryptographic hash for an object given its this_arg pointer.";
+                       let hash_docs_b = "This is used, for example, for inclusion of this object in a hash map.";
+                       writeln!(w, "\t/// {}", hash_docs_a).unwrap();
+                       writeln!(w, "\t/// {}", hash_docs_b).unwrap();
                        writeln!(w, "\tpub hash: extern \"C\" fn (this_arg: *const c_void) -> u64,").unwrap();
-                       generated_fields.push(("hash".to_owned(), true));
+                       generated_fields.push(("hash".to_owned(), None,
+                               Some(format!("\t/**\n\t * {}\n\t * {}\n\t */\n", hash_docs_a, hash_docs_b))));
                },
                ("Send", _) => {}, ("Sync", _) => {},
                (s, i) => {
+                       // TODO: Both of the below should expose supertrait methods in C++, but doing so is
+                       // nontrivial.
                        generated_fields.push(if types.crate_types.traits.get(s).is_none() {
                                let (docs, name, ret) = convert_trait_impl_field(s);
                                writeln!(w, "\t/// {}", docs).unwrap();
                                writeln!(w, "\tpub {}: extern \"C\" fn (this_arg: *const c_void) -> {},", name, ret).unwrap();
-                               (name, true) // Assume clonable
+                               (name, None, None) // Assume clonable
                        } else {
                                // For in-crate supertraits, just store a C-mapped copy of the supertrait as a member.
                                writeln!(w, "\t/// Implementation of {} for this object.", i).unwrap();
-                               writeln!(w, "\tpub {}: crate::{},", i, s).unwrap();
                                let is_clonable = types.is_clonable(s);
-                               if !is_clonable && requires_clone {
-                                       writeln!(w, "\t/// Creates a copy of the {}, for a copy of this {}.", i, trait_name).unwrap();
-                                       writeln!(w, "\t/// Because {} doesn't natively support copying itself, you have to provide a full copy implementation here.", i).unwrap();
-                                       writeln!(w, "\tpub {}_clone: extern \"C\" fn (orig_{}: &{}) -> {},", i, i, i, i).unwrap();
-                               }
-                               (format!("{}", i), is_clonable)
+                               writeln!(w, "\tpub {}: crate::{},", i, s).unwrap();
+                               (format!("{}", i), if !is_clonable {
+                                       Some(format!("crate::{}_clone_fields", s))
+                               } else { None }, None)
                        });
                }
        ) );
        writeln!(w, "\t/// Frees any resources associated with this object given its this_arg pointer.").unwrap();
        writeln!(w, "\t/// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.").unwrap();
        writeln!(w, "\tpub free: Option<extern \"C\" fn(this_arg: *mut c_void)>,").unwrap();
-       generated_fields.push(("free".to_owned(), true));
+       generated_fields.push(("free".to_owned(), None, None));
        writeln!(w, "}}").unwrap();
 
        macro_rules! impl_trait_for_c {
@@ -426,7 +431,9 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty
                                                }
                                                write_method_var_decl_body(w, &m.sig, "\t", $type_resolver, Some(&meth_gen_types), true);
                                                write!(w, "(self{}.{})(", $impl_accessor, m.sig.ident).unwrap();
-                                               write_method_call_params(w, &m.sig, "\t", $type_resolver, Some(&meth_gen_types), "", true);
+                                               let mut args = Vec::new();
+                                               write_method_call_params(&mut args, &m.sig, "\t", $type_resolver, Some(&meth_gen_types), "", true);
+                                               w.write_all(String::from_utf8(args).unwrap().replace("self", &format!("self{}", $impl_accessor)).as_bytes()).unwrap();
 
                                                writeln!(w, "\n\t}}").unwrap();
                                        },
@@ -447,35 +454,42 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty
                }
        }
 
+       writeln!(w, "unsafe impl Send for {} {{}}", trait_name).unwrap();
+       writeln!(w, "unsafe impl Sync for {} {{}}", trait_name).unwrap();
+
+       writeln!(w, "#[no_mangle]").unwrap();
+       writeln!(w, "pub(crate) extern \"C\" fn {}_clone_fields(orig: &{}) -> {} {{", trait_name, trait_name, trait_name).unwrap();
+       writeln!(w, "\t{} {{", trait_name).unwrap();
+       writeln!(w, "\t\tthis_arg: orig.this_arg,").unwrap();
+       for (field, clone_fn, _) in generated_fields.iter() {
+               if let Some(f) = clone_fn {
+                       // If the field isn't clonable, blindly assume its a trait and hope for the best.
+                       writeln!(w, "\t\t{}: {}(&orig.{}),", field, f, field).unwrap();
+               } else {
+                       writeln!(w, "\t\t{}: Clone::clone(&orig.{}),", field, field).unwrap();
+               }
+       }
+       writeln!(w, "\t}}\n}}").unwrap();
 
        // Implement supertraits for the C-mapped struct.
        walk_supertraits!(t, Some(&types), (
-               ("Send", _) => writeln!(w, "unsafe impl Send for {} {{}}", trait_name).unwrap(),
-               ("Sync", _) => writeln!(w, "unsafe impl Sync for {} {{}}", trait_name).unwrap(),
-               ("std::cmp::Eq", _) => {
+               ("std::cmp::Eq", _)|("core::cmp::Eq", _) => {
                        writeln!(w, "impl std::cmp::Eq for {} {{}}", trait_name).unwrap();
                        writeln!(w, "impl std::cmp::PartialEq for {} {{", trait_name).unwrap();
                        writeln!(w, "\tfn eq(&self, o: &Self) -> bool {{ (self.eq)(self.this_arg, o) }}\n}}").unwrap();
                },
-               ("std::hash::Hash", _) => {
+               ("std::hash::Hash", _)|("core::hash::Hash", _) => {
                        writeln!(w, "impl std::hash::Hash for {} {{", trait_name).unwrap();
                        writeln!(w, "\tfn hash<H: std::hash::Hasher>(&self, hasher: &mut H) {{ hasher.write_u64((self.hash)(self.this_arg)) }}\n}}").unwrap();
                },
+               ("Send", _) => {}, ("Sync", _) => {},
                ("Clone", _) => {
                        writeln!(w, "#[no_mangle]").unwrap();
                        writeln!(w, "/// Creates a copy of a {}", trait_name).unwrap();
                        writeln!(w, "pub extern \"C\" fn {}_clone(orig: &{}) -> {} {{", trait_name, trait_name, trait_name).unwrap();
-                       writeln!(w, "\t{} {{", trait_name).unwrap();
-                       writeln!(w, "\t\tthis_arg: if let Some(f) = orig.clone {{ (f)(orig.this_arg) }} else {{ orig.this_arg }},").unwrap();
-                       for (field, clonable) in generated_fields.iter() {
-                               if *clonable {
-                                       writeln!(w, "\t\t{}: Clone::clone(&orig.{}),", field, field).unwrap();
-                               } else {
-                                       writeln!(w, "\t\t{}: (orig.{}_clone)(&orig.{}),", field, field, field).unwrap();
-                                       writeln!(w, "\t\t{}_clone: orig.{}_clone,", field, field).unwrap();
-                               }
-                       }
-                       writeln!(w, "\t}}\n}}").unwrap();
+                       writeln!(w, "\tlet mut res = {}_clone_fields(orig);", trait_name).unwrap();
+                       writeln!(w, "\tif let Some(f) = orig.cloned {{ (f)(&mut res) }};").unwrap();
+                       writeln!(w, "\tres\n}}").unwrap();
                        writeln!(w, "impl Clone for {} {{", trait_name).unwrap();
                        writeln!(w, "\tfn clone(&self) -> Self {{").unwrap();
                        writeln!(w, "\t\t{}_clone(self)", trait_name).unwrap();
@@ -492,11 +506,6 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty
                                writeln!(w, "impl {} for {} {{", s, trait_name).unwrap();
                                impl_trait_for_c!(supertrait, format!(".{}", i), &resolver);
                                writeln!(w, "}}").unwrap();
-                               walk_supertraits!(supertrait, Some(&types), (
-                                       ("Send", _) => writeln!(w, "unsafe impl Send for {} {{}}", trait_name).unwrap(),
-                                       ("Sync", _) => writeln!(w, "unsafe impl Sync for {} {{}}", trait_name).unwrap(),
-                                       _ => unimplemented!()
-                               ) );
                        } else {
                                do_write_impl_trait(w, s, i, &trait_name);
                        }
@@ -505,15 +514,17 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty
 
        // Finally, implement the original Rust trait for the newly created mapped trait.
        writeln!(w, "\nuse {}::{} as rust{};", types.module_path, t.ident, trait_name).unwrap();
-       write!(w, "impl rust{}", t.ident).unwrap();
-       maybe_write_generics(w, &t.generics, types, false);
-       writeln!(w, " for {} {{", trait_name).unwrap();
-       impl_trait_for_c!(t, "", types);
-       writeln!(w, "}}\n").unwrap();
-       writeln!(w, "// We're essentially a pointer already, or at least a set of pointers, so allow us to be used").unwrap();
-       writeln!(w, "// directly as a Deref trait in higher-level structs:").unwrap();
-       writeln!(w, "impl std::ops::Deref for {} {{\n\ttype Target = Self;", trait_name).unwrap();
-       writeln!(w, "\tfn deref(&self) -> &Self {{\n\t\tself\n\t}}\n}}").unwrap();
+       if implementable {
+               write!(w, "impl rust{}", t.ident).unwrap();
+               maybe_write_generics(w, &t.generics, types, false);
+               writeln!(w, " for {} {{", trait_name).unwrap();
+               impl_trait_for_c!(t, "", types);
+               writeln!(w, "}}\n").unwrap();
+               writeln!(w, "// We're essentially a pointer already, or at least a set of pointers, so allow us to be used").unwrap();
+               writeln!(w, "// directly as a Deref trait in higher-level structs:").unwrap();
+               writeln!(w, "impl std::ops::Deref for {} {{\n\ttype Target = Self;", trait_name).unwrap();
+               writeln!(w, "\tfn deref(&self) -> &Self {{\n\t\tself\n\t}}\n}}").unwrap();
+       }
 
        writeln!(w, "/// Calls the free function if one is set").unwrap();
        writeln!(w, "#[no_mangle]\npub extern \"C\" fn {}_free(this_ptr: {}) {{ }}", trait_name, trait_name).unwrap();
@@ -523,7 +534,8 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty
        writeln!(w, "\t\t\tf(self.this_arg);").unwrap();
        writeln!(w, "\t\t}}\n\t}}\n}}").unwrap();
 
-       write_cpp_wrapper(cpp_headers, &trait_name, true);
+       write_cpp_wrapper(cpp_headers, &trait_name, true, Some(generated_fields.drain(..)
+               .filter_map(|(name, _, docs)| if let Some(docs) = docs { Some((name, docs)) } else { None }).collect()));
 }
 
 /// Write out a simple "opaque" type (eg structs) which contain a pointer to the native Rust type
@@ -551,7 +563,7 @@ fn writeln_opaque<W: std::io::Write>(w: &mut W, ident: &syn::Ident, struct_name:
        writeln!(w, "}}\n").unwrap();
        writeln!(w, "impl Drop for {} {{\n\tfn drop(&mut self) {{", struct_name).unwrap();
        writeln!(w, "\t\tif self.is_owned && !<*mut native{}>::is_null(self.inner) {{", ident).unwrap();
-       writeln!(w, "\t\t\tlet _ = unsafe {{ Box::from_raw(self.inner) }};\n\t\t}}\n\t}}\n}}").unwrap();
+       writeln!(w, "\t\t\tlet _ = unsafe {{ Box::from_raw(ObjOps::untweak_ptr(self.inner)) }};\n\t\t}}\n\t}}\n}}").unwrap();
        writeln!(w, "/// Frees any resources used by the {}, if is_owned is set and inner is non-NULL.", struct_name).unwrap();
        writeln!(w, "#[no_mangle]\npub extern \"C\" fn {}_free(this_obj: {}) {{ }}", struct_name, struct_name).unwrap();
        writeln!(w, "#[allow(unused)]").unwrap();
@@ -559,16 +571,22 @@ fn writeln_opaque<W: std::io::Write>(w: &mut W, ident: &syn::Ident, struct_name:
        writeln!(w, "extern \"C\" fn {}_free_void(this_ptr: *mut c_void) {{", struct_name).unwrap();
        writeln!(w, "\tunsafe {{ let _ = Box::from_raw(this_ptr as *mut native{}); }}\n}}", struct_name).unwrap();
        writeln!(w, "#[allow(unused)]").unwrap();
-       writeln!(w, "/// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy").unwrap();
        writeln!(w, "impl {} {{", struct_name).unwrap();
+       writeln!(w, "\tpub(crate) fn get_native_ref(&self) -> &'static native{} {{", struct_name).unwrap();
+       writeln!(w, "\t\tunsafe {{ &*ObjOps::untweak_ptr(self.inner) }}").unwrap();
+       writeln!(w, "\t}}").unwrap();
+       writeln!(w, "\tpub(crate) fn get_native_mut_ref(&self) -> &'static mut native{} {{", struct_name).unwrap();
+       writeln!(w, "\t\tunsafe {{ &mut *ObjOps::untweak_ptr(self.inner) }}").unwrap();
+       writeln!(w, "\t}}").unwrap();
+       writeln!(w, "\t/// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy").unwrap();
        writeln!(w, "\tpub(crate) fn take_inner(mut self) -> *mut native{} {{", struct_name).unwrap();
        writeln!(w, "\t\tassert!(self.is_owned);").unwrap();
-       writeln!(w, "\t\tlet ret = self.inner;").unwrap();
+       writeln!(w, "\t\tlet ret = ObjOps::untweak_ptr(self.inner);").unwrap();
        writeln!(w, "\t\tself.inner = std::ptr::null_mut();").unwrap();
        writeln!(w, "\t\tret").unwrap();
        writeln!(w, "\t}}\n}}").unwrap();
 
-       write_cpp_wrapper(cpp_headers, &format!("{}", ident), true);
+       write_cpp_wrapper(cpp_headers, &format!("{}", ident), true, None);
 }
 
 /// Writes out all the relevant mappings for a Rust struct, deferring to writeln_opaque to generate
@@ -597,6 +615,7 @@ fn writeln_struct<'a, 'b, W: std::io::Write>(w: &mut W, s: &'a syn::ItemStruct,
                                                all_fields_settable = false;
                                                continue
                                        },
+                                       ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
                                }
 
                                if let Some(ident) = &field.ident {
@@ -604,10 +623,10 @@ fn writeln_struct<'a, 'b, W: std::io::Write>(w: &mut W, s: &'a syn::ItemStruct,
                                                and_token: syn::Token!(&)(Span::call_site()), lifetime: None, mutability: None,
                                                elem: Box::new(field.ty.clone()) });
                                        if types.understood_c_type(&ref_type, Some(&gen_types)) {
-                                               writeln_docs(w, &field.attrs, "");
+                                               writeln_arg_docs(w, &field.attrs, "", types, Some(&gen_types), vec![].drain(..), Some(&ref_type));
                                                write!(w, "#[no_mangle]\npub extern \"C\" fn {}_get_{}(this_ptr: &{}) -> ", struct_name, ident, struct_name).unwrap();
                                                types.write_c_type(w, &ref_type, Some(&gen_types), true);
-                                               write!(w, " {{\n\tlet mut inner_val = &mut unsafe {{ &mut *this_ptr.inner }}.{};\n\t", ident).unwrap();
+                                               write!(w, " {{\n\tlet mut inner_val = &mut this_ptr.get_native_mut_ref().{};\n\t", ident).unwrap();
                                                let local_var = types.write_to_c_conversion_new_var(w, &format_ident!("inner_val"), &ref_type, Some(&gen_types), true);
                                                if local_var { write!(w, "\n\t").unwrap(); }
                                                types.write_to_c_conversion_inline_prefix(w, &ref_type, Some(&gen_types), true);
@@ -617,13 +636,13 @@ fn writeln_struct<'a, 'b, W: std::io::Write>(w: &mut W, s: &'a syn::ItemStruct,
                                        }
 
                                        if types.understood_c_type(&field.ty, Some(&gen_types)) {
-                                               writeln_docs(w, &field.attrs, "");
+                                               writeln_arg_docs(w, &field.attrs, "", types, Some(&gen_types), vec![("val".to_owned(), &field.ty)].drain(..), None);
                                                write!(w, "#[no_mangle]\npub extern \"C\" fn {}_set_{}(this_ptr: &mut {}, mut val: ", struct_name, ident, struct_name).unwrap();
                                                types.write_c_type(w, &field.ty, Some(&gen_types), false);
                                                write!(w, ") {{\n\t").unwrap();
                                                let local_var = types.write_from_c_conversion_new_var(w, &format_ident!("val"), &field.ty, Some(&gen_types));
                                                if local_var { write!(w, "\n\t").unwrap(); }
-                                               write!(w, "unsafe {{ &mut *this_ptr.inner }}.{} = ", ident).unwrap();
+                                               write!(w, "unsafe {{ &mut *ObjOps::untweak_ptr(this_ptr.inner) }}.{} = ", ident).unwrap();
                                                types.write_from_c_conversion_prefix(w, &field.ty, Some(&gen_types));
                                                write!(w, "val").unwrap();
                                                types.write_from_c_conversion_suffix(w, &field.ty, Some(&gen_types));
@@ -649,7 +668,7 @@ fn writeln_struct<'a, 'b, W: std::io::Write>(w: &mut W, s: &'a syn::ItemStruct,
                                        write!(w, "\n\t").unwrap();
                                }
                        }
-                       writeln!(w, "{} {{ inner: Box::into_raw(Box::new(native{} {{", struct_name, s.ident).unwrap();
+                       writeln!(w, "{} {{ inner: ObjOps::heap_alloc(native{} {{", struct_name, s.ident).unwrap();
                        for field in fields.named.iter() {
                                write!(w, "\t\t{}: ", field.ident.as_ref().unwrap()).unwrap();
                                types.write_from_c_conversion_prefix(w, &field.ty, Some(&gen_types));
@@ -657,7 +676,7 @@ fn writeln_struct<'a, 'b, W: std::io::Write>(w: &mut W, s: &'a syn::ItemStruct,
                                types.write_from_c_conversion_suffix(w, &field.ty, Some(&gen_types));
                                writeln!(w, ",").unwrap();
                        }
-                       writeln!(w, "\t}})), is_owned: true }}\n}}").unwrap();
+                       writeln!(w, "\t}}), is_owned: true }}\n}}").unwrap();
                }
        }
 }
@@ -675,6 +694,7 @@ fn writeln_impl<W: std::io::Write>(w: &mut W, i: &syn::ItemImpl, types: &mut Typ
        match export_status(&i.attrs) {
                ExportStatus::Export => {},
                ExportStatus::NoExport|ExportStatus::TestOnly => return,
+               ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
        }
 
        if let syn::Type::Tuple(_) = &*i.self_ty {
@@ -739,7 +759,7 @@ fn writeln_impl<W: std::io::Write>(w: &mut W, i: &syn::ItemImpl, types: &mut Typ
 
                                                let export = export_status(&trait_obj.attrs);
                                                match export {
-                                                       ExportStatus::Export => {},
+                                                       ExportStatus::Export|ExportStatus::NotImplementable => {},
                                                        ExportStatus::NoExport|ExportStatus::TestOnly => return,
                                                }
 
@@ -750,7 +770,7 @@ fn writeln_impl<W: std::io::Write>(w: &mut W, i: &syn::ItemImpl, types: &mut Typ
                                                // type-conversion logic without actually knowing the concrete native type.
                                                writeln!(w, "impl From<native{}> for crate::{} {{", ident, full_trait_path).unwrap();
                                                writeln!(w, "\tfn from(obj: native{}) -> Self {{", ident).unwrap();
-                                               writeln!(w, "\t\tlet mut rust_obj = {} {{ inner: Box::into_raw(Box::new(obj)), is_owned: true }};", ident).unwrap();
+                                               writeln!(w, "\t\tlet mut rust_obj = {} {{ inner: ObjOps::heap_alloc(obj), is_owned: true }};", ident).unwrap();
                                                writeln!(w, "\t\tlet mut ret = {}_as_{}(&rust_obj);", ident, trait_obj.ident).unwrap();
                                                writeln!(w, "\t\t// We want to free rust_obj when ret gets drop()'d, not rust_obj, so wipe rust_obj's pointer and set ret's free() fn").unwrap();
                                                writeln!(w, "\t\trust_obj.inner = std::ptr::null_mut();").unwrap();
@@ -761,7 +781,7 @@ fn writeln_impl<W: std::io::Write>(w: &mut W, i: &syn::ItemImpl, types: &mut Typ
                                                writeln!(w, "/// This copies the `inner` pointer in this_arg and thus the returned {} must be freed before this_arg is", trait_obj.ident).unwrap();
                                                write!(w, "#[no_mangle]\npub extern \"C\" fn {}_as_{}(this_arg: &{}) -> crate::{} {{\n", ident, trait_obj.ident, ident, full_trait_path).unwrap();
                                                writeln!(w, "\tcrate::{} {{", full_trait_path).unwrap();
-                                               writeln!(w, "\t\tthis_arg: unsafe {{ (*this_arg).inner as *mut c_void }},").unwrap();
+                                               writeln!(w, "\t\tthis_arg: unsafe {{ ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void }},").unwrap();
                                                writeln!(w, "\t\tfree: None,").unwrap();
 
                                                macro_rules! write_meth {
@@ -776,6 +796,7 @@ fn writeln_impl<W: std::io::Write>(w: &mut W, i: &syn::ItemImpl, types: &mut Typ
                                                                                continue;
                                                                        },
                                                                        ExportStatus::TestOnly => continue,
+                                                                       ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
                                                                }
 
                                                                let mut printed = false;
@@ -801,20 +822,17 @@ fn writeln_impl<W: std::io::Write>(w: &mut W, i: &syn::ItemImpl, types: &mut Typ
                                                        }
                                                }
                                                let mut requires_clone = false;
-                                               walk_supertraits!(trait_obj, Some(&types), (
-                                                       ("Clone", _) => requires_clone = true,
-                                                       (_, _) => {}
-                                               ) );
                                                walk_supertraits!(trait_obj, Some(&types), (
                                                        ("Clone", _) => {
-                                                               writeln!(w, "\t\tclone: Some({}_clone_void),", ident).unwrap();
+                                                               requires_clone = true;
+                                                               writeln!(w, "\t\tcloned: Some({}_{}_cloned),", trait_obj.ident, ident).unwrap();
                                                        },
                                                        ("Sync", _) => {}, ("Send", _) => {},
                                                        ("std::marker::Sync", _) => {}, ("std::marker::Send", _) => {},
                                                        (s, t) => {
                                                                if let Some(supertrait_obj) = types.crate_types.traits.get(s) {
                                                                        writeln!(w, "\t\t{}: crate::{} {{", t, s).unwrap();
-                                                                       writeln!(w, "\t\t\tthis_arg: unsafe {{ (*this_arg).inner as *mut c_void }},").unwrap();
+                                                                       writeln!(w, "\t\t\tthis_arg: unsafe {{ ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void }},").unwrap();
                                                                        writeln!(w, "\t\t\tfree: None,").unwrap();
                                                                        for item in supertrait_obj.items.iter() {
                                                                                match item {
@@ -825,9 +843,6 @@ fn writeln_impl<W: std::io::Write>(w: &mut W, i: &syn::ItemImpl, types: &mut Typ
                                                                                }
                                                                        }
                                                                        write!(w, "\t\t}},\n").unwrap();
-                                                                       if !types.is_clonable(s) && requires_clone {
-                                                                               writeln!(w, "\t\t{}_clone: {}_{}_clone,", t, ident, t).unwrap();
-                                                                       }
                                                                } else {
                                                                        write_trait_impl_field_assign(w, s, ident);
                                                                }
@@ -843,6 +858,7 @@ fn writeln_impl<W: std::io::Write>(w: &mut W, i: &syn::ItemImpl, types: &mut Typ
                                                                match export_status(&trait_method.attrs) {
                                                                        ExportStatus::Export => {},
                                                                        ExportStatus::NoExport|ExportStatus::TestOnly => continue,
+                                                                       ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
                                                                }
 
                                                                if let syn::ReturnType::Type(_, _) = &$m.sig.output {
@@ -911,42 +927,82 @@ fn writeln_impl<W: std::io::Write>(w: &mut W, i: &syn::ItemImpl, types: &mut Typ
                                                                _ => unimplemented!(),
                                                        }
                                                }
-                                               walk_supertraits!(trait_obj, Some(&types), (
-                                                       (s, t) => {
-                                                               if let Some(supertrait_obj) = types.crate_types.traits.get(s) {
-                                                                       if !types.is_clonable(s) && requires_clone {
-                                                                               writeln!(w, "extern \"C\" fn {}_{}_clone(orig: &crate::{}) -> crate::{} {{", ident, t, s, s).unwrap();
-                                                                               writeln!(w, "\tcrate::{} {{", s).unwrap();
-                                                                               writeln!(w, "\t\tthis_arg: orig.this_arg,").unwrap();
-                                                                               writeln!(w, "\t\tfree: None,").unwrap();
-                                                                               for item in supertrait_obj.items.iter() {
-                                                                                       match item {
-                                                                                               syn::TraitItem::Method(m) => {
-                                                                                                       write_meth!(m, supertrait_obj, "");
-                                                                                               },
-                                                                                               _ => {},
-                                                                                       }
-                                                                               }
-                                                                               write!(w, "\t}}\n}}\n").unwrap();
+                                               if requires_clone {
+                                                       writeln!(w, "extern \"C\" fn {}_{}_cloned(new_obj: &mut crate::{}) {{", trait_obj.ident, ident, full_trait_path).unwrap();
+                                                       writeln!(w, "\tnew_obj.this_arg = {}_clone_void(new_obj.this_arg);", ident).unwrap();
+                                                       writeln!(w, "\tnew_obj.free = Some({}_free_void);", ident).unwrap();
+                                                       walk_supertraits!(trait_obj, Some(&types), (
+                                                               (s, t) => {
+                                                                       if types.crate_types.traits.get(s).is_some() {
+                                                                               assert!(!types.is_clonable(s)); // We don't currently support cloning with a clonable supertrait
+                                                                               writeln!(w, "\tnew_obj.{}.this_arg = new_obj.this_arg;", t).unwrap();
+                                                                               writeln!(w, "\tnew_obj.{}.free = None;", t).unwrap();
                                                                        }
                                                                }
-                                                       }
-                                               ) );
+                                                       ) );
+                                                       writeln!(w, "}}").unwrap();
+                                               }
                                                write!(w, "\n").unwrap();
                                        } else if path_matches_nongeneric(&trait_path.1, &["From"]) {
                                        } else if path_matches_nongeneric(&trait_path.1, &["Default"]) {
                                                writeln!(w, "/// Creates a \"default\" {}. See struct and individual field documentaiton for details on which values are used.", ident).unwrap();
                                                write!(w, "#[must_use]\n#[no_mangle]\npub extern \"C\" fn {}_default() -> {} {{\n", ident, ident).unwrap();
-                                               write!(w, "\t{} {{ inner: Box::into_raw(Box::new(Default::default())), is_owned: true }}\n", ident).unwrap();
+                                               write!(w, "\t{} {{ inner: ObjOps::heap_alloc(Default::default()), is_owned: true }}\n", ident).unwrap();
                                                write!(w, "}}\n").unwrap();
                                        } else if path_matches_nongeneric(&trait_path.1, &["core", "cmp", "PartialEq"]) {
+                                       } else if path_matches_nongeneric(&trait_path.1, &["core", "cmp", "Eq"]) {
+                                               writeln!(w, "/// Checks if two {}s contain equal inner contents.", ident).unwrap();
+                                               writeln!(w, "/// This ignores pointers and is_owned flags and looks at the values in fields.").unwrap();
+                                               if types.c_type_has_inner_from_path(&resolved_path) {
+                                                       writeln!(w, "/// Two objects with NULL inner values will be considered \"equal\" here.").unwrap();
+                                               }
+                                               write!(w, "#[no_mangle]\npub extern \"C\" fn {}_eq(a: &{}, b: &{}) -> bool {{\n", ident, ident, ident).unwrap();
+                                               if types.c_type_has_inner_from_path(&resolved_path) {
+                                                       write!(w, "\tif a.inner == b.inner {{ return true; }}\n").unwrap();
+                                                       write!(w, "\tif a.inner.is_null() || b.inner.is_null() {{ return false; }}\n").unwrap();
+                                               }
+
+                                               let path = &p.path;
+                                               let ref_type: syn::Type = syn::parse_quote!(&#path);
+                                               assert!(!types.write_to_c_conversion_new_var(w, &format_ident!("a"), &*i.self_ty, Some(&gen_types), false), "We don't support new var conversions when comparing equality");
+
+                                               write!(w, "\tif ").unwrap();
+                                               types.write_from_c_conversion_prefix(w, &ref_type, Some(&gen_types));
+                                               write!(w, "a").unwrap();
+                                               types.write_from_c_conversion_suffix(w, &ref_type, Some(&gen_types));
+                                               write!(w, " == ").unwrap();
+                                               types.write_from_c_conversion_prefix(w, &ref_type, Some(&gen_types));
+                                               write!(w, "b").unwrap();
+                                               types.write_from_c_conversion_suffix(w, &ref_type, Some(&gen_types));
+
+                                               writeln!(w, " {{ true }} else {{ false }}\n}}").unwrap();
+                                       } else if path_matches_nongeneric(&trait_path.1, &["core", "hash", "Hash"]) {
+                                               writeln!(w, "/// Checks if two {}s contain equal inner contents.", ident).unwrap();
+                                               write!(w, "#[no_mangle]\npub extern \"C\" fn {}_hash(o: &{}) -> u64 {{\n", ident, ident).unwrap();
+                                               if types.c_type_has_inner_from_path(&resolved_path) {
+                                                       write!(w, "\tif o.inner.is_null() {{ return 0; }}\n").unwrap();
+                                               }
+
+                                               let path = &p.path;
+                                               let ref_type: syn::Type = syn::parse_quote!(&#path);
+                                               assert!(!types.write_to_c_conversion_new_var(w, &format_ident!("a"), &*i.self_ty, Some(&gen_types), false), "We don't support new var conversions when comparing equality");
+
+                                               writeln!(w, "\t// Note that we'd love to use std::collections::hash_map::DefaultHasher but it's not in core").unwrap();
+                                               writeln!(w, "\t#[allow(deprecated)]").unwrap();
+                                               writeln!(w, "\tlet mut hasher = core::hash::SipHasher::new();").unwrap();
+                                               write!(w, "\tstd::hash::Hash::hash(").unwrap();
+                                               types.write_from_c_conversion_prefix(w, &ref_type, Some(&gen_types));
+                                               write!(w, "o").unwrap();
+                                               types.write_from_c_conversion_suffix(w, &ref_type, Some(&gen_types));
+                                               writeln!(w, ", &mut hasher);").unwrap();
+                                               writeln!(w, "\tstd::hash::Hasher::finish(&hasher)\n}}").unwrap();
                                        } else if (path_matches_nongeneric(&trait_path.1, &["core", "clone", "Clone"]) || path_matches_nongeneric(&trait_path.1, &["Clone"])) &&
                                                        types.c_type_has_inner_from_path(&resolved_path) {
                                                writeln!(w, "impl Clone for {} {{", ident).unwrap();
                                                writeln!(w, "\tfn clone(&self) -> Self {{").unwrap();
                                                writeln!(w, "\t\tSelf {{").unwrap();
                                                writeln!(w, "\t\t\tinner: if <*mut native{}>::is_null(self.inner) {{ std::ptr::null_mut() }} else {{", ident).unwrap();
-                                               writeln!(w, "\t\t\t\tBox::into_raw(Box::new(unsafe {{ &*self.inner }}.clone())) }},").unwrap();
+                                               writeln!(w, "\t\t\t\tObjOps::heap_alloc(unsafe {{ &*ObjOps::untweak_ptr(self.inner) }}.clone()) }},").unwrap();
                                                writeln!(w, "\t\t\tis_owned: true,").unwrap();
                                                writeln!(w, "\t\t}}\n\t}}\n}}").unwrap();
                                                writeln!(w, "#[allow(unused)]").unwrap();
@@ -966,7 +1022,7 @@ fn writeln_impl<W: std::io::Write>(w: &mut W, i: &syn::ItemImpl, types: &mut Typ
                                                        writeln!(w, "#[no_mangle]").unwrap();
                                                        writeln!(w, "/// Read a {} object from a string", ident).unwrap();
                                                        writeln!(w, "pub extern \"C\" fn {}_from_str(s: crate::c_types::Str) -> {} {{", ident, container).unwrap();
-                                                       writeln!(w, "\tmatch {}::from_str(s.into()) {{", resolved_path).unwrap();
+                                                       writeln!(w, "\tmatch {}::from_str(s.into_str()) {{", resolved_path).unwrap();
                                                        writeln!(w, "\t\tOk(r) => {{").unwrap();
                                                        let new_var = types.write_to_c_conversion_new_var(w, &format_ident!("r"), &*i.self_ty, Some(&gen_types), false);
                                                        write!(w, "\t\t\tcrate::c_types::CResultTempl::ok(\n\t\t\t\t").unwrap();
@@ -974,7 +1030,7 @@ fn writeln_impl<W: std::io::Write>(w: &mut W, i: &syn::ItemImpl, types: &mut Typ
                                                        write!(w, "{}r", if new_var { "local_" } else { "" }).unwrap();
                                                        types.write_to_c_conversion_inline_suffix(w, &*i.self_ty, Some(&gen_types), false);
                                                        writeln!(w, "\n\t\t\t)\n\t\t}},").unwrap();
-                                                       writeln!(w, "\t\tErr(e) => crate::c_types::CResultTempl::err(0u8),").unwrap();
+                                                       writeln!(w, "\t\tErr(e) => crate::c_types::CResultTempl::err(()),").unwrap();
                                                        writeln!(w, "\t}}.into()\n}}").unwrap();
                                                }
                                        } else if path_matches_nongeneric(&trait_path.1, &["Display"]) {
@@ -1006,9 +1062,12 @@ fn writeln_impl<W: std::io::Write>(w: &mut W, i: &syn::ItemImpl, types: &mut Typ
                                                                        match export_status(&m.attrs) {
                                                                                ExportStatus::Export => {},
                                                                                ExportStatus::NoExport|ExportStatus::TestOnly => continue,
+                                                                               ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
                                                                        }
+                                                                       let mut meth_gen_types = gen_types.push_ctx();
+                                                                       assert!(meth_gen_types.learn_generics(&m.sig.generics, types));
                                                                        if m.defaultness.is_some() { unimplemented!(); }
-                                                                       writeln_docs(w, &m.attrs, "");
+                                                                       writeln_fn_docs(w, &m.attrs, "", types, Some(&meth_gen_types), m.sig.inputs.iter(), &m.sig.output);
                                                                        if let syn::ReturnType::Type(_, _) = &m.sig.output {
                                                                                writeln!(w, "#[must_use]").unwrap();
                                                                        }
@@ -1018,8 +1077,6 @@ fn writeln_impl<W: std::io::Write>(w: &mut W, i: &syn::ItemImpl, types: &mut Typ
                                                                                DeclType::StructImported => format!("{}", ident),
                                                                                _ => unimplemented!(),
                                                                        };
-                                                                       let mut meth_gen_types = gen_types.push_ctx();
-                                                                       assert!(meth_gen_types.learn_generics(&m.sig.generics, types));
                                                                        write_method_params(w, &m.sig, &ret_type, types, Some(&meth_gen_types), false, true);
                                                                        write!(w, " {{\n\t").unwrap();
                                                                        write_method_var_decl_body(w, &m.sig, "", types, Some(&meth_gen_types), false);
@@ -1042,9 +1099,9 @@ fn writeln_impl<W: std::io::Write>(w: &mut W, i: &syn::ItemImpl, types: &mut Typ
                                                                                                if takes_owned_self {
                                                                                                        write!(w, "(*unsafe {{ Box::from_raw(this_arg.take_inner()) }}).{}(", m.sig.ident).unwrap();
                                                                                                } else if takes_mut_self {
-                                                                                                       write!(w, "unsafe {{ &mut (*(this_arg.inner as *mut native{})) }}.{}(", ident, m.sig.ident).unwrap();
+                                                                                                       write!(w, "unsafe {{ &mut (*ObjOps::untweak_ptr(this_arg.inner as *mut native{})) }}.{}(", ident, m.sig.ident).unwrap();
                                                                                                } else {
-                                                                                                       write!(w, "unsafe {{ &*this_arg.inner }}.{}(", m.sig.ident).unwrap();
+                                                                                                       write!(w, "unsafe {{ &*ObjOps::untweak_ptr(this_arg.inner) }}.{}(", m.sig.ident).unwrap();
                                                                                                }
                                                                                        },
                                                                                        _ => unimplemented!(),
@@ -1119,6 +1176,23 @@ fn writeln_impl<W: std::io::Write>(w: &mut W, i: &syn::ItemImpl, types: &mut Typ
        }
 }
 
+/// Replaces upper case charachters with underscore followed by lower case except the first
+/// charachter and repeated upper case characthers (which are only made lower case).
+fn camel_to_snake_case(camel: &str) -> String {
+       let mut res = "".to_string();
+       let mut last_upper = -1;
+       for (idx, c) in camel.chars().enumerate() {
+               if c.is_uppercase() {
+                       if last_upper != idx as isize - 1 { res.push('_'); }
+                       res.push(c.to_lowercase().next().unwrap());
+                       last_upper = idx as isize;
+               } else {
+                       res.push(c);
+               }
+       }
+       res
+}
+
 
 /// Print a mapping of an enum. If all of the enum's fields are C-mapped in some form (or the enum
 /// is unitary), we generate an equivalent enum with all types replaced with their C mapped
@@ -1128,6 +1202,7 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type
        match export_status(&e.attrs) {
                ExportStatus::Export => {},
                ExportStatus::NoExport|ExportStatus::TestOnly => return,
+               ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
        }
 
        if is_enum_opaque(e) {
@@ -1141,36 +1216,74 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type
        assert!(gen_types.learn_generics(&e.generics, types));
 
        let mut needs_free = false;
+       let mut constr = Vec::new();
 
        writeln!(w, "#[must_use]\n#[derive(Clone)]\n#[repr(C)]\npub enum {} {{", e.ident).unwrap();
        for var in e.variants.iter() {
                assert_eq!(export_status(&var.attrs), ExportStatus::Export); // We can't partially-export a mirrored enum
                writeln_docs(w, &var.attrs, "\t");
                write!(w, "\t{}", var.ident).unwrap();
+               writeln!(&mut constr, "#[no_mangle]\n/// Utility method to constructs a new {}-variant {}", var.ident, e.ident).unwrap();
+               let constr_name = camel_to_snake_case(&format!("{}", var.ident));
+               write!(&mut constr, "pub extern \"C\" fn {}_{}(", e.ident, constr_name).unwrap();
+               let mut empty_tuple_variant = false;
                if let syn::Fields::Named(fields) = &var.fields {
                        needs_free = true;
                        writeln!(w, " {{").unwrap();
-                       for field in fields.named.iter() {
+                       for (idx, field) in fields.named.iter().enumerate() {
                                if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
-                               writeln_docs(w, &field.attrs, "\t\t");
+                               writeln_field_docs(w, &field.attrs, "\t\t", types, Some(&gen_types), &field.ty);
                                write!(w, "\t\t{}: ", field.ident.as_ref().unwrap()).unwrap();
+                               write!(&mut constr, "{}{}: ", if idx != 0 { ", " } else { "" }, field.ident.as_ref().unwrap()).unwrap();
                                types.write_c_type(w, &field.ty, Some(&gen_types), false);
+                               types.write_c_type(&mut constr, &field.ty, Some(&gen_types), false);
                                writeln!(w, ",").unwrap();
                        }
                        write!(w, "\t}}").unwrap();
                } else if let syn::Fields::Unnamed(fields) = &var.fields {
-                       needs_free = true;
-                       write!(w, "(").unwrap();
-                       for (idx, field) in fields.unnamed.iter().enumerate() {
-                               if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
-                               types.write_c_type(w, &field.ty, Some(&gen_types), false);
-                               if idx != fields.unnamed.len() - 1 {
-                                       write!(w, ",").unwrap();
+                       if fields.unnamed.len() == 1 {
+                               let mut empty_check = Vec::new();
+                               types.write_c_type(&mut empty_check, &fields.unnamed[0].ty, Some(&gen_types), false);
+                               if empty_check.is_empty() {
+                                       empty_tuple_variant = true;
+                               }
+                       }
+                       if !empty_tuple_variant {
+                               needs_free = true;
+                               write!(w, "(").unwrap();
+                               for (idx, field) in fields.unnamed.iter().enumerate() {
+                                       if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
+                                       write!(&mut constr, "{}: ", ('a' as u8 + idx as u8) as char).unwrap();
+                                       types.write_c_type(w, &field.ty, Some(&gen_types), false);
+                                       types.write_c_type(&mut constr, &field.ty, Some(&gen_types), false);
+                                       if idx != fields.unnamed.len() - 1 {
+                                               write!(w, ",").unwrap();
+                                               write!(&mut constr, ",").unwrap();
+                                       }
                                }
+                               write!(w, ")").unwrap();
                        }
-                       write!(w, ")").unwrap();
                }
                if var.discriminant.is_some() { unimplemented!(); }
+               write!(&mut constr, ") -> {} {{\n\t{}::{}", e.ident, e.ident, var.ident).unwrap();
+               if let syn::Fields::Named(fields) = &var.fields {
+                       writeln!(&mut constr, " {{").unwrap();
+                       for field in fields.named.iter() {
+                               writeln!(&mut constr, "\t\t{},", field.ident.as_ref().unwrap()).unwrap();
+                       }
+                       writeln!(&mut constr, "\t}}").unwrap();
+               } else if let syn::Fields::Unnamed(fields) = &var.fields {
+                       if !empty_tuple_variant {
+                               write!(&mut constr, "(").unwrap();
+                               for idx in 0..fields.unnamed.len() {
+                                       write!(&mut constr, "{}, ", ('a' as u8 + idx as u8) as char).unwrap();
+                               }
+                               writeln!(&mut constr, ")").unwrap();
+                       } else {
+                               writeln!(&mut constr, "").unwrap();
+                       }
+               }
+               writeln!(&mut constr, "}}").unwrap();
                writeln!(w, ",").unwrap();
        }
        writeln!(w, "}}\nuse {}::{} as native{};\nimpl {} {{", types.module_path, e.ident, e.ident, e.ident).unwrap();
@@ -1180,6 +1293,7 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type
                        writeln!(w, "\t#[allow(unused)]\n\tpub(crate) fn {} {{\n\t\tmatch {} {{", $fn_sig, if $to_c { "native" } else { "self" }).unwrap();
                        for var in e.variants.iter() {
                                write!(w, "\t\t\t{}{}::{} ", if $to_c { "native" } else { "" }, e.ident, var.ident).unwrap();
+                               let mut empty_tuple_variant = false;
                                if let syn::Fields::Named(fields) = &var.fields {
                                        write!(w, "{{").unwrap();
                                        for field in fields.named.iter() {
@@ -1188,12 +1302,21 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type
                                        }
                                        write!(w, "}} ").unwrap();
                                } else if let syn::Fields::Unnamed(fields) = &var.fields {
-                                       write!(w, "(").unwrap();
-                                       for (idx, field) in fields.unnamed.iter().enumerate() {
-                                               if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
-                                               write!(w, "{}{}, ", if $ref { "ref " } else { "mut " }, ('a' as u8 + idx as u8) as char).unwrap();
+                                       if fields.unnamed.len() == 1 {
+                                               let mut empty_check = Vec::new();
+                                               types.write_c_type(&mut empty_check, &fields.unnamed[0].ty, Some(&gen_types), false);
+                                               if empty_check.is_empty() {
+                                                       empty_tuple_variant = true;
+                                               }
+                                       }
+                                       if !empty_tuple_variant || $to_c {
+                                               write!(w, "(").unwrap();
+                                               for (idx, field) in fields.unnamed.iter().enumerate() {
+                                                       if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
+                                                       write!(w, "{}{}, ", if $ref { "ref " } else { "mut " }, ('a' as u8 + idx as u8) as char).unwrap();
+                                               }
+                                               write!(w, ") ").unwrap();
                                        }
-                                       write!(w, ") ").unwrap();
                                }
                                write!(w, "=>").unwrap();
 
@@ -1233,7 +1356,9 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type
                                } else if let syn::Fields::Unnamed(fields) = &var.fields {
                                        write!(w, " {{\n\t\t\t\t").unwrap();
                                        for (idx, field) in fields.unnamed.iter().enumerate() {
-                                               handle_field_a!(field, &format_ident!("{}", ('a' as u8 + idx as u8) as char));
+                                               if !empty_tuple_variant {
+                                                       handle_field_a!(field, &format_ident!("{}", ('a' as u8 + idx as u8) as char));
+                                               }
                                        }
                                } else { write!(w, " ").unwrap(); }
 
@@ -1268,12 +1393,14 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type
                                        writeln!(w, "\n\t\t\t\t}}").unwrap();
                                        write!(w, "\t\t\t}}").unwrap();
                                } else if let syn::Fields::Unnamed(fields) = &var.fields {
-                                       write!(w, " (").unwrap();
-                                       for (idx, field) in fields.unnamed.iter().enumerate() {
-                                               write!(w, "\n\t\t\t\t\t").unwrap();
-                                               handle_field_b!(field, &format_ident!("{}", ('a' as u8 + idx as u8) as char));
+                                       if !empty_tuple_variant || !$to_c {
+                                               write!(w, " (").unwrap();
+                                               for (idx, field) in fields.unnamed.iter().enumerate() {
+                                                       write!(w, "\n\t\t\t\t\t").unwrap();
+                                                       handle_field_b!(field, &format_ident!("{}", ('a' as u8 + idx as u8) as char));
+                                               }
+                                               writeln!(w, "\n\t\t\t\t)").unwrap();
                                        }
-                                       writeln!(w, "\n\t\t\t\t)").unwrap();
                                        write!(w, "\t\t\t}}").unwrap();
                                }
                                writeln!(w, ",").unwrap();
@@ -1297,19 +1424,21 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type
        writeln!(w, "pub extern \"C\" fn {}_clone(orig: &{}) -> {} {{", e.ident, e.ident, e.ident).unwrap();
        writeln!(w, "\torig.clone()").unwrap();
        writeln!(w, "}}").unwrap();
-       write_cpp_wrapper(cpp_headers, &format!("{}", e.ident), needs_free);
+       w.write_all(&constr).unwrap();
+       write_cpp_wrapper(cpp_headers, &format!("{}", e.ident), needs_free, None);
 }
 
 fn writeln_fn<'a, 'b, W: std::io::Write>(w: &mut W, f: &'a syn::ItemFn, types: &mut TypeResolver<'b, 'a>) {
        match export_status(&f.attrs) {
                ExportStatus::Export => {},
                ExportStatus::NoExport|ExportStatus::TestOnly => return,
+               ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
        }
-       writeln_docs(w, &f.attrs, "");
-
        let mut gen_types = GenericTypes::new(None);
        if !gen_types.learn_generics(&f.sig.generics, types) { return; }
 
+       writeln_fn_docs(w, &f.attrs, "", types, Some(&gen_types), f.sig.inputs.iter(), &f.sig.output);
+
        write!(w, "#[no_mangle]\npub extern \"C\" fn {}(", f.sig.ident).unwrap();
        write_method_params(w, &f.sig, "", types, Some(&gen_types), false, true);
        write!(w, " {{\n\t").unwrap();
@@ -1398,6 +1527,7 @@ fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &CrateTypes<'a>
                        writeln!(out, "#![allow(unused_braces)]").unwrap();
                        // TODO: We need to map deny(missing_docs) in the source crate(s)
                        //writeln!(out, "#![deny(missing_docs)]").unwrap();
+                       writeln!(out, "pub mod version;").unwrap();
                        writeln!(out, "pub mod c_types;").unwrap();
                        writeln!(out, "pub mod bitcoin;").unwrap();
                } else {
@@ -1444,7 +1574,7 @@ fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &CrateTypes<'a>
                                                if let syn::Type::Path(p) = &*c.ty {
                                                        let resolved_path = type_resolver.resolve_path(&p.path, None);
                                                        if type_resolver.is_primitive(&resolved_path) {
-                                                               writeln_docs(&mut out, &c.attrs, "");
+                                                               writeln_field_docs(&mut out, &c.attrs, "", &mut type_resolver, None, &*c.ty);
                                                                writeln!(out, "\n#[no_mangle]").unwrap();
                                                                writeln!(out, "pub static {}: {} = {}::{};", c.ident, resolved_path, module, c.ident).unwrap();
                                                        }
@@ -1456,6 +1586,7 @@ fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &CrateTypes<'a>
                                                match export_status(&t.attrs) {
                                                        ExportStatus::Export => {},
                                                        ExportStatus::NoExport|ExportStatus::TestOnly => continue,
+                                                       ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
                                                }
 
                                                let mut process_alias = true;
@@ -1527,6 +1658,7 @@ fn walk_ast<'a>(ast_storage: &'a FullLibraryAST, crate_types: &mut CrateTypes<'a
                                                match export_status(&s.attrs) {
                                                        ExportStatus::Export => {},
                                                        ExportStatus::NoExport|ExportStatus::TestOnly => continue,
+                                                       ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
                                                }
                                                let struct_path = format!("{}::{}", module, s.ident);
                                                crate_types.opaques.insert(struct_path, &s.ident);
@@ -1535,7 +1667,7 @@ fn walk_ast<'a>(ast_storage: &'a FullLibraryAST, crate_types: &mut CrateTypes<'a
                                syn::Item::Trait(t) => {
                                        if let syn::Visibility::Public(_) = t.vis {
                                                match export_status(&t.attrs) {
-                                                       ExportStatus::Export => {},
+                                                       ExportStatus::Export|ExportStatus::NotImplementable => {},
                                                        ExportStatus::NoExport|ExportStatus::TestOnly => continue,
                                                }
                                                let trait_path = format!("{}::{}", module, t.ident);
@@ -1553,6 +1685,7 @@ fn walk_ast<'a>(ast_storage: &'a FullLibraryAST, crate_types: &mut CrateTypes<'a
                                                match export_status(&t.attrs) {
                                                        ExportStatus::Export => {},
                                                        ExportStatus::NoExport|ExportStatus::TestOnly => continue,
+                                                       ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
                                                }
                                                let type_path = format!("{}::{}", module, t.ident);
                                                let mut process_alias = true;
@@ -1587,6 +1720,7 @@ fn walk_ast<'a>(ast_storage: &'a FullLibraryAST, crate_types: &mut CrateTypes<'a
                                                match export_status(&e.attrs) {
                                                        ExportStatus::Export => {},
                                                        ExportStatus::NoExport|ExportStatus::TestOnly => continue,
+                                                       ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
                                                }
                                                let enum_path = format!("{}::{}", module, e.ident);
                                                crate_types.opaques.insert(enum_path, &e.ident);
@@ -1597,6 +1731,7 @@ fn walk_ast<'a>(ast_storage: &'a FullLibraryAST, crate_types: &mut CrateTypes<'a
                                                match export_status(&e.attrs) {
                                                        ExportStatus::Export => {},
                                                        ExportStatus::NoExport|ExportStatus::TestOnly => continue,
+                                                       ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
                                                }
                                                let enum_path = format!("{}::{}", module, e.ident);
                                                crate_types.mirrored_enums.insert(enum_path, &e);
@@ -1674,7 +1809,7 @@ fn main() {
        // For container templates which we created while walking the crate, make sure we add C++
        // mapped types so that C++ users can utilize the auto-destructors available.
        for (ty, has_destructor) in libtypes.templates_defined.borrow().iter() {
-               write_cpp_wrapper(&mut cpp_header_file, ty, *has_destructor);
+               write_cpp_wrapper(&mut cpp_header_file, ty, *has_destructor, None);
        }
        writeln!(cpp_header_file, "}}").unwrap();