| David Tolnay | 7db7369 | 2019-10-20 14:51:12 -0400 | [diff] [blame] | 1 | use crate::syntax::{ |
| David Tolnay | 1644873 | 2020-03-18 12:39:36 -0700 | [diff] [blame] | 2 | attrs, error, Api, Atom, Doc, ExternFn, ExternType, Lang, Receiver, Ref, Signature, Struct, |
| 3 | Ty1, Type, Var, |
| David Tolnay | 7db7369 | 2019-10-20 14:51:12 -0400 | [diff] [blame] | 4 | }; |
| 5 | use proc_macro2::Ident; |
| David Tolnay | c071b89 | 2020-03-18 16:59:53 -0700 | [diff] [blame] | 6 | use quote::{format_ident, quote}; |
| David Tolnay | 7db7369 | 2019-10-20 14:51:12 -0400 | [diff] [blame] | 7 | use syn::{ |
| 8 | Abi, Error, Fields, FnArg, ForeignItem, ForeignItemFn, ForeignItemType, GenericArgument, Item, |
| David Tolnay | c071b89 | 2020-03-18 16:59:53 -0700 | [diff] [blame] | 9 | ItemForeignMod, ItemStruct, Pat, PathArguments, Result, ReturnType, Type as RustType, |
| 10 | TypeBareFn, TypePath, TypeReference, |
| David Tolnay | 7db7369 | 2019-10-20 14:51:12 -0400 | [diff] [blame] | 11 | }; |
| 12 | |
| David Tolnay | 7db7369 | 2019-10-20 14:51:12 -0400 | [diff] [blame] | 13 | pub fn parse_items(items: Vec<Item>) -> Result<Vec<Api>> { |
| 14 | let mut apis = Vec::new(); |
| 15 | for item in items { |
| 16 | match item { |
| 17 | Item::Struct(item) => { |
| 18 | let strct = parse_struct(item)?; |
| 19 | apis.push(strct); |
| 20 | } |
| 21 | Item::ForeignMod(foreign_mod) => { |
| 22 | let functions = parse_foreign_mod(foreign_mod)?; |
| 23 | apis.extend(functions); |
| 24 | } |
| 25 | Item::Use(item) => return Err(Error::new_spanned(item, error::USE_NOT_ALLOWED)), |
| 26 | _ => return Err(Error::new_spanned(item, "unsupported item")), |
| 27 | } |
| 28 | } |
| 29 | Ok(apis) |
| 30 | } |
| 31 | |
| 32 | fn parse_struct(item: ItemStruct) -> Result<Api> { |
| 33 | let generics = &item.generics; |
| 34 | if !generics.params.is_empty() || generics.where_clause.is_some() { |
| 35 | let struct_token = item.struct_token; |
| 36 | let ident = &item.ident; |
| 37 | let where_clause = &generics.where_clause; |
| 38 | let span = quote!(#struct_token #ident #generics #where_clause); |
| 39 | return Err(Error::new_spanned( |
| 40 | span, |
| 41 | "struct with generic parameters is not supported yet", |
| 42 | )); |
| 43 | } |
| 44 | |
| 45 | let mut doc = Doc::new(); |
| 46 | let mut derives = Vec::new(); |
| 47 | attrs::parse(&item.attrs, &mut doc, Some(&mut derives))?; |
| 48 | check_reserved_name(&item.ident)?; |
| David Tolnay | 09462ac | 2020-03-20 14:58:41 -0700 | [diff] [blame^] | 49 | |
| 50 | let fields = match item.fields { |
| 51 | Fields::Named(fields) => fields, |
| 52 | Fields::Unit => return Err(Error::new_spanned(item, "unit structs are not supported")), |
| 53 | Fields::Unnamed(_) => { |
| 54 | return Err(Error::new_spanned(item, "tuple structs are not supported")) |
| 55 | } |
| 56 | }; |
| 57 | |
| 58 | Ok(Api::Struct(Struct { |
| 59 | doc, |
| 60 | derives, |
| 61 | struct_token: item.struct_token, |
| 62 | ident: item.ident, |
| 63 | brace_token: fields.brace_token, |
| 64 | fields: fields |
| 65 | .named |
| 66 | .into_iter() |
| 67 | .map(|field| { |
| 68 | Ok(Var { |
| 69 | ident: field.ident.unwrap(), |
| 70 | ty: parse_type(&field.ty)?, |
| David Tolnay | 7db7369 | 2019-10-20 14:51:12 -0400 | [diff] [blame] | 71 | }) |
| David Tolnay | 09462ac | 2020-03-20 14:58:41 -0700 | [diff] [blame^] | 72 | }) |
| 73 | .collect::<Result<_>>()?, |
| 74 | })) |
| David Tolnay | 7db7369 | 2019-10-20 14:51:12 -0400 | [diff] [blame] | 75 | } |
| 76 | |
| 77 | fn parse_foreign_mod(foreign_mod: ItemForeignMod) -> Result<Vec<Api>> { |
| 78 | let lang = parse_lang(foreign_mod.abi)?; |
| 79 | let api_type = match lang { |
| 80 | Lang::Cxx => Api::CxxType, |
| 81 | Lang::Rust => Api::RustType, |
| 82 | }; |
| 83 | let api_function = match lang { |
| 84 | Lang::Cxx => Api::CxxFunction, |
| 85 | Lang::Rust => Api::RustFunction, |
| 86 | }; |
| 87 | |
| 88 | let mut items = Vec::new(); |
| 89 | for foreign in &foreign_mod.items { |
| 90 | match foreign { |
| 91 | ForeignItem::Type(foreign) => { |
| 92 | check_reserved_name(&foreign.ident)?; |
| 93 | let ety = parse_extern_type(foreign)?; |
| 94 | items.push(api_type(ety)); |
| 95 | } |
| 96 | ForeignItem::Fn(foreign) => { |
| David Tolnay | 6cde49f | 2020-03-16 12:25:45 -0700 | [diff] [blame] | 97 | let efn = parse_extern_fn(foreign, lang)?; |
| David Tolnay | 7db7369 | 2019-10-20 14:51:12 -0400 | [diff] [blame] | 98 | items.push(api_function(efn)); |
| 99 | } |
| 100 | ForeignItem::Macro(foreign) if foreign.mac.path.is_ident("include") => { |
| 101 | let include = foreign.mac.parse_body()?; |
| 102 | items.push(Api::Include(include)); |
| 103 | } |
| 104 | _ => return Err(Error::new_spanned(foreign, "unsupported foreign item")), |
| 105 | } |
| 106 | } |
| 107 | Ok(items) |
| 108 | } |
| 109 | |
| 110 | fn parse_lang(abi: Abi) -> Result<Lang> { |
| 111 | let name = match &abi.name { |
| 112 | Some(name) => name, |
| 113 | None => { |
| 114 | return Err(Error::new_spanned( |
| 115 | abi, |
| 116 | "ABI name is required, extern \"C\" or extern \"Rust\"", |
| 117 | )); |
| 118 | } |
| 119 | }; |
| 120 | match name.value().as_str() { |
| David Tolnay | 0b76aea | 2020-03-18 12:54:24 -0700 | [diff] [blame] | 121 | "C" | "C++" => Ok(Lang::Cxx), |
| David Tolnay | 7db7369 | 2019-10-20 14:51:12 -0400 | [diff] [blame] | 122 | "Rust" => Ok(Lang::Rust), |
| 123 | _ => Err(Error::new_spanned(abi, "unrecognized ABI")), |
| 124 | } |
| 125 | } |
| 126 | |
| 127 | fn parse_extern_type(foreign_type: &ForeignItemType) -> Result<ExternType> { |
| 128 | let doc = attrs::parse_doc(&foreign_type.attrs)?; |
| 129 | let type_token = foreign_type.type_token; |
| 130 | let ident = foreign_type.ident.clone(); |
| 131 | Ok(ExternType { |
| 132 | doc, |
| 133 | type_token, |
| 134 | ident, |
| 135 | }) |
| 136 | } |
| 137 | |
| David Tolnay | 6cde49f | 2020-03-16 12:25:45 -0700 | [diff] [blame] | 138 | fn parse_extern_fn(foreign_fn: &ForeignItemFn, lang: Lang) -> Result<ExternFn> { |
| David Tolnay | 7db7369 | 2019-10-20 14:51:12 -0400 | [diff] [blame] | 139 | let generics = &foreign_fn.sig.generics; |
| 140 | if !generics.params.is_empty() || generics.where_clause.is_some() { |
| 141 | return Err(Error::new_spanned( |
| 142 | foreign_fn, |
| 143 | "extern function with generic parameters is not supported yet", |
| 144 | )); |
| 145 | } |
| 146 | if let Some(variadic) = &foreign_fn.sig.variadic { |
| 147 | return Err(Error::new_spanned( |
| 148 | variadic, |
| 149 | "variadic function is not supported yet", |
| 150 | )); |
| 151 | } |
| 152 | |
| 153 | let mut receiver = None; |
| 154 | let mut args = Vec::new(); |
| 155 | for arg in &foreign_fn.sig.inputs { |
| 156 | match arg { |
| 157 | FnArg::Receiver(receiver) => { |
| 158 | return Err(Error::new_spanned(receiver, "unsupported signature")) |
| 159 | } |
| 160 | FnArg::Typed(arg) => { |
| 161 | let ident = match arg.pat.as_ref() { |
| 162 | Pat::Ident(pat) => pat.ident.clone(), |
| 163 | _ => return Err(Error::new_spanned(arg, "unsupported signature")), |
| 164 | }; |
| 165 | let ty = parse_type(&arg.ty)?; |
| 166 | if ident != "self" { |
| 167 | args.push(Var { ident, ty }); |
| 168 | continue; |
| 169 | } |
| 170 | if let Type::Ref(reference) = ty { |
| 171 | if let Type::Ident(ident) = reference.inner { |
| 172 | receiver = Some(Receiver { |
| 173 | mutability: reference.mutability, |
| 174 | ident, |
| 175 | }); |
| 176 | continue; |
| 177 | } |
| 178 | } |
| 179 | return Err(Error::new_spanned(arg, "unsupported method receiver")); |
| 180 | } |
| 181 | } |
| 182 | } |
| David Tolnay | 59b7ede | 2020-03-16 00:30:23 -0700 | [diff] [blame] | 183 | |
| 184 | let mut throws = false; |
| David Tolnay | c071b89 | 2020-03-18 16:59:53 -0700 | [diff] [blame] | 185 | let ret = parse_return_type(&foreign_fn.sig.output, &mut throws)?; |
| David Tolnay | 7db7369 | 2019-10-20 14:51:12 -0400 | [diff] [blame] | 186 | let doc = attrs::parse_doc(&foreign_fn.attrs)?; |
| 187 | let fn_token = foreign_fn.sig.fn_token; |
| 188 | let ident = foreign_fn.sig.ident.clone(); |
| David Tolnay | d95b119 | 2020-03-18 20:07:46 -0700 | [diff] [blame] | 189 | let mut foreign_fn2 = foreign_fn.clone(); |
| 190 | foreign_fn2.attrs.clear(); |
| 191 | let tokens = quote!(#foreign_fn2); |
| David Tolnay | 7db7369 | 2019-10-20 14:51:12 -0400 | [diff] [blame] | 192 | let semi_token = foreign_fn.semi_token; |
| David Tolnay | d95b119 | 2020-03-18 20:07:46 -0700 | [diff] [blame] | 193 | |
| David Tolnay | 7db7369 | 2019-10-20 14:51:12 -0400 | [diff] [blame] | 194 | Ok(ExternFn { |
| David Tolnay | 6cde49f | 2020-03-16 12:25:45 -0700 | [diff] [blame] | 195 | lang, |
| David Tolnay | 7db7369 | 2019-10-20 14:51:12 -0400 | [diff] [blame] | 196 | doc, |
| David Tolnay | 7db7369 | 2019-10-20 14:51:12 -0400 | [diff] [blame] | 197 | ident, |
| David Tolnay | 1644873 | 2020-03-18 12:39:36 -0700 | [diff] [blame] | 198 | sig: Signature { |
| 199 | fn_token, |
| 200 | receiver, |
| 201 | args, |
| 202 | ret, |
| 203 | throws, |
| David Tolnay | d95b119 | 2020-03-18 20:07:46 -0700 | [diff] [blame] | 204 | tokens, |
| David Tolnay | 1644873 | 2020-03-18 12:39:36 -0700 | [diff] [blame] | 205 | }, |
| David Tolnay | 7db7369 | 2019-10-20 14:51:12 -0400 | [diff] [blame] | 206 | semi_token, |
| 207 | }) |
| 208 | } |
| 209 | |
| 210 | fn parse_type(ty: &RustType) -> Result<Type> { |
| David Tolnay | 59b7ede | 2020-03-16 00:30:23 -0700 | [diff] [blame] | 211 | match ty { |
| David Tolnay | b40b9db | 2020-03-18 13:50:31 -0700 | [diff] [blame] | 212 | RustType::Reference(ty) => parse_type_reference(ty), |
| 213 | RustType::Path(ty) => parse_type_path(ty), |
| David Tolnay | c071b89 | 2020-03-18 16:59:53 -0700 | [diff] [blame] | 214 | RustType::BareFn(ty) => parse_type_fn(ty), |
| David Tolnay | b40b9db | 2020-03-18 13:50:31 -0700 | [diff] [blame] | 215 | RustType::Tuple(ty) if ty.elems.is_empty() => Ok(Type::Void(ty.paren_token.span)), |
| 216 | _ => Err(Error::new_spanned(ty, "unsupported type")), |
| 217 | } |
| 218 | } |
| 219 | |
| 220 | fn parse_type_reference(ty: &TypeReference) -> Result<Type> { |
| 221 | let inner = parse_type(&ty.elem)?; |
| 222 | let which = match &inner { |
| 223 | Type::Ident(ident) if ident == "str" => { |
| 224 | if ty.mutability.is_some() { |
| 225 | return Err(Error::new_spanned(ty, "unsupported type")); |
| 226 | } else { |
| 227 | Type::Str |
| David Tolnay | 7db7369 | 2019-10-20 14:51:12 -0400 | [diff] [blame] | 228 | } |
| 229 | } |
| David Tolnay | b40b9db | 2020-03-18 13:50:31 -0700 | [diff] [blame] | 230 | _ => Type::Ref, |
| 231 | }; |
| 232 | Ok(which(Box::new(Ref { |
| 233 | ampersand: ty.and_token, |
| 234 | mutability: ty.mutability, |
| 235 | inner, |
| 236 | }))) |
| 237 | } |
| 238 | |
| 239 | fn parse_type_path(ty: &TypePath) -> Result<Type> { |
| 240 | let path = &ty.path; |
| 241 | if ty.qself.is_none() && path.leading_colon.is_none() && path.segments.len() == 1 { |
| 242 | let segment = &path.segments[0]; |
| 243 | let ident = segment.ident.clone(); |
| 244 | match &segment.arguments { |
| 245 | PathArguments::None => return Ok(Type::Ident(ident)), |
| 246 | PathArguments::AngleBracketed(generic) => { |
| 247 | if ident == "UniquePtr" && generic.args.len() == 1 { |
| 248 | if let GenericArgument::Type(arg) = &generic.args[0] { |
| 249 | let inner = parse_type(arg)?; |
| 250 | return Ok(Type::UniquePtr(Box::new(Ty1 { |
| 251 | name: ident, |
| 252 | langle: generic.lt_token, |
| 253 | inner, |
| 254 | rangle: generic.gt_token, |
| 255 | }))); |
| 256 | } |
| 257 | } else if ident == "Box" && generic.args.len() == 1 { |
| 258 | if let GenericArgument::Type(arg) = &generic.args[0] { |
| 259 | let inner = parse_type(arg)?; |
| 260 | return Ok(Type::RustBox(Box::new(Ty1 { |
| 261 | name: ident, |
| 262 | langle: generic.lt_token, |
| 263 | inner, |
| 264 | rangle: generic.gt_token, |
| 265 | }))); |
| 266 | } |
| 267 | } |
| 268 | } |
| 269 | PathArguments::Parenthesized(_) => {} |
| David Tolnay | fb134ed | 2020-03-15 23:17:48 -0700 | [diff] [blame] | 270 | } |
| David Tolnay | 7db7369 | 2019-10-20 14:51:12 -0400 | [diff] [blame] | 271 | } |
| 272 | Err(Error::new_spanned(ty, "unsupported type")) |
| 273 | } |
| 274 | |
| David Tolnay | c071b89 | 2020-03-18 16:59:53 -0700 | [diff] [blame] | 275 | fn parse_type_fn(ty: &TypeBareFn) -> Result<Type> { |
| 276 | if ty.lifetimes.is_some() { |
| 277 | return Err(Error::new_spanned( |
| 278 | ty, |
| 279 | "function pointer with lifetime parameters is not supported yet", |
| 280 | )); |
| 281 | } |
| 282 | if ty.variadic.is_some() { |
| 283 | return Err(Error::new_spanned( |
| 284 | ty, |
| 285 | "variadic function pointer is not supported yet", |
| 286 | )); |
| 287 | } |
| 288 | let args = ty |
| 289 | .inputs |
| 290 | .iter() |
| 291 | .enumerate() |
| 292 | .map(|(i, arg)| { |
| 293 | let ty = parse_type(&arg.ty)?; |
| 294 | let ident = match &arg.name { |
| 295 | Some(ident) => ident.0.clone(), |
| 296 | None => format_ident!("_{}", i), |
| 297 | }; |
| 298 | Ok(Var { ident, ty }) |
| 299 | }) |
| 300 | .collect::<Result<_>>()?; |
| 301 | let mut throws = false; |
| 302 | let ret = parse_return_type(&ty.output, &mut throws)?; |
| 303 | let tokens = quote!(#ty); |
| 304 | Ok(Type::Fn(Box::new(Signature { |
| 305 | fn_token: ty.fn_token, |
| 306 | receiver: None, |
| 307 | args, |
| 308 | ret, |
| 309 | throws, |
| 310 | tokens, |
| 311 | }))) |
| 312 | } |
| 313 | |
| 314 | fn parse_return_type(ty: &ReturnType, throws: &mut bool) -> Result<Option<Type>> { |
| 315 | let mut ret = match ty { |
| 316 | ReturnType::Default => return Ok(None), |
| 317 | ReturnType::Type(_, ret) => ret.as_ref(), |
| 318 | }; |
| 319 | if let RustType::Path(ty) = ret { |
| 320 | let path = &ty.path; |
| 321 | if ty.qself.is_none() && path.leading_colon.is_none() && path.segments.len() == 1 { |
| 322 | let segment = &path.segments[0]; |
| 323 | let ident = segment.ident.clone(); |
| 324 | if let PathArguments::AngleBracketed(generic) = &segment.arguments { |
| 325 | if ident == "Result" && generic.args.len() == 1 { |
| 326 | if let GenericArgument::Type(arg) = &generic.args[0] { |
| 327 | ret = arg; |
| 328 | *throws = true; |
| 329 | } |
| 330 | } |
| 331 | } |
| 332 | } |
| 333 | } |
| 334 | match parse_type(ret)? { |
| 335 | Type::Void(_) => Ok(None), |
| 336 | ty => Ok(Some(ty)), |
| 337 | } |
| 338 | } |
| 339 | |
| David Tolnay | 7db7369 | 2019-10-20 14:51:12 -0400 | [diff] [blame] | 340 | fn check_reserved_name(ident: &Ident) -> Result<()> { |
| 341 | if ident == "Box" || ident == "UniquePtr" || Atom::from(ident).is_some() { |
| 342 | Err(Error::new(ident.span(), "reserved name")) |
| 343 | } else { |
| 344 | Ok(()) |
| 345 | } |
| 346 | } |