blob: 1ea4db4ed24f04c1f7739698eaf49fe4075cc052 [file] [log] [blame]
David Tolnay17e137f2020-05-08 15:55:28 -07001use crate::syntax::discriminant::DiscriminantSet;
David Tolnayc598a272020-08-29 15:10:18 -07002use crate::syntax::file::{Item, ItemForeignMod};
David Tolnay52759782020-05-03 23:59:40 -07003use crate::syntax::report::Errors;
David Tolnayeebe9b72020-04-14 16:32:18 -07004use crate::syntax::Atom::*;
David Tolnay7db73692019-10-20 14:51:12 -04005use crate::syntax::{
David Tolnayb7eb65e2020-11-27 20:00:53 -08006 attrs, error, Api, Array, Derive, Doc, Enum, ExternFn, ExternType, Impl, Include, IncludeKind,
David Tolnayee312322020-12-28 22:04:10 -08007 Lang, Lifetimes, Namespace, Pair, Receiver, Ref, RustName, Signature, SliceRef, Struct, Ty1,
8 Type, TypeAlias, Var, Variant,
David Tolnay7db73692019-10-20 14:51:12 -04009};
David Tolnay9a69d8a2020-11-16 09:16:41 -080010use proc_macro2::{Delimiter, Group, Span, TokenStream, TokenTree};
David Tolnaye2e303f2020-05-10 20:52:00 -070011use quote::{format_ident, quote, quote_spanned};
David Tolnay15a1fc12020-12-30 16:04:56 -080012use std::mem;
David Tolnaye2f9ec42020-05-07 16:19:33 -070013use syn::parse::{ParseStream, Parser};
David Tolnaye3a48152020-04-08 19:38:05 -070014use syn::punctuated::Punctuated;
David Tolnay7db73692019-10-20 14:51:12 -040015use syn::{
Xiangpeng Hao78762352020-11-12 10:24:18 +080016 Abi, Attribute, Error, Expr, Fields, FnArg, ForeignItem, ForeignItemFn, ForeignItemType,
David Tolnayee312322020-12-28 22:04:10 -080017 GenericArgument, GenericParam, Generics, Ident, ItemEnum, ItemImpl, ItemStruct, Lit, LitStr,
18 Pat, PathArguments, Result, ReturnType, Token, TraitBound, TraitBoundModifier,
David Tolnayb7eb65e2020-11-27 20:00:53 -080019 Type as RustType, TypeArray, TypeBareFn, TypeParamBound, TypePath, TypeReference,
David Tolnayd6143702020-12-29 23:48:09 -080020 Variant as RustVariant, Visibility,
David Tolnay7db73692019-10-20 14:51:12 -040021};
22
David Tolnaye3a48152020-04-08 19:38:05 -070023pub mod kw {
David Tolnayb27f7872020-11-15 15:07:04 -080024 syn::custom_keyword!(Pin);
David Tolnaye3a48152020-04-08 19:38:05 -070025 syn::custom_keyword!(Result);
26}
27
David Tolnayd7a3a182020-11-01 20:45:14 -080028pub fn parse_items(
29 cx: &mut Errors,
30 items: Vec<Item>,
31 trusted: bool,
32 namespace: &Namespace,
33) -> Vec<Api> {
David Tolnay7db73692019-10-20 14:51:12 -040034 let mut apis = Vec::new();
35 for item in items {
36 match item {
David Tolnay302b1752020-11-10 18:43:24 -080037 Item::Struct(item) => match parse_struct(cx, item, namespace) {
David Tolnay52759782020-05-03 23:59:40 -070038 Ok(strct) => apis.push(strct),
39 Err(err) => cx.push(err),
40 },
David Tolnay302b1752020-11-10 18:43:24 -080041 Item::Enum(item) => match parse_enum(cx, item, namespace) {
David Tolnay52759782020-05-03 23:59:40 -070042 Ok(enm) => apis.push(enm),
43 Err(err) => cx.push(err),
44 },
Adrian Taylorc8713432020-10-21 18:20:55 -070045 Item::ForeignMod(foreign_mod) => {
David Tolnayd7a3a182020-11-01 20:45:14 -080046 parse_foreign_mod(cx, foreign_mod, &mut apis, trusted, namespace)
Adrian Taylorc8713432020-10-21 18:20:55 -070047 }
David Tolnay313cc0a2020-11-24 21:47:01 -080048 Item::Impl(item) => match parse_impl(item) {
David Tolnay7e69f892020-10-03 22:20:22 -070049 Ok(imp) => apis.push(imp),
50 Err(err) => cx.push(err),
51 },
David Tolnay52759782020-05-03 23:59:40 -070052 Item::Use(item) => cx.error(item, error::USE_NOT_ALLOWED),
David Tolnay00a83852020-08-29 15:06:16 -070053 Item::Other(item) => cx.error(item, "unsupported item"),
David Tolnay7db73692019-10-20 14:51:12 -040054 }
55 }
David Tolnay52759782020-05-03 23:59:40 -070056 apis
David Tolnay7db73692019-10-20 14:51:12 -040057}
58
David Tolnay15a1fc12020-12-30 16:04:56 -080059fn parse_struct(cx: &mut Errors, mut item: ItemStruct, namespace: &Namespace) -> Result<Api> {
60 let attrs = mem::take(&mut item.attrs);
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 Tolnayb129ea72020-05-10 14:29:30 -070066 attrs::parse(
David Tolnay3e628882020-05-10 15:30:14 -070067 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -080068 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();
103 attrs::parse(
104 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 Tolnay89902442020-12-30 15:10:40 -0800126 visibility,
127 ident,
128 ty,
129 });
David Tolnay38c11212020-11-25 15:50:19 -0800130 }
David Tolnay302b1752020-11-10 18:43:24 -0800131
David Tolnay64343af2020-12-30 15:26:06 -0800132 let visibility = Token![pub](match item.vis {
133 Visibility::Public(vis) => vis.pub_token.span,
134 Visibility::Crate(vis) => vis.crate_token.span,
135 Visibility::Restricted(vis) => vis.pub_token.span,
136 Visibility::Inherited => item.ident.span(),
137 });
David Tolnayddbcb522020-12-21 15:24:45 -0800138 let struct_token = item.struct_token;
David Tolnay885be132020-12-21 15:52:47 -0800139 let name = pair(namespace, &item.ident, cxx_name, rust_name);
David Tolnayddbcb522020-12-21 15:24:45 -0800140 let brace_token = named_fields.brace_token;
141
David Tolnay09462ac2020-03-20 14:58:41 -0700142 Ok(Api::Struct(Struct {
143 doc,
144 derives,
David Tolnay64343af2020-12-30 15:26:06 -0800145 visibility,
David Tolnayddbcb522020-12-21 15:24:45 -0800146 struct_token,
147 name,
148 brace_token,
David Tolnay302b1752020-11-10 18:43:24 -0800149 fields,
David Tolnay09462ac2020-03-20 14:58:41 -0700150 }))
David Tolnay7db73692019-10-20 14:51:12 -0400151}
152
David Tolnay302b1752020-11-10 18:43:24 -0800153fn parse_enum(cx: &mut Errors, item: ItemEnum, namespace: &Namespace) -> Result<Api> {
David Tolnayddf69e22020-05-10 22:08:20 -0700154 let mut doc = Doc::new();
David Tolnayfbc46692020-11-27 11:33:29 -0800155 let mut derives = Vec::new();
David Tolnayddf69e22020-05-10 22:08:20 -0700156 let mut repr = None;
David Tolnay302b1752020-11-10 18:43:24 -0800157 let mut namespace = namespace.clone();
David Tolnay885be132020-12-21 15:52:47 -0800158 let mut cxx_name = None;
159 let mut rust_name = None;
David Tolnayddf69e22020-05-10 22:08:20 -0700160 attrs::parse(
161 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -0800162 item.attrs,
David Tolnayddf69e22020-05-10 22:08:20 -0700163 attrs::Parser {
164 doc: Some(&mut doc),
David Tolnayfbc46692020-11-27 11:33:29 -0800165 derives: Some(&mut derives),
David Tolnayddf69e22020-05-10 22:08:20 -0700166 repr: Some(&mut repr),
David Tolnayd7a3a182020-11-01 20:45:14 -0800167 namespace: Some(&mut namespace),
David Tolnay885be132020-12-21 15:52:47 -0800168 cxx_name: Some(&mut cxx_name),
169 rust_name: Some(&mut rust_name),
David Tolnayddf69e22020-05-10 22:08:20 -0700170 ..Default::default()
171 },
172 );
Joel Galensonc03402a2020-04-23 17:31:09 -0700173
David Tolnaybc954d92020-12-21 15:17:10 -0800174 let generics = &item.generics;
175 if !generics.params.is_empty() || generics.where_clause.is_some() {
176 let enum_token = item.enum_token;
177 let ident = &item.ident;
178 let where_clause = &generics.where_clause;
179 let span = quote!(#enum_token #ident #generics #where_clause);
180 return Err(Error::new_spanned(
181 span,
182 "enums with generic parameters are not allowed",
183 ));
184 }
185
Joel Galenson88547732020-05-05 08:23:42 -0700186 let mut variants = Vec::new();
David Tolnayddf69e22020-05-10 22:08:20 -0700187 let mut discriminants = DiscriminantSet::new(repr);
Joel Galenson88547732020-05-05 08:23:42 -0700188 for variant in item.variants {
David Tolnay6bf9ef42020-12-21 16:11:40 -0800189 match parse_variant(cx, variant, &mut discriminants) {
David Tolnay26809232020-12-21 16:06:47 -0800190 Ok(variant) => variants.push(variant),
191 Err(err) => cx.push(err),
Joel Galensonc03402a2020-04-23 17:31:09 -0700192 }
193 }
194
David Tolnaye2e303f2020-05-10 20:52:00 -0700195 let enum_token = item.enum_token;
196 let brace_token = item.brace_token;
197
David Tolnay58eee392020-11-20 20:37:58 -0800198 let explicit_repr = repr.is_some();
David Tolnay0435a812020-05-10 21:58:15 -0700199 let mut repr = U8;
200 match discriminants.inferred_repr() {
201 Ok(inferred) => repr = inferred,
David Tolnaye2e303f2020-05-10 20:52:00 -0700202 Err(err) => {
203 let span = quote_spanned!(brace_token.span=> #enum_token {});
David Tolnay0435a812020-05-10 21:58:15 -0700204 cx.error(span, err);
205 variants.clear();
David Tolnaye2e303f2020-05-10 20:52:00 -0700206 }
David Tolnay0435a812020-05-10 21:58:15 -0700207 }
David Tolnaye2e303f2020-05-10 20:52:00 -0700208
David Tolnay885be132020-12-21 15:52:47 -0800209 let name = pair(namespace, &item.ident, cxx_name, rust_name);
David Tolnayddbcb522020-12-21 15:24:45 -0800210 let repr_ident = Ident::new(repr.as_ref(), Span::call_site());
211 let repr_type = Type::Ident(RustName::new(repr_ident));
David Tolnay9a69d8a2020-11-16 09:16:41 -0800212
Joel Galensonc03402a2020-04-23 17:31:09 -0700213 Ok(Api::Enum(Enum {
214 doc,
David Tolnayfbc46692020-11-27 11:33:29 -0800215 derives,
David Tolnaye2e303f2020-05-10 20:52:00 -0700216 enum_token,
David Tolnayddbcb522020-12-21 15:24:45 -0800217 name,
David Tolnaye2e303f2020-05-10 20:52:00 -0700218 brace_token,
David Tolnay7ae018f2020-05-05 10:11:30 -0700219 variants,
David Tolnaye2e303f2020-05-10 20:52:00 -0700220 repr,
David Tolnay9a69d8a2020-11-16 09:16:41 -0800221 repr_type,
David Tolnay58eee392020-11-20 20:37:58 -0800222 explicit_repr,
Joel Galensonc03402a2020-04-23 17:31:09 -0700223 }))
224}
225
David Tolnay6bf9ef42020-12-21 16:11:40 -0800226fn parse_variant(
227 cx: &mut Errors,
David Tolnay15a1fc12020-12-30 16:04:56 -0800228 mut variant: RustVariant,
David Tolnay6bf9ef42020-12-21 16:11:40 -0800229 discriminants: &mut DiscriminantSet,
230) -> Result<Variant> {
David Tolnay15a1fc12020-12-30 16:04:56 -0800231 let attrs = mem::take(&mut variant.attrs);
David Tolnay4486f722020-12-30 00:01:26 -0800232 let mut doc = Doc::new();
David Tolnay6bf9ef42020-12-21 16:11:40 -0800233 let mut cxx_name = None;
234 let mut rust_name = None;
235 attrs::parse(
236 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -0800237 attrs,
David Tolnay6bf9ef42020-12-21 16:11:40 -0800238 attrs::Parser {
David Tolnay4486f722020-12-30 00:01:26 -0800239 doc: Some(&mut doc),
David Tolnay6bf9ef42020-12-21 16:11:40 -0800240 cxx_name: Some(&mut cxx_name),
241 rust_name: Some(&mut rust_name),
242 ..Default::default()
243 },
244 );
245
David Tolnay26809232020-12-21 16:06:47 -0800246 match variant.fields {
247 Fields::Unit => {}
248 _ => {
249 let msg = "enums with data are not supported yet";
250 return Err(Error::new_spanned(variant, msg));
251 }
252 }
253
254 let expr = variant.discriminant.as_ref().map(|(_, expr)| expr);
255 let try_discriminant = match &expr {
256 Some(lit) => discriminants.insert(lit),
257 None => discriminants.insert_next(),
258 };
259 let discriminant = match try_discriminant {
260 Ok(discriminant) => discriminant,
261 Err(err) => return Err(Error::new_spanned(variant, err)),
262 };
David Tolnaye6f62142020-12-21 16:00:41 -0800263
David Tolnay6bf9ef42020-12-21 16:11:40 -0800264 let name = pair(Namespace::ROOT, &variant.ident, cxx_name, rust_name);
David Tolnay26809232020-12-21 16:06:47 -0800265 let expr = variant.discriminant.map(|(_, expr)| expr);
266
267 Ok(Variant {
David Tolnay4486f722020-12-30 00:01:26 -0800268 doc,
David Tolnaye6f62142020-12-21 16:00:41 -0800269 name,
David Tolnay26809232020-12-21 16:06:47 -0800270 discriminant,
271 expr,
272 })
273}
274
David Tolnay805dca32020-08-29 19:09:55 -0700275fn parse_foreign_mod(
276 cx: &mut Errors,
277 foreign_mod: ItemForeignMod,
278 out: &mut Vec<Api>,
279 trusted: bool,
David Tolnayd7a3a182020-11-01 20:45:14 -0800280 namespace: &Namespace,
David Tolnay805dca32020-08-29 19:09:55 -0700281) {
David Tolnay3a451732020-08-29 18:54:55 -0700282 let lang = match parse_lang(&foreign_mod.abi) {
David Tolnay52759782020-05-03 23:59:40 -0700283 Ok(lang) => lang,
284 Err(err) => return cx.push(err),
285 };
David Tolnay7db73692019-10-20 14:51:12 -0400286
David Tolnay3a451732020-08-29 18:54:55 -0700287 match lang {
288 Lang::Rust => {
David Tolnay805dca32020-08-29 19:09:55 -0700289 if foreign_mod.unsafety.is_some() {
David Tolnay3a451732020-08-29 18:54:55 -0700290 let unsafety = foreign_mod.unsafety;
David Tolnay7be5b1f2020-11-11 10:48:32 -0800291 let abi = &foreign_mod.abi;
David Tolnay3a451732020-08-29 18:54:55 -0700292 let span = quote!(#unsafety #abi);
293 cx.error(span, "extern \"Rust\" block does not need to be unsafe");
294 }
295 }
296 Lang::Cxx => {}
297 }
298
David Tolnay805dca32020-08-29 19:09:55 -0700299 let trusted = trusted || foreign_mod.unsafety.is_some();
300
David Tolnay7feb2642020-11-10 18:49:04 -0800301 let mut namespace = namespace.clone();
302 attrs::parse(
303 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -0800304 foreign_mod.attrs,
David Tolnay7feb2642020-11-10 18:49:04 -0800305 attrs::Parser {
306 namespace: Some(&mut namespace),
307 ..Default::default()
308 },
309 );
310
Joel Galensone1e969d2020-04-21 12:50:20 -0700311 let mut items = Vec::new();
David Tolnay15a1fc12020-12-30 16:04:56 -0800312 for foreign in foreign_mod.items {
Joel Galensone1e969d2020-04-21 12:50:20 -0700313 match foreign {
Adrian Taylorc8713432020-10-21 18:20:55 -0700314 ForeignItem::Type(foreign) => {
David Tolnayf5ead102020-11-24 17:08:05 -0800315 let ety = parse_extern_type(cx, foreign, lang, trusted, &namespace);
316 items.push(ety);
Adrian Taylorc8713432020-10-21 18:20:55 -0700317 }
David Tolnay556738d2020-11-15 13:58:44 -0800318 ForeignItem::Fn(foreign) => {
319 match parse_extern_fn(cx, foreign, lang, trusted, &namespace) {
320 Ok(efn) => items.push(efn),
321 Err(err) => cx.push(err),
322 }
323 }
David Tolnay7db73692019-10-20 14:51:12 -0400324 ForeignItem::Macro(foreign) if foreign.mac.path.is_ident("include") => {
David Tolnay91e87fa2020-05-11 19:10:23 -0700325 match foreign.mac.parse_body_with(parse_include) {
David Tolnay52759782020-05-03 23:59:40 -0700326 Ok(include) => items.push(Api::Include(include)),
327 Err(err) => cx.push(err),
328 }
David Tolnay7db73692019-10-20 14:51:12 -0400329 }
Adrian Taylorc8713432020-10-21 18:20:55 -0700330 ForeignItem::Verbatim(tokens) => {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800331 match parse_extern_verbatim(cx, tokens, lang, trusted, &namespace) {
Adrian Taylorc8713432020-10-21 18:20:55 -0700332 Ok(api) => items.push(api),
333 Err(err) => cx.push(err),
334 }
335 }
David Tolnay52759782020-05-03 23:59:40 -0700336 _ => cx.error(foreign, "unsupported foreign item"),
David Tolnay7db73692019-10-20 14:51:12 -0400337 }
338 }
David Tolnaya1f29c42020-04-22 18:01:38 -0700339
David Tolnay7be5b1f2020-11-11 10:48:32 -0800340 if !trusted
341 && items.iter().any(|api| match api {
342 Api::CxxFunction(efn) => efn.unsafety.is_none(),
343 _ => false,
344 })
345 {
346 cx.error(
347 foreign_mod.abi,
348 "block must be declared `unsafe extern \"C++\"` if it contains any safe-to-call C++ functions",
349 );
350 }
351
David Tolnaya1f29c42020-04-22 18:01:38 -0700352 let mut types = items.iter().filter_map(|item| match item {
David Tolnay17a934c2020-11-02 00:40:04 -0800353 Api::CxxType(ety) | Api::RustType(ety) => Some(&ety.name),
354 Api::TypeAlias(alias) => Some(&alias.name),
David Tolnaya1f29c42020-04-22 18:01:38 -0700355 _ => None,
356 });
357 if let (Some(single_type), None) = (types.next(), types.next()) {
David Tolnaye5a015a2020-05-07 21:54:26 -0700358 let single_type = single_type.clone();
David Tolnaya1f29c42020-04-22 18:01:38 -0700359 for item in &mut items {
360 if let Api::CxxFunction(efn) | Api::RustFunction(efn) = item {
361 if let Some(receiver) = &mut efn.receiver {
David Tolnay2d99b002020-12-21 14:34:35 -0800362 if receiver.ty.rust == "Self" {
363 receiver.ty.rust = single_type.rust.clone();
David Tolnaya1f29c42020-04-22 18:01:38 -0700364 }
365 }
366 }
367 }
368 }
369
David Tolnay52759782020-05-03 23:59:40 -0700370 out.extend(items);
David Tolnay7db73692019-10-20 14:51:12 -0400371}
372
David Tolnay3a451732020-08-29 18:54:55 -0700373fn parse_lang(abi: &Abi) -> Result<Lang> {
David Tolnay7db73692019-10-20 14:51:12 -0400374 let name = match &abi.name {
375 Some(name) => name,
376 None => {
377 return Err(Error::new_spanned(
378 abi,
David Tolnayc72a9f62020-11-11 10:56:26 -0800379 "ABI name is required, extern \"C++\" or extern \"Rust\"",
David Tolnay7db73692019-10-20 14:51:12 -0400380 ));
381 }
382 };
David Tolnayddbcb522020-12-21 15:24:45 -0800383
David Tolnay7db73692019-10-20 14:51:12 -0400384 match name.value().as_str() {
David Tolnayea25ac82020-11-11 10:35:23 -0800385 "C++" => Ok(Lang::Cxx),
David Tolnay7db73692019-10-20 14:51:12 -0400386 "Rust" => Ok(Lang::Rust),
David Tolnay2757ca82020-11-14 15:12:06 -0800387 _ => Err(Error::new_spanned(
388 abi,
389 "unrecognized ABI, requires either \"C++\" or \"Rust\"",
390 )),
David Tolnay7db73692019-10-20 14:51:12 -0400391 }
392}
393
David Tolnay00f236a2020-08-29 19:07:18 -0700394fn parse_extern_type(
395 cx: &mut Errors,
David Tolnay15a1fc12020-12-30 16:04:56 -0800396 foreign_type: ForeignItemType,
David Tolnay00f236a2020-08-29 19:07:18 -0700397 lang: Lang,
398 trusted: bool,
David Tolnay302b1752020-11-10 18:43:24 -0800399 namespace: &Namespace,
David Tolnayf5ead102020-11-24 17:08:05 -0800400) -> Api {
Adrian Taylorc8713432020-10-21 18:20:55 -0700401 let mut doc = Doc::new();
David Tolnay16e26202020-11-27 19:28:37 -0800402 let mut derives = Vec::new();
David Tolnay302b1752020-11-10 18:43:24 -0800403 let mut namespace = namespace.clone();
David Tolnay885be132020-12-21 15:52:47 -0800404 let mut cxx_name = None;
405 let mut rust_name = None;
Adrian Taylorc8713432020-10-21 18:20:55 -0700406 attrs::parse(
407 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -0800408 foreign_type.attrs,
Adrian Taylorc8713432020-10-21 18:20:55 -0700409 attrs::Parser {
410 doc: Some(&mut doc),
David Tolnay16e26202020-11-27 19:28:37 -0800411 derives: Some(&mut derives),
David Tolnayd7a3a182020-11-01 20:45:14 -0800412 namespace: Some(&mut namespace),
David Tolnay885be132020-12-21 15:52:47 -0800413 cxx_name: Some(&mut cxx_name),
414 rust_name: Some(&mut rust_name),
Adrian Taylorc8713432020-10-21 18:20:55 -0700415 ..Default::default()
416 },
417 );
David Tolnayddbcb522020-12-21 15:24:45 -0800418
David Tolnay7db73692019-10-20 14:51:12 -0400419 let type_token = foreign_type.type_token;
David Tolnay885be132020-12-21 15:52:47 -0800420 let name = pair(namespace, &foreign_type.ident, cxx_name, rust_name);
David Tolnayee312322020-12-28 22:04:10 -0800421 let generics = Lifetimes {
422 lt_token: None,
423 lifetimes: Punctuated::new(),
424 gt_token: None,
425 };
David Tolnayddbcb522020-12-21 15:24:45 -0800426 let colon_token = None;
427 let bounds = Vec::new();
David Tolnayc8361022020-08-25 21:57:53 -0700428 let semi_token = foreign_type.semi_token;
David Tolnayddbcb522020-12-21 15:24:45 -0800429
430 (match lang {
David Tolnay295ef6b2020-05-07 16:10:22 -0700431 Lang::Cxx => Api::CxxType,
432 Lang::Rust => Api::RustType,
David Tolnayddbcb522020-12-21 15:24:45 -0800433 })(ExternType {
David Tolnay16e26202020-11-27 19:28:37 -0800434 lang,
David Tolnay7db73692019-10-20 14:51:12 -0400435 doc,
David Tolnay16e26202020-11-27 19:28:37 -0800436 derives,
David Tolnay7db73692019-10-20 14:51:12 -0400437 type_token,
David Tolnayddbcb522020-12-21 15:24:45 -0800438 name,
David Tolnayee312322020-12-28 22:04:10 -0800439 generics,
David Tolnayddbcb522020-12-21 15:24:45 -0800440 colon_token,
441 bounds,
David Tolnayc8361022020-08-25 21:57:53 -0700442 semi_token,
David Tolnay00f236a2020-08-29 19:07:18 -0700443 trusted,
David Tolnayf5ead102020-11-24 17:08:05 -0800444 })
David Tolnay7db73692019-10-20 14:51:12 -0400445}
446
Adrian Taylorc8713432020-10-21 18:20:55 -0700447fn parse_extern_fn(
448 cx: &mut Errors,
David Tolnay15a1fc12020-12-30 16:04:56 -0800449 mut foreign_fn: ForeignItemFn,
Adrian Taylorc8713432020-10-21 18:20:55 -0700450 lang: Lang,
David Tolnay556738d2020-11-15 13:58:44 -0800451 trusted: bool,
David Tolnay302b1752020-11-10 18:43:24 -0800452 namespace: &Namespace,
Adrian Taylorc8713432020-10-21 18:20:55 -0700453) -> Result<Api> {
David Tolnay15a1fc12020-12-30 16:04:56 -0800454 let attrs = mem::take(&mut foreign_fn.attrs);
David Tolnaybc954d92020-12-21 15:17:10 -0800455 let mut doc = Doc::new();
David Tolnaya2dfcbf2020-12-21 15:46:24 -0800456 let mut namespace = namespace.clone();
David Tolnaybc954d92020-12-21 15:17:10 -0800457 let mut cxx_name = None;
458 let mut rust_name = None;
David Tolnaybc954d92020-12-21 15:17:10 -0800459 attrs::parse(
460 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -0800461 attrs,
David Tolnaybc954d92020-12-21 15:17:10 -0800462 attrs::Parser {
463 doc: Some(&mut doc),
David Tolnaya2dfcbf2020-12-21 15:46:24 -0800464 namespace: Some(&mut namespace),
David Tolnaybc954d92020-12-21 15:17:10 -0800465 cxx_name: Some(&mut cxx_name),
466 rust_name: Some(&mut rust_name),
David Tolnaybc954d92020-12-21 15:17:10 -0800467 ..Default::default()
468 },
469 );
470
David Tolnay7db73692019-10-20 14:51:12 -0400471 let generics = &foreign_fn.sig.generics;
David Tolnay9938b642020-11-15 18:11:40 -0800472 if generics.where_clause.is_some()
473 || generics.params.iter().any(|param| match param {
474 GenericParam::Lifetime(lifetime) => !lifetime.bounds.is_empty(),
475 GenericParam::Type(_) | GenericParam::Const(_) => true,
476 })
477 {
David Tolnay7db73692019-10-20 14:51:12 -0400478 return Err(Error::new_spanned(
479 foreign_fn,
480 "extern function with generic parameters is not supported yet",
481 ));
482 }
David Tolnayddbcb522020-12-21 15:24:45 -0800483
David Tolnay7db73692019-10-20 14:51:12 -0400484 if let Some(variadic) = &foreign_fn.sig.variadic {
485 return Err(Error::new_spanned(
486 variadic,
487 "variadic function is not supported yet",
488 ));
489 }
David Tolnayddbcb522020-12-21 15:24:45 -0800490
David Tolnay8de461f2020-11-19 13:46:14 -0800491 if foreign_fn.sig.asyncness.is_some() {
492 return Err(Error::new_spanned(
493 foreign_fn,
494 "async function is not directly supported yet, but see https://cxx.rs/async.html for a working approach",
495 ));
496 }
David Tolnayddbcb522020-12-21 15:24:45 -0800497
David Tolnay80ef0682020-11-19 13:56:07 -0800498 if foreign_fn.sig.constness.is_some() {
499 return Err(Error::new_spanned(
500 foreign_fn,
501 "const extern function is not supported",
502 ));
503 }
David Tolnayddbcb522020-12-21 15:24:45 -0800504
David Tolnay80ef0682020-11-19 13:56:07 -0800505 if let Some(abi) = &foreign_fn.sig.abi {
506 return Err(Error::new_spanned(
507 abi,
508 "explicit ABI on extern function is not supported",
509 ));
510 }
David Tolnay7db73692019-10-20 14:51:12 -0400511
512 let mut receiver = None;
David Tolnaye3a48152020-04-08 19:38:05 -0700513 let mut args = Punctuated::new();
514 for arg in foreign_fn.sig.inputs.pairs() {
515 let (arg, comma) = arg.into_tuple();
David Tolnay7db73692019-10-20 14:51:12 -0400516 match arg {
David Tolnay1dd11a12020-04-22 12:31:48 -0700517 FnArg::Receiver(arg) => {
David Tolnaya1f29c42020-04-22 18:01:38 -0700518 if let Some((ampersand, lifetime)) = &arg.reference {
519 receiver = Some(Receiver {
David Tolnay9c76c392020-11-15 16:07:08 -0800520 pinned: false,
David Tolnaya1f29c42020-04-22 18:01:38 -0700521 ampersand: *ampersand,
522 lifetime: lifetime.clone(),
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800523 mutable: arg.mutability.is_some(),
David Tolnaya1f29c42020-04-22 18:01:38 -0700524 var: arg.self_token,
David Tolnay2d99b002020-12-21 14:34:35 -0800525 ty: RustName::new(Ident::new("Self", arg.self_token.span)),
David Tolnaya1f29c42020-04-22 18:01:38 -0700526 shorthand: true,
David Tolnay9c76c392020-11-15 16:07:08 -0800527 pin_tokens: None,
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800528 mutability: arg.mutability,
David Tolnaya1f29c42020-04-22 18:01:38 -0700529 });
530 continue;
Joel Galensone1e969d2020-04-21 12:50:20 -0700531 }
David Tolnay1dd11a12020-04-22 12:31:48 -0700532 return Err(Error::new_spanned(arg, "unsupported signature"));
David Tolnay7db73692019-10-20 14:51:12 -0400533 }
534 FnArg::Typed(arg) => {
535 let ident = match arg.pat.as_ref() {
536 Pat::Ident(pat) => pat.ident.clone(),
Joel Galensonba676072020-04-27 15:55:45 -0700537 Pat::Wild(pat) => {
David Tolnayb4c14552020-12-29 15:44:19 -0800538 Ident::new(&format!("arg{}", args.len()), pat.underscore_token.span)
Joel Galensonba676072020-04-27 15:55:45 -0700539 }
David Tolnay7db73692019-10-20 14:51:12 -0400540 _ => return Err(Error::new_spanned(arg, "unsupported signature")),
541 };
David Tolnay313cc0a2020-11-24 21:47:01 -0800542 let ty = parse_type(&arg.ty)?;
David Tolnay7db73692019-10-20 14:51:12 -0400543 if ident != "self" {
David Tolnayb4a05c32020-12-30 15:37:01 -0800544 let doc = Doc::new();
David Tolnay89902442020-12-30 15:10:40 -0800545 let visibility = Token![pub](ident.span());
546 args.push_value(Var {
David Tolnayb4a05c32020-12-30 15:37:01 -0800547 doc,
David Tolnay89902442020-12-30 15:10:40 -0800548 visibility,
549 ident,
550 ty,
551 });
David Tolnaye3a48152020-04-08 19:38:05 -0700552 if let Some(comma) = comma {
553 args.push_punct(*comma);
554 }
David Tolnay7db73692019-10-20 14:51:12 -0400555 continue;
556 }
557 if let Type::Ref(reference) = ty {
558 if let Type::Ident(ident) = reference.inner {
559 receiver = Some(Receiver {
David Tolnay9c76c392020-11-15 16:07:08 -0800560 pinned: reference.pinned,
David Tolnayfb6e3862020-04-20 01:33:23 -0700561 ampersand: reference.ampersand,
David Tolnay0bd50fa2020-04-22 15:31:33 -0700562 lifetime: reference.lifetime,
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800563 mutable: reference.mutable,
Adrian Taylorc8713432020-10-21 18:20:55 -0700564 var: Token![self](ident.rust.span()),
David Tolnay05e11cc2020-04-20 02:13:56 -0700565 ty: ident,
David Tolnay62d360c2020-04-22 16:26:21 -0700566 shorthand: false,
David Tolnay9c76c392020-11-15 16:07:08 -0800567 pin_tokens: reference.pin_tokens,
David Tolnay9c4ac2e2020-11-15 21:14:03 -0800568 mutability: reference.mutability,
David Tolnay7db73692019-10-20 14:51:12 -0400569 });
570 continue;
571 }
572 }
573 return Err(Error::new_spanned(arg, "unsupported method receiver"));
574 }
575 }
576 }
David Tolnay59b7ede2020-03-16 00:30:23 -0700577
David Tolnaye3a48152020-04-08 19:38:05 -0700578 let mut throws_tokens = None;
David Tolnay313cc0a2020-11-24 21:47:01 -0800579 let ret = parse_return_type(&foreign_fn.sig.output, &mut throws_tokens)?;
David Tolnaye3a48152020-04-08 19:38:05 -0700580 let throws = throws_tokens.is_some();
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 Tolnay17a934c2020-11-02 00:40:04 -0800594 name,
David Tolnay16448732020-03-18 12:39:36 -0700595 sig: Signature {
David Tolnaybdb576c2020-09-06 23:45:55 -0700596 unsafety,
David Tolnay16448732020-03-18 12:39:36 -0700597 fn_token,
David Tolnay9938b642020-11-15 18:11:40 -0800598 generics,
David Tolnay16448732020-03-18 12:39:36 -0700599 receiver,
600 args,
601 ret,
602 throws,
David Tolnaye3a48152020-04-08 19:38:05 -0700603 paren_token,
604 throws_tokens,
David Tolnay16448732020-03-18 12:39:36 -0700605 },
David Tolnay7db73692019-10-20 14:51:12 -0400606 semi_token,
David Tolnay556738d2020-11-15 13:58:44 -0800607 trusted,
David Tolnay295ef6b2020-05-07 16:10:22 -0700608 }))
David Tolnay7db73692019-10-20 14:51:12 -0400609}
610
Adrian Taylorc8713432020-10-21 18:20:55 -0700611fn parse_extern_verbatim(
612 cx: &mut Errors,
David Tolnay15a1fc12020-12-30 16:04:56 -0800613 tokens: TokenStream,
Adrian Taylorc8713432020-10-21 18:20:55 -0700614 lang: Lang,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800615 trusted: bool,
David Tolnay302b1752020-11-10 18:43:24 -0800616 namespace: &Namespace,
Adrian Taylorc8713432020-10-21 18:20:55 -0700617) -> Result<Api> {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800618 |input: ParseStream| -> Result<Api> {
David Tolnaye2f9ec42020-05-07 16:19:33 -0700619 let attrs = input.call(Attribute::parse_outer)?;
David Tolnayd6143702020-12-29 23:48:09 -0800620 input.parse::<Visibility>()?;
David Tolnaye2f9ec42020-05-07 16:19:33 -0700621 let type_token: Token![type] = match input.parse()? {
622 Some(type_token) => type_token,
623 None => {
624 let span = input.cursor().token_stream();
625 return Err(Error::new_spanned(span, "unsupported foreign item"));
626 }
627 };
628 let ident: Ident = input.parse()?;
David Tolnaye81647f2020-12-28 19:30:01 -0800629 let generics: Generics = input.parse()?;
David Tolnayee312322020-12-28 22:04:10 -0800630 let mut lifetimes = Punctuated::new();
David Tolnaye81647f2020-12-28 19:30:01 -0800631 let mut has_unsupported_generic_param = false;
David Tolnayee312322020-12-28 22:04:10 -0800632 for pair in generics.params.into_pairs() {
633 let (param, punct) = pair.into_tuple();
David Tolnaye81647f2020-12-28 19:30:01 -0800634 match param {
635 GenericParam::Lifetime(param) => {
636 if !param.bounds.is_empty() && !has_unsupported_generic_param {
637 let msg = "lifetime parameter with bounds is not supported yet";
638 cx.error(&param, msg);
639 has_unsupported_generic_param = true;
640 }
David Tolnayee312322020-12-28 22:04:10 -0800641 lifetimes.push_value(param.lifetime);
642 if let Some(punct) = punct {
643 lifetimes.push_punct(punct);
644 }
David Tolnaye81647f2020-12-28 19:30:01 -0800645 }
646 GenericParam::Type(param) => {
647 if !has_unsupported_generic_param {
648 let msg = "extern type with generic type parameter is not supported yet";
649 cx.error(&param, msg);
650 has_unsupported_generic_param = true;
651 }
652 }
653 GenericParam::Const(param) => {
654 if !has_unsupported_generic_param {
655 let msg = "extern type with const generic parameter is not supported yet";
656 cx.error(&param, msg);
657 has_unsupported_generic_param = true;
658 }
659 }
660 }
661 }
David Tolnayee312322020-12-28 22:04:10 -0800662 let lifetimes = Lifetimes {
663 lt_token: generics.lt_token,
664 lifetimes,
665 gt_token: generics.gt_token,
666 };
David Tolnayb7eb65e2020-11-27 20:00:53 -0800667 let lookahead = input.lookahead1();
668 if lookahead.peek(Token![=]) {
669 // type Alias = crate::path::to::Type;
David Tolnaye81647f2020-12-28 19:30:01 -0800670 parse_type_alias(
671 cx, attrs, type_token, ident, lifetimes, input, lang, namespace,
672 )
David Tolnaya870ac72020-12-28 19:48:33 -0800673 } else if lookahead.peek(Token![:]) || lookahead.peek(Token![;]) {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800674 // type Opaque: Bound2 + Bound2;
675 parse_extern_type_bounded(
David Tolnaye81647f2020-12-28 19:30:01 -0800676 cx, attrs, type_token, ident, lifetimes, input, lang, trusted, namespace,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800677 )
678 } else {
679 Err(lookahead.error())
David Tolnaye2f9ec42020-05-07 16:19:33 -0700680 }
681 }
David Tolnay15a1fc12020-12-30 16:04:56 -0800682 .parse2(tokens)
David Tolnayb7eb65e2020-11-27 20:00:53 -0800683}
684
685fn parse_type_alias(
686 cx: &mut Errors,
687 attrs: Vec<Attribute>,
688 type_token: Token![type],
689 ident: Ident,
David Tolnayee312322020-12-28 22:04:10 -0800690 generics: Lifetimes,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800691 input: ParseStream,
692 lang: Lang,
693 namespace: &Namespace,
694) -> Result<Api> {
695 let eq_token: Token![=] = input.parse()?;
696 let ty: RustType = input.parse()?;
697 let semi_token: Token![;] = input.parse()?;
698
699 let mut doc = Doc::new();
700 let mut derives = Vec::new();
701 let mut namespace = namespace.clone();
David Tolnay885be132020-12-21 15:52:47 -0800702 let mut cxx_name = None;
703 let mut rust_name = None;
David Tolnayb7eb65e2020-11-27 20:00:53 -0800704 attrs::parse(
705 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -0800706 attrs,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800707 attrs::Parser {
708 doc: Some(&mut doc),
709 derives: Some(&mut derives),
710 namespace: Some(&mut namespace),
David Tolnay885be132020-12-21 15:52:47 -0800711 cxx_name: Some(&mut cxx_name),
712 rust_name: Some(&mut rust_name),
David Tolnayb7eb65e2020-11-27 20:00:53 -0800713 ..Default::default()
714 },
715 );
716
717 if lang == Lang::Rust {
718 let span = quote!(#type_token #semi_token);
719 let msg = "type alias in extern \"Rust\" block is not supported";
720 return Err(Error::new_spanned(span, msg));
721 }
722
David Tolnay885be132020-12-21 15:52:47 -0800723 let name = pair(namespace, &ident, cxx_name, rust_name);
David Tolnayddbcb522020-12-21 15:24:45 -0800724
David Tolnayb7eb65e2020-11-27 20:00:53 -0800725 Ok(Api::TypeAlias(TypeAlias {
726 doc,
727 derives,
728 type_token,
David Tolnayddbcb522020-12-21 15:24:45 -0800729 name,
David Tolnayee312322020-12-28 22:04:10 -0800730 generics,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800731 eq_token,
732 ty,
733 semi_token,
734 }))
735}
736
737fn parse_extern_type_bounded(
738 cx: &mut Errors,
739 attrs: Vec<Attribute>,
740 type_token: Token![type],
741 ident: Ident,
David Tolnayee312322020-12-28 22:04:10 -0800742 generics: Lifetimes,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800743 input: ParseStream,
744 lang: Lang,
745 trusted: bool,
746 namespace: &Namespace,
747) -> Result<Api> {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800748 let mut bounds = Vec::new();
David Tolnaya870ac72020-12-28 19:48:33 -0800749 let colon_token: Option<Token![:]> = input.parse()?;
750 if colon_token.is_some() {
751 loop {
752 match input.parse()? {
753 TypeParamBound::Trait(TraitBound {
754 paren_token: None,
755 modifier: TraitBoundModifier::None,
756 lifetimes: None,
757 path,
758 }) if if let Some(derive) = path.get_ident().and_then(Derive::from) {
759 bounds.push(derive);
760 true
761 } else {
762 false
763 } => {}
764 bound @ TypeParamBound::Trait(_) | bound @ TypeParamBound::Lifetime(_) => {
765 cx.error(bound, "unsupported trait");
766 }
David Tolnayb7eb65e2020-11-27 20:00:53 -0800767 }
David Tolnayb7eb65e2020-11-27 20:00:53 -0800768
David Tolnaya870ac72020-12-28 19:48:33 -0800769 let lookahead = input.lookahead1();
770 if lookahead.peek(Token![+]) {
771 input.parse::<Token![+]>()?;
772 } else if lookahead.peek(Token![;]) {
773 break;
774 } else {
775 return Err(lookahead.error());
776 }
David Tolnayb7eb65e2020-11-27 20:00:53 -0800777 }
778 }
779 let semi_token: Token![;] = input.parse()?;
780
781 let mut doc = Doc::new();
782 let mut derives = Vec::new();
783 let mut namespace = namespace.clone();
David Tolnay885be132020-12-21 15:52:47 -0800784 let mut cxx_name = None;
785 let mut rust_name = None;
David Tolnayb7eb65e2020-11-27 20:00:53 -0800786 attrs::parse(
787 cx,
David Tolnay15a1fc12020-12-30 16:04:56 -0800788 attrs,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800789 attrs::Parser {
790 doc: Some(&mut doc),
791 derives: Some(&mut derives),
792 namespace: Some(&mut namespace),
David Tolnay885be132020-12-21 15:52:47 -0800793 cxx_name: Some(&mut cxx_name),
794 rust_name: Some(&mut rust_name),
David Tolnayb7eb65e2020-11-27 20:00:53 -0800795 ..Default::default()
796 },
797 );
798
David Tolnay885be132020-12-21 15:52:47 -0800799 let name = pair(namespace, &ident, cxx_name, rust_name);
David Tolnayddbcb522020-12-21 15:24:45 -0800800
801 Ok(match lang {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800802 Lang::Cxx => Api::CxxType,
803 Lang::Rust => Api::RustType,
David Tolnayddbcb522020-12-21 15:24:45 -0800804 }(ExternType {
David Tolnayb7eb65e2020-11-27 20:00:53 -0800805 lang,
806 doc,
807 derives,
808 type_token,
David Tolnayddbcb522020-12-21 15:24:45 -0800809 name,
David Tolnayee312322020-12-28 22:04:10 -0800810 generics,
David Tolnayddbcb522020-12-21 15:24:45 -0800811 colon_token,
David Tolnayb7eb65e2020-11-27 20:00:53 -0800812 bounds,
813 semi_token,
814 trusted,
815 }))
David Tolnaye2f9ec42020-05-07 16:19:33 -0700816}
817
David Tolnay313cc0a2020-11-24 21:47:01 -0800818fn parse_impl(imp: ItemImpl) -> Result<Api> {
David Tolnay7e69f892020-10-03 22:20:22 -0700819 if !imp.items.is_empty() {
820 let mut span = Group::new(Delimiter::Brace, TokenStream::new());
821 span.set_span(imp.brace_token.span);
822 return Err(Error::new_spanned(span, "expected an empty impl block"));
823 }
824
David Tolnay7e69f892020-10-03 22:20:22 -0700825 if let Some((bang, path, for_token)) = &imp.trait_ {
David Tolnay028d3d22020-11-29 18:09:52 -0800826 let self_ty = &imp.self_ty;
David Tolnay7e69f892020-10-03 22:20:22 -0700827 let span = quote!(#bang #path #for_token #self_ty);
828 return Err(Error::new_spanned(
829 span,
830 "unexpected impl, expected something like `impl UniquePtr<T> {}`",
831 ));
832 }
833
834 let generics = &imp.generics;
835 if !generics.params.is_empty() || generics.where_clause.is_some() {
836 return Err(Error::new_spanned(
837 imp,
838 "generic parameters on an impl is not supported",
839 ));
840 }
841
David Tolnay028d3d22020-11-29 18:09:52 -0800842 let mut negative_token = None;
843 let mut self_ty = *imp.self_ty;
844 if let RustType::Verbatim(ty) = &self_ty {
845 let mut iter = ty.clone().into_iter();
846 if let Some(TokenTree::Punct(punct)) = iter.next() {
847 if punct.as_char() == '!' {
848 let ty = iter.collect::<TokenStream>();
849 if !ty.is_empty() {
850 negative_token = Some(Token![!](punct.span()));
851 self_ty = syn::parse2(ty)?;
852 }
853 }
854 }
855 }
856
David Tolnayddbcb522020-12-21 15:24:45 -0800857 let impl_token = imp.impl_token;
858 let negative = negative_token.is_some();
859 let ty = parse_type(&self_ty)?;
860 let brace_token = imp.brace_token;
861
David Tolnay7e69f892020-10-03 22:20:22 -0700862 Ok(Api::Impl(Impl {
David Tolnayddbcb522020-12-21 15:24:45 -0800863 impl_token,
864 negative,
865 ty,
866 brace_token,
David Tolnay028d3d22020-11-29 18:09:52 -0800867 negative_token,
David Tolnay7e69f892020-10-03 22:20:22 -0700868 }))
869}
870
David Tolnayb0cd3272020-10-27 21:32:54 -0700871fn parse_include(input: ParseStream) -> Result<Include> {
David Tolnay91e87fa2020-05-11 19:10:23 -0700872 if input.peek(LitStr) {
David Tolnayb0cd3272020-10-27 21:32:54 -0700873 let lit: LitStr = input.parse()?;
874 let span = lit.span();
875 return Ok(Include {
876 path: lit.value(),
877 kind: IncludeKind::Quoted,
878 begin_span: span,
879 end_span: span,
880 });
David Tolnay91e87fa2020-05-11 19:10:23 -0700881 }
882
883 if input.peek(Token![<]) {
884 let mut path = String::new();
David Tolnayb0cd3272020-10-27 21:32:54 -0700885
David Tolnay2cc2e3a2020-10-28 13:12:35 -0700886 let langle: Token![<] = input.parse()?;
David Tolnay91e87fa2020-05-11 19:10:23 -0700887 while !input.is_empty() && !input.peek(Token![>]) {
888 let token: TokenTree = input.parse()?;
889 match token {
890 TokenTree::Ident(token) => path += &token.to_string(),
891 TokenTree::Literal(token)
892 if token
893 .to_string()
894 .starts_with(|ch: char| ch.is_ascii_digit()) =>
895 {
896 path += &token.to_string();
897 }
898 TokenTree::Punct(token) => path.push(token.as_char()),
899 _ => return Err(Error::new(token.span(), "unexpected token in include path")),
900 }
901 }
David Tolnayb0cd3272020-10-27 21:32:54 -0700902 let rangle: Token![>] = input.parse()?;
David Tolnayb0cd3272020-10-27 21:32:54 -0700903
904 return Ok(Include {
905 path,
906 kind: IncludeKind::Bracketed,
David Tolnay2cc2e3a2020-10-28 13:12:35 -0700907 begin_span: langle.span,
908 end_span: rangle.span,
David Tolnayb0cd3272020-10-27 21:32:54 -0700909 });
David Tolnay91e87fa2020-05-11 19:10:23 -0700910 }
911
912 Err(input.error("expected \"quoted/path/to\" or <bracketed/path/to>"))
913}
914
David Tolnay313cc0a2020-11-24 21:47:01 -0800915fn parse_type(ty: &RustType) -> Result<Type> {
David Tolnay59b7ede2020-03-16 00:30:23 -0700916 match ty {
David Tolnay313cc0a2020-11-24 21:47:01 -0800917 RustType::Reference(ty) => parse_type_reference(ty),
918 RustType::Path(ty) => parse_type_path(ty),
David Tolnay313cc0a2020-11-24 21:47:01 -0800919 RustType::Array(ty) => parse_type_array(ty),
920 RustType::BareFn(ty) => parse_type_fn(ty),
David Tolnayb40b9db2020-03-18 13:50:31 -0700921 RustType::Tuple(ty) if ty.elems.is_empty() => Ok(Type::Void(ty.paren_token.span)),
922 _ => Err(Error::new_spanned(ty, "unsupported type")),
923 }
924}
925
David Tolnay313cc0a2020-11-24 21:47:01 -0800926fn parse_type_reference(ty: &TypeReference) -> Result<Type> {
David Tolnayddbcb522020-12-21 15:24:45 -0800927 let ampersand = ty.and_token;
928 let lifetime = ty.lifetime.clone();
929 let mutable = ty.mutability.is_some();
930 let mutability = ty.mutability;
931
David Tolnaye0dca7b2020-11-25 17:18:57 -0800932 if let RustType::Slice(slice) = ty.elem.as_ref() {
933 let inner = parse_type(&slice.elem)?;
David Tolnayddbcb522020-12-21 15:24:45 -0800934 let bracket = slice.bracket_token;
David Tolnay69db8142020-11-25 17:49:25 -0800935 return Ok(Type::SliceRef(Box::new(SliceRef {
David Tolnayddbcb522020-12-21 15:24:45 -0800936 ampersand,
937 lifetime,
938 mutable,
939 bracket,
David Tolnay69db8142020-11-25 17:49:25 -0800940 inner,
David Tolnayddbcb522020-12-21 15:24:45 -0800941 mutability,
David Tolnay69db8142020-11-25 17:49:25 -0800942 })));
David Tolnaye0dca7b2020-11-25 17:18:57 -0800943 }
944
David Tolnay313cc0a2020-11-24 21:47:01 -0800945 let inner = parse_type(&ty.elem)?;
David Tolnayddbcb522020-12-21 15:24:45 -0800946 let pinned = false;
947 let pin_tokens = None;
948
949 Ok(match &inner {
Adrian Taylorc8713432020-10-21 18:20:55 -0700950 Type::Ident(ident) if ident.rust == "str" => {
David Tolnayb40b9db2020-03-18 13:50:31 -0700951 if ty.mutability.is_some() {
952 return Err(Error::new_spanned(ty, "unsupported type"));
953 } else {
954 Type::Str
David Tolnay7db73692019-10-20 14:51:12 -0400955 }
956 }
David Tolnayb40b9db2020-03-18 13:50:31 -0700957 _ => Type::Ref,
David Tolnayddbcb522020-12-21 15:24:45 -0800958 }(Box::new(Ref {
959 pinned,
960 ampersand,
961 lifetime,
962 mutable,
David Tolnayb40b9db2020-03-18 13:50:31 -0700963 inner,
David Tolnayddbcb522020-12-21 15:24:45 -0800964 pin_tokens,
965 mutability,
David Tolnayb40b9db2020-03-18 13:50:31 -0700966 })))
967}
968
David Tolnay313cc0a2020-11-24 21:47:01 -0800969fn parse_type_path(ty: &TypePath) -> Result<Type> {
David Tolnayb40b9db2020-03-18 13:50:31 -0700970 let path = &ty.path;
971 if ty.qself.is_none() && path.leading_colon.is_none() && path.segments.len() == 1 {
972 let segment = &path.segments[0];
973 let ident = segment.ident.clone();
974 match &segment.arguments {
David Tolnay75ea17c2020-12-06 21:08:34 -0800975 PathArguments::None => return Ok(Type::Ident(RustName::new(ident))),
David Tolnayb40b9db2020-03-18 13:50:31 -0700976 PathArguments::AngleBracketed(generic) => {
977 if ident == "UniquePtr" && generic.args.len() == 1 {
978 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnay313cc0a2020-11-24 21:47:01 -0800979 let inner = parse_type(arg)?;
David Tolnayb40b9db2020-03-18 13:50:31 -0700980 return Ok(Type::UniquePtr(Box::new(Ty1 {
David Tolnayda71ef62020-11-02 00:36:00 -0800981 name: ident,
David Tolnayb40b9db2020-03-18 13:50:31 -0700982 langle: generic.lt_token,
983 inner,
984 rangle: generic.gt_token,
985 })));
986 }
David Tolnayb3b24a12020-12-01 15:27:43 -0800987 } else if ident == "SharedPtr" && generic.args.len() == 1 {
988 if let GenericArgument::Type(arg) = &generic.args[0] {
989 let inner = parse_type(arg)?;
990 return Ok(Type::SharedPtr(Box::new(Ty1 {
991 name: ident,
992 langle: generic.lt_token,
993 inner,
994 rangle: generic.gt_token,
995 })));
996 }
David Tolnay215e77f2020-12-28 17:09:48 -0800997 } else if ident == "WeakPtr" && generic.args.len() == 1 {
998 if let GenericArgument::Type(arg) = &generic.args[0] {
999 let inner = parse_type(arg)?;
1000 return Ok(Type::WeakPtr(Box::new(Ty1 {
1001 name: ident,
1002 langle: generic.lt_token,
1003 inner,
1004 rangle: generic.gt_token,
1005 })));
1006 }
David Tolnaye1dcdf72020-04-24 17:40:55 -07001007 } else if ident == "CxxVector" && generic.args.len() == 1 {
Myron Ahneba35cf2020-02-05 19:41:51 +07001008 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnay313cc0a2020-11-24 21:47:01 -08001009 let inner = parse_type(arg)?;
David Tolnay4377a9e2020-04-24 15:20:26 -07001010 return Ok(Type::CxxVector(Box::new(Ty1 {
David Tolnayda71ef62020-11-02 00:36:00 -08001011 name: ident,
Myron Ahneba35cf2020-02-05 19:41:51 +07001012 langle: generic.lt_token,
1013 inner,
1014 rangle: generic.gt_token,
1015 })));
1016 }
David Tolnayb40b9db2020-03-18 13:50:31 -07001017 } else if ident == "Box" && generic.args.len() == 1 {
1018 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnay313cc0a2020-11-24 21:47:01 -08001019 let inner = parse_type(arg)?;
David Tolnayb40b9db2020-03-18 13:50:31 -07001020 return Ok(Type::RustBox(Box::new(Ty1 {
David Tolnayda71ef62020-11-02 00:36:00 -08001021 name: ident,
David Tolnayb40b9db2020-03-18 13:50:31 -07001022 langle: generic.lt_token,
1023 inner,
1024 rangle: generic.gt_token,
1025 })));
1026 }
Myron Ahneba35cf2020-02-05 19:41:51 +07001027 } else if ident == "Vec" && generic.args.len() == 1 {
1028 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnay313cc0a2020-11-24 21:47:01 -08001029 let inner = parse_type(arg)?;
Myron Ahneba35cf2020-02-05 19:41:51 +07001030 return Ok(Type::RustVec(Box::new(Ty1 {
David Tolnayda71ef62020-11-02 00:36:00 -08001031 name: ident,
Myron Ahneba35cf2020-02-05 19:41:51 +07001032 langle: generic.lt_token,
1033 inner,
1034 rangle: generic.gt_token,
1035 })));
1036 }
David Tolnaycbc2a4b2020-11-15 15:08:44 -08001037 } else if ident == "Pin" && generic.args.len() == 1 {
1038 if let GenericArgument::Type(arg) = &generic.args[0] {
David Tolnay313cc0a2020-11-24 21:47:01 -08001039 let inner = parse_type(arg)?;
David Tolnayc94035a2020-11-15 16:49:18 -08001040 let pin_token = kw::Pin(ident.span());
David Tolnaycbc2a4b2020-11-15 15:08:44 -08001041 if let Type::Ref(mut inner) = inner {
David Tolnaycbc2a4b2020-11-15 15:08:44 -08001042 inner.pinned = true;
1043 inner.pin_tokens =
1044 Some((pin_token, generic.lt_token, generic.gt_token));
1045 return Ok(Type::Ref(inner));
1046 }
1047 }
David Tolnayb40b9db2020-03-18 13:50:31 -07001048 }
1049 }
1050 PathArguments::Parenthesized(_) => {}
David Tolnayfb134ed2020-03-15 23:17:48 -07001051 }
David Tolnay7db73692019-10-20 14:51:12 -04001052 }
David Tolnayddbcb522020-12-21 15:24:45 -08001053
David Tolnay7db73692019-10-20 14:51:12 -04001054 Err(Error::new_spanned(ty, "unsupported type"))
1055}
1056
David Tolnay313cc0a2020-11-24 21:47:01 -08001057fn parse_type_array(ty: &TypeArray) -> Result<Type> {
1058 let inner = parse_type(&ty.elem)?;
David Tolnayd9f97842020-11-24 21:00:05 -08001059
1060 let len_expr = if let Expr::Lit(lit) = &ty.len {
1061 lit
1062 } else {
1063 let msg = "unsupported expression, array length must be an integer literal";
1064 return Err(Error::new_spanned(&ty.len, msg));
1065 };
1066
1067 let len_token = if let Lit::Int(int) = &len_expr.lit {
1068 int.clone()
1069 } else {
1070 let msg = "array length must be an integer literal";
1071 return Err(Error::new_spanned(len_expr, msg));
1072 };
1073
David Tolnay581f72d2020-11-25 15:48:59 -08001074 let len = len_token.base10_parse::<usize>()?;
1075 if len == 0 {
1076 let msg = "array with zero size is not supported";
1077 return Err(Error::new_spanned(ty, msg));
1078 }
1079
David Tolnayd9f97842020-11-24 21:00:05 -08001080 let bracket = ty.bracket_token;
1081 let semi_token = ty.semi_token;
David Tolnayd9f97842020-11-24 21:00:05 -08001082
1083 Ok(Type::Array(Box::new(Array {
1084 bracket,
1085 inner,
1086 semi_token,
1087 len,
1088 len_token,
1089 })))
David Tolnay2d0df232020-11-24 20:50:32 -08001090}
1091
David Tolnay313cc0a2020-11-24 21:47:01 -08001092fn parse_type_fn(ty: &TypeBareFn) -> Result<Type> {
David Tolnayc071b892020-03-18 16:59:53 -07001093 if ty.lifetimes.is_some() {
1094 return Err(Error::new_spanned(
1095 ty,
1096 "function pointer with lifetime parameters is not supported yet",
1097 ));
1098 }
David Tolnayddbcb522020-12-21 15:24:45 -08001099
David Tolnayc071b892020-03-18 16:59:53 -07001100 if ty.variadic.is_some() {
1101 return Err(Error::new_spanned(
1102 ty,
1103 "variadic function pointer is not supported yet",
1104 ));
1105 }
David Tolnayddbcb522020-12-21 15:24:45 -08001106
David Tolnayc071b892020-03-18 16:59:53 -07001107 let args = ty
1108 .inputs
1109 .iter()
1110 .enumerate()
1111 .map(|(i, arg)| {
David Tolnay313cc0a2020-11-24 21:47:01 -08001112 let ty = parse_type(&arg.ty)?;
David Tolnayc071b892020-03-18 16:59:53 -07001113 let ident = match &arg.name {
1114 Some(ident) => ident.0.clone(),
David Tolnayb4c14552020-12-29 15:44:19 -08001115 None => format_ident!("arg{}", i),
David Tolnayc071b892020-03-18 16:59:53 -07001116 };
David Tolnayb4a05c32020-12-30 15:37:01 -08001117 let doc = Doc::new();
David Tolnay89902442020-12-30 15:10:40 -08001118 let visibility = Token![pub](ident.span());
1119 Ok(Var {
David Tolnayb4a05c32020-12-30 15:37:01 -08001120 doc,
David Tolnay89902442020-12-30 15:10:40 -08001121 visibility,
1122 ident,
1123 ty,
1124 })
David Tolnayc071b892020-03-18 16:59:53 -07001125 })
1126 .collect::<Result<_>>()?;
David Tolnayddbcb522020-12-21 15:24:45 -08001127
David Tolnaye3a48152020-04-08 19:38:05 -07001128 let mut throws_tokens = None;
David Tolnay313cc0a2020-11-24 21:47:01 -08001129 let ret = parse_return_type(&ty.output, &mut throws_tokens)?;
David Tolnaye3a48152020-04-08 19:38:05 -07001130 let throws = throws_tokens.is_some();
David Tolnayddbcb522020-12-21 15:24:45 -08001131
1132 let unsafety = ty.unsafety;
1133 let fn_token = ty.fn_token;
1134 let generics = Generics::default();
1135 let receiver = None;
1136 let paren_token = ty.paren_token;
1137
David Tolnayc071b892020-03-18 16:59:53 -07001138 Ok(Type::Fn(Box::new(Signature {
David Tolnayddbcb522020-12-21 15:24:45 -08001139 unsafety,
1140 fn_token,
1141 generics,
1142 receiver,
David Tolnayc071b892020-03-18 16:59:53 -07001143 args,
1144 ret,
1145 throws,
David Tolnayddbcb522020-12-21 15:24:45 -08001146 paren_token,
David Tolnaye3a48152020-04-08 19:38:05 -07001147 throws_tokens,
David Tolnayc071b892020-03-18 16:59:53 -07001148 })))
1149}
1150
David Tolnaye3a48152020-04-08 19:38:05 -07001151fn parse_return_type(
1152 ty: &ReturnType,
1153 throws_tokens: &mut Option<(kw::Result, Token![<], Token![>])>,
1154) -> Result<Option<Type>> {
David Tolnayc071b892020-03-18 16:59:53 -07001155 let mut ret = match ty {
1156 ReturnType::Default => return Ok(None),
1157 ReturnType::Type(_, ret) => ret.as_ref(),
1158 };
David Tolnayddbcb522020-12-21 15:24:45 -08001159
David Tolnayc071b892020-03-18 16:59:53 -07001160 if let RustType::Path(ty) = ret {
1161 let path = &ty.path;
1162 if ty.qself.is_none() && path.leading_colon.is_none() && path.segments.len() == 1 {
1163 let segment = &path.segments[0];
1164 let ident = segment.ident.clone();
1165 if let PathArguments::AngleBracketed(generic) = &segment.arguments {
1166 if ident == "Result" && generic.args.len() == 1 {
1167 if let GenericArgument::Type(arg) = &generic.args[0] {
1168 ret = arg;
David Tolnaye3a48152020-04-08 19:38:05 -07001169 *throws_tokens =
1170 Some((kw::Result(ident.span()), generic.lt_token, generic.gt_token));
David Tolnayc071b892020-03-18 16:59:53 -07001171 }
1172 }
1173 }
1174 }
1175 }
David Tolnayddbcb522020-12-21 15:24:45 -08001176
David Tolnay313cc0a2020-11-24 21:47:01 -08001177 match parse_type(ret)? {
David Tolnayc071b892020-03-18 16:59:53 -07001178 Type::Void(_) => Ok(None),
1179 ty => Ok(Some(ty)),
1180 }
1181}
David Tolnay6a990f82020-12-21 15:42:31 -08001182
1183fn pair(namespace: Namespace, default: &Ident, cxx: Option<Ident>, rust: Option<Ident>) -> Pair {
1184 let default = || default.clone();
David Tolnayc2a4c782020-12-21 15:55:31 -08001185 Pair {
David Tolnay6a990f82020-12-21 15:42:31 -08001186 namespace,
David Tolnayc2a4c782020-12-21 15:55:31 -08001187 cxx: cxx.unwrap_or_else(default),
1188 rust: rust.unwrap_or_else(default),
1189 }
David Tolnay6a990f82020-12-21 15:42:31 -08001190}