ProgArg.h File Reference

#include <ICLUtils/CompatMacros.h>
#include <ICLUtils/Any.h>
#include <ICLUtils/Exception.h>
#include <ICLUtils/Macros.h>

Go to the source code of this file.

Classes
struct	icl::utils::ProgArgException
	Programm argument environment exception type \. More...
class	icl::utils::ProgArg
	Programm argument utility class. More...
Namespaces
namespace	icl
	The ICL-namespace.
namespace	icl::utils
Defines
#define	THROW_ProgArgException(X)   throw ProgArgException(__FUNCTION__,(X))
Functions
std::ostream &	icl::utils::operator<< (std::ostream &s, const ProgArg &pa)
	just puts the referenced argument value as string into the lvalue-stream
bool	icl::utils::operator&& (const ProgArg &a, const ProgArg &b)
	this allows to check if two progargs are defined
bool	icl::utils::operator&& (const ProgArg &a, bool b)
	allows to check more than two ProgArg instances at once
bool	icl::utils::operator&& (bool &b, const ProgArg &a)
	allows to check more than two ProgArg instances at once
bool	icl::utils::operator|| (const ProgArg &a, const ProgArg &b)
	this allows to check if either of two progargs are defined
bool	icl::utils::operator|| (const ProgArg &a, bool b)
	allows to check if either of more than two ProgArg instances is defined
bool	icl::utils::operator|| (bool &b, const ProgArg &a)
	allows to check if either of more than two ProgArg instances is defined
const ProgArg	icl::utils::pa (const std::string &id, unsigned int subargidx=0) throw (ProgArgException)
	returns given program argument
const ProgArg	icl::utils::pa (unsigned int idx, bool danglingOnly=true)
	returns given program argument at given index
template<class T >
const T	icl::utils::pa_def (const std::string &id, unsigned int subargidx, const T &def) throw (ProgArgException)
	utility function that allows to use a default value, if given argument was not defined
template<class T >
const T	icl::utils::pa_def (const std::string &id, const T &def) throw (ProgArgException)
	utility function that allows to use a default value, if given argument was not defined
ICLUtils_API unsigned int	icl::utils::pa_get_count (bool danglingOnly=true)
	returns number of actually given args given
ICLUtils_API const std::string &	icl::utils::pa_get_progname (bool fullpath=false)
	returns application name (full command line)
ICLUtils_API void	icl::utils::pa_show_usage (const std::string &msg="")
	shows current available programm arguments
PAEX	icl::utils::pa_explain (const std::string &pa, const std::string &ex)
	This function can be used to provide additional information for certain program arguments.
ICLUtils_API void	icl::utils::pa_init (int n, char **ppc, const std::string &init, bool allowDanglingArgs=false)
	initialization function for ICL's program argument evaluation framework
ICLUtils_API void	icl::utils::pa_show ()
	shows all given program arguments
ICLUtils_API void	icl::utils::pa_set_license (const std::string &newLicenseText)
	Sets a license text, that is used when applications are run with --version or -v.
ICLUtils_API void	icl::utils::pa_set_help_text (const std::string &newHelpText)
	Sets a applications help text that is used when applications are run with --help or with unknown arguments.
ICLUtils_API std::string	icl::utils::pa_get_license ()
	returns the current license text
ICLUtils_API std::string	icl::utils::pa_get_help_text ()
	returns the current help text (which is empty, if it was not set)

---

Define Documentation

#define THROW_ProgArgException

(

X

)

throw ProgArgException(__FUNCTION__,(X))