option.hpp¶

See Public API for a list of names and headers that are part of the public HPX API.

namespace hpx

namespace program_options

Typedefs

using option = basic_option<char>¶

using woption = basic_option<wchar_t>¶

template<class Char> class basic_option¶

#include <option.hpp>

Option found in input source. Contains a key and a value. The key, in turn, can be a string (name of an option), or an integer (position in input source) – in case no name is specified. The latter is only possible for command line. The template parameter specifies the type of char used for storing the option’s value.

Public Functions

basic_option()¶

basic_option(const std::string &xstring_key, const std::vector<std::string> &xvalue)¶

Public Members

std::string string_key¶: String key of this option. Intentionally independent of the template parameter.

int position_key¶: Position key of this option. All options without an explicit name are sequentially numbered starting from 0. If an option has explicit name, ‘position_key’ is equal to -1. It is possible that both position_key and string_key is specified, in case name is implicitly added.

std::vector<std::basic_string<Char>> value¶: Option’s value

std::vector<std::basic_string<Char>> original_tokens¶: The original unchanged tokens this option was created from.

bool unregistered¶: True if option was not recognized. In that case, ‘string_key’ and ‘value’ are results of purely syntactic parsing of source. The original tokens can be recovered from the “original_tokens” member.

bool case_insensitive¶: True if string_key has to be handled case insensitive.