openbox/menu.c

   1 #include "debug.h"
   2 #include "menu.h"
   3 #include "openbox.h"
   4 #include "stacking.h"
   5 #include "client.h"
   6 #include "grab.h"
   7 #include "config.h"
   8 #include "screen.h"
   9 #include "menuframe.h"
  10 #include "geom.h"
  11 #include "misc.h"
  12 #include "client_menu.h"
  13 #include "client_list_menu.h"
  14 #include "parser/parse.h"
  15
  16 typedef struct _ObMenuParseState ObMenuParseState;
  17
  18 struct _ObMenuParseState
  19 {
  20     GSList *menus;
  21 };
  22
  23 static GHashTable *menu_hash = NULL;
  24 static ObParseInst *menu_parse_inst;
  25 static ObMenuParseState menu_parse_state;
  26
  27 static void menu_destroy_hash_value(ObMenu *self);
  28 static void parse_menu_item(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
  29                             gpointer data);
  30 static void parse_menu_separator(ObParseInst *i,
  31                                  xmlDocPtr doc, xmlNodePtr node,
  32                                  gpointer data);
  33 static void parse_menu(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
  34                        gpointer data);
  35
  36 static gboolean menu_open(gchar *file, xmlDocPtr *doc, xmlNodePtr *node)
  37 {
  38     gboolean loaded = TRUE;
  39     gchar *p;
  40
  41     p = g_build_filename(g_get_home_dir(), ".openbox", file, NULL);
  42     if (!parse_load(p, "openbox_menu", doc, node)) {
  43         g_free(p);
  44         p = g_build_filename(RCDIR, file, NULL);
  45         if (!parse_load(p, "openbox_menu", doc, node)) {
  46             g_free(p);
  47             p = g_strdup(file);
  48             if (!parse_load(p, "openbox_menu", doc, node)) {
  49                 g_warning("Failed to load menu from '%s'", file);
  50                 loaded = FALSE;
  51             }
  52         }
  53     }
  54     g_free(p);
  55     return loaded;
  56 }
  57
  58 static void client_dest(gpointer client)
  59 {
  60     /* menus can be associated with a client, so close any that are since
  61        we are disappearing now */
  62     menu_frame_hide_all_client(client);
  63 }
  64
  65 void menu_startup(gboolean reconfig)
  66 {
  67     xmlDocPtr doc;
  68     xmlNodePtr node;
  69     gboolean loaded = FALSE;
  70     GSList *it;
  71
  72     menu_hash = g_hash_table_new_full(g_str_hash, g_str_equal, NULL,
  73                                       (GDestroyNotify)menu_destroy_hash_value);
  74
  75     client_list_menu_startup();
  76     client_menu_startup();
  77
  78     menu_parse_inst = parse_startup();
  79
  80     menu_parse_state.menus = NULL;
  81     parse_register(menu_parse_inst, "menu", parse_menu, &menu_parse_state);
  82     parse_register(menu_parse_inst, "item", parse_menu_item,
  83                    &menu_parse_state);
  84     parse_register(menu_parse_inst, "separator",
  85                    parse_menu_separator, &menu_parse_state);
  86
  87     for (it = config_menu_files; it; it = g_slist_next(it)) {
  88         if (menu_open(it->data, &doc, &node)) {
  89             loaded = TRUE;
  90             parse_tree(menu_parse_inst, doc, node->xmlChildrenNode);
  91             xmlFreeDoc(doc);
  92         }
  93     }
  94     if (!loaded) {
  95         if (menu_open("menu.xml", &doc, &node)) {
  96             parse_tree(menu_parse_inst, doc, node->xmlChildrenNode);
  97             xmlFreeDoc(doc);
  98         }
  99     }
 100
 101     g_assert(menu_parse_state.menus == NULL);
 102
 103     if (!reconfig)
 104         client_add_destructor(client_dest);
 105 }
 106
 107 void menu_shutdown(gboolean reconfig)
 108 {
 109     if (!reconfig)
 110         client_remove_destructor(client_dest);
 111
 112     parse_shutdown(menu_parse_inst);
 113     menu_parse_inst = NULL;
 114
 115     menu_frame_hide_all();
 116     g_hash_table_destroy(menu_hash);
 117     menu_hash = NULL;
 118 }
 119
 120 void menu_pipe_execute(ObMenu *self)
 121 {
 122     xmlDocPtr doc;
 123     xmlNodePtr node;
 124     gchar *output;
 125     GError *err = NULL;
 126
 127     if (!self->execute)
 128         return;
 129
 130     if (!g_spawn_command_line_sync(self->execute, &output, NULL, NULL, &err))
 131     {
 132         g_warning("Failed to execute command for pipe-menu: %s", err->message);
 133         g_error_free(err);
 134         return;
 135     }
 136
 137     if (parse_load_mem(output, strlen(output),
 138                        "openbox_pipe_menu", &doc, &node))
 139     {
 140         menu_clear_entries(self);
 141
 142         menu_parse_state.menus = g_slist_prepend(NULL, self);
 143         parse_tree(menu_parse_inst, doc, node->xmlChildrenNode);
 144         menu_parse_state.menus = g_slist_remove(menu_parse_state.menus, self);
 145         xmlFreeDoc(doc);
 146
 147         g_assert(menu_parse_state.menus == NULL);
 148     }
 149 }
 150
 151 static ObMenu* menu_from_name(gchar *name)
 152 {
 153     ObMenu *self = NULL;
 154
 155     g_assert(name != NULL);
 156
 157     if (!(self = g_hash_table_lookup(menu_hash, name)))
 158         g_warning("Attempted to access menu '%s' but it does not exist.",
 159                   name);
 160     return self;
 161 }
 162
 163 static void parse_menu_item(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
 164                             gpointer data)
 165 {
 166     ObMenuParseState *state = data;
 167     gchar *label;
 168
 169     if (state->menus) {
 170         if (parse_attr_string("label", node, &label)) {
 171             GSList *acts = NULL;
 172
 173             for (node = node->xmlChildrenNode; node; node = node->next)
 174                 if (!xmlStrcasecmp(node->name, (const xmlChar*) "action"))
 175                     acts = g_slist_append(acts, action_parse(i, doc, node));
 176             menu_add_normal(state->menus->data, -1, label, acts);
 177             g_free(label);
 178         }
 179     }
 180 }
 181
 182 static void parse_menu_separator(ObParseInst *i,
 183                                  xmlDocPtr doc, xmlNodePtr node,
 184                                  gpointer data)
 185 {
 186     ObMenuParseState *state = data;
 187
 188     if (state->menus)
 189         menu_add_separator(state->menus->data, -1);
 190 }
 191
 192 static void parse_menu(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
 193                        gpointer data)
 194 {
 195     ObMenuParseState *state = data;
 196     gchar *name = NULL, *title = NULL, *script = NULL;
 197     ObMenu *menu;
 198
 199     if (!parse_attr_string("id", node, &name))
 200         goto parse_menu_fail;
 201
 202     if (!g_hash_table_lookup(menu_hash, name)) {
 203         if (!parse_attr_string("label", node, &title))
 204             goto parse_menu_fail;
 205
 206         if ((menu = menu_new(name, title, NULL))) {
 207             if (parse_attr_string("execute", node, &script)) {
 208                 menu->execute = ob_expand_tilde(script);
 209             } else {
 210                 state->menus = g_slist_prepend(state->menus, menu);
 211                 parse_tree(i, doc, node->xmlChildrenNode);
 212                 state->menus = g_slist_delete_link(state->menus, state->menus);
 213             }
 214         }
 215     }
 216
 217     if (state->menus)
 218         menu_add_submenu(state->menus->data, -1, name);
 219
 220 parse_menu_fail:
 221     g_free(name);
 222     g_free(title);
 223     g_free(script);
 224 }
 225
 226 ObMenu* menu_new(gchar *name, gchar *title, gpointer data)
 227 {
 228     ObMenu *self;
 229
 230     self = g_new0(ObMenu, 1);
 231     self->name = g_strdup(name);
 232     self->title = g_strdup(title);
 233     self->data = data;
 234
 235     g_hash_table_replace(menu_hash, self->name, self);
 236
 237     return self;
 238 }
 239
 240 static void menu_destroy_hash_value(ObMenu *self)
 241 {
 242     /* XXX make sure its not visible */
 243
 244     if (self->destroy_func)
 245         self->destroy_func(self, self->data);
 246
 247     menu_clear_entries(self);
 248     g_free(self->name);
 249     g_free(self->title);
 250     g_free(self->execute);
 251 }
 252
 253 void menu_free(ObMenu *menu)
 254 {
 255     g_hash_table_remove(menu_hash, menu->name);
 256 }
 257
 258 void menu_show(gchar *name, gint x, gint y, ObClient *client)
 259 {
 260     ObMenu *self;
 261     ObMenuFrame *frame;
 262
 263     if (!(self = menu_from_name(name))) return;
 264
 265     frame = menu_frame_new(self, client);
 266     menu_frame_move(frame, x, y);
 267     menu_frame_show(frame, NULL);
 268     if (frame->entries)
 269         menu_frame_select_next(frame);
 270 }
 271
 272 static ObMenuEntry* menu_entry_new(ObMenu *menu, ObMenuEntryType type, gint id)
 273 {
 274     ObMenuEntry *self;
 275
 276     g_assert(menu);
 277
 278     self = g_new0(ObMenuEntry, 1);
 279     self->type = type;
 280     self->menu = menu;
 281     self->id = id;
 282
 283     switch (type) {
 284     case OB_MENU_ENTRY_TYPE_NORMAL:
 285         self->data.normal.enabled = TRUE;
 286         break;
 287     case OB_MENU_ENTRY_TYPE_SUBMENU:
 288     case OB_MENU_ENTRY_TYPE_SEPARATOR:
 289         break;
 290     }
 291
 292     return self;
 293 }
 294
 295 void menu_entry_free(ObMenuEntry *self)
 296 {
 297     if (self) {
 298         switch (self->type) {
 299         case OB_MENU_ENTRY_TYPE_NORMAL:
 300             g_free(self->data.normal.label);
 301             while (self->data.normal.actions) {
 302                 action_free(self->data.normal.actions->data);
 303                 self->data.normal.actions =
 304                     g_slist_delete_link(self->data.normal.actions,
 305                                         self->data.normal.actions);
 306             }
 307             break;
 308         case OB_MENU_ENTRY_TYPE_SUBMENU:
 309             g_free(self->data.submenu.name);
 310             break;
 311         case OB_MENU_ENTRY_TYPE_SEPARATOR:
 312             break;
 313         }
 314
 315         g_free(self);
 316     }
 317 }
 318
 319 void menu_clear_entries(ObMenu *self)
 320 {
 321     /* XXX assert that the menu isn't visible */
 322
 323     while (self->entries) {
 324         menu_entry_free(self->entries->data);
 325         self->entries = g_list_delete_link(self->entries, self->entries);
 326     }
 327 }
 328
 329 void menu_entry_remove(ObMenuEntry *self)
 330 {
 331     self->menu->entries = g_list_remove(self->menu->entries, self);
 332     menu_entry_free(self);
 333 }
 334
 335 ObMenuEntry* menu_add_normal(ObMenu *self, gint id, gchar *label,
 336                              GSList *actions)
 337 {
 338     ObMenuEntry *e;
 339
 340     e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_NORMAL, id);
 341     e->data.normal.label = g_strdup(label);
 342     e->data.normal.actions = actions;
 343
 344     self->entries = g_list_append(self->entries, e);
 345     return e;
 346 }
 347
 348 ObMenuEntry* menu_add_submenu(ObMenu *self, gint id, gchar *submenu)
 349 {
 350     ObMenuEntry *e;
 351
 352     e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SUBMENU, id);
 353     e->data.submenu.name = g_strdup(submenu);
 354
 355     self->entries = g_list_append(self->entries, e);
 356     return e;
 357 }
 358
 359 ObMenuEntry* menu_add_separator(ObMenu *self, gint id)
 360 {
 361     ObMenuEntry *e;
 362
 363     e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SEPARATOR, id);
 364
 365     self->entries = g_list_append(self->entries, e);
 366     return e;
 367 }
 368
 369 void menu_set_update_func(ObMenu *self, ObMenuUpdateFunc func)
 370 {
 371     self->update_func = func;
 372 }
 373
 374 void menu_set_execute_func(ObMenu *self, ObMenuExecuteFunc func)
 375 {
 376     self->execute_func = func;
 377 }
 378
 379 void menu_set_destroy_func(ObMenu *self, ObMenuDestroyFunc func)
 380 {
 381     self->destroy_func = func;
 382 }
 383
 384 ObMenuEntry* menu_find_entry_id(ObMenu *self, gint id)
 385 {
 386     ObMenuEntry *ret = NULL;
 387     GList *it;
 388
 389     for (it = self->entries; it; it = g_list_next(it)) {
 390         ObMenuEntry *e = it->data;
 391
 392         if (e->id == id) {
 393             ret = e;
 394             break;
 395         }
 396     }
 397     return ret;
 398 }
 399
 400 void menu_find_submenus(ObMenu *self)
 401 {
 402     GList *it;
 403
 404     for (it = self->entries; it; it = g_list_next(it)) {
 405         ObMenuEntry *e = it->data;
 406
 407         if (e->type == OB_MENU_ENTRY_TYPE_SUBMENU)
 408             e->data.submenu.submenu = menu_from_name(e->data.submenu.name);
 409     }
 410 }