1 /*
2 * Copyright (c) 2001-2009 Hypertriton, Inc. <http://hypertriton.com/>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
15 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
18 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
20 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
21 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
22 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
23 * USE OF THIS SOFTWARE EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26 /*
27 * Application-wide hotkey bindings.
28 */
29
30 #include <agar/core/core.h>
31 #include <agar/gui/window.h>
32
33 struct ag_global_key {
34 AG_KeySym keysym;
35 AG_KeyMod keymod;
36 void (*fn)(void);
37 void (*fn_ev)(AG_Event *);
38 SLIST_ENTRY(ag_global_key) gkeys;
39 };
40 static SLIST_HEAD_(ag_global_key) agGlobalKeys;
41 #ifdef AG_THREADS
42 static AG_Mutex agGlobalKeysLock;
43 #endif
44
45 /* Initialize the global keys table. */
46 void
AG_InitGlobalKeys(void)47 AG_InitGlobalKeys(void)
48 {
49 AG_MutexInitRecursive(&agGlobalKeysLock);
50 SLIST_INIT(&agGlobalKeys);
51 }
52
53 /* Clear the global keys table. */
54 void
AG_DestroyGlobalKeys(void)55 AG_DestroyGlobalKeys(void)
56 {
57 AG_ClearGlobalKeys();
58 AG_MutexDestroy(&agGlobalKeysLock);
59 }
60
61 /* Tie a global hotkey to a callback function. */
62 void
AG_BindGlobalKey(AG_KeySym keysym,AG_KeyMod keymod,void (* fn)(void))63 AG_BindGlobalKey(AG_KeySym keysym, AG_KeyMod keymod, void (*fn)(void))
64 {
65 struct ag_global_key *gk;
66
67 gk = Malloc(sizeof(struct ag_global_key));
68 gk->keysym = keysym;
69 gk->keymod = keymod;
70 gk->fn = fn;
71 gk->fn_ev = NULL;
72
73 AG_MutexLock(&agGlobalKeysLock);
74 SLIST_INSERT_HEAD(&agGlobalKeys, gk, gkeys);
75 AG_MutexUnlock(&agGlobalKeysLock);
76 }
77
78 /*
79 * Set up some standard, platform-specific hotkey bindings for controlling
80 * zoom or exiting the application.
81 */
82 void
AG_BindStdGlobalKeys(void)83 AG_BindStdGlobalKeys(void)
84 {
85 #ifdef __APPLE__
86 AG_BindGlobalKey(AG_KEY_EQUALS, AG_KEYMOD_META, AG_ZoomIn);
87 AG_BindGlobalKey(AG_KEY_MINUS, AG_KEYMOD_META, AG_ZoomOut);
88 AG_BindGlobalKey(AG_KEY_0, AG_KEYMOD_META, AG_ZoomReset);
89 AG_BindGlobalKey(AG_KEY_Q, AG_KEYMOD_META, AG_QuitGUI);
90 #else
91 AG_BindGlobalKey(AG_KEY_EQUALS, AG_KEYMOD_CTRL, AG_ZoomIn);
92 AG_BindGlobalKey(AG_KEY_MINUS, AG_KEYMOD_CTRL, AG_ZoomOut);
93 AG_BindGlobalKey(AG_KEY_0, AG_KEYMOD_CTRL, AG_ZoomReset);
94 AG_BindGlobalKey(AG_KEY_Q, AG_KEYMOD_CTRL, AG_QuitGUI);
95 #endif
96 AG_BindGlobalKey(AG_KEY_ESCAPE, AG_KEYMOD_ANY, AG_CloseFocusedWindow);
97 }
98
99 /* Tie a global hotkey to a callback function (AG_Event style). */
100 void
AG_BindGlobalKeyEv(AG_KeySym keysym,AG_KeyMod keymod,void (* fn_ev)(AG_Event *))101 AG_BindGlobalKeyEv(AG_KeySym keysym, AG_KeyMod keymod,
102 void (*fn_ev)(AG_Event *))
103 {
104 struct ag_global_key *gk;
105
106 gk = Malloc(sizeof(struct ag_global_key));
107 gk->keysym = keysym;
108 gk->keymod = keymod;
109 gk->fn = NULL;
110 gk->fn_ev = fn_ev;
111
112 AG_MutexLock(&agGlobalKeysLock);
113 SLIST_INSERT_HEAD(&agGlobalKeys, gk, gkeys);
114 AG_MutexUnlock(&agGlobalKeysLock);
115 }
116
117 /* Unregister a hotkey. */
118 int
AG_UnbindGlobalKey(AG_KeySym keysym,AG_KeyMod keymod)119 AG_UnbindGlobalKey(AG_KeySym keysym, AG_KeyMod keymod)
120 {
121 struct ag_global_key *gk;
122
123 AG_MutexLock(&agGlobalKeysLock);
124 SLIST_FOREACH(gk, &agGlobalKeys, gkeys) {
125 if (gk->keysym == keysym && gk->keymod == keymod) {
126 SLIST_REMOVE(&agGlobalKeys, gk, ag_global_key, gkeys);
127 free(gk);
128 AG_MutexUnlock(&agGlobalKeysLock);
129 return (0);
130 }
131 }
132 AG_MutexUnlock(&agGlobalKeysLock);
133 AG_SetError("No such key binding");
134 return (-1);
135 }
136
137 /* Free the table of hotkeys. */
138 void
AG_ClearGlobalKeys(void)139 AG_ClearGlobalKeys(void)
140 {
141 struct ag_global_key *gk, *gkNext;
142
143 AG_MutexLock(&agGlobalKeysLock);
144 for (gk = SLIST_FIRST(&agGlobalKeys);
145 gk != SLIST_END(&agGlobalKeys);
146 gk = gkNext) {
147 gkNext = SLIST_NEXT(gk, gkeys);
148 free(gk);
149 }
150 SLIST_INIT(&agGlobalKeys);
151 AG_MutexUnlock(&agGlobalKeysLock);
152 }
153
154 /* Execute any action tied to a hotkey. */
155 int
AG_ExecGlobalKeys(AG_KeySym sym,AG_KeyMod mod)156 AG_ExecGlobalKeys(AG_KeySym sym, AG_KeyMod mod)
157 {
158 struct ag_global_key *gk;
159 int rv = 0;
160
161 AG_MutexLock(&agGlobalKeysLock);
162 SLIST_FOREACH(gk, &agGlobalKeys, gkeys) {
163 if ((gk->keysym == AG_KEY_ANY || gk->keysym == sym) &&
164 (gk->keymod == AG_KEYMOD_ANY || gk->keymod & mod)) {
165 if (gk->fn != NULL) {
166 gk->fn();
167 } else if (gk->fn_ev != NULL) {
168 gk->fn_ev(NULL);
169 }
170 rv = 1;
171 }
172 }
173 AG_MutexUnlock(&agGlobalKeysLock);
174 return (rv);
175 }
176