aboutsummaryrefslogtreecommitdiffstats
path: root/e-util/e-plugin-ui.c
blob: feb9952efd264a9f2660d0a5a4f270febc4affc1 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
 * Copyright (C) 2008 Novell, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU Lesser General Public
 * License as published by the Free Software Foundation.
 *
 * 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 Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#include "e-plugin-ui.h"

#include <string.h>

#define E_PLUGIN_UI_HOOK_GET_PRIVATE(obj) \
    (G_TYPE_INSTANCE_GET_PRIVATE \
    ((obj), E_TYPE_PLUGIN_UI_HOOK, EPluginUIHookPrivate))

#define E_PLUGIN_UI_INIT_FUNC       "e_plugin_ui_init"
#define E_PLUGIN_UI_HOOK_CLASS_ID       "org.gnome.evolution.ui:1.0"
#define E_PLUGIN_UI_MANAGER_ID_KEY  "e-plugin-ui-manager-id"

struct _EPluginUIHookPrivate {

    /* Table of GtkUIManager ID's to UI definitions. 
     *
     * For example:
     *
     *     <ui-manager id="org.gnome.evolution.sample">
     *             ... UI definition ...
     *     </ui-manager>
     *
     * Results in:
     *
     *     g_hash_table_insert (
     *             ui_definitions,
     *             "org.gnome.evolution.sample",
     *             "... UI definition ...");
     *
     * See http://library.gnome.org/devel/gtk/unstable/GtkUIManager.html
     * for more information about UI definitions.  Note: the <ui> tag is
     * optional.
     */
    GHashTable *ui_definitions;
};

/* The registry is a hash table of hash tables.  It maps
 *
 *    EPluginUIHook instance --> GtkUIManager instance --> UI merge id
 *
 * GtkUIManager instances are automatically removed when finalized.
 */
static GHashTable *registry;
static gpointer parent_class;

static void
plugin_ui_registry_remove (EPluginUIHook *hook,
                           GtkUIManager *manager)
{
    GHashTable *hash_table;

    /* Note: Manager may already be finalized. */

    hash_table = g_hash_table_lookup (registry, hook);
    g_return_if_fail (hash_table != NULL);

    g_hash_table_remove (hash_table, manager);
    if (g_hash_table_size (hash_table) == 0)
        g_hash_table_remove (registry, hook);
}

static void
plugin_ui_registry_insert (EPluginUIHook *hook,
                           GtkUIManager *manager,
                           guint merge_id)
{
    GHashTable *hash_table;

    if (registry == NULL)
        registry = g_hash_table_new_full (
            g_direct_hash, g_direct_equal,
            (GDestroyNotify) NULL,
            (GDestroyNotify) g_hash_table_destroy);

    hash_table = g_hash_table_lookup (registry, hook);
    if (hash_table == NULL) {
        hash_table = g_hash_table_new (g_direct_hash, g_direct_equal);
        g_hash_table_insert (registry, hook, hash_table);
    }

    g_object_weak_ref (
        G_OBJECT (manager), (GWeakNotify)
        plugin_ui_registry_remove, hook);

    g_hash_table_insert (hash_table, manager, GUINT_TO_POINTER (merge_id));
}

/* Helper for plugin_ui_hook_merge_ui() */
static void
plugin_ui_hook_merge_foreach (GtkUIManager *manager,
                              const gchar *ui_definition,
                              GHashTable *hash_table)
{
    guint merge_id;
    GError *error = NULL;

    /* Merge the UI definition into the manager. */
    merge_id = gtk_ui_manager_add_ui_from_string (
        manager, ui_definition, -1, &error);
    gtk_ui_manager_ensure_update (manager);
    if (error != NULL) {
        g_warning ("%s", error->message);
        g_error_free (error);
    }

    /* Merge ID will be 0 on error, which is what we want. */
    g_hash_table_insert (hash_table, manager, GUINT_TO_POINTER (merge_id));
}

