command_line Namespace Reference

Classes
struct	arg_descriptor
struct	arg_descriptor< T, false >
struct	arg_descriptor< std::vector< T >, false >
struct	arg_descriptor< T, true >
struct	arg_descriptor< T, false, true >
struct	arg_descriptor< T, false, true, NUM_DEPS >

Functions
bool	is_yes (const std::string &str)
bool	is_no (const std::string &str)
template<typename T>
boost::program_options::typed_value< T, char > *	make_semantic (const arg_descriptor< T, true > &)
template<typename T>
boost::program_options::typed_value< T, char > *	make_semantic (const arg_descriptor< T, false > &arg)
template<typename T>
boost::program_options::typed_value< T, char > *	make_semantic (const arg_descriptor< T, false, true > &arg)
template<typename T, int NUM_DEPS>
boost::program_options::typed_value< T, char > *	make_semantic (const arg_descriptor< T, false, true, NUM_DEPS > &arg)
template<typename T>
boost::program_options::typed_value< T, char > *	make_semantic (const arg_descriptor< T, false > &arg, const T &def)
template<typename T>
boost::program_options::typed_value< std::vector< T >, char > *	make_semantic (const arg_descriptor< std::vector< T >, false > &)
template<typename T, bool required, bool dependent, int NUM_DEPS>
void	add_arg (boost::program_options::options_description &description, const arg_descriptor< T, required, dependent, NUM_DEPS > &arg, bool unique=true)
template<typename T>
void	add_arg (boost::program_options::options_description &description, const arg_descriptor< T, false > &arg, const T &def, bool unique=true)
template<>
void	add_arg (boost::program_options::options_description &description, const arg_descriptor< bool, false > &arg, bool unique)
template<typename charT>
boost::program_options::basic_parsed_options< charT >	parse_command_line (int argc, const charT *const argv[], const boost::program_options::options_description &desc, bool allow_unregistered=false)
template<typename F>
bool	handle_error_helper (const boost::program_options::options_description &desc, F parser)
template<typename T, bool required, bool dependent, int NUM_DEPS>
std::enable_if<!std::is_same< T, bool >::value, bool >::type	has_arg (const boost::program_options::variables_map &vm, const arg_descriptor< T, required, dependent, NUM_DEPS > &arg)
template<typename T, bool required, bool dependent, int NUM_DEPS>
bool	is_arg_defaulted (const boost::program_options::variables_map &vm, const arg_descriptor< T, required, dependent, NUM_DEPS > &arg)
template<typename T>
T	get_arg (const boost::program_options::variables_map &vm, const arg_descriptor< T, false, true > &arg)
template<typename T, int NUM_DEPS>
T	get_arg (const boost::program_options::variables_map &vm, const arg_descriptor< T, false, true, NUM_DEPS > &arg)
template<typename T, bool required>
T	get_arg (const boost::program_options::variables_map &vm, const arg_descriptor< T, required > &arg)
template<bool dependent, int NUM_DEPS>
bool	has_arg (const boost::program_options::variables_map &vm, const arg_descriptor< bool, false, dependent, NUM_DEPS > &arg)

Variables
const arg_descriptor< bool >	arg_help = {"help", "Produce help message"}
const arg_descriptor< bool >	arg_version = {"version", "Output version information"}

Function Documentation

add_arg() [1/3]

template<>

void command_line::add_arg ( boost::program_options::options_description & description, const arg_descriptor< bool, false > & arg, bool unique )

inline

Definition at line 212 of file command_line.h.

  {
    if (0 != description.find_nothrow(arg.name, false))
    {
      CHECK_AND_ASSERT_MES(!unique, void(), "Argument already exists: " << arg.name);
      return;
    }
 
    description.add_options()(arg.name, boost::program_options::bool_switch(), arg.description);
  }

add_arg() [2/3]

template<typename T>

void command_line::add_arg	(	boost::program_options::options_description &	description,
		const arg_descriptor< T, false > &	arg,
		const T &	def,
		bool	unique = true )

Definition at line 200 of file command_line.h.

  {
    if (0 != description.find_nothrow(arg.name, false))
    {
      CHECK_AND_ASSERT_MES(!unique, void(), "Argument already exists: " << arg.name);
      return;
    }
 
    description.add_options()(arg.name, make_semantic(arg, def), arg.description);
  }

Here is the call graph for this function:

add_arg() [3/3]

