class common_config_file_iterator

Declaration

class common_config_file_iterator : public eof_iterator { /* full declaration omitted */ };

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: will result in option "gui.accessibility.visual_bell" with value "yes" been returned. TODO: maybe, we should just accept a pointer to options_description class.

Declared at: libs/pika/program_options/include/pika/program_options/detail/config_file.hpp:55

Inherits from: eof_iterator

Method Overview

• public common_config_file_iterator()
• public common_config_file_iterator(const std::set<std::string> & allowed_options, bool allow_unregistered = false)
• public void get()
• protected virtual bool getline(std::string &)
• public virtual ~common_config_file_iterator()

Methods

common_config_file_iterator()

Declared at: libs/pika/program_options/include/pika/program_options/detail/config_file.hpp:59

common_config_file_iterator(
    const std::set<std::string>& allowed_options,
    bool allow_unregistered = false)

Declared at: libs/pika/program_options/include/pika/program_options/detail/config_file.hpp:64

Parameters

const std::set<std::string>& allowed_options

bool allow_unregistered = false

void get()

Declared at: libs/pika/program_options/include/pika/program_options/detail/config_file.hpp:71

virtual bool getline(std::string&)

Declared at: libs/pika/program_options/include/pika/program_options/detail/config_file.hpp:84

Parameters

std::string&

virtual ~common_config_file_iterator()

Declared at: libs/pika/program_options/include/pika/program_options/detail/config_file.hpp:68