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