static void
plugin_ui_hook_merge_ui (EPluginUIHook *hook)
{
    GHashTable *old_merge_ids;
    GHashTable *new_merge_ids;
    GHashTable *intermediate;
    GList *keys;

    old_merge_ids = g_hash_table_lookup (registry, hook);
    if (old_merge_ids == NULL)
        return;

    /* The GtkUIManager instances and UI definitions live in separate
     * tables, so we need to build an intermediate table that we can
     * easily iterate over. */
    keys = g_hash_table_get_keys (old_merge_ids);
    intermediate = g_hash_table_new (g_direct_hash, g_direct_equal);

    while (keys != NULL) {
        GtkUIManager *manager = keys->data;
        gchar *ui_definition;

        ui_definition = g_hash_table_lookup (
            hook->priv->ui_definitions,
            e_plugin_ui_get_manager_id (manager));

        g_hash_table_insert (intermediate, manager, ui_definition);

        keys = g_list_delete_link (keys, keys);
    }

    new_merge_ids = g_hash_table_new (g_direct_hash, g_direct_equal);

    g_hash_table_foreach (
        intermediate, (GHFunc)
        plugin_ui_hook_merge_foreach, new_merge_ids);

    g_hash_table_insert (registry, hook, new_merge_ids);

    g_hash_table_destroy (intermediate);
}

/* Helper for plugin_ui_hook_unmerge_ui() */
static void
plugin_ui_hook_unmerge_foreach (GtkUIManager *manager,
                                gpointer value,
                                GHashTable *hash_table)
{
    guint merge_id;

    merge_id = GPOINTER_TO_UINT (value);
    gtk_ui_manager_remove_ui (manager, merge_id);

    g_hash_table_insert (hash_table, manager, GUINT_TO_POINTER (0));
}

static void
plugin_ui_hook_unmerge_ui (EPluginUIHook *hook)
{
    GHashTable *old_merge_ids;
    GHashTable *new_merge_ids;

    old_merge_ids = g_hash_table_lookup (registry, hook);
    if (old_merge_ids == NULL)
        return;

    new_merge_ids = g_hash_table_new (g_direct_hash, g_direct_equal);

    g_hash_table_foreach (
        old_merge_ids, (GHFunc)
        plugin_ui_hook_unmerge_foreach, new_merge_ids);

    g_hash_table_insert (registry, hook, new_merge_ids);
}

static void
plugin_ui_hook_register_manager (EPluginUIHook *hook,
                                 GtkUIManager *manager,
                                 const gchar *ui_definition,
                                 gpointer user_data)
{
    EPlugin *plugin;
    EPluginUIInitFunc func;
    guint merge_id = 0;

    plugin = ((EPluginHook *) hook)->plugin;
    func = e_plugin_get_symbol (plugin, E_PLUGIN_UI_INIT_FUNC);

    /* Pass the manager and user_data to the plugin's e_plugin_ui_init()
     * function (if it defined one).  The plugin should install whatever
     * GtkActions and GtkActionGroups are neccessary to implement the
     * action names in its UI definition. */
    if (func != NULL && !func (manager, user_data))
        return;

    if (plugin->enabled) {
        GError *error = NULL;

        /* Merge the UI definition into the manager. */
        merge_id = gtk_ui_manager_add_ui_from_string (
            manager, ui_definition, -1, &error);
        gtk_ui_manager_ensure_update (manager);
        if (error != NULL) {
            g_warning ("%s", error->message);
            g_error_free (error);
        }
    }

    /* Save merge ID's for later use. */
    plugin_ui_registry_insert (hook, manager, merge_id);
}

static void
plugin_ui_hook_finalize (GObject *object)
{
    EPluginUIHookPrivate *priv;

    priv = E_PLUGIN_UI_HOOK_GET_PRIVATE (object);

    g_hash_table_destroy (priv->ui_definitions);

    /* Chain up to parent's dispose() method. */
    G_OBJECT_CLASS (parent_class)->dispose (object);
}

static gint
plugin_ui_hook_construct (EPluginHook *hook,
                          EPlugin *plugin,
                          xmlNodePtr node)
{
    EPluginUIHookPrivate *priv;

    priv = E_PLUGIN_UI_HOOK_GET_PRIVATE (hook);

    /* XXX The EPlugin should be a property of EPluginHookClass.
     *     Then it could be passed directly to g_object_new() and
     *     we wouldn't have to chain up here. */

    /* Chain up to parent's construct() method. */
    E_PLUGIN_HOOK_CLASS (parent_class)->construct (hook, plugin, node);

    for (node = node->children; node != NULL; node = node->next) {
        xmlNodePtr child;
        xmlBufferPtr buffer;
        const gchar *content;
        gchar *id;

        if (strcmp ((gchar *) node->name, "ui-manager") != 0)
            continue;

        id = e_plugin_xml_prop (node, "id");
        if (id == NULL) {
            g_warning ("<ui-manager> requires 'id' property");
            continue;
        }

        /* Extract the XML content below <ui-manager> */
        buffer = xmlBufferCreate ();
        child = node->children;
        while (child != NULL && xmlNodeIsText (child))
            child = child->next;
        if (child != NULL)
            xmlNodeDump (buffer, node->doc, child, 2, 1);
        content = (const gchar *) xmlBufferContent (buffer);

        g_hash_table_insert (
            priv->ui_definitions,
            id, g_strdup (content));

        xmlBufferFree (buffer);
    }

    return 0;
}

