blob: 94c5696388b99116d260513631a48ac03724a677 [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));
Joel Galenson905eb2e2020-05-04 14:58:14 -070050 }
51 }
David Tolnay7db73692019-10-20 14:51:12 -040052 Api::CxxFunction(efn) => {
Adrian Taylorc8713432020-10-21 18:20:55 -070053 expanded.extend(expand_cxx_function_shim(efn, types));
David Tolnay7db73692019-10-20 14:51:12 -040054 }
Adrian Taylorc8713432020-10-21 18:20:55 -070055 Api::RustFunction(efn) => hidden.extend(expand_rust_function_shim(efn, types)),
David Tolnay5f9e8ca2020-05-07 17:21:05 -070056 Api::TypeAlias(alias) => {
57 expanded.extend(expand_type_alias(alias));
Adrian Taylorc8713432020-10-21 18:20:55 -070058 hidden.extend(expand_type_alias_verify(alias, types));
David Tolnay5f9e8ca2020-05-07 17:21:05 -070059 }
David Tolnay7db73692019-10-20 14:51:12 -040060 }
61 }
62
David Tolnayc94035a2020-11-15 16:49:18 -080063 let mut expanded_unique_ptr = Set::new();
David Tolnay7db73692019-10-20 14:51:12 -040064 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 Tolnayc94035a2020-11-15 16:49:18 -080082 && expanded_unique_ptr.insert(&ident.rust)
David Tolnay7e69f892020-10-03 22:20:22 -070083 {
Adrian Taylorc8713432020-10-21 18:20:55 -070084 expanded.extend(expand_unique_ptr(ident, types, explicit_impl));
Myron Ahneba35cf2020-02-05 19:41:51 +070085 }
86 }
David Tolnay4377a9e2020-04-24 15:20:26 -070087 } else if let Type::CxxVector(ptr) = ty {
Myron Ahneba35cf2020-02-05 19:41:51 +070088 if let Type::Ident(ident) = &ptr.inner {
Adrian Taylorc8713432020-10-21 18:20:55 -070089 if Atom::from(&ident.rust).is_none()
90 && (explicit_impl.is_some() || !types.aliases.contains_key(&ident.rust))
David Tolnay7e69f892020-10-03 22:20:22 -070091 {
David Tolnay17631102020-04-24 19:01:30 -070092 // Generate impl for CxxVector<T> if T is a struct or opaque
93 // C++ type. Impl for primitives is already provided by cxx
94 // crate.
Adrian Taylorc8713432020-10-21 18:20:55 -070095 expanded.extend(expand_cxx_vector(ident, explicit_impl, types));
David Tolnay7db73692019-10-20 14:51:12 -040096 }
97 }
98 }
99 }
100
101 // Work around https://github.com/rust-lang/rust/issues/67851.
102 if !hidden.is_empty() {
103 expanded.extend(quote! {
104 #[doc(hidden)]
105 const _: () = {
106 #hidden
107 };
108 });
109 }
110
111 let attrs = ffi
112 .attrs
113 .into_iter()
114 .filter(|attr| attr.path.is_ident("doc"));
115 let vis = &ffi.vis;
David Tolnaycbf3f032020-05-03 23:51:14 -0700116 let ident = &ffi.ident;
David Tolnay7db73692019-10-20 14:51:12 -0400117
David Tolnaycbf3f032020-05-03 23:51:14 -0700118 quote! {
David Tolnay7db73692019-10-20 14:51:12 -0400119 #(#attrs)*
120 #[deny(improper_ctypes)]
121 #[allow(non_snake_case)]
122 #vis mod #ident {
123 #expanded
124 }
David Tolnaycbf3f032020-05-03 23:51:14 -0700125 }
David Tolnay7db73692019-10-20 14:51:12 -0400126}
127
Adrian Taylorc8713432020-10-21 18:20:55 -0700128fn expand_struct(strct: &Struct) -> TokenStream {
David Tolnay17a934c2020-11-02 00:40:04 -0800129 let ident = &strct.name.rust;
David Tolnay7db73692019-10-20 14:51:12 -0400130 let doc = &strct.doc;
David Tolnayf3a9afa2020-10-08 23:22:12 -0700131 let derives = DeriveAttribute(&strct.derives);
David Tolnay17a934c2020-11-02 00:40:04 -0800132 let type_id = type_id(&strct.name);
David Tolnay7db73692019-10-20 14:51:12 -0400133 let fields = strct.fields.iter().map(|field| {
134 // This span on the pub makes "private type in public interface" errors
135 // appear in the right place.
136 let vis = Token![pub](field.ident.span());
137 quote!(#vis #field)
138 });
David Tolnay8684cc52020-10-07 17:09:48 -0700139
David Tolnay7db73692019-10-20 14:51:12 -0400140 quote! {
141 #doc
David Tolnayf3a9afa2020-10-08 23:22:12 -0700142 #derives
David Tolnay7db73692019-10-20 14:51:12 -0400143 #[repr(C)]
144 pub struct #ident {
145 #(#fields,)*
146 }
David Tolnay8684cc52020-10-07 17:09:48 -0700147
148 unsafe impl ::cxx::ExternType for #ident {
149 type Id = #type_id;
150 type Kind = ::cxx::kind::Trivial;
151 }
David Tolnay7db73692019-10-20 14:51:12 -0400152 }
153}
154
Adrian Taylorc8713432020-10-21 18:20:55 -0700155fn expand_enum(enm: &Enum) -> TokenStream {
David Tolnay17a934c2020-11-02 00:40:04 -0800156 let ident = &enm.name.rust;
Joel Galensonc03402a2020-04-23 17:31:09 -0700157 let doc = &enm.doc;
David Tolnayc605e6f2020-05-10 23:37:12 -0700158 let repr = enm.repr;
David Tolnay17a934c2020-11-02 00:40:04 -0800159 let type_id = type_id(&enm.name);
Joel Galenson88547732020-05-05 08:23:42 -0700160 let variants = enm.variants.iter().map(|variant| {
161 let variant_ident = &variant.ident;
162 let discriminant = &variant.discriminant;
163 Some(quote! {
164 pub const #variant_ident: Self = #ident { repr: #discriminant };
165 })
166 });
David Tolnay8684cc52020-10-07 17:09:48 -0700167
Joel Galensonc03402a2020-04-23 17:31:09 -0700168 quote! {
169 #doc
170 #[derive(Copy, Clone, PartialEq, Eq)]
171 #[repr(transparent)]
Joel Galensondb1ec312020-05-01 13:57:32 -0700172 pub struct #ident {
David Tolnayc605e6f2020-05-10 23:37:12 -0700173 pub repr: #repr,
Joel Galensondb1ec312020-05-01 13:57:32 -0700174 }
Joel Galensonc03402a2020-04-23 17:31:09 -0700175
176 #[allow(non_upper_case_globals)]
177 impl #ident {
David Tolnayd7984c22020-04-30 20:09:31 -0700178 #(#variants)*
Joel Galensonc03402a2020-04-23 17:31:09 -0700179 }
David Tolnay8684cc52020-10-07 17:09:48 -0700180
181 unsafe impl ::cxx::ExternType for #ident {
182 type Id = #type_id;
183 type Kind = ::cxx::kind::Trivial;
184 }
Joel Galensonc03402a2020-04-23 17:31:09 -0700185 }
186}
187
Adrian Taylorc8713432020-10-21 18:20:55 -0700188fn expand_cxx_type(ety: &ExternType) -> TokenStream {
David Tolnay17a934c2020-11-02 00:40:04 -0800189 let ident = &ety.name.rust;
David Tolnay7db73692019-10-20 14:51:12 -0400190 let doc = &ety.doc;
David Tolnay17a934c2020-11-02 00:40:04 -0800191 let type_id = type_id(&ety.name);
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700192
David Tolnay7db73692019-10-20 14:51:12 -0400193 quote! {
194 #doc
195 #[repr(C)]
196 pub struct #ident {
197 _private: ::cxx::private::Opaque,
198 }
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700199
200 unsafe impl ::cxx::ExternType for #ident {
201 type Id = #type_id;
David Tolnay38f5ad62020-10-03 18:06:44 -0700202 type Kind = ::cxx::kind::Opaque;
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700203 }
David Tolnay7db73692019-10-20 14:51:12 -0400204 }
205}
206
Adrian Taylorc8713432020-10-21 18:20:55 -0700207fn expand_cxx_function_decl(efn: &ExternFn, types: &Types) -> TokenStream {
David Tolnay18ba92c2020-04-22 16:17:30 -0700208 let receiver = efn.receiver.iter().map(|receiver| {
209 let receiver_type = receiver.ty();
210 quote!(_: #receiver_type)
211 });
David Tolnay39d575f2020-03-03 00:10:56 -0800212 let args = efn.args.iter().map(|arg| {
213 let ident = &arg.ident;
David Tolnay2f090422020-11-02 18:25:35 -0800214 let ty = expand_extern_type(&arg.ty, types, true);
David Tolnaya46a2372020-03-06 10:03:48 -0800215 if arg.ty == RustString {
216 quote!(#ident: *const #ty)
David Tolnay313b10e2020-04-25 16:30:51 -0700217 } else if let Type::RustVec(_) = arg.ty {
218 quote!(#ident: *const #ty)
David Tolnay75dca2e2020-03-25 20:17:52 -0700219 } else if let Type::Fn(_) = arg.ty {
220 quote!(#ident: ::cxx::private::FatFunction)
David Tolnaya46a2372020-03-06 10:03:48 -0800221 } else if types.needs_indirect_abi(&arg.ty) {
David Tolnay39d575f2020-03-03 00:10:56 -0800222 quote!(#ident: *mut #ty)
223 } else {
224 quote!(#ident: #ty)
225 }
226 });
Joel Galenson3d4f6122020-04-07 15:54:05 -0700227 let all_args = receiver.chain(args);
David Tolnayebef4a22020-03-17 15:33:47 -0700228 let ret = if efn.throws {
229 quote!(-> ::cxx::private::Result)
230 } else {
David Tolnay2f090422020-11-02 18:25:35 -0800231 expand_extern_return_type(&efn.ret, types, true)
David Tolnayebef4a22020-03-17 15:33:47 -0700232 };
David Tolnay7db73692019-10-20 14:51:12 -0400233 let mut outparam = None;
David Tolnay1e548172020-03-16 13:37:09 -0700234 if indirect_return(efn, types) {
David Tolnay2f090422020-11-02 18:25:35 -0800235 let ret = expand_extern_type(efn.ret.as_ref().unwrap(), types, true);
David Tolnay7db73692019-10-20 14:51:12 -0400236 outparam = Some(quote!(__return: *mut #ret));
237 }
Adrian Taylorc8713432020-10-21 18:20:55 -0700238 let link_name = mangle::extern_fn(efn, types);
David Tolnay17a934c2020-11-02 00:40:04 -0800239 let local_name = format_ident!("__{}", efn.name.rust);
David Tolnay7db73692019-10-20 14:51:12 -0400240 quote! {
241 #[link_name = #link_name]
Joel Galenson3d4f6122020-04-07 15:54:05 -0700242 fn #local_name(#(#all_args,)* #outparam) #ret;
David Tolnay7db73692019-10-20 14:51:12 -0400243 }
244}
245
Adrian Taylorc8713432020-10-21 18:20:55 -0700246fn expand_cxx_function_shim(efn: &ExternFn, types: &Types) -> TokenStream {
David Tolnay7db73692019-10-20 14:51:12 -0400247 let doc = &efn.doc;
Adrian Taylorc8713432020-10-21 18:20:55 -0700248 let decl = expand_cxx_function_decl(efn, types);
David Tolnayfb6e3862020-04-20 01:33:23 -0700249 let receiver = efn.receiver.iter().map(|receiver| {
David Tolnayf9ffb932020-04-20 02:22:57 -0700250 let var = receiver.var;
David Tolnayc9673842020-11-15 16:26:10 -0800251 if receiver.pinned {
252 let ty = receiver.ty();
253 quote!(#var: #ty)
254 } else {
255 let ampersand = receiver.ampersand;
256 let mutability = receiver.mutability;
257 quote!(#ampersand #mutability #var)
258 }
David Tolnayfb6e3862020-04-20 01:33:23 -0700259 });
Joel Galenson3d4f6122020-04-07 15:54:05 -0700260 let args = efn.args.iter().map(|arg| quote!(#arg));
261 let all_args = receiver.chain(args);
David Tolnayebef4a22020-03-17 15:33:47 -0700262 let ret = if efn.throws {
263 let ok = match &efn.ret {
264 Some(ret) => quote!(#ret),
265 None => quote!(()),
266 };
267 quote!(-> ::std::result::Result<#ok, ::cxx::Exception>)
268 } else {
269 expand_return_type(&efn.ret)
270 };
David Tolnay1e548172020-03-16 13:37:09 -0700271 let indirect_return = indirect_return(efn, types);
David Tolnayf9ffb932020-04-20 02:22:57 -0700272 let receiver_var = efn
273 .receiver
274 .iter()
275 .map(|receiver| receiver.var.to_token_stream());
Joel Galenson3d4f6122020-04-07 15:54:05 -0700276 let arg_vars = efn.args.iter().map(|arg| {
David Tolnay7db73692019-10-20 14:51:12 -0400277 let var = &arg.ident;
278 match &arg.ty {
Adrian Taylorc8713432020-10-21 18:20:55 -0700279 Type::Ident(ident) if ident.rust == RustString => {
David Tolnaya46a2372020-03-06 10:03:48 -0800280 quote!(#var.as_mut_ptr() as *const ::cxx::private::RustString)
David Tolnay7db73692019-10-20 14:51:12 -0400281 }
282 Type::RustBox(_) => quote!(::std::boxed::Box::into_raw(#var)),
David Tolnaya4170652020-11-15 17:00:59 -0800283 Type::UniquePtr(ptr) => match ptr.pinned {
284 false => quote!(::cxx::UniquePtr::into_raw(#var)),
285 true => quote!(::cxx::UniquePtr::__pin_into_raw(#var)),
286 },
David Tolnay313b10e2020-04-25 16:30:51 -0700287 Type::RustVec(_) => quote!(#var.as_mut_ptr() as *const ::cxx::private::RustVec<_>),
David Tolnay7db73692019-10-20 14:51:12 -0400288 Type::Ref(ty) => match &ty.inner {
Adrian Taylorc8713432020-10-21 18:20:55 -0700289 Type::Ident(ident) if ident.rust == RustString => match ty.mutability {
David Tolnayf1c7f322020-08-27 00:46:01 -0700290 None => quote!(::cxx::private::RustString::from_ref(#var)),
291 Some(_) => quote!(::cxx::private::RustString::from_mut(#var)),
292 },
David Tolnay33f56ad2020-08-27 17:06:35 -0700293 Type::RustVec(vec) if vec.inner == RustString => match ty.mutability {
294 None => quote!(::cxx::private::RustVec::from_ref_vec_string(#var)),
295 Some(_) => quote!(::cxx::private::RustVec::from_mut_vec_string(#var)),
296 },
David Tolnayf1c7f322020-08-27 00:46:01 -0700297 Type::RustVec(_) => match ty.mutability {
298 None => quote!(::cxx::private::RustVec::from_ref(#var)),
299 Some(_) => quote!(::cxx::private::RustVec::from_mut(#var)),
300 },
David Tolnay4cb97672020-11-02 16:13:34 -0800301 inner if types.is_considered_improper_ctype(inner) => match ty.mutability {
302 None => quote!(#var as *const #inner as *const ::std::ffi::c_void),
303 Some(_) => quote!(#var as *mut #inner as *mut ::std::ffi::c_void),
304 },
David Tolnay7db73692019-10-20 14:51:12 -0400305 _ => quote!(#var),
306 },
307 Type::Str(_) => quote!(::cxx::private::RustStr::from(#var)),
Adrian Taylorf5dd5522020-04-13 16:50:14 -0700308 Type::SliceRefU8(_) => quote!(::cxx::private::RustSliceU8::from(#var)),
David Tolnay7db73692019-10-20 14:51:12 -0400309 ty if types.needs_indirect_abi(ty) => quote!(#var.as_mut_ptr()),
310 _ => quote!(#var),
311 }
312 });
Joel Galenson3d4f6122020-04-07 15:54:05 -0700313 let vars = receiver_var.chain(arg_vars);
David Tolnay75dca2e2020-03-25 20:17:52 -0700314 let trampolines = efn
315 .args
316 .iter()
317 .filter_map(|arg| {
318 if let Type::Fn(f) = &arg.ty {
319 let var = &arg.ident;
Adrian Taylorc8713432020-10-21 18:20:55 -0700320 Some(expand_function_pointer_trampoline(efn, var, f, types))
David Tolnay75dca2e2020-03-25 20:17:52 -0700321 } else {
322 None
323 }
324 })
325 .collect::<TokenStream>();
David Tolnay7db73692019-10-20 14:51:12 -0400326 let mut setup = efn
327 .args
328 .iter()
329 .filter(|arg| types.needs_indirect_abi(&arg.ty))
330 .map(|arg| {
331 let var = &arg.ident;
332 // These are arguments for which C++ has taken ownership of the data
333 // behind the mut reference it received.
334 quote! {
David Tolnaycb4ee4b2020-04-24 11:28:08 -0700335 let mut #var = ::std::mem::MaybeUninit::new(#var);
David Tolnay7db73692019-10-20 14:51:12 -0400336 }
337 })
338 .collect::<TokenStream>();
David Tolnay17a934c2020-11-02 00:40:04 -0800339 let local_name = format_ident!("__{}", efn.name.rust);
David Tolnay7db73692019-10-20 14:51:12 -0400340 let call = if indirect_return {
David Tolnay2f090422020-11-02 18:25:35 -0800341 let ret = expand_extern_type(efn.ret.as_ref().unwrap(), types, true);
David Tolnay7db73692019-10-20 14:51:12 -0400342 setup.extend(quote! {
343 let mut __return = ::std::mem::MaybeUninit::<#ret>::uninit();
David Tolnay7db73692019-10-20 14:51:12 -0400344 });
David Tolnay0d524852020-11-02 17:21:50 -0800345 setup.extend(if efn.throws {
346 quote! {
David Tolnayebef4a22020-03-17 15:33:47 -0700347 #local_name(#(#vars,)* __return.as_mut_ptr()).exception()?;
David Tolnay0d524852020-11-02 17:21:50 -0800348 }
David Tolnayebef4a22020-03-17 15:33:47 -0700349 } else {
David Tolnay0d524852020-11-02 17:21:50 -0800350 quote! {
David Tolnayebef4a22020-03-17 15:33:47 -0700351 #local_name(#(#vars,)* __return.as_mut_ptr());
David Tolnay0d524852020-11-02 17:21:50 -0800352 }
353 });
354 quote!(__return.assume_init())
David Tolnayebef4a22020-03-17 15:33:47 -0700355 } else if efn.throws {
David Tolnay7db73692019-10-20 14:51:12 -0400356 quote! {
David Tolnayebef4a22020-03-17 15:33:47 -0700357 #local_name(#(#vars),*).exception()
David Tolnay7db73692019-10-20 14:51:12 -0400358 }
359 } else {
360 quote! {
361 #local_name(#(#vars),*)
362 }
363 };
David Tolnay2debdb22020-11-02 17:14:53 -0800364 let mut expr;
365 if efn.throws && efn.sig.ret.is_none() {
366 expr = call;
Myron Ahn84849302020-03-25 22:00:58 +0700367 } else {
David Tolnay0d524852020-11-02 17:21:50 -0800368 expr = match &efn.ret {
369 None => call,
370 Some(ret) => match ret {
371 Type::Ident(ident) if ident.rust == RustString => quote!(#call.into_string()),
372 Type::RustBox(_) => quote!(::std::boxed::Box::from_raw(#call)),
David Tolnaya1f02e52020-11-02 17:10:54 -0800373 Type::RustVec(vec) => {
374 if vec.inner == RustString {
David Tolnay0d524852020-11-02 17:21:50 -0800375 quote!(#call.into_vec_string())
David Tolnaya1f02e52020-11-02 17:10:54 -0800376 } else {
David Tolnay0d524852020-11-02 17:21:50 -0800377 quote!(#call.into_vec())
David Tolnaya1f02e52020-11-02 17:10:54 -0800378 }
David Tolnay33f56ad2020-08-27 17:06:35 -0700379 }
David Tolnaya4170652020-11-15 17:00:59 -0800380 Type::UniquePtr(ptr) => match ptr.pinned {
381 false => quote!(::cxx::UniquePtr::from_raw(#call)),
382 true => quote!(::cxx::UniquePtr::__pin_from_raw(#call)),
383 },
David Tolnaya1f02e52020-11-02 17:10:54 -0800384 Type::Ref(ty) => match &ty.inner {
385 Type::Ident(ident) if ident.rust == RustString => match ty.mutability {
David Tolnay0d524852020-11-02 17:21:50 -0800386 None => quote!(#call.as_string()),
387 Some(_) => quote!(#call.as_mut_string()),
David Tolnaya1f02e52020-11-02 17:10:54 -0800388 },
389 Type::RustVec(vec) if vec.inner == RustString => match ty.mutability {
David Tolnay0d524852020-11-02 17:21:50 -0800390 None => quote!(#call.as_vec_string()),
391 Some(_) => quote!(#call.as_mut_vec_string()),
David Tolnaya1f02e52020-11-02 17:10:54 -0800392 },
393 Type::RustVec(_) => match ty.mutability {
David Tolnay0d524852020-11-02 17:21:50 -0800394 None => quote!(#call.as_vec()),
395 Some(_) => quote!(#call.as_mut_vec()),
David Tolnaya1f02e52020-11-02 17:10:54 -0800396 },
David Tolnay4cb97672020-11-02 16:13:34 -0800397 inner if types.is_considered_improper_ctype(inner) => {
398 let mutability = ty.mutability;
399 quote!(&#mutability *#call.cast())
400 }
David Tolnay0d524852020-11-02 17:21:50 -0800401 _ => call,
David Tolnayf1c7f322020-08-27 00:46:01 -0700402 },
David Tolnay0d524852020-11-02 17:21:50 -0800403 Type::Str(_) => quote!(#call.as_str()),
404 Type::SliceRefU8(_) => quote!(#call.as_slice()),
405 _ => call,
406 },
407 };
David Tolnay2debdb22020-11-02 17:14:53 -0800408 if efn.throws {
409 expr = quote!(::std::result::Result::Ok(#expr));
410 }
David Tolnaya1f02e52020-11-02 17:10:54 -0800411 };
David Tolnaye67bcf52020-09-06 23:50:44 -0700412 let mut dispatch = quote!(#setup #expr);
413 let unsafety = &efn.sig.unsafety;
414 if unsafety.is_none() {
415 dispatch = quote!(unsafe { #dispatch });
416 }
David Tolnay17a934c2020-11-02 00:40:04 -0800417 let ident = &efn.name.rust;
David Tolnayc66cdbb2020-04-20 01:41:15 -0700418 let function_shim = quote! {
419 #doc
David Tolnaye67bcf52020-09-06 23:50:44 -0700420 pub #unsafety fn #ident(#(#all_args,)*) #ret {
David Tolnayc66cdbb2020-04-20 01:41:15 -0700421 extern "C" {
422 #decl
David Tolnay7db73692019-10-20 14:51:12 -0400423 }
David Tolnayc66cdbb2020-04-20 01:41:15 -0700424 #trampolines
David Tolnaye67bcf52020-09-06 23:50:44 -0700425 #dispatch
David Tolnayc66cdbb2020-04-20 01:41:15 -0700426 }
427 };
428 match &efn.receiver {
429 None => function_shim,
430 Some(receiver) => {
David Tolnay05e11cc2020-04-20 02:13:56 -0700431 let receiver_type = &receiver.ty;
David Tolnayc66cdbb2020-04-20 01:41:15 -0700432 quote!(impl #receiver_type { #function_shim })
433 }
David Tolnay7db73692019-10-20 14:51:12 -0400434 }
435}
436
David Tolnay75dca2e2020-03-25 20:17:52 -0700437fn expand_function_pointer_trampoline(
David Tolnay75dca2e2020-03-25 20:17:52 -0700438 efn: &ExternFn,
439 var: &Ident,
440 sig: &Signature,
441 types: &Types,
442) -> TokenStream {
Adrian Taylorc8713432020-10-21 18:20:55 -0700443 let c_trampoline = mangle::c_trampoline(efn, var, types);
444 let r_trampoline = mangle::r_trampoline(efn, var, types);
David Tolnay75dca2e2020-03-25 20:17:52 -0700445 let local_name = parse_quote!(__);
David Tolnay17a934c2020-11-02 00:40:04 -0800446 let catch_unwind_label = format!("::{}::{}", efn.name.rust, var);
David Tolnay75dca2e2020-03-25 20:17:52 -0700447 let shim = expand_rust_function_shim_impl(
448 sig,
449 types,
450 &r_trampoline,
451 local_name,
452 catch_unwind_label,
453 None,
454 );
455
456 quote! {
457 let #var = ::cxx::private::FatFunction {
458 trampoline: {
459 extern "C" {
460 #[link_name = #c_trampoline]
461 fn trampoline();
462 }
463 #shim
464 trampoline as usize as *const ()
465 },
466 ptr: #var as usize as *const (),
467 };
468 }
469}
470
David Tolnay7db73692019-10-20 14:51:12 -0400471fn expand_rust_type(ety: &ExternType) -> TokenStream {
David Tolnay17a934c2020-11-02 00:40:04 -0800472 let ident = &ety.name.rust;
David Tolnay7db73692019-10-20 14:51:12 -0400473 quote! {
474 use super::#ident;
475 }
476}
477
David Tolnayc8361022020-08-25 21:57:53 -0700478fn expand_rust_type_assert_sized(ety: &ExternType) -> TokenStream {
479 // Rustc will render as follows if not sized:
480 //
481 // type TheirType;
482 // -----^^^^^^^^^-
483 // | |
484 // | doesn't have a size known at compile-time
485 // required by this bound in `ffi::_::__AssertSized`
486
David Tolnay17a934c2020-11-02 00:40:04 -0800487 let ident = &ety.name.rust;
David Tolnayc8361022020-08-25 21:57:53 -0700488 let begin_span = Token![::](ety.type_token.span);
489 let sized = quote_spanned! {ety.semi_token.span=>
490 #begin_span std::marker::Sized
491 };
David Tolnay20fa62b2020-11-15 17:34:05 -0800492 let unpin = quote_spanned! {ety.semi_token.span=>
493 #begin_span std::marker::Unpin
494 };
David Tolnay17a934c2020-11-02 00:40:04 -0800495 quote_spanned! {ident.span()=>
David Tolnayc8361022020-08-25 21:57:53 -0700496 let _ = {
497 fn __AssertSized<T: ?#sized + #sized>() {}
David Tolnay20fa62b2020-11-15 17:34:05 -0800498 fn __AssertUnpin<T: #unpin>() {}
499 (__AssertSized::<#ident>, __AssertUnpin::<#ident>)
David Tolnayc8361022020-08-25 21:57:53 -0700500 };
501 }
502}
503
Adrian Taylorc8713432020-10-21 18:20:55 -0700504fn expand_rust_function_shim(efn: &ExternFn, types: &Types) -> TokenStream {
505 let link_name = mangle::extern_fn(efn, types);
David Tolnay17a934c2020-11-02 00:40:04 -0800506 let local_name = format_ident!("__{}", efn.name.rust);
507 let catch_unwind_label = format!("::{}", efn.name.rust);
508 let invoke = Some(&efn.name.rust);
David Tolnay75dca2e2020-03-25 20:17:52 -0700509 expand_rust_function_shim_impl(
510 efn,
511 types,
512 &link_name,
513 local_name,
514 catch_unwind_label,
515 invoke,
516 )
517}
518
519fn expand_rust_function_shim_impl(
520 sig: &Signature,
521 types: &Types,
David Tolnay891061b2020-04-19 22:42:33 -0700522 link_name: &Symbol,
David Tolnay75dca2e2020-03-25 20:17:52 -0700523 local_name: Ident,
524 catch_unwind_label: String,
525 invoke: Option<&Ident>,
526) -> TokenStream {
David Tolnayf9ffb932020-04-20 02:22:57 -0700527 let receiver_var = sig
528 .receiver
529 .as_ref()
530 .map(|receiver| quote_spanned!(receiver.var.span=> __self));
David Tolnay18ba92c2020-04-22 16:17:30 -0700531 let receiver = sig.receiver.as_ref().map(|receiver| {
532 let receiver_type = receiver.ty();
533 quote!(#receiver_var: #receiver_type)
534 });
David Tolnay75dca2e2020-03-25 20:17:52 -0700535 let args = sig.args.iter().map(|arg| {
David Tolnay39d575f2020-03-03 00:10:56 -0800536 let ident = &arg.ident;
David Tolnay2f090422020-11-02 18:25:35 -0800537 let ty = expand_extern_type(&arg.ty, types, false);
David Tolnay39d575f2020-03-03 00:10:56 -0800538 if types.needs_indirect_abi(&arg.ty) {
539 quote!(#ident: *mut #ty)
540 } else {
541 quote!(#ident: #ty)
542 }
543 });
David Tolnayf9ffb932020-04-20 02:22:57 -0700544 let all_args = receiver.into_iter().chain(args);
David Tolnay75dca2e2020-03-25 20:17:52 -0700545
David Tolnay3a45f2d2020-04-20 01:51:12 -0700546 let arg_vars = sig.args.iter().map(|arg| {
David Tolnay7db73692019-10-20 14:51:12 -0400547 let ident = &arg.ident;
David Tolnay17955e22020-01-20 17:58:24 -0800548 match &arg.ty {
Adrian Taylorc8713432020-10-21 18:20:55 -0700549 Type::Ident(i) if i.rust == RustString => {
David Tolnaycc3767f2020-03-06 10:41:51 -0800550 quote!(::std::mem::take((*#ident).as_mut_string()))
551 }
David Tolnay40226ab2020-03-03 00:05:35 -0800552 Type::RustBox(_) => quote!(::std::boxed::Box::from_raw(#ident)),
David Tolnay33f56ad2020-08-27 17:06:35 -0700553 Type::RustVec(vec) => {
554 if vec.inner == RustString {
555 quote!(::std::mem::take((*#ident).as_mut_vec_string()))
556 } else {
557 quote!(::std::mem::take((*#ident).as_mut_vec()))
558 }
559 }
David Tolnaya4170652020-11-15 17:00:59 -0800560 Type::UniquePtr(ptr) => match ptr.pinned {
561 false => quote!(::cxx::UniquePtr::from_raw(#ident)),
562 true => quote!(::cxx::UniquePtr::__pin_from_raw(#ident)),
563 },
David Tolnay17955e22020-01-20 17:58:24 -0800564 Type::Ref(ty) => match &ty.inner {
Adrian Taylorc8713432020-10-21 18:20:55 -0700565 Type::Ident(i) if i.rust == RustString => match ty.mutability {
David Tolnayf1c7f322020-08-27 00:46:01 -0700566 None => quote!(#ident.as_string()),
567 Some(_) => quote!(#ident.as_mut_string()),
568 },
David Tolnay33f56ad2020-08-27 17:06:35 -0700569 Type::RustVec(vec) if vec.inner == RustString => match ty.mutability {
570 None => quote!(#ident.as_vec_string()),
571 Some(_) => quote!(#ident.as_mut_vec_string()),
572 },
David Tolnayf1c7f322020-08-27 00:46:01 -0700573 Type::RustVec(_) => match ty.mutability {
574 None => quote!(#ident.as_vec()),
575 Some(_) => quote!(#ident.as_mut_vec()),
576 },
David Tolnay40226ab2020-03-03 00:05:35 -0800577 _ => quote!(#ident),
David Tolnay17955e22020-01-20 17:58:24 -0800578 },
David Tolnay40226ab2020-03-03 00:05:35 -0800579 Type::Str(_) => quote!(#ident.as_str()),
Adrian Taylorf5dd5522020-04-13 16:50:14 -0700580 Type::SliceRefU8(_) => quote!(#ident.as_slice()),
David Tolnay40226ab2020-03-03 00:05:35 -0800581 ty if types.needs_indirect_abi(ty) => quote!(::std::ptr::read(#ident)),
582 _ => quote!(#ident),
David Tolnay7db73692019-10-20 14:51:12 -0400583 }
584 });
David Tolnayf9ffb932020-04-20 02:22:57 -0700585 let vars = receiver_var.into_iter().chain(arg_vars);
David Tolnay75dca2e2020-03-25 20:17:52 -0700586
David Tolnay26219462020-11-09 19:47:28 -0800587 let wrap_super = invoke.map(|invoke| expand_rust_function_shim_super(sig, &local_name, invoke));
588
David Tolnay75dca2e2020-03-25 20:17:52 -0700589 let mut call = match invoke {
David Tolnay26219462020-11-09 19:47:28 -0800590 Some(_) => quote!(#local_name),
David Tolnayb8ebeb02020-10-31 23:52:06 -0700591 None => quote!(::std::mem::transmute::<*const (), #sig>(__extern)),
David Tolnay75dca2e2020-03-25 20:17:52 -0700592 };
593 call.extend(quote! { (#(#vars),*) });
594
David Tolnay22602b42020-09-21 18:04:05 -0400595 let conversion = sig.ret.as_ref().and_then(|ret| match ret {
Adrian Taylorc8713432020-10-21 18:20:55 -0700596 Type::Ident(ident) if ident.rust == RustString => {
597 Some(quote!(::cxx::private::RustString::from))
598 }
David Tolnay22602b42020-09-21 18:04:05 -0400599 Type::RustBox(_) => Some(quote!(::std::boxed::Box::into_raw)),
600 Type::RustVec(vec) => {
601 if vec.inner == RustString {
602 Some(quote!(::cxx::private::RustVec::from_vec_string))
603 } else {
604 Some(quote!(::cxx::private::RustVec::from))
David Tolnay7db73692019-10-20 14:51:12 -0400605 }
David Tolnay22602b42020-09-21 18:04:05 -0400606 }
David Tolnaya4170652020-11-15 17:00:59 -0800607 Type::UniquePtr(ptr) => match ptr.pinned {
608 false => Some(quote!(::cxx::UniquePtr::into_raw)),
609 true => Some(quote!(::cxx::UniquePtr::__pin_into_raw)),
610 },
David Tolnay22602b42020-09-21 18:04:05 -0400611 Type::Ref(ty) => match &ty.inner {
Adrian Taylorc8713432020-10-21 18:20:55 -0700612 Type::Ident(ident) if ident.rust == RustString => match ty.mutability {
David Tolnay22602b42020-09-21 18:04:05 -0400613 None => Some(quote!(::cxx::private::RustString::from_ref)),
614 Some(_) => Some(quote!(::cxx::private::RustString::from_mut)),
David Tolnay7db73692019-10-20 14:51:12 -0400615 },
David Tolnay22602b42020-09-21 18:04:05 -0400616 Type::RustVec(vec) if vec.inner == RustString => match ty.mutability {
617 None => Some(quote!(::cxx::private::RustVec::from_ref_vec_string)),
618 Some(_) => Some(quote!(::cxx::private::RustVec::from_mut_vec_string)),
619 },
620 Type::RustVec(_) => match ty.mutability {
621 None => Some(quote!(::cxx::private::RustVec::from_ref)),
622 Some(_) => Some(quote!(::cxx::private::RustVec::from_mut)),
623 },
David Tolnay7db73692019-10-20 14:51:12 -0400624 _ => None,
David Tolnay22602b42020-09-21 18:04:05 -0400625 },
626 Type::Str(_) => Some(quote!(::cxx::private::RustStr::from)),
627 Type::SliceRefU8(_) => Some(quote!(::cxx::private::RustSliceU8::from)),
628 _ => None,
629 });
630
631 let mut expr = match conversion {
632 None => call,
633 Some(conversion) if !sig.throws => quote!(#conversion(#call)),
634 Some(conversion) => quote!(::std::result::Result::map(#call, #conversion)),
635 };
David Tolnay75dca2e2020-03-25 20:17:52 -0700636
637 let mut outparam = None;
638 let indirect_return = indirect_return(sig, types);
David Tolnay1e548172020-03-16 13:37:09 -0700639 if indirect_return {
David Tolnay2f090422020-11-02 18:25:35 -0800640 let ret = expand_extern_type(sig.ret.as_ref().unwrap(), types, false);
David Tolnay75dca2e2020-03-25 20:17:52 -0700641 outparam = Some(quote!(__return: *mut #ret,));
David Tolnay1e548172020-03-16 13:37:09 -0700642 }
David Tolnay75dca2e2020-03-25 20:17:52 -0700643 if sig.throws {
644 let out = match sig.ret {
David Tolnaycecada62020-03-17 01:45:58 -0700645 Some(_) => quote!(__return),
646 None => quote!(&mut ()),
647 };
648 expr = quote!(::cxx::private::r#try(#out, #expr));
David Tolnay1e548172020-03-16 13:37:09 -0700649 } else if indirect_return {
David Tolnay7db73692019-10-20 14:51:12 -0400650 expr = quote!(::std::ptr::write(__return, #expr));
651 }
David Tolnay75dca2e2020-03-25 20:17:52 -0700652
David Tolnay1e548172020-03-16 13:37:09 -0700653 expr = quote!(::cxx::private::catch_unwind(__fn, move || #expr));
David Tolnay75dca2e2020-03-25 20:17:52 -0700654
655 let ret = if sig.throws {
David Tolnay486b6ec2020-03-17 01:19:57 -0700656 quote!(-> ::cxx::private::Result)
David Tolnay1e548172020-03-16 13:37:09 -0700657 } else {
David Tolnay2f090422020-11-02 18:25:35 -0800658 expand_extern_return_type(&sig.ret, types, false)
David Tolnay1e548172020-03-16 13:37:09 -0700659 };
David Tolnay75dca2e2020-03-25 20:17:52 -0700660
661 let pointer = match invoke {
David Tolnayb8ebeb02020-10-31 23:52:06 -0700662 None => Some(quote!(__extern: *const ())),
David Tolnay75dca2e2020-03-25 20:17:52 -0700663 Some(_) => None,
664 };
665
David Tolnay7db73692019-10-20 14:51:12 -0400666 quote! {
667 #[doc(hidden)]
668 #[export_name = #link_name]
Joel Galensonc1c4e7a2020-04-15 10:21:00 -0700669 unsafe extern "C" fn #local_name(#(#all_args,)* #outparam #pointer) #ret {
David Tolnay7db73692019-10-20 14:51:12 -0400670 let __fn = concat!(module_path!(), #catch_unwind_label);
David Tolnay26219462020-11-09 19:47:28 -0800671 #wrap_super
David Tolnay7db73692019-10-20 14:51:12 -0400672 #expr
673 }
674 }
675}
676
David Tolnay26219462020-11-09 19:47:28 -0800677// A wrapper like `fn f(x: Arg) { super::f(x) }` just to ensure we have the
678// accurate unsafety declaration and no problematic elided lifetimes.
679fn expand_rust_function_shim_super(
680 sig: &Signature,
681 local_name: &Ident,
682 invoke: &Ident,
683) -> TokenStream {
684 let unsafety = sig.unsafety;
685
686 let receiver_var = sig
687 .receiver
688 .as_ref()
689 .map(|receiver| Ident::new("__self", receiver.var.span));
690 let receiver = sig.receiver.iter().map(|receiver| {
691 let receiver_type = receiver.ty();
692 quote!(#receiver_var: #receiver_type)
693 });
694 let args = sig.args.iter().map(|arg| quote!(#arg));
695 let all_args = receiver.chain(args);
696
David Tolnay5d164672020-11-09 20:23:17 -0800697 let ret = if let Some((result, _langle, rangle)) = sig.throws_tokens {
David Tolnay26219462020-11-09 19:47:28 -0800698 let ok = match &sig.ret {
699 Some(ret) => quote!(#ret),
700 None => quote!(()),
701 };
David Tolnay5d164672020-11-09 20:23:17 -0800702 let impl_trait = quote_spanned!(result.span=> impl);
703 let display = quote_spanned!(rangle.span=> ::std::fmt::Display);
704 quote!(-> ::std::result::Result<#ok, #impl_trait #display>)
David Tolnay26219462020-11-09 19:47:28 -0800705 } else {
706 expand_return_type(&sig.ret)
707 };
708
709 let arg_vars = sig.args.iter().map(|arg| &arg.ident);
710 let vars = receiver_var.iter().chain(arg_vars);
711
712 let span = invoke.span();
713 let call = match &sig.receiver {
714 None => quote_spanned!(span=> super::#invoke),
715 Some(receiver) => {
716 let receiver_type = &receiver.ty;
717 quote_spanned!(span=> #receiver_type::#invoke)
718 }
719 };
720
721 quote_spanned! {span=>
722 #unsafety fn #local_name(#(#all_args,)*) #ret {
723 #call(#(#vars,)*)
724 }
725 }
726}
727
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700728fn expand_type_alias(alias: &TypeAlias) -> TokenStream {
Bryan Henry890083d2020-09-13 10:34:31 -0700729 let doc = &alias.doc;
David Tolnay17a934c2020-11-02 00:40:04 -0800730 let ident = &alias.name.rust;
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700731 let ty = &alias.ty;
732 quote! {
Bryan Henry890083d2020-09-13 10:34:31 -0700733 #doc
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700734 pub type #ident = #ty;
735 }
736}
737
Adrian Taylorc8713432020-10-21 18:20:55 -0700738fn expand_type_alias_verify(alias: &TypeAlias, types: &Types) -> TokenStream {
David Tolnay17a934c2020-11-02 00:40:04 -0800739 let ident = &alias.name.rust;
740 let type_id = type_id(&alias.name);
David Tolnay83fe0f02020-05-07 20:00:15 -0700741 let begin_span = alias.type_token.span;
742 let end_span = alias.semi_token.span;
743 let begin = quote_spanned!(begin_span=> ::cxx::private::verify_extern_type::<);
744 let end = quote_spanned!(end_span=> >);
745
David Tolnay63a0e4e2020-10-03 18:52:32 -0700746 let mut verify = quote! {
David Tolnay83fe0f02020-05-07 20:00:15 -0700747 const _: fn() = #begin #ident, #type_id #end;
David Tolnay63a0e4e2020-10-03 18:52:32 -0700748 };
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700749
David Tolnay17a934c2020-11-02 00:40:04 -0800750 if types.required_trivial.contains_key(&alias.name.rust) {
David Tolnay63a0e4e2020-10-03 18:52:32 -0700751 let begin = quote_spanned!(begin_span=> ::cxx::private::verify_extern_kind::<);
752 verify.extend(quote! {
753 const _: fn() = #begin #ident, ::cxx::kind::Trivial #end;
754 });
Adrian Taylorc7043292020-09-25 12:48:36 -0700755 }
David Tolnay63a0e4e2020-10-03 18:52:32 -0700756
757 verify
Adrian Taylorc7043292020-09-25 12:48:36 -0700758}
759
David Tolnay8faec772020-11-02 00:18:19 -0800760fn type_id(name: &Pair) -> TokenStream {
761 let path = name.to_fully_qualified();
David Tolnay5f9e8ca2020-05-07 17:21:05 -0700762 quote! {
763 ::cxx::type_id!(#path)
764 }
765}
766
Adrian Taylorc8713432020-10-21 18:20:55 -0700767fn expand_rust_box(ident: &ResolvableName, types: &Types) -> TokenStream {
768 let link_prefix = format!("cxxbridge05$box${}$", types.resolve(ident).to_symbol());
David Tolnay7db73692019-10-20 14:51:12 -0400769 let link_uninit = format!("{}uninit", link_prefix);
David Tolnay7db73692019-10-20 14:51:12 -0400770 let link_drop = format!("{}drop", link_prefix);
David Tolnay7db73692019-10-20 14:51:12 -0400771
Adrian Taylorc8713432020-10-21 18:20:55 -0700772 let local_prefix = format_ident!("{}__box_", &ident.rust);
David Tolnay7db73692019-10-20 14:51:12 -0400773 let local_uninit = format_ident!("{}uninit", local_prefix);
David Tolnay7db73692019-10-20 14:51:12 -0400774 let local_drop = format_ident!("{}drop", local_prefix);
David Tolnay7db73692019-10-20 14:51:12 -0400775
776 let span = ident.span();
777 quote_spanned! {span=>
778 #[doc(hidden)]
779 #[export_name = #link_uninit]
780 unsafe extern "C" fn #local_uninit(
781 this: *mut ::std::boxed::Box<::std::mem::MaybeUninit<#ident>>,
782 ) {
783 ::std::ptr::write(
784 this,
785 ::std::boxed::Box::new(::std::mem::MaybeUninit::uninit()),
786 );
787 }
788 #[doc(hidden)]
David Tolnay7db73692019-10-20 14:51:12 -0400789 #[export_name = #link_drop]
790 unsafe extern "C" fn #local_drop(this: *mut ::std::boxed::Box<#ident>) {
791 ::std::ptr::drop_in_place(this);
792 }
David Tolnay7db73692019-10-20 14:51:12 -0400793 }
794}
795
Adrian Taylorc8713432020-10-21 18:20:55 -0700796fn expand_rust_vec(elem: &ResolvableName, types: &Types) -> TokenStream {
797 let link_prefix = format!("cxxbridge05$rust_vec${}$", elem.to_symbol(types));
David Tolnayf97c2d52020-04-25 16:37:48 -0700798 let link_new = format!("{}new", link_prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700799 let link_drop = format!("{}drop", link_prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700800 let link_len = format!("{}len", link_prefix);
David Tolnay219c0792020-04-24 20:31:37 -0700801 let link_data = format!("{}data", link_prefix);
David Tolnayfb6b73c2020-11-10 14:32:16 -0800802 let link_reserve_total = format!("{}reserve_total", link_prefix);
803 let link_set_len = format!("{}set_len", link_prefix);
David Tolnay503d0192020-04-24 22:18:56 -0700804 let link_stride = format!("{}stride", link_prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700805
Adrian Taylorc8713432020-10-21 18:20:55 -0700806 let local_prefix = format_ident!("{}__vec_", elem.rust);
David Tolnayf97c2d52020-04-25 16:37:48 -0700807 let local_new = format_ident!("{}new", local_prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700808 let local_drop = format_ident!("{}drop", local_prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700809 let local_len = format_ident!("{}len", local_prefix);
David Tolnay219c0792020-04-24 20:31:37 -0700810 let local_data = format_ident!("{}data", local_prefix);
David Tolnayfb6b73c2020-11-10 14:32:16 -0800811 let local_reserve_total = format_ident!("{}reserve_total", local_prefix);
812 let local_set_len = format_ident!("{}set_len", local_prefix);
David Tolnay503d0192020-04-24 22:18:56 -0700813 let local_stride = format_ident!("{}stride", local_prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700814
David Tolnay83a7ec92020-04-25 12:37:42 -0700815 let span = elem.span();
Myron Ahneba35cf2020-02-05 19:41:51 +0700816 quote_spanned! {span=>
817 #[doc(hidden)]
David Tolnayf97c2d52020-04-25 16:37:48 -0700818 #[export_name = #link_new]
819 unsafe extern "C" fn #local_new(this: *mut ::cxx::private::RustVec<#elem>) {
820 ::std::ptr::write(this, ::cxx::private::RustVec::new());
821 }
822 #[doc(hidden)]
Myron Ahneba35cf2020-02-05 19:41:51 +0700823 #[export_name = #link_drop]
David Tolnay83a7ec92020-04-25 12:37:42 -0700824 unsafe extern "C" fn #local_drop(this: *mut ::cxx::private::RustVec<#elem>) {
David Tolnay4c64afb2020-04-24 11:30:18 -0700825 ::std::ptr::drop_in_place(this);
Myron Ahneba35cf2020-02-05 19:41:51 +0700826 }
David Tolnay85db5a02020-04-25 13:17:27 -0700827 #[doc(hidden)]
Myron Ahneba35cf2020-02-05 19:41:51 +0700828 #[export_name = #link_len]
David Tolnay83a7ec92020-04-25 12:37:42 -0700829 unsafe extern "C" fn #local_len(this: *const ::cxx::private::RustVec<#elem>) -> usize {
David Tolnay2cef5df2020-04-24 11:33:58 -0700830 (*this).len()
Myron Ahneba35cf2020-02-05 19:41:51 +0700831 }
David Tolnay219c0792020-04-24 20:31:37 -0700832 #[doc(hidden)]
833 #[export_name = #link_data]
David Tolnay83a7ec92020-04-25 12:37:42 -0700834 unsafe extern "C" fn #local_data(this: *const ::cxx::private::RustVec<#elem>) -> *const #elem {
David Tolnay219c0792020-04-24 20:31:37 -0700835 (*this).as_ptr()
836 }
David Tolnay503d0192020-04-24 22:18:56 -0700837 #[doc(hidden)]
David Tolnayfb6b73c2020-11-10 14:32:16 -0800838 #[export_name = #link_reserve_total]
839 unsafe extern "C" fn #local_reserve_total(this: *mut ::cxx::private::RustVec<#elem>, cap: usize) {
840 (*this).reserve_total(cap);
841 }
842 #[doc(hidden)]
843 #[export_name = #link_set_len]
844 unsafe extern "C" fn #local_set_len(this: *mut ::cxx::private::RustVec<#elem>, len: usize) {
845 (*this).set_len(len);
846 }
847 #[doc(hidden)]
David Tolnay503d0192020-04-24 22:18:56 -0700848 #[export_name = #link_stride]
849 unsafe extern "C" fn #local_stride() -> usize {
David Tolnay83a7ec92020-04-25 12:37:42 -0700850 ::std::mem::size_of::<#elem>()
David Tolnay503d0192020-04-24 22:18:56 -0700851 }
Myron Ahneba35cf2020-02-05 19:41:51 +0700852 }
853}
854
David Tolnay0531f432020-10-03 23:50:28 -0700855fn expand_unique_ptr(
Adrian Taylorc8713432020-10-21 18:20:55 -0700856 ident: &ResolvableName,
David Tolnay0531f432020-10-03 23:50:28 -0700857 types: &Types,
858 explicit_impl: Option<&Impl>,
859) -> TokenStream {
Adrian Taylorc8713432020-10-21 18:20:55 -0700860 let name = ident.rust.to_string();
861 let prefix = format!("cxxbridge05$unique_ptr${}$", ident.to_symbol(types));
David Tolnay7db73692019-10-20 14:51:12 -0400862 let link_null = format!("{}null", prefix);
863 let link_new = format!("{}new", prefix);
864 let link_raw = format!("{}raw", prefix);
865 let link_get = format!("{}get", prefix);
866 let link_release = format!("{}release", prefix);
867 let link_drop = format!("{}drop", prefix);
868
Adrian Taylorc8713432020-10-21 18:20:55 -0700869 let new_method =
870 if types.structs.contains_key(&ident.rust) || types.aliases.contains_key(&ident.rust) {
871 Some(quote! {
872 fn __new(mut value: Self) -> *mut ::std::ffi::c_void {
873 extern "C" {
874 #[link_name = #link_new]
875 fn __new(this: *mut *mut ::std::ffi::c_void, value: *mut #ident);
876 }
877 let mut repr = ::std::ptr::null_mut::<::std::ffi::c_void>();
878 unsafe { __new(&mut repr, &mut value) }
879 repr
David Tolnay53838912020-04-09 20:56:44 -0700880 }
Adrian Taylorc8713432020-10-21 18:20:55 -0700881 })
882 } else {
883 None
884 };
David Tolnay53838912020-04-09 20:56:44 -0700885
David Tolnay0531f432020-10-03 23:50:28 -0700886 let begin_span =
887 explicit_impl.map_or_else(Span::call_site, |explicit| explicit.impl_token.span);
888 let end_span = explicit_impl.map_or_else(Span::call_site, |explicit| explicit.brace_token.span);
889 let unsafe_token = format_ident!("unsafe", span = begin_span);
890
891 quote_spanned! {end_span=>
892 #unsafe_token impl ::cxx::private::UniquePtrTarget for #ident {
David Tolnay3b40b6f2020-04-24 17:58:24 -0700893 const __NAME: &'static dyn ::std::fmt::Display = &#name;
David Tolnay7db73692019-10-20 14:51:12 -0400894 fn __null() -> *mut ::std::ffi::c_void {
895 extern "C" {
896 #[link_name = #link_null]
897 fn __null(this: *mut *mut ::std::ffi::c_void);
898 }
899 let mut repr = ::std::ptr::null_mut::<::std::ffi::c_void>();
900 unsafe { __null(&mut repr) }
901 repr
902 }
David Tolnay53838912020-04-09 20:56:44 -0700903 #new_method
David Tolnay7db73692019-10-20 14:51:12 -0400904 unsafe fn __raw(raw: *mut Self) -> *mut ::std::ffi::c_void {
905 extern "C" {
906 #[link_name = #link_raw]
David Tolnay3b40b6f2020-04-24 17:58:24 -0700907 fn __raw(this: *mut *mut ::std::ffi::c_void, raw: *mut #ident);
David Tolnay7db73692019-10-20 14:51:12 -0400908 }
909 let mut repr = ::std::ptr::null_mut::<::std::ffi::c_void>();
910 __raw(&mut repr, raw);
911 repr
912 }
913 unsafe fn __get(repr: *mut ::std::ffi::c_void) -> *const Self {
914 extern "C" {
915 #[link_name = #link_get]
David Tolnay3b40b6f2020-04-24 17:58:24 -0700916 fn __get(this: *const *mut ::std::ffi::c_void) -> *const #ident;
David Tolnay7db73692019-10-20 14:51:12 -0400917 }
918 __get(&repr)
919 }
920 unsafe fn __release(mut repr: *mut ::std::ffi::c_void) -> *mut Self {
921 extern "C" {
922 #[link_name = #link_release]
David Tolnay3b40b6f2020-04-24 17:58:24 -0700923 fn __release(this: *mut *mut ::std::ffi::c_void) -> *mut #ident;
David Tolnay7db73692019-10-20 14:51:12 -0400924 }
925 __release(&mut repr)
926 }
927 unsafe fn __drop(mut repr: *mut ::std::ffi::c_void) {
928 extern "C" {
929 #[link_name = #link_drop]
930 fn __drop(this: *mut *mut ::std::ffi::c_void);
931 }
932 __drop(&mut repr);
933 }
934 }
935 }
936}
937
David Tolnay0531f432020-10-03 23:50:28 -0700938fn expand_cxx_vector(
Adrian Taylorc8713432020-10-21 18:20:55 -0700939 elem: &ResolvableName,
David Tolnay0531f432020-10-03 23:50:28 -0700940 explicit_impl: Option<&Impl>,
Adrian Taylorc8713432020-10-21 18:20:55 -0700941 types: &Types,
David Tolnay0531f432020-10-03 23:50:28 -0700942) -> TokenStream {
943 let _ = explicit_impl;
Adrian Taylorc8713432020-10-21 18:20:55 -0700944 let name = elem.rust.to_string();
945 let prefix = format!("cxxbridge05$std$vector${}$", elem.to_symbol(types));
David Tolnaya83247c2020-04-24 14:36:10 -0700946 let link_size = format!("{}size", prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700947 let link_get_unchecked = format!("{}get_unchecked", prefix);
Adrian Taylorc8713432020-10-21 18:20:55 -0700948 let unique_ptr_prefix = format!(
949 "cxxbridge05$unique_ptr$std$vector${}$",
950 elem.to_symbol(types)
951 );
David Tolnay3b40b6f2020-04-24 17:58:24 -0700952 let link_unique_ptr_null = format!("{}null", unique_ptr_prefix);
953 let link_unique_ptr_raw = format!("{}raw", unique_ptr_prefix);
954 let link_unique_ptr_get = format!("{}get", unique_ptr_prefix);
955 let link_unique_ptr_release = format!("{}release", unique_ptr_prefix);
956 let link_unique_ptr_drop = format!("{}drop", unique_ptr_prefix);
Myron Ahneba35cf2020-02-05 19:41:51 +0700957
David Tolnay0531f432020-10-03 23:50:28 -0700958 let begin_span =
959 explicit_impl.map_or_else(Span::call_site, |explicit| explicit.impl_token.span);
960 let end_span = explicit_impl.map_or_else(Span::call_site, |explicit| explicit.brace_token.span);
961 let unsafe_token = format_ident!("unsafe", span = begin_span);
962
963 quote_spanned! {end_span=>
964 #unsafe_token impl ::cxx::private::VectorElement for #elem {
David Tolnay3b40b6f2020-04-24 17:58:24 -0700965 const __NAME: &'static dyn ::std::fmt::Display = &#name;
David Tolnay17631102020-04-24 19:01:30 -0700966 fn __vector_size(v: &::cxx::CxxVector<Self>) -> usize {
David Tolnayfa2119c2020-04-24 14:42:58 -0700967 extern "C" {
968 #[link_name = #link_size]
David Tolnay17631102020-04-24 19:01:30 -0700969 fn __vector_size(_: &::cxx::CxxVector<#elem>) -> usize;
Myron Ahneba35cf2020-02-05 19:41:51 +0700970 }
David Tolnayfa2119c2020-04-24 14:42:58 -0700971 unsafe { __vector_size(v) }
Myron Ahneba35cf2020-02-05 19:41:51 +0700972 }
David Tolnay93637ca2020-09-24 15:58:20 -0400973 unsafe fn __get_unchecked(v: &::cxx::CxxVector<Self>, pos: usize) -> *const Self {
David Tolnaycc75ad22020-04-24 14:45:16 -0700974 extern "C" {
975 #[link_name = #link_get_unchecked]
David Tolnay17631102020-04-24 19:01:30 -0700976 fn __get_unchecked(_: &::cxx::CxxVector<#elem>, _: usize) -> *const #elem;
David Tolnaycc75ad22020-04-24 14:45:16 -0700977 }
David Tolnay93637ca2020-09-24 15:58:20 -0400978 __get_unchecked(v, pos)
David Tolnaycc75ad22020-04-24 14:45:16 -0700979 }
David Tolnay3b40b6f2020-04-24 17:58:24 -0700980 fn __unique_ptr_null() -> *mut ::std::ffi::c_void {
981 extern "C" {
982 #[link_name = #link_unique_ptr_null]
983 fn __unique_ptr_null(this: *mut *mut ::std::ffi::c_void);
984 }
985 let mut repr = ::std::ptr::null_mut::<::std::ffi::c_void>();
986 unsafe { __unique_ptr_null(&mut repr) }
987 repr
988 }
989 unsafe fn __unique_ptr_raw(raw: *mut ::cxx::CxxVector<Self>) -> *mut ::std::ffi::c_void {
990 extern "C" {
991 #[link_name = #link_unique_ptr_raw]
992 fn __unique_ptr_raw(this: *mut *mut ::std::ffi::c_void, raw: *mut ::cxx::CxxVector<#elem>);
993 }
994 let mut repr = ::std::ptr::null_mut::<::std::ffi::c_void>();
995 __unique_ptr_raw(&mut repr, raw);
996 repr
997 }
998 unsafe fn __unique_ptr_get(repr: *mut ::std::ffi::c_void) -> *const ::cxx::CxxVector<Self> {
999 extern "C" {
1000 #[link_name = #link_unique_ptr_get]
1001 fn __unique_ptr_get(this: *const *mut ::std::ffi::c_void) -> *const ::cxx::CxxVector<#elem>;
1002 }
1003 __unique_ptr_get(&repr)
1004 }
1005 unsafe fn __unique_ptr_release(mut repr: *mut ::std::ffi::c_void) -> *mut ::cxx::CxxVector<Self> {
1006 extern "C" {
1007 #[link_name = #link_unique_ptr_release]
1008 fn __unique_ptr_release(this: *mut *mut ::std::ffi::c_void) -> *mut ::cxx::CxxVector<#elem>;
1009 }
1010 __unique_ptr_release(&mut repr)
1011 }
1012 unsafe fn __unique_ptr_drop(mut repr: *mut ::std::ffi::c_void) {
1013 extern "C" {
1014 #[link_name = #link_unique_ptr_drop]
1015 fn __unique_ptr_drop(this: *mut *mut ::std::ffi::c_void);
1016 }
1017 __unique_ptr_drop(&mut repr);
1018 }
Myron Ahneba35cf2020-02-05 19:41:51 +07001019 }
1020 }
1021}
1022
David Tolnay7db73692019-10-20 14:51:12 -04001023fn expand_return_type(ret: &Option<Type>) -> TokenStream {
1024 match ret {
1025 Some(ret) => quote!(-> #ret),
1026 None => TokenStream::new(),
1027 }
1028}
1029
David Tolnay75dca2e2020-03-25 20:17:52 -07001030fn indirect_return(sig: &Signature, types: &Types) -> bool {
1031 sig.ret
David Tolnay1e548172020-03-16 13:37:09 -07001032 .as_ref()
David Tolnay75dca2e2020-03-25 20:17:52 -07001033 .map_or(false, |ret| sig.throws || types.needs_indirect_abi(ret))
David Tolnay7db73692019-10-20 14:51:12 -04001034}
1035
David Tolnay2f090422020-11-02 18:25:35 -08001036fn expand_extern_type(ty: &Type, types: &Types, proper: bool) -> TokenStream {
David Tolnay7db73692019-10-20 14:51:12 -04001037 match ty {
Adrian Taylorc8713432020-10-21 18:20:55 -07001038 Type::Ident(ident) if ident.rust == RustString => quote!(::cxx::private::RustString),
David Tolnay7db73692019-10-20 14:51:12 -04001039 Type::RustBox(ty) | Type::UniquePtr(ty) => {
David Tolnay2f090422020-11-02 18:25:35 -08001040 let inner = expand_extern_type(&ty.inner, types, proper);
David Tolnay7db73692019-10-20 14:51:12 -04001041 quote!(*mut #inner)
1042 }
David Tolnaye6d50212020-04-25 15:38:23 -07001043 Type::RustVec(ty) => {
David Tolnay2f090422020-11-02 18:25:35 -08001044 let elem = expand_extern_type(&ty.inner, types, proper);
David Tolnaye6d50212020-04-25 15:38:23 -07001045 quote!(::cxx::private::RustVec<#elem>)
1046 }
David Tolnayf1c7f322020-08-27 00:46:01 -07001047 Type::Ref(ty) => {
1048 let mutability = ty.mutability;
1049 match &ty.inner {
Adrian Taylorc8713432020-10-21 18:20:55 -07001050 Type::Ident(ident) if ident.rust == RustString => {
David Tolnayf1c7f322020-08-27 00:46:01 -07001051 quote!(&#mutability ::cxx::private::RustString)
1052 }
1053 Type::RustVec(ty) => {
David Tolnay2f090422020-11-02 18:25:35 -08001054 let inner = expand_extern_type(&ty.inner, types, proper);
David Tolnayf1c7f322020-08-27 00:46:01 -07001055 quote!(&#mutability ::cxx::private::RustVec<#inner>)
1056 }
David Tolnay2f090422020-11-02 18:25:35 -08001057 inner if proper && types.is_considered_improper_ctype(inner) => match mutability {
David Tolnay4cb97672020-11-02 16:13:34 -08001058 None => quote!(*const ::std::ffi::c_void),
1059 Some(_) => quote!(*#mutability ::std::ffi::c_void),
1060 },
David Tolnayf1c7f322020-08-27 00:46:01 -07001061 _ => quote!(#ty),
Myron Ahneba35cf2020-02-05 19:41:51 +07001062 }
David Tolnayf1c7f322020-08-27 00:46:01 -07001063 }
David Tolnay7db73692019-10-20 14:51:12 -04001064 Type::Str(_) => quote!(::cxx::private::RustStr),
Adrian Taylorf5dd5522020-04-13 16:50:14 -07001065 Type::SliceRefU8(_) => quote!(::cxx::private::RustSliceU8),
David Tolnay7db73692019-10-20 14:51:12 -04001066 _ => quote!(#ty),
1067 }
1068}
1069
David Tolnay2f090422020-11-02 18:25:35 -08001070fn expand_extern_return_type(ret: &Option<Type>, types: &Types, proper: bool) -> TokenStream {
David Tolnay7db73692019-10-20 14:51:12 -04001071 let ret = match ret {
1072 Some(ret) if !types.needs_indirect_abi(ret) => ret,
1073 _ => return TokenStream::new(),
1074 };
David Tolnay2f090422020-11-02 18:25:35 -08001075 let ty = expand_extern_type(ret, types, proper);
David Tolnay7db73692019-10-20 14:51:12 -04001076 quote!(-> #ty)
1077}