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 );
54 unsigned int global_keys_find( const char* name ){
56 if ( !name || !*name ) {
59 k = gdk_keyval_from_name( name );
60 if ( k == GDK_VoidSymbol ) {
66 void accelerator_write( const Accelerator& accelerator, TextOutputStream& ostream ){
68 if ( accelerator.modifiers & GDK_SHIFT_MASK ) {
69 ostream << "Shift + ";
71 if ( accelerator.modifiers & GDK_MOD1_MASK ) {
74 if ( accelerator.modifiers & GDK_CONTROL_MASK ) {
75 ostream << "Control + ";
78 const char* keyName = global_keys_find( accelerator.key );
79 if ( !string_empty( keyName ) ) {
84 ostream << static_cast<char>( accelerator.key );
87 ostream << gtk_accelerator_get_label( accelerator.key, accelerator.modifiers );
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 ){
94 if ( accelerator.key != 0 ) {
95 return acceleratorMap.insert( AcceleratorMap::value_type( accelerator, callback ) ).second;
100 bool accelerator_map_erase( AcceleratorMap& acceleratorMap, Accelerator accelerator ){
101 if ( accelerator.key != 0 ) {
102 AcceleratorMap::iterator i = acceleratorMap.find( accelerator );
103 if ( i == acceleratorMap.end() ) {
106 acceleratorMap.erase( i );
111 Accelerator accelerator_for_event_key( guint keyval, guint state ){
112 keyval = gdk_keyval_to_upper( keyval );
113 if ( keyval == GDK_ISO_Left_Tab ) {
116 return Accelerator( keyval, (GdkModifierType)( state & gtk_accelerator_get_default_mod_mask() ) );
119 bool AcceleratorMap_activate( const AcceleratorMap& acceleratorMap, const Accelerator& accelerator ){
120 AcceleratorMap::const_iterator i = acceleratorMap.find( accelerator );
121 if ( i != acceleratorMap.end() ) {
129 static gboolean accelerator_key_event( GtkWindow* window, GdkEventKey* event, AcceleratorMap* acceleratorMap ){
130 return AcceleratorMap_activate( *acceleratorMap, accelerator_for_event_key( event->keyval, event->state ) );
134 AcceleratorMap g_special_accelerators;
137 namespace MouseButton
147 typedef unsigned int ButtonMask;
149 void print_buttons( ButtonMask mask ){
150 globalOutputStream() << "button state: ";
151 if ( ( mask & MouseButton::Left ) != 0 ) {
152 globalOutputStream() << "Left ";
154 if ( ( mask & MouseButton::Right ) != 0 ) {
155 globalOutputStream() << "Right ";
157 if ( ( mask & MouseButton::Middle ) != 0 ) {
158 globalOutputStream() << "Middle ";
160 globalOutputStream() << "\n";
163 ButtonMask ButtonMask_for_event_button( guint button ){
167 return MouseButton::Left;
169 return MouseButton::Middle;
171 return MouseButton::Right;
176 bool window_has_accel( GtkWindow* toplevel ){
177 return g_slist_length( gtk_accel_groups_from_object( G_OBJECT( toplevel ) ) ) != 0;
182 bool g_accel_enabled = true;
185 bool global_accel_enabled(){
186 return g_accel_enabled;
190 GClosure* accel_group_add_accelerator( GtkAccelGroup* group, Accelerator accelerator, const Callback& callback );
191 void accel_group_remove_accelerator( GtkAccelGroup* group, Accelerator accelerator );
193 AcceleratorMap g_queuedAcceleratorsAdd;
194 AcceleratorSet g_queuedAcceleratorsRemove;
196 void globalQueuedAccelerators_add( Accelerator accelerator, const Callback& callback ){
197 if ( !g_queuedAcceleratorsAdd.insert( AcceleratorMap::value_type( accelerator, callback ) ).second ) {
198 globalErrorStream() << "globalQueuedAccelerators_add: accelerator already queued: " << accelerator << "\n";
202 void globalQueuedAccelerators_remove( Accelerator accelerator ){
203 if ( g_queuedAcceleratorsAdd.erase( accelerator ) == 0 ) {
204 if ( !g_queuedAcceleratorsRemove.insert( accelerator ).second ) {
205 globalErrorStream() << "globalQueuedAccelerators_remove: accelerator already queued: " << accelerator << "\n";
210 void globalQueuedAccelerators_commit(){
211 for ( AcceleratorSet::const_iterator i = g_queuedAcceleratorsRemove.begin(); i != g_queuedAcceleratorsRemove.end(); ++i )
213 //globalOutputStream() << "removing: " << (*i).first << "\n";
214 accel_group_remove_accelerator( global_accel, *i );
216 g_queuedAcceleratorsRemove.clear();
217 for ( AcceleratorMap::const_iterator i = g_queuedAcceleratorsAdd.begin(); i != g_queuedAcceleratorsAdd.end(); ++i )
219 //globalOutputStream() << "adding: " << (*i).first << "\n";
220 accel_group_add_accelerator( global_accel, ( *i ).first, ( *i ).second );
222 g_queuedAcceleratorsAdd.clear();
225 void accel_group_test( GtkWindow* toplevel, GtkAccelGroup* accel ){
227 gtk_accel_group_query( accel, '4', (GdkModifierType)0, &n_entries );
228 globalOutputStream() << "grid4: " << n_entries << "\n";
229 globalOutputStream() << "toplevel accelgroups: " << g_slist_length( gtk_accel_groups_from_object( G_OBJECT( toplevel ) ) ) << "\n";
232 typedef std::set<GtkWindow*> WindowSet;
233 WindowSet g_accel_windows;
235 bool Buttons_press( ButtonMask& buttons, guint button, guint state ){
236 if ( buttons == 0 && bitfield_enable( buttons, ButtonMask_for_event_button( button ) ) != 0 ) {
237 ASSERT_MESSAGE( g_accel_enabled, "Buttons_press: accelerators not enabled" );
238 g_accel_enabled = false;
239 for ( WindowSet::iterator i = g_accel_windows.begin(); i != g_accel_windows.end(); ++i )
241 GtkWindow* toplevel = *i;
242 ASSERT_MESSAGE( window_has_accel( toplevel ), "ERROR" );
243 ASSERT_MESSAGE( GTK_WIDGET_TOPLEVEL( toplevel ), "disabling accel for non-toplevel window" );
244 gtk_window_remove_accel_group( toplevel, global_accel );
246 globalOutputStream() << reinterpret_cast<unsigned int>( toplevel ) << ": disabled global accelerators\n";
249 accel_group_test( toplevel, global_accel );
253 buttons = bitfield_enable( buttons, ButtonMask_for_event_button( button ) );
255 globalOutputStream() << "Buttons_press: ";
256 print_buttons( buttons );
261 bool Buttons_release( ButtonMask& buttons, guint button, guint state ){
262 if ( buttons != 0 && bitfield_disable( buttons, ButtonMask_for_event_button( button ) ) == 0 ) {
263 ASSERT_MESSAGE( !g_accel_enabled, "Buttons_release: accelerators are enabled" );
264 g_accel_enabled = true;
265 for ( WindowSet::iterator i = g_accel_windows.begin(); i != g_accel_windows.end(); ++i )
267 GtkWindow* toplevel = *i;
268 ASSERT_MESSAGE( !window_has_accel( toplevel ), "ERROR" );
269 ASSERT_MESSAGE( GTK_WIDGET_TOPLEVEL( toplevel ), "enabling accel for non-toplevel window" );
270 gtk_window_add_accel_group( toplevel, global_accel );
272 globalOutputStream() << reinterpret_cast<unsigned int>( toplevel ) << ": enabled global accelerators\n";
275 accel_group_test( toplevel, global_accel );
278 globalQueuedAccelerators_commit();
280 buttons = bitfield_disable( buttons, ButtonMask_for_event_button( button ) );
282 globalOutputStream() << "Buttons_release: ";
283 print_buttons( buttons );
288 bool Buttons_releaseAll( ButtonMask& buttons ){
289 Buttons_release( buttons, MouseButton::Left | MouseButton::Middle | MouseButton::Right, 0 );
293 struct PressedButtons
297 PressedButtons() : buttons( 0 ){
301 gboolean PressedButtons_button_press( GtkWidget* widget, GdkEventButton* event, PressedButtons* pressed ){
302 if ( event->type == GDK_BUTTON_PRESS ) {
303 return Buttons_press( pressed->buttons, event->button, event->state );
308 gboolean PressedButtons_button_release( GtkWidget* widget, GdkEventButton* event, PressedButtons* pressed ){
309 if ( event->type == GDK_BUTTON_RELEASE ) {
310 return Buttons_release( pressed->buttons, event->button, event->state );
315 gboolean PressedButtons_focus_out( GtkWidget* widget, GdkEventFocus* event, PressedButtons* pressed ){
316 Buttons_releaseAll( pressed->buttons );
320 void PressedButtons_connect( PressedButtons& pressedButtons, GtkWidget* widget ){
321 g_signal_connect( G_OBJECT( widget ), "button_press_event", G_CALLBACK( PressedButtons_button_press ), &pressedButtons );
322 g_signal_connect( G_OBJECT( widget ), "button_release_event", G_CALLBACK( PressedButtons_button_release ), &pressedButtons );
323 g_signal_connect( G_OBJECT( widget ), "focus_out_event", G_CALLBACK( PressedButtons_focus_out ), &pressedButtons );
326 PressedButtons g_pressedButtons;
333 typedef std::set<guint> Keys;
335 std::size_t refcount;
337 PressedKeys() : refcount( 0 ){
341 AcceleratorMap g_keydown_accelerators;
342 AcceleratorMap g_keyup_accelerators;
344 bool Keys_press( PressedKeys::Keys& keys, guint keyval ){
345 if ( keys.insert( keyval ).second ) {
346 return AcceleratorMap_activate( g_keydown_accelerators, accelerator_for_event_key( keyval, 0 ) );
348 return g_keydown_accelerators.find( accelerator_for_event_key( keyval, 0 ) ) != g_keydown_accelerators.end();
351 bool Keys_release( PressedKeys::Keys& keys, guint keyval ){
352 if ( keys.erase( keyval ) != 0 ) {
353 return AcceleratorMap_activate( g_keyup_accelerators, accelerator_for_event_key( keyval, 0 ) );
355 return g_keyup_accelerators.find( accelerator_for_event_key( keyval, 0 ) ) != g_keyup_accelerators.end();
358 void Keys_releaseAll( PressedKeys::Keys& keys, guint state ){
359 for ( PressedKeys::Keys::iterator i = keys.begin(); i != keys.end(); ++i )
361 AcceleratorMap_activate( g_keyup_accelerators, accelerator_for_event_key( *i, state ) );
366 gboolean PressedKeys_key_press( GtkWidget* widget, GdkEventKey* event, PressedKeys* pressedKeys ){
367 //globalOutputStream() << "pressed: " << event->keyval << "\n";
368 return event->state == 0 && Keys_press( pressedKeys->keys, event->keyval );
371 gboolean PressedKeys_key_release( GtkWidget* widget, GdkEventKey* event, PressedKeys* pressedKeys ){
372 //globalOutputStream() << "released: " << event->keyval << "\n";
373 return Keys_release( pressedKeys->keys, event->keyval );
376 gboolean PressedKeys_focus_in( GtkWidget* widget, GdkEventFocus* event, PressedKeys* pressedKeys ){
377 ++pressedKeys->refcount;
381 gboolean PressedKeys_focus_out( GtkWidget* widget, GdkEventFocus* event, PressedKeys* pressedKeys ){
382 if ( --pressedKeys->refcount == 0 ) {
383 Keys_releaseAll( pressedKeys->keys, 0 );
388 PressedKeys g_pressedKeys;
390 void GlobalPressedKeys_releaseAll(){
391 Keys_releaseAll( g_pressedKeys.keys, 0 );
394 void GlobalPressedKeys_connect( GtkWindow* window ){
395 unsigned int key_press_handler = g_signal_connect( G_OBJECT( window ), "key_press_event", G_CALLBACK( PressedKeys_key_press ), &g_pressedKeys );
396 unsigned int key_release_handler = g_signal_connect( G_OBJECT( window ), "key_release_event", G_CALLBACK( PressedKeys_key_release ), &g_pressedKeys );
397 g_object_set_data( G_OBJECT( window ), "key_press_handler", gint_to_pointer( key_press_handler ) );
398 g_object_set_data( G_OBJECT( window ), "key_release_handler", gint_to_pointer( key_release_handler ) );
399 unsigned int focus_in_handler = g_signal_connect( G_OBJECT( window ), "focus_in_event", G_CALLBACK( PressedKeys_focus_in ), &g_pressedKeys );
400 unsigned int focus_out_handler = g_signal_connect( G_OBJECT( window ), "focus_out_event", G_CALLBACK( PressedKeys_focus_out ), &g_pressedKeys );
401 g_object_set_data( G_OBJECT( window ), "focus_in_handler", gint_to_pointer( focus_in_handler ) );
402 g_object_set_data( G_OBJECT( window ), "focus_out_handler", gint_to_pointer( focus_out_handler ) );
405 void GlobalPressedKeys_disconnect( GtkWindow* window ){
406 g_signal_handler_disconnect( G_OBJECT( window ), gpointer_to_int( g_object_get_data( G_OBJECT( window ), "key_press_handler" ) ) );
407 g_signal_handler_disconnect( G_OBJECT( window ), gpointer_to_int( g_object_get_data( G_OBJECT( window ), "key_release_handler" ) ) );
408 g_signal_handler_disconnect( G_OBJECT( window ), gpointer_to_int( g_object_get_data( G_OBJECT( window ), "focus_in_handler" ) ) );
409 g_signal_handler_disconnect( G_OBJECT( window ), gpointer_to_int( g_object_get_data( G_OBJECT( window ), "focus_out_handler" ) ) );
414 void special_accelerators_add( Accelerator accelerator, const Callback& callback ){
415 //globalOutputStream() << "special_accelerators_add: " << makeQuoted(accelerator) << "\n";
416 if ( !accelerator_map_insert( g_special_accelerators, accelerator, callback ) ) {
417 globalErrorStream() << "special_accelerators_add: already exists: " << makeQuoted( accelerator ) << "\n";
420 void special_accelerators_remove( Accelerator accelerator ){
421 //globalOutputStream() << "special_accelerators_remove: " << makeQuoted(accelerator) << "\n";
422 if ( !accelerator_map_erase( g_special_accelerators, accelerator ) ) {
423 globalErrorStream() << "special_accelerators_remove: not found: " << makeQuoted( accelerator ) << "\n";
427 void keydown_accelerators_add( Accelerator accelerator, const Callback& callback ){
428 //globalOutputStream() << "keydown_accelerators_add: " << makeQuoted(accelerator) << "\n";
429 if ( !accelerator_map_insert( g_keydown_accelerators, accelerator, callback ) ) {
430 globalErrorStream() << "keydown_accelerators_add: already exists: " << makeQuoted( accelerator ) << "\n";
433 void keydown_accelerators_remove( Accelerator accelerator ){
434 //globalOutputStream() << "keydown_accelerators_remove: " << makeQuoted(accelerator) << "\n";
435 if ( !accelerator_map_erase( g_keydown_accelerators, accelerator ) ) {
436 globalErrorStream() << "keydown_accelerators_remove: not found: " << makeQuoted( accelerator ) << "\n";
440 void keyup_accelerators_add( Accelerator accelerator, const Callback& callback ){
441 //globalOutputStream() << "keyup_accelerators_add: " << makeQuoted(accelerator) << "\n";
442 if ( !accelerator_map_insert( g_keyup_accelerators, accelerator, callback ) ) {
443 globalErrorStream() << "keyup_accelerators_add: already exists: " << makeQuoted( accelerator ) << "\n";
446 void keyup_accelerators_remove( Accelerator accelerator ){
447 //globalOutputStream() << "keyup_accelerators_remove: " << makeQuoted(accelerator) << "\n";
448 if ( !accelerator_map_erase( g_keyup_accelerators, accelerator ) ) {
449 globalErrorStream() << "keyup_accelerators_remove: not found: " << makeQuoted( accelerator ) << "\n";
454 gboolean accel_closure_callback( GtkAccelGroup* group, GtkWidget* widget, guint key, GdkModifierType modifiers, gpointer data ){
455 ( *reinterpret_cast<Callback*>( data ) )( );
459 GClosure* accel_group_add_accelerator( GtkAccelGroup* group, Accelerator accelerator, const Callback& callback ){
460 if ( accelerator.key != 0 && gtk_accelerator_valid( accelerator.key, accelerator.modifiers ) ) {
461 //globalOutputStream() << "global_accel_connect: " << makeQuoted(accelerator) << "\n";
462 GClosure* closure = create_cclosure( G_CALLBACK( accel_closure_callback ), callback );
463 gtk_accel_group_connect( group, accelerator.key, accelerator.modifiers, GTK_ACCEL_VISIBLE, closure );
468 special_accelerators_add( accelerator, callback );
473 void accel_group_remove_accelerator( GtkAccelGroup* group, Accelerator accelerator ){
474 if ( accelerator.key != 0 && gtk_accelerator_valid( accelerator.key, accelerator.modifiers ) ) {
475 //globalOutputStream() << "global_accel_disconnect: " << makeQuoted(accelerator) << "\n";
476 gtk_accel_group_disconnect_key( group, accelerator.key, accelerator.modifiers );
480 special_accelerators_remove( accelerator );
484 GtkAccelGroup* global_accel = 0;
486 void global_accel_init(){
487 global_accel = gtk_accel_group_new();
490 void global_accel_destroy(){
491 g_object_unref( global_accel );
494 GClosure* global_accel_group_add_accelerator( Accelerator accelerator, const Callback& callback ){
495 if ( !global_accel_enabled() ) {
496 // workaround: cannot add to GtkAccelGroup while it is disabled
497 //globalOutputStream() << "queued for add: " << accelerator << "\n";
498 globalQueuedAccelerators_add( accelerator, callback );
501 return accel_group_add_accelerator( global_accel, accelerator, callback );
503 void global_accel_group_remove_accelerator( Accelerator accelerator ){
504 if ( !global_accel_enabled() ) {
505 //globalOutputStream() << "queued for remove: " << accelerator << "\n";
506 globalQueuedAccelerators_remove( accelerator );
509 accel_group_remove_accelerator( global_accel, accelerator );
512 /// \brief Propagates key events to the focus-widget, overriding global accelerators.
513 static gboolean override_global_accelerators( GtkWindow* window, GdkEventKey* event, gpointer data ){
514 gboolean b = gtk_window_propagate_key_event( window, event );
518 void global_accel_connect_window( GtkWindow* window ){
520 unsigned int override_handler = g_signal_connect( G_OBJECT( window ), "key_press_event", G_CALLBACK( override_global_accelerators ), 0 );
521 g_object_set_data( G_OBJECT( window ), "override_handler", gint_to_pointer( override_handler ) );
523 unsigned int special_key_press_handler = g_signal_connect( G_OBJECT( window ), "key_press_event", G_CALLBACK( accelerator_key_event ), &g_special_accelerators );
524 g_object_set_data( G_OBJECT( window ), "special_key_press_handler", gint_to_pointer( special_key_press_handler ) );
526 GlobalPressedKeys_connect( window );
528 unsigned int key_press_handler = g_signal_connect( G_OBJECT( window ), "key_press_event", G_CALLBACK( accelerator_key_event ), &g_keydown_accelerators );
529 unsigned int key_release_handler = g_signal_connect( G_OBJECT( window ), "key_release_event", G_CALLBACK( accelerator_key_event ), &g_keyup_accelerators );
530 g_object_set_data( G_OBJECT( window ), "key_press_handler", gint_to_pointer( key_press_handler ) );
531 g_object_set_data( G_OBJECT( window ), "key_release_handler", gint_to_pointer( key_release_handler ) );
533 g_accel_windows.insert( window );
534 gtk_window_add_accel_group( window, global_accel );
536 void global_accel_disconnect_window( GtkWindow* window ){
538 GlobalPressedKeys_disconnect( window );
540 g_signal_handler_disconnect( G_OBJECT( window ), gpointer_to_int( g_object_get_data( G_OBJECT( window ), "override_handler" ) ) );
541 g_signal_handler_disconnect( G_OBJECT( window ), gpointer_to_int( g_object_get_data( G_OBJECT( window ), "special_key_press_handler" ) ) );
543 g_signal_handler_disconnect( G_OBJECT( window ), gpointer_to_int( g_object_get_data( G_OBJECT( window ), "key_press_handler" ) ) );
544 g_signal_handler_disconnect( G_OBJECT( window ), gpointer_to_int( g_object_get_data( G_OBJECT( window ), "key_release_handler" ) ) );
546 gtk_window_remove_accel_group( window, global_accel );
547 std::size_t count = g_accel_windows.erase( window );
548 ASSERT_MESSAGE( count == 1, "failed to remove accel group\n" );
552 GClosure* global_accel_group_find( Accelerator accelerator ){
553 guint numEntries = 0;
554 GtkAccelGroupEntry* entry = gtk_accel_group_query( global_accel, accelerator.key, accelerator.modifiers, &numEntries );
555 if ( numEntries != 0 ) {
556 if ( numEntries != 1 ) {
557 char* name = gtk_accelerator_name( accelerator.key, accelerator.modifiers );
558 globalErrorStream() << "accelerator already in-use: " << name << "\n";
561 return entry->closure;
566 void global_accel_group_connect( const Accelerator& accelerator, const Callback& callback ){
567 if ( accelerator.key != 0 ) {
568 global_accel_group_add_accelerator( accelerator, callback );
572 void global_accel_group_disconnect( const Accelerator& accelerator, const Callback& callback ){
573 if ( accelerator.key != 0 ) {
574 global_accel_group_remove_accelerator( accelerator );