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       void (* data_free)()),
  44     void * context);
  45   void (* item_activate_callback)(const char * name, void * data);
  46   bool add_sensitive;
  47   gulong activate_signal_id;
  48   char * description;
  49 };
  50
  51 struct ladish_dynmenu_item_data
  52 {
  53   GtkWidget * item;
  54   void * data;
  55   void (* data_free)();
  56   void (* item_activate_callback)(const char * name, void * data);
  57 };
  58
  59 void on_activate_item(GtkMenuItem * item, struct ladish_dynmenu_item_data * data_ptr)
  60 {
  61   //log_info("on_activate_item('%s')", gtk_label_get_text(GTK_LABEL(gtk_bin_get_child(GTK_BIN(data_ptr->item)))));
  62
  63   data_ptr->item_activate_callback(
  64     gtk_label_get_text(GTK_LABEL(gtk_bin_get_child(GTK_BIN(data_ptr->item)))),
  65     data_ptr->data);
  66 }
  67
  68 #define data_ptr ((struct ladish_dynmenu_item_data *)data)
  69
  70 void free_item_data(gpointer data, GClosure * closure)
  71 {
  72   //log_info("data_ptr %p deallocate", data_ptr);
  73
  74   if (data_ptr->data != NULL)
  75   {
  76     if (data_ptr->data_free != NULL)
  77     {
  78       data_ptr->data_free(data_ptr->data);
  79     }
  80     else
  81     {
  82       free(data_ptr->data);
  83     }
  84   }
  85
  86   free(data_ptr);
  87 }
  88
  89 #undef data_ptr
  90 #define dynmenu_ptr ((struct ladish_dynmenu *)context)
  91
  92 static void ladish_dynmenu_add_entry(void * context, const char * name, void * data, void (* data_free)())
  93 {
  94   struct ladish_dynmenu_item_data * data_ptr;
  95
  96   data_ptr = malloc(sizeof(struct ladish_dynmenu_item_data));
  97   //log_info("data_ptr %p allocated", data_ptr);
  98   data_ptr->data = data;
  99   data_ptr->data_free = data_free;
 100   data_ptr->item_activate_callback = dynmenu_ptr->item_activate_callback;
 101
 102   data_ptr->item = gtk_menu_item_new_with_label(name);
 103   //log_info("refcount == %d", (unsigned int)G_OBJECT(item)->ref_count); // refcount == 2 because of the label
 104   gtk_widget_set_sensitive(data_ptr->item, dynmenu_ptr->add_sensitive);
 105   gtk_widget_show(data_ptr->item);
 106   gtk_menu_shell_append(GTK_MENU_SHELL(dynmenu_ptr->menu), data_ptr->item);
 107   g_signal_connect_data(
 108     G_OBJECT(data_ptr->item),
 109     "activate",
 110     G_CALLBACK(on_activate_item),
 111     data_ptr,
 112     free_item_data,
 113     (GConnectFlags)0);
 114   dynmenu_ptr->count++;
 115 }
 116
 117 static void remove_dynmenu_menu_entry(GtkWidget * item, gpointer context)
 118 {
 119   GtkWidget * label;
 120
 121   label = gtk_bin_get_child(GTK_BIN(item));
 122
 123   //log_debug("removing dynmenu item \"%s\"", gtk_menu_item_get_label(GTK_MENU_ITEM(item));
 124   // gtk_menu_item_get_label() requries gtk 2.16
 125   log_debug("removing dynmenu item \"%s\"", gtk_label_get_text(GTK_LABEL(label)));
 126
 127   gtk_container_remove(GTK_CONTAINER(item), label); /* destroy the label and drop the item refcount by one */
 128   //log_info("refcount == %d", (unsigned int)G_OBJECT(item)->ref_count);
 129   gtk_container_remove(GTK_CONTAINER(dynmenu_ptr->menu), item); /* drop the refcount of item by one and thus destroy it */
 130   dynmenu_ptr->count--;
 131 }
 132
 133 #undef dynmenu_ptr
 134
 135 static void menu_dynmenu_clear(struct ladish_dynmenu * dynmenu_ptr)
 136 {
 137   gtk_container_foreach(GTK_CONTAINER(dynmenu_ptr->menu), remove_dynmenu_menu_entry, dynmenu_ptr);
 138   ASSERT(dynmenu_ptr->count == 0);
 139   dynmenu_ptr->count = 0;
 140 }
 141
 142 static void populate_dynmenu_menu(GtkMenuItem * menu_item, struct ladish_dynmenu * dynmenu_ptr)
 143 {
 144   const char * prefix;
 145   char * text;
 146
 147   menu_dynmenu_clear(dynmenu_ptr);
 148   dynmenu_ptr->add_sensitive = true;
 149   if (!dynmenu_ptr->fill_callback(ladish_dynmenu_add_entry, dynmenu_ptr))
 150   {
 151     menu_dynmenu_clear(dynmenu_ptr);
 152     prefix = "Error obtaining ";
 153   }
 154   else if (dynmenu_ptr->count == 0)
 155   {
 156     prefix = "Empty ";
 157   }
 158   else
 159   {
 160     return;
 161   }
 162
 163   text = catdup(prefix, dynmenu_ptr->description);
 164
 165   dynmenu_ptr->add_sensitive = false;
 166   ladish_dynmenu_add_entry(dynmenu_ptr, text != NULL ? text : prefix, NULL, NULL);
 167
 168   free(text);                   /* free(NULL) is safe */
 169 }
 170
 171 bool
 172 ladish_dynmenu_create(
 173   const char * menu_item,
 174   const char * menu,
 175   bool
 176   (* fill_callback)(
 177     void
 178     (* callback)(
 179       void * context,
 180       const char * name,
 181       void * data,
 182       void (* data_free)()),
 183     void * context),
 184   const char * description,
 185   void (* item_activate_callback)(const char * name, void * data),
 186   ladish_dynmenu_handle * dynmenu_handle_ptr)
 187 {
 188   struct ladish_dynmenu * dynmenu_ptr;
 189
 190   dynmenu_ptr = malloc(sizeof(struct ladish_dynmenu));
 191   if (dynmenu_ptr == NULL)
 192   {
 193     log_error("Allocation of ladish_dynmenu struct failed");
 194     return false;
 195   }
 196
 197   dynmenu_ptr->description = strdup(description);
 198   if (dynmenu_ptr->description == NULL)
 199   {
 200     log_error("strdup('%s') failed for dynmenu description string", description);
 201     free(dynmenu_ptr);
 202     return false;
 203   }
 204
 205   dynmenu_ptr->count = 0;
 206   dynmenu_ptr->menu_item = get_gtk_builder_widget(menu_item);
 207   dynmenu_ptr->menu = get_gtk_builder_widget(menu);
 208   dynmenu_ptr->fill_callback = fill_callback;
 209   dynmenu_ptr->item_activate_callback = item_activate_callback;
 210   gtk_menu_item_set_submenu(GTK_MENU_ITEM(dynmenu_ptr->menu_item), dynmenu_ptr->menu);
 211   dynmenu_ptr->activate_signal_id = g_signal_connect(G_OBJECT(dynmenu_ptr->menu_item), "activate", G_CALLBACK(populate_dynmenu_menu), dynmenu_ptr);
 212
 213   *dynmenu_handle_ptr = (ladish_dynmenu_handle)dynmenu_ptr;
 214   return true;
 215 }
 216
 217 #define dynmenu_ptr ((struct ladish_dynmenu *)dynmenu_handle)
 218
 219 void
 220 ladish_dynmenu_destroy(
 221   ladish_dynmenu_handle dynmenu_handle)
 222 {
 223   if (g_signal_handler_is_connected(G_OBJECT(dynmenu_ptr->menu_item), dynmenu_ptr->activate_signal_id))
 224   {
 225     g_signal_handler_disconnect(G_OBJECT(dynmenu_ptr->menu_item), dynmenu_ptr->activate_signal_id);
 226   }
 227
 228   free(dynmenu_ptr);
 229 }
 230
 231 #undef dynmenu_ptr