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},
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;
151 bool accelerator_map_insert(AcceleratorMap& acceleratorMap, Accelerator accelerator, const Callback& callback)
153 if(accelerator.key != 0)
155 return acceleratorMap.insert(AcceleratorMap::value_type(accelerator, callback)).second;
160 bool accelerator_map_erase(AcceleratorMap& acceleratorMap, Accelerator accelerator)
162 if(accelerator.key != 0)
164 AcceleratorMap::iterator i = acceleratorMap.find(accelerator);
165 if(i == acceleratorMap.end())
169 acceleratorMap.erase(i);
174 Accelerator accelerator_for_event_key(guint keyval, guint state)
176 keyval = gdk_keyval_to_upper(keyval);
177 if(keyval == GDK_ISO_Left_Tab)
179 return Accelerator(keyval, (GdkModifierType)(state & gtk_accelerator_get_default_mod_mask()));
182 bool AcceleratorMap_activate(const AcceleratorMap& acceleratorMap, const Accelerator& accelerator)
184 AcceleratorMap::const_iterator i = acceleratorMap.find(accelerator);
185 if(i != acceleratorMap.end())
194 static gboolean accelerator_key_event(GtkWindow* window, GdkEventKey* event, AcceleratorMap* acceleratorMap)
196 return AcceleratorMap_activate(*acceleratorMap, accelerator_for_event_key(event->keyval, event->state));
200 AcceleratorMap g_special_accelerators;
203 namespace MouseButton
213 typedef unsigned int ButtonMask;
215 void print_buttons(ButtonMask mask)
217 globalOutputStream() << "button state: ";
218 if((mask & MouseButton::Left) != 0)
220 globalOutputStream() << "Left ";
222 if((mask & MouseButton::Right) != 0)
224 globalOutputStream() << "Right ";
226 if((mask & MouseButton::Middle) != 0)
228 globalOutputStream() << "Middle ";
230 globalOutputStream() << "\n";
233 ButtonMask ButtonMask_for_event_button(guint button)
238 return MouseButton::Left;
240 return MouseButton::Middle;
242 return MouseButton::Right;
247 bool window_has_accel(GtkWindow* toplevel)
249 return g_slist_length(gtk_accel_groups_from_object(G_OBJECT(toplevel))) != 0;
254 bool g_accel_enabled = true;
257 bool global_accel_enabled()
259 return g_accel_enabled;
263 AcceleratorMap g_queuedAccelerators;
265 GClosure* accel_group_add_accelerator(GtkAccelGroup* group, Accelerator accelerator, const Callback& callback);
267 void GlobalQueuedAccelerators_commit()
269 for(AcceleratorMap::const_iterator i = g_queuedAccelerators.begin(); i != g_queuedAccelerators.end(); ++i)
271 accel_group_add_accelerator(global_accel, (*i).first, (*i).second);
273 g_queuedAccelerators.clear();
276 void GlobalQueuedAccelerators_add(Accelerator accelerator, const Callback& callback)
278 g_queuedAccelerators.insert(AcceleratorMap::value_type(accelerator, callback));
281 void accel_group_test(GtkWindow* toplevel, GtkAccelGroup* accel)
284 gtk_accel_group_query(accel, '4', (GdkModifierType)0, &n_entries);
285 globalOutputStream() << "grid4: " << n_entries << "\n";
286 globalOutputStream() << "toplevel accelgroups: " << g_slist_length(gtk_accel_groups_from_object(G_OBJECT(toplevel))) << "\n";
289 typedef std::set<GtkWindow*> WindowSet;
290 WindowSet g_accel_windows;
292 bool Buttons_press(ButtonMask& buttons, guint button, guint state)
294 if(buttons == 0 && bitfield_enable(buttons, ButtonMask_for_event_button(button)) != 0)
296 ASSERT_MESSAGE(g_accel_enabled, "Buttons_press: accelerators not enabled");
297 g_accel_enabled = false;
298 for(WindowSet::iterator i = g_accel_windows.begin(); i != g_accel_windows.end(); ++i)
300 GtkWindow* toplevel = *i;
301 ASSERT_MESSAGE(window_has_accel(toplevel), "ERROR");
302 ASSERT_MESSAGE(GTK_WIDGET_TOPLEVEL(toplevel), "disabling accel for non-toplevel window");
303 gtk_window_remove_accel_group(toplevel, global_accel);
305 globalOutputStream() << reinterpret_cast<unsigned int>(toplevel) << ": disabled global accelerators\n";
308 accel_group_test(toplevel, global_accel);
312 buttons = bitfield_enable(buttons, ButtonMask_for_event_button(button));
314 globalOutputStream() << "Buttons_press: ";
315 print_buttons(buttons);
320 bool Buttons_release(ButtonMask& buttons, guint button, guint state)
322 if(buttons != 0 && bitfield_disable(buttons, ButtonMask_for_event_button(button)) == 0)
324 ASSERT_MESSAGE(!g_accel_enabled, "Buttons_release: accelerators are enabled");
325 g_accel_enabled = true;
326 for(WindowSet::iterator i = g_accel_windows.begin(); i != g_accel_windows.end(); ++i)
328 GtkWindow* toplevel = *i;
329 ASSERT_MESSAGE(!window_has_accel(toplevel), "ERROR");
330 ASSERT_MESSAGE(GTK_WIDGET_TOPLEVEL(toplevel), "enabling accel for non-toplevel window");
331 gtk_window_add_accel_group(toplevel, global_accel);
333 globalOutputStream() << reinterpret_cast<unsigned int>(toplevel) << ": enabled global accelerators\n";
336 accel_group_test(toplevel, global_accel);
339 GlobalQueuedAccelerators_commit();
341 buttons = bitfield_disable(buttons, ButtonMask_for_event_button(button));
343 globalOutputStream() << "Buttons_release: ";
344 print_buttons(buttons);
349 bool Buttons_releaseAll(ButtonMask& buttons)
351 Buttons_release(buttons, MouseButton::Left | MouseButton::Middle | MouseButton::Right, 0);
355 struct PressedButtons
359 PressedButtons() : buttons(0)
364 gboolean PressedButtons_button_press(GtkWidget* widget, GdkEventButton* event, PressedButtons* pressed)
366 if(event->type == GDK_BUTTON_PRESS)
368 return Buttons_press(pressed->buttons, event->button, event->state);
373 gboolean PressedButtons_button_release(GtkWidget* widget, GdkEventButton* event, PressedButtons* pressed)
375 if(event->type == GDK_BUTTON_RELEASE)
377 return Buttons_release(pressed->buttons, event->button, event->state);
382 gboolean PressedButtons_focus_out(GtkWidget* widget, GdkEventFocus* event, PressedButtons* pressed)
384 Buttons_releaseAll(pressed->buttons);
388 void PressedButtons_connect(PressedButtons& pressedButtons, GtkWidget* widget)
390 g_signal_connect(G_OBJECT(widget), "button_press_event", G_CALLBACK(PressedButtons_button_press), &pressedButtons);
391 g_signal_connect(G_OBJECT(widget), "button_release_event", G_CALLBACK(PressedButtons_button_release), &pressedButtons);
392 g_signal_connect(G_OBJECT(widget), "focus_out_event", G_CALLBACK(PressedButtons_focus_out), &pressedButtons);
395 PressedButtons g_pressedButtons;
402 typedef std::set<guint> Keys;
404 std::size_t refcount;
406 PressedKeys() : refcount(0)
411 AcceleratorMap g_keydown_accelerators;
412 AcceleratorMap g_keyup_accelerators;
414 bool Keys_press(PressedKeys::Keys& keys, guint keyval)
416 if(keys.insert(keyval).second)
418 return AcceleratorMap_activate(g_keydown_accelerators, accelerator_for_event_key(keyval, 0));
420 return g_keydown_accelerators.find(accelerator_for_event_key(keyval, 0)) != g_keydown_accelerators.end();
423 bool Keys_release(PressedKeys::Keys& keys, guint keyval)
425 if(keys.erase(keyval) != 0)
427 return AcceleratorMap_activate(g_keyup_accelerators, accelerator_for_event_key(keyval, 0));
429 return g_keyup_accelerators.find(accelerator_for_event_key(keyval, 0)) != g_keyup_accelerators.end();
432 void Keys_releaseAll(PressedKeys::Keys& keys, guint state)
434 for(PressedKeys::Keys::iterator i = keys.begin(); i != keys.end(); ++i)
436 AcceleratorMap_activate(g_keyup_accelerators, accelerator_for_event_key(*i, state));
441 gboolean PressedKeys_key_press(GtkWidget* widget, GdkEventKey* event, PressedKeys* pressedKeys)
443 //globalOutputStream() << "pressed: " << event->keyval << "\n";
444 return event->state == 0 && Keys_press(pressedKeys->keys, event->keyval);
447 gboolean PressedKeys_key_release(GtkWidget* widget, GdkEventKey* event, PressedKeys* pressedKeys)
449 //globalOutputStream() << "released: " << event->keyval << "\n";
450 return Keys_release(pressedKeys->keys, event->keyval);
453 gboolean PressedKeys_focus_in(GtkWidget* widget, GdkEventFocus* event, PressedKeys* pressedKeys)
455 ++pressedKeys->refcount;
459 gboolean PressedKeys_focus_out(GtkWidget* widget, GdkEventFocus* event, PressedKeys* pressedKeys)
461 if(--pressedKeys->refcount == 0)
463 Keys_releaseAll(pressedKeys->keys, 0);
468 PressedKeys g_pressedKeys;
470 void GlobalPressedKeys_releaseAll()
472 Keys_releaseAll(g_pressedKeys.keys, 0);
475 void GlobalPressedKeys_connect(GtkWindow* window)
477 unsigned int key_press_handler = g_signal_connect(G_OBJECT(window), "key_press_event", G_CALLBACK(PressedKeys_key_press), &g_pressedKeys);
478 unsigned int key_release_handler = g_signal_connect(G_OBJECT(window), "key_release_event", G_CALLBACK(PressedKeys_key_release), &g_pressedKeys);
479 g_object_set_data(G_OBJECT(window), "key_press_handler", gint_to_pointer(key_press_handler));
480 g_object_set_data(G_OBJECT(window), "key_release_handler", gint_to_pointer(key_release_handler));
481 unsigned int focus_in_handler = g_signal_connect(G_OBJECT(window), "focus_in_event", G_CALLBACK(PressedKeys_focus_in), &g_pressedKeys);
482 unsigned int focus_out_handler = g_signal_connect(G_OBJECT(window), "focus_out_event", G_CALLBACK(PressedKeys_focus_out), &g_pressedKeys);
483 g_object_set_data(G_OBJECT(window), "focus_in_handler", gint_to_pointer(focus_in_handler));
484 g_object_set_data(G_OBJECT(window), "focus_out_handler", gint_to_pointer(focus_out_handler));
487 void GlobalPressedKeys_disconnect(GtkWindow* window)
489 g_signal_handler_disconnect(G_OBJECT(window), gpointer_to_int(g_object_get_data(G_OBJECT(window), "key_press_handler")));
490 g_signal_handler_disconnect(G_OBJECT(window), gpointer_to_int(g_object_get_data(G_OBJECT(window), "key_release_handler")));
491 g_signal_handler_disconnect(G_OBJECT(window), gpointer_to_int(g_object_get_data(G_OBJECT(window), "focus_in_handler")));
492 g_signal_handler_disconnect(G_OBJECT(window), gpointer_to_int(g_object_get_data(G_OBJECT(window), "focus_out_handler")));
497 void special_accelerators_add(Accelerator accelerator, const Callback& callback)
499 if(!accelerator_map_insert(g_special_accelerators, accelerator, callback))
501 globalErrorStream() << "special_accelerators_add: already exists: " << makeQuoted(accelerator) << "\n";
504 void special_accelerators_remove(Accelerator accelerator)
506 if(!accelerator_map_erase(g_special_accelerators, accelerator))
508 globalErrorStream() << "special_accelerators_remove: not found: " << makeQuoted(accelerator) << "\n";
512 void keydown_accelerators_add(Accelerator accelerator, const Callback& callback)
514 if(!accelerator_map_insert(g_keydown_accelerators, accelerator, callback))
516 globalErrorStream() << "keydown_accelerators_add: already exists: " << makeQuoted(accelerator) << "\n";
519 void keydown_accelerators_remove(Accelerator accelerator)
521 if(!accelerator_map_erase(g_keydown_accelerators, accelerator))
523 globalErrorStream() << "keydown_accelerators_remove: not found: " << makeQuoted(accelerator) << "\n";
527 void keyup_accelerators_add(Accelerator accelerator, const Callback& callback)
529 if(!accelerator_map_insert(g_keyup_accelerators, accelerator, callback))
531 globalErrorStream() << "keyup_accelerators_add: already exists: " << makeQuoted(accelerator) << "\n";
534 void keyup_accelerators_remove(Accelerator accelerator)
536 if(!accelerator_map_erase(g_keyup_accelerators, accelerator))
538 globalErrorStream() << "keyup_accelerators_remove: not found: " << makeQuoted(accelerator) << "\n";
543 gboolean accel_closure_callback(GtkAccelGroup* group, GtkWidget* widget, guint key, GdkModifierType modifiers, gpointer data)
545 (*reinterpret_cast<Callback*>(data))();
549 GClosure* accel_group_add_accelerator(GtkAccelGroup* group, Accelerator accelerator, const Callback& callback)
551 if(accelerator.key != 0 && gtk_accelerator_valid(accelerator.key, accelerator.modifiers))
553 //globalOutputStream() << "adding accelerator: " << accelerator.key << " " << accelerator.modifiers << "\n";
554 GClosure* closure = create_cclosure(G_CALLBACK(accel_closure_callback), callback);
555 gtk_accel_group_connect(group, accelerator.key, accelerator.modifiers, GTK_ACCEL_VISIBLE, closure);
560 special_accelerators_add(accelerator, callback);
565 void accel_group_remove_accelerator(GtkAccelGroup* group, Accelerator accelerator)
567 if(accelerator.key != 0 && gtk_accelerator_valid(accelerator.key, accelerator.modifiers))
569 gtk_accel_group_disconnect_key(group, accelerator.key, accelerator.modifiers);
573 special_accelerators_remove(accelerator);
577 GtkAccelGroup* global_accel = 0;
579 void global_accel_init()
581 global_accel = gtk_accel_group_new();
584 void global_accel_destroy()
586 g_object_unref(global_accel);
589 GClosure* global_accel_group_add_accelerator(Accelerator accelerator, const Callback& callback)
591 if(!global_accel_enabled())
593 // workaround: cannot add to GtkAccelGroup while it is disabled
594 GlobalQueuedAccelerators_add(accelerator, callback);
597 return accel_group_add_accelerator(global_accel, accelerator, callback);
599 void global_accel_group_remove_accelerator(Accelerator accelerator)
601 //ASSERT_MESSAGE(global_accel_enabled(), "removing accelerator while global accel is disabled");
602 accel_group_remove_accelerator(global_accel, accelerator);
605 /// \brief Propagates key events to the focus-widget, overriding global accelerators.
606 static gboolean override_global_accelerators(GtkWindow* window, GdkEventKey* event, gpointer data)
608 return gtk_window_propagate_key_event(window, event);
611 void global_accel_connect_window(GtkWindow* window)
614 unsigned int override_handler = g_signal_connect(G_OBJECT(window), "key_press_event", G_CALLBACK(override_global_accelerators), 0);
615 g_object_set_data(G_OBJECT(window), "override_handler", gint_to_pointer(override_handler));
617 unsigned int special_key_press_handler = g_signal_connect(G_OBJECT(window), "key_press_event", G_CALLBACK(accelerator_key_event), &g_special_accelerators);
618 g_object_set_data(G_OBJECT(window), "special_key_press_handler", gint_to_pointer(special_key_press_handler));
620 GlobalPressedKeys_connect(window);
622 unsigned int key_press_handler = g_signal_connect(G_OBJECT(window), "key_press_event", G_CALLBACK(accelerator_key_event), &g_keydown_accelerators);
623 unsigned int key_release_handler = g_signal_connect(G_OBJECT(window), "key_release_event", G_CALLBACK(accelerator_key_event), &g_keyup_accelerators);
624 g_object_set_data(G_OBJECT(window), "key_press_handler", gint_to_pointer(key_press_handler));
625 g_object_set_data(G_OBJECT(window), "key_release_handler", gint_to_pointer(key_release_handler));
627 g_accel_windows.insert(window);
628 gtk_window_add_accel_group(window, global_accel);
630 void global_accel_disconnect_window(GtkWindow* window)
633 GlobalPressedKeys_disconnect(window);
635 g_signal_handler_disconnect(G_OBJECT(window), gpointer_to_int(g_object_get_data(G_OBJECT(window), "override_handler")));
636 g_signal_handler_disconnect(G_OBJECT(window), gpointer_to_int(g_object_get_data(G_OBJECT(window), "special_key_press_handler")));
638 g_signal_handler_disconnect(G_OBJECT(window), gpointer_to_int(g_object_get_data(G_OBJECT(window), "key_press_handler")));
639 g_signal_handler_disconnect(G_OBJECT(window), gpointer_to_int(g_object_get_data(G_OBJECT(window), "key_release_handler")));
641 gtk_window_remove_accel_group(window, global_accel);
642 std::size_t count = g_accel_windows.erase(window);
643 ASSERT_MESSAGE(count == 1, "failed to remove accel group\n");
647 GClosure* global_accel_group_find(Accelerator accelerator)
649 guint numEntries = 0;
650 GtkAccelGroupEntry* entry = gtk_accel_group_query(global_accel, accelerator.key, accelerator.modifiers, &numEntries);
655 char* name = gtk_accelerator_name(accelerator.key, accelerator.modifiers);
656 globalErrorStream() << "accelerator already in-use: " << name << "\n";
659 return entry->closure;
664 void global_accel_group_connect(const Accelerator& accelerator, const Callback& callback)
666 if(accelerator.key != 0)
668 global_accel_group_add_accelerator(accelerator, callback);
672 void global_accel_group_disconnect(const Accelerator& accelerator, const Callback& callback)
674 if(accelerator.key != 0)
676 global_accel_group_remove_accelerator(accelerator);