depau/Purism-Calls
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/calls.git synced 2024-06-18 09:49:32 +00:00
Code Issues Releases Wiki Activity

src: Generalise Provider object enumeration with calls_enumerate()

Browse source
This commit is contained in:
Bob Ham 2018-11-01 11:05:45 +00:00
parent 07cc15ceae
commit 74c3987ce1
9 changed files with 636 additions and 144 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

67
src/calls-call-window.c
View file

@ -29,6 +29,7 @@
#include "calls-call-holder.h"
#include "calls-call-selector-item.h"
#include "calls-new-call-box.h"
#include "calls-enumerate.h"
#include "util.h"
#include <glib/gi18n.h>
@ -231,9 +232,6 @@ add_call (CallsCallWindow *self,
g_return_if_fail (CALLS_IS_CALL_WINDOW (self));
g_return_if_fail (CALLS_IS_CALL (call));
g_signal_connect_swapped (call, "message",
G_CALLBACK (show_message), self);
holder = calls_call_holder_new (call);
display = calls_call_holder_get_display (holder);
@ -288,7 +286,7 @@ remove_calls (CallsCallWindow *self)
{
GList *children, *child;
/* Safely remove the call stack's children. */
/* Safely remove the call stack's children. */
children = gtk_container_get_children (GTK_CONTAINER (self->call_stack));
for (child = children; child != NULL; child = child->next)
gtk_container_remove (GTK_CONTAINER (self->call_stack),
@ -301,57 +299,24 @@ remove_calls (CallsCallWindow *self)
}
static void
add_origin_calls (CallsCallWindow *self, CallsOrigin *origin)
{
GList *calls, *node;
calls = calls_origin_get_calls (origin);
for (node = calls; node; node = node->next)
{
add_call (self, CALLS_CALL (node->data));
}
g_list_free (calls);
}
static void
add_origin (CallsCallWindow *self, CallsOrigin *origin)
{
g_signal_connect_swapped (origin, "call-added",
G_CALLBACK (add_call), self);
g_signal_connect_swapped (origin, "call-removed",
G_CALLBACK (remove_call), self);
add_origin_calls (self, origin);
}
static void
add_provider_origins (CallsCallWindow *self, CallsProvider *provider)
{
GList *origins, *node;
origins = calls_provider_get_origins (provider);
for (node = origins; node; node = node->next)
{
add_origin (self, CALLS_ORIGIN (node->data));
}
g_list_free (origins);
}
static void
set_provider (CallsCallWindow *self, CallsProvider *provider)
{
g_signal_connect_swapped (provider, "origin-added",
G_CALLBACK (add_origin), self);
CallsEnumerateParams *params;
add_provider_origins (self, provider);
params = calls_enumerate_params_new (self);
calls_enumerate_params_add
(params, CALLS_TYPE_ORIGIN, "call-added", G_CALLBACK (add_call));
calls_enumerate_params_add
(params, CALLS_TYPE_ORIGIN, "call-removed", G_CALLBACK (remove_call));
calls_enumerate_params_add
(params, CALLS_TYPE_CALL, "message", G_CALLBACK (show_message));
calls_enumerate (provider, params);
g_object_unref (params);
}
static void

252
src/calls-enumerate-params.c Normal file
View file

@ -0,0 +1,252 @@
/*
* Copyright (C) 2018 Purism SPC
*
* This file is part of Calls.
*
* Calls 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 3 of the License, or
* (at your option) any later version.
*
* Calls 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 Calls. If not, see <http://www.gnu.org/licenses/>.
*
* Author: Bob Ham <bob.ham@puri.sm>
*
* SPDX-License-Identifier: GPL-3.0-or-later
*
*/
#include "calls-enumerate-params.h"
#include "calls-provider.h"
#include "calls-origin.h"
#include "calls-call.h"
#include <glib/gi18n.h>
#include <glib-object.h>
typedef enum
{
CALLS_ENUMERATE_PROVIDER,
CALLS_ENUMERATE_ORIGIN,
CALLS_ENUMERATE_CALL,
CALLS_ENUMERATE_LAST
} CallsEnumerateObjectType;
struct _CallsEnumerateParams
{
GObject parent_instance;
gboolean enumerating;
gpointer user_data;
GHashTable *callbacks[3];
};
G_DEFINE_TYPE (CallsEnumerateParams, calls_enumerate_params, G_TYPE_OBJECT);
enum {
PROP_0,
PROP_USER_DATA,
PROP_LAST_PROP,
};
static GParamSpec *props[PROP_LAST_PROP];
static void
calls_enumerate_params_init (CallsEnumerateParams *self)
{
unsigned i;
self->enumerating = TRUE;
for (i = 0; i < CALLS_ENUMERATE_LAST; ++i)
{
self->callbacks[i] =
g_hash_table_new_full (g_str_hash, g_str_equal,
g_free, NULL);
}
}
static void
set_property (GObject *object,
guint property_id,
const GValue *value,
GParamSpec *pspec)
{
CallsEnumerateParams *self = CALLS_ENUMERATE_PARAMS (object);
switch (property_id) {
case PROP_USER_DATA:
self->user_data = g_value_get_pointer (value);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
break;
}
}
static void
finalize (GObject *object)
{
GObjectClass *parent_class = g_type_class_peek (G_TYPE_OBJECT);
CallsEnumerateParams *self = CALLS_ENUMERATE_PARAMS (object);
unsigned i;
for (i = 0; i < CALLS_ENUMERATE_LAST; ++i)
{
g_hash_table_unref (self->callbacks[i]);
}
parent_class->finalize (object);
}
static void
calls_enumerate_params_class_init (CallsEnumerateParamsClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
object_class->set_property = set_property;
object_class->finalize = finalize;
props[PROP_USER_DATA] =
g_param_spec_pointer ("user-data",
_("User data"),
_("The pointer to be provided as user data for signal connections"),
G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY);
g_object_class_install_properties (object_class, PROP_LAST_PROP, props);
}
CallsEnumerateParams *
calls_enumerate_params_new (gpointer user_data)
{
return g_object_new (CALLS_TYPE_ENUMERATE_PARAMS,
"user-data", user_data,
NULL);
}
gpointer
calls_enumerate_params_get_user_data (CallsEnumerateParams *self)
{
return self->user_data;
}
gboolean
calls_enumerate_params_get_enumerating (CallsEnumerateParams *self)
{
return self->enumerating;
}
void
calls_enumerate_params_set_enumerating (CallsEnumerateParams *self,
gboolean enumerating)
{
self->enumerating = enumerating;
}
static GHashTable *
lookup_callbacks (CallsEnumerateParams *self,
GType obj_type)
{
const GType obj_gtypes[3] =
{
CALLS_TYPE_PROVIDER,
CALLS_TYPE_ORIGIN,
CALLS_TYPE_CALL
};
unsigned i;
for (i = 0; i < CALLS_ENUMERATE_LAST; ++i)
{
if (g_type_is_a (obj_type, obj_gtypes[i]))
{
return self->callbacks[i];
}
}
g_error ("Unknown GType `%s' converting to Provider enumeration object type",
g_type_name (obj_type));
}
gboolean
calls_enumerate_params_have_callbacks (CallsEnumerateParams *self,
GType obj_type)
{
GHashTable * const callbacks = lookup_callbacks (self, obj_type);
return g_hash_table_size (callbacks) > 0;
}
gboolean
calls_enumerate_params_add (CallsEnumerateParams *self,
GType obj_type,
const gchar *detail,
GCallback callback)
{
GHashTable * const callbacks = lookup_callbacks (self, obj_type);
return g_hash_table_insert (callbacks, g_strdup (detail), callback);
}
struct _CallsEnumerateConnectData
{
gpointer instance;
gpointer user_data;
};
typedef struct _CallsEnumerateConnectData CallsEnumerateConnectData;
static void
callbacks_connect (const gchar *detail,
GCallback callback,
CallsEnumerateConnectData *data)
{
g_signal_connect_swapped (data->instance,
detail,
callback,
data->user_data);
}
void
calls_enumerate_params_connect (CallsEnumerateParams *self,
GObject *object)
{
GHashTable * const callbacks =
lookup_callbacks (self, G_TYPE_FROM_INSTANCE (object));
CallsEnumerateConnectData data;
data.instance = object;
data.user_data = self->user_data;
g_hash_table_foreach (callbacks,
(GHFunc)callbacks_connect,
&data);
}
GCallback
calls_enumerate_params_lookup (CallsEnumerateParams *self,
GType obj_type,
const gchar *detail)
{
GHashTable * const callbacks = lookup_callbacks (self, obj_type);
return g_hash_table_lookup (callbacks, detail);
}

56
src/calls-enumerate-params.h Normal file
View file

@ -0,0 +1,56 @@
/*
* Copyright (C) 2018 Purism SPC
*
* This file is part of Calls.
*
* Calls 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 3 of the License, or
* (at your option) any later version.
*
* Calls 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 Calls. If not, see <http://www.gnu.org/licenses/>.
*
* Author: Bob Ham <bob.ham@puri.sm>
*
* SPDX-License-Identifier: GPL-3.0-or-later
*
*/
#ifndef CALLS_ENUMERATE_PARAMS_H__
#define CALLS_ENUMERATE_PARAMS_H__
#include <glib-object.h>
G_BEGIN_DECLS
#define CALLS_TYPE_ENUMERATE_PARAMS (calls_enumerate_params_get_type ())
G_DECLARE_FINAL_TYPE (CallsEnumerateParams, calls_enumerate_params,
CALLS, ENUMERATE_PARAMS, GObject);
CallsEnumerateParams *calls_enumerate_params_new (gpointer user_data);
gpointer calls_enumerate_params_get_user_data (CallsEnumerateParams *self);
gboolean calls_enumerate_params_have_callbacks (CallsEnumerateParams *self,
GType obj_type);
gboolean calls_enumerate_params_get_enumerating (CallsEnumerateParams *self);
void calls_enumerate_params_set_enumerating (CallsEnumerateParams *self,
gboolean enuming);
gboolean calls_enumerate_params_add (CallsEnumerateParams *self,
GType obj_type,
const gchar *detail,
GCallback callback);
void calls_enumerate_params_connect (CallsEnumerateParams *self,
GObject *object);
GCallback calls_enumerate_params_lookup (CallsEnumerateParams *self,
GType obj_type,
const gchar *detail);
G_END_DECLS
#endif /* CALLS_ENUMERATE_PARAMS_H__ */

211
src/calls-enumerate.c Normal file
View file

@ -0,0 +1,211 @@
/*
* Copyright (C) 2018 Purism SPC
*
* This file is part of Calls.
*
* Calls 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 3 of the License, or
* (at your option) any later version.
*
* Calls 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 Calls. If not, see <http://www.gnu.org/licenses/>.
*
* Author: Bob Ham <bob.ham@puri.sm>
*
* SPDX-License-Identifier: GPL-3.0-or-later
*
*/
#include "calls-enumerate.h"
#include "calls-origin.h"
#include "calls-call.h"
#include <glib/gi18n.h>
typedef void (*CallAddedCallback) (gpointer user_data,
CallsCall *call,
CallsOrigin *origin);
static void
enum_call_added_cb (CallsOrigin *origin,
CallsCall *call,
CallsEnumerateParams *params)
{
// Call call-added signal
if (calls_enumerate_params_get_enumerating (params))
{
CallAddedCallback call_added_cb;
call_added_cb = (CallAddedCallback)
calls_enumerate_params_lookup (params,
CALLS_TYPE_ORIGIN,
"call-added");
if (call_added_cb)
{
gpointer user_data = calls_enumerate_params_get_user_data (params);
call_added_cb (user_data, call, origin);
}
}
// Connect user's callbacks
calls_enumerate_params_connect (params, G_OBJECT (call));
}
static void
enum_origin_calls (CallsOrigin *origin,
CallsEnumerateParams *params)
{
GList *calls, *node;
calls = calls_origin_get_calls (origin);
for (node = calls; node; node = node->next)
{
enum_call_added_cb (origin,
CALLS_CALL (node->data),
params);
}
g_list_free (calls);
}
typedef void (*OriginAddedCallback) (gpointer user_data,
CallsOrigin *origin,
CallsProvider *provider);
static void
enum_origin_added_cb (CallsProvider *provider,
CallsOrigin *origin,
CallsEnumerateParams *params)
{
gboolean add_callback;
// Call origin-added signal
if (calls_enumerate_params_get_enumerating (params))
{
OriginAddedCallback origin_added_cb;
origin_added_cb = (OriginAddedCallback)
calls_enumerate_params_lookup (params,
CALLS_TYPE_PROVIDER,
"origin-added");
if (origin_added_cb)
{
gpointer user_data = calls_enumerate_params_get_user_data (params);
origin_added_cb (user_data, origin, provider);
}
}
// Connect user's callbacks
calls_enumerate_params_connect (params, G_OBJECT (origin));
// We add a callback for ourselves if we have to set callbacks on
// anything lower in the hierarchy in future
add_callback =
calls_enumerate_params_have_callbacks (params, CALLS_TYPE_CALL);
if (add_callback)
{
g_object_ref (params);
g_signal_connect_data (origin,
"call-added",
G_CALLBACK (enum_call_added_cb),
params,
(GClosureNotify)g_object_unref,
0);
}
// We enumerate if we've added callbacks and if there's the specific
// "call-added" callback for this level
if (add_callback
||
calls_enumerate_params_lookup (params, CALLS_TYPE_ORIGIN,
"call-added"))
{
enum_origin_calls (origin, params);
}
}
static void
enum_provider_origins (CallsProvider *provider,
CallsEnumerateParams *params)
{
GList *origins, *node;
origins = calls_provider_get_origins (provider);
for (node = origins; node; node = node->next)
{
enum_origin_added_cb (provider,
CALLS_ORIGIN (node->data),
params);
}
g_list_free (origins);
}
/**
* calls_enumerateerate:
* @provider: a #CallsProvider
* @params: a #CallsEnumerateParams containing callbacks and state
*
* Enumerate all of the #CallsOrigin objects in the #CallsProvider and
* then all of the #CallsCall objects in those #CallsOrigin objects.
* For any callbacks stored in @params, connect them to the
* enumerated objects and connect them to any future objects that
* appear. Call the "origin-added" callback for a #CallsProvider and
* "call-added" for a #CallsOrigin if the target objects are
* enumerated.
*/
void
calls_enumerate (CallsProvider *provider,
CallsEnumerateParams *params)
{
gboolean add_callback;
// Connect user's callbacks
calls_enumerate_params_connect (params, G_OBJECT (provider));
// We add a callback for ourselves if we have to set callbacks on
// anything lower in the hierarchy in future
add_callback =
calls_enumerate_params_have_callbacks (params, CALLS_TYPE_ORIGIN)
||
calls_enumerate_params_have_callbacks (params, CALLS_TYPE_CALL);
if (add_callback)
{
g_object_ref (params);
g_signal_connect_data (provider,
"origin-added",
G_CALLBACK (enum_origin_added_cb),
params,
(GClosureNotify)g_object_unref,
0);
}
// We enumerate if we've added callbacks and if there's the specific
// "origin-added" callback for this level
if (add_callback ||
calls_enumerate_params_lookup (params, CALLS_TYPE_PROVIDER,
"origin-added"))
{
enum_provider_origins (provider, params);
}
calls_enumerate_params_set_enumerating (params, FALSE);
}

40
src/calls-enumerate.h Normal file
View file

@ -0,0 +1,40 @@
/*
* Copyright (C) 2018 Purism SPC
*
* This file is part of Calls.
*
* Calls 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 3 of the License, or
* (at your option) any later version.
*
* Calls 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 Calls. If not, see <http://www.gnu.org/licenses/>.
*
* Author: Bob Ham <bob.ham@puri.sm>
*
* SPDX-License-Identifier: GPL-3.0-or-later
*
*/
#ifndef CALLS_ENUMERATE_H__
#define CALLS_ENUMERATE_H__
#include "calls-provider.h"
#include "calls-enumerate-params.h"
#include <glib-object.h>
G_BEGIN_DECLS
void calls_enumerate (CallsProvider *provider,
CallsEnumerateParams *params);
G_END_DECLS
#endif /* CALLS_ENUMERATE_H__ */

97
src/calls-main-window.c
View file

@ -27,6 +27,7 @@
#include "calls-call-holder.h"
#include "calls-call-selector-item.h"
#include "calls-new-call-box.h"
#include "calls-enumerate.h"
#include "config.h"
#include "util.h"
@ -165,69 +166,12 @@ info_response_cb (GtkInfoBar *infobar,
static void
add_call (CallsMainWindow *self, CallsCall *call)
call_removed_cb (CallsMainWindow *self, CallsCall *call, const gchar *reason)
{
g_signal_connect_swapped (call, "message",
G_CALLBACK (show_message), self);
}
static void
remove_call (CallsMainWindow *self, CallsCall *call, const gchar *reason)
{
g_return_if_fail (CALLS_IS_MAIN_WINDOW (self));
g_return_if_fail (CALLS_IS_CALL (call));
show_message(self, reason, GTK_MESSAGE_INFO);
}
static void
add_origin_calls (CallsMainWindow *self, CallsOrigin *origin)
{
GList *calls, *node;
calls = calls_origin_get_calls (origin);
for (node = calls; node; node = node->next)
{
add_call (self, CALLS_CALL (node->data));
}
g_list_free (calls);
}
static void
add_origin (CallsMainWindow *self, CallsOrigin *origin)
{
g_signal_connect_swapped (origin, "message",
G_CALLBACK (show_message), self);
g_signal_connect_swapped (origin, "call-added",
G_CALLBACK (add_call), self);
g_signal_connect_swapped (origin, "call-removed",
G_CALLBACK (remove_call), self);
add_origin_calls (self, origin);
}
static void
add_provider_origins (CallsMainWindow *self, CallsProvider *provider)
{
GList *origins, *node;
origins = calls_provider_get_origins (provider);
for (node = origins; node; node = node->next)
{
add_origin (self, CALLS_ORIGIN (node->data));
}
g_list_free (origins);
}
static void
set_property (GObject *object,
guint property_id,
@ -248,6 +192,35 @@ set_property (GObject *object,
}
static void
set_up_provider (CallsMainWindow *self)
{
const GType msg_obj_types[3] =
{
CALLS_TYPE_PROVIDER,
CALLS_TYPE_ORIGIN,
CALLS_TYPE_CALL
};
CallsEnumerateParams *params;
unsigned i;
params = calls_enumerate_params_new (self);
for (i = 0; i < 3; ++i)
{
calls_enumerate_params_add
(params, msg_obj_types[i], "message", G_CALLBACK (show_message));
}
calls_enumerate_params_add
(params, CALLS_TYPE_ORIGIN, "call-removed", G_CALLBACK (call_removed_cb));
calls_enumerate (self->provider, params);
g_object_unref (params);
}
static void
constructed (GObject *object)
{
@ -256,13 +229,7 @@ constructed (GObject *object)
GSimpleActionGroup *simple_action_group;
CallsNewCallBox *new_call_box;
/* Set up provider */
g_signal_connect_swapped (self->provider, "message",
G_CALLBACK (show_message), self);
g_signal_connect_swapped (self->provider, "origin-added",
G_CALLBACK (add_origin), self);
add_provider_origins (self, self->provider);
set_up_provider (self);
/* Add new call box */
new_call_box = calls_new_call_box_new (self->provider);

43
src/calls-new-call-box.c
View file

@ -23,8 +23,7 @@
*/
#include "calls-new-call-box.h"
#include "calls-origin.h"
#include "calls-enumerate.h"
#include <glib/gi18n.h>
#define HANDY_USE_UNSTABLE_API
@ -208,33 +207,27 @@ remove_origins (CallsNewCallBox *self)
}
static void
add_provider_origins (CallsNewCallBox *self, CallsProvider *provider)
{
GList *origins, *node;
origins = calls_provider_get_origins (provider);
for (node = origins; node; node = node->next)
{
add_origin (self, CALLS_ORIGIN (node->data));
}
g_list_free (origins);
}
static void
set_provider (CallsNewCallBox *self, CallsProvider *provider)
{
g_signal_connect_swapped (provider, "notify::status",
G_CALLBACK (notify_status_cb), self);
g_signal_connect_swapped (provider, "origin-added",
G_CALLBACK (add_origin), self);
g_signal_connect_swapped (provider, "origin-removed",
G_CALLBACK (remove_origin), self);
CallsEnumerateParams *params;
add_provider_origins (self, provider);
params = calls_enumerate_params_new (self);
#define add(detail,cb) \
calls_enumerate_params_add \
(params, CALLS_TYPE_PROVIDER, detail, \
G_CALLBACK (cb));
add ("notify::status", notify_status_cb);
add ("origin-added", add_origin);
add ("origin-removed", remove_origin);
#undef add
calls_enumerate (provider, params);
g_object_unref (params);
}
static void

12
src/calls-provider.h
View file

@ -25,16 +25,21 @@
#ifndef CALLS_PROVIDER_H__
#define CALLS_PROVIDER_H__
#include "calls-message-source.h"
#include "calls-origin.h"
#include "calls-call.h"
#include "util.h"
#include <glib-object.h>
G_BEGIN_DECLS
#define CALLS_TYPE_PROVIDER (calls_provider_get_type ())
G_DECLARE_INTERFACE (CallsProvider, calls_provider, CALLS, PROVIDER, GObject);
struct _CallsProviderInterface
{
GTypeInterface parent_iface;
@ -44,9 +49,10 @@ struct _CallsProviderInterface
};
const gchar * calls_provider_get_name (CallsProvider *self);
gchar * calls_provider_get_status (CallsProvider *self);
GList * calls_provider_get_origins (CallsProvider *self);
const gchar * calls_provider_get_name (CallsProvider *self);
gchar * calls_provider_get_status (CallsProvider *self);
GList * calls_provider_get_origins (CallsProvider *self);
G_END_DECLS

2
src/meson.build
View file

@ -34,6 +34,8 @@ calls_sources = files(['calls-message-source.c', 'calls-message-source.h',
'calls-call.c',
'calls-origin.c', 'calls-origin.h',
'calls-provider.c', 'calls-provider.h',
'calls-enumerate-params.c', 'calls-enumerate-params.h',
'calls-enumerate.c', 'calls-enumerate.h',
'calls-ofono-call.c', 'calls-ofono-call.h',
'calls-ofono-origin.c', 'calls-ofono-origin.h',
'calls-ofono-provider.c', 'calls-ofono-provider.h',