blob: 4f703b1183b7db4024a33ecf38f434c2f53d632c [file] [log] [blame]
David Tolnayf3a9afa2020-10-08 23:22:12 -07001use crate::derive::DeriveAttribute;
David Tolnaya52602b2020-03-06 10:24:34 -08002use crate::syntax::atom::Atom::{self, *};
David Tolnay05ef6ff2020-08-29 11:27:05 -07003use crate::syntax::file::Module;
David Tolnay0dd85ff2020-05-03 23:43:33 -07004use crate::syntax::report::Errors;
David Tolnay891061b2020-04-19 22:42:33 -07005use crate::syntax::symbol::Symbol;
David Tolnay3caa50a2020-04-19 21:25:34 -07006use crate::syntax::{
David Tolnay8faec772020-11-02 00:18:19 -08007 self, check, mangle, Api, Enum, ExternFn, ExternType, Impl, Pair, ResolvableName, Signature,
Adrian Taylorc8713432020-10-21 18:20:55 -07008 Struct, Type, TypeAlias, Types,
David Tolnay3caa50a2020-04-19 21:25:34 -07009};
David Tolnay0531f432020-10-03 23:50:28 -070010use proc_macro2::{Ident, Span, TokenStream};
David Tolnayf9ffb932020-04-20 02:22:57 -070011use quote::{format_ident, quote, quote_spanned, ToTokens};
David Tolnay05ef6ff2020-08-29 11:27:05 -070012use std::mem;
13use syn::{parse_quote, Result, Token};
David Tolnay7db73692019-10-20 14:51:12 -040014
David Tolnay3c64a4e2020-08-29 14:07:38 -070015pub fn bridge(mut ffi: Module) -> Result<TokenStream> {
David Tolnay0dd85ff2020-05-03 23:43:33 -070016 let ref mut errors = Errors::new();
David Tolnay05ef6ff2020-08-29 11:27:05 -070017 let content = mem::take(&mut ffi.content);
David Tolnay805dca32020-08-29 19:09:55 -070018 let trusted = ffi.unsafety.is_some();
Adrian Taylorc8713432020-10-21 18:20:55 -070019 let namespace = &ffi.namespace;
20 let ref apis = syntax::parse_items(errors, content, trusted, namespace);
David Tolnay52759782020-05-03 23:59:40 -070021 let ref types = Types::collect(errors, apis);
22 errors.propagate()?;
Adrian Taylorc8713432020-10-21 18:20:55 -070023 check::typecheck(errors, apis, types);
David Tolnay0dd85ff2020-05-03 23:43:33 -070024 errors.propagate()?;
David Tolnay7db73692019-10-20 14:51:12 -040025
David Tolnay3c64a4e2020-08-29 14:07:38 -070026 Ok(expand(ffi, apis, types))
David Tolnaycbf3f032020-05-03 23:51:14 -070027}
28
David Tolnay3c64a4e2020-08-29 14:07:38 -070029fn expand(ffi: Module, apis: &[Api], types: &Types) -> TokenStream {
David Tolnay7db73692019-10-20 14:51:12 -040030 let mut expanded = TokenStream::new();
31 let mut hidden = TokenStream::new();
David Tolnay7db73692019-10-20 14:51:12 -040032
David Tolnay2ec14632020-05-04 00:47:10 -070033 for api in apis {
David Tolnay7db73692019-10-20 14:51:12 -040034 if let Api::RustType(ety) = api {
35 expanded.extend(expand_rust_type(ety));
David Tolnayc8361022020-08-25 21:57:53 -070036 hidden.extend(expand_rust_type_assert_sized(ety));
David Tolnay7db73692019-10-20 14:51:12 -040037 }
38 }
39
David Tolnay2ec14632020-05-04 00:47:10 -070040 for api in apis {
David Tolnay7db73692019-10-20 14:51:12 -040041 match api {
David Tolnay7e69f892020-10-03 22:20:22 -070042 Api::Include(_) | Api::RustType(_) | Api::Impl(_) => {}
Adrian Taylorc8713432020-10-21 18:20:55 -070043 Api::Struct(strct) => expanded.extend(expand_struct(strct)),
44 Api::Enum(enm) => expanded.extend(expand_enum(enm)),
Joel Galenson905eb2e2020-05-04 14:58:14 -070045 Api::CxxType(ety) => {
David Tolnay17a934c2020-11-02 00:40:04 -080046 let ident = &ety.name.rust;
47 if !types.structs.contains_key(ident) && !types.enums.contains_key(ident) {
Adrian Taylorc8713432020-10-21 18:20:55 -070048 expanded.extend(expand_cxx_type(ety));
David Tolnay9eef6092020-11-15 17:56:41 -080049 hidden.extend(expand_cxx_type_assert_pinned(ety));
Joel Galenson905eb2e2020-05-04 14:58:14 -070050 }
51 }
David Tolnay7db73692019-10-20 14:51:12 -040052 Api::CxxFunction(efn) => {
Adrian Taylorc8713432020-10-21 18:20:55 -070053 expanded.extend(expand_cxx_function_shim(efn, types));
David Tolnay7db73692019-10-20 14:51:12 -040054 }
Adrian Taylorc8713432020-10-21 18:20:55 -070055 Api::RustFunction(efn) => hidden.extend(expand_rust_function_shim(efn, types)),
David Tolnay5f9e8ca2020-05-07 17:21:05 -070056 Api::TypeAlias(alias) => {
57 expanded.extend(expand_type_alias(alias));
Adrian Taylorc8713432020-10-21 18:20:55 -070058 hidden.extend(expand_type_alias_verify(alias, types));
David Tolnay5f9e8ca2020-05-07 17:21:05 -070059 }
David Tolnay7db73692019-10-20 14:51:12 -040060 }
61 }
62
63 for ty in types {
David Tolnay0531f432020-10-03 23:50:28 -070064 let explicit_impl = types.explicit_impls.get(ty);
David Tolnay7db73692019-10-20 14:51:12 -040065 if let Type::RustBox(ty) = ty {
66 if let Type::Ident(ident) = &ty.inner {
Adrian Taylorc8713432020-10-21 18:20:55 -070067 if Atom::from(&ident.rust).is_none() {
68 hidden.extend(expand_rust_box(ident, types));
David Tolnay7db73692019-10-20 14:51:12 -040069 }
70 }
Myron Ahneba35cf2020-02-05 19:41:51 +070071 } else if let Type::RustVec(ty) = ty {
72 if let Type::Ident(ident) = &ty.inner {
Adrian Taylorc8713432020-10-21 18:20:55 -070073 if Atom::from(&ident.rust).is_none() {
74 hidden.extend(expand_rust_vec(ident, types));
David Tolnaya006bca2020-04-25 11:28:13 -070075 }
Myron Ahneba35cf2020-02-05 19:41:51 +070076 }
David Tolnay7db73692019-10-20 14:51:12 -040077 } else if let Type::UniquePtr(ptr) = ty {
78 if let Type::Ident(ident) = &ptr.inner {
Adrian Taylorc8713432020-10-21 18:20:55 -070079 if Atom::from(&ident.rust).is_none()
80 && (explicit_impl.is_some() || !types.aliases.contains_key(&ident.rust))
David Tolnay7e69f892020-10-03 22:20:22 -070081 {
Adrian Taylorc8713432020-10-21 18:20:55 -070082 expanded.extend(expand_unique_ptr(ident, types, explicit_impl));
Myron Ahneba35cf2020-02-05 19:41:51 +070083 }
84 }
David Tolnay4377a9e2020-04-24 15:20:26 -070085 } else if let Type::CxxVector(ptr) = ty {
Myron Ahneba35cf2020-02-05 19:41:51 +070086 if let Type::Ident(ident) = &ptr.inner {
Adrian Taylorc8713432020-10-21 18:20:55 -070087 if Atom::from(&ident.rust).is_none()
88 && (explicit_impl.is_some() || !types.aliases.contains_key(&ident.rust))
David Tolnay7e69f892020-10-03 22:20:22 -070089 {
David Tolnay17631102020-04-24 19:01:30 -070090 // Generate impl for CxxVector<T> if T is a struct or opaque
91 // C++ type. Impl for primitives is already provided by cxx
92 // crate.
Adrian Taylorc8713432020-10-21 18:20:55 -070093 expanded.extend(expand_cxx_vector(ident, explicit_impl, types));
David Tolnay7db73692019-10-20 14:51:12 -040094 }
95 }
96 }
97 }
98
99 // Work around https://github.com/rust-lang/rust/issues/67851.
100 if !hidden.is_empty() {
101 expanded.extend(quote! {
102 #[doc(hidden)]
103 const _: () = {
104 #hidden
105 };
106 });
107 }
108
109 let attrs = ffi
110 .attrs
111 .into_iter()
112 .filter(|attr| attr.path.is_ident("doc"));
113 let vis = &ffi.vis;
David Tolnaycbf3f032020-05-03 23:51:14 -0700114 let ident = &ffi.ident;
David Tolnay7db73692019-10-20 14:51:12 -0400115
David Tolnaycbf3f032020-05-03 23:51:14 -0700116 quote! {
David Tolnay7db73692019-10-20 14:51:12 -0400117 #(#attrs)*
118 #[deny(improper_ctypes)]
119 #[allow(non_snake_case)]
120 #vis mod #ident {
121 #expanded
122 }
David Tolnaycbf3f032020-05-03 23:51:14 -0700123 }
David Tolnay7db73692019-10-20 14:51:12 -0400124}
125
Adrian Taylorc8713432020-10-21 18:20:55 -0700126fn expand_struct(strct: &Struct) -> TokenStream {
David Tolnay17a934c2020-11-02 00:40:04 -0800127 let ident = &strct.name.rust;
David Tolnay7db73692019-10-20 14:51:12 -0400128 let doc = &strct.doc;
David Tolnayf3a9afa2020-10-08 23:22:12 -0700129 let derives = DeriveAttribute(&strct.derives);
David Tolnay17a934c2020-11-02 00:40:04 -0800130 let type_id = type_id(&strct.name);
David Tolnay7db73692019-10-20 14:51:12 -0400131 let fields = strct.fields.iter().map(|field| {
132 // This span on the pub makes "private type in public interface" errors
133 // appear in the right place.
134 let vis = Token![pub](field.ident.span());
135 quote!(#vis #field)
136 });
David Tolnay8684cc52020-10-07 17:09:48 -0700137
David Tolnay7db73692019-10-20 14:51:12 -0400138 quote! {
139 #doc
David Tolnayf3a9afa2020-10-08 23:22:12 -0700140 #derives
David Tolnay7db73692019-10-20 14:51:12 -0400141 #[repr(C)]
142 pub struct #ident {
143 #(#fields,)*
144 }
David Tolnay8684cc52020-10-07 17:09:48 -0700145
146 unsafe impl ::cxx::ExternType for #ident {
147 type Id = #type_id;
148 type Kind = ::cxx::kind::Trivial;
149 }
David Tolnay7db73692019-10-20 14:51:12 -0400150 }
151}
152
Adrian Taylorc8713432020-10-21 18:20:55 -0700153fn expand_enum(enm: &Enum) -> TokenStream {
David Tolnay17a934c2020-11-02 00:40:04 -0800154 let ident = &enm.name.rust;
Joel Galensonc03402a2020-04-23 17:31:09 -0700155 let doc = &enm.doc;
David Tolnayc605e6f2020-05-10 23:37:12 -0700156 let repr = enm.repr;
David Tolnay17a934c2020-11-02 00:40:04 -0800157 let type_id = type_id(&enm.name);
Joel Galenson88547732020-05-05 08:23:42 -0700158 let variants = enm.variants.iter().map(|variant| {
159 let variant_ident = &variant.ident;
160 let discriminant = &variant.discriminant;
161 Some(quote! {
162 pub const #variant_ident: Self = #ident { repr: #discriminant };
163 })
164 });
David Tolnay8684cc52020-10-07 17:09:48 -0700165
Joel Galensonc03402a2020-04-23 17:31:09 -0700166 quote! {
167 #doc
168 #[derive(Copy, Clone, PartialEq, Eq)]
169 #[repr(transparent)]
Joel Galensondb1ec312020-05-01 13:57:32 -0700170 pub struct #ident {
David Tolnayc605e6f2020-05-10 23:37:12 -0700171 pub repr: #repr,
Joel Galensondb1ec312020-05-01 13:57:32 -0700172 }
Joel Galensonc03402a2020-04-23 17:31:09 -0700173
174 #[allow(non_upper_case_globals)]
175 impl #ident {
David Tolnayd7984c22020-04-30 20:09:31 -0700176 #(#variants)*
Joel Galensonc03402a2020-04-23 17:31:09 -0700177 }
David Tolnay8684cc52020-10-07 17:09:48 -0700178
179 unsafe impl ::cxx::ExternType for #ident {
180 type Id = #type_id;
181 type Kind = ::cxx::kind::Trivial;
182 }
Joel Galensonc03402a2020-04-23 17:31:09 -0700183 }
184}
185
Adrian Taylorc8713432020-10-21 18:20:55 -0700186fn expand_cxx_type(ety: &ExternType) -> TokenStream {
David Tolnay17a934c2020-11-02 00:40:04 -0800187 let ident = &ety.name.rust;
David Tolnay7db73692019-10-20 14:51:12 -0400188 let doc = &ety.doc;
David Tolnay17a934c2020-11-02 00:40:04 -0800189 let type_id = type_id(&ety.name);
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700190
David Tolnay7db73692019-10-20 14:51:12 -0400191 quote! {
192 #doc
193 #[repr(C)]
194 pub struct #ident {
195 _private: ::cxx::private::Opaque,
196 }
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700197
198 unsafe impl ::cxx::ExternType for #ident {
199 type Id = #type_id;
David Tolnay38f5ad62020-10-03 18:06:44 -0700200 type Kind = ::cxx::kind::Opaque;
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700201 }
David Tolnay7db73692019-10-20 14:51:12 -0400202 }
203}
204
David Tolnay9eef6092020-11-15 17:56:41 -0800205fn expand_cxx_type_assert_pinned(ety: &ExternType) -> TokenStream {
206 let ident = &ety.name.rust;
207 let infer = Token![_](ident.span());
208
209 quote! {
210 let _ = {
211 // Derived from https://github.com/nvzqz/static-assertions-rs.
212 trait __AmbiguousIfImpl<A> {
213 fn infer() {}
214 }
215
216 impl<T: ?Sized> __AmbiguousIfImpl<()> for T {}
217
218 #[allow(dead_code)]
219 struct __Invalid;
220
221 impl<T: ?Sized + Unpin> __AmbiguousIfImpl<__Invalid> for T {}
222
223 // If there is only one specialized trait impl, type inference with
224 // `_` can be resolved and this can compile. Fails to compile if
225 // user has added a manual Unpin impl for their opaque C++ type as
226 // then `__AmbiguousIfImpl<__Invalid>` also exists.
227 <#ident as __AmbiguousIfImpl<#infer>>::infer
228 };
229 }
230}
231
Adrian Taylorc8713432020-10-21 18:20:55 -0700232fn expand_cxx_function_decl(efn: &ExternFn, types: &Types) -> TokenStream {
David Tolnay9938b642020-11-15 18:11:40 -0800233 let generics = &efn.generics;
David Tolnay18ba92c2020-04-22 16:17:30 -0700234 let receiver = efn.receiver.iter().map(|receiver| {
235 let receiver_type = receiver.ty();
236 quote!(_: #receiver_type)
237 });
David Tolnay39d575f2020-03-03 00:10:56 -0800238 let args = efn.args.iter().map(|arg| {
239 let ident = &arg.ident;
David Tolnay2f090422020-11-02 18:25:35 -0800240 let ty = expand_extern_type(&arg.ty, types, true);
David Tolnaya46a2372020-03-06 10:03:48 -0800241 if arg.ty == RustString {
242 quote!(#ident: *const #ty)
David Tolnay313b10e2020-04-25 16:30:51 -0700243 } else if let Type::RustVec(_) = arg.ty {
244 quote!(#ident: *const #ty)
David Tolnay75dca2e2020-03-25 20:17:52 -0700245 } else if let Type::Fn(_) = arg.ty {
246 quote!(#ident: ::cxx::private::FatFunction)
David Tolnaya46a2372020-03-06 10:03:48 -0800247 } else if types.needs_indirect_abi(&arg.ty) {
David Tolnay39d575f2020-03-03 00:10:56 -0800248 quote!(#ident: *mut #ty)
249 } else {
250 quote!(#ident: #ty)
251 }
252 });
Joel Galenson3d4f6122020-04-07 15:54:05 -0700253 let all_args = receiver.chain(args);
David Tolnayebef4a22020-03-17 15:33:47 -0700254 let ret = if efn.throws {
255 quote!(-> ::cxx::private::Result)
256 } else {
David Tolnay2f090422020-11-02 18:25:35 -0800257 expand_extern_return_type(&efn.ret, types, true)
David Tolnayebef4a22020-03-17 15:33:47 -0700258 };
David Tolnay7db73692019-10-20 14:51:12 -0400259 let mut outparam = None;
David Tolnay1e548172020-03-16 13:37:09 -0700260 if indirect_return(efn, types) {
David Tolnay2f090422020-11-02 18:25:35 -0800261 let ret = expand_extern_type(efn.ret.as_ref().unwrap(), types, true);
David Tolnay7db73692019-10-20 14:51:12 -0400262 outparam = Some(quote!(__return: *mut #ret));
263 }
Adrian Taylorc8713432020-10-21 18:20:55 -0700264 let link_name = mangle::extern_fn(efn, types);
David Tolnay17a934c2020-11-02 00:40:04 -0800265 let local_name = format_ident!("__{}", efn.name.rust);
David Tolnay7db73692019-10-20 14:51:12 -0400266 quote! {
267 #[link_name = #link_name]
David Tolnay9938b642020-11-15 18:11:40 -0800268 fn #local_name #generics(#(#all_args,)* #outparam) #ret;
David Tolnay7db73692019-10-20 14:51:12 -0400269 }
270}
271
Adrian Taylorc8713432020-10-21 18:20:55 -0700272fn expand_cxx_function_shim(efn: &ExternFn, types: &Types) -> TokenStream {
David Tolnay7db73692019-10-20 14:51:12 -0400273 let doc = &efn.doc;
Adrian Taylorc8713432020-10-21 18:20:55 -0700274 let decl = expand_cxx_function_decl(efn, types);
David Tolnayfb6e3862020-04-20 01:33:23 -0700275 let receiver = efn.receiver.iter().map(|receiver| {
David Tolnayf9ffb932020-04-20 02:22:57 -0700276 let var = receiver.var;
David Tolnayc9673842020-11-15 16:26:10 -0800277 if receiver.pinned {
278 let ty = receiver.ty();
279 quote!(#var: #ty)
280 } else {
281 let ampersand = receiver.ampersand;
David Tolnay9938b642020-11-15 18:11:40 -0800282 let lifetime = &receiver.lifetime;
David Tolnayc9673842020-11-15 16:26:10 -0800283 let mutability = receiver.mutability;
David Tolnay9938b642020-11-15 18:11:40 -0800284 quote!(#ampersand #lifetime #mutability #var)
David Tolnayc9673842020-11-15 16:26:10 -0800285 }
David Tolnayfb6e3862020-04-20 01:33:23 -0700286 });
Joel Galenson3d4f6122020-04-07 15:54:05 -0700287 let args = efn.args.iter().map(|arg| quote!(#arg));
288 let all_args = receiver.chain(args);
David Tolnayebef4a22020-03-17 15:33:47 -0700289 let ret = if efn.throws {
290 let ok = match &efn.ret {
291 Some(ret) => quote!(#ret),
292 None => quote!(()),
293 };
294 quote!(-> ::std::result::Result<#ok, ::cxx::Exception>)
295 } else {
296 expand_return_type(&efn.ret)
297 };
David Tolnay1e548172020-03-16 13:37:09 -0700298 let indirect_return = indirect_return(efn, types);
David Tolnayf9ffb932020-04-20 02:22:57 -0700299 let receiver_var = efn
300 .receiver
301 .iter()
302 .map(|receiver| receiver.var.to_token_stream());
Joel Galenson3d4f6122020-04-07 15:54:05 -0700303 let arg_vars = efn.args.iter().map(|arg| {
David Tolnay7db73692019-10-20 14:51:12 -0400304 let var = &arg.ident;
305 match &arg.ty {
Adrian Taylorc8713432020-10-21 18:20:55 -0700306 Type::Ident(ident) if ident.rust == RustString => {
David Tolnaya46a2372020-03-06 10:03:48 -0800307 quote!(#var.as_mut_ptr() as *const ::cxx::private::RustString)
David Tolnay7db73692019-10-20 14:51:12 -0400308 }
309 Type::RustBox(_) => quote!(::std::boxed::Box::into_raw(#var)),
David Tolnaybf7ae812020-11-16 23:31:45 -0800310 Type::UniquePtr(_) => quote!(::cxx::UniquePtr::into_raw(#var)),
David Tolnay313b10e2020-04-25 16:30:51 -0700311 Type::RustVec(_) => quote!(#var.as_mut_ptr() as *const ::cxx::private::RustVec<_>),
David Tolnay7db73692019-10-20 14:51:12 -0400312 Type::Ref(ty) => match &ty.inner {
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800313 Type::Ident(ident) if ident.rust == RustString => match ty.mutable {
314 false => quote!(::cxx::private::RustString::from_ref(#var)),
315 true => quote!(::cxx::private::RustString::from_mut(#var)),
David Tolnayf1c7f322020-08-27 00:46:01 -0700316 },
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800317 Type::RustVec(vec) if vec.inner == RustString => match ty.mutable {
318 false => quote!(::cxx::private::RustVec::from_ref_vec_string(#var)),
319 true => quote!(::cxx::private::RustVec::from_mut_vec_string(#var)),
David Tolnay33f56ad2020-08-27 17:06:35 -0700320 },
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800321 Type::RustVec(_) => match ty.mutable {
322 false => quote!(::cxx::private::RustVec::from_ref(#var)),
323 true => quote!(::cxx::private::RustVec::from_mut(#var)),
David Tolnayf1c7f322020-08-27 00:46:01 -0700324 },
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800325 inner if types.is_considered_improper_ctype(inner) => match ty.mutable {
326 false => quote!(#var as *const #inner as *const ::std::ffi::c_void),
327 true => quote!(#var as *mut #inner as *mut ::std::ffi::c_void),
David Tolnay4cb97672020-11-02 16:13:34 -0800328 },
David Tolnay7db73692019-10-20 14:51:12 -0400329 _ => quote!(#var),
330 },
331 Type::Str(_) => quote!(::cxx::private::RustStr::from(#var)),
Adrian Taylorf5dd5522020-04-13 16:50:14 -0700332 Type::SliceRefU8(_) => quote!(::cxx::private::RustSliceU8::from(#var)),
David Tolnay7db73692019-10-20 14:51:12 -0400333 ty if types.needs_indirect_abi(ty) => quote!(#var.as_mut_ptr()),
334 _ => quote!(#var),
335 }
336 });
Joel Galenson3d4f6122020-04-07 15:54:05 -0700337 let vars = receiver_var.chain(arg_vars);
David Tolnay75dca2e2020-03-25 20:17:52 -0700338 let trampolines = efn
339 .args
340 .iter()
341 .filter_map(|arg| {
342 if let Type::Fn(f) = &arg.ty {
343 let var = &arg.ident;
Adrian Taylorc8713432020-10-21 18:20:55 -0700344 Some(expand_function_pointer_trampoline(efn, var, f, types))
David Tolnay75dca2e2020-03-25 20:17:52 -0700345 } else {
346 None
347 }
348 })
349 .collect::<TokenStream>();
David Tolnay7db73692019-10-20 14:51:12 -0400350 let mut setup = efn
351 .args
352 .iter()
353 .filter(|arg| types.needs_indirect_abi(&arg.ty))
354 .map(|arg| {
355 let var = &arg.ident;
356 // These are arguments for which C++ has taken ownership of the data
357 // behind the mut reference it received.
358 quote! {
David Tolnaycb4ee4b2020-04-24 11:28:08 -0700359 let mut #var = ::std::mem::MaybeUninit::new(#var);
David Tolnay7db73692019-10-20 14:51:12 -0400360 }
361 })
362 .collect::<TokenStream>();
David Tolnay17a934c2020-11-02 00:40:04 -0800363 let local_name = format_ident!("__{}", efn.name.rust);
David Tolnay7db73692019-10-20 14:51:12 -0400364 let call = if indirect_return {
David Tolnay2f090422020-11-02 18:25:35 -0800365 let ret = expand_extern_type(efn.ret.as_ref().unwrap(), types, true);
David Tolnay7db73692019-10-20 14:51:12 -0400366 setup.extend(quote! {
367 let mut __return = ::std::mem::MaybeUninit::<#ret>::uninit();
David Tolnay7db73692019-10-20 14:51:12 -0400368 });
David Tolnay0d524852020-11-02 17:21:50 -0800369 setup.extend(if efn.throws {
370 quote! {
David Tolnayebef4a22020-03-17 15:33:47 -0700371 #local_name(#(#vars,)* __return.as_mut_ptr()).exception()?;
David Tolnay0d524852020-11-02 17:21:50 -0800372 }
David Tolnayebef4a22020-03-17 15:33:47 -0700373 } else {
David Tolnay0d524852020-11-02 17:21:50 -0800374 quote! {
David Tolnayebef4a22020-03-17 15:33:47 -0700375 #local_name(#(#vars,)* __return.as_mut_ptr());
David Tolnay0d524852020-11-02 17:21:50 -0800376 }
377 });
378 quote!(__return.assume_init())
David Tolnayebef4a22020-03-17 15:33:47 -0700379 } else if efn.throws {
David Tolnay7db73692019-10-20 14:51:12 -0400380 quote! {
David Tolnayebef4a22020-03-17 15:33:47 -0700381 #local_name(#(#vars),*).exception()
David Tolnay7db73692019-10-20 14:51:12 -0400382 }
383 } else {
384 quote! {
385 #local_name(#(#vars),*)
386 }
387 };
David Tolnay2debdb22020-11-02 17:14:53 -0800388 let mut expr;
389 if efn.throws && efn.sig.ret.is_none() {
390 expr = call;
Myron Ahn84849302020-03-25 22:00:58 +0700391 } else {
David Tolnay0d524852020-11-02 17:21:50 -0800392 expr = match &efn.ret {
393 None => call,
394 Some(ret) => match ret {
395 Type::Ident(ident) if ident.rust == RustString => quote!(#call.into_string()),
396 Type::RustBox(_) => quote!(::std::boxed::Box::from_raw(#call)),
David Tolnaya1f02e52020-11-02 17:10:54 -0800397 Type::RustVec(vec) => {
398 if vec.inner == RustString {
David Tolnay0d524852020-11-02 17:21:50 -0800399 quote!(#call.into_vec_string())
David Tolnaya1f02e52020-11-02 17:10:54 -0800400 } else {
David Tolnay0d524852020-11-02 17:21:50 -0800401 quote!(#call.into_vec())
David Tolnaya1f02e52020-11-02 17:10:54 -0800402 }
David Tolnay33f56ad2020-08-27 17:06:35 -0700403 }
David Tolnaybf7ae812020-11-16 23:31:45 -0800404 Type::UniquePtr(_) => quote!(::cxx::UniquePtr::from_raw(#call)),
David Tolnaya1f02e52020-11-02 17:10:54 -0800405 Type::Ref(ty) => match &ty.inner {
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800406 Type::Ident(ident) if ident.rust == RustString => match ty.mutable {
407 false => quote!(#call.as_string()),
408 true => quote!(#call.as_mut_string()),
David Tolnaya1f02e52020-11-02 17:10:54 -0800409 },
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800410 Type::RustVec(vec) if vec.inner == RustString => match ty.mutable {
411 false => quote!(#call.as_vec_string()),
412 true => quote!(#call.as_mut_vec_string()),
David Tolnaya1f02e52020-11-02 17:10:54 -0800413 },
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800414 Type::RustVec(_) => match ty.mutable {
415 false => quote!(#call.as_vec()),
416 true => quote!(#call.as_mut_vec()),
David Tolnaya1f02e52020-11-02 17:10:54 -0800417 },
David Tolnay4cb97672020-11-02 16:13:34 -0800418 inner if types.is_considered_improper_ctype(inner) => {
419 let mutability = ty.mutability;
420 quote!(&#mutability *#call.cast())
421 }
David Tolnay0d524852020-11-02 17:21:50 -0800422 _ => call,
David Tolnayf1c7f322020-08-27 00:46:01 -0700423 },
David Tolnay0d524852020-11-02 17:21:50 -0800424 Type::Str(_) => quote!(#call.as_str()),
425 Type::SliceRefU8(_) => quote!(#call.as_slice()),
426 _ => call,
427 },
428 };
David Tolnay2debdb22020-11-02 17:14:53 -0800429 if efn.throws {
430 expr = quote!(::std::result::Result::Ok(#expr));
431 }
David Tolnaya1f02e52020-11-02 17:10:54 -0800432 };
David Tolnaye67bcf52020-09-06 23:50:44 -0700433 let mut dispatch = quote!(#setup #expr);
434 let unsafety = &efn.sig.unsafety;
435 if unsafety.is_none() {
436 dispatch = quote!(unsafe { #dispatch });
437 }
David Tolnay17a934c2020-11-02 00:40:04 -0800438 let ident = &efn.name.rust;
David Tolnay9938b642020-11-15 18:11:40 -0800439 let generics = &efn.generics;
David Tolnayc66cdbb2020-04-20 01:41:15 -0700440 let function_shim = quote! {
441 #doc
David Tolnay9938b642020-11-15 18:11:40 -0800442 pub #unsafety fn #ident #generics(#(#all_args,)*) #ret {
David Tolnayc66cdbb2020-04-20 01:41:15 -0700443 extern "C" {
444 #decl
David Tolnay7db73692019-10-20 14:51:12 -0400445 }
David Tolnayc66cdbb2020-04-20 01:41:15 -0700446 #trampolines
David Tolnaye67bcf52020-09-06 23:50:44 -0700447 #dispatch
David Tolnayc66cdbb2020-04-20 01:41:15 -0700448 }
449 };
450 match &efn.receiver {
451 None => function_shim,
452 Some(receiver) => {
David Tolnay05e11cc2020-04-20 02:13:56 -0700453 let receiver_type = &receiver.ty;
David Tolnayc66cdbb2020-04-20 01:41:15 -0700454 quote!(impl #receiver_type { #function_shim })
455 }
David Tolnay7db73692019-10-20 14:51:12 -0400456 }
457}
458
David Tolnay75dca2e2020-03-25 20:17:52 -0700459fn expand_function_pointer_trampoline(
David Tolnay75dca2e2020-03-25 20:17:52 -0700460 efn: &ExternFn,
461 var: &Ident,
462 sig: &Signature,
463 types: &Types,
464) -> TokenStream {
Adrian Taylorc8713432020-10-21 18:20:55 -0700465 let c_trampoline = mangle::c_trampoline(efn, var, types);
466 let r_trampoline = mangle::r_trampoline(efn, var, types);
David Tolnay75dca2e2020-03-25 20:17:52 -0700467 let local_name = parse_quote!(__);
David Tolnay17a934c2020-11-02 00:40:04 -0800468 let catch_unwind_label = format!("::{}::{}", efn.name.rust, var);
David Tolnay75dca2e2020-03-25 20:17:52 -0700469 let shim = expand_rust_function_shim_impl(
470 sig,
471 types,
472 &r_trampoline,
473 local_name,
474 catch_unwind_label,
475 None,
476 );
477
478 quote! {
479 let #var = ::cxx::private::FatFunction {
480 trampoline: {
481 extern "C" {
482 #[link_name = #c_trampoline]
483 fn trampoline();
484 }
485 #shim
486 trampoline as usize as *const ()
487 },
488 ptr: #var as usize as *const (),
489 };
490 }
491}
492
David Tolnay7db73692019-10-20 14:51:12 -0400493fn expand_rust_type(ety: &ExternType) -> TokenStream {
David Tolnay17a934c2020-11-02 00:40:04 -0800494 let ident = &ety.name.rust;
David Tolnay7db73692019-10-20 14:51:12 -0400495 quote! {
496 use super::#ident;
497 }
498}
499
David Tolnayc8361022020-08-25 21:57:53 -0700500fn expand_rust_type_assert_sized(ety: &ExternType) -> TokenStream {
501 // Rustc will render as follows if not sized:
502 //
503 // type TheirType;
504 // -----^^^^^^^^^-
505 // | |
506 // | doesn't have a size known at compile-time
507 // required by this bound in `ffi::_::__AssertSized`
508
David Tolnay17a934c2020-11-02 00:40:04 -0800509 let ident = &ety.name.rust;
David Tolnayc8361022020-08-25 21:57:53 -0700510 let begin_span = Token![::](ety.type_token.span);
511 let sized = quote_spanned! {ety.semi_token.span=>
512 #begin_span std::marker::Sized
513 };
David Tolnay20fa62b2020-11-15 17:34:05 -0800514 let unpin = quote_spanned! {ety.semi_token.span=>
515 #begin_span std::marker::Unpin
516 };
David Tolnay17a934c2020-11-02 00:40:04 -0800517 quote_spanned! {ident.span()=>
David Tolnayc8361022020-08-25 21:57:53 -0700518 let _ = {
519 fn __AssertSized<T: ?#sized + #sized>() {}
David Tolnay20fa62b2020-11-15 17:34:05 -0800520 fn __AssertUnpin<T: #unpin>() {}
521 (__AssertSized::<#ident>, __AssertUnpin::<#ident>)
David Tolnayc8361022020-08-25 21:57:53 -0700522 };
523 }
524}
525
Adrian Taylorc8713432020-10-21 18:20:55 -0700526fn expand_rust_function_shim(efn: &ExternFn, types: &Types) -> TokenStream {
527 let link_name = mangle::extern_fn(efn, types);
David Tolnay17a934c2020-11-02 00:40:04 -0800528 let local_name = format_ident!("__{}", efn.name.rust);
529 let catch_unwind_label = format!("::{}", efn.name.rust);
530 let invoke = Some(&efn.name.rust);
David Tolnay75dca2e2020-03-25 20:17:52 -0700531 expand_rust_function_shim_impl(
532 efn,
533 types,
534 &link_name,
535 local_name,
536 catch_unwind_label,
537 invoke,
538 )
539}
540
541fn expand_rust_function_shim_impl(
542 sig: &Signature,
543 types: &Types,
David Tolnay891061b2020-04-19 22:42:33 -0700544 link_name: &Symbol,
David Tolnay75dca2e2020-03-25 20:17:52 -0700545 local_name: Ident,
546 catch_unwind_label: String,
547 invoke: Option<&Ident>,
548) -> TokenStream {
David Tolnay9938b642020-11-15 18:11:40 -0800549 let generics = &sig.generics;
David Tolnayf9ffb932020-04-20 02:22:57 -0700550 let receiver_var = sig
551 .receiver
552 .as_ref()
553 .map(|receiver| quote_spanned!(receiver.var.span=> __self));
David Tolnay18ba92c2020-04-22 16:17:30 -0700554 let receiver = sig.receiver.as_ref().map(|receiver| {
555 let receiver_type = receiver.ty();
556 quote!(#receiver_var: #receiver_type)
557 });
David Tolnay75dca2e2020-03-25 20:17:52 -0700558 let args = sig.args.iter().map(|arg| {
David Tolnay39d575f2020-03-03 00:10:56 -0800559 let ident = &arg.ident;
David Tolnay2f090422020-11-02 18:25:35 -0800560 let ty = expand_extern_type(&arg.ty, types, false);
David Tolnay39d575f2020-03-03 00:10:56 -0800561 if types.needs_indirect_abi(&arg.ty) {
562 quote!(#ident: *mut #ty)
563 } else {
564 quote!(#ident: #ty)
565 }
566 });
David Tolnayf9ffb932020-04-20 02:22:57 -0700567 let all_args = receiver.into_iter().chain(args);
David Tolnay75dca2e2020-03-25 20:17:52 -0700568
David Tolnay3a45f2d2020-04-20 01:51:12 -0700569 let arg_vars = sig.args.iter().map(|arg| {
David Tolnay7db73692019-10-20 14:51:12 -0400570 let ident = &arg.ident;
David Tolnay17955e22020-01-20 17:58:24 -0800571 match &arg.ty {
Adrian Taylorc8713432020-10-21 18:20:55 -0700572 Type::Ident(i) if i.rust == RustString => {
David Tolnaycc3767f2020-03-06 10:41:51 -0800573 quote!(::std::mem::take((*#ident).as_mut_string()))
574 }
David Tolnay40226ab2020-03-03 00:05:35 -0800575 Type::RustBox(_) => quote!(::std::boxed::Box::from_raw(#ident)),
David Tolnay33f56ad2020-08-27 17:06:35 -0700576 Type::RustVec(vec) => {
577 if vec.inner == RustString {
578 quote!(::std::mem::take((*#ident).as_mut_vec_string()))
579 } else {
580 quote!(::std::mem::take((*#ident).as_mut_vec()))
581 }
582 }
David Tolnaybf7ae812020-11-16 23:31:45 -0800583 Type::UniquePtr(_) => quote!(::cxx::UniquePtr::from_raw(#ident)),
David Tolnay17955e22020-01-20 17:58:24 -0800584 Type::Ref(ty) => match &ty.inner {
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800585 Type::Ident(i) if i.rust == RustString => match ty.mutable {
586 false => quote!(#ident.as_string()),
587 true => quote!(#ident.as_mut_string()),
David Tolnayf1c7f322020-08-27 00:46:01 -0700588 },
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800589 Type::RustVec(vec) if vec.inner == RustString => match ty.mutable {
590 false => quote!(#ident.as_vec_string()),
591 true => quote!(#ident.as_mut_vec_string()),
David Tolnay33f56ad2020-08-27 17:06:35 -0700592 },
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800593 Type::RustVec(_) => match ty.mutable {
594 false => quote!(#ident.as_vec()),
595 true => quote!(#ident.as_mut_vec()),
David Tolnayf1c7f322020-08-27 00:46:01 -0700596 },
David Tolnay40226ab2020-03-03 00:05:35 -0800597 _ => quote!(#ident),
David Tolnay17955e22020-01-20 17:58:24 -0800598 },
David Tolnay40226ab2020-03-03 00:05:35 -0800599 Type::Str(_) => quote!(#ident.as_str()),
Adrian Taylorf5dd5522020-04-13 16:50:14 -0700600 Type::SliceRefU8(_) => quote!(#ident.as_slice()),
David Tolnay40226ab2020-03-03 00:05:35 -0800601 ty if types.needs_indirect_abi(ty) => quote!(::std::ptr::read(#ident)),
602 _ => quote!(#ident),
David Tolnay7db73692019-10-20 14:51:12 -0400603 }
604 });
David Tolnayf9ffb932020-04-20 02:22:57 -0700605 let vars = receiver_var.into_iter().chain(arg_vars);
David Tolnay75dca2e2020-03-25 20:17:52 -0700606
David Tolnay26219462020-11-09 19:47:28 -0800607 let wrap_super = invoke.map(|invoke| expand_rust_function_shim_super(sig, &local_name, invoke));
608
David Tolnay75dca2e2020-03-25 20:17:52 -0700609 let mut call = match invoke {
David Tolnay26219462020-11-09 19:47:28 -0800610 Some(_) => quote!(#local_name),
David Tolnayb8ebeb02020-10-31 23:52:06 -0700611 None => quote!(::std::mem::transmute::<*const (), #sig>(__extern)),
David Tolnay75dca2e2020-03-25 20:17:52 -0700612 };
613 call.extend(quote! { (#(#vars),*) });
614
David Tolnay22602b42020-09-21 18:04:05 -0400615 let conversion = sig.ret.as_ref().and_then(|ret| match ret {
Adrian Taylorc8713432020-10-21 18:20:55 -0700616 Type::Ident(ident) if ident.rust == RustString => {
617 Some(quote!(::cxx::private::RustString::from))
618 }
David Tolnay22602b42020-09-21 18:04:05 -0400619 Type::RustBox(_) => Some(quote!(::std::boxed::Box::into_raw)),
620 Type::RustVec(vec) => {
621 if vec.inner == RustString {
622 Some(quote!(::cxx::private::RustVec::from_vec_string))
623 } else {
624 Some(quote!(::cxx::private::RustVec::from))
David Tolnay7db73692019-10-20 14:51:12 -0400625 }
David Tolnay22602b42020-09-21 18:04:05 -0400626 }
David Tolnaybf7ae812020-11-16 23:31:45 -0800627 Type::UniquePtr(_) => Some(quote!(::cxx::UniquePtr::into_raw)),
David Tolnay22602b42020-09-21 18:04:05 -0400628 Type::Ref(ty) => match &ty.inner {
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800629 Type::Ident(ident) if ident.rust == RustString => match ty.mutable {
630 false => Some(quote!(::cxx::private::RustString::from_ref)),
631 true => Some(quote!(::cxx::private::RustString::from_mut)),
David Tolnay7db73692019-10-20 14:51:12 -0400632 },
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800633 Type::RustVec(vec) if vec.inner == RustString => match ty.mutable {
634 false => Some(quote!(::cxx::private::RustVec::from_ref_vec_string)),
635 true => Some(quote!(::cxx::private::RustVec::from_mut_vec_string)),
David Tolnay22602b42020-09-21 18:04:05 -0400636 },
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800637 Type::RustVec(_) => match ty.mutable {
638 false => Some(quote!(::cxx::private::RustVec::from_ref)),
639 true => Some(quote!(::cxx::private::RustVec::from_mut)),
David Tolnay22602b42020-09-21 18:04:05 -0400640 },
David Tolnay7db73692019-10-20 14:51:12 -0400641 _ => None,
David Tolnay22602b42020-09-21 18:04:05 -0400642 },
643 Type::Str(_) => Some(quote!(::cxx::private::RustStr::from)),
644 Type::SliceRefU8(_) => Some(quote!(::cxx::private::RustSliceU8::from)),
645 _ => None,
646 });
647
648 let mut expr = match conversion {
649 None => call,
650 Some(conversion) if !sig.throws => quote!(#conversion(#call)),
651 Some(conversion) => quote!(::std::result::Result::map(#call, #conversion)),
652 };
David Tolnay75dca2e2020-03-25 20:17:52 -0700653
654 let mut outparam = None;
655 let indirect_return = indirect_return(sig, types);
David Tolnay1e548172020-03-16 13:37:09 -0700656 if indirect_return {
David Tolnay2f090422020-11-02 18:25:35 -0800657 let ret = expand_extern_type(sig.ret.as_ref().unwrap(), types, false);
David Tolnay75dca2e2020-03-25 20:17:52 -0700658 outparam = Some(quote!(__return: *mut #ret,));
David Tolnay1e548172020-03-16 13:37:09 -0700659 }
David Tolnay75dca2e2020-03-25 20:17:52 -0700660 if sig.throws {
661 let out = match sig.ret {
David Tolnaycecada62020-03-17 01:45:58 -0700662 Some(_) => quote!(__return),
663 None => quote!(&mut ()),
664 };
665 expr = quote!(::cxx::private::r#try(#out, #expr));
David Tolnay1e548172020-03-16 13:37:09 -0700666 } else if indirect_return {
David Tolnay7db73692019-10-20 14:51:12 -0400667 expr = quote!(::std::ptr::write(__return, #expr));
668 }
David Tolnay75dca2e2020-03-25 20:17:52 -0700669
David Tolnay1e548172020-03-16 13:37:09 -0700670 expr = quote!(::cxx::private::catch_unwind(__fn, move || #expr));
David Tolnay75dca2e2020-03-25 20:17:52 -0700671
672 let ret = if sig.throws {
David Tolnay486b6ec2020-03-17 01:19:57 -0700673 quote!(-> ::cxx::private::Result)
David Tolnay1e548172020-03-16 13:37:09 -0700674 } else {
David Tolnay2f090422020-11-02 18:25:35 -0800675 expand_extern_return_type(&sig.ret, types, false)
David Tolnay1e548172020-03-16 13:37:09 -0700676 };
David Tolnay75dca2e2020-03-25 20:17:52 -0700677
678 let pointer = match invoke {
David Tolnayb8ebeb02020-10-31 23:52:06 -0700679 None => Some(quote!(__extern: *const ())),
David Tolnay75dca2e2020-03-25 20:17:52 -0700680 Some(_) => None,
681 };
682
David Tolnay7db73692019-10-20 14:51:12 -0400683 quote! {
684 #[doc(hidden)]
685 #[export_name = #link_name]
David Tolnay9938b642020-11-15 18:11:40 -0800686 unsafe extern "C" fn #local_name #generics(#(#all_args,)* #outparam #pointer) #ret {
David Tolnay7db73692019-10-20 14:51:12 -0400687 let __fn = concat!(module_path!(), #catch_unwind_label);
David Tolnay26219462020-11-09 19:47:28 -0800688 #wrap_super
David Tolnay7db73692019-10-20 14:51:12 -0400689 #expr
690 }
691 }
692}
693
David Tolnay26219462020-11-09 19:47:28 -0800694// A wrapper like `fn f(x: Arg) { super::f(x) }` just to ensure we have the
695// accurate unsafety declaration and no problematic elided lifetimes.
696fn expand_rust_function_shim_super(
697 sig: &Signature,
698 local_name: &Ident,
699 invoke: &Ident,
700) -> TokenStream {
701 let unsafety = sig.unsafety;
David Tolnay9938b642020-11-15 18:11:40 -0800702 let generics = &sig.generics;
David Tolnay26219462020-11-09 19:47:28 -0800703
704 let receiver_var = sig
705 .receiver
706 .as_ref()
707 .map(|receiver| Ident::new("__self", receiver.var.span));
708 let receiver = sig.receiver.iter().map(|receiver| {
709 let receiver_type = receiver.ty();
710 quote!(#receiver_var: #receiver_type)
711 });
712 let args = sig.args.iter().map(|arg| quote!(#arg));
713 let all_args = receiver.chain(args);
714
David Tolnay5d164672020-11-09 20:23:17 -0800715 let ret = if let Some((result, _langle, rangle)) = sig.throws_tokens {
David Tolnay26219462020-11-09 19:47:28 -0800716 let ok = match &sig.ret {
717 Some(ret) => quote!(#ret),
718 None => quote!(()),
719 };
David Tolnay5d164672020-11-09 20:23:17 -0800720 let impl_trait = quote_spanned!(result.span=> impl);
721 let display = quote_spanned!(rangle.span=> ::std::fmt::Display);
722 quote!(-> ::std::result::Result<#ok, #impl_trait #display>)
David Tolnay26219462020-11-09 19:47:28 -0800723 } else {
724 expand_return_type(&sig.ret)
725 };
726
727 let arg_vars = sig.args.iter().map(|arg| &arg.ident);
728 let vars = receiver_var.iter().chain(arg_vars);
729
730 let span = invoke.span();
731 let call = match &sig.receiver {
732 None => quote_spanned!(span=> super::#invoke),
733 Some(receiver) => {
734 let receiver_type = &receiver.ty;
735 quote_spanned!(span=> #receiver_type::#invoke)
736 }
737 };
738
739 quote_spanned! {span=>
David Tolnay9938b642020-11-15 18:11:40 -0800740 #unsafety fn #local_name #generics(#(#all_args,)*) #ret {
David Tolnay26219462020-11-09 19:47:28 -0800741 #call(#(#vars,)*)
742 }
743 }
744}
745
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700746fn expand_type_alias(alias: &TypeAlias) -> TokenStream {
Bryan Henry890083d2020-09-13 10:34:31 -0700747 let doc = &alias.doc;
David Tolnay17a934c2020-11-02 00:40:04 -0800748 let ident = &alias.name.rust;
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700749 let ty = &alias.ty;
750 quote! {
Bryan Henry890083d2020-09-13 10:34:31 -0700751 #doc
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700752 pub type #ident = #ty;
753 }
754}
755
Adrian Taylorc8713432020-10-21 18:20:55 -0700756fn expand_type_alias_verify(alias: &TypeAlias, types: &Types) -> TokenStream {
David Tolnay17a934c2020-11-02 00:40:04 -0800757 let ident = &alias.name.rust;
758 let type_id = type_id(&alias.name);
David Tolnay83fe0f02020-05-07 20:00:15 -0700759 let begin_span = alias.type_token.span;
760 let end_span = alias.semi_token.span;
761 let begin = quote_spanned!(begin_span=> ::cxx::private::verify_extern_type::<);
762 let end = quote_spanned!(end_span=> >);
763
David Tolnay63a0e4e2020-10-03 18:52:32 -0700764 let mut verify = quote! {
David Tolnay83fe0f02020-05-07 20:00:15 -0700765 const _: fn() = #begin #ident, #type_id #end;
David Tolnay63a0e4e2020-10-03 18:52:32 -0700766 };
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700767
David Tolnay17a934c2020-11-02 00:40:04 -0800768 if types.required_trivial.contains_key(&alias.name.rust) {
David Tolnay63a0e4e2020-10-03 18:52:32 -0700769 let begin = quote_spanned!(begin_span=> ::cxx::private::verify_extern_kind::<);
770 verify.extend(quote! {
771 const _: fn() = #begin #ident, ::cxx::kind::Trivial #end;
772 });
Adrian Taylorc7043292020-09-25 12:48:36 -0700773 }
David Tolnay63a0e4e2020-10-03 18:52:32 -0700774
775 verify
Adrian Taylorc7043292020-09-25 12:48:36 -0700776}
777
David Tolnay8faec772020-11-02 00:18:19 -0800778fn type_id(name: &Pair) -> TokenStream {
779 let path = name.to_fully_qualified();
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700780 quote! {
781 ::cxx::type_id!(#path)
782 }
783}
784
Adrian Taylorc8713432020-10-21 18:20:55 -0700785fn expand_rust_box(ident: &ResolvableName, types: &Types) -> TokenStream {
786 let link_prefix = format!("cxxbridge05$box${}$", types.resolve(ident).to_symbol());
David Tolnay7db73692019-10-20 14:51:12 -0400787 let link_uninit = format!("{}uninit", link_prefix);
David Tolnay7db73692019-10-20 14:51:12 -0400788 let link_drop = format!("{}drop", link_prefix);
David Tolnay7db73692019-10-20 14:51:12 -0400789
Adrian Taylorc8713432020-10-21 18:20:55 -0700790 let local_prefix = format_ident!("{}__box_", &ident.rust);
David Tolnay7db73692019-10-20 14:51:12 -0400791 let local_uninit = format_ident!("{}uninit", local_prefix);
David Tolnay7db73692019-10-20 14:51:12 -0400792 let local_drop = format_ident!("{}drop", local_prefix);
David Tolnay7db73692019-10-20 14:51:12 -0400793
794 let span = ident.span();
795 quote_spanned! {span=>
796 #[doc(hidden)]
797 #[export_name = #link_uninit]
798 unsafe extern "C" fn #local_uninit(
799 this: *mut ::std::boxed::Box<::std::mem::MaybeUninit<#ident>>,
800 ) {
801 ::std::ptr::write(
802 this,
803 ::std::boxed::Box::new(::std::mem::MaybeUninit::uninit()),
804 );
805 }
806 #[doc(hidden)]
David Tolnay7db73692019-10-20 14:51:12 -0400807 #[export_name = #link_drop]
808 unsafe extern "C" fn #local_drop(this: *mut ::std::boxed::Box<#ident>) {
809 ::std::ptr::drop_in_place(this);
810 }
David Tolnay7db73692019-10-20 14:51:12 -0400811 }
812}
813
Adrian Taylorc8713432020-10-21 18:20:55 -0700814fn expand_rust_vec(elem: &ResolvableName, types: &Types) -> TokenStream {
815 let link_prefix = format!("cxxbridge05$rust_vec${}$", elem.to_symbol(types));
David Tolnayf97c2d52020-04-25 16:37:48 -0700816 let link_new = format!("{}new", link_prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700817 let link_drop = format!("{}drop", link_prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700818 let link_len = format!("{}len", link_prefix);
David Tolnay219c0792020-04-24 20:31:37 -0700819 let link_data = format!("{}data", link_prefix);
David Tolnayfb6b73c2020-11-10 14:32:16 -0800820 let link_reserve_total = format!("{}reserve_total", link_prefix);
821 let link_set_len = format!("{}set_len", link_prefix);
David Tolnay503d0192020-04-24 22:18:56 -0700822 let link_stride = format!("{}stride", link_prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700823
Adrian Taylorc8713432020-10-21 18:20:55 -0700824 let local_prefix = format_ident!("{}__vec_", elem.rust);
David Tolnayf97c2d52020-04-25 16:37:48 -0700825 let local_new = format_ident!("{}new", local_prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700826 let local_drop = format_ident!("{}drop", local_prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700827 let local_len = format_ident!("{}len", local_prefix);
David Tolnay219c0792020-04-24 20:31:37 -0700828 let local_data = format_ident!("{}data", local_prefix);
David Tolnayfb6b73c2020-11-10 14:32:16 -0800829 let local_reserve_total = format_ident!("{}reserve_total", local_prefix);
830 let local_set_len = format_ident!("{}set_len", local_prefix);
David Tolnay503d0192020-04-24 22:18:56 -0700831 let local_stride = format_ident!("{}stride", local_prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700832
David Tolnay83a7ec92020-04-25 12:37:42 -0700833 let span = elem.span();
Myron Ahneba35cf2020-02-05 19:41:51 +0700834 quote_spanned! {span=>
835 #[doc(hidden)]
David Tolnayf97c2d52020-04-25 16:37:48 -0700836 #[export_name = #link_new]
837 unsafe extern "C" fn #local_new(this: *mut ::cxx::private::RustVec<#elem>) {
838 ::std::ptr::write(this, ::cxx::private::RustVec::new());
839 }
840 #[doc(hidden)]
Myron Ahneba35cf2020-02-05 19:41:51 +0700841 #[export_name = #link_drop]
David Tolnay83a7ec92020-04-25 12:37:42 -0700842 unsafe extern "C" fn #local_drop(this: *mut ::cxx::private::RustVec<#elem>) {
David Tolnay4c64afb2020-04-24 11:30:18 -0700843 ::std::ptr::drop_in_place(this);
Myron Ahneba35cf2020-02-05 19:41:51 +0700844 }
David Tolnay85db5a02020-04-25 13:17:27 -0700845 #[doc(hidden)]
Myron Ahneba35cf2020-02-05 19:41:51 +0700846 #[export_name = #link_len]
David Tolnay83a7ec92020-04-25 12:37:42 -0700847 unsafe extern "C" fn #local_len(this: *const ::cxx::private::RustVec<#elem>) -> usize {
David Tolnay2cef5df2020-04-24 11:33:58 -0700848 (*this).len()
Myron Ahneba35cf2020-02-05 19:41:51 +0700849 }
David Tolnay219c0792020-04-24 20:31:37 -0700850 #[doc(hidden)]
851 #[export_name = #link_data]
David Tolnay83a7ec92020-04-25 12:37:42 -0700852 unsafe extern "C" fn #local_data(this: *const ::cxx::private::RustVec<#elem>) -> *const #elem {
David Tolnay219c0792020-04-24 20:31:37 -0700853 (*this).as_ptr()
854 }
David Tolnay503d0192020-04-24 22:18:56 -0700855 #[doc(hidden)]
David Tolnayfb6b73c2020-11-10 14:32:16 -0800856 #[export_name = #link_reserve_total]
857 unsafe extern "C" fn #local_reserve_total(this: *mut ::cxx::private::RustVec<#elem>, cap: usize) {
858 (*this).reserve_total(cap);
859 }
860 #[doc(hidden)]
861 #[export_name = #link_set_len]
862 unsafe extern "C" fn #local_set_len(this: *mut ::cxx::private::RustVec<#elem>, len: usize) {
863 (*this).set_len(len);
864 }
865 #[doc(hidden)]
David Tolnay503d0192020-04-24 22:18:56 -0700866 #[export_name = #link_stride]
867 unsafe extern "C" fn #local_stride() -> usize {
David Tolnay83a7ec92020-04-25 12:37:42 -0700868 ::std::mem::size_of::<#elem>()
David Tolnay503d0192020-04-24 22:18:56 -0700869 }
Myron Ahneba35cf2020-02-05 19:41:51 +0700870 }
871}
872
David Tolnay0531f432020-10-03 23:50:28 -0700873fn expand_unique_ptr(
Adrian Taylorc8713432020-10-21 18:20:55 -0700874 ident: &ResolvableName,
David Tolnay0531f432020-10-03 23:50:28 -0700875 types: &Types,
876 explicit_impl: Option<&Impl>,
877) -> TokenStream {
Adrian Taylorc8713432020-10-21 18:20:55 -0700878 let name = ident.rust.to_string();
879 let prefix = format!("cxxbridge05$unique_ptr${}$", ident.to_symbol(types));
David Tolnay7db73692019-10-20 14:51:12 -0400880 let link_null = format!("{}null", prefix);
881 let link_new = format!("{}new", prefix);
882 let link_raw = format!("{}raw", prefix);
883 let link_get = format!("{}get", prefix);
884 let link_release = format!("{}release", prefix);
885 let link_drop = format!("{}drop", prefix);
886
Adrian Taylorc8713432020-10-21 18:20:55 -0700887 let new_method =
888 if types.structs.contains_key(&ident.rust) || types.aliases.contains_key(&ident.rust) {
889 Some(quote! {
890 fn __new(mut value: Self) -> *mut ::std::ffi::c_void {
891 extern "C" {
892 #[link_name = #link_new]
893 fn __new(this: *mut *mut ::std::ffi::c_void, value: *mut #ident);
894 }
895 let mut repr = ::std::ptr::null_mut::<::std::ffi::c_void>();
896 unsafe { __new(&mut repr, &mut value) }
897 repr
David Tolnay53838912020-04-09 20:56:44 -0700898 }
Adrian Taylorc8713432020-10-21 18:20:55 -0700899 })
900 } else {
901 None
902 };
David Tolnay53838912020-04-09 20:56:44 -0700903
David Tolnay0531f432020-10-03 23:50:28 -0700904 let begin_span =
905 explicit_impl.map_or_else(Span::call_site, |explicit| explicit.impl_token.span);
906 let end_span = explicit_impl.map_or_else(Span::call_site, |explicit| explicit.brace_token.span);
907 let unsafe_token = format_ident!("unsafe", span = begin_span);
908
909 quote_spanned! {end_span=>
910 #unsafe_token impl ::cxx::private::UniquePtrTarget for #ident {
David Tolnay3b40b6f2020-04-24 17:58:24 -0700911 const __NAME: &'static dyn ::std::fmt::Display = &#name;
David Tolnay7db73692019-10-20 14:51:12 -0400912 fn __null() -> *mut ::std::ffi::c_void {
913 extern "C" {
914 #[link_name = #link_null]
915 fn __null(this: *mut *mut ::std::ffi::c_void);
916 }
917 let mut repr = ::std::ptr::null_mut::<::std::ffi::c_void>();
918 unsafe { __null(&mut repr) }
919 repr
920 }
David Tolnay53838912020-04-09 20:56:44 -0700921 #new_method
David Tolnay7db73692019-10-20 14:51:12 -0400922 unsafe fn __raw(raw: *mut Self) -> *mut ::std::ffi::c_void {
923 extern "C" {
924 #[link_name = #link_raw]
David Tolnay3b40b6f2020-04-24 17:58:24 -0700925 fn __raw(this: *mut *mut ::std::ffi::c_void, raw: *mut #ident);
David Tolnay7db73692019-10-20 14:51:12 -0400926 }
927 let mut repr = ::std::ptr::null_mut::<::std::ffi::c_void>();
928 __raw(&mut repr, raw);
929 repr
930 }
931 unsafe fn __get(repr: *mut ::std::ffi::c_void) -> *const Self {
932 extern "C" {
933 #[link_name = #link_get]
David Tolnay3b40b6f2020-04-24 17:58:24 -0700934 fn __get(this: *const *mut ::std::ffi::c_void) -> *const #ident;
David Tolnay7db73692019-10-20 14:51:12 -0400935 }
936 __get(&repr)
937 }
938 unsafe fn __release(mut repr: *mut ::std::ffi::c_void) -> *mut Self {
939 extern "C" {
940 #[link_name = #link_release]
David Tolnay3b40b6f2020-04-24 17:58:24 -0700941 fn __release(this: *mut *mut ::std::ffi::c_void) -> *mut #ident;
David Tolnay7db73692019-10-20 14:51:12 -0400942 }
943 __release(&mut repr)
944 }
945 unsafe fn __drop(mut repr: *mut ::std::ffi::c_void) {
946 extern "C" {
947 #[link_name = #link_drop]
948 fn __drop(this: *mut *mut ::std::ffi::c_void);
949 }
950 __drop(&mut repr);
951 }
952 }
953 }
954}
955
David Tolnay0531f432020-10-03 23:50:28 -0700956fn expand_cxx_vector(
Adrian Taylorc8713432020-10-21 18:20:55 -0700957 elem: &ResolvableName,
David Tolnay0531f432020-10-03 23:50:28 -0700958 explicit_impl: Option<&Impl>,
Adrian Taylorc8713432020-10-21 18:20:55 -0700959 types: &Types,
David Tolnay0531f432020-10-03 23:50:28 -0700960) -> TokenStream {
961 let _ = explicit_impl;
Adrian Taylorc8713432020-10-21 18:20:55 -0700962 let name = elem.rust.to_string();
963 let prefix = format!("cxxbridge05$std$vector${}$", elem.to_symbol(types));
David Tolnaya83247c2020-04-24 14:36:10 -0700964 let link_size = format!("{}size", prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700965 let link_get_unchecked = format!("{}get_unchecked", prefix);
Adrian Taylorc8713432020-10-21 18:20:55 -0700966 let unique_ptr_prefix = format!(
967 "cxxbridge05$unique_ptr$std$vector${}$",
968 elem.to_symbol(types)
969 );
David Tolnay3b40b6f2020-04-24 17:58:24 -0700970 let link_unique_ptr_null = format!("{}null", unique_ptr_prefix);
971 let link_unique_ptr_raw = format!("{}raw", unique_ptr_prefix);
972 let link_unique_ptr_get = format!("{}get", unique_ptr_prefix);
973 let link_unique_ptr_release = format!("{}release", unique_ptr_prefix);
974 let link_unique_ptr_drop = format!("{}drop", unique_ptr_prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700975
David Tolnay0531f432020-10-03 23:50:28 -0700976 let begin_span =
977 explicit_impl.map_or_else(Span::call_site, |explicit| explicit.impl_token.span);
978 let end_span = explicit_impl.map_or_else(Span::call_site, |explicit| explicit.brace_token.span);
979 let unsafe_token = format_ident!("unsafe", span = begin_span);
980
981 quote_spanned! {end_span=>
982 #unsafe_token impl ::cxx::private::VectorElement for #elem {
David Tolnay3b40b6f2020-04-24 17:58:24 -0700983 const __NAME: &'static dyn ::std::fmt::Display = &#name;
David Tolnay17631102020-04-24 19:01:30 -0700984 fn __vector_size(v: &::cxx::CxxVector<Self>) -> usize {
David Tolnayfa2119c2020-04-24 14:42:58 -0700985 extern "C" {
986 #[link_name = #link_size]
David Tolnay17631102020-04-24 19:01:30 -0700987 fn __vector_size(_: &::cxx::CxxVector<#elem>) -> usize;
Myron Ahneba35cf2020-02-05 19:41:51 +0700988 }
David Tolnayfa2119c2020-04-24 14:42:58 -0700989 unsafe { __vector_size(v) }
Myron Ahneba35cf2020-02-05 19:41:51 +0700990 }
David Tolnay93637ca2020-09-24 15:58:20 -0400991 unsafe fn __get_unchecked(v: &::cxx::CxxVector<Self>, pos: usize) -> *const Self {
David Tolnaycc75ad22020-04-24 14:45:16 -0700992 extern "C" {
993 #[link_name = #link_get_unchecked]
David Tolnay17631102020-04-24 19:01:30 -0700994 fn __get_unchecked(_: &::cxx::CxxVector<#elem>, _: usize) -> *const #elem;
David Tolnaycc75ad22020-04-24 14:45:16 -0700995 }
David Tolnay93637ca2020-09-24 15:58:20 -0400996 __get_unchecked(v, pos)
David Tolnaycc75ad22020-04-24 14:45:16 -0700997 }
David Tolnay3b40b6f2020-04-24 17:58:24 -0700998 fn __unique_ptr_null() -> *mut ::std::ffi::c_void {
999 extern "C" {
1000 #[link_name = #link_unique_ptr_null]
1001 fn __unique_ptr_null(this: *mut *mut ::std::ffi::c_void);
1002 }
1003 let mut repr = ::std::ptr::null_mut::<::std::ffi::c_void>();
1004 unsafe { __unique_ptr_null(&mut repr) }
1005 repr
1006 }
1007 unsafe fn __unique_ptr_raw(raw: *mut ::cxx::CxxVector<Self>) -> *mut ::std::ffi::c_void {
1008 extern "C" {
1009 #[link_name = #link_unique_ptr_raw]
1010 fn __unique_ptr_raw(this: *mut *mut ::std::ffi::c_void, raw: *mut ::cxx::CxxVector<#elem>);
1011 }
1012 let mut repr = ::std::ptr::null_mut::<::std::ffi::c_void>();
1013 __unique_ptr_raw(&mut repr, raw);
1014 repr
1015 }
1016 unsafe fn __unique_ptr_get(repr: *mut ::std::ffi::c_void) -> *const ::cxx::CxxVector<Self> {
1017 extern "C" {
1018 #[link_name = #link_unique_ptr_get]
1019 fn __unique_ptr_get(this: *const *mut ::std::ffi::c_void) -> *const ::cxx::CxxVector<#elem>;
1020 }
1021 __unique_ptr_get(&repr)
1022 }
1023 unsafe fn __unique_ptr_release(mut repr: *mut ::std::ffi::c_void) -> *mut ::cxx::CxxVector<Self> {
1024 extern "C" {
1025 #[link_name = #link_unique_ptr_release]
1026 fn __unique_ptr_release(this: *mut *mut ::std::ffi::c_void) -> *mut ::cxx::CxxVector<#elem>;
1027 }
1028 __unique_ptr_release(&mut repr)
1029 }
1030 unsafe fn __unique_ptr_drop(mut repr: *mut ::std::ffi::c_void) {
1031 extern "C" {
1032 #[link_name = #link_unique_ptr_drop]
1033 fn __unique_ptr_drop(this: *mut *mut ::std::ffi::c_void);
1034 }
1035 __unique_ptr_drop(&mut repr);
1036 }
Myron Ahneba35cf2020-02-05 19:41:51 +07001037 }
1038 }
1039}
1040
David Tolnay7db73692019-10-20 14:51:12 -04001041fn expand_return_type(ret: &Option<Type>) -> TokenStream {
1042 match ret {
1043 Some(ret) => quote!(-> #ret),
1044 None => TokenStream::new(),
1045 }
1046}
1047
David Tolnay75dca2e2020-03-25 20:17:52 -07001048fn indirect_return(sig: &Signature, types: &Types) -> bool {
1049 sig.ret
David Tolnay1e548172020-03-16 13:37:09 -07001050 .as_ref()
David Tolnay75dca2e2020-03-25 20:17:52 -07001051 .map_or(false, |ret| sig.throws || types.needs_indirect_abi(ret))
David Tolnay7db73692019-10-20 14:51:12 -04001052}
1053
David Tolnay2f090422020-11-02 18:25:35 -08001054fn expand_extern_type(ty: &Type, types: &Types, proper: bool) -> TokenStream {
David Tolnay7db73692019-10-20 14:51:12 -04001055 match ty {
Adrian Taylorc8713432020-10-21 18:20:55 -07001056 Type::Ident(ident) if ident.rust == RustString => quote!(::cxx::private::RustString),
David Tolnay7db73692019-10-20 14:51:12 -04001057 Type::RustBox(ty) | Type::UniquePtr(ty) => {
David Tolnay2f090422020-11-02 18:25:35 -08001058 let inner = expand_extern_type(&ty.inner, types, proper);
David Tolnay7db73692019-10-20 14:51:12 -04001059 quote!(*mut #inner)
1060 }
David Tolnaye6d50212020-04-25 15:38:23 -07001061 Type::RustVec(ty) => {
David Tolnay2f090422020-11-02 18:25:35 -08001062 let elem = expand_extern_type(&ty.inner, types, proper);
David Tolnaye6d50212020-04-25 15:38:23 -07001063 quote!(::cxx::private::RustVec<#elem>)
1064 }
David Tolnayf1c7f322020-08-27 00:46:01 -07001065 Type::Ref(ty) => {
1066 let mutability = ty.mutability;
1067 match &ty.inner {
Adrian Taylorc8713432020-10-21 18:20:55 -07001068 Type::Ident(ident) if ident.rust == RustString => {
David Tolnayf1c7f322020-08-27 00:46:01 -07001069 quote!(&#mutability ::cxx::private::RustString)
1070 }
1071 Type::RustVec(ty) => {
David Tolnay2f090422020-11-02 18:25:35 -08001072 let inner = expand_extern_type(&ty.inner, types, proper);
David Tolnayf1c7f322020-08-27 00:46:01 -07001073 quote!(&#mutability ::cxx::private::RustVec<#inner>)
1074 }
David Tolnay9c4ac2e2020-11-15 21:14:03 -08001075 inner if proper && types.is_considered_improper_ctype(inner) => match ty.mutable {
1076 false => quote!(*const ::std::ffi::c_void),
1077 true => quote!(*#mutability ::std::ffi::c_void),
David Tolnay4cb97672020-11-02 16:13:34 -08001078 },
David Tolnayf1c7f322020-08-27 00:46:01 -07001079 _ => quote!(#ty),
Myron Ahneba35cf2020-02-05 19:41:51 +07001080 }
David Tolnayf1c7f322020-08-27 00:46:01 -07001081 }
David Tolnay7db73692019-10-20 14:51:12 -04001082 Type::Str(_) => quote!(::cxx::private::RustStr),
Adrian Taylorf5dd5522020-04-13 16:50:14 -07001083 Type::SliceRefU8(_) => quote!(::cxx::private::RustSliceU8),
David Tolnay7db73692019-10-20 14:51:12 -04001084 _ => quote!(#ty),
1085 }
1086}
1087
David Tolnay2f090422020-11-02 18:25:35 -08001088fn expand_extern_return_type(ret: &Option<Type>, types: &Types, proper: bool) -> TokenStream {
David Tolnay7db73692019-10-20 14:51:12 -04001089 let ret = match ret {
1090 Some(ret) if !types.needs_indirect_abi(ret) => ret,
1091 _ => return TokenStream::new(),
1092 };
David Tolnay2f090422020-11-02 18:25:35 -08001093 let ty = expand_extern_type(ret, types, proper);
David Tolnay7db73692019-10-20 14:51:12 -04001094 quote!(-> #ty)
1095}