Class command

include/lyra/command.hpp:51–129

tag::reference[] [#lyra_command] = `lyra::command` A parser that encapsulates the pattern of parsing sub-commands. It provides a quick wrapper for the equivalent arrangement of `group` and `literal` parsers. For example: [source] ---- lyra::command c = lyra::command("sub"); ---- Is equivalent to: [source] ---- lyra::command c = lyra::group() .sequential() .add_argument(literal("sub")) .add

*/ // end::reference[]
class command : public group
{
	public:
	// Construction, with and without, callback.
	explicit command(const std::string & n);
	command(
		const std::string & n, const std::function<void(const group &)> & f);

	// Help description.
	command & help(const std::string & text);
	command & operator()(std::string const & description);

	// Add arguments.
	template <typename P>
	command & add_argument(P const & p);
	template <typename P>
	command & operator|=(P const & p);

	// Settings.
	command & brief_help(bool brief = true);
	command & optional() { return static_cast<command &>(group::optional()); }
	command & required(std::size_t n = 1)
	{
		return static_cast<command &>(group::required(n));
	}
	command & cardinality(std::size_t n)
	{
		return static_cast<command &>(group::cardinality(n));
	}
	command & cardinality(std::size_t n, std::size_t m)
	{
		return static_cast<command &>(group::cardinality(n, m));
	}

	// Internal.
	std::unique_ptr<parser> clone() const override
	{
		return make_clone<command>(this);
	}
	detail::parser_cardinality cardinality() const override
	{
		return group::cardinality();
	}

	std::string get_usage_text(const option_style & style) const override
	{
		auto tail = parsers[1]->get_usage_text(style);
		return parsers[0]->get_usage_text(style)
			+ (tail.empty() ? (tail) : (" " + tail));
	}

	protected:
	bool expanded_help_details = true;

	std::string get_print_order_key(const option_style & style) const override
	{
		return parsers[0]->get_print_order_key(style);
	}