summaryrefslogtreecommitdiff
path: root/src/Keys.cc
blob: 079bdb663d4db64ade6744f7287dc78cc5fd8520 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
// Keys.cc for Fluxbox - an X11 Window manager
// Copyright (c) 2001-2002 Henrik Kinnunen (fluxgen@linuxmail.org)
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.

//$Id: Keys.cc,v 1.10 2002/02/20 23:10:48 fluxgen Exp $

#ifdef		HAVE_CONFIG_H
#	 include "config.h"
#endif

#include "Keys.hh"

#include "StringUtil.hh"

#ifdef		HAVE_STDIO_H
#	 include <stdio.h>
#endif									// HAVE_STDIO_H

#ifdef		HAVE_CTYPE_H
#	 include <ctype.h>
#endif									// HAVE_CTYPE_H

#ifdef		STDC_HEADERS
#	 include <stdlib.h>
#	 include <string.h>
#  include <errno.h>
#endif									// STDC_HEADERS

#if HAVE_STRINGS_H
# include <strings.h>
#endif

#ifdef		HAVE_SYS_TYPES_H
#	 include <sys/types.h>
#endif									// HAVE_SYS_TYPES_H

#ifdef		HAVE_SYS_WAIT_H
#	 include <sys/wait.h>
#endif									// HAVE_SYS_WAIT_H

#ifdef		HAVE_UNISTD_H
#	 include <unistd.h>
#endif									// HAVE_UNISTD_H

#ifdef		HAVE_SYS_STAT_H
#	 include <sys/stat.h>
#endif									// HAVE_SYS_STAT_H

#include <X11/Xlib.h>
#include <X11/Xproto.h>
#include <X11/keysym.h>

#include <iostream>
#include <fstream>
#include <vector>
#include <cassert>
#include <memory>

using namespace std;

Keys::t_actionstr Keys::m_actionlist[] = {
	{"Minimize", ICONIFY},
	{"Raise", RAISE},
	{"Lower", LOWER},
	{"Close", CLOSE},
	{"AbortKeychain", ABORTKEYCHAIN},
	{"Workspace", WORKSPACE},
	{"Workspace1", WORKSPACE1},
	{"Workspace2", WORKSPACE2},
	{"Workspace3", WORKSPACE3},
	{"Workspace4", WORKSPACE4},
	{"Workspace5", WORKSPACE5},
	{"Workspace6", WORKSPACE6},
	{"Workspace7", WORKSPACE7},
	{"Workspace8", WORKSPACE8},
	{"Workspace9", WORKSPACE9},
	{"Workspace10", WORKSPACE10},
	{"Workspace11", WORKSPACE11},
	{"Workspace12",  WORKSPACE12},
	{"NextWorkspace", NEXTWORKSPACE},
	{"PrevWorkspace", PREVWORKSPACE},
	{"LeftWorkspace", LEFTWORKSPACE},
	{"RightWorkspace", RIGHTWORKSPACE},
	{"KillWindow", KILLWINDOW},
	{"NextWindow", NEXTWINDOW},
	{"PrevWindow", PREVWINDOW},
	{"NextTab", NEXTTAB},
	{"PrevTab", PREVTAB},
	{"ShadeWindow", SHADE},
	{"MaximizeWindow", MAXIMIZE},
	{"StickWindow", STICK},
	{"ExecCommand", EXECUTE},
	{"MaximizeVertical", VERTMAX},
	{"MaximizeHorizontal", HORIZMAX},
	{"NudgeRight", NUDGERIGHT},
	{"NudgeLeft", NUDGELEFT},
	{"NudgeUp", NUDGEUP},
	{"NudgeDown", NUDGEDOWN},
	{"BigNudgeRight", BIGNUDGERIGHT},
	{"BigNudgeLeft", BIGNUDGELEFT},
	{"BigNudgeUp", BIGNUDGEUP},
	{"BigNudgeDown", BIGNUDGEDOWN},
	{"HorizontalIncrement", HORIZINC},
	{"VerticalIncrement", VERTINC},
	{"HorizontalDecrement", HORIZDEC},
	{"VerticalDecrement", VERTDEC},
	{"ToggleDecor", TOGGLEDECOR},	
	{0, LASTKEYGRAB}
	};	

Keys::Keys(Display *display, char *filename):
m_abortkey(0),
m_display(display)
{
	assert(display);
	if (filename)
		load(filename);
}

Keys::~Keys() {	
	ungrabKeys();
	deleteTree();
}

//--------- deleteTree -----------
// Destroys the keytree and m_abortkey
//--------------------------------
void Keys::deleteTree() {
	while (!m_keylist.empty()) {
		if (m_keylist.back())
			delete m_keylist.back();		
		m_keylist.pop_back();
	}
	if (m_abortkey) {
		delete m_abortkey;
		m_abortkey=0;
	}	
}

