proxmox-mirrors/proxmox
1
0
Fork 1
mirror of https://git.proxmox.com/git/proxmox synced 2025-08-13 02:40:35 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

api-macro: add consts for defaults

Browse Source 
Not sure how we want to actually handle default values yet.
For now we need to figure out what "feels best".
This adds default values as publicly available consts so
they can be accessed from anywhere as
`API_METHOD_<METHOD_NAME>_PARAM_DEFAULT_<PARAM_NAME>`.
This is quite a handful to type, but I'm not sure how to
make this better.

Within the function body we also have the
`api_get_default!(param_name)` macro which is more
convenient, but not available outside the `#[api]` tagged
function.

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
This commit is contained in:
Wolfgang Bumiller 2020-03-23 09:06:43 +01:00
parent 6a21867d87
commit 176e208caf
1 changed files with 25 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
proxmox-api-macro/src/api/method.rs
View File

@ -49,12 +49,15 @@ pub fn handle_method(mut attribs: JSONObject, mut func: syn::ItemFn) -> Result<T
)?;
let mut wrapper_ts = TokenStream::new();
let mut default_consts = TokenStream::new();
let is_async = func.sig.asyncness.is_some();
let api_func_name = handle_function_signature(
&mut input_schema,
&mut returns_schema,
&mut func,
&mut wrapper_ts,
&mut default_consts,
)?;
// input schema is done, let's give the method body a chance to extract default parameters:
@ -115,6 +118,8 @@ pub fn handle_method(mut attribs: JSONObject, mut func: syn::ItemFn) -> Result<T
#returns_schema_setter
.protected(#protected);
#default_consts
#wrapper_ts
#func
@ -150,6 +155,7 @@ fn handle_function_signature(
returns_schema: &mut Option<Schema>,
func: &mut syn::ItemFn,
wrapper_ts: &mut TokenStream,
default_consts: &mut TokenStream,
) -> Result<Ident, Error> {
let sig = &func.sig;
let is_async = sig.asyncness.is_some();
@ -271,6 +277,7 @@ fn handle_function_signature(
param_list,
func,
wrapper_ts,
default_consts,
is_async,
)
}
@ -327,6 +334,7 @@ fn create_wrapper_function(
param_list: Vec<(FieldName, ParameterType)>,
func: &syn::ItemFn,
wrapper_ts: &mut TokenStream,
default_consts: &mut TokenStream,
is_async: bool,
) -> Result<Ident, Error> {
let api_func_name = Ident::new(
@ -337,6 +345,8 @@ fn create_wrapper_function(
let mut body = TokenStream::new();
let mut args = TokenStream::new();
let func_uc = func.sig.ident.to_string().to_uppercase();
for (name, param) in param_list {
let span = name.span();
match param {
@ -356,6 +366,7 @@ fn create_wrapper_function(
.map(::serde_json::from_value)
.transpose()?
});
let default_value = schema.find_schema_property("default");
if !optional {
// Non-optional types need to be extracted out of the option though (unless
// they have a default):
@ -371,7 +382,7 @@ fn create_wrapper_function(
});
} else if util::is_option_type(ty).is_none() {
// Optional parameter without an Option<T> type requires a default:
if let Some(def) = schema.find_schema_property("default") {
if let Some(def) = &default_value {
body.extend(quote_spanned! { span =>
.unwrap_or_else(|| #def)
});
@ -381,6 +392,19 @@ fn create_wrapper_function(
}
body.extend(quote_spanned! { span => ; });
args.extend(quote_spanned! { span => #arg_name, });
if let Some(def) = &default_value {
let name_uc = name.as_ident().to_string().to_uppercase();
let name = Ident::new(
&format!("API_METHOD_{}_PARAM_DEFAULT_{}", func_uc, name_uc),
span,
);
// strip possible Option<> from this type:
let ty = util::is_option_type(ty).unwrap_or(ty);
default_consts.extend(quote_spanned! { span =>
pub const #name: #ty = #def;
});
}
}
}
}