blob: 93dfba064f100b1efdaafe925a68857aa25d7cce [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 Tolnaya00f4682020-12-30 18:11:16 -0800118 let visibility = visibility_pub(&field.vis, &ident);
David Tolnay89902442020-12-30 15:10:40 -0800119 fields.push(Var {
David Tolnayb4a05c32020-12-30 15:37:01 -0800120 doc,
David Tolnay067638e2020-12-30 16:18:05 -0800121 attrs,
David Tolnay89902442020-12-30 15:10:40 -0800122 visibility,
123 ident,
124 ty,
125 });
David Tolnay38c11212020-11-25 15:50:19 -0800126 }
David Tolnay302b1752020-11-10 18:43:24 -0800127
David Tolnaya00f4682020-12-30 18:11:16 -0800128 let visibility = visibility_pub(&item.vis, &item.ident);
David Tolnayddbcb522020-12-21 15:24:45 -0800129 let struct_token = item.struct_token;
David Tolnay885be132020-12-21 15:52:47 -0800130 let name = pair(namespace, &item.ident, cxx_name, rust_name);
David Tolnayddbcb522020-12-21 15:24:45 -0800131 let brace_token = named_fields.brace_token;
132
David Tolnay09462ac2020-03-20 14:58:41 -0700133 Ok(Api::Struct(Struct {
134 doc,
135 derives,
David Tolnay067638e2020-12-30 16:18:05 -0800136 attrs,
David Tolnay64343af2020-12-30 15:26:06 -0800137 visibility,
David Tolnayddbcb522020-12-21 15:24:45 -0800138 struct_token,
139 name,
140 brace_token,
David Tolnay302b1752020-11-10 18:43:24 -0800141 fields,
David Tolnay09462ac2020-03-20 14:58:41 -0700142 }))
David Tolnay7db73692019-10-20 14:51:12 -0400143}
144
David Tolnay302b1752020-11-10 18:43:24 -0800145fn parse_enum(cx: &mut Errors, item: ItemEnum, namespace: &Namespace) -> Result<Api> {
David Tolnayddf69e22020-05-10 22:08:20 -0700146 let mut doc = Doc::new();
David Tolnayfbc46692020-11-27 11:33:29 -0800147 let mut derives = Vec::new();
David Tolnayddf69e22020-05-10 22:08:20 -0700148 let mut repr = None;
David Tolnay302b1752020-11-10 18:43:24 -0800149 let mut namespace = namespace.clone();
David Tolnay885be132020-12-21 15:52:47 -0800150 let mut cxx_name = None;
151 let mut rust_name = None;
David Tolnay067638e2020-12-30 16:18:05 -0800152 let attrs = attrs::parse(
David Tolnayddf69e22020-05-10 22:08:20 -0700153 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -0800154 item.attrs,
David Tolnayddf69e22020-05-10 22:08:20 -0700155 attrs::Parser {
156 doc: Some(&mut doc),
David Tolnayfbc46692020-11-27 11:33:29 -0800157 derives: Some(&mut derives),
David Tolnayddf69e22020-05-10 22:08:20 -0700158 repr: Some(&mut repr),
David Tolnayd7a3a182020-11-01 20:45:14 -0800159 namespace: Some(&mut namespace),
David Tolnay885be132020-12-21 15:52:47 -0800160 cxx_name: Some(&mut cxx_name),
161 rust_name: Some(&mut rust_name),
David Tolnayddf69e22020-05-10 22:08:20 -0700162 ..Default::default()
163 },
164 );
Joel Galensonc03402a2020-04-23 17:31:09 -0700165
David Tolnaybc954d92020-12-21 15:17:10 -0800166 let generics = &item.generics;
167 if !generics.params.is_empty() || generics.where_clause.is_some() {
168 let enum_token = item.enum_token;
169 let ident = &item.ident;
170 let where_clause = &generics.where_clause;
171 let span = quote!(#enum_token #ident #generics #where_clause);
172 return Err(Error::new_spanned(
173 span,
174 "enums with generic parameters are not allowed",
175 ));
176 }
177
Joel Galenson88547732020-05-05 08:23:42 -0700178 let mut variants = Vec::new();
David Tolnayddf69e22020-05-10 22:08:20 -0700179 let mut discriminants = DiscriminantSet::new(repr);
Joel Galenson88547732020-05-05 08:23:42 -0700180 for variant in item.variants {
David Tolnay6bf9ef42020-12-21 16:11:40 -0800181 match parse_variant(cx, variant, &mut discriminants) {
David Tolnay26809232020-12-21 16:06:47 -0800182 Ok(variant) => variants.push(variant),
183 Err(err) => cx.push(err),
Joel Galensonc03402a2020-04-23 17:31:09 -0700184 }
185 }
186
David Tolnaya00f4682020-12-30 18:11:16 -0800187 let visibility = visibility_pub(&item.vis, &item.ident);
David Tolnaye2e303f2020-05-10 20:52:00 -0700188 let enum_token = item.enum_token;
189 let brace_token = item.brace_token;
190
David Tolnay58eee392020-11-20 20:37:58 -0800191 let explicit_repr = repr.is_some();
David Tolnay0435a812020-05-10 21:58:15 -0700192 let mut repr = U8;
193 match discriminants.inferred_repr() {
194 Ok(inferred) => repr = inferred,
David Tolnaye2e303f2020-05-10 20:52:00 -0700195 Err(err) => {
196 let span = quote_spanned!(brace_token.span=> #enum_token {});
David Tolnay0435a812020-05-10 21:58:15 -0700197 cx.error(span, err);
198 variants.clear();
David Tolnaye2e303f2020-05-10 20:52:00 -0700199 }
David Tolnay0435a812020-05-10 21:58:15 -0700200 }
David Tolnaye2e303f2020-05-10 20:52:00 -0700201
David Tolnay885be132020-12-21 15:52:47 -0800202 let name = pair(namespace, &item.ident, cxx_name, rust_name);
David Tolnayddbcb522020-12-21 15:24:45 -0800203 let repr_ident = Ident::new(repr.as_ref(), Span::call_site());
204 let repr_type = Type::Ident(RustName::new(repr_ident));
David Tolnay9a69d8a2020-11-16 09:16:41 -0800205
Joel Galensonc03402a2020-04-23 17:31:09 -0700206 Ok(Api::Enum(Enum {
207 doc,
David Tolnayfbc46692020-11-27 11:33:29 -0800208 derives,
David Tolnay067638e2020-12-30 16:18:05 -0800209 attrs,
David Tolnay8fbaea82020-12-30 17:15:46 -0800210 visibility,
David Tolnaye2e303f2020-05-10 20:52:00 -0700211 enum_token,
David Tolnayddbcb522020-12-21 15:24:45 -0800212 name,
David Tolnaye2e303f2020-05-10 20:52:00 -0700213 brace_token,
David Tolnay7ae018f2020-05-05 10:11:30 -0700214 variants,
David Tolnaye2e303f2020-05-10 20:52:00 -0700215 repr,
David Tolnay9a69d8a2020-11-16 09:16:41 -0800216 repr_type,
David Tolnay58eee392020-11-20 20:37:58 -0800217 explicit_repr,
Joel Galensonc03402a2020-04-23 17:31:09 -0700218 }))
219}
220
David Tolnay6bf9ef42020-12-21 16:11:40 -0800221fn parse_variant(
222 cx: &mut Errors,
David Tolnay15a1fc12020-12-30 16:04:56 -0800223 mut variant: RustVariant,
David Tolnay6bf9ef42020-12-21 16:11:40 -0800224 discriminants: &mut DiscriminantSet,
225) -> Result<Variant> {
David Tolnay4486f722020-12-30 00:01:26 -0800226 let mut doc = Doc::new();
David Tolnay6bf9ef42020-12-21 16:11:40 -0800227 let mut cxx_name = None;
228 let mut rust_name = None;
David Tolnay067638e2020-12-30 16:18:05 -0800229 let attrs = attrs::parse(
David Tolnay6bf9ef42020-12-21 16:11:40 -0800230 cx,
David Tolnay067638e2020-12-30 16:18:05 -0800231 mem::take(&mut variant.attrs),
David Tolnay6bf9ef42020-12-21 16:11:40 -0800232 attrs::Parser {
David Tolnay4486f722020-12-30 00:01:26 -0800233 doc: Some(&mut doc),
David Tolnay6bf9ef42020-12-21 16:11:40 -0800234 cxx_name: Some(&mut cxx_name),
235 rust_name: Some(&mut rust_name),
236 ..Default::default()
237 },
238 );
239
David Tolnay26809232020-12-21 16:06:47 -0800240 match variant.fields {
241 Fields::Unit => {}
242 _ => {
243 let msg = "enums with data are not supported yet";
244 return Err(Error::new_spanned(variant, msg));
245 }
246 }
247
248 let expr = variant.discriminant.as_ref().map(|(_, expr)| expr);
249 let try_discriminant = match &expr {
250 Some(lit) => discriminants.insert(lit),
251 None => discriminants.insert_next(),
252 };
253 let discriminant = match try_discriminant {
254 Ok(discriminant) => discriminant,
255 Err(err) => return Err(Error::new_spanned(variant, err)),
256 };
David Tolnaye6f62142020-12-21 16:00:41 -0800257
David Tolnay6bf9ef42020-12-21 16:11:40 -0800258 let name = pair(Namespace::ROOT, &variant.ident, cxx_name, rust_name);
David Tolnay26809232020-12-21 16:06:47 -0800259 let expr = variant.discriminant.map(|(_, expr)| expr);
260
261 Ok(Variant {
David Tolnay4486f722020-12-30 00:01:26 -0800262 doc,
David Tolnay067638e2020-12-30 16:18:05 -0800263 attrs,
David Tolnaye6f62142020-12-21 16:00:41 -0800264 name,
David Tolnay26809232020-12-21 16:06:47 -0800265 discriminant,
266 expr,
267 })
268}
269
David Tolnay805dca32020-08-29 19:09:55 -0700270fn parse_foreign_mod(
271 cx: &mut Errors,
272 foreign_mod: ItemForeignMod,
273 out: &mut Vec<Api>,
274 trusted: bool,
David Tolnayd7a3a182020-11-01 20:45:14 -0800275 namespace: &Namespace,
David Tolnay805dca32020-08-29 19:09:55 -0700276) {
David Tolnay3a451732020-08-29 18:54:55 -0700277 let lang = match parse_lang(&foreign_mod.abi) {
David Tolnay52759782020-05-03 23:59:40 -0700278 Ok(lang) => lang,
279 Err(err) => return cx.push(err),
280 };
David Tolnay7db73692019-10-20 14:51:12 -0400281
David Tolnay3a451732020-08-29 18:54:55 -0700282 match lang {
283 Lang::Rust => {
David Tolnay805dca32020-08-29 19:09:55 -0700284 if foreign_mod.unsafety.is_some() {
David Tolnay3a451732020-08-29 18:54:55 -0700285 let unsafety = foreign_mod.unsafety;
David Tolnay7be5b1f2020-11-11 10:48:32 -0800286 let abi = &foreign_mod.abi;
David Tolnay3a451732020-08-29 18:54:55 -0700287 let span = quote!(#unsafety #abi);
288 cx.error(span, "extern \"Rust\" block does not need to be unsafe");
289 }
290 }
291 Lang::Cxx => {}
292 }
293
David Tolnay805dca32020-08-29 19:09:55 -0700294 let trusted = trusted || foreign_mod.unsafety.is_some();
295
David Tolnay7feb2642020-11-10 18:49:04 -0800296 let mut namespace = namespace.clone();
297 attrs::parse(
298 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -0800299 foreign_mod.attrs,
David Tolnay7feb2642020-11-10 18:49:04 -0800300 attrs::Parser {
301 namespace: Some(&mut namespace),
302 ..Default::default()
303 },
304 );
305
Joel Galensone1e969d2020-04-21 12:50:20 -0700306 let mut items = Vec::new();
David Tolnay15a1fc12020-12-30 16:04:56 -0800307 for foreign in foreign_mod.items {
Joel Galensone1e969d2020-04-21 12:50:20 -0700308 match foreign {
Adrian Taylorc8713432020-10-21 18:20:55 -0700309 ForeignItem::Type(foreign) => {
David Tolnayf5ead102020-11-24 17:08:05 -0800310 let ety = parse_extern_type(cx, foreign, lang, trusted, &namespace);
311 items.push(ety);
Adrian Taylorc8713432020-10-21 18:20:55 -0700312 }
David Tolnay556738d2020-11-15 13:58:44 -0800313 ForeignItem::Fn(foreign) => {
314 match parse_extern_fn(cx, foreign, lang, trusted, &namespace) {
315 Ok(efn) => items.push(efn),
316 Err(err) => cx.push(err),
317 }
318 }
David Tolnay7db73692019-10-20 14:51:12 -0400319 ForeignItem::Macro(foreign) if foreign.mac.path.is_ident("include") => {
David Tolnay91e87fa2020-05-11 19:10:23 -0700320 match foreign.mac.parse_body_with(parse_include) {
David Tolnay52759782020-05-03 23:59:40 -0700321 Ok(include) => items.push(Api::Include(include)),
322 Err(err) => cx.push(err),
323 }
David Tolnay7db73692019-10-20 14:51:12 -0400324 }
Adrian Taylorc8713432020-10-21 18:20:55 -0700325 ForeignItem::Verbatim(tokens) => {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800326 match parse_extern_verbatim(cx, tokens, lang, trusted, &namespace) {
Adrian Taylorc8713432020-10-21 18:20:55 -0700327 Ok(api) => items.push(api),
328 Err(err) => cx.push(err),
329 }
330 }
David Tolnay52759782020-05-03 23:59:40 -0700331 _ => cx.error(foreign, "unsupported foreign item"),
David Tolnay7db73692019-10-20 14:51:12 -0400332 }
333 }
David Tolnaya1f29c42020-04-22 18:01:38 -0700334
David Tolnay7be5b1f2020-11-11 10:48:32 -0800335 if !trusted
336 && items.iter().any(|api| match api {
337 Api::CxxFunction(efn) => efn.unsafety.is_none(),
338 _ => false,
339 })
340 {
341 cx.error(
342 foreign_mod.abi,
343 "block must be declared `unsafe extern \"C++\"` if it contains any safe-to-call C++ functions",
344 );
345 }
346
David Tolnaya1f29c42020-04-22 18:01:38 -0700347 let mut types = items.iter().filter_map(|item| match item {
David Tolnay17a934c2020-11-02 00:40:04 -0800348 Api::CxxType(ety) | Api::RustType(ety) => Some(&ety.name),
349 Api::TypeAlias(alias) => Some(&alias.name),
David Tolnaya1f29c42020-04-22 18:01:38 -0700350 _ => None,
351 });
352 if let (Some(single_type), None) = (types.next(), types.next()) {
David Tolnaye5a015a2020-05-07 21:54:26 -0700353 let single_type = single_type.clone();
David Tolnaya1f29c42020-04-22 18:01:38 -0700354 for item in &mut items {
355 if let Api::CxxFunction(efn) | Api::RustFunction(efn) = item {
356 if let Some(receiver) = &mut efn.receiver {
David Tolnay2d99b002020-12-21 14:34:35 -0800357 if receiver.ty.rust == "Self" {
358 receiver.ty.rust = single_type.rust.clone();
David Tolnaya1f29c42020-04-22 18:01:38 -0700359 }
360 }
361 }
362 }
363 }
364
David Tolnay52759782020-05-03 23:59:40 -0700365 out.extend(items);
David Tolnay7db73692019-10-20 14:51:12 -0400366}
367
David Tolnay3a451732020-08-29 18:54:55 -0700368fn parse_lang(abi: &Abi) -> Result<Lang> {
David Tolnay7db73692019-10-20 14:51:12 -0400369 let name = match &abi.name {
370 Some(name) => name,
371 None => {
372 return Err(Error::new_spanned(
373 abi,
David Tolnayc72a9f62020-11-11 10:56:26 -0800374 "ABI name is required, extern \"C++\" or extern \"Rust\"",
David Tolnay7db73692019-10-20 14:51:12 -0400375 ));
376 }
377 };
David Tolnayddbcb522020-12-21 15:24:45 -0800378
David Tolnay7db73692019-10-20 14:51:12 -0400379 match name.value().as_str() {
David Tolnayea25ac82020-11-11 10:35:23 -0800380 "C++" => Ok(Lang::Cxx),
David Tolnay7db73692019-10-20 14:51:12 -0400381 "Rust" => Ok(Lang::Rust),
David Tolnay2757ca82020-11-14 15:12:06 -0800382 _ => Err(Error::new_spanned(
383 abi,
384 "unrecognized ABI, requires either \"C++\" or \"Rust\"",
385 )),
David Tolnay7db73692019-10-20 14:51:12 -0400386 }
387}
388
David Tolnay00f236a2020-08-29 19:07:18 -0700389fn parse_extern_type(
390 cx: &mut Errors,
David Tolnay15a1fc12020-12-30 16:04:56 -0800391 foreign_type: ForeignItemType,
David Tolnay00f236a2020-08-29 19:07:18 -0700392 lang: Lang,
393 trusted: bool,
David Tolnay302b1752020-11-10 18:43:24 -0800394 namespace: &Namespace,
David Tolnayf5ead102020-11-24 17:08:05 -0800395) -> Api {
Adrian Taylorc8713432020-10-21 18:20:55 -0700396 let mut doc = Doc::new();
David Tolnay16e26202020-11-27 19:28:37 -0800397 let mut derives = Vec::new();
David Tolnay302b1752020-11-10 18:43:24 -0800398 let mut namespace = namespace.clone();
David Tolnay885be132020-12-21 15:52:47 -0800399 let mut cxx_name = None;
400 let mut rust_name = None;
David Tolnay067638e2020-12-30 16:18:05 -0800401 let attrs = attrs::parse(
Adrian Taylorc8713432020-10-21 18:20:55 -0700402 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -0800403 foreign_type.attrs,
Adrian Taylorc8713432020-10-21 18:20:55 -0700404 attrs::Parser {
405 doc: Some(&mut doc),
David Tolnay16e26202020-11-27 19:28:37 -0800406 derives: Some(&mut derives),
David Tolnayd7a3a182020-11-01 20:45:14 -0800407 namespace: Some(&mut namespace),
David Tolnay885be132020-12-21 15:52:47 -0800408 cxx_name: Some(&mut cxx_name),
409 rust_name: Some(&mut rust_name),
Adrian Taylorc8713432020-10-21 18:20:55 -0700410 ..Default::default()
411 },
412 );
David Tolnayddbcb522020-12-21 15:24:45 -0800413
David Tolnaya00f4682020-12-30 18:11:16 -0800414 let visibility = visibility_pub(&foreign_type.vis, &foreign_type.ident);
David Tolnay7db73692019-10-20 14:51:12 -0400415 let type_token = foreign_type.type_token;
David Tolnay885be132020-12-21 15:52:47 -0800416 let name = pair(namespace, &foreign_type.ident, cxx_name, rust_name);
David Tolnayee312322020-12-28 22:04:10 -0800417 let generics = Lifetimes {
418 lt_token: None,
419 lifetimes: Punctuated::new(),
420 gt_token: None,
421 };
David Tolnayddbcb522020-12-21 15:24:45 -0800422 let colon_token = None;
423 let bounds = Vec::new();
David Tolnayc8361022020-08-25 21:57:53 -0700424 let semi_token = foreign_type.semi_token;
David Tolnayddbcb522020-12-21 15:24:45 -0800425
426 (match lang {
David Tolnay295ef6b2020-05-07 16:10:22 -0700427 Lang::Cxx => Api::CxxType,
428 Lang::Rust => Api::RustType,
David Tolnayddbcb522020-12-21 15:24:45 -0800429 })(ExternType {
David Tolnay16e26202020-11-27 19:28:37 -0800430 lang,
David Tolnay7db73692019-10-20 14:51:12 -0400431 doc,
David Tolnay16e26202020-11-27 19:28:37 -0800432 derives,
David Tolnay067638e2020-12-30 16:18:05 -0800433 attrs,
David Tolnay524ff682020-12-30 17:25:38 -0800434 visibility,
David Tolnay7db73692019-10-20 14:51:12 -0400435 type_token,
David Tolnayddbcb522020-12-21 15:24:45 -0800436 name,
David Tolnayee312322020-12-28 22:04:10 -0800437 generics,
David Tolnayddbcb522020-12-21 15:24:45 -0800438 colon_token,
439 bounds,
David Tolnayc8361022020-08-25 21:57:53 -0700440 semi_token,
David Tolnay00f236a2020-08-29 19:07:18 -0700441 trusted,
David Tolnayf5ead102020-11-24 17:08:05 -0800442 })
David Tolnay7db73692019-10-20 14:51:12 -0400443}
444
Adrian Taylorc8713432020-10-21 18:20:55 -0700445fn parse_extern_fn(
446 cx: &mut Errors,
David Tolnay15a1fc12020-12-30 16:04:56 -0800447 mut foreign_fn: ForeignItemFn,
Adrian Taylorc8713432020-10-21 18:20:55 -0700448 lang: Lang,
David Tolnay556738d2020-11-15 13:58:44 -0800449 trusted: bool,
David Tolnay302b1752020-11-10 18:43:24 -0800450 namespace: &Namespace,
Adrian Taylorc8713432020-10-21 18:20:55 -0700451) -> Result<Api> {
David Tolnaybc954d92020-12-21 15:17:10 -0800452 let mut doc = Doc::new();
David Tolnaya2dfcbf2020-12-21 15:46:24 -0800453 let mut namespace = namespace.clone();
David Tolnaybc954d92020-12-21 15:17:10 -0800454 let mut cxx_name = None;
455 let mut rust_name = None;
David Tolnay067638e2020-12-30 16:18:05 -0800456 let attrs = attrs::parse(
David Tolnaybc954d92020-12-21 15:17:10 -0800457 cx,
David Tolnay067638e2020-12-30 16:18:05 -0800458 mem::take(&mut foreign_fn.attrs),
David Tolnaybc954d92020-12-21 15:17:10 -0800459 attrs::Parser {
460 doc: Some(&mut doc),
David Tolnaya2dfcbf2020-12-21 15:46:24 -0800461 namespace: Some(&mut namespace),
David Tolnaybc954d92020-12-21 15:17:10 -0800462 cxx_name: Some(&mut cxx_name),
463 rust_name: Some(&mut rust_name),
David Tolnaybc954d92020-12-21 15:17:10 -0800464 ..Default::default()
465 },
466 );
467
David Tolnay7db73692019-10-20 14:51:12 -0400468 let generics = &foreign_fn.sig.generics;
David Tolnay9938b642020-11-15 18:11:40 -0800469 if generics.where_clause.is_some()
470 || generics.params.iter().any(|param| match param {
471 GenericParam::Lifetime(lifetime) => !lifetime.bounds.is_empty(),
472 GenericParam::Type(_) | GenericParam::Const(_) => true,
473 })
474 {
David Tolnay7db73692019-10-20 14:51:12 -0400475 return Err(Error::new_spanned(
476 foreign_fn,
477 "extern function with generic parameters is not supported yet",
478 ));
479 }
David Tolnayddbcb522020-12-21 15:24:45 -0800480
David Tolnay7db73692019-10-20 14:51:12 -0400481 if let Some(variadic) = &foreign_fn.sig.variadic {
482 return Err(Error::new_spanned(
483 variadic,
484 "variadic function is not supported yet",
485 ));
486 }
David Tolnayddbcb522020-12-21 15:24:45 -0800487
David Tolnay8de461f2020-11-19 13:46:14 -0800488 if foreign_fn.sig.asyncness.is_some() {
489 return Err(Error::new_spanned(
490 foreign_fn,
491 "async function is not directly supported yet, but see https://cxx.rs/async.html for a working approach",
492 ));
493 }
David Tolnayddbcb522020-12-21 15:24:45 -0800494
David Tolnay80ef0682020-11-19 13:56:07 -0800495 if foreign_fn.sig.constness.is_some() {
496 return Err(Error::new_spanned(
497 foreign_fn,
498 "const extern function is not supported",
499 ));
500 }
David Tolnayddbcb522020-12-21 15:24:45 -0800501
David Tolnay80ef0682020-11-19 13:56:07 -0800502 if let Some(abi) = &foreign_fn.sig.abi {
503 return Err(Error::new_spanned(
504 abi,
505 "explicit ABI on extern function is not supported",
506 ));
507 }
David Tolnay7db73692019-10-20 14:51:12 -0400508
509 let mut receiver = None;
David Tolnaye3a48152020-04-08 19:38:05 -0700510 let mut args = Punctuated::new();
511 for arg in foreign_fn.sig.inputs.pairs() {
512 let (arg, comma) = arg.into_tuple();
David Tolnay7db73692019-10-20 14:51:12 -0400513 match arg {
David Tolnay1dd11a12020-04-22 12:31:48 -0700514 FnArg::Receiver(arg) => {
David Tolnaya1f29c42020-04-22 18:01:38 -0700515 if let Some((ampersand, lifetime)) = &arg.reference {
516 receiver = Some(Receiver {
David Tolnay9c76c392020-11-15 16:07:08 -0800517 pinned: false,
David Tolnaya1f29c42020-04-22 18:01:38 -0700518 ampersand: *ampersand,
519 lifetime: lifetime.clone(),
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800520 mutable: arg.mutability.is_some(),
David Tolnaya1f29c42020-04-22 18:01:38 -0700521 var: arg.self_token,
David Tolnay2d99b002020-12-21 14:34:35 -0800522 ty: RustName::new(Ident::new("Self", arg.self_token.span)),
David Tolnaya1f29c42020-04-22 18:01:38 -0700523 shorthand: true,
David Tolnay9c76c392020-11-15 16:07:08 -0800524 pin_tokens: None,
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800525 mutability: arg.mutability,
David Tolnaya1f29c42020-04-22 18:01:38 -0700526 });
527 continue;
Joel Galensone1e969d2020-04-21 12:50:20 -0700528 }
David Tolnay1dd11a12020-04-22 12:31:48 -0700529 return Err(Error::new_spanned(arg, "unsupported signature"));
David Tolnay7db73692019-10-20 14:51:12 -0400530 }
531 FnArg::Typed(arg) => {
532 let ident = match arg.pat.as_ref() {
533 Pat::Ident(pat) => pat.ident.clone(),
Joel Galensonba676072020-04-27 15:55:45 -0700534 Pat::Wild(pat) => {
David Tolnayb4c14552020-12-29 15:44:19 -0800535 Ident::new(&format!("arg{}", args.len()), pat.underscore_token.span)
Joel Galensonba676072020-04-27 15:55:45 -0700536 }
David Tolnay7db73692019-10-20 14:51:12 -0400537 _ => return Err(Error::new_spanned(arg, "unsupported signature")),
538 };
David Tolnay313cc0a2020-11-24 21:47:01 -0800539 let ty = parse_type(&arg.ty)?;
David Tolnay7db73692019-10-20 14:51:12 -0400540 if ident != "self" {
David Tolnayb4a05c32020-12-30 15:37:01 -0800541 let doc = Doc::new();
David Tolnaycba3d442020-12-30 16:39:21 -0800542 let attrs = OtherAttrs::none();
David Tolnay89902442020-12-30 15:10:40 -0800543 let visibility = Token![pub](ident.span());
544 args.push_value(Var {
David Tolnayb4a05c32020-12-30 15:37:01 -0800545 doc,
David Tolnay067638e2020-12-30 16:18:05 -0800546 attrs,
David Tolnay89902442020-12-30 15:10:40 -0800547 visibility,
548 ident,
549 ty,
550 });
David Tolnaye3a48152020-04-08 19:38:05 -0700551 if let Some(comma) = comma {
552 args.push_punct(*comma);
553 }
David Tolnay7db73692019-10-20 14:51:12 -0400554 continue;
555 }
556 if let Type::Ref(reference) = ty {
557 if let Type::Ident(ident) = reference.inner {
558 receiver = Some(Receiver {
David Tolnay9c76c392020-11-15 16:07:08 -0800559 pinned: reference.pinned,
David Tolnayfb6e3862020-04-20 01:33:23 -0700560 ampersand: reference.ampersand,
David Tolnay0bd50fa2020-04-22 15:31:33 -0700561 lifetime: reference.lifetime,
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800562 mutable: reference.mutable,
Adrian Taylorc8713432020-10-21 18:20:55 -0700563 var: Token![self](ident.rust.span()),
David Tolnay05e11cc2020-04-20 02:13:56 -0700564 ty: ident,
David Tolnay62d360c2020-04-22 16:26:21 -0700565 shorthand: false,
David Tolnay9c76c392020-11-15 16:07:08 -0800566 pin_tokens: reference.pin_tokens,
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800567 mutability: reference.mutability,
David Tolnay7db73692019-10-20 14:51:12 -0400568 });
569 continue;
570 }
571 }
572 return Err(Error::new_spanned(arg, "unsupported method receiver"));
573 }
574 }
575 }
David Tolnay59b7ede2020-03-16 00:30:23 -0700576
David Tolnaye3a48152020-04-08 19:38:05 -0700577 let mut throws_tokens = None;
David Tolnay313cc0a2020-11-24 21:47:01 -0800578 let ret = parse_return_type(&foreign_fn.sig.output, &mut throws_tokens)?;
David Tolnaye3a48152020-04-08 19:38:05 -0700579 let throws = throws_tokens.is_some();
David Tolnaya00f4682020-12-30 18:11:16 -0800580 let visibility = visibility_pub(&foreign_fn.vis, &foreign_fn.sig.ident);
David Tolnaybdb576c2020-09-06 23:45:55 -0700581 let unsafety = foreign_fn.sig.unsafety;
David Tolnay7db73692019-10-20 14:51:12 -0400582 let fn_token = foreign_fn.sig.fn_token;
David Tolnay6a990f82020-12-21 15:42:31 -0800583 let name = pair(namespace, &foreign_fn.sig.ident, cxx_name, rust_name);
David Tolnay9938b642020-11-15 18:11:40 -0800584 let generics = generics.clone();
David Tolnaye3a48152020-04-08 19:38:05 -0700585 let paren_token = foreign_fn.sig.paren_token;
David Tolnay7db73692019-10-20 14:51:12 -0400586 let semi_token = foreign_fn.semi_token;
David Tolnayddbcb522020-12-21 15:24:45 -0800587
588 Ok(match lang {
David Tolnay295ef6b2020-05-07 16:10:22 -0700589 Lang::Cxx => Api::CxxFunction,
590 Lang::Rust => Api::RustFunction,
David Tolnayddbcb522020-12-21 15:24:45 -0800591 }(ExternFn {
David Tolnay6cde49f2020-03-16 12:25:45 -0700592 lang,
David Tolnay7db73692019-10-20 14:51:12 -0400593 doc,
David Tolnay067638e2020-12-30 16:18:05 -0800594 attrs,
David Tolnay49f9df72020-12-30 18:02:38 -0800595 visibility,
David Tolnay17a934c2020-11-02 00:40:04 -0800596 name,
David Tolnay16448732020-03-18 12:39:36 -0700597 sig: Signature {
David Tolnaybdb576c2020-09-06 23:45:55 -0700598 unsafety,
David Tolnay16448732020-03-18 12:39:36 -0700599 fn_token,
David Tolnay9938b642020-11-15 18:11:40 -0800600 generics,
David Tolnay16448732020-03-18 12:39:36 -0700601 receiver,
602 args,
603 ret,
604 throws,
David Tolnaye3a48152020-04-08 19:38:05 -0700605 paren_token,
606 throws_tokens,
David Tolnay16448732020-03-18 12:39:36 -0700607 },
David Tolnay7db73692019-10-20 14:51:12 -0400608 semi_token,
David Tolnay556738d2020-11-15 13:58:44 -0800609 trusted,
David Tolnay295ef6b2020-05-07 16:10:22 -0700610 }))
David Tolnay7db73692019-10-20 14:51:12 -0400611}
612
Adrian Taylorc8713432020-10-21 18:20:55 -0700613fn parse_extern_verbatim(
614 cx: &mut Errors,
David Tolnay15a1fc12020-12-30 16:04:56 -0800615 tokens: TokenStream,
Adrian Taylorc8713432020-10-21 18:20:55 -0700616 lang: Lang,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800617 trusted: bool,
David Tolnay302b1752020-11-10 18:43:24 -0800618 namespace: &Namespace,
Adrian Taylorc8713432020-10-21 18:20:55 -0700619) -> Result<Api> {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800620 |input: ParseStream| -> Result<Api> {
David Tolnaye2f9ec42020-05-07 16:19:33 -0700621 let attrs = input.call(Attribute::parse_outer)?;
David Tolnay524ff682020-12-30 17:25:38 -0800622 let visibility: Visibility = input.parse()?;
David Tolnaye2f9ec42020-05-07 16:19:33 -0700623 let type_token: Token![type] = match input.parse()? {
624 Some(type_token) => type_token,
625 None => {
626 let span = input.cursor().token_stream();
627 return Err(Error::new_spanned(span, "unsupported foreign item"));
628 }
629 };
630 let ident: Ident = input.parse()?;
David Tolnaye81647f2020-12-28 19:30:01 -0800631 let generics: Generics = input.parse()?;
David Tolnayee312322020-12-28 22:04:10 -0800632 let mut lifetimes = Punctuated::new();
David Tolnaye81647f2020-12-28 19:30:01 -0800633 let mut has_unsupported_generic_param = false;
David Tolnayee312322020-12-28 22:04:10 -0800634 for pair in generics.params.into_pairs() {
635 let (param, punct) = pair.into_tuple();
David Tolnaye81647f2020-12-28 19:30:01 -0800636 match param {
637 GenericParam::Lifetime(param) => {
638 if !param.bounds.is_empty() && !has_unsupported_generic_param {
639 let msg = "lifetime parameter with bounds is not supported yet";
640 cx.error(&param, msg);
641 has_unsupported_generic_param = true;
642 }
David Tolnayee312322020-12-28 22:04:10 -0800643 lifetimes.push_value(param.lifetime);
644 if let Some(punct) = punct {
645 lifetimes.push_punct(punct);
646 }
David Tolnaye81647f2020-12-28 19:30:01 -0800647 }
648 GenericParam::Type(param) => {
649 if !has_unsupported_generic_param {
650 let msg = "extern type with generic type parameter is not supported yet";
651 cx.error(&param, msg);
652 has_unsupported_generic_param = true;
653 }
654 }
655 GenericParam::Const(param) => {
656 if !has_unsupported_generic_param {
657 let msg = "extern type with const generic parameter is not supported yet";
658 cx.error(&param, msg);
659 has_unsupported_generic_param = true;
660 }
661 }
662 }
663 }
David Tolnayee312322020-12-28 22:04:10 -0800664 let lifetimes = Lifetimes {
665 lt_token: generics.lt_token,
666 lifetimes,
667 gt_token: generics.gt_token,
668 };
David Tolnayb7eb65e2020-11-27 20:00:53 -0800669 let lookahead = input.lookahead1();
670 if lookahead.peek(Token![=]) {
671 // type Alias = crate::path::to::Type;
David Tolnaye81647f2020-12-28 19:30:01 -0800672 parse_type_alias(
David Tolnay291c9352020-12-30 17:31:19 -0800673 cx, attrs, visibility, type_token, ident, lifetimes, input, lang, namespace,
David Tolnaye81647f2020-12-28 19:30:01 -0800674 )
David Tolnaya870ac72020-12-28 19:48:33 -0800675 } else if lookahead.peek(Token![:]) || lookahead.peek(Token![;]) {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800676 // type Opaque: Bound2 + Bound2;
677 parse_extern_type_bounded(
David Tolnay524ff682020-12-30 17:25:38 -0800678 cx, attrs, visibility, type_token, ident, lifetimes, input, lang, trusted,
679 namespace,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800680 )
681 } else {
682 Err(lookahead.error())
David Tolnaye2f9ec42020-05-07 16:19:33 -0700683 }
684 }
David Tolnay15a1fc12020-12-30 16:04:56 -0800685 .parse2(tokens)
David Tolnayb7eb65e2020-11-27 20:00:53 -0800686}
687
688fn parse_type_alias(
689 cx: &mut Errors,
690 attrs: Vec<Attribute>,
David Tolnay291c9352020-12-30 17:31:19 -0800691 visibility: Visibility,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800692 type_token: Token![type],
693 ident: Ident,
David Tolnayee312322020-12-28 22:04:10 -0800694 generics: Lifetimes,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800695 input: ParseStream,
696 lang: Lang,
697 namespace: &Namespace,
698) -> Result<Api> {
699 let eq_token: Token![=] = input.parse()?;
700 let ty: RustType = input.parse()?;
701 let semi_token: Token![;] = input.parse()?;
702
703 let mut doc = Doc::new();
704 let mut derives = Vec::new();
705 let mut namespace = namespace.clone();
David Tolnay885be132020-12-21 15:52:47 -0800706 let mut cxx_name = None;
707 let mut rust_name = None;
David Tolnay067638e2020-12-30 16:18:05 -0800708 let attrs = attrs::parse(
David Tolnayb7eb65e2020-11-27 20:00:53 -0800709 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -0800710 attrs,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800711 attrs::Parser {
712 doc: Some(&mut doc),
713 derives: Some(&mut derives),
714 namespace: Some(&mut namespace),
David Tolnay885be132020-12-21 15:52:47 -0800715 cxx_name: Some(&mut cxx_name),
716 rust_name: Some(&mut rust_name),
David Tolnayb7eb65e2020-11-27 20:00:53 -0800717 ..Default::default()
718 },
719 );
720
721 if lang == Lang::Rust {
722 let span = quote!(#type_token #semi_token);
723 let msg = "type alias in extern \"Rust\" block is not supported";
724 return Err(Error::new_spanned(span, msg));
725 }
726
David Tolnaya00f4682020-12-30 18:11:16 -0800727 let visibility = visibility_pub(&visibility, &ident);
David Tolnay885be132020-12-21 15:52:47 -0800728 let name = pair(namespace, &ident, cxx_name, rust_name);
David Tolnayddbcb522020-12-21 15:24:45 -0800729
David Tolnayb7eb65e2020-11-27 20:00:53 -0800730 Ok(Api::TypeAlias(TypeAlias {
731 doc,
732 derives,
David Tolnay067638e2020-12-30 16:18:05 -0800733 attrs,
David Tolnay291c9352020-12-30 17:31:19 -0800734 visibility,
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>,
David Tolnay524ff682020-12-30 17:25:38 -0800747 visibility: Visibility,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800748 type_token: Token![type],
749 ident: Ident,
David Tolnayee312322020-12-28 22:04:10 -0800750 generics: Lifetimes,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800751 input: ParseStream,
752 lang: Lang,
753 trusted: bool,
754 namespace: &Namespace,
755) -> Result<Api> {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800756 let mut bounds = Vec::new();
David Tolnaya870ac72020-12-28 19:48:33 -0800757 let colon_token: Option<Token![:]> = input.parse()?;
758 if colon_token.is_some() {
759 loop {
760 match input.parse()? {
761 TypeParamBound::Trait(TraitBound {
762 paren_token: None,
763 modifier: TraitBoundModifier::None,
764 lifetimes: None,
765 path,
766 }) if if let Some(derive) = path.get_ident().and_then(Derive::from) {
767 bounds.push(derive);
768 true
769 } else {
770 false
771 } => {}
772 bound @ TypeParamBound::Trait(_) | bound @ TypeParamBound::Lifetime(_) => {
773 cx.error(bound, "unsupported trait");
774 }
David Tolnayb7eb65e2020-11-27 20:00:53 -0800775 }
David Tolnayb7eb65e2020-11-27 20:00:53 -0800776
David Tolnaya870ac72020-12-28 19:48:33 -0800777 let lookahead = input.lookahead1();
778 if lookahead.peek(Token![+]) {
779 input.parse::<Token![+]>()?;
780 } else if lookahead.peek(Token![;]) {
781 break;
782 } else {
783 return Err(lookahead.error());
784 }
David Tolnayb7eb65e2020-11-27 20:00:53 -0800785 }
786 }
787 let semi_token: Token![;] = input.parse()?;
788
789 let mut doc = Doc::new();
790 let mut derives = Vec::new();
791 let mut namespace = namespace.clone();
David Tolnay885be132020-12-21 15:52:47 -0800792 let mut cxx_name = None;
793 let mut rust_name = None;
David Tolnay067638e2020-12-30 16:18:05 -0800794 let attrs = attrs::parse(
David Tolnayb7eb65e2020-11-27 20:00:53 -0800795 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -0800796 attrs,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800797 attrs::Parser {
798 doc: Some(&mut doc),
799 derives: Some(&mut derives),
800 namespace: Some(&mut namespace),
David Tolnay885be132020-12-21 15:52:47 -0800801 cxx_name: Some(&mut cxx_name),
802 rust_name: Some(&mut rust_name),
David Tolnayb7eb65e2020-11-27 20:00:53 -0800803 ..Default::default()
804 },
805 );
806
David Tolnaya00f4682020-12-30 18:11:16 -0800807 let visibility = visibility_pub(&visibility, &ident);
David Tolnay885be132020-12-21 15:52:47 -0800808 let name = pair(namespace, &ident, cxx_name, rust_name);
David Tolnayddbcb522020-12-21 15:24:45 -0800809
810 Ok(match lang {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800811 Lang::Cxx => Api::CxxType,
812 Lang::Rust => Api::RustType,
David Tolnayddbcb522020-12-21 15:24:45 -0800813 }(ExternType {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800814 lang,
815 doc,
816 derives,
David Tolnay067638e2020-12-30 16:18:05 -0800817 attrs,
David Tolnay524ff682020-12-30 17:25:38 -0800818 visibility,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800819 type_token,
David Tolnayddbcb522020-12-21 15:24:45 -0800820 name,
David Tolnayee312322020-12-28 22:04:10 -0800821 generics,
David Tolnayddbcb522020-12-21 15:24:45 -0800822 colon_token,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800823 bounds,
824 semi_token,
825 trusted,
826 }))
David Tolnaye2f9ec42020-05-07 16:19:33 -0700827}
828
David Tolnay313cc0a2020-11-24 21:47:01 -0800829fn parse_impl(imp: ItemImpl) -> Result<Api> {
David Tolnay7e69f892020-10-03 22:20:22 -0700830 if !imp.items.is_empty() {
831 let mut span = Group::new(Delimiter::Brace, TokenStream::new());
832 span.set_span(imp.brace_token.span);
833 return Err(Error::new_spanned(span, "expected an empty impl block"));
834 }
835
David Tolnay7e69f892020-10-03 22:20:22 -0700836 if let Some((bang, path, for_token)) = &imp.trait_ {
David Tolnay028d3d22020-11-29 18:09:52 -0800837 let self_ty = &imp.self_ty;
David Tolnay7e69f892020-10-03 22:20:22 -0700838 let span = quote!(#bang #path #for_token #self_ty);
839 return Err(Error::new_spanned(
840 span,
841 "unexpected impl, expected something like `impl UniquePtr<T> {}`",
842 ));
843 }
844
845 let generics = &imp.generics;
846 if !generics.params.is_empty() || generics.where_clause.is_some() {
847 return Err(Error::new_spanned(
848 imp,
849 "generic parameters on an impl is not supported",
850 ));
851 }
852
David Tolnay028d3d22020-11-29 18:09:52 -0800853 let mut negative_token = None;
854 let mut self_ty = *imp.self_ty;
855 if let RustType::Verbatim(ty) = &self_ty {
856 let mut iter = ty.clone().into_iter();
857 if let Some(TokenTree::Punct(punct)) = iter.next() {
858 if punct.as_char() == '!' {
859 let ty = iter.collect::<TokenStream>();
860 if !ty.is_empty() {
861 negative_token = Some(Token![!](punct.span()));
862 self_ty = syn::parse2(ty)?;
863 }
864 }
865 }
866 }
867
David Tolnayddbcb522020-12-21 15:24:45 -0800868 let impl_token = imp.impl_token;
869 let negative = negative_token.is_some();
870 let ty = parse_type(&self_ty)?;
871 let brace_token = imp.brace_token;
872
David Tolnay7e69f892020-10-03 22:20:22 -0700873 Ok(Api::Impl(Impl {
David Tolnayddbcb522020-12-21 15:24:45 -0800874 impl_token,
875 negative,
876 ty,
877 brace_token,
David Tolnay028d3d22020-11-29 18:09:52 -0800878 negative_token,
David Tolnay7e69f892020-10-03 22:20:22 -0700879 }))
880}
881
David Tolnayb0cd3272020-10-27 21:32:54 -0700882fn parse_include(input: ParseStream) -> Result<Include> {
David Tolnay91e87fa2020-05-11 19:10:23 -0700883 if input.peek(LitStr) {
David Tolnayb0cd3272020-10-27 21:32:54 -0700884 let lit: LitStr = input.parse()?;
885 let span = lit.span();
886 return Ok(Include {
887 path: lit.value(),
888 kind: IncludeKind::Quoted,
889 begin_span: span,
890 end_span: span,
891 });
David Tolnay91e87fa2020-05-11 19:10:23 -0700892 }
893
894 if input.peek(Token![<]) {
895 let mut path = String::new();
David Tolnayb0cd3272020-10-27 21:32:54 -0700896
David Tolnay2cc2e3a2020-10-28 13:12:35 -0700897 let langle: Token![<] = input.parse()?;
David Tolnay91e87fa2020-05-11 19:10:23 -0700898 while !input.is_empty() && !input.peek(Token![>]) {
899 let token: TokenTree = input.parse()?;
900 match token {
901 TokenTree::Ident(token) => path += &token.to_string(),
902 TokenTree::Literal(token)
903 if token
904 .to_string()
905 .starts_with(|ch: char| ch.is_ascii_digit()) =>
906 {
907 path += &token.to_string();
908 }
909 TokenTree::Punct(token) => path.push(token.as_char()),
910 _ => return Err(Error::new(token.span(), "unexpected token in include path")),
911 }
912 }
David Tolnayb0cd3272020-10-27 21:32:54 -0700913 let rangle: Token![>] = input.parse()?;
David Tolnayb0cd3272020-10-27 21:32:54 -0700914
915 return Ok(Include {
916 path,
917 kind: IncludeKind::Bracketed,
David Tolnay2cc2e3a2020-10-28 13:12:35 -0700918 begin_span: langle.span,
919 end_span: rangle.span,
David Tolnayb0cd3272020-10-27 21:32:54 -0700920 });
David Tolnay91e87fa2020-05-11 19:10:23 -0700921 }
922
923 Err(input.error("expected \"quoted/path/to\" or <bracketed/path/to>"))
924}
925
David Tolnay313cc0a2020-11-24 21:47:01 -0800926fn parse_type(ty: &RustType) -> Result<Type> {
David Tolnay59b7ede2020-03-16 00:30:23 -0700927 match ty {
David Tolnay313cc0a2020-11-24 21:47:01 -0800928 RustType::Reference(ty) => parse_type_reference(ty),
929 RustType::Path(ty) => parse_type_path(ty),
David Tolnay313cc0a2020-11-24 21:47:01 -0800930 RustType::Array(ty) => parse_type_array(ty),
931 RustType::BareFn(ty) => parse_type_fn(ty),
David Tolnayb40b9db2020-03-18 13:50:31 -0700932 RustType::Tuple(ty) if ty.elems.is_empty() => Ok(Type::Void(ty.paren_token.span)),
933 _ => Err(Error::new_spanned(ty, "unsupported type")),
934 }
935}
936
David Tolnay313cc0a2020-11-24 21:47:01 -0800937fn parse_type_reference(ty: &TypeReference) -> Result<Type> {
David Tolnayddbcb522020-12-21 15:24:45 -0800938 let ampersand = ty.and_token;
939 let lifetime = ty.lifetime.clone();
940 let mutable = ty.mutability.is_some();
941 let mutability = ty.mutability;
942
David Tolnaye0dca7b2020-11-25 17:18:57 -0800943 if let RustType::Slice(slice) = ty.elem.as_ref() {
944 let inner = parse_type(&slice.elem)?;
David Tolnayddbcb522020-12-21 15:24:45 -0800945 let bracket = slice.bracket_token;
David Tolnay69db8142020-11-25 17:49:25 -0800946 return Ok(Type::SliceRef(Box::new(SliceRef {
David Tolnayddbcb522020-12-21 15:24:45 -0800947 ampersand,
948 lifetime,
949 mutable,
950 bracket,
David Tolnay69db8142020-11-25 17:49:25 -0800951 inner,
David Tolnayddbcb522020-12-21 15:24:45 -0800952 mutability,
David Tolnay69db8142020-11-25 17:49:25 -0800953 })));
David Tolnaye0dca7b2020-11-25 17:18:57 -0800954 }
955
David Tolnay313cc0a2020-11-24 21:47:01 -0800956 let inner = parse_type(&ty.elem)?;
David Tolnayddbcb522020-12-21 15:24:45 -0800957 let pinned = false;
958 let pin_tokens = None;
959
960 Ok(match &inner {
Adrian Taylorc8713432020-10-21 18:20:55 -0700961 Type::Ident(ident) if ident.rust == "str" => {
David Tolnayb40b9db2020-03-18 13:50:31 -0700962 if ty.mutability.is_some() {
963 return Err(Error::new_spanned(ty, "unsupported type"));
964 } else {
965 Type::Str
David Tolnay7db73692019-10-20 14:51:12 -0400966 }
967 }
David Tolnayb40b9db2020-03-18 13:50:31 -0700968 _ => Type::Ref,
David Tolnayddbcb522020-12-21 15:24:45 -0800969 }(Box::new(Ref {
970 pinned,
971 ampersand,
972 lifetime,
973 mutable,
David Tolnayb40b9db2020-03-18 13:50:31 -0700974 inner,
David Tolnayddbcb522020-12-21 15:24:45 -0800975 pin_tokens,
976 mutability,
David Tolnayb40b9db2020-03-18 13:50:31 -0700977 })))
978}
979
David Tolnay313cc0a2020-11-24 21:47:01 -0800980fn parse_type_path(ty: &TypePath) -> Result<Type> {
David Tolnayb40b9db2020-03-18 13:50:31 -0700981 let path = &ty.path;
982 if ty.qself.is_none() && path.leading_colon.is_none() && path.segments.len() == 1 {
983 let segment = &path.segments[0];
984 let ident = segment.ident.clone();
985 match &segment.arguments {
David Tolnay75ea17c2020-12-06 21:08:34 -0800986 PathArguments::None => return Ok(Type::Ident(RustName::new(ident))),
David Tolnayb40b9db2020-03-18 13:50:31 -0700987 PathArguments::AngleBracketed(generic) => {
988 if ident == "UniquePtr" && generic.args.len() == 1 {
989 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnay313cc0a2020-11-24 21:47:01 -0800990 let inner = parse_type(arg)?;
David Tolnayb40b9db2020-03-18 13:50:31 -0700991 return Ok(Type::UniquePtr(Box::new(Ty1 {
David Tolnayda71ef62020-11-02 00:36:00 -0800992 name: ident,
David Tolnayb40b9db2020-03-18 13:50:31 -0700993 langle: generic.lt_token,
994 inner,
995 rangle: generic.gt_token,
996 })));
997 }
David Tolnayb3b24a12020-12-01 15:27:43 -0800998 } else if ident == "SharedPtr" && generic.args.len() == 1 {
999 if let GenericArgument::Type(arg) = &generic.args[0] {
1000 let inner = parse_type(arg)?;
1001 return Ok(Type::SharedPtr(Box::new(Ty1 {
1002 name: ident,
1003 langle: generic.lt_token,
1004 inner,
1005 rangle: generic.gt_token,
1006 })));
1007 }
David Tolnay215e77f2020-12-28 17:09:48 -08001008 } else if ident == "WeakPtr" && generic.args.len() == 1 {
1009 if let GenericArgument::Type(arg) = &generic.args[0] {
1010 let inner = parse_type(arg)?;
1011 return Ok(Type::WeakPtr(Box::new(Ty1 {
1012 name: ident,
1013 langle: generic.lt_token,
1014 inner,
1015 rangle: generic.gt_token,
1016 })));
1017 }
David Tolnaye1dcdf72020-04-24 17:40:55 -07001018 } else if ident == "CxxVector" && generic.args.len() == 1 {
Myron Ahneba35cf2020-02-05 19:41:51 +07001019 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnay313cc0a2020-11-24 21:47:01 -08001020 let inner = parse_type(arg)?;
David Tolnay4377a9e2020-04-24 15:20:26 -07001021 return Ok(Type::CxxVector(Box::new(Ty1 {
David Tolnayda71ef62020-11-02 00:36:00 -08001022 name: ident,
Myron Ahneba35cf2020-02-05 19:41:51 +07001023 langle: generic.lt_token,
1024 inner,
1025 rangle: generic.gt_token,
1026 })));
1027 }
David Tolnayb40b9db2020-03-18 13:50:31 -07001028 } else if ident == "Box" && generic.args.len() == 1 {
1029 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnay313cc0a2020-11-24 21:47:01 -08001030 let inner = parse_type(arg)?;
David Tolnayb40b9db2020-03-18 13:50:31 -07001031 return Ok(Type::RustBox(Box::new(Ty1 {
David Tolnayda71ef62020-11-02 00:36:00 -08001032 name: ident,
David Tolnayb40b9db2020-03-18 13:50:31 -07001033 langle: generic.lt_token,
1034 inner,
1035 rangle: generic.gt_token,
1036 })));
1037 }
Myron Ahneba35cf2020-02-05 19:41:51 +07001038 } else if ident == "Vec" && generic.args.len() == 1 {
1039 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnay313cc0a2020-11-24 21:47:01 -08001040 let inner = parse_type(arg)?;
Myron Ahneba35cf2020-02-05 19:41:51 +07001041 return Ok(Type::RustVec(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 Tolnaycbc2a4b2020-11-15 15:08:44 -08001048 } else if ident == "Pin" && 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 Tolnayc94035a2020-11-15 16:49:18 -08001051 let pin_token = kw::Pin(ident.span());
David Tolnaycbc2a4b2020-11-15 15:08:44 -08001052 if let Type::Ref(mut inner) = inner {
David Tolnaycbc2a4b2020-11-15 15:08:44 -08001053 inner.pinned = true;
1054 inner.pin_tokens =
1055 Some((pin_token, generic.lt_token, generic.gt_token));
1056 return Ok(Type::Ref(inner));
1057 }
1058 }
David Tolnayb40b9db2020-03-18 13:50:31 -07001059 }
1060 }
1061 PathArguments::Parenthesized(_) => {}
David Tolnayfb134ed2020-03-15 23:17:48 -07001062 }
David Tolnay7db73692019-10-20 14:51:12 -04001063 }
David Tolnayddbcb522020-12-21 15:24:45 -08001064
David Tolnay7db73692019-10-20 14:51:12 -04001065 Err(Error::new_spanned(ty, "unsupported type"))
1066}
1067
David Tolnay313cc0a2020-11-24 21:47:01 -08001068fn parse_type_array(ty: &TypeArray) -> Result<Type> {
1069 let inner = parse_type(&ty.elem)?;
David Tolnayd9f97842020-11-24 21:00:05 -08001070
1071 let len_expr = if let Expr::Lit(lit) = &ty.len {
1072 lit
1073 } else {
1074 let msg = "unsupported expression, array length must be an integer literal";
1075 return Err(Error::new_spanned(&ty.len, msg));
1076 };
1077
1078 let len_token = if let Lit::Int(int) = &len_expr.lit {
1079 int.clone()
1080 } else {
1081 let msg = "array length must be an integer literal";
1082 return Err(Error::new_spanned(len_expr, msg));
1083 };
1084
David Tolnay581f72d2020-11-25 15:48:59 -08001085 let len = len_token.base10_parse::<usize>()?;
1086 if len == 0 {
1087 let msg = "array with zero size is not supported";
1088 return Err(Error::new_spanned(ty, msg));
1089 }
1090
David Tolnayd9f97842020-11-24 21:00:05 -08001091 let bracket = ty.bracket_token;
1092 let semi_token = ty.semi_token;
David Tolnayd9f97842020-11-24 21:00:05 -08001093
1094 Ok(Type::Array(Box::new(Array {
1095 bracket,
1096 inner,
1097 semi_token,
1098 len,
1099 len_token,
1100 })))
David Tolnay2d0df232020-11-24 20:50:32 -08001101}
1102
David Tolnay313cc0a2020-11-24 21:47:01 -08001103fn parse_type_fn(ty: &TypeBareFn) -> Result<Type> {
David Tolnayc071b892020-03-18 16:59:53 -07001104 if ty.lifetimes.is_some() {
1105 return Err(Error::new_spanned(
1106 ty,
1107 "function pointer with lifetime parameters is not supported yet",
1108 ));
1109 }
David Tolnayddbcb522020-12-21 15:24:45 -08001110
David Tolnayc071b892020-03-18 16:59:53 -07001111 if ty.variadic.is_some() {
1112 return Err(Error::new_spanned(
1113 ty,
1114 "variadic function pointer is not supported yet",
1115 ));
1116 }
David Tolnayddbcb522020-12-21 15:24:45 -08001117
David Tolnayc071b892020-03-18 16:59:53 -07001118 let args = ty
1119 .inputs
1120 .iter()
1121 .enumerate()
1122 .map(|(i, arg)| {
David Tolnay313cc0a2020-11-24 21:47:01 -08001123 let ty = parse_type(&arg.ty)?;
David Tolnayc071b892020-03-18 16:59:53 -07001124 let ident = match &arg.name {
1125 Some(ident) => ident.0.clone(),
David Tolnayb4c14552020-12-29 15:44:19 -08001126 None => format_ident!("arg{}", i),
David Tolnayc071b892020-03-18 16:59:53 -07001127 };
David Tolnayb4a05c32020-12-30 15:37:01 -08001128 let doc = Doc::new();
David Tolnaycba3d442020-12-30 16:39:21 -08001129 let attrs = OtherAttrs::none();
David Tolnay89902442020-12-30 15:10:40 -08001130 let visibility = Token![pub](ident.span());
1131 Ok(Var {
David Tolnayb4a05c32020-12-30 15:37:01 -08001132 doc,
David Tolnay067638e2020-12-30 16:18:05 -08001133 attrs,
David Tolnay89902442020-12-30 15:10:40 -08001134 visibility,
1135 ident,
1136 ty,
1137 })
David Tolnayc071b892020-03-18 16:59:53 -07001138 })
1139 .collect::<Result<_>>()?;
David Tolnayddbcb522020-12-21 15:24:45 -08001140
David Tolnaye3a48152020-04-08 19:38:05 -07001141 let mut throws_tokens = None;
David Tolnay313cc0a2020-11-24 21:47:01 -08001142 let ret = parse_return_type(&ty.output, &mut throws_tokens)?;
David Tolnaye3a48152020-04-08 19:38:05 -07001143 let throws = throws_tokens.is_some();
David Tolnayddbcb522020-12-21 15:24:45 -08001144
1145 let unsafety = ty.unsafety;
1146 let fn_token = ty.fn_token;
1147 let generics = Generics::default();
1148 let receiver = None;
1149 let paren_token = ty.paren_token;
1150
David Tolnayc071b892020-03-18 16:59:53 -07001151 Ok(Type::Fn(Box::new(Signature {
David Tolnayddbcb522020-12-21 15:24:45 -08001152 unsafety,
1153 fn_token,
1154 generics,
1155 receiver,
David Tolnayc071b892020-03-18 16:59:53 -07001156 args,
1157 ret,
1158 throws,
David Tolnayddbcb522020-12-21 15:24:45 -08001159 paren_token,
David Tolnaye3a48152020-04-08 19:38:05 -07001160 throws_tokens,
David Tolnayc071b892020-03-18 16:59:53 -07001161 })))
1162}
1163
David Tolnaye3a48152020-04-08 19:38:05 -07001164fn parse_return_type(
1165 ty: &ReturnType,
1166 throws_tokens: &mut Option<(kw::Result, Token![<], Token![>])>,
1167) -> Result<Option<Type>> {
David Tolnayc071b892020-03-18 16:59:53 -07001168 let mut ret = match ty {
1169 ReturnType::Default => return Ok(None),
1170 ReturnType::Type(_, ret) => ret.as_ref(),
1171 };
David Tolnayddbcb522020-12-21 15:24:45 -08001172
David Tolnayc071b892020-03-18 16:59:53 -07001173 if let RustType::Path(ty) = ret {
1174 let path = &ty.path;
1175 if ty.qself.is_none() && path.leading_colon.is_none() && path.segments.len() == 1 {
1176 let segment = &path.segments[0];
1177 let ident = segment.ident.clone();
1178 if let PathArguments::AngleBracketed(generic) = &segment.arguments {
1179 if ident == "Result" && generic.args.len() == 1 {
1180 if let GenericArgument::Type(arg) = &generic.args[0] {
1181 ret = arg;
David Tolnaye3a48152020-04-08 19:38:05 -07001182 *throws_tokens =
1183 Some((kw::Result(ident.span()), generic.lt_token, generic.gt_token));
David Tolnayc071b892020-03-18 16:59:53 -07001184 }
1185 }
1186 }
1187 }
1188 }
David Tolnayddbcb522020-12-21 15:24:45 -08001189
David Tolnay313cc0a2020-11-24 21:47:01 -08001190 match parse_type(ret)? {
David Tolnayc071b892020-03-18 16:59:53 -07001191 Type::Void(_) => Ok(None),
1192 ty => Ok(Some(ty)),
1193 }
1194}
David Tolnay6a990f82020-12-21 15:42:31 -08001195
David Tolnaya00f4682020-12-30 18:11:16 -08001196fn visibility_pub(vis: &Visibility, inherited: &Ident) -> Token![pub] {
1197 Token![pub](match vis {
1198 Visibility::Public(vis) => vis.pub_token.span,
1199 Visibility::Crate(vis) => vis.crate_token.span,
1200 Visibility::Restricted(vis) => vis.pub_token.span,
1201 Visibility::Inherited => inherited.span(),
1202 })
1203}
1204
David Tolnay6a990f82020-12-21 15:42:31 -08001205fn pair(namespace: Namespace, default: &Ident, cxx: Option<Ident>, rust: Option<Ident>) -> Pair {
1206 let default = || default.clone();
David Tolnayc2a4c782020-12-21 15:55:31 -08001207 Pair {
David Tolnay6a990f82020-12-21 15:42:31 -08001208 namespace,
David Tolnayc2a4c782020-12-21 15:55:31 -08001209 cxx: cxx.unwrap_or_else(default),
1210 rust: rust.unwrap_or_else(default),
1211 }
David Tolnay6a990f82020-12-21 15:42:31 -08001212}