chris/ruwuma
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

api-macros: Remove RawApi, some refactoring

Browse Source
This commit is contained in:
Jonas Platte 2020-11-27 21:12:10 +01:00
parent 183f427143
commit 761aecbe4e
No known key found for this signature in database
GPG Key ID: CC154DE0E30B7C67
2 changed files with 257 additions and 308 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

151
ruma-api-macros/src/api.rs
View File

@ -1,7 +1,5 @@
//! Details of the `ruma_api` procedural macro. //! Details of the `ruma_api` procedural macro.
use std::convert::TryFrom;
use proc_macro2::TokenStream; use proc_macro2::TokenStream;
use quote::{quote, ToTokens}; use quote::{quote, ToTokens};
use syn::{ use syn::{
@ -36,29 +34,23 @@ pub struct Api {
response: Response, response: Response,
/// The `error` section of the macro. /// The `error` section of the macro.
error: TokenStream, error_ty: TokenStream,
} }
impl TryFrom<RawApi> for Api { impl Parse for Api {
type Error = syn::Error; fn parse(input: ParseStream<'_>) -> syn::Result<Self> {
fn try_from(raw_api: RawApi) -> syn::Result<Self> {
let import_path = util::import_ruma_api(); let import_path = util::import_ruma_api();
let res = Self { let metadata: Metadata = input.parse()?;
metadata: raw_api.metadata, let request: Request = input.parse()?;
request: raw_api.request, let response: Response = input.parse()?;
response: raw_api.response, let error_ty = match input.parse::<ErrorType>() {
error: match raw_api.error { Ok(err) => err.ty.to_token_stream(),
Some(raw_err) => raw_err.ty.to_token_stream(), Err(_) => quote! { #import_path::error::Void },
None => quote! { #import_path::error::Void },
},
}; };
let newtype_body_field = res.request.newtype_body_field(); let newtype_body_field = request.newtype_body_field();
if res.metadata.method == "GET" if metadata.method == "GET" && (request.has_body_fields() || newtype_body_field.is_some()) {
&& (res.request.has_body_fields() || newtype_body_field.is_some())
{
let mut combined_error: Option<syn::Error> = None; let mut combined_error: Option<syn::Error> = None;
let mut add_error = |field| { let mut add_error = |field| {
let error = syn::Error::new_spanned(field, "GET endpoints can't have body fields"); let error = syn::Error::new_spanned(field, "GET endpoints can't have body fields");
@ -69,7 +61,7 @@ impl TryFrom<RawApi> for Api {
} }
}; };
for field in res.request.body_fields() { for field in request.body_fields() {
add_error(field); add_error(field);
} }
@ -77,38 +69,34 @@ impl TryFrom<RawApi> for Api {
add_error(field); add_error(field);
} }
Err(combined_error.unwrap()) return Err(combined_error.unwrap());
} else {
Ok(res)
} }
Ok(Self { metadata, request, response, error_ty })
} }
} }
impl ToTokens for Api { pub fn expand_all(api: Api) -> syn::Result<TokenStream> {
fn to_tokens(&self, tokens: &mut TokenStream) {
// Guarantee `ruma_api` is available and named something we can refer to. // Guarantee `ruma_api` is available and named something we can refer to.
let ruma_api_import = util::import_ruma_api(); let ruma_api_import = util::import_ruma_api();
let description = &self.metadata.description; let description = &api.metadata.description;
let method = &self.metadata.method; let method = &api.metadata.method;
// We don't (currently) use this literal as a literal in the generated code. Instead we just // We don't (currently) use this literal as a literal in the generated code. Instead we just
// put it into doc comments, for which the span information is irrelevant. So we can work // put it into doc comments, for which the span information is irrelevant. So we can work
// with only the literal's value from here on. // with only the literal's value from here on.
let name = &self.metadata.name.value(); let name = &api.metadata.name.value();
let path = &self.metadata.path; let path = &api.metadata.path;
let rate_limited = &self.metadata.rate_limited; let rate_limited = &api.metadata.rate_limited;
let authentication = &self.metadata.authentication; let authentication = &api.metadata.authentication;
let request_type = &self.request; let request_type = &api.request;
let response_type = &self.response; let response_type = &api.response;
let incoming_request_type = if self.request.contains_lifetimes() { let incoming_request_type =
quote!(IncomingRequest) if api.request.contains_lifetimes() { quote!(IncomingRequest) } else { quote!(Request) };
} else {
quote!(Request)
};
let extract_request_path = if self.request.has_path_fields() { let extract_request_path = if api.request.has_path_fields() {
quote! { quote! {
let path_segments: ::std::vec::Vec<&::std::primitive::str> = let path_segments: ::std::vec::Vec<&::std::primitive::str> =
request.uri().path()[1..].split('/').collect(); request.uri().path()[1..].split('/').collect();
@ -118,23 +106,23 @@ impl ToTokens for Api {
}; };
let (request_path_string, parse_request_path) = let (request_path_string, parse_request_path) =
util::request_path_string_and_parse(&self.request, &self.metadata, &ruma_api_import); util::request_path_string_and_parse(&api.request, &api.metadata, &ruma_api_import);
let request_query_string = util::build_query_string(&self.request, &ruma_api_import); let request_query_string = util::build_query_string(&api.request, &ruma_api_import);
let extract_request_query = util::extract_request_query(&self.request, &ruma_api_import); let extract_request_query = util::extract_request_query(&api.request, &ruma_api_import);
let parse_request_query = if let Some(field) = self.request.query_map_field() { let parse_request_query = if let Some(field) = api.request.query_map_field() {
let field_name = field.ident.as_ref().expect("expected field to have an identifier"); let field_name = field.ident.as_ref().expect("expected field to have an identifier");
quote! { quote! {
#field_name: request_query, #field_name: request_query,
} }
} else { } else {
self.request.request_init_query_fields() api.request.request_init_query_fields()
}; };
let mut header_kvs = self.request.append_header_kvs(); let mut header_kvs = api.request.append_header_kvs();
if authentication == "AccessToken" { if authentication == "AccessToken" {
header_kvs.extend(quote! { header_kvs.extend(quote! {
req_builder = req_builder.header( req_builder = req_builder.header(
@ -151,7 +139,7 @@ impl ToTokens for Api {
}); });
} }
let extract_request_headers = if self.request.has_header_fields() { let extract_request_headers = if api.request.has_header_fields() {
quote! { quote! {
let headers = request.headers(); let headers = request.headers();
} }
@ -159,13 +147,12 @@ impl ToTokens for Api {
TokenStream::new() TokenStream::new()
}; };
let extract_request_body = if self.request.has_body_fields() let extract_request_body =
|| self.request.newtype_body_field().is_some() if api.request.has_body_fields() || api.request.newtype_body_field().is_some() {
{ let body_lifetimes = if api.request.has_body_lifetimes() {
let body_lifetimes = if self.request.has_body_lifetimes() {
// duplicate the anonymous lifetime as many times as needed // duplicate the anonymous lifetime as many times as needed
let lifetimes = let lifetimes =
std::iter::repeat(quote! { '_ }).take(self.request.body_lifetime_count()); std::iter::repeat(quote! { '_ }).take(api.request.body_lifetime_count());
quote! { < #( #lifetimes, )* >} quote! { < #( #lifetimes, )* >}
} else { } else {
TokenStream::new() TokenStream::new()
@ -184,17 +171,17 @@ impl ToTokens for Api {
TokenStream::new() TokenStream::new()
}; };
let parse_request_headers = if self.request.has_header_fields() { let parse_request_headers = if api.request.has_header_fields() {
self.request.parse_headers_from_request() api.request.parse_headers_from_request()
} else { } else {
TokenStream::new() TokenStream::new()
}; };
let request_body = util::build_request_body(&self.request, &ruma_api_import); let request_body = util::build_request_body(&api.request, &ruma_api_import);
let parse_request_body = util::parse_request_body(&self.request); let parse_request_body = util::parse_request_body(&api.request);
let extract_response_headers = if self.response.has_header_fields() { let extract_response_headers = if api.response.has_header_fields() {
quote! { quote! {
let mut headers = response.headers().clone(); let mut headers = response.headers().clone();
} }
@ -202,8 +189,8 @@ impl ToTokens for Api {
TokenStream::new() TokenStream::new()
}; };
let typed_response_body_decl = if self.response.has_body_fields() let typed_response_body_decl = if api.response.has_body_fields()
|| self.response.newtype_body_field().is_some() || api.response.newtype_body_field().is_some()
{ {
quote! { quote! {
let response_body: < let response_body: <
@ -219,23 +206,20 @@ impl ToTokens for Api {
TokenStream::new() TokenStream::new()
}; };
let response_init_fields = self.response.init_fields(); let response_init_fields = api.response.init_fields();
let serialize_response_headers = self.response.apply_header_fields(); let serialize_response_headers = api.response.apply_header_fields();
let body = self.response.to_body(); let body = api.response.to_body();
let metadata_doc = format!("Metadata for the `{}` API endpoint.", name); let metadata_doc = format!("Metadata for the `{}` API endpoint.", name);
let request_doc = format!( let request_doc =
"Data for a request to the `{}` API endpoint.\n\n{}", format!("Data for a request to the `{}` API endpoint.\n\n{}", name, description.value());
name,
description.value()
);
let response_doc = format!("Data in the response from the `{}` API endpoint.", name); let response_doc = format!("Data in the response from the `{}` API endpoint.", name);
let error = &self.error; let error = &api.error_ty;
let request_lifetimes = self.request.combine_lifetimes(); let request_lifetimes = api.request.combine_lifetimes();
let non_auth_endpoint_impls = if authentication != "None" { let non_auth_endpoint_impls = if authentication != "None" {
TokenStream::new() TokenStream::new()
@ -249,7 +233,7 @@ impl ToTokens for Api {
} }
}; };
let api = quote! { Ok(quote! {
#[doc = #request_doc] #[doc = #request_doc]
#request_type #request_type
@ -387,36 +371,7 @@ impl ToTokens for Api {
} }
#non_auth_endpoint_impls #non_auth_endpoint_impls
};
api.to_tokens(tokens);
}
}
/// The entire `ruma_api!` macro structure directly as it appears in the source code..
pub struct RawApi {
/// The `metadata` section of the macro.
pub metadata: Metadata,
/// The `request` section of the macro.
pub request: Request,
/// The `response` section of the macro.
pub response: Response,
/// The `error` section of the macro.
pub error: Option<ErrorType>,
}
impl Parse for RawApi {
fn parse(input: ParseStream<'_>) -> syn::Result<Self> {
Ok(Self {
metadata: input.parse()?,
request: input.parse()?,
response: input.parse()?,
error: input.parse().ok(),
}) })
}
} }
mod kw { mod kw {

12
ruma-api-macros/src/lib.rs
View File

@ -13,22 +13,16 @@
#![allow(clippy::unknown_clippy_lints)] #![allow(clippy::unknown_clippy_lints)]
#![recursion_limit = "256"] #![recursion_limit = "256"]
use std::convert::TryFrom as _;
use proc_macro::TokenStream; use proc_macro::TokenStream;
use quote::ToTokens;
use syn::parse_macro_input; use syn::parse_macro_input;
use self::api::{Api, RawApi}; use self::api::Api;
mod api; mod api;
mod util; mod util;
#[proc_macro] #[proc_macro]
pub fn ruma_api(input: TokenStream) -> TokenStream { pub fn ruma_api(input: TokenStream) -> TokenStream {
let raw_api = parse_macro_input!(input as RawApi); let api = parse_macro_input!(input as Api);
match Api::try_from(raw_api) { api::expand_all(api).unwrap_or_else(|err| err.to_compile_error()).into()
Ok(api) => api.into_token_stream().into(),
Err(err) => err.to_compile_error().into(),
}
} }