drizzle
C++ MySQL-protocol-compatible database server
Loading...
Searching...
No Matches
drizzled::program_options::detail::common_config_file_iterator Class Reference

#include <config_file.h>

Inheritance diagram for drizzled::program_options::detail::common_config_file_iterator:
[legend]
Collaboration diagram for drizzled::program_options::detail::common_config_file_iterator:
[legend]

Public Member Functions

 common_config_file_iterator (const std::set< std::string > &in_allowed_options, bool allow_unregistered)
void get ()

Protected Member Functions

virtual bool getline (std::string &)

Private Member Functions

void add_option (const char *name)
bool allowed_option (const std::string &s) const

Private Attributes

std::set< std::string > allowed_options
std::set< std::string > allowed_prefixes
std::string m_prefix
bool m_allow_unregistered

Detailed Description

Standalone parser for config files in ini-line format. The parser is a model of single-pass lvalue iterator, and default constructor creates past-the-end-iterator. The typical usage is: config_file_iterator i(is, ... set of options ...), e; for(; i !=e; ++i) { i; }

Syntax conventions:

  • config file can not contain positional options
  • '#' is comment character: it is ignored together with the rest of the line.
  • variable assignments are in the form name '=' value. spaces around '=' are trimmed.
  • Section names are given in brackets.

The actual option name is constructed by combining current section name and specified option name, with dot between. If section_name already contains dot at the end, new dot is not inserted. For example:

[gui.accessibility]
visual_bell=yes

will result in option "gui.accessibility.visual_bell" with value "yes" been returned.

Definition at line 210 of file config_file.h.

Constructor & Destructor Documentation

◆ common_config_file_iterator() [1/2]

drizzled::program_options::detail::common_config_file_iterator::common_config_file_iterator ( )
inline

Definition at line 215 of file config_file.h.

◆ common_config_file_iterator() [2/2]

drizzled::program_options::detail::common_config_file_iterator::common_config_file_iterator ( const std::set< std::string > & in_allowed_options,
bool allow_unregistered )
inline

Definition at line 220 of file config_file.h.

◆ ~common_config_file_iterator()

virtual drizzled::program_options::detail::common_config_file_iterator::~common_config_file_iterator ( )
inlinevirtual

Definition at line 233 of file config_file.h.

Member Function Documentation

◆ add_option()

void drizzled::program_options::detail::common_config_file_iterator::add_option ( const char * name)
inlineprivate

Adds another allowed option. If the 'name' ends with '', then all options with the same prefix are allowed. For example, if 'name' is 'foo', then 'foo1' and 'foo_bar' are allowed.

Definition at line 311 of file config_file.h.

◆ allowed_option()

bool drizzled::program_options::detail::common_config_file_iterator::allowed_option ( const std::string & s) const
inlineprivate

Definition at line 343 of file config_file.h.

◆ get()

void drizzled::program_options::detail::common_config_file_iterator::get ( )
inline

Definition at line 237 of file config_file.h.

◆ getline()

virtual bool drizzled::program_options::detail::common_config_file_iterator::getline ( std::string & )
inlineprotectedvirtual

Definition at line 304 of file config_file.h.

Member Data Documentation

◆ allowed_options

std::set<std::string> drizzled::program_options::detail::common_config_file_iterator::allowed_options
private

Definition at line 360 of file config_file.h.

◆ allowed_prefixes

std::set<std::string> drizzled::program_options::detail::common_config_file_iterator::allowed_prefixes
private

Definition at line 362 of file config_file.h.

◆ m_allow_unregistered

bool drizzled::program_options::detail::common_config_file_iterator::m_allow_unregistered
private

Definition at line 364 of file config_file.h.

◆ m_prefix

std::string drizzled::program_options::detail::common_config_file_iterator::m_prefix
private

Definition at line 363 of file config_file.h.


The documentation for this class was generated from the following file: