sbuild::keyfile_base Class Reference

Base class for key-value configuration file formats. More...

#include <sbuild-keyfile-base.h>

Inheritance diagram for sbuild::keyfile_base:

Inheritance graph
[legend]
List of all members.

Public Types

enum  priority {
  PRIORITY_OPTIONAL, PRIORITY_REQUIRED, PRIORITY_DISALLOWED, PRIORITY_DEPRECATED,
  PRIORITY_OBSOLETE
}
 Configuration parameter priority. More...
enum  error_code {
  BAD_FILE, DEPRECATED_KEY, DEPRECATED_KEY_NL, DISALLOWED_KEY,
  DISALLOWED_KEY_NL, DUPLICATE_GROUP, DUPLICATE_KEY, INVALID_GROUP,
  INVALID_LINE, MISSING_KEY, MISSING_KEY_NL, NO_GROUP,
  NO_KEY, OBSOLETE_KEY, OBSOLETE_KEY_NL, PASSTHROUGH_G,
  PASSTHROUGH_GK, PASSTHROUGH_LG, PASSTHROUGH_LGK
}
 Error codes. More...
typedef parse_error< error_codeerror
 Exception type.

Public Member Functions

 keyfile_base ()
 The constructor.
virtual ~keyfile_base ()
 The destructor.

Detailed Description

Base class for key-value configuration file formats.


Member Typedef Documentation

typedef parse_error<error_code> sbuild::keyfile_base::error

Exception type.


Member Enumeration Documentation

enum sbuild::keyfile_base::priority

Configuration parameter priority.

Enumerator:
PRIORITY_OPTIONAL  The parameter is optional.
PRIORITY_REQUIRED  The parameter is required.
PRIORITY_DISALLOWED  The parameter is not allowed in this context.
PRIORITY_DEPRECATED  The parameter is deprecated, but functional.
PRIORITY_OBSOLETE  The parameter is obsolete, and not functional.

enum sbuild::keyfile_base::error_code

Error codes.

Enumerator:
BAD_FILE  The file to parse couldn't be opened.
DEPRECATED_KEY  The key is deprecated.
DEPRECATED_KEY_NL  The key is deprecated (no line specified).
DISALLOWED_KEY  The key is not allowed.
DISALLOWED_KEY_NL  The key is not allowed (no line specified).
DUPLICATE_GROUP  The group is a duplicate.
DUPLICATE_KEY  The key is a duplicate.
INVALID_GROUP  The group is invalid.
INVALID_LINE  The line is invalid.
MISSING_KEY  The key is missing.
MISSING_KEY_NL  The key is missing (no line specified).
NO_GROUP  No group was specified.
NO_KEY  No key was specified.
OBSOLETE_KEY  The key is obsolete.
OBSOLETE_KEY_NL  The key is obsolete (no line specified).
PASSTHROUGH_G  Pass through exception with group.
PASSTHROUGH_GK  Pass through exception with group and key.
PASSTHROUGH_LG  Pass through exception with line and group.
PASSTHROUGH_LGK  Pass through exception with line, group and key.


Constructor & Destructor Documentation

keyfile_base::keyfile_base (  ) 

The constructor.

keyfile_base::~keyfile_base (  )  [virtual]

The destructor.


The documentation for this class was generated from the following files:
Generated on Sun Jul 8 21:23:51 2007 for sbuild by  doxygen 1.5.2