blob: c6d64804d1c121b947b499eac788b51974c571c3 [file] [log] [blame]
David Tolnay17e137f2020-05-08 15:55:28 -07001use crate::syntax::discriminant::DiscriminantSet;
David Tolnayc598a272020-08-29 15:10:18 -07002use crate::syntax::file::{Item, ItemForeignMod};
David Tolnay52759782020-05-03 23:59:40 -07003use crate::syntax::report::Errors;
David Tolnayeebe9b72020-04-14 16:32:18 -07004use crate::syntax::Atom::*;
David Tolnay7db73692019-10-20 14:51:12 -04005use crate::syntax::{
Adrian Taylor0f8ab222020-10-29 21:31:56 -07006 attrs, error, Api, Doc, Enum, ExternFn, ExternType, Impl, Include, IncludeKind, Lang,
David Tolnayd60c07b2020-10-29 13:18:49 -07007 Namespace, Pair, Receiver, Ref, ResolvableName, Signature, Slice, Struct, Ty1, Type, TypeAlias,
8 Var, Variant,
David Tolnay7db73692019-10-20 14:51:12 -04009};
David Tolnay9a69d8a2020-11-16 09:16:41 -080010use proc_macro2::{Delimiter, Group, Span, TokenStream, TokenTree};
David Tolnaye2e303f2020-05-10 20:52:00 -070011use quote::{format_ident, quote, quote_spanned};
David Tolnaye2f9ec42020-05-07 16:19:33 -070012use syn::parse::{ParseStream, Parser};
David Tolnaye3a48152020-04-08 19:38:05 -070013use syn::punctuated::Punctuated;
David Tolnay7db73692019-10-20 14:51:12 -040014use syn::{
David Tolnay17e137f2020-05-08 15:55:28 -070015 Abi, Attribute, Error, Fields, FnArg, ForeignItem, ForeignItemFn, ForeignItemType,
David Tolnay9938b642020-11-15 18:11:40 -080016 GenericArgument, GenericParam, Generics, Ident, ItemEnum, ItemImpl, ItemStruct, LitStr, Pat,
17 PathArguments, Result, ReturnType, Token, Type as RustType, TypeBareFn, TypePath,
18 TypeReference, TypeSlice,
David Tolnay7db73692019-10-20 14:51:12 -040019};
20
David Tolnaye3a48152020-04-08 19:38:05 -070021pub mod kw {
David Tolnayb27f7872020-11-15 15:07:04 -080022 syn::custom_keyword!(Pin);
David Tolnaye3a48152020-04-08 19:38:05 -070023 syn::custom_keyword!(Result);
24}
25
David Tolnayd7a3a182020-11-01 20:45:14 -080026pub fn parse_items(
27 cx: &mut Errors,
28 items: Vec<Item>,
29 trusted: bool,
30 namespace: &Namespace,
31) -> Vec<Api> {
David Tolnay7db73692019-10-20 14:51:12 -040032 let mut apis = Vec::new();
33 for item in items {
34 match item {
David Tolnay302b1752020-11-10 18:43:24 -080035 Item::Struct(item) => match parse_struct(cx, item, namespace) {
David Tolnay52759782020-05-03 23:59:40 -070036 Ok(strct) => apis.push(strct),
37 Err(err) => cx.push(err),
38 },
David Tolnay302b1752020-11-10 18:43:24 -080039 Item::Enum(item) => match parse_enum(cx, item, namespace) {
David Tolnay52759782020-05-03 23:59:40 -070040 Ok(enm) => apis.push(enm),
41 Err(err) => cx.push(err),
42 },
Adrian Taylorc8713432020-10-21 18:20:55 -070043 Item::ForeignMod(foreign_mod) => {
David Tolnayd7a3a182020-11-01 20:45:14 -080044 parse_foreign_mod(cx, foreign_mod, &mut apis, trusted, namespace)
Adrian Taylorc8713432020-10-21 18:20:55 -070045 }
David Tolnayd7a3a182020-11-01 20:45:14 -080046 Item::Impl(item) => match parse_impl(item, namespace) {
David Tolnay7e69f892020-10-03 22:20:22 -070047 Ok(imp) => apis.push(imp),
48 Err(err) => cx.push(err),
49 },
David Tolnay52759782020-05-03 23:59:40 -070050 Item::Use(item) => cx.error(item, error::USE_NOT_ALLOWED),
David Tolnay00a83852020-08-29 15:06:16 -070051 Item::Other(item) => cx.error(item, "unsupported item"),
David Tolnay7db73692019-10-20 14:51:12 -040052 }
53 }
David Tolnay52759782020-05-03 23:59:40 -070054 apis
David Tolnay7db73692019-10-20 14:51:12 -040055}
56
David Tolnay302b1752020-11-10 18:43:24 -080057fn parse_struct(cx: &mut Errors, item: ItemStruct, namespace: &Namespace) -> Result<Api> {
David Tolnay7db73692019-10-20 14:51:12 -040058 let generics = &item.generics;
59 if !generics.params.is_empty() || generics.where_clause.is_some() {
60 let struct_token = item.struct_token;
61 let ident = &item.ident;
62 let where_clause = &generics.where_clause;
63 let span = quote!(#struct_token #ident #generics #where_clause);
64 return Err(Error::new_spanned(
65 span,
66 "struct with generic parameters is not supported yet",
67 ));
68 }
69
70 let mut doc = Doc::new();
71 let mut derives = Vec::new();
David Tolnay302b1752020-11-10 18:43:24 -080072 let mut namespace = namespace.clone();
David Tolnayb129ea72020-05-10 14:29:30 -070073 attrs::parse(
David Tolnay3e628882020-05-10 15:30:14 -070074 cx,
David Tolnayb129ea72020-05-10 14:29:30 -070075 &item.attrs,
76 attrs::Parser {
77 doc: Some(&mut doc),
78 derives: Some(&mut derives),
David Tolnayd7a3a182020-11-01 20:45:14 -080079 namespace: Some(&mut namespace),
David Tolnayddf69e22020-05-10 22:08:20 -070080 ..Default::default()
David Tolnayb129ea72020-05-10 14:29:30 -070081 },
David Tolnay3e628882020-05-10 15:30:14 -070082 );
David Tolnay09462ac2020-03-20 14:58:41 -070083
David Tolnay302b1752020-11-10 18:43:24 -080084 let named_fields = match item.fields {
David Tolnay09462ac2020-03-20 14:58:41 -070085 Fields::Named(fields) => fields,
86 Fields::Unit => return Err(Error::new_spanned(item, "unit structs are not supported")),
87 Fields::Unnamed(_) => {
David Tolnay2c4b35f2020-10-04 21:22:30 -070088 return Err(Error::new_spanned(item, "tuple structs are not supported"));
David Tolnay09462ac2020-03-20 14:58:41 -070089 }
90 };
91
David Tolnay302b1752020-11-10 18:43:24 -080092 let fields = named_fields
93 .named
94 .into_iter()
95 .map(|field| {
96 Ok(Var {
97 ident: field.ident.unwrap(),
98 ty: parse_type(&field.ty, &namespace)?,
99 })
100 })
101 .collect::<Result<_>>()?;
102
David Tolnay09462ac2020-03-20 14:58:41 -0700103 Ok(Api::Struct(Struct {
104 doc,
105 derives,
106 struct_token: item.struct_token,
David Tolnay302b1752020-11-10 18:43:24 -0800107 name: Pair::new(namespace, item.ident),
108 brace_token: named_fields.brace_token,
109 fields,
David Tolnay09462ac2020-03-20 14:58:41 -0700110 }))
David Tolnay7db73692019-10-20 14:51:12 -0400111}
112
David Tolnay302b1752020-11-10 18:43:24 -0800113fn parse_enum(cx: &mut Errors, item: ItemEnum, namespace: &Namespace) -> Result<Api> {
Joel Galensonc03402a2020-04-23 17:31:09 -0700114 let generics = &item.generics;
115 if !generics.params.is_empty() || generics.where_clause.is_some() {
116 let enum_token = item.enum_token;
117 let ident = &item.ident;
118 let where_clause = &generics.where_clause;
119 let span = quote!(#enum_token #ident #generics #where_clause);
120 return Err(Error::new_spanned(
121 span,
122 "enums with generic parameters are not allowed",
123 ));
124 }
125
David Tolnayddf69e22020-05-10 22:08:20 -0700126 let mut doc = Doc::new();
127 let mut repr = None;
David Tolnay302b1752020-11-10 18:43:24 -0800128 let mut namespace = namespace.clone();
David Tolnayddf69e22020-05-10 22:08:20 -0700129 attrs::parse(
130 cx,
131 &item.attrs,
132 attrs::Parser {
133 doc: Some(&mut doc),
134 repr: Some(&mut repr),
David Tolnayd7a3a182020-11-01 20:45:14 -0800135 namespace: Some(&mut namespace),
David Tolnayddf69e22020-05-10 22:08:20 -0700136 ..Default::default()
137 },
138 );
Joel Galensonc03402a2020-04-23 17:31:09 -0700139
Joel Galenson88547732020-05-05 08:23:42 -0700140 let mut variants = Vec::new();
David Tolnayddf69e22020-05-10 22:08:20 -0700141 let mut discriminants = DiscriminantSet::new(repr);
Joel Galenson88547732020-05-05 08:23:42 -0700142 for variant in item.variants {
143 match variant.fields {
Joel Galensonc03402a2020-04-23 17:31:09 -0700144 Fields::Unit => {}
145 _ => {
David Tolnay0435a812020-05-10 21:58:15 -0700146 cx.error(variant, "enums with data are not supported yet");
147 break;
Joel Galensonc03402a2020-04-23 17:31:09 -0700148 }
149 }
David Tolnay17e137f2020-05-08 15:55:28 -0700150 let expr = variant.discriminant.as_ref().map(|(_, expr)| expr);
151 let try_discriminant = match &expr {
152 Some(lit) => discriminants.insert(lit),
153 None => discriminants.insert_next(),
154 };
155 let discriminant = match try_discriminant {
156 Ok(discriminant) => discriminant,
David Tolnay0435a812020-05-10 21:58:15 -0700157 Err(err) => {
158 cx.error(variant, err);
159 break;
160 }
David Tolnay17e137f2020-05-08 15:55:28 -0700161 };
David Tolnay2b8bf6d2020-05-10 17:37:16 -0700162 let expr = variant.discriminant.map(|(_, expr)| expr);
Joel Galenson88547732020-05-05 08:23:42 -0700163 variants.push(Variant {
164 ident: variant.ident,
David Tolnay7ae018f2020-05-05 10:11:30 -0700165 discriminant,
David Tolnay2b8bf6d2020-05-10 17:37:16 -0700166 expr,
Joel Galenson88547732020-05-05 08:23:42 -0700167 });
Joel Galensonc03402a2020-04-23 17:31:09 -0700168 }
169
David Tolnaye2e303f2020-05-10 20:52:00 -0700170 let enum_token = item.enum_token;
171 let brace_token = item.brace_token;
172
David Tolnay58eee392020-11-20 20:37:58 -0800173 let explicit_repr = repr.is_some();
David Tolnay0435a812020-05-10 21:58:15 -0700174 let mut repr = U8;
175 match discriminants.inferred_repr() {
176 Ok(inferred) => repr = inferred,
David Tolnaye2e303f2020-05-10 20:52:00 -0700177 Err(err) => {
178 let span = quote_spanned!(brace_token.span=> #enum_token {});
David Tolnay0435a812020-05-10 21:58:15 -0700179 cx.error(span, err);
180 variants.clear();
David Tolnaye2e303f2020-05-10 20:52:00 -0700181 }
David Tolnay0435a812020-05-10 21:58:15 -0700182 }
David Tolnaye2e303f2020-05-10 20:52:00 -0700183
David Tolnay9a69d8a2020-11-16 09:16:41 -0800184 let ident = Ident::new(repr.as_ref(), Span::call_site());
185 let repr_type = Type::Ident(ResolvableName::new(ident));
186
Joel Galensonc03402a2020-04-23 17:31:09 -0700187 Ok(Api::Enum(Enum {
188 doc,
David Tolnaye2e303f2020-05-10 20:52:00 -0700189 enum_token,
David Tolnay17a934c2020-11-02 00:40:04 -0800190 name: Pair::new(namespace, item.ident),
David Tolnaye2e303f2020-05-10 20:52:00 -0700191 brace_token,
David Tolnay7ae018f2020-05-05 10:11:30 -0700192 variants,
David Tolnaye2e303f2020-05-10 20:52:00 -0700193 repr,
David Tolnay9a69d8a2020-11-16 09:16:41 -0800194 repr_type,
David Tolnay58eee392020-11-20 20:37:58 -0800195 explicit_repr,
Joel Galensonc03402a2020-04-23 17:31:09 -0700196 }))
197}
198
David Tolnay805dca32020-08-29 19:09:55 -0700199fn parse_foreign_mod(
200 cx: &mut Errors,
201 foreign_mod: ItemForeignMod,
202 out: &mut Vec<Api>,
203 trusted: bool,
David Tolnayd7a3a182020-11-01 20:45:14 -0800204 namespace: &Namespace,
David Tolnay805dca32020-08-29 19:09:55 -0700205) {
David Tolnay3a451732020-08-29 18:54:55 -0700206 let lang = match parse_lang(&foreign_mod.abi) {
David Tolnay52759782020-05-03 23:59:40 -0700207 Ok(lang) => lang,
208 Err(err) => return cx.push(err),
209 };
David Tolnay7db73692019-10-20 14:51:12 -0400210
David Tolnay3a451732020-08-29 18:54:55 -0700211 match lang {
212 Lang::Rust => {
David Tolnay805dca32020-08-29 19:09:55 -0700213 if foreign_mod.unsafety.is_some() {
David Tolnay3a451732020-08-29 18:54:55 -0700214 let unsafety = foreign_mod.unsafety;
David Tolnay7be5b1f2020-11-11 10:48:32 -0800215 let abi = &foreign_mod.abi;
David Tolnay3a451732020-08-29 18:54:55 -0700216 let span = quote!(#unsafety #abi);
217 cx.error(span, "extern \"Rust\" block does not need to be unsafe");
218 }
219 }
220 Lang::Cxx => {}
221 }
222
David Tolnay805dca32020-08-29 19:09:55 -0700223 let trusted = trusted || foreign_mod.unsafety.is_some();
224
David Tolnay7feb2642020-11-10 18:49:04 -0800225 let mut namespace = namespace.clone();
226 attrs::parse(
227 cx,
228 &foreign_mod.attrs,
229 attrs::Parser {
230 namespace: Some(&mut namespace),
231 ..Default::default()
232 },
233 );
234
Joel Galensone1e969d2020-04-21 12:50:20 -0700235 let mut items = Vec::new();
236 for foreign in &foreign_mod.items {
237 match foreign {
Adrian Taylorc8713432020-10-21 18:20:55 -0700238 ForeignItem::Type(foreign) => {
David Tolnay7feb2642020-11-10 18:49:04 -0800239 match parse_extern_type(cx, foreign, lang, trusted, &namespace) {
Adrian Taylorc8713432020-10-21 18:20:55 -0700240 Ok(ety) => items.push(ety),
241 Err(err) => cx.push(err),
242 }
243 }
David Tolnay556738d2020-11-15 13:58:44 -0800244 ForeignItem::Fn(foreign) => {
245 match parse_extern_fn(cx, foreign, lang, trusted, &namespace) {
246 Ok(efn) => items.push(efn),
247 Err(err) => cx.push(err),
248 }
249 }
David Tolnay7db73692019-10-20 14:51:12 -0400250 ForeignItem::Macro(foreign) if foreign.mac.path.is_ident("include") => {
David Tolnay91e87fa2020-05-11 19:10:23 -0700251 match foreign.mac.parse_body_with(parse_include) {
David Tolnay52759782020-05-03 23:59:40 -0700252 Ok(include) => items.push(Api::Include(include)),
253 Err(err) => cx.push(err),
254 }
David Tolnay7db73692019-10-20 14:51:12 -0400255 }
Adrian Taylorc8713432020-10-21 18:20:55 -0700256 ForeignItem::Verbatim(tokens) => {
David Tolnay7feb2642020-11-10 18:49:04 -0800257 match parse_extern_verbatim(cx, tokens, lang, &namespace) {
Adrian Taylorc8713432020-10-21 18:20:55 -0700258 Ok(api) => items.push(api),
259 Err(err) => cx.push(err),
260 }
261 }
David Tolnay52759782020-05-03 23:59:40 -0700262 _ => cx.error(foreign, "unsupported foreign item"),
David Tolnay7db73692019-10-20 14:51:12 -0400263 }
264 }
David Tolnaya1f29c42020-04-22 18:01:38 -0700265
David Tolnay7be5b1f2020-11-11 10:48:32 -0800266 if !trusted
267 && items.iter().any(|api| match api {
268 Api::CxxFunction(efn) => efn.unsafety.is_none(),
269 _ => false,
270 })
271 {
272 cx.error(
273 foreign_mod.abi,
274 "block must be declared `unsafe extern \"C++\"` if it contains any safe-to-call C++ functions",
275 );
276 }
277
David Tolnaya1f29c42020-04-22 18:01:38 -0700278 let mut types = items.iter().filter_map(|item| match item {
David Tolnay17a934c2020-11-02 00:40:04 -0800279 Api::CxxType(ety) | Api::RustType(ety) => Some(&ety.name),
280 Api::TypeAlias(alias) => Some(&alias.name),
David Tolnaya1f29c42020-04-22 18:01:38 -0700281 _ => None,
282 });
283 if let (Some(single_type), None) = (types.next(), types.next()) {
David Tolnaye5a015a2020-05-07 21:54:26 -0700284 let single_type = single_type.clone();
David Tolnaya1f29c42020-04-22 18:01:38 -0700285 for item in &mut items {
286 if let Api::CxxFunction(efn) | Api::RustFunction(efn) = item {
287 if let Some(receiver) = &mut efn.receiver {
Adrian Taylorc8713432020-10-21 18:20:55 -0700288 if receiver.ty.is_self() {
Adrian Taylor565ddf02020-10-29 21:12:36 -0700289 receiver.ty = ResolvableName::new(single_type.rust.clone());
David Tolnaya1f29c42020-04-22 18:01:38 -0700290 }
291 }
292 }
293 }
294 }
295
David Tolnay52759782020-05-03 23:59:40 -0700296 out.extend(items);
David Tolnay7db73692019-10-20 14:51:12 -0400297}
298
David Tolnay3a451732020-08-29 18:54:55 -0700299fn parse_lang(abi: &Abi) -> Result<Lang> {
David Tolnay7db73692019-10-20 14:51:12 -0400300 let name = match &abi.name {
301 Some(name) => name,
302 None => {
303 return Err(Error::new_spanned(
304 abi,
David Tolnayc72a9f62020-11-11 10:56:26 -0800305 "ABI name is required, extern \"C++\" or extern \"Rust\"",
David Tolnay7db73692019-10-20 14:51:12 -0400306 ));
307 }
308 };
309 match name.value().as_str() {
David Tolnayea25ac82020-11-11 10:35:23 -0800310 "C++" => Ok(Lang::Cxx),
David Tolnay7db73692019-10-20 14:51:12 -0400311 "Rust" => Ok(Lang::Rust),
David Tolnay2757ca82020-11-14 15:12:06 -0800312 _ => Err(Error::new_spanned(
313 abi,
314 "unrecognized ABI, requires either \"C++\" or \"Rust\"",
315 )),
David Tolnay7db73692019-10-20 14:51:12 -0400316 }
317}
318
David Tolnay00f236a2020-08-29 19:07:18 -0700319fn parse_extern_type(
320 cx: &mut Errors,
321 foreign_type: &ForeignItemType,
322 lang: Lang,
323 trusted: bool,
David Tolnay302b1752020-11-10 18:43:24 -0800324 namespace: &Namespace,
David Tolnay00f236a2020-08-29 19:07:18 -0700325) -> Result<Api> {
Adrian Taylorc8713432020-10-21 18:20:55 -0700326 let mut doc = Doc::new();
David Tolnay302b1752020-11-10 18:43:24 -0800327 let mut namespace = namespace.clone();
Adrian Taylorc8713432020-10-21 18:20:55 -0700328 attrs::parse(
329 cx,
330 &foreign_type.attrs,
331 attrs::Parser {
332 doc: Some(&mut doc),
David Tolnayd7a3a182020-11-01 20:45:14 -0800333 namespace: Some(&mut namespace),
Adrian Taylorc8713432020-10-21 18:20:55 -0700334 ..Default::default()
335 },
336 );
David Tolnay7db73692019-10-20 14:51:12 -0400337 let type_token = foreign_type.type_token;
338 let ident = foreign_type.ident.clone();
David Tolnayc8361022020-08-25 21:57:53 -0700339 let semi_token = foreign_type.semi_token;
David Tolnay295ef6b2020-05-07 16:10:22 -0700340 let api_type = match lang {
341 Lang::Cxx => Api::CxxType,
342 Lang::Rust => Api::RustType,
343 };
344 Ok(api_type(ExternType {
David Tolnay7db73692019-10-20 14:51:12 -0400345 doc,
346 type_token,
David Tolnay17a934c2020-11-02 00:40:04 -0800347 name: Pair::new(namespace, ident),
David Tolnayc8361022020-08-25 21:57:53 -0700348 semi_token,
David Tolnay00f236a2020-08-29 19:07:18 -0700349 trusted,
David Tolnay295ef6b2020-05-07 16:10:22 -0700350 }))
David Tolnay7db73692019-10-20 14:51:12 -0400351}
352
Adrian Taylorc8713432020-10-21 18:20:55 -0700353fn parse_extern_fn(
354 cx: &mut Errors,
355 foreign_fn: &ForeignItemFn,
356 lang: Lang,
David Tolnay556738d2020-11-15 13:58:44 -0800357 trusted: bool,
David Tolnay302b1752020-11-10 18:43:24 -0800358 namespace: &Namespace,
Adrian Taylorc8713432020-10-21 18:20:55 -0700359) -> Result<Api> {
David Tolnay7db73692019-10-20 14:51:12 -0400360 let generics = &foreign_fn.sig.generics;
David Tolnay9938b642020-11-15 18:11:40 -0800361 if generics.where_clause.is_some()
362 || generics.params.iter().any(|param| match param {
363 GenericParam::Lifetime(lifetime) => !lifetime.bounds.is_empty(),
364 GenericParam::Type(_) | GenericParam::Const(_) => true,
365 })
366 {
David Tolnay7db73692019-10-20 14:51:12 -0400367 return Err(Error::new_spanned(
368 foreign_fn,
369 "extern function with generic parameters is not supported yet",
370 ));
371 }
372 if let Some(variadic) = &foreign_fn.sig.variadic {
373 return Err(Error::new_spanned(
374 variadic,
375 "variadic function is not supported yet",
376 ));
377 }
David Tolnay8de461f2020-11-19 13:46:14 -0800378 if foreign_fn.sig.asyncness.is_some() {
379 return Err(Error::new_spanned(
380 foreign_fn,
381 "async function is not directly supported yet, but see https://cxx.rs/async.html for a working approach",
382 ));
383 }
David Tolnay80ef0682020-11-19 13:56:07 -0800384 if foreign_fn.sig.constness.is_some() {
385 return Err(Error::new_spanned(
386 foreign_fn,
387 "const extern function is not supported",
388 ));
389 }
390 if let Some(abi) = &foreign_fn.sig.abi {
391 return Err(Error::new_spanned(
392 abi,
393 "explicit ABI on extern function is not supported",
394 ));
395 }
David Tolnay7db73692019-10-20 14:51:12 -0400396
David Tolnay938ca852020-10-09 19:25:08 -0700397 let mut doc = Doc::new();
398 let mut cxx_name = None;
399 let mut rust_name = None;
David Tolnay302b1752020-11-10 18:43:24 -0800400 let mut namespace = namespace.clone();
David Tolnay938ca852020-10-09 19:25:08 -0700401 attrs::parse(
402 cx,
403 &foreign_fn.attrs,
404 attrs::Parser {
405 doc: Some(&mut doc),
406 cxx_name: Some(&mut cxx_name),
407 rust_name: Some(&mut rust_name),
David Tolnayd7a3a182020-11-01 20:45:14 -0800408 namespace: Some(&mut namespace),
David Tolnay938ca852020-10-09 19:25:08 -0700409 ..Default::default()
410 },
411 );
412
David Tolnay7db73692019-10-20 14:51:12 -0400413 let mut receiver = None;
David Tolnaye3a48152020-04-08 19:38:05 -0700414 let mut args = Punctuated::new();
415 for arg in foreign_fn.sig.inputs.pairs() {
416 let (arg, comma) = arg.into_tuple();
David Tolnay7db73692019-10-20 14:51:12 -0400417 match arg {
David Tolnay1dd11a12020-04-22 12:31:48 -0700418 FnArg::Receiver(arg) => {
David Tolnaya1f29c42020-04-22 18:01:38 -0700419 if let Some((ampersand, lifetime)) = &arg.reference {
420 receiver = Some(Receiver {
David Tolnay9c76c392020-11-15 16:07:08 -0800421 pinned: false,
David Tolnaya1f29c42020-04-22 18:01:38 -0700422 ampersand: *ampersand,
423 lifetime: lifetime.clone(),
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800424 mutable: arg.mutability.is_some(),
David Tolnaya1f29c42020-04-22 18:01:38 -0700425 var: arg.self_token,
Adrian Taylorc8713432020-10-21 18:20:55 -0700426 ty: ResolvableName::make_self(arg.self_token.span),
David Tolnaya1f29c42020-04-22 18:01:38 -0700427 shorthand: true,
David Tolnay9c76c392020-11-15 16:07:08 -0800428 pin_tokens: None,
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800429 mutability: arg.mutability,
David Tolnaya1f29c42020-04-22 18:01:38 -0700430 });
431 continue;
Joel Galensone1e969d2020-04-21 12:50:20 -0700432 }
David Tolnay1dd11a12020-04-22 12:31:48 -0700433 return Err(Error::new_spanned(arg, "unsupported signature"));
David Tolnay7db73692019-10-20 14:51:12 -0400434 }
435 FnArg::Typed(arg) => {
436 let ident = match arg.pat.as_ref() {
437 Pat::Ident(pat) => pat.ident.clone(),
Joel Galensonba676072020-04-27 15:55:45 -0700438 Pat::Wild(pat) => {
439 Ident::new(&format!("_{}", args.len()), pat.underscore_token.span)
440 }
David Tolnay7db73692019-10-20 14:51:12 -0400441 _ => return Err(Error::new_spanned(arg, "unsupported signature")),
442 };
David Tolnayd7a3a182020-11-01 20:45:14 -0800443 let ty = parse_type(&arg.ty, &namespace)?;
David Tolnay7db73692019-10-20 14:51:12 -0400444 if ident != "self" {
David Tolnaye3a48152020-04-08 19:38:05 -0700445 args.push_value(Var { ident, ty });
446 if let Some(comma) = comma {
447 args.push_punct(*comma);
448 }
David Tolnay7db73692019-10-20 14:51:12 -0400449 continue;
450 }
451 if let Type::Ref(reference) = ty {
452 if let Type::Ident(ident) = reference.inner {
453 receiver = Some(Receiver {
David Tolnay9c76c392020-11-15 16:07:08 -0800454 pinned: reference.pinned,
David Tolnayfb6e3862020-04-20 01:33:23 -0700455 ampersand: reference.ampersand,
David Tolnay0bd50fa2020-04-22 15:31:33 -0700456 lifetime: reference.lifetime,
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800457 mutable: reference.mutable,
Adrian Taylorc8713432020-10-21 18:20:55 -0700458 var: Token![self](ident.rust.span()),
David Tolnay05e11cc2020-04-20 02:13:56 -0700459 ty: ident,
David Tolnay62d360c2020-04-22 16:26:21 -0700460 shorthand: false,
David Tolnay9c76c392020-11-15 16:07:08 -0800461 pin_tokens: reference.pin_tokens,
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800462 mutability: reference.mutability,
David Tolnay7db73692019-10-20 14:51:12 -0400463 });
464 continue;
465 }
466 }
467 return Err(Error::new_spanned(arg, "unsupported method receiver"));
468 }
469 }
470 }
David Tolnay59b7ede2020-03-16 00:30:23 -0700471
David Tolnaye3a48152020-04-08 19:38:05 -0700472 let mut throws_tokens = None;
David Tolnayd7a3a182020-11-01 20:45:14 -0800473 let ret = parse_return_type(&foreign_fn.sig.output, &mut throws_tokens, &namespace)?;
David Tolnaye3a48152020-04-08 19:38:05 -0700474 let throws = throws_tokens.is_some();
David Tolnaybdb576c2020-09-06 23:45:55 -0700475 let unsafety = foreign_fn.sig.unsafety;
David Tolnay7db73692019-10-20 14:51:12 -0400476 let fn_token = foreign_fn.sig.fn_token;
David Tolnay17a934c2020-11-02 00:40:04 -0800477 let name = Pair::new_from_differing_names(
David Tolnayd7a3a182020-11-01 20:45:14 -0800478 namespace,
Adrian Taylor0f8ab222020-10-29 21:31:56 -0700479 cxx_name.unwrap_or(foreign_fn.sig.ident.clone()),
480 rust_name.unwrap_or(foreign_fn.sig.ident.clone()),
481 );
David Tolnay9938b642020-11-15 18:11:40 -0800482 let generics = generics.clone();
David Tolnaye3a48152020-04-08 19:38:05 -0700483 let paren_token = foreign_fn.sig.paren_token;
David Tolnay7db73692019-10-20 14:51:12 -0400484 let semi_token = foreign_fn.semi_token;
David Tolnay295ef6b2020-05-07 16:10:22 -0700485 let api_function = match lang {
486 Lang::Cxx => Api::CxxFunction,
487 Lang::Rust => Api::RustFunction,
488 };
David Tolnayd95b1192020-03-18 20:07:46 -0700489
David Tolnay295ef6b2020-05-07 16:10:22 -0700490 Ok(api_function(ExternFn {
David Tolnay6cde49f2020-03-16 12:25:45 -0700491 lang,
David Tolnay7db73692019-10-20 14:51:12 -0400492 doc,
David Tolnay17a934c2020-11-02 00:40:04 -0800493 name,
David Tolnay16448732020-03-18 12:39:36 -0700494 sig: Signature {
David Tolnaybdb576c2020-09-06 23:45:55 -0700495 unsafety,
David Tolnay16448732020-03-18 12:39:36 -0700496 fn_token,
David Tolnay9938b642020-11-15 18:11:40 -0800497 generics,
David Tolnay16448732020-03-18 12:39:36 -0700498 receiver,
499 args,
500 ret,
501 throws,
David Tolnaye3a48152020-04-08 19:38:05 -0700502 paren_token,
503 throws_tokens,
David Tolnay16448732020-03-18 12:39:36 -0700504 },
David Tolnay7db73692019-10-20 14:51:12 -0400505 semi_token,
David Tolnay556738d2020-11-15 13:58:44 -0800506 trusted,
David Tolnay295ef6b2020-05-07 16:10:22 -0700507 }))
David Tolnay7db73692019-10-20 14:51:12 -0400508}
509
Adrian Taylorc8713432020-10-21 18:20:55 -0700510fn parse_extern_verbatim(
511 cx: &mut Errors,
512 tokens: &TokenStream,
513 lang: Lang,
David Tolnay302b1752020-11-10 18:43:24 -0800514 namespace: &Namespace,
Adrian Taylorc8713432020-10-21 18:20:55 -0700515) -> Result<Api> {
David Tolnaye2f9ec42020-05-07 16:19:33 -0700516 // type Alias = crate::path::to::Type;
David Tolnay3e628882020-05-10 15:30:14 -0700517 let parse = |input: ParseStream| -> Result<TypeAlias> {
David Tolnaye2f9ec42020-05-07 16:19:33 -0700518 let attrs = input.call(Attribute::parse_outer)?;
519 let type_token: Token![type] = match input.parse()? {
520 Some(type_token) => type_token,
521 None => {
522 let span = input.cursor().token_stream();
523 return Err(Error::new_spanned(span, "unsupported foreign item"));
524 }
525 };
526 let ident: Ident = input.parse()?;
527 let eq_token: Token![=] = input.parse()?;
528 let ty: RustType = input.parse()?;
529 let semi_token: Token![;] = input.parse()?;
Adrian Taylorc8713432020-10-21 18:20:55 -0700530 let mut doc = Doc::new();
David Tolnay302b1752020-11-10 18:43:24 -0800531 let mut namespace = namespace.clone();
Adrian Taylorc8713432020-10-21 18:20:55 -0700532 attrs::parse(
533 cx,
534 &attrs,
535 attrs::Parser {
536 doc: Some(&mut doc),
David Tolnayd7a3a182020-11-01 20:45:14 -0800537 namespace: Some(&mut namespace),
Adrian Taylorc8713432020-10-21 18:20:55 -0700538 ..Default::default()
539 },
540 );
David Tolnaye2f9ec42020-05-07 16:19:33 -0700541
542 Ok(TypeAlias {
Bryan Henry890083d2020-09-13 10:34:31 -0700543 doc,
David Tolnaye2f9ec42020-05-07 16:19:33 -0700544 type_token,
David Tolnay17a934c2020-11-02 00:40:04 -0800545 name: Pair::new(namespace, ident),
David Tolnaye2f9ec42020-05-07 16:19:33 -0700546 eq_token,
547 ty,
548 semi_token,
549 })
David Tolnay3e628882020-05-10 15:30:14 -0700550 };
David Tolnaye2f9ec42020-05-07 16:19:33 -0700551
552 let type_alias = parse.parse2(tokens.clone())?;
553 match lang {
554 Lang::Cxx => Ok(Api::TypeAlias(type_alias)),
555 Lang::Rust => {
556 let (type_token, semi_token) = (type_alias.type_token, type_alias.semi_token);
557 let span = quote!(#type_token #semi_token);
558 let msg = "type alias in extern \"Rust\" block is not supported";
559 Err(Error::new_spanned(span, msg))
560 }
561 }
562}
563
David Tolnayd7a3a182020-11-01 20:45:14 -0800564fn parse_impl(imp: ItemImpl, namespace: &Namespace) -> Result<Api> {
David Tolnay7e69f892020-10-03 22:20:22 -0700565 if !imp.items.is_empty() {
566 let mut span = Group::new(Delimiter::Brace, TokenStream::new());
567 span.set_span(imp.brace_token.span);
568 return Err(Error::new_spanned(span, "expected an empty impl block"));
569 }
570
571 let self_ty = &imp.self_ty;
572 if let Some((bang, path, for_token)) = &imp.trait_ {
573 let span = quote!(#bang #path #for_token #self_ty);
574 return Err(Error::new_spanned(
575 span,
576 "unexpected impl, expected something like `impl UniquePtr<T> {}`",
577 ));
578 }
579
580 let generics = &imp.generics;
581 if !generics.params.is_empty() || generics.where_clause.is_some() {
582 return Err(Error::new_spanned(
583 imp,
584 "generic parameters on an impl is not supported",
585 ));
586 }
587
588 Ok(Api::Impl(Impl {
589 impl_token: imp.impl_token,
David Tolnayd7a3a182020-11-01 20:45:14 -0800590 ty: parse_type(&self_ty, namespace)?,
David Tolnay7e69f892020-10-03 22:20:22 -0700591 brace_token: imp.brace_token,
592 }))
593}
594
David Tolnayb0cd3272020-10-27 21:32:54 -0700595fn parse_include(input: ParseStream) -> Result<Include> {
David Tolnay91e87fa2020-05-11 19:10:23 -0700596 if input.peek(LitStr) {
David Tolnayb0cd3272020-10-27 21:32:54 -0700597 let lit: LitStr = input.parse()?;
598 let span = lit.span();
599 return Ok(Include {
600 path: lit.value(),
601 kind: IncludeKind::Quoted,
602 begin_span: span,
603 end_span: span,
604 });
David Tolnay91e87fa2020-05-11 19:10:23 -0700605 }
606
607 if input.peek(Token![<]) {
608 let mut path = String::new();
David Tolnayb0cd3272020-10-27 21:32:54 -0700609
David Tolnay2cc2e3a2020-10-28 13:12:35 -0700610 let langle: Token![<] = input.parse()?;
David Tolnay91e87fa2020-05-11 19:10:23 -0700611 while !input.is_empty() && !input.peek(Token![>]) {
612 let token: TokenTree = input.parse()?;
613 match token {
614 TokenTree::Ident(token) => path += &token.to_string(),
615 TokenTree::Literal(token)
616 if token
617 .to_string()
618 .starts_with(|ch: char| ch.is_ascii_digit()) =>
619 {
620 path += &token.to_string();
621 }
622 TokenTree::Punct(token) => path.push(token.as_char()),
623 _ => return Err(Error::new(token.span(), "unexpected token in include path")),
624 }
625 }
David Tolnayb0cd3272020-10-27 21:32:54 -0700626 let rangle: Token![>] = input.parse()?;
David Tolnayb0cd3272020-10-27 21:32:54 -0700627
628 return Ok(Include {
629 path,
630 kind: IncludeKind::Bracketed,
David Tolnay2cc2e3a2020-10-28 13:12:35 -0700631 begin_span: langle.span,
632 end_span: rangle.span,
David Tolnayb0cd3272020-10-27 21:32:54 -0700633 });
David Tolnay91e87fa2020-05-11 19:10:23 -0700634 }
635
636 Err(input.error("expected \"quoted/path/to\" or <bracketed/path/to>"))
637}
638
David Tolnayd7a3a182020-11-01 20:45:14 -0800639fn parse_type(ty: &RustType, namespace: &Namespace) -> Result<Type> {
David Tolnay59b7ede2020-03-16 00:30:23 -0700640 match ty {
David Tolnayd7a3a182020-11-01 20:45:14 -0800641 RustType::Reference(ty) => parse_type_reference(ty, namespace),
642 RustType::Path(ty) => parse_type_path(ty, namespace),
643 RustType::Slice(ty) => parse_type_slice(ty, namespace),
644 RustType::BareFn(ty) => parse_type_fn(ty, namespace),
David Tolnayb40b9db2020-03-18 13:50:31 -0700645 RustType::Tuple(ty) if ty.elems.is_empty() => Ok(Type::Void(ty.paren_token.span)),
646 _ => Err(Error::new_spanned(ty, "unsupported type")),
647 }
648}
649
David Tolnayd7a3a182020-11-01 20:45:14 -0800650fn parse_type_reference(ty: &TypeReference, namespace: &Namespace) -> Result<Type> {
651 let inner = parse_type(&ty.elem, namespace)?;
David Tolnayb40b9db2020-03-18 13:50:31 -0700652 let which = match &inner {
Adrian Taylorc8713432020-10-21 18:20:55 -0700653 Type::Ident(ident) if ident.rust == "str" => {
David Tolnayb40b9db2020-03-18 13:50:31 -0700654 if ty.mutability.is_some() {
655 return Err(Error::new_spanned(ty, "unsupported type"));
656 } else {
657 Type::Str
David Tolnay7db73692019-10-20 14:51:12 -0400658 }
659 }
David Tolnayeebe9b72020-04-14 16:32:18 -0700660 Type::Slice(slice) => match &slice.inner {
David Tolnayc5629f02020-11-23 18:32:46 -0800661 Type::Ident(ident) if ident.rust == U8 => Type::SliceRefU8,
David Tolnayeebe9b72020-04-14 16:32:18 -0700662 _ => Type::Ref,
David Tolnayeb952ba2020-04-14 15:02:24 -0700663 },
David Tolnayb40b9db2020-03-18 13:50:31 -0700664 _ => Type::Ref,
665 };
666 Ok(which(Box::new(Ref {
David Tolnayb27f7872020-11-15 15:07:04 -0800667 pinned: false,
David Tolnayb40b9db2020-03-18 13:50:31 -0700668 ampersand: ty.and_token,
David Tolnay0bd50fa2020-04-22 15:31:33 -0700669 lifetime: ty.lifetime.clone(),
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800670 mutable: ty.mutability.is_some(),
David Tolnayb40b9db2020-03-18 13:50:31 -0700671 inner,
David Tolnayb27f7872020-11-15 15:07:04 -0800672 pin_tokens: None,
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800673 mutability: ty.mutability,
David Tolnayb40b9db2020-03-18 13:50:31 -0700674 })))
675}
676
David Tolnayd7a3a182020-11-01 20:45:14 -0800677fn parse_type_path(ty: &TypePath, namespace: &Namespace) -> Result<Type> {
David Tolnayb40b9db2020-03-18 13:50:31 -0700678 let path = &ty.path;
679 if ty.qself.is_none() && path.leading_colon.is_none() && path.segments.len() == 1 {
680 let segment = &path.segments[0];
681 let ident = segment.ident.clone();
682 match &segment.arguments {
David Tolnayda71ef62020-11-02 00:36:00 -0800683 PathArguments::None => return Ok(Type::Ident(ResolvableName::new(ident))),
David Tolnayb40b9db2020-03-18 13:50:31 -0700684 PathArguments::AngleBracketed(generic) => {
685 if ident == "UniquePtr" && generic.args.len() == 1 {
686 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnayd7a3a182020-11-01 20:45:14 -0800687 let inner = parse_type(arg, namespace)?;
David Tolnayb40b9db2020-03-18 13:50:31 -0700688 return Ok(Type::UniquePtr(Box::new(Ty1 {
David Tolnayda71ef62020-11-02 00:36:00 -0800689 name: ident,
David Tolnayb40b9db2020-03-18 13:50:31 -0700690 langle: generic.lt_token,
691 inner,
692 rangle: generic.gt_token,
693 })));
694 }
David Tolnaye1dcdf72020-04-24 17:40:55 -0700695 } else if ident == "CxxVector" && generic.args.len() == 1 {
Myron Ahneba35cf2020-02-05 19:41:51 +0700696 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnayd7a3a182020-11-01 20:45:14 -0800697 let inner = parse_type(arg, namespace)?;
David Tolnay4377a9e2020-04-24 15:20:26 -0700698 return Ok(Type::CxxVector(Box::new(Ty1 {
David Tolnayda71ef62020-11-02 00:36:00 -0800699 name: ident,
Myron Ahneba35cf2020-02-05 19:41:51 +0700700 langle: generic.lt_token,
701 inner,
702 rangle: generic.gt_token,
703 })));
704 }
David Tolnayb40b9db2020-03-18 13:50:31 -0700705 } else if ident == "Box" && generic.args.len() == 1 {
706 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnayd7a3a182020-11-01 20:45:14 -0800707 let inner = parse_type(arg, namespace)?;
David Tolnayb40b9db2020-03-18 13:50:31 -0700708 return Ok(Type::RustBox(Box::new(Ty1 {
David Tolnayda71ef62020-11-02 00:36:00 -0800709 name: ident,
David Tolnayb40b9db2020-03-18 13:50:31 -0700710 langle: generic.lt_token,
711 inner,
712 rangle: generic.gt_token,
713 })));
714 }
Myron Ahneba35cf2020-02-05 19:41:51 +0700715 } else if ident == "Vec" && generic.args.len() == 1 {
716 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnayd7a3a182020-11-01 20:45:14 -0800717 let inner = parse_type(arg, namespace)?;
Myron Ahneba35cf2020-02-05 19:41:51 +0700718 return Ok(Type::RustVec(Box::new(Ty1 {
David Tolnayda71ef62020-11-02 00:36:00 -0800719 name: ident,
Myron Ahneba35cf2020-02-05 19:41:51 +0700720 langle: generic.lt_token,
721 inner,
722 rangle: generic.gt_token,
723 })));
724 }
David Tolnaycbc2a4b2020-11-15 15:08:44 -0800725 } else if ident == "Pin" && generic.args.len() == 1 {
726 if let GenericArgument::Type(arg) = &generic.args[0] {
727 let inner = parse_type(arg, namespace)?;
David Tolnayc94035a2020-11-15 16:49:18 -0800728 let pin_token = kw::Pin(ident.span());
David Tolnaycbc2a4b2020-11-15 15:08:44 -0800729 if let Type::Ref(mut inner) = inner {
David Tolnaycbc2a4b2020-11-15 15:08:44 -0800730 inner.pinned = true;
731 inner.pin_tokens =
732 Some((pin_token, generic.lt_token, generic.gt_token));
733 return Ok(Type::Ref(inner));
734 }
735 }
David Tolnayb40b9db2020-03-18 13:50:31 -0700736 }
737 }
738 PathArguments::Parenthesized(_) => {}
David Tolnayfb134ed2020-03-15 23:17:48 -0700739 }
David Tolnay7db73692019-10-20 14:51:12 -0400740 }
741 Err(Error::new_spanned(ty, "unsupported type"))
742}
743
David Tolnayd7a3a182020-11-01 20:45:14 -0800744fn parse_type_slice(ty: &TypeSlice, namespace: &Namespace) -> Result<Type> {
745 let inner = parse_type(&ty.elem, namespace)?;
David Tolnayeebe9b72020-04-14 16:32:18 -0700746 Ok(Type::Slice(Box::new(Slice {
747 bracket: ty.bracket_token,
748 inner,
749 })))
750}
751
David Tolnayd7a3a182020-11-01 20:45:14 -0800752fn parse_type_fn(ty: &TypeBareFn, namespace: &Namespace) -> Result<Type> {
David Tolnayc071b892020-03-18 16:59:53 -0700753 if ty.lifetimes.is_some() {
754 return Err(Error::new_spanned(
755 ty,
756 "function pointer with lifetime parameters is not supported yet",
757 ));
758 }
759 if ty.variadic.is_some() {
760 return Err(Error::new_spanned(
761 ty,
762 "variadic function pointer is not supported yet",
763 ));
764 }
765 let args = ty
766 .inputs
767 .iter()
768 .enumerate()
769 .map(|(i, arg)| {
David Tolnayd7a3a182020-11-01 20:45:14 -0800770 let ty = parse_type(&arg.ty, namespace)?;
David Tolnayc071b892020-03-18 16:59:53 -0700771 let ident = match &arg.name {
772 Some(ident) => ident.0.clone(),
773 None => format_ident!("_{}", i),
774 };
775 Ok(Var { ident, ty })
776 })
777 .collect::<Result<_>>()?;
David Tolnaye3a48152020-04-08 19:38:05 -0700778 let mut throws_tokens = None;
David Tolnayd7a3a182020-11-01 20:45:14 -0800779 let ret = parse_return_type(&ty.output, &mut throws_tokens, namespace)?;
David Tolnaye3a48152020-04-08 19:38:05 -0700780 let throws = throws_tokens.is_some();
David Tolnayc071b892020-03-18 16:59:53 -0700781 Ok(Type::Fn(Box::new(Signature {
David Tolnaybdb576c2020-09-06 23:45:55 -0700782 unsafety: ty.unsafety,
David Tolnayc071b892020-03-18 16:59:53 -0700783 fn_token: ty.fn_token,
David Tolnay9938b642020-11-15 18:11:40 -0800784 generics: Generics::default(),
David Tolnayc071b892020-03-18 16:59:53 -0700785 receiver: None,
786 args,
787 ret,
788 throws,
David Tolnaye3a48152020-04-08 19:38:05 -0700789 paren_token: ty.paren_token,
790 throws_tokens,
David Tolnayc071b892020-03-18 16:59:53 -0700791 })))
792}
793
David Tolnaye3a48152020-04-08 19:38:05 -0700794fn parse_return_type(
795 ty: &ReturnType,
796 throws_tokens: &mut Option<(kw::Result, Token![<], Token![>])>,
David Tolnayd7a3a182020-11-01 20:45:14 -0800797 namespace: &Namespace,
David Tolnaye3a48152020-04-08 19:38:05 -0700798) -> Result<Option<Type>> {
David Tolnayc071b892020-03-18 16:59:53 -0700799 let mut ret = match ty {
800 ReturnType::Default => return Ok(None),
801 ReturnType::Type(_, ret) => ret.as_ref(),
802 };
803 if let RustType::Path(ty) = ret {
804 let path = &ty.path;
805 if ty.qself.is_none() && path.leading_colon.is_none() && path.segments.len() == 1 {
806 let segment = &path.segments[0];
807 let ident = segment.ident.clone();
808 if let PathArguments::AngleBracketed(generic) = &segment.arguments {
809 if ident == "Result" && generic.args.len() == 1 {
810 if let GenericArgument::Type(arg) = &generic.args[0] {
811 ret = arg;
David Tolnaye3a48152020-04-08 19:38:05 -0700812 *throws_tokens =
813 Some((kw::Result(ident.span()), generic.lt_token, generic.gt_token));
David Tolnayc071b892020-03-18 16:59:53 -0700814 }
815 }
816 }
817 }
818 }
David Tolnayd7a3a182020-11-01 20:45:14 -0800819 match parse_type(ret, namespace)? {
David Tolnayc071b892020-03-18 16:59:53 -0700820 Type::Void(_) => Ok(None),
821 ty => Ok(Some(ty)),
822 }
823}