openbox/menu.c

   1 #include "menu.h"
   2 #include "openbox.h"
   3 #include "stacking.h"
   4 #include "grab.h"
   5 #include "render/theme.h"
   6 #include "screen.h"
   7 #include "geom.h"
   8 #include "plugin.h"
   9
  10 static GHashTable *menu_hash = NULL;
  11 GHashTable *menu_map = NULL;
  12
  13 #define FRAME_EVENTMASK (ButtonPressMask |ButtonMotionMask | EnterWindowMask | \
  14                          LeaveWindowMask)
  15 #define TITLE_EVENTMASK (ButtonPressMask | ButtonMotionMask)
  16 #define ENTRY_EVENTMASK (EnterWindowMask | LeaveWindowMask | \
  17                          ButtonPressMask | ButtonReleaseMask)
  18
  19 void menu_control_show(Menu *self, int x, int y, Client *client);
  20
  21 void menu_destroy_hash_key(gpointer data)
  22 {
  23     g_free(data);
  24 }
  25
  26 void menu_destroy_hash_value(Menu *self)
  27 {
  28     GList *it;
  29
  30     for (it = self->entries; it; it = it->next)
  31         menu_entry_free(it->data);
  32     g_list_free(self->entries);
  33
  34     g_free(self->label);
  35     g_free(self->name);
  36
  37     g_hash_table_remove(menu_map, &self->title);
  38     g_hash_table_remove(menu_map, &self->frame);
  39     g_hash_table_remove(menu_map, &self->items);
  40
  41     stacking_remove(self);
  42
  43     appearance_free(self->a_title);
  44     XDestroyWindow(ob_display, self->title);
  45     XDestroyWindow(ob_display, self->frame);
  46     XDestroyWindow(ob_display, self->items);
  47
  48     g_free(self);
  49 }
  50
  51 void menu_entry_free(MenuEntry *self)
  52 {
  53     g_free(self->label);
  54     action_free(self->action);
  55
  56     g_hash_table_remove(menu_map, &self->item);
  57
  58     appearance_free(self->a_item);
  59     appearance_free(self->a_disabled);
  60     appearance_free(self->a_hilite);
  61     XDestroyWindow(ob_display, self->item);
  62
  63     g_free(self);
  64 }
  65
  66 void menu_startup()
  67 {
  68     Menu *m;
  69     Menu *s;
  70     Menu *t;
  71     Action *a;
  72
  73     menu_hash = g_hash_table_new_full(g_str_hash, g_str_equal,
  74                                       menu_destroy_hash_key,
  75                                       (GDestroyNotify)menu_destroy_hash_value);
  76     menu_map = g_hash_table_new(g_int_hash, g_int_equal);
  77
  78     m = menu_new(NULL, "root", NULL);
  79
  80     a = action_from_string("execute");
  81     a->data.execute.path = g_strdup("xterm");
  82     menu_add_entry(m, menu_entry_new("xterm", a));
  83     a = action_from_string("restart");
  84     menu_add_entry(m, menu_entry_new("restart", a));
  85     menu_add_entry(m, menu_entry_new_separator("--"));
  86     a = action_from_string("exit");
  87     menu_add_entry(m, menu_entry_new("exit", a));
  88     s = menu_new("subsex menu", "submenu", m);
  89     a = action_from_string("execute");
  90     a->data.execute.path = g_strdup("xclock");
  91     menu_add_entry(s, menu_entry_new("xclock", a));
  92
  93     menu_add_entry(m, menu_entry_new_submenu("subz", s));
  94
  95     t = (Menu *)plugin_create("timed_menu");
  96     if (t) {
  97         a = action_from_string("execute");
  98         a->data.execute.path = g_strdup("xeyes");
  99         menu_add_entry(t, menu_entry_new("xeyes", a));
 100         menu_add_entry(m, menu_entry_new_submenu("timed", t));
 101     }
 102
 103     s = menu_new("empty", "chub", m);
 104     menu_add_entry(m, menu_entry_new_submenu("empty", s));
 105
 106     s = menu_new("", "s-club", m);
 107     menu_add_entry(m, menu_entry_new_submenu("empty", s));
 108
 109     s = menu_new(NULL, "h-club", m);
 110     menu_add_entry(m, menu_entry_new_submenu("empty", s));
 111
 112     s = menu_new(NULL, "g-club", m);
 113
 114     a = action_from_string("execute");
 115     a->data.execute.path = g_strdup("xterm");
 116     menu_add_entry(s, menu_entry_new("xterm", a));
 117     a = action_from_string("restart");
 118     menu_add_entry(s, menu_entry_new("restart", a));
 119     menu_add_entry(s, menu_entry_new_separator("--"));
 120     a = action_from_string("exit");
 121     menu_add_entry(s, menu_entry_new("exit", a));
 122
 123     menu_add_entry(m, menu_entry_new_submenu("long", s));
 124
 125     m = menu_new(NULL, "client", NULL);
 126     a = action_from_string("iconify");
 127     menu_add_entry(m, menu_entry_new("iconify", a));
 128     a = action_from_string("toggleshade");
 129     menu_add_entry(m, menu_entry_new("(un)shade", a));
 130     a = action_from_string("togglemaximizefull");
 131     menu_add_entry(m, menu_entry_new("(un)maximize", a));
 132     a = action_from_string("close");
 133     menu_add_entry(m, menu_entry_new("close", a));
 134
 135 }
 136
 137 void menu_shutdown()
 138 {
 139     g_hash_table_destroy(menu_hash);
 140     g_hash_table_destroy(menu_map);
 141 }
 142
 143 static Window createWindow(Window parent, unsigned long mask,
 144                            XSetWindowAttributes *attrib)
 145 {
 146     return XCreateWindow(ob_display, parent, 0, 0, 1, 1, 0,
 147                          render_depth, InputOutput, render_visual,
 148                          mask, attrib);
 149
 150 }
 151
 152 Menu *menu_new_full(char *label, char *name, Menu *parent,
 153                     menu_controller_show show, menu_controller_update update)
 154 {
 155     XSetWindowAttributes attrib;
 156     Menu *self;
 157
 158     self = g_new0(Menu, 1);
 159     self->obwin.type = Window_Menu;
 160     self->label = g_strdup(label);
 161     self->name = g_strdup(name);
 162     self->parent = parent;
 163     self->open_submenu = NULL;
 164
 165     self->entries = NULL;
 166     self->shown = FALSE;
 167     self->invalid = TRUE;
 168
 169     /* default controllers */
 170     self->show = show;
 171     self->hide = NULL;
 172     self->update = update;
 173     self->mouseover = NULL;
 174     self->selected = NULL;
 175
 176     self->plugin = NULL;
 177     self->plugin_data = NULL;
 178
 179     attrib.override_redirect = TRUE;
 180     attrib.event_mask = FRAME_EVENTMASK;
 181     self->frame = createWindow(ob_root, CWOverrideRedirect|CWEventMask, &attrib);
 182     attrib.event_mask = TITLE_EVENTMASK;
 183     self->title = createWindow(self->frame, CWEventMask, &attrib);
 184     self->items = createWindow(self->frame, 0, &attrib);
 185
 186     XSetWindowBorderWidth(ob_display, self->frame, theme_bwidth);
 187     XSetWindowBackground(ob_display, self->frame, theme_b_color->pixel);
 188     XSetWindowBorderWidth(ob_display, self->title, theme_bwidth);
 189     XSetWindowBorder(ob_display, self->frame, theme_b_color->pixel);
 190     XSetWindowBorder(ob_display, self->title, theme_b_color->pixel);
 191
 192     XMapWindow(ob_display, self->title);
 193     XMapWindow(ob_display, self->items);
 194
 195     self->a_title = appearance_copy(theme_a_menu_title);
 196     self->a_items = appearance_copy(theme_a_menu);
 197
 198     g_hash_table_insert(menu_map, &self->frame, self);
 199     g_hash_table_insert(menu_map, &self->title, self);
 200     g_hash_table_insert(menu_map, &self->items, self);
 201     g_hash_table_insert(menu_hash, g_strdup(name), self);
 202
 203     stacking_add(self);
 204     stacking_raise(MENU_AS_WINDOW(self));
 205
 206     return self;
 207 }
 208
 209 void menu_free(char *name)
 210 {
 211     g_hash_table_remove(menu_hash, name);
 212 }
 213
 214 MenuEntry *menu_entry_new_full(char *label, Action *action,
 215                                MenuEntryRenderType render_type,
 216                                gpointer submenu)
 217 {
 218     MenuEntry *menu_entry = g_new0(MenuEntry, 1);
 219
 220     menu_entry->label = g_strdup(label);
 221     menu_entry->render_type = render_type;
 222     menu_entry->action = action;
 223
 224     menu_entry->hilite = FALSE;
 225     menu_entry->enabled = TRUE;
 226
 227     menu_entry->submenu = submenu;
 228
 229     return menu_entry;
 230 }
 231
 232 void menu_entry_set_submenu(MenuEntry *entry, Menu *submenu)
 233 {
 234     g_assert(entry != NULL);
 235
 236     entry->submenu = submenu;
 237
 238     if(entry->parent != NULL)
 239         entry->parent->invalid = TRUE;
 240 }
 241
 242 void menu_add_entry(Menu *menu, MenuEntry *entry)
 243 {
 244     XSetWindowAttributes attrib;
 245
 246     g_assert(menu != NULL);
 247     g_assert(entry != NULL);
 248     g_assert(entry->item == None);
 249
 250     menu->entries = g_list_append(menu->entries, entry);
 251     entry->parent = menu;
 252
 253     attrib.event_mask = ENTRY_EVENTMASK;
 254     entry->item = createWindow(menu->items, CWEventMask, &attrib);
 255     XMapWindow(ob_display, entry->item);
 256     entry->a_item = appearance_copy(theme_a_menu_item);
 257     entry->a_disabled = appearance_copy(theme_a_menu_disabled);
 258     entry->a_hilite = appearance_copy(theme_a_menu_hilite);
 259
 260     menu->invalid = TRUE;
 261
 262     g_hash_table_insert(menu_map, &entry->item, menu);
 263 }
 264
 265 void menu_show(char *name, int x, int y, Client *client)
 266 {
 267     Menu *self;
 268
 269     self = g_hash_table_lookup(menu_hash, name);
 270     if (!self) {
 271         g_warning("Attempted to show menu '%s' but it does not exist.",
 272                   name);
 273         return;
 274     }
 275
 276     menu_show_full(self, x, y, client);
 277 }
 278
 279 void menu_show_full(Menu *self, int x, int y, Client *client)
 280 {
 281     g_assert(self != NULL);
 282
 283     menu_render(self);
 284
 285     self->client = client;
 286
 287     if (self->show) {
 288         self->show(self, x, y, client);
 289     } else {
 290       menu_control_show(self, x, y, client);
 291     }
 292 }
 293
 294
 295 void menu_hide(Menu *self) {
 296     if (self->shown) {
 297         XUnmapWindow(ob_display, self->frame);
 298         self->shown = FALSE;
 299         if (self->open_submenu)
 300             menu_hide(self->open_submenu);
 301         if (self->parent && self->parent->open_submenu == self)
 302             self->parent->open_submenu = NULL;
 303
 304     }
 305 }
 306
 307 void menu_clear(Menu *self) {
 308     GList *it;
 309
 310     for (it = self->entries; it; it = it->next) {
 311         MenuEntry *entry = it->data;
 312         menu_entry_free(entry);
 313     }
 314     self->entries = NULL;
 315     self->invalid = TRUE;
 316 }
 317
 318
 319 MenuEntry *menu_find_entry(Menu *menu, Window win)
 320 {
 321     GList *it;
 322
 323     for (it = menu->entries; it; it = it->next) {
 324         MenuEntry *entry = it->data;
 325         if (entry->item == win)
 326             return entry;
 327     }
 328     return NULL;
 329 }
 330
 331 void menu_entry_fire(MenuEntry *self)
 332 {
 333     Menu *m;
 334
 335     if (self->action) {
 336         self->action->data.any.c = self->parent->client;
 337         self->action->func(&self->action->data);
 338
 339         /* hide the whole thing */
 340         m = self->parent;
 341         while (m->parent) m = m->parent;
 342         menu_hide(m);
 343     }
 344 }
 345
 346 /*
 347    Default menu controller action for showing.
 348 */
 349
 350 void menu_control_show(Menu *self, int x, int y, Client *client) {
 351     g_assert(!self->invalid);
 352
 353     XMoveWindow(ob_display, self->frame,
 354                 MIN(x, screen_physical_size.width - self->size.width),
 355                 MIN(y, screen_physical_size.height - self->size.height));
 356     POINT_SET(self->location,
 357               MIN(x, screen_physical_size.width - self->size.width),
 358               MIN(y, screen_physical_size.height - self->size.height));
 359
 360     if (!self->shown) {
 361         XMapWindow(ob_display, self->frame);
 362         stacking_raise(MENU_AS_WINDOW(self));
 363         self->shown = TRUE;
 364     } else if (self->shown && self->open_submenu) {
 365         menu_hide(self->open_submenu);
 366     }
 367 }
 368
 369 void menu_control_mouseover(MenuEntry *self, gboolean enter) {
 370     int x;
 371     self->hilite = enter;
 372
 373     if (enter) {
 374         if (self->parent->open_submenu && self->submenu
 375             != self->parent->open_submenu)
 376             menu_hide(self->parent->open_submenu);
 377
 378         if (self->submenu) {
 379             self->parent->open_submenu = self->submenu;
 380
 381             /* shouldn't be invalid since it must be displayed */
 382             g_assert(!self->parent->invalid);
 383             /* TODO: I don't understand why these bevels should be here.
 384                Something must be wrong in the width calculation */
 385             x = self->parent->location.x + self->parent->size.width +
 386                 theme_bevel;
 387
 388             /* need to get the width. is this bad?*/
 389             menu_render(self->submenu);
 390
 391             if (self->submenu->size.width + x > screen_physical_size.width)
 392                 x = self->parent->location.x - self->submenu->size.width -
 393                     theme_bevel;
 394
 395             menu_show_full(self->submenu, x,
 396                            self->parent->location.y + self->y, NULL);
 397         }
 398     }
 399 }