//-------- ungrabKeys ---------
// Ungrabs the keys
//-----------------------------
void Keys::ungrabKeys() {
	for (int screen=0; screen<ScreenCount(m_display); screen++) {
		XUngrabKey(m_display, AnyKey, AnyModifier,
			RootWindow(m_display, screen));		
	}
}

//-------------- load ----------------
// Load and grab keys
// Returns true on success else false
// TODO: error checking
//------------------------------------
bool Keys::load(char *filename) {
	if (!filename)
		return false;
	
	//ungrab all keys
	ungrabKeys();
	//free memory of previous grabs
	deleteTree();
			
	XSync(m_display, False);
						
	//open the file
	ifstream infile(filename);
	if (!infile)
		return false;
	
	
	auto_ptr<char> linebuffer(new char[1024]);
	
	int line=0;//current line, so we can tell the user where the fault is

	while (!infile.eof()) {
		
		infile.getline(linebuffer.get(), 1024);		

		line++;
		vector<string> val;
		//Parse arguments
		StringUtil::stringtok(val, linebuffer.get());
		//must have at least 1 argument
		if (val.size()<=0)
			continue;
			
		if (val[0][0]=='#') //the line is commented
			continue;
		
		unsigned int key=0, mod=0;		
		char keyarg=0;
		t_key *current_key=0, *last_key=0;
		
		for (unsigned int argc=0; argc<val.size(); argc++) {

			if (val[argc][0]!=':') {
				keyarg++;
				if (keyarg==1) //first arg is modifier
					mod = getModifier(val[argc].c_str());
				else if (keyarg>1) {

					//keyarg=0;
					int tmpmod=getModifier(val[argc].c_str());
					if(tmpmod)
						mod|=tmpmod; //If it's a modifier
					else{ 
						key = getKey(val[argc].c_str()); // else get the key
						if (!current_key) {
							current_key = new t_key(key, mod);
							last_key = current_key;
						} else { 
							t_key *temp_key = new t_key(key, mod);
							last_key->keylist.push_back(temp_key);
							last_key = temp_key;
						}
					}
				}			

			} else {
				
				unsigned int i=0;

				for (i=0; i< LASTKEYGRAB; i++) {
					// +1 on the val[argc] because we dont want to compare the ':'
					if (strcasecmp(m_actionlist[i].string, val[argc].c_str()+1) == 0)
						break;	
				}

				if (i < LASTKEYGRAB ) {
					if (!current_key) {
						cerr<<"Error on line: "<<line<<endl;
						cerr<<linebuffer.get()<<endl;
						delete current_key;
						current_key = 0;
						last_key = 0;
						break; //break out and read next line
					}

					//special case for grabAbortKeychain
					if (m_actionlist[i].action == ABORTKEYCHAIN) {
						if (last_key!=current_key)
							cerr<<"Keys: "<<m_actionlist[i].string<<" cant be in chained mode"<<endl;
						else if (m_abortkey)
							cerr<<"Keys: "<<m_actionlist[i].string<<" is already bound."<<endl;
						else
							m_abortkey = new t_key(current_key->key, current_key->mod, ABORTKEYCHAIN);

						delete current_key;
						current_key = 0;
						last_key = 0;
						break; //break out and read next line
					}
					
					last_key->action = m_actionlist[i].action;
                    switch(last_key->action) {
                        case Keys::EXECUTE:
						last_key->execcommand = 
                                const_cast<char *>
                                (StringUtil::strcasestr(linebuffer.get(),
                                                        getActionStr(Keys::EXECUTE))+
							strlen(getActionStr(Keys::EXECUTE)));
                            break;
                        case WORKSPACE:
                            if (argc + 1 < val.size())
                                last_key->param = atoi( val[argc+1].c_str());
                            else
                                last_key->param = 0;
                            break;
                        case LEFTWORKSPACE:
                        case RIGHTWORKSPACE:
                        case NEXTWORKSPACE:
                        case PREVWORKSPACE:
                            if (argc + 1 < val.size())
                                last_key->param = atoi( val[argc+1].c_str());
                            else
                                last_key->param = 1;
                            break;
                        case NUDGERIGHT:
                        case NUDGELEFT:
                        case NUDGEUP:
                        case NUDGEDOWN:
                            if (argc + 1 < val.size())
                                last_key->param = atoi( val[argc+1].c_str());
                            else
                                last_key->param = 2;
                            break;
                        default:
                            break;
                    }

					//add the keychain to list										
					if (!mergeTree(current_key))
						cerr<<"Keys: Failed to merge keytree!"<<endl;
				
					//clear keypointers now that we have them in m_keylist					
					delete current_key;
					current_key = 0;
					last_key = 0;
					
				}	else { //destroy list if no action is found
					#ifdef DEBUG
					cerr<<"Didnt find action="<<val[argc]<<endl;
					#endif					
					//destroy current_key ... this will also destroy the last_key										
					delete current_key;
					current_key = 0;
					last_key = 0;
				}
				
				break; //dont process this linebuffer more
			}	
		}
	}

	return true;
}

