1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
/*
* Copyright (C) 2008 Martin Willi
* Hochschule fuer Technik Rapperswil
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*
* $Id$
*/
/**
* @defgroup settings settings
* @{ @ingroup libstrongswan
*/
#ifndef SETTINGS_H_
#define SETTINGS_H_
typedef struct settings_t settings_t;
#include <library.h>
#include <utils/enumerator.h>
/**
* Generic configuration options read from a config file.
*
* The syntax is quite simple:
*
* settings := (section|keyvalue)*
* section := name { settings }
* keyvalue := key = value\n
*
* E.g.:
* @code
a = b
section-one {
somevalue = asdf
subsection {
othervalue = xxx
}
yetanother = zz
}
section-two {
}
@endcode
*
* The values are accesses using the get() functions using dotted keys, e.g.
* section-one.subsection.othervalue
*/
struct settings_t {
/**
* Get a settings value as a string.
*
* @param key key including sections, printf style format
* @param def value returned if key not found
* @param ... argument list for key
* @return value pointing to internal string
*/
char* (*get_str)(settings_t *this, char *key, char *def, ...);
/**
* Get a boolean yes|no, true|false value.
*
* @param key key including sections, printf style format
* @param def value returned if key not found
* @param ... argument list for key
* @return value of the key
*/
bool (*get_bool)(settings_t *this, char *key, bool def, ...);
/**
* Get an integer value.
*
* @param key key including sections, printf style format
* @param def value returned if key not found
* @param ... argument list for key
* @return value of the key
*/
int (*get_int)(settings_t *this, char *key, int def, ...);
/**
* Get a time value.
*
* @param key key including sections, printf style format
* @param def value returned if key not found
* @param ... argument list for key
* @return value of the key
*/
u_int32_t (*get_time)(settings_t *this, char *key, u_int32_t def, ...);
/**
* Create an enumerator over subsection names of a section.
*
* @param section section including parents, printf style format
* @param ... argument list for key
* @return enumerator over subsection names
*/
enumerator_t* (*create_section_enumerator)(settings_t *this,
char *section, ...);
/**
* Destroy a settings instance.
*/
void (*destroy)(settings_t *this);
};
/**
* Load setings from a file.
*/
settings_t *settings_create(char *file);
#endif /** SETTINGS_H_ @}*/
|
