CLI11  2.5.0
Classes | Namespaces | Macros | Typedefs | Enumerations | Functions
App.hpp File Reference
#include <algorithm>
#include <cstdint>
#include <functional>
#include <iostream>
#include <iterator>
#include <memory>
#include <numeric>
#include <set>
#include <sstream>
#include <string>
#include <utility>
#include <vector>
#include "ConfigFwd.hpp"
#include "Error.hpp"
#include "FormatterFwd.hpp"
#include "Macros.hpp"
#include "Option.hpp"
#include "impl/App_inl.hpp"
Include dependency graph for App.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  CLI::App
 Creates a command line program, with very few defaults. More...
 
class  CLI::Option_group
 Extension of App to better manage groups of options. More...
 
struct  CLI::detail::AppFriend
 This class is simply to allow tests access to App's protected functions. More...
 

Namespaces

 CLI
 
 CLI::detail
 
 CLI::FailureMessage
 

Macros

#define CLI11_PARSE(app, ...)
 

Typedefs

using CLI::App_p = std::shared_ptr< App >
 

Enumerations

enum  CLI::detail::Classifier {
  CLI::detail::Classifier::NONE, CLI::detail::Classifier::POSITIONAL_MARK, CLI::detail::Classifier::SHORT, CLI::detail::Classifier::LONG,
  CLI::detail::Classifier::WINDOWS_STYLE, CLI::detail::Classifier::SUBCOMMAND, CLI::detail::Classifier::SUBCOMMAND_TERMINATOR
}
 
enum  CLI::config_extras_mode : char { CLI::config_extras_mode::error = 0, CLI::config_extras_mode::ignore, CLI::config_extras_mode::ignore_all, CLI::config_extras_mode::capture }
 enumeration of modes of how to deal with extras in config files More...
 

Functions

CLI11_INLINE std::string CLI::FailureMessage::simple (const App *app, const Error &e)
 Printout a clean, simple message on error (the default in CLI11 1.5+) More...
 
CLI11_INLINE std::string CLI::FailureMessage::help (const App *app, const Error &e)
 Printout the full help string on error (if this fn is set, the old default for CLI11) More...
 
template<typename T >
Option * CLI::detail::default_flag_modifiers (Option *opt)
 helper functions for adding in appropriate flag modifiers for add_flag More...
 
template<typename T , enable_if_t< std::is_integral< T >::value &&(sizeof(T) > 1U>
Option * CLI::detail::default_flag_modifiers (Option *opt)
 summing modifiers More...
 
CLI11_INLINE void CLI::TriggerOn (App *trigger_app, App *app_to_enable)
 Helper function to enable one option group/subcommand when another is used. More...
 
CLI11_INLINE void CLI::TriggerOn (App *trigger_app, std::vector< App * > apps_to_enable)
 Helper function to enable one option group/subcommand when another is used. More...
 
CLI11_INLINE void CLI::TriggerOff (App *trigger_app, App *app_to_enable)
 Helper function to disable one option group/subcommand when another is used. More...
 
CLI11_INLINE void CLI::TriggerOff (App *trigger_app, std::vector< App * > apps_to_enable)
 Helper function to disable one option group/subcommand when another is used. More...
 
CLI11_INLINE void CLI::deprecate_option (Option *opt, const std::string &replacement="")
 Helper function to mark an option as deprecated. More...
 
void CLI::deprecate_option (App *app, const std::string &option_name, const std::string &replacement="")
 Helper function to mark an option as deprecated. More...
 
void CLI::deprecate_option (App &app, const std::string &option_name, const std::string &replacement="")
 Helper function to mark an option as deprecated. More...
 
CLI11_INLINE void CLI::retire_option (App *app, Option *opt)
 Helper function to mark an option as retired. More...
 
CLI11_INLINE void CLI::retire_option (App &app, Option *opt)
 Helper function to mark an option as retired. More...
 
CLI11_INLINE void CLI::retire_option (App *app, const std::string &option_name)
 Helper function to mark an option as retired. More...
 
CLI11_INLINE void CLI::retire_option (App &app, const std::string &option_name)
 Helper function to mark an option as retired. More...
 

Macro Definition Documentation

#define CLI11_PARSE (   app,
  ... 
)
Value:
try { \
(app).parse(__VA_ARGS__); \
} catch(const CLI::ParseError &e) { \
return (app).exit(e); \
}
Anything that can error in Parse.
Definition: Error.hpp:159