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>
44 const char* m_strName;
45 unsigned int m_nVKKey;
51 {"Backspace", GDK_BackSpace},
52 {"Escape", GDK_Escape},
54 {"Insert", GDK_Insert},
55 {"Delete", GDK_Delete},
56 {"PageUp", GDK_Prior},
57 {"PageDown", GDK_Next},
75 {"Return", GDK_Return},
77 {"Period", GDK_period},
79 {"Multiply", GDK_multiply},
80 {"Minus", GDK_KP_Subtract},
81 {"NumPad0", GDK_KP_0},
82 {"NumPad1", GDK_KP_1},
83 {"NumPad2", GDK_KP_2},
84 {"NumPad3", GDK_KP_3},
85 {"NumPad4", GDK_KP_4},
86 {"NumPad5", GDK_KP_5},
87 {"NumPad6", GDK_KP_6},
88 {"NumPad7", GDK_KP_7},
89 {"NumPad8", GDK_KP_8},
90 {"NumPad9", GDK_KP_9},
91 {"[", GDK_bracketleft},
92 {"]", GDK_bracketright},
97 int g_nKeyCount = sizeof(g_Keys) / sizeof(SKeyInfo);
99 const char* global_keys_find(unsigned int key)
101 for(int i = 0; i < g_nKeyCount; ++i)
103 if(g_Keys[i].m_nVKKey == key)
105 return g_Keys[i].m_strName;
111 unsigned int global_keys_find(const char* name)
113 for(int i = 0; i < g_nKeyCount; ++i)
115 if(string_equal_nocase(g_Keys[i].m_strName, name))
117 return g_Keys[i].m_nVKKey;
123 void accelerator_write(const Accelerator& accelerator, TextOutputStream& ostream)
125 if(accelerator.modifiers & GDK_SHIFT_MASK)
127 ostream << "Shift + ";
129 if(accelerator.modifiers & GDK_MOD1_MASK)
133 if(accelerator.modifiers & GDK_CONTROL_MASK)
135 ostream << "Control + ";
138 const char* keyName = global_keys_find(accelerator.key);
139 if(!string_empty(keyName))
145 ostream << static_cast<char>(accelerator.key);
149 typedef std::map<Accelerator, Callback> AcceleratorMap;
150 typedef std::set<Accelerator> AcceleratorSet;
152 bool accelerator_map_insert(AcceleratorMap& acceleratorMap, Accelerator accelerator, const Callback& callback)
154 if(accelerator.key != 0)
156 return acceleratorMap.insert(AcceleratorMap::value_type(accelerator, callback)).second;
161 bool accelerator_map_erase(AcceleratorMap& acceleratorMap, Accelerator accelerator)
163 if(accelerator.key != 0)
165 AcceleratorMap::iterator i = acceleratorMap.find(accelerator);
166 if(i == acceleratorMap.end())
170 acceleratorMap.erase(i);
175 Accelerator accelerator_for_event_key(guint keyval, guint state)
177 keyval = gdk_keyval_to_upper(keyval);
178 if(keyval == GDK_ISO_Left_Tab)
180 return Accelerator(keyval, (GdkModifierType)(state & gtk_accelerator_get_default_mod_mask()));
183 bool AcceleratorMap_activate(const AcceleratorMap& acceleratorMap, const Accelerator& accelerator)
185 AcceleratorMap::const_iterator i = acceleratorMap.find(accelerator);
186 if(i != acceleratorMap.end())
195 static gboolean accelerator_key_event(GtkWindow* window, GdkEventKey* event, AcceleratorMap* acceleratorMap)
197 return AcceleratorMap_activate(*acceleratorMap, accelerator_for_event_key(event->keyval, event->state));
201 AcceleratorMap g_special_accelerators;
204 namespace MouseButton
214 typedef unsigned int ButtonMask;
216 void print_buttons(ButtonMask mask)
218 globalOutputStream() << "button state: ";
219 if((mask & MouseButton::Left) != 0)
221 globalOutputStream() << "Left ";
223 if((mask & MouseButton::Right) != 0)
225 globalOutputStream() << "Right ";
227 if((mask & MouseButton::Middle) != 0)
229 globalOutputStream() << "Middle ";
231 globalOutputStream() << "\n";
234 ButtonMask ButtonMask_for_event_button(guint button)
239 return MouseButton::Left;
241 return MouseButton::Middle;
243 return MouseButton::Right;
248 bool window_has_accel(GtkWindow* toplevel)
250 return g_slist_length(gtk_accel_groups_from_object(G_OBJECT(toplevel))) != 0;
255 bool g_accel_enabled = true;
258 bool global_accel_enabled()
260 return g_accel_enabled;
264 GClosure* accel_group_add_accelerator(GtkAccelGroup* group, Accelerator accelerator, const Callback& callback);
265 void accel_group_remove_accelerator(GtkAccelGroup* group, Accelerator accelerator);
267 AcceleratorMap g_queuedAcceleratorsAdd;
268 AcceleratorSet g_queuedAcceleratorsRemove;
270 void globalQueuedAccelerators_add(Accelerator accelerator, const Callback& callback)
272 if(!g_queuedAcceleratorsAdd.insert(AcceleratorMap::value_type(accelerator, callback)).second)
274 globalErrorStream() << "globalQueuedAccelerators_add: accelerator already queued: " << accelerator << "\n";
278 void globalQueuedAccelerators_remove(Accelerator accelerator)
280 if(g_queuedAcceleratorsAdd.erase(accelerator) == 0)
282 if(!g_queuedAcceleratorsRemove.insert(accelerator).second)
284 globalErrorStream() << "globalQueuedAccelerators_remove: accelerator already queued: " << accelerator << "\n";
289 void globalQueuedAccelerators_commit()
291 for(AcceleratorSet::const_iterator i = g_queuedAcceleratorsRemove.begin(); i != g_queuedAcceleratorsRemove.end(); ++i)
293 //globalOutputStream() << "removing: " << (*i).first << "\n";
294 accel_group_remove_accelerator(global_accel, *i);
296 g_queuedAcceleratorsRemove.clear();
297 for(AcceleratorMap::const_iterator i = g_queuedAcceleratorsAdd.begin(); i != g_queuedAcceleratorsAdd.end(); ++i)
299 //globalOutputStream() << "adding: " << (*i).first << "\n";
300 accel_group_add_accelerator(global_accel, (*i).first, (*i).second);
302 g_queuedAcceleratorsAdd.clear();
305 void accel_group_test(GtkWindow* toplevel, GtkAccelGroup* accel)
308 gtk_accel_group_query(accel, '4', (GdkModifierType)0, &n_entries);
309 globalOutputStream() << "grid4: " << n_entries << "\n";
310 globalOutputStream() << "toplevel accelgroups: " << g_slist_length(gtk_accel_groups_from_object(G_OBJECT(toplevel))) << "\n";
313 typedef std::set<GtkWindow*> WindowSet;
314 WindowSet g_accel_windows;
316 bool Buttons_press(ButtonMask& buttons, guint button, guint state)
318 if(buttons == 0 && bitfield_enable(buttons, ButtonMask_for_event_button(button)) != 0)
320 ASSERT_MESSAGE(g_accel_enabled, "Buttons_press: accelerators not enabled");
321 g_accel_enabled = false;
322 for(WindowSet::iterator i = g_accel_windows.begin(); i != g_accel_windows.end(); ++i)
324 GtkWindow* toplevel = *i;
325 ASSERT_MESSAGE(window_has_accel(toplevel), "ERROR");
326 ASSERT_MESSAGE(GTK_WIDGET_TOPLEVEL(toplevel), "disabling accel for non-toplevel window");
327 gtk_window_remove_accel_group(toplevel, global_accel);
329 globalOutputStream() << reinterpret_cast<unsigned int>(toplevel) << ": disabled global accelerators\n";
332 accel_group_test(toplevel, global_accel);
336 buttons = bitfield_enable(buttons, ButtonMask_for_event_button(button));
338 globalOutputStream() << "Buttons_press: ";
339 print_buttons(buttons);
344 bool Buttons_release(ButtonMask& buttons, guint button, guint state)
346 if(buttons != 0 && bitfield_disable(buttons, ButtonMask_for_event_button(button)) == 0)
348 ASSERT_MESSAGE(!g_accel_enabled, "Buttons_release: accelerators are enabled");
349 g_accel_enabled = true;
350 for(WindowSet::iterator i = g_accel_windows.begin(); i != g_accel_windows.end(); ++i)
352 GtkWindow* toplevel = *i;
353 ASSERT_MESSAGE(!window_has_accel(toplevel), "ERROR");
354 ASSERT_MESSAGE(GTK_WIDGET_TOPLEVEL(toplevel), "enabling accel for non-toplevel window");
355 gtk_window_add_accel_group(toplevel, global_accel);
357 globalOutputStream() << reinterpret_cast<unsigned int>(toplevel) << ": enabled global accelerators\n";
360 accel_group_test(toplevel, global_accel);
363 globalQueuedAccelerators_commit();
365 buttons = bitfield_disable(buttons, ButtonMask_for_event_button(button));
367 globalOutputStream() << "Buttons_release: ";
368 print_buttons(buttons);
373 bool Buttons_releaseAll(ButtonMask& buttons)
375 Buttons_release(buttons, MouseButton::Left | MouseButton::Middle | MouseButton::Right, 0);
379 struct PressedButtons
383 PressedButtons() : buttons(0)
388 gboolean PressedButtons_button_press(GtkWidget* widget, GdkEventButton* event, PressedButtons* pressed)
390 if(event->type == GDK_BUTTON_PRESS)
392 return Buttons_press(pressed->buttons, event->button, event->state);
397 gboolean PressedButtons_button_release(GtkWidget* widget, GdkEventButton* event, PressedButtons* pressed)
399 if(event->type == GDK_BUTTON_RELEASE)
401 return Buttons_release(pressed->buttons, event->button, event->state);
406 gboolean PressedButtons_focus_out(GtkWidget* widget, GdkEventFocus* event, PressedButtons* pressed)
408 Buttons_releaseAll(pressed->buttons);
412 void PressedButtons_connect(PressedButtons& pressedButtons, GtkWidget* widget)
414 g_signal_connect(G_OBJECT(widget), "button_press_event", G_CALLBACK(PressedButtons_button_press), &pressedButtons);
415 g_signal_connect(G_OBJECT(widget), "button_release_event", G_CALLBACK(PressedButtons_button_release), &pressedButtons);
416 g_signal_connect(G_OBJECT(widget), "focus_out_event", G_CALLBACK(PressedButtons_focus_out), &pressedButtons);
419 PressedButtons g_pressedButtons;
426 typedef std::set<guint> Keys;
428 std::size_t refcount;
430 PressedKeys() : refcount(0)
435 AcceleratorMap g_keydown_accelerators;
436 AcceleratorMap g_keyup_accelerators;
438 bool Keys_press(PressedKeys::Keys& keys, guint keyval)
440 if(keys.insert(keyval).second)
442 return AcceleratorMap_activate(g_keydown_accelerators, accelerator_for_event_key(keyval, 0));
444 return g_keydown_accelerators.find(accelerator_for_event_key(keyval, 0)) != g_keydown_accelerators.end();
447 bool Keys_release(PressedKeys::Keys& keys, guint keyval)
449 if(keys.erase(keyval) != 0)
451 return AcceleratorMap_activate(g_keyup_accelerators, accelerator_for_event_key(keyval, 0));
453 return g_keyup_accelerators.find(accelerator_for_event_key(keyval, 0)) != g_keyup_accelerators.end();
456 void Keys_releaseAll(PressedKeys::Keys& keys, guint state)
458 for(PressedKeys::Keys::iterator i = keys.begin(); i != keys.end(); ++i)
460 AcceleratorMap_activate(g_keyup_accelerators, accelerator_for_event_key(*i, state));
465 gboolean PressedKeys_key_press(GtkWidget* widget, GdkEventKey* event, PressedKeys* pressedKeys)
467 //globalOutputStream() << "pressed: " << event->keyval << "\n";
468 return event->state == 0 && Keys_press(pressedKeys->keys, event->keyval);
471 gboolean PressedKeys_key_release(GtkWidget* widget, GdkEventKey* event, PressedKeys* pressedKeys)
473 //globalOutputStream() << "released: " << event->keyval << "\n";
474 return Keys_release(pressedKeys->keys, event->keyval);
477 gboolean PressedKeys_focus_in(GtkWidget* widget, GdkEventFocus* event, PressedKeys* pressedKeys)
479 ++pressedKeys->refcount;
483 gboolean PressedKeys_focus_out(GtkWidget* widget, GdkEventFocus* event, PressedKeys* pressedKeys)
485 if(--pressedKeys->refcount == 0)
487 Keys_releaseAll(pressedKeys->keys, 0);
492 PressedKeys g_pressedKeys;
494 void GlobalPressedKeys_releaseAll()
496 Keys_releaseAll(g_pressedKeys.keys, 0);
499 void GlobalPressedKeys_connect(GtkWindow* window)
501 unsigned int key_press_handler = g_signal_connect(G_OBJECT(window), "key_press_event", G_CALLBACK(PressedKeys_key_press), &g_pressedKeys);
502 unsigned int key_release_handler = g_signal_connect(G_OBJECT(window), "key_release_event", G_CALLBACK(PressedKeys_key_release), &g_pressedKeys);
503 g_object_set_data(G_OBJECT(window), "key_press_handler", gint_to_pointer(key_press_handler));
504 g_object_set_data(G_OBJECT(window), "key_release_handler", gint_to_pointer(key_release_handler));
505 unsigned int focus_in_handler = g_signal_connect(G_OBJECT(window), "focus_in_event", G_CALLBACK(PressedKeys_focus_in), &g_pressedKeys);
506 unsigned int focus_out_handler = g_signal_connect(G_OBJECT(window), "focus_out_event", G_CALLBACK(PressedKeys_focus_out), &g_pressedKeys);
507 g_object_set_data(G_OBJECT(window), "focus_in_handler", gint_to_pointer(focus_in_handler));
508 g_object_set_data(G_OBJECT(window), "focus_out_handler", gint_to_pointer(focus_out_handler));
511 void GlobalPressedKeys_disconnect(GtkWindow* window)
513 g_signal_handler_disconnect(G_OBJECT(window), gpointer_to_int(g_object_get_data(G_OBJECT(window), "key_press_handler")));
514 g_signal_handler_disconnect(G_OBJECT(window), gpointer_to_int(g_object_get_data(G_OBJECT(window), "key_release_handler")));
515 g_signal_handler_disconnect(G_OBJECT(window), gpointer_to_int(g_object_get_data(G_OBJECT(window), "focus_in_handler")));
516 g_signal_handler_disconnect(G_OBJECT(window), gpointer_to_int(g_object_get_data(G_OBJECT(window), "focus_out_handler")));
521 void special_accelerators_add(Accelerator accelerator, const Callback& callback)
523 //globalOutputStream() << "special_accelerators_add: " << makeQuoted(accelerator) << "\n";
524 if(!accelerator_map_insert(g_special_accelerators, accelerator, callback))
526 globalErrorStream() << "special_accelerators_add: already exists: " << makeQuoted(accelerator) << "\n";
529 void special_accelerators_remove(Accelerator accelerator)
531 //globalOutputStream() << "special_accelerators_remove: " << makeQuoted(accelerator) << "\n";
532 if(!accelerator_map_erase(g_special_accelerators, accelerator))
534 globalErrorStream() << "special_accelerators_remove: not found: " << makeQuoted(accelerator) << "\n";
538 void keydown_accelerators_add(Accelerator accelerator, const Callback& callback)
540 //globalOutputStream() << "keydown_accelerators_add: " << makeQuoted(accelerator) << "\n";
541 if(!accelerator_map_insert(g_keydown_accelerators, accelerator, callback))
543 globalErrorStream() << "keydown_accelerators_add: already exists: " << makeQuoted(accelerator) << "\n";
546 void keydown_accelerators_remove(Accelerator accelerator)
548 //globalOutputStream() << "keydown_accelerators_remove: " << makeQuoted(accelerator) << "\n";
549 if(!accelerator_map_erase(g_keydown_accelerators, accelerator))
551 globalErrorStream() << "keydown_accelerators_remove: not found: " << makeQuoted(accelerator) << "\n";
555 void keyup_accelerators_add(Accelerator accelerator, const Callback& callback)
557 //globalOutputStream() << "keyup_accelerators_add: " << makeQuoted(accelerator) << "\n";
558 if(!accelerator_map_insert(g_keyup_accelerators, accelerator, callback))
560 globalErrorStream() << "keyup_accelerators_add: already exists: " << makeQuoted(accelerator) << "\n";
563 void keyup_accelerators_remove(Accelerator accelerator)
565 //globalOutputStream() << "keyup_accelerators_remove: " << makeQuoted(accelerator) << "\n";
566 if(!accelerator_map_erase(g_keyup_accelerators, accelerator))
568 globalErrorStream() << "keyup_accelerators_remove: not found: " << makeQuoted(accelerator) << "\n";
573 gboolean accel_closure_callback(GtkAccelGroup* group, GtkWidget* widget, guint key, GdkModifierType modifiers, gpointer data)
575 (*reinterpret_cast<Callback*>(data))();
579 GClosure* accel_group_add_accelerator(GtkAccelGroup* group, Accelerator accelerator, const Callback& callback)
581 if(accelerator.key != 0 && gtk_accelerator_valid(accelerator.key, accelerator.modifiers))
583 //globalOutputStream() << "global_accel_connect: " << makeQuoted(accelerator) << "\n";
584 GClosure* closure = create_cclosure(G_CALLBACK(accel_closure_callback), callback);
585 gtk_accel_group_connect(group, accelerator.key, accelerator.modifiers, GTK_ACCEL_VISIBLE, closure);
590 special_accelerators_add(accelerator, callback);
595 void accel_group_remove_accelerator(GtkAccelGroup* group, Accelerator accelerator)
597 if(accelerator.key != 0 && gtk_accelerator_valid(accelerator.key, accelerator.modifiers))
599 //globalOutputStream() << "global_accel_disconnect: " << makeQuoted(accelerator) << "\n";
600 gtk_accel_group_disconnect_key(group, accelerator.key, accelerator.modifiers);
604 special_accelerators_remove(accelerator);
608 GtkAccelGroup* global_accel = 0;
610 void global_accel_init()
612 global_accel = gtk_accel_group_new();
615 void global_accel_destroy()
617 g_object_unref(global_accel);
620 GClosure* global_accel_group_add_accelerator(Accelerator accelerator, const Callback& callback)
622 if(!global_accel_enabled())
624 // workaround: cannot add to GtkAccelGroup while it is disabled
625 //globalOutputStream() << "queued for add: " << accelerator << "\n";
626 globalQueuedAccelerators_add(accelerator, callback);
629 return accel_group_add_accelerator(global_accel, accelerator, callback);
631 void global_accel_group_remove_accelerator(Accelerator accelerator)
633 if(!global_accel_enabled())
635 //globalOutputStream() << "queued for remove: " << accelerator << "\n";
636 globalQueuedAccelerators_remove(accelerator);
639 accel_group_remove_accelerator(global_accel, accelerator);
642 /// \brief Propagates key events to the focus-widget, overriding global accelerators.
643 static gboolean override_global_accelerators(GtkWindow* window, GdkEventKey* event, gpointer data)
645 gboolean b = gtk_window_propagate_key_event(window, event);
649 void global_accel_connect_window(GtkWindow* window)
652 unsigned int override_handler = g_signal_connect(G_OBJECT(window), "key_press_event", G_CALLBACK(override_global_accelerators), 0);
653 g_object_set_data(G_OBJECT(window), "override_handler", gint_to_pointer(override_handler));
655 unsigned int special_key_press_handler = g_signal_connect(G_OBJECT(window), "key_press_event", G_CALLBACK(accelerator_key_event), &g_special_accelerators);
656 g_object_set_data(G_OBJECT(window), "special_key_press_handler", gint_to_pointer(special_key_press_handler));
658 GlobalPressedKeys_connect(window);
660 unsigned int key_press_handler = g_signal_connect(G_OBJECT(window), "key_press_event", G_CALLBACK(accelerator_key_event), &g_keydown_accelerators);
661 unsigned int key_release_handler = g_signal_connect(G_OBJECT(window), "key_release_event", G_CALLBACK(accelerator_key_event), &g_keyup_accelerators);
662 g_object_set_data(G_OBJECT(window), "key_press_handler", gint_to_pointer(key_press_handler));
663 g_object_set_data(G_OBJECT(window), "key_release_handler", gint_to_pointer(key_release_handler));
665 g_accel_windows.insert(window);
666 gtk_window_add_accel_group(window, global_accel);
668 void global_accel_disconnect_window(GtkWindow* window)
671 GlobalPressedKeys_disconnect(window);
673 g_signal_handler_disconnect(G_OBJECT(window), gpointer_to_int(g_object_get_data(G_OBJECT(window), "override_handler")));
674 g_signal_handler_disconnect(G_OBJECT(window), gpointer_to_int(g_object_get_data(G_OBJECT(window), "special_key_press_handler")));
676 g_signal_handler_disconnect(G_OBJECT(window), gpointer_to_int(g_object_get_data(G_OBJECT(window), "key_press_handler")));
677 g_signal_handler_disconnect(G_OBJECT(window), gpointer_to_int(g_object_get_data(G_OBJECT(window), "key_release_handler")));
679 gtk_window_remove_accel_group(window, global_accel);
680 std::size_t count = g_accel_windows.erase(window);
681 ASSERT_MESSAGE(count == 1, "failed to remove accel group\n");
685 GClosure* global_accel_group_find(Accelerator accelerator)
687 guint numEntries = 0;
688 GtkAccelGroupEntry* entry = gtk_accel_group_query(global_accel, accelerator.key, accelerator.modifiers, &numEntries);
693 char* name = gtk_accelerator_name(accelerator.key, accelerator.modifiers);
694 globalErrorStream() << "accelerator already in-use: " << name << "\n";
697 return entry->closure;
702 void global_accel_group_connect(const Accelerator& accelerator, const Callback& callback)
704 if(accelerator.key != 0)
706 global_accel_group_add_accelerator(accelerator, callback);
710 void global_accel_group_disconnect(const Accelerator& accelerator, const Callback& callback)
712 if(accelerator.key != 0)
714 global_accel_group_remove_accelerator(accelerator);