Open Lighting Architecture: include/ola/base/Flags.h File Reference

| Open Lighting Architecture 0.10.9

Loading...
Searching...
No Matches
Namespaces | Macros | Functions
Flags.h File Reference
Command Line Flags

## Detailed Description

Defines macros to ease creation of command line flags.

Go to the source code of this file.

## Namespaces
namespace | ola
| The namespace containing all OLA symbols.

## Macros
#define | DECLARE_bool(name)
| Reuse a bool flag from another file.
#define | DECLARE_int8(name)
| Reuse an int8_t flag from another file.
#define | DECLARE_int16(name)
| Reuse an int16_t flag from another file.
#define | DECLARE_int32(name)
| Reuse an int32_t flag from another file.
#define | DECLARE_uint8(name)
| Reuse a uint8_t flag from another file.
#define | DECLARE_uint16(name)
| Reuse a uint16_t flag from another file.
#define | DECLARE_uint32(name)
| Reuse a uint32_t flag from another file.
#define | DECLARE_string(name)
| Reuse a string flag from another file.
#define | DEFINE_bool(name, default_value, help_str)
| Create a new longname bool flag.
#define | DEFINE_s_bool(name, short_opt, default_value, help_str)
| Create a new bool flag with a long and short name.
#define | DEFINE_default_bool(name, default_value, help_str)
| Create a new longname bool flag that doesn't require an argument.
#define | DEFINE_s_default_bool(name, short_opt, default_value, help_str)
| Create a new bool flag with a long and short name that doesn't require an argument.
#define | DEFINE_int8(name, default_value, help_str)
| Create a new longname int8_t flag.
#define | DEFINE_s_int8(name, short_opt, default_value, help_str)
| Create a new int8_t flag with a long and short name.
#define | DEFINE_uint8(name, default_value, help_str)
| Create a new longname uint8_t flag.
#define | DEFINE_s_uint8(name, short_opt, default_value, help_str)
| Create a new uint8_t flag with a long and short name.
#define | DEFINE_int16(name, default_value, help_str)
| Create a new longname int16_t flag.
#define | DEFINE_s_int16(name, short_opt, default_value, help_str)
| Create a new int16_t flag with a long and short name.
#define | DEFINE_uint16(name, default_value, help_str)
| Create a new longname uint16_t flag.
#define | DEFINE_s_uint16(name, short_opt, default_value, help_str)
| Create a new uint16_t flag with a long and short name.
#define | DEFINE_int32(name, default_value, help_str)
| Create a new longname int32_t flag.
#define | DEFINE_s_int32(name, short_opt, default_value, help_str)
| Create a new int32_t flag with a long and short name.
#define | DEFINE_uint32(name, default_value, help_str)
| Create a new longname uint32_t flag.
#define | DEFINE_s_uint32(name, short_opt, default_value, help_str)
| Create a new int32_t flag with a long and short name.
#define | DEFINE_string(name, default_value, help_str)
| Create a new longname string flag.
#define | DEFINE_s_string(name, short_opt, default_value, help_str)
| Create a new string flag with a long and short name.

## Functions
void | ola::SetHelpString (const std::string &first_line, const std::string &description)
| Set the help string for the program.
void | ola::DisplayUsage ()
| Print the usage text to stdout.
void | ola::DisplayUsageAndExit ()
| Print the usage text to stdout then exit.
void | ola::DisplayVersion ()
| Print the version text to stdout.
void | ola::ParseFlags (int *argc, char **argv)
| Parses the command line flags up to the first non-flag value. argv is re-arranged so that it only contains non-flag arguments.