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 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
* Authors: Michael Zucchi <notzed@ximian.com>
*
* Copyright 2004 Ximian, Inc. (www.ximian.com)
*
* 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, write to the Free Software
* Foundation, Inc., 59 Temple Street #330, Boston, MA 02111-1307, USA.
*
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <string.h>
#include <stdlib.h>
#include <glib.h>
#include <gtk/gtkmenu.h>
#include <gtk/gtkmenuitem.h>
#include <gtk/gtkimagemenuitem.h>
#include <gtk/gtkcheckmenuitem.h>
#include <gtk/gtkradiomenuitem.h>
#include <gtk/gtkseparatormenuitem.h>
#include <gtk/gtklabel.h>
#include <gtk/gtkimage.h>
#include "e-popup.h"
#include <e-util/e-icon-factory.h>
#include <libgnome/gnome-i18n.h>
#define d(x)
struct _EPopupFactory {
struct _EPopupFactory *next, *prev;
char *menuid;
EPopupFactoryFunc factory;
void *factory_data;
};
/* Used for the "activate" signal callback data to re-map to the api */
struct _item_node {
struct _item_node *next; /* tree pointers */
struct _item_node *prev;
struct _item_node *parent;
EDList children;
struct _item_node *link; /* for freeing */
EPopupItem *item;
struct _menu_node *menu;
};
/* Stores all the items added */
struct _menu_node {
struct _menu_node *next, *prev;
EPopup *popup;
GSList *menu;
char *domain;
EPopupItemsFunc freefunc;
void *data;
struct _item_node *items;
};
struct _EPopupPrivate {
EDList menus;
};
static GObjectClass *ep_parent;
static void
ep_init(GObject *o)
{
EPopup *emp = (EPopup *)o;
struct _EPopupPrivate *p;
p = emp->priv = g_malloc0(sizeof(struct _EPopupPrivate));
e_dlist_init(&p->menus);
}
static void
ep_finalise(GObject *o)
{
EPopup *emp = (EPopup *)o;
struct _EPopupPrivate *p = emp->priv;
struct _menu_node *mnode, *nnode;
mnode = (struct _menu_node *)p->menus.head;
nnode = mnode->next;
while (nnode) {
struct _item_node *inode;
if (mnode->freefunc)
mnode->freefunc(emp, mnode->menu, mnode->data);
g_free(mnode->domain);
/* free item activate callback data */
inode = mnode->items;
while (inode) {
/* This was declared as _menu_node above already */
struct _item_node *nnode = inode->link;
g_free(inode);
inode = nnode;
}
g_free(mnode);
mnode = nnode;
nnode = nnode->next;
}
if (emp->target)
e_popup_target_free(emp, emp->target);
g_free(emp->menuid);
g_free(p);
((GObjectClass *)ep_parent)->finalize(o);
}
static void
ep_target_free(EPopup *ep, EPopupTarget *t)
{
g_free(t);
g_object_unref(ep);
}
static void
ep_class_init(GObjectClass *klass)
{
d(printf("EPopup class init %p '%s'\n", klass, g_type_name(((GObjectClass *)klass)->g_type_class.g_type)));
klass->finalize = ep_finalise;
((EPopupClass *)klass)->target_free = ep_target_free;
}
static void
ep_base_init(GObjectClass *klass)
{
e_dlist_init(&((EPopupClass *)klass)->factories);
}
/**
* e_popup_get_type:
*
* Standard GObject type function.
*
* Return value: The EPopup object type.
**/
GType
e_popup_get_type(void)
{
static GType type = 0;
if (type == 0) {
static const GTypeInfo info = {
sizeof(EPopupClass),
(GBaseInitFunc)ep_base_init, NULL,
(GClassInitFunc)ep_class_init, NULL, NULL,
sizeof(EPopup), 0,
(GInstanceInitFunc)ep_init
};
ep_parent = g_type_class_ref(G_TYPE_OBJECT);
type = g_type_register_static(G_TYPE_OBJECT, "EPopup", &info, 0);
}
return type;
}
/**
* e_popup_new - Create an targetless popup menu manager.
* @menuid: Unique ID for this menu.
*
* Create a targetless popup menu object. This can be used as a
* helper for creating popup menu's with no target. Such popup menu's
* wont be very pluggable.
*
* Return value: A new EPopup.
**/
EPopup *e_popup_new(const char *menuid)
{
EPopup *ep = g_object_new(e_popup_get_type(), NULL);
e_popup_construct(ep, menuid);
return ep;
}
/**
* e_popup_construct:
* @ep: An instantiated but uninitialised EPopup.
* @menuid: The menu identifier.
*
* Construct the base popup instance with standard parameters.
*
* Return value: Returns @ep.
**/
EPopup *e_popup_construct(EPopup *ep, const char *menuid)
{
ep->menuid = g_strdup(menuid);
return ep;
}
/**
* e_popup_add_items:
* @emp: An EPopup derived object.
* @items: A list of EPopupItem's to add to the current popup menu.
* @domain: Translation domain for translating labels.
* @freefunc: A function which will be called when the items are no
* longer needed.
* @data: user-data passed to @freefunc, and passed to all activate
* methods.
*
* Add new EPopupItems to the menus. Any with the same path
* will override previously defined menu items, at menu building
* time. This may be called any number of times before the menu is
* built to create a complex heirarchy of menus.
**/
void
e_popup_add_items(EPopup *emp, GSList *items, const char *domain, EPopupItemsFunc freefunc, void *data)
{
struct _menu_node *node;
node = g_malloc0(sizeof(*node));
node->menu = items;
node->domain = g_strdup(domain);
node->freefunc = freefunc;
node->data = data;
node->popup = emp;
e_dlist_addtail(&emp->priv->menus, (EDListNode *)node);
}
static void
ep_add_static_items(EPopup *emp)
{
struct _EPopupFactory *f;
EPopupClass *klass = (EPopupClass *)G_OBJECT_GET_CLASS(emp);
if (emp->menuid == NULL || emp->target == NULL)
return;
/* setup the menu itself */
f = (struct _EPopupFactory *)klass->factories.head;
while (f->next) {
if (f->menuid == NULL
|| !strcmp(f->menuid, emp->menuid)) {
f->factory(emp, f->factory_data);
}
f = f->next;
}
}
static int
ep_cmp(const void *ap, const void *bp)
{
struct _item_node *a = *((void **)ap);
struct _item_node *b = *((void **)bp);
return strcmp(a->item->path, b->item->path);
}
static void
ep_activate(GtkWidget *w, struct _item_node *inode)
{
EPopupItem *item = inode->item;
guint32 type = item->type & E_POPUP_TYPE_MASK;
/* this is a bit hackish, use the item->type to transmit the
active state, presumes we can write to this memory ... The
alternative is the EMenu idea of different callbacks, but
thats painful for breaking type-safety on callbacks */
if (type == E_POPUP_TOGGLE || type == E_POPUP_RADIO) {
if (gtk_check_menu_item_get_active((GtkCheckMenuItem *)w))
item->type |= E_POPUP_ACTIVE;
else
item->type &= ~E_POPUP_ACTIVE;
}
item->activate(inode->menu->popup, item, inode->menu->data);
}
static void
ep_prune_tree(EDList *head)
{
struct _item_node *inode, *nnode;
/* need to do two scans, first to find out if the subtree's
* are empty, then to remove any unecessary bars which may
* become unecessary after the first scan */
inode = (struct _item_node *)head->head;
nnode = inode->next;
while (nnode) {
struct _EPopupItem *item = inode->item;
ep_prune_tree(&inode->children);
if ((item->type & E_POPUP_TYPE_MASK) == E_POPUP_SUBMENU) {
if (e_dlist_empty(&inode->children))
e_dlist_remove((EDListNode *)inode);
}
inode = nnode;
nnode = nnode->next;
}
inode = (struct _item_node *)head->head;
nnode = inode->next;
while (nnode) {
struct _EPopupItem *item = inode->item;
if ((item->type & E_POPUP_TYPE_MASK) == E_POPUP_BAR) {
if (inode->prev->prev == NULL
|| nnode->next == NULL
|| (nnode->item->type & E_POPUP_TYPE_MASK) == E_POPUP_BAR)
e_dlist_remove((EDListNode *)inode);
}
inode = nnode;
nnode = nnode->next;
}
}
static GtkMenu *
ep_build_tree(struct _item_node *inode, guint32 mask)
{
struct _item_node *nnode;
GtkMenu *topmenu;
GHashTable *group_hash = g_hash_table_new(g_str_hash, g_str_equal);
topmenu = (GtkMenu *)gtk_menu_new();
nnode = inode->next;
while (nnode) {
GtkWidget *label;
struct _EPopupItem *item = inode->item;
GtkMenuItem *menuitem;
switch (item->type & E_POPUP_TYPE_MASK) {
case E_POPUP_ITEM:
if (item->image) {
GtkWidget *image;
/* work-around e-icon-factory not doing GTK_STOCK stuff */
if (strncmp((char *)item->image, "gtk-", 4) == 0)
image = gtk_image_new_from_stock((char *)item->image, GTK_ICON_SIZE_MENU);
else
image = e_icon_factory_get_image((char *)item->image, E_ICON_SIZE_MENU);
gtk_widget_show(image);
menuitem = (GtkMenuItem *)gtk_image_menu_item_new();
gtk_image_menu_item_set_image((GtkImageMenuItem *)menuitem, image);
} else {
menuitem = (GtkMenuItem *)gtk_menu_item_new();
}
break;
case E_POPUP_TOGGLE:
menuitem = (GtkMenuItem *)gtk_check_menu_item_new();
gtk_check_menu_item_set_active((GtkCheckMenuItem *)menuitem, item->type & E_POPUP_ACTIVE);
break;
case E_POPUP_RADIO: {
char *ppath = inode->parent?inode->parent->item->path:NULL;
menuitem = (GtkMenuItem *)gtk_radio_menu_item_new(g_hash_table_lookup(group_hash, ppath));
g_hash_table_insert(group_hash, ppath, gtk_radio_menu_item_get_group((GtkRadioMenuItem *)menuitem));
gtk_check_menu_item_set_active((GtkCheckMenuItem *)menuitem, item->type & E_POPUP_ACTIVE);
break; }
case E_POPUP_IMAGE:
menuitem = (GtkMenuItem *)gtk_image_menu_item_new();
gtk_image_menu_item_set_image((GtkImageMenuItem *)menuitem, item->image);
break;
case E_POPUP_SUBMENU: {
GtkMenu *submenu = ep_build_tree((struct _item_node *)inode->children.head, mask);
menuitem = (GtkMenuItem *)gtk_menu_item_new();
gtk_menu_item_set_submenu(menuitem, (GtkWidget *)submenu);
break; }
case E_POPUP_BAR:
menuitem = (GtkMenuItem *)gtk_separator_menu_item_new();
break;
default:
continue;
}
if (item->label) {
label = gtk_label_new_with_mnemonic(dgettext(inode->menu->domain, item->label));
gtk_misc_set_alignment((GtkMisc *)label, 0.0, 0.5);
gtk_widget_show(label);
gtk_container_add((GtkContainer *)menuitem, label);
}
if (item->activate)
g_signal_connect(menuitem, "activate", G_CALLBACK(ep_activate), inode);
gtk_menu_shell_append((GtkMenuShell *)topmenu, (GtkWidget *)menuitem);
if (item->enable & mask)
gtk_widget_set_sensitive((GtkWidget *)menuitem, FALSE);
gtk_widget_show((GtkWidget *)menuitem);
inode = nnode;
nnode = nnode->next;
}
g_hash_table_destroy(group_hash);
return topmenu;
}
/**
* e_popup_create:
* @emp: An EPopup derived object.
* @target: popup target, if set, then factories will be invoked.
* This is then owned by the menu.
* @mask: If supplied, overrides the target specified mask or provides
* a mask if no target is supplied. Used to enable or show menu
* items.
*
* All of the menu items registered on @emp are sorted by path, and
* then converted into a menu heirarchy.
*
*
* Return value: A GtkMenu which can be popped up when ready.
**/
GtkMenu *
e_popup_create_menu(EPopup *emp, EPopupTarget *target, guint32 mask)
{
struct _EPopupPrivate *p = emp->priv;
struct _menu_node *mnode, *nnode;
GPtrArray *items = g_ptr_array_new();
GSList *l;
GString *ppath = g_string_new("");
GHashTable *tree_hash = g_hash_table_new(g_str_hash, g_str_equal);
EDList head = E_DLIST_INITIALISER(head);
int i;
emp->target = target;
ep_add_static_items(emp);
if (target && mask == 0)
mask = target->mask;
/* Note: This code vastly simplifies memory management by
* keeping a linked list of all temporary tree nodes on the
* menu's tree until the epopup is destroyed */
/* FIXME: need to override old ones with new names */
mnode = (struct _menu_node *)p->menus.head;
nnode = mnode->next;
while (nnode) {
for (l=mnode->menu; l; l = l->next) {
struct _item_node *inode;
struct _EPopupItem *item = l->data;
/* we calculate bar/submenu visibility based on calculated set */
if (item->visible) {
if ((item->type & E_POPUP_TYPE_MASK) != E_POPUP_BAR
&& (item->type & E_POPUP_TYPE_MASK) != E_POPUP_SUBMENU
&& item->visible & mask) {
d(printf("%s not visible\n", item->path));
continue;
}
}
inode = g_malloc0(sizeof(*inode));
inode->item = l->data;
inode->menu = mnode;
e_dlist_init(&inode->children);
inode->link = mnode->items;
mnode->items = inode;
g_ptr_array_add(items, inode);
}
mnode = nnode;
nnode = nnode->next;
}
/* this makes building the tree in the right order easier */
qsort(items->pdata, items->len, sizeof(items->pdata[0]), ep_cmp);
/* create tree structure */
for (i=0;i<items->len;i++) {
struct _item_node *inode = items->pdata[i], *pnode;
struct _EPopupItem *item = inode->item;
const char *tmp;
g_string_truncate(ppath, 0);
tmp = strrchr(item->path, '/');
if (tmp) {
g_string_append_len(ppath, item->path, tmp-item->path);
pnode = g_hash_table_lookup(tree_hash, ppath->str);
if (pnode == NULL) {
g_warning("No parent defined for node '%s'", item->path);
e_dlist_addtail(&head, (EDListNode *)inode);
} else {
e_dlist_addtail(&pnode->children, (EDListNode *)inode);
inode->parent = pnode;
}
} else {
e_dlist_addtail(&head, (EDListNode *)inode);
}
if ((item->type & E_POPUP_TYPE_MASK) == E_POPUP_SUBMENU)
g_hash_table_insert(tree_hash, item->path, inode);
}
g_string_free(ppath, TRUE);
g_ptr_array_free(items, TRUE);
g_hash_table_destroy(tree_hash);
/* prune unnecessary items */
ep_prune_tree(&head);
/* & build it */
return ep_build_tree((struct _item_node *)head.head, mask);
}
static void
ep_popup_done(GtkWidget *w, EPopup *emp)
{
gtk_widget_destroy(w);
if (emp->target) {
e_popup_target_free(emp, emp->target);
emp->target = NULL;
}
g_object_unref(emp);
}
/**
* e_popup_create_menu_once:
* @emp: EPopup, once the menu is shown, this cannot be
* considered a valid pointer.
* @target: If set, the target of the selection. Static menu
* items will be added. The target will be freed once complete.
* @mask: Enable/disable and visibility mask.
*
* Like popup_create_menu, but automatically sets up the menu
* so that it is destroyed once a selection takes place, and
* the EPopup is unreffed. This is the normal entry point as it
* automates most memory management for popup menus.
*
* Return value: A menu, to popup.
**/
GtkMenu *
e_popup_create_menu_once(EPopup *emp, EPopupTarget *target, guint32 mask)
{
GtkMenu *menu;
menu = e_popup_create_menu(emp, target, mask);
g_signal_connect(menu, "selection_done", G_CALLBACK(ep_popup_done), emp);
return menu;
}
/* ********************************************************************** */
/**
* e_popup_class_add_factory:
* @klass: The EPopup derived class which you're interested in.
* @menuid: The identifier of the menu you're interested in, or NULL
* to be called for all menus on this class.
* @func: The factory called when the menu @menuid is being created.
* @data: User-data for the factory callback.
*
* This is a class-static method used to register factory callbacks
* against specific menu's.
*
* The factory method will be invoked before the menu is created.
* This way, the factory may add any additional menu items it wishes
* based on the context supplied in the @target.
*
* Return value: A handle to the factory which can be used to remove
* it later.
**/
EPopupFactory *
e_popup_class_add_factory(EPopupClass *klass, const char *menuid, EPopupFactoryFunc func, void *data)
{
struct _EPopupFactory *f = g_malloc0(sizeof(*f));
f->menuid = g_strdup(menuid);
f->factory = func;
f->factory_data = data;
e_dlist_addtail(&klass->factories, (EDListNode *)f);
return f;
}
/**
* e_popup_class_remove_factory:
* @klass: The EPopup derived class.
* @f: The factory handle returned by e_popup_class_add_factory().
*
* Remove a popup menu factory. If it has not been added, or it has
* already been removed, then the result is undefined (i.e. it will
* crash).
*
* Generally factories are static for the life of the application, and
* so do not need to be removed.
**/
void
e_popup_class_remove_factory(EPopupClass *klass, EPopupFactory *f)
{
e_dlist_remove((EDListNode *)f);
g_free(f->menuid);
g_free(f);
}
/**
* e_popup_target_new:
* @ep: An EPopup derived object.
* @type: type, defined by the implementing class.
* @size: The size of memory to allocate for the target. It must be
* equal or greater than the size of EPopupTarget.
*
* Allocate a new popup target suitable for this popup type.
**/
void *e_popup_target_new(EPopup *ep, int type, size_t size)
{
EPopupTarget *t;
g_assert(size >= sizeof(EPopupTarget));
t = g_malloc0(size);
t->popup = ep;
g_object_ref(ep);
t->type = type;
return t;
}
/**
* e_popup_target_free:
* @ep: An EPopup derived object.
* @o: The target, previously allocated by e_popup_target_new().
*
* Free the target against @ep. Note that targets are automatically
* freed if they are passed to the menu creation functions, so this is
* only required if you are using the target for other purposes.
**/
void
e_popup_target_free(EPopup *ep, void *o)
{
EPopupTarget *t = o;
((EPopupClass *)G_OBJECT_GET_CLASS(ep))->target_free(ep, t);
}
/* ********************************************************************** */
/* Popup menu plugin handler */
/*
<e-plugin
class="org.gnome.mail.plugin.popup:1.0"
id="org.gnome.mail.plugin.popup.item:1.0"
type="shlib"
location="/opt/gnome2/lib/camel/1.0/libcamelimap.so"
name="imap"
description="IMAP4 and IMAP4v1 mail store">
<hook class="org.gnome.mail.popupMenu:1.0"
handler="HandlePopup">
<menu id="any" target="select" factory="funcspec"?>
<item
type="item|toggle|radio|image|submenu|bar"
active
path="foo/bar"
label="label"
icon="foo"
visible="select_one"
activate="ep_view_emacs"/> *
</menu>
</extension>
*/
static void *emph_parent_class;
#define emph ((EPopupHook *)eph)
/* must have 1:1 correspondence with e-popup types in order */
static const EPluginHookTargetKey emph_item_types[] = {
{ "item", E_POPUP_ITEM },
{ "toggle", E_POPUP_TOGGLE },
{ "radio", E_POPUP_RADIO },
{ "image", E_POPUP_IMAGE },
{ "submenu", E_POPUP_SUBMENU },
{ "bar", E_POPUP_BAR },
{ 0 }
};
static void
emph_popup_activate(EPopup *ep, EPopupItem *item, void *data)
{
EPopupHook *hook = data;
e_plugin_invoke(hook->hook.plugin, (char *)item->user_data, ep->target);
}
static void
emph_popup_factory(EPopup *emp, void *data)
{
struct _EPopupHookMenu *menu = data;
d(printf("popup factory called %s mask %08x\n", menu->id?menu->id:"all menus", emp->target->mask));
/* If we're disabled, then don't add the menu's. */
if (emp->target->type != menu->target_type
|| !menu->hook->hook.plugin->enabled)
return;
if (menu->items)
e_popup_add_items(emp, menu->items, menu->hook->hook.plugin->domain, NULL, menu->hook);
if (menu->factory)
e_plugin_invoke(menu->hook->hook.plugin, menu->factory, emp->target);
}
static void
emph_free_item(struct _EPopupItem *item)
{
g_free(item->path);
g_free(item->label);
g_free(item->image);
g_free(item->user_data);
g_free(item);
}
static void
emph_free_menu(struct _EPopupHookMenu *menu)
{
g_slist_foreach(menu->items, (GFunc)emph_free_item, NULL);
g_slist_free(menu->items);
g_free(menu->factory);
g_free(menu->id);
g_free(menu);
}
static struct _EPopupItem *
emph_construct_item(EPluginHook *eph, EPopupHookMenu *menu, xmlNodePtr root, EPopupHookTargetMap *map)
{
struct _EPopupItem *item;
d(printf(" loading menu item\n"));
item = g_malloc0(sizeof(*item));
if ((item->type = e_plugin_hook_id(root, emph_item_types, "type")) == -1
|| item->type == E_POPUP_IMAGE)
goto error;
item->path = e_plugin_xml_prop(root, "path");
item->label = e_plugin_xml_prop_domain(root, "label", eph->plugin->domain);
item->image = e_plugin_xml_prop(root, "icon");
item->visible = e_plugin_hook_mask(root, map->mask_bits, "visible");
item->enable = e_plugin_hook_mask(root, map->mask_bits, "enable");
item->user_data = e_plugin_xml_prop(root, "activate");
item->activate = emph_popup_activate;
if (item->user_data == NULL)
goto error;
d(printf(" path=%s\n", item->path));
d(printf(" label=%s\n", item->label));
return item;
error:
d(printf("error!\n"));
emph_free_item(item);
return NULL;
}
static struct _EPopupHookMenu *
emph_construct_menu(EPluginHook *eph, xmlNodePtr root)
{
struct _EPopupHookMenu *menu;
xmlNodePtr node;
EPopupHookTargetMap *map;
EPopupHookClass *klass = (EPopupHookClass *)G_OBJECT_GET_CLASS(eph);
char *tmp;
d(printf(" loading menu\n"));
menu = g_malloc0(sizeof(*menu));
menu->hook = (EPopupHook *)eph;
tmp = xmlGetProp(root, "target");
if (tmp == NULL)
goto error;
map = g_hash_table_lookup(klass->target_map, tmp);
xmlFree(tmp);
if (map == NULL)
goto error;
menu->target_type = map->id;
menu->id = e_plugin_xml_prop(root, "id");
if (menu->id == NULL) {
g_warning("Plugin '%s' missing 'id' field in popup for '%s'\n", eph->plugin->name,
((EPluginHookClass *)G_OBJECT_GET_CLASS(eph))->id);
goto error;
}
menu->factory = e_plugin_xml_prop(root, "factory");
node = root->children;
while (node) {
if (0 == strcmp(node->name, "item")) {
struct _EPopupItem *item;
item = emph_construct_item(eph, menu, node, map);
if (item)
menu->items = g_slist_append(menu->items, item);
}
node = node->next;
}
return menu;
error:
emph_free_menu(menu);
return NULL;
}
static int
emph_construct(EPluginHook *eph, EPlugin *ep, xmlNodePtr root)
{
xmlNodePtr node;
EPopupClass *klass;
d(printf("loading popup hook\n"));
if (((EPluginHookClass *)emph_parent_class)->construct(eph, ep, root) == -1)
return -1;
klass = ((EPopupHookClass *)G_OBJECT_GET_CLASS(eph))->popup_class;
node = root->children;
while (node) {
if (strcmp(node->name, "menu") == 0) {
struct _EPopupHookMenu *menu;
menu = emph_construct_menu(eph, node);
if (menu) {
e_popup_class_add_factory(klass, menu->id, emph_popup_factory, menu);
emph->menus = g_slist_append(emph->menus, menu);
}
}
node = node->next;
}
eph->plugin = ep;
return 0;
}
static void
emph_finalise(GObject *o)
{
EPluginHook *eph = (EPluginHook *)o;
g_slist_foreach(emph->menus, (GFunc)emph_free_menu, NULL);
g_slist_free(emph->menus);
((GObjectClass *)emph_parent_class)->finalize(o);
}
static void
emph_class_init(EPluginHookClass *klass)
{
((GObjectClass *)klass)->finalize = emph_finalise;
klass->construct = emph_construct;
/* this is actually an abstract implementation but list it anyway */
klass->id = "org.gnome.evolution.popup:1.0";
d(printf("EPopupHook: init class %p '%s'\n", klass, g_type_name(((GObjectClass *)klass)->g_type_class.g_type)));
((EPopupHookClass *)klass)->target_map = g_hash_table_new(g_str_hash, g_str_equal);
((EPopupHookClass *)klass)->popup_class = g_type_class_ref(e_popup_get_type());
}
/**
* e_popup_hook_get_type:
*
* Standard GObject function to get the object type. Used to subclass
* EPopupHook.
*
* Return value: The type of the popup hook class.
**/
GType
e_popup_hook_get_type(void)
{
static GType type = 0;
if (!type) {
static const GTypeInfo info = {
sizeof(EPopupHookClass), NULL, NULL, (GClassInitFunc) emph_class_init, NULL, NULL,
sizeof(EPopupHook), 0, (GInstanceInitFunc) NULL,
};
emph_parent_class = g_type_class_ref(e_plugin_hook_get_type());
type = g_type_register_static(e_plugin_hook_get_type(), "EPopupHook", &info, 0);
}
return type;
}
/**
* e_popup_hook_class_add_target_map:
* @klass: The derived EPopupHook class.
* @map: A map used to describe a single EPopupTarget type for this
* class.
*
* Add a target map to a concrete derived class of EPopup. The target
* map enumerates a single target type and the enable mask bit names,
* so that the type can be loaded automatically by the EPopup class.
**/
void e_popup_hook_class_add_target_map(EPopupHookClass *klass, const EPopupHookTargetMap *map)
{
g_hash_table_insert(klass->target_map, (void *)map->type, (void *)map);
}
|