sjero.net Git - linphone/blob - coreapi/lpconfig.h

   1 /***************************************************************************
   2  *            lpconfig.h
   3  *
   4  *  Thu Mar 10 15:02:49 2005
   5  *  Copyright  2005  Simon Morlat
   6  *  Email simon.morlat@linphone.org
   7  ****************************************************************************/
   8
   9 /*
  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.
  14  *
  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.
  19  *
  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.
  23  */
  24
  25 #ifndef LPCONFIG_H
  26 #define LPCONFIG_H
  27
  28 /**
  29  * The LpConfig object is used to manipulate a configuration file.
  30  *
  31  * @ingroup misc
  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.
  35  *
  36  * Example:
  37  * @code
  38  * [sound]
  39  * echocanceler=1
  40  * playback_dev=ALSA: Default device
  41  *
  42  * [video]
  43  * enabled=1
  44  * @endcode
  45 **/
  46 typedef struct _LpConfig LpConfig;
  47
  48 #ifdef __cplusplus
  49 extern "C" {
  50 #endif
  51
  52 LpConfig * lp_config_new(const char *filename);
  53 int lp_config_read_file(LpConfig *lpconfig, const char *filename);
  54 /**
  55  * Retrieves a configuration item as a string, given its section, key, and default value.
  56  *
  57  * @ingroup misc
  58  * The default value string is returned if the config item isn't found.
  59 **/
  60 const char *lp_config_get_string(LpConfig *lpconfig, const char *section, const char *key, const char *default_string);
  61 int lp_config_read_file(LpConfig *lpconfig, const char *filename);
  62 /**
  63  * Retrieves a configuration item as an integer, given its section, key, and default value.
  64  *
  65  * @ingroup misc
  66  * The default integer value is returned if the config item isn't found.
  67 **/
  68 int lp_config_get_int(LpConfig *lpconfig,const char *section, const char *key, int default_value);
  69 int lp_config_read_file(LpConfig *lpconfig, const char *filename);
  70 /**
  71  * Retrieves a configuration item as a float, given its section, key, and default value.
  72  *
  73  * @ingroup misc
  74  * The default float value is returned if the config item isn't found.
  75 **/
  76 float lp_config_get_float(LpConfig *lpconfig,const char *section, const char *key, float default_value);
  77 /**
  78  * Sets a string config item
  79  *
  80  * @ingroup misc
  81 **/
  82 void lp_config_set_string(LpConfig *lpconfig,const char *section, const char *key, const char *value);
  83 /**
  84  * Sets an integer config item
  85  *
  86  * @ingroup misc
  87 **/
  88 void lp_config_set_int(LpConfig *lpconfig,const char *section, const char *key, int value);
  89 /**
  90  * Sets a float config item
  91  *
  92  * @ingroup misc
  93 **/
  94 void lp_config_set_float(LpConfig *lpconfig,const char *section, const char *key, float value);
  95 /**
  96  * Writes the config file to disk.
  97  *
  98  * @ingroup misc
  99 **/
 100 int lp_config_sync(LpConfig *lpconfig);
 101 /**
 102  * Returns 1 if a given section is present in the configuration.
 103  *
 104  * @ingroup misc
 105 **/
 106 int lp_config_has_section(LpConfig *lpconfig, const char *section);
 107 /**
 108  * Removes every pair of key,value in a section and remove the section.
 109  *
 110  * @ingroup misc
 111 **/
 112 void lp_config_clean_section(LpConfig *lpconfig, const char *section);
 113 /*tells whether uncommited (with lp_config_sync()) modifications exist*/
 114 int lp_config_needs_commit(const LpConfig *lpconfig);
 115 void lp_config_destroy(LpConfig *cfg);
 116
 117 #ifdef __cplusplus
 118 }
 119 #endif
 120
 121 #endif