* updated test case, code cleanup, documentation fixes

[modest] / src / modest-conf.h

diff --git a/src/modest-conf.h b/src/modest-conf.h
index af1fa2c..40cf511 100644 (file)
--- a/src/modest-conf.h
+++ b/src/modest-conf.h
@@ -27,9 +27,6 @@
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-
-/* modest-conf.h */
-
 #ifndef __MODEST_CONF_H__
 #define __MODEST_CONF_H__
 
@@ -46,20 +43,32 @@ G_BEGIN_DECLS
 #define MODEST_IS_CONF_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_CONF))
 #define MODEST_CONF_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_CONF,ModestConfClass))
 
-typedef struct _ModestConf      ModestConf;
-typedef struct _ModestConfClass ModestConfClass;
+typedef struct _ModestConf        ModestConf;
+typedef struct _ModestConfClass   ModestConfClass;
+/* typedef enum   _ModestConfEvent   ModestConfEvent; */
+/* typedef enum   _ModestConfValueType   ModestConfValueType; */
+
+typedef enum _ModestConfValueType {
+       MODEST_CONF_VALUE_INT,
+       MODEST_CONF_VALUE_BOOL,
+       MODEST_CONF_VALUE_FLOAT,
+       MODEST_CONF_VALUE_STRING
+} ModestConfValueType;
+
+typedef enum _ModestConfEvent {
+       MODEST_CONF_EVENT_KEY_CHANGED,
+       MODEST_CONF_EVENT_KEY_UNSET
+} ModestConfEvent;
 
 struct _ModestConf {
         GObject parent;
 };
 
 struct _ModestConfClass {
-       GObjectClass parent_class;
-       
-       void (* key_changed) (ModestConf* self, const gchar *key, const gchar *new_value);
+       GObjectClass parent_class;      
+       void (* key_changed) (ModestConf* self, const gchar *key, ModestConfEvent event);
 };
 
-
 /**
  * modest_conf_get_type:
  * 
@@ -78,7 +87,7 @@ GType        modest_conf_get_type    (void) G_GNUC_CONST;
  * Returns: a new ModestConf instance, or NULL in case
  * of any error
  */
-GObject*     modest_conf_new         (void);
+ModestConf*     modest_conf_new         (void);
 
 
 /**
@@ -107,7 +116,7 @@ gchar*       modest_conf_get_string  (ModestConf* self, const gchar* key, GError
  * (of course, -1 can also be returned in non-error cases).
  * @err gives details in case of error
  */
-int          modest_conf_get_int     (ModestConf* self, const gchar* key, GError **err);
+gint         modest_conf_get_int     (ModestConf* self, const gchar* key, GError **err);
 
 
 /** 
@@ -118,13 +127,46 @@ int          modest_conf_get_int     (ModestConf* self, const gchar* key, GError
  * 
  * get a boolean value from the configuration system
  *  
- * Returns: a boolean value with the value for the key, or -1 in case of error
- * (of course, -1 can also be returned in non-error cases).
+ * Returns: a boolean value with the value for the key, or FALSE in case of error
+ * (of course, FALSE can also be returned in non-error cases).
  * @err gives details in case of error
  */
 gboolean     modest_conf_get_bool    (ModestConf* self, const gchar* key, GError **err);
 
 
+
+/**
+ * modest_conf_get_string_or_default:
+ * @self: a ModestConf instance
+ * @key: the key of the value to retrieve
+ * @err: a GError ptr, or NULL to ignore.
+ * 
+ * get a string from the configuration system; if the value is not set,
+ * or some error occurs, return @defaultval (copied)
+ *
+ * Returns: a newly allocated string with the value for the key,
+ * or the @defaultval in case of any error
+ */
+gchar*       modest_conf_get_string_or_default  (ModestConf* self, const gchar* key,
+                                                const gchar *defaultval);
+
+
+/**
+ * modest_conf_get_int_or_default:
+ * @self: a ModestConf instance
+ * @key: the key of the value to retrieve
+ * @err: a GError ptr, or NULL to ignore.
+ * 
+ * get an integer from the configuration system; if the value is not set,
+ * or some error occurs, return @defaultval.
+ * 
+ * Returns: an integer with the value for the key, or the @defaultval in case
+ * of any error
+ */
+gint          modest_conf_get_int_or_default     (ModestConf* self, const gchar* key,
+                                                 int defaultval);
+
+
 /**
  * modest_conf_set_string:
  * @self: a ModestConf instance
@@ -215,6 +257,32 @@ gboolean   modest_conf_remove_key    (ModestConf* self, const gchar* key, GError
 gboolean   modest_conf_key_exists   (ModestConf* self, const gchar* key, GError **err);
 
 
+/**
+ * modest_conf_key_escape:
+ * @self: a ModestConf instance. Not used, but for consistency with other ModestConf funcs
+ * @str: a string to escape
+ *
+ * returns an escaped version of @str, ie. something suitable as a key
+ * 
+ * Returns: a newly allocated string with the escaped version
+ */
+gchar* modest_conf_key_escape (ModestConf *self, const gchar* str);
+
+
+/**
+ * modest_conf_key_escape:
+ * @self: a ModestConf instance. Not used, but for consistency with other ModestConf funcs
+ * @str: a string to escape
+ *
+ * returns an unescaped version of @str
+ * 
+ * Returns: a newly allocated string with the unescaped version
+ */
+gchar* modest_conf_key_unescape (ModestConf *self, const gchar* str);
+
+
+GSList* modest_conf_get_list (ModestConf* self, const gchar* key, ModestConfValueType list_type, GError **err);
+
 G_END_DECLS
 
 #endif /* __MODEST_CONF_H__ */