E-MailRelay
|
A configuration structure for G::OptionsUsage. More...
#include <goptionsusage.h>
Public Member Functions | |
Config & | set_separator (const std::string &) |
Config & | set_column (std::size_t) noexcept |
Config & | set_width (std::size_t) noexcept |
Config & | set_width2 (std::size_t) noexcept |
Config & | set_margin (std::size_t) noexcept |
Config & | set_extra (bool=true) noexcept |
Config & | set_alt_usage (bool=true) noexcept |
Config & | set_level_max (unsigned int) noexcept |
Config & | set_level_min (unsigned int) noexcept |
Config & | set_main_tag (unsigned int) noexcept |
Config & | set_tag_bits (unsigned int) noexcept |
Config & | setDefaults () |
Config & | setWidthsWrtMargin () |
Config & | setOverflowFormat (char=' ') |
Public Attributes | |
std::string | separator |
separator between syntax and description More... | |
std::size_t | separator_spaces {1U} |
extra spaces on wrapped lines if using a separator More... | |
std::size_t | column {30U} |
left hand column width if no separator (includes margin) More... | |
std::size_t | width {default_} |
overall width for wrapping, or zero for none, defaults to $COLUMNS More... | |
std::size_t | width2 {0U} |
width after the first line, or zero for 'width' More... | |
std::size_t | margin {2U} |
spaces added to the left More... | |
std::size_t | overflow {20U} |
use 'overflow' format if rhs is squashed down to this More... | |
std::size_t | overflow_spaces {1U} |
'overflow' format extra spaces on wrapped lines More... | |
bool | extra {false} |
include descriptions' extra text More... | |
bool | alt_usage {false} |
use alternate "usage:" string More... | |
unsigned int | level_max {99U} |
show options at-or-below this level More... | |
unsigned int | level_min {1U} |
.. and at-or-above this level More... | |
unsigned int | main_tag {0U} |
show options with this main tag, or zero for all More... | |
unsigned int | tag_bits {0U} |
show options with matching tag bits, or zero for all More... | |
Static Public Attributes | |
static constexpr std::size_t | default_ = static_cast<std::size_t>(-1) |
A configuration structure for G::OptionsUsage.
Definition at line 67 of file goptionsusage.h.
|
inlinenoexcept |
Definition at line 171 of file goptionsusage.h.
|
inlinenoexcept |
Definition at line 166 of file goptionsusage.h.
|
inlinenoexcept |
Definition at line 170 of file goptionsusage.h.
|
inlinenoexcept |
Definition at line 172 of file goptionsusage.h.
|
inlinenoexcept |
Definition at line 173 of file goptionsusage.h.
|
inlinenoexcept |
Definition at line 174 of file goptionsusage.h.
|
inlinenoexcept |
Definition at line 169 of file goptionsusage.h.
|
inline |
Definition at line 165 of file goptionsusage.h.
|
inlinenoexcept |
Definition at line 175 of file goptionsusage.h.
|
inlinenoexcept |
Definition at line 167 of file goptionsusage.h.
|
inlinenoexcept |
Definition at line 168 of file goptionsusage.h.
G::OptionsUsage::Config & G::OptionsUsage::Config::setDefaults | ( | ) |
Definition at line 298 of file goptionsusage.cpp.
G::OptionsUsage::Config & G::OptionsUsage::Config::setWidthsWrtMargin | ( | ) |
Definition at line 307 of file goptionsusage.cpp.
bool G::OptionsUsage::Config::alt_usage {false} |
use alternate "usage:" string
Definition at line 81 of file goptionsusage.h.
std::size_t G::OptionsUsage::Config::column {30U} |
left hand column width if no separator (includes margin)
Definition at line 73 of file goptionsusage.h.
|
staticconstexpr |
Definition at line 69 of file goptionsusage.h.
bool G::OptionsUsage::Config::extra {false} |
include descriptions' extra text
Definition at line 80 of file goptionsusage.h.
unsigned int G::OptionsUsage::Config::level_max {99U} |
show options at-or-below this level
Definition at line 83 of file goptionsusage.h.
unsigned int G::OptionsUsage::Config::level_min {1U} |
.. and at-or-above this level
Definition at line 84 of file goptionsusage.h.
unsigned int G::OptionsUsage::Config::main_tag {0U} |
show options with this main tag, or zero for all
Definition at line 85 of file goptionsusage.h.
std::size_t G::OptionsUsage::Config::margin {2U} |
spaces added to the left
Definition at line 76 of file goptionsusage.h.
std::size_t G::OptionsUsage::Config::overflow {20U} |
use 'overflow' format if rhs is squashed down to this
Definition at line 77 of file goptionsusage.h.
std::size_t G::OptionsUsage::Config::overflow_spaces {1U} |
'overflow' format extra spaces on wrapped lines
Definition at line 78 of file goptionsusage.h.
std::string G::OptionsUsage::Config::separator |
separator between syntax and description
Definition at line 71 of file goptionsusage.h.
std::size_t G::OptionsUsage::Config::separator_spaces {1U} |
extra spaces on wrapped lines if using a separator
Definition at line 72 of file goptionsusage.h.
unsigned int G::OptionsUsage::Config::tag_bits {0U} |
show options with matching tag bits, or zero for all
Definition at line 86 of file goptionsusage.h.
std::size_t G::OptionsUsage::Config::width {default_} |
overall width for wrapping, or zero for none, defaults to $COLUMNS
Definition at line 74 of file goptionsusage.h.
std::size_t G::OptionsUsage::Config::width2 {0U} |
width after the first line, or zero for 'width'
Definition at line 75 of file goptionsusage.h.