1 /***************************************************************************
4 * Thu Mar 10 15:02:49 2005
5 * Copyright 2005 Simon Morlat
6 * Email simon.morlat@linphone.org
7 ****************************************************************************/
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU Library General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
29 * The LpConfig object is used to manipulate a configuration file.
32 * The format of the configuration file is a .ini like format:
33 * - sections are defined in []
34 * - each section contains a sequence of key=value pairs.
40 * playback_dev=ALSA: Default device
46 typedef struct _LpConfig LpConfig;
53 #define LP_CONFIG_DEFAULT_STRING(config, name, default) \
54 (config) ? (lp_config_get_string(config, "default_values", name, default)) : (default)
56 #define LP_CONFIG_DEFAULT_INT(config, name, default) \
57 (config) ? (lp_config_get_int(config, "default_values", name, default)) : (default)
59 #define LP_CONFIG_DEFAULT_INT64(config, name, default) \
60 (config) ? (lp_config_get_int64(config, "default_values", name, default)) : (default)
62 #define LP_CONFIG_DEFAULT_FLOAT(config, name, default) \
63 (config) ? (lp_config_get_float(config, "default_values", name, default)) : (default)
66 LpConfig * lp_config_new(const char *filename);
67 int lp_config_read_file(LpConfig *lpconfig, const char *filename);
69 * Retrieves a configuration item as a string, given its section, key, and default value.
72 * The default value string is returned if the config item isn't found.
74 const char *lp_config_get_string(LpConfig *lpconfig, const char *section, const char *key, const char *default_string);
75 int lp_config_read_file(LpConfig *lpconfig, const char *filename);
77 * Retrieves a configuration item as a range, given its section, key, and default min and max values.
80 * @return TRUE if the value is successfully parsed as a range, FALSE otherwise.
81 * If FALSE is returned, min and max are filled respectively with default_min and default_max values.
83 bool_t lp_config_get_range(LpConfig *lpconfig, const char *section, const char *key, int *min, int *max, int default_min, int default_max);
85 * Retrieves a configuration item as an integer, given its section, key, and default value.
88 * The default integer value is returned if the config item isn't found.
90 int lp_config_get_int(LpConfig *lpconfig,const char *section, const char *key, int default_value);
93 * Retrieves a configuration item as a 64 bit integer, given its section, key, and default value.
96 * The default integer value is returned if the config item isn't found.
98 int64_t lp_config_get_int64(LpConfig *lpconfig,const char *section, const char *key, int64_t default_value);
101 int lp_config_read_file(LpConfig *lpconfig, const char *filename);
103 * Retrieves a configuration item as a float, given its section, key, and default value.
106 * The default float value is returned if the config item isn't found.
108 float lp_config_get_float(LpConfig *lpconfig,const char *section, const char *key, float default_value);
110 * Sets a string config item
114 void lp_config_set_string(LpConfig *lpconfig,const char *section, const char *key, const char *value);
116 * Sets a range config item
120 void lp_config_set_range(LpConfig *lpconfig, const char *section, const char *key, int min_value, int max_value);
122 * Sets an integer config item
126 void lp_config_set_int(LpConfig *lpconfig,const char *section, const char *key, int value);
129 * Sets an integer config item, but store it as hexadecimal
133 void lp_config_set_int_hex(LpConfig *lpconfig,const char *section, const char *key, int value);
136 * Sets a 64 bits integer config item
140 void lp_config_set_int64(LpConfig *lpconfig,const char *section, const char *key, int64_t value);
143 * Sets a float config item
147 void lp_config_set_float(LpConfig *lpconfig,const char *section, const char *key, float value);
149 * Writes the config file to disk.
153 int lp_config_sync(LpConfig *lpconfig);
155 * Returns 1 if a given section is present in the configuration.
159 int lp_config_has_section(LpConfig *lpconfig, const char *section);
161 * Removes every pair of key,value in a section and remove the section.
165 void lp_config_clean_section(LpConfig *lpconfig, const char *section);
166 /*tells whether uncommited (with lp_config_sync()) modifications exist*/
167 int lp_config_needs_commit(const LpConfig *lpconfig);
168 void lp_config_destroy(LpConfig *cfg);