Option needs an another one with a given value

[wsbak]

Hello all,

I did not find a way to specify it.
Is there anyone ?

Proposition : Option *needs_true(std::function<bool()> must_return_true, const std::string& help_message);

TEST_CASE_METHOD(TApp, "NeedsTrue", "[app]") {
    std::string str;
    CLI::Option *opts = app.add_option("-s,--string", str);
    app.add_flag("--opt1")->needs_true([&]() { return str == "val_with_opt1"; }, "--string val_with_opt1");

    run();

    args = {"--opt1"};
    CHECK_THROWS_AS(run(), CLI::RequiresError);

    args = {"--string", "val"};
    run();

    args = {"--string", "val", "--opt1"};
    CHECK_THROWS_AS(run(), CLI::RequiresError);

    args = {"--string", "val_with_opt1", "--opt1"};
    run();

    args = {"--opt1", "--string", "val_with_opt1"};  // order is not revelant
    run();
}

RequiresError.what() will give : --opt1 requires --string val_with_opt1

Thanks,
Olivier

[phlptp]

TEST_CASE_METHOD(TApp, "NeedsTrue", "[app]") {
    std::string str;
    CLI::Option *opts = app.add_option("-s,--string", str);
    app.add_flag("--opt1")->check([&](const std::string &) {
         return (str != "val_with_opt1")?std::string("--opt1 requires --string val_with_opt1"):std::string{};
});

    run();

    args = {"--opt1"};
    CHECK_THROWS_AS(run(), CLI::ValidationError);

    args = {"--string", "val"};
    run();

    args = {"--string", "val", "--opt1"};
    CHECK_THROWS_AS(run(), CLI::ValidationError);

    args = {"--string", "val_with_opt1", "--opt1"};
    run();

    args = {"--opt1", "--string", "val_with_opt1"};  // order is not revelant
    run();
}

The check method can be used for this purpose and other general validation operations.

[wsbak]

Thanks, it works

But I need the same thing for Option_group
Option_group does not have check
Do you have a solution ?

[phlptp]

option groups like subcommands have a series of callbacks that can be executed at various stages of the processing. These can function similarly to the check option.

these include

/// executed after processing is complete
    App *final_callback(std::function<void()> app_callback);

    /// Set a callback to execute when parsing has completed for the app
    ///
    App *parse_complete_callback(std::function<void()> pc_callback) {
        parse_complete_callback_ = std::move(pc_callback);
        return this;
    }

    /// Set a callback to execute prior to parsing.
    ///
    App *preparse_callback(std::function<void(std::size_t)> pp_callback);

So if you wanted a function similar to check for an option_group, set up one of the callbacks that has access to the required data and generate a CLI::ValidationError or some other similar error if the check fails. You might also have to add some extra description somewhere at your discretion.