1#![allow(clippy::write_with_newline)]
5
6use std::borrow::Cow;
8use std::cmp;
9use std::collections::BTreeMap;
10
11use crate::builder::PossibleValue;
13use crate::builder::Str;
14use crate::builder::StyledStr;
15use crate::builder::Styles;
16use crate::builder::{Arg, Command};
17use crate::output::display_width;
18use crate::output::wrap;
19use crate::output::Usage;
20use crate::output::TAB;
21use crate::output::TAB_WIDTH;
22use crate::util::FlatSet;
23
24pub(crate) struct AutoHelp<'cmd, 'writer> {
26 template: HelpTemplate<'cmd, 'writer>,
27}
28
29impl<'cmd, 'writer> AutoHelp<'cmd, 'writer> {
31 pub(crate) fn new(
33 writer: &'writer mut StyledStr,
34 cmd: &'cmd Command,
35 usage: &'cmd Usage<'cmd>,
36 use_long: bool,
37 ) -> Self {
38 Self {
39 template: HelpTemplate::new(writer, cmd, usage, use_long),
40 }
41 }
42
43 pub(crate) fn write_help(&mut self) {
44 let pos = self
45 .template
46 .cmd
47 .get_positionals()
48 .any(|arg| should_show_arg(self.template.use_long, arg));
49 let non_pos = self
50 .template
51 .cmd
52 .get_non_positionals()
53 .any(|arg| should_show_arg(self.template.use_long, arg));
54 let subcmds = self.template.cmd.has_visible_subcommands();
55
56 let template = if non_pos || pos || subcmds {
57 DEFAULT_TEMPLATE
58 } else {
59 DEFAULT_NO_ARGS_TEMPLATE
60 };
61 self.template.write_templated_help(template);
62 }
63}
64
65const DEFAULT_TEMPLATE: &str = "\
66{before-help}{about-with-newline}
67{usage-heading} {usage}
68
69{all-args}{after-help}\
70 ";
71
72const DEFAULT_NO_ARGS_TEMPLATE: &str = "\
73{before-help}{about-with-newline}
74{usage-heading} {usage}{after-help}\
75 ";
76
77const SHORT_SIZE: usize = 4; pub(crate) struct HelpTemplate<'cmd, 'writer> {
83 writer: &'writer mut StyledStr,
84 cmd: &'cmd Command,
85 styles: &'cmd Styles,
86 usage: &'cmd Usage<'cmd>,
87 next_line_help: bool,
88 term_w: usize,
89 use_long: bool,
90}
91
92impl<'cmd, 'writer> HelpTemplate<'cmd, 'writer> {
94 pub(crate) fn new(
96 writer: &'writer mut StyledStr,
97 cmd: &'cmd Command,
98 usage: &'cmd Usage<'cmd>,
99 use_long: bool,
100 ) -> Self {
101 debug!(
102 "HelpTemplate::new cmd={}, use_long={}",
103 cmd.get_name(),
104 use_long
105 );
106 let term_w = Self::term_w(cmd);
107 let next_line_help = cmd.is_next_line_help_set();
108
109 HelpTemplate {
110 writer,
111 cmd,
112 styles: cmd.get_styles(),
113 usage,
114 next_line_help,
115 term_w,
116 use_long,
117 }
118 }
119
120 #[cfg(not(feature = "unstable-v5"))]
121 fn term_w(cmd: &'cmd Command) -> usize {
122 match cmd.get_term_width() {
123 Some(0) => usize::MAX,
124 Some(w) => w,
125 None => {
126 let (current_width, _h) = dimensions();
127 let current_width = current_width.unwrap_or(100);
128 let max_width = match cmd.get_max_term_width() {
129 None | Some(0) => usize::MAX,
130 Some(mw) => mw,
131 };
132 cmp::min(current_width, max_width)
133 }
134 }
135 }
136
137 #[cfg(feature = "unstable-v5")]
138 fn term_w(cmd: &'cmd Command) -> usize {
139 let term_w = match cmd.get_term_width() {
140 Some(0) => usize::MAX,
141 Some(w) => w,
142 None => {
143 let (current_width, _h) = dimensions();
144 current_width.unwrap_or(usize::MAX)
145 }
146 };
147
148 let max_term_w = match cmd.get_max_term_width() {
149 Some(0) => usize::MAX,
150 Some(mw) => mw,
151 None => 100,
152 };
153
154 cmp::min(term_w, max_term_w)
155 }
156
157 pub(crate) fn write_templated_help(&mut self, template: &str) {
163 debug!("HelpTemplate::write_templated_help");
164 use std::fmt::Write as _;
165
166 let mut parts = template.split('{');
167 if let Some(first) = parts.next() {
168 self.writer.push_str(first);
169 }
170 for part in parts {
171 if let Some((tag, rest)) = part.split_once('}') {
172 match tag {
173 "name" => {
174 self.write_display_name();
175 }
176 #[cfg(not(feature = "unstable-v5"))]
177 "bin" => {
178 self.write_bin_name();
179 }
180 "version" => {
181 self.write_version();
182 }
183 "author" => {
184 self.write_author(false, false);
185 }
186 "author-with-newline" => {
187 self.write_author(false, true);
188 }
189 "author-section" => {
190 self.write_author(true, true);
191 }
192 "about" => {
193 self.write_about(false, false);
194 }
195 "about-with-newline" => {
196 self.write_about(false, true);
197 }
198 "about-section" => {
199 self.write_about(true, true);
200 }
201 "usage-heading" => {
202 let _ = write!(
203 self.writer,
204 "{}Usage:{}",
205 self.styles.get_usage().render(),
206 self.styles.get_usage().render_reset()
207 );
208 }
209 "usage" => {
210 self.writer.push_styled(
211 &self.usage.create_usage_no_title(&[]).unwrap_or_default(),
212 );
213 }
214 "all-args" => {
215 self.write_all_args();
216 }
217 "options" => {
218 self.write_args(
221 &self.cmd.get_non_positionals().collect::<Vec<_>>(),
222 "options",
223 option_sort_key,
224 );
225 }
226 "positionals" => {
227 self.write_args(
228 &self.cmd.get_positionals().collect::<Vec<_>>(),
229 "positionals",
230 positional_sort_key,
231 );
232 }
233 "subcommands" => {
234 self.write_subcommands(self.cmd);
235 }
236 "tab" => {
237 self.writer.push_str(TAB);
238 }
239 "after-help" => {
240 self.write_after_help();
241 }
242 "before-help" => {
243 self.write_before_help();
244 }
245 _ => {
246 let _ = write!(self.writer, "{{{tag}}}");
247 }
248 }
249 self.writer.push_str(rest);
250 }
251 }
252 }
253}
254
255impl HelpTemplate<'_, '_> {
257 fn write_display_name(&mut self) {
259 debug!("HelpTemplate::write_display_name");
260
261 let display_name = wrap(
262 &self
263 .cmd
264 .get_display_name()
265 .unwrap_or_else(|| self.cmd.get_name())
266 .replace("{n}", "\n"),
267 self.term_w,
268 );
269 self.writer.push_string(display_name);
270 }
271
272 #[cfg(not(feature = "unstable-v5"))]
274 fn write_bin_name(&mut self) {
275 debug!("HelpTemplate::write_bin_name");
276
277 let bin_name = if let Some(bn) = self.cmd.get_bin_name() {
278 if bn.contains(' ') {
279 bn.replace(' ', "-")
281 } else {
282 wrap(&self.cmd.get_name().replace("{n}", "\n"), self.term_w)
283 }
284 } else {
285 wrap(&self.cmd.get_name().replace("{n}", "\n"), self.term_w)
286 };
287 self.writer.push_string(bin_name);
288 }
289
290 fn write_version(&mut self) {
291 let version = self
292 .cmd
293 .get_version()
294 .or_else(|| self.cmd.get_long_version());
295 if let Some(output) = version {
296 self.writer.push_string(wrap(output, self.term_w));
297 }
298 }
299
300 fn write_author(&mut self, before_new_line: bool, after_new_line: bool) {
301 if let Some(author) = self.cmd.get_author() {
302 if before_new_line {
303 self.writer.push_str("\n");
304 }
305 self.writer.push_string(wrap(author, self.term_w));
306 if after_new_line {
307 self.writer.push_str("\n");
308 }
309 }
310 }
311
312 fn write_about(&mut self, before_new_line: bool, after_new_line: bool) {
313 let about = if self.use_long {
314 self.cmd.get_long_about().or_else(|| self.cmd.get_about())
315 } else {
316 self.cmd.get_about()
317 };
318 if let Some(output) = about {
319 if before_new_line {
320 self.writer.push_str("\n");
321 }
322 let mut output = output.clone();
323 output.replace_newline_var();
324 output.wrap(self.term_w);
325 self.writer.push_styled(&output);
326 if after_new_line {
327 self.writer.push_str("\n");
328 }
329 }
330 }
331
332 fn write_before_help(&mut self) {
333 debug!("HelpTemplate::write_before_help");
334 let before_help = if self.use_long {
335 self.cmd
336 .get_before_long_help()
337 .or_else(|| self.cmd.get_before_help())
338 } else {
339 self.cmd.get_before_help()
340 };
341 if let Some(output) = before_help {
342 let mut output = output.clone();
343 output.replace_newline_var();
344 output.wrap(self.term_w);
345 self.writer.push_styled(&output);
346 self.writer.push_str("\n\n");
347 }
348 }
349
350 fn write_after_help(&mut self) {
351 debug!("HelpTemplate::write_after_help");
352 let after_help = if self.use_long {
353 self.cmd
354 .get_after_long_help()
355 .or_else(|| self.cmd.get_after_help())
356 } else {
357 self.cmd.get_after_help()
358 };
359 if let Some(output) = after_help {
360 self.writer.push_str("\n\n");
361 let mut output = output.clone();
362 output.replace_newline_var();
363 output.wrap(self.term_w);
364 self.writer.push_styled(&output);
365 }
366 }
367}
368
369impl HelpTemplate<'_, '_> {
371 pub(crate) fn write_all_args(&mut self) {
374 debug!("HelpTemplate::write_all_args");
375 use std::fmt::Write as _;
376 let header = &self.styles.get_header();
377
378 let pos = self
379 .cmd
380 .get_positionals()
381 .filter(|a| a.get_help_heading().is_none())
382 .filter(|arg| should_show_arg(self.use_long, arg))
383 .collect::<Vec<_>>();
384 let non_pos = self
385 .cmd
386 .get_non_positionals()
387 .filter(|a| a.get_help_heading().is_none())
388 .filter(|arg| should_show_arg(self.use_long, arg))
389 .collect::<Vec<_>>();
390 let subcmds = self.cmd.has_visible_subcommands();
391
392 let custom_headings = self
393 .cmd
394 .get_arguments()
395 .filter_map(|arg| arg.get_help_heading())
396 .collect::<FlatSet<_>>();
397
398 let flatten = self.cmd.is_flatten_help_set();
399
400 let mut first = true;
401
402 if subcmds && !flatten {
403 if !first {
404 self.writer.push_str("\n\n");
405 }
406 first = false;
407 let default_help_heading = Str::from("Commands");
408 let help_heading = self
409 .cmd
410 .get_subcommand_help_heading()
411 .unwrap_or(&default_help_heading);
412 let _ = write!(self.writer, "{header}{help_heading}:{header:#}\n",);
413
414 self.write_subcommands(self.cmd);
415 }
416
417 if !pos.is_empty() {
418 if !first {
419 self.writer.push_str("\n\n");
420 }
421 first = false;
422 let help_heading = "Arguments";
424 let _ = write!(self.writer, "{header}{help_heading}:{header:#}\n",);
425 self.write_args(&pos, "Arguments", positional_sort_key);
426 }
427
428 if !non_pos.is_empty() {
429 if !first {
430 self.writer.push_str("\n\n");
431 }
432 first = false;
433 let help_heading = "Options";
434 let _ = write!(self.writer, "{header}{help_heading}:{header:#}\n",);
435 self.write_args(&non_pos, "Options", option_sort_key);
436 }
437 if !custom_headings.is_empty() {
438 for heading in custom_headings {
439 let args = self
440 .cmd
441 .get_arguments()
442 .filter(|a| {
443 if let Some(help_heading) = a.get_help_heading() {
444 return help_heading == heading;
445 }
446 false
447 })
448 .filter(|arg| should_show_arg(self.use_long, arg))
449 .collect::<Vec<_>>();
450
451 if !args.is_empty() {
452 if !first {
453 self.writer.push_str("\n\n");
454 }
455 first = false;
456 let _ = write!(self.writer, "{header}{heading}:{header:#}\n",);
457 self.write_args(&args, heading, option_sort_key);
458 }
459 }
460 }
461 if subcmds && flatten {
462 let mut cmd = self.cmd.clone();
463 cmd.build();
464 self.write_flat_subcommands(&cmd, &mut first);
465 }
466 }
467
468 fn write_args(&mut self, args: &[&Arg], _category: &str, sort_key: ArgSortKey) {
470 debug!("HelpTemplate::write_args {_category}");
471 let mut longest = 2;
473 let mut ord_v = BTreeMap::new();
474
475 for &arg in args.iter().filter(|arg| {
477 should_show_arg(self.use_long, arg)
481 }) {
482 if longest_filter(arg) {
483 let width = display_width(&arg.to_string());
484 let actual_width = if arg.is_positional() {
485 width
486 } else {
487 width + SHORT_SIZE
488 };
489 longest = longest.max(actual_width);
490 debug!(
491 "HelpTemplate::write_args: arg={:?} longest={}",
492 arg.get_id(),
493 longest
494 );
495 }
496
497 let key = (sort_key)(arg);
498 ord_v.insert(key, arg);
499 }
500
501 let next_line_help = self.will_args_wrap(args, longest);
502
503 for (i, (_, arg)) in ord_v.iter().enumerate() {
504 if i != 0 {
505 self.writer.push_str("\n");
506 if next_line_help && self.use_long {
507 self.writer.push_str("\n");
508 }
509 }
510 self.write_arg(arg, next_line_help, longest);
511 }
512 }
513
514 fn write_arg(&mut self, arg: &Arg, next_line_help: bool, longest: usize) {
516 let spec_vals = &self.spec_vals(arg);
517
518 self.writer.push_str(TAB);
519 self.short(arg);
520 self.long(arg);
521 self.writer
522 .push_styled(&arg.stylize_arg_suffix(self.styles, None));
523 self.align_to_about(arg, next_line_help, longest);
524
525 let about = if self.use_long {
526 arg.get_long_help()
527 .or_else(|| arg.get_help())
528 .unwrap_or_default()
529 } else {
530 arg.get_help()
531 .or_else(|| arg.get_long_help())
532 .unwrap_or_default()
533 };
534
535 self.help(Some(arg), about, spec_vals, next_line_help, longest);
536 }
537
538 fn short(&mut self, arg: &Arg) {
540 debug!("HelpTemplate::short");
541 use std::fmt::Write as _;
542 let literal = &self.styles.get_literal();
543
544 if let Some(s) = arg.get_short() {
545 let _ = write!(self.writer, "{literal}-{s}{literal:#}",);
546 } else if arg.get_long().is_some() {
547 self.writer.push_str(" ");
548 }
549 }
550
551 fn long(&mut self, arg: &Arg) {
553 debug!("HelpTemplate::long");
554 use std::fmt::Write as _;
555 let literal = &self.styles.get_literal();
556
557 if let Some(long) = arg.get_long() {
558 if arg.get_short().is_some() {
559 self.writer.push_str(", ");
560 }
561 let _ = write!(self.writer, "{literal}--{long}{literal:#}",);
562 }
563 }
564
565 fn align_to_about(&mut self, arg: &Arg, next_line_help: bool, longest: usize) {
567 debug!(
568 "HelpTemplate::align_to_about: arg={}, next_line_help={}, longest={}",
569 arg.get_id(),
570 next_line_help,
571 longest
572 );
573 let padding = if self.use_long || next_line_help {
574 debug!("HelpTemplate::align_to_about: printing long help so skip alignment");
576 0
577 } else if !arg.is_positional() {
578 let self_len = display_width(&arg.to_string()) + SHORT_SIZE;
579 let padding = if arg.get_long().is_some() {
582 TAB_WIDTH
584 } else {
585 TAB_WIDTH + 4
587 };
588 let spcs = longest + padding - self_len;
589 debug!(
590 "HelpTemplate::align_to_about: positional=false arg_len={self_len}, spaces={spcs}"
591 );
592
593 spcs
594 } else {
595 let self_len = display_width(&arg.to_string());
596 let padding = TAB_WIDTH;
597 let spcs = longest + padding - self_len;
598 debug!(
599 "HelpTemplate::align_to_about: positional=true arg_len={self_len}, spaces={spcs}",
600 );
601
602 spcs
603 };
604
605 self.write_padding(padding);
606 }
607
608 fn help(
610 &mut self,
611 arg: Option<&Arg>,
612 about: &StyledStr,
613 spec_vals: &str,
614 next_line_help: bool,
615 longest: usize,
616 ) {
617 debug!("HelpTemplate::help");
618 use std::fmt::Write as _;
619 let literal = &self.styles.get_literal();
620
621 if next_line_help {
623 debug!("HelpTemplate::help: Next Line...{next_line_help:?}");
624 self.writer.push_str("\n");
625 self.writer.push_str(TAB);
626 self.writer.push_str(NEXT_LINE_INDENT);
627 }
628
629 let spaces = if next_line_help {
630 TAB.len() + NEXT_LINE_INDENT.len()
631 } else {
632 longest + TAB_WIDTH * 2
633 };
634 let trailing_indent = spaces; let trailing_indent = self.get_spaces(trailing_indent);
636
637 let mut help = about.clone();
638 help.replace_newline_var();
639 if !spec_vals.is_empty() {
640 if !help.is_empty() {
641 let sep = if self.use_long && arg.is_some() {
642 "\n\n"
643 } else {
644 " "
645 };
646 help.push_str(sep);
647 }
648 help.push_str(spec_vals);
649 }
650 let avail_chars = self.term_w.saturating_sub(spaces);
651 debug!(
652 "HelpTemplate::help: help_width={}, spaces={}, avail={}",
653 spaces,
654 help.display_width(),
655 avail_chars
656 );
657 help.wrap(avail_chars);
658 help.indent("", &trailing_indent);
659 let help_is_empty = help.is_empty();
660 self.writer.push_styled(&help);
661 if let Some(arg) = arg {
662 if !arg.is_hide_possible_values_set() && self.use_long_pv(arg) {
663 const DASH_SPACE: usize = "- ".len();
664 let possible_vals = arg.get_possible_values();
665 if !possible_vals.is_empty() {
666 debug!("HelpTemplate::help: Found possible vals...{possible_vals:?}");
667 let longest = possible_vals
668 .iter()
669 .filter(|f| !f.is_hide_set())
670 .map(|f| display_width(f.get_name()))
671 .max()
672 .expect("Only called with possible value");
673
674 let spaces = spaces + TAB_WIDTH - DASH_SPACE;
675 let trailing_indent = spaces + DASH_SPACE;
676 let trailing_indent = self.get_spaces(trailing_indent);
677
678 if !help_is_empty {
679 let _ = write!(self.writer, "\n\n{:spaces$}", "");
680 }
681 self.writer.push_str("Possible values:");
682 for pv in possible_vals.iter().filter(|pv| !pv.is_hide_set()) {
683 let name = pv.get_name();
684
685 let mut descr = StyledStr::new();
686 let _ = write!(&mut descr, "{literal}{name}{literal:#}",);
687 if let Some(help) = pv.get_help() {
688 debug!("HelpTemplate::help: Possible Value help");
689 let padding = longest - display_width(name);
691 let _ = write!(&mut descr, ": {:padding$}", "");
692 descr.push_styled(help);
693 }
694
695 let avail_chars = if self.term_w > trailing_indent.len() {
696 self.term_w - trailing_indent.len()
697 } else {
698 usize::MAX
699 };
700 descr.replace_newline_var();
701 descr.wrap(avail_chars);
702 descr.indent("", &trailing_indent);
703
704 let _ = write!(self.writer, "\n{:spaces$}- ", "",);
705 self.writer.push_styled(&descr);
706 }
707 }
708 }
709 }
710 }
711
712 fn will_args_wrap(&self, args: &[&Arg], longest: usize) -> bool {
714 args.iter()
715 .filter(|arg| should_show_arg(self.use_long, arg))
716 .any(|arg| {
717 let spec_vals = &self.spec_vals(arg);
718 self.arg_next_line_help(arg, spec_vals, longest)
719 })
720 }
721
722 fn arg_next_line_help(&self, arg: &Arg, spec_vals: &str, longest: usize) -> bool {
723 if self.next_line_help || arg.is_next_line_help_set() || self.use_long {
724 true
726 } else {
727 let h = arg
729 .get_help()
730 .or_else(|| arg.get_long_help())
731 .unwrap_or_default();
732 let h_w = h.display_width() + display_width(spec_vals);
733 let taken = longest + TAB_WIDTH * 2;
734 self.term_w >= taken
735 && (taken as f32 / self.term_w as f32) > 0.40
736 && h_w > (self.term_w - taken)
737 }
738 }
739
740 fn spec_vals(&self, a: &Arg) -> String {
741 debug!("HelpTemplate::spec_vals: a={a}");
742 let ctx = &self.styles.get_context();
743 let ctx_val = &self.styles.get_context_value();
744 let val_sep = format!("{ctx}, {ctx:#}"); let mut spec_vals = Vec::new();
747 #[cfg(feature = "env")]
748 if let Some(ref env) = a.env {
749 if !a.is_hide_env_set() {
750 debug!(
751 "HelpTemplate::spec_vals: Found environment variable...[{:?}:{:?}]",
752 env.0, env.1
753 );
754 let env_val = if !a.is_hide_env_values_set() {
755 format!(
756 "={}",
757 env.1
758 .as_ref()
759 .map(|s| s.to_string_lossy())
760 .unwrap_or_default()
761 )
762 } else {
763 Default::default()
764 };
765 let env_info = format!(
766 "{ctx}[env: {ctx:#}{ctx_val}{}{}{ctx_val:#}{ctx}]{ctx:#}",
767 env.0.to_string_lossy(),
768 env_val
769 );
770 spec_vals.push(env_info);
771 }
772 }
773 if a.is_takes_value_set() && !a.is_hide_default_value_set() && !a.default_vals.is_empty() {
774 debug!(
775 "HelpTemplate::spec_vals: Found default value...[{:?}]",
776 a.default_vals
777 );
778
779 let dvs = a
780 .default_vals
781 .iter()
782 .map(|dv| dv.to_string_lossy())
783 .map(|dv| {
784 if dv.contains(char::is_whitespace) {
785 Cow::from(format!("{dv:?}"))
786 } else {
787 dv
788 }
789 })
790 .collect::<Vec<_>>()
791 .join(" ");
792
793 spec_vals.push(format!(
794 "{ctx}[default: {ctx:#}{ctx_val}{dvs}{ctx_val:#}{ctx}]{ctx:#}"
795 ));
796 }
797
798 let mut als = Vec::new();
799
800 let short_als = a
801 .short_aliases
802 .iter()
803 .filter(|&als| als.1) .map(|als| format!("{ctx_val}-{}{ctx_val:#}", als.0)); debug!(
806 "HelpTemplate::spec_vals: Found short aliases...{:?}",
807 a.short_aliases
808 );
809 als.extend(short_als);
810
811 let long_als = a
812 .aliases
813 .iter()
814 .filter(|&als| als.1) .map(|als| format!("{ctx_val}--{}{ctx_val:#}", als.0)); debug!("HelpTemplate::spec_vals: Found aliases...{:?}", a.aliases);
817 als.extend(long_als);
818
819 if !als.is_empty() {
820 let als = als.join(&val_sep);
821 spec_vals.push(format!("{ctx}[aliases: {ctx:#}{als}{ctx}]{ctx:#}"));
822 }
823
824 if !a.is_hide_possible_values_set() && !self.use_long_pv(a) {
825 let possible_vals = a.get_possible_values();
826 if !possible_vals.is_empty() {
827 debug!("HelpTemplate::spec_vals: Found possible vals...{possible_vals:?}");
828
829 let pvs = possible_vals
830 .iter()
831 .filter_map(PossibleValue::get_visible_quoted_name)
832 .map(|pv| format!("{ctx_val}{pv}{ctx_val:#}"))
833 .collect::<Vec<_>>()
834 .join(&val_sep);
835
836 spec_vals.push(format!("{ctx}[possible values: {ctx:#}{pvs}{ctx}]{ctx:#}"));
837 }
838 }
839 let connector = if self.use_long { "\n" } else { " " };
840 spec_vals.join(connector)
841 }
842
843 fn get_spaces(&self, n: usize) -> String {
844 " ".repeat(n)
845 }
846
847 fn write_padding(&mut self, amount: usize) {
848 use std::fmt::Write as _;
849 let _ = write!(self.writer, "{:amount$}", "");
850 }
851
852 fn use_long_pv(&self, arg: &Arg) -> bool {
853 self.use_long
854 && arg
855 .get_possible_values()
856 .iter()
857 .any(PossibleValue::should_show_help)
858 }
859}
860
861impl HelpTemplate<'_, '_> {
863 fn write_flat_subcommands(&mut self, cmd: &Command, first: &mut bool) {
865 debug!(
866 "HelpTemplate::write_flat_subcommands, cmd={}, first={}",
867 cmd.get_name(),
868 *first
869 );
870 use std::fmt::Write as _;
871 let header = &self.styles.get_header();
872
873 let mut ord_v = BTreeMap::new();
874 for subcommand in cmd
875 .get_subcommands()
876 .filter(|subcommand| should_show_subcommand(subcommand))
877 {
878 ord_v.insert(
879 (subcommand.get_display_order(), subcommand.get_name()),
880 subcommand,
881 );
882 }
883 for (_, subcommand) in ord_v {
884 if !*first {
885 self.writer.push_str("\n\n");
886 }
887 *first = false;
888
889 let heading = subcommand.get_usage_name_fallback();
890 let about = subcommand
891 .get_about()
892 .or_else(|| subcommand.get_long_about())
893 .unwrap_or_default();
894
895 let _ = write!(self.writer, "{header}{heading}:{header:#}",);
896 if !about.is_empty() {
897 let _ = write!(self.writer, "\n{about}",);
898 }
899
900 let args = subcommand
901 .get_arguments()
902 .filter(|arg| should_show_arg(self.use_long, arg) && !arg.is_global_set())
903 .collect::<Vec<_>>();
904 if !args.is_empty() {
905 self.writer.push_str("\n");
906 }
907
908 let mut sub_help = HelpTemplate {
909 writer: self.writer,
910 cmd: subcommand,
911 styles: self.styles,
912 usage: self.usage,
913 next_line_help: self.next_line_help,
914 term_w: self.term_w,
915 use_long: self.use_long,
916 };
917 sub_help.write_args(&args, heading, option_sort_key);
918 if subcommand.is_flatten_help_set() {
919 sub_help.write_flat_subcommands(subcommand, first);
920 }
921 }
922 }
923
924 fn write_subcommands(&mut self, cmd: &Command) {
926 debug!("HelpTemplate::write_subcommands");
927 use std::fmt::Write as _;
928 let literal = &self.styles.get_literal();
929
930 let mut longest = 2;
932 let mut ord_v = BTreeMap::new();
933 for subcommand in cmd
934 .get_subcommands()
935 .filter(|subcommand| should_show_subcommand(subcommand))
936 {
937 let mut styled = StyledStr::new();
938 let name = subcommand.get_name();
939 let _ = write!(styled, "{literal}{name}{literal:#}",);
940 if let Some(short) = subcommand.get_short_flag() {
941 let _ = write!(styled, ", {literal}-{short}{literal:#}",);
942 }
943 if let Some(long) = subcommand.get_long_flag() {
944 let _ = write!(styled, ", {literal}--{long}{literal:#}",);
945 }
946 longest = longest.max(styled.display_width());
947 ord_v.insert((subcommand.get_display_order(), styled), subcommand);
948 }
949
950 debug!("HelpTemplate::write_subcommands longest = {longest}");
951
952 let next_line_help = self.will_subcommands_wrap(cmd.get_subcommands(), longest);
953
954 for (i, (sc_str, sc)) in ord_v.into_iter().enumerate() {
955 if 0 < i {
956 self.writer.push_str("\n");
957 }
958 self.write_subcommand(sc_str.1, sc, next_line_help, longest);
959 }
960 }
961
962 fn will_subcommands_wrap<'a>(
964 &self,
965 subcommands: impl IntoIterator<Item = &'a Command>,
966 longest: usize,
967 ) -> bool {
968 subcommands
969 .into_iter()
970 .filter(|&subcommand| should_show_subcommand(subcommand))
971 .any(|subcommand| {
972 let spec_vals = &self.sc_spec_vals(subcommand);
973 self.subcommand_next_line_help(subcommand, spec_vals, longest)
974 })
975 }
976
977 fn write_subcommand(
978 &mut self,
979 sc_str: StyledStr,
980 cmd: &Command,
981 next_line_help: bool,
982 longest: usize,
983 ) {
984 debug!("HelpTemplate::write_subcommand");
985
986 let spec_vals = &self.sc_spec_vals(cmd);
987
988 let about = cmd
989 .get_about()
990 .or_else(|| cmd.get_long_about())
991 .unwrap_or_default();
992
993 self.subcmd(sc_str, next_line_help, longest);
994 self.help(None, about, spec_vals, next_line_help, longest);
995 }
996
997 fn sc_spec_vals(&self, a: &Command) -> String {
998 debug!("HelpTemplate::sc_spec_vals: a={}", a.get_name());
999 let ctx = &self.styles.get_context();
1000 let ctx_val = &self.styles.get_context_value();
1001 let val_sep = format!("{ctx}, {ctx:#}"); let mut spec_vals = vec![];
1003
1004 let mut short_als = a
1005 .get_visible_short_flag_aliases()
1006 .map(|a| format!("{ctx_val}-{a}{ctx_val:#}"))
1007 .collect::<Vec<_>>();
1008 let als = a
1009 .get_visible_aliases()
1010 .map(|s| format!("{ctx_val}{s}{ctx_val:#}"));
1011 short_als.extend(als);
1012 let all_als = short_als.join(&val_sep);
1013 if !all_als.is_empty() {
1014 debug!(
1015 "HelpTemplate::spec_vals: Found aliases...{:?}",
1016 a.get_all_aliases().collect::<Vec<_>>()
1017 );
1018 debug!(
1019 "HelpTemplate::spec_vals: Found short flag aliases...{:?}",
1020 a.get_all_short_flag_aliases().collect::<Vec<_>>()
1021 );
1022 spec_vals.push(format!("{ctx}[aliases: {ctx:#}{all_als}{ctx}]{ctx:#}"));
1023 }
1024
1025 spec_vals.join(" ")
1026 }
1027
1028 fn subcommand_next_line_help(&self, cmd: &Command, spec_vals: &str, longest: usize) -> bool {
1029 if self.next_line_help {
1031 true
1033 } else {
1034 let h = cmd
1036 .get_about()
1037 .or_else(|| cmd.get_long_about())
1038 .unwrap_or_default();
1039 let h_w = h.display_width() + display_width(spec_vals);
1040 let taken = longest + TAB_WIDTH * 2;
1041 self.term_w >= taken
1042 && (taken as f32 / self.term_w as f32) > 0.40
1043 && h_w > (self.term_w - taken)
1044 }
1045 }
1046
1047 fn subcmd(&mut self, sc_str: StyledStr, next_line_help: bool, longest: usize) {
1049 self.writer.push_str(TAB);
1050 self.writer.push_styled(&sc_str);
1051 if !next_line_help {
1052 let width = sc_str.display_width();
1053 let padding = longest + TAB_WIDTH - width;
1054 self.write_padding(padding);
1055 }
1056 }
1057}
1058
1059const NEXT_LINE_INDENT: &str = " ";
1060
1061type ArgSortKey = fn(arg: &Arg) -> (usize, String);
1062
1063fn positional_sort_key(arg: &Arg) -> (usize, String) {
1064 (arg.get_index().unwrap_or(0), String::new())
1065}
1066
1067fn option_sort_key(arg: &Arg) -> (usize, String) {
1068 let key = if let Some(x) = arg.get_short() {
1077 let mut s = x.to_ascii_lowercase().to_string();
1078 s.push(if x.is_ascii_lowercase() { '0' } else { '1' });
1079 s
1080 } else if let Some(x) = arg.get_long() {
1081 x.to_string()
1082 } else {
1083 let mut s = '{'.to_string();
1084 s.push_str(arg.get_id().as_str());
1085 s
1086 };
1087 (arg.get_display_order(), key)
1088}
1089
1090pub(crate) fn dimensions() -> (Option<usize>, Option<usize>) {
1091 #[cfg(not(feature = "wrap_help"))]
1092 return (None, None);
1093
1094 #[cfg(feature = "wrap_help")]
1095 terminal_size::terminal_size()
1096 .map(|(w, h)| (Some(w.0.into()), Some(h.0.into())))
1097 .unwrap_or_else(|| (parse_env("COLUMNS"), parse_env("LINES")))
1098}
1099
1100#[cfg(feature = "wrap_help")]
1101fn parse_env(var: &str) -> Option<usize> {
1102 some!(some!(std::env::var_os(var)).to_str())
1103 .parse::<usize>()
1104 .ok()
1105}
1106
1107fn should_show_arg(use_long: bool, arg: &Arg) -> bool {
1108 debug!(
1109 "should_show_arg: use_long={:?}, arg={}",
1110 use_long,
1111 arg.get_id()
1112 );
1113 if arg.is_hide_set() {
1114 return false;
1115 }
1116 (!arg.is_hide_long_help_set() && use_long)
1117 || (!arg.is_hide_short_help_set() && !use_long)
1118 || arg.is_next_line_help_set()
1119}
1120
1121fn should_show_subcommand(subcommand: &Command) -> bool {
1122 !subcommand.is_hide_set()
1123}
1124
1125fn longest_filter(arg: &Arg) -> bool {
1126 arg.is_takes_value_set() || arg.get_long().is_some() || arg.get_short().is_none()
1127}
1128
1129#[cfg(test)]
1130mod test {
1131 #[test]
1132 #[cfg(feature = "wrap_help")]
1133 fn wrap_help_last_word() {
1134 use super::*;
1135
1136 let help = String::from("foo bar baz");
1137 assert_eq!(wrap(&help, 5), "foo\nbar\nbaz");
1138 }
1139
1140 #[test]
1141 #[cfg(feature = "unicode")]
1142 fn display_width_handles_non_ascii() {
1143 use super::*;
1144
1145 let text = "rødgrød med fløde";
1147 assert_eq!(display_width(text), 17);
1148 assert_eq!(text.len(), 20);
1151 }
1152
1153 #[test]
1154 #[cfg(feature = "unicode")]
1155 fn display_width_handles_emojis() {
1156 use super::*;
1157
1158 let text = "😂";
1159 assert_eq!(text.chars().count(), 1);
1161 assert_eq!(display_width(text), 2);
1163 assert_eq!(text.len(), 4);
1165 }
1166}