-#include <glib.h>
+/* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
+
+ menu.c for the Openbox window manager
+ Copyright (c) 2003 Ben 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 <assert.h>
+#include "openbox.h"
+#include "stacking.h"
+#include "client.h"
+#include "config.h"
+#include "screen.h"
+#include "menuframe.h"
+#include "geom.h"
+#include "misc.h"
+#include "client_menu.h"
+#include "client_list_menu.h"
+#include "parser/parse.h"
+
+typedef struct _ObMenuParseState ObMenuParseState;
-GHashTable *menu_hash = NULL;
+struct _ObMenuParseState
+{
+ ObMenu *parent;
+ ObMenu *pipe_creator;
+};
+
+static GHashTable *menu_hash = NULL;
+static ObParseInst *menu_parse_inst;
+static ObMenuParseState menu_parse_state;
+
+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);
-void menu_destroy_hash_key(const gpointer data)
+static void client_dest(gpointer client)
{
- g_free(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_free_entries(const Menu *menu)
+void menu_startup(gboolean reconfig)
{
- GList *it;
+ 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();
+ client_menu_startup();
- for (it = menu->entries; it; it = it->next)
- menu_entry_free((MenuEntry *)it->data);
+ menu_parse_inst = parse_startup();
- g_list_free(menu->entries);
+ 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);
+ }
+ }
+ if (!loaded) {
+ if (parse_load_menu("menu.xml", &doc, &node)) {
+ parse_tree(menu_parse_inst, doc, node->children);
+ xmlFreeDoc(doc);
+ }
+ }
+
+ g_assert(menu_parse_state.parent == NULL);
+
+ if (!reconfig)
+ client_add_destructor(client_dest);
}
-void menu_destroy_hash_value(const gpointer data)
+void menu_shutdown(gboolean reconfig)
{
- const Menu *del_menu = (Menu *)data;
+ if (!reconfig)
+ client_remove_destructor(client_dest);
- g_free(del_menu->label);
- g_free(del_menu->name);
+ parse_shutdown(menu_parse_inst);
+ menu_parse_inst = NULL;
+
+ menu_frame_hide_all();
+ g_hash_table_destroy(menu_hash);
+ menu_hash = NULL;
+}
- menu_free_entries(del_menu);
+static gboolean menu_pipe_submenu(gpointer key, gpointer val, gpointer data)
+{
+ ObMenu *menu = val;
+ return menu->pipe_creator == data;
}
-void menu_entry_free(const MenuEntry *entry)
+void menu_pipe_execute(ObMenu *self)
{
- g_free(entry->label);
- g_free(entry->render_data);
+ xmlDocPtr doc;
+ xmlNodePtr node;
+ gchar *output;
+ GError *err = NULL;
+
+ if (!self->execute)
+ return;
+
+ if (!g_spawn_command_line_sync(self->execute, &output, NULL, NULL, &err)) {
+ g_warning("Failed to execute command for pipe-menu: %s", err->message);
+ g_error_free(err);
+ return;
+ }
+
+ if (parse_load_mem(output, strlen(output),
+ "openbox_pipe_menu", &doc, &node))
+ {
+ 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);
+ } else {
+ g_warning("Invalid output from pipe-menu: %s", self->execute);
+ }
+
+ g_free(output);
}
+
+static ObMenu* menu_from_name(gchar *name)
+{
+ ObMenu *self = NULL;
+
+ 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.",
+ name);
+ return self;
+}
+
+static void parse_menu_item(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
+ gpointer data)
+{
+ ObMenuParseState *state = data;
+ gchar *label;
-void menu_startup()
+ if (state->parent) {
+ if (parse_attr_string("label", node, &label)) {
+ GSList *acts = NULL;
+
+ for (node = node->children; node; node = node->next)
+ if (!xmlStrcasecmp(node->name, (const xmlChar*) "action"))
+ acts = g_slist_append(acts, action_parse
+ (i, doc, node,
+ OB_USER_ACTION_MENU_SELECTION));
+ menu_add_normal(state->parent, -1, label, acts);
+ g_free(label);
+ }
+ }
+}
+
+static void parse_menu_separator(ObParseInst *i,
+ xmlDocPtr doc, xmlNodePtr node,
+ gpointer data)
{
- menu_hash = g_hash_table_new_full(g_str_hash, g_str_equal,
- menu_destroy_hash_key,
- menu_destroy_hash_value);
+ ObMenuParseState *state = data;
+
+ if (state->parent)
+ menu_add_separator(state->parent, -1);
}
-void menu_shutdown()
+static void parse_menu(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
+ gpointer data)
{
- g_hash_table_destroy(menu_hash);
+ ObMenuParseState *state = data;
+ 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("label", node, &title))
+ goto parse_menu_fail;
+
+ if ((menu = menu_new(name, title, 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->parent)
+ menu_add_submenu(state->parent, -1, name);
+
+parse_menu_fail:
+ g_free(name);
+ g_free(title);
+ g_free(script);
+}
+
+ObMenu* menu_new(gchar *name, gchar *title, gpointer data)
+{
+ ObMenu *self;
+
+ self = g_new0(ObMenu, 1);
+ self->name = g_strdup(name);
+ self->title = g_strdup(title);
+ self->data = data;
+
+ g_hash_table_replace(menu_hash, self->name, self);
+
+ return self;
+}
+
+static void menu_destroy_hash_value(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 (self->destroy_func)
+ self->destroy_func(self, self->data);
+
+ menu_clear_entries(self);
+ g_free(self->name);
+ g_free(self->title);
+ g_free(self->execute);
+
+ g_free(self);
+}
+
+void menu_free(ObMenu *menu)
+{
+ g_hash_table_remove(menu_hash, menu->name);
+}
+
+void menu_show(gchar *name, gint x, gint y, ObClient *client)
+{
+ ObMenu *self;
+ ObMenuFrame *frame;
+
+ if (!(self = menu_from_name(name))) return;
+
+ menu_frame_hide_all();
+
+ frame = menu_frame_new(self, client);
+ menu_frame_move(frame, x, y);
+ menu_frame_show(frame, NULL);
+ if (frame->entries)
+ menu_frame_select_next(frame);
}
-Menu *menu_new(const char *label, const char *name, Menu *parent)
+static ObMenuEntry* menu_entry_new(ObMenu *menu, ObMenuEntryType type, gint id)
{
- Menu *new_menu = g_new0(Menu, 1);
- new_menu->label = g_strdup(label);
- new_menu->name = g_strdup(name);
- new_menu->parent = parent;
+ ObMenuEntry *self;
- new_menu->entries = NULL;
- new_menu->shown = FALSE;
- new_menu->invalid = FALSE;
- /* default controllers? */
+ g_assert(menu);
- g_hash_table_insert(menu_hash, g_strdup(name), new_menu);
- return new_menu;
+ self = g_new0(ObMenuEntry, 1);
+ self->type = type;
+ self->menu = menu;
+ self->id = id;
+
+ switch (type) {
+ case OB_MENU_ENTRY_TYPE_NORMAL:
+ self->data.normal.enabled = TRUE;
+ break;
+ case OB_MENU_ENTRY_TYPE_SUBMENU:
+ case OB_MENU_ENTRY_TYPE_SEPARATOR:
+ break;
+ }
+
+ return self;
}
-void menu_free(const char *name)
+void menu_entry_free(ObMenuEntry *self)
{
- g_hash_table_remove(menu_hash, name);
+ if (self) {
+ 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);
+ 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;
+ }
+
+ g_free(self);
+ }
}
-MenuEntry *menu_entry_new_full(const char *label, Action *action,
- const MenuEntryRenderType render_type,
- gpointer render_data, gpointer submenu)
+void menu_clear_entries(ObMenu *self)
{
- MenuEntry *menu_entry = g_new(MenuEntry, 1);
+#ifdef DEBUG
+ /* assert that the menu isn't visible */
+ {
+ GList *it;
+ ObMenuFrame *f;
- menu_entry->label = g_strdup(label);
- menu_entry->render_type = render_type;
- menu_entry->action.func = action->func;
- menu_entry->action.data = action->data; //watch out. copying Client * ptr
+ for (it = menu_frame_visible; it; it = g_list_next(it)) {
+ f = it->data;
+ g_assert(f->menu != self);
+ }
+ }
+#endif
- menu_entry->render_data = render_data; //watch out.
- menu_entry->submenu = submenu;
+ while (self->entries) {
+ menu_entry_free(self->entries->data);
+ self->entries = g_list_delete_link(self->entries, self->entries);
+ }
+}
- return menu_entry;
+void menu_entry_remove(ObMenuEntry *self)
+{
+ self->menu->entries = g_list_remove(self->menu->entries, self);
+ menu_entry_free(self);
}
-void menu_entry_set_submenu(MenuEntry *entry, Menu *submenu)
+ObMenuEntry* menu_add_normal(ObMenu *self, gint id, gchar *label,
+ GSList *actions)
{
- assert(entry != NULL);
-
- entry->submenu = submenu;
+ 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;
+
+ self->entries = g_list_append(self->entries, e);
+ return e;
+}
- if(entry->parent != NULL)
- entry->parent->invalid = TRUE;
+ObMenuEntry* menu_add_submenu(ObMenu *self, gint id, gchar *submenu)
+{
+ ObMenuEntry *e;
+
+ e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SUBMENU, id);
+ e->data.submenu.name = g_strdup(submenu);
+
+ self->entries = g_list_append(self->entries, e);
+ return e;
+}
+
+ObMenuEntry* menu_add_separator(ObMenu *self, gint id)
+{
+ ObMenuEntry *e;
+
+ e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SEPARATOR, id);
+
+ self->entries = g_list_append(self->entries, e);
+ return e;
+}
+
+void menu_set_update_func(ObMenu *self, ObMenuUpdateFunc func)
+{
+ self->update_func = func;
+}
+
+void menu_set_execute_func(ObMenu *self, ObMenuExecuteFunc func)
+{
+ self->execute_func = func;
+}
+
+void menu_set_destroy_func(ObMenu *self, ObMenuDestroyFunc func)
+{
+ self->destroy_func = func;
+}
+
+ObMenuEntry* menu_find_entry_id(ObMenu *self, gint id)
+{
+ ObMenuEntry *ret = NULL;
+ GList *it;
+
+ for (it = self->entries; it; it = g_list_next(it)) {
+ ObMenuEntry *e = it->data;
+
+ if (e->id == id) {
+ ret = e;
+ break;
+ }
+ }
+ return ret;
}
-void menu_add_entry(Menu *menu, MenuEntry *entry)
+void menu_find_submenus(ObMenu *self)
{
- assert(menu != NULL && entry != NULL);
+ GList *it;
- menu->entries = g_list_append(menu->entries, entry);
- entry->parent = menu;
+ for (it = self->entries; it; it = g_list_next(it)) {
+ ObMenuEntry *e = it->data;
- menu->invalid = TRUE;
+ if (e->type == OB_MENU_ENTRY_TYPE_SUBMENU)
+ e->data.submenu.submenu = menu_from_name(e->data.submenu.name);
+ }
}