diff src/libaudacious/configdb.h @ 2313:3149d4b1a9a9 trunk

[svn] - objective-make autodepend fixes - move all sourcecode into src/ and adjust Makefiles accordingly
author nenolod
date Fri, 12 Jan 2007 11:43:40 -0800
parents
children 0b98ad8c8b17
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/libaudacious/configdb.h	Fri Jan 12 11:43:40 2007 -0800
@@ -0,0 +1,198 @@
+#ifndef CONFIGDB_H
+#define CONFIGDB_H
+
+#include <glib.h>
+
+/**
+ * ConfigDb:
+ *
+ * A configuration database handle, opened with bmp_cfg_db_open().
+ **/
+typedef struct _ConfigDb ConfigDb;
+
+
+G_BEGIN_DECLS
+
+    /**
+     * bmp_cfg_db_open:
+     *
+     * Opens the configuration database.
+     *
+     * Return value: A configuration database handle.
+     **/
+    ConfigDb *bmp_cfg_db_open();
+
+    /**
+     * bmp_cfg_db_close:
+     * @db: A configuration database handle.
+     *
+     * Closes the configuration database.
+     **/
+    void bmp_cfg_db_close(ConfigDb *db);
+
+    /**
+     * bmp_cfg_db_get_string:
+     * @db: A configuration database handle.
+     * @section: The section of the configuration database to search.
+     * @key: The name of the field in the configuration database to look up.
+     * @value: Pointer to a buffer to put the data in.
+     *
+     * Searches the configuration database for a value.
+     *
+     * Return value: TRUE if successful, FALSE otherwise.
+     **/
+    gboolean bmp_cfg_db_get_string(ConfigDb *db,
+                                   const gchar *section,
+                                   const gchar *key,
+                                   gchar **value);
+
+    /**
+     * bmp_cfg_db_get_int:
+     * @db: A configuration database handle.
+     * @section: The section of the configuration database to search.
+     * @key: The name of the field in the configuration database to look up.
+     * @value: Pointer to an integer to put the data in.
+     *
+     * Searches the configuration database for a value.
+     *
+     * Return value: TRUE if successful, FALSE otherwise.
+     **/
+    gboolean bmp_cfg_db_get_int(ConfigDb *db,
+                                const gchar *section,
+                                const gchar *key,
+                                gint *value);
+
+    /**
+     * bmp_cfg_db_get_bool:
+     * @db: A configuration database handle.
+     * @section: The section of the configuration database to search.
+     * @key: The name of the field in the configuration database to look up.
+     * @value: Pointer to a boolean to put the data in.
+     *
+     * Searches the configuration database for a value.
+     *
+     * Return value: TRUE if successful, FALSE otherwise.
+     **/
+    gboolean bmp_cfg_db_get_bool(ConfigDb *db,
+                                 const gchar *section,
+                                 const gchar *key,
+                                 gboolean *value);
+
+    /**
+     * bmp_cfg_db_get_float:
+     * @db: A configuration database handle.
+     * @section: The section of the configuration database to search.
+     * @key: The name of the field in the configuration database to look up.
+     * @value: Pointer to a floating point integer to put the data in.
+     *
+     * Searches the configuration database for a value.
+     *
+     * Return value: TRUE if successful, FALSE otherwise.
+     **/
+    gboolean bmp_cfg_db_get_float(ConfigDb *db,
+                                  const gchar *section,
+                                  const gchar *key,
+                                  gfloat *value);
+
+    /**
+     * bmp_cfg_db_get_double:
+     * @db: A configuration database handle.
+     * @section: The section of the configuration database to search.
+     * @key: The name of the field in the configuration database to look up.
+     * @value: Pointer to a double-precision floating point integer to put the data in.
+     *
+     * Searches the configuration database for a value.
+     *
+     * Return value: TRUE if successful, FALSE otherwise.
+     **/
+    gboolean bmp_cfg_db_get_double(ConfigDb *db,
+                                   const gchar *section,
+                                   const gchar *key,
+                                   gdouble *value);
+
+    /**
+     * bmp_cfg_db_set_string:
+     * @db: A configuration database handle.
+     * @section: The section of the configuration database to search.
+     * @key: The name of the field in the configuration database to set.
+     * @value: Pointer to a buffer containing the data.
+     *
+     * Sets a value in the configuration database.
+     **/
+    void bmp_cfg_db_set_string(ConfigDb *db,
+                               const gchar *section,
+                               const gchar *key,
+                               gchar *value);
+
+    /**
+     * bmp_cfg_db_set_int:
+     * @db: A configuration database handle.
+     * @section: The section of the configuration database to search.
+     * @key: The name of the field in the configuration database to set.
+     * @value: Pointer to an integer containing the data.
+     *
+     * Sets a value in the configuration database.
+     **/
+    void bmp_cfg_db_set_int(ConfigDb *db,
+                            const gchar *section,
+                            const gchar *key,
+                            gint value);
+
+    /**
+     * bmp_cfg_db_set_bool:
+     * @db: A configuration database handle.
+     * @section: The section of the configuration database to search.
+     * @key: The name of the field in the configuration database to set.
+     * @value: Pointer to a boolean containing the data.
+     *
+     * Sets a value in the configuration database.
+     **/
+    void bmp_cfg_db_set_bool(ConfigDb *db,
+                             const gchar *section,
+                             const gchar *key,
+                             gboolean value);
+
+    /**
+     * bmp_cfg_db_set_float:
+     * @db: A configuration database handle.
+     * @section: The section of the configuration database to search.
+     * @key: The name of the field in the configuration database to set.
+     * @value: Pointer to a floating point integer containing the data.
+     *
+     * Sets a value in the configuration database.
+     **/
+    void bmp_cfg_db_set_float(ConfigDb *db,
+                              const gchar *section,
+                              const gchar *key,
+                              gfloat value);
+
+    /**
+     * bmp_cfg_db_set_double:
+     * @db: A configuration database handle.
+     * @section: The section of the configuration database to search.
+     * @key: The name of the field in the configuration database to set.
+     * @value: Pointer to a double precision floating point integer containing the data.
+     *
+     * Sets a value in the configuration database.
+     **/
+    void bmp_cfg_db_set_double(ConfigDb *db,
+                               const gchar *section,
+                               const gchar *key,
+                               gdouble value);
+
+    /**
+     * bmp_cfg_db_unset_key:
+     * @db: A configuration database handle.
+     * @section: The section of the configuration database to search.
+     * @key: The name of the field in the configuration database to set.
+     *
+     * Removes a value from the configuration database.
+     **/
+    void bmp_cfg_db_unset_key(ConfigDb *db,
+                              const gchar *section,
+                              const gchar *key);
+
+G_END_DECLS
+
+#endif // CONFIGDB_H
+