![]() |
TSDuck v3.39-3843
MPEG Transport Stream Toolkit
|
Dektec output plugin for tsp
.
More...
#include <tsDektecOutputPlugin.h>
Public Types | |
enum | ArgType { NONE , STRING , FILENAME , DIRECTORY , HEXADATA , INTEGER , UNSIGNED , POSITIVE , UINT8 , UINT16 , UINT32 , UINT63 , PIDVAL , INT8 , INT16 , INT32 , INT64 , ANUMBER , CHRONO , TRISTATE , IPADDR , IPSOCKADDR , IPSOCKADDR_OA , IPSOCKADDR_OP , IPSOCKADDR_OAP } |
Type of an argument or parameter. More... | |
enum | Flags { NO_ERROR_DISPLAY = 0x0001 , NO_EXIT_ON_ERROR = 0x0002 , NO_EXIT_ON_HELP = 0x0004 , NO_EXIT_ON_VERSION = 0x0008 , GATHER_PARAMETERS = 0x0010 , HELP_ON_THIS = 0x0020 , NO_DEBUG = 0x0040 , NO_HELP = 0x0080 , NO_VERBOSE = 0x0100 , NO_VERSION = 0x0200 , NO_CONFIG_FILE = 0x0400 } |
Args object flags, used in an or'ed mask. More... | |
enum | HelpFormat { HELP_NAME , HELP_DESCRIPTION , HELP_USAGE , HELP_SYNTAX , HELP_FULL , HELP_OPTIONS } |
Types of help formatting, for getHelpText() and predefined option --help. More... | |
Public Member Functions | |
DektecOutputPlugin (TSP *tsp) | |
Constructor. | |
virtual | ~DektecOutputPlugin () override |
Destructor. | |
virtual bool | analyze (const UString &app_name, const UStringVector &arguments, bool processRedirections=true) |
Load command arguments and analyze them. | |
virtual bool | analyze (const UString &command, bool processRedirections=true) |
Load command arguments and analyze them. | |
virtual bool | analyze (int argc, char *argv[], bool processRedirections=true) |
Load command arguments and analyze them. | |
UString | appName () const |
Get the application name from the last command line analysis. | |
template<typename INT , typename std::enable_if< std::is_integral< INT >::value >::type * = nullptr> | |
INT | bitMaskValue (const UChar *name=nullptr, const INT &def_value=static_cast< INT >(0)) const |
Get an OR'ed of all values of an integer option in the last analyzed command line. | |
UString | commandLine () const |
Get the full command line from the last command line analysis. | |
Args & | copyOptions (const Args &other, const bool replace=false) |
Copy all option definitions from another Args object into this one. | |
size_t | count (const UChar *name=nullptr) const |
Check the number of occurences of an option in the last analyzed command line. | |
bool | debug () const |
Check if debugging is active. | |
template<class... Args> | |
void | debug (const UChar *fmt, Args &&... args) |
Report a debug message with a printf-like interface. | |
void | debug (const UChar *msg) |
Report a debug message. | |
template<class... Args> | |
void | debug (const UString &fmt, Args &&... args) |
Report a debug message with a printf-like interface. | |
void | debug (const UString &msg) |
Report a debug message. | |
Report * | delegateReport (Report *report) |
Delegate message logging to another report object. | |
template<class... Args> | |
void | error (const UChar *fmt, Args &&... args) |
Report an error message with a printf-like interface. | |
void | error (const UChar *msg) |
Report an error message. | |
template<class... Args> | |
void | error (const UString &fmt, Args &&... args) |
Report an error message with a printf-like interface. | |
void | error (const UString &msg) |
Report an error message. | |
void | exitOnError (bool force=false) |
Exit application when errors were reported in the last analyzed command line. | |
template<class... Args> | |
void | fatal (const UChar *fmt, Args &&... args) |
Report a fatal error message with a printf-like interface. | |
void | fatal (const UChar *msg) |
Report a fatal error message. | |
template<class... Args> | |
void | fatal (const UString &fmt, Args &&... args) |
Report a fatal error message with a printf-like interface. | |
void | fatal (const UString &msg) |
Report a fatal error message. | |
template<typename INT , typename std::enable_if< std::is_integral< INT >::value >::type * = nullptr> | |
void | getBitMaskValue (INT &value, const UChar *name=nullptr, const INT &def_value=static_cast< INT >(0)) const |
Get an OR'ed of all values of an integer option in the last analyzed command line. | |
virtual BitRate | getBitrate () override |
Get the plugin bitrate. | |
virtual BitRateConfidence | getBitrateConfidence () override |
Get the plugin bitrate confidence. | |
template<class Rep , class Period > | |
void | getChronoValue (cn::duration< Rep, Period > &value, const UChar *name=nullptr, size_t index=0) const |
Get the value of an std::chrono::duration option in the last analyzed command line. | |
template<class Rep1 , class Period1 , class Rep2 , class Period2 > | |
void | getChronoValue (cn::duration< Rep1, Period1 > &value, const UChar *name=nullptr, const cn::duration< Rep2, Period2 > &def_value=cn::duration< Rep1, Period1 >::zero(), size_t index=0) const |
Get the value of an std::chrono::duration option in the last analyzed command line. | |
void | getCommandArgs (UStringVector &args) const |
Get the command line parameters from the last command line analysis. | |
const UString & | getDescription () const |
Get the description of the command. | |
int | getFlags () const |
Get the option flags of the command. | |
virtual UString | getHelpText (HelpFormat format, size_t line_width=DEFAULT_LINE_WIDTH) const |
Get a formatted help text. | |
void | getHexaValue (ByteBlock &value, const UChar *name=nullptr, const ByteBlock &def_value=ByteBlock(), size_t index=0) const |
Get the value of an hexadecimal option in the last analyzed command line. | |
template<typename INT , typename INT2 = INT, typename std::enable_if< std::is_integral< INT >::value||std::is_enum< INT >::value >::type * = nullptr> | |
void | getIntValue (INT &value, const UChar *name=nullptr, const INT2 def_value=static_cast< INT2 >(0), size_t index=0) const |
Get the value of an integer option in the last analyzed command line. | |
template<std::size_t N> | |
void | getIntValues (CompactBitSet< N > &values, const UChar *name=nullptr, bool defValue=false) const |
Get all occurences of an option as a compact bitset of values. | |
template<std::size_t N> | |
void | getIntValues (std::bitset< N > &values, const UChar *name=nullptr, bool defValue=false) const |
Get all occurences of an option as a bitset of values. | |
template<typename INT , typename std::enable_if< std::is_integral< INT >::value||std::is_enum< INT >::value >::type * = nullptr> | |
void | getIntValues (std::set< INT > &values, const UChar *name=nullptr) const |
Get all occurences of an integer option in a set of integers. | |
template<typename INT , typename std::enable_if< std::is_integral< INT >::value||std::is_enum< INT >::value >::type * = nullptr> | |
void | getIntValues (std::vector< INT > &values, const UChar *name=nullptr) const |
Get all occurences of an integer option in a vector of integers. | |
void | getIPValue (IPv4Address &value, const UChar *name=nullptr, const IPv4Address &def_value=IPv4Address(), size_t index=0) const |
Get the value of an option as an IPv4 address in the last analyzed command line. | |
template<typename INT , typename std::enable_if< std::is_integral< INT >::value||std::is_enum< INT >::value >::type * = nullptr> | |
void | getOptionalIntValue (std::optional< INT > &value, const UChar *name=nullptr, bool clear_if_absent=false) const |
Get the value of an integer option in the last analyzed command line, only if present. | |
void | getOptionalValue (std::optional< UString > &value, const UChar *name=nullptr, bool clear_if_absent=false) const |
Get the value of an option in the last analyzed command line, only if present. | |
virtual bool | getOptions () |
The main application invokes getOptions() only once, at application startup. | |
void | getPathValue (fs::path &value, const UChar *name=nullptr, const fs::path &def_value=fs::path(), size_t index=0) const |
Get the value of a filesystem path option in the last analyzed command line. | |
template<class CONTAINER , typename std::enable_if< std::is_base_of< fs::path, typename CONTAINER::value_type >::value >::type * = nullptr> | |
void | getPathValues (CONTAINER &values, const UChar *name=nullptr) const |
Get all occurences of a filesystem path option in a container of path. | |
const UString & | getShell () const |
Get the "shell" string. | |
void | getSocketValue (IPv4SocketAddress &value, const UChar *name=nullptr, const IPv4SocketAddress &def_value=IPv4SocketAddress(), size_t index=0) const |
Get the value of an option as an IPv4 socket address in the last analyzed command line. | |
const UString & | getSyntax () const |
Get the syntax of the command. | |
void | getTristateValue (Tristate &value, const UChar *name=nullptr, size_t index=0) const |
Get the value of tristate option in the last analyzed command line. | |
template<class NUMTYPE , typename INT1 , typename std::enable_if< std::is_base_of< AbstractNumber, NUMTYPE >::value &&std::is_integral< INT1 >::value, int >::type = 0> | |
void | getValue (NUMTYPE &value, const UChar *name, INT1 def_value, size_t index=0) const |
Get the value of an AbstractNumber option in the last analyzed command line. | |
template<class NUMTYPE , typename std::enable_if< std::is_base_of< AbstractNumber, NUMTYPE >::value, int >::type = 0> | |
void | getValue (NUMTYPE &value, const UChar *name=nullptr, const NUMTYPE &def_value=NUMTYPE(0), size_t index=0) const |
Get the value of an AbstractNumber option in the last analyzed command line. | |
void | getValue (UString &value, const UChar *name=nullptr, const UChar *def_value=u"", size_t index=0) const |
Get the value of an option in the last analyzed command line. | |
template<class CONTAINER , typename std::enable_if< std::is_base_of< UString, typename CONTAINER::value_type >::value >::type * = nullptr> | |
void | getValues (CONTAINER &values, const UChar *name=nullptr) const |
Get all occurences of an option in a container of strings. | |
bool | gotErrors () const |
Check if errors (or worse) were reported through this object. | |
virtual bool | handlePacketTimeout () |
Invoked when no packet could be retrieved within the specified timeout. | |
Args & | help (const UChar *name, const UString &syntax, const UString &text) |
Add the help text of an existing option. | |
Args & | help (const UChar *name, const UString &text) |
Add the help text of an existing option. | |
ByteBlock | hexaValue (const UChar *name=nullptr, const ByteBlock &def_value=ByteBlock(), size_t index=0) const |
Get the value of an hexadecimal option in the last analyzed command line. | |
template<class... Args> | |
void | info (const UChar *fmt, Args &&... args) |
Report an informational message with a printf-like interface. | |
void | info (const UChar *msg) |
Report an informational message. | |
template<class... Args> | |
void | info (const UString &fmt, Args &&... args) |
Report an informational message with a printf-like interface. | |
void | info (const UString &msg) |
Report an informational message. | |
template<typename INT , typename std::enable_if< std::is_integral< INT >::value||std::is_enum< INT >::value >::type * = nullptr> | |
INT | intValue (const UChar *name=nullptr, const INT def_value=static_cast< INT >(0), size_t index=0) const |
Get the value of an integer option in the last analyzed command line. | |
void | invalidate () |
Force en error state in this object, as if an error was reported. | |
IPv4Address | ipValue (const UChar *name=nullptr, const IPv4Address &def_value=IPv4Address(), size_t index=0) const |
Get the value of an option as an IPv4 address in the last analyzed command line. | |
virtual bool | isRealTime () override |
Tell if the plugin is a real time one. | |
template<class... Args> | |
void | log (int severity, const UChar *fmt, Args &&... args) |
Report a message with an explicit severity and a printf-like interface. | |
template<class... Args> | |
void | log (int severity, const UString &fmt, Args &&... args) |
Report a message with an explicit severity and a printf-like interface. | |
void | log (int severity, const UString &msg) |
Report a message with an explicit severity. | |
int | maxSeverity () const |
Get maximum severity level. | |
template<class NUMTYPE , typename std::enable_if< std::is_base_of< AbstractNumber, NUMTYPE >::value, int >::type = 0> | |
NUMTYPE | numValue (const UChar *name=nullptr, const NUMTYPE &def_value=NUMTYPE(0), size_t index=0) const |
Get the value of an AbstractNumber option in the last analyzed command line. | |
Args & | option (const UChar *name, UChar short_name, const Enumeration &enumeration, size_t min_occur=0, size_t max_occur=0, bool optional=false) |
Add the definition of an option, the value being from an enumeration type. | |
template<class NUMTYPE , typename INT1 = int64_t, typename INT2 = int64_t, typename std::enable_if< std::is_base_of< AbstractNumber, NUMTYPE >::value &&std::is_integral< INT1 >::value &&std::is_integral< INT2 >::value, int >::type = 0> | |
Args & | option (const UChar *name, UChar short_name=0, size_t min_occur=0, size_t max_occur=0, INT1 min_value=std::numeric_limits< INT2 >::min(), INT2 max_value=std::numeric_limits< INT1 >::max(), bool optional=false) |
Add the definition of an option, the value being an instance of AbstractNumber. | |
template<class DURATION , typename std::enable_if< std::is_integral< typename DURATION::rep >::value, int >::type = 0> | |
Args & | option (const UChar *name, UChar short_name=0, size_t min_occur=0, size_t max_occur=0, int64_t min_value=0, int64_t max_value=std::numeric_limits< int64_t >::max(), bool optional=false) |
Add the definition of an option, the value being an instance of std::chrono::duration. | |
Args & | option (const UChar *name=nullptr, UChar short_name=0, ArgType type=NONE, size_t min_occur=0, size_t max_occur=0, int64_t min_value=0, int64_t max_value=0, bool optional=false, size_t decimals=0) |
Add the definition of an option. | |
UString | optionNames (const UChar *name, const UString &separator=u", ") const |
When an option has an Enumeration type, get a list of all valid names. | |
bool | present (const UChar *name=nullptr) const |
Check if an option is present in the last analyzed command line. | |
bool | processArgsRedirection (UStringVector &args) |
Process argument redirection using '@' on a vector of strings. | |
void | raiseMaxSeverity (int level, bool delegated=false) |
Raise maximum severity level. | |
UString | reportPrefix () const |
Get the current prefix to display. | |
void | resetContext (const DuckContext::SavedArgs &state) |
Reset the internal TSDuck execution context of this plugin. | |
void | resetErrors () |
Reset the error indicator. | |
virtual bool | send (const TSPacket *, const TSPacketMetadata *, size_t) override |
Packet output interface. | |
void | setAppName (const UString &name) |
Set the initial application name (will be overwritten at next command analysis). | |
virtual void | setDescription (const UString &description) |
Set the description of the command. | |
virtual void | setFlags (int flags) |
Set the option flags of the command. | |
virtual void | setIntro (const UString &intro) |
Set the introduction or preamble text for help description. | |
void | setMaxSeverity (int level, bool delegated=false) |
Set maximum severity level. | |
void | setReportPrefix (const UString &prefix) |
Set the prefix to display before each message. | |
void | setShell (const UString &shell) |
Set the "shell" string. | |
virtual void | setSyntax (const UString &syntax) |
Set the syntax of the command. | |
virtual void | setTail (const UString &tail) |
Set the conclusion or tailing text for help description. | |
template<class... Args> | |
void | severe (const UChar *fmt, Args &&... args) |
Report a severe error message with a printf-like interface. | |
void | severe (const UChar *msg) |
Report a severe error message. | |
template<class... Args> | |
void | severe (const UString &fmt, Args &&... args) |
Report a severe error message with a printf-like interface. | |
void | severe (const UString &msg) |
Report a severe error message. | |
IPv4SocketAddress | socketValue (const UChar *name=nullptr, const IPv4SocketAddress &def_value=IPv4SocketAddress(), size_t index=0) const |
Get the value of an option as an IPv4 socket address in the last analyzed command line. | |
virtual size_t | stackUsage () const |
Define the maximum stack usage for the thread executing the plugin. | |
virtual bool | start () override |
The main application invokes start() to start the plugin. | |
virtual bool | stop () override |
The main application invokes stop() to terminate the plugin. | |
Tristate | tristateValue (const UChar *name=nullptr, size_t index=0) const |
Get the value of tristate option in the last analyzed command line. | |
virtual PluginType | type () const override |
Get the plugin type. | |
bool | valid () const |
Check if options were correct during the last command line analysis. | |
UString | value (const UChar *name=nullptr, const UChar *def_value=u"", size_t index=0) const |
Get the value of an option in the last analyzed command line. | |
bool | verbose () const |
Check if verbose reporting is active. | |
template<class... Args> | |
void | verbose (const UChar *fmt, Args &&... args) |
Report a verbose message with a printf-like interface. | |
void | verbose (const UChar *msg) |
Report a verbose message. | |
template<class... Args> | |
void | verbose (const UString &fmt, Args &&... args) |
Report a verbose message with a printf-like interface. | |
void | verbose (const UString &msg) |
Report a verbose message. | |
template<class... Args> | |
void | warning (const UChar *fmt, Args &&... args) |
Report a warning message with a printf-like interface. | |
void | warning (const UChar *msg) |
Report a warning error message. | |
template<class... Args> | |
void | warning (const UString &fmt, Args &&... args) |
Report a warning message with a printf-like interface. | |
void | warning (const UString &msg) |
Report a warning error message. | |
Static Public Member Functions | |
static UString | GetAppName (int argc, char *argv[]) |
Get the application name from a standard argc/argv pair. | |
Static Public Attributes | |
static constexpr size_t | DEFAULT_LINE_WIDTH = 79 |
Default line width for help texts. | |
static constexpr size_t | DEFAULT_STACK_USAGE = 128 * 1024 |
Default stack usage in bytes for the thread executing a plugin. | |
static const Enumeration | HelpFormatEnum |
Enumeration description of HelpFormat. | |
static constexpr size_t | UNLIMITED_COUNT = std::numeric_limits<size_t>::max() |
Unlimited number of occurences. | |
static const int64_t | UNLIMITED_VALUE = std::numeric_limits<int64_t>::max() |
Unlimited value. | |
Protected Member Functions | |
virtual void | writeLog (int severity, const UString &message) override |
Actual message reporting method. | |
Protected Attributes | |
DuckContext | duck |
The TSDuck context with various MPEG/DVB features. | |
TSP *const | tsp |
The TSP callback structure can be directly accessed by subclasses. | |
Dektec output plugin for tsp
.
|
inherited |
Args object flags, used in an or'ed mask.
Enumerator | |
---|---|
NO_ERROR_DISPLAY | Don't display errors. |
NO_EXIT_ON_ERROR | Don't terminate application on error. |
NO_EXIT_ON_HELP | Don't terminate application on --help. |
NO_EXIT_ON_VERSION | Don't terminate application on --version. |
GATHER_PARAMETERS | Specifies that all options must be placed before the parameters. Once the first parameter is found, all subsequent elements on the command line are considered as parameters, even if they start with '-' or '--'. |
HELP_ON_THIS | Display help using info() on this object, not standard error. |
NO_DEBUG | No predefined option "--debug". |
NO_HELP | No predefined option "--help". |
NO_VERBOSE | No predefined option "--verbose". |
NO_VERSION | No predefined option "--version". |
NO_CONFIG_FILE | No default option from the configuration file. |
|
inherited |
Type of an argument or parameter.
Enumerator | |
---|---|
NONE | Option without argument. |
STRING | Uninterpreted string argument. |
FILENAME | String argument which will be interpreted as a file name. |
DIRECTORY | String argument which will be interpreted as a directory name. |
HEXADATA | String argument which will be interpreted as a suite of hexadecimal digits. |
INTEGER | Integer argument, must set min & max values. |
UNSIGNED | Integer 0..unlimited. |
POSITIVE | Integer 1..unlimited. |
UINT8 | Integer 0..0xFF. |
UINT16 | Integer 0..0xFFFF. |
UINT32 | Integer 0..0xFFFFFFFF. |
UINT63 | 63-bit unsigned (cannot represent 2^63 and higher). |
PIDVAL | Integer 0..0x1FFF (an MPEG PID value). |
INT8 | Integer -128..127. |
INT16 | Integer -32,768..32,767. |
INT32 | Integer -2,147,483,648..2,147,483,647. |
INT64 | 64-bit signed. |
ANUMBER | A subclass of AbstractNumber. |
CHRONO | Any instantiation of std::chrono::duration. |
TRISTATE | Tristate value, ts::Maybe if absent. |
IPADDR | IPv4 address or host name translating to an address. |
IPSOCKADDR | IPv4 socket address (or host name) and port, both are mandatory. |
IPSOCKADDR_OA | IPv4 socket address (or host name) and port, address is optional. |
IPSOCKADDR_OP | IPv4 socket address (or host name) and port, port is optional. |
IPSOCKADDR_OAP | IPv4 socket address (or host name) and port, address and port are optional. |
|
inherited |
Types of help formatting, for getHelpText() and predefined option --help.
ts::DektecOutputPlugin::DektecOutputPlugin | ( | TSP * | tsp | ) |
Constructor.
[in] | tsp | Associated callback to tsp executable. |
|
overridevirtual |
The main application invokes start() to start the plugin.
Optionally implemented by subclasses.
Reimplemented from ts::Plugin.
|
overridevirtual |
The main application invokes stop() to terminate the plugin.
Optionally implemented by subclasses.
Reimplemented from ts::Plugin.
|
overridevirtual |
Packet output interface.
The main application invokes send() to output packets. This methods writes complete 188-byte TS packets.
[in] | buffer | Address of outgoing packets. |
[in] | pkt_data | Array of metadata for outgoing packets. A packet and its metadata have the same index in their respective arrays. |
[in] | packet_count | Number of packets to send from buffer. |
Implements ts::OutputPlugin.
|
overridevirtual |
Tell if the plugin is a real time one.
Some plugin behave more accurately when the responsiveness of the environment is more accurate. Typically, input and output on tuners, modulators or ASI devices are real-time plugins. On the opposite, working on offline disk files is not.
This method shall be implemented by real-time plugins and shall return true. The default implementation returns false.
A plugin should be defined as real-time by design, not based on the interpretation of command-line parameters. Typically, the method isRealTime() is invoked before starting the plugin and consequently before the plugin has the opportunity to analyze its command-line parameters.
Reimplemented from ts::Plugin.
|
overridevirtual |
Get the plugin bitrate.
The main application may invoke getBitrate() at any time. The semantics depends on the capability.
Optionally implemented by subclasses. By default, return that the plugin is not aware of the bitrate.
Reimplemented from ts::Plugin.
|
overridevirtual |
Get the plugin bitrate confidence.
When a subclass overrides getBitrate(), it should also override getBitrateConfidence().
Reimplemented from ts::Plugin.
|
overridevirtualinherited |
|
virtualinherited |
Define the maximum stack usage for the thread executing the plugin.
If the method is not implemented by a subclass, the default value is DEFAULT_STACK_USAGE (128 kB).
Reimplemented in ts::DektecInputPlugin.
|
virtualinherited |
The main application invokes getOptions() only once, at application startup.
Optionally implemented by subclasses to analyze the command line options. A plugin may ignore getOptions() and analyzes the command line options as part of the start() method. However, if a plugin is started later, command line errors may be reported too late.
Reimplemented in ts::DektecInputPlugin, ts::AbstractDatagramInputPlugin, ts::AbstractDescrambler, ts::AbstractDuplicateRemapPlugin, ts::AbstractHTTPInputPlugin, ts::AbstractTablePlugin, ts::DebugPlugin, ts::FileInputPlugin, ts::FileOutputPlugin, ts::FilePacketPlugin, ts::ForkInputPlugin, ts::ForkOutputPlugin, ts::ForkPacketPlugin, ts::hls::InputPlugin, ts::hls::OutputPlugin, ts::HTTPInputPlugin, ts::HTTPOutputPlugin, ts::IPInputPlugin, ts::IPOutputPlugin, ts::IPPacketPlugin, ts::MemoryInputPlugin, ts::MemoryOutputPlugin, ts::NullInputPlugin, ts::PSIPlugin, ts::RISTInputPlugin, ts::RISTOutputPlugin, ts::SkipPlugin, ts::SRTInputPlugin, ts::SRTOutputPlugin, and ts::TablesPlugin.
|
virtualinherited |
Invoked when no packet could be retrieved within the specified timeout.
For input plugins, this method is called when no space in input buffer can be found within the specified timeout.
|
inherited |
Reset the internal TSDuck execution context of this plugin.
This can be done to set default option values before getOptions() and start(). This can also be done between stop() and start() to enforce a clean restart.
[in] | state | Initial state to set or restore. |
|
inlineinherited |
Add the definition of an option.
This method is typically invoked in the constructor of a subclass.
[in] | name | Long name of option. 0 or "" means a parameter, not an option. |
[in] | short_name | Optional one letter short name. |
[in] | type | Option or parameter value type. |
[in] | min_occur | Minimum number of occurences of this option on the command line, ignored if type is NONE. |
[in] | max_occur | Maximum number of occurences, ignored if type is NONE, 0 means default (1 for an option, unlimited for a parameters). |
[in] | min_value | Minimum value for integer, minimum size for string and hexa data. |
[in] | max_value | Maximum value for integer, maximum size for string and hexa data. |
[in] | optional | When true, the option's value is optional. |
[in] | decimals | Reference number of decimal digits. When decimals is greater than zero, the result is automatically adjusted by the corresponding power of ten. For instance, when decimals is 3, u"12" returns 12000, u"12.34" returns 12340 and "12.345678" returns 12345. All extra decimals are accepted but ignored. |
|
inlineinherited |
Add the definition of an option, the value being from an enumeration type.
This method is typically invoked in the constructor of a subclass.
[in] | name | Long name of option. 0 or "" means a parameter, not an option. |
[in] | short_name | Optional one letter short name. |
[in] | enumeration | List of enumeration values. The command line parameter value can be a string describing an enumeration value or directly an integer value. In the application, the option's value is always the integer value of the enumeration value. |
[in] | min_occur | Minimum number of occurences of this option on the command line. |
[in] | max_occur | Maximum number of occurences. 0 means default : 1 for an option, unlimited for a parameters. |
[in] | optional | When true, the option's value is optional. |
|
inlineinherited |
Add the definition of an option, the value being an instance of AbstractNumber.
This method is typically invoked in the constructor of a subclass of Args.
NUMTYPE | A subclass of AbstractNumber. |
[in] | name | Long name of option. 0 or "" means a parameter, not an option. |
[in] | short_name | Optional one letter short name. |
[in] | min_occur | Minimum number of occurences of this option on the command line. |
[in] | max_occur | Maximum number of occurences. 0 means default : 1 for an option, unlimited for a parameters. |
[in] | min_value | Minimum value. Use an integer value, not a NUMTYPE value. |
[in] | max_value | Maximum value. Use an integer value, not a NUMTYPE value |
[in] | optional | When true, the option's value is optional. |
|
inlineinherited |
Add the definition of an option, the value being an instance of std::chrono::duration.
This method is typically invoked in the constructor of a subclass of Args.
DURATION | An instance of std::chrono::duration. |
[in] | name | Long name of option. 0 or "" means a parameter, not an option. |
[in] | short_name | Optional one letter short name. |
[in] | min_occur | Minimum number of occurences of this option on the command line. |
[in] | max_occur | Maximum number of occurences. 0 means default : 1 for an option, unlimited for a parameters. |
[in] | min_value | Minimum value. Use an integer value, not a DURATION value. |
[in] | max_value | Maximum value. Use an integer value, not a DURATION value. |
[in] | optional | When true, the option's value is optional. |
|
inherited |
Add the help text of an existing option.
[in] | name | Long name of option. 0 or "" means a parameter, not an option. |
[in] | syntax | String to display for the option value instead of the default "value". For instance: "address:port" "'string'". |
[in] | text | Help text. Unformatted, line breaks will be added automatically. |
Add the help text of an existing option.
[in] | name | Long name of option. 0 or "" means a parameter, not an option. |
[in] | text | Help text. Unformatted, line breaks will be added automatically. |
|
inherited |
When an option has an Enumeration type, get a list of all valid names.
[in] | name | Long name of option. 0 or "" means a parameter, not an option. |
[in] | separator | The separator to be used between values, a comma by default. |
Copy all option definitions from another Args object into this one.
This method is typically invoked in the constructor of a subclass to import all option definitions of another instance.
[in] | other | Another instance from which to get the options. |
[in] | replace | If true, override duplicated options which were already declared in this object. If false (the default), duplicated options are ignored. |
|
virtualinherited |
Set the description of the command.
[in] | description | A short one-line description, e.g. "Wonderful File Copier". |
|
virtualinherited |
Set the syntax of the command.
[in] | syntax | A short one-line syntax summary, e.g. "[options] filename ...". |
Reimplemented in ts::ArgsWithPlugins.
|
virtualinherited |
Set the introduction or preamble text for help description.
[in] | intro | Introduction text. |
|
virtualinherited |
Set the conclusion or tailing text for help description.
[in] | tail | Tailing text. |
|
virtualinherited |
Set the option flags of the command.
[in] | flags | Define various options, a combination of or'ed values from Flags. |
|
inlineinherited |
Get the description of the command.
|
inlineinherited |
Get the syntax of the command.
|
inlineinherited |
Get the option flags of the command.
|
virtualinherited |
Get a formatted help text.
[in] | format | Requested format of the help text. |
[in] | line_width | Maximum width of text lines. |
Reimplemented in ts::ArgsWithPlugins.
|
inlineinherited |
Set the initial application name (will be overwritten at next command analysis).
[in] | name | Application name string. |
|
inlineinherited |
Set the "shell" string.
The shell string is an optional prefix for the syntax line as displayed by the --help predefined option. The shell name is displayed before the application name.
[in] | shell | Shell name string. |
|
inlineinherited |
|
virtualinherited |
Load command arguments and analyze them.
Normally, in case of error or if --help
or --version
is specified, the application is automatically terminated. If some flags prevent the termination of the application, return true
if the command is correct, false
if the command is incorrect or --help
or --version
is specified.
[in] | command | Full command line, with application name and parameters. Parameters are separated with spaces. Special characters and spaces must be escaped or quoted in the parameters. |
[in] | processRedirections | If true (the default), process command line arguments redirection. All lines with the form '@filename' are replaced by the content of filename. |
true
if the command is correct, false
if the command is incorrect or --help
or --version
is specified. Reimplemented in ts::ArgsWithPlugins.
|
virtualinherited |
Load command arguments and analyze them.
Normally, in case of error or if --help
or --version
is specified, the application is automatically terminated. If some flags prevent the termination of the application, return true
if the command is correct, false
if the command is incorrect or --help
or --version
is specified.
[in] | argc | Number of arguments from command line. |
[in] | argv | Arguments from command line. The application name is in argv[0]. The subsequent elements contain the arguments. |
[in] | processRedirections | If true (the default), process command line arguments redirection. All lines with the form '@filename' are replaced by the content of filename. |
true
if the command is correct, false
if the command is incorrect or --help
or --version
is specified. Reimplemented in ts::ArgsWithPlugins.
|
virtualinherited |
Load command arguments and analyze them.
Normally, in case of error or if --help
or --version
is specified, the application is automatically terminated. If some flags prevent the termination of the application, return true
if the command is correct, false
if the command is incorrect or --help
or --version
is specified.
[in] | app_name | Application name. |
[in] | arguments | Arguments from command line. |
[in] | processRedirections | If true (the default), process command line arguments redirection. All lines with the form '@filename' are replaced by the content of filename. |
true
if the command is correct, false
if the command is incorrect or --help
or --version
is specified. Reimplemented in ts::ArgsWithPlugins.
|
inlineinherited |
Check if options were correct during the last command line analysis.
|
inlineinherited |
Get the application name from the last command line analysis.
|
staticinherited |
Get the application name from a standard argc/argv pair.
[in] | argc | Number of arguments from command line. |
[in] | argv | Arguments from command line. |
|
inlineinherited |
Get the command line parameters from the last command line analysis.
[out] | args | The command parameters from the last command line analysis. |
|
inherited |
Get the full command line from the last command line analysis.
|
inherited |
Check if an option is present in the last analyzed command line.
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command, a fatal error is reported. |
|
inherited |
Check the number of occurences of an option in the last analyzed command line.
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command, a fatal error is reported. |
|
inherited |
Get the value of an option in the last analyzed command line.
[out] | value | A string receiving the value of the option or parameter. |
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command, a fatal error is reported. |
[in] | def_value | The string to return in value if the option or parameter is not present in the command line or with fewer occurences than index. |
[in] | index | The occurence of the option to return. Zero designates the first occurence. |
|
inherited |
Get the value of an AbstractNumber option in the last analyzed command line.
If the option has been declared with an AbstractNumber type in the syntax of the command, the validity of the supplied option value has been checked by the analyze() method. If analyze() did not fail, the option value is guaranteed to be in the declared range.
NUMTYPE | A subclass of AbstractNumber. |
[out] | value | A variable receiving the value of the option or parameter. |
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command or declared as a non-string type, a fatal error is reported. |
[in] | def_value | The value to return in value if the option or parameter is not present in the command line or with fewer occurences than index. |
[in] | index | The occurence of the option to return. Zero designates the first occurence. |
|
inlineinherited |
Get the value of an AbstractNumber option in the last analyzed command line.
If the option has been declared with an AbstractNumber type in the syntax of the command, the validity of the supplied option value has been checked by the analyze() method. If analyze() did not fail, the option value is guaranteed to be in the declared range.
NUMTYPE | A subclass of AbstractNumber. |
[out] | value | A variable receiving the value of the option or parameter. |
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command or declared as a non-string type, a fatal error is reported. |
[in] | def_value | The value to return in value if the option or parameter is not present in the command line or with fewer occurences than index. |
[in] | index | The occurence of the option to return. Zero designates the first occurence. |
|
inherited |
Get the value of an option in the last analyzed command line.
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command, a fatal error is reported. |
[in] | def_value | The string to return if the option or parameter is not present in the command line or with fewer occurences than index. |
[in] | index | The occurence of the option to return. Zero designates the first occurence. |
|
inherited |
Get the value of an option in the last analyzed command line, only if present.
[in,out] | value | A std::optional string receiving the value of the option or parameter. |
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command, a fatal error is reported. |
[in] | clear_if_absent | When the option is not present, the std::optional object is cleared (set to uninitialized) when clear_if_absent it true. Otherwise, it is left unmodified. |
|
inherited |
Get all occurences of an option in a container of strings.
CONTAINER | A container type of UString such as list, vector, etc. |
[out] | values | A container of strings receiving all values of the option or parameter. |
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command, a fatal error is reported. |
|
inherited |
Get the value of a filesystem path option in the last analyzed command line.
[out] | value | A path receiving the value of the option or parameter. |
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command, a fatal error is reported. |
[in] | def_value | The path to return in value if the option or parameter is not present in the command line or with fewer occurences than index. |
[in] | index | The occurence of the option to return. Zero designates the first occurence. |
|
inherited |
Get all occurences of a filesystem path option in a container of path.
CONTAINER | A container type of fs::path such as list, vector, etc. |
[out] | values | A container of fs::path receiving all values of the option or parameter. |
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command, a fatal error is reported. |
|
inherited |
Get the value of an integer option in the last analyzed command line.
If the option has been declared with an integer type in the syntax of the command, the validity of the supplied option value has been checked by the analyze() method. If analyze() did not fail, the option value is guaranteed to be in the declared range.
INT | An integer or enumeration type for the result. |
[out] | value | A variable receiving the integer value of the option or parameter. |
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command or declared as a non-string type, a fatal error is reported. |
[in] | def_value | The value to return in value if the option or parameter is not present in the command line or with fewer occurences than index. |
[in] | index | The occurence of the option to return. Zero designates the first occurence. |
|
inherited |
Get the value of an integer option in the last analyzed command line.
INT | An integer or enumeration type for the result. |
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command or declared as a non-string type, a fatal error is reported. |
[in] | def_value | The value to return if the option or parameter is not present in the command line or with fewer occurences than index. |
[in] | index | The occurence of the option to return. Zero designates the first occurence. |
|
inherited |
Get the value of an integer option in the last analyzed command line, only if present.
INT | An integer or enumeration type for the result. |
[in,out] | value | A std::optional integer receiving the value of the option or parameter. |
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command, a fatal error is reported. |
[in] | clear_if_absent | When the option is not present, the std::optional object is cleared (set to uninitialized) when clear_if_absent it true. Otherwise, it is left unmodified. |
|
inherited |
Get all occurences of an integer option in a vector of integers.
INT | An integer or enumeration type for the result. |
[out] | values | A container of integers receiving all values of the option or parameter. |
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command or declared as a non-string type, a fatal error is reported. |
|
inherited |
Get all occurences of an integer option in a set of integers.
INT | An integer or enumeration type for the result. |
[out] | values | A container of integers receiving all values of the option or parameter. |
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command or declared as a non-string type, a fatal error is reported. |
|
inherited |
Get all occurences of an option as a bitset of values.
[out] | values | A bitset receiving all values of the option or parameter. For each value of the option, the corresponding bit is set. Values which are out of range are ignored. |
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command, a fatal error is reported. |
[in] | defValue | The boolean to set in all values if the option or parameter is not present in the command line. |
|
inherited |
Get all occurences of an option as a compact bitset of values.
[out] | values | A compact bitset receiving all values of the option or parameter. For each value of the option, the corresponding bit is set. Values which are out of range are ignored. |
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command, a fatal error is reported. |
[in] | defValue | The boolean to set in all values if the option or parameter is not present in the command line. |
|
inherited |
Get an OR'ed of all values of an integer option in the last analyzed command line.
This method is typically useful when the values of an option are taken from an Enumeration and each value is a bit mask. When specifying several values, the result of this method is a mask of all specified options.
INT | An integer type for the result. |
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command or declared as a non-string type, a fatal error is reported. |
[in] | def_value | The value to return in value if the option or parameter is not present in the command line. |
|
inherited |
Get an OR'ed of all values of an integer option in the last analyzed command line.
This method is typically useful when the values of an option are taken from an Enumeration and each value is a bit mask. When specifying several values, the result of this method is a mask of all specified options.
INT | An integer type for the result. |
[out] | value | A variable receiving the OR'ed values of the integer option. |
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command or declared as a non-string type, a fatal error is reported. |
[in] | def_value | The value to return in value if the option or parameter is not present in the command line. |
|
inherited |
Get the value of an std::chrono::duration option in the last analyzed command line.
If the option has been declared with a std::chrono::duration type in the syntax of the command, the validity of the supplied option value has been checked by the analyze() method. If analyze() did not fail, the option value is guaranteed to be in the declared range.
[out] | value | A variable receiving the duration value of the option or parameter. |
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command or declared as a non-string type, a fatal error is reported. |
[in] | def_value | The value to return in value if the option or parameter is not present in the command line or with fewer occurences than index. |
[in] | index | The occurence of the option to return. Zero designates the first occurence. Add the definition of an option, the value being an instance of std::chrono::duration. |
|
inlineinherited |
Get the value of an std::chrono::duration option in the last analyzed command line.
If the option has been declared with a std::chrono::duration type in the syntax of the command, the validity of the supplied option value has been checked by the analyze() method. If analyze() did not fail, the option value is guaranteed to be in the declared range.
[out] | value | A variable receiving the duration value of the option or parameter. |
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command or declared as a non-string type, a fatal error is reported. |
[in] | index | The occurence of the option to return. Zero designates the first occurence. Add the definition of an option, the value being an instance of std::chrono::duration. |
|
inherited |
Get the value of tristate option in the last analyzed command line.
[out] | value | A variable receiving the tristate value of the option or parameter. The returned value is always one of the three valid Tristate values. When the option or parameter is not present in the command line or with fewer occurences than index, the returned value is Maybe. For options with optional values, if the the option is present without value, the returned value is TRUE. |
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command or declared as a non-string type, a fatal error is reported. |
[in] | index | The occurence of the option to return. Zero designates the first occurence. |
Get the value of tristate option in the last analyzed command line.
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command or declared as a non-string type, a fatal error is reported. |
[in] | index | The occurence of the option to return. Zero designates the first occurence. |
|
inherited |
Get the value of an hexadecimal option in the last analyzed command line.
[out] | value | A variable receiving the decoded binary value of the option or parameter. |
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command or declared as a non-string type, a fatal error is reported. |
[in] | def_value | The data to return if the option or parameter is not present in the command line or with fewer occurences than index. |
[in] | index | The occurence of the option to return. Zero designates the first occurence. |
|
inherited |
Get the value of an hexadecimal option in the last analyzed command line.
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command or declared as a non-string type, a fatal error is reported. |
[in] | def_value | The data to return if the option or parameter is not present in the command line or with fewer occurences than index. |
[in] | index | The occurence of the option to return. Zero designates the first occurence. |
|
inherited |
Get the value of an option as an IPv4 address in the last analyzed command line.
[out] | value | A variable receiving the resolved IPv4 address value of the option or parameter. |
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command or declared as a non-string type, a fatal error is reported. |
[in] | def_value | The IPv4 address to return if the option or parameter is not present in the command line or with fewer occurences than index. |
[in] | index | The occurence of the option to return. Zero designates the first occurence. |
|
inherited |
Get the value of an option as an IPv4 address in the last analyzed command line.
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command or declared as a non-string type, a fatal error is reported. |
[in] | def_value | The IPv4 address to return if the option or parameter is not present in the command line or with fewer occurences than index. |
[in] | index | The occurence of the option to return. Zero designates the first occurence. |
|
inherited |
Get the value of an option as an IPv4 socket address in the last analyzed command line.
[out] | value | A variable receiving the resolved IPv4 socket address value of the option or parameter. |
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command or declared as a non-string type, a fatal error is reported. |
[in] | def_value | The IPv4 address socket to return if the option or parameter is not present in the command line or with fewer occurences than index. If the parameter is present but either address or port is missing, the missing part is copied from def_value. |
[in] | index | The occurence of the option to return. Zero designates the first occurence. |
|
inherited |
Get the value of an option as an IPv4 socket address in the last analyzed command line.
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command or declared as a non-string type, a fatal error is reported. |
[in] | def_value | The IPv4 socket address to return if the option or parameter If the parameter is present but either address or port is missing, the missing part is copied from def_value. is not present in the command line or with fewer occurences than index. |
[in] | index | The occurence of the option to return. Zero designates the first occurence. |
|
inherited |
Get the value of an AbstractNumber option in the last analyzed command line.
If the option has been declared with an AbstractNumber type in the syntax of the command, the validity of the supplied option value has been checked by the analyze() method. If analyze() did not fail, the option value is guaranteed to be in the declared range.
NUMTYPE | A subclass of AbstractNumber. |
[in] | name | The full name of the option. If the parameter is a null pointer or an empty string, this specifies a parameter, not an option. If the specified option was not declared in the syntax of the command or declared as a non-string type, a fatal error is reported. |
[in] | def_value | The value to return in value if the option or parameter is not present in the command line or with fewer occurences than index. |
[in] | index | The occurence of the option to return. Zero designates the first occurence. |
|
inherited |
Exit application when errors were reported in the last analyzed command line.
[in] | force | If true, ignore flag NO_EXIT_ON_ERROR and force application termination on error. |
|
inherited |
Process argument redirection using '@'
on a vector of strings.
[in,out] | args | A vector of strings. All lines of the form '@filename' are replaced by the content of the given file. A double '@@' at the beginning of a line is replaced by a single '@' without reading a file. |
|
overrideprotectedvirtualinherited |
Actual message reporting method.
The method is called only when a message passed the severity filter. It is not necessary to recheck the maximum severity inside the method. By default, does nothing.
[in] | severity | Message severity. |
[in] | msg | Message text. |
Reimplemented from ts::Report.
|
inherited |
Set maximum severity level.
Messages with higher severities are not reported.
[in] | level | Set report to that level. |
[in] | delegated | Propagate the severity to delegated reports. |
|
inherited |
Raise maximum severity level.
The severity can only be increased (more verbose, more debug), never decreased.
[in] | level | Set report at least to that level. |
[in] | delegated | Propagate the severity to delegated reports. |
|
inlineinherited |
Get maximum severity level.
|
inlineinherited |
Check if errors (or worse) were reported through this object.
Errors which were reported through delegated reports are ignored.
|
inlineinherited |
Reset the error indicator.
|
inlineinherited |
Set the prefix to display before each message.
[in] | prefix | The prefix to prepend to all messages. |
|
inlineinherited |
Get the current prefix to display.
Delegate message logging to another report object.
[in] | report | New report object to which messages are delegated. Use nullptr to remove the delegation and return to normal logging. |
|
inlineinherited |
Check if debugging is active.
|
inlineinherited |
Report a debug message.
[in] | msg | Message line. |
|
inlineinherited |
Report a debug message.
[in] | msg | Message line. |
|
inlineinherited |
Report a debug message with a printf-like interface.
[in] | fmt | Format string with embedded '%' sequences. |
[in] | args | List of arguments to substitute in the format string. |
|
inlineinherited |
Report a debug message with a printf-like interface.
[in] | fmt | Format string with embedded '%' sequences. |
[in] | args | List of arguments to substitute in the format string. |
|
inlineinherited |
Check if verbose reporting is active.
|
inlineinherited |
Report a verbose message.
[in] | msg | Message line. |
|
inlineinherited |
Report a verbose message.
[in] | msg | Message line. |
|
inlineinherited |
Report a verbose message with a printf-like interface.
[in] | fmt | Format string with embedded '%' sequences. |
[in] | args | List of arguments to substitute in the format string. |
|
inlineinherited |
Report a verbose message with a printf-like interface.
[in] | fmt | Format string with embedded '%' sequences. |
[in] | args | List of arguments to substitute in the format string. |
|
inherited |
Report a message with an explicit severity.
[in] | severity | Message severity. |
[in] | msg | Message line. |
|
inlineinherited |
Report a message with an explicit severity and a printf-like interface.
[in] | severity | Message severity. |
[in] | fmt | Format string with embedded '%' sequences. |
[in] | args | List of arguments to substitute in the format string. |
|
inlineinherited |
Report a message with an explicit severity and a printf-like interface.
[in] | severity | Message severity. |
[in] | fmt | Format string with embedded '%' sequences. |
[in] | args | List of arguments to substitute in the format string. |
|
inlineinherited |
Report a fatal error message.
[in] | msg | Message line. |
|
inlineinherited |
Report a fatal error message.
[in] | msg | Message line. |
|
inlineinherited |
Report a fatal error message with a printf-like interface.
[in] | fmt | Format string with embedded '%' sequences. |
[in] | args | List of arguments to substitute in the format string. |
|
inlineinherited |
Report a fatal error message with a printf-like interface.
[in] | fmt | Format string with embedded '%' sequences. |
[in] | args | List of arguments to substitute in the format string. |
|
inlineinherited |
Report a severe error message.
[in] | msg | Message line. |
|
inlineinherited |
Report a severe error message.
[in] | msg | Message line. |
|
inlineinherited |
Report a severe error message with a printf-like interface.
[in] | fmt | Format string with embedded '%' sequences. |
[in] | args | List of arguments to substitute in the format string. |
|
inlineinherited |
Report a severe error message with a printf-like interface.
[in] | fmt | Format string with embedded '%' sequences. |
[in] | args | List of arguments to substitute in the format string. |
|
inlineinherited |
Report an error message.
[in] | msg | Message line. |
|
inlineinherited |
Report an error message.
[in] | msg | Message line. |
|
inlineinherited |
Report an error message with a printf-like interface.
[in] | fmt | Format string with embedded '%' sequences. |
[in] | args | List of arguments to substitute in the format string. |
|
inlineinherited |
Report an error message with a printf-like interface.
[in] | fmt | Format string with embedded '%' sequences. |
[in] | args | List of arguments to substitute in the format string. |
|
inlineinherited |
Report a warning error message.
[in] | msg | Message line. |
|
inlineinherited |
Report a warning error message.
[in] | msg | Message line. |
|
inlineinherited |
Report a warning message with a printf-like interface.
[in] | fmt | Format string with embedded '%' sequences. |
[in] | args | List of arguments to substitute in the format string. |
|
inlineinherited |
Report a warning message with a printf-like interface.
[in] | fmt | Format string with embedded '%' sequences. |
[in] | args | List of arguments to substitute in the format string. |
|
inlineinherited |
Report an informational message.
[in] | msg | Message line. |
|
inlineinherited |
Report an informational message.
[in] | msg | Message line. |
|
inlineinherited |
Report an informational message with a printf-like interface.
[in] | fmt | Format string with embedded '%' sequences. |
[in] | args | List of arguments to substitute in the format string. |
|
inlineinherited |
Report an informational message with a printf-like interface.
[in] | fmt | Format string with embedded '%' sequences. |
[in] | args | List of arguments to substitute in the format string. |
|
staticconstexprinherited |
Unlimited number of occurences.
To be used as value for parameter max_occur to indicate that there is no limit to the number of occurences of an option.
Warning: use only for max_occur (size_t
). Do not use for max_value (int64_t
) since size_t
is uint64_t
on 64-bit platforms.
|
staticinherited |
Unlimited value.
To be used as value for parameter @ max_value to indicate that there is no limit to the parameter integer value.
|
staticinherited |
Enumeration description of HelpFormat.
Typically used to implement the --help command line option.