clap/clap_derive/src/derives/arg_enum.rs

93 lines
2.8 KiB
Rust
Raw Normal View History

2018-07-02 17:41:01 +00:00
// Copyright 2018 Guillaume Pinot (@TeXitoi) <texitoi@texitoi.eu>,
// Kevin Knapp (@kbknapp) <kbknapp@gmail.com>, and
// Andrew Hobden (@hoverbear) <andrew@hoverbear.org>
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
2020-01-31 11:05:12 +00:00
/*
2018-07-02 18:31:23 +00:00
use proc_macro2;
2020-01-31 11:05:12 +00:00
use quote;
2018-07-02 18:31:23 +00:00
use syn;
2020-01-31 11:05:12 +00:00
use syn::punctuated;
use syn::token;
2017-11-12 18:02:56 +00:00
Ported all the commits from structopt (#23) * Automatic naming of fields and subcommands (#143) * Introduce smarter parsing of doc comments. (#146) * Fix invalid structopt syntax error message (#154) There was a typo preventing the probematic attr to be shown to the user. * Fix spelling: occurences -> occurrences, (#158) was found in comments and code, but required no user-facing API change. * Remove line-ending periods from short help. (#161) * Fix #168 * Support Option<Option<T>> field types (#190) * Support Option<Vec<T>> field type (#191) * Fix use of deprecated function * Fix some clippy lints * Update deprecated function and provide more info about the parsing error (#193) * Improve ChangeLog as suggested by @ErichDonGubler (#194) * [Casing] Change default from verbatim to kebab. (#204) .. fixes TeXitoi/structopt#202 * Use trybuild for testing expected proc macro errors (#205) * Custom attributes parser (#198) * update README.md for 0.3 fix #208 * Small fixes: clippy and typos (#215) * Add example for environment variables (#160) (#216) * Support skipping struct fields (#213) * Now error messages highlight the error location (#225) * Minor fixes * Change behavior of `about/author/version` and ad `no_version` * Emit error about `raw` removal * Update changelog * Update keyvalue example (#234) * Update documentation and changelog (#236) * Update dependencies (#227) * Bump minimum rustc version to 1.36 * Fix issues * Fix structopt-derive permissions (#239) * Fix #245 (#246) * Emit dummy impls on error (#248) * Fix changelog example (#250) * Do not call .verison() when CARGO_PKG_VERSION is not set * Update and improve docs * Propagate span info from origin code to generated code Most of `quote!` invocations are replaced with `quote_spanned!` ones. Now everywhere - sometimes it's pointless, sometimes we don't have any meaningless location to toke a span from, sometimes I just can't workaround the current implementation - too much changes. * Fix nightly tests * Do not mangle `author` string inside `<...>` * Support `skip = value` syntax * Fix code formatting * Fix nightly tests * Run ui tests only on stable * Add from_flag parser (#271) * Clarify docs and error messages (#277) * Fix parse for OptionVec (#279) ref pull #191 * Fix #269 and #265 (#278) * Pass the try_from_str functions a &str instead of a &String. (#282) In most cases this doesn't matter, as &String is coerced to a &str, but this fails for generic functions like CString::new. * Add an example of a negative flag (i.e. --no-verbose) Question from https://github.com/TeXitoi/structopt/issues/280 * Fix #283 (#284) Fix #283 * Add `examples/README.md` and do some cleanup * Handle special types correctly * cargo clippy * Handle inter-expansion top-level args properly * Cleanup tests * Update proc-macro-error to v0.4 * Offer helpful suggestion on `raw(...)` error * Add `after_help` example * Prohibit positional `bool` args * Add tests/utils.rs * fixed typo, removed misleading doc * Remove CHANGELOG additions * Rust 2018 * Addressed review Co-authored-by: rnd <bruno.kirschner@online.de> Co-authored-by: Robin Lambertz <github@roblab.la> Co-authored-by: florianjacob <accounts+github@florianjacob.de> Co-authored-by: Ted Driggs <ted.driggs@outlook.com> Co-authored-by: Guillaume P. <TeXitoi@users.noreply.github.com> Co-authored-by: Ivan Veselov <veselov@gmail.com> Co-authored-by: Owen Walpole <owenthewizard@hotmail.com> Co-authored-by: Robin Stocker <robin.stocker@gmail.com> Co-authored-by: CreepySkeleton <creepy-skeleton@yandex.ru> Co-authored-by: Ophir LOJKINE <ophir.lojkine@auto-grid.com> Co-authored-by: kpcyrd <git@rxv.cc> Co-authored-by: Luiz F. A. de Prá <luizdepra@users.noreply.github.com> Co-authored-by: Andy Weiss <wvvwwvw@gmail.com> Co-authored-by: xiaoniu-578fa6bff964d005 <32661032+xiaoniu-578fa6bff964d005@users.noreply.github.com> Co-authored-by: Mara Bos <m-ou.se@m-ou.se> Co-authored-by: Renê Couto e Silva <31329678+csrene@users.noreply.github.com>
2020-01-07 10:17:23 +00:00
pub fn derive_arg_enum(_ast: &syn::DeriveInput) -> proc_macro2::TokenStream {
2020-01-31 11:05:12 +00:00
let from_str_block = impl_from_str(ast)?;
let variants_block = impl_variants(ast)?;
2018-07-02 17:41:01 +00:00
2020-01-31 11:05:12 +00:00
quote! {
#from_str_block
#variants_block
}
2017-11-12 18:02:56 +00:00
}
2018-07-02 18:31:23 +00:00
fn impl_from_str(ast: &syn::DeriveInput) -> proc_macro2::TokenStream {
2017-11-12 18:02:56 +00:00
let ident = &ast.ident;
2017-11-15 17:49:55 +00:00
let is_case_sensitive = ast.attrs.iter().any(|v| v.name() == "case_sensitive");
2018-07-02 18:31:23 +00:00
let variants = variants(ast)?;
2017-11-12 18:02:56 +00:00
2018-07-02 17:41:01 +00:00
let strings = variants
.iter()
2017-11-12 18:02:56 +00:00
.map(|ref variant| String::from(variant.ident.as_ref()))
.collect::<Vec<_>>();
2018-07-02 17:41:01 +00:00
2017-11-15 17:49:55 +00:00
// All of these need to be iterators.
2017-11-12 18:02:56 +00:00
let ident_slice = [ident.clone()];
let idents = ident_slice.iter().cycle();
let for_error_message = strings.clone();
2017-11-15 17:49:55 +00:00
let condition_function_slice = [match is_case_sensitive {
true => quote! { str::eq },
false => quote! { ::std::ascii::AsciiExt::eq_ignore_ascii_case },
}];
let condition_function = condition_function_slice.iter().cycle();
2017-11-12 18:02:56 +00:00
Ok(quote! {
impl ::std::str::FromStr for #ident {
type Err = String;
fn from_str(input: &str) -> ::std::result::Result<Self, Self::Err> {
match input {
2017-11-15 17:49:55 +00:00
#(val if #condition_function(val, #strings) => Ok(#idents::#variants),)*
2017-11-12 18:02:56 +00:00
_ => Err({
let v = #for_error_message;
format!("valid values: {}",
v.join(" ,"))
}),
}
}
}
})
}
2018-07-02 18:31:23 +00:00
fn impl_variants(ast: &syn::DeriveInput) -> proc_macro2::TokenStream {
2017-11-12 18:02:56 +00:00
let ident = &ast.ident;
2018-07-02 18:31:23 +00:00
let variants = variants(ast)?
2017-11-12 18:02:56 +00:00
.iter()
.map(|ref variant| String::from(variant.ident.as_ref()))
.collect::<Vec<_>>();
let length = variants.len();
Ok(quote! {
impl #ident {
fn variants() -> [&'static str; #length] {
#variants
}
}
})
2018-07-02 17:41:01 +00:00
}
2018-07-02 18:31:23 +00:00
fn variants(ast: &syn::DeriveInput) -> &punctuated::Punctuated<syn::Variant, token::Comma> {
use syn::Data::*;
match ast.data {
Enum(ref data) => data.variants,
_ => panic!("Only enums are supported for deriving the ArgEnum trait"),
}
}
*/