mirror of
https://github.com/CLIUtils/CLI11.git
synced 2025-04-29 12:13:52 +00:00
af2ed66d6e
Removing OptionFormatter Rename files Rename to just Formatter Remove OptionFormatMode (just needs a bool) Renaming option functions on formatter
128 lines
3.6 KiB
C++
128 lines
3.6 KiB
C++
#pragma once
|
|
|
|
// Distributed under the 3-Clause BSD License. See accompanying
|
|
// file LICENSE or https://github.com/CLIUtils/CLI11 for details.
|
|
|
|
#include <string>
|
|
#include <map>
|
|
|
|
#include "CLI/StringTools.hpp"
|
|
|
|
namespace CLI {
|
|
|
|
class Option;
|
|
class App;
|
|
|
|
/// This enum signifies the type of help requested
|
|
///
|
|
/// This is passed in by App; all user classes must accept this as
|
|
/// the second argument.
|
|
|
|
enum class AppFormatMode {
|
|
Normal, //< The normal, detailed help
|
|
All, //< A fully expanded help
|
|
Sub, //< Used when printed as part of expanded subcommand
|
|
};
|
|
|
|
class Formatter {
|
|
/// @name Options
|
|
///@{
|
|
|
|
/// The width of the first column
|
|
size_t column_width_{30};
|
|
|
|
/// @brief The required help printout labels (user changeable)
|
|
/// Values are Needs, Excludes, etc.
|
|
std::map<std::string, std::string> labels_;
|
|
|
|
///@}
|
|
/// @name Basic
|
|
///@{
|
|
|
|
public:
|
|
Formatter() = default;
|
|
Formatter(const Formatter &) = default;
|
|
Formatter(Formatter &&) = default;
|
|
///@}
|
|
/// @name Setters
|
|
///@{
|
|
|
|
/// Set the "REQUIRED" label
|
|
void label(std::string key, std::string val) { labels_[key] = val; }
|
|
|
|
/// Set the column width
|
|
void column_width(size_t val) { column_width_ = val; }
|
|
|
|
///@}
|
|
/// @name Getters
|
|
///@{
|
|
|
|
/// Get the current value of a name (REQUIRED, etc.)
|
|
std::string get_label(std::string key) const {
|
|
if(labels_.find(key) == labels_.end())
|
|
return key;
|
|
else
|
|
return labels_.at(key);
|
|
}
|
|
|
|
/// Get the current column width
|
|
size_t get_column_width() const { return column_width_; }
|
|
|
|
/// @name Overridables
|
|
///@{
|
|
|
|
/// This prints out a group of options
|
|
virtual std::string make_group(std::string group, std::vector<const Option *> opts, bool is_positional) const;
|
|
|
|
/// This prints out all the groups of options
|
|
virtual std::string make_groups(const App *app, AppFormatMode mode) const;
|
|
|
|
/// This prints out all the subcommands
|
|
virtual std::string make_subcommands(const App *app, AppFormatMode mode) const;
|
|
|
|
/// This prints out a subcommand
|
|
virtual std::string make_subcommand(const App *sub) const;
|
|
|
|
/// This prints out a subcommand in help-all
|
|
virtual std::string make_expanded(const App *sub) const;
|
|
|
|
/// This prints out all the groups of options
|
|
virtual std::string make_footer(const App *app) const;
|
|
|
|
/// This displays the description line
|
|
virtual std::string make_description(const App *app) const;
|
|
|
|
/// This displays the usage line
|
|
virtual std::string make_usage(const App *app, std::string name) const;
|
|
|
|
/// This puts everything together
|
|
virtual std::string operator()(const App *, std::string, AppFormatMode) const;
|
|
|
|
///@}
|
|
/// @name Options
|
|
///@{
|
|
|
|
virtual std::string make_option(const Option *opt, bool is_positional) const {
|
|
std::stringstream out;
|
|
detail::format_help(
|
|
out, make_option_name(opt, is_positional) + make_option_opts(opt), make_option_desc(opt), column_width_);
|
|
return out.str();
|
|
}
|
|
|
|
/// @brief This is the name part of an option, Default: left column
|
|
virtual std::string make_option_name(const Option *, bool) const;
|
|
|
|
/// @brief This is the options part of the name, Default: combined into left column
|
|
virtual std::string make_option_opts(const Option *) const;
|
|
|
|
/// @brief This is the description. Default: Right column, on new line if left column too large
|
|
virtual std::string make_option_desc(const Option *) const;
|
|
|
|
/// @brief This is used to print the name on the USAGE line
|
|
virtual std::string make_option_usage(const Option *opt) const;
|
|
|
|
///@}
|
|
};
|
|
|
|
} // namespace CLI
|