2 Copyright (C) 2001-2006, William Joseph.
5 This file is part of GtkRadiant.
7 GtkRadiant is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 GtkRadiant is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GtkRadiant; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 #include "accelerator.h"
24 #include "debugging/debugging.h"
28 #include <gtk/gtkwindow.h>
29 #include <gtk/gtkaccelgroup.h>
31 #include "generic/callback.h"
32 #include "generic/bitfield.h"
33 #include "string/string.h"
38 #include <gdk/gdkkeysyms.h>
42 const char* global_keys_find(unsigned int key)
47 s = gdk_keyval_name(key);
53 unsigned int global_keys_find(const char* name)
58 k = gdk_keyval_from_name(name);
59 if(k == GDK_VoidSymbol)
64 void accelerator_write(const Accelerator& accelerator, TextOutputStream& ostream)
66 if(accelerator.modifiers & GDK_SHIFT_MASK)
68 ostream << "Shift + ";
70 if(accelerator.modifiers & GDK_MOD1_MASK)
74 if(accelerator.modifiers & GDK_CONTROL_MASK)
76 ostream << "Control + ";
79 const char* keyName = global_keys_find(accelerator.key);
80 if(!string_empty(keyName))
86 ostream << static_cast<char>(accelerator.key);
90 typedef std::map<Accelerator, Callback> AcceleratorMap;
91 typedef std::set<Accelerator> AcceleratorSet;
93 bool accelerator_map_insert(AcceleratorMap& acceleratorMap, Accelerator accelerator, const Callback& callback)
95 if(accelerator.key != 0)
97 return acceleratorMap.insert(AcceleratorMap::value_type(accelerator, callback)).second;
102 bool accelerator_map_erase(AcceleratorMap& acceleratorMap, Accelerator accelerator)
104 if(accelerator.key != 0)
106 AcceleratorMap::iterator i = acceleratorMap.find(accelerator);
107 if(i == acceleratorMap.end())
111 acceleratorMap.erase(i);
116 Accelerator accelerator_for_event_key(guint keyval, guint state)
118 keyval = gdk_keyval_to_upper(keyval);
119 if(keyval == GDK_ISO_Left_Tab)
121 return Accelerator(keyval, (GdkModifierType)(state & gtk_accelerator_get_default_mod_mask()));
124 bool AcceleratorMap_activate(const AcceleratorMap& acceleratorMap, const Accelerator& accelerator)
126 AcceleratorMap::const_iterator i = acceleratorMap.find(accelerator);
127 if(i != acceleratorMap.end())
136 static gboolean accelerator_key_event(GtkWindow* window, GdkEventKey* event, AcceleratorMap* acceleratorMap)
138 return AcceleratorMap_activate(*acceleratorMap, accelerator_for_event_key(event->keyval, event->state));
142 AcceleratorMap g_special_accelerators;
145 namespace MouseButton
155 typedef unsigned int ButtonMask;
157 void print_buttons(ButtonMask mask)
159 globalOutputStream() << "button state: ";
160 if((mask & MouseButton::Left) != 0)
162 globalOutputStream() << "Left ";
164 if((mask & MouseButton::Right) != 0)
166 globalOutputStream() << "Right ";
168 if((mask & MouseButton::Middle) != 0)
170 globalOutputStream() << "Middle ";
172 globalOutputStream() << "\n";
175 ButtonMask ButtonMask_for_event_button(guint button)
180 return MouseButton::Left;
182 return MouseButton::Middle;
184 return MouseButton::Right;
189 bool window_has_accel(GtkWindow* toplevel)
191 return g_slist_length(gtk_accel_groups_from_object(G_OBJECT(toplevel))) != 0;
196 bool g_accel_enabled = true;
199 bool global_accel_enabled()
201 return g_accel_enabled;
205 GClosure* accel_group_add_accelerator(GtkAccelGroup* group, Accelerator accelerator, const Callback& callback);
206 void accel_group_remove_accelerator(GtkAccelGroup* group, Accelerator accelerator);
208 AcceleratorMap g_queuedAcceleratorsAdd;
209 AcceleratorSet g_queuedAcceleratorsRemove;
211 void globalQueuedAccelerators_add(Accelerator accelerator, const Callback& callback)
213 if(!g_queuedAcceleratorsAdd.insert(AcceleratorMap::value_type(accelerator, callback)).second)
215 globalErrorStream() << "globalQueuedAccelerators_add: accelerator already queued: " << accelerator << "\n";
219 void globalQueuedAccelerators_remove(Accelerator accelerator)
221 if(g_queuedAcceleratorsAdd.erase(accelerator) == 0)
223 if(!g_queuedAcceleratorsRemove.insert(accelerator).second)
225 globalErrorStream() << "globalQueuedAccelerators_remove: accelerator already queued: " << accelerator << "\n";
230 void globalQueuedAccelerators_commit()
232 for(AcceleratorSet::const_iterator i = g_queuedAcceleratorsRemove.begin(); i != g_queuedAcceleratorsRemove.end(); ++i)
234 //globalOutputStream() << "removing: " << (*i).first << "\n";
235 accel_group_remove_accelerator(global_accel, *i);
237 g_queuedAcceleratorsRemove.clear();
238 for(AcceleratorMap::const_iterator i = g_queuedAcceleratorsAdd.begin(); i != g_queuedAcceleratorsAdd.end(); ++i)
240 //globalOutputStream() << "adding: " << (*i).first << "\n";
241 accel_group_add_accelerator(global_accel, (*i).first, (*i).second);
243 g_queuedAcceleratorsAdd.clear();
246 void accel_group_test(GtkWindow* toplevel, GtkAccelGroup* accel)
249 gtk_accel_group_query(accel, '4', (GdkModifierType)0, &n_entries);
250 globalOutputStream() << "grid4: " << n_entries << "\n";
251 globalOutputStream() << "toplevel accelgroups: " << g_slist_length(gtk_accel_groups_from_object(G_OBJECT(toplevel))) << "\n";
254 typedef std::set<GtkWindow*> WindowSet;
255 WindowSet g_accel_windows;
257 bool Buttons_press(ButtonMask& buttons, guint button, guint state)
259 if(buttons == 0 && bitfield_enable(buttons, ButtonMask_for_event_button(button)) != 0)
261 ASSERT_MESSAGE(g_accel_enabled, "Buttons_press: accelerators not enabled");
262 g_accel_enabled = false;
263 for(WindowSet::iterator i = g_accel_windows.begin(); i != g_accel_windows.end(); ++i)
265 GtkWindow* toplevel = *i;
266 ASSERT_MESSAGE(window_has_accel(toplevel), "ERROR");
267 ASSERT_MESSAGE(GTK_WIDGET_TOPLEVEL(toplevel), "disabling accel for non-toplevel window");
268 gtk_window_remove_accel_group(toplevel, global_accel);
270 globalOutputStream() << reinterpret_cast<unsigned int>(toplevel) << ": disabled global accelerators\n";
273 accel_group_test(toplevel, global_accel);
277 buttons = bitfield_enable(buttons, ButtonMask_for_event_button(button));
279 globalOutputStream() << "Buttons_press: ";
280 print_buttons(buttons);
285 bool Buttons_release(ButtonMask& buttons, guint button, guint state)
287 if(buttons != 0 && bitfield_disable(buttons, ButtonMask_for_event_button(button)) == 0)
289 ASSERT_MESSAGE(!g_accel_enabled, "Buttons_release: accelerators are enabled");
290 g_accel_enabled = true;
291 for(WindowSet::iterator i = g_accel_windows.begin(); i != g_accel_windows.end(); ++i)
293 GtkWindow* toplevel = *i;
294 ASSERT_MESSAGE(!window_has_accel(toplevel), "ERROR");
295 ASSERT_MESSAGE(GTK_WIDGET_TOPLEVEL(toplevel), "enabling accel for non-toplevel window");
296 gtk_window_add_accel_group(toplevel, global_accel);
298 globalOutputStream() << reinterpret_cast<unsigned int>(toplevel) << ": enabled global accelerators\n";
301 accel_group_test(toplevel, global_accel);
304 globalQueuedAccelerators_commit();
306 buttons = bitfield_disable(buttons, ButtonMask_for_event_button(button));
308 globalOutputStream() << "Buttons_release: ";
309 print_buttons(buttons);
314 bool Buttons_releaseAll(ButtonMask& buttons)
316 Buttons_release(buttons, MouseButton::Left | MouseButton::Middle | MouseButton::Right, 0);
320 struct PressedButtons
324 PressedButtons() : buttons(0)
329 gboolean PressedButtons_button_press(GtkWidget* widget, GdkEventButton* event, PressedButtons* pressed)
331 if(event->type == GDK_BUTTON_PRESS)
333 return Buttons_press(pressed->buttons, event->button, event->state);
338 gboolean PressedButtons_button_release(GtkWidget* widget, GdkEventButton* event, PressedButtons* pressed)
340 if(event->type == GDK_BUTTON_RELEASE)
342 return Buttons_release(pressed->buttons, event->button, event->state);
347 gboolean PressedButtons_focus_out(GtkWidget* widget, GdkEventFocus* event, PressedButtons* pressed)
349 Buttons_releaseAll(pressed->buttons);
353 void PressedButtons_connect(PressedButtons& pressedButtons, GtkWidget* widget)
355 g_signal_connect(G_OBJECT(widget), "button_press_event", G_CALLBACK(PressedButtons_button_press), &pressedButtons);
356 g_signal_connect(G_OBJECT(widget), "button_release_event", G_CALLBACK(PressedButtons_button_release), &pressedButtons);
357 g_signal_connect(G_OBJECT(widget), "focus_out_event", G_CALLBACK(PressedButtons_focus_out), &pressedButtons);
360 PressedButtons g_pressedButtons;
367 typedef std::set<guint> Keys;
369 std::size_t refcount;
371 PressedKeys() : refcount(0)
376 AcceleratorMap g_keydown_accelerators;
377 AcceleratorMap g_keyup_accelerators;
379 bool Keys_press(PressedKeys::Keys& keys, guint keyval)
381 if(keys.insert(keyval).second)
383 return AcceleratorMap_activate(g_keydown_accelerators, accelerator_for_event_key(keyval, 0));
385 return g_keydown_accelerators.find(accelerator_for_event_key(keyval, 0)) != g_keydown_accelerators.end();
388 bool Keys_release(PressedKeys::Keys& keys, guint keyval)
390 if(keys.erase(keyval) != 0)
392 return AcceleratorMap_activate(g_keyup_accelerators, accelerator_for_event_key(keyval, 0));
394 return g_keyup_accelerators.find(accelerator_for_event_key(keyval, 0)) != g_keyup_accelerators.end();
397 void Keys_releaseAll(PressedKeys::Keys& keys, guint state)
399 for(PressedKeys::Keys::iterator i = keys.begin(); i != keys.end(); ++i)
401 AcceleratorMap_activate(g_keyup_accelerators, accelerator_for_event_key(*i, state));
406 gboolean PressedKeys_key_press(GtkWidget* widget, GdkEventKey* event, PressedKeys* pressedKeys)
408 //globalOutputStream() << "pressed: " << event->keyval << "\n";
409 return event->state == 0 && Keys_press(pressedKeys->keys, event->keyval);
412 gboolean PressedKeys_key_release(GtkWidget* widget, GdkEventKey* event, PressedKeys* pressedKeys)
414 //globalOutputStream() << "released: " << event->keyval << "\n";
415 return Keys_release(pressedKeys->keys, event->keyval);
418 gboolean PressedKeys_focus_in(GtkWidget* widget, GdkEventFocus* event, PressedKeys* pressedKeys)
420 ++pressedKeys->refcount;
424 gboolean PressedKeys_focus_out(GtkWidget* widget, GdkEventFocus* event, PressedKeys* pressedKeys)
426 if(--pressedKeys->refcount == 0)
428 Keys_releaseAll(pressedKeys->keys, 0);
433 PressedKeys g_pressedKeys;
435 void GlobalPressedKeys_releaseAll()
437 Keys_releaseAll(g_pressedKeys.keys, 0);
440 void GlobalPressedKeys_connect(GtkWindow* window)
442 unsigned int key_press_handler = g_signal_connect(G_OBJECT(window), "key_press_event", G_CALLBACK(PressedKeys_key_press), &g_pressedKeys);
443 unsigned int key_release_handler = g_signal_connect(G_OBJECT(window), "key_release_event", G_CALLBACK(PressedKeys_key_release), &g_pressedKeys);
444 g_object_set_data(G_OBJECT(window), "key_press_handler", gint_to_pointer(key_press_handler));
445 g_object_set_data(G_OBJECT(window), "key_release_handler", gint_to_pointer(key_release_handler));
446 unsigned int focus_in_handler = g_signal_connect(G_OBJECT(window), "focus_in_event", G_CALLBACK(PressedKeys_focus_in), &g_pressedKeys);
447 unsigned int focus_out_handler = g_signal_connect(G_OBJECT(window), "focus_out_event", G_CALLBACK(PressedKeys_focus_out), &g_pressedKeys);
448 g_object_set_data(G_OBJECT(window), "focus_in_handler", gint_to_pointer(focus_in_handler));
449 g_object_set_data(G_OBJECT(window), "focus_out_handler", gint_to_pointer(focus_out_handler));
452 void GlobalPressedKeys_disconnect(GtkWindow* window)
454 g_signal_handler_disconnect(G_OBJECT(window), gpointer_to_int(g_object_get_data(G_OBJECT(window), "key_press_handler")));
455 g_signal_handler_disconnect(G_OBJECT(window), gpointer_to_int(g_object_get_data(G_OBJECT(window), "key_release_handler")));
456 g_signal_handler_disconnect(G_OBJECT(window), gpointer_to_int(g_object_get_data(G_OBJECT(window), "focus_in_handler")));
457 g_signal_handler_disconnect(G_OBJECT(window), gpointer_to_int(g_object_get_data(G_OBJECT(window), "focus_out_handler")));
462 void special_accelerators_add(Accelerator accelerator, const Callback& callback)
464 //globalOutputStream() << "special_accelerators_add: " << makeQuoted(accelerator) << "\n";
465 if(!accelerator_map_insert(g_special_accelerators, accelerator, callback))
467 globalErrorStream() << "special_accelerators_add: already exists: " << makeQuoted(accelerator) << "\n";
470 void special_accelerators_remove(Accelerator accelerator)
472 //globalOutputStream() << "special_accelerators_remove: " << makeQuoted(accelerator) << "\n";
473 if(!accelerator_map_erase(g_special_accelerators, accelerator))
475 globalErrorStream() << "special_accelerators_remove: not found: " << makeQuoted(accelerator) << "\n";
479 void keydown_accelerators_add(Accelerator accelerator, const Callback& callback)
481 //globalOutputStream() << "keydown_accelerators_add: " << makeQuoted(accelerator) << "\n";
482 if(!accelerator_map_insert(g_keydown_accelerators, accelerator, callback))
484 globalErrorStream() << "keydown_accelerators_add: already exists: " << makeQuoted(accelerator) << "\n";
487 void keydown_accelerators_remove(Accelerator accelerator)
489 //globalOutputStream() << "keydown_accelerators_remove: " << makeQuoted(accelerator) << "\n";
490 if(!accelerator_map_erase(g_keydown_accelerators, accelerator))
492 globalErrorStream() << "keydown_accelerators_remove: not found: " << makeQuoted(accelerator) << "\n";
496 void keyup_accelerators_add(Accelerator accelerator, const Callback& callback)
498 //globalOutputStream() << "keyup_accelerators_add: " << makeQuoted(accelerator) << "\n";
499 if(!accelerator_map_insert(g_keyup_accelerators, accelerator, callback))
501 globalErrorStream() << "keyup_accelerators_add: already exists: " << makeQuoted(accelerator) << "\n";
504 void keyup_accelerators_remove(Accelerator accelerator)
506 //globalOutputStream() << "keyup_accelerators_remove: " << makeQuoted(accelerator) << "\n";
507 if(!accelerator_map_erase(g_keyup_accelerators, accelerator))
509 globalErrorStream() << "keyup_accelerators_remove: not found: " << makeQuoted(accelerator) << "\n";
514 gboolean accel_closure_callback(GtkAccelGroup* group, GtkWidget* widget, guint key, GdkModifierType modifiers, gpointer data)
516 (*reinterpret_cast<Callback*>(data))();
520 GClosure* accel_group_add_accelerator(GtkAccelGroup* group, Accelerator accelerator, const Callback& callback)
522 if(accelerator.key != 0 && gtk_accelerator_valid(accelerator.key, accelerator.modifiers))
524 //globalOutputStream() << "global_accel_connect: " << makeQuoted(accelerator) << "\n";
525 GClosure* closure = create_cclosure(G_CALLBACK(accel_closure_callback), callback);
526 gtk_accel_group_connect(group, accelerator.key, accelerator.modifiers, GTK_ACCEL_VISIBLE, closure);
531 special_accelerators_add(accelerator, callback);
536 void accel_group_remove_accelerator(GtkAccelGroup* group, Accelerator accelerator)
538 if(accelerator.key != 0 && gtk_accelerator_valid(accelerator.key, accelerator.modifiers))
540 //globalOutputStream() << "global_accel_disconnect: " << makeQuoted(accelerator) << "\n";
541 gtk_accel_group_disconnect_key(group, accelerator.key, accelerator.modifiers);
545 special_accelerators_remove(accelerator);
549 GtkAccelGroup* global_accel = 0;
551 void global_accel_init()
553 global_accel = gtk_accel_group_new();
556 void global_accel_destroy()
558 g_object_unref(global_accel);
561 GClosure* global_accel_group_add_accelerator(Accelerator accelerator, const Callback& callback)
563 if(!global_accel_enabled())
565 // workaround: cannot add to GtkAccelGroup while it is disabled
566 //globalOutputStream() << "queued for add: " << accelerator << "\n";
567 globalQueuedAccelerators_add(accelerator, callback);
570 return accel_group_add_accelerator(global_accel, accelerator, callback);
572 void global_accel_group_remove_accelerator(Accelerator accelerator)
574 if(!global_accel_enabled())
576 //globalOutputStream() << "queued for remove: " << accelerator << "\n";
577 globalQueuedAccelerators_remove(accelerator);
580 accel_group_remove_accelerator(global_accel, accelerator);
583 /// \brief Propagates key events to the focus-widget, overriding global accelerators.
584 static gboolean override_global_accelerators(GtkWindow* window, GdkEventKey* event, gpointer data)
586 gboolean b = gtk_window_propagate_key_event(window, event);
590 void global_accel_connect_window(GtkWindow* window)
593 unsigned int override_handler = g_signal_connect(G_OBJECT(window), "key_press_event", G_CALLBACK(override_global_accelerators), 0);
594 g_object_set_data(G_OBJECT(window), "override_handler", gint_to_pointer(override_handler));
596 unsigned int special_key_press_handler = g_signal_connect(G_OBJECT(window), "key_press_event", G_CALLBACK(accelerator_key_event), &g_special_accelerators);
597 g_object_set_data(G_OBJECT(window), "special_key_press_handler", gint_to_pointer(special_key_press_handler));
599 GlobalPressedKeys_connect(window);
601 unsigned int key_press_handler = g_signal_connect(G_OBJECT(window), "key_press_event", G_CALLBACK(accelerator_key_event), &g_keydown_accelerators);
602 unsigned int key_release_handler = g_signal_connect(G_OBJECT(window), "key_release_event", G_CALLBACK(accelerator_key_event), &g_keyup_accelerators);
603 g_object_set_data(G_OBJECT(window), "key_press_handler", gint_to_pointer(key_press_handler));
604 g_object_set_data(G_OBJECT(window), "key_release_handler", gint_to_pointer(key_release_handler));
606 g_accel_windows.insert(window);
607 gtk_window_add_accel_group(window, global_accel);
609 void global_accel_disconnect_window(GtkWindow* window)
612 GlobalPressedKeys_disconnect(window);
614 g_signal_handler_disconnect(G_OBJECT(window), gpointer_to_int(g_object_get_data(G_OBJECT(window), "override_handler")));
615 g_signal_handler_disconnect(G_OBJECT(window), gpointer_to_int(g_object_get_data(G_OBJECT(window), "special_key_press_handler")));
617 g_signal_handler_disconnect(G_OBJECT(window), gpointer_to_int(g_object_get_data(G_OBJECT(window), "key_press_handler")));
618 g_signal_handler_disconnect(G_OBJECT(window), gpointer_to_int(g_object_get_data(G_OBJECT(window), "key_release_handler")));
620 gtk_window_remove_accel_group(window, global_accel);
621 std::size_t count = g_accel_windows.erase(window);
622 ASSERT_MESSAGE(count == 1, "failed to remove accel group\n");
626 GClosure* global_accel_group_find(Accelerator accelerator)
628 guint numEntries = 0;
629 GtkAccelGroupEntry* entry = gtk_accel_group_query(global_accel, accelerator.key, accelerator.modifiers, &numEntries);
634 char* name = gtk_accelerator_name(accelerator.key, accelerator.modifiers);
635 globalErrorStream() << "accelerator already in-use: " << name << "\n";
638 return entry->closure;
643 void global_accel_group_connect(const Accelerator& accelerator, const Callback& callback)
645 if(accelerator.key != 0)
647 global_accel_group_add_accelerator(accelerator, callback);
651 void global_accel_group_disconnect(const Accelerator& accelerator, const Callback& callback)
653 if(accelerator.key != 0)
655 global_accel_group_remove_accelerator(accelerator);