conf_file.h File Reference

Declaration of the conf_file class used to read a configuration file. More...

#include <advgetopt/variables.h>
#include <cstdint>
#include <fstream>
#include <functional>
#include <map>
#include <memory>
#include <set>

Include dependency graph for conf_file.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	advgetopt::conf_file::callback_entry_t
class	advgetopt::conf_file
class	advgetopt::conf_file_setup
class	advgetopt::parameter_value

Namespaces
namespace	advgetopt
	The advgetopt environment to parse command line options.

Typedefs
typedef std::uint_fast16_t	advgetopt::assignment_operator_t
typedef std::uint_fast16_t	advgetopt::comment_t
typedef std::uint_fast16_t	advgetopt::name_separator_t
typedef std::uint_fast16_t	advgetopt::section_operator_t

Enumerations
enum class	advgetopt::callback_action_t {   advgetopt::created ,   advgetopt::updated ,   advgetopt::erased }
enum class	advgetopt::line_continuation_t {   advgetopt::line_continuation_single_line ,   advgetopt::line_continuation_rfc_822 ,   advgetopt::line_continuation_msdos ,   advgetopt::line_continuation_unix ,   advgetopt::line_continuation_fortran ,   advgetopt::line_continuation_semicolon }

Functions
bool	advgetopt::iswspace (int c)
	Returns true if c is considered to be a whitespace.

Variables
constexpr assignment_operator_t	advgetopt::ASSIGNMENT_OPERATOR_COLON = 0x0002
constexpr assignment_operator_t	advgetopt::ASSIGNMENT_OPERATOR_EQUAL = 0x0001
constexpr assignment_operator_t	advgetopt::ASSIGNMENT_OPERATOR_EXTENDED = 0x0008
constexpr assignment_operator_t	advgetopt::ASSIGNMENT_OPERATOR_MASK = 0x000F
constexpr assignment_operator_t	advgetopt::ASSIGNMENT_OPERATOR_SPACE = 0x0004
constexpr comment_t	advgetopt::COMMENT_CPP = 0x0004
constexpr comment_t	advgetopt::COMMENT_INI = 0x0001
constexpr comment_t	advgetopt::COMMENT_MASK = 0x0007
constexpr comment_t	advgetopt::COMMENT_NONE = 0x0000
constexpr comment_t	advgetopt::COMMENT_SAVE = 0x8000
constexpr comment_t	advgetopt::COMMENT_SHELL = 0x0002
constexpr name_separator_t	advgetopt::NAME_SEPARATOR_DASHES = 0x0002
constexpr name_separator_t	advgetopt::NAME_SEPARATOR_UNDERSCORES = 0x0001
constexpr section_operator_t	advgetopt::SECTION_OPERATOR_BLOCK = 0x0004
constexpr section_operator_t	advgetopt::SECTION_OPERATOR_C = 0x0001
constexpr section_operator_t	advgetopt::SECTION_OPERATOR_CPP = 0x0002
constexpr section_operator_t	advgetopt::SECTION_OPERATOR_INI_FILE = 0x0008
constexpr section_operator_t	advgetopt::SECTION_OPERATOR_MASK = 0x000F
constexpr section_operator_t	advgetopt::SECTION_OPERATOR_NONE = 0x0000
constexpr section_operator_t	advgetopt::SECTION_OPERATOR_ONE_SECTION = 0x8000

Detailed Description

The library offers a way to read a configuration file parameters without doing anything more than that. The getopt class uses it to read and verify the parameters. It also uses it to read files of configuration options.

Definition in file conf_file.h.