Attachment 66211 Details for Bug 54151 – [2/5] McdPluginAccountManager: fold interface methods into their implementations

[patch] [2/5] McdPluginAccountManager: fold interface methods into their implementations

0002-McdPluginAccountManager-fold-interface-methods-into-.patch (text/plain), 29.96 KB, created by Simon McVittie on 2012-08-28 09:53:14 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Simon McVittie

Created: 2012-08-28 09:53:14 UTC

Size: 29.96 KB

patch

obsolete

>From 4fae17b03d9cdbfe07238d746de8548928e3f5db Mon Sep 17 00:00:00 2001
>From: Simon McVittie <simon.mcvittie@collabora.co.uk>
>Date: Mon, 27 Aug 2012 17:05:45 +0100
>Subject: [PATCH 2/5] McdPluginAccountManager: fold interface methods into
> their implementations
>
>Nothing except McdPluginAccountManager implements McdStorage, and nothing
>ever will or should, so we can squash the two together.
>---
> src/mcd-storage.c    |  367 +-------------------------------------------------
> src/mcd-storage.h    |   55 --------
> src/plugin-account.c |  295 ++++++++++++++++++++++++++++++++--------
> 3 files changed, 240 insertions(+), 477 deletions(-)
>
>diff --git a/src/mcd-storage.c b/src/mcd-storage.c
>index e87d393..4166215 100644
>--- a/src/mcd-storage.c
>+++ b/src/mcd-storage.c
>@@ -55,76 +55,6 @@ mcd_storage_get_type (void)
> }
> 
> /**
>- * mcd_storage_set_string:
>- * @storage: An object implementing the #McdStorage interface
>- * @account: the unique name of an account
>- * @key: the key (name) of the parameter or setting
>- * @value: the value to be stored (or %NULL to erase it)
>- * @secret: whether the value is confidential (might get stored in the
>- * keyring, for example)
>- *
>- * Copies and stores the supplied @value (or removes it if %NULL) to the
>- * internal cache.
>- *
>- * Returns: a #gboolean indicating whether the cache actually required an
>- * update (so that the caller can decide whether to request a commit to
>- * long term storage or not). %TRUE indicates the cache was updated and 
>- * may not be in sync with the store any longer, %FALSE indicates we already
>- * held the value supplied.
>- */
>-gboolean
>-mcd_storage_set_string (McdStorage *storage,
>-    const gchar *account,
>-    const gchar *key,
>-    const gchar *value,
>-    gboolean secret)
>-{
>-  McdStorageIface *iface = MCD_STORAGE_GET_IFACE (storage);
>-
>-  g_assert (iface != NULL);
>-  g_return_val_if_fail (account != NULL, FALSE);
>-  g_return_val_if_fail (key != NULL, FALSE);
>-  g_return_val_if_fail (iface->set_string != NULL, FALSE);
>-
>-  return iface->set_string (storage, account, key, value, secret);
>-}
>-
>-/**
>- * mcd_storage_set_value:
>- * @storage: An object implementing the #McdStorage interface
>- * @account: the unique name of an account
>- * @key: the key (name) of the parameter or setting
>- * @value: the value to be stored (or %NULL to erase it)
>- * @secret: whether the value is confidential (might get stored in the
>- * keyring, for example)
>- *
>- * Copies and stores the supplied @value (or removes it if %NULL) to the
>- * internal cache.
>- *
>- * Returns: a #gboolean indicating whether the cache actually required an
>- * update (so that the caller can decide whether to request a commit to
>- * long term storage or not). %TRUE indicates the cache was updated and
>- * may not be in sync with the store any longer, %FALSE indicates we already
>- * held the value supplied.
>- */
>-gboolean
>-mcd_storage_set_value (McdStorage *storage,
>-    const gchar *account,
>-    const gchar *key,
>-    const GValue *value,
>-    gboolean secret)
>-{
>-  McdStorageIface *iface = MCD_STORAGE_GET_IFACE (storage);
>-
>-  g_assert (iface != NULL);
>-  g_return_val_if_fail (account != NULL, FALSE);
>-  g_return_val_if_fail (key != NULL, FALSE);
>-  g_return_val_if_fail (iface->set_value != NULL, FALSE);
>-
>-  return iface->set_value (storage, account, key, value, secret);
>-}
>-
>-/**
>  * mcd_storage_set_strv:
>  * @storage: An object implementing the #McdStorage interface
>  * @account: the unique name of an account
>@@ -149,314 +79,21 @@ mcd_storage_set_strv (McdStorage *storage,
>     const gchar * const *strv,
>     gboolean secret)
> {
>-  McdStorageIface *iface = MCD_STORAGE_GET_IFACE (storage);
>   GValue v = { 0, };
>   static const gchar * const *empty = { NULL };
>   gboolean ret;
> 
>-  g_assert (iface != NULL);
>+  g_return_val_if_fail (MCD_IS_STORAGE (storage), FALSE);
>   g_return_val_if_fail (account != NULL, FALSE);
>   g_return_val_if_fail (key != NULL, FALSE);
>-  g_return_val_if_fail (iface->set_value != NULL, FALSE);
> 
>   g_value_init (&v, G_TYPE_STRV);
>   g_value_set_static_boxed (&v, strv == NULL ? empty : strv);
>-  ret = iface->set_value (storage, account, key, &v, secret);
>+  ret = mcd_storage_set_value (storage, account, key, &v, secret);
>   g_value_unset (&v);
>   return ret;
> }
> 
>-/**
>- * mcd_storage_commit:
>- * @storage: An object implementing the #McdStorage interface
>- * @account: the unique name of an account
>- *
>- * Sync the long term storage (whatever it might be) with the current
>- * state of our internal cache.
>- */
>-void
>-mcd_storage_commit (McdStorage *storage, const gchar *account)
>-{
>-  McdStorageIface *iface = MCD_STORAGE_GET_IFACE (storage);
>-
>-  g_assert (iface != NULL);
>-  g_return_if_fail (iface->commit != NULL);
>-
>-  iface->commit (storage, account);
>-}
>-
>-/**
>- * mcd_storage_load:
>- * @storage: An object implementing the #McdStorage interface
>- *
>- * Load the long term account settings storage into our internal cache.
>- * Should only really be called during startup, ie before our DBus names
>- * have been claimed and other people might be relying on responses from us.
>- */
>-void
>-mcd_storage_load (McdStorage *storage)
>-{
>-  McdStorageIface *iface = MCD_STORAGE_GET_IFACE (storage);
>-
>-  g_assert (iface != NULL);
>-  g_return_if_fail (iface->load != NULL);
>-
>-  iface->load (storage);
>-}
>-
>-/**
>- * mcd_storage_dup_accounts:
>- * @storage: An object implementing the #McdStorage interface
>- * @n: place for the number of accounts to be written to (or %NULL)
>- *
>- * Returns: a newly allocated GStrv containing the unique account names,
>- * which must be freed by the caller with g_strfreev().
>- **/
>-GStrv
>-mcd_storage_dup_accounts (McdStorage *storage, gsize *n)
>-{
>-  McdStorageIface *iface = MCD_STORAGE_GET_IFACE (storage);
>-
>-  g_assert (iface != NULL);
>-  g_return_val_if_fail (iface->dup_accounts != NULL, NULL);
>-
>-  return iface->dup_accounts (storage, n);
>-}
>-
>-/**
>- * mcd_storage_dup_settings:
>- * @storage: An object implementing the #McdStorage interface
>- * @account: unique name of the account
>- * @n: place for the number of settings to be written to (or %NULL)
>- *
>- * Returns: a newly allocated GStrv containing the names of all the
>- * settings or parameters currently stored for @account. Must be
>- * freed by the caller with g_strfreev().
>- **/
>-GStrv
>-mcd_storage_dup_settings (McdStorage *storage, const gchar *account, gsize *n)
>-{
>-  McdStorageIface *iface = MCD_STORAGE_GET_IFACE (storage);
>-
>-  g_assert (iface != NULL);
>-  g_return_val_if_fail (account != NULL, NULL);
>-  g_return_val_if_fail (iface->dup_settings != NULL, NULL);
>-
>-  return iface->dup_settings (storage, account, n);
>-}
>-
>-/**
>- * mcd_storage_dup_string:
>- * @storage: An object implementing the #McdStorage interface
>- * @account: unique name of the account
>- * @key: name of the setting to be retrieved
>- *
>- * Returns: a newly allocated gchar * which must be freed with g_free().
>- **/
>-gchar *
>-mcd_storage_dup_string (McdStorage *storage,
>-    const gchar *account,
>-    const gchar *key)
>-{
>-  McdStorageIface *iface = MCD_STORAGE_GET_IFACE (storage);
>-
>-  g_assert (iface != NULL);
>-  g_assert (iface->dup_string != NULL);
>-  g_return_val_if_fail (account != NULL, NULL);
>-
>-  return iface->dup_string (storage, account, key);
>-}
>-
>-/**
>- * mcd_storage_dup_value:
>- * @storage: An object implementing the #McdStorage interface
>- * @account: unique name of the account
>- * @key: name of the setting to be retrieved
>- * @type: the type of #GValue to retrieve
>- * @error: a place to store any #GErrors that occur
>- *
>- * Returns: a newly allocated #GValue of type @type, whihc should be freed
>- * with tp_g_value_slice_free() or g_slice_free() depending on whether the
>- * the value itself should be freed (the former frees everything, the latter
>- * only the #GValue container.
>- *
>- * If @error is set, but a non-%NULL value was returned, this indicates
>- * that no value for the @key was found for @account, and the default
>- * value for @type has been returned.
>- **/
>-GValue *
>-mcd_storage_dup_value (McdStorage *storage,
>-    const gchar *account,
>-    const gchar *key,
>-    GType type,
>-    GError **error)
>-{
>-  McdStorageIface *iface = MCD_STORAGE_GET_IFACE (storage);
>-
>-  g_assert (iface != NULL);
>-  g_assert (iface->dup_value != NULL);
>-  g_return_val_if_fail (account != NULL, NULL);
>-
>-  return iface->dup_value (storage, account, key, type, error);
>-}
>-
>-/**
>- * mcd_storage_get_boolean:
>- * @storage: An object implementing the #McdStorage interface
>- * @account: unique name of the account
>- * @key: name of the setting to be retrieved
>- *
>- * Returns: a #gboolean. Unset/unparseable values are returned as %FALSE
>- **/
>-gboolean
>-mcd_storage_get_boolean (McdStorage *storage,
>-    const gchar *account,
>-    const gchar *key)
>-{
>-  McdStorageIface *iface = MCD_STORAGE_GET_IFACE (storage);
>-
>-  g_assert (iface != NULL);
>-  g_assert (iface->get_boolean != NULL);
>-  g_return_val_if_fail (account != NULL, FALSE);
>-
>-  return iface->get_boolean (storage, account, key);
>-}
>-
>-/**
>- * mcd_storage_get_integer:
>- * @storage: An object implementing the #McdStorage interface
>- * @account: unique name of the account
>- * @key: name of the setting to be retrieved
>- *
>- * Returns: a #gint. Unset or non-numeric values are returned as 0
>- **/
>-gint
>-mcd_storage_get_integer (McdStorage *storage,
>-    const gchar *account,
>-    const gchar *key)
>-{
>-  McdStorageIface *iface = MCD_STORAGE_GET_IFACE (storage);
>-
>-  g_assert (iface != NULL);
>-  g_assert (iface->get_integer != NULL);
>-  g_return_val_if_fail (account != NULL, 0);
>-
>-  return iface->get_integer (storage, account, key);
>-}
>-
>-
>-/**
>- * mcd_storage_has_value:
>- * @storage: An object implementing the #McdStorage interface
>- * @account: unique name of the account
>- * @key: name of the setting to be retrieved
>- *
>- * Returns: a #gboolean: %TRUE if the setting is present in the store,
>- * %FALSE otherwise.
>- **/
>-gboolean
>-mcd_storage_has_value (McdStorage *storage,
>-    const gchar *account,
>-    const gchar *key)
>-{
>-  McdStorageIface *iface = MCD_STORAGE_GET_IFACE (storage);
>-
>-  g_assert (iface != NULL);
>-  g_assert (iface->has_value != NULL);
>-  g_return_val_if_fail (account != NULL, FALSE);
>-  g_return_val_if_fail (key != NULL, FALSE);
>-
>-  return iface->has_value (storage, account, key);
>-}
>-
>-/**
>- * mcd_storage_get_plugin:
>- * @storage: An object implementing the #McdStorage interface
>- * @account: unique name of the account
>- *
>- * Returns: the #McpAccountStorage object which is handling the account,
>- * if any (if a new account has not yet been flushed to storage this can 
>- * be %NULL).
>- *
>- * Plugins are kept in permanent storage and can never be unloaded, so
>- * the returned pointer need not be reffed or unreffed. (Indeed, it's
>- * probably safer not to)
>- **/
>-McpAccountStorage *
>-mcd_storage_get_plugin (McdStorage *storage, const gchar *account)
>-{
>-  McdStorageIface *iface = MCD_STORAGE_GET_IFACE (storage);
>-
>-  g_assert (iface != NULL);
>-  g_assert (iface->get_storage_plugin != NULL);
>-  g_return_val_if_fail (account != NULL, NULL);
>-
>-  return iface->get_storage_plugin (storage, account);
>-}
>-
>-/**
>- * mcd_storage_create_account:
>- * @storage: An object implementing the #McdStorage interface
>- * @provider: the desired storage provider, or %NULL
>- * @manager: the name of the manager
>- * @protocol: the name of the protocol
>- * @params: A gchar * / GValue * hash table of account parameters
>- * @error: a #GError to fill when returning %NULL
>- *
>- * Create a new account in storage. This should not store any
>- * information on the long term storage until mcd_storage_commit() is called.
>- *
>- * See mcp_account_storage_create().
>- *
>- * Returns: the unique name to use for the new account, or %NULL on error.
>- */
>-gchar *
>-mcd_storage_create_account (McdStorage *storage,
>-    const gchar *provider,
>-    const gchar *manager,
>-    const gchar *protocol,
>-    GHashTable *params,
>-    GError **error)
>-{
>-  McdStorageIface *iface = MCD_STORAGE_GET_IFACE (storage);
>-
>-  g_assert (iface != NULL);
>-  g_assert (!tp_str_empty (manager));
>-  g_assert (!tp_str_empty (protocol));
>-
>-  if (iface->create_account == NULL)
>-    {
>-      g_set_error (error, TP_ERROR, TP_ERROR_NOT_IMPLEMENTED,
>-          "McdStorage::create_account not implemented");
>-      return NULL;
>-    }
>-
>-  return iface->create_account (storage, provider, manager, protocol, params,
>-      error);
>-}
>-
>-/**
>- * mcd_storage_delete_account:
>- * @storage: An object implementing the #McdStorage interface
>- * @account: unique name of the account
>- *
>- * Removes an account's settings from long term storage.
>- * This does not handle any of the other logic to do with removing
>- * accounts, it merely ensures that no trace of the account remains
>- * in long term storage once mcd_storage_commit() has been called.
>- */
>-void
>-mcd_storage_delete_account (McdStorage *storage, const gchar *account)
>-{
>-  McdStorageIface *iface = MCD_STORAGE_GET_IFACE (storage);
>-
>-  g_assert (iface != NULL);
>-  g_assert (iface->delete_account != NULL);
>-  g_return_if_fail (account != NULL);
>-
>-  iface->delete_account (storage, account);
>-}
>-
> void
> _mcd_storage_store_connections (McdStorage *storage)
> {
>diff --git a/src/mcd-storage.h b/src/mcd-storage.h
>index a988118..7a17f7e 100644
>--- a/src/mcd-storage.h
>+++ b/src/mcd-storage.h
>@@ -32,61 +32,6 @@ typedef struct _McdStorageIface McdStorageIface;
> 
> struct _McdStorageIface {
>   GTypeInterface parent;
>-
>-  void (*load) (McdStorage *storage);
>-
>-  GStrv (*dup_accounts) (McdStorage *storage, gsize *n);
>-
>-  GStrv (*dup_settings) (McdStorage *storage, const gchar *account, gsize *n);
>-
>-  gboolean (*set_string) (McdStorage *storage,
>-      const gchar *account,
>-      const gchar *key,
>-      const gchar *value,
>-      gboolean secret);
>-
>-  gboolean (*set_value) (McdStorage *storage,
>-      const gchar *account,
>-      const gchar *key,
>-      const GValue *value,
>-      gboolean secret);
>-
>-  gchar * (*create_account) (McdStorage *storage,
>-    const gchar *provider,
>-    const gchar *manager,
>-    const gchar *protocol,
>-    GHashTable *params,
>-    GError **error);
>-
>-  void (*delete_account) (McdStorage *storage,
>-      const gchar *account);
>-
>-  void (*commit) (McdStorage *storage, const gchar *account);
>-
>-  gchar * (*dup_string) (McdStorage *storage,
>-    const gchar *account,
>-    const gchar *key);
>-
>-  GValue * (*dup_value) (McdStorage *storage,
>-    const gchar *account,
>-    const gchar *key,
>-    GType type,
>-    GError **error);
>-
>-  gboolean  (*get_boolean) (McdStorage *storage,
>-    const gchar *account,
>-    const gchar *key);
>-
>-  gint (*get_integer) (McdStorage *storage,
>-    const gchar *account,
>-    const gchar *key);
>-
>-  gboolean (*has_value) (McdStorage *storage,
>-      const gchar *account,
>-      const gchar *key);
>-
>-  McpAccountStorage *(*get_storage_plugin) (McdStorage *storage,
>-      const gchar *account);
> };
> 
> #define MCD_TYPE_STORAGE (mcd_storage_get_type ())
>diff --git a/src/plugin-account.c b/src/plugin-account.c
>index 4f26b06..8e99ba7 100644
>--- a/src/plugin-account.c
>+++ b/src/plugin-account.c
>@@ -52,15 +52,12 @@ struct _McdPluginAccountManagerClass {
>     GObjectClass parent;
> };
> 
>-static void storage_iface_init (McdStorageIface *iface,
>-    gpointer unused G_GNUC_UNUSED);
>-
> static void plugin_iface_init (McpAccountManagerIface *iface,
>     gpointer unused G_GNUC_UNUSED);
> 
> G_DEFINE_TYPE_WITH_CODE (McdPluginAccountManager, mcd_plugin_account_manager, \
>     G_TYPE_OBJECT,
>-    G_IMPLEMENT_INTERFACE (MCD_TYPE_STORAGE, storage_iface_init);
>+    G_IMPLEMENT_INTERFACE (MCD_TYPE_STORAGE, NULL);
>     G_IMPLEMENT_INTERFACE (MCP_TYPE_ACCOUNT_MANAGER, plugin_iface_init))
> 
> static void
>@@ -354,13 +351,22 @@ _mcd_plugin_account_manager_connect_signal (const gchar *signame,
>     }
> }
> 
>-/* implement the McdStorage interface */
>-static void
>-_storage_load (McdStorage *self)
>+/*
>+ * mcd_storage_load:
>+ * @storage: An object implementing the #McdStorage interface
>+ *
>+ * Load the long term account settings storage into our internal cache.
>+ * Should only really be called during startup, ie before our DBus names
>+ * have been claimed and other people might be relying on responses from us.
>+ */
>+void
>+mcd_storage_load (McdStorage *self)
> {
>   McpAccountManager *ma = MCP_ACCOUNT_MANAGER (self);
>   GList *store = NULL;
> 
>+  g_return_if_fail (MCD_IS_PLUGIN_ACCOUNT_MANAGER (self));
>+
>   sort_and_cache_plugins ();
> 
>   store = g_list_last (stores);
>@@ -392,30 +398,71 @@ _storage_load (McdStorage *self)
>     }
> }
> 
>-static GStrv
>-_storage_dup_accounts (McdStorage *storage, gsize *n)
>+/*
>+ * mcd_storage_dup_accounts:
>+ * @storage: An object implementing the #McdStorage interface
>+ * @n: place for the number of accounts to be written to (or %NULL)
>+ *
>+ * Returns: a newly allocated GStrv containing the unique account names,
>+ * which must be freed by the caller with g_strfreev().
>+ */
>+GStrv
>+mcd_storage_dup_accounts (McdStorage *storage,
>+    gsize *n)
> {
>   McdPluginAccountManager *self = MCD_PLUGIN_ACCOUNT_MANAGER (storage);
> 
>+  g_return_val_if_fail (MCD_IS_PLUGIN_ACCOUNT_MANAGER (storage), NULL);
>+
>   return g_key_file_get_groups (self->keyfile, n);
> }
> 
>-static GStrv
>-_storage_dup_settings (McdStorage *storage, const gchar *account, gsize *n)
>+/*
>+ * mcd_storage_dup_settings:
>+ * @storage: An object implementing the #McdStorage interface
>+ * @account: unique name of the account
>+ * @n: place for the number of settings to be written to (or %NULL)
>+ *
>+ * Returns: a newly allocated GStrv containing the names of all the
>+ * settings or parameters currently stored for @account. Must be
>+ * freed by the caller with g_strfreev().
>+ */
>+GStrv
>+mcd_storage_dup_settings (McdStorage *storage,
>+    const gchar *account,
>+    gsize *n)
> {
>   McdPluginAccountManager *self = MCD_PLUGIN_ACCOUNT_MANAGER (storage);
> 
>+  g_return_val_if_fail (MCD_IS_PLUGIN_ACCOUNT_MANAGER (storage), NULL);
>+
>   return g_key_file_get_keys (self->keyfile, account, n, NULL);
> }
> 
>-static McpAccountStorage *
>-_storage_get_plugin (McdStorage *storage, const gchar *account)
>+/*
>+ * mcd_storage_get_plugin:
>+ * @storage: An object implementing the #McdStorage interface
>+ * @account: unique name of the account
>+ *
>+ * Returns: the #McpAccountStorage object which is handling the account,
>+ * if any (if a new account has not yet been flushed to storage this can
>+ * be %NULL).
>+ *
>+ * Plugins are kept in permanent storage and can never be unloaded, so
>+ * the returned pointer need not be reffed or unreffed. (Indeed, it's
>+ * probably safer not to)
>+ */
>+McpAccountStorage *
>+mcd_storage_get_plugin (McdStorage *storage, const gchar *account)
> {
>   GList *store = stores;
>   McdPluginAccountManager *self = MCD_PLUGIN_ACCOUNT_MANAGER (storage);
>   McpAccountManager *ma = MCP_ACCOUNT_MANAGER (self);
>   McpAccountStorage *owner = NULL;
> 
>+  g_return_val_if_fail (MCD_IS_PLUGIN_ACCOUNT_MANAGER (storage), NULL);
>+  g_return_val_if_fail (account != NULL, NULL);
>+
>   for (; store != NULL && owner == NULL; store = g_list_next (store))
>     {
>       McpAccountStorage *plugin = store->data;
>@@ -427,31 +474,72 @@ _storage_get_plugin (McdStorage *storage, const gchar *account)
>   return owner;
> }
> 
>-static gchar *
>-_storage_dup_string (McdStorage *storage,
>+/*
>+ * mcd_storage_dup_string:
>+ * @storage: An object implementing the #McdStorage interface
>+ * @account: unique name of the account
>+ * @key: name of the setting to be retrieved
>+ *
>+ * Returns: a newly allocated gchar * which must be freed with g_free().
>+ */
>+gchar *
>+mcd_storage_dup_string (McdStorage *storage,
>     const gchar *account,
>     const gchar *key)
> {
>   gchar *value = NULL;
>   McdPluginAccountManager *self = MCD_PLUGIN_ACCOUNT_MANAGER (storage);
> 
>+  g_return_val_if_fail (MCD_IS_PLUGIN_ACCOUNT_MANAGER (storage), NULL);
>+  g_return_val_if_fail (account != NULL, NULL);
>+
>   value = g_key_file_get_string (self->keyfile, account, key, NULL);
> 
>   return value;
> }
> 
>-static gboolean
>-_storage_has_value (McdStorage *storage,
>+/*
>+ * mcd_storage_has_value:
>+ * @storage: An object implementing the #McdStorage interface
>+ * @account: unique name of the account
>+ * @key: name of the setting to be retrieved
>+ *
>+ * Returns: a #gboolean: %TRUE if the setting is present in the store,
>+ * %FALSE otherwise.
>+ */
>+gboolean
>+mcd_storage_has_value (McdStorage *storage,
>     const gchar *account,
>     const gchar *key)
> {
>   McdPluginAccountManager *self = MCD_PLUGIN_ACCOUNT_MANAGER (storage);
> 
>+  g_return_val_if_fail (MCD_IS_PLUGIN_ACCOUNT_MANAGER (storage), FALSE);
>+  g_return_val_if_fail (account != NULL, FALSE);
>+  g_return_val_if_fail (key != NULL, FALSE);
>+
>   return g_key_file_has_key (self->keyfile, account, key, NULL);
> }
> 
>-static GValue *
>-_storage_dup_value (McdStorage *storage,
>+/*
>+ * mcd_storage_dup_value:
>+ * @storage: An object implementing the #McdStorage interface
>+ * @account: unique name of the account
>+ * @key: name of the setting to be retrieved
>+ * @type: the type of #GValue to retrieve
>+ * @error: a place to store any #GErrors that occur
>+ *
>+ * Returns: a newly allocated #GValue of type @type, whihc should be freed
>+ * with tp_g_value_slice_free() or g_slice_free() depending on whether the
>+ * the value itself should be freed (the former frees everything, the latter
>+ * only the #GValue container.
>+ *
>+ * If @error is set, but a non-%NULL value was returned, this indicates
>+ * that no value for the @key was found for @account, and the default
>+ * value for @type has been returned.
>+ */
>+GValue *
>+mcd_storage_dup_value (McdStorage *storage,
>     const gchar *account,
>     const gchar *key,
>     GType type,
>@@ -463,7 +551,12 @@ _storage_dup_value (McdStorage *storage,
>   guint64 v_uint = 0;
>   gboolean v_bool = FALSE;
>   double v_double = 0.0;
>-  GKeyFile *keyfile = MCD_PLUGIN_ACCOUNT_MANAGER (storage)->keyfile;
>+  GKeyFile *keyfile;
>+
>+  g_return_val_if_fail (MCD_IS_PLUGIN_ACCOUNT_MANAGER (storage), NULL);
>+  g_return_val_if_fail (account != NULL, NULL);
>+
>+  keyfile = MCD_PLUGIN_ACCOUNT_MANAGER (storage)->keyfile;
> 
>   switch (type)
>     {
>@@ -610,23 +703,45 @@ _storage_dup_value (McdStorage *storage,
>   return value;
> }
> 
>-static gboolean
>-_storage_get_boolean (McdStorage *storage,
>+/*
>+ * mcd_storage_get_boolean:
>+ * @storage: An object implementing the #McdStorage interface
>+ * @account: unique name of the account
>+ * @key: name of the setting to be retrieved
>+ *
>+ * Returns: a #gboolean. Unset/unparseable values are returned as %FALSE
>+ */
>+gboolean
>+mcd_storage_get_boolean (McdStorage *storage,
>     const gchar *account,
>     const gchar *key)
> {
>   McdPluginAccountManager *self = MCD_PLUGIN_ACCOUNT_MANAGER (storage);
> 
>+  g_return_val_if_fail (MCD_IS_PLUGIN_ACCOUNT_MANAGER (storage), FALSE);
>+  g_return_val_if_fail (account != NULL, FALSE);
>+
>   return g_key_file_get_boolean (self->keyfile, account, key, NULL);
> }
> 
>-static gint
>-_storage_get_integer (McdStorage *storage,
>+/*
>+ * mcd_storage_get_integer:
>+ * @storage: An object implementing the #McdStorage interface
>+ * @account: unique name of the account
>+ * @key: name of the setting to be retrieved
>+ *
>+ * Returns: a #gint. Unset or non-numeric values are returned as 0
>+ */
>+gint
>+mcd_storage_get_integer (McdStorage *storage,
>     const gchar *account,
>     const gchar *key)
> {
>   McdPluginAccountManager *self = MCD_PLUGIN_ACCOUNT_MANAGER (storage);
> 
>+  g_return_val_if_fail (MCD_IS_PLUGIN_ACCOUNT_MANAGER (storage), 0);
>+  g_return_val_if_fail (account != NULL, 0);
>+
>   return g_key_file_get_integer (self->keyfile, account, key, NULL);
> }
> 
>@@ -671,8 +786,26 @@ update_storage (McdPluginAccountManager *self,
>   g_free (val);
> }
> 
>-static gboolean
>-_storage_set_string (McdStorage *storage,
>+/*
>+ * mcd_storage_set_string:
>+ * @storage: An object implementing the #McdStorage interface
>+ * @account: the unique name of an account
>+ * @key: the key (name) of the parameter or setting
>+ * @value: the value to be stored (or %NULL to erase it)
>+ * @secret: whether the value is confidential (might get stored in the
>+ * keyring, for example)
>+ *
>+ * Copies and stores the supplied @value (or removes it if %NULL) to the
>+ * internal cache.
>+ *
>+ * Returns: a #gboolean indicating whether the cache actually required an
>+ * update (so that the caller can decide whether to request a commit to
>+ * long term storage or not). %TRUE indicates the cache was updated and
>+ * may not be in sync with the store any longer, %FALSE indicates we already
>+ * held the value supplied.
>+ */
>+gboolean
>+mcd_storage_set_string (McdStorage *storage,
>     const gchar *account,
>     const gchar *key,
>     const gchar *val,
>@@ -682,6 +815,10 @@ _storage_set_string (McdStorage *storage,
>   gboolean updated = FALSE;
>   gchar *old = g_key_file_get_string (self->keyfile, account, key, NULL);
> 
>+  g_return_val_if_fail (MCD_IS_PLUGIN_ACCOUNT_MANAGER (storage), FALSE);
>+  g_return_val_if_fail (account != NULL, FALSE);
>+  g_return_val_if_fail (key != NULL, FALSE);
>+
>   if (val == NULL)
>     g_key_file_remove_key (self->keyfile, account, key, NULL);
>   else
>@@ -705,16 +842,38 @@ _storage_set_string (McdStorage *storage,
>   return updated;
> }
> 
>-static gboolean
>-_storage_set_value (McdStorage *storage,
>+/*
>+ * mcd_storage_set_value:
>+ * @storage: An object implementing the #McdStorage interface
>+ * @account: the unique name of an account
>+ * @key: the key (name) of the parameter or setting
>+ * @value: the value to be stored (or %NULL to erase it)
>+ * @secret: whether the value is confidential (might get stored in the
>+ * keyring, for example)
>+ *
>+ * Copies and stores the supplied @value (or removes it if %NULL) to the
>+ * internal cache.
>+ *
>+ * Returns: a #gboolean indicating whether the cache actually required an
>+ * update (so that the caller can decide whether to request a commit to
>+ * long term storage or not). %TRUE indicates the cache was updated and
>+ * may not be in sync with the store any longer, %FALSE indicates we already
>+ * held the value supplied.
>+ */
>+gboolean
>+mcd_storage_set_value (McdStorage *storage,
>     const gchar *name,
>     const gchar *key,
>     const GValue *value,
>     gboolean secret)
> {
>+  g_return_val_if_fail (MCD_IS_PLUGIN_ACCOUNT_MANAGER (storage), FALSE);
>+  g_return_val_if_fail (name != NULL, FALSE);
>+  g_return_val_if_fail (key != NULL, FALSE);
>+
>   if (value == NULL)
>     {
>-      return _storage_set_string (storage, name, key, NULL, secret);
>+      return mcd_storage_set_string (storage, name, key, NULL, secret);
>     }
>   else
>     {
>@@ -819,8 +978,24 @@ _storage_set_value (McdStorage *storage,
>     }
> }
> 
>-static gchar *
>-_storage_create_account (McdStorage *storage,
>+/*
>+ * mcd_storage_create_account:
>+ * @storage: An object implementing the #McdStorage interface
>+ * @provider: the desired storage provider, or %NULL
>+ * @manager: the name of the manager
>+ * @protocol: the name of the protocol
>+ * @params: A gchar * / GValue * hash table of account parameters
>+ * @error: a #GError to fill when returning %NULL
>+ *
>+ * Create a new account in storage. This should not store any
>+ * information on the long term storage until mcd_storage_commit() is called.
>+ *
>+ * See mcp_account_storage_create().
>+ *
>+ * Returns: the unique name to use for the new account, or %NULL on error.
>+ */
>+gchar *
>+mcd_storage_create_account (McdStorage *storage,
>     const gchar *provider,
>     const gchar *manager,
>     const gchar *protocol,
>@@ -831,6 +1006,10 @@ _storage_create_account (McdStorage *storage,
>   McdPluginAccountManager *self = MCD_PLUGIN_ACCOUNT_MANAGER (storage);
>   McpAccountManager *ma = MCP_ACCOUNT_MANAGER (self);
> 
>+  g_return_val_if_fail (MCD_IS_PLUGIN_ACCOUNT_MANAGER (storage), NULL);
>+  g_return_val_if_fail (!tp_str_empty (manager), NULL);
>+  g_return_val_if_fail (!tp_str_empty (protocol), NULL);
>+
>   /* If a storage provider is specified, use only it or fail */
>   if (provider != NULL)
>     {
>@@ -910,13 +1089,27 @@ _storage_create_account (McdStorage *storage,
>   return NULL;
> }
> 
>-static void
>-_storage_delete_account (McdStorage *storage, const gchar *account)
>+
>+/*
>+ * mcd_storage_delete_account:
>+ * @storage: An object implementing the #McdStorage interface
>+ * @account: unique name of the account
>+ *
>+ * Removes an account's settings from long term storage.
>+ * This does not handle any of the other logic to do with removing
>+ * accounts, it merely ensures that no trace of the account remains
>+ * in long term storage once mcd_storage_commit() has been called.
>+ */
>+void
>+mcd_storage_delete_account (McdStorage *storage, const gchar *account)
> {
>   GList *store;
>   McdPluginAccountManager *self = MCD_PLUGIN_ACCOUNT_MANAGER (storage);
>   McpAccountManager *ma = MCP_ACCOUNT_MANAGER (self);
> 
>+  g_return_if_fail (MCD_IS_PLUGIN_ACCOUNT_MANAGER (storage));
>+  g_return_if_fail (account != NULL);
>+
>   g_key_file_remove_group (self->keyfile, account, NULL);
> 
>   for (store = stores; store != NULL; store = g_list_next (store))
>@@ -927,12 +1120,22 @@ _storage_delete_account (McdStorage *storage, const gchar *account)
>     }
> }
> 
>-static void
>-_storage_commit (McdStorage *self, const gchar *account)
>+/*
>+ * mcd_storage_commit:
>+ * @storage: An object implementing the #McdStorage interface
>+ * @account: the unique name of an account
>+ *
>+ * Sync the long term storage (whatever it might be) with the current
>+ * state of our internal cache.
>+ */
>+void
>+mcd_storage_commit (McdStorage *self, const gchar *account)
> {
>   GList *store;
>   McpAccountManager *ma = MCP_ACCOUNT_MANAGER (self);
> 
>+  g_return_if_fail (MCD_IS_PLUGIN_ACCOUNT_MANAGER (self));
>+
>   for (store = stores; store != NULL; store = g_list_next (store))
>     {
>       McpAccountStorage *plugin = store->data;
>@@ -968,28 +1171,6 @@ _mcd_plugin_account_manager_ready (McdPluginAccountManager *self)
> }
> 
> static void
>-storage_iface_init (McdStorageIface *iface,
>-    gpointer unused G_GNUC_UNUSED)
>-{
>-  iface->load = _storage_load;
>-  iface->dup_accounts = _storage_dup_accounts;
>-  iface->dup_settings = _storage_dup_settings;
>-
>-  iface->create_account = _storage_create_account;
>-  iface->delete_account = _storage_delete_account;
>-  iface->set_string = _storage_set_string;
>-  iface->set_value = _storage_set_value;
>-  iface->commit = _storage_commit;
>-
>-  iface->has_value = _storage_has_value;
>-  iface->get_storage_plugin = _storage_get_plugin;
>-  iface->dup_value = _storage_dup_value;
>-  iface->dup_string = _storage_dup_string;
>-  iface->get_integer = _storage_get_integer;
>-  iface->get_boolean = _storage_get_boolean;
>-}
>-
>-static void
> plugin_iface_init (McpAccountManagerIface *iface,
>     gpointer unused G_GNUC_UNUSED)
> {
>-- 
>1.7.10.4
>

Actions: View | Splinter Review

Attachments on bug 54151: 66210 | 66211 | 66212 | 66213 | 66214

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.