Skip to content

Commit

Permalink
Merge pull request #5205 from epage/flatten-refactor
Browse files Browse the repository at this point in the history
refavtor: Prepare for help flattening
  • Loading branch information
epage authored Nov 9, 2023
2 parents a920a7f + 2142b13 commit 3383242
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 17 deletions.
20 changes: 20 additions & 0 deletions clap_builder/src/builder/command.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3335,6 +3335,20 @@ impl Command {
self.usage_name.as_deref()
}

#[inline]
#[cfg(feature = "usage")]
pub(crate) fn get_usage_name_fallback(&self) -> &str {
self.get_usage_name()
.unwrap_or_else(|| self.get_bin_name_fallback())
}

#[inline]
#[cfg(not(feature = "usage"))]
#[allow(dead_code)]
pub(crate) fn get_usage_name_fallback(&self) -> &str {
self.get_bin_name_fallback()
}

/// Get the name of the binary.
#[inline]
pub fn get_display_name(&self) -> Option<&str> {
Expand All @@ -3347,6 +3361,12 @@ impl Command {
self.bin_name.as_deref()
}

/// Get the name of the binary.
#[inline]
pub(crate) fn get_bin_name_fallback(&self) -> &str {
self.bin_name.as_deref().unwrap_or_else(|| self.get_name())
}

/// Set binary name. Uses `&mut self` instead of `self`.
pub fn set_bin_name(&mut self, name: impl Into<String>) {
self.bin_name = Some(name.into());
Expand Down
11 changes: 2 additions & 9 deletions clap_builder/src/output/usage.rs
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ impl<'cmd> Usage<'cmd> {
let literal = &self.styles.get_literal();
let placeholder = &self.styles.get_placeholder();

let bin_name = self.get_name();
let bin_name = self.cmd.get_usage_name_fallback();
if !bin_name.is_empty() {
// the trim won't properly remove a leading space due to the formatting
let _ = write!(
Expand Down Expand Up @@ -176,7 +176,7 @@ impl<'cmd> Usage<'cmd> {
styled.trim_end();
let _ = write!(styled, "{}", USAGE_SEP);
if self.cmd.is_args_conflicts_with_subcommands_set() {
let bin_name = self.get_name();
let bin_name = self.cmd.get_usage_name_fallback();
// Short-circuit full usage creation since no args will be relevant
let _ = write!(
styled,
Expand Down Expand Up @@ -211,13 +211,6 @@ impl<'cmd> Usage<'cmd> {
}
}

fn get_name(&self) -> &str {
self.cmd
.get_usage_name()
.or_else(|| self.cmd.get_bin_name())
.unwrap_or_else(|| self.cmd.get_name())
}

// Determines if we need the `[OPTIONS]` tag in the usage string
fn needs_options_tag(&self) -> bool {
debug!("Usage::needs_options_tag");
Expand Down
5 changes: 1 addition & 4 deletions clap_builder/src/parser/parser.rs
Original file line number Diff line number Diff line change
Expand Up @@ -501,10 +501,7 @@ impl<'cmd> Parser<'cmd> {
self.cmd,
arg_os.display().to_string(),
candidates,
self.cmd
.get_bin_name()
.unwrap_or_else(|| self.cmd.get_name())
.to_owned(),
self.cmd.get_bin_name_fallback().to_owned(),
suggested_trailing_arg,
Usage::new(self.cmd).create_usage_with_title(&[]),
);
Expand Down
5 changes: 1 addition & 4 deletions clap_builder/src/parser/validator.rs
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,7 @@ impl<'cmd> Validator<'cmd> {
}
}
if !has_subcmd && self.cmd.is_subcommand_required_set() {
let bn = self
.cmd
.get_bin_name()
.unwrap_or_else(|| self.cmd.get_name());
let bn = self.cmd.get_bin_name_fallback();
return Err(Error::missing_subcommand(
self.cmd,
bn.to_string(),
Expand Down

0 comments on commit 3383242

Please sign in to comment.