gui/dynmenu.c

   1 /* -*- Mode: C ; c-basic-offset: 2 -*- */
   2 /*
   3  * LADI Session Handler (ladish)
   4  *
   5  * Copyright (C) 2010 Nedko Arnaudov <nedko@arnaudov.name>
   6  *
   7  **************************************************************************
   8  * This file contains dynamic menu related code
   9  **************************************************************************
  10  *
  11  * LADI Session Handler is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * LADI Session Handler is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with LADI Session Handler. If not, see <http://www.gnu.org/licenses/>
  23  * or write to the Free Software Foundation, Inc.,
  24  * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  25  */
  26
  27 #include "dynmenu.h"
  28 #include "gtk_builder.h"
  29 #include "../common/catdup.h"
  30
  31 struct ladish_dynmenu
  32 {
  33   int count;
  34   GtkWidget * menu_item;
  35   GtkWidget * menu;
  36   bool
  37   (* fill_callback)(
  38     void
  39     (* callback)(
  40       void * context,
  41       const char * name,
  42       void * data,
  43       ladish_dynmenu_item_activate_callback item_activate_callback,
  44       void (* data_free)()),
  45     void * context);
  46   ladish_dynmenu_item_activate_callback item_activate_callback;
  47   bool add_sensitive;
  48   gulong activate_signal_id;
  49   char * description;
  50 };
  51
  52 struct ladish_dynmenu_item_data
  53 {
  54   GtkWidget * item;
  55   void * data;
  56   void (* data_free)();
  57   ladish_dynmenu_item_activate_callback item_activate_callback;
  58 };
  59
  60 void on_activate_item(GtkMenuItem * item, struct ladish_dynmenu_item_data * data_ptr)
  61 {
  62   //log_info("on_activate_item('%s')", gtk_label_get_text(GTK_LABEL(gtk_bin_get_child(GTK_BIN(data_ptr->item)))));
  63
  64   data_ptr->item_activate_callback(
  65     gtk_label_get_text(GTK_LABEL(gtk_bin_get_child(GTK_BIN(data_ptr->item)))),
  66     data_ptr->data);
  67 }
  68
  69 #define data_ptr ((struct ladish_dynmenu_item_data *)data)
  70
  71 void free_item_data(gpointer data, GClosure * closure)
  72 {
  73   //log_info("data_ptr %p deallocate", data_ptr);
  74
  75   if (data_ptr->data != NULL)
  76   {
  77     if (data_ptr->data_free != NULL)
  78     {
  79       data_ptr->data_free(data_ptr->data);
  80     }
  81     else
  82     {
  83       free(data_ptr->data);
  84     }
  85   }
  86
  87   free(data_ptr);
  88 }
  89
  90 #undef data_ptr
  91 #define dynmenu_ptr ((struct ladish_dynmenu *)context)
  92
  93 static
  94 void
  95 ladish_dynmenu_add_entry(
  96   void * context,
  97   const char * name,
  98   void * data,
  99   ladish_dynmenu_item_activate_callback item_activate_callback,
 100   void (* data_free)())
 101 {
 102   struct ladish_dynmenu_item_data * data_ptr;
 103
 104   data_ptr = malloc(sizeof(struct ladish_dynmenu_item_data));
 105   //log_info("data_ptr %p allocated", data_ptr);
 106   data_ptr->data = data;
 107   data_ptr->data_free = data_free;
 108   data_ptr->item_activate_callback = item_activate_callback != NULL ? item_activate_callback : dynmenu_ptr->item_activate_callback;
 109
 110   if (name == NULL)
 111   {
 112     data_ptr->item = gtk_separator_menu_item_new(); /* separator */
 113     gtk_widget_show(data_ptr->item);
 114     gtk_menu_shell_append(GTK_MENU_SHELL(dynmenu_ptr->menu), data_ptr->item);
 115   }
 116   else
 117   {
 118     data_ptr->item = gtk_menu_item_new_with_label(name);
 119     //log_info("refcount == %d", (unsigned int)G_OBJECT(item)->ref_count); // refcount == 2 because of the label
 120     gtk_widget_set_sensitive(data_ptr->item, dynmenu_ptr->add_sensitive);
 121     gtk_widget_show(data_ptr->item);
 122     gtk_menu_shell_append(GTK_MENU_SHELL(dynmenu_ptr->menu), data_ptr->item);
 123     g_signal_connect_data(
 124       G_OBJECT(data_ptr->item),
 125       "activate",
 126       G_CALLBACK(on_activate_item),
 127       data_ptr,
 128       free_item_data,
 129       (GConnectFlags)0);
 130   }
 131
 132   dynmenu_ptr->count++;
 133 }
 134
 135 static void remove_dynmenu_menu_entry(GtkWidget * item, gpointer context)
 136 {
 137   GtkWidget * label;
 138
 139   label = gtk_bin_get_child(GTK_BIN(item));
 140
 141   //log_debug("removing dynmenu item \"%s\"", gtk_menu_item_get_label(GTK_MENU_ITEM(item));
 142   // gtk_menu_item_get_label() requries gtk 2.16
 143   log_debug("removing dynmenu item \"%s\"", gtk_label_get_text(GTK_LABEL(label)));
 144
 145   gtk_container_remove(GTK_CONTAINER(item), label); /* destroy the label and drop the item refcount by one */
 146   //log_info("refcount == %d", (unsigned int)G_OBJECT(item)->ref_count);
 147   gtk_container_remove(GTK_CONTAINER(dynmenu_ptr->menu), item); /* drop the refcount of item by one and thus destroy it */
 148   dynmenu_ptr->count--;
 149 }
 150
 151 #undef dynmenu_ptr
 152
 153 static void menu_dynmenu_clear(struct ladish_dynmenu * dynmenu_ptr)
 154 {
 155   gtk_container_foreach(GTK_CONTAINER(dynmenu_ptr->menu), remove_dynmenu_menu_entry, dynmenu_ptr);
 156   ASSERT(dynmenu_ptr->count == 0);
 157   dynmenu_ptr->count = 0;
 158 }
 159
 160 static void populate_dynmenu_menu(GtkMenuItem * menu_item, struct ladish_dynmenu * dynmenu_ptr)
 161 {
 162   const char * prefix;
 163   char * text;
 164
 165   menu_dynmenu_clear(dynmenu_ptr);
 166   dynmenu_ptr->add_sensitive = true;
 167   if (!dynmenu_ptr->fill_callback(ladish_dynmenu_add_entry, dynmenu_ptr))
 168   {
 169     menu_dynmenu_clear(dynmenu_ptr);
 170     prefix = _("Error filling ");
 171   }
 172   else if (dynmenu_ptr->count == 0)
 173   {
 174     prefix = _("Empty ");
 175   }
 176   else
 177   {
 178     return;
 179   }
 180
 181   text = catdup(prefix, dynmenu_ptr->description);
 182
 183   dynmenu_ptr->add_sensitive = false;
 184   ladish_dynmenu_add_entry(dynmenu_ptr, text != NULL ? text : prefix, NULL, NULL, NULL);
 185
 186   free(text);                   /* free(NULL) is safe */
 187 }
 188
 189 bool
 190 ladish_dynmenu_create(
 191   const char * menu_item,
 192   const char * menu,
 193   bool
 194   (* fill_callback)(
 195     void
 196     (* callback)(
 197       void * context,
 198       const char * name,
 199       void * data,
 200       ladish_dynmenu_item_activate_callback item_activate_callback,
 201       void (* data_free)()),
 202     void * context),
 203   const char * description,
 204   ladish_dynmenu_item_activate_callback item_activate_callback,
 205   ladish_dynmenu_handle * dynmenu_handle_ptr)
 206 {
 207   struct ladish_dynmenu * dynmenu_ptr;
 208
 209   dynmenu_ptr = malloc(sizeof(struct ladish_dynmenu));
 210   if (dynmenu_ptr == NULL)
 211   {
 212     log_error("Allocation of ladish_dynmenu struct failed");
 213     return false;
 214   }
 215
 216   dynmenu_ptr->description = strdup(description);
 217   if (dynmenu_ptr->description == NULL)
 218   {
 219     log_error("strdup('%s') failed for dynmenu description string", description);
 220     free(dynmenu_ptr);
 221     return false;
 222   }
 223
 224   dynmenu_ptr->count = 0;
 225   dynmenu_ptr->menu_item = get_gtk_builder_widget(menu_item);
 226   dynmenu_ptr->menu = get_gtk_builder_widget(menu);
 227   dynmenu_ptr->fill_callback = fill_callback;
 228   dynmenu_ptr->item_activate_callback = item_activate_callback;
 229   gtk_menu_item_set_submenu(GTK_MENU_ITEM(dynmenu_ptr->menu_item), dynmenu_ptr->menu);
 230   dynmenu_ptr->activate_signal_id = g_signal_connect(G_OBJECT(dynmenu_ptr->menu_item), "activate", G_CALLBACK(populate_dynmenu_menu), dynmenu_ptr);
 231
 232   *dynmenu_handle_ptr = (ladish_dynmenu_handle)dynmenu_ptr;
 233   return true;
 234 }
 235
 236 #define dynmenu_ptr ((struct ladish_dynmenu *)dynmenu_handle)
 237
 238 void
 239 ladish_dynmenu_fill_external(
 240   ladish_dynmenu_handle dynmenu_handle,
 241   GtkMenu * menu)
 242 {
 243   GtkWidget * menu_backup;
 244   int count_backup;
 245
 246   menu_backup = dynmenu_ptr->menu;
 247   count_backup = dynmenu_ptr->count;
 248
 249   dynmenu_ptr->menu = GTK_WIDGET(menu);
 250   dynmenu_ptr->add_sensitive = true;
 251
 252   dynmenu_ptr->fill_callback(ladish_dynmenu_add_entry, dynmenu_ptr);
 253
 254   dynmenu_ptr->menu = menu_backup;
 255   dynmenu_ptr->count = count_backup;
 256 }
 257
 258 void
 259 ladish_dynmenu_destroy(
 260   ladish_dynmenu_handle dynmenu_handle)
 261 {
 262   if (g_signal_handler_is_connected(G_OBJECT(dynmenu_ptr->menu_item), dynmenu_ptr->activate_signal_id))
 263   {
 264     g_signal_handler_disconnect(G_OBJECT(dynmenu_ptr->menu_item), dynmenu_ptr->activate_signal_id);
 265   }
 266
 267   free(dynmenu_ptr);
 268 }
 269
 270 #undef dynmenu_ptr