    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423
    424
    425
    426
    427
    428
    429
    430
    431
    432
    433
    434
    435
    436
    437
    438
    439
    440
    441

    #![cfg_attr(not(feature = "usage"), allow(unused_imports))]
    #![cfg_attr(not(feature = "usage"), allow(unused_variables))]
    #![cfg_attr(not(feature = "usage"), allow(clippy::manual_map))]
    #![cfg_attr(not(feature = "usage"), allow(dead_code))]

    // Internal
    use crate::builder::StyledStr;
    use crate::builder::{ArgPredicate, Command};
    use crate::parser::ArgMatcher;
    use crate::util::ChildGraph;
    use crate::util::FlatSet;
    use crate::util::Id;

    static DEFAULT_SUB_VALUE_NAME: &str = "COMMAND";

    pub(crate) struct Usage<'cmd> {
        cmd: &'cmd Command,
        required: Option<&'cmd ChildGraph<Id>>,
    }

    impl<'cmd> Usage<'cmd> {
        pub(crate) fn new(cmd: &'cmd Command) -> Self {
            Usage {
                cmd,
                required: None,
            }
        }

        pub(crate) fn required(mut self, required: &'cmd ChildGraph<Id>) -> Self {
            self.required = Some(required);
            self
        }

        // Creates a usage string for display. This happens just after all arguments were parsed, but before
        // any subcommands have been parsed (so as to give subcommands their own usage recursively)
        pub(crate) fn create_usage_with_title(&self, used: &[Id]) -> Option<StyledStr> {
            debug!("Usage::create_usage_with_title");
            let usage = some!(self.create_usage_no_title(used));

            let mut styled = StyledStr::new();
            styled.header("Usage:");
            styled.none(" ");
            styled.extend(usage.into_iter());
            Some(styled)
        }

        // Creates a usage string (*without title*) if one was not provided by the user manually.
        pub(crate) fn create_usage_no_title(&self, used: &[Id]) -> Option<StyledStr> {
            debug!("Usage::create_usage_no_title");
            if let Some(u) = self.cmd.get_override_usage() {
                Some(u.clone())
            } else {
                #[cfg(feature = "usage")]
                {
                    if used.is_empty() {
                        Some(self.create_help_usage(true))
                    } else {
                        Some(self.create_smart_usage(used))
                    }
                }

                #[cfg(not(feature = "usage"))]
                {
                    None
                }
            }
        }
    }

    #[cfg(feature = "usage")]
    impl<'cmd> Usage<'cmd> {
        // Creates a usage string for display in help messages (i.e. not for errors)
        fn create_help_usage(&self, incl_reqs: bool) -> StyledStr {
            debug!("Usage::create_help_usage; incl_reqs={:?}", incl_reqs);
            let mut styled = StyledStr::new();
            let name = self
                .cmd
                .get_usage_name()
                .or_else(|| self.cmd.get_bin_name())
                .unwrap_or_else(|| self.cmd.get_name());
            styled.literal(name);

            if self.needs_options_tag() {
                styled.placeholder(" [OPTIONS]");
            }

            self.write_args(&[], !incl_reqs, &mut styled);

            // incl_reqs is only false when this function is called recursively
            if self.cmd.has_visible_subcommands() && incl_reqs
                || self.cmd.is_allow_external_subcommands_set()
            {
                let placeholder = self
                    .cmd
                    .get_subcommand_value_name()
                    .unwrap_or(DEFAULT_SUB_VALUE_NAME);
                if self.cmd.is_subcommand_negates_reqs_set()
                    || self.cmd.is_args_conflicts_with_subcommands_set()
                {
                    styled.none("\n");
                    styled.none("       ");
                    if self.cmd.is_args_conflicts_with_subcommands_set() {
                        // Short-circuit full usage creation since no args will be relevant
                        styled.literal(name);
                    } else {
                        styled.extend(self.create_help_usage(false).into_iter());
                    }
                    styled.placeholder(" <");
                    styled.placeholder(placeholder);
                    styled.placeholder(">");
                } else if self.cmd.is_subcommand_required_set() {
                    styled.placeholder(" <");
                    styled.placeholder(placeholder);
                    styled.placeholder(">");
                } else {
                    styled.placeholder(" [");
                    styled.placeholder(placeholder);
                    styled.placeholder("]");
                }
            }
            styled.trim();
            debug!("Usage::create_help_usage: usage={}", styled);
            styled
        }

        // Creates a context aware usage string, or "smart usage" from currently used
        // args, and requirements
        fn create_smart_usage(&self, used: &[Id]) -> StyledStr {
            debug!("Usage::create_smart_usage");
            let mut styled = StyledStr::new();

            styled.literal(
                self.cmd
                    .get_usage_name()
                    .or_else(|| self.cmd.get_bin_name())
                    .unwrap_or_else(|| self.cmd.get_name()),
            );

            self.write_args(used, false, &mut styled);

            if self.cmd.is_subcommand_required_set() {
                styled.placeholder(" <");
                styled.placeholder(
                    self.cmd
                        .get_subcommand_value_name()
                        .unwrap_or(DEFAULT_SUB_VALUE_NAME),
                );
                styled.placeholder(">");
            }
            styled
        }

        // Determines if we need the `[OPTIONS]` tag in the usage string
        fn needs_options_tag(&self) -> bool {
            debug!("Usage::needs_options_tag");
            'outer: for f in self.cmd.get_non_positionals() {
                debug!("Usage::needs_options_tag:iter: f={}", f.get_id());

                // Don't print `[OPTIONS]` just for help or version
                if f.get_long() == Some("help") || f.get_long() == Some("version") {
                    debug!("Usage::needs_options_tag:iter Option is built-in");
                    continue;
                }

                if f.is_hide_set() {
                    debug!("Usage::needs_options_tag:iter Option is hidden");
                    continue;
                }
                if f.is_required_set() {
                    debug!("Usage::needs_options_tag:iter Option is required");
                    continue;
                }
                for grp_s in self.cmd.groups_for_arg(f.get_id()) {
                    debug!("Usage::needs_options_tag:iter:iter: grp_s={:?}", grp_s);
                    if self.cmd.get_groups().any(|g| g.id == grp_s && g.required) {
                        debug!("Usage::needs_options_tag:iter:iter: Group is required");
                        continue 'outer;
                    }
                }

                debug!("Usage::needs_options_tag:iter: [OPTIONS] required");
                return true;
            }

            debug!("Usage::needs_options_tag: [OPTIONS] not required");
            false
        }

        // Returns the required args in usage string form by fully unrolling all groups
        pub(crate) fn write_args(&self, incls: &[Id], force_optional: bool, styled: &mut StyledStr) {
            for required in self.get_args(incls, force_optional) {
                styled.none(" ");
                styled.extend(required.into_iter());
            }
        }

        pub(crate) fn get_args(&self, incls: &[Id], force_optional: bool) -> Vec<StyledStr> {
            debug!("Usage::get_args: incls={:?}", incls,);

            let required_owned;
            let required = if let Some(required) = self.required {
                required
            } else {
                required_owned = self.cmd.required_graph();
                &required_owned
            };

            let mut unrolled_reqs = Vec::new();
            for a in required.iter() {
                let is_relevant = |(val, req_arg): &(ArgPredicate, Id)| -> Option<Id> {
                    let required = match val {
                        ArgPredicate::Equals(_) => false,
                        ArgPredicate::IsPresent => true,
                    };
                    required.then(|| req_arg.clone())
                };

                for aa in self.cmd.unroll_arg_requires(is_relevant, a) {
                    // if we don't check for duplicates here this causes duplicate error messages
                    // see https://github.com/clap-rs/clap/issues/2770
                    unrolled_reqs.push(aa);
                }
                // always include the required arg itself. it will not be enumerated
                // by unroll_requirements_for_arg.
                unrolled_reqs.push(a.clone());
            }
            debug!("Usage::get_args: unrolled_reqs={:?}", unrolled_reqs);

            let mut required_groups_members = FlatSet::new();
            let mut required_groups = FlatSet::new();
            for req in unrolled_reqs.iter().chain(incls.iter()) {
                if self.cmd.find_group(req).is_some() {
                    let group_members = self.cmd.unroll_args_in_group(req);
                    let elem = self.cmd.format_group(req);
                    required_groups.insert(elem);
                    required_groups_members.extend(group_members);
                } else {
                    debug_assert!(self.cmd.find(req).is_some());
                }
            }

            let mut required_opts = FlatSet::new();
            let mut required_positionals = Vec::new();
            for req in unrolled_reqs.iter().chain(incls.iter()) {
                if let Some(arg) = self.cmd.find(req) {
                    if required_groups_members.contains(arg.get_id()) {
                        continue;
                    }

                    let stylized = arg.stylized(Some(!force_optional));
                    if let Some(index) = arg.get_index() {
                        let new_len = index + 1;
                        if required_positionals.len() < new_len {
                            required_positionals.resize(new_len, None);
                        }
                        required_positionals[index] = Some(stylized);
                    } else {
                        required_opts.insert(stylized);
                    }
                } else {
                    debug_assert!(self.cmd.find_group(req).is_some());
                }
            }

            for pos in self.cmd.get_positionals() {
                if pos.is_hide_set() {
                    continue;
                }
                if required_groups_members.contains(pos.get_id()) {
                    continue;
                }

                let index = pos.get_index().unwrap();
                let new_len = index + 1;
                if required_positionals.len() < new_len {
                    required_positionals.resize(new_len, None);
                }
                if required_positionals[index].is_some() {
                    if pos.is_last_set() {
                        let styled = required_positionals[index].take().unwrap();
                        let mut new = StyledStr::new();
                        new.literal("-- ");
                        new.extend(styled.into_iter());
                        required_positionals[index] = Some(new);
                    }
                } else {
                    let mut styled;
                    if pos.is_last_set() {
                        styled = StyledStr::new();
                        styled.literal("[-- ");
                        styled.extend(pos.stylized(Some(true)).into_iter());
                        styled.literal("]");
                    } else {
                        styled = pos.stylized(Some(false));
                    }
                    required_positionals[index] = Some(styled);
                }
                if pos.is_last_set() && force_optional {
                    required_positionals[index] = None;
                }
            }

            let mut ret_val = Vec::new();
            if !force_optional {
                ret_val.extend(required_opts);
                ret_val.extend(required_groups);
            }
            for pos in required_positionals.into_iter().flatten() {
                ret_val.push(pos);
            }

            debug!("Usage::get_args: ret_val={:?}", ret_val);
            ret_val
        }

        pub(crate) fn get_required_usage_from(
            &self,
            incls: &[Id],
            matcher: Option<&ArgMatcher>,
            incl_last: bool,
        ) -> Vec<StyledStr> {
            debug!(
                "Usage::get_required_usage_from: incls={:?}, matcher={:?}, incl_last={:?}",
                incls,
                matcher.is_some(),
                incl_last
            );

            let required_owned;
            let required = if let Some(required) = self.required {
                required
            } else {
                required_owned = self.cmd.required_graph();
                &required_owned
            };

            let mut unrolled_reqs = Vec::new();
            for a in required.iter() {
                let is_relevant = |(val, req_arg): &(ArgPredicate, Id)| -> Option<Id> {
                    let required = match val {
                        ArgPredicate::Equals(_) => {
                            if let Some(matcher) = matcher {
                                matcher.check_explicit(a, val)
                            } else {
                                false
                            }
                        }
                        ArgPredicate::IsPresent => true,
                    };
                    required.then(|| req_arg.clone())
                };

                for aa in self.cmd.unroll_arg_requires(is_relevant, a) {
                    // if we don't check for duplicates here this causes duplicate error messages
                    // see https://github.com/clap-rs/clap/issues/2770
                    unrolled_reqs.push(aa);
                }
                // always include the required arg itself. it will not be enumerated
                // by unroll_requirements_for_arg.
                unrolled_reqs.push(a.clone());
            }
            debug!(
                "Usage::get_required_usage_from: unrolled_reqs={:?}",
                unrolled_reqs
            );

            let mut required_groups_members = FlatSet::new();
            let mut required_groups = FlatSet::new();
            for req in unrolled_reqs.iter().chain(incls.iter()) {
                if self.cmd.find_group(req).is_some() {
                    let group_members = self.cmd.unroll_args_in_group(req);
                    let is_present = matcher
                        .map(|m| {
                            group_members
                                .iter()
                                .any(|arg| m.check_explicit(arg, &ArgPredicate::IsPresent))
                        })
                        .unwrap_or(false);
                    debug!(
                        "Usage::get_required_usage_from:iter:{:?} group is_present={}",
                        req, is_present
                    );
                    if is_present {
                        continue;
                    }

                    let elem = self.cmd.format_group(req);
                    required_groups.insert(elem);
                    required_groups_members.extend(group_members);
                } else {
                    debug_assert!(self.cmd.find(req).is_some());
                }
            }

            let mut required_opts = FlatSet::new();
            let mut required_positionals = Vec::new();
            for req in unrolled_reqs.iter().chain(incls.iter()) {
                if let Some(arg) = self.cmd.find(req) {
                    if required_groups_members.contains(arg.get_id()) {
                        continue;
                    }

                    let is_present = matcher
                        .map(|m| m.check_explicit(req, &ArgPredicate::IsPresent))
                        .unwrap_or(false);
                    debug!(
                        "Usage::get_required_usage_from:iter:{:?} arg is_present={}",
                        req, is_present
                    );
                    if is_present {
                        continue;
                    }

                    let stylized = arg.stylized(Some(true));
                    if let Some(index) = arg.get_index() {
                        if !arg.is_last_set() || incl_last {
                            let new_len = index + 1;
                            if required_positionals.len() < new_len {
                                required_positionals.resize(new_len, None);
                            }
                            required_positionals[index] = Some(stylized);
                        }
                    } else {
                        required_opts.insert(stylized);
                    }
                } else {
                    debug_assert!(self.cmd.find_group(req).is_some());
                }
            }

            let mut ret_val = Vec::new();
            ret_val.extend(required_opts);
            ret_val.extend(required_groups);
            for pos in required_positionals.into_iter().flatten() {
                ret_val.push(pos);
            }

            debug!("Usage::get_required_usage_from: ret_val={:?}", ret_val);
            ret_val
        }
    }