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
  78 #include "framewin.h"
  79
  80 #define MAX_SHORTCUT_LENGTH 32
  81
  82 /*** var ***/
  83 extern WPreferences wPreferences;
  84
  85 typedef struct {
  86         WScreen *screen;
  87         WShortKey *key;
  88         int key_no;
  89 } WUserMenuData;
  90
  91 static void notifyClient(WMenu * menu, WMenuEntry * entry)
  92 {
  93         XEvent event;
  94         WUserMenuData *data = entry->clientdata;
  95         WScreen *scr = data->screen;
  96         Window window;
  97         int i;
  98
  99         window = scr->focused_window->client_win;
 100
 101         for (i = 0; i < data->key_no; i++) {
 102                 event.xkey.type = KeyPress;
 103                 event.xkey.display = dpy;
 104                 event.xkey.window = window;
 105                 event.xkey.root = DefaultRootWindow(dpy);
 106                 event.xkey.subwindow = (Window) None;
 107                 event.xkey.x = 0x0;
 108                 event.xkey.y = 0x0;
 109                 event.xkey.x_root = 0x0;
 110                 event.xkey.y_root = 0x0;
 111                 event.xkey.keycode = data->key[i].keycode;
 112                 event.xkey.state = data->key[i].modifier;
 113                 event.xkey.same_screen = True;
 114                 event.xkey.time = CurrentTime;
 115                 if (XSendEvent(dpy, window, False, KeyPressMask, &event)) {
 116                         event.xkey.type = KeyRelease;
 117                         event.xkey.time = CurrentTime;
 118                         XSendEvent(dpy, window, True, KeyReleaseMask, &event);
 119                 }
 120         }
 121 }
 122
 123 static void removeUserMenudata(void *menudata)
 124 {
 125         WUserMenuData *data = menudata;
 126         if (data->key)
 127                 wfree(data->key);
 128
 129         wfree(data);
 130 }
 131
 132 static WUserMenuData *convertShortcuts(WScreen * scr, WMPropList * shortcut)
 133 {
 134         WUserMenuData *data;
 135         KeySym ksym;
 136         char *k, buf[MAX_SHORTCUT_LENGTH], *b;
 137         int keycount, i, j, mod;
 138
 139         if (WMIsPLString(shortcut)) {
 140                 keycount = 1;
 141         } else if (WMIsPLArray(shortcut)) {
 142                 keycount = WMGetPropListItemCount(shortcut);
 143         } else {
 144                 return NULL;
 145         }
 146
 147         data = wmalloc(sizeof(WUserMenuData));
 148         if (!data)
 149                 return NULL;
 150
 151         data->key = wmalloc(sizeof(WShortKey) * keycount);
 152         if (!data->key) {
 153                 wfree(data);
 154                 return NULL;
 155         }
 156
 157         for (i = 0, j = 0; i < keycount; i++) {
 158                 data->key[j].modifier = 0;
 159                 if (WMIsPLArray(shortcut))
 160                         wstrlcpy(buf, WMGetFromPLString(WMGetFromPLArray(shortcut, i)), MAX_SHORTCUT_LENGTH);
 161                 else
 162                         wstrlcpy(buf, WMGetFromPLString(shortcut), MAX_SHORTCUT_LENGTH);
 163
 164                 b = (char *)buf;
 165
 166                 while ((k = strchr(b, '+')) != NULL) {
 167                         *k = 0;
 168                         mod = wXModifierFromKey(b);
 169                         if (mod < 0)
 170                                 break;
 171
 172                         data->key[j].modifier |= mod;
 173                         b = k + 1;
 174                 }
 175
 176                 ksym = XStringToKeysym(b);
 177                 if (ksym == NoSymbol)
 178                         continue;
 179
 180                 data->key[j].keycode = XKeysymToKeycode(dpy, ksym);
 181                 if (data->key[j].keycode)
 182                         j++;
 183         }
 184
 185  keyover:
 186
 187         /* get key */
 188         if (!j) {
 189                 puts("fatal j");
 190                 wfree(data->key);
 191                 wfree(data);
 192                 return NULL;
 193         }
 194         data->key_no = j;
 195         data->screen = scr;
 196
 197         return data;
 198 }
 199
 200 static WMenu *configureUserMenu(WScreen * scr, WMPropList * plum)
 201 {
 202         char *mtitle;
 203         WMenu *menu = NULL;
 204         WMPropList *elem, *title, *command, *params;
 205         int count, i;
 206         WUserMenuData *data;
 207
 208         if (!plum)
 209                 return NULL;
 210
 211         if (!WMIsPLArray(plum))
 212                 return NULL;
 213
 214         count = WMGetPropListItemCount(plum);
 215         if (!count)
 216                 return NULL;
 217
 218         elem = WMGetFromPLArray(plum, 0);
 219         if (!WMIsPLString(elem))
 220                 return NULL;
 221
 222         mtitle = WMGetFromPLString(elem);
 223
 224         menu = wMenuCreateForApp(scr, mtitle, True);
 225
 226         for (i = 1; i < count; i++) {
 227                 elem = WMGetFromPLArray(plum, i);
 228                 if (WMIsPLArray(WMGetFromPLArray(elem, 1))) {
 229                         WMenu *submenu;
 230                         WMenuEntry *mentry;
 231
 232                         submenu = configureUserMenu(scr, elem);
 233                         if (submenu)
 234                                 mentry = wMenuAddCallback(menu, submenu->frame->title, NULL, NULL);
 235                         wMenuEntrySetCascade(menu, mentry, submenu);
 236                 } else {
 237                         int idx = 0;
 238                         WMPropList *instances = 0;
 239
 240                         title = WMGetFromPLArray(elem, idx++);
 241                         command = WMGetFromPLArray(elem, idx++);
 242                         if (WMGetPropListItemCount(elem) >= 3)
 243                                 params = WMGetFromPLArray(elem, idx++);
 244
 245                         if (!title || !command)
 246                                 return menu;
 247
 248                         if (!strcmp("SHORTCUT", WMGetFromPLString(command))) {
 249                                 WMenuEntry *entry;
 250
 251                                 data = convertShortcuts(scr, params);
 252                                 if (data) {
 253                                         entry = wMenuAddCallback(menu, WMGetFromPLString(title),
 254                                                                  notifyClient, data);
 255
 256                                         if (entry) {
 257                                                 if (WMIsPLString(params))
 258                                                         entry->rtext =
 259                                                             GetShortcutString(WMGetFromPLString(params));
 260
 261                                                 entry->free_cdata = removeUserMenudata;
 262
 263                                                 if (WMGetPropListItemCount(elem) >= 4) {
 264                                                         instances = WMGetFromPLArray(elem, idx++);
 265                                                         if (WMIsPLArray(instances))
 266                                                                 if (instances && WMGetPropListItemCount(instances)
 267                                                                     && WMIsPLArray(instances)) {
 268                                                                         entry->instances =
 269                                                                             WMRetainPropList(instances);
 270                                                                 }
 271                                                 }
 272                                         }
 273                                 }
 274                         }
 275
 276                 }
 277         }
 278         return menu;
 279 }
 280
 281 void wUserMenuRefreshInstances(WMenu * menu, WWindow * wwin)
 282 {
 283         WMenuEntry *entry;
 284         int i, j, count, paintflag;
 285
 286         paintflag = 0;
 287
 288         if (!menu)
 289                 return;
 290
 291         for (i = 0; i < menu->entry_no; i++) {
 292                 if (menu->entries[i]->instances) {
 293                         WMPropList *ins;
 294                         int oldflag;
 295                         count = WMGetPropListItemCount(menu->entries[i]->instances);
 296
 297                         oldflag = menu->entries[i]->flags.enabled;
 298                         menu->entries[i]->flags.enabled = 0;
 299                         for (j = 0; j < count; j++) {
 300                                 ins = WMGetFromPLArray(menu->entries[i]->instances, j);
 301                                 if (!strcmp(wwin->wm_instance, WMGetFromPLString(ins))) {
 302                                         menu->entries[i]->flags.enabled = 1;
 303                                         break;
 304                                 }
 305                         }
 306                         if (oldflag != menu->entries[i]->flags.enabled)
 307                                 paintflag = 1;
 308                 }
 309         }
 310         for (i = 0; i < menu->cascade_no; i++) {
 311                 if (!menu->cascades[i]->flags.brother)
 312                         wUserMenuRefreshInstances(menu->cascades[i], wwin);
 313                 else
 314                         wUserMenuRefreshInstances(menu->cascades[i]->brother, wwin);
 315         }
 316
 317         if (paintflag)
 318                 wMenuPaint(menu);
 319 }
 320
 321 static WMenu *readUserMenuFile(WScreen *scr, const char *file_name)
 322 {
 323         WMenu *menu = NULL;
 324         WMPropList *plum;
 325
 326         plum = WMReadPropListFromFile(file_name);
 327         if (plum) {
 328                 menu = configureUserMenu(scr, plum);
 329                 WMReleasePropList(plum);
 330         }
 331         return menu;
 332 }
 333
 334 WMenu *wUserMenuGet(WScreen * scr, WWindow * wwin)
 335 {
 336         WMenu *menu = NULL;
 337         char *path = NULL;
 338         char *tmp;
 339         if (wwin->wm_instance && wwin->wm_class) {
 340                 int len = strlen(wwin->wm_instance) + strlen(wwin->wm_class) + 7;
 341                 tmp = wmalloc(len);
 342                 snprintf(tmp, len, "%s.%s.menu", wwin->wm_instance, wwin->wm_class);
 343                 path = wfindfile(DEF_USER_MENU_PATHS, tmp);
 344                 wfree(tmp);
 345
 346                 if (!path)
 347                         return NULL;
 348
 349                 if (wwin)
 350                         menu = readUserMenuFile(scr, path);
 351
 352                 wfree(path);
 353         }
 354         return menu;
 355 }
 356
 357 #endif                          /* USER_MENU */