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(ObClient *c)
  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(c);
  63 }
  64
  65 void menu_startup()
  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     for (it = config_menu_files; it; it = g_slist_next(it)) {
  81         if (menu_open(it->data, &doc, &node))
  82             loaded = TRUE;
  83
  84     }
  85     if (!loaded)
  86         loaded = menu_open("menu", &doc, &node);
  87
  88     if (loaded) {
  89         menu_parse_state.menus = NULL;
  90
  91         parse_register(menu_parse_inst, "menu", parse_menu, &menu_parse_state);
  92         parse_register(menu_parse_inst, "item", parse_menu_item,
  93                        &menu_parse_state);
  94         parse_register(menu_parse_inst, "separator",
  95                        parse_menu_separator, &menu_parse_state);
  96         parse_tree(menu_parse_inst, doc, node->xmlChildrenNode);
  97         xmlFreeDoc(doc);
  98
  99         g_assert(menu_parse_state.menus == NULL);
 100     }
 101
 102     client_add_destructor(client_dest);
 103 }
 104
 105 void menu_shutdown()
 106 {
 107     client_remove_destructor(client_dest);
 108
 109     parse_shutdown(menu_parse_inst);
 110     menu_parse_inst = NULL;
 111
 112     menu_frame_hide_all();
 113     g_hash_table_destroy(menu_hash);
 114     menu_hash = NULL;
 115 }
 116
 117 void menu_pipe_execute(ObMenu *self)
 118 {
 119     xmlDocPtr doc;
 120     xmlNodePtr node;
 121     gchar *output;
 122     GError *err = NULL;
 123
 124     if (!self->execute)
 125         return;
 126
 127     if (!g_spawn_command_line_sync(self->execute, &output, NULL, NULL, &err))
 128     {
 129         g_warning("Failed to execute command for pipe-menu: %s", err->message);
 130         g_error_free(err);
 131         return;
 132     }
 133
 134     if (parse_load_mem(output, strlen(output),
 135                        "openbox_pipe_menu", &doc, &node))
 136     {
 137         menu_clear_entries(self);
 138
 139         menu_parse_state.menus = g_slist_prepend(NULL, self);
 140         parse_tree(menu_parse_inst, doc, node->xmlChildrenNode);
 141         menu_parse_state.menus = g_slist_remove(menu_parse_state.menus, self);
 142         xmlFreeDoc(doc);
 143
 144         g_assert(menu_parse_state.menus == NULL);
 145     }
 146 }
 147
 148 static ObMenu* menu_from_name(gchar *name)
 149 {
 150     ObMenu *self = NULL;
 151
 152     g_assert(name != NULL);
 153
 154     if (!(self = g_hash_table_lookup(menu_hash, name)))
 155         g_warning("Attempted to access menu '%s' but it does not exist.",
 156                   name);
 157     return self;
 158 }
 159
 160 static void parse_menu_item(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
 161                             gpointer data)
 162 {
 163     ObMenuParseState *state = data;
 164     gchar *label;
 165
 166     if (state->menus) {
 167         if (parse_attr_string("label", node, &label)) {
 168             GSList *acts = NULL;
 169
 170             for (node = node->xmlChildrenNode; node; node = node->next)
 171                 if (!xmlStrcasecmp(node->name, (const xmlChar*) "action"))
 172                     acts = g_slist_append(acts, action_parse(i, doc, node));
 173             menu_add_normal(state->menus->data, -1, label, acts);
 174             g_free(label);
 175         }
 176     }
 177 }
 178
 179 static void parse_menu_separator(ObParseInst *i,
 180                                  xmlDocPtr doc, xmlNodePtr node,
 181                                  gpointer data)
 182 {
 183     ObMenuParseState *state = data;
 184
 185     if (state->menus)
 186         menu_add_separator(state->menus->data, -1);
 187 }
 188
 189 static void parse_menu(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
 190                        gpointer data)
 191 {
 192     ObMenuParseState *state = data;
 193     gchar *name = NULL, *title = NULL, *script = NULL;
 194     ObMenu *menu;
 195
 196     if (!parse_attr_string("id", node, &name))
 197         goto parse_menu_fail;
 198
 199     if (!g_hash_table_lookup(menu_hash, name)) {
 200         if (!parse_attr_string("label", node, &title))
 201             goto parse_menu_fail;
 202
 203         if ((menu = menu_new(name, title, NULL))) {
 204             if (parse_attr_string("execute", node, &script)) {
 205                 menu->execute = g_strdup(script);
 206             } else {
 207                 state->menus = g_slist_prepend(state->menus, menu);
 208                 parse_tree(i, doc, node->xmlChildrenNode);
 209                 state->menus = g_slist_delete_link(state->menus, state->menus);
 210             }
 211         }
 212     }
 213
 214     if (state->menus)
 215         menu_add_submenu(state->menus->data, -1, name);
 216
 217 parse_menu_fail:
 218     g_free(name);
 219     g_free(title);
 220     g_free(script);
 221 }
 222
 223 ObMenu* menu_new(gchar *name, gchar *title, gpointer data)
 224 {
 225     ObMenu *self;
 226
 227     self = g_new0(ObMenu, 1);
 228     self->name = g_strdup(name);
 229     self->title = g_strdup(title);
 230     self->data = data;
 231
 232     g_hash_table_replace(menu_hash, self->name, self);
 233
 234     return self;
 235 }
 236
 237 static void menu_destroy_hash_value(ObMenu *self)
 238 {
 239     /* XXX make sure its not visible */
 240
 241     if (self->destroy_func)
 242         self->destroy_func(self, self->data);
 243
 244     menu_clear_entries(self);
 245     g_free(self->name);
 246     g_free(self->title);
 247     g_free(self->execute);
 248 }
 249
 250 void menu_free(ObMenu *menu)
 251 {
 252     g_hash_table_remove(menu_hash, menu->name);
 253 }
 254
 255 void menu_show(gchar *name, gint x, gint y, ObClient *client)
 256 {
 257     ObMenu *self;
 258     ObMenuFrame *frame;
 259
 260     if (!(self = menu_from_name(name))) return;
 261
 262     frame = menu_frame_new(self, client);
 263     menu_frame_move(frame, x, y);
 264     menu_frame_show(frame, NULL);
 265     if (frame->entries)
 266         menu_frame_select_next(frame);
 267 }
 268
 269 static ObMenuEntry* menu_entry_new(ObMenu *menu, ObMenuEntryType type, gint id)
 270 {
 271     ObMenuEntry *self;
 272
 273     g_assert(menu);
 274
 275     self = g_new0(ObMenuEntry, 1);
 276     self->type = type;
 277     self->menu = menu;
 278     self->id = id;
 279
 280     switch (type) {
 281     case OB_MENU_ENTRY_TYPE_NORMAL:
 282         self->data.normal.enabled = TRUE;
 283         break;
 284     case OB_MENU_ENTRY_TYPE_SUBMENU:
 285     case OB_MENU_ENTRY_TYPE_SEPARATOR:
 286         break;
 287     }
 288
 289     return self;
 290 }
 291
 292 void menu_entry_free(ObMenuEntry *self)
 293 {
 294     if (self) {
 295         switch (self->type) {
 296         case OB_MENU_ENTRY_TYPE_NORMAL:
 297             g_free(self->data.normal.label);
 298             while (self->data.normal.actions) {
 299                 action_free(self->data.normal.actions->data);
 300                 self->data.normal.actions =
 301                     g_slist_delete_link(self->data.normal.actions,
 302                                         self->data.normal.actions);
 303             }
 304             break;
 305         case OB_MENU_ENTRY_TYPE_SUBMENU:
 306             g_free(self->data.submenu.name);
 307             break;
 308         case OB_MENU_ENTRY_TYPE_SEPARATOR:
 309             break;
 310         }
 311
 312         g_free(self);
 313     }
 314 }
 315
 316 void menu_clear_entries(ObMenu *self)
 317 {
 318     /* XXX assert that the menu isn't visible */
 319
 320     while (self->entries) {
 321         menu_entry_free(self->entries->data);
 322         self->entries = g_list_delete_link(self->entries, self->entries);
 323     }
 324 }
 325
 326 void menu_entry_remove(ObMenuEntry *self)
 327 {
 328     self->menu->entries = g_list_remove(self->menu->entries, self);
 329     menu_entry_free(self);
 330 }
 331
 332 ObMenuEntry* menu_add_normal(ObMenu *self, gint id, gchar *label,
 333                              GSList *actions)
 334 {
 335     ObMenuEntry *e;
 336
 337     e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_NORMAL, id);
 338     e->data.normal.label = g_strdup(label);
 339     e->data.normal.actions = actions;
 340
 341     self->entries = g_list_append(self->entries, e);
 342     return e;
 343 }
 344
 345 ObMenuEntry* menu_add_submenu(ObMenu *self, gint id, gchar *submenu)
 346 {
 347     ObMenuEntry *e;
 348
 349     e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SUBMENU, id);
 350     e->data.submenu.name = g_strdup(submenu);
 351
 352     self->entries = g_list_append(self->entries, e);
 353     return e;
 354 }
 355
 356 ObMenuEntry* menu_add_separator(ObMenu *self, gint id)
 357 {
 358     ObMenuEntry *e;
 359
 360     e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SEPARATOR, id);
 361
 362     self->entries = g_list_append(self->entries, e);
 363     return e;
 364 }
 365
 366 void menu_set_update_func(ObMenu *self, ObMenuUpdateFunc func)
 367 {
 368     self->update_func = func;
 369 }
 370
 371 void menu_set_execute_func(ObMenu *self, ObMenuExecuteFunc func)
 372 {
 373     self->execute_func = func;
 374 }
 375
 376 void menu_set_destroy_func(ObMenu *self, ObMenuDestroyFunc func)
 377 {
 378     self->destroy_func = func;
 379 }
 380
 381 ObMenuEntry* menu_find_entry_id(ObMenu *self, gint id)
 382 {
 383     ObMenuEntry *ret = NULL;
 384     GList *it;
 385
 386     for (it = self->entries; it; it = g_list_next(it)) {
 387         ObMenuEntry *e = it->data;
 388
 389         if (e->id == id) {
 390             ret = e;
 391             break;
 392         }
 393     }
 394     return ret;
 395 }
 396
 397 void menu_find_submenus(ObMenu *self)
 398 {
 399     GList *it;
 400
 401     for (it = self->entries; it; it = g_list_next(it)) {
 402         ObMenuEntry *e = it->data;
 403
 404         if (e->type == OB_MENU_ENTRY_TYPE_SUBMENU)
 405             e->data.submenu.submenu = menu_from_name(e->data.submenu.name);
 406     }
 407 }