static void
plugin_ui_hook_enable (EPluginHook *hook,
                       gint state)
{
    if (state)
        plugin_ui_hook_merge_ui (E_PLUGIN_UI_HOOK (hook));
    else
        plugin_ui_hook_unmerge_ui (E_PLUGIN_UI_HOOK (hook));
}

static void
plugin_ui_hook_class_init (EPluginUIHookClass *class)
{
    GObjectClass *object_class;
    EPluginHookClass *plugin_hook_class;

    parent_class = g_type_class_peek_parent (class);
    g_type_class_add_private (class, sizeof (EPluginUIHookPrivate));

    object_class = G_OBJECT_CLASS (class);
    object_class->finalize = plugin_ui_hook_finalize;

    plugin_hook_class = E_PLUGIN_HOOK_CLASS (class);
    plugin_hook_class->id = E_PLUGIN_UI_HOOK_CLASS_ID;
    plugin_hook_class->construct = plugin_ui_hook_construct;
    plugin_hook_class->enable = plugin_ui_hook_enable;
}

static void
plugin_ui_hook_init (EPluginUIHook *hook)
{
    GHashTable *ui_definitions;

    ui_definitions = g_hash_table_new_full (
        g_str_hash, g_str_equal,
        (GDestroyNotify) g_free,
        (GDestroyNotify) g_free);

    hook->priv = E_PLUGIN_UI_HOOK_GET_PRIVATE (hook);
    hook->priv->ui_definitions = ui_definitions;
}

GType
e_plugin_ui_hook_get_type (void)
{
    static GType type = 0;

    if (G_UNLIKELY (type == 0)) {
        static const GTypeInfo type_info = {
            sizeof (EPluginUIHookClass),
            (GBaseInitFunc) NULL,
            (GBaseFinalizeFunc) NULL,
            (GClassInitFunc) plugin_ui_hook_class_init,
            (GClassFinalizeFunc) NULL,
            NULL,  /* class_data */
            sizeof (EPluginUIHook),
            0,     /* n_preallocs */
            (GInstanceInitFunc) plugin_ui_hook_init,
            NULL   /* value_table */
        };

        type = g_type_register_static (
            E_TYPE_PLUGIN_HOOK, "EPluginUIHook", &type_info, 0);
    }

    return type;
}

void
e_plugin_ui_register_manager (const gchar *id,
                              GtkUIManager *manager,
                              gpointer user_data)
{
    const gchar *key = E_PLUGIN_UI_MANAGER_ID_KEY;
    GSList *plugin_list;

    g_return_if_fail (id != NULL);
    g_return_if_fail (GTK_IS_UI_MANAGER (manager));

    g_object_set_data (G_OBJECT (manager), key, (gpointer) id);

    /* Loop over all installed plugins. */
    plugin_list = e_plugin_list_plugins ();
    while (plugin_list != NULL) {
        EPlugin *plugin = plugin_list->data;
        GSList *iter;

        /* Look for hooks of type EPluginUIHook. */
        for (iter = plugin->hooks; iter != NULL; iter = iter->next) {
            EPluginUIHook *hook = iter->data;
            const gchar *ui_definition;

            if (!E_IS_PLUGIN_UI_HOOK (hook))
                continue;

            /* Check if the hook has a UI definition
             * for the GtkUIManager being registered. */
            ui_definition = g_hash_table_lookup (
                hook->priv->ui_definitions, id);
            if (ui_definition == NULL)
                continue;

            /* Register the manager with the hook. */
            plugin_ui_hook_register_manager (
                hook, manager, ui_definition, user_data);
        }

        plugin_list = g_slist_next (plugin_list);
    }
}

const gchar *
e_plugin_ui_get_manager_id (GtkUIManager *manager)
{
    const gchar *key = E_PLUGIN_UI_MANAGER_ID_KEY;

    g_return_val_if_fail (GTK_IS_UI_MANAGER (manager), NULL);

    return g_object_get_data (G_OBJECT (manager), key);
}