Dynamic Instrumentation Tool Platform
DynamoRIO
Public Member Functions
dynamorio::droption::droption_t< T > Class Template Reference

#include <droption.h>

Inheritance diagram for dynamorio::droption::droption_t< T >:
dynamorio::droption::droption_parser_t

Public Member Functions

 droption_t (unsigned int scope, std::string name, T defval, std::string desc_short, std::string desc_long)
 
 droption_t (unsigned int scope, std::string name, unsigned int flags, T defval, std::string desc_short, std::string desc_long)
 
 droption_t (unsigned int scope, std::string name, unsigned int flags, std::string valsep, T defval, std::string desc_short, std::string desc_long)
 
 droption_t (unsigned int scope, std::string name, T defval, T minval, T maxval, std::string desc_short, std::string desc_long)
 
 droption_t (unsigned int scope, std::vector< std::string > names, T defval, std::string desc_short, std::string desc_long)
 
 droption_t (unsigned int scope, std::vector< std::string > names, unsigned int flags, T defval, std::string desc_short, std::string desc_long)
 
 droption_t (unsigned int scope, std::vector< std::string > names, unsigned int flags, std::string valsep, T defval, std::string desc_short, std::string desc_long)
 
 droption_t (unsigned int scope, std::vector< std::string > names, T defval, T minval, T maxval, std::string desc_short, std::string desc_long)
 
T get_value () const
 
void clear_value () override
 
std::string get_value_separator () const
 
void set_value (T new_value)
 
- Public Member Functions inherited from dynamorio::droption::droption_parser_t
bool specified ()
 
std::string get_name ()
 

Additional Inherited Members

- Static Public Member Functions inherited from dynamorio::droption::droption_parser_t
static bool parse_argv (unsigned int scope, int argc, const char *argv[], std::string *error_msg, int *last_index)
 
static std::string usage_short (unsigned int scope)
 
static std::string usage_long (unsigned int scope, std::string pre_name="----------\n", std::string post_name="\n", std::string pre_value="", std::string post_value="\n", std::string pre_desc="", std::string post_desc="\n")
 
static void clear_values ()
 

Detailed Description

template<typename T>
class dynamorio::droption::droption_t< T >

Option class for declaring new options.

Constructor & Destructor Documentation

◆ droption_t() [1/8]

template<typename T >
dynamorio::droption::droption_t< T >::droption_t ( unsigned int  scope,
std::string  name,
T  defval,
std::string  desc_short,
std::string  desc_long 
)
inline

Declares a new option of type T with the given scope, default value, and description in short and long forms.

◆ droption_t() [2/8]

template<typename T >
dynamorio::droption::droption_t< T >::droption_t ( unsigned int  scope,
std::string  name,
unsigned int  flags,
T  defval,
std::string  desc_short,
std::string  desc_long 
)
inline

Declares a new option of type T with the given scope, behavior flags, default value, and description in short and long forms.

◆ droption_t() [3/8]

template<typename T >
dynamorio::droption::droption_t< T >::droption_t ( unsigned int  scope,
std::string  name,
unsigned int  flags,
std::string  valsep,
T  defval,
std::string  desc_short,
std::string  desc_long 
)
inline

Declares a new option of type T with the given scope, behavior flags, accumulated value separator (see DROPTION_FLAG_ACCUMULATE), default value, and description in short and long forms.

◆ droption_t() [4/8]

template<typename T >
dynamorio::droption::droption_t< T >::droption_t ( unsigned int  scope,
std::string  name,
T  defval,
T  minval,
T  maxval,
std::string  desc_short,
std::string  desc_long 
)
inline

Declares a new option of type T with the given scope, default value, minimum and maximum values, and description in short and long forms.

◆ droption_t() [5/8]

template<typename T >
dynamorio::droption::droption_t< T >::droption_t ( unsigned int  scope,
std::vector< std::string >  names,
T  defval,
std::string  desc_short,
std::string  desc_long 
)
inline

Declares a new option of type T with the given scope, list of alternative names, default value, and description in short and long forms.

◆ droption_t() [6/8]

template<typename T >
dynamorio::droption::droption_t< T >::droption_t ( unsigned int  scope,
std::vector< std::string >  names,
unsigned int  flags,
T  defval,
std::string  desc_short,
std::string  desc_long 
)
inline

Declares a new option of type T with the given scope, list of alternative names, behavior flags, default value, and description in short and long forms.

◆ droption_t() [7/8]

template<typename T >
dynamorio::droption::droption_t< T >::droption_t ( unsigned int  scope,
std::vector< std::string >  names,
unsigned int  flags,
std::string  valsep,
T  defval,
std::string  desc_short,
std::string  desc_long 
)
inline

Declares a new option of type T with the given scope, list of alternative names, behavior flags, accumulated value separator (see DROPTION_FLAG_ACCUMULATE), default value, and description in short and long forms. The first listed name is considered the primary name; the others are aliases.

◆ droption_t() [8/8]

template<typename T >
dynamorio::droption::droption_t< T >::droption_t ( unsigned int  scope,
std::vector< std::string >  names,
T  defval,
T  minval,
T  maxval,
std::string  desc_short,
std::string  desc_long 
)
inline

Declares a new option of type T with the given scope, list of alternative names, default value, minimum and maximum values, and description in short and long forms.

Member Function Documentation

◆ clear_value()

template<typename T >
void dynamorio::droption::droption_t< T >::clear_value ( )
inlineoverridevirtual

Resets the value of this option to the default value.

Implements dynamorio::droption::droption_parser_t.

◆ get_value()

template<typename T >
T dynamorio::droption::droption_t< T >::get_value ( ) const
inline

Returns the value of this option.

◆ get_value_separator()

template<typename T >
std::string dynamorio::droption::droption_t< T >::get_value_separator ( ) const
inline

Returns the separator of the option value (see DROPTION_FLAG_ACCUMULATE).

◆ set_value()

template<typename T >
void dynamorio::droption::droption_t< T >::set_value ( T  new_value)
inline

Sets the value of this option, overriding the command line.

The documentation for this class was generated from the following file:
  • /home/runner/work/dynamorio/dynamorio/ext/droption/droption.h