blob: 5ce2cf31ee7fee908acbeb2f389e2a1afb990a39 [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 Tolnaye2e303f2020-05-10 20:52:00 -0700197 let enum_token = item.enum_token;
198 let brace_token = item.brace_token;
199
David Tolnay58eee392020-11-20 20:37:58 -0800200 let explicit_repr = repr.is_some();
David Tolnay0435a812020-05-10 21:58:15 -0700201 let mut repr = U8;
202 match discriminants.inferred_repr() {
203 Ok(inferred) => repr = inferred,
David Tolnaye2e303f2020-05-10 20:52:00 -0700204 Err(err) => {
205 let span = quote_spanned!(brace_token.span=> #enum_token {});
David Tolnay0435a812020-05-10 21:58:15 -0700206 cx.error(span, err);
207 variants.clear();
David Tolnaye2e303f2020-05-10 20:52:00 -0700208 }
David Tolnay0435a812020-05-10 21:58:15 -0700209 }
David Tolnaye2e303f2020-05-10 20:52:00 -0700210
David Tolnay885be132020-12-21 15:52:47 -0800211 let name = pair(namespace, &item.ident, cxx_name, rust_name);
David Tolnayddbcb522020-12-21 15:24:45 -0800212 let repr_ident = Ident::new(repr.as_ref(), Span::call_site());
213 let repr_type = Type::Ident(RustName::new(repr_ident));
David Tolnay9a69d8a2020-11-16 09:16:41 -0800214
Joel Galensonc03402a2020-04-23 17:31:09 -0700215 Ok(Api::Enum(Enum {
216 doc,
David Tolnayfbc46692020-11-27 11:33:29 -0800217 derives,
David Tolnay067638e2020-12-30 16:18:05 -0800218 attrs,
David Tolnaye2e303f2020-05-10 20:52:00 -0700219 enum_token,
David Tolnayddbcb522020-12-21 15:24:45 -0800220 name,
David Tolnaye2e303f2020-05-10 20:52:00 -0700221 brace_token,
David Tolnay7ae018f2020-05-05 10:11:30 -0700222 variants,
David Tolnaye2e303f2020-05-10 20:52:00 -0700223 repr,
David Tolnay9a69d8a2020-11-16 09:16:41 -0800224 repr_type,
David Tolnay58eee392020-11-20 20:37:58 -0800225 explicit_repr,
Joel Galensonc03402a2020-04-23 17:31:09 -0700226 }))
227}
228
David Tolnay6bf9ef42020-12-21 16:11:40 -0800229fn parse_variant(
230 cx: &mut Errors,
David Tolnay15a1fc12020-12-30 16:04:56 -0800231 mut variant: RustVariant,
David Tolnay6bf9ef42020-12-21 16:11:40 -0800232 discriminants: &mut DiscriminantSet,
233) -> Result<Variant> {
David Tolnay4486f722020-12-30 00:01:26 -0800234 let mut doc = Doc::new();
David Tolnay6bf9ef42020-12-21 16:11:40 -0800235 let mut cxx_name = None;
236 let mut rust_name = None;
David Tolnay067638e2020-12-30 16:18:05 -0800237 let attrs = attrs::parse(
David Tolnay6bf9ef42020-12-21 16:11:40 -0800238 cx,
David Tolnay067638e2020-12-30 16:18:05 -0800239 mem::take(&mut variant.attrs),
David Tolnay6bf9ef42020-12-21 16:11:40 -0800240 attrs::Parser {
David Tolnay4486f722020-12-30 00:01:26 -0800241 doc: Some(&mut doc),
David Tolnay6bf9ef42020-12-21 16:11:40 -0800242 cxx_name: Some(&mut cxx_name),
243 rust_name: Some(&mut rust_name),
244 ..Default::default()
245 },
246 );
247
David Tolnay26809232020-12-21 16:06:47 -0800248 match variant.fields {
249 Fields::Unit => {}
250 _ => {
251 let msg = "enums with data are not supported yet";
252 return Err(Error::new_spanned(variant, msg));
253 }
254 }
255
256 let expr = variant.discriminant.as_ref().map(|(_, expr)| expr);
257 let try_discriminant = match &expr {
258 Some(lit) => discriminants.insert(lit),
259 None => discriminants.insert_next(),
260 };
261 let discriminant = match try_discriminant {
262 Ok(discriminant) => discriminant,
263 Err(err) => return Err(Error::new_spanned(variant, err)),
264 };
David Tolnaye6f62142020-12-21 16:00:41 -0800265
David Tolnay6bf9ef42020-12-21 16:11:40 -0800266 let name = pair(Namespace::ROOT, &variant.ident, cxx_name, rust_name);
David Tolnay26809232020-12-21 16:06:47 -0800267 let expr = variant.discriminant.map(|(_, expr)| expr);
268
269 Ok(Variant {
David Tolnay4486f722020-12-30 00:01:26 -0800270 doc,
David Tolnay067638e2020-12-30 16:18:05 -0800271 attrs,
David Tolnaye6f62142020-12-21 16:00:41 -0800272 name,
David Tolnay26809232020-12-21 16:06:47 -0800273 discriminant,
274 expr,
275 })
276}
277
David Tolnay805dca32020-08-29 19:09:55 -0700278fn parse_foreign_mod(
279 cx: &mut Errors,
280 foreign_mod: ItemForeignMod,
281 out: &mut Vec<Api>,
282 trusted: bool,
David Tolnayd7a3a182020-11-01 20:45:14 -0800283 namespace: &Namespace,
David Tolnay805dca32020-08-29 19:09:55 -0700284) {
David Tolnay3a451732020-08-29 18:54:55 -0700285 let lang = match parse_lang(&foreign_mod.abi) {
David Tolnay52759782020-05-03 23:59:40 -0700286 Ok(lang) => lang,
287 Err(err) => return cx.push(err),
288 };
David Tolnay7db73692019-10-20 14:51:12 -0400289
David Tolnay3a451732020-08-29 18:54:55 -0700290 match lang {
291 Lang::Rust => {
David Tolnay805dca32020-08-29 19:09:55 -0700292 if foreign_mod.unsafety.is_some() {
David Tolnay3a451732020-08-29 18:54:55 -0700293 let unsafety = foreign_mod.unsafety;
David Tolnay7be5b1f2020-11-11 10:48:32 -0800294 let abi = &foreign_mod.abi;
David Tolnay3a451732020-08-29 18:54:55 -0700295 let span = quote!(#unsafety #abi);
296 cx.error(span, "extern \"Rust\" block does not need to be unsafe");
297 }
298 }
299 Lang::Cxx => {}
300 }
301
David Tolnay805dca32020-08-29 19:09:55 -0700302 let trusted = trusted || foreign_mod.unsafety.is_some();
303
David Tolnay7feb2642020-11-10 18:49:04 -0800304 let mut namespace = namespace.clone();
305 attrs::parse(
306 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -0800307 foreign_mod.attrs,
David Tolnay7feb2642020-11-10 18:49:04 -0800308 attrs::Parser {
309 namespace: Some(&mut namespace),
310 ..Default::default()
311 },
312 );
313
Joel Galensone1e969d2020-04-21 12:50:20 -0700314 let mut items = Vec::new();
David Tolnay15a1fc12020-12-30 16:04:56 -0800315 for foreign in foreign_mod.items {
Joel Galensone1e969d2020-04-21 12:50:20 -0700316 match foreign {
Adrian Taylorc8713432020-10-21 18:20:55 -0700317 ForeignItem::Type(foreign) => {
David Tolnayf5ead102020-11-24 17:08:05 -0800318 let ety = parse_extern_type(cx, foreign, lang, trusted, &namespace);
319 items.push(ety);
Adrian Taylorc8713432020-10-21 18:20:55 -0700320 }
David Tolnay556738d2020-11-15 13:58:44 -0800321 ForeignItem::Fn(foreign) => {
322 match parse_extern_fn(cx, foreign, lang, trusted, &namespace) {
323 Ok(efn) => items.push(efn),
324 Err(err) => cx.push(err),
325 }
326 }
David Tolnay7db73692019-10-20 14:51:12 -0400327 ForeignItem::Macro(foreign) if foreign.mac.path.is_ident("include") => {
David Tolnay91e87fa2020-05-11 19:10:23 -0700328 match foreign.mac.parse_body_with(parse_include) {
David Tolnay52759782020-05-03 23:59:40 -0700329 Ok(include) => items.push(Api::Include(include)),
330 Err(err) => cx.push(err),
331 }
David Tolnay7db73692019-10-20 14:51:12 -0400332 }
Adrian Taylorc8713432020-10-21 18:20:55 -0700333 ForeignItem::Verbatim(tokens) => {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800334 match parse_extern_verbatim(cx, tokens, lang, trusted, &namespace) {
Adrian Taylorc8713432020-10-21 18:20:55 -0700335 Ok(api) => items.push(api),
336 Err(err) => cx.push(err),
337 }
338 }
David Tolnay52759782020-05-03 23:59:40 -0700339 _ => cx.error(foreign, "unsupported foreign item"),
David Tolnay7db73692019-10-20 14:51:12 -0400340 }
341 }
David Tolnaya1f29c42020-04-22 18:01:38 -0700342
David Tolnay7be5b1f2020-11-11 10:48:32 -0800343 if !trusted
344 && items.iter().any(|api| match api {
345 Api::CxxFunction(efn) => efn.unsafety.is_none(),
346 _ => false,
347 })
348 {
349 cx.error(
350 foreign_mod.abi,
351 "block must be declared `unsafe extern \"C++\"` if it contains any safe-to-call C++ functions",
352 );
353 }
354
David Tolnaya1f29c42020-04-22 18:01:38 -0700355 let mut types = items.iter().filter_map(|item| match item {
David Tolnay17a934c2020-11-02 00:40:04 -0800356 Api::CxxType(ety) | Api::RustType(ety) => Some(&ety.name),
357 Api::TypeAlias(alias) => Some(&alias.name),
David Tolnaya1f29c42020-04-22 18:01:38 -0700358 _ => None,
359 });
360 if let (Some(single_type), None) = (types.next(), types.next()) {
David Tolnaye5a015a2020-05-07 21:54:26 -0700361 let single_type = single_type.clone();
David Tolnaya1f29c42020-04-22 18:01:38 -0700362 for item in &mut items {
363 if let Api::CxxFunction(efn) | Api::RustFunction(efn) = item {
364 if let Some(receiver) = &mut efn.receiver {
David Tolnay2d99b002020-12-21 14:34:35 -0800365 if receiver.ty.rust == "Self" {
366 receiver.ty.rust = single_type.rust.clone();
David Tolnaya1f29c42020-04-22 18:01:38 -0700367 }
368 }
369 }
370 }
371 }
372
David Tolnay52759782020-05-03 23:59:40 -0700373 out.extend(items);
David Tolnay7db73692019-10-20 14:51:12 -0400374}
375
David Tolnay3a451732020-08-29 18:54:55 -0700376fn parse_lang(abi: &Abi) -> Result<Lang> {
David Tolnay7db73692019-10-20 14:51:12 -0400377 let name = match &abi.name {
378 Some(name) => name,
379 None => {
380 return Err(Error::new_spanned(
381 abi,
David Tolnayc72a9f62020-11-11 10:56:26 -0800382 "ABI name is required, extern \"C++\" or extern \"Rust\"",
David Tolnay7db73692019-10-20 14:51:12 -0400383 ));
384 }
385 };
David Tolnayddbcb522020-12-21 15:24:45 -0800386
David Tolnay7db73692019-10-20 14:51:12 -0400387 match name.value().as_str() {
David Tolnayea25ac82020-11-11 10:35:23 -0800388 "C++" => Ok(Lang::Cxx),
David Tolnay7db73692019-10-20 14:51:12 -0400389 "Rust" => Ok(Lang::Rust),
David Tolnay2757ca82020-11-14 15:12:06 -0800390 _ => Err(Error::new_spanned(
391 abi,
392 "unrecognized ABI, requires either \"C++\" or \"Rust\"",
393 )),
David Tolnay7db73692019-10-20 14:51:12 -0400394 }
395}
396
David Tolnay00f236a2020-08-29 19:07:18 -0700397fn parse_extern_type(
398 cx: &mut Errors,
David Tolnay15a1fc12020-12-30 16:04:56 -0800399 foreign_type: ForeignItemType,
David Tolnay00f236a2020-08-29 19:07:18 -0700400 lang: Lang,
401 trusted: bool,
David Tolnay302b1752020-11-10 18:43:24 -0800402 namespace: &Namespace,
David Tolnayf5ead102020-11-24 17:08:05 -0800403) -> Api {
Adrian Taylorc8713432020-10-21 18:20:55 -0700404 let mut doc = Doc::new();
David Tolnay16e26202020-11-27 19:28:37 -0800405 let mut derives = Vec::new();
David Tolnay302b1752020-11-10 18:43:24 -0800406 let mut namespace = namespace.clone();
David Tolnay885be132020-12-21 15:52:47 -0800407 let mut cxx_name = None;
408 let mut rust_name = None;
David Tolnay067638e2020-12-30 16:18:05 -0800409 let attrs = attrs::parse(
Adrian Taylorc8713432020-10-21 18:20:55 -0700410 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -0800411 foreign_type.attrs,
Adrian Taylorc8713432020-10-21 18:20:55 -0700412 attrs::Parser {
413 doc: Some(&mut doc),
David Tolnay16e26202020-11-27 19:28:37 -0800414 derives: Some(&mut derives),
David Tolnayd7a3a182020-11-01 20:45:14 -0800415 namespace: Some(&mut namespace),
David Tolnay885be132020-12-21 15:52:47 -0800416 cxx_name: Some(&mut cxx_name),
417 rust_name: Some(&mut rust_name),
Adrian Taylorc8713432020-10-21 18:20:55 -0700418 ..Default::default()
419 },
420 );
David Tolnayddbcb522020-12-21 15:24:45 -0800421
David Tolnay7db73692019-10-20 14:51:12 -0400422 let type_token = foreign_type.type_token;
David Tolnay885be132020-12-21 15:52:47 -0800423 let name = pair(namespace, &foreign_type.ident, cxx_name, rust_name);
David Tolnayee312322020-12-28 22:04:10 -0800424 let generics = Lifetimes {
425 lt_token: None,
426 lifetimes: Punctuated::new(),
427 gt_token: None,
428 };
David Tolnayddbcb522020-12-21 15:24:45 -0800429 let colon_token = None;
430 let bounds = Vec::new();
David Tolnayc8361022020-08-25 21:57:53 -0700431 let semi_token = foreign_type.semi_token;
David Tolnayddbcb522020-12-21 15:24:45 -0800432
433 (match lang {
David Tolnay295ef6b2020-05-07 16:10:22 -0700434 Lang::Cxx => Api::CxxType,
435 Lang::Rust => Api::RustType,
David Tolnayddbcb522020-12-21 15:24:45 -0800436 })(ExternType {
David Tolnay16e26202020-11-27 19:28:37 -0800437 lang,
David Tolnay7db73692019-10-20 14:51:12 -0400438 doc,
David Tolnay16e26202020-11-27 19:28:37 -0800439 derives,
David Tolnay067638e2020-12-30 16:18:05 -0800440 attrs,
David Tolnay7db73692019-10-20 14:51:12 -0400441 type_token,
David Tolnayddbcb522020-12-21 15:24:45 -0800442 name,
David Tolnayee312322020-12-28 22:04:10 -0800443 generics,
David Tolnayddbcb522020-12-21 15:24:45 -0800444 colon_token,
445 bounds,
David Tolnayc8361022020-08-25 21:57:53 -0700446 semi_token,
David Tolnay00f236a2020-08-29 19:07:18 -0700447 trusted,
David Tolnayf5ead102020-11-24 17:08:05 -0800448 })
David Tolnay7db73692019-10-20 14:51:12 -0400449}
450
Adrian Taylorc8713432020-10-21 18:20:55 -0700451fn parse_extern_fn(
452 cx: &mut Errors,
David Tolnay15a1fc12020-12-30 16:04:56 -0800453 mut foreign_fn: ForeignItemFn,
Adrian Taylorc8713432020-10-21 18:20:55 -0700454 lang: Lang,
David Tolnay556738d2020-11-15 13:58:44 -0800455 trusted: bool,
David Tolnay302b1752020-11-10 18:43:24 -0800456 namespace: &Namespace,
Adrian Taylorc8713432020-10-21 18:20:55 -0700457) -> Result<Api> {
David Tolnaybc954d92020-12-21 15:17:10 -0800458 let mut doc = Doc::new();
David Tolnaya2dfcbf2020-12-21 15:46:24 -0800459 let mut namespace = namespace.clone();
David Tolnaybc954d92020-12-21 15:17:10 -0800460 let mut cxx_name = None;
461 let mut rust_name = None;
David Tolnay067638e2020-12-30 16:18:05 -0800462 let attrs = attrs::parse(
David Tolnaybc954d92020-12-21 15:17:10 -0800463 cx,
David Tolnay067638e2020-12-30 16:18:05 -0800464 mem::take(&mut foreign_fn.attrs),
David Tolnaybc954d92020-12-21 15:17:10 -0800465 attrs::Parser {
466 doc: Some(&mut doc),
David Tolnaya2dfcbf2020-12-21 15:46:24 -0800467 namespace: Some(&mut namespace),
David Tolnaybc954d92020-12-21 15:17:10 -0800468 cxx_name: Some(&mut cxx_name),
469 rust_name: Some(&mut rust_name),
David Tolnaybc954d92020-12-21 15:17:10 -0800470 ..Default::default()
471 },
472 );
473
David Tolnay7db73692019-10-20 14:51:12 -0400474 let generics = &foreign_fn.sig.generics;
David Tolnay9938b642020-11-15 18:11:40 -0800475 if generics.where_clause.is_some()
476 || generics.params.iter().any(|param| match param {
477 GenericParam::Lifetime(lifetime) => !lifetime.bounds.is_empty(),
478 GenericParam::Type(_) | GenericParam::Const(_) => true,
479 })
480 {
David Tolnay7db73692019-10-20 14:51:12 -0400481 return Err(Error::new_spanned(
482 foreign_fn,
483 "extern function with generic parameters is not supported yet",
484 ));
485 }
David Tolnayddbcb522020-12-21 15:24:45 -0800486
David Tolnay7db73692019-10-20 14:51:12 -0400487 if let Some(variadic) = &foreign_fn.sig.variadic {
488 return Err(Error::new_spanned(
489 variadic,
490 "variadic function is not supported yet",
491 ));
492 }
David Tolnayddbcb522020-12-21 15:24:45 -0800493
David Tolnay8de461f2020-11-19 13:46:14 -0800494 if foreign_fn.sig.asyncness.is_some() {
495 return Err(Error::new_spanned(
496 foreign_fn,
497 "async function is not directly supported yet, but see https://cxx.rs/async.html for a working approach",
498 ));
499 }
David Tolnayddbcb522020-12-21 15:24:45 -0800500
David Tolnay80ef0682020-11-19 13:56:07 -0800501 if foreign_fn.sig.constness.is_some() {
502 return Err(Error::new_spanned(
503 foreign_fn,
504 "const extern function is not supported",
505 ));
506 }
David Tolnayddbcb522020-12-21 15:24:45 -0800507
David Tolnay80ef0682020-11-19 13:56:07 -0800508 if let Some(abi) = &foreign_fn.sig.abi {
509 return Err(Error::new_spanned(
510 abi,
511 "explicit ABI on extern function is not supported",
512 ));
513 }
David Tolnay7db73692019-10-20 14:51:12 -0400514
515 let mut receiver = None;
David Tolnaye3a48152020-04-08 19:38:05 -0700516 let mut args = Punctuated::new();
517 for arg in foreign_fn.sig.inputs.pairs() {
518 let (arg, comma) = arg.into_tuple();
David Tolnay7db73692019-10-20 14:51:12 -0400519 match arg {
David Tolnay1dd11a12020-04-22 12:31:48 -0700520 FnArg::Receiver(arg) => {
David Tolnaya1f29c42020-04-22 18:01:38 -0700521 if let Some((ampersand, lifetime)) = &arg.reference {
522 receiver = Some(Receiver {
David Tolnay9c76c392020-11-15 16:07:08 -0800523 pinned: false,
David Tolnaya1f29c42020-04-22 18:01:38 -0700524 ampersand: *ampersand,
525 lifetime: lifetime.clone(),
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800526 mutable: arg.mutability.is_some(),
David Tolnaya1f29c42020-04-22 18:01:38 -0700527 var: arg.self_token,
David Tolnay2d99b002020-12-21 14:34:35 -0800528 ty: RustName::new(Ident::new("Self", arg.self_token.span)),
David Tolnaya1f29c42020-04-22 18:01:38 -0700529 shorthand: true,
David Tolnay9c76c392020-11-15 16:07:08 -0800530 pin_tokens: None,
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800531 mutability: arg.mutability,
David Tolnaya1f29c42020-04-22 18:01:38 -0700532 });
533 continue;
Joel Galensone1e969d2020-04-21 12:50:20 -0700534 }
David Tolnay1dd11a12020-04-22 12:31:48 -0700535 return Err(Error::new_spanned(arg, "unsupported signature"));
David Tolnay7db73692019-10-20 14:51:12 -0400536 }
537 FnArg::Typed(arg) => {
538 let ident = match arg.pat.as_ref() {
539 Pat::Ident(pat) => pat.ident.clone(),
Joel Galensonba676072020-04-27 15:55:45 -0700540 Pat::Wild(pat) => {
David Tolnayb4c14552020-12-29 15:44:19 -0800541 Ident::new(&format!("arg{}", args.len()), pat.underscore_token.span)
Joel Galensonba676072020-04-27 15:55:45 -0700542 }
David Tolnay7db73692019-10-20 14:51:12 -0400543 _ => return Err(Error::new_spanned(arg, "unsupported signature")),
544 };
David Tolnay313cc0a2020-11-24 21:47:01 -0800545 let ty = parse_type(&arg.ty)?;
David Tolnay7db73692019-10-20 14:51:12 -0400546 if ident != "self" {
David Tolnayb4a05c32020-12-30 15:37:01 -0800547 let doc = Doc::new();
David Tolnaycba3d442020-12-30 16:39:21 -0800548 let attrs = OtherAttrs::none();
David Tolnay89902442020-12-30 15:10:40 -0800549 let visibility = Token![pub](ident.span());
550 args.push_value(Var {
David Tolnayb4a05c32020-12-30 15:37:01 -0800551 doc,
David Tolnay067638e2020-12-30 16:18:05 -0800552 attrs,
David Tolnay89902442020-12-30 15:10:40 -0800553 visibility,
554 ident,
555 ty,
556 });
David Tolnaye3a48152020-04-08 19:38:05 -0700557 if let Some(comma) = comma {
558 args.push_punct(*comma);
559 }
David Tolnay7db73692019-10-20 14:51:12 -0400560 continue;
561 }
562 if let Type::Ref(reference) = ty {
563 if let Type::Ident(ident) = reference.inner {
564 receiver = Some(Receiver {
David Tolnay9c76c392020-11-15 16:07:08 -0800565 pinned: reference.pinned,
David Tolnayfb6e3862020-04-20 01:33:23 -0700566 ampersand: reference.ampersand,
David Tolnay0bd50fa2020-04-22 15:31:33 -0700567 lifetime: reference.lifetime,
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800568 mutable: reference.mutable,
Adrian Taylorc8713432020-10-21 18:20:55 -0700569 var: Token![self](ident.rust.span()),
David Tolnay05e11cc2020-04-20 02:13:56 -0700570 ty: ident,
David Tolnay62d360c2020-04-22 16:26:21 -0700571 shorthand: false,
David Tolnay9c76c392020-11-15 16:07:08 -0800572 pin_tokens: reference.pin_tokens,
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800573 mutability: reference.mutability,
David Tolnay7db73692019-10-20 14:51:12 -0400574 });
575 continue;
576 }
577 }
578 return Err(Error::new_spanned(arg, "unsupported method receiver"));
579 }
580 }
581 }
David Tolnay59b7ede2020-03-16 00:30:23 -0700582
David Tolnaye3a48152020-04-08 19:38:05 -0700583 let mut throws_tokens = None;
David Tolnay313cc0a2020-11-24 21:47:01 -0800584 let ret = parse_return_type(&foreign_fn.sig.output, &mut throws_tokens)?;
David Tolnaye3a48152020-04-08 19:38:05 -0700585 let throws = throws_tokens.is_some();
David Tolnaybdb576c2020-09-06 23:45:55 -0700586 let unsafety = foreign_fn.sig.unsafety;
David Tolnay7db73692019-10-20 14:51:12 -0400587 let fn_token = foreign_fn.sig.fn_token;
David Tolnay6a990f82020-12-21 15:42:31 -0800588 let name = pair(namespace, &foreign_fn.sig.ident, cxx_name, rust_name);
David Tolnay9938b642020-11-15 18:11:40 -0800589 let generics = generics.clone();
David Tolnaye3a48152020-04-08 19:38:05 -0700590 let paren_token = foreign_fn.sig.paren_token;
David Tolnay7db73692019-10-20 14:51:12 -0400591 let semi_token = foreign_fn.semi_token;
David Tolnayddbcb522020-12-21 15:24:45 -0800592
593 Ok(match lang {
David Tolnay295ef6b2020-05-07 16:10:22 -0700594 Lang::Cxx => Api::CxxFunction,
595 Lang::Rust => Api::RustFunction,
David Tolnayddbcb522020-12-21 15:24:45 -0800596 }(ExternFn {
David Tolnay6cde49f2020-03-16 12:25:45 -0700597 lang,
David Tolnay7db73692019-10-20 14:51:12 -0400598 doc,
David Tolnay067638e2020-12-30 16:18:05 -0800599 attrs,
David Tolnay17a934c2020-11-02 00:40:04 -0800600 name,
David Tolnay16448732020-03-18 12:39:36 -0700601 sig: Signature {
David Tolnaybdb576c2020-09-06 23:45:55 -0700602 unsafety,
David Tolnay16448732020-03-18 12:39:36 -0700603 fn_token,
David Tolnay9938b642020-11-15 18:11:40 -0800604 generics,
David Tolnay16448732020-03-18 12:39:36 -0700605 receiver,
606 args,
607 ret,
608 throws,
David Tolnaye3a48152020-04-08 19:38:05 -0700609 paren_token,
610 throws_tokens,
David Tolnay16448732020-03-18 12:39:36 -0700611 },
David Tolnay7db73692019-10-20 14:51:12 -0400612 semi_token,
David Tolnay556738d2020-11-15 13:58:44 -0800613 trusted,
David Tolnay295ef6b2020-05-07 16:10:22 -0700614 }))
David Tolnay7db73692019-10-20 14:51:12 -0400615}
616
Adrian Taylorc8713432020-10-21 18:20:55 -0700617fn parse_extern_verbatim(
618 cx: &mut Errors,
David Tolnay15a1fc12020-12-30 16:04:56 -0800619 tokens: TokenStream,
Adrian Taylorc8713432020-10-21 18:20:55 -0700620 lang: Lang,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800621 trusted: bool,
David Tolnay302b1752020-11-10 18:43:24 -0800622 namespace: &Namespace,
Adrian Taylorc8713432020-10-21 18:20:55 -0700623) -> Result<Api> {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800624 |input: ParseStream| -> Result<Api> {
David Tolnaye2f9ec42020-05-07 16:19:33 -0700625 let attrs = input.call(Attribute::parse_outer)?;
David Tolnayd6143702020-12-29 23:48:09 -0800626 input.parse::<Visibility>()?;
David Tolnaye2f9ec42020-05-07 16:19:33 -0700627 let type_token: Token![type] = match input.parse()? {
628 Some(type_token) => type_token,
629 None => {
630 let span = input.cursor().token_stream();
631 return Err(Error::new_spanned(span, "unsupported foreign item"));
632 }
633 };
634 let ident: Ident = input.parse()?;
David Tolnaye81647f2020-12-28 19:30:01 -0800635 let generics: Generics = input.parse()?;
David Tolnayee312322020-12-28 22:04:10 -0800636 let mut lifetimes = Punctuated::new();
David Tolnaye81647f2020-12-28 19:30:01 -0800637 let mut has_unsupported_generic_param = false;
David Tolnayee312322020-12-28 22:04:10 -0800638 for pair in generics.params.into_pairs() {
639 let (param, punct) = pair.into_tuple();
David Tolnaye81647f2020-12-28 19:30:01 -0800640 match param {
641 GenericParam::Lifetime(param) => {
642 if !param.bounds.is_empty() && !has_unsupported_generic_param {
643 let msg = "lifetime parameter with bounds is not supported yet";
644 cx.error(&param, msg);
645 has_unsupported_generic_param = true;
646 }
David Tolnayee312322020-12-28 22:04:10 -0800647 lifetimes.push_value(param.lifetime);
648 if let Some(punct) = punct {
649 lifetimes.push_punct(punct);
650 }
David Tolnaye81647f2020-12-28 19:30:01 -0800651 }
652 GenericParam::Type(param) => {
653 if !has_unsupported_generic_param {
654 let msg = "extern type with generic type parameter is not supported yet";
655 cx.error(&param, msg);
656 has_unsupported_generic_param = true;
657 }
658 }
659 GenericParam::Const(param) => {
660 if !has_unsupported_generic_param {
661 let msg = "extern type with const generic parameter is not supported yet";
662 cx.error(&param, msg);
663 has_unsupported_generic_param = true;
664 }
665 }
666 }
667 }
David Tolnayee312322020-12-28 22:04:10 -0800668 let lifetimes = Lifetimes {
669 lt_token: generics.lt_token,
670 lifetimes,
671 gt_token: generics.gt_token,
672 };
David Tolnayb7eb65e2020-11-27 20:00:53 -0800673 let lookahead = input.lookahead1();
674 if lookahead.peek(Token![=]) {
675 // type Alias = crate::path::to::Type;
David Tolnaye81647f2020-12-28 19:30:01 -0800676 parse_type_alias(
677 cx, attrs, type_token, ident, lifetimes, input, lang, namespace,
678 )
David Tolnaya870ac72020-12-28 19:48:33 -0800679 } else if lookahead.peek(Token![:]) || lookahead.peek(Token![;]) {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800680 // type Opaque: Bound2 + Bound2;
681 parse_extern_type_bounded(
David Tolnaye81647f2020-12-28 19:30:01 -0800682 cx, attrs, type_token, ident, lifetimes, input, lang, trusted, namespace,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800683 )
684 } else {
685 Err(lookahead.error())
David Tolnaye2f9ec42020-05-07 16:19:33 -0700686 }
687 }
David Tolnay15a1fc12020-12-30 16:04:56 -0800688 .parse2(tokens)
David Tolnayb7eb65e2020-11-27 20:00:53 -0800689}
690
691fn parse_type_alias(
692 cx: &mut Errors,
693 attrs: Vec<Attribute>,
694 type_token: Token![type],
695 ident: Ident,
David Tolnayee312322020-12-28 22:04:10 -0800696 generics: Lifetimes,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800697 input: ParseStream,
698 lang: Lang,
699 namespace: &Namespace,
700) -> Result<Api> {
701 let eq_token: Token![=] = input.parse()?;
702 let ty: RustType = input.parse()?;
703 let semi_token: Token![;] = input.parse()?;
704
705 let mut doc = Doc::new();
706 let mut derives = Vec::new();
707 let mut namespace = namespace.clone();
David Tolnay885be132020-12-21 15:52:47 -0800708 let mut cxx_name = None;
709 let mut rust_name = None;
David Tolnay067638e2020-12-30 16:18:05 -0800710 let attrs = attrs::parse(
David Tolnayb7eb65e2020-11-27 20:00:53 -0800711 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -0800712 attrs,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800713 attrs::Parser {
714 doc: Some(&mut doc),
715 derives: Some(&mut derives),
716 namespace: Some(&mut namespace),
David Tolnay885be132020-12-21 15:52:47 -0800717 cxx_name: Some(&mut cxx_name),
718 rust_name: Some(&mut rust_name),
David Tolnayb7eb65e2020-11-27 20:00:53 -0800719 ..Default::default()
720 },
721 );
722
723 if lang == Lang::Rust {
724 let span = quote!(#type_token #semi_token);
725 let msg = "type alias in extern \"Rust\" block is not supported";
726 return Err(Error::new_spanned(span, msg));
727 }
728
David Tolnay885be132020-12-21 15:52:47 -0800729 let name = pair(namespace, &ident, cxx_name, rust_name);
David Tolnayddbcb522020-12-21 15:24:45 -0800730
David Tolnayb7eb65e2020-11-27 20:00:53 -0800731 Ok(Api::TypeAlias(TypeAlias {
732 doc,
733 derives,
David Tolnay067638e2020-12-30 16:18:05 -0800734 attrs,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800735 type_token,
David Tolnayddbcb522020-12-21 15:24:45 -0800736 name,
David Tolnayee312322020-12-28 22:04:10 -0800737 generics,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800738 eq_token,
739 ty,
740 semi_token,
741 }))
742}
743
744fn parse_extern_type_bounded(
745 cx: &mut Errors,
746 attrs: Vec<Attribute>,
747 type_token: Token![type],
748 ident: Ident,
David Tolnayee312322020-12-28 22:04:10 -0800749 generics: Lifetimes,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800750 input: ParseStream,
751 lang: Lang,
752 trusted: bool,
753 namespace: &Namespace,
754) -> Result<Api> {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800755 let mut bounds = Vec::new();
David Tolnaya870ac72020-12-28 19:48:33 -0800756 let colon_token: Option<Token![:]> = input.parse()?;
757 if colon_token.is_some() {
758 loop {
759 match input.parse()? {
760 TypeParamBound::Trait(TraitBound {
761 paren_token: None,
762 modifier: TraitBoundModifier::None,
763 lifetimes: None,
764 path,
765 }) if if let Some(derive) = path.get_ident().and_then(Derive::from) {
766 bounds.push(derive);
767 true
768 } else {
769 false
770 } => {}
771 bound @ TypeParamBound::Trait(_) | bound @ TypeParamBound::Lifetime(_) => {
772 cx.error(bound, "unsupported trait");
773 }
David Tolnayb7eb65e2020-11-27 20:00:53 -0800774 }
David Tolnayb7eb65e2020-11-27 20:00:53 -0800775
David Tolnaya870ac72020-12-28 19:48:33 -0800776 let lookahead = input.lookahead1();
777 if lookahead.peek(Token![+]) {
778 input.parse::<Token![+]>()?;
779 } else if lookahead.peek(Token![;]) {
780 break;
781 } else {
782 return Err(lookahead.error());
783 }
David Tolnayb7eb65e2020-11-27 20:00:53 -0800784 }
785 }
786 let semi_token: Token![;] = input.parse()?;
787
788 let mut doc = Doc::new();
789 let mut derives = Vec::new();
790 let mut namespace = namespace.clone();
David Tolnay885be132020-12-21 15:52:47 -0800791 let mut cxx_name = None;
792 let mut rust_name = None;
David Tolnay067638e2020-12-30 16:18:05 -0800793 let attrs = attrs::parse(
David Tolnayb7eb65e2020-11-27 20:00:53 -0800794 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -0800795 attrs,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800796 attrs::Parser {
797 doc: Some(&mut doc),
798 derives: Some(&mut derives),
799 namespace: Some(&mut namespace),
David Tolnay885be132020-12-21 15:52:47 -0800800 cxx_name: Some(&mut cxx_name),
801 rust_name: Some(&mut rust_name),
David Tolnayb7eb65e2020-11-27 20:00:53 -0800802 ..Default::default()
803 },
804 );
805
David Tolnay885be132020-12-21 15:52:47 -0800806 let name = pair(namespace, &ident, cxx_name, rust_name);
David Tolnayddbcb522020-12-21 15:24:45 -0800807
808 Ok(match lang {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800809 Lang::Cxx => Api::CxxType,
810 Lang::Rust => Api::RustType,
David Tolnayddbcb522020-12-21 15:24:45 -0800811 }(ExternType {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800812 lang,
813 doc,
814 derives,
David Tolnay067638e2020-12-30 16:18:05 -0800815 attrs,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800816 type_token,
David Tolnayddbcb522020-12-21 15:24:45 -0800817 name,
David Tolnayee312322020-12-28 22:04:10 -0800818 generics,
David Tolnayddbcb522020-12-21 15:24:45 -0800819 colon_token,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800820 bounds,
821 semi_token,
822 trusted,
823 }))
David Tolnaye2f9ec42020-05-07 16:19:33 -0700824}
825
David Tolnay313cc0a2020-11-24 21:47:01 -0800826fn parse_impl(imp: ItemImpl) -> Result<Api> {
David Tolnay7e69f892020-10-03 22:20:22 -0700827 if !imp.items.is_empty() {
828 let mut span = Group::new(Delimiter::Brace, TokenStream::new());
829 span.set_span(imp.brace_token.span);
830 return Err(Error::new_spanned(span, "expected an empty impl block"));
831 }
832
David Tolnay7e69f892020-10-03 22:20:22 -0700833 if let Some((bang, path, for_token)) = &imp.trait_ {
David Tolnay028d3d22020-11-29 18:09:52 -0800834 let self_ty = &imp.self_ty;
David Tolnay7e69f892020-10-03 22:20:22 -0700835 let span = quote!(#bang #path #for_token #self_ty);
836 return Err(Error::new_spanned(
837 span,
838 "unexpected impl, expected something like `impl UniquePtr<T> {}`",
839 ));
840 }
841
842 let generics = &imp.generics;
843 if !generics.params.is_empty() || generics.where_clause.is_some() {
844 return Err(Error::new_spanned(
845 imp,
846 "generic parameters on an impl is not supported",
847 ));
848 }
849
David Tolnay028d3d22020-11-29 18:09:52 -0800850 let mut negative_token = None;
851 let mut self_ty = *imp.self_ty;
852 if let RustType::Verbatim(ty) = &self_ty {
853 let mut iter = ty.clone().into_iter();
854 if let Some(TokenTree::Punct(punct)) = iter.next() {
855 if punct.as_char() == '!' {
856 let ty = iter.collect::<TokenStream>();
857 if !ty.is_empty() {
858 negative_token = Some(Token![!](punct.span()));
859 self_ty = syn::parse2(ty)?;
860 }
861 }
862 }
863 }
864
David Tolnayddbcb522020-12-21 15:24:45 -0800865 let impl_token = imp.impl_token;
866 let negative = negative_token.is_some();
867 let ty = parse_type(&self_ty)?;
868 let brace_token = imp.brace_token;
869
David Tolnay7e69f892020-10-03 22:20:22 -0700870 Ok(Api::Impl(Impl {
David Tolnayddbcb522020-12-21 15:24:45 -0800871 impl_token,
872 negative,
873 ty,
874 brace_token,
David Tolnay028d3d22020-11-29 18:09:52 -0800875 negative_token,
David Tolnay7e69f892020-10-03 22:20:22 -0700876 }))
877}
878
David Tolnayb0cd3272020-10-27 21:32:54 -0700879fn parse_include(input: ParseStream) -> Result<Include> {
David Tolnay91e87fa2020-05-11 19:10:23 -0700880 if input.peek(LitStr) {
David Tolnayb0cd3272020-10-27 21:32:54 -0700881 let lit: LitStr = input.parse()?;
882 let span = lit.span();
883 return Ok(Include {
884 path: lit.value(),
885 kind: IncludeKind::Quoted,
886 begin_span: span,
887 end_span: span,
888 });
David Tolnay91e87fa2020-05-11 19:10:23 -0700889 }
890
891 if input.peek(Token![<]) {
892 let mut path = String::new();
David Tolnayb0cd3272020-10-27 21:32:54 -0700893
David Tolnay2cc2e3a2020-10-28 13:12:35 -0700894 let langle: Token![<] = input.parse()?;
David Tolnay91e87fa2020-05-11 19:10:23 -0700895 while !input.is_empty() && !input.peek(Token![>]) {
896 let token: TokenTree = input.parse()?;
897 match token {
898 TokenTree::Ident(token) => path += &token.to_string(),
899 TokenTree::Literal(token)
900 if token
901 .to_string()
902 .starts_with(|ch: char| ch.is_ascii_digit()) =>
903 {
904 path += &token.to_string();
905 }
906 TokenTree::Punct(token) => path.push(token.as_char()),
907 _ => return Err(Error::new(token.span(), "unexpected token in include path")),
908 }
909 }
David Tolnayb0cd3272020-10-27 21:32:54 -0700910 let rangle: Token![>] = input.parse()?;
David Tolnayb0cd3272020-10-27 21:32:54 -0700911
912 return Ok(Include {
913 path,
914 kind: IncludeKind::Bracketed,
David Tolnay2cc2e3a2020-10-28 13:12:35 -0700915 begin_span: langle.span,
916 end_span: rangle.span,
David Tolnayb0cd3272020-10-27 21:32:54 -0700917 });
David Tolnay91e87fa2020-05-11 19:10:23 -0700918 }
919
920 Err(input.error("expected \"quoted/path/to\" or <bracketed/path/to>"))
921}
922
David Tolnay313cc0a2020-11-24 21:47:01 -0800923fn parse_type(ty: &RustType) -> Result<Type> {
David Tolnay59b7ede2020-03-16 00:30:23 -0700924 match ty {
David Tolnay313cc0a2020-11-24 21:47:01 -0800925 RustType::Reference(ty) => parse_type_reference(ty),
926 RustType::Path(ty) => parse_type_path(ty),
David Tolnay313cc0a2020-11-24 21:47:01 -0800927 RustType::Array(ty) => parse_type_array(ty),
928 RustType::BareFn(ty) => parse_type_fn(ty),
David Tolnayb40b9db2020-03-18 13:50:31 -0700929 RustType::Tuple(ty) if ty.elems.is_empty() => Ok(Type::Void(ty.paren_token.span)),
930 _ => Err(Error::new_spanned(ty, "unsupported type")),
931 }
932}
933
David Tolnay313cc0a2020-11-24 21:47:01 -0800934fn parse_type_reference(ty: &TypeReference) -> Result<Type> {
David Tolnayddbcb522020-12-21 15:24:45 -0800935 let ampersand = ty.and_token;
936 let lifetime = ty.lifetime.clone();
937 let mutable = ty.mutability.is_some();
938 let mutability = ty.mutability;
939
David Tolnaye0dca7b2020-11-25 17:18:57 -0800940 if let RustType::Slice(slice) = ty.elem.as_ref() {
941 let inner = parse_type(&slice.elem)?;
David Tolnayddbcb522020-12-21 15:24:45 -0800942 let bracket = slice.bracket_token;
David Tolnay69db8142020-11-25 17:49:25 -0800943 return Ok(Type::SliceRef(Box::new(SliceRef {
David Tolnayddbcb522020-12-21 15:24:45 -0800944 ampersand,
945 lifetime,
946 mutable,
947 bracket,
David Tolnay69db8142020-11-25 17:49:25 -0800948 inner,
David Tolnayddbcb522020-12-21 15:24:45 -0800949 mutability,
David Tolnay69db8142020-11-25 17:49:25 -0800950 })));
David Tolnaye0dca7b2020-11-25 17:18:57 -0800951 }
952
David Tolnay313cc0a2020-11-24 21:47:01 -0800953 let inner = parse_type(&ty.elem)?;
David Tolnayddbcb522020-12-21 15:24:45 -0800954 let pinned = false;
955 let pin_tokens = None;
956
957 Ok(match &inner {
Adrian Taylorc8713432020-10-21 18:20:55 -0700958 Type::Ident(ident) if ident.rust == "str" => {
David Tolnayb40b9db2020-03-18 13:50:31 -0700959 if ty.mutability.is_some() {
960 return Err(Error::new_spanned(ty, "unsupported type"));
961 } else {
962 Type::Str
David Tolnay7db73692019-10-20 14:51:12 -0400963 }
964 }
David Tolnayb40b9db2020-03-18 13:50:31 -0700965 _ => Type::Ref,
David Tolnayddbcb522020-12-21 15:24:45 -0800966 }(Box::new(Ref {
967 pinned,
968 ampersand,
969 lifetime,
970 mutable,
David Tolnayb40b9db2020-03-18 13:50:31 -0700971 inner,
David Tolnayddbcb522020-12-21 15:24:45 -0800972 pin_tokens,
973 mutability,
David Tolnayb40b9db2020-03-18 13:50:31 -0700974 })))
975}
976
David Tolnay313cc0a2020-11-24 21:47:01 -0800977fn parse_type_path(ty: &TypePath) -> Result<Type> {
David Tolnayb40b9db2020-03-18 13:50:31 -0700978 let path = &ty.path;
979 if ty.qself.is_none() && path.leading_colon.is_none() && path.segments.len() == 1 {
980 let segment = &path.segments[0];
981 let ident = segment.ident.clone();
982 match &segment.arguments {
David Tolnay75ea17c2020-12-06 21:08:34 -0800983 PathArguments::None => return Ok(Type::Ident(RustName::new(ident))),
David Tolnayb40b9db2020-03-18 13:50:31 -0700984 PathArguments::AngleBracketed(generic) => {
985 if ident == "UniquePtr" && generic.args.len() == 1 {
986 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnay313cc0a2020-11-24 21:47:01 -0800987 let inner = parse_type(arg)?;
David Tolnayb40b9db2020-03-18 13:50:31 -0700988 return Ok(Type::UniquePtr(Box::new(Ty1 {
David Tolnayda71ef62020-11-02 00:36:00 -0800989 name: ident,
David Tolnayb40b9db2020-03-18 13:50:31 -0700990 langle: generic.lt_token,
991 inner,
992 rangle: generic.gt_token,
993 })));
994 }
David Tolnayb3b24a12020-12-01 15:27:43 -0800995 } else if ident == "SharedPtr" && generic.args.len() == 1 {
996 if let GenericArgument::Type(arg) = &generic.args[0] {
997 let inner = parse_type(arg)?;
998 return Ok(Type::SharedPtr(Box::new(Ty1 {
999 name: ident,
1000 langle: generic.lt_token,
1001 inner,
1002 rangle: generic.gt_token,
1003 })));
1004 }
David Tolnay215e77f2020-12-28 17:09:48 -08001005 } else if ident == "WeakPtr" && generic.args.len() == 1 {
1006 if let GenericArgument::Type(arg) = &generic.args[0] {
1007 let inner = parse_type(arg)?;
1008 return Ok(Type::WeakPtr(Box::new(Ty1 {
1009 name: ident,
1010 langle: generic.lt_token,
1011 inner,
1012 rangle: generic.gt_token,
1013 })));
1014 }
David Tolnaye1dcdf72020-04-24 17:40:55 -07001015 } else if ident == "CxxVector" && generic.args.len() == 1 {
Myron Ahneba35cf2020-02-05 19:41:51 +07001016 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnay313cc0a2020-11-24 21:47:01 -08001017 let inner = parse_type(arg)?;
David Tolnay4377a9e2020-04-24 15:20:26 -07001018 return Ok(Type::CxxVector(Box::new(Ty1 {
David Tolnayda71ef62020-11-02 00:36:00 -08001019 name: ident,
Myron Ahneba35cf2020-02-05 19:41:51 +07001020 langle: generic.lt_token,
1021 inner,
1022 rangle: generic.gt_token,
1023 })));
1024 }
David Tolnayb40b9db2020-03-18 13:50:31 -07001025 } else if ident == "Box" && generic.args.len() == 1 {
1026 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnay313cc0a2020-11-24 21:47:01 -08001027 let inner = parse_type(arg)?;
David Tolnayb40b9db2020-03-18 13:50:31 -07001028 return Ok(Type::RustBox(Box::new(Ty1 {
David Tolnayda71ef62020-11-02 00:36:00 -08001029 name: ident,
David Tolnayb40b9db2020-03-18 13:50:31 -07001030 langle: generic.lt_token,
1031 inner,
1032 rangle: generic.gt_token,
1033 })));
1034 }
Myron Ahneba35cf2020-02-05 19:41:51 +07001035 } else if ident == "Vec" && generic.args.len() == 1 {
1036 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnay313cc0a2020-11-24 21:47:01 -08001037 let inner = parse_type(arg)?;
Myron Ahneba35cf2020-02-05 19:41:51 +07001038 return Ok(Type::RustVec(Box::new(Ty1 {
David Tolnayda71ef62020-11-02 00:36:00 -08001039 name: ident,
Myron Ahneba35cf2020-02-05 19:41:51 +07001040 langle: generic.lt_token,
1041 inner,
1042 rangle: generic.gt_token,
1043 })));
1044 }
David Tolnaycbc2a4b2020-11-15 15:08:44 -08001045 } else if ident == "Pin" && generic.args.len() == 1 {
1046 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnay313cc0a2020-11-24 21:47:01 -08001047 let inner = parse_type(arg)?;
David Tolnayc94035a2020-11-15 16:49:18 -08001048 let pin_token = kw::Pin(ident.span());
David Tolnaycbc2a4b2020-11-15 15:08:44 -08001049 if let Type::Ref(mut inner) = inner {
David Tolnaycbc2a4b2020-11-15 15:08:44 -08001050 inner.pinned = true;
1051 inner.pin_tokens =
1052 Some((pin_token, generic.lt_token, generic.gt_token));
1053 return Ok(Type::Ref(inner));
1054 }
1055 }
David Tolnayb40b9db2020-03-18 13:50:31 -07001056 }
1057 }
1058 PathArguments::Parenthesized(_) => {}
David Tolnayfb134ed2020-03-15 23:17:48 -07001059 }
David Tolnay7db73692019-10-20 14:51:12 -04001060 }
David Tolnayddbcb522020-12-21 15:24:45 -08001061
David Tolnay7db73692019-10-20 14:51:12 -04001062 Err(Error::new_spanned(ty, "unsupported type"))
1063}
1064
David Tolnay313cc0a2020-11-24 21:47:01 -08001065fn parse_type_array(ty: &TypeArray) -> Result<Type> {
1066 let inner = parse_type(&ty.elem)?;
David Tolnayd9f97842020-11-24 21:00:05 -08001067
1068 let len_expr = if let Expr::Lit(lit) = &ty.len {
1069 lit
1070 } else {
1071 let msg = "unsupported expression, array length must be an integer literal";
1072 return Err(Error::new_spanned(&ty.len, msg));
1073 };
1074
1075 let len_token = if let Lit::Int(int) = &len_expr.lit {
1076 int.clone()
1077 } else {
1078 let msg = "array length must be an integer literal";
1079 return Err(Error::new_spanned(len_expr, msg));
1080 };
1081
David Tolnay581f72d2020-11-25 15:48:59 -08001082 let len = len_token.base10_parse::<usize>()?;
1083 if len == 0 {
1084 let msg = "array with zero size is not supported";
1085 return Err(Error::new_spanned(ty, msg));
1086 }
1087
David Tolnayd9f97842020-11-24 21:00:05 -08001088 let bracket = ty.bracket_token;
1089 let semi_token = ty.semi_token;
David Tolnayd9f97842020-11-24 21:00:05 -08001090
1091 Ok(Type::Array(Box::new(Array {
1092 bracket,
1093 inner,
1094 semi_token,
1095 len,
1096 len_token,
1097 })))
David Tolnay2d0df232020-11-24 20:50:32 -08001098}
1099
David Tolnay313cc0a2020-11-24 21:47:01 -08001100fn parse_type_fn(ty: &TypeBareFn) -> Result<Type> {
David Tolnayc071b892020-03-18 16:59:53 -07001101 if ty.lifetimes.is_some() {
1102 return Err(Error::new_spanned(
1103 ty,
1104 "function pointer with lifetime parameters is not supported yet",
1105 ));
1106 }
David Tolnayddbcb522020-12-21 15:24:45 -08001107
David Tolnayc071b892020-03-18 16:59:53 -07001108 if ty.variadic.is_some() {
1109 return Err(Error::new_spanned(
1110 ty,
1111 "variadic function pointer is not supported yet",
1112 ));
1113 }
David Tolnayddbcb522020-12-21 15:24:45 -08001114
David Tolnayc071b892020-03-18 16:59:53 -07001115 let args = ty
1116 .inputs
1117 .iter()
1118 .enumerate()
1119 .map(|(i, arg)| {
David Tolnay313cc0a2020-11-24 21:47:01 -08001120 let ty = parse_type(&arg.ty)?;
David Tolnayc071b892020-03-18 16:59:53 -07001121 let ident = match &arg.name {
1122 Some(ident) => ident.0.clone(),
David Tolnayb4c14552020-12-29 15:44:19 -08001123 None => format_ident!("arg{}", i),
David Tolnayc071b892020-03-18 16:59:53 -07001124 };
David Tolnayb4a05c32020-12-30 15:37:01 -08001125 let doc = Doc::new();
David Tolnaycba3d442020-12-30 16:39:21 -08001126 let attrs = OtherAttrs::none();
David Tolnay89902442020-12-30 15:10:40 -08001127 let visibility = Token![pub](ident.span());
1128 Ok(Var {
David Tolnayb4a05c32020-12-30 15:37:01 -08001129 doc,
David Tolnay067638e2020-12-30 16:18:05 -08001130 attrs,
David Tolnay89902442020-12-30 15:10:40 -08001131 visibility,
1132 ident,
1133 ty,
1134 })
David Tolnayc071b892020-03-18 16:59:53 -07001135 })
1136 .collect::<Result<_>>()?;
David Tolnayddbcb522020-12-21 15:24:45 -08001137
David Tolnaye3a48152020-04-08 19:38:05 -07001138 let mut throws_tokens = None;
David Tolnay313cc0a2020-11-24 21:47:01 -08001139 let ret = parse_return_type(&ty.output, &mut throws_tokens)?;
David Tolnaye3a48152020-04-08 19:38:05 -07001140 let throws = throws_tokens.is_some();
David Tolnayddbcb522020-12-21 15:24:45 -08001141
1142 let unsafety = ty.unsafety;
1143 let fn_token = ty.fn_token;
1144 let generics = Generics::default();
1145 let receiver = None;
1146 let paren_token = ty.paren_token;
1147
David Tolnayc071b892020-03-18 16:59:53 -07001148 Ok(Type::Fn(Box::new(Signature {
David Tolnayddbcb522020-12-21 15:24:45 -08001149 unsafety,
1150 fn_token,
1151 generics,
1152 receiver,
David Tolnayc071b892020-03-18 16:59:53 -07001153 args,
1154 ret,
1155 throws,
David Tolnayddbcb522020-12-21 15:24:45 -08001156 paren_token,
David Tolnaye3a48152020-04-08 19:38:05 -07001157 throws_tokens,
David Tolnayc071b892020-03-18 16:59:53 -07001158 })))
1159}
1160
David Tolnaye3a48152020-04-08 19:38:05 -07001161fn parse_return_type(
1162 ty: &ReturnType,
1163 throws_tokens: &mut Option<(kw::Result, Token![<], Token![>])>,
1164) -> Result<Option<Type>> {
David Tolnayc071b892020-03-18 16:59:53 -07001165 let mut ret = match ty {
1166 ReturnType::Default => return Ok(None),
1167 ReturnType::Type(_, ret) => ret.as_ref(),
1168 };
David Tolnayddbcb522020-12-21 15:24:45 -08001169
David Tolnayc071b892020-03-18 16:59:53 -07001170 if let RustType::Path(ty) = ret {
1171 let path = &ty.path;
1172 if ty.qself.is_none() && path.leading_colon.is_none() && path.segments.len() == 1 {
1173 let segment = &path.segments[0];
1174 let ident = segment.ident.clone();
1175 if let PathArguments::AngleBracketed(generic) = &segment.arguments {
1176 if ident == "Result" && generic.args.len() == 1 {
1177 if let GenericArgument::Type(arg) = &generic.args[0] {
1178 ret = arg;
David Tolnaye3a48152020-04-08 19:38:05 -07001179 *throws_tokens =
1180 Some((kw::Result(ident.span()), generic.lt_token, generic.gt_token));
David Tolnayc071b892020-03-18 16:59:53 -07001181 }
1182 }
1183 }
1184 }
1185 }
David Tolnayddbcb522020-12-21 15:24:45 -08001186
David Tolnay313cc0a2020-11-24 21:47:01 -08001187 match parse_type(ret)? {
David Tolnayc071b892020-03-18 16:59:53 -07001188 Type::Void(_) => Ok(None),
1189 ty => Ok(Some(ty)),
1190 }
1191}
David Tolnay6a990f82020-12-21 15:42:31 -08001192
1193fn pair(namespace: Namespace, default: &Ident, cxx: Option<Ident>, rust: Option<Ident>) -> Pair {
1194 let default = || default.clone();
David Tolnayc2a4c782020-12-21 15:55:31 -08001195 Pair {
David Tolnay6a990f82020-12-21 15:42:31 -08001196 namespace,
David Tolnayc2a4c782020-12-21 15:55:31 -08001197 cxx: cxx.unwrap_or_else(default),
1198 rust: rust.unwrap_or_else(default),
1199 }
David Tolnay6a990f82020-12-21 15:42:31 -08001200}