template<typename T, bool required, bool dependent, int NUM_DEPS>

void command_line::add_arg	(	boost::program_options::options_description &	description,
		const arg_descriptor< T, required, dependent, NUM_DEPS > &	arg,
		bool	unique = true )

Definition at line 188 of file command_line.h.

  {
    if (0 != description.find_nothrow(arg.name, false))
    {
      CHECK_AND_ASSERT_MES(!unique, void(), "Argument already exists: " << arg.name);
      return;
    }
 
    description.add_options()(arg.name, make_semantic(arg), arg.description);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

get_arg() [1/3]

template<typename T>

T command_line::get_arg	(	const boost::program_options::variables_map &	vm,
		const arg_descriptor< T, false, true > &	arg )

Definition at line 271 of file command_line.h.

  {
    return arg.depf(get_arg(vm, arg.ref), is_arg_defaulted(vm, arg), vm[arg.name].template as<T>());
  }

Here is the call graph for this function:

Here is the caller graph for this function:

get_arg() [2/3]

template<typename T, int NUM_DEPS>

T command_line::get_arg	(	const boost::program_options::variables_map &	vm,
		const arg_descriptor< T, false, true, NUM_DEPS > &	arg )

Definition at line 277 of file command_line.h.

  {
    std::array<bool, NUM_DEPS> depval;
    for (size_t i = 0; i < depval.size(); ++i)
      depval[i] = get_arg(vm, *arg.ref[i]);
    return arg.depf(depval, is_arg_defaulted(vm, arg), vm[arg.name].template as<T>());
  }

Here is the call graph for this function:

get_arg() [3/3]

template<typename T, bool required>

T command_line::get_arg	(	const boost::program_options::variables_map &	vm,
		const arg_descriptor< T, required > &	arg )

Definition at line 286 of file command_line.h.

  {
    return vm[arg.name].template as<T>();
  }

handle_error_helper()

template<typename F>

bool command_line::handle_error_helper	(	const boost::program_options::options_description &	desc,
		F	parser )

Definition at line 237 of file command_line.h.

  {
    try
    {
      return parser();
    }
    catch (const std::exception& e)
    {
      std::cerr << "Failed to parse arguments: " << e.what() << std::endl;
      std::cerr << desc << std::endl;
      return false;
    }
    catch (...)
    {
      std::cerr << "Failed to parse arguments: unknown exception" << std::endl;
      std::cerr << desc << std::endl;
      return false;
    }
  }

Here is the caller graph for this function:

has_arg() [1/2]

template<bool dependent, int NUM_DEPS>

bool command_line::has_arg ( const boost::program_options::variables_map & vm, const arg_descriptor< bool, false, dependent, NUM_DEPS > & arg )

inline

Definition at line 292 of file command_line.h.

  {
    return get_arg(vm, arg);
  }

Here is the call graph for this function:

has_arg() [2/2]

template<typename T, bool required, bool dependent, int NUM_DEPS>

std::enable_if<!std::is_same< T, bool >::value, bool >::type command_line::has_arg	(	const boost::program_options::variables_map &	vm,
		const arg_descriptor< T, required, dependent, NUM_DEPS > &	arg )

Definition at line 258 of file command_line.h.

  {
    auto value = vm[arg.name];
    return !value.empty();
  }

Here is the caller graph for this function:

is_arg_defaulted()

template<typename T, bool required, bool dependent, int NUM_DEPS>

bool command_line::is_arg_defaulted	(	const boost::program_options::variables_map &	vm,
		const arg_descriptor< T, required, dependent, NUM_DEPS > &	arg )

Definition at line 265 of file command_line.h.

  {
    return vm[arg.name].defaulted();
  }

Here is the caller graph for this function:

is_no()

bool command_line::is_no

(

const std::string &

str

)

Returns

True if str is is_iequal("n" || "no" || tr("no"))`.

Definition at line 62 of file command_line.cpp.

  {
    if (str == "n" || str == "N")
      return true;
 
    boost::algorithm::is_iequal ignore_case{};
    if (boost::algorithm::equals("no", str, ignore_case))
      return true;
    if (boost::algorithm::equals(command_line::tr("no"), str, ignore_case))
      return true;
 
    return false;
  }

Here is the caller graph for this function:

is_yes()

bool command_line::is_yes

(

const std::string &

str

)

Returns

True if str is is_iequal("y" || "yes" || tr("yes"))`.

Definition at line 48 of file command_line.cpp.

  {
    if (str == "y" || str == "Y")
      return true;
 
    boost::algorithm::is_iequal ignore_case{};
    if (boost::algorithm::equals("yes", str, ignore_case))
      return true;
    if (boost::algorithm::equals(command_line::tr("yes"), str, ignore_case))
      return true;
 
    return false;
  }

Here is the caller graph for this function:

make_semantic() [1/6]

template<typename T>

boost::program_options::typed_value< std::vector< T >, char > * command_line::make_semantic

(

const arg_descriptor< std::vector< T >, false > &

)

Definition at line 180 of file command_line.h.

  {
    auto semantic = boost::program_options::value< std::vector<T> >();
    semantic->default_value(std::vector<T>(), "");
    return semantic;
  }

make_semantic() [2/6]

template<typename T>

boost::program_options::typed_value< T, char > * command_line::make_semantic

(

const arg_descriptor< T, false > &

arg

)

Definition at line 126 of file command_line.h.

  {
    auto semantic = boost::program_options::value<T>();
    if (!arg.not_use_default)
      semantic->default_value(arg.default_value);
    return semantic;
  }

make_semantic() [3/6]

template<typename T>

boost::program_options::typed_value< T, char > * command_line::make_semantic	(	const arg_descriptor< T, false > &	arg,
		const T &	def )

Definition at line 171 of file command_line.h.

  {
    auto semantic = boost::program_options::value<T>();
    if (!arg.not_use_default)
      semantic->default_value(def);
    return semantic;
  }

make_semantic() [4/6]

template<typename T>

boost::program_options::typed_value< T, char > * command_line::make_semantic

(

const arg_descriptor< T, false, true > &

arg

)

Definition at line 135 of file command_line.h.

  {
    auto semantic = boost::program_options::value<T>();
    if (!arg.not_use_default) {
      std::ostringstream format;
      format << arg.depf(false, true, arg.default_value) << ", "
             << arg.depf(true, true, arg.default_value) << " if '"
             << arg.ref.name << "'";
      semantic->default_value(arg.depf(arg.ref.default_value, true, arg.default_value), format.str());
    }
    return semantic;
  }

make_semantic() [5/6]

template<typename T, int NUM_DEPS>

boost::program_options::typed_value< T, char > * command_line::make_semantic

(

const arg_descriptor< T, false, true, NUM_DEPS > &

arg

)

Definition at line 149 of file command_line.h.

  {
    auto semantic = boost::program_options::value<T>();
    if (!arg.not_use_default) {
      std::array<bool, NUM_DEPS> depval;
      depval.fill(false);
      std::ostringstream format;
      format << arg.depf(depval, true, arg.default_value);
      for (size_t i = 0; i < depval.size(); ++i)
      {
        depval.fill(false);
        depval[i] = true;
        format << ", " << arg.depf(depval, true, arg.default_value) << " if '" << arg.ref[i]->name << "'";
      }
      for (size_t i = 0; i < depval.size(); ++i)
        depval[i] = arg.ref[i]->default_value;
      semantic->default_value(arg.depf(depval, true, arg.default_value), format.str());
    }
    return semantic;
  }

make_semantic() [6/6]

template<typename T>

boost::program_options::typed_value< T, char > * command_line::make_semantic

(

const arg_descriptor< T, true > &

)

Definition at line 120 of file command_line.h.

  {
    return boost::program_options::value<T>()->required();
  }

Here is the caller graph for this function:

parse_command_line()

template<typename charT>

boost::program_options::basic_parsed_options< charT > command_line::parse_command_line	(	int	argc,
		const charT *const	argv[],
		const boost::program_options::options_description &	desc,
		bool	allow_unregistered = false )

Definition at line 224 of file command_line.h.

  {
    auto parser = boost::program_options::command_line_parser(argc, argv);
    parser.options(desc);
    if (allow_unregistered)
    {
      parser.allow_unregistered();
    }
    return parser.run();
  }

Variable Documentation

arg_help

const arg_descriptor< bool > command_line::arg_help = {"help", "Produce help message"}

Definition at line 76 of file command_line.cpp.

{"help", "Produce help message"};

arg_version

const arg_descriptor< bool > command_line::arg_version = {"version", "Output version information"}

Definition at line 77 of file command_line.cpp.

{"version", "Output version information"};