pidgin/pidgin

Avoid manual handling of icons in request field list items

2021-04-05, Arkadiy Illarionov
b5eccef8404e
Avoid manual handling of icons in request field list items

* Use `PurpleKeyValuePair` as field list items
* Replace `icons` list with `has_icons` flag, thus fixing memleak
* Replace `purple_request_field_list_get_icons` with `purple_request_field_list_has_icons`

Testing Done:
Compile and run.

Reviewed at https://reviews.imfreedom.org/r/563/
/*
* Purple - Internet Messaging Library
* Copyright (C) Pidgin Developers <devel@pidgin.im>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses/>.
*/
#if !defined(PURPLE_GLOBAL_HEADER_INSIDE) && !defined(PURPLE_COMPILATION)
# error "only <pidgin.h> may be included directly"
#endif
#ifndef PURPLE_CREDENTIAL_MANAGER_H
#define PURPLE_CREDENTIAL_MANAGER_H
#include <glib.h>
#include <glib-object.h>
#include "account.h"
#include <purplecredentialprovider.h>
G_BEGIN_DECLS
/**
* SECTION:purplecredentialmanager
* @section_id: libpurple-purplecredentialmanager
* @title: Purple Credential Manager
*
* Purple Credential Manager is the main API access to different credential
* providers. Providers register themselves with the manager and then the user
* can choose which provider to use.
*
* Once a provider is selected, all credential access will be directed to that
* provider.
*/
/**
* PURPLE_CREDENTIAL_MANAGER_DOMAIN:
*
* A #GError domain for errors from #PurpleCredentialManager.
*
* Since: 3.0.0
*/
#define PURPLE_CREDENTIAL_MANAGER_DOMAIN (g_quark_from_static_string("purple-credential-manager"))
/**
* PURPLE_TYPE_CREDENTIAL_MANAGER:
*
* The standard _get_type macro for #PurpleCredentialManager.
*
* Since: 3.0.0
*/
#define PURPLE_TYPE_CREDENTIAL_MANAGER (purple_credential_manager_get_type())
G_DECLARE_DERIVABLE_TYPE(PurpleCredentialManager, purple_credential_manager,
PURPLE, CREDENTIAL_MANAGER, GObject)
/**
* PurpleCredentialManager:
*
* An opaque data structure that manages credentials.
*
* Since: 3.0.0
*/
/**
* PurpleCredentialManagerClass:
* @provider_registered: The default signal handler for when a provider is
* registered.
* @provider_unregistered: The default signal handler for when a provider is
* unregistered.
* @active_provider_changed: The default signal handler for when the active
* provider is changed.
*
* The class structure for #PurpleCredentialProvider.
*
* Since: 3.0.0
*/
struct _PurpleCredentialManagerClass {
/*< private >*/
GObjectClass parent;
/*< public >*/
void (*provider_registered)(PurpleCredentialManager *manager, PurpleCredentialProvider *provider);
void (*provider_unregistered)(PurpleCredentialManager *manager, PurpleCredentialProvider *provider);
void (*active_provider_changed)(PurpleCredentialManager *manager, PurpleCredentialProvider *old, PurpleCredentialProvider *current);
/*< private >*/
gpointer reserved[8];
};
/**
* PurpleCredentialManagerForeachFunc:
* @provider: The #PurpleCredentialProvider instance.
* @data: User supplied data.
*
* A function to be used as a callback with
* purple_credential_manager_foreach_provider().
*
* Since: 3.0.0
*/
typedef void (*PurpleCredentialManagerForeachFunc)(PurpleCredentialProvider *provider, gpointer data);
/**
* purple_credential_manager_get_default:
*
* Gets the default #PurpleCredentialManager instance.
*
* Returns: (transfer none): The default #PurpleCredentialManager instance.
*
* Since: 3.0.0
*/
PurpleCredentialManager *purple_credential_manager_get_default(void);
/**
* purple_credential_manager_register_provider:
* @manager: The #PurpleCredentialManager instance.
* @provider: The #PurpleCredentialProvider to register.
* @error: (out) (optional) (nullable): A return address for a #GError.
*
* Registers @provider with @manager.
*
* Returns: %TRUE if @provider was successfully registered with @manager, %FALSE
* otherwise.
*
* Since: 3.0.0
*/
gboolean purple_credential_manager_register_provider(PurpleCredentialManager *manager, PurpleCredentialProvider *provider, GError **error);
/**
* purple_credential_manager_unregister_provider:
* @manager: The #PurpleCredentialManager instance.
* @provider: The #PurpleCredentialProvider to unregister.
* @error: (out) (optional) (nullable): A return address for a #GError.
*
* Unregisters @provider from @manager.
*
* Returns: %TRUE if @provider was successfully unregistered from @provider,
* %FALSE otherwise.
*
* Since: 3.0.0
*/
gboolean purple_credential_manager_unregister_provider(PurpleCredentialManager *manager, PurpleCredentialProvider *provider, GError **error);
/**
* purple_credential_manager_set_active_provider:
* @manager: The #PurpleCredentialManager instance.
* @id: The id of the #PurpleCredentialProvider to use or %NULL to disable the
* active provider.
* @error: (out) (optional) (nullable): A return address for a #GError.
*
* Changes the active #PurpleCredentialProvider of @manager to provider with an
* id of @id.
*
* Returns: %TRUE on success or %FALSE with @error set on failure.
*
* Since: 3.0.0
*/
gboolean purple_credential_manager_set_active_provider(PurpleCredentialManager *manager, const gchar *id, GError **error);
/**
* purple_credential_manager_get_active_provider:
* @manager: The #PurpleCredentialManager instance.
*
* Gets the currently active #PurpleCredentialProvider or %NULL if there is no
* active provider.
*
* Returns: (transfer none): The active #PurpleCredentialProvider.
*
* Since: 3.0.0
*/
PurpleCredentialProvider *purple_credential_manager_get_active_provider(PurpleCredentialManager *manager);
/**
* purple_credential_manager_read_password_async:
* @manager: The #PurpleCredentialManager instance.
* @account: The #PurpleAccount whose password to read.
* @cancellable: (nullable): optional GCancellable object, %NULL to ignore.
* @callback: (scope async): a #GAsyncReadyCallback to call when the request is
* satisfied.
* @data: User data to pass to @callback.
*
* Reads the password for @account using the active #PurpleCredentialProvider of
* @manager.
*
* Since: 3.0.0
*/
void purple_credential_manager_read_password_async(PurpleCredentialManager *manager, PurpleAccount *account, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer data);
/**
* purple_credential_manager_read_password_finish:
* @manager: The #PurpleCredentialManager instance.
* @result: The #GAsyncResult from the previous
* purple_credential_manager_read_password_async() call.
* @error: (out) (optional): Return address for a #GError.
*
* Finishes a previous call to purple_credential_manager_read_password_async().
*
* Returns: (transfer full): The password or %NULL if successful, otherwise
* %NULL with @error set on failure.
*
* Since: 3.0.0
*/
gchar *purple_credential_manager_read_password_finish(PurpleCredentialManager *manager, GAsyncResult *result, GError **error);
/**
* purple_credential_manager_write_password_async:
* @manager: The #PurpleCredentialManager instance.
* @account: The #PurpleAccount whose password to write.
* @password: The password to write.
* @cancellable: (nullable): optional GCancellable object, %NULL to ignore.
* @callback: (scope async): a #GAsyncReadyCallback to call when the request is
* satisfied.
* @data: User data to pass to @callback.
*
* Writes @password for @account to the active #PurpleCredentialProvider of
* @manager.
*
* Since: 3.0.0
*/
void purple_credential_manager_write_password_async(PurpleCredentialManager *manager, PurpleAccount *account, const gchar *password, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer data);
/**
* purple_credential_manager_write_password_finish:
* @manager: The #PurpleCredentialManager instance.
* @result: The #GAsyncResult from the previous
* purple_credential_provider_write_password_async() call.
* @error: (out) (optional) (nullable): Return address for a #GError.
*
* Finishes a previous call to purple_credential_manager_write_password_async().
*
* Returns: %TRUE if the password was written successfully, otherwise %FALSE
* with @error set.
*
* Since: 3.0.0
*/
gboolean purple_credential_manager_write_password_finish(PurpleCredentialManager *manager, GAsyncResult *result, GError **error);
/**
* purple_credential_manager_clear_password_async:
* @manager: The #PurpleCredentialManager instance.
* @account: The #PurpleAccount whose password to clear.
* @cancellable: (nullable): optional #GCancellable object, or %NULL to ignore.
* @callback: (scope async): a #GAsyncReadyCallback to call when the request is
* satisfied.
* @data: User data to pass to @callback.
*
* Clears the password for @account from the active #PurpleCredentialProvider
* of @manager.
*
* Since: 3.0.0
*/
void purple_credential_manager_clear_password_async(PurpleCredentialManager *manager, PurpleAccount *account, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer data);
/**
* purple_credential_manager_clear_password_finish:
* @manager: The #PurpleCredentialManager instance.
* @result: The #GAsyncResult from the previous
* purple_credential_provider_clear_password_async() call.
* @error: (out) (optional) (nullable): Return address for a #GError.
*
* Finishes a previous call to
* purple_credential_provider_clear_password_async().
*
* Returns: %TRUE if the password was cleared successfully, otherwise %FALSE
* with @error set.
*
* Since: 3.0.0
*/
gboolean purple_credential_manager_clear_password_finish(PurpleCredentialManager *manager, GAsyncResult *result, GError **error);
/**
* purple_credential_manager_read_settings:
* @manager: The #PurpleCredentialManager instance.
* @error: (out) (optional) (nullable): A return address for a #GError.
*
* Reads settings from the active #PurpleCredentialProvider of @manager.
*
* Returns: (transfer full): New copy of current settings which must be free'd
* with purple_request_fields_destroy().
*
* Since: 3.0.0
*/
PurpleRequestFields *purple_credential_manager_read_settings(PurpleCredentialManager *manager, GError **error);
/**
* purple_credential_manager_write_settings:
* @manager: The #PurpleCredentialManager instance.
* @fields: (transfer full): Modified settings from
* purple_credential_manager_read_settings().
* @error: (out) (optional) (nullable): A return address for a #GError.
*
* Write @fields to the active #PurpleCredentialProvider of @manager.
*
* Returns: %TRUE if successful, %FALSE otherwise.
*
* Since: 3.0.0
*/
gboolean purple_credential_manager_write_settings(PurpleCredentialManager *manager, PurpleRequestFields *fields, GError **error);
/**
* purple_credential_manager_foreach_provider:
* @manager: The #PurpleCredentialManager instance.
* @func: (scope call): The #PurpleCredentialManagerForeachFunc to call.
* @data: User data to pass to @func.
*
* Calls @func for each #PurpleCredentialProvider that @manager knows about.
*
* Since: 3.0.0
*/
void purple_credential_manager_foreach_provider(PurpleCredentialManager *manager, PurpleCredentialManagerForeachFunc func, gpointer data);
G_END_DECLS
#endif /* PURPLE_CREDENTIAL_MANAGER_H */