X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=openbox%2Fmenu.c;h=374aeec1fc59a7b951acaf8e7bfa5fb3709318d8;hb=fd77a0a7b3f892925f203287b8b46c6ec9be94ea;hp=7197868b79c76230fd335813b57bc20f5b43854a;hpb=9aa42c2ae7b457db6efc1703dd47d1e3ac5e75e8;p=chaz%2Fopenbox diff --git a/openbox/menu.c b/openbox/menu.c index 7197868b..374aeec1 100644 --- a/openbox/menu.c +++ b/openbox/menu.c @@ -21,8 +21,10 @@ #include "menu.h" #include "openbox.h" #include "stacking.h" +#include "grab.h" #include "client.h" #include "config.h" +#include "actions.h" #include "screen.h" #include "menuframe.h" #include "keyboard.h" @@ -32,7 +34,8 @@ #include "client_list_menu.h" #include "client_list_combined_menu.h" #include "gettext.h" -#include "parser/parse.h" +#include "obt/xml.h" +#include "obt/paths.h" typedef struct _ObMenuParseState ObMenuParseState; @@ -43,32 +46,20 @@ struct _ObMenuParseState }; static GHashTable *menu_hash = NULL; -static ObParseInst *menu_parse_inst; +static ObtXmlInst *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 void parse_menu_item(xmlNodePtr node, gpointer data); +static void parse_menu_separator(xmlNodePtr node, gpointer data); +static void parse_menu(xmlNodePtr node, gpointer data); static gunichar parse_shortcut(const gchar *label, gboolean allow_shortcut, - gchar **strippedlabel, guint *position); - - -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); -} + gchar **strippedlabel, guint *position, + gboolean *always_show); void menu_startup(gboolean reconfig) { - xmlDocPtr doc; - xmlNodePtr node; gboolean loaded = FALSE; GSList *it; @@ -79,46 +70,48 @@ void menu_startup(gboolean reconfig) client_list_combined_menu_startup(reconfig); client_menu_startup(); - menu_parse_inst = parse_startup(); + menu_parse_inst = obt_xml_instance_new(); 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); + obt_xml_register(menu_parse_inst, "menu", parse_menu, &menu_parse_state); + obt_xml_register(menu_parse_inst, "item", parse_menu_item, + &menu_parse_state); + obt_xml_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)) { + if (obt_xml_load_config_file(menu_parse_inst, + "openbox", + it->data, + "openbox_menu")) + { loaded = TRUE; - parse_tree(menu_parse_inst, doc, node->children); - xmlFreeDoc(doc); + obt_xml_tree_from_root(menu_parse_inst); + obt_xml_close(menu_parse_inst); } else - g_message(_("Unable to find a valid menu file '%s'"), + 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); + if (obt_xml_load_config_file(menu_parse_inst, + "openbox", + "menu.xml", + "openbox_menu")) + { + obt_xml_tree_from_root(menu_parse_inst); + obt_xml_close(menu_parse_inst); } else - g_message(_("Unable to find a valid menu file '%s'"), + g_message(_("Unable to find a valid menu file \"%s\""), "menu.xml"); } - - g_assert(menu_parse_state.parent == NULL); - if (!reconfig) - client_add_destructor(client_dest, NULL); + g_assert(menu_parse_state.parent == NULL); } void menu_shutdown(gboolean reconfig) { - if (!reconfig) - client_remove_destructor(client_dest); - - parse_shutdown(menu_parse_inst); + obt_xml_instance_unref(menu_parse_inst); menu_parse_inst = NULL; client_list_menu_shutdown(reconfig); @@ -132,38 +125,50 @@ void menu_shutdown(gboolean reconfig) static gboolean menu_pipe_submenu(gpointer key, gpointer val, gpointer data) { ObMenu *menu = val; - return menu->pipe_creator == data; + 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(void) +{ + /* 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"), + 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)) + if (obt_xml_load_mem(menu_parse_inst, output, strlen(output), + "openbox_pipe_menu")) { - g_hash_table_foreach_remove(menu_hash, menu_pipe_submenu, self); - menu_clear_entries(self); - menu_parse_state.pipe_creator = self; menu_parse_state.parent = self; - parse_tree(menu_parse_inst, doc, node->children); - xmlFreeDoc(doc); + obt_xml_tree_from_root(menu_parse_inst); + obt_xml_close(menu_parse_inst); } else { - g_message(_("Invalid output from pipe-menu '%s'"), self->execute); + g_message(_("Invalid output from pipe-menu \"%s\""), self->execute); } g_free(output); @@ -176,21 +181,23 @@ static ObMenu* menu_from_name(gchar *name) g_assert(name != NULL); if (!(self = g_hash_table_lookup(menu_hash, name))) - g_message(_("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) + gchar **strippedlabel, guint *position, + gboolean *always_show) { gunichar shortcut = 0; - + *position = 0; + *always_show = FALSE; g_assert(strippedlabel != NULL); @@ -198,30 +205,54 @@ static gunichar parse_shortcut(const gchar *label, gboolean allow_shortcut, *strippedlabel = NULL; } else { gchar *i; + gboolean escape; *strippedlabel = g_strdup(label); - /* if allow_shortcut is false, then you can't use the &, instead you + /* if allow_shortcut is false, then you can't use the '_', instead you have to just use the first valid character */ - i = strchr(*strippedlabel, '&'); + /* allow __ to escape an underscore */ + i = *strippedlabel; + do { + escape = FALSE; + i = strchr(i, '_'); + if (i && *(i+1) == '_') { + gchar *j; + + /* remove the escape '_' from the string */ + for (j = i; *j != '\0'; ++j) + *j = *(j+1); + + ++i; + escape = TRUE; + } + } while (escape); + if (allow_shortcut && i != NULL) { - /* there is an ampersand in the string */ + /* 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" + 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 */ + /* 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 ampersand, so find the first valid character to use + /* there is no underscore, so find the first valid character to use instead */ for (i = *strippedlabel; *i != '\0'; ++i) @@ -235,39 +266,65 @@ static gunichar parse_shortcut(const gchar *label, gboolean allow_shortcut, return shortcut; } -static void parse_menu_item(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node, - gpointer data) +static void parse_menu_item(xmlNodePtr node, gpointer data) { ObMenuParseState *state = data; gchar *label; - + gchar *icon; + ObMenuEntry *e; + if (state->parent) { - if (parse_attr_string("label", node, &label)) { + /* Don't try to extract "icon" attribute if icons in user-defined + menus are not enabled. */ + + if (obt_xml_attr_string(node, "label", &label)) { + xmlNodePtr c; GSList *acts = NULL; - for (node = node->children; node; node = node->next) - if (!xmlStrcasecmp(node->name, (const xmlChar*) "action")) { - ObAction *a = action_parse - (i, doc, node, OB_USER_ACTION_MENU_SELECTION); - if (a) - acts = g_slist_append(acts, a); + c = obt_xml_find_node(node->children, "action"); + while (c) { + ObActionsAct *action = actions_parse(c); + if (action) + acts = g_slist_append(acts, action); + c = obt_xml_find_node(node->next, "action"); + } + e = menu_add_normal(state->parent, -1, label, acts, TRUE); + + if (config_menu_show_icons && + obt_xml_attr_string(node, "icon", &icon)) + { + RrImage *ic; + + ic = RrImageCacheFindName(ob_rr_icons, icon); + if (ic) + RrImageRef(ic); + else { + ic = RrImageNew(ob_rr_icons); + if (!RrImageAddPictureName(ic, icon)) { + RrImageUnref(ic); /* no need to keep it around */ + ic = NULL; + } } - menu_add_normal(state->parent, -1, label, acts, FALSE); + e->data.normal.icon = ic; + + if (e->data.normal.icon) + e->data.normal.icon_alpha = 0xff; + + g_free(icon); + } g_free(label); } } } -static void parse_menu_separator(ObParseInst *i, - xmlDocPtr doc, xmlNodePtr node, - gpointer data) +static void parse_menu_separator(xmlNodePtr node, gpointer data) { ObMenuParseState *state = data; if (state->parent) { gchar *label; - if (!parse_attr_string("label", node, &label)) + if (!obt_xml_attr_string(node, "label", &label)) label = NULL; menu_add_separator(state->parent, -1, label); @@ -275,30 +332,29 @@ static void parse_menu_separator(ObParseInst *i, } } -static void parse_menu(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node, - gpointer data) +static void parse_menu(xmlNodePtr node, gpointer data) { ObMenuParseState *state = data; gchar *name = NULL, *title = NULL, *script = NULL; ObMenu *menu; - if (!parse_attr_string("id", node, &name)) + if (!obt_xml_attr_string(node, "id", &name)) goto parse_menu_fail; if (!g_hash_table_lookup(menu_hash, name)) { - if (!parse_attr_string("label", node, &title)) + if (!obt_xml_attr_string(node, "label", &title)) goto parse_menu_fail; - if ((menu = menu_new(name, title, FALSE, NULL))) { + 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); + if (obt_xml_attr_string(node, "execute", &script)) { + menu->execute = obt_paths_expand_tilde(script); } else { ObMenu *old; old = state->parent; state->parent = menu; - parse_tree(i, doc, node->children); + obt_xml_tree(menu_parse_inst, node->children); state->parent = old; } } @@ -314,19 +370,35 @@ parse_menu_fail: } ObMenu* menu_new(const gchar *name, const gchar *title, - gboolean allow_shortcut, gpointer data) + gboolean allow_shortcut_selection, gpointer data) { ObMenu *self; - self = g_new0(ObMenu, 1); + self = g_slice_new0(ObMenu); self->name = g_strdup(name); self->data = data; - self->shortcut = parse_shortcut(title, allow_shortcut, &self->title, - &self->shortcut_position); + self->shortcut = parse_shortcut(title, allow_shortcut_selection, + &self->title, &self->shortcut_position, + &self->shortcut_always_show); g_hash_table_replace(menu_hash, self->name, self); + /* 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. + + This can be done multiple times using the same more_menu. + + more_menu->more_menu will always be NULL, since there is only 1 for + each menu. */ + self->more_menu = g_slice_new0(ObMenu); + 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")); + return self; } @@ -351,22 +423,30 @@ static void menu_destroy_hash_value(ObMenu *self) g_free(self->name); g_free(self->title); g_free(self->execute); + g_slice_free(ObMenu, self->more_menu); - g_free(self); + g_slice_free(ObMenu, self); } void menu_free(ObMenu *menu) { - g_hash_table_remove(menu_hash, menu->name); + if (menu) + g_hash_table_remove(menu_hash, menu->name); } -void menu_show(gchar *name, gint x, gint y, ObClient *client) +static gboolean menu_hide_delay_func(gpointer data) +{ + menu_can_hide = TRUE; + return FALSE; /* no repeat */ +} + +void menu_show(gchar *name, gint x, gint y, gboolean mouse, ObClient *client) { ObMenu *self; ObMenuFrame *frame; - if (!(self = menu_from_name(name)) - || keyboard_interactively_grabbed()) 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 */ @@ -378,24 +458,55 @@ void menu_show(gchar *name, gint x, gint y, ObClient *client) menu_frame_hide_all(); - frame = menu_frame_new(self, client); - if (!menu_frame_show_topmenu(frame, x, y)) + /* 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 (frame->entries) { - ObMenuEntryFrame *e = frame->entries->data; - if (e->entry->type == OB_MENU_ENTRY_TYPE_NORMAL && - e->entry->data.normal.enabled) - menu_frame_select(frame, e, FALSE); + 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; + g_timeout_add_full(G_PRIORITY_DEFAULT, + config_menu_hide_delay, + menu_hide_delay_func, + NULL, NULL); + } } } +gboolean menu_hide_delay_reached(void) +{ + return menu_can_hide; +} + static ObMenuEntry* menu_entry_new(ObMenu *menu, ObMenuEntryType type, gint id) { ObMenuEntry *self; g_assert(menu); - self = g_new0(ObMenuEntry, 1); + self = g_slice_new0(ObMenuEntry); + self->ref = 1; self->type = type; self->menu = menu; self->id = id; @@ -412,14 +523,20 @@ static ObMenuEntry* menu_entry_new(ObMenu *menu, ObMenuEntryType type, gint id) return self; } -void menu_entry_free(ObMenuEntry *self) +void menu_entry_ref(ObMenuEntry *self) { - if (self) { + ++self->ref; +} + +void menu_entry_unref(ObMenuEntry *self) +{ + if (self && --self->ref == 0) { switch (self->type) { case OB_MENU_ENTRY_TYPE_NORMAL: + RrImageUnref(self->data.normal.icon); g_free(self->data.normal.label); while (self->data.normal.actions) { - action_unref(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); @@ -429,10 +546,11 @@ void menu_entry_free(ObMenuEntry *self) g_free(self->data.submenu.name); break; case OB_MENU_ENTRY_TYPE_SEPARATOR: + g_free(self->data.separator.label); break; } - g_free(self); + g_slice_free(ObMenuEntry, self); } } @@ -452,15 +570,16 @@ void menu_clear_entries(ObMenu *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_entry_remove(ObMenuEntry *self) { self->menu->entries = g_list_remove(self->menu->entries, self); - menu_entry_free(self); + menu_entry_unref(self); } ObMenuEntry* menu_add_normal(ObMenu *self, gint id, const gchar *label, @@ -474,6 +593,18 @@ ObMenuEntry* menu_add_normal(ObMenu *self, gint id, const gchar *label, 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; +} + +ObMenuEntry* menu_get_more(ObMenu *self, guint show_from) +{ + 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; } @@ -485,6 +616,7 @@ ObMenuEntry* menu_add_submenu(ObMenu *self, gint id, const gchar *submenu) 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; } @@ -497,9 +629,20 @@ ObMenuEntry* menu_add_separator(ObMenu *self, gint id, const gchar *label) 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_show_func(ObMenu *self, ObMenuShowFunc func) +{ + self->show_func = func; +} + +void menu_set_hide_func(ObMenu *self, ObMenuHideFunc func) +{ + self->hide_func = func; +} + void menu_set_update_func(ObMenu *self, ObMenuUpdateFunc func) { self->update_func = func; @@ -508,6 +651,12 @@ void menu_set_update_func(ObMenu *self, ObMenuUpdateFunc func) 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_cleanup_func(ObMenu *self, ObMenuCleanupFunc func) +{ + self->cleanup_func = func; } void menu_set_destroy_func(ObMenu *self, ObMenuDestroyFunc func) @@ -515,6 +664,11 @@ void menu_set_destroy_func(ObMenu *self, ObMenuDestroyFunc func) self->destroy_func = func; } +void menu_set_place_func(ObMenu *self, ObMenuPlaceFunc func) +{ + self->place_func = func; +} + ObMenuEntry* menu_find_entry_id(ObMenu *self, gint id) { ObMenuEntry *ret = NULL; @@ -555,7 +709,8 @@ void menu_entry_set_label(ObMenuEntry *self, const gchar *label, 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_position, + &self->data.normal.shortcut_always_show); break; default: g_assert_not_reached();