blob: fd2ea3293f846675567e890029710aa61796f35c [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 Tolnayc94035a2020-11-15 16:49:18 -080012use std::collections::BTreeSet as Set;
David Tolnay05ef6ff2020-08-29 11:27:05 -070013use std::mem;
14use syn::{parse_quote, Result, Token};
David Tolnay7db73692019-10-20 14:51:12 -040015
David Tolnay3c64a4e2020-08-29 14:07:38 -070016pub fn bridge(mut ffi: Module) -> Result<TokenStream> {
David Tolnay0dd85ff2020-05-03 23:43:33 -070017 let ref mut errors = Errors::new();
David Tolnay05ef6ff2020-08-29 11:27:05 -070018 let content = mem::take(&mut ffi.content);
David Tolnay805dca32020-08-29 19:09:55 -070019 let trusted = ffi.unsafety.is_some();
Adrian Taylorc8713432020-10-21 18:20:55 -070020 let namespace = &ffi.namespace;
21 let ref apis = syntax::parse_items(errors, content, trusted, namespace);
David Tolnay52759782020-05-03 23:59:40 -070022 let ref types = Types::collect(errors, apis);
23 errors.propagate()?;
Adrian Taylorc8713432020-10-21 18:20:55 -070024 check::typecheck(errors, apis, types);
David Tolnay0dd85ff2020-05-03 23:43:33 -070025 errors.propagate()?;
David Tolnay7db73692019-10-20 14:51:12 -040026
David Tolnay3c64a4e2020-08-29 14:07:38 -070027 Ok(expand(ffi, apis, types))
David Tolnaycbf3f032020-05-03 23:51:14 -070028}
29
David Tolnay3c64a4e2020-08-29 14:07:38 -070030fn expand(ffi: Module, apis: &[Api], types: &Types) -> TokenStream {
David Tolnay7db73692019-10-20 14:51:12 -040031 let mut expanded = TokenStream::new();
32 let mut hidden = TokenStream::new();
David Tolnay7db73692019-10-20 14:51:12 -040033
David Tolnay2ec14632020-05-04 00:47:10 -070034 for api in apis {
David Tolnay7db73692019-10-20 14:51:12 -040035 if let Api::RustType(ety) = api {
36 expanded.extend(expand_rust_type(ety));
David Tolnayc8361022020-08-25 21:57:53 -070037 hidden.extend(expand_rust_type_assert_sized(ety));
David Tolnay7db73692019-10-20 14:51:12 -040038 }
39 }
40
David Tolnay2ec14632020-05-04 00:47:10 -070041 for api in apis {
David Tolnay7db73692019-10-20 14:51:12 -040042 match api {
David Tolnay7e69f892020-10-03 22:20:22 -070043 Api::Include(_) | Api::RustType(_) | Api::Impl(_) => {}
Adrian Taylorc8713432020-10-21 18:20:55 -070044 Api::Struct(strct) => expanded.extend(expand_struct(strct)),
45 Api::Enum(enm) => expanded.extend(expand_enum(enm)),
Joel Galenson905eb2e2020-05-04 14:58:14 -070046 Api::CxxType(ety) => {
David Tolnay17a934c2020-11-02 00:40:04 -080047 let ident = &ety.name.rust;
48 if !types.structs.contains_key(ident) && !types.enums.contains_key(ident) {
Adrian Taylorc8713432020-10-21 18:20:55 -070049 expanded.extend(expand_cxx_type(ety));
David Tolnay9eef6092020-11-15 17:56:41 -080050 hidden.extend(expand_cxx_type_assert_pinned(ety));
Joel Galenson905eb2e2020-05-04 14:58:14 -070051 }
52 }
David Tolnay7db73692019-10-20 14:51:12 -040053 Api::CxxFunction(efn) => {
Adrian Taylorc8713432020-10-21 18:20:55 -070054 expanded.extend(expand_cxx_function_shim(efn, types));
David Tolnay7db73692019-10-20 14:51:12 -040055 }
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
David Tolnayc94035a2020-11-15 16:49:18 -080064 let mut expanded_unique_ptr = Set::new();
David Tolnay7db73692019-10-20 14:51:12 -040065 for ty in types {
David Tolnay0531f432020-10-03 23:50:28 -070066 let explicit_impl = types.explicit_impls.get(ty);
David Tolnay7db73692019-10-20 14:51:12 -040067 if let Type::RustBox(ty) = ty {
68 if let Type::Ident(ident) = &ty.inner {
Adrian Taylorc8713432020-10-21 18:20:55 -070069 if Atom::from(&ident.rust).is_none() {
70 hidden.extend(expand_rust_box(ident, types));
David Tolnay7db73692019-10-20 14:51:12 -040071 }
72 }
Myron Ahneba35cf2020-02-05 19:41:51 +070073 } else if let Type::RustVec(ty) = ty {
74 if let Type::Ident(ident) = &ty.inner {
Adrian Taylorc8713432020-10-21 18:20:55 -070075 if Atom::from(&ident.rust).is_none() {
76 hidden.extend(expand_rust_vec(ident, types));
David Tolnaya006bca2020-04-25 11:28:13 -070077 }
Myron Ahneba35cf2020-02-05 19:41:51 +070078 }
David Tolnay7db73692019-10-20 14:51:12 -040079 } else if let Type::UniquePtr(ptr) = ty {
80 if let Type::Ident(ident) = &ptr.inner {
Adrian Taylorc8713432020-10-21 18:20:55 -070081 if Atom::from(&ident.rust).is_none()
82 && (explicit_impl.is_some() || !types.aliases.contains_key(&ident.rust))
David Tolnayc94035a2020-11-15 16:49:18 -080083 && expanded_unique_ptr.insert(&ident.rust)
David Tolnay7e69f892020-10-03 22:20:22 -070084 {
Adrian Taylorc8713432020-10-21 18:20:55 -070085 expanded.extend(expand_unique_ptr(ident, types, explicit_impl));
Myron Ahneba35cf2020-02-05 19:41:51 +070086 }
87 }
David Tolnay4377a9e2020-04-24 15:20:26 -070088 } else if let Type::CxxVector(ptr) = ty {
Myron Ahneba35cf2020-02-05 19:41:51 +070089 if let Type::Ident(ident) = &ptr.inner {
Adrian Taylorc8713432020-10-21 18:20:55 -070090 if Atom::from(&ident.rust).is_none()
91 && (explicit_impl.is_some() || !types.aliases.contains_key(&ident.rust))
David Tolnay7e69f892020-10-03 22:20:22 -070092 {
David Tolnay17631102020-04-24 19:01:30 -070093 // Generate impl for CxxVector<T> if T is a struct or opaque
94 // C++ type. Impl for primitives is already provided by cxx
95 // crate.
Adrian Taylorc8713432020-10-21 18:20:55 -070096 expanded.extend(expand_cxx_vector(ident, explicit_impl, types));
David Tolnay7db73692019-10-20 14:51:12 -040097 }
98 }
99 }
100 }
101
102 // Work around https://github.com/rust-lang/rust/issues/67851.
103 if !hidden.is_empty() {
104 expanded.extend(quote! {
105 #[doc(hidden)]
106 const _: () = {
107 #hidden
108 };
109 });
110 }
111
112 let attrs = ffi
113 .attrs
114 .into_iter()
115 .filter(|attr| attr.path.is_ident("doc"));
116 let vis = &ffi.vis;
David Tolnaycbf3f032020-05-03 23:51:14 -0700117 let ident = &ffi.ident;
David Tolnay7db73692019-10-20 14:51:12 -0400118
David Tolnaycbf3f032020-05-03 23:51:14 -0700119 quote! {
David Tolnay7db73692019-10-20 14:51:12 -0400120 #(#attrs)*
121 #[deny(improper_ctypes)]
122 #[allow(non_snake_case)]
123 #vis mod #ident {
124 #expanded
125 }
David Tolnaycbf3f032020-05-03 23:51:14 -0700126 }
David Tolnay7db73692019-10-20 14:51:12 -0400127}
128
Adrian Taylorc8713432020-10-21 18:20:55 -0700129fn expand_struct(strct: &Struct) -> TokenStream {
David Tolnay17a934c2020-11-02 00:40:04 -0800130 let ident = &strct.name.rust;
David Tolnay7db73692019-10-20 14:51:12 -0400131 let doc = &strct.doc;
David Tolnayf3a9afa2020-10-08 23:22:12 -0700132 let derives = DeriveAttribute(&strct.derives);
David Tolnay17a934c2020-11-02 00:40:04 -0800133 let type_id = type_id(&strct.name);
David Tolnay7db73692019-10-20 14:51:12 -0400134 let fields = strct.fields.iter().map(|field| {
135 // This span on the pub makes "private type in public interface" errors
136 // appear in the right place.
137 let vis = Token![pub](field.ident.span());
138 quote!(#vis #field)
139 });
David Tolnay8684cc52020-10-07 17:09:48 -0700140
David Tolnay7db73692019-10-20 14:51:12 -0400141 quote! {
142 #doc
David Tolnayf3a9afa2020-10-08 23:22:12 -0700143 #derives
David Tolnay7db73692019-10-20 14:51:12 -0400144 #[repr(C)]
145 pub struct #ident {
146 #(#fields,)*
147 }
David Tolnay8684cc52020-10-07 17:09:48 -0700148
149 unsafe impl ::cxx::ExternType for #ident {
150 type Id = #type_id;
151 type Kind = ::cxx::kind::Trivial;
152 }
David Tolnay7db73692019-10-20 14:51:12 -0400153 }
154}
155
Adrian Taylorc8713432020-10-21 18:20:55 -0700156fn expand_enum(enm: &Enum) -> TokenStream {
David Tolnay17a934c2020-11-02 00:40:04 -0800157 let ident = &enm.name.rust;
Joel Galensonc03402a2020-04-23 17:31:09 -0700158 let doc = &enm.doc;
David Tolnayc605e6f2020-05-10 23:37:12 -0700159 let repr = enm.repr;
David Tolnay17a934c2020-11-02 00:40:04 -0800160 let type_id = type_id(&enm.name);
Joel Galenson88547732020-05-05 08:23:42 -0700161 let variants = enm.variants.iter().map(|variant| {
162 let variant_ident = &variant.ident;
163 let discriminant = &variant.discriminant;
164 Some(quote! {
165 pub const #variant_ident: Self = #ident { repr: #discriminant };
166 })
167 });
David Tolnay8684cc52020-10-07 17:09:48 -0700168
Joel Galensonc03402a2020-04-23 17:31:09 -0700169 quote! {
170 #doc
171 #[derive(Copy, Clone, PartialEq, Eq)]
172 #[repr(transparent)]
Joel Galensondb1ec312020-05-01 13:57:32 -0700173 pub struct #ident {
David Tolnayc605e6f2020-05-10 23:37:12 -0700174 pub repr: #repr,
Joel Galensondb1ec312020-05-01 13:57:32 -0700175 }
Joel Galensonc03402a2020-04-23 17:31:09 -0700176
177 #[allow(non_upper_case_globals)]
178 impl #ident {
David Tolnayd7984c22020-04-30 20:09:31 -0700179 #(#variants)*
Joel Galensonc03402a2020-04-23 17:31:09 -0700180 }
David Tolnay8684cc52020-10-07 17:09:48 -0700181
182 unsafe impl ::cxx::ExternType for #ident {
183 type Id = #type_id;
184 type Kind = ::cxx::kind::Trivial;
185 }
Joel Galensonc03402a2020-04-23 17:31:09 -0700186 }
187}
188
Adrian Taylorc8713432020-10-21 18:20:55 -0700189fn expand_cxx_type(ety: &ExternType) -> TokenStream {
David Tolnay17a934c2020-11-02 00:40:04 -0800190 let ident = &ety.name.rust;
David Tolnay7db73692019-10-20 14:51:12 -0400191 let doc = &ety.doc;
David Tolnay17a934c2020-11-02 00:40:04 -0800192 let type_id = type_id(&ety.name);
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700193
David Tolnay7db73692019-10-20 14:51:12 -0400194 quote! {
195 #doc
196 #[repr(C)]
197 pub struct #ident {
198 _private: ::cxx::private::Opaque,
199 }
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700200
201 unsafe impl ::cxx::ExternType for #ident {
202 type Id = #type_id;
David Tolnay38f5ad62020-10-03 18:06:44 -0700203 type Kind = ::cxx::kind::Opaque;
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700204 }
David Tolnay7db73692019-10-20 14:51:12 -0400205 }
206}
207
David Tolnay9eef6092020-11-15 17:56:41 -0800208fn expand_cxx_type_assert_pinned(ety: &ExternType) -> TokenStream {
209 let ident = &ety.name.rust;
210 let infer = Token![_](ident.span());
211
212 quote! {
213 let _ = {
214 // Derived from https://github.com/nvzqz/static-assertions-rs.
215 trait __AmbiguousIfImpl<A> {
216 fn infer() {}
217 }
218
219 impl<T: ?Sized> __AmbiguousIfImpl<()> for T {}
220
221 #[allow(dead_code)]
222 struct __Invalid;
223
224 impl<T: ?Sized + Unpin> __AmbiguousIfImpl<__Invalid> for T {}
225
226 // If there is only one specialized trait impl, type inference with
227 // `_` can be resolved and this can compile. Fails to compile if
228 // user has added a manual Unpin impl for their opaque C++ type as
229 // then `__AmbiguousIfImpl<__Invalid>` also exists.
230 <#ident as __AmbiguousIfImpl<#infer>>::infer
231 };
232 }
233}
234
Adrian Taylorc8713432020-10-21 18:20:55 -0700235fn expand_cxx_function_decl(efn: &ExternFn, types: &Types) -> TokenStream {
David Tolnay9938b642020-11-15 18:11:40 -0800236 let generics = &efn.generics;
David Tolnay18ba92c2020-04-22 16:17:30 -0700237 let receiver = efn.receiver.iter().map(|receiver| {
238 let receiver_type = receiver.ty();
239 quote!(_: #receiver_type)
240 });
David Tolnay39d575f2020-03-03 00:10:56 -0800241 let args = efn.args.iter().map(|arg| {
242 let ident = &arg.ident;
David Tolnay2f090422020-11-02 18:25:35 -0800243 let ty = expand_extern_type(&arg.ty, types, true);
David Tolnaya46a2372020-03-06 10:03:48 -0800244 if arg.ty == RustString {
245 quote!(#ident: *const #ty)
David Tolnay313b10e2020-04-25 16:30:51 -0700246 } else if let Type::RustVec(_) = arg.ty {
247 quote!(#ident: *const #ty)
David Tolnay75dca2e2020-03-25 20:17:52 -0700248 } else if let Type::Fn(_) = arg.ty {
249 quote!(#ident: ::cxx::private::FatFunction)
David Tolnaya46a2372020-03-06 10:03:48 -0800250 } else if types.needs_indirect_abi(&arg.ty) {
David Tolnay39d575f2020-03-03 00:10:56 -0800251 quote!(#ident: *mut #ty)
252 } else {
253 quote!(#ident: #ty)
254 }
255 });
Joel Galenson3d4f6122020-04-07 15:54:05 -0700256 let all_args = receiver.chain(args);
David Tolnayebef4a22020-03-17 15:33:47 -0700257 let ret = if efn.throws {
258 quote!(-> ::cxx::private::Result)
259 } else {
David Tolnay2f090422020-11-02 18:25:35 -0800260 expand_extern_return_type(&efn.ret, types, true)
David Tolnayebef4a22020-03-17 15:33:47 -0700261 };
David Tolnay7db73692019-10-20 14:51:12 -0400262 let mut outparam = None;
David Tolnay1e548172020-03-16 13:37:09 -0700263 if indirect_return(efn, types) {
David Tolnay2f090422020-11-02 18:25:35 -0800264 let ret = expand_extern_type(efn.ret.as_ref().unwrap(), types, true);
David Tolnay7db73692019-10-20 14:51:12 -0400265 outparam = Some(quote!(__return: *mut #ret));
266 }
Adrian Taylorc8713432020-10-21 18:20:55 -0700267 let link_name = mangle::extern_fn(efn, types);
David Tolnay17a934c2020-11-02 00:40:04 -0800268 let local_name = format_ident!("__{}", efn.name.rust);
David Tolnay7db73692019-10-20 14:51:12 -0400269 quote! {
270 #[link_name = #link_name]
David Tolnay9938b642020-11-15 18:11:40 -0800271 fn #local_name #generics(#(#all_args,)* #outparam) #ret;
David Tolnay7db73692019-10-20 14:51:12 -0400272 }
273}
274
Adrian Taylorc8713432020-10-21 18:20:55 -0700275fn expand_cxx_function_shim(efn: &ExternFn, types: &Types) -> TokenStream {
David Tolnay7db73692019-10-20 14:51:12 -0400276 let doc = &efn.doc;
Adrian Taylorc8713432020-10-21 18:20:55 -0700277 let decl = expand_cxx_function_decl(efn, types);
David Tolnayfb6e3862020-04-20 01:33:23 -0700278 let receiver = efn.receiver.iter().map(|receiver| {
David Tolnayf9ffb932020-04-20 02:22:57 -0700279 let var = receiver.var;
David Tolnayc9673842020-11-15 16:26:10 -0800280 if receiver.pinned {
281 let ty = receiver.ty();
282 quote!(#var: #ty)
283 } else {
284 let ampersand = receiver.ampersand;
David Tolnay9938b642020-11-15 18:11:40 -0800285 let lifetime = &receiver.lifetime;
David Tolnayc9673842020-11-15 16:26:10 -0800286 let mutability = receiver.mutability;
David Tolnay9938b642020-11-15 18:11:40 -0800287 quote!(#ampersand #lifetime #mutability #var)
David Tolnayc9673842020-11-15 16:26:10 -0800288 }
David Tolnayfb6e3862020-04-20 01:33:23 -0700289 });
Joel Galenson3d4f6122020-04-07 15:54:05 -0700290 let args = efn.args.iter().map(|arg| quote!(#arg));
291 let all_args = receiver.chain(args);
David Tolnayebef4a22020-03-17 15:33:47 -0700292 let ret = if efn.throws {
293 let ok = match &efn.ret {
294 Some(ret) => quote!(#ret),
295 None => quote!(()),
296 };
297 quote!(-> ::std::result::Result<#ok, ::cxx::Exception>)
298 } else {
299 expand_return_type(&efn.ret)
300 };
David Tolnay1e548172020-03-16 13:37:09 -0700301 let indirect_return = indirect_return(efn, types);
David Tolnayf9ffb932020-04-20 02:22:57 -0700302 let receiver_var = efn
303 .receiver
304 .iter()
305 .map(|receiver| receiver.var.to_token_stream());
Joel Galenson3d4f6122020-04-07 15:54:05 -0700306 let arg_vars = efn.args.iter().map(|arg| {
David Tolnay7db73692019-10-20 14:51:12 -0400307 let var = &arg.ident;
308 match &arg.ty {
Adrian Taylorc8713432020-10-21 18:20:55 -0700309 Type::Ident(ident) if ident.rust == RustString => {
David Tolnaya46a2372020-03-06 10:03:48 -0800310 quote!(#var.as_mut_ptr() as *const ::cxx::private::RustString)
David Tolnay7db73692019-10-20 14:51:12 -0400311 }
312 Type::RustBox(_) => quote!(::std::boxed::Box::into_raw(#var)),
David Tolnaya4170652020-11-15 17:00:59 -0800313 Type::UniquePtr(ptr) => match ptr.pinned {
314 false => quote!(::cxx::UniquePtr::into_raw(#var)),
315 true => quote!(::cxx::UniquePtr::__pin_into_raw(#var)),
316 },
David Tolnay313b10e2020-04-25 16:30:51 -0700317 Type::RustVec(_) => quote!(#var.as_mut_ptr() as *const ::cxx::private::RustVec<_>),
David Tolnay7db73692019-10-20 14:51:12 -0400318 Type::Ref(ty) => match &ty.inner {
Adrian Taylorc8713432020-10-21 18:20:55 -0700319 Type::Ident(ident) if ident.rust == RustString => match ty.mutability {
David Tolnayf1c7f322020-08-27 00:46:01 -0700320 None => quote!(::cxx::private::RustString::from_ref(#var)),
321 Some(_) => quote!(::cxx::private::RustString::from_mut(#var)),
322 },
David Tolnay33f56ad2020-08-27 17:06:35 -0700323 Type::RustVec(vec) if vec.inner == RustString => match ty.mutability {
324 None => quote!(::cxx::private::RustVec::from_ref_vec_string(#var)),
325 Some(_) => quote!(::cxx::private::RustVec::from_mut_vec_string(#var)),
326 },
David Tolnayf1c7f322020-08-27 00:46:01 -0700327 Type::RustVec(_) => match ty.mutability {
328 None => quote!(::cxx::private::RustVec::from_ref(#var)),
329 Some(_) => quote!(::cxx::private::RustVec::from_mut(#var)),
330 },
David Tolnay4cb97672020-11-02 16:13:34 -0800331 inner if types.is_considered_improper_ctype(inner) => match ty.mutability {
332 None => quote!(#var as *const #inner as *const ::std::ffi::c_void),
333 Some(_) => quote!(#var as *mut #inner as *mut ::std::ffi::c_void),
334 },
David Tolnay7db73692019-10-20 14:51:12 -0400335 _ => quote!(#var),
336 },
337 Type::Str(_) => quote!(::cxx::private::RustStr::from(#var)),
Adrian Taylorf5dd5522020-04-13 16:50:14 -0700338 Type::SliceRefU8(_) => quote!(::cxx::private::RustSliceU8::from(#var)),
David Tolnay7db73692019-10-20 14:51:12 -0400339 ty if types.needs_indirect_abi(ty) => quote!(#var.as_mut_ptr()),
340 _ => quote!(#var),
341 }
342 });
Joel Galenson3d4f6122020-04-07 15:54:05 -0700343 let vars = receiver_var.chain(arg_vars);
David Tolnay75dca2e2020-03-25 20:17:52 -0700344 let trampolines = efn
345 .args
346 .iter()
347 .filter_map(|arg| {
348 if let Type::Fn(f) = &arg.ty {
349 let var = &arg.ident;
Adrian Taylorc8713432020-10-21 18:20:55 -0700350 Some(expand_function_pointer_trampoline(efn, var, f, types))
David Tolnay75dca2e2020-03-25 20:17:52 -0700351 } else {
352 None
353 }
354 })
355 .collect::<TokenStream>();
David Tolnay7db73692019-10-20 14:51:12 -0400356 let mut setup = efn
357 .args
358 .iter()
359 .filter(|arg| types.needs_indirect_abi(&arg.ty))
360 .map(|arg| {
361 let var = &arg.ident;
362 // These are arguments for which C++ has taken ownership of the data
363 // behind the mut reference it received.
364 quote! {
David Tolnaycb4ee4b2020-04-24 11:28:08 -0700365 let mut #var = ::std::mem::MaybeUninit::new(#var);
David Tolnay7db73692019-10-20 14:51:12 -0400366 }
367 })
368 .collect::<TokenStream>();
David Tolnay17a934c2020-11-02 00:40:04 -0800369 let local_name = format_ident!("__{}", efn.name.rust);
David Tolnay7db73692019-10-20 14:51:12 -0400370 let call = if indirect_return {
David Tolnay2f090422020-11-02 18:25:35 -0800371 let ret = expand_extern_type(efn.ret.as_ref().unwrap(), types, true);
David Tolnay7db73692019-10-20 14:51:12 -0400372 setup.extend(quote! {
373 let mut __return = ::std::mem::MaybeUninit::<#ret>::uninit();
David Tolnay7db73692019-10-20 14:51:12 -0400374 });
David Tolnay0d524852020-11-02 17:21:50 -0800375 setup.extend(if efn.throws {
376 quote! {
David Tolnayebef4a22020-03-17 15:33:47 -0700377 #local_name(#(#vars,)* __return.as_mut_ptr()).exception()?;
David Tolnay0d524852020-11-02 17:21:50 -0800378 }
David Tolnayebef4a22020-03-17 15:33:47 -0700379 } else {
David Tolnay0d524852020-11-02 17:21:50 -0800380 quote! {
David Tolnayebef4a22020-03-17 15:33:47 -0700381 #local_name(#(#vars,)* __return.as_mut_ptr());
David Tolnay0d524852020-11-02 17:21:50 -0800382 }
383 });
384 quote!(__return.assume_init())
David Tolnayebef4a22020-03-17 15:33:47 -0700385 } else if efn.throws {
David Tolnay7db73692019-10-20 14:51:12 -0400386 quote! {
David Tolnayebef4a22020-03-17 15:33:47 -0700387 #local_name(#(#vars),*).exception()
David Tolnay7db73692019-10-20 14:51:12 -0400388 }
389 } else {
390 quote! {
391 #local_name(#(#vars),*)
392 }
393 };
David Tolnay2debdb22020-11-02 17:14:53 -0800394 let mut expr;
395 if efn.throws && efn.sig.ret.is_none() {
396 expr = call;
Myron Ahn84849302020-03-25 22:00:58 +0700397 } else {
David Tolnay0d524852020-11-02 17:21:50 -0800398 expr = match &efn.ret {
399 None => call,
400 Some(ret) => match ret {
401 Type::Ident(ident) if ident.rust == RustString => quote!(#call.into_string()),
402 Type::RustBox(_) => quote!(::std::boxed::Box::from_raw(#call)),
David Tolnaya1f02e52020-11-02 17:10:54 -0800403 Type::RustVec(vec) => {
404 if vec.inner == RustString {
David Tolnay0d524852020-11-02 17:21:50 -0800405 quote!(#call.into_vec_string())
David Tolnaya1f02e52020-11-02 17:10:54 -0800406 } else {
David Tolnay0d524852020-11-02 17:21:50 -0800407 quote!(#call.into_vec())
David Tolnaya1f02e52020-11-02 17:10:54 -0800408 }
David Tolnay33f56ad2020-08-27 17:06:35 -0700409 }
David Tolnaya4170652020-11-15 17:00:59 -0800410 Type::UniquePtr(ptr) => match ptr.pinned {
411 false => quote!(::cxx::UniquePtr::from_raw(#call)),
412 true => quote!(::cxx::UniquePtr::__pin_from_raw(#call)),
413 },
David Tolnaya1f02e52020-11-02 17:10:54 -0800414 Type::Ref(ty) => match &ty.inner {
415 Type::Ident(ident) if ident.rust == RustString => match ty.mutability {
David Tolnay0d524852020-11-02 17:21:50 -0800416 None => quote!(#call.as_string()),
417 Some(_) => quote!(#call.as_mut_string()),
David Tolnaya1f02e52020-11-02 17:10:54 -0800418 },
419 Type::RustVec(vec) if vec.inner == RustString => match ty.mutability {
David Tolnay0d524852020-11-02 17:21:50 -0800420 None => quote!(#call.as_vec_string()),
421 Some(_) => quote!(#call.as_mut_vec_string()),
David Tolnaya1f02e52020-11-02 17:10:54 -0800422 },
423 Type::RustVec(_) => match ty.mutability {
David Tolnay0d524852020-11-02 17:21:50 -0800424 None => quote!(#call.as_vec()),
425 Some(_) => quote!(#call.as_mut_vec()),
David Tolnaya1f02e52020-11-02 17:10:54 -0800426 },
David Tolnay4cb97672020-11-02 16:13:34 -0800427 inner if types.is_considered_improper_ctype(inner) => {
428 let mutability = ty.mutability;
429 quote!(&#mutability *#call.cast())
430 }
David Tolnay0d524852020-11-02 17:21:50 -0800431 _ => call,
David Tolnayf1c7f322020-08-27 00:46:01 -0700432 },
David Tolnay0d524852020-11-02 17:21:50 -0800433 Type::Str(_) => quote!(#call.as_str()),
434 Type::SliceRefU8(_) => quote!(#call.as_slice()),
435 _ => call,
436 },
437 };
David Tolnay2debdb22020-11-02 17:14:53 -0800438 if efn.throws {
439 expr = quote!(::std::result::Result::Ok(#expr));
440 }
David Tolnaya1f02e52020-11-02 17:10:54 -0800441 };
David Tolnaye67bcf52020-09-06 23:50:44 -0700442 let mut dispatch = quote!(#setup #expr);
443 let unsafety = &efn.sig.unsafety;
444 if unsafety.is_none() {
445 dispatch = quote!(unsafe { #dispatch });
446 }
David Tolnay17a934c2020-11-02 00:40:04 -0800447 let ident = &efn.name.rust;
David Tolnay9938b642020-11-15 18:11:40 -0800448 let generics = &efn.generics;
David Tolnayc66cdbb2020-04-20 01:41:15 -0700449 let function_shim = quote! {
450 #doc
David Tolnay9938b642020-11-15 18:11:40 -0800451 pub #unsafety fn #ident #generics(#(#all_args,)*) #ret {
David Tolnayc66cdbb2020-04-20 01:41:15 -0700452 extern "C" {
453 #decl
David Tolnay7db73692019-10-20 14:51:12 -0400454 }
David Tolnayc66cdbb2020-04-20 01:41:15 -0700455 #trampolines
David Tolnaye67bcf52020-09-06 23:50:44 -0700456 #dispatch
David Tolnayc66cdbb2020-04-20 01:41:15 -0700457 }
458 };
459 match &efn.receiver {
460 None => function_shim,
461 Some(receiver) => {
David Tolnay05e11cc2020-04-20 02:13:56 -0700462 let receiver_type = &receiver.ty;
David Tolnayc66cdbb2020-04-20 01:41:15 -0700463 quote!(impl #receiver_type { #function_shim })
464 }
David Tolnay7db73692019-10-20 14:51:12 -0400465 }
466}
467
David Tolnay75dca2e2020-03-25 20:17:52 -0700468fn expand_function_pointer_trampoline(
David Tolnay75dca2e2020-03-25 20:17:52 -0700469 efn: &ExternFn,
470 var: &Ident,
471 sig: &Signature,
472 types: &Types,
473) -> TokenStream {
Adrian Taylorc8713432020-10-21 18:20:55 -0700474 let c_trampoline = mangle::c_trampoline(efn, var, types);
475 let r_trampoline = mangle::r_trampoline(efn, var, types);
David Tolnay75dca2e2020-03-25 20:17:52 -0700476 let local_name = parse_quote!(__);
David Tolnay17a934c2020-11-02 00:40:04 -0800477 let catch_unwind_label = format!("::{}::{}", efn.name.rust, var);
David Tolnay75dca2e2020-03-25 20:17:52 -0700478 let shim = expand_rust_function_shim_impl(
479 sig,
480 types,
481 &r_trampoline,
482 local_name,
483 catch_unwind_label,
484 None,
485 );
486
487 quote! {
488 let #var = ::cxx::private::FatFunction {
489 trampoline: {
490 extern "C" {
491 #[link_name = #c_trampoline]
492 fn trampoline();
493 }
494 #shim
495 trampoline as usize as *const ()
496 },
497 ptr: #var as usize as *const (),
498 };
499 }
500}
501
David Tolnay7db73692019-10-20 14:51:12 -0400502fn expand_rust_type(ety: &ExternType) -> TokenStream {
David Tolnay17a934c2020-11-02 00:40:04 -0800503 let ident = &ety.name.rust;
David Tolnay7db73692019-10-20 14:51:12 -0400504 quote! {
505 use super::#ident;
506 }
507}
508
David Tolnayc8361022020-08-25 21:57:53 -0700509fn expand_rust_type_assert_sized(ety: &ExternType) -> TokenStream {
510 // Rustc will render as follows if not sized:
511 //
512 // type TheirType;
513 // -----^^^^^^^^^-
514 // | |
515 // | doesn't have a size known at compile-time
516 // required by this bound in `ffi::_::__AssertSized`
517
David Tolnay17a934c2020-11-02 00:40:04 -0800518 let ident = &ety.name.rust;
David Tolnayc8361022020-08-25 21:57:53 -0700519 let begin_span = Token![::](ety.type_token.span);
520 let sized = quote_spanned! {ety.semi_token.span=>
521 #begin_span std::marker::Sized
522 };
David Tolnay20fa62b2020-11-15 17:34:05 -0800523 let unpin = quote_spanned! {ety.semi_token.span=>
524 #begin_span std::marker::Unpin
525 };
David Tolnay17a934c2020-11-02 00:40:04 -0800526 quote_spanned! {ident.span()=>
David Tolnayc8361022020-08-25 21:57:53 -0700527 let _ = {
528 fn __AssertSized<T: ?#sized + #sized>() {}
David Tolnay20fa62b2020-11-15 17:34:05 -0800529 fn __AssertUnpin<T: #unpin>() {}
530 (__AssertSized::<#ident>, __AssertUnpin::<#ident>)
David Tolnayc8361022020-08-25 21:57:53 -0700531 };
532 }
533}
534
Adrian Taylorc8713432020-10-21 18:20:55 -0700535fn expand_rust_function_shim(efn: &ExternFn, types: &Types) -> TokenStream {
536 let link_name = mangle::extern_fn(efn, types);
David Tolnay17a934c2020-11-02 00:40:04 -0800537 let local_name = format_ident!("__{}", efn.name.rust);
538 let catch_unwind_label = format!("::{}", efn.name.rust);
539 let invoke = Some(&efn.name.rust);
David Tolnay75dca2e2020-03-25 20:17:52 -0700540 expand_rust_function_shim_impl(
541 efn,
542 types,
543 &link_name,
544 local_name,
545 catch_unwind_label,
546 invoke,
547 )
548}
549
550fn expand_rust_function_shim_impl(
551 sig: &Signature,
552 types: &Types,
David Tolnay891061b2020-04-19 22:42:33 -0700553 link_name: &Symbol,
David Tolnay75dca2e2020-03-25 20:17:52 -0700554 local_name: Ident,
555 catch_unwind_label: String,
556 invoke: Option<&Ident>,
557) -> TokenStream {
David Tolnay9938b642020-11-15 18:11:40 -0800558 let generics = &sig.generics;
David Tolnayf9ffb932020-04-20 02:22:57 -0700559 let receiver_var = sig
560 .receiver
561 .as_ref()
562 .map(|receiver| quote_spanned!(receiver.var.span=> __self));
David Tolnay18ba92c2020-04-22 16:17:30 -0700563 let receiver = sig.receiver.as_ref().map(|receiver| {
564 let receiver_type = receiver.ty();
565 quote!(#receiver_var: #receiver_type)
566 });
David Tolnay75dca2e2020-03-25 20:17:52 -0700567 let args = sig.args.iter().map(|arg| {
David Tolnay39d575f2020-03-03 00:10:56 -0800568 let ident = &arg.ident;
David Tolnay2f090422020-11-02 18:25:35 -0800569 let ty = expand_extern_type(&arg.ty, types, false);
David Tolnay39d575f2020-03-03 00:10:56 -0800570 if types.needs_indirect_abi(&arg.ty) {
571 quote!(#ident: *mut #ty)
572 } else {
573 quote!(#ident: #ty)
574 }
575 });
David Tolnayf9ffb932020-04-20 02:22:57 -0700576 let all_args = receiver.into_iter().chain(args);
David Tolnay75dca2e2020-03-25 20:17:52 -0700577
David Tolnay3a45f2d2020-04-20 01:51:12 -0700578 let arg_vars = sig.args.iter().map(|arg| {
David Tolnay7db73692019-10-20 14:51:12 -0400579 let ident = &arg.ident;
David Tolnay17955e22020-01-20 17:58:24 -0800580 match &arg.ty {
Adrian Taylorc8713432020-10-21 18:20:55 -0700581 Type::Ident(i) if i.rust == RustString => {
David Tolnaycc3767f2020-03-06 10:41:51 -0800582 quote!(::std::mem::take((*#ident).as_mut_string()))
583 }
David Tolnay40226ab2020-03-03 00:05:35 -0800584 Type::RustBox(_) => quote!(::std::boxed::Box::from_raw(#ident)),
David Tolnay33f56ad2020-08-27 17:06:35 -0700585 Type::RustVec(vec) => {
586 if vec.inner == RustString {
587 quote!(::std::mem::take((*#ident).as_mut_vec_string()))
588 } else {
589 quote!(::std::mem::take((*#ident).as_mut_vec()))
590 }
591 }
David Tolnaya4170652020-11-15 17:00:59 -0800592 Type::UniquePtr(ptr) => match ptr.pinned {
593 false => quote!(::cxx::UniquePtr::from_raw(#ident)),
594 true => quote!(::cxx::UniquePtr::__pin_from_raw(#ident)),
595 },
David Tolnay17955e22020-01-20 17:58:24 -0800596 Type::Ref(ty) => match &ty.inner {
Adrian Taylorc8713432020-10-21 18:20:55 -0700597 Type::Ident(i) if i.rust == RustString => match ty.mutability {
David Tolnayf1c7f322020-08-27 00:46:01 -0700598 None => quote!(#ident.as_string()),
599 Some(_) => quote!(#ident.as_mut_string()),
600 },
David Tolnay33f56ad2020-08-27 17:06:35 -0700601 Type::RustVec(vec) if vec.inner == RustString => match ty.mutability {
602 None => quote!(#ident.as_vec_string()),
603 Some(_) => quote!(#ident.as_mut_vec_string()),
604 },
David Tolnayf1c7f322020-08-27 00:46:01 -0700605 Type::RustVec(_) => match ty.mutability {
606 None => quote!(#ident.as_vec()),
607 Some(_) => quote!(#ident.as_mut_vec()),
608 },
David Tolnay40226ab2020-03-03 00:05:35 -0800609 _ => quote!(#ident),
David Tolnay17955e22020-01-20 17:58:24 -0800610 },
David Tolnay40226ab2020-03-03 00:05:35 -0800611 Type::Str(_) => quote!(#ident.as_str()),
Adrian Taylorf5dd5522020-04-13 16:50:14 -0700612 Type::SliceRefU8(_) => quote!(#ident.as_slice()),
David Tolnay40226ab2020-03-03 00:05:35 -0800613 ty if types.needs_indirect_abi(ty) => quote!(::std::ptr::read(#ident)),
614 _ => quote!(#ident),
David Tolnay7db73692019-10-20 14:51:12 -0400615 }
616 });
David Tolnayf9ffb932020-04-20 02:22:57 -0700617 let vars = receiver_var.into_iter().chain(arg_vars);
David Tolnay75dca2e2020-03-25 20:17:52 -0700618
David Tolnay26219462020-11-09 19:47:28 -0800619 let wrap_super = invoke.map(|invoke| expand_rust_function_shim_super(sig, &local_name, invoke));
620
David Tolnay75dca2e2020-03-25 20:17:52 -0700621 let mut call = match invoke {
David Tolnay26219462020-11-09 19:47:28 -0800622 Some(_) => quote!(#local_name),
David Tolnayb8ebeb02020-10-31 23:52:06 -0700623 None => quote!(::std::mem::transmute::<*const (), #sig>(__extern)),
David Tolnay75dca2e2020-03-25 20:17:52 -0700624 };
625 call.extend(quote! { (#(#vars),*) });
626
David Tolnay22602b42020-09-21 18:04:05 -0400627 let conversion = sig.ret.as_ref().and_then(|ret| match ret {
Adrian Taylorc8713432020-10-21 18:20:55 -0700628 Type::Ident(ident) if ident.rust == RustString => {
629 Some(quote!(::cxx::private::RustString::from))
630 }
David Tolnay22602b42020-09-21 18:04:05 -0400631 Type::RustBox(_) => Some(quote!(::std::boxed::Box::into_raw)),
632 Type::RustVec(vec) => {
633 if vec.inner == RustString {
634 Some(quote!(::cxx::private::RustVec::from_vec_string))
635 } else {
636 Some(quote!(::cxx::private::RustVec::from))
David Tolnay7db73692019-10-20 14:51:12 -0400637 }
David Tolnay22602b42020-09-21 18:04:05 -0400638 }
David Tolnaya4170652020-11-15 17:00:59 -0800639 Type::UniquePtr(ptr) => match ptr.pinned {
640 false => Some(quote!(::cxx::UniquePtr::into_raw)),
641 true => Some(quote!(::cxx::UniquePtr::__pin_into_raw)),
642 },
David Tolnay22602b42020-09-21 18:04:05 -0400643 Type::Ref(ty) => match &ty.inner {
Adrian Taylorc8713432020-10-21 18:20:55 -0700644 Type::Ident(ident) if ident.rust == RustString => match ty.mutability {
David Tolnay22602b42020-09-21 18:04:05 -0400645 None => Some(quote!(::cxx::private::RustString::from_ref)),
646 Some(_) => Some(quote!(::cxx::private::RustString::from_mut)),
David Tolnay7db73692019-10-20 14:51:12 -0400647 },
David Tolnay22602b42020-09-21 18:04:05 -0400648 Type::RustVec(vec) if vec.inner == RustString => match ty.mutability {
649 None => Some(quote!(::cxx::private::RustVec::from_ref_vec_string)),
650 Some(_) => Some(quote!(::cxx::private::RustVec::from_mut_vec_string)),
651 },
652 Type::RustVec(_) => match ty.mutability {
653 None => Some(quote!(::cxx::private::RustVec::from_ref)),
654 Some(_) => Some(quote!(::cxx::private::RustVec::from_mut)),
655 },
David Tolnay7db73692019-10-20 14:51:12 -0400656 _ => None,
David Tolnay22602b42020-09-21 18:04:05 -0400657 },
658 Type::Str(_) => Some(quote!(::cxx::private::RustStr::from)),
659 Type::SliceRefU8(_) => Some(quote!(::cxx::private::RustSliceU8::from)),
660 _ => None,
661 });
662
663 let mut expr = match conversion {
664 None => call,
665 Some(conversion) if !sig.throws => quote!(#conversion(#call)),
666 Some(conversion) => quote!(::std::result::Result::map(#call, #conversion)),
667 };
David Tolnay75dca2e2020-03-25 20:17:52 -0700668
669 let mut outparam = None;
670 let indirect_return = indirect_return(sig, types);
David Tolnay1e548172020-03-16 13:37:09 -0700671 if indirect_return {
David Tolnay2f090422020-11-02 18:25:35 -0800672 let ret = expand_extern_type(sig.ret.as_ref().unwrap(), types, false);
David Tolnay75dca2e2020-03-25 20:17:52 -0700673 outparam = Some(quote!(__return: *mut #ret,));
David Tolnay1e548172020-03-16 13:37:09 -0700674 }
David Tolnay75dca2e2020-03-25 20:17:52 -0700675 if sig.throws {
676 let out = match sig.ret {
David Tolnaycecada62020-03-17 01:45:58 -0700677 Some(_) => quote!(__return),
678 None => quote!(&mut ()),
679 };
680 expr = quote!(::cxx::private::r#try(#out, #expr));
David Tolnay1e548172020-03-16 13:37:09 -0700681 } else if indirect_return {
David Tolnay7db73692019-10-20 14:51:12 -0400682 expr = quote!(::std::ptr::write(__return, #expr));
683 }
David Tolnay75dca2e2020-03-25 20:17:52 -0700684
David Tolnay1e548172020-03-16 13:37:09 -0700685 expr = quote!(::cxx::private::catch_unwind(__fn, move || #expr));
David Tolnay75dca2e2020-03-25 20:17:52 -0700686
687 let ret = if sig.throws {
David Tolnay486b6ec2020-03-17 01:19:57 -0700688 quote!(-> ::cxx::private::Result)
David Tolnay1e548172020-03-16 13:37:09 -0700689 } else {
David Tolnay2f090422020-11-02 18:25:35 -0800690 expand_extern_return_type(&sig.ret, types, false)
David Tolnay1e548172020-03-16 13:37:09 -0700691 };
David Tolnay75dca2e2020-03-25 20:17:52 -0700692
693 let pointer = match invoke {
David Tolnayb8ebeb02020-10-31 23:52:06 -0700694 None => Some(quote!(__extern: *const ())),
David Tolnay75dca2e2020-03-25 20:17:52 -0700695 Some(_) => None,
696 };
697
David Tolnay7db73692019-10-20 14:51:12 -0400698 quote! {
699 #[doc(hidden)]
700 #[export_name = #link_name]
David Tolnay9938b642020-11-15 18:11:40 -0800701 unsafe extern "C" fn #local_name #generics(#(#all_args,)* #outparam #pointer) #ret {
David Tolnay7db73692019-10-20 14:51:12 -0400702 let __fn = concat!(module_path!(), #catch_unwind_label);
David Tolnay26219462020-11-09 19:47:28 -0800703 #wrap_super
David Tolnay7db73692019-10-20 14:51:12 -0400704 #expr
705 }
706 }
707}
708
David Tolnay26219462020-11-09 19:47:28 -0800709// A wrapper like `fn f(x: Arg) { super::f(x) }` just to ensure we have the
710// accurate unsafety declaration and no problematic elided lifetimes.
711fn expand_rust_function_shim_super(
712 sig: &Signature,
713 local_name: &Ident,
714 invoke: &Ident,
715) -> TokenStream {
716 let unsafety = sig.unsafety;
David Tolnay9938b642020-11-15 18:11:40 -0800717 let generics = &sig.generics;
David Tolnay26219462020-11-09 19:47:28 -0800718
719 let receiver_var = sig
720 .receiver
721 .as_ref()
722 .map(|receiver| Ident::new("__self", receiver.var.span));
723 let receiver = sig.receiver.iter().map(|receiver| {
724 let receiver_type = receiver.ty();
725 quote!(#receiver_var: #receiver_type)
726 });
727 let args = sig.args.iter().map(|arg| quote!(#arg));
728 let all_args = receiver.chain(args);
729
David Tolnay5d164672020-11-09 20:23:17 -0800730 let ret = if let Some((result, _langle, rangle)) = sig.throws_tokens {
David Tolnay26219462020-11-09 19:47:28 -0800731 let ok = match &sig.ret {
732 Some(ret) => quote!(#ret),
733 None => quote!(()),
734 };
David Tolnay5d164672020-11-09 20:23:17 -0800735 let impl_trait = quote_spanned!(result.span=> impl);
736 let display = quote_spanned!(rangle.span=> ::std::fmt::Display);
737 quote!(-> ::std::result::Result<#ok, #impl_trait #display>)
David Tolnay26219462020-11-09 19:47:28 -0800738 } else {
739 expand_return_type(&sig.ret)
740 };
741
742 let arg_vars = sig.args.iter().map(|arg| &arg.ident);
743 let vars = receiver_var.iter().chain(arg_vars);
744
745 let span = invoke.span();
746 let call = match &sig.receiver {
747 None => quote_spanned!(span=> super::#invoke),
748 Some(receiver) => {
749 let receiver_type = &receiver.ty;
750 quote_spanned!(span=> #receiver_type::#invoke)
751 }
752 };
753
754 quote_spanned! {span=>
David Tolnay9938b642020-11-15 18:11:40 -0800755 #unsafety fn #local_name #generics(#(#all_args,)*) #ret {
David Tolnay26219462020-11-09 19:47:28 -0800756 #call(#(#vars,)*)
757 }
758 }
759}
760
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700761fn expand_type_alias(alias: &TypeAlias) -> TokenStream {
Bryan Henry890083d2020-09-13 10:34:31 -0700762 let doc = &alias.doc;
David Tolnay17a934c2020-11-02 00:40:04 -0800763 let ident = &alias.name.rust;
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700764 let ty = &alias.ty;
765 quote! {
Bryan Henry890083d2020-09-13 10:34:31 -0700766 #doc
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700767 pub type #ident = #ty;
768 }
769}
770
Adrian Taylorc8713432020-10-21 18:20:55 -0700771fn expand_type_alias_verify(alias: &TypeAlias, types: &Types) -> TokenStream {
David Tolnay17a934c2020-11-02 00:40:04 -0800772 let ident = &alias.name.rust;
773 let type_id = type_id(&alias.name);
David Tolnay83fe0f02020-05-07 20:00:15 -0700774 let begin_span = alias.type_token.span;
775 let end_span = alias.semi_token.span;
776 let begin = quote_spanned!(begin_span=> ::cxx::private::verify_extern_type::<);
777 let end = quote_spanned!(end_span=> >);
778
David Tolnay63a0e4e2020-10-03 18:52:32 -0700779 let mut verify = quote! {
David Tolnay83fe0f02020-05-07 20:00:15 -0700780 const _: fn() = #begin #ident, #type_id #end;
David Tolnay63a0e4e2020-10-03 18:52:32 -0700781 };
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700782
David Tolnay17a934c2020-11-02 00:40:04 -0800783 if types.required_trivial.contains_key(&alias.name.rust) {
David Tolnay63a0e4e2020-10-03 18:52:32 -0700784 let begin = quote_spanned!(begin_span=> ::cxx::private::verify_extern_kind::<);
785 verify.extend(quote! {
786 const _: fn() = #begin #ident, ::cxx::kind::Trivial #end;
787 });
Adrian Taylorc7043292020-09-25 12:48:36 -0700788 }
David Tolnay63a0e4e2020-10-03 18:52:32 -0700789
790 verify
Adrian Taylorc7043292020-09-25 12:48:36 -0700791}
792
David Tolnay8faec772020-11-02 00:18:19 -0800793fn type_id(name: &Pair) -> TokenStream {
794 let path = name.to_fully_qualified();
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700795 quote! {
796 ::cxx::type_id!(#path)
797 }
798}
799
Adrian Taylorc8713432020-10-21 18:20:55 -0700800fn expand_rust_box(ident: &ResolvableName, types: &Types) -> TokenStream {
801 let link_prefix = format!("cxxbridge05$box${}$", types.resolve(ident).to_symbol());
David Tolnay7db73692019-10-20 14:51:12 -0400802 let link_uninit = format!("{}uninit", link_prefix);
David Tolnay7db73692019-10-20 14:51:12 -0400803 let link_drop = format!("{}drop", link_prefix);
David Tolnay7db73692019-10-20 14:51:12 -0400804
Adrian Taylorc8713432020-10-21 18:20:55 -0700805 let local_prefix = format_ident!("{}__box_", &ident.rust);
David Tolnay7db73692019-10-20 14:51:12 -0400806 let local_uninit = format_ident!("{}uninit", local_prefix);
David Tolnay7db73692019-10-20 14:51:12 -0400807 let local_drop = format_ident!("{}drop", local_prefix);
David Tolnay7db73692019-10-20 14:51:12 -0400808
809 let span = ident.span();
810 quote_spanned! {span=>
811 #[doc(hidden)]
812 #[export_name = #link_uninit]
813 unsafe extern "C" fn #local_uninit(
814 this: *mut ::std::boxed::Box<::std::mem::MaybeUninit<#ident>>,
815 ) {
816 ::std::ptr::write(
817 this,
818 ::std::boxed::Box::new(::std::mem::MaybeUninit::uninit()),
819 );
820 }
821 #[doc(hidden)]
David Tolnay7db73692019-10-20 14:51:12 -0400822 #[export_name = #link_drop]
823 unsafe extern "C" fn #local_drop(this: *mut ::std::boxed::Box<#ident>) {
824 ::std::ptr::drop_in_place(this);
825 }
David Tolnay7db73692019-10-20 14:51:12 -0400826 }
827}
828
Adrian Taylorc8713432020-10-21 18:20:55 -0700829fn expand_rust_vec(elem: &ResolvableName, types: &Types) -> TokenStream {
830 let link_prefix = format!("cxxbridge05$rust_vec${}$", elem.to_symbol(types));
David Tolnayf97c2d52020-04-25 16:37:48 -0700831 let link_new = format!("{}new", link_prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700832 let link_drop = format!("{}drop", link_prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700833 let link_len = format!("{}len", link_prefix);
David Tolnay219c0792020-04-24 20:31:37 -0700834 let link_data = format!("{}data", link_prefix);
David Tolnayfb6b73c2020-11-10 14:32:16 -0800835 let link_reserve_total = format!("{}reserve_total", link_prefix);
836 let link_set_len = format!("{}set_len", link_prefix);
David Tolnay503d0192020-04-24 22:18:56 -0700837 let link_stride = format!("{}stride", link_prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700838
Adrian Taylorc8713432020-10-21 18:20:55 -0700839 let local_prefix = format_ident!("{}__vec_", elem.rust);
David Tolnayf97c2d52020-04-25 16:37:48 -0700840 let local_new = format_ident!("{}new", local_prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700841 let local_drop = format_ident!("{}drop", local_prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700842 let local_len = format_ident!("{}len", local_prefix);
David Tolnay219c0792020-04-24 20:31:37 -0700843 let local_data = format_ident!("{}data", local_prefix);
David Tolnayfb6b73c2020-11-10 14:32:16 -0800844 let local_reserve_total = format_ident!("{}reserve_total", local_prefix);
845 let local_set_len = format_ident!("{}set_len", local_prefix);
David Tolnay503d0192020-04-24 22:18:56 -0700846 let local_stride = format_ident!("{}stride", local_prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700847
David Tolnay83a7ec92020-04-25 12:37:42 -0700848 let span = elem.span();
Myron Ahneba35cf2020-02-05 19:41:51 +0700849 quote_spanned! {span=>
850 #[doc(hidden)]
David Tolnayf97c2d52020-04-25 16:37:48 -0700851 #[export_name = #link_new]
852 unsafe extern "C" fn #local_new(this: *mut ::cxx::private::RustVec<#elem>) {
853 ::std::ptr::write(this, ::cxx::private::RustVec::new());
854 }
855 #[doc(hidden)]
Myron Ahneba35cf2020-02-05 19:41:51 +0700856 #[export_name = #link_drop]
David Tolnay83a7ec92020-04-25 12:37:42 -0700857 unsafe extern "C" fn #local_drop(this: *mut ::cxx::private::RustVec<#elem>) {
David Tolnay4c64afb2020-04-24 11:30:18 -0700858 ::std::ptr::drop_in_place(this);
Myron Ahneba35cf2020-02-05 19:41:51 +0700859 }
David Tolnay85db5a02020-04-25 13:17:27 -0700860 #[doc(hidden)]
Myron Ahneba35cf2020-02-05 19:41:51 +0700861 #[export_name = #link_len]
David Tolnay83a7ec92020-04-25 12:37:42 -0700862 unsafe extern "C" fn #local_len(this: *const ::cxx::private::RustVec<#elem>) -> usize {
David Tolnay2cef5df2020-04-24 11:33:58 -0700863 (*this).len()
Myron Ahneba35cf2020-02-05 19:41:51 +0700864 }
David Tolnay219c0792020-04-24 20:31:37 -0700865 #[doc(hidden)]
866 #[export_name = #link_data]
David Tolnay83a7ec92020-04-25 12:37:42 -0700867 unsafe extern "C" fn #local_data(this: *const ::cxx::private::RustVec<#elem>) -> *const #elem {
David Tolnay219c0792020-04-24 20:31:37 -0700868 (*this).as_ptr()
869 }
David Tolnay503d0192020-04-24 22:18:56 -0700870 #[doc(hidden)]
David Tolnayfb6b73c2020-11-10 14:32:16 -0800871 #[export_name = #link_reserve_total]
872 unsafe extern "C" fn #local_reserve_total(this: *mut ::cxx::private::RustVec<#elem>, cap: usize) {
873 (*this).reserve_total(cap);
874 }
875 #[doc(hidden)]
876 #[export_name = #link_set_len]
877 unsafe extern "C" fn #local_set_len(this: *mut ::cxx::private::RustVec<#elem>, len: usize) {
878 (*this).set_len(len);
879 }
880 #[doc(hidden)]
David Tolnay503d0192020-04-24 22:18:56 -0700881 #[export_name = #link_stride]
882 unsafe extern "C" fn #local_stride() -> usize {
David Tolnay83a7ec92020-04-25 12:37:42 -0700883 ::std::mem::size_of::<#elem>()
David Tolnay503d0192020-04-24 22:18:56 -0700884 }
Myron Ahneba35cf2020-02-05 19:41:51 +0700885 }
886}
887
David Tolnay0531f432020-10-03 23:50:28 -0700888fn expand_unique_ptr(
Adrian Taylorc8713432020-10-21 18:20:55 -0700889 ident: &ResolvableName,
David Tolnay0531f432020-10-03 23:50:28 -0700890 types: &Types,
891 explicit_impl: Option<&Impl>,
892) -> TokenStream {
Adrian Taylorc8713432020-10-21 18:20:55 -0700893 let name = ident.rust.to_string();
894 let prefix = format!("cxxbridge05$unique_ptr${}$", ident.to_symbol(types));
David Tolnay7db73692019-10-20 14:51:12 -0400895 let link_null = format!("{}null", prefix);
896 let link_new = format!("{}new", prefix);
897 let link_raw = format!("{}raw", prefix);
898 let link_get = format!("{}get", prefix);
899 let link_release = format!("{}release", prefix);
900 let link_drop = format!("{}drop", prefix);
901
Adrian Taylorc8713432020-10-21 18:20:55 -0700902 let new_method =
903 if types.structs.contains_key(&ident.rust) || types.aliases.contains_key(&ident.rust) {
904 Some(quote! {
905 fn __new(mut value: Self) -> *mut ::std::ffi::c_void {
906 extern "C" {
907 #[link_name = #link_new]
908 fn __new(this: *mut *mut ::std::ffi::c_void, value: *mut #ident);
909 }
910 let mut repr = ::std::ptr::null_mut::<::std::ffi::c_void>();
911 unsafe { __new(&mut repr, &mut value) }
912 repr
David Tolnay53838912020-04-09 20:56:44 -0700913 }
Adrian Taylorc8713432020-10-21 18:20:55 -0700914 })
915 } else {
916 None
917 };
David Tolnay53838912020-04-09 20:56:44 -0700918
David Tolnay0531f432020-10-03 23:50:28 -0700919 let begin_span =
920 explicit_impl.map_or_else(Span::call_site, |explicit| explicit.impl_token.span);
921 let end_span = explicit_impl.map_or_else(Span::call_site, |explicit| explicit.brace_token.span);
922 let unsafe_token = format_ident!("unsafe", span = begin_span);
923
924 quote_spanned! {end_span=>
925 #unsafe_token impl ::cxx::private::UniquePtrTarget for #ident {
David Tolnay3b40b6f2020-04-24 17:58:24 -0700926 const __NAME: &'static dyn ::std::fmt::Display = &#name;
David Tolnay7db73692019-10-20 14:51:12 -0400927 fn __null() -> *mut ::std::ffi::c_void {
928 extern "C" {
929 #[link_name = #link_null]
930 fn __null(this: *mut *mut ::std::ffi::c_void);
931 }
932 let mut repr = ::std::ptr::null_mut::<::std::ffi::c_void>();
933 unsafe { __null(&mut repr) }
934 repr
935 }
David Tolnay53838912020-04-09 20:56:44 -0700936 #new_method
David Tolnay7db73692019-10-20 14:51:12 -0400937 unsafe fn __raw(raw: *mut Self) -> *mut ::std::ffi::c_void {
938 extern "C" {
939 #[link_name = #link_raw]
David Tolnay3b40b6f2020-04-24 17:58:24 -0700940 fn __raw(this: *mut *mut ::std::ffi::c_void, raw: *mut #ident);
David Tolnay7db73692019-10-20 14:51:12 -0400941 }
942 let mut repr = ::std::ptr::null_mut::<::std::ffi::c_void>();
943 __raw(&mut repr, raw);
944 repr
945 }
946 unsafe fn __get(repr: *mut ::std::ffi::c_void) -> *const Self {
947 extern "C" {
948 #[link_name = #link_get]
David Tolnay3b40b6f2020-04-24 17:58:24 -0700949 fn __get(this: *const *mut ::std::ffi::c_void) -> *const #ident;
David Tolnay7db73692019-10-20 14:51:12 -0400950 }
951 __get(&repr)
952 }
953 unsafe fn __release(mut repr: *mut ::std::ffi::c_void) -> *mut Self {
954 extern "C" {
955 #[link_name = #link_release]
David Tolnay3b40b6f2020-04-24 17:58:24 -0700956 fn __release(this: *mut *mut ::std::ffi::c_void) -> *mut #ident;
David Tolnay7db73692019-10-20 14:51:12 -0400957 }
958 __release(&mut repr)
959 }
960 unsafe fn __drop(mut repr: *mut ::std::ffi::c_void) {
961 extern "C" {
962 #[link_name = #link_drop]
963 fn __drop(this: *mut *mut ::std::ffi::c_void);
964 }
965 __drop(&mut repr);
966 }
967 }
968 }
969}
970
David Tolnay0531f432020-10-03 23:50:28 -0700971fn expand_cxx_vector(
Adrian Taylorc8713432020-10-21 18:20:55 -0700972 elem: &ResolvableName,
David Tolnay0531f432020-10-03 23:50:28 -0700973 explicit_impl: Option<&Impl>,
Adrian Taylorc8713432020-10-21 18:20:55 -0700974 types: &Types,
David Tolnay0531f432020-10-03 23:50:28 -0700975) -> TokenStream {
976 let _ = explicit_impl;
Adrian Taylorc8713432020-10-21 18:20:55 -0700977 let name = elem.rust.to_string();
978 let prefix = format!("cxxbridge05$std$vector${}$", elem.to_symbol(types));
David Tolnaya83247c2020-04-24 14:36:10 -0700979 let link_size = format!("{}size", prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700980 let link_get_unchecked = format!("{}get_unchecked", prefix);
Adrian Taylorc8713432020-10-21 18:20:55 -0700981 let unique_ptr_prefix = format!(
982 "cxxbridge05$unique_ptr$std$vector${}$",
983 elem.to_symbol(types)
984 );
David Tolnay3b40b6f2020-04-24 17:58:24 -0700985 let link_unique_ptr_null = format!("{}null", unique_ptr_prefix);
986 let link_unique_ptr_raw = format!("{}raw", unique_ptr_prefix);
987 let link_unique_ptr_get = format!("{}get", unique_ptr_prefix);
988 let link_unique_ptr_release = format!("{}release", unique_ptr_prefix);
989 let link_unique_ptr_drop = format!("{}drop", unique_ptr_prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700990
David Tolnay0531f432020-10-03 23:50:28 -0700991 let begin_span =
992 explicit_impl.map_or_else(Span::call_site, |explicit| explicit.impl_token.span);
993 let end_span = explicit_impl.map_or_else(Span::call_site, |explicit| explicit.brace_token.span);
994 let unsafe_token = format_ident!("unsafe", span = begin_span);
995
996 quote_spanned! {end_span=>
997 #unsafe_token impl ::cxx::private::VectorElement for #elem {
David Tolnay3b40b6f2020-04-24 17:58:24 -0700998 const __NAME: &'static dyn ::std::fmt::Display = &#name;
David Tolnay17631102020-04-24 19:01:30 -0700999 fn __vector_size(v: &::cxx::CxxVector<Self>) -> usize {
David Tolnayfa2119c2020-04-24 14:42:58 -07001000 extern "C" {
1001 #[link_name = #link_size]
David Tolnay17631102020-04-24 19:01:30 -07001002 fn __vector_size(_: &::cxx::CxxVector<#elem>) -> usize;
Myron Ahneba35cf2020-02-05 19:41:51 +07001003 }
David Tolnayfa2119c2020-04-24 14:42:58 -07001004 unsafe { __vector_size(v) }
Myron Ahneba35cf2020-02-05 19:41:51 +07001005 }
David Tolnay93637ca2020-09-24 15:58:20 -04001006 unsafe fn __get_unchecked(v: &::cxx::CxxVector<Self>, pos: usize) -> *const Self {
David Tolnaycc75ad22020-04-24 14:45:16 -07001007 extern "C" {
1008 #[link_name = #link_get_unchecked]
David Tolnay17631102020-04-24 19:01:30 -07001009 fn __get_unchecked(_: &::cxx::CxxVector<#elem>, _: usize) -> *const #elem;
David Tolnaycc75ad22020-04-24 14:45:16 -07001010 }
David Tolnay93637ca2020-09-24 15:58:20 -04001011 __get_unchecked(v, pos)
David Tolnaycc75ad22020-04-24 14:45:16 -07001012 }
David Tolnay3b40b6f2020-04-24 17:58:24 -07001013 fn __unique_ptr_null() -> *mut ::std::ffi::c_void {
1014 extern "C" {
1015 #[link_name = #link_unique_ptr_null]
1016 fn __unique_ptr_null(this: *mut *mut ::std::ffi::c_void);
1017 }
1018 let mut repr = ::std::ptr::null_mut::<::std::ffi::c_void>();
1019 unsafe { __unique_ptr_null(&mut repr) }
1020 repr
1021 }
1022 unsafe fn __unique_ptr_raw(raw: *mut ::cxx::CxxVector<Self>) -> *mut ::std::ffi::c_void {
1023 extern "C" {
1024 #[link_name = #link_unique_ptr_raw]
1025 fn __unique_ptr_raw(this: *mut *mut ::std::ffi::c_void, raw: *mut ::cxx::CxxVector<#elem>);
1026 }
1027 let mut repr = ::std::ptr::null_mut::<::std::ffi::c_void>();
1028 __unique_ptr_raw(&mut repr, raw);
1029 repr
1030 }
1031 unsafe fn __unique_ptr_get(repr: *mut ::std::ffi::c_void) -> *const ::cxx::CxxVector<Self> {
1032 extern "C" {
1033 #[link_name = #link_unique_ptr_get]
1034 fn __unique_ptr_get(this: *const *mut ::std::ffi::c_void) -> *const ::cxx::CxxVector<#elem>;
1035 }
1036 __unique_ptr_get(&repr)
1037 }
1038 unsafe fn __unique_ptr_release(mut repr: *mut ::std::ffi::c_void) -> *mut ::cxx::CxxVector<Self> {
1039 extern "C" {
1040 #[link_name = #link_unique_ptr_release]
1041 fn __unique_ptr_release(this: *mut *mut ::std::ffi::c_void) -> *mut ::cxx::CxxVector<#elem>;
1042 }
1043 __unique_ptr_release(&mut repr)
1044 }
1045 unsafe fn __unique_ptr_drop(mut repr: *mut ::std::ffi::c_void) {
1046 extern "C" {
1047 #[link_name = #link_unique_ptr_drop]
1048 fn __unique_ptr_drop(this: *mut *mut ::std::ffi::c_void);
1049 }
1050 __unique_ptr_drop(&mut repr);
1051 }
Myron Ahneba35cf2020-02-05 19:41:51 +07001052 }
1053 }
1054}
1055
David Tolnay7db73692019-10-20 14:51:12 -04001056fn expand_return_type(ret: &Option<Type>) -> TokenStream {
1057 match ret {
1058 Some(ret) => quote!(-> #ret),
1059 None => TokenStream::new(),
1060 }
1061}
1062
David Tolnay75dca2e2020-03-25 20:17:52 -07001063fn indirect_return(sig: &Signature, types: &Types) -> bool {
1064 sig.ret
David Tolnay1e548172020-03-16 13:37:09 -07001065 .as_ref()
David Tolnay75dca2e2020-03-25 20:17:52 -07001066 .map_or(false, |ret| sig.throws || types.needs_indirect_abi(ret))
David Tolnay7db73692019-10-20 14:51:12 -04001067}
1068
David Tolnay2f090422020-11-02 18:25:35 -08001069fn expand_extern_type(ty: &Type, types: &Types, proper: bool) -> TokenStream {
David Tolnay7db73692019-10-20 14:51:12 -04001070 match ty {
Adrian Taylorc8713432020-10-21 18:20:55 -07001071 Type::Ident(ident) if ident.rust == RustString => quote!(::cxx::private::RustString),
David Tolnay7db73692019-10-20 14:51:12 -04001072 Type::RustBox(ty) | Type::UniquePtr(ty) => {
David Tolnay2f090422020-11-02 18:25:35 -08001073 let inner = expand_extern_type(&ty.inner, types, proper);
David Tolnay7db73692019-10-20 14:51:12 -04001074 quote!(*mut #inner)
1075 }
David Tolnaye6d50212020-04-25 15:38:23 -07001076 Type::RustVec(ty) => {
David Tolnay2f090422020-11-02 18:25:35 -08001077 let elem = expand_extern_type(&ty.inner, types, proper);
David Tolnaye6d50212020-04-25 15:38:23 -07001078 quote!(::cxx::private::RustVec<#elem>)
1079 }
David Tolnayf1c7f322020-08-27 00:46:01 -07001080 Type::Ref(ty) => {
1081 let mutability = ty.mutability;
1082 match &ty.inner {
Adrian Taylorc8713432020-10-21 18:20:55 -07001083 Type::Ident(ident) if ident.rust == RustString => {
David Tolnayf1c7f322020-08-27 00:46:01 -07001084 quote!(&#mutability ::cxx::private::RustString)
1085 }
1086 Type::RustVec(ty) => {
David Tolnay2f090422020-11-02 18:25:35 -08001087 let inner = expand_extern_type(&ty.inner, types, proper);
David Tolnayf1c7f322020-08-27 00:46:01 -07001088 quote!(&#mutability ::cxx::private::RustVec<#inner>)
1089 }
David Tolnay2f090422020-11-02 18:25:35 -08001090 inner if proper && types.is_considered_improper_ctype(inner) => match mutability {
David Tolnay4cb97672020-11-02 16:13:34 -08001091 None => quote!(*const ::std::ffi::c_void),
1092 Some(_) => quote!(*#mutability ::std::ffi::c_void),
1093 },
David Tolnayf1c7f322020-08-27 00:46:01 -07001094 _ => quote!(#ty),
Myron Ahneba35cf2020-02-05 19:41:51 +07001095 }
David Tolnayf1c7f322020-08-27 00:46:01 -07001096 }
David Tolnay7db73692019-10-20 14:51:12 -04001097 Type::Str(_) => quote!(::cxx::private::RustStr),
Adrian Taylorf5dd5522020-04-13 16:50:14 -07001098 Type::SliceRefU8(_) => quote!(::cxx::private::RustSliceU8),
David Tolnay7db73692019-10-20 14:51:12 -04001099 _ => quote!(#ty),
1100 }
1101}
1102
David Tolnay2f090422020-11-02 18:25:35 -08001103fn expand_extern_return_type(ret: &Option<Type>, types: &Types, proper: bool) -> TokenStream {
David Tolnay7db73692019-10-20 14:51:12 -04001104 let ret = match ret {
1105 Some(ret) if !types.needs_indirect_abi(ret) => ret,
1106 _ => return TokenStream::new(),
1107 };
David Tolnay2f090422020-11-02 18:25:35 -08001108 let ty = expand_extern_type(ret, types, proper);
David Tolnay7db73692019-10-20 14:51:12 -04001109 quote!(-> #ty)
1110}