Claw  1.7.3
Public Types | Public Member Functions | Public Attributes | List of all members
claw::configuration_file::syntax_description Struct Reference

This class tells us how to parse the input file. More...

#include <configuration_file.hpp>

Public Types

typedef std::pair< char, char > paired_symbol
 Two symbols making a pair (like () or []).

Public Member Functions

 syntax_description ()
 Default constructor.
std::string make_comment (const std::string &value) const
 Create a comment from a string.
std::string make_assignment (const std::string &key, const std::string &value) const
 Make an assignment of a value to a key.
std::string make_section_name (const std::string &name) const
 Create a section name from a string.

Public Attributes

char comment
 Symbol used to comment the rest of the line.
char assignment
 Symbol used to assign a value to a field.
paired_symbol section_name
 Pair of symbols around a section name.

Detailed Description

This class tells us how to parse the input file.

Definition at line 50 of file configuration_file.hpp.

Member Function Documentation

std::string claw::configuration_file::syntax_description::make_assignment ( const std::string &  key,
const std::string &  value 
) const

Make an assignment of a value to a key.

Parameters
keyThe key.
valueThe value given to the key.

Definition at line 62 of file configuration_file.cpp.

std::string claw::configuration_file::syntax_description::make_comment ( const std::string &  value) const

Create a comment from a string.

Parameters
valueThe string to comment.

Definition at line 50 of file configuration_file.cpp.

std::string claw::configuration_file::syntax_description::make_section_name ( const std::string &  name) const

Create a section name from a string.

Parameters
nameThe name of the section.

Definition at line 73 of file configuration_file.cpp.

Referenced by claw::configuration_file::save().


The documentation for this struct was generated from the following files: