blob: 0fbdda2845276b34d59c663eec0660e2cc478eb2 [file] [log] [blame]
David Tolnaycba3d442020-12-30 16:39:21 -08001use crate::syntax::attrs::OtherAttrs;
David Tolnay17e137f2020-05-08 15:55:28 -07002use crate::syntax::discriminant::DiscriminantSet;
David Tolnayc598a272020-08-29 15:10:18 -07003use crate::syntax::file::{Item, ItemForeignMod};
David Tolnay52759782020-05-03 23:59:40 -07004use crate::syntax::report::Errors;
David Tolnayeebe9b72020-04-14 16:32:18 -07005use crate::syntax::Atom::*;
David Tolnay7db73692019-10-20 14:51:12 -04006use crate::syntax::{
David Tolnayb7eb65e2020-11-27 20:00:53 -08007 attrs, error, Api, Array, Derive, Doc, Enum, ExternFn, ExternType, Impl, Include, IncludeKind,
David Tolnayee312322020-12-28 22:04:10 -08008 Lang, Lifetimes, Namespace, Pair, Receiver, Ref, RustName, Signature, SliceRef, Struct, Ty1,
9 Type, TypeAlias, Var, Variant,
David Tolnay7db73692019-10-20 14:51:12 -040010};
David Tolnay9a69d8a2020-11-16 09:16:41 -080011use proc_macro2::{Delimiter, Group, Span, TokenStream, TokenTree};
David Tolnaye2e303f2020-05-10 20:52:00 -070012use quote::{format_ident, quote, quote_spanned};
David Tolnay15a1fc12020-12-30 16:04:56 -080013use std::mem;
David Tolnaye2f9ec42020-05-07 16:19:33 -070014use syn::parse::{ParseStream, Parser};
David Tolnaye3a48152020-04-08 19:38:05 -070015use syn::punctuated::Punctuated;
David Tolnay7db73692019-10-20 14:51:12 -040016use syn::{
Xiangpeng Hao78762352020-11-12 10:24:18 +080017 Abi, Attribute, Error, Expr, Fields, FnArg, ForeignItem, ForeignItemFn, ForeignItemType,
David Tolnayee312322020-12-28 22:04:10 -080018 GenericArgument, GenericParam, Generics, Ident, ItemEnum, ItemImpl, ItemStruct, Lit, LitStr,
19 Pat, PathArguments, Result, ReturnType, Token, TraitBound, TraitBoundModifier,
David Tolnayb7eb65e2020-11-27 20:00:53 -080020 Type as RustType, TypeArray, TypeBareFn, TypeParamBound, TypePath, TypeReference,
David Tolnayd6143702020-12-29 23:48:09 -080021 Variant as RustVariant, Visibility,
David Tolnay7db73692019-10-20 14:51:12 -040022};
23
David Tolnaye3a48152020-04-08 19:38:05 -070024pub mod kw {
David Tolnayb27f7872020-11-15 15:07:04 -080025 syn::custom_keyword!(Pin);
David Tolnaye3a48152020-04-08 19:38:05 -070026 syn::custom_keyword!(Result);
27}
28
David Tolnayd7a3a182020-11-01 20:45:14 -080029pub fn parse_items(
30 cx: &mut Errors,
31 items: Vec<Item>,
32 trusted: bool,
33 namespace: &Namespace,
34) -> Vec<Api> {
David Tolnay7db73692019-10-20 14:51:12 -040035 let mut apis = Vec::new();
36 for item in items {
37 match item {
David Tolnay302b1752020-11-10 18:43:24 -080038 Item::Struct(item) => match parse_struct(cx, item, namespace) {
David Tolnay52759782020-05-03 23:59:40 -070039 Ok(strct) => apis.push(strct),
40 Err(err) => cx.push(err),
41 },
David Tolnay302b1752020-11-10 18:43:24 -080042 Item::Enum(item) => match parse_enum(cx, item, namespace) {
David Tolnay52759782020-05-03 23:59:40 -070043 Ok(enm) => apis.push(enm),
44 Err(err) => cx.push(err),
45 },
Adrian Taylorc8713432020-10-21 18:20:55 -070046 Item::ForeignMod(foreign_mod) => {
David Tolnayd7a3a182020-11-01 20:45:14 -080047 parse_foreign_mod(cx, foreign_mod, &mut apis, trusted, namespace)
Adrian Taylorc8713432020-10-21 18:20:55 -070048 }
David Tolnay313cc0a2020-11-24 21:47:01 -080049 Item::Impl(item) => match parse_impl(item) {
David Tolnay7e69f892020-10-03 22:20:22 -070050 Ok(imp) => apis.push(imp),
51 Err(err) => cx.push(err),
52 },
David Tolnay52759782020-05-03 23:59:40 -070053 Item::Use(item) => cx.error(item, error::USE_NOT_ALLOWED),
David Tolnay00a83852020-08-29 15:06:16 -070054 Item::Other(item) => cx.error(item, "unsupported item"),
David Tolnay7db73692019-10-20 14:51:12 -040055 }
56 }
David Tolnay52759782020-05-03 23:59:40 -070057 apis
David Tolnay7db73692019-10-20 14:51:12 -040058}
59
David Tolnay15a1fc12020-12-30 16:04:56 -080060fn parse_struct(cx: &mut Errors, mut item: ItemStruct, namespace: &Namespace) -> Result<Api> {
David Tolnay7db73692019-10-20 14:51:12 -040061 let mut doc = Doc::new();
62 let mut derives = Vec::new();
David Tolnay302b1752020-11-10 18:43:24 -080063 let mut namespace = namespace.clone();
David Tolnay885be132020-12-21 15:52:47 -080064 let mut cxx_name = None;
65 let mut rust_name = None;
David Tolnay067638e2020-12-30 16:18:05 -080066 let attrs = attrs::parse(
David Tolnay3e628882020-05-10 15:30:14 -070067 cx,
David Tolnay067638e2020-12-30 16:18:05 -080068 mem::take(&mut item.attrs),
David Tolnayb129ea72020-05-10 14:29:30 -070069 attrs::Parser {
70 doc: Some(&mut doc),
71 derives: Some(&mut derives),
David Tolnayd7a3a182020-11-01 20:45:14 -080072 namespace: Some(&mut namespace),
David Tolnay885be132020-12-21 15:52:47 -080073 cxx_name: Some(&mut cxx_name),
74 rust_name: Some(&mut rust_name),
David Tolnayddf69e22020-05-10 22:08:20 -070075 ..Default::default()
David Tolnayb129ea72020-05-10 14:29:30 -070076 },
David Tolnay3e628882020-05-10 15:30:14 -070077 );
David Tolnay09462ac2020-03-20 14:58:41 -070078
David Tolnaybc954d92020-12-21 15:17:10 -080079 let generics = &item.generics;
80 if !generics.params.is_empty() || generics.where_clause.is_some() {
81 let struct_token = item.struct_token;
82 let ident = &item.ident;
83 let where_clause = &generics.where_clause;
84 let span = quote!(#struct_token #ident #generics #where_clause);
85 return Err(Error::new_spanned(
86 span,
87 "struct with generic parameters is not supported yet",
88 ));
89 }
90
David Tolnay302b1752020-11-10 18:43:24 -080091 let named_fields = match item.fields {
David Tolnay09462ac2020-03-20 14:58:41 -070092 Fields::Named(fields) => fields,
93 Fields::Unit => return Err(Error::new_spanned(item, "unit structs are not supported")),
94 Fields::Unnamed(_) => {
David Tolnay2c4b35f2020-10-04 21:22:30 -070095 return Err(Error::new_spanned(item, "tuple structs are not supported"));
David Tolnay09462ac2020-03-20 14:58:41 -070096 }
97 };
98
David Tolnay38c11212020-11-25 15:50:19 -080099 let mut fields = Vec::new();
100 for field in named_fields.named {
101 let ident = field.ident.unwrap();
David Tolnayb4a05c32020-12-30 15:37:01 -0800102 let mut doc = Doc::new();
David Tolnay067638e2020-12-30 16:18:05 -0800103 let attrs = attrs::parse(
David Tolnayb4a05c32020-12-30 15:37:01 -0800104 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -0800105 field.attrs,
David Tolnayb4a05c32020-12-30 15:37:01 -0800106 attrs::Parser {
107 doc: Some(&mut doc),
108 ..Default::default()
109 },
110 );
David Tolnay38c11212020-11-25 15:50:19 -0800111 let ty = match parse_type(&field.ty) {
112 Ok(ty) => ty,
113 Err(err) => {
114 cx.push(err);
115 continue;
116 }
117 };
David Tolnay89902442020-12-30 15:10:40 -0800118 let visibility = Token![pub](match field.vis {
119 Visibility::Public(vis) => vis.pub_token.span,
120 Visibility::Crate(vis) => vis.crate_token.span,
121 Visibility::Restricted(vis) => vis.pub_token.span,
122 Visibility::Inherited => ident.span(),
123 });
124 fields.push(Var {
David Tolnayb4a05c32020-12-30 15:37:01 -0800125 doc,
David Tolnay067638e2020-12-30 16:18:05 -0800126 attrs,
David Tolnay89902442020-12-30 15:10:40 -0800127 visibility,
128 ident,
129 ty,
130 });
David Tolnay38c11212020-11-25 15:50:19 -0800131 }
David Tolnay302b1752020-11-10 18:43:24 -0800132
David Tolnay64343af2020-12-30 15:26:06 -0800133 let visibility = Token![pub](match item.vis {
134 Visibility::Public(vis) => vis.pub_token.span,
135 Visibility::Crate(vis) => vis.crate_token.span,
136 Visibility::Restricted(vis) => vis.pub_token.span,
137 Visibility::Inherited => item.ident.span(),
138 });
David Tolnayddbcb522020-12-21 15:24:45 -0800139 let struct_token = item.struct_token;
David Tolnay885be132020-12-21 15:52:47 -0800140 let name = pair(namespace, &item.ident, cxx_name, rust_name);
David Tolnayddbcb522020-12-21 15:24:45 -0800141 let brace_token = named_fields.brace_token;
142
David Tolnay09462ac2020-03-20 14:58:41 -0700143 Ok(Api::Struct(Struct {
144 doc,
145 derives,
David Tolnay067638e2020-12-30 16:18:05 -0800146 attrs,
David Tolnay64343af2020-12-30 15:26:06 -0800147 visibility,
David Tolnayddbcb522020-12-21 15:24:45 -0800148 struct_token,
149 name,
150 brace_token,
David Tolnay302b1752020-11-10 18:43:24 -0800151 fields,
David Tolnay09462ac2020-03-20 14:58:41 -0700152 }))
David Tolnay7db73692019-10-20 14:51:12 -0400153}
154
David Tolnay302b1752020-11-10 18:43:24 -0800155fn parse_enum(cx: &mut Errors, item: ItemEnum, namespace: &Namespace) -> Result<Api> {
David Tolnayddf69e22020-05-10 22:08:20 -0700156 let mut doc = Doc::new();
David Tolnayfbc46692020-11-27 11:33:29 -0800157 let mut derives = Vec::new();
David Tolnayddf69e22020-05-10 22:08:20 -0700158 let mut repr = None;
David Tolnay302b1752020-11-10 18:43:24 -0800159 let mut namespace = namespace.clone();
David Tolnay885be132020-12-21 15:52:47 -0800160 let mut cxx_name = None;
161 let mut rust_name = None;
David Tolnay067638e2020-12-30 16:18:05 -0800162 let attrs = attrs::parse(
David Tolnayddf69e22020-05-10 22:08:20 -0700163 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -0800164 item.attrs,
David Tolnayddf69e22020-05-10 22:08:20 -0700165 attrs::Parser {
166 doc: Some(&mut doc),
David Tolnayfbc46692020-11-27 11:33:29 -0800167 derives: Some(&mut derives),
David Tolnayddf69e22020-05-10 22:08:20 -0700168 repr: Some(&mut repr),
David Tolnayd7a3a182020-11-01 20:45:14 -0800169 namespace: Some(&mut namespace),
David Tolnay885be132020-12-21 15:52:47 -0800170 cxx_name: Some(&mut cxx_name),
171 rust_name: Some(&mut rust_name),
David Tolnayddf69e22020-05-10 22:08:20 -0700172 ..Default::default()
173 },
174 );
Joel Galensonc03402a2020-04-23 17:31:09 -0700175
David Tolnaybc954d92020-12-21 15:17:10 -0800176 let generics = &item.generics;
177 if !generics.params.is_empty() || generics.where_clause.is_some() {
178 let enum_token = item.enum_token;
179 let ident = &item.ident;
180 let where_clause = &generics.where_clause;
181 let span = quote!(#enum_token #ident #generics #where_clause);
182 return Err(Error::new_spanned(
183 span,
184 "enums with generic parameters are not allowed",
185 ));
186 }
187
Joel Galenson88547732020-05-05 08:23:42 -0700188 let mut variants = Vec::new();
David Tolnayddf69e22020-05-10 22:08:20 -0700189 let mut discriminants = DiscriminantSet::new(repr);
Joel Galenson88547732020-05-05 08:23:42 -0700190 for variant in item.variants {
David Tolnay6bf9ef42020-12-21 16:11:40 -0800191 match parse_variant(cx, variant, &mut discriminants) {
David Tolnay26809232020-12-21 16:06:47 -0800192 Ok(variant) => variants.push(variant),
193 Err(err) => cx.push(err),
Joel Galensonc03402a2020-04-23 17:31:09 -0700194 }
195 }
196
David Tolnay8fbaea82020-12-30 17:15:46 -0800197 let visibility = Token![pub](match item.vis {
198 Visibility::Public(vis) => vis.pub_token.span,
199 Visibility::Crate(vis) => vis.crate_token.span,
200 Visibility::Restricted(vis) => vis.pub_token.span,
201 Visibility::Inherited => item.ident.span(),
202 });
David Tolnaye2e303f2020-05-10 20:52:00 -0700203 let enum_token = item.enum_token;
204 let brace_token = item.brace_token;
205
David Tolnay58eee392020-11-20 20:37:58 -0800206 let explicit_repr = repr.is_some();
David Tolnay0435a812020-05-10 21:58:15 -0700207 let mut repr = U8;
208 match discriminants.inferred_repr() {
209 Ok(inferred) => repr = inferred,
David Tolnaye2e303f2020-05-10 20:52:00 -0700210 Err(err) => {
211 let span = quote_spanned!(brace_token.span=> #enum_token {});
David Tolnay0435a812020-05-10 21:58:15 -0700212 cx.error(span, err);
213 variants.clear();
David Tolnaye2e303f2020-05-10 20:52:00 -0700214 }
David Tolnay0435a812020-05-10 21:58:15 -0700215 }
David Tolnaye2e303f2020-05-10 20:52:00 -0700216
David Tolnay885be132020-12-21 15:52:47 -0800217 let name = pair(namespace, &item.ident, cxx_name, rust_name);
David Tolnayddbcb522020-12-21 15:24:45 -0800218 let repr_ident = Ident::new(repr.as_ref(), Span::call_site());
219 let repr_type = Type::Ident(RustName::new(repr_ident));
David Tolnay9a69d8a2020-11-16 09:16:41 -0800220
Joel Galensonc03402a2020-04-23 17:31:09 -0700221 Ok(Api::Enum(Enum {
222 doc,
David Tolnayfbc46692020-11-27 11:33:29 -0800223 derives,
David Tolnay067638e2020-12-30 16:18:05 -0800224 attrs,
David Tolnay8fbaea82020-12-30 17:15:46 -0800225 visibility,
David Tolnaye2e303f2020-05-10 20:52:00 -0700226 enum_token,
David Tolnayddbcb522020-12-21 15:24:45 -0800227 name,
David Tolnaye2e303f2020-05-10 20:52:00 -0700228 brace_token,
David Tolnay7ae018f2020-05-05 10:11:30 -0700229 variants,
David Tolnaye2e303f2020-05-10 20:52:00 -0700230 repr,
David Tolnay9a69d8a2020-11-16 09:16:41 -0800231 repr_type,
David Tolnay58eee392020-11-20 20:37:58 -0800232 explicit_repr,
Joel Galensonc03402a2020-04-23 17:31:09 -0700233 }))
234}
235
David Tolnay6bf9ef42020-12-21 16:11:40 -0800236fn parse_variant(
237 cx: &mut Errors,
David Tolnay15a1fc12020-12-30 16:04:56 -0800238 mut variant: RustVariant,
David Tolnay6bf9ef42020-12-21 16:11:40 -0800239 discriminants: &mut DiscriminantSet,
240) -> Result<Variant> {
David Tolnay4486f722020-12-30 00:01:26 -0800241 let mut doc = Doc::new();
David Tolnay6bf9ef42020-12-21 16:11:40 -0800242 let mut cxx_name = None;
243 let mut rust_name = None;
David Tolnay067638e2020-12-30 16:18:05 -0800244 let attrs = attrs::parse(
David Tolnay6bf9ef42020-12-21 16:11:40 -0800245 cx,
David Tolnay067638e2020-12-30 16:18:05 -0800246 mem::take(&mut variant.attrs),
David Tolnay6bf9ef42020-12-21 16:11:40 -0800247 attrs::Parser {
David Tolnay4486f722020-12-30 00:01:26 -0800248 doc: Some(&mut doc),
David Tolnay6bf9ef42020-12-21 16:11:40 -0800249 cxx_name: Some(&mut cxx_name),
250 rust_name: Some(&mut rust_name),
251 ..Default::default()
252 },
253 );
254
David Tolnay26809232020-12-21 16:06:47 -0800255 match variant.fields {
256 Fields::Unit => {}
257 _ => {
258 let msg = "enums with data are not supported yet";
259 return Err(Error::new_spanned(variant, msg));
260 }
261 }
262
263 let expr = variant.discriminant.as_ref().map(|(_, expr)| expr);
264 let try_discriminant = match &expr {
265 Some(lit) => discriminants.insert(lit),
266 None => discriminants.insert_next(),
267 };
268 let discriminant = match try_discriminant {
269 Ok(discriminant) => discriminant,
270 Err(err) => return Err(Error::new_spanned(variant, err)),
271 };
David Tolnaye6f62142020-12-21 16:00:41 -0800272
David Tolnay6bf9ef42020-12-21 16:11:40 -0800273 let name = pair(Namespace::ROOT, &variant.ident, cxx_name, rust_name);
David Tolnay26809232020-12-21 16:06:47 -0800274 let expr = variant.discriminant.map(|(_, expr)| expr);
275
276 Ok(Variant {
David Tolnay4486f722020-12-30 00:01:26 -0800277 doc,
David Tolnay067638e2020-12-30 16:18:05 -0800278 attrs,
David Tolnaye6f62142020-12-21 16:00:41 -0800279 name,
David Tolnay26809232020-12-21 16:06:47 -0800280 discriminant,
281 expr,
282 })
283}
284
David Tolnay805dca32020-08-29 19:09:55 -0700285fn parse_foreign_mod(
286 cx: &mut Errors,
287 foreign_mod: ItemForeignMod,
288 out: &mut Vec<Api>,
289 trusted: bool,
David Tolnayd7a3a182020-11-01 20:45:14 -0800290 namespace: &Namespace,
David Tolnay805dca32020-08-29 19:09:55 -0700291) {
David Tolnay3a451732020-08-29 18:54:55 -0700292 let lang = match parse_lang(&foreign_mod.abi) {
David Tolnay52759782020-05-03 23:59:40 -0700293 Ok(lang) => lang,
294 Err(err) => return cx.push(err),
295 };
David Tolnay7db73692019-10-20 14:51:12 -0400296
David Tolnay3a451732020-08-29 18:54:55 -0700297 match lang {
298 Lang::Rust => {
David Tolnay805dca32020-08-29 19:09:55 -0700299 if foreign_mod.unsafety.is_some() {
David Tolnay3a451732020-08-29 18:54:55 -0700300 let unsafety = foreign_mod.unsafety;
David Tolnay7be5b1f2020-11-11 10:48:32 -0800301 let abi = &foreign_mod.abi;
David Tolnay3a451732020-08-29 18:54:55 -0700302 let span = quote!(#unsafety #abi);
303 cx.error(span, "extern \"Rust\" block does not need to be unsafe");
304 }
305 }
306 Lang::Cxx => {}
307 }
308
David Tolnay805dca32020-08-29 19:09:55 -0700309 let trusted = trusted || foreign_mod.unsafety.is_some();
310
David Tolnay7feb2642020-11-10 18:49:04 -0800311 let mut namespace = namespace.clone();
312 attrs::parse(
313 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -0800314 foreign_mod.attrs,
David Tolnay7feb2642020-11-10 18:49:04 -0800315 attrs::Parser {
316 namespace: Some(&mut namespace),
317 ..Default::default()
318 },
319 );
320
Joel Galensone1e969d2020-04-21 12:50:20 -0700321 let mut items = Vec::new();
David Tolnay15a1fc12020-12-30 16:04:56 -0800322 for foreign in foreign_mod.items {
Joel Galensone1e969d2020-04-21 12:50:20 -0700323 match foreign {
Adrian Taylorc8713432020-10-21 18:20:55 -0700324 ForeignItem::Type(foreign) => {
David Tolnayf5ead102020-11-24 17:08:05 -0800325 let ety = parse_extern_type(cx, foreign, lang, trusted, &namespace);
326 items.push(ety);
Adrian Taylorc8713432020-10-21 18:20:55 -0700327 }
David Tolnay556738d2020-11-15 13:58:44 -0800328 ForeignItem::Fn(foreign) => {
329 match parse_extern_fn(cx, foreign, lang, trusted, &namespace) {
330 Ok(efn) => items.push(efn),
331 Err(err) => cx.push(err),
332 }
333 }
David Tolnay7db73692019-10-20 14:51:12 -0400334 ForeignItem::Macro(foreign) if foreign.mac.path.is_ident("include") => {
David Tolnay91e87fa2020-05-11 19:10:23 -0700335 match foreign.mac.parse_body_with(parse_include) {
David Tolnay52759782020-05-03 23:59:40 -0700336 Ok(include) => items.push(Api::Include(include)),
337 Err(err) => cx.push(err),
338 }
David Tolnay7db73692019-10-20 14:51:12 -0400339 }
Adrian Taylorc8713432020-10-21 18:20:55 -0700340 ForeignItem::Verbatim(tokens) => {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800341 match parse_extern_verbatim(cx, tokens, lang, trusted, &namespace) {
Adrian Taylorc8713432020-10-21 18:20:55 -0700342 Ok(api) => items.push(api),
343 Err(err) => cx.push(err),
344 }
345 }
David Tolnay52759782020-05-03 23:59:40 -0700346 _ => cx.error(foreign, "unsupported foreign item"),
David Tolnay7db73692019-10-20 14:51:12 -0400347 }
348 }
David Tolnaya1f29c42020-04-22 18:01:38 -0700349
David Tolnay7be5b1f2020-11-11 10:48:32 -0800350 if !trusted
351 && items.iter().any(|api| match api {
352 Api::CxxFunction(efn) => efn.unsafety.is_none(),
353 _ => false,
354 })
355 {
356 cx.error(
357 foreign_mod.abi,
358 "block must be declared `unsafe extern \"C++\"` if it contains any safe-to-call C++ functions",
359 );
360 }
361
David Tolnaya1f29c42020-04-22 18:01:38 -0700362 let mut types = items.iter().filter_map(|item| match item {
David Tolnay17a934c2020-11-02 00:40:04 -0800363 Api::CxxType(ety) | Api::RustType(ety) => Some(&ety.name),
364 Api::TypeAlias(alias) => Some(&alias.name),
David Tolnaya1f29c42020-04-22 18:01:38 -0700365 _ => None,
366 });
367 if let (Some(single_type), None) = (types.next(), types.next()) {
David Tolnaye5a015a2020-05-07 21:54:26 -0700368 let single_type = single_type.clone();
David Tolnaya1f29c42020-04-22 18:01:38 -0700369 for item in &mut items {
370 if let Api::CxxFunction(efn) | Api::RustFunction(efn) = item {
371 if let Some(receiver) = &mut efn.receiver {
David Tolnay2d99b002020-12-21 14:34:35 -0800372 if receiver.ty.rust == "Self" {
373 receiver.ty.rust = single_type.rust.clone();
David Tolnaya1f29c42020-04-22 18:01:38 -0700374 }
375 }
376 }
377 }
378 }
379
David Tolnay52759782020-05-03 23:59:40 -0700380 out.extend(items);
David Tolnay7db73692019-10-20 14:51:12 -0400381}
382
David Tolnay3a451732020-08-29 18:54:55 -0700383fn parse_lang(abi: &Abi) -> Result<Lang> {
David Tolnay7db73692019-10-20 14:51:12 -0400384 let name = match &abi.name {
385 Some(name) => name,
386 None => {
387 return Err(Error::new_spanned(
388 abi,
David Tolnayc72a9f62020-11-11 10:56:26 -0800389 "ABI name is required, extern \"C++\" or extern \"Rust\"",
David Tolnay7db73692019-10-20 14:51:12 -0400390 ));
391 }
392 };
David Tolnayddbcb522020-12-21 15:24:45 -0800393
David Tolnay7db73692019-10-20 14:51:12 -0400394 match name.value().as_str() {
David Tolnayea25ac82020-11-11 10:35:23 -0800395 "C++" => Ok(Lang::Cxx),
David Tolnay7db73692019-10-20 14:51:12 -0400396 "Rust" => Ok(Lang::Rust),
David Tolnay2757ca82020-11-14 15:12:06 -0800397 _ => Err(Error::new_spanned(
398 abi,
399 "unrecognized ABI, requires either \"C++\" or \"Rust\"",
400 )),
David Tolnay7db73692019-10-20 14:51:12 -0400401 }
402}
403
David Tolnay00f236a2020-08-29 19:07:18 -0700404fn parse_extern_type(
405 cx: &mut Errors,
David Tolnay15a1fc12020-12-30 16:04:56 -0800406 foreign_type: ForeignItemType,
David Tolnay00f236a2020-08-29 19:07:18 -0700407 lang: Lang,
408 trusted: bool,
David Tolnay302b1752020-11-10 18:43:24 -0800409 namespace: &Namespace,
David Tolnayf5ead102020-11-24 17:08:05 -0800410) -> Api {
Adrian Taylorc8713432020-10-21 18:20:55 -0700411 let mut doc = Doc::new();
David Tolnay16e26202020-11-27 19:28:37 -0800412 let mut derives = Vec::new();
David Tolnay302b1752020-11-10 18:43:24 -0800413 let mut namespace = namespace.clone();
David Tolnay885be132020-12-21 15:52:47 -0800414 let mut cxx_name = None;
415 let mut rust_name = None;
David Tolnay067638e2020-12-30 16:18:05 -0800416 let attrs = attrs::parse(
Adrian Taylorc8713432020-10-21 18:20:55 -0700417 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -0800418 foreign_type.attrs,
Adrian Taylorc8713432020-10-21 18:20:55 -0700419 attrs::Parser {
420 doc: Some(&mut doc),
David Tolnay16e26202020-11-27 19:28:37 -0800421 derives: Some(&mut derives),
David Tolnayd7a3a182020-11-01 20:45:14 -0800422 namespace: Some(&mut namespace),
David Tolnay885be132020-12-21 15:52:47 -0800423 cxx_name: Some(&mut cxx_name),
424 rust_name: Some(&mut rust_name),
Adrian Taylorc8713432020-10-21 18:20:55 -0700425 ..Default::default()
426 },
427 );
David Tolnayddbcb522020-12-21 15:24:45 -0800428
David Tolnay524ff682020-12-30 17:25:38 -0800429 let visibility = Token![pub](match foreign_type.vis {
430 Visibility::Public(vis) => vis.pub_token.span,
431 Visibility::Crate(vis) => vis.crate_token.span,
432 Visibility::Restricted(vis) => vis.pub_token.span,
433 Visibility::Inherited => foreign_type.ident.span(),
434 });
David Tolnay7db73692019-10-20 14:51:12 -0400435 let type_token = foreign_type.type_token;
David Tolnay885be132020-12-21 15:52:47 -0800436 let name = pair(namespace, &foreign_type.ident, cxx_name, rust_name);
David Tolnayee312322020-12-28 22:04:10 -0800437 let generics = Lifetimes {
438 lt_token: None,
439 lifetimes: Punctuated::new(),
440 gt_token: None,
441 };
David Tolnayddbcb522020-12-21 15:24:45 -0800442 let colon_token = None;
443 let bounds = Vec::new();
David Tolnayc8361022020-08-25 21:57:53 -0700444 let semi_token = foreign_type.semi_token;
David Tolnayddbcb522020-12-21 15:24:45 -0800445
446 (match lang {
David Tolnay295ef6b2020-05-07 16:10:22 -0700447 Lang::Cxx => Api::CxxType,
448 Lang::Rust => Api::RustType,
David Tolnayddbcb522020-12-21 15:24:45 -0800449 })(ExternType {
David Tolnay16e26202020-11-27 19:28:37 -0800450 lang,
David Tolnay7db73692019-10-20 14:51:12 -0400451 doc,
David Tolnay16e26202020-11-27 19:28:37 -0800452 derives,
David Tolnay067638e2020-12-30 16:18:05 -0800453 attrs,
David Tolnay524ff682020-12-30 17:25:38 -0800454 visibility,
David Tolnay7db73692019-10-20 14:51:12 -0400455 type_token,
David Tolnayddbcb522020-12-21 15:24:45 -0800456 name,
David Tolnayee312322020-12-28 22:04:10 -0800457 generics,
David Tolnayddbcb522020-12-21 15:24:45 -0800458 colon_token,
459 bounds,
David Tolnayc8361022020-08-25 21:57:53 -0700460 semi_token,
David Tolnay00f236a2020-08-29 19:07:18 -0700461 trusted,
David Tolnayf5ead102020-11-24 17:08:05 -0800462 })
David Tolnay7db73692019-10-20 14:51:12 -0400463}
464
Adrian Taylorc8713432020-10-21 18:20:55 -0700465fn parse_extern_fn(
466 cx: &mut Errors,
David Tolnay15a1fc12020-12-30 16:04:56 -0800467 mut foreign_fn: ForeignItemFn,
Adrian Taylorc8713432020-10-21 18:20:55 -0700468 lang: Lang,
David Tolnay556738d2020-11-15 13:58:44 -0800469 trusted: bool,
David Tolnay302b1752020-11-10 18:43:24 -0800470 namespace: &Namespace,
Adrian Taylorc8713432020-10-21 18:20:55 -0700471) -> Result<Api> {
David Tolnaybc954d92020-12-21 15:17:10 -0800472 let mut doc = Doc::new();
David Tolnaya2dfcbf2020-12-21 15:46:24 -0800473 let mut namespace = namespace.clone();
David Tolnaybc954d92020-12-21 15:17:10 -0800474 let mut cxx_name = None;
475 let mut rust_name = None;
David Tolnay067638e2020-12-30 16:18:05 -0800476 let attrs = attrs::parse(
David Tolnaybc954d92020-12-21 15:17:10 -0800477 cx,
David Tolnay067638e2020-12-30 16:18:05 -0800478 mem::take(&mut foreign_fn.attrs),
David Tolnaybc954d92020-12-21 15:17:10 -0800479 attrs::Parser {
480 doc: Some(&mut doc),
David Tolnaya2dfcbf2020-12-21 15:46:24 -0800481 namespace: Some(&mut namespace),
David Tolnaybc954d92020-12-21 15:17:10 -0800482 cxx_name: Some(&mut cxx_name),
483 rust_name: Some(&mut rust_name),
David Tolnaybc954d92020-12-21 15:17:10 -0800484 ..Default::default()
485 },
486 );
487
David Tolnay7db73692019-10-20 14:51:12 -0400488 let generics = &foreign_fn.sig.generics;
David Tolnay9938b642020-11-15 18:11:40 -0800489 if generics.where_clause.is_some()
490 || generics.params.iter().any(|param| match param {
491 GenericParam::Lifetime(lifetime) => !lifetime.bounds.is_empty(),
492 GenericParam::Type(_) | GenericParam::Const(_) => true,
493 })
494 {
David Tolnay7db73692019-10-20 14:51:12 -0400495 return Err(Error::new_spanned(
496 foreign_fn,
497 "extern function with generic parameters is not supported yet",
498 ));
499 }
David Tolnayddbcb522020-12-21 15:24:45 -0800500
David Tolnay7db73692019-10-20 14:51:12 -0400501 if let Some(variadic) = &foreign_fn.sig.variadic {
502 return Err(Error::new_spanned(
503 variadic,
504 "variadic function is not supported yet",
505 ));
506 }
David Tolnayddbcb522020-12-21 15:24:45 -0800507
David Tolnay8de461f2020-11-19 13:46:14 -0800508 if foreign_fn.sig.asyncness.is_some() {
509 return Err(Error::new_spanned(
510 foreign_fn,
511 "async function is not directly supported yet, but see https://cxx.rs/async.html for a working approach",
512 ));
513 }
David Tolnayddbcb522020-12-21 15:24:45 -0800514
David Tolnay80ef0682020-11-19 13:56:07 -0800515 if foreign_fn.sig.constness.is_some() {
516 return Err(Error::new_spanned(
517 foreign_fn,
518 "const extern function is not supported",
519 ));
520 }
David Tolnayddbcb522020-12-21 15:24:45 -0800521
David Tolnay80ef0682020-11-19 13:56:07 -0800522 if let Some(abi) = &foreign_fn.sig.abi {
523 return Err(Error::new_spanned(
524 abi,
525 "explicit ABI on extern function is not supported",
526 ));
527 }
David Tolnay7db73692019-10-20 14:51:12 -0400528
529 let mut receiver = None;
David Tolnaye3a48152020-04-08 19:38:05 -0700530 let mut args = Punctuated::new();
531 for arg in foreign_fn.sig.inputs.pairs() {
532 let (arg, comma) = arg.into_tuple();
David Tolnay7db73692019-10-20 14:51:12 -0400533 match arg {
David Tolnay1dd11a12020-04-22 12:31:48 -0700534 FnArg::Receiver(arg) => {
David Tolnaya1f29c42020-04-22 18:01:38 -0700535 if let Some((ampersand, lifetime)) = &arg.reference {
536 receiver = Some(Receiver {
David Tolnay9c76c392020-11-15 16:07:08 -0800537 pinned: false,
David Tolnaya1f29c42020-04-22 18:01:38 -0700538 ampersand: *ampersand,
539 lifetime: lifetime.clone(),
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800540 mutable: arg.mutability.is_some(),
David Tolnaya1f29c42020-04-22 18:01:38 -0700541 var: arg.self_token,
David Tolnay2d99b002020-12-21 14:34:35 -0800542 ty: RustName::new(Ident::new("Self", arg.self_token.span)),
David Tolnaya1f29c42020-04-22 18:01:38 -0700543 shorthand: true,
David Tolnay9c76c392020-11-15 16:07:08 -0800544 pin_tokens: None,
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800545 mutability: arg.mutability,
David Tolnaya1f29c42020-04-22 18:01:38 -0700546 });
547 continue;
Joel Galensone1e969d2020-04-21 12:50:20 -0700548 }
David Tolnay1dd11a12020-04-22 12:31:48 -0700549 return Err(Error::new_spanned(arg, "unsupported signature"));
David Tolnay7db73692019-10-20 14:51:12 -0400550 }
551 FnArg::Typed(arg) => {
552 let ident = match arg.pat.as_ref() {
553 Pat::Ident(pat) => pat.ident.clone(),
Joel Galensonba676072020-04-27 15:55:45 -0700554 Pat::Wild(pat) => {
David Tolnayb4c14552020-12-29 15:44:19 -0800555 Ident::new(&format!("arg{}", args.len()), pat.underscore_token.span)
Joel Galensonba676072020-04-27 15:55:45 -0700556 }
David Tolnay7db73692019-10-20 14:51:12 -0400557 _ => return Err(Error::new_spanned(arg, "unsupported signature")),
558 };
David Tolnay313cc0a2020-11-24 21:47:01 -0800559 let ty = parse_type(&arg.ty)?;
David Tolnay7db73692019-10-20 14:51:12 -0400560 if ident != "self" {
David Tolnayb4a05c32020-12-30 15:37:01 -0800561 let doc = Doc::new();
David Tolnaycba3d442020-12-30 16:39:21 -0800562 let attrs = OtherAttrs::none();
David Tolnay89902442020-12-30 15:10:40 -0800563 let visibility = Token![pub](ident.span());
564 args.push_value(Var {
David Tolnayb4a05c32020-12-30 15:37:01 -0800565 doc,
David Tolnay067638e2020-12-30 16:18:05 -0800566 attrs,
David Tolnay89902442020-12-30 15:10:40 -0800567 visibility,
568 ident,
569 ty,
570 });
David Tolnaye3a48152020-04-08 19:38:05 -0700571 if let Some(comma) = comma {
572 args.push_punct(*comma);
573 }
David Tolnay7db73692019-10-20 14:51:12 -0400574 continue;
575 }
576 if let Type::Ref(reference) = ty {
577 if let Type::Ident(ident) = reference.inner {
578 receiver = Some(Receiver {
David Tolnay9c76c392020-11-15 16:07:08 -0800579 pinned: reference.pinned,
David Tolnayfb6e3862020-04-20 01:33:23 -0700580 ampersand: reference.ampersand,
David Tolnay0bd50fa2020-04-22 15:31:33 -0700581 lifetime: reference.lifetime,
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800582 mutable: reference.mutable,
Adrian Taylorc8713432020-10-21 18:20:55 -0700583 var: Token![self](ident.rust.span()),
David Tolnay05e11cc2020-04-20 02:13:56 -0700584 ty: ident,
David Tolnay62d360c2020-04-22 16:26:21 -0700585 shorthand: false,
David Tolnay9c76c392020-11-15 16:07:08 -0800586 pin_tokens: reference.pin_tokens,
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800587 mutability: reference.mutability,
David Tolnay7db73692019-10-20 14:51:12 -0400588 });
589 continue;
590 }
591 }
592 return Err(Error::new_spanned(arg, "unsupported method receiver"));
593 }
594 }
595 }
David Tolnay59b7ede2020-03-16 00:30:23 -0700596
David Tolnaye3a48152020-04-08 19:38:05 -0700597 let mut throws_tokens = None;
David Tolnay313cc0a2020-11-24 21:47:01 -0800598 let ret = parse_return_type(&foreign_fn.sig.output, &mut throws_tokens)?;
David Tolnaye3a48152020-04-08 19:38:05 -0700599 let throws = throws_tokens.is_some();
David Tolnaybdb576c2020-09-06 23:45:55 -0700600 let unsafety = foreign_fn.sig.unsafety;
David Tolnay7db73692019-10-20 14:51:12 -0400601 let fn_token = foreign_fn.sig.fn_token;
David Tolnay6a990f82020-12-21 15:42:31 -0800602 let name = pair(namespace, &foreign_fn.sig.ident, cxx_name, rust_name);
David Tolnay9938b642020-11-15 18:11:40 -0800603 let generics = generics.clone();
David Tolnaye3a48152020-04-08 19:38:05 -0700604 let paren_token = foreign_fn.sig.paren_token;
David Tolnay7db73692019-10-20 14:51:12 -0400605 let semi_token = foreign_fn.semi_token;
David Tolnayddbcb522020-12-21 15:24:45 -0800606
607 Ok(match lang {
David Tolnay295ef6b2020-05-07 16:10:22 -0700608 Lang::Cxx => Api::CxxFunction,
609 Lang::Rust => Api::RustFunction,
David Tolnayddbcb522020-12-21 15:24:45 -0800610 }(ExternFn {
David Tolnay6cde49f2020-03-16 12:25:45 -0700611 lang,
David Tolnay7db73692019-10-20 14:51:12 -0400612 doc,
David Tolnay067638e2020-12-30 16:18:05 -0800613 attrs,
David Tolnay17a934c2020-11-02 00:40:04 -0800614 name,
David Tolnay16448732020-03-18 12:39:36 -0700615 sig: Signature {
David Tolnaybdb576c2020-09-06 23:45:55 -0700616 unsafety,
David Tolnay16448732020-03-18 12:39:36 -0700617 fn_token,
David Tolnay9938b642020-11-15 18:11:40 -0800618 generics,
David Tolnay16448732020-03-18 12:39:36 -0700619 receiver,
620 args,
621 ret,
622 throws,
David Tolnaye3a48152020-04-08 19:38:05 -0700623 paren_token,
624 throws_tokens,
David Tolnay16448732020-03-18 12:39:36 -0700625 },
David Tolnay7db73692019-10-20 14:51:12 -0400626 semi_token,
David Tolnay556738d2020-11-15 13:58:44 -0800627 trusted,
David Tolnay295ef6b2020-05-07 16:10:22 -0700628 }))
David Tolnay7db73692019-10-20 14:51:12 -0400629}
630
Adrian Taylorc8713432020-10-21 18:20:55 -0700631fn parse_extern_verbatim(
632 cx: &mut Errors,
David Tolnay15a1fc12020-12-30 16:04:56 -0800633 tokens: TokenStream,
Adrian Taylorc8713432020-10-21 18:20:55 -0700634 lang: Lang,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800635 trusted: bool,
David Tolnay302b1752020-11-10 18:43:24 -0800636 namespace: &Namespace,
Adrian Taylorc8713432020-10-21 18:20:55 -0700637) -> Result<Api> {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800638 |input: ParseStream| -> Result<Api> {
David Tolnaye2f9ec42020-05-07 16:19:33 -0700639 let attrs = input.call(Attribute::parse_outer)?;
David Tolnay524ff682020-12-30 17:25:38 -0800640 let visibility: Visibility = input.parse()?;
David Tolnaye2f9ec42020-05-07 16:19:33 -0700641 let type_token: Token![type] = match input.parse()? {
642 Some(type_token) => type_token,
643 None => {
644 let span = input.cursor().token_stream();
645 return Err(Error::new_spanned(span, "unsupported foreign item"));
646 }
647 };
648 let ident: Ident = input.parse()?;
David Tolnaye81647f2020-12-28 19:30:01 -0800649 let generics: Generics = input.parse()?;
David Tolnayee312322020-12-28 22:04:10 -0800650 let mut lifetimes = Punctuated::new();
David Tolnaye81647f2020-12-28 19:30:01 -0800651 let mut has_unsupported_generic_param = false;
David Tolnayee312322020-12-28 22:04:10 -0800652 for pair in generics.params.into_pairs() {
653 let (param, punct) = pair.into_tuple();
David Tolnaye81647f2020-12-28 19:30:01 -0800654 match param {
655 GenericParam::Lifetime(param) => {
656 if !param.bounds.is_empty() && !has_unsupported_generic_param {
657 let msg = "lifetime parameter with bounds is not supported yet";
658 cx.error(&param, msg);
659 has_unsupported_generic_param = true;
660 }
David Tolnayee312322020-12-28 22:04:10 -0800661 lifetimes.push_value(param.lifetime);
662 if let Some(punct) = punct {
663 lifetimes.push_punct(punct);
664 }
David Tolnaye81647f2020-12-28 19:30:01 -0800665 }
666 GenericParam::Type(param) => {
667 if !has_unsupported_generic_param {
668 let msg = "extern type with generic type parameter is not supported yet";
669 cx.error(&param, msg);
670 has_unsupported_generic_param = true;
671 }
672 }
673 GenericParam::Const(param) => {
674 if !has_unsupported_generic_param {
675 let msg = "extern type with const generic parameter is not supported yet";
676 cx.error(&param, msg);
677 has_unsupported_generic_param = true;
678 }
679 }
680 }
681 }
David Tolnayee312322020-12-28 22:04:10 -0800682 let lifetimes = Lifetimes {
683 lt_token: generics.lt_token,
684 lifetimes,
685 gt_token: generics.gt_token,
686 };
David Tolnayb7eb65e2020-11-27 20:00:53 -0800687 let lookahead = input.lookahead1();
688 if lookahead.peek(Token![=]) {
689 // type Alias = crate::path::to::Type;
David Tolnaye81647f2020-12-28 19:30:01 -0800690 parse_type_alias(
691 cx, attrs, type_token, ident, lifetimes, input, lang, namespace,
692 )
David Tolnaya870ac72020-12-28 19:48:33 -0800693 } else if lookahead.peek(Token![:]) || lookahead.peek(Token![;]) {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800694 // type Opaque: Bound2 + Bound2;
695 parse_extern_type_bounded(
David Tolnay524ff682020-12-30 17:25:38 -0800696 cx, attrs, visibility, type_token, ident, lifetimes, input, lang, trusted,
697 namespace,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800698 )
699 } else {
700 Err(lookahead.error())
David Tolnaye2f9ec42020-05-07 16:19:33 -0700701 }
702 }
David Tolnay15a1fc12020-12-30 16:04:56 -0800703 .parse2(tokens)
David Tolnayb7eb65e2020-11-27 20:00:53 -0800704}
705
706fn parse_type_alias(
707 cx: &mut Errors,
708 attrs: Vec<Attribute>,
709 type_token: Token![type],
710 ident: Ident,
David Tolnayee312322020-12-28 22:04:10 -0800711 generics: Lifetimes,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800712 input: ParseStream,
713 lang: Lang,
714 namespace: &Namespace,
715) -> Result<Api> {
716 let eq_token: Token![=] = input.parse()?;
717 let ty: RustType = input.parse()?;
718 let semi_token: Token![;] = input.parse()?;
719
720 let mut doc = Doc::new();
721 let mut derives = Vec::new();
722 let mut namespace = namespace.clone();
David Tolnay885be132020-12-21 15:52:47 -0800723 let mut cxx_name = None;
724 let mut rust_name = None;
David Tolnay067638e2020-12-30 16:18:05 -0800725 let attrs = attrs::parse(
David Tolnayb7eb65e2020-11-27 20:00:53 -0800726 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -0800727 attrs,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800728 attrs::Parser {
729 doc: Some(&mut doc),
730 derives: Some(&mut derives),
731 namespace: Some(&mut namespace),
David Tolnay885be132020-12-21 15:52:47 -0800732 cxx_name: Some(&mut cxx_name),
733 rust_name: Some(&mut rust_name),
David Tolnayb7eb65e2020-11-27 20:00:53 -0800734 ..Default::default()
735 },
736 );
737
738 if lang == Lang::Rust {
739 let span = quote!(#type_token #semi_token);
740 let msg = "type alias in extern \"Rust\" block is not supported";
741 return Err(Error::new_spanned(span, msg));
742 }
743
David Tolnay885be132020-12-21 15:52:47 -0800744 let name = pair(namespace, &ident, cxx_name, rust_name);
David Tolnayddbcb522020-12-21 15:24:45 -0800745
David Tolnayb7eb65e2020-11-27 20:00:53 -0800746 Ok(Api::TypeAlias(TypeAlias {
747 doc,
748 derives,
David Tolnay067638e2020-12-30 16:18:05 -0800749 attrs,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800750 type_token,
David Tolnayddbcb522020-12-21 15:24:45 -0800751 name,
David Tolnayee312322020-12-28 22:04:10 -0800752 generics,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800753 eq_token,
754 ty,
755 semi_token,
756 }))
757}
758
759fn parse_extern_type_bounded(
760 cx: &mut Errors,
761 attrs: Vec<Attribute>,
David Tolnay524ff682020-12-30 17:25:38 -0800762 visibility: Visibility,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800763 type_token: Token![type],
764 ident: Ident,
David Tolnayee312322020-12-28 22:04:10 -0800765 generics: Lifetimes,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800766 input: ParseStream,
767 lang: Lang,
768 trusted: bool,
769 namespace: &Namespace,
770) -> Result<Api> {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800771 let mut bounds = Vec::new();
David Tolnaya870ac72020-12-28 19:48:33 -0800772 let colon_token: Option<Token![:]> = input.parse()?;
773 if colon_token.is_some() {
774 loop {
775 match input.parse()? {
776 TypeParamBound::Trait(TraitBound {
777 paren_token: None,
778 modifier: TraitBoundModifier::None,
779 lifetimes: None,
780 path,
781 }) if if let Some(derive) = path.get_ident().and_then(Derive::from) {
782 bounds.push(derive);
783 true
784 } else {
785 false
786 } => {}
787 bound @ TypeParamBound::Trait(_) | bound @ TypeParamBound::Lifetime(_) => {
788 cx.error(bound, "unsupported trait");
789 }
David Tolnayb7eb65e2020-11-27 20:00:53 -0800790 }
David Tolnayb7eb65e2020-11-27 20:00:53 -0800791
David Tolnaya870ac72020-12-28 19:48:33 -0800792 let lookahead = input.lookahead1();
793 if lookahead.peek(Token![+]) {
794 input.parse::<Token![+]>()?;
795 } else if lookahead.peek(Token![;]) {
796 break;
797 } else {
798 return Err(lookahead.error());
799 }
David Tolnayb7eb65e2020-11-27 20:00:53 -0800800 }
801 }
802 let semi_token: Token![;] = input.parse()?;
803
804 let mut doc = Doc::new();
805 let mut derives = Vec::new();
806 let mut namespace = namespace.clone();
David Tolnay885be132020-12-21 15:52:47 -0800807 let mut cxx_name = None;
808 let mut rust_name = None;
David Tolnay067638e2020-12-30 16:18:05 -0800809 let attrs = attrs::parse(
David Tolnayb7eb65e2020-11-27 20:00:53 -0800810 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -0800811 attrs,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800812 attrs::Parser {
813 doc: Some(&mut doc),
814 derives: Some(&mut derives),
815 namespace: Some(&mut namespace),
David Tolnay885be132020-12-21 15:52:47 -0800816 cxx_name: Some(&mut cxx_name),
817 rust_name: Some(&mut rust_name),
David Tolnayb7eb65e2020-11-27 20:00:53 -0800818 ..Default::default()
819 },
820 );
821
David Tolnay524ff682020-12-30 17:25:38 -0800822 let visibility = Token![pub](match visibility {
823 Visibility::Public(vis) => vis.pub_token.span,
824 Visibility::Crate(vis) => vis.crate_token.span,
825 Visibility::Restricted(vis) => vis.pub_token.span,
826 Visibility::Inherited => ident.span(),
827 });
David Tolnay885be132020-12-21 15:52:47 -0800828 let name = pair(namespace, &ident, cxx_name, rust_name);
David Tolnayddbcb522020-12-21 15:24:45 -0800829
830 Ok(match lang {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800831 Lang::Cxx => Api::CxxType,
832 Lang::Rust => Api::RustType,
David Tolnayddbcb522020-12-21 15:24:45 -0800833 }(ExternType {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800834 lang,
835 doc,
836 derives,
David Tolnay067638e2020-12-30 16:18:05 -0800837 attrs,
David Tolnay524ff682020-12-30 17:25:38 -0800838 visibility,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800839 type_token,
David Tolnayddbcb522020-12-21 15:24:45 -0800840 name,
David Tolnayee312322020-12-28 22:04:10 -0800841 generics,
David Tolnayddbcb522020-12-21 15:24:45 -0800842 colon_token,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800843 bounds,
844 semi_token,
845 trusted,
846 }))
David Tolnaye2f9ec42020-05-07 16:19:33 -0700847}
848
David Tolnay313cc0a2020-11-24 21:47:01 -0800849fn parse_impl(imp: ItemImpl) -> Result<Api> {
David Tolnay7e69f892020-10-03 22:20:22 -0700850 if !imp.items.is_empty() {
851 let mut span = Group::new(Delimiter::Brace, TokenStream::new());
852 span.set_span(imp.brace_token.span);
853 return Err(Error::new_spanned(span, "expected an empty impl block"));
854 }
855
David Tolnay7e69f892020-10-03 22:20:22 -0700856 if let Some((bang, path, for_token)) = &imp.trait_ {
David Tolnay028d3d22020-11-29 18:09:52 -0800857 let self_ty = &imp.self_ty;
David Tolnay7e69f892020-10-03 22:20:22 -0700858 let span = quote!(#bang #path #for_token #self_ty);
859 return Err(Error::new_spanned(
860 span,
861 "unexpected impl, expected something like `impl UniquePtr<T> {}`",
862 ));
863 }
864
865 let generics = &imp.generics;
866 if !generics.params.is_empty() || generics.where_clause.is_some() {
867 return Err(Error::new_spanned(
868 imp,
869 "generic parameters on an impl is not supported",
870 ));
871 }
872
David Tolnay028d3d22020-11-29 18:09:52 -0800873 let mut negative_token = None;
874 let mut self_ty = *imp.self_ty;
875 if let RustType::Verbatim(ty) = &self_ty {
876 let mut iter = ty.clone().into_iter();
877 if let Some(TokenTree::Punct(punct)) = iter.next() {
878 if punct.as_char() == '!' {
879 let ty = iter.collect::<TokenStream>();
880 if !ty.is_empty() {
881 negative_token = Some(Token![!](punct.span()));
882 self_ty = syn::parse2(ty)?;
883 }
884 }
885 }
886 }
887
David Tolnayddbcb522020-12-21 15:24:45 -0800888 let impl_token = imp.impl_token;
889 let negative = negative_token.is_some();
890 let ty = parse_type(&self_ty)?;
891 let brace_token = imp.brace_token;
892
David Tolnay7e69f892020-10-03 22:20:22 -0700893 Ok(Api::Impl(Impl {
David Tolnayddbcb522020-12-21 15:24:45 -0800894 impl_token,
895 negative,
896 ty,
897 brace_token,
David Tolnay028d3d22020-11-29 18:09:52 -0800898 negative_token,
David Tolnay7e69f892020-10-03 22:20:22 -0700899 }))
900}
901
David Tolnayb0cd3272020-10-27 21:32:54 -0700902fn parse_include(input: ParseStream) -> Result<Include> {
David Tolnay91e87fa2020-05-11 19:10:23 -0700903 if input.peek(LitStr) {
David Tolnayb0cd3272020-10-27 21:32:54 -0700904 let lit: LitStr = input.parse()?;
905 let span = lit.span();
906 return Ok(Include {
907 path: lit.value(),
908 kind: IncludeKind::Quoted,
909 begin_span: span,
910 end_span: span,
911 });
David Tolnay91e87fa2020-05-11 19:10:23 -0700912 }
913
914 if input.peek(Token![<]) {
915 let mut path = String::new();
David Tolnayb0cd3272020-10-27 21:32:54 -0700916
David Tolnay2cc2e3a2020-10-28 13:12:35 -0700917 let langle: Token![<] = input.parse()?;
David Tolnay91e87fa2020-05-11 19:10:23 -0700918 while !input.is_empty() && !input.peek(Token![>]) {
919 let token: TokenTree = input.parse()?;
920 match token {
921 TokenTree::Ident(token) => path += &token.to_string(),
922 TokenTree::Literal(token)
923 if token
924 .to_string()
925 .starts_with(|ch: char| ch.is_ascii_digit()) =>
926 {
927 path += &token.to_string();
928 }
929 TokenTree::Punct(token) => path.push(token.as_char()),
930 _ => return Err(Error::new(token.span(), "unexpected token in include path")),
931 }
932 }
David Tolnayb0cd3272020-10-27 21:32:54 -0700933 let rangle: Token![>] = input.parse()?;
David Tolnayb0cd3272020-10-27 21:32:54 -0700934
935 return Ok(Include {
936 path,
937 kind: IncludeKind::Bracketed,
David Tolnay2cc2e3a2020-10-28 13:12:35 -0700938 begin_span: langle.span,
939 end_span: rangle.span,
David Tolnayb0cd3272020-10-27 21:32:54 -0700940 });
David Tolnay91e87fa2020-05-11 19:10:23 -0700941 }
942
943 Err(input.error("expected \"quoted/path/to\" or <bracketed/path/to>"))
944}
945
David Tolnay313cc0a2020-11-24 21:47:01 -0800946fn parse_type(ty: &RustType) -> Result<Type> {
David Tolnay59b7ede2020-03-16 00:30:23 -0700947 match ty {
David Tolnay313cc0a2020-11-24 21:47:01 -0800948 RustType::Reference(ty) => parse_type_reference(ty),
949 RustType::Path(ty) => parse_type_path(ty),
David Tolnay313cc0a2020-11-24 21:47:01 -0800950 RustType::Array(ty) => parse_type_array(ty),
951 RustType::BareFn(ty) => parse_type_fn(ty),
David Tolnayb40b9db2020-03-18 13:50:31 -0700952 RustType::Tuple(ty) if ty.elems.is_empty() => Ok(Type::Void(ty.paren_token.span)),
953 _ => Err(Error::new_spanned(ty, "unsupported type")),
954 }
955}
956
David Tolnay313cc0a2020-11-24 21:47:01 -0800957fn parse_type_reference(ty: &TypeReference) -> Result<Type> {
David Tolnayddbcb522020-12-21 15:24:45 -0800958 let ampersand = ty.and_token;
959 let lifetime = ty.lifetime.clone();
960 let mutable = ty.mutability.is_some();
961 let mutability = ty.mutability;
962
David Tolnaye0dca7b2020-11-25 17:18:57 -0800963 if let RustType::Slice(slice) = ty.elem.as_ref() {
964 let inner = parse_type(&slice.elem)?;
David Tolnayddbcb522020-12-21 15:24:45 -0800965 let bracket = slice.bracket_token;
David Tolnay69db8142020-11-25 17:49:25 -0800966 return Ok(Type::SliceRef(Box::new(SliceRef {
David Tolnayddbcb522020-12-21 15:24:45 -0800967 ampersand,
968 lifetime,
969 mutable,
970 bracket,
David Tolnay69db8142020-11-25 17:49:25 -0800971 inner,
David Tolnayddbcb522020-12-21 15:24:45 -0800972 mutability,
David Tolnay69db8142020-11-25 17:49:25 -0800973 })));
David Tolnaye0dca7b2020-11-25 17:18:57 -0800974 }
975
David Tolnay313cc0a2020-11-24 21:47:01 -0800976 let inner = parse_type(&ty.elem)?;
David Tolnayddbcb522020-12-21 15:24:45 -0800977 let pinned = false;
978 let pin_tokens = None;
979
980 Ok(match &inner {
Adrian Taylorc8713432020-10-21 18:20:55 -0700981 Type::Ident(ident) if ident.rust == "str" => {
David Tolnayb40b9db2020-03-18 13:50:31 -0700982 if ty.mutability.is_some() {
983 return Err(Error::new_spanned(ty, "unsupported type"));
984 } else {
985 Type::Str
David Tolnay7db73692019-10-20 14:51:12 -0400986 }
987 }
David Tolnayb40b9db2020-03-18 13:50:31 -0700988 _ => Type::Ref,
David Tolnayddbcb522020-12-21 15:24:45 -0800989 }(Box::new(Ref {
990 pinned,
991 ampersand,
992 lifetime,
993 mutable,
David Tolnayb40b9db2020-03-18 13:50:31 -0700994 inner,
David Tolnayddbcb522020-12-21 15:24:45 -0800995 pin_tokens,
996 mutability,
David Tolnayb40b9db2020-03-18 13:50:31 -0700997 })))
998}
999
David Tolnay313cc0a2020-11-24 21:47:01 -08001000fn parse_type_path(ty: &TypePath) -> Result<Type> {
David Tolnayb40b9db2020-03-18 13:50:31 -07001001 let path = &ty.path;
1002 if ty.qself.is_none() && path.leading_colon.is_none() && path.segments.len() == 1 {
1003 let segment = &path.segments[0];
1004 let ident = segment.ident.clone();
1005 match &segment.arguments {
David Tolnay75ea17c2020-12-06 21:08:34 -08001006 PathArguments::None => return Ok(Type::Ident(RustName::new(ident))),
David Tolnayb40b9db2020-03-18 13:50:31 -07001007 PathArguments::AngleBracketed(generic) => {
1008 if ident == "UniquePtr" && generic.args.len() == 1 {
1009 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnay313cc0a2020-11-24 21:47:01 -08001010 let inner = parse_type(arg)?;
David Tolnayb40b9db2020-03-18 13:50:31 -07001011 return Ok(Type::UniquePtr(Box::new(Ty1 {
David Tolnayda71ef62020-11-02 00:36:00 -08001012 name: ident,
David Tolnayb40b9db2020-03-18 13:50:31 -07001013 langle: generic.lt_token,
1014 inner,
1015 rangle: generic.gt_token,
1016 })));
1017 }
David Tolnayb3b24a12020-12-01 15:27:43 -08001018 } else if ident == "SharedPtr" && generic.args.len() == 1 {
1019 if let GenericArgument::Type(arg) = &generic.args[0] {
1020 let inner = parse_type(arg)?;
1021 return Ok(Type::SharedPtr(Box::new(Ty1 {
1022 name: ident,
1023 langle: generic.lt_token,
1024 inner,
1025 rangle: generic.gt_token,
1026 })));
1027 }
David Tolnay215e77f2020-12-28 17:09:48 -08001028 } else if ident == "WeakPtr" && generic.args.len() == 1 {
1029 if let GenericArgument::Type(arg) = &generic.args[0] {
1030 let inner = parse_type(arg)?;
1031 return Ok(Type::WeakPtr(Box::new(Ty1 {
1032 name: ident,
1033 langle: generic.lt_token,
1034 inner,
1035 rangle: generic.gt_token,
1036 })));
1037 }
David Tolnaye1dcdf72020-04-24 17:40:55 -07001038 } else if ident == "CxxVector" && generic.args.len() == 1 {
Myron Ahneba35cf2020-02-05 19:41:51 +07001039 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnay313cc0a2020-11-24 21:47:01 -08001040 let inner = parse_type(arg)?;
David Tolnay4377a9e2020-04-24 15:20:26 -07001041 return Ok(Type::CxxVector(Box::new(Ty1 {
David Tolnayda71ef62020-11-02 00:36:00 -08001042 name: ident,
Myron Ahneba35cf2020-02-05 19:41:51 +07001043 langle: generic.lt_token,
1044 inner,
1045 rangle: generic.gt_token,
1046 })));
1047 }
David Tolnayb40b9db2020-03-18 13:50:31 -07001048 } else if ident == "Box" && generic.args.len() == 1 {
1049 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnay313cc0a2020-11-24 21:47:01 -08001050 let inner = parse_type(arg)?;
David Tolnayb40b9db2020-03-18 13:50:31 -07001051 return Ok(Type::RustBox(Box::new(Ty1 {
David Tolnayda71ef62020-11-02 00:36:00 -08001052 name: ident,
David Tolnayb40b9db2020-03-18 13:50:31 -07001053 langle: generic.lt_token,
1054 inner,
1055 rangle: generic.gt_token,
1056 })));
1057 }
Myron Ahneba35cf2020-02-05 19:41:51 +07001058 } else if ident == "Vec" && generic.args.len() == 1 {
1059 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnay313cc0a2020-11-24 21:47:01 -08001060 let inner = parse_type(arg)?;
Myron Ahneba35cf2020-02-05 19:41:51 +07001061 return Ok(Type::RustVec(Box::new(Ty1 {
David Tolnayda71ef62020-11-02 00:36:00 -08001062 name: ident,
Myron Ahneba35cf2020-02-05 19:41:51 +07001063 langle: generic.lt_token,
1064 inner,
1065 rangle: generic.gt_token,
1066 })));
1067 }
David Tolnaycbc2a4b2020-11-15 15:08:44 -08001068 } else if ident == "Pin" && generic.args.len() == 1 {
1069 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnay313cc0a2020-11-24 21:47:01 -08001070 let inner = parse_type(arg)?;
David Tolnayc94035a2020-11-15 16:49:18 -08001071 let pin_token = kw::Pin(ident.span());
David Tolnaycbc2a4b2020-11-15 15:08:44 -08001072 if let Type::Ref(mut inner) = inner {
David Tolnaycbc2a4b2020-11-15 15:08:44 -08001073 inner.pinned = true;
1074 inner.pin_tokens =
1075 Some((pin_token, generic.lt_token, generic.gt_token));
1076 return Ok(Type::Ref(inner));
1077 }
1078 }
David Tolnayb40b9db2020-03-18 13:50:31 -07001079 }
1080 }
1081 PathArguments::Parenthesized(_) => {}
David Tolnayfb134ed2020-03-15 23:17:48 -07001082 }
David Tolnay7db73692019-10-20 14:51:12 -04001083 }
David Tolnayddbcb522020-12-21 15:24:45 -08001084
David Tolnay7db73692019-10-20 14:51:12 -04001085 Err(Error::new_spanned(ty, "unsupported type"))
1086}
1087
David Tolnay313cc0a2020-11-24 21:47:01 -08001088fn parse_type_array(ty: &TypeArray) -> Result<Type> {
1089 let inner = parse_type(&ty.elem)?;
David Tolnayd9f97842020-11-24 21:00:05 -08001090
1091 let len_expr = if let Expr::Lit(lit) = &ty.len {
1092 lit
1093 } else {
1094 let msg = "unsupported expression, array length must be an integer literal";
1095 return Err(Error::new_spanned(&ty.len, msg));
1096 };
1097
1098 let len_token = if let Lit::Int(int) = &len_expr.lit {
1099 int.clone()
1100 } else {
1101 let msg = "array length must be an integer literal";
1102 return Err(Error::new_spanned(len_expr, msg));
1103 };
1104
David Tolnay581f72d2020-11-25 15:48:59 -08001105 let len = len_token.base10_parse::<usize>()?;
1106 if len == 0 {
1107 let msg = "array with zero size is not supported";
1108 return Err(Error::new_spanned(ty, msg));
1109 }
1110
David Tolnayd9f97842020-11-24 21:00:05 -08001111 let bracket = ty.bracket_token;
1112 let semi_token = ty.semi_token;
David Tolnayd9f97842020-11-24 21:00:05 -08001113
1114 Ok(Type::Array(Box::new(Array {
1115 bracket,
1116 inner,
1117 semi_token,
1118 len,
1119 len_token,
1120 })))
David Tolnay2d0df232020-11-24 20:50:32 -08001121}
1122
David Tolnay313cc0a2020-11-24 21:47:01 -08001123fn parse_type_fn(ty: &TypeBareFn) -> Result<Type> {
David Tolnayc071b892020-03-18 16:59:53 -07001124 if ty.lifetimes.is_some() {
1125 return Err(Error::new_spanned(
1126 ty,
1127 "function pointer with lifetime parameters is not supported yet",
1128 ));
1129 }
David Tolnayddbcb522020-12-21 15:24:45 -08001130
David Tolnayc071b892020-03-18 16:59:53 -07001131 if ty.variadic.is_some() {
1132 return Err(Error::new_spanned(
1133 ty,
1134 "variadic function pointer is not supported yet",
1135 ));
1136 }
David Tolnayddbcb522020-12-21 15:24:45 -08001137
David Tolnayc071b892020-03-18 16:59:53 -07001138 let args = ty
1139 .inputs
1140 .iter()
1141 .enumerate()
1142 .map(|(i, arg)| {
David Tolnay313cc0a2020-11-24 21:47:01 -08001143 let ty = parse_type(&arg.ty)?;
David Tolnayc071b892020-03-18 16:59:53 -07001144 let ident = match &arg.name {
1145 Some(ident) => ident.0.clone(),
David Tolnayb4c14552020-12-29 15:44:19 -08001146 None => format_ident!("arg{}", i),
David Tolnayc071b892020-03-18 16:59:53 -07001147 };
David Tolnayb4a05c32020-12-30 15:37:01 -08001148 let doc = Doc::new();
David Tolnaycba3d442020-12-30 16:39:21 -08001149 let attrs = OtherAttrs::none();
David Tolnay89902442020-12-30 15:10:40 -08001150 let visibility = Token![pub](ident.span());
1151 Ok(Var {
David Tolnayb4a05c32020-12-30 15:37:01 -08001152 doc,
David Tolnay067638e2020-12-30 16:18:05 -08001153 attrs,
David Tolnay89902442020-12-30 15:10:40 -08001154 visibility,
1155 ident,
1156 ty,
1157 })
David Tolnayc071b892020-03-18 16:59:53 -07001158 })
1159 .collect::<Result<_>>()?;
David Tolnayddbcb522020-12-21 15:24:45 -08001160
David Tolnaye3a48152020-04-08 19:38:05 -07001161 let mut throws_tokens = None;
David Tolnay313cc0a2020-11-24 21:47:01 -08001162 let ret = parse_return_type(&ty.output, &mut throws_tokens)?;
David Tolnaye3a48152020-04-08 19:38:05 -07001163 let throws = throws_tokens.is_some();
David Tolnayddbcb522020-12-21 15:24:45 -08001164
1165 let unsafety = ty.unsafety;
1166 let fn_token = ty.fn_token;
1167 let generics = Generics::default();
1168 let receiver = None;
1169 let paren_token = ty.paren_token;
1170
David Tolnayc071b892020-03-18 16:59:53 -07001171 Ok(Type::Fn(Box::new(Signature {
David Tolnayddbcb522020-12-21 15:24:45 -08001172 unsafety,
1173 fn_token,
1174 generics,
1175 receiver,
David Tolnayc071b892020-03-18 16:59:53 -07001176 args,
1177 ret,
1178 throws,
David Tolnayddbcb522020-12-21 15:24:45 -08001179 paren_token,
David Tolnaye3a48152020-04-08 19:38:05 -07001180 throws_tokens,
David Tolnayc071b892020-03-18 16:59:53 -07001181 })))
1182}
1183
David Tolnaye3a48152020-04-08 19:38:05 -07001184fn parse_return_type(
1185 ty: &ReturnType,
1186 throws_tokens: &mut Option<(kw::Result, Token![<], Token![>])>,
1187) -> Result<Option<Type>> {
David Tolnayc071b892020-03-18 16:59:53 -07001188 let mut ret = match ty {
1189 ReturnType::Default => return Ok(None),
1190 ReturnType::Type(_, ret) => ret.as_ref(),
1191 };
David Tolnayddbcb522020-12-21 15:24:45 -08001192
David Tolnayc071b892020-03-18 16:59:53 -07001193 if let RustType::Path(ty) = ret {
1194 let path = &ty.path;
1195 if ty.qself.is_none() && path.leading_colon.is_none() && path.segments.len() == 1 {
1196 let segment = &path.segments[0];
1197 let ident = segment.ident.clone();
1198 if let PathArguments::AngleBracketed(generic) = &segment.arguments {
1199 if ident == "Result" && generic.args.len() == 1 {
1200 if let GenericArgument::Type(arg) = &generic.args[0] {
1201 ret = arg;
David Tolnaye3a48152020-04-08 19:38:05 -07001202 *throws_tokens =
1203 Some((kw::Result(ident.span()), generic.lt_token, generic.gt_token));
David Tolnayc071b892020-03-18 16:59:53 -07001204 }
1205 }
1206 }
1207 }
1208 }
David Tolnayddbcb522020-12-21 15:24:45 -08001209
David Tolnay313cc0a2020-11-24 21:47:01 -08001210 match parse_type(ret)? {
David Tolnayc071b892020-03-18 16:59:53 -07001211 Type::Void(_) => Ok(None),
1212 ty => Ok(Some(ty)),
1213 }
1214}
David Tolnay6a990f82020-12-21 15:42:31 -08001215
1216fn pair(namespace: Namespace, default: &Ident, cxx: Option<Ident>, rust: Option<Ident>) -> Pair {
1217 let default = || default.clone();
David Tolnayc2a4c782020-12-21 15:55:31 -08001218 Pair {
David Tolnay6a990f82020-12-21 15:42:31 -08001219 namespace,
David Tolnayc2a4c782020-12-21 15:55:31 -08001220 cxx: cxx.unwrap_or_else(default),
1221 rust: rust.unwrap_or_else(default),
1222 }
David Tolnay6a990f82020-12-21 15:42:31 -08001223}