blob: fcc44d294a98a05405254097119c89a704259a54 [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 Tolnay2cc2e3a2020-10-28 13:12:35 -070010use proc_macro2::{Delimiter, Group, 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 Tolnay0435a812020-05-10 21:58:15 -0700173 let mut repr = U8;
174 match discriminants.inferred_repr() {
175 Ok(inferred) => repr = inferred,
David Tolnaye2e303f2020-05-10 20:52:00 -0700176 Err(err) => {
177 let span = quote_spanned!(brace_token.span=> #enum_token {});
David Tolnay0435a812020-05-10 21:58:15 -0700178 cx.error(span, err);
179 variants.clear();
David Tolnaye2e303f2020-05-10 20:52:00 -0700180 }
David Tolnay0435a812020-05-10 21:58:15 -0700181 }
David Tolnaye2e303f2020-05-10 20:52:00 -0700182
Joel Galensonc03402a2020-04-23 17:31:09 -0700183 Ok(Api::Enum(Enum {
184 doc,
David Tolnaye2e303f2020-05-10 20:52:00 -0700185 enum_token,
David Tolnay17a934c2020-11-02 00:40:04 -0800186 name: Pair::new(namespace, item.ident),
David Tolnaye2e303f2020-05-10 20:52:00 -0700187 brace_token,
David Tolnay7ae018f2020-05-05 10:11:30 -0700188 variants,
David Tolnaye2e303f2020-05-10 20:52:00 -0700189 repr,
Joel Galensonc03402a2020-04-23 17:31:09 -0700190 }))
191}
192
David Tolnay805dca32020-08-29 19:09:55 -0700193fn parse_foreign_mod(
194 cx: &mut Errors,
195 foreign_mod: ItemForeignMod,
196 out: &mut Vec<Api>,
197 trusted: bool,
David Tolnayd7a3a182020-11-01 20:45:14 -0800198 namespace: &Namespace,
David Tolnay805dca32020-08-29 19:09:55 -0700199) {
David Tolnay3a451732020-08-29 18:54:55 -0700200 let lang = match parse_lang(&foreign_mod.abi) {
David Tolnay52759782020-05-03 23:59:40 -0700201 Ok(lang) => lang,
202 Err(err) => return cx.push(err),
203 };
David Tolnay7db73692019-10-20 14:51:12 -0400204
David Tolnay3a451732020-08-29 18:54:55 -0700205 match lang {
206 Lang::Rust => {
David Tolnay805dca32020-08-29 19:09:55 -0700207 if foreign_mod.unsafety.is_some() {
David Tolnay3a451732020-08-29 18:54:55 -0700208 let unsafety = foreign_mod.unsafety;
David Tolnay7be5b1f2020-11-11 10:48:32 -0800209 let abi = &foreign_mod.abi;
David Tolnay3a451732020-08-29 18:54:55 -0700210 let span = quote!(#unsafety #abi);
211 cx.error(span, "extern \"Rust\" block does not need to be unsafe");
212 }
213 }
214 Lang::Cxx => {}
215 }
216
David Tolnay805dca32020-08-29 19:09:55 -0700217 let trusted = trusted || foreign_mod.unsafety.is_some();
218
David Tolnay7feb2642020-11-10 18:49:04 -0800219 let mut namespace = namespace.clone();
220 attrs::parse(
221 cx,
222 &foreign_mod.attrs,
223 attrs::Parser {
224 namespace: Some(&mut namespace),
225 ..Default::default()
226 },
227 );
228
Joel Galensone1e969d2020-04-21 12:50:20 -0700229 let mut items = Vec::new();
230 for foreign in &foreign_mod.items {
231 match foreign {
Adrian Taylorc8713432020-10-21 18:20:55 -0700232 ForeignItem::Type(foreign) => {
David Tolnay7feb2642020-11-10 18:49:04 -0800233 match parse_extern_type(cx, foreign, lang, trusted, &namespace) {
Adrian Taylorc8713432020-10-21 18:20:55 -0700234 Ok(ety) => items.push(ety),
235 Err(err) => cx.push(err),
236 }
237 }
David Tolnay556738d2020-11-15 13:58:44 -0800238 ForeignItem::Fn(foreign) => {
239 match parse_extern_fn(cx, foreign, lang, trusted, &namespace) {
240 Ok(efn) => items.push(efn),
241 Err(err) => cx.push(err),
242 }
243 }
David Tolnay7db73692019-10-20 14:51:12 -0400244 ForeignItem::Macro(foreign) if foreign.mac.path.is_ident("include") => {
David Tolnay91e87fa2020-05-11 19:10:23 -0700245 match foreign.mac.parse_body_with(parse_include) {
David Tolnay52759782020-05-03 23:59:40 -0700246 Ok(include) => items.push(Api::Include(include)),
247 Err(err) => cx.push(err),
248 }
David Tolnay7db73692019-10-20 14:51:12 -0400249 }
Adrian Taylorc8713432020-10-21 18:20:55 -0700250 ForeignItem::Verbatim(tokens) => {
David Tolnay7feb2642020-11-10 18:49:04 -0800251 match parse_extern_verbatim(cx, tokens, lang, &namespace) {
Adrian Taylorc8713432020-10-21 18:20:55 -0700252 Ok(api) => items.push(api),
253 Err(err) => cx.push(err),
254 }
255 }
David Tolnay52759782020-05-03 23:59:40 -0700256 _ => cx.error(foreign, "unsupported foreign item"),
David Tolnay7db73692019-10-20 14:51:12 -0400257 }
258 }
David Tolnaya1f29c42020-04-22 18:01:38 -0700259
David Tolnay7be5b1f2020-11-11 10:48:32 -0800260 if !trusted
261 && items.iter().any(|api| match api {
262 Api::CxxFunction(efn) => efn.unsafety.is_none(),
263 _ => false,
264 })
265 {
266 cx.error(
267 foreign_mod.abi,
268 "block must be declared `unsafe extern \"C++\"` if it contains any safe-to-call C++ functions",
269 );
270 }
271
David Tolnaya1f29c42020-04-22 18:01:38 -0700272 let mut types = items.iter().filter_map(|item| match item {
David Tolnay17a934c2020-11-02 00:40:04 -0800273 Api::CxxType(ety) | Api::RustType(ety) => Some(&ety.name),
274 Api::TypeAlias(alias) => Some(&alias.name),
David Tolnaya1f29c42020-04-22 18:01:38 -0700275 _ => None,
276 });
277 if let (Some(single_type), None) = (types.next(), types.next()) {
David Tolnaye5a015a2020-05-07 21:54:26 -0700278 let single_type = single_type.clone();
David Tolnaya1f29c42020-04-22 18:01:38 -0700279 for item in &mut items {
280 if let Api::CxxFunction(efn) | Api::RustFunction(efn) = item {
281 if let Some(receiver) = &mut efn.receiver {
Adrian Taylorc8713432020-10-21 18:20:55 -0700282 if receiver.ty.is_self() {
Adrian Taylor565ddf02020-10-29 21:12:36 -0700283 receiver.ty = ResolvableName::new(single_type.rust.clone());
David Tolnaya1f29c42020-04-22 18:01:38 -0700284 }
285 }
286 }
287 }
288 }
289
David Tolnay52759782020-05-03 23:59:40 -0700290 out.extend(items);
David Tolnay7db73692019-10-20 14:51:12 -0400291}
292
David Tolnay3a451732020-08-29 18:54:55 -0700293fn parse_lang(abi: &Abi) -> Result<Lang> {
David Tolnay7db73692019-10-20 14:51:12 -0400294 let name = match &abi.name {
295 Some(name) => name,
296 None => {
297 return Err(Error::new_spanned(
298 abi,
David Tolnayc72a9f62020-11-11 10:56:26 -0800299 "ABI name is required, extern \"C++\" or extern \"Rust\"",
David Tolnay7db73692019-10-20 14:51:12 -0400300 ));
301 }
302 };
303 match name.value().as_str() {
David Tolnayea25ac82020-11-11 10:35:23 -0800304 "C++" => Ok(Lang::Cxx),
David Tolnay7db73692019-10-20 14:51:12 -0400305 "Rust" => Ok(Lang::Rust),
David Tolnay2757ca82020-11-14 15:12:06 -0800306 _ => Err(Error::new_spanned(
307 abi,
308 "unrecognized ABI, requires either \"C++\" or \"Rust\"",
309 )),
David Tolnay7db73692019-10-20 14:51:12 -0400310 }
311}
312
David Tolnay00f236a2020-08-29 19:07:18 -0700313fn parse_extern_type(
314 cx: &mut Errors,
315 foreign_type: &ForeignItemType,
316 lang: Lang,
317 trusted: bool,
David Tolnay302b1752020-11-10 18:43:24 -0800318 namespace: &Namespace,
David Tolnay00f236a2020-08-29 19:07:18 -0700319) -> Result<Api> {
Adrian Taylorc8713432020-10-21 18:20:55 -0700320 let mut doc = Doc::new();
David Tolnay302b1752020-11-10 18:43:24 -0800321 let mut namespace = namespace.clone();
Adrian Taylorc8713432020-10-21 18:20:55 -0700322 attrs::parse(
323 cx,
324 &foreign_type.attrs,
325 attrs::Parser {
326 doc: Some(&mut doc),
David Tolnayd7a3a182020-11-01 20:45:14 -0800327 namespace: Some(&mut namespace),
Adrian Taylorc8713432020-10-21 18:20:55 -0700328 ..Default::default()
329 },
330 );
David Tolnay7db73692019-10-20 14:51:12 -0400331 let type_token = foreign_type.type_token;
332 let ident = foreign_type.ident.clone();
David Tolnayc8361022020-08-25 21:57:53 -0700333 let semi_token = foreign_type.semi_token;
David Tolnay295ef6b2020-05-07 16:10:22 -0700334 let api_type = match lang {
335 Lang::Cxx => Api::CxxType,
336 Lang::Rust => Api::RustType,
337 };
338 Ok(api_type(ExternType {
David Tolnay7db73692019-10-20 14:51:12 -0400339 doc,
340 type_token,
David Tolnay17a934c2020-11-02 00:40:04 -0800341 name: Pair::new(namespace, ident),
David Tolnayc8361022020-08-25 21:57:53 -0700342 semi_token,
David Tolnay00f236a2020-08-29 19:07:18 -0700343 trusted,
David Tolnay295ef6b2020-05-07 16:10:22 -0700344 }))
David Tolnay7db73692019-10-20 14:51:12 -0400345}
346
Adrian Taylorc8713432020-10-21 18:20:55 -0700347fn parse_extern_fn(
348 cx: &mut Errors,
349 foreign_fn: &ForeignItemFn,
350 lang: Lang,
David Tolnay556738d2020-11-15 13:58:44 -0800351 trusted: bool,
David Tolnay302b1752020-11-10 18:43:24 -0800352 namespace: &Namespace,
Adrian Taylorc8713432020-10-21 18:20:55 -0700353) -> Result<Api> {
David Tolnay7db73692019-10-20 14:51:12 -0400354 let generics = &foreign_fn.sig.generics;
David Tolnay9938b642020-11-15 18:11:40 -0800355 if generics.where_clause.is_some()
356 || generics.params.iter().any(|param| match param {
357 GenericParam::Lifetime(lifetime) => !lifetime.bounds.is_empty(),
358 GenericParam::Type(_) | GenericParam::Const(_) => true,
359 })
360 {
David Tolnay7db73692019-10-20 14:51:12 -0400361 return Err(Error::new_spanned(
362 foreign_fn,
363 "extern function with generic parameters is not supported yet",
364 ));
365 }
366 if let Some(variadic) = &foreign_fn.sig.variadic {
367 return Err(Error::new_spanned(
368 variadic,
369 "variadic function is not supported yet",
370 ));
371 }
372
David Tolnay938ca852020-10-09 19:25:08 -0700373 let mut doc = Doc::new();
374 let mut cxx_name = None;
375 let mut rust_name = None;
David Tolnay302b1752020-11-10 18:43:24 -0800376 let mut namespace = namespace.clone();
David Tolnay938ca852020-10-09 19:25:08 -0700377 attrs::parse(
378 cx,
379 &foreign_fn.attrs,
380 attrs::Parser {
381 doc: Some(&mut doc),
382 cxx_name: Some(&mut cxx_name),
383 rust_name: Some(&mut rust_name),
David Tolnayd7a3a182020-11-01 20:45:14 -0800384 namespace: Some(&mut namespace),
David Tolnay938ca852020-10-09 19:25:08 -0700385 ..Default::default()
386 },
387 );
388
David Tolnay7db73692019-10-20 14:51:12 -0400389 let mut receiver = None;
David Tolnaye3a48152020-04-08 19:38:05 -0700390 let mut args = Punctuated::new();
391 for arg in foreign_fn.sig.inputs.pairs() {
392 let (arg, comma) = arg.into_tuple();
David Tolnay7db73692019-10-20 14:51:12 -0400393 match arg {
David Tolnay1dd11a12020-04-22 12:31:48 -0700394 FnArg::Receiver(arg) => {
David Tolnaya1f29c42020-04-22 18:01:38 -0700395 if let Some((ampersand, lifetime)) = &arg.reference {
396 receiver = Some(Receiver {
David Tolnay9c76c392020-11-15 16:07:08 -0800397 pinned: false,
David Tolnaya1f29c42020-04-22 18:01:38 -0700398 ampersand: *ampersand,
399 lifetime: lifetime.clone(),
400 mutability: arg.mutability,
401 var: arg.self_token,
Adrian Taylorc8713432020-10-21 18:20:55 -0700402 ty: ResolvableName::make_self(arg.self_token.span),
David Tolnaya1f29c42020-04-22 18:01:38 -0700403 shorthand: true,
David Tolnay9c76c392020-11-15 16:07:08 -0800404 pin_tokens: None,
David Tolnaya1f29c42020-04-22 18:01:38 -0700405 });
406 continue;
Joel Galensone1e969d2020-04-21 12:50:20 -0700407 }
David Tolnay1dd11a12020-04-22 12:31:48 -0700408 return Err(Error::new_spanned(arg, "unsupported signature"));
David Tolnay7db73692019-10-20 14:51:12 -0400409 }
410 FnArg::Typed(arg) => {
411 let ident = match arg.pat.as_ref() {
412 Pat::Ident(pat) => pat.ident.clone(),
Joel Galensonba676072020-04-27 15:55:45 -0700413 Pat::Wild(pat) => {
414 Ident::new(&format!("_{}", args.len()), pat.underscore_token.span)
415 }
David Tolnay7db73692019-10-20 14:51:12 -0400416 _ => return Err(Error::new_spanned(arg, "unsupported signature")),
417 };
David Tolnayd7a3a182020-11-01 20:45:14 -0800418 let ty = parse_type(&arg.ty, &namespace)?;
David Tolnay7db73692019-10-20 14:51:12 -0400419 if ident != "self" {
David Tolnaye3a48152020-04-08 19:38:05 -0700420 args.push_value(Var { ident, ty });
421 if let Some(comma) = comma {
422 args.push_punct(*comma);
423 }
David Tolnay7db73692019-10-20 14:51:12 -0400424 continue;
425 }
426 if let Type::Ref(reference) = ty {
427 if let Type::Ident(ident) = reference.inner {
428 receiver = Some(Receiver {
David Tolnay9c76c392020-11-15 16:07:08 -0800429 pinned: reference.pinned,
David Tolnayfb6e3862020-04-20 01:33:23 -0700430 ampersand: reference.ampersand,
David Tolnay0bd50fa2020-04-22 15:31:33 -0700431 lifetime: reference.lifetime,
David Tolnay7db73692019-10-20 14:51:12 -0400432 mutability: reference.mutability,
Adrian Taylorc8713432020-10-21 18:20:55 -0700433 var: Token![self](ident.rust.span()),
David Tolnay05e11cc2020-04-20 02:13:56 -0700434 ty: ident,
David Tolnay62d360c2020-04-22 16:26:21 -0700435 shorthand: false,
David Tolnay9c76c392020-11-15 16:07:08 -0800436 pin_tokens: reference.pin_tokens,
David Tolnay7db73692019-10-20 14:51:12 -0400437 });
438 continue;
439 }
440 }
441 return Err(Error::new_spanned(arg, "unsupported method receiver"));
442 }
443 }
444 }
David Tolnay59b7ede2020-03-16 00:30:23 -0700445
David Tolnaye3a48152020-04-08 19:38:05 -0700446 let mut throws_tokens = None;
David Tolnayd7a3a182020-11-01 20:45:14 -0800447 let ret = parse_return_type(&foreign_fn.sig.output, &mut throws_tokens, &namespace)?;
David Tolnaye3a48152020-04-08 19:38:05 -0700448 let throws = throws_tokens.is_some();
David Tolnaybdb576c2020-09-06 23:45:55 -0700449 let unsafety = foreign_fn.sig.unsafety;
David Tolnay7db73692019-10-20 14:51:12 -0400450 let fn_token = foreign_fn.sig.fn_token;
David Tolnay17a934c2020-11-02 00:40:04 -0800451 let name = Pair::new_from_differing_names(
David Tolnayd7a3a182020-11-01 20:45:14 -0800452 namespace,
Adrian Taylor0f8ab222020-10-29 21:31:56 -0700453 cxx_name.unwrap_or(foreign_fn.sig.ident.clone()),
454 rust_name.unwrap_or(foreign_fn.sig.ident.clone()),
455 );
David Tolnay9938b642020-11-15 18:11:40 -0800456 let generics = generics.clone();
David Tolnaye3a48152020-04-08 19:38:05 -0700457 let paren_token = foreign_fn.sig.paren_token;
David Tolnay7db73692019-10-20 14:51:12 -0400458 let semi_token = foreign_fn.semi_token;
David Tolnay295ef6b2020-05-07 16:10:22 -0700459 let api_function = match lang {
460 Lang::Cxx => Api::CxxFunction,
461 Lang::Rust => Api::RustFunction,
462 };
David Tolnayd95b1192020-03-18 20:07:46 -0700463
David Tolnay295ef6b2020-05-07 16:10:22 -0700464 Ok(api_function(ExternFn {
David Tolnay6cde49f2020-03-16 12:25:45 -0700465 lang,
David Tolnay7db73692019-10-20 14:51:12 -0400466 doc,
David Tolnay17a934c2020-11-02 00:40:04 -0800467 name,
David Tolnay16448732020-03-18 12:39:36 -0700468 sig: Signature {
David Tolnaybdb576c2020-09-06 23:45:55 -0700469 unsafety,
David Tolnay16448732020-03-18 12:39:36 -0700470 fn_token,
David Tolnay9938b642020-11-15 18:11:40 -0800471 generics,
David Tolnay16448732020-03-18 12:39:36 -0700472 receiver,
473 args,
474 ret,
475 throws,
David Tolnaye3a48152020-04-08 19:38:05 -0700476 paren_token,
477 throws_tokens,
David Tolnay16448732020-03-18 12:39:36 -0700478 },
David Tolnay7db73692019-10-20 14:51:12 -0400479 semi_token,
David Tolnay556738d2020-11-15 13:58:44 -0800480 trusted,
David Tolnay295ef6b2020-05-07 16:10:22 -0700481 }))
David Tolnay7db73692019-10-20 14:51:12 -0400482}
483
Adrian Taylorc8713432020-10-21 18:20:55 -0700484fn parse_extern_verbatim(
485 cx: &mut Errors,
486 tokens: &TokenStream,
487 lang: Lang,
David Tolnay302b1752020-11-10 18:43:24 -0800488 namespace: &Namespace,
Adrian Taylorc8713432020-10-21 18:20:55 -0700489) -> Result<Api> {
David Tolnaye2f9ec42020-05-07 16:19:33 -0700490 // type Alias = crate::path::to::Type;
David Tolnay3e628882020-05-10 15:30:14 -0700491 let parse = |input: ParseStream| -> Result<TypeAlias> {
David Tolnaye2f9ec42020-05-07 16:19:33 -0700492 let attrs = input.call(Attribute::parse_outer)?;
493 let type_token: Token![type] = match input.parse()? {
494 Some(type_token) => type_token,
495 None => {
496 let span = input.cursor().token_stream();
497 return Err(Error::new_spanned(span, "unsupported foreign item"));
498 }
499 };
500 let ident: Ident = input.parse()?;
501 let eq_token: Token![=] = input.parse()?;
502 let ty: RustType = input.parse()?;
503 let semi_token: Token![;] = input.parse()?;
Adrian Taylorc8713432020-10-21 18:20:55 -0700504 let mut doc = Doc::new();
David Tolnay302b1752020-11-10 18:43:24 -0800505 let mut namespace = namespace.clone();
Adrian Taylorc8713432020-10-21 18:20:55 -0700506 attrs::parse(
507 cx,
508 &attrs,
509 attrs::Parser {
510 doc: Some(&mut doc),
David Tolnayd7a3a182020-11-01 20:45:14 -0800511 namespace: Some(&mut namespace),
Adrian Taylorc8713432020-10-21 18:20:55 -0700512 ..Default::default()
513 },
514 );
David Tolnaye2f9ec42020-05-07 16:19:33 -0700515
516 Ok(TypeAlias {
Bryan Henry890083d2020-09-13 10:34:31 -0700517 doc,
David Tolnaye2f9ec42020-05-07 16:19:33 -0700518 type_token,
David Tolnay17a934c2020-11-02 00:40:04 -0800519 name: Pair::new(namespace, ident),
David Tolnaye2f9ec42020-05-07 16:19:33 -0700520 eq_token,
521 ty,
522 semi_token,
523 })
David Tolnay3e628882020-05-10 15:30:14 -0700524 };
David Tolnaye2f9ec42020-05-07 16:19:33 -0700525
526 let type_alias = parse.parse2(tokens.clone())?;
527 match lang {
528 Lang::Cxx => Ok(Api::TypeAlias(type_alias)),
529 Lang::Rust => {
530 let (type_token, semi_token) = (type_alias.type_token, type_alias.semi_token);
531 let span = quote!(#type_token #semi_token);
532 let msg = "type alias in extern \"Rust\" block is not supported";
533 Err(Error::new_spanned(span, msg))
534 }
535 }
536}
537
David Tolnayd7a3a182020-11-01 20:45:14 -0800538fn parse_impl(imp: ItemImpl, namespace: &Namespace) -> Result<Api> {
David Tolnay7e69f892020-10-03 22:20:22 -0700539 if !imp.items.is_empty() {
540 let mut span = Group::new(Delimiter::Brace, TokenStream::new());
541 span.set_span(imp.brace_token.span);
542 return Err(Error::new_spanned(span, "expected an empty impl block"));
543 }
544
545 let self_ty = &imp.self_ty;
546 if let Some((bang, path, for_token)) = &imp.trait_ {
547 let span = quote!(#bang #path #for_token #self_ty);
548 return Err(Error::new_spanned(
549 span,
550 "unexpected impl, expected something like `impl UniquePtr<T> {}`",
551 ));
552 }
553
554 let generics = &imp.generics;
555 if !generics.params.is_empty() || generics.where_clause.is_some() {
556 return Err(Error::new_spanned(
557 imp,
558 "generic parameters on an impl is not supported",
559 ));
560 }
561
562 Ok(Api::Impl(Impl {
563 impl_token: imp.impl_token,
David Tolnayd7a3a182020-11-01 20:45:14 -0800564 ty: parse_type(&self_ty, namespace)?,
David Tolnay7e69f892020-10-03 22:20:22 -0700565 brace_token: imp.brace_token,
566 }))
567}
568
David Tolnayb0cd3272020-10-27 21:32:54 -0700569fn parse_include(input: ParseStream) -> Result<Include> {
David Tolnay91e87fa2020-05-11 19:10:23 -0700570 if input.peek(LitStr) {
David Tolnayb0cd3272020-10-27 21:32:54 -0700571 let lit: LitStr = input.parse()?;
572 let span = lit.span();
573 return Ok(Include {
574 path: lit.value(),
575 kind: IncludeKind::Quoted,
576 begin_span: span,
577 end_span: span,
578 });
David Tolnay91e87fa2020-05-11 19:10:23 -0700579 }
580
581 if input.peek(Token![<]) {
582 let mut path = String::new();
David Tolnayb0cd3272020-10-27 21:32:54 -0700583
David Tolnay2cc2e3a2020-10-28 13:12:35 -0700584 let langle: Token![<] = input.parse()?;
David Tolnay91e87fa2020-05-11 19:10:23 -0700585 while !input.is_empty() && !input.peek(Token![>]) {
586 let token: TokenTree = input.parse()?;
587 match token {
588 TokenTree::Ident(token) => path += &token.to_string(),
589 TokenTree::Literal(token)
590 if token
591 .to_string()
592 .starts_with(|ch: char| ch.is_ascii_digit()) =>
593 {
594 path += &token.to_string();
595 }
596 TokenTree::Punct(token) => path.push(token.as_char()),
597 _ => return Err(Error::new(token.span(), "unexpected token in include path")),
598 }
599 }
David Tolnayb0cd3272020-10-27 21:32:54 -0700600 let rangle: Token![>] = input.parse()?;
David Tolnayb0cd3272020-10-27 21:32:54 -0700601
602 return Ok(Include {
603 path,
604 kind: IncludeKind::Bracketed,
David Tolnay2cc2e3a2020-10-28 13:12:35 -0700605 begin_span: langle.span,
606 end_span: rangle.span,
David Tolnayb0cd3272020-10-27 21:32:54 -0700607 });
David Tolnay91e87fa2020-05-11 19:10:23 -0700608 }
609
610 Err(input.error("expected \"quoted/path/to\" or <bracketed/path/to>"))
611}
612
David Tolnayd7a3a182020-11-01 20:45:14 -0800613fn parse_type(ty: &RustType, namespace: &Namespace) -> Result<Type> {
David Tolnay59b7ede2020-03-16 00:30:23 -0700614 match ty {
David Tolnayd7a3a182020-11-01 20:45:14 -0800615 RustType::Reference(ty) => parse_type_reference(ty, namespace),
616 RustType::Path(ty) => parse_type_path(ty, namespace),
617 RustType::Slice(ty) => parse_type_slice(ty, namespace),
618 RustType::BareFn(ty) => parse_type_fn(ty, namespace),
David Tolnayb40b9db2020-03-18 13:50:31 -0700619 RustType::Tuple(ty) if ty.elems.is_empty() => Ok(Type::Void(ty.paren_token.span)),
620 _ => Err(Error::new_spanned(ty, "unsupported type")),
621 }
622}
623
David Tolnayd7a3a182020-11-01 20:45:14 -0800624fn parse_type_reference(ty: &TypeReference, namespace: &Namespace) -> Result<Type> {
625 let inner = parse_type(&ty.elem, namespace)?;
David Tolnayb40b9db2020-03-18 13:50:31 -0700626 let which = match &inner {
Adrian Taylorc8713432020-10-21 18:20:55 -0700627 Type::Ident(ident) if ident.rust == "str" => {
David Tolnayb40b9db2020-03-18 13:50:31 -0700628 if ty.mutability.is_some() {
629 return Err(Error::new_spanned(ty, "unsupported type"));
630 } else {
631 Type::Str
David Tolnay7db73692019-10-20 14:51:12 -0400632 }
633 }
David Tolnayeebe9b72020-04-14 16:32:18 -0700634 Type::Slice(slice) => match &slice.inner {
Adrian Taylorc8713432020-10-21 18:20:55 -0700635 Type::Ident(ident) if ident.rust == U8 && ty.mutability.is_none() => Type::SliceRefU8,
David Tolnayeebe9b72020-04-14 16:32:18 -0700636 _ => Type::Ref,
David Tolnayeb952ba2020-04-14 15:02:24 -0700637 },
David Tolnayb40b9db2020-03-18 13:50:31 -0700638 _ => Type::Ref,
639 };
640 Ok(which(Box::new(Ref {
David Tolnayb27f7872020-11-15 15:07:04 -0800641 pinned: false,
David Tolnayb40b9db2020-03-18 13:50:31 -0700642 ampersand: ty.and_token,
David Tolnay0bd50fa2020-04-22 15:31:33 -0700643 lifetime: ty.lifetime.clone(),
David Tolnayb40b9db2020-03-18 13:50:31 -0700644 mutability: ty.mutability,
645 inner,
David Tolnayb27f7872020-11-15 15:07:04 -0800646 pin_tokens: None,
David Tolnayb40b9db2020-03-18 13:50:31 -0700647 })))
648}
649
David Tolnayd7a3a182020-11-01 20:45:14 -0800650fn parse_type_path(ty: &TypePath, namespace: &Namespace) -> Result<Type> {
David Tolnayb40b9db2020-03-18 13:50:31 -0700651 let path = &ty.path;
652 if ty.qself.is_none() && path.leading_colon.is_none() && path.segments.len() == 1 {
653 let segment = &path.segments[0];
654 let ident = segment.ident.clone();
655 match &segment.arguments {
David Tolnayda71ef62020-11-02 00:36:00 -0800656 PathArguments::None => return Ok(Type::Ident(ResolvableName::new(ident))),
David Tolnayb40b9db2020-03-18 13:50:31 -0700657 PathArguments::AngleBracketed(generic) => {
658 if ident == "UniquePtr" && generic.args.len() == 1 {
659 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnayd7a3a182020-11-01 20:45:14 -0800660 let inner = parse_type(arg, namespace)?;
David Tolnayb40b9db2020-03-18 13:50:31 -0700661 return Ok(Type::UniquePtr(Box::new(Ty1 {
David Tolnayc94035a2020-11-15 16:49:18 -0800662 pinned: false,
David Tolnayda71ef62020-11-02 00:36:00 -0800663 name: ident,
David Tolnayb40b9db2020-03-18 13:50:31 -0700664 langle: generic.lt_token,
665 inner,
666 rangle: generic.gt_token,
David Tolnayc94035a2020-11-15 16:49:18 -0800667 pin_tokens: None,
David Tolnayb40b9db2020-03-18 13:50:31 -0700668 })));
669 }
David Tolnaye1dcdf72020-04-24 17:40:55 -0700670 } else if ident == "CxxVector" && generic.args.len() == 1 {
Myron Ahneba35cf2020-02-05 19:41:51 +0700671 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnayd7a3a182020-11-01 20:45:14 -0800672 let inner = parse_type(arg, namespace)?;
David Tolnay4377a9e2020-04-24 15:20:26 -0700673 return Ok(Type::CxxVector(Box::new(Ty1 {
David Tolnayc94035a2020-11-15 16:49:18 -0800674 pinned: false,
David Tolnayda71ef62020-11-02 00:36:00 -0800675 name: ident,
Myron Ahneba35cf2020-02-05 19:41:51 +0700676 langle: generic.lt_token,
677 inner,
678 rangle: generic.gt_token,
David Tolnayc94035a2020-11-15 16:49:18 -0800679 pin_tokens: None,
Myron Ahneba35cf2020-02-05 19:41:51 +0700680 })));
681 }
David Tolnayb40b9db2020-03-18 13:50:31 -0700682 } else if ident == "Box" && generic.args.len() == 1 {
683 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnayd7a3a182020-11-01 20:45:14 -0800684 let inner = parse_type(arg, namespace)?;
David Tolnayb40b9db2020-03-18 13:50:31 -0700685 return Ok(Type::RustBox(Box::new(Ty1 {
David Tolnayc94035a2020-11-15 16:49:18 -0800686 pinned: false,
David Tolnayda71ef62020-11-02 00:36:00 -0800687 name: ident,
David Tolnayb40b9db2020-03-18 13:50:31 -0700688 langle: generic.lt_token,
689 inner,
690 rangle: generic.gt_token,
David Tolnayc94035a2020-11-15 16:49:18 -0800691 pin_tokens: None,
David Tolnayb40b9db2020-03-18 13:50:31 -0700692 })));
693 }
Myron Ahneba35cf2020-02-05 19:41:51 +0700694 } else if ident == "Vec" && generic.args.len() == 1 {
695 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnayd7a3a182020-11-01 20:45:14 -0800696 let inner = parse_type(arg, namespace)?;
Myron Ahneba35cf2020-02-05 19:41:51 +0700697 return Ok(Type::RustVec(Box::new(Ty1 {
David Tolnayc94035a2020-11-15 16:49:18 -0800698 pinned: false,
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,
David Tolnayc94035a2020-11-15 16:49:18 -0800703 pin_tokens: None,
Myron Ahneba35cf2020-02-05 19:41:51 +0700704 })));
705 }
David Tolnaycbc2a4b2020-11-15 15:08:44 -0800706 } else if ident == "Pin" && generic.args.len() == 1 {
707 if let GenericArgument::Type(arg) = &generic.args[0] {
708 let inner = parse_type(arg, namespace)?;
David Tolnayc94035a2020-11-15 16:49:18 -0800709 let pin_token = kw::Pin(ident.span());
David Tolnaycbc2a4b2020-11-15 15:08:44 -0800710 if let Type::Ref(mut inner) = inner {
David Tolnaycbc2a4b2020-11-15 15:08:44 -0800711 inner.pinned = true;
712 inner.pin_tokens =
713 Some((pin_token, generic.lt_token, generic.gt_token));
714 return Ok(Type::Ref(inner));
David Tolnayc94035a2020-11-15 16:49:18 -0800715 } else if let Type::UniquePtr(mut inner) = inner {
716 inner.pinned = true;
717 inner.pin_tokens =
718 Some((pin_token, generic.lt_token, generic.gt_token));
719 return Ok(Type::UniquePtr(inner));
David Tolnaycbc2a4b2020-11-15 15:08:44 -0800720 }
721 }
David Tolnayb40b9db2020-03-18 13:50:31 -0700722 }
723 }
724 PathArguments::Parenthesized(_) => {}
David Tolnayfb134ed2020-03-15 23:17:48 -0700725 }
David Tolnay7db73692019-10-20 14:51:12 -0400726 }
727 Err(Error::new_spanned(ty, "unsupported type"))
728}
729
David Tolnayd7a3a182020-11-01 20:45:14 -0800730fn parse_type_slice(ty: &TypeSlice, namespace: &Namespace) -> Result<Type> {
731 let inner = parse_type(&ty.elem, namespace)?;
David Tolnayeebe9b72020-04-14 16:32:18 -0700732 Ok(Type::Slice(Box::new(Slice {
733 bracket: ty.bracket_token,
734 inner,
735 })))
736}
737
David Tolnayd7a3a182020-11-01 20:45:14 -0800738fn parse_type_fn(ty: &TypeBareFn, namespace: &Namespace) -> Result<Type> {
David Tolnayc071b892020-03-18 16:59:53 -0700739 if ty.lifetimes.is_some() {
740 return Err(Error::new_spanned(
741 ty,
742 "function pointer with lifetime parameters is not supported yet",
743 ));
744 }
745 if ty.variadic.is_some() {
746 return Err(Error::new_spanned(
747 ty,
748 "variadic function pointer is not supported yet",
749 ));
750 }
751 let args = ty
752 .inputs
753 .iter()
754 .enumerate()
755 .map(|(i, arg)| {
David Tolnayd7a3a182020-11-01 20:45:14 -0800756 let ty = parse_type(&arg.ty, namespace)?;
David Tolnayc071b892020-03-18 16:59:53 -0700757 let ident = match &arg.name {
758 Some(ident) => ident.0.clone(),
759 None => format_ident!("_{}", i),
760 };
761 Ok(Var { ident, ty })
762 })
763 .collect::<Result<_>>()?;
David Tolnaye3a48152020-04-08 19:38:05 -0700764 let mut throws_tokens = None;
David Tolnayd7a3a182020-11-01 20:45:14 -0800765 let ret = parse_return_type(&ty.output, &mut throws_tokens, namespace)?;
David Tolnaye3a48152020-04-08 19:38:05 -0700766 let throws = throws_tokens.is_some();
David Tolnayc071b892020-03-18 16:59:53 -0700767 Ok(Type::Fn(Box::new(Signature {
David Tolnaybdb576c2020-09-06 23:45:55 -0700768 unsafety: ty.unsafety,
David Tolnayc071b892020-03-18 16:59:53 -0700769 fn_token: ty.fn_token,
David Tolnay9938b642020-11-15 18:11:40 -0800770 generics: Generics::default(),
David Tolnayc071b892020-03-18 16:59:53 -0700771 receiver: None,
772 args,
773 ret,
774 throws,
David Tolnaye3a48152020-04-08 19:38:05 -0700775 paren_token: ty.paren_token,
776 throws_tokens,
David Tolnayc071b892020-03-18 16:59:53 -0700777 })))
778}
779
David Tolnaye3a48152020-04-08 19:38:05 -0700780fn parse_return_type(
781 ty: &ReturnType,
782 throws_tokens: &mut Option<(kw::Result, Token![<], Token![>])>,
David Tolnayd7a3a182020-11-01 20:45:14 -0800783 namespace: &Namespace,
David Tolnaye3a48152020-04-08 19:38:05 -0700784) -> Result<Option<Type>> {
David Tolnayc071b892020-03-18 16:59:53 -0700785 let mut ret = match ty {
786 ReturnType::Default => return Ok(None),
787 ReturnType::Type(_, ret) => ret.as_ref(),
788 };
789 if let RustType::Path(ty) = ret {
790 let path = &ty.path;
791 if ty.qself.is_none() && path.leading_colon.is_none() && path.segments.len() == 1 {
792 let segment = &path.segments[0];
793 let ident = segment.ident.clone();
794 if let PathArguments::AngleBracketed(generic) = &segment.arguments {
795 if ident == "Result" && generic.args.len() == 1 {
796 if let GenericArgument::Type(arg) = &generic.args[0] {
797 ret = arg;
David Tolnaye3a48152020-04-08 19:38:05 -0700798 *throws_tokens =
799 Some((kw::Result(ident.span()), generic.lt_token, generic.gt_token));
David Tolnayc071b892020-03-18 16:59:53 -0700800 }
801 }
802 }
803 }
804 }
David Tolnayd7a3a182020-11-01 20:45:14 -0800805 match parse_type(ret, namespace)? {
David Tolnayc071b892020-03-18 16:59:53 -0700806 Type::Void(_) => Ok(None),
807 ty => Ok(Some(ty)),
808 }
809}