Skip to content

Commit

Permalink
Merge clap-rs#2935
Browse files Browse the repository at this point in the history 
2935: fix(derive): Avoid name collisions with users r=epage a=epage



Co-authored-by: Ed Page <eopage@gmail.com>
  • Loading branch information
@bors @epage
bors[bot] and epage committed Oct 23, 2021
2 parents 4a6430c + 3a697af commit 3f933e1
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 40 deletions.
14 changes: 7 additions & 7 deletions clap_derive/src/derives/args.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ pub fn gen_for_struct(
Sp::call_site(DEFAULT_CASING),
Sp::call_site(DEFAULT_ENV_CASING),
);
let app_var = Ident::new("app", Span::call_site());
let app_var = Ident::new("__clap_app", Span::call_site());
let augmentation = gen_augment(fields, &app_var, &attrs, false);
let augmentation_update = gen_augment(fields, &app_var, &attrs, true);

Expand Down Expand Up @@ -118,12 +118,12 @@ pub fn gen_from_arg_matches_for_struct(
)]
#[deny(clippy::correctness)]
impl clap::FromArgMatches for #struct_name {
fn from_arg_matches(arg_matches: &clap::ArgMatches) -> Option<Self> {
fn from_arg_matches(__clap_arg_matches: &clap::ArgMatches) -> Option<Self> {
let v = #struct_name #constructor;
Some(v)
}

fn update_from_arg_matches(&mut self, arg_matches: &clap::ArgMatches) {
fn update_from_arg_matches(&mut self, __clap_arg_matches: &clap::ArgMatches) {
#updater
}
}
Expand Down Expand Up @@ -198,7 +198,7 @@ pub fn gen_augment(
| Kind::ExternalSubcommand => None,
Kind::Flatten => {
let ty = &field.ty;
let old_heading_var = format_ident!("old_heading");
let old_heading_var = format_ident!("__clap_old_heading");
if override_required {
Some(quote_spanned! { kind.span()=>
let #old_heading_var = #app_var.get_help_heading();
Expand Down Expand Up @@ -385,7 +385,7 @@ pub fn gen_constructor(fields: &Punctuated<Field, Comma>, parent_attribute: &Att
);
let field_name = field.ident.as_ref().unwrap();
let kind = attrs.kind();
let arg_matches = format_ident!("arg_matches");
let arg_matches = format_ident!("__clap_arg_matches");
match &*kind {
Kind::ExternalSubcommand => {
abort! { kind.span(),
Expand Down Expand Up @@ -451,7 +451,7 @@ pub fn gen_updater(
} else {
quote!()
};
let arg_matches = format_ident!("arg_matches");
let arg_matches = format_ident!("__clap_arg_matches");

match &*kind {
Kind::ExternalSubcommand => {
Expand Down Expand Up @@ -563,7 +563,7 @@ fn gen_parsers(
// Give this identifier the same hygiene
// as the `arg_matches` parameter definition. This
// allows us to refer to `arg_matches` within a `quote_spanned` block
let arg_matches = format_ident!("arg_matches");
let arg_matches = format_ident!("__clap_arg_matches");

let field_value = match **ty {
Ty::Bool => {
Expand Down
11 changes: 6 additions & 5 deletions clap_derive/src/derives/into_app.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ pub fn gen_for_struct(struct_name: &Ident, attrs: &[Attribute]) -> TokenStream {
Sp::call_site(DEFAULT_ENV_CASING),
);
let name = attrs.cased_name();
let app_var = Ident::new("__clap_app", Span::call_site());

let tokens = quote! {
#[allow(dead_code, unreachable_code, unused_variables)]
Expand All @@ -71,13 +72,13 @@ pub fn gen_for_struct(struct_name: &Ident, attrs: &[Attribute]) -> TokenStream {
#[deny(clippy::correctness)]
impl clap::IntoApp for #struct_name {
fn into_app<'b>() -> clap::App<'b> {
let app = clap::App::new(#name);
<#struct_name as clap::Args>::augment_args(app)
let #app_var = clap::App::new(#name);
<#struct_name as clap::Args>::augment_args(#app_var)
}

fn into_app_for_update<'b>() -> clap::App<'b> {
let app = clap::App::new(#name);
<#struct_name as clap::Args>::augment_args_for_update(app)
let #app_var = clap::App::new(#name);
<#struct_name as clap::Args>::augment_args_for_update(#app_var)
}
}
};
Expand All @@ -96,7 +97,7 @@ pub fn gen_for_enum(enum_name: &Ident, attrs: &[Attribute]) -> TokenStream {
Sp::call_site(DEFAULT_ENV_CASING),
);
let name = attrs.cased_name();
let app_var = Ident::new("app", Span::call_site());
let app_var = Ident::new("__clap_app", Span::call_site());

quote! {
#[allow(dead_code, unreachable_code, unused_variables)]
Expand Down
56 changes: 28 additions & 28 deletions clap_derive/src/derives/subcommand.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,13 +67,13 @@ pub fn gen_for_enum(enum_name: &Ident, attrs: &[Attribute], e: &DataEnum) -> Tok
)]
#[deny(clippy::correctness)]
impl clap::Subcommand for #enum_name {
fn augment_subcommands <'b>(app: clap::App<'b>) -> clap::App<'b> {
fn augment_subcommands <'b>(__clap_app: clap::App<'b>) -> clap::App<'b> {
#augmentation
}
fn augment_subcommands_for_update <'b>(app: clap::App<'b>) -> clap::App<'b> {
fn augment_subcommands_for_update <'b>(__clap_app: clap::App<'b>) -> clap::App<'b> {
#augmentation_update
}
fn has_subcommand(name: &str) -> bool {
fn has_subcommand(__clap_name: &str) -> bool {
#has_subcommand
}
}
Expand Down Expand Up @@ -119,7 +119,7 @@ fn gen_augment(
) -> TokenStream {
use syn::Fields::*;

let app_var = Ident::new("app", Span::call_site());
let app_var = Ident::new("__clap_app", Span::call_site());

let subcommands: Vec<_> = variants
.iter()
Expand Down Expand Up @@ -170,7 +170,7 @@ fn gen_augment(
Kind::Flatten => match variant.fields {
Unnamed(FieldsUnnamed { ref unnamed, .. }) if unnamed.len() == 1 => {
let ty = &unnamed[0];
let old_heading_var = format_ident!("old_heading");
let old_heading_var = format_ident!("__clap_old_heading");
let subcommand = if override_required {
quote! {
let #old_heading_var = #app_var.get_help_heading();
Expand All @@ -193,7 +193,7 @@ fn gen_augment(
},

Kind::Subcommand(_) => {
let subcommand_var = Ident::new("subcommand", Span::call_site());
let subcommand_var = Ident::new("__clap_subcommand", Span::call_site());
let arg_block = match variant.fields {
Named(_) => {
abort!(variant, "non single-typed tuple enums are not supported")
Expand Down Expand Up @@ -236,7 +236,7 @@ fn gen_augment(
}

_ => {
let subcommand_var = Ident::new("subcommand", Span::call_site());
let subcommand_var = Ident::new("__clap_subcommand", Span::call_site());
let arg_block = match variant.fields {
Named(ref fields) => {
args::gen_augment(&fields.named, &subcommand_var, &attrs, override_required)
Expand Down Expand Up @@ -321,7 +321,7 @@ fn gen_has_subcommand(
let subcommands = variants.iter().map(|(_variant, attrs)| {
let sub_name = attrs.cased_name();
quote! {
if #sub_name == name {
if #sub_name == __clap_name {
return true
}
}
Expand All @@ -332,7 +332,7 @@ fn gen_has_subcommand(
Unnamed(ref fields) if fields.unnamed.len() == 1 => {
let ty = &fields.unnamed[0];
quote! {
if <#ty as clap::Subcommand>::has_subcommand(name) {
if <#ty as clap::Subcommand>::has_subcommand(__clap_name) {
return true;
}
}
Expand Down Expand Up @@ -365,8 +365,8 @@ fn gen_from_arg_matches(

let mut ext_subcmd = None;

let subcommand_name_var = format_ident!("name");
let sub_arg_matches_var = format_ident!("sub_arg_matches");
let subcommand_name_var = format_ident!("__clap_name");
let sub_arg_matches_var = format_ident!("__clap_sub_arg_matches");
let (flatten_variants, variants): (Vec<_>, Vec<_>) = variants
.iter()
.filter_map(|variant| {
Expand Down Expand Up @@ -445,7 +445,7 @@ fn gen_from_arg_matches(
Unit => quote!(),
Unnamed(ref fields) if fields.unnamed.len() == 1 => {
let ty = &fields.unnamed[0];
quote!( ( <#ty as clap::FromArgMatches>::from_arg_matches(arg_matches).unwrap() ) )
quote!( ( <#ty as clap::FromArgMatches>::from_arg_matches(__clap_arg_matches).unwrap() ) )
}
Unnamed(..) => abort_call_site!("{}: tuple enums are not supported", variant.ident),
};
Expand All @@ -462,9 +462,9 @@ fn gen_from_arg_matches(
Unnamed(ref fields) if fields.unnamed.len() == 1 => {
let ty = &fields.unnamed[0];
quote! {
if <#ty as clap::Subcommand>::has_subcommand(name) {
let res = <#ty as clap::FromArgMatches>::from_arg_matches(arg_matches).unwrap();
return Some(#name :: #variant_name (res));
if <#ty as clap::Subcommand>::has_subcommand(__clap_name) {
let __clap_res = <#ty as clap::FromArgMatches>::from_arg_matches(__clap_arg_matches).unwrap();
return Some(#name :: #variant_name (__clap_res));
}
}
}
Expand All @@ -490,10 +490,10 @@ fn gen_from_arg_matches(
};

quote! {
fn from_arg_matches(arg_matches: &clap::ArgMatches) -> Option<Self> {
if let Some((#subcommand_name_var, #sub_arg_matches_var)) = arg_matches.subcommand() {
fn from_arg_matches(__clap_arg_matches: &clap::ArgMatches) -> Option<Self> {
if let Some((#subcommand_name_var, #sub_arg_matches_var)) = __clap_arg_matches.subcommand() {
{
let arg_matches = #sub_arg_matches_var;
let __clap_arg_matches = #sub_arg_matches_var;
#( #subcommands )*
}

Expand Down Expand Up @@ -561,10 +561,10 @@ fn gen_update_from_arg_matches(
Unnamed(ref fields) => {
if fields.unnamed.len() == 1 {
(
quote!((ref mut arg)),
quote!((ref mut __clap_arg)),
quote!(clap::FromArgMatches::update_from_arg_matches(
arg,
sub_arg_matches
__clap_arg,
__clap_sub_arg_matches
)),
)
} else {
Expand All @@ -574,8 +574,8 @@ fn gen_update_from_arg_matches(
};

quote! {
#name :: #variant_name #pattern if #sub_name == name => {
let arg_matches = sub_arg_matches;
#name :: #variant_name #pattern if #sub_name == __clap_name => {
let __clap_arg_matches = __clap_sub_arg_matches;
#updater
}
}
Expand All @@ -587,9 +587,9 @@ fn gen_update_from_arg_matches(
Unnamed(ref fields) if fields.unnamed.len() == 1 => {
let ty = &fields.unnamed[0];
quote! {
if <#ty as clap::Subcommand>::has_subcommand(name) {
if <#ty as clap::Subcommand>::has_subcommand(__clap_name) {
if let #name :: #variant_name (child) = s {
<#ty as clap::FromArgMatches>::update_from_arg_matches(child, arg_matches);
<#ty as clap::FromArgMatches>::update_from_arg_matches(child, __clap_arg_matches);
return;
}
}
Expand All @@ -605,14 +605,14 @@ fn gen_update_from_arg_matches(
quote! {
fn update_from_arg_matches<'b>(
&mut self,
arg_matches: &clap::ArgMatches,
__clap_arg_matches: &clap::ArgMatches,
) {
if let Some((name, sub_arg_matches)) = arg_matches.subcommand() {
if let Some((__clap_name, __clap_sub_arg_matches)) = __clap_arg_matches.subcommand() {
match self {
#( #subcommands ),*
s => {
#( #child_subcommands )*
*s = <Self as clap::FromArgMatches>::from_arg_matches(arg_matches).unwrap();
*s = <Self as clap::FromArgMatches>::from_arg_matches(__clap_arg_matches).unwrap();
}
}
}
Expand Down

0 comments on commit 3f933e1

Please sign in to comment.