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