src/usermenu.c

   1 /* usermenu.c- user defined menu
   2  *
   3  *  Window Maker window manager
   4  *
   5  *  Copyright (c) hmmm... Should I put everybody's name here?
   6  *  Where's my lawyer?? -- ]d :D
   7  *
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License as published by
  10  *  the Free Software Foundation; either version 2 of the License, or
  11  *  (at your option) any later version.
  12  *
  13  *  This program is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License along
  19  *  with this program; if not, write to the Free Software Foundation, Inc.,
  20  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  *
  22  * * * * * * * * *
  23  * User defined menu is good, but beer's always better
  24  * if someone wanna start hacking something, He heard...
  25  * TODO
  26  *  - enhance commands. (eg, exit, hide, list all app's member
  27  *    window and etc)
  28  *  - cache menu... dunno.. if people really use this feature :P
  29  *  - Violins, senseless violins!
  30  *  that's all, right now :P
  31  *  - external! WINGs menu editor.
  32  *  TODONOT
  33  *  - allow applications to share their menu. ] think it
  34  *    looks wierd since there still are more than 1 appicon.
  35  *
  36  *  Syntax...
  37  *  (
  38  *    "Program Name",
  39  *    ("Command 1", SHORTCUT, 1),
  40  *    ("Command 2", SHORTCUT, 2, ("Allowed_instant_1", "Allowed_instant_2")),
  41  *    ("Command 3", SHORTCUT, (3,4,5), ("Allowed_instant_1")),
  42  *    (
  43  *      "Submenu",
  44  *      ("Kill Command", KILL),
  45  *      ("Hide Command", HIDE),
  46  *      ("Hide Others Command", HIDE_OTHERS),
  47  *      ("Members", MEMBERS),
  48  *      ("Exit Command", EXIT)
  49  *    )
  50  *  )
  51  *
  52  *  Tips:
  53  *  - If you don't want short cut keys to be listed
  54  *    in the right side of entries, you can just put them
  55  *    in array instead of using the string directly.
  56  *
  57  */
  58
  59 #include "wconfig.h"
  60
  61 #ifdef USER_MENU
  62
  63 #include <X11/Xlib.h>
  64 #include <X11/Xutil.h>
  65 #include <X11/Xproto.h>
  66 #include <X11/Xatom.h>
  67 #include <stdlib.h>
  68 #include <string.h>
  69 #include <stdio.h>
  70 #include <unistd.h>
  71
  72 #include "WindowMaker.h"
  73 #include "menu.h"
  74 #include "actions.h"
  75 #include "keybind.h"
  76 #include "xmodifier.h"
  77 #include "misc.h"
  78
  79 #include "framewin.h"
  80
  81 #define MAX_SHORTCUT_LENGTH 32
  82
  83
  84 typedef struct {
  85         WScreen *screen;
  86         WShortKey *key;
  87         int key_no;
  88 } WUserMenuData;
  89
  90 static void notifyClient(WMenu * menu, WMenuEntry * entry)
  91 {
  92         XEvent event;
  93         WUserMenuData *data = entry->clientdata;
  94         WScreen *scr = data->screen;
  95         Window window;
  96         int i;
  97
  98         window = scr->focused_window->client_win;
  99
 100         for (i = 0; i < data->key_no; i++) {
 101                 event.xkey.type = KeyPress;
 102                 event.xkey.display = dpy;
 103                 event.xkey.window = window;
 104                 event.xkey.root = DefaultRootWindow(dpy);
 105                 event.xkey.subwindow = (Window) None;
 106                 event.xkey.x = 0x0;
 107                 event.xkey.y = 0x0;
 108                 event.xkey.x_root = 0x0;
 109                 event.xkey.y_root = 0x0;
 110                 event.xkey.keycode = data->key[i].keycode;
 111                 event.xkey.state = data->key[i].modifier;
 112                 event.xkey.same_screen = True;
 113                 event.xkey.time = CurrentTime;
 114                 if (XSendEvent(dpy, window, False, KeyPressMask, &event)) {
 115                         event.xkey.type = KeyRelease;
 116                         event.xkey.time = CurrentTime;
 117                         XSendEvent(dpy, window, True, KeyReleaseMask, &event);
 118                 }
 119         }
 120 }
 121
 122 static void removeUserMenudata(void *menudata)
 123 {
 124         WUserMenuData *data = menudata;
 125         if (data->key)
 126                 wfree(data->key);
 127
 128         wfree(data);
 129 }
 130
 131 static WUserMenuData *convertShortcuts(WScreen * scr, WMPropList * shortcut)
 132 {
 133         WUserMenuData *data;
 134         KeySym ksym;
 135         char *k, buf[MAX_SHORTCUT_LENGTH], *b;
 136         int keycount, i, j, mod;
 137
 138         if (WMIsPLString(shortcut)) {
 139                 keycount = 1;
 140         } else if (WMIsPLArray(shortcut)) {
 141                 keycount = WMGetPropListItemCount(shortcut);
 142         } else {
 143                 return NULL;
 144         }
 145
 146         data = wmalloc(sizeof(WUserMenuData));
 147         if (!data)
 148                 return NULL;
 149
 150         data->key = wmalloc(sizeof(WShortKey) * keycount);
 151         if (!data->key) {
 152                 wfree(data);
 153                 return NULL;
 154         }
 155
 156         for (i = 0, j = 0; i < keycount; i++) {
 157                 data->key[j].modifier = 0;
 158                 if (WMIsPLArray(shortcut))
 159                         wstrlcpy(buf, WMGetFromPLString(WMGetFromPLArray(shortcut, i)), MAX_SHORTCUT_LENGTH);
 160                 else
 161                         wstrlcpy(buf, WMGetFromPLString(shortcut), MAX_SHORTCUT_LENGTH);
 162
 163                 b = (char *)buf;
 164
 165                 while ((k = strchr(b, '+')) != NULL) {
 166                         *k = 0;
 167                         mod = wXModifierFromKey(b);
 168                         if (mod < 0)
 169                                 break;
 170
 171                         data->key[j].modifier |= mod;
 172                         b = k + 1;
 173                 }
 174
 175                 ksym = XStringToKeysym(b);
 176                 if (ksym == NoSymbol)
 177                         continue;
 178
 179                 data->key[j].keycode = XKeysymToKeycode(dpy, ksym);
 180                 if (data->key[j].keycode)
 181                         j++;
 182         }
 183
 184  keyover:
 185
 186         /* get key */
 187         if (!j) {
 188                 puts("fatal j");
 189                 wfree(data->key);
 190                 wfree(data);
 191                 return NULL;
 192         }
 193         data->key_no = j;
 194         data->screen = scr;
 195
 196         return data;
 197 }
 198
 199 static WMenu *configureUserMenu(WScreen * scr, WMPropList * plum)
 200 {
 201         char *mtitle;
 202         WMenu *menu = NULL;
 203         WMPropList *elem, *title, *command, *params;
 204         int count, i;
 205         WUserMenuData *data;
 206
 207         if (!plum)
 208                 return NULL;
 209
 210         if (!WMIsPLArray(plum))
 211                 return NULL;
 212
 213         count = WMGetPropListItemCount(plum);
 214         if (!count)
 215                 return NULL;
 216
 217         elem = WMGetFromPLArray(plum, 0);
 218         if (!WMIsPLString(elem))
 219                 return NULL;
 220
 221         mtitle = WMGetFromPLString(elem);
 222
 223         menu = wMenuCreateForApp(scr, mtitle, True);
 224
 225         for (i = 1; i < count; i++) {
 226                 elem = WMGetFromPLArray(plum, i);
 227                 if (WMIsPLArray(WMGetFromPLArray(elem, 1))) {
 228                         WMenu *submenu;
 229                         WMenuEntry *mentry;
 230
 231                         submenu = configureUserMenu(scr, elem);
 232                         if (submenu)
 233                                 mentry = wMenuAddCallback(menu, submenu->frame->title, NULL, NULL);
 234                         wMenuEntrySetCascade(menu, mentry, submenu);
 235                 } else {
 236                         int idx = 0;
 237                         WMPropList *instances = 0;
 238
 239                         title = WMGetFromPLArray(elem, idx++);
 240                         command = WMGetFromPLArray(elem, idx++);
 241                         if (WMGetPropListItemCount(elem) >= 3)
 242                                 params = WMGetFromPLArray(elem, idx++);
 243
 244                         if (!title || !command)
 245                                 return menu;
 246
 247                         if (!strcmp("SHORTCUT", WMGetFromPLString(command))) {
 248                                 WMenuEntry *entry;
 249
 250                                 data = convertShortcuts(scr, params);
 251                                 if (data) {
 252                                         entry = wMenuAddCallback(menu, WMGetFromPLString(title),
 253                                                                  notifyClient, data);
 254
 255                                         if (entry) {
 256                                                 if (WMIsPLString(params))
 257                                                         entry->rtext =
 258                                                             GetShortcutString(WMGetFromPLString(params));
 259
 260                                                 entry->free_cdata = removeUserMenudata;
 261
 262                                                 if (WMGetPropListItemCount(elem) >= 4) {
 263                                                         instances = WMGetFromPLArray(elem, idx++);
 264                                                         if (WMIsPLArray(instances))
 265                                                                 if (instances && WMGetPropListItemCount(instances)
 266                                                                     && WMIsPLArray(instances)) {
 267                                                                         entry->instances =
 268                                                                             WMRetainPropList(instances);
 269                                                                 }
 270                                                 }
 271                                         }
 272                                 }
 273                         }
 274
 275                 }
 276         }
 277         return menu;
 278 }
 279
 280 void wUserMenuRefreshInstances(WMenu * menu, WWindow * wwin)
 281 {
 282         int i, j, count, paintflag;
 283
 284         paintflag = 0;
 285
 286         if (!menu)
 287                 return;
 288
 289         for (i = 0; i < menu->entry_no; i++) {
 290                 if (menu->entries[i]->instances) {
 291                         WMPropList *ins;
 292                         int oldflag;
 293                         count = WMGetPropListItemCount(menu->entries[i]->instances);
 294
 295                         oldflag = menu->entries[i]->flags.enabled;
 296                         menu->entries[i]->flags.enabled = 0;
 297                         for (j = 0; j < count; j++) {
 298                                 ins = WMGetFromPLArray(menu->entries[i]->instances, j);
 299                                 if (!strcmp(wwin->wm_instance, WMGetFromPLString(ins))) {
 300                                         menu->entries[i]->flags.enabled = 1;
 301                                         break;
 302                                 }
 303                         }
 304                         if (oldflag != menu->entries[i]->flags.enabled)
 305                                 paintflag = 1;
 306                 }
 307         }
 308         for (i = 0; i < menu->cascade_no; i++) {
 309                 if (!menu->cascades[i]->flags.brother)
 310                         wUserMenuRefreshInstances(menu->cascades[i], wwin);
 311                 else
 312                         wUserMenuRefreshInstances(menu->cascades[i]->brother, wwin);
 313         }
 314
 315         if (paintflag)
 316                 wMenuPaint(menu);
 317 }
 318
 319 static WMenu *readUserMenuFile(WScreen *scr, const char *file_name)
 320 {
 321         WMenu *menu = NULL;
 322         WMPropList *plum;
 323
 324         plum = WMReadPropListFromFile(file_name);
 325         if (plum) {
 326                 menu = configureUserMenu(scr, plum);
 327                 WMReleasePropList(plum);
 328         }
 329         return menu;
 330 }
 331
 332 WMenu *wUserMenuGet(WScreen * scr, WWindow * wwin)
 333 {
 334         WMenu *menu = NULL;
 335         char *path = NULL;
 336         char *tmp;
 337         if (wwin && wwin->wm_instance && wwin->wm_class) {
 338                 int len = strlen(wwin->wm_instance) + strlen(wwin->wm_class) + 7;
 339                 tmp = wmalloc(len);
 340                 snprintf(tmp, len, "%s.%s.menu", wwin->wm_instance, wwin->wm_class);
 341                 path = wfindfile(DEF_USER_MENU_PATHS, tmp);
 342                 wfree(tmp);
 343
 344                 if (!path)
 345                         return NULL;
 346
 347                 menu = readUserMenuFile(scr, path);
 348                 wfree(path);
 349         }
 350         return menu;
 351 }
 352
 353 #endif                          /* USER_MENU */