blob: f29c4cc1ed8e5988160d3ad90ac8a9456f77ac32 [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 {
David Tolnay62cae8e2020-11-17 07:54:54 -080035 expanded.extend(expand_rust_type_import(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 Tolnay62cae8e2020-11-17 07:54:54 -080042 Api::Include(_) | 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 }
David Tolnay62cae8e2020-11-17 07:54:54 -080055 Api::RustType(ety) => expanded.extend(expand_rust_type_impl(ety)),
Adrian Taylorc8713432020-10-21 18:20:55 -070056 Api::RustFunction(efn) => hidden.extend(expand_rust_function_shim(efn, types)),
David Tolnay5f9e8ca2020-05-07 17:21:05 -070057 Api::TypeAlias(alias) => {
58 expanded.extend(expand_type_alias(alias));
Adrian Taylorc8713432020-10-21 18:20:55 -070059 hidden.extend(expand_type_alias_verify(alias, types));
David Tolnay5f9e8ca2020-05-07 17:21:05 -070060 }
David Tolnay7db73692019-10-20 14:51:12 -040061 }
62 }
63
64 for ty in types {
David Tolnay0531f432020-10-03 23:50:28 -070065 let explicit_impl = types.explicit_impls.get(ty);
David Tolnay7db73692019-10-20 14:51:12 -040066 if let Type::RustBox(ty) = ty {
67 if let Type::Ident(ident) = &ty.inner {
Adrian Taylorc8713432020-10-21 18:20:55 -070068 if Atom::from(&ident.rust).is_none() {
69 hidden.extend(expand_rust_box(ident, types));
David Tolnay7db73692019-10-20 14:51:12 -040070 }
71 }
Myron Ahneba35cf2020-02-05 19:41:51 +070072 } else if let Type::RustVec(ty) = ty {
73 if let Type::Ident(ident) = &ty.inner {
Adrian Taylorc8713432020-10-21 18:20:55 -070074 if Atom::from(&ident.rust).is_none() {
75 hidden.extend(expand_rust_vec(ident, types));
David Tolnaya006bca2020-04-25 11:28:13 -070076 }
Myron Ahneba35cf2020-02-05 19:41:51 +070077 }
David Tolnay7db73692019-10-20 14:51:12 -040078 } else if let Type::UniquePtr(ptr) = ty {
79 if let Type::Ident(ident) = &ptr.inner {
Adrian Taylorc8713432020-10-21 18:20:55 -070080 if Atom::from(&ident.rust).is_none()
81 && (explicit_impl.is_some() || !types.aliases.contains_key(&ident.rust))
David Tolnay7e69f892020-10-03 22:20:22 -070082 {
Adrian Taylorc8713432020-10-21 18:20:55 -070083 expanded.extend(expand_unique_ptr(ident, types, explicit_impl));
Myron Ahneba35cf2020-02-05 19:41:51 +070084 }
85 }
David Tolnay4377a9e2020-04-24 15:20:26 -070086 } else if let Type::CxxVector(ptr) = ty {
Myron Ahneba35cf2020-02-05 19:41:51 +070087 if let Type::Ident(ident) = &ptr.inner {
Adrian Taylorc8713432020-10-21 18:20:55 -070088 if Atom::from(&ident.rust).is_none()
89 && (explicit_impl.is_some() || !types.aliases.contains_key(&ident.rust))
David Tolnay7e69f892020-10-03 22:20:22 -070090 {
David Tolnay17631102020-04-24 19:01:30 -070091 // Generate impl for CxxVector<T> if T is a struct or opaque
92 // C++ type. Impl for primitives is already provided by cxx
93 // crate.
Adrian Taylorc8713432020-10-21 18:20:55 -070094 expanded.extend(expand_cxx_vector(ident, explicit_impl, types));
David Tolnay7db73692019-10-20 14:51:12 -040095 }
96 }
97 }
98 }
99
100 // Work around https://github.com/rust-lang/rust/issues/67851.
101 if !hidden.is_empty() {
102 expanded.extend(quote! {
103 #[doc(hidden)]
104 const _: () = {
105 #hidden
106 };
107 });
108 }
109
110 let attrs = ffi
111 .attrs
112 .into_iter()
113 .filter(|attr| attr.path.is_ident("doc"));
114 let vis = &ffi.vis;
David Tolnaycbf3f032020-05-03 23:51:14 -0700115 let ident = &ffi.ident;
David Tolnay7db73692019-10-20 14:51:12 -0400116
David Tolnaycbf3f032020-05-03 23:51:14 -0700117 quote! {
David Tolnay7db73692019-10-20 14:51:12 -0400118 #(#attrs)*
119 #[deny(improper_ctypes)]
120 #[allow(non_snake_case)]
121 #vis mod #ident {
122 #expanded
123 }
David Tolnaycbf3f032020-05-03 23:51:14 -0700124 }
David Tolnay7db73692019-10-20 14:51:12 -0400125}
126
Adrian Taylorc8713432020-10-21 18:20:55 -0700127fn expand_struct(strct: &Struct) -> TokenStream {
David Tolnay17a934c2020-11-02 00:40:04 -0800128 let ident = &strct.name.rust;
David Tolnay7db73692019-10-20 14:51:12 -0400129 let doc = &strct.doc;
David Tolnayf3a9afa2020-10-08 23:22:12 -0700130 let derives = DeriveAttribute(&strct.derives);
David Tolnay17a934c2020-11-02 00:40:04 -0800131 let type_id = type_id(&strct.name);
David Tolnay7db73692019-10-20 14:51:12 -0400132 let fields = strct.fields.iter().map(|field| {
133 // This span on the pub makes "private type in public interface" errors
134 // appear in the right place.
135 let vis = Token![pub](field.ident.span());
136 quote!(#vis #field)
137 });
David Tolnay8684cc52020-10-07 17:09:48 -0700138
David Tolnay7db73692019-10-20 14:51:12 -0400139 quote! {
140 #doc
David Tolnayf3a9afa2020-10-08 23:22:12 -0700141 #derives
David Tolnay7db73692019-10-20 14:51:12 -0400142 #[repr(C)]
143 pub struct #ident {
144 #(#fields,)*
145 }
David Tolnay8684cc52020-10-07 17:09:48 -0700146
147 unsafe impl ::cxx::ExternType for #ident {
148 type Id = #type_id;
149 type Kind = ::cxx::kind::Trivial;
150 }
David Tolnay7db73692019-10-20 14:51:12 -0400151 }
152}
153
Adrian Taylorc8713432020-10-21 18:20:55 -0700154fn expand_enum(enm: &Enum) -> TokenStream {
David Tolnay17a934c2020-11-02 00:40:04 -0800155 let ident = &enm.name.rust;
Joel Galensonc03402a2020-04-23 17:31:09 -0700156 let doc = &enm.doc;
David Tolnayc605e6f2020-05-10 23:37:12 -0700157 let repr = enm.repr;
David Tolnay17a934c2020-11-02 00:40:04 -0800158 let type_id = type_id(&enm.name);
Joel Galenson88547732020-05-05 08:23:42 -0700159 let variants = enm.variants.iter().map(|variant| {
160 let variant_ident = &variant.ident;
161 let discriminant = &variant.discriminant;
162 Some(quote! {
163 pub const #variant_ident: Self = #ident { repr: #discriminant };
164 })
165 });
David Tolnay8684cc52020-10-07 17:09:48 -0700166
Joel Galensonc03402a2020-04-23 17:31:09 -0700167 quote! {
168 #doc
169 #[derive(Copy, Clone, PartialEq, Eq)]
170 #[repr(transparent)]
Joel Galensondb1ec312020-05-01 13:57:32 -0700171 pub struct #ident {
David Tolnayc605e6f2020-05-10 23:37:12 -0700172 pub repr: #repr,
Joel Galensondb1ec312020-05-01 13:57:32 -0700173 }
Joel Galensonc03402a2020-04-23 17:31:09 -0700174
175 #[allow(non_upper_case_globals)]
176 impl #ident {
David Tolnayd7984c22020-04-30 20:09:31 -0700177 #(#variants)*
Joel Galensonc03402a2020-04-23 17:31:09 -0700178 }
David Tolnay8684cc52020-10-07 17:09:48 -0700179
180 unsafe impl ::cxx::ExternType for #ident {
181 type Id = #type_id;
182 type Kind = ::cxx::kind::Trivial;
183 }
Joel Galensonc03402a2020-04-23 17:31:09 -0700184 }
185}
186
Adrian Taylorc8713432020-10-21 18:20:55 -0700187fn expand_cxx_type(ety: &ExternType) -> TokenStream {
David Tolnay17a934c2020-11-02 00:40:04 -0800188 let ident = &ety.name.rust;
David Tolnay7db73692019-10-20 14:51:12 -0400189 let doc = &ety.doc;
David Tolnay17a934c2020-11-02 00:40:04 -0800190 let type_id = type_id(&ety.name);
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700191
David Tolnay7db73692019-10-20 14:51:12 -0400192 quote! {
193 #doc
194 #[repr(C)]
195 pub struct #ident {
196 _private: ::cxx::private::Opaque,
197 }
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700198
199 unsafe impl ::cxx::ExternType for #ident {
200 type Id = #type_id;
David Tolnay38f5ad62020-10-03 18:06:44 -0700201 type Kind = ::cxx::kind::Opaque;
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700202 }
David Tolnay7db73692019-10-20 14:51:12 -0400203 }
204}
205
David Tolnay9eef6092020-11-15 17:56:41 -0800206fn expand_cxx_type_assert_pinned(ety: &ExternType) -> TokenStream {
207 let ident = &ety.name.rust;
208 let infer = Token![_](ident.span());
209
210 quote! {
211 let _ = {
212 // Derived from https://github.com/nvzqz/static-assertions-rs.
213 trait __AmbiguousIfImpl<A> {
214 fn infer() {}
215 }
216
217 impl<T: ?Sized> __AmbiguousIfImpl<()> for T {}
218
219 #[allow(dead_code)]
220 struct __Invalid;
221
222 impl<T: ?Sized + Unpin> __AmbiguousIfImpl<__Invalid> for T {}
223
224 // If there is only one specialized trait impl, type inference with
225 // `_` can be resolved and this can compile. Fails to compile if
226 // user has added a manual Unpin impl for their opaque C++ type as
227 // then `__AmbiguousIfImpl<__Invalid>` also exists.
228 <#ident as __AmbiguousIfImpl<#infer>>::infer
229 };
230 }
231}
232
Adrian Taylorc8713432020-10-21 18:20:55 -0700233fn expand_cxx_function_decl(efn: &ExternFn, types: &Types) -> TokenStream {
David Tolnay9938b642020-11-15 18:11:40 -0800234 let generics = &efn.generics;
David Tolnay18ba92c2020-04-22 16:17:30 -0700235 let receiver = efn.receiver.iter().map(|receiver| {
236 let receiver_type = receiver.ty();
237 quote!(_: #receiver_type)
238 });
David Tolnay39d575f2020-03-03 00:10:56 -0800239 let args = efn.args.iter().map(|arg| {
240 let ident = &arg.ident;
David Tolnay2f090422020-11-02 18:25:35 -0800241 let ty = expand_extern_type(&arg.ty, types, true);
David Tolnaya46a2372020-03-06 10:03:48 -0800242 if arg.ty == RustString {
243 quote!(#ident: *const #ty)
David Tolnay313b10e2020-04-25 16:30:51 -0700244 } else if let Type::RustVec(_) = arg.ty {
245 quote!(#ident: *const #ty)
David Tolnay75dca2e2020-03-25 20:17:52 -0700246 } else if let Type::Fn(_) = arg.ty {
247 quote!(#ident: ::cxx::private::FatFunction)
David Tolnaya46a2372020-03-06 10:03:48 -0800248 } else if types.needs_indirect_abi(&arg.ty) {
David Tolnay39d575f2020-03-03 00:10:56 -0800249 quote!(#ident: *mut #ty)
250 } else {
251 quote!(#ident: #ty)
252 }
253 });
Joel Galenson3d4f6122020-04-07 15:54:05 -0700254 let all_args = receiver.chain(args);
David Tolnayebef4a22020-03-17 15:33:47 -0700255 let ret = if efn.throws {
256 quote!(-> ::cxx::private::Result)
257 } else {
David Tolnay2f090422020-11-02 18:25:35 -0800258 expand_extern_return_type(&efn.ret, types, true)
David Tolnayebef4a22020-03-17 15:33:47 -0700259 };
David Tolnay7db73692019-10-20 14:51:12 -0400260 let mut outparam = None;
David Tolnay1e548172020-03-16 13:37:09 -0700261 if indirect_return(efn, types) {
David Tolnay2f090422020-11-02 18:25:35 -0800262 let ret = expand_extern_type(efn.ret.as_ref().unwrap(), types, true);
David Tolnay7db73692019-10-20 14:51:12 -0400263 outparam = Some(quote!(__return: *mut #ret));
264 }
Adrian Taylorc8713432020-10-21 18:20:55 -0700265 let link_name = mangle::extern_fn(efn, types);
David Tolnay17a934c2020-11-02 00:40:04 -0800266 let local_name = format_ident!("__{}", efn.name.rust);
David Tolnay7db73692019-10-20 14:51:12 -0400267 quote! {
268 #[link_name = #link_name]
David Tolnay9938b642020-11-15 18:11:40 -0800269 fn #local_name #generics(#(#all_args,)* #outparam) #ret;
David Tolnay7db73692019-10-20 14:51:12 -0400270 }
271}
272
Adrian Taylorc8713432020-10-21 18:20:55 -0700273fn expand_cxx_function_shim(efn: &ExternFn, types: &Types) -> TokenStream {
David Tolnay7db73692019-10-20 14:51:12 -0400274 let doc = &efn.doc;
Adrian Taylorc8713432020-10-21 18:20:55 -0700275 let decl = expand_cxx_function_decl(efn, types);
David Tolnayfb6e3862020-04-20 01:33:23 -0700276 let receiver = efn.receiver.iter().map(|receiver| {
David Tolnayf9ffb932020-04-20 02:22:57 -0700277 let var = receiver.var;
David Tolnayc9673842020-11-15 16:26:10 -0800278 if receiver.pinned {
279 let ty = receiver.ty();
280 quote!(#var: #ty)
281 } else {
282 let ampersand = receiver.ampersand;
David Tolnay9938b642020-11-15 18:11:40 -0800283 let lifetime = &receiver.lifetime;
David Tolnayc9673842020-11-15 16:26:10 -0800284 let mutability = receiver.mutability;
David Tolnay9938b642020-11-15 18:11:40 -0800285 quote!(#ampersand #lifetime #mutability #var)
David Tolnayc9673842020-11-15 16:26:10 -0800286 }
David Tolnayfb6e3862020-04-20 01:33:23 -0700287 });
Joel Galenson3d4f6122020-04-07 15:54:05 -0700288 let args = efn.args.iter().map(|arg| quote!(#arg));
289 let all_args = receiver.chain(args);
David Tolnayebef4a22020-03-17 15:33:47 -0700290 let ret = if efn.throws {
291 let ok = match &efn.ret {
292 Some(ret) => quote!(#ret),
293 None => quote!(()),
294 };
295 quote!(-> ::std::result::Result<#ok, ::cxx::Exception>)
296 } else {
297 expand_return_type(&efn.ret)
298 };
David Tolnay1e548172020-03-16 13:37:09 -0700299 let indirect_return = indirect_return(efn, types);
David Tolnayf9ffb932020-04-20 02:22:57 -0700300 let receiver_var = efn
301 .receiver
302 .iter()
303 .map(|receiver| receiver.var.to_token_stream());
Joel Galenson3d4f6122020-04-07 15:54:05 -0700304 let arg_vars = efn.args.iter().map(|arg| {
David Tolnay7db73692019-10-20 14:51:12 -0400305 let var = &arg.ident;
306 match &arg.ty {
Adrian Taylorc8713432020-10-21 18:20:55 -0700307 Type::Ident(ident) if ident.rust == RustString => {
David Tolnaya46a2372020-03-06 10:03:48 -0800308 quote!(#var.as_mut_ptr() as *const ::cxx::private::RustString)
David Tolnay7db73692019-10-20 14:51:12 -0400309 }
310 Type::RustBox(_) => quote!(::std::boxed::Box::into_raw(#var)),
David Tolnaybf7ae812020-11-16 23:31:45 -0800311 Type::UniquePtr(_) => quote!(::cxx::UniquePtr::into_raw(#var)),
David Tolnay313b10e2020-04-25 16:30:51 -0700312 Type::RustVec(_) => quote!(#var.as_mut_ptr() as *const ::cxx::private::RustVec<_>),
David Tolnay7db73692019-10-20 14:51:12 -0400313 Type::Ref(ty) => match &ty.inner {
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800314 Type::Ident(ident) if ident.rust == RustString => match ty.mutable {
315 false => quote!(::cxx::private::RustString::from_ref(#var)),
316 true => quote!(::cxx::private::RustString::from_mut(#var)),
David Tolnayf1c7f322020-08-27 00:46:01 -0700317 },
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800318 Type::RustVec(vec) if vec.inner == RustString => match ty.mutable {
319 false => quote!(::cxx::private::RustVec::from_ref_vec_string(#var)),
320 true => quote!(::cxx::private::RustVec::from_mut_vec_string(#var)),
David Tolnay33f56ad2020-08-27 17:06:35 -0700321 },
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800322 Type::RustVec(_) => match ty.mutable {
323 false => quote!(::cxx::private::RustVec::from_ref(#var)),
324 true => quote!(::cxx::private::RustVec::from_mut(#var)),
David Tolnayf1c7f322020-08-27 00:46:01 -0700325 },
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800326 inner if types.is_considered_improper_ctype(inner) => match ty.mutable {
327 false => quote!(#var as *const #inner as *const ::std::ffi::c_void),
328 true => quote!(#var as *mut #inner as *mut ::std::ffi::c_void),
David Tolnay4cb97672020-11-02 16:13:34 -0800329 },
David Tolnay7db73692019-10-20 14:51:12 -0400330 _ => quote!(#var),
331 },
332 Type::Str(_) => quote!(::cxx::private::RustStr::from(#var)),
Adrian Taylorf5dd5522020-04-13 16:50:14 -0700333 Type::SliceRefU8(_) => quote!(::cxx::private::RustSliceU8::from(#var)),
David Tolnay7db73692019-10-20 14:51:12 -0400334 ty if types.needs_indirect_abi(ty) => quote!(#var.as_mut_ptr()),
335 _ => quote!(#var),
336 }
337 });
Joel Galenson3d4f6122020-04-07 15:54:05 -0700338 let vars = receiver_var.chain(arg_vars);
David Tolnay75dca2e2020-03-25 20:17:52 -0700339 let trampolines = efn
340 .args
341 .iter()
342 .filter_map(|arg| {
343 if let Type::Fn(f) = &arg.ty {
344 let var = &arg.ident;
Adrian Taylorc8713432020-10-21 18:20:55 -0700345 Some(expand_function_pointer_trampoline(efn, var, f, types))
David Tolnay75dca2e2020-03-25 20:17:52 -0700346 } else {
347 None
348 }
349 })
350 .collect::<TokenStream>();
David Tolnay7db73692019-10-20 14:51:12 -0400351 let mut setup = efn
352 .args
353 .iter()
354 .filter(|arg| types.needs_indirect_abi(&arg.ty))
355 .map(|arg| {
356 let var = &arg.ident;
357 // These are arguments for which C++ has taken ownership of the data
358 // behind the mut reference it received.
359 quote! {
David Tolnaycb4ee4b2020-04-24 11:28:08 -0700360 let mut #var = ::std::mem::MaybeUninit::new(#var);
David Tolnay7db73692019-10-20 14:51:12 -0400361 }
362 })
363 .collect::<TokenStream>();
David Tolnay17a934c2020-11-02 00:40:04 -0800364 let local_name = format_ident!("__{}", efn.name.rust);
David Tolnay7db73692019-10-20 14:51:12 -0400365 let call = if indirect_return {
David Tolnay2f090422020-11-02 18:25:35 -0800366 let ret = expand_extern_type(efn.ret.as_ref().unwrap(), types, true);
David Tolnay7db73692019-10-20 14:51:12 -0400367 setup.extend(quote! {
368 let mut __return = ::std::mem::MaybeUninit::<#ret>::uninit();
David Tolnay7db73692019-10-20 14:51:12 -0400369 });
David Tolnay0d524852020-11-02 17:21:50 -0800370 setup.extend(if efn.throws {
371 quote! {
David Tolnayebef4a22020-03-17 15:33:47 -0700372 #local_name(#(#vars,)* __return.as_mut_ptr()).exception()?;
David Tolnay0d524852020-11-02 17:21:50 -0800373 }
David Tolnayebef4a22020-03-17 15:33:47 -0700374 } else {
David Tolnay0d524852020-11-02 17:21:50 -0800375 quote! {
David Tolnayebef4a22020-03-17 15:33:47 -0700376 #local_name(#(#vars,)* __return.as_mut_ptr());
David Tolnay0d524852020-11-02 17:21:50 -0800377 }
378 });
379 quote!(__return.assume_init())
David Tolnayebef4a22020-03-17 15:33:47 -0700380 } else if efn.throws {
David Tolnay7db73692019-10-20 14:51:12 -0400381 quote! {
David Tolnayebef4a22020-03-17 15:33:47 -0700382 #local_name(#(#vars),*).exception()
David Tolnay7db73692019-10-20 14:51:12 -0400383 }
384 } else {
385 quote! {
386 #local_name(#(#vars),*)
387 }
388 };
David Tolnay2debdb22020-11-02 17:14:53 -0800389 let mut expr;
390 if efn.throws && efn.sig.ret.is_none() {
391 expr = call;
Myron Ahn84849302020-03-25 22:00:58 +0700392 } else {
David Tolnay0d524852020-11-02 17:21:50 -0800393 expr = match &efn.ret {
394 None => call,
395 Some(ret) => match ret {
396 Type::Ident(ident) if ident.rust == RustString => quote!(#call.into_string()),
397 Type::RustBox(_) => quote!(::std::boxed::Box::from_raw(#call)),
David Tolnaya1f02e52020-11-02 17:10:54 -0800398 Type::RustVec(vec) => {
399 if vec.inner == RustString {
David Tolnay0d524852020-11-02 17:21:50 -0800400 quote!(#call.into_vec_string())
David Tolnaya1f02e52020-11-02 17:10:54 -0800401 } else {
David Tolnay0d524852020-11-02 17:21:50 -0800402 quote!(#call.into_vec())
David Tolnaya1f02e52020-11-02 17:10:54 -0800403 }
David Tolnay33f56ad2020-08-27 17:06:35 -0700404 }
David Tolnaybf7ae812020-11-16 23:31:45 -0800405 Type::UniquePtr(_) => quote!(::cxx::UniquePtr::from_raw(#call)),
David Tolnaya1f02e52020-11-02 17:10:54 -0800406 Type::Ref(ty) => match &ty.inner {
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800407 Type::Ident(ident) if ident.rust == RustString => match ty.mutable {
408 false => quote!(#call.as_string()),
409 true => quote!(#call.as_mut_string()),
David Tolnaya1f02e52020-11-02 17:10:54 -0800410 },
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800411 Type::RustVec(vec) if vec.inner == RustString => match ty.mutable {
412 false => quote!(#call.as_vec_string()),
413 true => quote!(#call.as_mut_vec_string()),
David Tolnaya1f02e52020-11-02 17:10:54 -0800414 },
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800415 Type::RustVec(_) => match ty.mutable {
416 false => quote!(#call.as_vec()),
417 true => quote!(#call.as_mut_vec()),
David Tolnaya1f02e52020-11-02 17:10:54 -0800418 },
David Tolnay4cb97672020-11-02 16:13:34 -0800419 inner if types.is_considered_improper_ctype(inner) => {
420 let mutability = ty.mutability;
421 quote!(&#mutability *#call.cast())
422 }
David Tolnay0d524852020-11-02 17:21:50 -0800423 _ => call,
David Tolnayf1c7f322020-08-27 00:46:01 -0700424 },
David Tolnay0d524852020-11-02 17:21:50 -0800425 Type::Str(_) => quote!(#call.as_str()),
426 Type::SliceRefU8(_) => quote!(#call.as_slice()),
427 _ => call,
428 },
429 };
David Tolnay2debdb22020-11-02 17:14:53 -0800430 if efn.throws {
431 expr = quote!(::std::result::Result::Ok(#expr));
432 }
David Tolnaya1f02e52020-11-02 17:10:54 -0800433 };
David Tolnaye67bcf52020-09-06 23:50:44 -0700434 let mut dispatch = quote!(#setup #expr);
435 let unsafety = &efn.sig.unsafety;
436 if unsafety.is_none() {
437 dispatch = quote!(unsafe { #dispatch });
438 }
David Tolnay17a934c2020-11-02 00:40:04 -0800439 let ident = &efn.name.rust;
David Tolnay9938b642020-11-15 18:11:40 -0800440 let generics = &efn.generics;
David Tolnayc66cdbb2020-04-20 01:41:15 -0700441 let function_shim = quote! {
442 #doc
David Tolnay9938b642020-11-15 18:11:40 -0800443 pub #unsafety fn #ident #generics(#(#all_args,)*) #ret {
David Tolnayc66cdbb2020-04-20 01:41:15 -0700444 extern "C" {
445 #decl
David Tolnay7db73692019-10-20 14:51:12 -0400446 }
David Tolnayc66cdbb2020-04-20 01:41:15 -0700447 #trampolines
David Tolnaye67bcf52020-09-06 23:50:44 -0700448 #dispatch
David Tolnayc66cdbb2020-04-20 01:41:15 -0700449 }
450 };
451 match &efn.receiver {
452 None => function_shim,
453 Some(receiver) => {
David Tolnay05e11cc2020-04-20 02:13:56 -0700454 let receiver_type = &receiver.ty;
David Tolnayc66cdbb2020-04-20 01:41:15 -0700455 quote!(impl #receiver_type { #function_shim })
456 }
David Tolnay7db73692019-10-20 14:51:12 -0400457 }
458}
459
David Tolnay75dca2e2020-03-25 20:17:52 -0700460fn expand_function_pointer_trampoline(
David Tolnay75dca2e2020-03-25 20:17:52 -0700461 efn: &ExternFn,
462 var: &Ident,
463 sig: &Signature,
464 types: &Types,
465) -> TokenStream {
Adrian Taylorc8713432020-10-21 18:20:55 -0700466 let c_trampoline = mangle::c_trampoline(efn, var, types);
467 let r_trampoline = mangle::r_trampoline(efn, var, types);
David Tolnay75dca2e2020-03-25 20:17:52 -0700468 let local_name = parse_quote!(__);
David Tolnay17a934c2020-11-02 00:40:04 -0800469 let catch_unwind_label = format!("::{}::{}", efn.name.rust, var);
David Tolnay75dca2e2020-03-25 20:17:52 -0700470 let shim = expand_rust_function_shim_impl(
471 sig,
472 types,
473 &r_trampoline,
474 local_name,
475 catch_unwind_label,
476 None,
477 );
478
479 quote! {
480 let #var = ::cxx::private::FatFunction {
481 trampoline: {
482 extern "C" {
483 #[link_name = #c_trampoline]
484 fn trampoline();
485 }
486 #shim
487 trampoline as usize as *const ()
488 },
489 ptr: #var as usize as *const (),
490 };
491 }
492}
493
David Tolnay62cae8e2020-11-17 07:54:54 -0800494fn expand_rust_type_import(ety: &ExternType) -> TokenStream {
David Tolnay17a934c2020-11-02 00:40:04 -0800495 let ident = &ety.name.rust;
David Tolnay62cae8e2020-11-17 07:54:54 -0800496 let span = ident.span();
497
498 quote_spanned! {span=>
David Tolnay7db73692019-10-20 14:51:12 -0400499 use super::#ident;
500 }
501}
502
David Tolnay62cae8e2020-11-17 07:54:54 -0800503fn expand_rust_type_impl(ety: &ExternType) -> TokenStream {
504 let ident = &ety.name.rust;
505 let span = ident.span();
506 let unsafe_impl = quote_spanned!(ety.type_token.span=> unsafe impl);
507
508 quote_spanned! {span=>
509 #unsafe_impl ::cxx::private::RustType for #ident {}
510 }
511}
512
David Tolnayc8361022020-08-25 21:57:53 -0700513fn expand_rust_type_assert_sized(ety: &ExternType) -> TokenStream {
514 // Rustc will render as follows if not sized:
515 //
516 // type TheirType;
517 // -----^^^^^^^^^-
518 // | |
519 // | doesn't have a size known at compile-time
520 // required by this bound in `ffi::_::__AssertSized`
521
David Tolnay17a934c2020-11-02 00:40:04 -0800522 let ident = &ety.name.rust;
David Tolnayc8361022020-08-25 21:57:53 -0700523 let begin_span = Token![::](ety.type_token.span);
524 let sized = quote_spanned! {ety.semi_token.span=>
525 #begin_span std::marker::Sized
526 };
David Tolnay20fa62b2020-11-15 17:34:05 -0800527 let unpin = quote_spanned! {ety.semi_token.span=>
528 #begin_span std::marker::Unpin
529 };
David Tolnay17a934c2020-11-02 00:40:04 -0800530 quote_spanned! {ident.span()=>
David Tolnayc8361022020-08-25 21:57:53 -0700531 let _ = {
532 fn __AssertSized<T: ?#sized + #sized>() {}
David Tolnay20fa62b2020-11-15 17:34:05 -0800533 fn __AssertUnpin<T: #unpin>() {}
534 (__AssertSized::<#ident>, __AssertUnpin::<#ident>)
David Tolnayc8361022020-08-25 21:57:53 -0700535 };
536 }
537}
538
Adrian Taylorc8713432020-10-21 18:20:55 -0700539fn expand_rust_function_shim(efn: &ExternFn, types: &Types) -> TokenStream {
540 let link_name = mangle::extern_fn(efn, types);
David Tolnay17a934c2020-11-02 00:40:04 -0800541 let local_name = format_ident!("__{}", efn.name.rust);
542 let catch_unwind_label = format!("::{}", efn.name.rust);
543 let invoke = Some(&efn.name.rust);
David Tolnay75dca2e2020-03-25 20:17:52 -0700544 expand_rust_function_shim_impl(
545 efn,
546 types,
547 &link_name,
548 local_name,
549 catch_unwind_label,
550 invoke,
551 )
552}
553
554fn expand_rust_function_shim_impl(
555 sig: &Signature,
556 types: &Types,
David Tolnay891061b2020-04-19 22:42:33 -0700557 link_name: &Symbol,
David Tolnay75dca2e2020-03-25 20:17:52 -0700558 local_name: Ident,
559 catch_unwind_label: String,
560 invoke: Option<&Ident>,
561) -> TokenStream {
David Tolnay9938b642020-11-15 18:11:40 -0800562 let generics = &sig.generics;
David Tolnayf9ffb932020-04-20 02:22:57 -0700563 let receiver_var = sig
564 .receiver
565 .as_ref()
566 .map(|receiver| quote_spanned!(receiver.var.span=> __self));
David Tolnay18ba92c2020-04-22 16:17:30 -0700567 let receiver = sig.receiver.as_ref().map(|receiver| {
568 let receiver_type = receiver.ty();
569 quote!(#receiver_var: #receiver_type)
570 });
David Tolnay75dca2e2020-03-25 20:17:52 -0700571 let args = sig.args.iter().map(|arg| {
David Tolnay39d575f2020-03-03 00:10:56 -0800572 let ident = &arg.ident;
David Tolnay2f090422020-11-02 18:25:35 -0800573 let ty = expand_extern_type(&arg.ty, types, false);
David Tolnay39d575f2020-03-03 00:10:56 -0800574 if types.needs_indirect_abi(&arg.ty) {
575 quote!(#ident: *mut #ty)
576 } else {
577 quote!(#ident: #ty)
578 }
579 });
David Tolnayf9ffb932020-04-20 02:22:57 -0700580 let all_args = receiver.into_iter().chain(args);
David Tolnay75dca2e2020-03-25 20:17:52 -0700581
David Tolnay3a45f2d2020-04-20 01:51:12 -0700582 let arg_vars = sig.args.iter().map(|arg| {
David Tolnay7db73692019-10-20 14:51:12 -0400583 let ident = &arg.ident;
David Tolnay17955e22020-01-20 17:58:24 -0800584 match &arg.ty {
Adrian Taylorc8713432020-10-21 18:20:55 -0700585 Type::Ident(i) if i.rust == RustString => {
David Tolnaycc3767f2020-03-06 10:41:51 -0800586 quote!(::std::mem::take((*#ident).as_mut_string()))
587 }
David Tolnay40226ab2020-03-03 00:05:35 -0800588 Type::RustBox(_) => quote!(::std::boxed::Box::from_raw(#ident)),
David Tolnay33f56ad2020-08-27 17:06:35 -0700589 Type::RustVec(vec) => {
590 if vec.inner == RustString {
591 quote!(::std::mem::take((*#ident).as_mut_vec_string()))
592 } else {
593 quote!(::std::mem::take((*#ident).as_mut_vec()))
594 }
595 }
David Tolnaybf7ae812020-11-16 23:31:45 -0800596 Type::UniquePtr(_) => quote!(::cxx::UniquePtr::from_raw(#ident)),
David Tolnay17955e22020-01-20 17:58:24 -0800597 Type::Ref(ty) => match &ty.inner {
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800598 Type::Ident(i) if i.rust == RustString => match ty.mutable {
599 false => quote!(#ident.as_string()),
600 true => quote!(#ident.as_mut_string()),
David Tolnayf1c7f322020-08-27 00:46:01 -0700601 },
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800602 Type::RustVec(vec) if vec.inner == RustString => match ty.mutable {
603 false => quote!(#ident.as_vec_string()),
604 true => quote!(#ident.as_mut_vec_string()),
David Tolnay33f56ad2020-08-27 17:06:35 -0700605 },
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800606 Type::RustVec(_) => match ty.mutable {
607 false => quote!(#ident.as_vec()),
608 true => quote!(#ident.as_mut_vec()),
David Tolnayf1c7f322020-08-27 00:46:01 -0700609 },
David Tolnay40226ab2020-03-03 00:05:35 -0800610 _ => quote!(#ident),
David Tolnay17955e22020-01-20 17:58:24 -0800611 },
David Tolnay40226ab2020-03-03 00:05:35 -0800612 Type::Str(_) => quote!(#ident.as_str()),
Adrian Taylorf5dd5522020-04-13 16:50:14 -0700613 Type::SliceRefU8(_) => quote!(#ident.as_slice()),
David Tolnay40226ab2020-03-03 00:05:35 -0800614 ty if types.needs_indirect_abi(ty) => quote!(::std::ptr::read(#ident)),
615 _ => quote!(#ident),
David Tolnay7db73692019-10-20 14:51:12 -0400616 }
617 });
David Tolnayf9ffb932020-04-20 02:22:57 -0700618 let vars = receiver_var.into_iter().chain(arg_vars);
David Tolnay75dca2e2020-03-25 20:17:52 -0700619
David Tolnay26219462020-11-09 19:47:28 -0800620 let wrap_super = invoke.map(|invoke| expand_rust_function_shim_super(sig, &local_name, invoke));
621
David Tolnay75dca2e2020-03-25 20:17:52 -0700622 let mut call = match invoke {
David Tolnay26219462020-11-09 19:47:28 -0800623 Some(_) => quote!(#local_name),
David Tolnayb8ebeb02020-10-31 23:52:06 -0700624 None => quote!(::std::mem::transmute::<*const (), #sig>(__extern)),
David Tolnay75dca2e2020-03-25 20:17:52 -0700625 };
626 call.extend(quote! { (#(#vars),*) });
627
David Tolnay22602b42020-09-21 18:04:05 -0400628 let conversion = sig.ret.as_ref().and_then(|ret| match ret {
Adrian Taylorc8713432020-10-21 18:20:55 -0700629 Type::Ident(ident) if ident.rust == RustString => {
630 Some(quote!(::cxx::private::RustString::from))
631 }
David Tolnay22602b42020-09-21 18:04:05 -0400632 Type::RustBox(_) => Some(quote!(::std::boxed::Box::into_raw)),
633 Type::RustVec(vec) => {
634 if vec.inner == RustString {
635 Some(quote!(::cxx::private::RustVec::from_vec_string))
636 } else {
637 Some(quote!(::cxx::private::RustVec::from))
David Tolnay7db73692019-10-20 14:51:12 -0400638 }
David Tolnay22602b42020-09-21 18:04:05 -0400639 }
David Tolnaybf7ae812020-11-16 23:31:45 -0800640 Type::UniquePtr(_) => Some(quote!(::cxx::UniquePtr::into_raw)),
David Tolnay22602b42020-09-21 18:04:05 -0400641 Type::Ref(ty) => match &ty.inner {
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800642 Type::Ident(ident) if ident.rust == RustString => match ty.mutable {
643 false => Some(quote!(::cxx::private::RustString::from_ref)),
644 true => Some(quote!(::cxx::private::RustString::from_mut)),
David Tolnay7db73692019-10-20 14:51:12 -0400645 },
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800646 Type::RustVec(vec) if vec.inner == RustString => match ty.mutable {
647 false => Some(quote!(::cxx::private::RustVec::from_ref_vec_string)),
648 true => Some(quote!(::cxx::private::RustVec::from_mut_vec_string)),
David Tolnay22602b42020-09-21 18:04:05 -0400649 },
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800650 Type::RustVec(_) => match ty.mutable {
651 false => Some(quote!(::cxx::private::RustVec::from_ref)),
652 true => Some(quote!(::cxx::private::RustVec::from_mut)),
David Tolnay22602b42020-09-21 18:04:05 -0400653 },
David Tolnay7db73692019-10-20 14:51:12 -0400654 _ => None,
David Tolnay22602b42020-09-21 18:04:05 -0400655 },
656 Type::Str(_) => Some(quote!(::cxx::private::RustStr::from)),
657 Type::SliceRefU8(_) => Some(quote!(::cxx::private::RustSliceU8::from)),
658 _ => None,
659 });
660
661 let mut expr = match conversion {
662 None => call,
663 Some(conversion) if !sig.throws => quote!(#conversion(#call)),
664 Some(conversion) => quote!(::std::result::Result::map(#call, #conversion)),
665 };
David Tolnay75dca2e2020-03-25 20:17:52 -0700666
667 let mut outparam = None;
668 let indirect_return = indirect_return(sig, types);
David Tolnay1e548172020-03-16 13:37:09 -0700669 if indirect_return {
David Tolnay2f090422020-11-02 18:25:35 -0800670 let ret = expand_extern_type(sig.ret.as_ref().unwrap(), types, false);
David Tolnay75dca2e2020-03-25 20:17:52 -0700671 outparam = Some(quote!(__return: *mut #ret,));
David Tolnay1e548172020-03-16 13:37:09 -0700672 }
David Tolnay75dca2e2020-03-25 20:17:52 -0700673 if sig.throws {
674 let out = match sig.ret {
David Tolnaycecada62020-03-17 01:45:58 -0700675 Some(_) => quote!(__return),
676 None => quote!(&mut ()),
677 };
678 expr = quote!(::cxx::private::r#try(#out, #expr));
David Tolnay1e548172020-03-16 13:37:09 -0700679 } else if indirect_return {
David Tolnay7db73692019-10-20 14:51:12 -0400680 expr = quote!(::std::ptr::write(__return, #expr));
681 }
David Tolnay75dca2e2020-03-25 20:17:52 -0700682
David Tolnay1e548172020-03-16 13:37:09 -0700683 expr = quote!(::cxx::private::catch_unwind(__fn, move || #expr));
David Tolnay75dca2e2020-03-25 20:17:52 -0700684
685 let ret = if sig.throws {
David Tolnay486b6ec2020-03-17 01:19:57 -0700686 quote!(-> ::cxx::private::Result)
David Tolnay1e548172020-03-16 13:37:09 -0700687 } else {
David Tolnay2f090422020-11-02 18:25:35 -0800688 expand_extern_return_type(&sig.ret, types, false)
David Tolnay1e548172020-03-16 13:37:09 -0700689 };
David Tolnay75dca2e2020-03-25 20:17:52 -0700690
691 let pointer = match invoke {
David Tolnayb8ebeb02020-10-31 23:52:06 -0700692 None => Some(quote!(__extern: *const ())),
David Tolnay75dca2e2020-03-25 20:17:52 -0700693 Some(_) => None,
694 };
695
David Tolnay7db73692019-10-20 14:51:12 -0400696 quote! {
697 #[doc(hidden)]
698 #[export_name = #link_name]
David Tolnay9938b642020-11-15 18:11:40 -0800699 unsafe extern "C" fn #local_name #generics(#(#all_args,)* #outparam #pointer) #ret {
David Tolnay7db73692019-10-20 14:51:12 -0400700 let __fn = concat!(module_path!(), #catch_unwind_label);
David Tolnay26219462020-11-09 19:47:28 -0800701 #wrap_super
David Tolnay7db73692019-10-20 14:51:12 -0400702 #expr
703 }
704 }
705}
706
David Tolnay26219462020-11-09 19:47:28 -0800707// A wrapper like `fn f(x: Arg) { super::f(x) }` just to ensure we have the
708// accurate unsafety declaration and no problematic elided lifetimes.
709fn expand_rust_function_shim_super(
710 sig: &Signature,
711 local_name: &Ident,
712 invoke: &Ident,
713) -> TokenStream {
714 let unsafety = sig.unsafety;
David Tolnay9938b642020-11-15 18:11:40 -0800715 let generics = &sig.generics;
David Tolnay26219462020-11-09 19:47:28 -0800716
717 let receiver_var = sig
718 .receiver
719 .as_ref()
720 .map(|receiver| Ident::new("__self", receiver.var.span));
721 let receiver = sig.receiver.iter().map(|receiver| {
722 let receiver_type = receiver.ty();
723 quote!(#receiver_var: #receiver_type)
724 });
725 let args = sig.args.iter().map(|arg| quote!(#arg));
726 let all_args = receiver.chain(args);
727
David Tolnay5d164672020-11-09 20:23:17 -0800728 let ret = if let Some((result, _langle, rangle)) = sig.throws_tokens {
David Tolnay26219462020-11-09 19:47:28 -0800729 let ok = match &sig.ret {
730 Some(ret) => quote!(#ret),
731 None => quote!(()),
732 };
David Tolnay5d164672020-11-09 20:23:17 -0800733 let impl_trait = quote_spanned!(result.span=> impl);
734 let display = quote_spanned!(rangle.span=> ::std::fmt::Display);
735 quote!(-> ::std::result::Result<#ok, #impl_trait #display>)
David Tolnay26219462020-11-09 19:47:28 -0800736 } else {
737 expand_return_type(&sig.ret)
738 };
739
740 let arg_vars = sig.args.iter().map(|arg| &arg.ident);
741 let vars = receiver_var.iter().chain(arg_vars);
742
743 let span = invoke.span();
744 let call = match &sig.receiver {
745 None => quote_spanned!(span=> super::#invoke),
746 Some(receiver) => {
747 let receiver_type = &receiver.ty;
748 quote_spanned!(span=> #receiver_type::#invoke)
749 }
750 };
751
752 quote_spanned! {span=>
David Tolnay9938b642020-11-15 18:11:40 -0800753 #unsafety fn #local_name #generics(#(#all_args,)*) #ret {
David Tolnay26219462020-11-09 19:47:28 -0800754 #call(#(#vars,)*)
755 }
756 }
757}
758
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700759fn expand_type_alias(alias: &TypeAlias) -> TokenStream {
Bryan Henry890083d2020-09-13 10:34:31 -0700760 let doc = &alias.doc;
David Tolnay17a934c2020-11-02 00:40:04 -0800761 let ident = &alias.name.rust;
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700762 let ty = &alias.ty;
763 quote! {
Bryan Henry890083d2020-09-13 10:34:31 -0700764 #doc
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700765 pub type #ident = #ty;
766 }
767}
768
Adrian Taylorc8713432020-10-21 18:20:55 -0700769fn expand_type_alias_verify(alias: &TypeAlias, types: &Types) -> TokenStream {
David Tolnay17a934c2020-11-02 00:40:04 -0800770 let ident = &alias.name.rust;
771 let type_id = type_id(&alias.name);
David Tolnay83fe0f02020-05-07 20:00:15 -0700772 let begin_span = alias.type_token.span;
773 let end_span = alias.semi_token.span;
774 let begin = quote_spanned!(begin_span=> ::cxx::private::verify_extern_type::<);
775 let end = quote_spanned!(end_span=> >);
776
David Tolnay63a0e4e2020-10-03 18:52:32 -0700777 let mut verify = quote! {
David Tolnay83fe0f02020-05-07 20:00:15 -0700778 const _: fn() = #begin #ident, #type_id #end;
David Tolnay63a0e4e2020-10-03 18:52:32 -0700779 };
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700780
David Tolnay17a934c2020-11-02 00:40:04 -0800781 if types.required_trivial.contains_key(&alias.name.rust) {
David Tolnay63a0e4e2020-10-03 18:52:32 -0700782 let begin = quote_spanned!(begin_span=> ::cxx::private::verify_extern_kind::<);
783 verify.extend(quote! {
784 const _: fn() = #begin #ident, ::cxx::kind::Trivial #end;
785 });
Adrian Taylorc7043292020-09-25 12:48:36 -0700786 }
David Tolnay63a0e4e2020-10-03 18:52:32 -0700787
788 verify
Adrian Taylorc7043292020-09-25 12:48:36 -0700789}
790
David Tolnay8faec772020-11-02 00:18:19 -0800791fn type_id(name: &Pair) -> TokenStream {
792 let path = name.to_fully_qualified();
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700793 quote! {
794 ::cxx::type_id!(#path)
795 }
796}
797
Adrian Taylorc8713432020-10-21 18:20:55 -0700798fn expand_rust_box(ident: &ResolvableName, types: &Types) -> TokenStream {
David Tolnay0f0162f2020-11-16 23:43:37 -0800799 let link_prefix = format!("cxxbridge1$box${}$", types.resolve(ident).to_symbol());
David Tolnay7db73692019-10-20 14:51:12 -0400800 let link_uninit = format!("{}uninit", link_prefix);
David Tolnay7db73692019-10-20 14:51:12 -0400801 let link_drop = format!("{}drop", link_prefix);
David Tolnay7db73692019-10-20 14:51:12 -0400802
Adrian Taylorc8713432020-10-21 18:20:55 -0700803 let local_prefix = format_ident!("{}__box_", &ident.rust);
David Tolnay7db73692019-10-20 14:51:12 -0400804 let local_uninit = format_ident!("{}uninit", local_prefix);
David Tolnay7db73692019-10-20 14:51:12 -0400805 let local_drop = format_ident!("{}drop", local_prefix);
David Tolnay7db73692019-10-20 14:51:12 -0400806
807 let span = ident.span();
808 quote_spanned! {span=>
809 #[doc(hidden)]
810 #[export_name = #link_uninit]
811 unsafe extern "C" fn #local_uninit(
812 this: *mut ::std::boxed::Box<::std::mem::MaybeUninit<#ident>>,
813 ) {
814 ::std::ptr::write(
815 this,
816 ::std::boxed::Box::new(::std::mem::MaybeUninit::uninit()),
817 );
818 }
819 #[doc(hidden)]
David Tolnay7db73692019-10-20 14:51:12 -0400820 #[export_name = #link_drop]
821 unsafe extern "C" fn #local_drop(this: *mut ::std::boxed::Box<#ident>) {
822 ::std::ptr::drop_in_place(this);
823 }
David Tolnay7db73692019-10-20 14:51:12 -0400824 }
825}
826
Adrian Taylorc8713432020-10-21 18:20:55 -0700827fn expand_rust_vec(elem: &ResolvableName, types: &Types) -> TokenStream {
David Tolnay0f0162f2020-11-16 23:43:37 -0800828 let link_prefix = format!("cxxbridge1$rust_vec${}$", elem.to_symbol(types));
David Tolnayf97c2d52020-04-25 16:37:48 -0700829 let link_new = format!("{}new", link_prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700830 let link_drop = format!("{}drop", link_prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700831 let link_len = format!("{}len", link_prefix);
David Tolnay219c0792020-04-24 20:31:37 -0700832 let link_data = format!("{}data", link_prefix);
David Tolnayfb6b73c2020-11-10 14:32:16 -0800833 let link_reserve_total = format!("{}reserve_total", link_prefix);
834 let link_set_len = format!("{}set_len", link_prefix);
David Tolnay503d0192020-04-24 22:18:56 -0700835 let link_stride = format!("{}stride", link_prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700836
Adrian Taylorc8713432020-10-21 18:20:55 -0700837 let local_prefix = format_ident!("{}__vec_", elem.rust);
David Tolnayf97c2d52020-04-25 16:37:48 -0700838 let local_new = format_ident!("{}new", local_prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700839 let local_drop = format_ident!("{}drop", local_prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700840 let local_len = format_ident!("{}len", local_prefix);
David Tolnay219c0792020-04-24 20:31:37 -0700841 let local_data = format_ident!("{}data", local_prefix);
David Tolnayfb6b73c2020-11-10 14:32:16 -0800842 let local_reserve_total = format_ident!("{}reserve_total", local_prefix);
843 let local_set_len = format_ident!("{}set_len", local_prefix);
David Tolnay503d0192020-04-24 22:18:56 -0700844 let local_stride = format_ident!("{}stride", local_prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700845
David Tolnay83a7ec92020-04-25 12:37:42 -0700846 let span = elem.span();
Myron Ahneba35cf2020-02-05 19:41:51 +0700847 quote_spanned! {span=>
848 #[doc(hidden)]
David Tolnayf97c2d52020-04-25 16:37:48 -0700849 #[export_name = #link_new]
850 unsafe extern "C" fn #local_new(this: *mut ::cxx::private::RustVec<#elem>) {
851 ::std::ptr::write(this, ::cxx::private::RustVec::new());
852 }
853 #[doc(hidden)]
Myron Ahneba35cf2020-02-05 19:41:51 +0700854 #[export_name = #link_drop]
David Tolnay83a7ec92020-04-25 12:37:42 -0700855 unsafe extern "C" fn #local_drop(this: *mut ::cxx::private::RustVec<#elem>) {
David Tolnay4c64afb2020-04-24 11:30:18 -0700856 ::std::ptr::drop_in_place(this);
Myron Ahneba35cf2020-02-05 19:41:51 +0700857 }
David Tolnay85db5a02020-04-25 13:17:27 -0700858 #[doc(hidden)]
Myron Ahneba35cf2020-02-05 19:41:51 +0700859 #[export_name = #link_len]
David Tolnay83a7ec92020-04-25 12:37:42 -0700860 unsafe extern "C" fn #local_len(this: *const ::cxx::private::RustVec<#elem>) -> usize {
David Tolnay2cef5df2020-04-24 11:33:58 -0700861 (*this).len()
Myron Ahneba35cf2020-02-05 19:41:51 +0700862 }
David Tolnay219c0792020-04-24 20:31:37 -0700863 #[doc(hidden)]
864 #[export_name = #link_data]
David Tolnay83a7ec92020-04-25 12:37:42 -0700865 unsafe extern "C" fn #local_data(this: *const ::cxx::private::RustVec<#elem>) -> *const #elem {
David Tolnay219c0792020-04-24 20:31:37 -0700866 (*this).as_ptr()
867 }
David Tolnay503d0192020-04-24 22:18:56 -0700868 #[doc(hidden)]
David Tolnayfb6b73c2020-11-10 14:32:16 -0800869 #[export_name = #link_reserve_total]
870 unsafe extern "C" fn #local_reserve_total(this: *mut ::cxx::private::RustVec<#elem>, cap: usize) {
871 (*this).reserve_total(cap);
872 }
873 #[doc(hidden)]
874 #[export_name = #link_set_len]
875 unsafe extern "C" fn #local_set_len(this: *mut ::cxx::private::RustVec<#elem>, len: usize) {
876 (*this).set_len(len);
877 }
878 #[doc(hidden)]
David Tolnay503d0192020-04-24 22:18:56 -0700879 #[export_name = #link_stride]
880 unsafe extern "C" fn #local_stride() -> usize {
David Tolnay83a7ec92020-04-25 12:37:42 -0700881 ::std::mem::size_of::<#elem>()
David Tolnay503d0192020-04-24 22:18:56 -0700882 }
Myron Ahneba35cf2020-02-05 19:41:51 +0700883 }
884}
885
David Tolnay0531f432020-10-03 23:50:28 -0700886fn expand_unique_ptr(
Adrian Taylorc8713432020-10-21 18:20:55 -0700887 ident: &ResolvableName,
David Tolnay0531f432020-10-03 23:50:28 -0700888 types: &Types,
889 explicit_impl: Option<&Impl>,
890) -> TokenStream {
Adrian Taylorc8713432020-10-21 18:20:55 -0700891 let name = ident.rust.to_string();
David Tolnay0f0162f2020-11-16 23:43:37 -0800892 let prefix = format!("cxxbridge1$unique_ptr${}$", ident.to_symbol(types));
David Tolnay7db73692019-10-20 14:51:12 -0400893 let link_null = format!("{}null", prefix);
894 let link_new = format!("{}new", prefix);
895 let link_raw = format!("{}raw", prefix);
896 let link_get = format!("{}get", prefix);
897 let link_release = format!("{}release", prefix);
898 let link_drop = format!("{}drop", prefix);
899
Adrian Taylorc8713432020-10-21 18:20:55 -0700900 let new_method =
901 if types.structs.contains_key(&ident.rust) || types.aliases.contains_key(&ident.rust) {
902 Some(quote! {
903 fn __new(mut value: Self) -> *mut ::std::ffi::c_void {
904 extern "C" {
905 #[link_name = #link_new]
906 fn __new(this: *mut *mut ::std::ffi::c_void, value: *mut #ident);
907 }
908 let mut repr = ::std::ptr::null_mut::<::std::ffi::c_void>();
909 unsafe { __new(&mut repr, &mut value) }
910 repr
David Tolnay53838912020-04-09 20:56:44 -0700911 }
Adrian Taylorc8713432020-10-21 18:20:55 -0700912 })
913 } else {
914 None
915 };
David Tolnay53838912020-04-09 20:56:44 -0700916
David Tolnay0531f432020-10-03 23:50:28 -0700917 let begin_span =
918 explicit_impl.map_or_else(Span::call_site, |explicit| explicit.impl_token.span);
919 let end_span = explicit_impl.map_or_else(Span::call_site, |explicit| explicit.brace_token.span);
920 let unsafe_token = format_ident!("unsafe", span = begin_span);
921
922 quote_spanned! {end_span=>
923 #unsafe_token impl ::cxx::private::UniquePtrTarget for #ident {
David Tolnay3b40b6f2020-04-24 17:58:24 -0700924 const __NAME: &'static dyn ::std::fmt::Display = &#name;
David Tolnay7db73692019-10-20 14:51:12 -0400925 fn __null() -> *mut ::std::ffi::c_void {
926 extern "C" {
927 #[link_name = #link_null]
928 fn __null(this: *mut *mut ::std::ffi::c_void);
929 }
930 let mut repr = ::std::ptr::null_mut::<::std::ffi::c_void>();
931 unsafe { __null(&mut repr) }
932 repr
933 }
David Tolnay53838912020-04-09 20:56:44 -0700934 #new_method
David Tolnay7db73692019-10-20 14:51:12 -0400935 unsafe fn __raw(raw: *mut Self) -> *mut ::std::ffi::c_void {
936 extern "C" {
937 #[link_name = #link_raw]
David Tolnay3b40b6f2020-04-24 17:58:24 -0700938 fn __raw(this: *mut *mut ::std::ffi::c_void, raw: *mut #ident);
David Tolnay7db73692019-10-20 14:51:12 -0400939 }
940 let mut repr = ::std::ptr::null_mut::<::std::ffi::c_void>();
941 __raw(&mut repr, raw);
942 repr
943 }
944 unsafe fn __get(repr: *mut ::std::ffi::c_void) -> *const Self {
945 extern "C" {
946 #[link_name = #link_get]
David Tolnay3b40b6f2020-04-24 17:58:24 -0700947 fn __get(this: *const *mut ::std::ffi::c_void) -> *const #ident;
David Tolnay7db73692019-10-20 14:51:12 -0400948 }
949 __get(&repr)
950 }
951 unsafe fn __release(mut repr: *mut ::std::ffi::c_void) -> *mut Self {
952 extern "C" {
953 #[link_name = #link_release]
David Tolnay3b40b6f2020-04-24 17:58:24 -0700954 fn __release(this: *mut *mut ::std::ffi::c_void) -> *mut #ident;
David Tolnay7db73692019-10-20 14:51:12 -0400955 }
956 __release(&mut repr)
957 }
958 unsafe fn __drop(mut repr: *mut ::std::ffi::c_void) {
959 extern "C" {
960 #[link_name = #link_drop]
961 fn __drop(this: *mut *mut ::std::ffi::c_void);
962 }
963 __drop(&mut repr);
964 }
965 }
966 }
967}
968
David Tolnay0531f432020-10-03 23:50:28 -0700969fn expand_cxx_vector(
Adrian Taylorc8713432020-10-21 18:20:55 -0700970 elem: &ResolvableName,
David Tolnay0531f432020-10-03 23:50:28 -0700971 explicit_impl: Option<&Impl>,
Adrian Taylorc8713432020-10-21 18:20:55 -0700972 types: &Types,
David Tolnay0531f432020-10-03 23:50:28 -0700973) -> TokenStream {
974 let _ = explicit_impl;
Adrian Taylorc8713432020-10-21 18:20:55 -0700975 let name = elem.rust.to_string();
David Tolnay0f0162f2020-11-16 23:43:37 -0800976 let prefix = format!("cxxbridge1$std$vector${}$", elem.to_symbol(types));
David Tolnaya83247c2020-04-24 14:36:10 -0700977 let link_size = format!("{}size", prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700978 let link_get_unchecked = format!("{}get_unchecked", prefix);
Adrian Taylorc8713432020-10-21 18:20:55 -0700979 let unique_ptr_prefix = format!(
David Tolnay0f0162f2020-11-16 23:43:37 -0800980 "cxxbridge1$unique_ptr$std$vector${}$",
Adrian Taylorc8713432020-10-21 18:20:55 -0700981 elem.to_symbol(types)
982 );
David Tolnay3b40b6f2020-04-24 17:58:24 -0700983 let link_unique_ptr_null = format!("{}null", unique_ptr_prefix);
984 let link_unique_ptr_raw = format!("{}raw", unique_ptr_prefix);
985 let link_unique_ptr_get = format!("{}get", unique_ptr_prefix);
986 let link_unique_ptr_release = format!("{}release", unique_ptr_prefix);
987 let link_unique_ptr_drop = format!("{}drop", unique_ptr_prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700988
David Tolnay0531f432020-10-03 23:50:28 -0700989 let begin_span =
990 explicit_impl.map_or_else(Span::call_site, |explicit| explicit.impl_token.span);
991 let end_span = explicit_impl.map_or_else(Span::call_site, |explicit| explicit.brace_token.span);
992 let unsafe_token = format_ident!("unsafe", span = begin_span);
993
994 quote_spanned! {end_span=>
995 #unsafe_token impl ::cxx::private::VectorElement for #elem {
David Tolnay3b40b6f2020-04-24 17:58:24 -0700996 const __NAME: &'static dyn ::std::fmt::Display = &#name;
David Tolnay17631102020-04-24 19:01:30 -0700997 fn __vector_size(v: &::cxx::CxxVector<Self>) -> usize {
David Tolnayfa2119c2020-04-24 14:42:58 -0700998 extern "C" {
999 #[link_name = #link_size]
David Tolnay17631102020-04-24 19:01:30 -07001000 fn __vector_size(_: &::cxx::CxxVector<#elem>) -> usize;
Myron Ahneba35cf2020-02-05 19:41:51 +07001001 }
David Tolnayfa2119c2020-04-24 14:42:58 -07001002 unsafe { __vector_size(v) }
Myron Ahneba35cf2020-02-05 19:41:51 +07001003 }
David Tolnay93637ca2020-09-24 15:58:20 -04001004 unsafe fn __get_unchecked(v: &::cxx::CxxVector<Self>, pos: usize) -> *const Self {
David Tolnaycc75ad22020-04-24 14:45:16 -07001005 extern "C" {
1006 #[link_name = #link_get_unchecked]
David Tolnay17631102020-04-24 19:01:30 -07001007 fn __get_unchecked(_: &::cxx::CxxVector<#elem>, _: usize) -> *const #elem;
David Tolnaycc75ad22020-04-24 14:45:16 -07001008 }
David Tolnay93637ca2020-09-24 15:58:20 -04001009 __get_unchecked(v, pos)
David Tolnaycc75ad22020-04-24 14:45:16 -07001010 }
David Tolnay3b40b6f2020-04-24 17:58:24 -07001011 fn __unique_ptr_null() -> *mut ::std::ffi::c_void {
1012 extern "C" {
1013 #[link_name = #link_unique_ptr_null]
1014 fn __unique_ptr_null(this: *mut *mut ::std::ffi::c_void);
1015 }
1016 let mut repr = ::std::ptr::null_mut::<::std::ffi::c_void>();
1017 unsafe { __unique_ptr_null(&mut repr) }
1018 repr
1019 }
1020 unsafe fn __unique_ptr_raw(raw: *mut ::cxx::CxxVector<Self>) -> *mut ::std::ffi::c_void {
1021 extern "C" {
1022 #[link_name = #link_unique_ptr_raw]
1023 fn __unique_ptr_raw(this: *mut *mut ::std::ffi::c_void, raw: *mut ::cxx::CxxVector<#elem>);
1024 }
1025 let mut repr = ::std::ptr::null_mut::<::std::ffi::c_void>();
1026 __unique_ptr_raw(&mut repr, raw);
1027 repr
1028 }
1029 unsafe fn __unique_ptr_get(repr: *mut ::std::ffi::c_void) -> *const ::cxx::CxxVector<Self> {
1030 extern "C" {
1031 #[link_name = #link_unique_ptr_get]
1032 fn __unique_ptr_get(this: *const *mut ::std::ffi::c_void) -> *const ::cxx::CxxVector<#elem>;
1033 }
1034 __unique_ptr_get(&repr)
1035 }
1036 unsafe fn __unique_ptr_release(mut repr: *mut ::std::ffi::c_void) -> *mut ::cxx::CxxVector<Self> {
1037 extern "C" {
1038 #[link_name = #link_unique_ptr_release]
1039 fn __unique_ptr_release(this: *mut *mut ::std::ffi::c_void) -> *mut ::cxx::CxxVector<#elem>;
1040 }
1041 __unique_ptr_release(&mut repr)
1042 }
1043 unsafe fn __unique_ptr_drop(mut repr: *mut ::std::ffi::c_void) {
1044 extern "C" {
1045 #[link_name = #link_unique_ptr_drop]
1046 fn __unique_ptr_drop(this: *mut *mut ::std::ffi::c_void);
1047 }
1048 __unique_ptr_drop(&mut repr);
1049 }
Myron Ahneba35cf2020-02-05 19:41:51 +07001050 }
1051 }
1052}
1053
David Tolnay7db73692019-10-20 14:51:12 -04001054fn expand_return_type(ret: &Option<Type>) -> TokenStream {
1055 match ret {
1056 Some(ret) => quote!(-> #ret),
1057 None => TokenStream::new(),
1058 }
1059}
1060
David Tolnay75dca2e2020-03-25 20:17:52 -07001061fn indirect_return(sig: &Signature, types: &Types) -> bool {
1062 sig.ret
David Tolnay1e548172020-03-16 13:37:09 -07001063 .as_ref()
David Tolnay75dca2e2020-03-25 20:17:52 -07001064 .map_or(false, |ret| sig.throws || types.needs_indirect_abi(ret))
David Tolnay7db73692019-10-20 14:51:12 -04001065}
1066
David Tolnay2f090422020-11-02 18:25:35 -08001067fn expand_extern_type(ty: &Type, types: &Types, proper: bool) -> TokenStream {
David Tolnay7db73692019-10-20 14:51:12 -04001068 match ty {
Adrian Taylorc8713432020-10-21 18:20:55 -07001069 Type::Ident(ident) if ident.rust == RustString => quote!(::cxx::private::RustString),
David Tolnay7db73692019-10-20 14:51:12 -04001070 Type::RustBox(ty) | Type::UniquePtr(ty) => {
David Tolnay2f090422020-11-02 18:25:35 -08001071 let inner = expand_extern_type(&ty.inner, types, proper);
David Tolnay7db73692019-10-20 14:51:12 -04001072 quote!(*mut #inner)
1073 }
David Tolnaye6d50212020-04-25 15:38:23 -07001074 Type::RustVec(ty) => {
David Tolnay2f090422020-11-02 18:25:35 -08001075 let elem = expand_extern_type(&ty.inner, types, proper);
David Tolnaye6d50212020-04-25 15:38:23 -07001076 quote!(::cxx::private::RustVec<#elem>)
1077 }
David Tolnayf1c7f322020-08-27 00:46:01 -07001078 Type::Ref(ty) => {
1079 let mutability = ty.mutability;
1080 match &ty.inner {
Adrian Taylorc8713432020-10-21 18:20:55 -07001081 Type::Ident(ident) if ident.rust == RustString => {
David Tolnayf1c7f322020-08-27 00:46:01 -07001082 quote!(&#mutability ::cxx::private::RustString)
1083 }
1084 Type::RustVec(ty) => {
David Tolnay2f090422020-11-02 18:25:35 -08001085 let inner = expand_extern_type(&ty.inner, types, proper);
David Tolnayf1c7f322020-08-27 00:46:01 -07001086 quote!(&#mutability ::cxx::private::RustVec<#inner>)
1087 }
David Tolnay9c4ac2e2020-11-15 21:14:03 -08001088 inner if proper && types.is_considered_improper_ctype(inner) => match ty.mutable {
1089 false => quote!(*const ::std::ffi::c_void),
1090 true => quote!(*#mutability ::std::ffi::c_void),
David Tolnay4cb97672020-11-02 16:13:34 -08001091 },
David Tolnayf1c7f322020-08-27 00:46:01 -07001092 _ => quote!(#ty),
Myron Ahneba35cf2020-02-05 19:41:51 +07001093 }
David Tolnayf1c7f322020-08-27 00:46:01 -07001094 }
David Tolnay7db73692019-10-20 14:51:12 -04001095 Type::Str(_) => quote!(::cxx::private::RustStr),
Adrian Taylorf5dd5522020-04-13 16:50:14 -07001096 Type::SliceRefU8(_) => quote!(::cxx::private::RustSliceU8),
David Tolnay7db73692019-10-20 14:51:12 -04001097 _ => quote!(#ty),
1098 }
1099}
1100
David Tolnay2f090422020-11-02 18:25:35 -08001101fn expand_extern_return_type(ret: &Option<Type>, types: &Types, proper: bool) -> TokenStream {
David Tolnay7db73692019-10-20 14:51:12 -04001102 let ret = match ret {
1103 Some(ret) if !types.needs_indirect_abi(ret) => ret,
1104 _ => return TokenStream::new(),
1105 };
David Tolnay2f090422020-11-02 18:25:35 -08001106 let ty = expand_extern_type(ret, types, proper);
David Tolnay7db73692019-10-20 14:51:12 -04001107 quote!(-> #ty)
1108}