//--------- grabKey ---------------------
// Grabs a key with the modifier
// and with numlock,capslock and scrollock
//----------------------------------------
void Keys::grabKey(unsigned int key, unsigned int mod) {

	for (int screen=0; screen<ScreenCount(m_display); screen++) {
		
		Window root = RootWindow(m_display, screen);
		
		XGrabKey(m_display, key, mod,
			root, True,
			GrabModeAsync, GrabModeAsync);
						
		// Grab with numlock, capslock and scrlock	

		//numlock	
		XGrabKey(m_display, key, mod|Mod2Mask,
			root, True,
			GrabModeAsync, GrabModeAsync);		
		//scrolllock
		XGrabKey(m_display, key, mod|Mod5Mask,
			root, True,
			GrabModeAsync, GrabModeAsync);	
		//capslock
		XGrabKey(m_display, key, mod|LockMask,
			root, True,
			GrabModeAsync, GrabModeAsync);
	
		//capslock+numlock
		XGrabKey(m_display, key, mod|LockMask|Mod2Mask,
			root, True,
			GrabModeAsync, GrabModeAsync);

		//capslock+scrolllock
		XGrabKey(m_display, key, mod|LockMask|Mod5Mask,
			root, True,
			GrabModeAsync, GrabModeAsync);						
	
		//capslock+numlock+scrolllock
		XGrabKey(m_display, key, mod|Mod2Mask|Mod5Mask|LockMask,
			root, True,
			GrabModeAsync, GrabModeAsync);						

		//numlock+scrollLock
		XGrabKey(m_display, key, mod|Mod2Mask|Mod5Mask,
			root, True,
			GrabModeAsync, GrabModeAsync);
	
	}
			
}

//------------ getModifier ---------------
// Returns the modifier for the modstr
// else zero on failure.
// TODO fix more masks
//----------------------------------------
unsigned int Keys::getModifier(const char *modstr) {
	if (!modstr)
		return 0;
	struct t_modlist{
		char *string;
		unsigned int mask;
		bool operator == (const char *modstr) {
			return  (strcasecmp(string, modstr) == 0 && mask !=0);
		}
	} modlist[] = {
		{"SHIFT", ShiftMask},
		{"CONTROL", ControlMask},
		{"MOD1", Mod1Mask},
		{"MOD2", Mod2Mask},
		{"MOD3", Mod3Mask},
		{"MOD4", Mod4Mask},
		{"MOD5", Mod5Mask},
		{0, 0}
		};
		
	for (unsigned int i=0; modlist[i].string!=0; i++) {
		if (modlist[i]==modstr)		
			return modlist[i].mask;		
	}
	
	return 0;	
}

//----------- getKey ----------------
// Returns keycode of keystr on success
// else it returns zero
//-----------------------------------
unsigned int Keys::getKey(const char *keystr) {
	if (!keystr)
		return 0;
	return XKeysymToKeycode(m_display,
		XStringToKeysym(keystr));
}

//--------- getAction -----------------
// returns the KeyAction of the XKeyEvent
//-------------------------------------
Keys::KeyAction Keys::getAction(XKeyEvent *ke) {	
	static t_key *next_key = 0;
	//remove numlock, capslock and scrolllock
	ke->state &= ~Mod2Mask & ~Mod5Mask & ~LockMask;
	
	if (m_abortkey && *m_abortkey==ke) { //abort current keychain
		next_key = 0;		
		return m_abortkey->action;
	}
	
	if (!next_key) {
	
		for (unsigned int i=0; i<m_keylist.size(); i++) {
			if (*m_keylist[i] == ke) {
				if (m_keylist[i]->keylist.size()) {
					next_key = m_keylist[i];
					break; //end for-loop 
				} else {
					if (m_keylist[i]->action == Keys::EXECUTE)
						m_execcmdstring = m_keylist[i]->execcommand; //update execcmdstring if action is grabExecute
                    m_param = m_keylist[i]->param;
					return m_keylist[i]->action;
				}
			}
		}
	
	} else { //check the nextkey
		t_key *temp_key = next_key->find(ke);
		if (temp_key) {
			if (temp_key->keylist.size()) {
				next_key = temp_key;								
			} else {
				next_key = 0;
				if (temp_key->action == Keys::EXECUTE)
					m_execcmdstring = temp_key->execcommand; //update execcmdstring if action is grabExecute
				return temp_key->action;
			}
		}  else  {
			temp_key = next_key;		
			next_key = 0;
			if (temp_key->action == Keys::EXECUTE)
				m_execcmdstring = temp_key->execcommand; //update execcmdstring if action is grabExecute
			return temp_key->action;				
		}
		
	}
	
	return Keys::LASTKEYGRAB;
}

