FormatterFwd.hpp

Go to the documentation of this file.

// Copyright (c) 2017-2026, University of Cincinnati, developed by Henry Schreiner
// under NSF AWARD 1414736 and by the respective contributors.
// All rights reserved.
//
// SPDX-License-Identifier: BSD-3-Clause
 
#pragma once
 
// IWYU pragma: private, include "CLI/CLI.hpp"
 
// [CLI11:public_includes:set]
#include <functional>
#include <map>
#include <string>
#include <utility>
#include <vector>
// [CLI11:public_includes:end]
 
#include "StringTools.hpp"
 
namespace CLI {
// [CLI11:formatter_fwd_hpp:verbatim]
 
class Option;
class App;

 
enum class AppFormatMode : std::uint8_t {
    Normal,  
    All,     
    Sub,     
};

class FormatterBase {
  protected:

    std::size_t column_width_{30};

    float long_option_alignment_ratio_{1 / 3.f};

    std::size_t right_column_width_{65};

    std::size_t description_paragraph_width_{80};

    std::size_t footer_paragraph_width_{80};

    bool enable_description_formatting_{true};
    bool enable_footer_formatting_{true};

    bool enable_option_defaults_{true};
    bool enable_option_type_names_{true};
    bool enable_default_flag_values_{true};
    std::map<std::string, std::string> labels_{};

 
  public:
    FormatterBase() = default;
    FormatterBase(const FormatterBase &) = default;
    FormatterBase(FormatterBase &&) = default;
    FormatterBase &operator=(const FormatterBase &) = default;
    FormatterBase &operator=(FormatterBase &&) = default;

    virtual ~FormatterBase() noexcept {}  // NOLINT(modernize-use-equals-default)

    virtual std::string make_help(const App *, std::string, AppFormatMode) const = 0;


    void label(std::string key, std::string val) { labels_[key] = val; }

    void column_width(std::size_t val) { column_width_ = val; }

    void long_option_alignment_ratio(float ratio) {
        long_option_alignment_ratio_ =
            (ratio >= 0.0f) ? ((ratio <= 1.0f) ? ratio : 1.0f / ratio) : ((ratio < -1.0f) ? 1.0f / (-ratio) : -ratio);
    }

    void right_column_width(std::size_t val) { right_column_width_ = val; }

    void description_paragraph_width(std::size_t val) { description_paragraph_width_ = val; }

    void footer_paragraph_width(std::size_t val) { footer_paragraph_width_ = val; }
    void enable_description_formatting(bool value = true) { enable_description_formatting_ = value; }
    void enable_footer_formatting(bool value = true) { enable_footer_formatting_ = value; }

    void enable_option_defaults(bool value = true) { enable_option_defaults_ = value; }
    void enable_option_type_names(bool value = true) { enable_option_type_names_ = value; }
    void enable_default_flag_values(bool value = true) { enable_default_flag_values_ = value; }

    CLI11_NODISCARD std::string get_label(std::string key) const {
        if(labels_.find(key) == labels_.end())
            return key;
        return labels_.at(key);
    }

    CLI11_NODISCARD std::size_t get_column_width() const { return column_width_; }

    CLI11_NODISCARD std::size_t get_right_column_width() const { return right_column_width_; }

    CLI11_NODISCARD std::size_t get_description_paragraph_width() const { return description_paragraph_width_; }

    CLI11_NODISCARD std::size_t get_footer_paragraph_width() const { return footer_paragraph_width_; }

    CLI11_NODISCARD float get_long_option_alignment_ratio() const { return long_option_alignment_ratio_; }

    CLI11_NODISCARD bool is_description_paragraph_formatting_enabled() const { return enable_description_formatting_; }

    CLI11_NODISCARD bool is_footer_paragraph_formatting_enabled() const { return enable_footer_formatting_; }

    CLI11_NODISCARD bool is_option_defaults_enabled() const { return enable_option_defaults_; }

    CLI11_NODISCARD bool is_option_type_names_enabled() const { return enable_option_type_names_; }

    CLI11_NODISCARD bool is_default_flag_values_enabled() const { return enable_default_flag_values_; }

};

class FormatterLambda final : public FormatterBase {
    using funct_t = std::function<std::string(const App *, std::string, AppFormatMode)>;

    funct_t lambda_;
 
  public:
    explicit FormatterLambda(funct_t funct) : lambda_(std::move(funct)) {}

    ~FormatterLambda() noexcept override {}  // NOLINT(modernize-use-equals-default)

    std::string make_help(const App *app, std::string name, AppFormatMode mode) const override {
        return lambda_(app, name, mode);
    }
};

class Formatter : public FormatterBase {
  public:
    Formatter() = default;
    Formatter(const Formatter &) = default;
    Formatter(Formatter &&) = default;
    Formatter &operator=(const Formatter &) = default;
    Formatter &operator=(Formatter &&) = default;


    CLI11_NODISCARD virtual std::string
    make_group(std::string group, bool is_positional, std::vector<const Option *> opts) const;

    virtual std::string make_positionals(const App *app) const;

    std::string make_groups(const App *app, AppFormatMode mode) const;

    virtual std::string make_subcommands(const App *app, AppFormatMode mode) const;

    virtual std::string make_subcommand(const App *sub) const;

    virtual std::string make_expanded(const App *sub, AppFormatMode mode) const;

    virtual std::string make_footer(const App *app) const;

    virtual std::string make_description(const App *app) const;

    virtual std::string make_usage(const App *app, std::string name) const;

    std::string make_help(const App *app, std::string, AppFormatMode mode) const override;


    virtual std::string make_option(const Option *, bool) const;

    virtual std::string make_option_name(const Option *, bool) const;

    virtual std::string make_option_opts(const Option *) const;

    virtual std::string make_option_desc(const Option *) const;

    virtual std::string make_option_usage(const Option *opt) const;

};
 
// [CLI11:formatter_fwd_hpp:end]
}  // namespace CLI