cmdopt.hpp File Reference

#include <string_view>
#include <optional>
#include <stdexcept>
#include <string>
#include <vector>

Include dependency graph for cmdopt.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	shamcmdopt
	namespace for cli utilities

Functions
int	shamcmdopt::get_argc ()
	Get the number of command line arguments.
char **	shamcmdopt::get_argv ()
	Get the command line arguments.
void	shamcmdopt::register_opt (std::string name, std::optional< std::string > args, std::string description)
	Register a command line option.
void	shamcmdopt::init (int argc, char *argv[])
	Initialize the command line option parser. We also process generic options in this call (color detection typically)
bool	shamcmdopt::has_option (const std::string_view &option_name)
	Check if an option is present.
std::string_view	shamcmdopt::get_option (const std::string_view &option_name)
	Get the value of an option.
void	shamcmdopt::print_help ()
	Print the help message.
void	shamcmdopt::print_completion_zsh ()
	print zsh completion script to be sourced
bool	shamcmdopt::is_help_mode ()
	Check if the help mode is enabled.

Detailed Description

Author

Timothée David–Cléris (tim.s.nosp@m.hamr.nosp@m.ock@p.nosp@m.roto.nosp@m.n.me)

Definition in file cmdopt.hpp.