//--------- reconfigure -------------
// deletes the tree and load configuration
// returns true on success else false
//-----------------------------------
bool Keys::reconfigure(char *filename) {
	deleteTree();
	return load(filename);
}

//------------- getActionStr ------------------
// Tries to find the action for the key
// Returns actionstring on success else
// 0 on failure
//---------------------------------------------
const char *Keys::getActionStr(KeyAction action) {
	for (unsigned int i=0; m_actionlist[i].string!=0 ; i++) {
		if (m_actionlist[i].action == action) 
			return m_actionlist[i].string;
	}
	
	return 0;
}

#ifdef DEBUG
//--------- showTree -----------
// Debug function that show the
// keytree. Starts with the
// rootlist
//------------------------------
void Keys::showTree() {
	for (unsigned int i=0; i<m_keylist.size(); i++) {
		if (m_keylist[i]) {
			cerr<<i<<" ";
			showKeyTree(m_keylist[i]);	
		} else
			cerr<<"Null @ "<<i<<endl;
	}
}

//---------- showKeyTree --------
// Debug function to show t_key tree
//-------------------------------
void Keys::showKeyTree(t_key *key, unsigned int w) {	
	for (unsigned int i=0; i<w+1; i++)
		cerr<<"-";	
	if (!key->keylist.empty()) {
		for (unsigned int i=0; i<key->keylist.size(); i++) {
			cerr<<"( "<<(int)key->key<<" "<<(int)key->mod<<" )";
			showKeyTree(key->keylist[i], 4);		
			cerr<<endl;
		}
	} else
		cerr<<"( "<<(int)key->key<<" "<<(int)key->mod<<" ) {"<<getActionStr(key->action)<<"}"<<endl;
}
#endif //DEBUG
//------------ mergeTree ---------------
// Merges two chains and binds new keys
// Returns true on success else false.
//---------------------------------------
bool Keys::mergeTree(t_key *newtree, t_key *basetree) {
	if (basetree==0) {
		unsigned int baselist_i=0;
		for (; baselist_i<m_keylist.size(); baselist_i++) {
			if (m_keylist[baselist_i]->mod == newtree->mod && 
					m_keylist[baselist_i]->key == newtree->key) {
				if (newtree->keylist.size() && m_keylist[baselist_i]->action == LASTKEYGRAB) {
					//assumes the newtree only have one branch
					return mergeTree(newtree->keylist[0], m_keylist[baselist_i]);
				} else
					break;
			}
		}

		if (baselist_i == m_keylist.size()) {
			grabKey(newtree->key, newtree->mod);
			m_keylist.push_back(new t_key(newtree));			
			if (newtree->keylist.size())
				return mergeTree(newtree->keylist[0], m_keylist.back());
			return true;
		}
		
	} else {
		unsigned int baselist_i = 0;
		for (; baselist_i<basetree->keylist.size(); baselist_i++) {
			if (basetree->keylist[baselist_i]->mod == newtree->mod &&
					basetree->keylist[baselist_i]->key == newtree->key) {
				if (newtree->keylist.size()) {
					//assumes the newtree only have on branch
					return mergeTree(newtree->keylist[0], basetree->keylist[baselist_i]);
				} else
					return false;
			}					
		}
		//if it wasn't in the list grab the key and add it to the list
		if (baselist_i==basetree->keylist.size()) {			
			grabKey(newtree->key, newtree->mod);
			basetree->keylist.push_back(new t_key(newtree));
			if (newtree->keylist.size())
				return mergeTree(newtree->keylist[0], basetree->keylist.back());
			return true;		
		}		
	}
	
	return false;
}

Keys::t_key::t_key(unsigned int key_, unsigned int mod_, KeyAction action_) {
	action = action_;
	key = key_;
	mod = mod_;	
    param = 0;
}

Keys::t_key::t_key(t_key *k) {
	action = k->action;
	key = k->key;
	mod = k->mod;
	execcommand = k->execcommand;
    param = k-> param;
}

Keys::t_key::~t_key() {	
	while (!keylist.empty()) {		
		t_key *k = keylist.back();
		delete k;
		keylist.pop_back();				
	}
}