blob: 78e6a3f24f9db465d9fd07efe0f9aca3be8fec33 [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 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
David Tolnay9a69d8a2020-11-16 09:16:41 -0800183 let ident = Ident::new(repr.as_ref(), Span::call_site());
184 let repr_type = Type::Ident(ResolvableName::new(ident));
185
Joel Galensonc03402a2020-04-23 17:31:09 -0700186 Ok(Api::Enum(Enum {
187 doc,
David Tolnaye2e303f2020-05-10 20:52:00 -0700188 enum_token,
David Tolnay17a934c2020-11-02 00:40:04 -0800189 name: Pair::new(namespace, item.ident),
David Tolnaye2e303f2020-05-10 20:52:00 -0700190 brace_token,
David Tolnay7ae018f2020-05-05 10:11:30 -0700191 variants,
David Tolnaye2e303f2020-05-10 20:52:00 -0700192 repr,
David Tolnay9a69d8a2020-11-16 09:16:41 -0800193 repr_type,
Joel Galensonc03402a2020-04-23 17:31:09 -0700194 }))
195}
196
David Tolnay805dca32020-08-29 19:09:55 -0700197fn parse_foreign_mod(
198 cx: &mut Errors,
199 foreign_mod: ItemForeignMod,
200 out: &mut Vec<Api>,
201 trusted: bool,
David Tolnayd7a3a182020-11-01 20:45:14 -0800202 namespace: &Namespace,
David Tolnay805dca32020-08-29 19:09:55 -0700203) {
David Tolnay3a451732020-08-29 18:54:55 -0700204 let lang = match parse_lang(&foreign_mod.abi) {
David Tolnay52759782020-05-03 23:59:40 -0700205 Ok(lang) => lang,
206 Err(err) => return cx.push(err),
207 };
David Tolnay7db73692019-10-20 14:51:12 -0400208
David Tolnay3a451732020-08-29 18:54:55 -0700209 match lang {
210 Lang::Rust => {
David Tolnay805dca32020-08-29 19:09:55 -0700211 if foreign_mod.unsafety.is_some() {
David Tolnay3a451732020-08-29 18:54:55 -0700212 let unsafety = foreign_mod.unsafety;
David Tolnay7be5b1f2020-11-11 10:48:32 -0800213 let abi = &foreign_mod.abi;
David Tolnay3a451732020-08-29 18:54:55 -0700214 let span = quote!(#unsafety #abi);
215 cx.error(span, "extern \"Rust\" block does not need to be unsafe");
216 }
217 }
218 Lang::Cxx => {}
219 }
220
David Tolnay805dca32020-08-29 19:09:55 -0700221 let trusted = trusted || foreign_mod.unsafety.is_some();
222
David Tolnay7feb2642020-11-10 18:49:04 -0800223 let mut namespace = namespace.clone();
224 attrs::parse(
225 cx,
226 &foreign_mod.attrs,
227 attrs::Parser {
228 namespace: Some(&mut namespace),
229 ..Default::default()
230 },
231 );
232
Joel Galensone1e969d2020-04-21 12:50:20 -0700233 let mut items = Vec::new();
234 for foreign in &foreign_mod.items {
235 match foreign {
Adrian Taylorc8713432020-10-21 18:20:55 -0700236 ForeignItem::Type(foreign) => {
David Tolnay7feb2642020-11-10 18:49:04 -0800237 match parse_extern_type(cx, foreign, lang, trusted, &namespace) {
Adrian Taylorc8713432020-10-21 18:20:55 -0700238 Ok(ety) => items.push(ety),
239 Err(err) => cx.push(err),
240 }
241 }
David Tolnay556738d2020-11-15 13:58:44 -0800242 ForeignItem::Fn(foreign) => {
243 match parse_extern_fn(cx, foreign, lang, trusted, &namespace) {
244 Ok(efn) => items.push(efn),
245 Err(err) => cx.push(err),
246 }
247 }
David Tolnay7db73692019-10-20 14:51:12 -0400248 ForeignItem::Macro(foreign) if foreign.mac.path.is_ident("include") => {
David Tolnay91e87fa2020-05-11 19:10:23 -0700249 match foreign.mac.parse_body_with(parse_include) {
David Tolnay52759782020-05-03 23:59:40 -0700250 Ok(include) => items.push(Api::Include(include)),
251 Err(err) => cx.push(err),
252 }
David Tolnay7db73692019-10-20 14:51:12 -0400253 }
Adrian Taylorc8713432020-10-21 18:20:55 -0700254 ForeignItem::Verbatim(tokens) => {
David Tolnay7feb2642020-11-10 18:49:04 -0800255 match parse_extern_verbatim(cx, tokens, lang, &namespace) {
Adrian Taylorc8713432020-10-21 18:20:55 -0700256 Ok(api) => items.push(api),
257 Err(err) => cx.push(err),
258 }
259 }
David Tolnay52759782020-05-03 23:59:40 -0700260 _ => cx.error(foreign, "unsupported foreign item"),
David Tolnay7db73692019-10-20 14:51:12 -0400261 }
262 }
David Tolnaya1f29c42020-04-22 18:01:38 -0700263
David Tolnay7be5b1f2020-11-11 10:48:32 -0800264 if !trusted
265 && items.iter().any(|api| match api {
266 Api::CxxFunction(efn) => efn.unsafety.is_none(),
267 _ => false,
268 })
269 {
270 cx.error(
271 foreign_mod.abi,
272 "block must be declared `unsafe extern \"C++\"` if it contains any safe-to-call C++ functions",
273 );
274 }
275
David Tolnaya1f29c42020-04-22 18:01:38 -0700276 let mut types = items.iter().filter_map(|item| match item {
David Tolnay17a934c2020-11-02 00:40:04 -0800277 Api::CxxType(ety) | Api::RustType(ety) => Some(&ety.name),
278 Api::TypeAlias(alias) => Some(&alias.name),
David Tolnaya1f29c42020-04-22 18:01:38 -0700279 _ => None,
280 });
281 if let (Some(single_type), None) = (types.next(), types.next()) {
David Tolnaye5a015a2020-05-07 21:54:26 -0700282 let single_type = single_type.clone();
David Tolnaya1f29c42020-04-22 18:01:38 -0700283 for item in &mut items {
284 if let Api::CxxFunction(efn) | Api::RustFunction(efn) = item {
285 if let Some(receiver) = &mut efn.receiver {
Adrian Taylorc8713432020-10-21 18:20:55 -0700286 if receiver.ty.is_self() {
Adrian Taylor565ddf02020-10-29 21:12:36 -0700287 receiver.ty = ResolvableName::new(single_type.rust.clone());
David Tolnaya1f29c42020-04-22 18:01:38 -0700288 }
289 }
290 }
291 }
292 }
293
David Tolnay52759782020-05-03 23:59:40 -0700294 out.extend(items);
David Tolnay7db73692019-10-20 14:51:12 -0400295}
296
David Tolnay3a451732020-08-29 18:54:55 -0700297fn parse_lang(abi: &Abi) -> Result<Lang> {
David Tolnay7db73692019-10-20 14:51:12 -0400298 let name = match &abi.name {
299 Some(name) => name,
300 None => {
301 return Err(Error::new_spanned(
302 abi,
David Tolnayc72a9f62020-11-11 10:56:26 -0800303 "ABI name is required, extern \"C++\" or extern \"Rust\"",
David Tolnay7db73692019-10-20 14:51:12 -0400304 ));
305 }
306 };
307 match name.value().as_str() {
David Tolnayea25ac82020-11-11 10:35:23 -0800308 "C++" => Ok(Lang::Cxx),
David Tolnay7db73692019-10-20 14:51:12 -0400309 "Rust" => Ok(Lang::Rust),
David Tolnay2757ca82020-11-14 15:12:06 -0800310 _ => Err(Error::new_spanned(
311 abi,
312 "unrecognized ABI, requires either \"C++\" or \"Rust\"",
313 )),
David Tolnay7db73692019-10-20 14:51:12 -0400314 }
315}
316
David Tolnay00f236a2020-08-29 19:07:18 -0700317fn parse_extern_type(
318 cx: &mut Errors,
319 foreign_type: &ForeignItemType,
320 lang: Lang,
321 trusted: bool,
David Tolnay302b1752020-11-10 18:43:24 -0800322 namespace: &Namespace,
David Tolnay00f236a2020-08-29 19:07:18 -0700323) -> Result<Api> {
Adrian Taylorc8713432020-10-21 18:20:55 -0700324 let mut doc = Doc::new();
David Tolnay302b1752020-11-10 18:43:24 -0800325 let mut namespace = namespace.clone();
Adrian Taylorc8713432020-10-21 18:20:55 -0700326 attrs::parse(
327 cx,
328 &foreign_type.attrs,
329 attrs::Parser {
330 doc: Some(&mut doc),
David Tolnayd7a3a182020-11-01 20:45:14 -0800331 namespace: Some(&mut namespace),
Adrian Taylorc8713432020-10-21 18:20:55 -0700332 ..Default::default()
333 },
334 );
David Tolnay7db73692019-10-20 14:51:12 -0400335 let type_token = foreign_type.type_token;
336 let ident = foreign_type.ident.clone();
David Tolnayc8361022020-08-25 21:57:53 -0700337 let semi_token = foreign_type.semi_token;
David Tolnay295ef6b2020-05-07 16:10:22 -0700338 let api_type = match lang {
339 Lang::Cxx => Api::CxxType,
340 Lang::Rust => Api::RustType,
341 };
342 Ok(api_type(ExternType {
David Tolnay7db73692019-10-20 14:51:12 -0400343 doc,
344 type_token,
David Tolnay17a934c2020-11-02 00:40:04 -0800345 name: Pair::new(namespace, ident),
David Tolnayc8361022020-08-25 21:57:53 -0700346 semi_token,
David Tolnay00f236a2020-08-29 19:07:18 -0700347 trusted,
David Tolnay295ef6b2020-05-07 16:10:22 -0700348 }))
David Tolnay7db73692019-10-20 14:51:12 -0400349}
350
Adrian Taylorc8713432020-10-21 18:20:55 -0700351fn parse_extern_fn(
352 cx: &mut Errors,
353 foreign_fn: &ForeignItemFn,
354 lang: Lang,
David Tolnay556738d2020-11-15 13:58:44 -0800355 trusted: bool,
David Tolnay302b1752020-11-10 18:43:24 -0800356 namespace: &Namespace,
Adrian Taylorc8713432020-10-21 18:20:55 -0700357) -> Result<Api> {
David Tolnay7db73692019-10-20 14:51:12 -0400358 let generics = &foreign_fn.sig.generics;
David Tolnay9938b642020-11-15 18:11:40 -0800359 if generics.where_clause.is_some()
360 || generics.params.iter().any(|param| match param {
361 GenericParam::Lifetime(lifetime) => !lifetime.bounds.is_empty(),
362 GenericParam::Type(_) | GenericParam::Const(_) => true,
363 })
364 {
David Tolnay7db73692019-10-20 14:51:12 -0400365 return Err(Error::new_spanned(
366 foreign_fn,
367 "extern function with generic parameters is not supported yet",
368 ));
369 }
370 if let Some(variadic) = &foreign_fn.sig.variadic {
371 return Err(Error::new_spanned(
372 variadic,
373 "variadic function is not supported yet",
374 ));
375 }
David Tolnay8de461f2020-11-19 13:46:14 -0800376 if foreign_fn.sig.asyncness.is_some() {
377 return Err(Error::new_spanned(
378 foreign_fn,
379 "async function is not directly supported yet, but see https://cxx.rs/async.html for a working approach",
380 ));
381 }
David Tolnay7db73692019-10-20 14:51:12 -0400382
David Tolnay938ca852020-10-09 19:25:08 -0700383 let mut doc = Doc::new();
384 let mut cxx_name = None;
385 let mut rust_name = None;
David Tolnay302b1752020-11-10 18:43:24 -0800386 let mut namespace = namespace.clone();
David Tolnay938ca852020-10-09 19:25:08 -0700387 attrs::parse(
388 cx,
389 &foreign_fn.attrs,
390 attrs::Parser {
391 doc: Some(&mut doc),
392 cxx_name: Some(&mut cxx_name),
393 rust_name: Some(&mut rust_name),
David Tolnayd7a3a182020-11-01 20:45:14 -0800394 namespace: Some(&mut namespace),
David Tolnay938ca852020-10-09 19:25:08 -0700395 ..Default::default()
396 },
397 );
398
David Tolnay7db73692019-10-20 14:51:12 -0400399 let mut receiver = None;
David Tolnaye3a48152020-04-08 19:38:05 -0700400 let mut args = Punctuated::new();
401 for arg in foreign_fn.sig.inputs.pairs() {
402 let (arg, comma) = arg.into_tuple();
David Tolnay7db73692019-10-20 14:51:12 -0400403 match arg {
David Tolnay1dd11a12020-04-22 12:31:48 -0700404 FnArg::Receiver(arg) => {
David Tolnaya1f29c42020-04-22 18:01:38 -0700405 if let Some((ampersand, lifetime)) = &arg.reference {
406 receiver = Some(Receiver {
David Tolnay9c76c392020-11-15 16:07:08 -0800407 pinned: false,
David Tolnaya1f29c42020-04-22 18:01:38 -0700408 ampersand: *ampersand,
409 lifetime: lifetime.clone(),
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800410 mutable: arg.mutability.is_some(),
David Tolnaya1f29c42020-04-22 18:01:38 -0700411 var: arg.self_token,
Adrian Taylorc8713432020-10-21 18:20:55 -0700412 ty: ResolvableName::make_self(arg.self_token.span),
David Tolnaya1f29c42020-04-22 18:01:38 -0700413 shorthand: true,
David Tolnay9c76c392020-11-15 16:07:08 -0800414 pin_tokens: None,
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800415 mutability: arg.mutability,
David Tolnaya1f29c42020-04-22 18:01:38 -0700416 });
417 continue;
Joel Galensone1e969d2020-04-21 12:50:20 -0700418 }
David Tolnay1dd11a12020-04-22 12:31:48 -0700419 return Err(Error::new_spanned(arg, "unsupported signature"));
David Tolnay7db73692019-10-20 14:51:12 -0400420 }
421 FnArg::Typed(arg) => {
422 let ident = match arg.pat.as_ref() {
423 Pat::Ident(pat) => pat.ident.clone(),
Joel Galensonba676072020-04-27 15:55:45 -0700424 Pat::Wild(pat) => {
425 Ident::new(&format!("_{}", args.len()), pat.underscore_token.span)
426 }
David Tolnay7db73692019-10-20 14:51:12 -0400427 _ => return Err(Error::new_spanned(arg, "unsupported signature")),
428 };
David Tolnayd7a3a182020-11-01 20:45:14 -0800429 let ty = parse_type(&arg.ty, &namespace)?;
David Tolnay7db73692019-10-20 14:51:12 -0400430 if ident != "self" {
David Tolnaye3a48152020-04-08 19:38:05 -0700431 args.push_value(Var { ident, ty });
432 if let Some(comma) = comma {
433 args.push_punct(*comma);
434 }
David Tolnay7db73692019-10-20 14:51:12 -0400435 continue;
436 }
437 if let Type::Ref(reference) = ty {
438 if let Type::Ident(ident) = reference.inner {
439 receiver = Some(Receiver {
David Tolnay9c76c392020-11-15 16:07:08 -0800440 pinned: reference.pinned,
David Tolnayfb6e3862020-04-20 01:33:23 -0700441 ampersand: reference.ampersand,
David Tolnay0bd50fa2020-04-22 15:31:33 -0700442 lifetime: reference.lifetime,
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800443 mutable: reference.mutable,
Adrian Taylorc8713432020-10-21 18:20:55 -0700444 var: Token![self](ident.rust.span()),
David Tolnay05e11cc2020-04-20 02:13:56 -0700445 ty: ident,
David Tolnay62d360c2020-04-22 16:26:21 -0700446 shorthand: false,
David Tolnay9c76c392020-11-15 16:07:08 -0800447 pin_tokens: reference.pin_tokens,
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800448 mutability: reference.mutability,
David Tolnay7db73692019-10-20 14:51:12 -0400449 });
450 continue;
451 }
452 }
453 return Err(Error::new_spanned(arg, "unsupported method receiver"));
454 }
455 }
456 }
David Tolnay59b7ede2020-03-16 00:30:23 -0700457
David Tolnaye3a48152020-04-08 19:38:05 -0700458 let mut throws_tokens = None;
David Tolnayd7a3a182020-11-01 20:45:14 -0800459 let ret = parse_return_type(&foreign_fn.sig.output, &mut throws_tokens, &namespace)?;
David Tolnaye3a48152020-04-08 19:38:05 -0700460 let throws = throws_tokens.is_some();
David Tolnaybdb576c2020-09-06 23:45:55 -0700461 let unsafety = foreign_fn.sig.unsafety;
David Tolnay7db73692019-10-20 14:51:12 -0400462 let fn_token = foreign_fn.sig.fn_token;
David Tolnay17a934c2020-11-02 00:40:04 -0800463 let name = Pair::new_from_differing_names(
David Tolnayd7a3a182020-11-01 20:45:14 -0800464 namespace,
Adrian Taylor0f8ab222020-10-29 21:31:56 -0700465 cxx_name.unwrap_or(foreign_fn.sig.ident.clone()),
466 rust_name.unwrap_or(foreign_fn.sig.ident.clone()),
467 );
David Tolnay9938b642020-11-15 18:11:40 -0800468 let generics = generics.clone();
David Tolnaye3a48152020-04-08 19:38:05 -0700469 let paren_token = foreign_fn.sig.paren_token;
David Tolnay7db73692019-10-20 14:51:12 -0400470 let semi_token = foreign_fn.semi_token;
David Tolnay295ef6b2020-05-07 16:10:22 -0700471 let api_function = match lang {
472 Lang::Cxx => Api::CxxFunction,
473 Lang::Rust => Api::RustFunction,
474 };
David Tolnayd95b1192020-03-18 20:07:46 -0700475
David Tolnay295ef6b2020-05-07 16:10:22 -0700476 Ok(api_function(ExternFn {
David Tolnay6cde49f2020-03-16 12:25:45 -0700477 lang,
David Tolnay7db73692019-10-20 14:51:12 -0400478 doc,
David Tolnay17a934c2020-11-02 00:40:04 -0800479 name,
David Tolnay16448732020-03-18 12:39:36 -0700480 sig: Signature {
David Tolnaybdb576c2020-09-06 23:45:55 -0700481 unsafety,
David Tolnay16448732020-03-18 12:39:36 -0700482 fn_token,
David Tolnay9938b642020-11-15 18:11:40 -0800483 generics,
David Tolnay16448732020-03-18 12:39:36 -0700484 receiver,
485 args,
486 ret,
487 throws,
David Tolnaye3a48152020-04-08 19:38:05 -0700488 paren_token,
489 throws_tokens,
David Tolnay16448732020-03-18 12:39:36 -0700490 },
David Tolnay7db73692019-10-20 14:51:12 -0400491 semi_token,
David Tolnay556738d2020-11-15 13:58:44 -0800492 trusted,
David Tolnay295ef6b2020-05-07 16:10:22 -0700493 }))
David Tolnay7db73692019-10-20 14:51:12 -0400494}
495
Adrian Taylorc8713432020-10-21 18:20:55 -0700496fn parse_extern_verbatim(
497 cx: &mut Errors,
498 tokens: &TokenStream,
499 lang: Lang,
David Tolnay302b1752020-11-10 18:43:24 -0800500 namespace: &Namespace,
Adrian Taylorc8713432020-10-21 18:20:55 -0700501) -> Result<Api> {
David Tolnaye2f9ec42020-05-07 16:19:33 -0700502 // type Alias = crate::path::to::Type;
David Tolnay3e628882020-05-10 15:30:14 -0700503 let parse = |input: ParseStream| -> Result<TypeAlias> {
David Tolnaye2f9ec42020-05-07 16:19:33 -0700504 let attrs = input.call(Attribute::parse_outer)?;
505 let type_token: Token![type] = match input.parse()? {
506 Some(type_token) => type_token,
507 None => {
508 let span = input.cursor().token_stream();
509 return Err(Error::new_spanned(span, "unsupported foreign item"));
510 }
511 };
512 let ident: Ident = input.parse()?;
513 let eq_token: Token![=] = input.parse()?;
514 let ty: RustType = input.parse()?;
515 let semi_token: Token![;] = input.parse()?;
Adrian Taylorc8713432020-10-21 18:20:55 -0700516 let mut doc = Doc::new();
David Tolnay302b1752020-11-10 18:43:24 -0800517 let mut namespace = namespace.clone();
Adrian Taylorc8713432020-10-21 18:20:55 -0700518 attrs::parse(
519 cx,
520 &attrs,
521 attrs::Parser {
522 doc: Some(&mut doc),
David Tolnayd7a3a182020-11-01 20:45:14 -0800523 namespace: Some(&mut namespace),
Adrian Taylorc8713432020-10-21 18:20:55 -0700524 ..Default::default()
525 },
526 );
David Tolnaye2f9ec42020-05-07 16:19:33 -0700527
528 Ok(TypeAlias {
Bryan Henry890083d2020-09-13 10:34:31 -0700529 doc,
David Tolnaye2f9ec42020-05-07 16:19:33 -0700530 type_token,
David Tolnay17a934c2020-11-02 00:40:04 -0800531 name: Pair::new(namespace, ident),
David Tolnaye2f9ec42020-05-07 16:19:33 -0700532 eq_token,
533 ty,
534 semi_token,
535 })
David Tolnay3e628882020-05-10 15:30:14 -0700536 };
David Tolnaye2f9ec42020-05-07 16:19:33 -0700537
538 let type_alias = parse.parse2(tokens.clone())?;
539 match lang {
540 Lang::Cxx => Ok(Api::TypeAlias(type_alias)),
541 Lang::Rust => {
542 let (type_token, semi_token) = (type_alias.type_token, type_alias.semi_token);
543 let span = quote!(#type_token #semi_token);
544 let msg = "type alias in extern \"Rust\" block is not supported";
545 Err(Error::new_spanned(span, msg))
546 }
547 }
548}
549
David Tolnayd7a3a182020-11-01 20:45:14 -0800550fn parse_impl(imp: ItemImpl, namespace: &Namespace) -> Result<Api> {
David Tolnay7e69f892020-10-03 22:20:22 -0700551 if !imp.items.is_empty() {
552 let mut span = Group::new(Delimiter::Brace, TokenStream::new());
553 span.set_span(imp.brace_token.span);
554 return Err(Error::new_spanned(span, "expected an empty impl block"));
555 }
556
557 let self_ty = &imp.self_ty;
558 if let Some((bang, path, for_token)) = &imp.trait_ {
559 let span = quote!(#bang #path #for_token #self_ty);
560 return Err(Error::new_spanned(
561 span,
562 "unexpected impl, expected something like `impl UniquePtr<T> {}`",
563 ));
564 }
565
566 let generics = &imp.generics;
567 if !generics.params.is_empty() || generics.where_clause.is_some() {
568 return Err(Error::new_spanned(
569 imp,
570 "generic parameters on an impl is not supported",
571 ));
572 }
573
574 Ok(Api::Impl(Impl {
575 impl_token: imp.impl_token,
David Tolnayd7a3a182020-11-01 20:45:14 -0800576 ty: parse_type(&self_ty, namespace)?,
David Tolnay7e69f892020-10-03 22:20:22 -0700577 brace_token: imp.brace_token,
578 }))
579}
580
David Tolnayb0cd3272020-10-27 21:32:54 -0700581fn parse_include(input: ParseStream) -> Result<Include> {
David Tolnay91e87fa2020-05-11 19:10:23 -0700582 if input.peek(LitStr) {
David Tolnayb0cd3272020-10-27 21:32:54 -0700583 let lit: LitStr = input.parse()?;
584 let span = lit.span();
585 return Ok(Include {
586 path: lit.value(),
587 kind: IncludeKind::Quoted,
588 begin_span: span,
589 end_span: span,
590 });
David Tolnay91e87fa2020-05-11 19:10:23 -0700591 }
592
593 if input.peek(Token![<]) {
594 let mut path = String::new();
David Tolnayb0cd3272020-10-27 21:32:54 -0700595
David Tolnay2cc2e3a2020-10-28 13:12:35 -0700596 let langle: Token![<] = input.parse()?;
David Tolnay91e87fa2020-05-11 19:10:23 -0700597 while !input.is_empty() && !input.peek(Token![>]) {
598 let token: TokenTree = input.parse()?;
599 match token {
600 TokenTree::Ident(token) => path += &token.to_string(),
601 TokenTree::Literal(token)
602 if token
603 .to_string()
604 .starts_with(|ch: char| ch.is_ascii_digit()) =>
605 {
606 path += &token.to_string();
607 }
608 TokenTree::Punct(token) => path.push(token.as_char()),
609 _ => return Err(Error::new(token.span(), "unexpected token in include path")),
610 }
611 }
David Tolnayb0cd3272020-10-27 21:32:54 -0700612 let rangle: Token![>] = input.parse()?;
David Tolnayb0cd3272020-10-27 21:32:54 -0700613
614 return Ok(Include {
615 path,
616 kind: IncludeKind::Bracketed,
David Tolnay2cc2e3a2020-10-28 13:12:35 -0700617 begin_span: langle.span,
618 end_span: rangle.span,
David Tolnayb0cd3272020-10-27 21:32:54 -0700619 });
David Tolnay91e87fa2020-05-11 19:10:23 -0700620 }
621
622 Err(input.error("expected \"quoted/path/to\" or <bracketed/path/to>"))
623}
624
David Tolnayd7a3a182020-11-01 20:45:14 -0800625fn parse_type(ty: &RustType, namespace: &Namespace) -> Result<Type> {
David Tolnay59b7ede2020-03-16 00:30:23 -0700626 match ty {
David Tolnayd7a3a182020-11-01 20:45:14 -0800627 RustType::Reference(ty) => parse_type_reference(ty, namespace),
628 RustType::Path(ty) => parse_type_path(ty, namespace),
629 RustType::Slice(ty) => parse_type_slice(ty, namespace),
630 RustType::BareFn(ty) => parse_type_fn(ty, namespace),
David Tolnayb40b9db2020-03-18 13:50:31 -0700631 RustType::Tuple(ty) if ty.elems.is_empty() => Ok(Type::Void(ty.paren_token.span)),
632 _ => Err(Error::new_spanned(ty, "unsupported type")),
633 }
634}
635
David Tolnayd7a3a182020-11-01 20:45:14 -0800636fn parse_type_reference(ty: &TypeReference, namespace: &Namespace) -> Result<Type> {
637 let inner = parse_type(&ty.elem, namespace)?;
David Tolnayb40b9db2020-03-18 13:50:31 -0700638 let which = match &inner {
Adrian Taylorc8713432020-10-21 18:20:55 -0700639 Type::Ident(ident) if ident.rust == "str" => {
David Tolnayb40b9db2020-03-18 13:50:31 -0700640 if ty.mutability.is_some() {
641 return Err(Error::new_spanned(ty, "unsupported type"));
642 } else {
643 Type::Str
David Tolnay7db73692019-10-20 14:51:12 -0400644 }
645 }
David Tolnayeebe9b72020-04-14 16:32:18 -0700646 Type::Slice(slice) => match &slice.inner {
Adrian Taylorc8713432020-10-21 18:20:55 -0700647 Type::Ident(ident) if ident.rust == U8 && ty.mutability.is_none() => Type::SliceRefU8,
David Tolnayeebe9b72020-04-14 16:32:18 -0700648 _ => Type::Ref,
David Tolnayeb952ba2020-04-14 15:02:24 -0700649 },
David Tolnayb40b9db2020-03-18 13:50:31 -0700650 _ => Type::Ref,
651 };
652 Ok(which(Box::new(Ref {
David Tolnayb27f7872020-11-15 15:07:04 -0800653 pinned: false,
David Tolnayb40b9db2020-03-18 13:50:31 -0700654 ampersand: ty.and_token,
David Tolnay0bd50fa2020-04-22 15:31:33 -0700655 lifetime: ty.lifetime.clone(),
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800656 mutable: ty.mutability.is_some(),
David Tolnayb40b9db2020-03-18 13:50:31 -0700657 inner,
David Tolnayb27f7872020-11-15 15:07:04 -0800658 pin_tokens: None,
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800659 mutability: ty.mutability,
David Tolnayb40b9db2020-03-18 13:50:31 -0700660 })))
661}
662
David Tolnayd7a3a182020-11-01 20:45:14 -0800663fn parse_type_path(ty: &TypePath, namespace: &Namespace) -> Result<Type> {
David Tolnayb40b9db2020-03-18 13:50:31 -0700664 let path = &ty.path;
665 if ty.qself.is_none() && path.leading_colon.is_none() && path.segments.len() == 1 {
666 let segment = &path.segments[0];
667 let ident = segment.ident.clone();
668 match &segment.arguments {
David Tolnayda71ef62020-11-02 00:36:00 -0800669 PathArguments::None => return Ok(Type::Ident(ResolvableName::new(ident))),
David Tolnayb40b9db2020-03-18 13:50:31 -0700670 PathArguments::AngleBracketed(generic) => {
671 if ident == "UniquePtr" && generic.args.len() == 1 {
672 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnayd7a3a182020-11-01 20:45:14 -0800673 let inner = parse_type(arg, namespace)?;
David Tolnayb40b9db2020-03-18 13:50:31 -0700674 return Ok(Type::UniquePtr(Box::new(Ty1 {
David Tolnayda71ef62020-11-02 00:36:00 -0800675 name: ident,
David Tolnayb40b9db2020-03-18 13:50:31 -0700676 langle: generic.lt_token,
677 inner,
678 rangle: generic.gt_token,
679 })));
680 }
David Tolnaye1dcdf72020-04-24 17:40:55 -0700681 } else if ident == "CxxVector" && generic.args.len() == 1 {
Myron Ahneba35cf2020-02-05 19:41:51 +0700682 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnayd7a3a182020-11-01 20:45:14 -0800683 let inner = parse_type(arg, namespace)?;
David Tolnay4377a9e2020-04-24 15:20:26 -0700684 return Ok(Type::CxxVector(Box::new(Ty1 {
David Tolnayda71ef62020-11-02 00:36:00 -0800685 name: ident,
Myron Ahneba35cf2020-02-05 19:41:51 +0700686 langle: generic.lt_token,
687 inner,
688 rangle: generic.gt_token,
689 })));
690 }
David Tolnayb40b9db2020-03-18 13:50:31 -0700691 } else if ident == "Box" && generic.args.len() == 1 {
692 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnayd7a3a182020-11-01 20:45:14 -0800693 let inner = parse_type(arg, namespace)?;
David Tolnayb40b9db2020-03-18 13:50:31 -0700694 return Ok(Type::RustBox(Box::new(Ty1 {
David Tolnayda71ef62020-11-02 00:36:00 -0800695 name: ident,
David Tolnayb40b9db2020-03-18 13:50:31 -0700696 langle: generic.lt_token,
697 inner,
698 rangle: generic.gt_token,
699 })));
700 }
Myron Ahneba35cf2020-02-05 19:41:51 +0700701 } else if ident == "Vec" && generic.args.len() == 1 {
702 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnayd7a3a182020-11-01 20:45:14 -0800703 let inner = parse_type(arg, namespace)?;
Myron Ahneba35cf2020-02-05 19:41:51 +0700704 return Ok(Type::RustVec(Box::new(Ty1 {
David Tolnayda71ef62020-11-02 00:36:00 -0800705 name: ident,
Myron Ahneba35cf2020-02-05 19:41:51 +0700706 langle: generic.lt_token,
707 inner,
708 rangle: generic.gt_token,
709 })));
710 }
David Tolnaycbc2a4b2020-11-15 15:08:44 -0800711 } else if ident == "Pin" && generic.args.len() == 1 {
712 if let GenericArgument::Type(arg) = &generic.args[0] {
713 let inner = parse_type(arg, namespace)?;
David Tolnayc94035a2020-11-15 16:49:18 -0800714 let pin_token = kw::Pin(ident.span());
David Tolnaycbc2a4b2020-11-15 15:08:44 -0800715 if let Type::Ref(mut inner) = inner {
David Tolnaycbc2a4b2020-11-15 15:08:44 -0800716 inner.pinned = true;
717 inner.pin_tokens =
718 Some((pin_token, generic.lt_token, generic.gt_token));
719 return Ok(Type::Ref(inner));
720 }
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}