X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=openbox%2Fmenu.c;h=b49177ba8b4473059ed05dfec7f970acecbc4d38;hb=d519deeb2e24ba27664a231c6579bee1e02b4ebb;hp=5efb0c353ded4d1499e13a612e60fa19e9f210ab;hpb=ffba11aeb059bef0b4876eb6aad2a8a24e2db6f1;p=chaz%2Fopenbox diff --git a/openbox/menu.c b/openbox/menu.c index 5efb0c35..b49177ba 100644 --- a/openbox/menu.c +++ b/openbox/menu.c @@ -1,27 +1,192 @@ +/* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*- + + menu.c for the Openbox window manager + Copyright (c) 2006 Mikael Magnusson + Copyright (c) 2003-2007 Dana Jansens + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + See the COPYING file for a copy of the GNU General Public License. +*/ + #include "debug.h" #include "menu.h" #include "openbox.h" +#include "mainloop.h" #include "stacking.h" -#include "client.h" #include "grab.h" +#include "client.h" #include "config.h" +#include "actions.h" #include "screen.h" #include "menuframe.h" +#include "keyboard.h" #include "geom.h" -#include "plugin.h" #include "misc.h" +#include "client_menu.h" +#include "client_list_menu.h" +#include "client_list_combined_menu.h" +#include "gettext.h" #include "parser/parse.h" -GHashTable *menu_hash = NULL; - typedef struct _ObMenuParseState ObMenuParseState; struct _ObMenuParseState { - GSList *menus; + ObMenu *parent; + ObMenu *pipe_creator; }; -static void menu_clear_entries_internal(ObMenu *self); +static GHashTable *menu_hash = NULL; +static ObParseInst *menu_parse_inst; +static ObMenuParseState menu_parse_state; +static gboolean menu_can_hide = FALSE; + +static void menu_destroy_hash_value(ObMenu *self); +static void parse_menu_item(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node, + gpointer data); +static void parse_menu_separator(ObParseInst *i, + xmlDocPtr doc, xmlNodePtr node, + gpointer data); +static void parse_menu(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node, + gpointer data); +static gunichar parse_shortcut(const gchar *label, gboolean allow_shortcut, + gchar **strippedlabel, guint *position, + gboolean *always_show); + + +static void client_dest(ObClient *client, gpointer data) +{ + /* menus can be associated with a client, so close any that are since + we are disappearing now */ + menu_frame_hide_all_client(client); +} + +void menu_startup(gboolean reconfig) +{ + xmlDocPtr doc; + xmlNodePtr node; + gboolean loaded = FALSE; + GSList *it; + + menu_hash = g_hash_table_new_full(g_str_hash, g_str_equal, NULL, + (GDestroyNotify)menu_destroy_hash_value); + + client_list_menu_startup(reconfig); + client_list_combined_menu_startup(reconfig); + client_menu_startup(); + + menu_parse_inst = parse_startup(); + + menu_parse_state.parent = NULL; + menu_parse_state.pipe_creator = NULL; + parse_register(menu_parse_inst, "menu", parse_menu, &menu_parse_state); + parse_register(menu_parse_inst, "item", parse_menu_item, + &menu_parse_state); + parse_register(menu_parse_inst, "separator", + parse_menu_separator, &menu_parse_state); + + for (it = config_menu_files; it; it = g_slist_next(it)) { + if (parse_load_menu(it->data, &doc, &node)) { + loaded = TRUE; + parse_tree(menu_parse_inst, doc, node->children); + xmlFreeDoc(doc); + } else + g_message(_("Unable to find a valid menu file '%s'"), + (const gchar*)it->data); + } + if (!loaded) { + if (parse_load_menu("menu.xml", &doc, &node)) { + parse_tree(menu_parse_inst, doc, node->children); + xmlFreeDoc(doc); + } else + g_message(_("Unable to find a valid menu file '%s'"), + "menu.xml"); + } + + g_assert(menu_parse_state.parent == NULL); + + if (!reconfig) + client_add_destroy_notify(client_dest, NULL); +} + +void menu_shutdown(gboolean reconfig) +{ + if (!reconfig) + client_remove_destroy_notify(client_dest); + + parse_shutdown(menu_parse_inst); + menu_parse_inst = NULL; + + client_list_menu_shutdown(reconfig); + client_list_combined_menu_shutdown(reconfig); + + menu_frame_hide_all(); + g_hash_table_destroy(menu_hash); + menu_hash = NULL; +} + +static gboolean menu_pipe_submenu(gpointer key, gpointer val, gpointer data) +{ + ObMenu *menu = val; + return menu->pipe_creator != NULL; +} + +static void clear_cache(gpointer key, gpointer val, gpointer data) +{ + ObMenu *menu = val; + if (menu->execute) + menu_clear_entries(menu); +} + +void menu_clear_pipe_caches() +{ + /* delete any pipe menus' submenus */ + g_hash_table_foreach_remove(menu_hash, menu_pipe_submenu, NULL); + /* empty the top level pipe menus */ + g_hash_table_foreach(menu_hash, clear_cache, NULL); +} + +void menu_pipe_execute(ObMenu *self) +{ + xmlDocPtr doc; + xmlNodePtr node; + gchar *output; + GError *err = NULL; + + if (!self->execute) + return; + if (self->entries) /* the entries are already created and cached */ + return; + + if (!g_spawn_command_line_sync(self->execute, &output, NULL, NULL, &err)) { + g_message(_("Failed to execute command for pipe-menu '%s': %s"), + self->execute, err->message); + g_error_free(err); + return; + } + + if (parse_load_mem(output, strlen(output), + "openbox_pipe_menu", &doc, &node)) + { + menu_parse_state.pipe_creator = self; + menu_parse_state.parent = self; + parse_tree(menu_parse_inst, doc, node->children); + xmlFreeDoc(doc); + } else { + g_message(_("Invalid output from pipe-menu '%s'"), self->execute); + } + + g_free(output); +} static ObMenu* menu_from_name(gchar *name) { @@ -30,25 +195,91 @@ static ObMenu* menu_from_name(gchar *name) g_assert(name != NULL); if (!(self = g_hash_table_lookup(menu_hash, name))) - g_warning("Attempted to access menu '%s' but it does not exist.", + g_message(_("Attempted to access menu '%s' but it does not exist"), name); return self; } +#define VALID_SHORTCUT(c) (((c) >= '0' && (c) <= '9') || \ + ((c) >= 'A' && (c) <= 'Z') || \ + ((c) >= 'a' && (c) <= 'z')) + +static gunichar parse_shortcut(const gchar *label, gboolean allow_shortcut, + gchar **strippedlabel, guint *position, + gboolean *always_show) +{ + gunichar shortcut = 0; + + *position = 0; + *always_show = FALSE; + + g_assert(strippedlabel != NULL); + + if (label == NULL) { + *strippedlabel = NULL; + } else { + gchar *i; + + *strippedlabel = g_strdup(label); + + /* if allow_shortcut is false, then you can't use the '_', instead you + have to just use the first valid character + */ + + i = strchr(*strippedlabel, '_'); + if (allow_shortcut && i != NULL) { + /* there is an underscore in the string */ + + /* you have to use a printable ascii character for shortcuts + don't allow space either, so you can have like "a _ b" + */ + if (VALID_SHORTCUT(*(i+1))) { + shortcut = g_unichar_tolower(g_utf8_get_char(i+1)); + *position = i - *strippedlabel; + *always_show = TRUE; + + /* remove the '_' from the string */ + for (; *i != '\0'; ++i) + *i = *(i+1); + } else if (*(i+1) == '\0') { + /* no default shortcut if the '_' is the last character + (eg. "Exit_") for menu entries that you don't want + to be executed by mistake + */ + *i = '\0'; + } + } else { + /* there is no underscore, so find the first valid character to use + instead */ + + for (i = *strippedlabel; *i != '\0'; ++i) + if (VALID_SHORTCUT(*i)) { + *position = i - *strippedlabel; + shortcut = g_unichar_tolower(g_utf8_get_char(i)); + break; + } + } + } + return shortcut; +} + static void parse_menu_item(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node, gpointer data) { ObMenuParseState *state = data; gchar *label; - if (state->menus) { + if (state->parent) { if (parse_attr_string("label", node, &label)) { GSList *acts = NULL; - for (node = node->xmlChildrenNode; node; node = node->next) - if (!xmlStrcasecmp(node->name, (const xmlChar*) "action")) - acts = g_slist_append(acts, action_parse(doc, node)); - menu_add_normal(state->menus->data, 0, label, acts); + for (node = node->children; node; node = node->next) + if (!xmlStrcasecmp(node->name, (const xmlChar*) "action")) { + ObActionsAct *a = actions_parse(i, doc, node); + if (a) + acts = g_slist_append(acts, a); + } + menu_add_normal(state->parent, -1, label, acts, TRUE); g_free(label); } } @@ -60,147 +291,190 @@ static void parse_menu_separator(ObParseInst *i, { ObMenuParseState *state = data; - if (state->menus) - menu_add_separator(state->menus->data, 0); + if (state->parent) { + gchar *label; + + if (!parse_attr_string("label", node, &label)) + label = NULL; + + menu_add_separator(state->parent, -1, label); + g_free(label); + } } static void parse_menu(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node, gpointer data) { ObMenuParseState *state = data; - gchar *name = NULL, *title = NULL, *plugin = NULL; + gchar *name = NULL, *title = NULL, *script = NULL; + ObMenu *menu; if (!parse_attr_string("id", node, &name)) goto parse_menu_fail; if (!g_hash_table_lookup(menu_hash, name)) { - if (parse_attr_string("plugin", node, &plugin)) { - if (!plugin_open(plugin, i)) - goto parse_menu_fail; - plugin_start(plugin); - if (!g_hash_table_lookup(menu_hash, name)) - g_warning("Specified plugin '%s' did not provide the " - "menu '%s'", plugin, name); - goto parse_menu_fail; - } else { - if (!parse_attr_string("label", node, &title)) - goto parse_menu_fail; - - if (menu_new(name, title, NULL)) { - state->menus = g_slist_prepend(state->menus, name); - parse_tree(i, doc, node->xmlChildrenNode); - state->menus = g_slist_delete_link(state->menus, state->menus); + if (!parse_attr_string("label", node, &title)) + goto parse_menu_fail; + + if ((menu = menu_new(name, title, TRUE, NULL))) { + menu->pipe_creator = state->pipe_creator; + if (parse_attr_string("execute", node, &script)) { + menu->execute = parse_expand_tilde(script); + } else { + ObMenu *old; + + old = state->parent; + state->parent = menu; + parse_tree(i, doc, node->children); + state->parent = old; } } } - if (state->menus) - menu_add_submenu(state->menus->data, 0, name); + if (state->parent) + menu_add_submenu(state->parent, -1, name); parse_menu_fail: g_free(name); g_free(title); - g_free(plugin); + g_free(script); } - -void menu_destroy_hash_value(ObMenu *self) +ObMenu* menu_new(const gchar *name, const gchar *title, + gboolean allow_shortcut_selection, gpointer data) { - /* XXX make sure its not visible */ - menu_clear_entries_internal(self); - g_free(self->name); - g_free(self->title); -} + ObMenu *self; -void menu_startup(ObParseInst *i) -{ - menu_hash = g_hash_table_new_full(g_str_hash, g_str_equal, NULL, - (GDestroyNotify)menu_destroy_hash_value); -} + self = g_new0(ObMenu, 1); + self->name = g_strdup(name); + self->data = data; -void menu_shutdown() -{ - menu_frame_hide_all(); - g_hash_table_destroy(menu_hash); - menu_hash = NULL; -} + self->shortcut = parse_shortcut(title, allow_shortcut_selection, + &self->title, &self->shortcut_position, + &self->shortcut_always_show); -void menu_parse() -{ - ObParseInst *i; - ObMenuParseState parse_state; - xmlDocPtr doc; - xmlNodePtr node; - gchar *p; - gboolean loaded = FALSE; + g_hash_table_replace(menu_hash, self->name, self); - i = parse_startup(); + /* Each menu has a single more_menu. When the menu spills past what + can fit on the screen, a new menu frame entry is created from this + more_menu, and a new menu frame for the submenu is created for this + menu, also pointing to the more_menu. - if (config_menu_path) - if (!(loaded = - parse_load(config_menu_path, "openbox_menu", &doc, &node))) - g_warning("Failed to load menu from '%s'", config_menu_path); - if (!loaded) { - p = g_build_filename(g_get_home_dir(), ".openbox", "menu", NULL); - if (!(loaded = - parse_load(p, "openbox_menu", &doc, &node))) - g_warning("Failed to load menu from '%s'", p); - g_free(p); - } - if (!loaded) { - p = g_build_filename(RCDIR, "menu", NULL); - if (!(loaded = - parse_load(p, "openbox_menu", &doc, &node))) - g_warning("Failed to load menu from '%s'", p); - g_free(p); - } + This can be done multiple times using the same more_menu. - if (loaded) { - parse_state.menus = NULL; + more_menu->more_menu will always be NULL, since there is only 1 for + each menu. */ + self->more_menu = g_new0(ObMenu, 1); + self->more_menu->name = _("More..."); + self->more_menu->title = _("More..."); + self->more_menu->data = data; + self->more_menu->shortcut = g_unichar_tolower(g_utf8_get_char("M")); - parse_register(i, "menu", parse_menu, &parse_state); - parse_register(i, "item", parse_menu_item, &parse_state); - parse_register(i, "separator", parse_menu_separator, &parse_state); - parse_tree(i, doc, node->xmlChildrenNode); - } + self->more_menu->show_func = self->show_func; + self->more_menu->hide_func = self->hide_func; + self->more_menu->update_func = self->update_func; + self->more_menu->execute_func = self->execute_func; + self->more_menu->destroy_func = self->destroy_func; + self->more_menu->place_func = self->place_func; - parse_shutdown(i); + return self; } -gboolean menu_new(gchar *name, gchar *title, gpointer data) +static void menu_destroy_hash_value(ObMenu *self) { - ObMenu *self; + /* make sure its not visible */ + { + GList *it; + ObMenuFrame *f; + + for (it = menu_frame_visible; it; it = g_list_next(it)) { + f = it->data; + if (f->menu == self) + menu_frame_hide_all(); + } + } - if (g_hash_table_lookup(menu_hash, name)) return FALSE; + if (self->destroy_func) + self->destroy_func(self, self->data); - self = g_new0(ObMenu, 1); - self->name = g_strdup(name); - self->title = g_strdup(title); - self->data = data; + menu_clear_entries(self); + g_free(self->name); + g_free(self->title); + g_free(self->execute); + g_free(self->more_menu); - g_hash_table_insert(menu_hash, self->name, self); + g_free(self); +} - return TRUE; +void menu_free(ObMenu *menu) +{ + if (menu) + g_hash_table_remove(menu_hash, menu->name); } -void menu_free(gchar *name) +static gboolean menu_hide_delay_func(gpointer data) { - ObMenu *self; - - if (!(self = menu_from_name(name))) return; - g_hash_table_remove(menu_hash, self->name); + menu_can_hide = TRUE; + return FALSE; /* no repeat */ } -void menu_show(gchar *name, gint x, gint y, ObClient *client) +void menu_show(gchar *name, gint x, gint y, gboolean mouse, ObClient *client) { ObMenu *self; ObMenuFrame *frame; - if (!(self = menu_from_name(name))) return; + if (!(self = menu_from_name(name)) || + grab_on_keyboard() || grab_on_pointer()) return; + + /* if the requested menu is already the top visible menu, then don't + bother */ + if (menu_frame_visible) { + frame = menu_frame_visible->data; + if (frame->menu == self) + return; + } + + menu_frame_hide_all(); + + /* clear the pipe menus when showing a new menu */ + menu_clear_pipe_caches(); + + frame = menu_frame_new(self, 0, client); + if (!menu_frame_show_topmenu(frame, x, y, mouse)) + menu_frame_free(frame); + else { + if (!mouse) { + /* select the first entry if it's not a submenu and we opened + * the menu with the keyboard, and skip all headers */ + GList *it = frame->entries; + while (it) { + ObMenuEntryFrame *e = it->data; + if (e->entry->type == OB_MENU_ENTRY_TYPE_NORMAL) { + menu_frame_select(frame, e, FALSE); + break; + } else if (e->entry->type == OB_MENU_ENTRY_TYPE_SEPARATOR) + it = g_list_next(it); + else + break; + } + } + + /* reset the hide timer */ + if (!mouse) + menu_can_hide = TRUE; + else { + menu_can_hide = FALSE; + ob_main_loop_timeout_add(ob_main_loop, + config_menu_hide_delay * 1000, + menu_hide_delay_func, + NULL, g_direct_equal, NULL); + } + } +} - frame = menu_frame_new(self, client); - menu_frame_move(frame, x, y); - menu_frame_show(frame, NULL); +gboolean menu_hide_delay_reached() +{ + return menu_can_hide; } static ObMenuEntry* menu_entry_new(ObMenu *menu, ObMenuEntryType type, gint id) @@ -210,6 +484,7 @@ static ObMenuEntry* menu_entry_new(ObMenu *menu, ObMenuEntryType type, gint id) g_assert(menu); self = g_new0(ObMenuEntry, 1); + self->ref = 1; self->type = type; self->menu = menu; self->id = id; @@ -226,20 +501,27 @@ static ObMenuEntry* menu_entry_new(ObMenu *menu, ObMenuEntryType type, gint id) return self; } -static void menu_entry_free(ObMenuEntry *self) +void menu_entry_ref(ObMenuEntry *self) +{ + ++self->ref; +} + +void menu_entry_unref(ObMenuEntry *self) { - if (self) { + if (self && --self->ref == 0) { switch (self->type) { case OB_MENU_ENTRY_TYPE_NORMAL: g_free(self->data.normal.label); while (self->data.normal.actions) { - action_free(self->data.normal.actions->data); + actions_act_unref(self->data.normal.actions->data); self->data.normal.actions = g_slist_delete_link(self->data.normal.actions, self->data.normal.actions); } break; case OB_MENU_ENTRY_TYPE_SUBMENU: + g_free(self->data.submenu.name); + break; case OB_MENU_ENTRY_TYPE_SEPARATOR: break; } @@ -248,71 +530,119 @@ static void menu_entry_free(ObMenuEntry *self) } } -void menu_clear_entries(gchar *name) +void menu_clear_entries(ObMenu *self) { - ObMenu *self; - - if (!(self = menu_from_name(name))) return; - - menu_clear_entries_internal(self); -} - -static void menu_clear_entries_internal(ObMenu *self) -{ - /* XXX assert that the menu isn't visible */ +#ifdef DEBUG + /* assert that the menu isn't visible */ + { + GList *it; + ObMenuFrame *f; + + for (it = menu_frame_visible; it; it = g_list_next(it)) { + f = it->data; + g_assert(f->menu != self); + } + } +#endif while (self->entries) { - menu_entry_free(self->entries->data); + menu_entry_unref(self->entries->data); self->entries = g_list_delete_link(self->entries, self->entries); } + self->more_menu->entries = self->entries; /* keep it in sync */ } -void menu_add_normal(gchar *name, gint id, gchar *label, GSList *actions) +void menu_entry_remove(ObMenuEntry *self) { - ObMenu *self; - ObMenuEntry *e; + self->menu->entries = g_list_remove(self->menu->entries, self); + menu_entry_unref(self); +} - if (!(self = menu_from_name(name))) return; +ObMenuEntry* menu_add_normal(ObMenu *self, gint id, const gchar *label, + GSList *actions, gboolean allow_shortcut) +{ + ObMenuEntry *e; e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_NORMAL, id); - e->data.normal.label = g_strdup(label); e->data.normal.actions = actions; + menu_entry_set_label(e, label, allow_shortcut); + self->entries = g_list_append(self->entries, e); + self->more_menu->entries = self->entries; /* keep it in sync */ + return e; } -void menu_add_submenu(gchar *name, gint id, gchar *submenu) +ObMenuEntry* menu_get_more(ObMenu *self, guint show_from) { - ObMenu *self, *sub; ObMenuEntry *e; + e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SUBMENU, -1); + /* points to itself */ + e->data.submenu.name = g_strdup(self->name); + e->data.submenu.submenu = self; + e->data.submenu.show_from = show_from; + return e; +} - if (!(self = menu_from_name(name))) return; - if (!(sub = menu_from_name(submenu))) return; +ObMenuEntry* menu_add_submenu(ObMenu *self, gint id, const gchar *submenu) +{ + ObMenuEntry *e; e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SUBMENU, id); - e->data.submenu.submenu = sub; + e->data.submenu.name = g_strdup(submenu); self->entries = g_list_append(self->entries, e); + self->more_menu->entries = self->entries; /* keep it in sync */ + return e; } -void menu_add_separator(gchar *name, gint id) +ObMenuEntry* menu_add_separator(ObMenu *self, gint id, const gchar *label) { - ObMenu *self; ObMenuEntry *e; - if (!(self = menu_from_name(name))) return; - e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SEPARATOR, id); + menu_entry_set_label(e, label, FALSE); + self->entries = g_list_append(self->entries, e); + self->more_menu->entries = self->entries; /* keep it in sync */ + return e; } -void menu_set_update_func(gchar *name, ObMenuUpdateFunc func) +void menu_set_show_func(ObMenu *self, ObMenuShowFunc func) { - ObMenu *self; + self->show_func = func; + self->more_menu->show_func = func; /* keep it in sync */ +} - if (!(self = menu_from_name(name))) return; +void menu_set_hide_func(ObMenu *self, ObMenuHideFunc func) +{ + self->hide_func = func; + self->more_menu->hide_func = func; /* keep it in sync */ +} + +void menu_set_update_func(ObMenu *self, ObMenuUpdateFunc func) +{ self->update_func = func; + self->more_menu->update_func = func; /* keep it in sync */ +} + +void menu_set_execute_func(ObMenu *self, ObMenuExecuteFunc func) +{ + self->execute_func = func; + self->more_menu->execute_func = func; /* keep it in sync */ +} + +void menu_set_destroy_func(ObMenu *self, ObMenuDestroyFunc func) +{ + self->destroy_func = func; + self->more_menu->destroy_func = func; /* keep it in sync */ +} + +void menu_set_place_func(ObMenu *self, ObMenuPlaceFunc func) +{ + self->place_func = func; + self->more_menu->place_func = func; /* keep it in sync */ } ObMenuEntry* menu_find_entry_id(ObMenu *self, gint id) @@ -330,3 +660,40 @@ ObMenuEntry* menu_find_entry_id(ObMenu *self, gint id) } return ret; } + +void menu_find_submenus(ObMenu *self) +{ + GList *it; + + for (it = self->entries; it; it = g_list_next(it)) { + ObMenuEntry *e = it->data; + + if (e->type == OB_MENU_ENTRY_TYPE_SUBMENU) + e->data.submenu.submenu = menu_from_name(e->data.submenu.name); + } +} + +void menu_entry_set_label(ObMenuEntry *self, const gchar *label, + gboolean allow_shortcut) +{ + switch (self->type) { + case OB_MENU_ENTRY_TYPE_SEPARATOR: + g_free(self->data.separator.label); + self->data.separator.label = g_strdup(label); + break; + case OB_MENU_ENTRY_TYPE_NORMAL: + g_free(self->data.normal.label); + self->data.normal.shortcut = + parse_shortcut(label, allow_shortcut, &self->data.normal.label, + &self->data.normal.shortcut_position, + &self->data.normal.shortcut_always_show); + break; + default: + g_assert_not_reached(); + } +} + +void menu_show_all_shortcuts(ObMenu *self, gboolean show) +{ + self->show_all_shortcuts = show; +}