blob: 87f43b2c73d4891dc0b095e735affc6d09004c8c [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::{
David Tolnayb7eb65e2020-11-27 20:00:53 -08006 attrs, error, Api, Array, Derive, Doc, Enum, ExternFn, ExternType, Impl, Include, IncludeKind,
David Tolnayee312322020-12-28 22:04:10 -08007 Lang, Lifetimes, Namespace, Pair, Receiver, Ref, RustName, Signature, SliceRef, Struct, Ty1,
8 Type, TypeAlias, 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 Tolnay15a1fc12020-12-30 16:04:56 -080012use std::mem;
David Tolnaye2f9ec42020-05-07 16:19:33 -070013use syn::parse::{ParseStream, Parser};
David Tolnaye3a48152020-04-08 19:38:05 -070014use syn::punctuated::Punctuated;
David Tolnay7db73692019-10-20 14:51:12 -040015use syn::{
Xiangpeng Hao78762352020-11-12 10:24:18 +080016 Abi, Attribute, Error, Expr, Fields, FnArg, ForeignItem, ForeignItemFn, ForeignItemType,
David Tolnayee312322020-12-28 22:04:10 -080017 GenericArgument, GenericParam, Generics, Ident, ItemEnum, ItemImpl, ItemStruct, Lit, LitStr,
18 Pat, PathArguments, Result, ReturnType, Token, TraitBound, TraitBoundModifier,
David Tolnayb7eb65e2020-11-27 20:00:53 -080019 Type as RustType, TypeArray, TypeBareFn, TypeParamBound, TypePath, TypeReference,
David Tolnayd6143702020-12-29 23:48:09 -080020 Variant as RustVariant, Visibility,
David Tolnay7db73692019-10-20 14:51:12 -040021};
22
David Tolnaye3a48152020-04-08 19:38:05 -070023pub mod kw {
David Tolnayb27f7872020-11-15 15:07:04 -080024 syn::custom_keyword!(Pin);
David Tolnaye3a48152020-04-08 19:38:05 -070025 syn::custom_keyword!(Result);
26}
27
David Tolnayd7a3a182020-11-01 20:45:14 -080028pub fn parse_items(
29 cx: &mut Errors,
30 items: Vec<Item>,
31 trusted: bool,
32 namespace: &Namespace,
33) -> Vec<Api> {
David Tolnay7db73692019-10-20 14:51:12 -040034 let mut apis = Vec::new();
35 for item in items {
36 match item {
David Tolnay302b1752020-11-10 18:43:24 -080037 Item::Struct(item) => match parse_struct(cx, item, namespace) {
David Tolnay52759782020-05-03 23:59:40 -070038 Ok(strct) => apis.push(strct),
39 Err(err) => cx.push(err),
40 },
David Tolnay302b1752020-11-10 18:43:24 -080041 Item::Enum(item) => match parse_enum(cx, item, namespace) {
David Tolnay52759782020-05-03 23:59:40 -070042 Ok(enm) => apis.push(enm),
43 Err(err) => cx.push(err),
44 },
Adrian Taylorc8713432020-10-21 18:20:55 -070045 Item::ForeignMod(foreign_mod) => {
David Tolnayd7a3a182020-11-01 20:45:14 -080046 parse_foreign_mod(cx, foreign_mod, &mut apis, trusted, namespace)
Adrian Taylorc8713432020-10-21 18:20:55 -070047 }
David Tolnay313cc0a2020-11-24 21:47:01 -080048 Item::Impl(item) => match parse_impl(item) {
David Tolnay7e69f892020-10-03 22:20:22 -070049 Ok(imp) => apis.push(imp),
50 Err(err) => cx.push(err),
51 },
David Tolnay52759782020-05-03 23:59:40 -070052 Item::Use(item) => cx.error(item, error::USE_NOT_ALLOWED),
David Tolnay00a83852020-08-29 15:06:16 -070053 Item::Other(item) => cx.error(item, "unsupported item"),
David Tolnay7db73692019-10-20 14:51:12 -040054 }
55 }
David Tolnay52759782020-05-03 23:59:40 -070056 apis
David Tolnay7db73692019-10-20 14:51:12 -040057}
58
David Tolnay15a1fc12020-12-30 16:04:56 -080059fn parse_struct(cx: &mut Errors, mut item: ItemStruct, namespace: &Namespace) -> Result<Api> {
David Tolnay7db73692019-10-20 14:51:12 -040060 let mut doc = Doc::new();
61 let mut derives = Vec::new();
David Tolnay302b1752020-11-10 18:43:24 -080062 let mut namespace = namespace.clone();
David Tolnay885be132020-12-21 15:52:47 -080063 let mut cxx_name = None;
64 let mut rust_name = None;
David Tolnay067638e2020-12-30 16:18:05 -080065 let attrs = attrs::parse(
David Tolnay3e628882020-05-10 15:30:14 -070066 cx,
David Tolnay067638e2020-12-30 16:18:05 -080067 mem::take(&mut item.attrs),
David Tolnayb129ea72020-05-10 14:29:30 -070068 attrs::Parser {
69 doc: Some(&mut doc),
70 derives: Some(&mut derives),
David Tolnayd7a3a182020-11-01 20:45:14 -080071 namespace: Some(&mut namespace),
David Tolnay885be132020-12-21 15:52:47 -080072 cxx_name: Some(&mut cxx_name),
73 rust_name: Some(&mut rust_name),
David Tolnayddf69e22020-05-10 22:08:20 -070074 ..Default::default()
David Tolnayb129ea72020-05-10 14:29:30 -070075 },
David Tolnay3e628882020-05-10 15:30:14 -070076 );
David Tolnay09462ac2020-03-20 14:58:41 -070077
David Tolnaybc954d92020-12-21 15:17:10 -080078 let generics = &item.generics;
79 if !generics.params.is_empty() || generics.where_clause.is_some() {
80 let struct_token = item.struct_token;
81 let ident = &item.ident;
82 let where_clause = &generics.where_clause;
83 let span = quote!(#struct_token #ident #generics #where_clause);
84 return Err(Error::new_spanned(
85 span,
86 "struct with generic parameters is not supported yet",
87 ));
88 }
89
David Tolnay302b1752020-11-10 18:43:24 -080090 let named_fields = match item.fields {
David Tolnay09462ac2020-03-20 14:58:41 -070091 Fields::Named(fields) => fields,
92 Fields::Unit => return Err(Error::new_spanned(item, "unit structs are not supported")),
93 Fields::Unnamed(_) => {
David Tolnay2c4b35f2020-10-04 21:22:30 -070094 return Err(Error::new_spanned(item, "tuple structs are not supported"));
David Tolnay09462ac2020-03-20 14:58:41 -070095 }
96 };
97
David Tolnay38c11212020-11-25 15:50:19 -080098 let mut fields = Vec::new();
99 for field in named_fields.named {
100 let ident = field.ident.unwrap();
David Tolnayb4a05c32020-12-30 15:37:01 -0800101 let mut doc = Doc::new();
David Tolnay067638e2020-12-30 16:18:05 -0800102 let attrs = attrs::parse(
David Tolnayb4a05c32020-12-30 15:37:01 -0800103 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -0800104 field.attrs,
David Tolnayb4a05c32020-12-30 15:37:01 -0800105 attrs::Parser {
106 doc: Some(&mut doc),
107 ..Default::default()
108 },
109 );
David Tolnay38c11212020-11-25 15:50:19 -0800110 let ty = match parse_type(&field.ty) {
111 Ok(ty) => ty,
112 Err(err) => {
113 cx.push(err);
114 continue;
115 }
116 };
David Tolnay89902442020-12-30 15:10:40 -0800117 let visibility = Token![pub](match field.vis {
118 Visibility::Public(vis) => vis.pub_token.span,
119 Visibility::Crate(vis) => vis.crate_token.span,
120 Visibility::Restricted(vis) => vis.pub_token.span,
121 Visibility::Inherited => ident.span(),
122 });
123 fields.push(Var {
David Tolnayb4a05c32020-12-30 15:37:01 -0800124 doc,
David Tolnay067638e2020-12-30 16:18:05 -0800125 attrs,
David Tolnay89902442020-12-30 15:10:40 -0800126 visibility,
127 ident,
128 ty,
129 });
David Tolnay38c11212020-11-25 15:50:19 -0800130 }
David Tolnay302b1752020-11-10 18:43:24 -0800131
David Tolnay64343af2020-12-30 15:26:06 -0800132 let visibility = Token![pub](match item.vis {
133 Visibility::Public(vis) => vis.pub_token.span,
134 Visibility::Crate(vis) => vis.crate_token.span,
135 Visibility::Restricted(vis) => vis.pub_token.span,
136 Visibility::Inherited => item.ident.span(),
137 });
David Tolnayddbcb522020-12-21 15:24:45 -0800138 let struct_token = item.struct_token;
David Tolnay885be132020-12-21 15:52:47 -0800139 let name = pair(namespace, &item.ident, cxx_name, rust_name);
David Tolnayddbcb522020-12-21 15:24:45 -0800140 let brace_token = named_fields.brace_token;
141
David Tolnay09462ac2020-03-20 14:58:41 -0700142 Ok(Api::Struct(Struct {
143 doc,
144 derives,
David Tolnay067638e2020-12-30 16:18:05 -0800145 attrs,
David Tolnay64343af2020-12-30 15:26:06 -0800146 visibility,
David Tolnayddbcb522020-12-21 15:24:45 -0800147 struct_token,
148 name,
149 brace_token,
David Tolnay302b1752020-11-10 18:43:24 -0800150 fields,
David Tolnay09462ac2020-03-20 14:58:41 -0700151 }))
David Tolnay7db73692019-10-20 14:51:12 -0400152}
153
David Tolnay302b1752020-11-10 18:43:24 -0800154fn parse_enum(cx: &mut Errors, item: ItemEnum, namespace: &Namespace) -> Result<Api> {
David Tolnayddf69e22020-05-10 22:08:20 -0700155 let mut doc = Doc::new();
David Tolnayfbc46692020-11-27 11:33:29 -0800156 let mut derives = Vec::new();
David Tolnayddf69e22020-05-10 22:08:20 -0700157 let mut repr = None;
David Tolnay302b1752020-11-10 18:43:24 -0800158 let mut namespace = namespace.clone();
David Tolnay885be132020-12-21 15:52:47 -0800159 let mut cxx_name = None;
160 let mut rust_name = None;
David Tolnay067638e2020-12-30 16:18:05 -0800161 let attrs = attrs::parse(
David Tolnayddf69e22020-05-10 22:08:20 -0700162 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -0800163 item.attrs,
David Tolnayddf69e22020-05-10 22:08:20 -0700164 attrs::Parser {
165 doc: Some(&mut doc),
David Tolnayfbc46692020-11-27 11:33:29 -0800166 derives: Some(&mut derives),
David Tolnayddf69e22020-05-10 22:08:20 -0700167 repr: Some(&mut repr),
David Tolnayd7a3a182020-11-01 20:45:14 -0800168 namespace: Some(&mut namespace),
David Tolnay885be132020-12-21 15:52:47 -0800169 cxx_name: Some(&mut cxx_name),
170 rust_name: Some(&mut rust_name),
David Tolnayddf69e22020-05-10 22:08:20 -0700171 ..Default::default()
172 },
173 );
Joel Galensonc03402a2020-04-23 17:31:09 -0700174
David Tolnaybc954d92020-12-21 15:17:10 -0800175 let generics = &item.generics;
176 if !generics.params.is_empty() || generics.where_clause.is_some() {
177 let enum_token = item.enum_token;
178 let ident = &item.ident;
179 let where_clause = &generics.where_clause;
180 let span = quote!(#enum_token #ident #generics #where_clause);
181 return Err(Error::new_spanned(
182 span,
183 "enums with generic parameters are not allowed",
184 ));
185 }
186
Joel Galenson88547732020-05-05 08:23:42 -0700187 let mut variants = Vec::new();
David Tolnayddf69e22020-05-10 22:08:20 -0700188 let mut discriminants = DiscriminantSet::new(repr);
Joel Galenson88547732020-05-05 08:23:42 -0700189 for variant in item.variants {
David Tolnay6bf9ef42020-12-21 16:11:40 -0800190 match parse_variant(cx, variant, &mut discriminants) {
David Tolnay26809232020-12-21 16:06:47 -0800191 Ok(variant) => variants.push(variant),
192 Err(err) => cx.push(err),
Joel Galensonc03402a2020-04-23 17:31:09 -0700193 }
194 }
195
David Tolnaye2e303f2020-05-10 20:52:00 -0700196 let enum_token = item.enum_token;
197 let brace_token = item.brace_token;
198
David Tolnay58eee392020-11-20 20:37:58 -0800199 let explicit_repr = repr.is_some();
David Tolnay0435a812020-05-10 21:58:15 -0700200 let mut repr = U8;
201 match discriminants.inferred_repr() {
202 Ok(inferred) => repr = inferred,
David Tolnaye2e303f2020-05-10 20:52:00 -0700203 Err(err) => {
204 let span = quote_spanned!(brace_token.span=> #enum_token {});
David Tolnay0435a812020-05-10 21:58:15 -0700205 cx.error(span, err);
206 variants.clear();
David Tolnaye2e303f2020-05-10 20:52:00 -0700207 }
David Tolnay0435a812020-05-10 21:58:15 -0700208 }
David Tolnaye2e303f2020-05-10 20:52:00 -0700209
David Tolnay885be132020-12-21 15:52:47 -0800210 let name = pair(namespace, &item.ident, cxx_name, rust_name);
David Tolnayddbcb522020-12-21 15:24:45 -0800211 let repr_ident = Ident::new(repr.as_ref(), Span::call_site());
212 let repr_type = Type::Ident(RustName::new(repr_ident));
David Tolnay9a69d8a2020-11-16 09:16:41 -0800213
Joel Galensonc03402a2020-04-23 17:31:09 -0700214 Ok(Api::Enum(Enum {
215 doc,
David Tolnayfbc46692020-11-27 11:33:29 -0800216 derives,
David Tolnay067638e2020-12-30 16:18:05 -0800217 attrs,
David Tolnaye2e303f2020-05-10 20:52:00 -0700218 enum_token,
David Tolnayddbcb522020-12-21 15:24:45 -0800219 name,
David Tolnaye2e303f2020-05-10 20:52:00 -0700220 brace_token,
David Tolnay7ae018f2020-05-05 10:11:30 -0700221 variants,
David Tolnaye2e303f2020-05-10 20:52:00 -0700222 repr,
David Tolnay9a69d8a2020-11-16 09:16:41 -0800223 repr_type,
David Tolnay58eee392020-11-20 20:37:58 -0800224 explicit_repr,
Joel Galensonc03402a2020-04-23 17:31:09 -0700225 }))
226}
227
David Tolnay6bf9ef42020-12-21 16:11:40 -0800228fn parse_variant(
229 cx: &mut Errors,
David Tolnay15a1fc12020-12-30 16:04:56 -0800230 mut variant: RustVariant,
David Tolnay6bf9ef42020-12-21 16:11:40 -0800231 discriminants: &mut DiscriminantSet,
232) -> Result<Variant> {
David Tolnay4486f722020-12-30 00:01:26 -0800233 let mut doc = Doc::new();
David Tolnay6bf9ef42020-12-21 16:11:40 -0800234 let mut cxx_name = None;
235 let mut rust_name = None;
David Tolnay067638e2020-12-30 16:18:05 -0800236 let attrs = attrs::parse(
David Tolnay6bf9ef42020-12-21 16:11:40 -0800237 cx,
David Tolnay067638e2020-12-30 16:18:05 -0800238 mem::take(&mut variant.attrs),
David Tolnay6bf9ef42020-12-21 16:11:40 -0800239 attrs::Parser {
David Tolnay4486f722020-12-30 00:01:26 -0800240 doc: Some(&mut doc),
David Tolnay6bf9ef42020-12-21 16:11:40 -0800241 cxx_name: Some(&mut cxx_name),
242 rust_name: Some(&mut rust_name),
243 ..Default::default()
244 },
245 );
246
David Tolnay26809232020-12-21 16:06:47 -0800247 match variant.fields {
248 Fields::Unit => {}
249 _ => {
250 let msg = "enums with data are not supported yet";
251 return Err(Error::new_spanned(variant, msg));
252 }
253 }
254
255 let expr = variant.discriminant.as_ref().map(|(_, expr)| expr);
256 let try_discriminant = match &expr {
257 Some(lit) => discriminants.insert(lit),
258 None => discriminants.insert_next(),
259 };
260 let discriminant = match try_discriminant {
261 Ok(discriminant) => discriminant,
262 Err(err) => return Err(Error::new_spanned(variant, err)),
263 };
David Tolnaye6f62142020-12-21 16:00:41 -0800264
David Tolnay6bf9ef42020-12-21 16:11:40 -0800265 let name = pair(Namespace::ROOT, &variant.ident, cxx_name, rust_name);
David Tolnay26809232020-12-21 16:06:47 -0800266 let expr = variant.discriminant.map(|(_, expr)| expr);
267
268 Ok(Variant {
David Tolnay4486f722020-12-30 00:01:26 -0800269 doc,
David Tolnay067638e2020-12-30 16:18:05 -0800270 attrs,
David Tolnaye6f62142020-12-21 16:00:41 -0800271 name,
David Tolnay26809232020-12-21 16:06:47 -0800272 discriminant,
273 expr,
274 })
275}
276
David Tolnay805dca32020-08-29 19:09:55 -0700277fn parse_foreign_mod(
278 cx: &mut Errors,
279 foreign_mod: ItemForeignMod,
280 out: &mut Vec<Api>,
281 trusted: bool,
David Tolnayd7a3a182020-11-01 20:45:14 -0800282 namespace: &Namespace,
David Tolnay805dca32020-08-29 19:09:55 -0700283) {
David Tolnay3a451732020-08-29 18:54:55 -0700284 let lang = match parse_lang(&foreign_mod.abi) {
David Tolnay52759782020-05-03 23:59:40 -0700285 Ok(lang) => lang,
286 Err(err) => return cx.push(err),
287 };
David Tolnay7db73692019-10-20 14:51:12 -0400288
David Tolnay3a451732020-08-29 18:54:55 -0700289 match lang {
290 Lang::Rust => {
David Tolnay805dca32020-08-29 19:09:55 -0700291 if foreign_mod.unsafety.is_some() {
David Tolnay3a451732020-08-29 18:54:55 -0700292 let unsafety = foreign_mod.unsafety;
David Tolnay7be5b1f2020-11-11 10:48:32 -0800293 let abi = &foreign_mod.abi;
David Tolnay3a451732020-08-29 18:54:55 -0700294 let span = quote!(#unsafety #abi);
295 cx.error(span, "extern \"Rust\" block does not need to be unsafe");
296 }
297 }
298 Lang::Cxx => {}
299 }
300
David Tolnay805dca32020-08-29 19:09:55 -0700301 let trusted = trusted || foreign_mod.unsafety.is_some();
302
David Tolnay7feb2642020-11-10 18:49:04 -0800303 let mut namespace = namespace.clone();
304 attrs::parse(
305 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -0800306 foreign_mod.attrs,
David Tolnay7feb2642020-11-10 18:49:04 -0800307 attrs::Parser {
308 namespace: Some(&mut namespace),
309 ..Default::default()
310 },
311 );
312
Joel Galensone1e969d2020-04-21 12:50:20 -0700313 let mut items = Vec::new();
David Tolnay15a1fc12020-12-30 16:04:56 -0800314 for foreign in foreign_mod.items {
Joel Galensone1e969d2020-04-21 12:50:20 -0700315 match foreign {
Adrian Taylorc8713432020-10-21 18:20:55 -0700316 ForeignItem::Type(foreign) => {
David Tolnayf5ead102020-11-24 17:08:05 -0800317 let ety = parse_extern_type(cx, foreign, lang, trusted, &namespace);
318 items.push(ety);
Adrian Taylorc8713432020-10-21 18:20:55 -0700319 }
David Tolnay556738d2020-11-15 13:58:44 -0800320 ForeignItem::Fn(foreign) => {
321 match parse_extern_fn(cx, foreign, lang, trusted, &namespace) {
322 Ok(efn) => items.push(efn),
323 Err(err) => cx.push(err),
324 }
325 }
David Tolnay7db73692019-10-20 14:51:12 -0400326 ForeignItem::Macro(foreign) if foreign.mac.path.is_ident("include") => {
David Tolnay91e87fa2020-05-11 19:10:23 -0700327 match foreign.mac.parse_body_with(parse_include) {
David Tolnay52759782020-05-03 23:59:40 -0700328 Ok(include) => items.push(Api::Include(include)),
329 Err(err) => cx.push(err),
330 }
David Tolnay7db73692019-10-20 14:51:12 -0400331 }
Adrian Taylorc8713432020-10-21 18:20:55 -0700332 ForeignItem::Verbatim(tokens) => {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800333 match parse_extern_verbatim(cx, tokens, lang, trusted, &namespace) {
Adrian Taylorc8713432020-10-21 18:20:55 -0700334 Ok(api) => items.push(api),
335 Err(err) => cx.push(err),
336 }
337 }
David Tolnay52759782020-05-03 23:59:40 -0700338 _ => cx.error(foreign, "unsupported foreign item"),
David Tolnay7db73692019-10-20 14:51:12 -0400339 }
340 }
David Tolnaya1f29c42020-04-22 18:01:38 -0700341
David Tolnay7be5b1f2020-11-11 10:48:32 -0800342 if !trusted
343 && items.iter().any(|api| match api {
344 Api::CxxFunction(efn) => efn.unsafety.is_none(),
345 _ => false,
346 })
347 {
348 cx.error(
349 foreign_mod.abi,
350 "block must be declared `unsafe extern \"C++\"` if it contains any safe-to-call C++ functions",
351 );
352 }
353
David Tolnaya1f29c42020-04-22 18:01:38 -0700354 let mut types = items.iter().filter_map(|item| match item {
David Tolnay17a934c2020-11-02 00:40:04 -0800355 Api::CxxType(ety) | Api::RustType(ety) => Some(&ety.name),
356 Api::TypeAlias(alias) => Some(&alias.name),
David Tolnaya1f29c42020-04-22 18:01:38 -0700357 _ => None,
358 });
359 if let (Some(single_type), None) = (types.next(), types.next()) {
David Tolnaye5a015a2020-05-07 21:54:26 -0700360 let single_type = single_type.clone();
David Tolnaya1f29c42020-04-22 18:01:38 -0700361 for item in &mut items {
362 if let Api::CxxFunction(efn) | Api::RustFunction(efn) = item {
363 if let Some(receiver) = &mut efn.receiver {
David Tolnay2d99b002020-12-21 14:34:35 -0800364 if receiver.ty.rust == "Self" {
365 receiver.ty.rust = single_type.rust.clone();
David Tolnaya1f29c42020-04-22 18:01:38 -0700366 }
367 }
368 }
369 }
370 }
371
David Tolnay52759782020-05-03 23:59:40 -0700372 out.extend(items);
David Tolnay7db73692019-10-20 14:51:12 -0400373}
374
David Tolnay3a451732020-08-29 18:54:55 -0700375fn parse_lang(abi: &Abi) -> Result<Lang> {
David Tolnay7db73692019-10-20 14:51:12 -0400376 let name = match &abi.name {
377 Some(name) => name,
378 None => {
379 return Err(Error::new_spanned(
380 abi,
David Tolnayc72a9f62020-11-11 10:56:26 -0800381 "ABI name is required, extern \"C++\" or extern \"Rust\"",
David Tolnay7db73692019-10-20 14:51:12 -0400382 ));
383 }
384 };
David Tolnayddbcb522020-12-21 15:24:45 -0800385
David Tolnay7db73692019-10-20 14:51:12 -0400386 match name.value().as_str() {
David Tolnayea25ac82020-11-11 10:35:23 -0800387 "C++" => Ok(Lang::Cxx),
David Tolnay7db73692019-10-20 14:51:12 -0400388 "Rust" => Ok(Lang::Rust),
David Tolnay2757ca82020-11-14 15:12:06 -0800389 _ => Err(Error::new_spanned(
390 abi,
391 "unrecognized ABI, requires either \"C++\" or \"Rust\"",
392 )),
David Tolnay7db73692019-10-20 14:51:12 -0400393 }
394}
395
David Tolnay00f236a2020-08-29 19:07:18 -0700396fn parse_extern_type(
397 cx: &mut Errors,
David Tolnay15a1fc12020-12-30 16:04:56 -0800398 foreign_type: ForeignItemType,
David Tolnay00f236a2020-08-29 19:07:18 -0700399 lang: Lang,
400 trusted: bool,
David Tolnay302b1752020-11-10 18:43:24 -0800401 namespace: &Namespace,
David Tolnayf5ead102020-11-24 17:08:05 -0800402) -> Api {
Adrian Taylorc8713432020-10-21 18:20:55 -0700403 let mut doc = Doc::new();
David Tolnay16e26202020-11-27 19:28:37 -0800404 let mut derives = Vec::new();
David Tolnay302b1752020-11-10 18:43:24 -0800405 let mut namespace = namespace.clone();
David Tolnay885be132020-12-21 15:52:47 -0800406 let mut cxx_name = None;
407 let mut rust_name = None;
David Tolnay067638e2020-12-30 16:18:05 -0800408 let attrs = attrs::parse(
Adrian Taylorc8713432020-10-21 18:20:55 -0700409 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -0800410 foreign_type.attrs,
Adrian Taylorc8713432020-10-21 18:20:55 -0700411 attrs::Parser {
412 doc: Some(&mut doc),
David Tolnay16e26202020-11-27 19:28:37 -0800413 derives: Some(&mut derives),
David Tolnayd7a3a182020-11-01 20:45:14 -0800414 namespace: Some(&mut namespace),
David Tolnay885be132020-12-21 15:52:47 -0800415 cxx_name: Some(&mut cxx_name),
416 rust_name: Some(&mut rust_name),
Adrian Taylorc8713432020-10-21 18:20:55 -0700417 ..Default::default()
418 },
419 );
David Tolnayddbcb522020-12-21 15:24:45 -0800420
David Tolnay7db73692019-10-20 14:51:12 -0400421 let type_token = foreign_type.type_token;
David Tolnay885be132020-12-21 15:52:47 -0800422 let name = pair(namespace, &foreign_type.ident, cxx_name, rust_name);
David Tolnayee312322020-12-28 22:04:10 -0800423 let generics = Lifetimes {
424 lt_token: None,
425 lifetimes: Punctuated::new(),
426 gt_token: None,
427 };
David Tolnayddbcb522020-12-21 15:24:45 -0800428 let colon_token = None;
429 let bounds = Vec::new();
David Tolnayc8361022020-08-25 21:57:53 -0700430 let semi_token = foreign_type.semi_token;
David Tolnayddbcb522020-12-21 15:24:45 -0800431
432 (match lang {
David Tolnay295ef6b2020-05-07 16:10:22 -0700433 Lang::Cxx => Api::CxxType,
434 Lang::Rust => Api::RustType,
David Tolnayddbcb522020-12-21 15:24:45 -0800435 })(ExternType {
David Tolnay16e26202020-11-27 19:28:37 -0800436 lang,
David Tolnay7db73692019-10-20 14:51:12 -0400437 doc,
David Tolnay16e26202020-11-27 19:28:37 -0800438 derives,
David Tolnay067638e2020-12-30 16:18:05 -0800439 attrs,
David Tolnay7db73692019-10-20 14:51:12 -0400440 type_token,
David Tolnayddbcb522020-12-21 15:24:45 -0800441 name,
David Tolnayee312322020-12-28 22:04:10 -0800442 generics,
David Tolnayddbcb522020-12-21 15:24:45 -0800443 colon_token,
444 bounds,
David Tolnayc8361022020-08-25 21:57:53 -0700445 semi_token,
David Tolnay00f236a2020-08-29 19:07:18 -0700446 trusted,
David Tolnayf5ead102020-11-24 17:08:05 -0800447 })
David Tolnay7db73692019-10-20 14:51:12 -0400448}
449
Adrian Taylorc8713432020-10-21 18:20:55 -0700450fn parse_extern_fn(
451 cx: &mut Errors,
David Tolnay15a1fc12020-12-30 16:04:56 -0800452 mut foreign_fn: ForeignItemFn,
Adrian Taylorc8713432020-10-21 18:20:55 -0700453 lang: Lang,
David Tolnay556738d2020-11-15 13:58:44 -0800454 trusted: bool,
David Tolnay302b1752020-11-10 18:43:24 -0800455 namespace: &Namespace,
Adrian Taylorc8713432020-10-21 18:20:55 -0700456) -> Result<Api> {
David Tolnaybc954d92020-12-21 15:17:10 -0800457 let mut doc = Doc::new();
David Tolnaya2dfcbf2020-12-21 15:46:24 -0800458 let mut namespace = namespace.clone();
David Tolnaybc954d92020-12-21 15:17:10 -0800459 let mut cxx_name = None;
460 let mut rust_name = None;
David Tolnay067638e2020-12-30 16:18:05 -0800461 let attrs = attrs::parse(
David Tolnaybc954d92020-12-21 15:17:10 -0800462 cx,
David Tolnay067638e2020-12-30 16:18:05 -0800463 mem::take(&mut foreign_fn.attrs),
David Tolnaybc954d92020-12-21 15:17:10 -0800464 attrs::Parser {
465 doc: Some(&mut doc),
David Tolnaya2dfcbf2020-12-21 15:46:24 -0800466 namespace: Some(&mut namespace),
David Tolnaybc954d92020-12-21 15:17:10 -0800467 cxx_name: Some(&mut cxx_name),
468 rust_name: Some(&mut rust_name),
David Tolnaybc954d92020-12-21 15:17:10 -0800469 ..Default::default()
470 },
471 );
472
David Tolnay7db73692019-10-20 14:51:12 -0400473 let generics = &foreign_fn.sig.generics;
David Tolnay9938b642020-11-15 18:11:40 -0800474 if generics.where_clause.is_some()
475 || generics.params.iter().any(|param| match param {
476 GenericParam::Lifetime(lifetime) => !lifetime.bounds.is_empty(),
477 GenericParam::Type(_) | GenericParam::Const(_) => true,
478 })
479 {
David Tolnay7db73692019-10-20 14:51:12 -0400480 return Err(Error::new_spanned(
481 foreign_fn,
482 "extern function with generic parameters is not supported yet",
483 ));
484 }
David Tolnayddbcb522020-12-21 15:24:45 -0800485
David Tolnay7db73692019-10-20 14:51:12 -0400486 if let Some(variadic) = &foreign_fn.sig.variadic {
487 return Err(Error::new_spanned(
488 variadic,
489 "variadic function is not supported yet",
490 ));
491 }
David Tolnayddbcb522020-12-21 15:24:45 -0800492
David Tolnay8de461f2020-11-19 13:46:14 -0800493 if foreign_fn.sig.asyncness.is_some() {
494 return Err(Error::new_spanned(
495 foreign_fn,
496 "async function is not directly supported yet, but see https://cxx.rs/async.html for a working approach",
497 ));
498 }
David Tolnayddbcb522020-12-21 15:24:45 -0800499
David Tolnay80ef0682020-11-19 13:56:07 -0800500 if foreign_fn.sig.constness.is_some() {
501 return Err(Error::new_spanned(
502 foreign_fn,
503 "const extern function is not supported",
504 ));
505 }
David Tolnayddbcb522020-12-21 15:24:45 -0800506
David Tolnay80ef0682020-11-19 13:56:07 -0800507 if let Some(abi) = &foreign_fn.sig.abi {
508 return Err(Error::new_spanned(
509 abi,
510 "explicit ABI on extern function is not supported",
511 ));
512 }
David Tolnay7db73692019-10-20 14:51:12 -0400513
514 let mut receiver = None;
David Tolnaye3a48152020-04-08 19:38:05 -0700515 let mut args = Punctuated::new();
516 for arg in foreign_fn.sig.inputs.pairs() {
517 let (arg, comma) = arg.into_tuple();
David Tolnay7db73692019-10-20 14:51:12 -0400518 match arg {
David Tolnay1dd11a12020-04-22 12:31:48 -0700519 FnArg::Receiver(arg) => {
David Tolnaya1f29c42020-04-22 18:01:38 -0700520 if let Some((ampersand, lifetime)) = &arg.reference {
521 receiver = Some(Receiver {
David Tolnay9c76c392020-11-15 16:07:08 -0800522 pinned: false,
David Tolnaya1f29c42020-04-22 18:01:38 -0700523 ampersand: *ampersand,
524 lifetime: lifetime.clone(),
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800525 mutable: arg.mutability.is_some(),
David Tolnaya1f29c42020-04-22 18:01:38 -0700526 var: arg.self_token,
David Tolnay2d99b002020-12-21 14:34:35 -0800527 ty: RustName::new(Ident::new("Self", arg.self_token.span)),
David Tolnaya1f29c42020-04-22 18:01:38 -0700528 shorthand: true,
David Tolnay9c76c392020-11-15 16:07:08 -0800529 pin_tokens: None,
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800530 mutability: arg.mutability,
David Tolnaya1f29c42020-04-22 18:01:38 -0700531 });
532 continue;
Joel Galensone1e969d2020-04-21 12:50:20 -0700533 }
David Tolnay1dd11a12020-04-22 12:31:48 -0700534 return Err(Error::new_spanned(arg, "unsupported signature"));
David Tolnay7db73692019-10-20 14:51:12 -0400535 }
536 FnArg::Typed(arg) => {
537 let ident = match arg.pat.as_ref() {
538 Pat::Ident(pat) => pat.ident.clone(),
Joel Galensonba676072020-04-27 15:55:45 -0700539 Pat::Wild(pat) => {
David Tolnayb4c14552020-12-29 15:44:19 -0800540 Ident::new(&format!("arg{}", args.len()), pat.underscore_token.span)
Joel Galensonba676072020-04-27 15:55:45 -0700541 }
David Tolnay7db73692019-10-20 14:51:12 -0400542 _ => return Err(Error::new_spanned(arg, "unsupported signature")),
543 };
David Tolnay313cc0a2020-11-24 21:47:01 -0800544 let ty = parse_type(&arg.ty)?;
David Tolnay7db73692019-10-20 14:51:12 -0400545 if ident != "self" {
David Tolnayb4a05c32020-12-30 15:37:01 -0800546 let doc = Doc::new();
David Tolnay067638e2020-12-30 16:18:05 -0800547 let attrs = Vec::new();
David Tolnay89902442020-12-30 15:10:40 -0800548 let visibility = Token![pub](ident.span());
549 args.push_value(Var {
David Tolnayb4a05c32020-12-30 15:37:01 -0800550 doc,
David Tolnay067638e2020-12-30 16:18:05 -0800551 attrs,
David Tolnay89902442020-12-30 15:10:40 -0800552 visibility,
553 ident,
554 ty,
555 });
David Tolnaye3a48152020-04-08 19:38:05 -0700556 if let Some(comma) = comma {
557 args.push_punct(*comma);
558 }
David Tolnay7db73692019-10-20 14:51:12 -0400559 continue;
560 }
561 if let Type::Ref(reference) = ty {
562 if let Type::Ident(ident) = reference.inner {
563 receiver = Some(Receiver {
David Tolnay9c76c392020-11-15 16:07:08 -0800564 pinned: reference.pinned,
David Tolnayfb6e3862020-04-20 01:33:23 -0700565 ampersand: reference.ampersand,
David Tolnay0bd50fa2020-04-22 15:31:33 -0700566 lifetime: reference.lifetime,
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800567 mutable: reference.mutable,
Adrian Taylorc8713432020-10-21 18:20:55 -0700568 var: Token![self](ident.rust.span()),
David Tolnay05e11cc2020-04-20 02:13:56 -0700569 ty: ident,
David Tolnay62d360c2020-04-22 16:26:21 -0700570 shorthand: false,
David Tolnay9c76c392020-11-15 16:07:08 -0800571 pin_tokens: reference.pin_tokens,
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800572 mutability: reference.mutability,
David Tolnay7db73692019-10-20 14:51:12 -0400573 });
574 continue;
575 }
576 }
577 return Err(Error::new_spanned(arg, "unsupported method receiver"));
578 }
579 }
580 }
David Tolnay59b7ede2020-03-16 00:30:23 -0700581
David Tolnaye3a48152020-04-08 19:38:05 -0700582 let mut throws_tokens = None;
David Tolnay313cc0a2020-11-24 21:47:01 -0800583 let ret = parse_return_type(&foreign_fn.sig.output, &mut throws_tokens)?;
David Tolnaye3a48152020-04-08 19:38:05 -0700584 let throws = throws_tokens.is_some();
David Tolnaybdb576c2020-09-06 23:45:55 -0700585 let unsafety = foreign_fn.sig.unsafety;
David Tolnay7db73692019-10-20 14:51:12 -0400586 let fn_token = foreign_fn.sig.fn_token;
David Tolnay6a990f82020-12-21 15:42:31 -0800587 let name = pair(namespace, &foreign_fn.sig.ident, cxx_name, rust_name);
David Tolnay9938b642020-11-15 18:11:40 -0800588 let generics = generics.clone();
David Tolnaye3a48152020-04-08 19:38:05 -0700589 let paren_token = foreign_fn.sig.paren_token;
David Tolnay7db73692019-10-20 14:51:12 -0400590 let semi_token = foreign_fn.semi_token;
David Tolnayddbcb522020-12-21 15:24:45 -0800591
592 Ok(match lang {
David Tolnay295ef6b2020-05-07 16:10:22 -0700593 Lang::Cxx => Api::CxxFunction,
594 Lang::Rust => Api::RustFunction,
David Tolnayddbcb522020-12-21 15:24:45 -0800595 }(ExternFn {
David Tolnay6cde49f2020-03-16 12:25:45 -0700596 lang,
David Tolnay7db73692019-10-20 14:51:12 -0400597 doc,
David Tolnay067638e2020-12-30 16:18:05 -0800598 attrs,
David Tolnay17a934c2020-11-02 00:40:04 -0800599 name,
David Tolnay16448732020-03-18 12:39:36 -0700600 sig: Signature {
David Tolnaybdb576c2020-09-06 23:45:55 -0700601 unsafety,
David Tolnay16448732020-03-18 12:39:36 -0700602 fn_token,
David Tolnay9938b642020-11-15 18:11:40 -0800603 generics,
David Tolnay16448732020-03-18 12:39:36 -0700604 receiver,
605 args,
606 ret,
607 throws,
David Tolnaye3a48152020-04-08 19:38:05 -0700608 paren_token,
609 throws_tokens,
David Tolnay16448732020-03-18 12:39:36 -0700610 },
David Tolnay7db73692019-10-20 14:51:12 -0400611 semi_token,
David Tolnay556738d2020-11-15 13:58:44 -0800612 trusted,
David Tolnay295ef6b2020-05-07 16:10:22 -0700613 }))
David Tolnay7db73692019-10-20 14:51:12 -0400614}
615
Adrian Taylorc8713432020-10-21 18:20:55 -0700616fn parse_extern_verbatim(
617 cx: &mut Errors,
David Tolnay15a1fc12020-12-30 16:04:56 -0800618 tokens: TokenStream,
Adrian Taylorc8713432020-10-21 18:20:55 -0700619 lang: Lang,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800620 trusted: bool,
David Tolnay302b1752020-11-10 18:43:24 -0800621 namespace: &Namespace,
Adrian Taylorc8713432020-10-21 18:20:55 -0700622) -> Result<Api> {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800623 |input: ParseStream| -> Result<Api> {
David Tolnaye2f9ec42020-05-07 16:19:33 -0700624 let attrs = input.call(Attribute::parse_outer)?;
David Tolnayd6143702020-12-29 23:48:09 -0800625 input.parse::<Visibility>()?;
David Tolnaye2f9ec42020-05-07 16:19:33 -0700626 let type_token: Token![type] = match input.parse()? {
627 Some(type_token) => type_token,
628 None => {
629 let span = input.cursor().token_stream();
630 return Err(Error::new_spanned(span, "unsupported foreign item"));
631 }
632 };
633 let ident: Ident = input.parse()?;
David Tolnaye81647f2020-12-28 19:30:01 -0800634 let generics: Generics = input.parse()?;
David Tolnayee312322020-12-28 22:04:10 -0800635 let mut lifetimes = Punctuated::new();
David Tolnaye81647f2020-12-28 19:30:01 -0800636 let mut has_unsupported_generic_param = false;
David Tolnayee312322020-12-28 22:04:10 -0800637 for pair in generics.params.into_pairs() {
638 let (param, punct) = pair.into_tuple();
David Tolnaye81647f2020-12-28 19:30:01 -0800639 match param {
640 GenericParam::Lifetime(param) => {
641 if !param.bounds.is_empty() && !has_unsupported_generic_param {
642 let msg = "lifetime parameter with bounds is not supported yet";
643 cx.error(&param, msg);
644 has_unsupported_generic_param = true;
645 }
David Tolnayee312322020-12-28 22:04:10 -0800646 lifetimes.push_value(param.lifetime);
647 if let Some(punct) = punct {
648 lifetimes.push_punct(punct);
649 }
David Tolnaye81647f2020-12-28 19:30:01 -0800650 }
651 GenericParam::Type(param) => {
652 if !has_unsupported_generic_param {
653 let msg = "extern type with generic type parameter is not supported yet";
654 cx.error(&param, msg);
655 has_unsupported_generic_param = true;
656 }
657 }
658 GenericParam::Const(param) => {
659 if !has_unsupported_generic_param {
660 let msg = "extern type with const generic parameter is not supported yet";
661 cx.error(&param, msg);
662 has_unsupported_generic_param = true;
663 }
664 }
665 }
666 }
David Tolnayee312322020-12-28 22:04:10 -0800667 let lifetimes = Lifetimes {
668 lt_token: generics.lt_token,
669 lifetimes,
670 gt_token: generics.gt_token,
671 };
David Tolnayb7eb65e2020-11-27 20:00:53 -0800672 let lookahead = input.lookahead1();
673 if lookahead.peek(Token![=]) {
674 // type Alias = crate::path::to::Type;
David Tolnaye81647f2020-12-28 19:30:01 -0800675 parse_type_alias(
676 cx, attrs, type_token, ident, lifetimes, input, lang, namespace,
677 )
David Tolnaya870ac72020-12-28 19:48:33 -0800678 } else if lookahead.peek(Token![:]) || lookahead.peek(Token![;]) {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800679 // type Opaque: Bound2 + Bound2;
680 parse_extern_type_bounded(
David Tolnaye81647f2020-12-28 19:30:01 -0800681 cx, attrs, type_token, ident, lifetimes, input, lang, trusted, namespace,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800682 )
683 } else {
684 Err(lookahead.error())
David Tolnaye2f9ec42020-05-07 16:19:33 -0700685 }
686 }
David Tolnay15a1fc12020-12-30 16:04:56 -0800687 .parse2(tokens)
David Tolnayb7eb65e2020-11-27 20:00:53 -0800688}
689
690fn parse_type_alias(
691 cx: &mut Errors,
692 attrs: Vec<Attribute>,
693 type_token: Token![type],
694 ident: Ident,
David Tolnayee312322020-12-28 22:04:10 -0800695 generics: Lifetimes,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800696 input: ParseStream,
697 lang: Lang,
698 namespace: &Namespace,
699) -> Result<Api> {
700 let eq_token: Token![=] = input.parse()?;
701 let ty: RustType = input.parse()?;
702 let semi_token: Token![;] = input.parse()?;
703
704 let mut doc = Doc::new();
705 let mut derives = Vec::new();
706 let mut namespace = namespace.clone();
David Tolnay885be132020-12-21 15:52:47 -0800707 let mut cxx_name = None;
708 let mut rust_name = None;
David Tolnay067638e2020-12-30 16:18:05 -0800709 let attrs = attrs::parse(
David Tolnayb7eb65e2020-11-27 20:00:53 -0800710 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -0800711 attrs,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800712 attrs::Parser {
713 doc: Some(&mut doc),
714 derives: Some(&mut derives),
715 namespace: Some(&mut namespace),
David Tolnay885be132020-12-21 15:52:47 -0800716 cxx_name: Some(&mut cxx_name),
717 rust_name: Some(&mut rust_name),
David Tolnayb7eb65e2020-11-27 20:00:53 -0800718 ..Default::default()
719 },
720 );
721
722 if lang == Lang::Rust {
723 let span = quote!(#type_token #semi_token);
724 let msg = "type alias in extern \"Rust\" block is not supported";
725 return Err(Error::new_spanned(span, msg));
726 }
727
David Tolnay885be132020-12-21 15:52:47 -0800728 let name = pair(namespace, &ident, cxx_name, rust_name);
David Tolnayddbcb522020-12-21 15:24:45 -0800729
David Tolnayb7eb65e2020-11-27 20:00:53 -0800730 Ok(Api::TypeAlias(TypeAlias {
731 doc,
732 derives,
David Tolnay067638e2020-12-30 16:18:05 -0800733 attrs,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800734 type_token,
David Tolnayddbcb522020-12-21 15:24:45 -0800735 name,
David Tolnayee312322020-12-28 22:04:10 -0800736 generics,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800737 eq_token,
738 ty,
739 semi_token,
740 }))
741}
742
743fn parse_extern_type_bounded(
744 cx: &mut Errors,
745 attrs: Vec<Attribute>,
746 type_token: Token![type],
747 ident: Ident,
David Tolnayee312322020-12-28 22:04:10 -0800748 generics: Lifetimes,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800749 input: ParseStream,
750 lang: Lang,
751 trusted: bool,
752 namespace: &Namespace,
753) -> Result<Api> {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800754 let mut bounds = Vec::new();
David Tolnaya870ac72020-12-28 19:48:33 -0800755 let colon_token: Option<Token![:]> = input.parse()?;
756 if colon_token.is_some() {
757 loop {
758 match input.parse()? {
759 TypeParamBound::Trait(TraitBound {
760 paren_token: None,
761 modifier: TraitBoundModifier::None,
762 lifetimes: None,
763 path,
764 }) if if let Some(derive) = path.get_ident().and_then(Derive::from) {
765 bounds.push(derive);
766 true
767 } else {
768 false
769 } => {}
770 bound @ TypeParamBound::Trait(_) | bound @ TypeParamBound::Lifetime(_) => {
771 cx.error(bound, "unsupported trait");
772 }
David Tolnayb7eb65e2020-11-27 20:00:53 -0800773 }
David Tolnayb7eb65e2020-11-27 20:00:53 -0800774
David Tolnaya870ac72020-12-28 19:48:33 -0800775 let lookahead = input.lookahead1();
776 if lookahead.peek(Token![+]) {
777 input.parse::<Token![+]>()?;
778 } else if lookahead.peek(Token![;]) {
779 break;
780 } else {
781 return Err(lookahead.error());
782 }
David Tolnayb7eb65e2020-11-27 20:00:53 -0800783 }
784 }
785 let semi_token: Token![;] = input.parse()?;
786
787 let mut doc = Doc::new();
788 let mut derives = Vec::new();
789 let mut namespace = namespace.clone();
David Tolnay885be132020-12-21 15:52:47 -0800790 let mut cxx_name = None;
791 let mut rust_name = None;
David Tolnay067638e2020-12-30 16:18:05 -0800792 let attrs = attrs::parse(
David Tolnayb7eb65e2020-11-27 20:00:53 -0800793 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -0800794 attrs,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800795 attrs::Parser {
796 doc: Some(&mut doc),
797 derives: Some(&mut derives),
798 namespace: Some(&mut namespace),
David Tolnay885be132020-12-21 15:52:47 -0800799 cxx_name: Some(&mut cxx_name),
800 rust_name: Some(&mut rust_name),
David Tolnayb7eb65e2020-11-27 20:00:53 -0800801 ..Default::default()
802 },
803 );
804
David Tolnay885be132020-12-21 15:52:47 -0800805 let name = pair(namespace, &ident, cxx_name, rust_name);
David Tolnayddbcb522020-12-21 15:24:45 -0800806
807 Ok(match lang {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800808 Lang::Cxx => Api::CxxType,
809 Lang::Rust => Api::RustType,
David Tolnayddbcb522020-12-21 15:24:45 -0800810 }(ExternType {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800811 lang,
812 doc,
813 derives,
David Tolnay067638e2020-12-30 16:18:05 -0800814 attrs,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800815 type_token,
David Tolnayddbcb522020-12-21 15:24:45 -0800816 name,
David Tolnayee312322020-12-28 22:04:10 -0800817 generics,
David Tolnayddbcb522020-12-21 15:24:45 -0800818 colon_token,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800819 bounds,
820 semi_token,
821 trusted,
822 }))
David Tolnaye2f9ec42020-05-07 16:19:33 -0700823}
824
David Tolnay313cc0a2020-11-24 21:47:01 -0800825fn parse_impl(imp: ItemImpl) -> Result<Api> {
David Tolnay7e69f892020-10-03 22:20:22 -0700826 if !imp.items.is_empty() {
827 let mut span = Group::new(Delimiter::Brace, TokenStream::new());
828 span.set_span(imp.brace_token.span);
829 return Err(Error::new_spanned(span, "expected an empty impl block"));
830 }
831
David Tolnay7e69f892020-10-03 22:20:22 -0700832 if let Some((bang, path, for_token)) = &imp.trait_ {
David Tolnay028d3d22020-11-29 18:09:52 -0800833 let self_ty = &imp.self_ty;
David Tolnay7e69f892020-10-03 22:20:22 -0700834 let span = quote!(#bang #path #for_token #self_ty);
835 return Err(Error::new_spanned(
836 span,
837 "unexpected impl, expected something like `impl UniquePtr<T> {}`",
838 ));
839 }
840
841 let generics = &imp.generics;
842 if !generics.params.is_empty() || generics.where_clause.is_some() {
843 return Err(Error::new_spanned(
844 imp,
845 "generic parameters on an impl is not supported",
846 ));
847 }
848
David Tolnay028d3d22020-11-29 18:09:52 -0800849 let mut negative_token = None;
850 let mut self_ty = *imp.self_ty;
851 if let RustType::Verbatim(ty) = &self_ty {
852 let mut iter = ty.clone().into_iter();
853 if let Some(TokenTree::Punct(punct)) = iter.next() {
854 if punct.as_char() == '!' {
855 let ty = iter.collect::<TokenStream>();
856 if !ty.is_empty() {
857 negative_token = Some(Token![!](punct.span()));
858 self_ty = syn::parse2(ty)?;
859 }
860 }
861 }
862 }
863
David Tolnayddbcb522020-12-21 15:24:45 -0800864 let impl_token = imp.impl_token;
865 let negative = negative_token.is_some();
866 let ty = parse_type(&self_ty)?;
867 let brace_token = imp.brace_token;
868
David Tolnay7e69f892020-10-03 22:20:22 -0700869 Ok(Api::Impl(Impl {
David Tolnayddbcb522020-12-21 15:24:45 -0800870 impl_token,
871 negative,
872 ty,
873 brace_token,
David Tolnay028d3d22020-11-29 18:09:52 -0800874 negative_token,
David Tolnay7e69f892020-10-03 22:20:22 -0700875 }))
876}
877
David Tolnayb0cd3272020-10-27 21:32:54 -0700878fn parse_include(input: ParseStream) -> Result<Include> {
David Tolnay91e87fa2020-05-11 19:10:23 -0700879 if input.peek(LitStr) {
David Tolnayb0cd3272020-10-27 21:32:54 -0700880 let lit: LitStr = input.parse()?;
881 let span = lit.span();
882 return Ok(Include {
883 path: lit.value(),
884 kind: IncludeKind::Quoted,
885 begin_span: span,
886 end_span: span,
887 });
David Tolnay91e87fa2020-05-11 19:10:23 -0700888 }
889
890 if input.peek(Token![<]) {
891 let mut path = String::new();
David Tolnayb0cd3272020-10-27 21:32:54 -0700892
David Tolnay2cc2e3a2020-10-28 13:12:35 -0700893 let langle: Token![<] = input.parse()?;
David Tolnay91e87fa2020-05-11 19:10:23 -0700894 while !input.is_empty() && !input.peek(Token![>]) {
895 let token: TokenTree = input.parse()?;
896 match token {
897 TokenTree::Ident(token) => path += &token.to_string(),
898 TokenTree::Literal(token)
899 if token
900 .to_string()
901 .starts_with(|ch: char| ch.is_ascii_digit()) =>
902 {
903 path += &token.to_string();
904 }
905 TokenTree::Punct(token) => path.push(token.as_char()),
906 _ => return Err(Error::new(token.span(), "unexpected token in include path")),
907 }
908 }
David Tolnayb0cd3272020-10-27 21:32:54 -0700909 let rangle: Token![>] = input.parse()?;
David Tolnayb0cd3272020-10-27 21:32:54 -0700910
911 return Ok(Include {
912 path,
913 kind: IncludeKind::Bracketed,
David Tolnay2cc2e3a2020-10-28 13:12:35 -0700914 begin_span: langle.span,
915 end_span: rangle.span,
David Tolnayb0cd3272020-10-27 21:32:54 -0700916 });
David Tolnay91e87fa2020-05-11 19:10:23 -0700917 }
918
919 Err(input.error("expected \"quoted/path/to\" or <bracketed/path/to>"))
920}
921
David Tolnay313cc0a2020-11-24 21:47:01 -0800922fn parse_type(ty: &RustType) -> Result<Type> {
David Tolnay59b7ede2020-03-16 00:30:23 -0700923 match ty {
David Tolnay313cc0a2020-11-24 21:47:01 -0800924 RustType::Reference(ty) => parse_type_reference(ty),
925 RustType::Path(ty) => parse_type_path(ty),
David Tolnay313cc0a2020-11-24 21:47:01 -0800926 RustType::Array(ty) => parse_type_array(ty),
927 RustType::BareFn(ty) => parse_type_fn(ty),
David Tolnayb40b9db2020-03-18 13:50:31 -0700928 RustType::Tuple(ty) if ty.elems.is_empty() => Ok(Type::Void(ty.paren_token.span)),
929 _ => Err(Error::new_spanned(ty, "unsupported type")),
930 }
931}
932
David Tolnay313cc0a2020-11-24 21:47:01 -0800933fn parse_type_reference(ty: &TypeReference) -> Result<Type> {
David Tolnayddbcb522020-12-21 15:24:45 -0800934 let ampersand = ty.and_token;
935 let lifetime = ty.lifetime.clone();
936 let mutable = ty.mutability.is_some();
937 let mutability = ty.mutability;
938
David Tolnaye0dca7b2020-11-25 17:18:57 -0800939 if let RustType::Slice(slice) = ty.elem.as_ref() {
940 let inner = parse_type(&slice.elem)?;
David Tolnayddbcb522020-12-21 15:24:45 -0800941 let bracket = slice.bracket_token;
David Tolnay69db8142020-11-25 17:49:25 -0800942 return Ok(Type::SliceRef(Box::new(SliceRef {
David Tolnayddbcb522020-12-21 15:24:45 -0800943 ampersand,
944 lifetime,
945 mutable,
946 bracket,
David Tolnay69db8142020-11-25 17:49:25 -0800947 inner,
David Tolnayddbcb522020-12-21 15:24:45 -0800948 mutability,
David Tolnay69db8142020-11-25 17:49:25 -0800949 })));
David Tolnaye0dca7b2020-11-25 17:18:57 -0800950 }
951
David Tolnay313cc0a2020-11-24 21:47:01 -0800952 let inner = parse_type(&ty.elem)?;
David Tolnayddbcb522020-12-21 15:24:45 -0800953 let pinned = false;
954 let pin_tokens = None;
955
956 Ok(match &inner {
Adrian Taylorc8713432020-10-21 18:20:55 -0700957 Type::Ident(ident) if ident.rust == "str" => {
David Tolnayb40b9db2020-03-18 13:50:31 -0700958 if ty.mutability.is_some() {
959 return Err(Error::new_spanned(ty, "unsupported type"));
960 } else {
961 Type::Str
David Tolnay7db73692019-10-20 14:51:12 -0400962 }
963 }
David Tolnayb40b9db2020-03-18 13:50:31 -0700964 _ => Type::Ref,
David Tolnayddbcb522020-12-21 15:24:45 -0800965 }(Box::new(Ref {
966 pinned,
967 ampersand,
968 lifetime,
969 mutable,
David Tolnayb40b9db2020-03-18 13:50:31 -0700970 inner,
David Tolnayddbcb522020-12-21 15:24:45 -0800971 pin_tokens,
972 mutability,
David Tolnayb40b9db2020-03-18 13:50:31 -0700973 })))
974}
975
David Tolnay313cc0a2020-11-24 21:47:01 -0800976fn parse_type_path(ty: &TypePath) -> Result<Type> {
David Tolnayb40b9db2020-03-18 13:50:31 -0700977 let path = &ty.path;
978 if ty.qself.is_none() && path.leading_colon.is_none() && path.segments.len() == 1 {
979 let segment = &path.segments[0];
980 let ident = segment.ident.clone();
981 match &segment.arguments {
David Tolnay75ea17c2020-12-06 21:08:34 -0800982 PathArguments::None => return Ok(Type::Ident(RustName::new(ident))),
David Tolnayb40b9db2020-03-18 13:50:31 -0700983 PathArguments::AngleBracketed(generic) => {
984 if ident == "UniquePtr" && generic.args.len() == 1 {
985 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnay313cc0a2020-11-24 21:47:01 -0800986 let inner = parse_type(arg)?;
David Tolnayb40b9db2020-03-18 13:50:31 -0700987 return Ok(Type::UniquePtr(Box::new(Ty1 {
David Tolnayda71ef62020-11-02 00:36:00 -0800988 name: ident,
David Tolnayb40b9db2020-03-18 13:50:31 -0700989 langle: generic.lt_token,
990 inner,
991 rangle: generic.gt_token,
992 })));
993 }
David Tolnayb3b24a12020-12-01 15:27:43 -0800994 } else if ident == "SharedPtr" && generic.args.len() == 1 {
995 if let GenericArgument::Type(arg) = &generic.args[0] {
996 let inner = parse_type(arg)?;
997 return Ok(Type::SharedPtr(Box::new(Ty1 {
998 name: ident,
999 langle: generic.lt_token,
1000 inner,
1001 rangle: generic.gt_token,
1002 })));
1003 }
David Tolnay215e77f2020-12-28 17:09:48 -08001004 } else if ident == "WeakPtr" && generic.args.len() == 1 {
1005 if let GenericArgument::Type(arg) = &generic.args[0] {
1006 let inner = parse_type(arg)?;
1007 return Ok(Type::WeakPtr(Box::new(Ty1 {
1008 name: ident,
1009 langle: generic.lt_token,
1010 inner,
1011 rangle: generic.gt_token,
1012 })));
1013 }
David Tolnaye1dcdf72020-04-24 17:40:55 -07001014 } else if ident == "CxxVector" && generic.args.len() == 1 {
Myron Ahneba35cf2020-02-05 19:41:51 +07001015 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnay313cc0a2020-11-24 21:47:01 -08001016 let inner = parse_type(arg)?;
David Tolnay4377a9e2020-04-24 15:20:26 -07001017 return Ok(Type::CxxVector(Box::new(Ty1 {
David Tolnayda71ef62020-11-02 00:36:00 -08001018 name: ident,
Myron Ahneba35cf2020-02-05 19:41:51 +07001019 langle: generic.lt_token,
1020 inner,
1021 rangle: generic.gt_token,
1022 })));
1023 }
David Tolnayb40b9db2020-03-18 13:50:31 -07001024 } else if ident == "Box" && generic.args.len() == 1 {
1025 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnay313cc0a2020-11-24 21:47:01 -08001026 let inner = parse_type(arg)?;
David Tolnayb40b9db2020-03-18 13:50:31 -07001027 return Ok(Type::RustBox(Box::new(Ty1 {
David Tolnayda71ef62020-11-02 00:36:00 -08001028 name: ident,
David Tolnayb40b9db2020-03-18 13:50:31 -07001029 langle: generic.lt_token,
1030 inner,
1031 rangle: generic.gt_token,
1032 })));
1033 }
Myron Ahneba35cf2020-02-05 19:41:51 +07001034 } else if ident == "Vec" && generic.args.len() == 1 {
1035 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnay313cc0a2020-11-24 21:47:01 -08001036 let inner = parse_type(arg)?;
Myron Ahneba35cf2020-02-05 19:41:51 +07001037 return Ok(Type::RustVec(Box::new(Ty1 {
David Tolnayda71ef62020-11-02 00:36:00 -08001038 name: ident,
Myron Ahneba35cf2020-02-05 19:41:51 +07001039 langle: generic.lt_token,
1040 inner,
1041 rangle: generic.gt_token,
1042 })));
1043 }
David Tolnaycbc2a4b2020-11-15 15:08:44 -08001044 } else if ident == "Pin" && generic.args.len() == 1 {
1045 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnay313cc0a2020-11-24 21:47:01 -08001046 let inner = parse_type(arg)?;
David Tolnayc94035a2020-11-15 16:49:18 -08001047 let pin_token = kw::Pin(ident.span());
David Tolnaycbc2a4b2020-11-15 15:08:44 -08001048 if let Type::Ref(mut inner) = inner {
David Tolnaycbc2a4b2020-11-15 15:08:44 -08001049 inner.pinned = true;
1050 inner.pin_tokens =
1051 Some((pin_token, generic.lt_token, generic.gt_token));
1052 return Ok(Type::Ref(inner));
1053 }
1054 }
David Tolnayb40b9db2020-03-18 13:50:31 -07001055 }
1056 }
1057 PathArguments::Parenthesized(_) => {}
David Tolnayfb134ed2020-03-15 23:17:48 -07001058 }
David Tolnay7db73692019-10-20 14:51:12 -04001059 }
David Tolnayddbcb522020-12-21 15:24:45 -08001060
David Tolnay7db73692019-10-20 14:51:12 -04001061 Err(Error::new_spanned(ty, "unsupported type"))
1062}
1063
David Tolnay313cc0a2020-11-24 21:47:01 -08001064fn parse_type_array(ty: &TypeArray) -> Result<Type> {
1065 let inner = parse_type(&ty.elem)?;
David Tolnayd9f97842020-11-24 21:00:05 -08001066
1067 let len_expr = if let Expr::Lit(lit) = &ty.len {
1068 lit
1069 } else {
1070 let msg = "unsupported expression, array length must be an integer literal";
1071 return Err(Error::new_spanned(&ty.len, msg));
1072 };
1073
1074 let len_token = if let Lit::Int(int) = &len_expr.lit {
1075 int.clone()
1076 } else {
1077 let msg = "array length must be an integer literal";
1078 return Err(Error::new_spanned(len_expr, msg));
1079 };
1080
David Tolnay581f72d2020-11-25 15:48:59 -08001081 let len = len_token.base10_parse::<usize>()?;
1082 if len == 0 {
1083 let msg = "array with zero size is not supported";
1084 return Err(Error::new_spanned(ty, msg));
1085 }
1086
David Tolnayd9f97842020-11-24 21:00:05 -08001087 let bracket = ty.bracket_token;
1088 let semi_token = ty.semi_token;
David Tolnayd9f97842020-11-24 21:00:05 -08001089
1090 Ok(Type::Array(Box::new(Array {
1091 bracket,
1092 inner,
1093 semi_token,
1094 len,
1095 len_token,
1096 })))
David Tolnay2d0df232020-11-24 20:50:32 -08001097}
1098
David Tolnay313cc0a2020-11-24 21:47:01 -08001099fn parse_type_fn(ty: &TypeBareFn) -> Result<Type> {
David Tolnayc071b892020-03-18 16:59:53 -07001100 if ty.lifetimes.is_some() {
1101 return Err(Error::new_spanned(
1102 ty,
1103 "function pointer with lifetime parameters is not supported yet",
1104 ));
1105 }
David Tolnayddbcb522020-12-21 15:24:45 -08001106
David Tolnayc071b892020-03-18 16:59:53 -07001107 if ty.variadic.is_some() {
1108 return Err(Error::new_spanned(
1109 ty,
1110 "variadic function pointer is not supported yet",
1111 ));
1112 }
David Tolnayddbcb522020-12-21 15:24:45 -08001113
David Tolnayc071b892020-03-18 16:59:53 -07001114 let args = ty
1115 .inputs
1116 .iter()
1117 .enumerate()
1118 .map(|(i, arg)| {
David Tolnay313cc0a2020-11-24 21:47:01 -08001119 let ty = parse_type(&arg.ty)?;
David Tolnayc071b892020-03-18 16:59:53 -07001120 let ident = match &arg.name {
1121 Some(ident) => ident.0.clone(),
David Tolnayb4c14552020-12-29 15:44:19 -08001122 None => format_ident!("arg{}", i),
David Tolnayc071b892020-03-18 16:59:53 -07001123 };
David Tolnayb4a05c32020-12-30 15:37:01 -08001124 let doc = Doc::new();
David Tolnay067638e2020-12-30 16:18:05 -08001125 let attrs = Vec::new();
David Tolnay89902442020-12-30 15:10:40 -08001126 let visibility = Token![pub](ident.span());
1127 Ok(Var {
David Tolnayb4a05c32020-12-30 15:37:01 -08001128 doc,
David Tolnay067638e2020-12-30 16:18:05 -08001129 attrs,
David Tolnay89902442020-12-30 15:10:40 -08001130 visibility,
1131 ident,
1132 ty,
1133 })
David Tolnayc071b892020-03-18 16:59:53 -07001134 })
1135 .collect::<Result<_>>()?;
David Tolnayddbcb522020-12-21 15:24:45 -08001136
David Tolnaye3a48152020-04-08 19:38:05 -07001137 let mut throws_tokens = None;
David Tolnay313cc0a2020-11-24 21:47:01 -08001138 let ret = parse_return_type(&ty.output, &mut throws_tokens)?;
David Tolnaye3a48152020-04-08 19:38:05 -07001139 let throws = throws_tokens.is_some();
David Tolnayddbcb522020-12-21 15:24:45 -08001140
1141 let unsafety = ty.unsafety;
1142 let fn_token = ty.fn_token;
1143 let generics = Generics::default();
1144 let receiver = None;
1145 let paren_token = ty.paren_token;
1146
David Tolnayc071b892020-03-18 16:59:53 -07001147 Ok(Type::Fn(Box::new(Signature {
David Tolnayddbcb522020-12-21 15:24:45 -08001148 unsafety,
1149 fn_token,
1150 generics,
1151 receiver,
David Tolnayc071b892020-03-18 16:59:53 -07001152 args,
1153 ret,
1154 throws,
David Tolnayddbcb522020-12-21 15:24:45 -08001155 paren_token,
David Tolnaye3a48152020-04-08 19:38:05 -07001156 throws_tokens,
David Tolnayc071b892020-03-18 16:59:53 -07001157 })))
1158}
1159
David Tolnaye3a48152020-04-08 19:38:05 -07001160fn parse_return_type(
1161 ty: &ReturnType,
1162 throws_tokens: &mut Option<(kw::Result, Token![<], Token![>])>,
1163) -> Result<Option<Type>> {
David Tolnayc071b892020-03-18 16:59:53 -07001164 let mut ret = match ty {
1165 ReturnType::Default => return Ok(None),
1166 ReturnType::Type(_, ret) => ret.as_ref(),
1167 };
David Tolnayddbcb522020-12-21 15:24:45 -08001168
David Tolnayc071b892020-03-18 16:59:53 -07001169 if let RustType::Path(ty) = ret {
1170 let path = &ty.path;
1171 if ty.qself.is_none() && path.leading_colon.is_none() && path.segments.len() == 1 {
1172 let segment = &path.segments[0];
1173 let ident = segment.ident.clone();
1174 if let PathArguments::AngleBracketed(generic) = &segment.arguments {
1175 if ident == "Result" && generic.args.len() == 1 {
1176 if let GenericArgument::Type(arg) = &generic.args[0] {
1177 ret = arg;
David Tolnaye3a48152020-04-08 19:38:05 -07001178 *throws_tokens =
1179 Some((kw::Result(ident.span()), generic.lt_token, generic.gt_token));
David Tolnayc071b892020-03-18 16:59:53 -07001180 }
1181 }
1182 }
1183 }
1184 }
David Tolnayddbcb522020-12-21 15:24:45 -08001185
David Tolnay313cc0a2020-11-24 21:47:01 -08001186 match parse_type(ret)? {
David Tolnayc071b892020-03-18 16:59:53 -07001187 Type::Void(_) => Ok(None),
1188 ty => Ok(Some(ty)),
1189 }
1190}
David Tolnay6a990f82020-12-21 15:42:31 -08001191
1192fn pair(namespace: Namespace, default: &Ident, cxx: Option<Ident>, rust: Option<Ident>) -> Pair {
1193 let default = || default.clone();
David Tolnayc2a4c782020-12-21 15:55:31 -08001194 Pair {
David Tolnay6a990f82020-12-21 15:42:31 -08001195 namespace,
David Tolnayc2a4c782020-12-21 15:55:31 -08001196 cxx: cxx.unwrap_or_else(default),
1197 rust: rust.unwrap_or_else(default),
1198 }
David Tolnay6a990f82020-12-21 15:42:31 -08001199}