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
25 #include "debugging/debugging.h"
29 #include "string/string.h"
30 #include "versionlib.h"
31 #include "gtkutil/messagebox.h"
34 typedef std::pair<Accelerator, int> ShortcutValue; // accelerator, isRegistered
35 typedef std::map<CopiedString, ShortcutValue> Shortcuts;
37 void Shortcuts_foreach( Shortcuts& shortcuts, CommandVisitor& visitor ){
38 for ( Shortcuts::iterator i = shortcuts.begin(); i != shortcuts.end(); ++i )
40 visitor.visit( ( *i ).first.c_str(), ( *i ).second.first );
44 Shortcuts g_shortcuts;
46 const Accelerator& GlobalShortcuts_insert( const char* name, const Accelerator& accelerator ){
47 return ( *g_shortcuts.insert( Shortcuts::value_type( name, ShortcutValue( accelerator, false ) ) ).first ).second.first;
50 void GlobalShortcuts_foreach( CommandVisitor& visitor ){
51 Shortcuts_foreach( g_shortcuts, visitor );
54 void GlobalShortcuts_register( const char* name, int type ){
55 Shortcuts::iterator i = g_shortcuts.find( name );
56 if ( i != g_shortcuts.end() ) {
57 ( *i ).second.second = type;
61 void GlobalShortcuts_reportUnregistered(){
62 for ( Shortcuts::iterator i = g_shortcuts.begin(); i != g_shortcuts.end(); ++i )
64 if ( ( *i ).second.first.key != 0 && !( *i ).second.second ) {
65 globalOutputStream() << "shortcut not registered: " << ( *i ).first.c_str() << "\n";
70 typedef std::map<CopiedString, Command> Commands;
74 void GlobalCommands_insert( const char* name, const Callback& callback, const Accelerator& accelerator ){
75 bool added = g_commands.insert( Commands::value_type( name, Command( callback, GlobalShortcuts_insert( name, accelerator ) ) ) ).second;
76 ASSERT_MESSAGE( added, "command already registered: " << makeQuoted( name ) );
79 const Command& GlobalCommands_find( const char* command ){
80 Commands::iterator i = g_commands.find( command );
81 ASSERT_MESSAGE( i != g_commands.end(), "failed to lookup command " << makeQuoted( command ) );
85 typedef std::map<CopiedString, Toggle> Toggles;
90 void GlobalToggles_insert( const char* name, const Callback& callback, const BoolExportCallback& exportCallback, const Accelerator& accelerator ){
91 bool added = g_toggles.insert( Toggles::value_type( name, Toggle( callback, GlobalShortcuts_insert( name, accelerator ), exportCallback ) ) ).second;
92 ASSERT_MESSAGE( added, "toggle already registered: " << makeQuoted( name ) );
94 const Toggle& GlobalToggles_find( const char* name ){
95 Toggles::iterator i = g_toggles.find( name );
96 ASSERT_MESSAGE( i != g_toggles.end(), "failed to lookup toggle " << makeQuoted( name ) );
100 typedef std::map<CopiedString, KeyEvent> KeyEvents;
103 KeyEvents g_keyEvents;
105 void GlobalKeyEvents_insert( const char* name, const Accelerator& accelerator, const Callback& keyDown, const Callback& keyUp ){
106 bool added = g_keyEvents.insert( KeyEvents::value_type( name, KeyEvent( GlobalShortcuts_insert( name, accelerator ), keyDown, keyUp ) ) ).second;
107 ASSERT_MESSAGE( added, "command already registered: " << makeQuoted( name ) );
109 const KeyEvent& GlobalKeyEvents_find( const char* name ){
110 KeyEvents::iterator i = g_keyEvents.find( name );
111 ASSERT_MESSAGE( i != g_keyEvents.end(), "failed to lookup keyEvent " << makeQuoted( name ) );
112 return ( *i ).second;
116 void disconnect_accelerator( const char *name ){
117 Shortcuts::iterator i = g_shortcuts.find( name );
118 if ( i != g_shortcuts.end() ) {
119 switch ( ( *i ).second.second )
123 command_disconnect_accelerator( name );
127 toggle_remove_accelerator( name );
133 void connect_accelerator( const char *name ){
134 Shortcuts::iterator i = g_shortcuts.find( name );
135 if ( i != g_shortcuts.end() ) {
136 switch ( ( *i ).second.second )
140 command_connect_accelerator( name );
144 toggle_add_accelerator( name );
151 #include <uilib/uilib.h>
152 #include <gdk/gdkkeysyms.h>
153 #include <util/buffer.h>
155 #include "gtkutil/dialog.h"
156 #include "mainframe.h"
158 #include "stream/textfilestream.h"
159 #include "stream/stringstream.h"
162 struct command_list_dialog_t : public ModalDialog
164 command_list_dialog_t()
165 : m_close_button( *this, eIDCANCEL ), m_list( NULL ), m_command_iter(), m_model( NULL ), m_waiting_for_key( false ){
167 ModalDialogButton m_close_button;
170 GtkTreeIter m_command_iter;
171 GtkTreeModel *m_model;
172 bool m_waiting_for_key;
175 void accelerator_clear_button_clicked( GtkButton *btn, gpointer dialogptr ){
176 command_list_dialog_t &dialog = *(command_list_dialog_t *) dialogptr;
178 if ( dialog.m_waiting_for_key ) {
179 // just unhighlight, user wanted to cancel
180 dialog.m_waiting_for_key = false;
181 gtk_list_store_set( GTK_LIST_STORE( dialog.m_model ), &dialog.m_command_iter, 2, false, -1 );
182 gtk_widget_set_sensitive( GTK_WIDGET( dialog.m_list ), true );
183 dialog.m_model = NULL;
187 GtkTreeSelection *sel = gtk_tree_view_get_selection( dialog.m_list );
190 if ( !gtk_tree_selection_get_selected( sel, &model, &iter ) ) {
195 memset( &val, 0, sizeof( val ) );
196 gtk_tree_model_get_value( GTK_TREE_MODEL( model ), &iter, 0, &val );
197 const char *commandName = g_value_get_string( &val );;
199 // clear the ACTUAL accelerator too!
200 disconnect_accelerator( commandName );
202 Shortcuts::iterator thisShortcutIterator = g_shortcuts.find( commandName );
203 if ( thisShortcutIterator == g_shortcuts.end() ) {
206 thisShortcutIterator->second.first = accelerator_null();
208 gtk_list_store_set( GTK_LIST_STORE( model ), &iter, 1, "", -1 );
210 g_value_unset( &val );
213 void accelerator_edit_button_clicked( GtkButton *btn, gpointer dialogptr ){
214 command_list_dialog_t &dialog = *(command_list_dialog_t *) dialogptr;
216 // 1. find selected row
217 GtkTreeSelection *sel = gtk_tree_view_get_selection( dialog.m_list );
220 if ( !gtk_tree_selection_get_selected( sel, &model, &iter ) ) {
223 dialog.m_command_iter = iter;
224 dialog.m_model = model;
226 // 2. disallow changing the row
227 //gtk_widget_set_sensitive(GTK_WIDGET(dialog.m_list), false);
229 // 3. highlight the row
230 gtk_list_store_set( GTK_LIST_STORE( model ), &iter, 2, true, -1 );
232 // 4. grab keyboard focus
233 dialog.m_waiting_for_key = true;
236 bool accelerator_window_key_press( ui::Widget widget, GdkEventKey *event, gpointer dialogptr ){
237 command_list_dialog_t &dialog = *(command_list_dialog_t *) dialogptr;
239 if ( !dialog.m_waiting_for_key ) {
244 if ( event->is_modifier ) {
248 switch ( event->keyval )
250 case GDK_KEY_Shift_L:
251 case GDK_KEY_Shift_R:
252 case GDK_KEY_Control_L:
253 case GDK_KEY_Control_R:
254 case GDK_KEY_Caps_Lock:
255 case GDK_KEY_Shift_Lock:
260 case GDK_KEY_Super_L:
261 case GDK_KEY_Super_R:
262 case GDK_KEY_Hyper_L:
263 case GDK_KEY_Hyper_R:
268 dialog.m_waiting_for_key = false;
270 // 7. find the name of the accelerator
272 memset( &val, 0, sizeof( val ) );
273 gtk_tree_model_get_value( GTK_TREE_MODEL( dialog.m_model ), &dialog.m_command_iter, 0, &val );
274 const char *commandName = g_value_get_string( &val );;
275 Shortcuts::iterator thisShortcutIterator = g_shortcuts.find( commandName );
276 if ( thisShortcutIterator == g_shortcuts.end() ) {
277 gtk_list_store_set( GTK_LIST_STORE( dialog.m_model ), &dialog.m_command_iter, 2, false, -1 );
278 gtk_widget_set_sensitive( GTK_WIDGET( dialog.m_list ), true );
282 // 8. build an Accelerator
283 Accelerator newAccel( event->keyval, (GdkModifierType) event->state );
285 // 8. verify the key is still free, show a dialog to ask what to do if not
286 class VerifyAcceleratorNotTaken : public CommandVisitor
288 const char *commandName;
289 const Accelerator &newAccel;
294 VerifyAcceleratorNotTaken( const char *name, const Accelerator &accelerator, ui::Widget w, GtkTreeModel *m ) : commandName( name ), newAccel( accelerator ), widget( w ), model( m ), allow( true ){
296 void visit( const char* name, Accelerator& accelerator ){
297 if ( !strcmp( name, commandName ) ) {
303 if ( accelerator.key == 0 ) {
306 if ( accelerator == newAccel ) {
307 StringOutputStream msg;
308 msg << "The command " << name << " is already assigned to the key " << accelerator << ".\n\n"
309 << "Do you want to unassign " << name << " first?";
310 auto r = widget.alert( msg.c_str(), "Key already used", ui::alert_type::YESNOCANCEL );
311 if ( r == ui::alert_response::YES ) {
312 // clear the ACTUAL accelerator too!
313 disconnect_accelerator( name );
314 // delete the modifier
315 accelerator = accelerator_null();
316 // empty the cell of the key binds dialog
318 if ( gtk_tree_model_get_iter_first( GTK_TREE_MODEL( model ), &i ) ) {
322 memset( &val, 0, sizeof( val ) );
323 gtk_tree_model_get_value( GTK_TREE_MODEL( model ), &i, 0, &val );
324 const char *thisName = g_value_get_string( &val );;
325 if ( !strcmp( thisName, name ) ) {
326 gtk_list_store_set( GTK_LIST_STORE( model ), &i, 1, "", -1 );
328 g_value_unset( &val );
329 if ( !gtk_tree_model_iter_next( GTK_TREE_MODEL( model ), &i ) ) {
335 else if ( r == ui::alert_response::CANCEL ) {
341 } verify_visitor( commandName, newAccel, widget, dialog.m_model );
342 GlobalShortcuts_foreach( verify_visitor );
344 gtk_list_store_set( GTK_LIST_STORE( dialog.m_model ), &dialog.m_command_iter, 2, false, -1 );
345 gtk_widget_set_sensitive( GTK_WIDGET( dialog.m_list ), true );
347 if ( verify_visitor.allow ) {
348 // clear the ACTUAL accelerator first
349 disconnect_accelerator( commandName );
351 thisShortcutIterator->second.first = newAccel;
353 // write into the cell
354 StringOutputStream modifiers;
355 modifiers << newAccel;
356 gtk_list_store_set( GTK_LIST_STORE( dialog.m_model ), &dialog.m_command_iter, 1, modifiers.c_str(), -1 );
358 // set the ACTUAL accelerator too!
359 connect_accelerator( commandName );
362 g_value_unset( &val );
364 dialog.m_model = NULL;
372 if(!model) {g_error("Unable to get model from cell renderer");}
373 gtk_tree_model_get_iter_from_string(GTK_TREE_MODEL(model), &row, path_string);
375 gtk_tree_model_get_value(GTK_TREE_MODEL(model), &row, 0, &val);
376 const char *name = g_value_get_string(&val);
377 Shortcuts::iterator i = g_shortcuts.find(name);
378 if(i != g_shortcuts.end())
380 accelerator_parse(i->second.first, new_text);
381 StringOutputStream modifiers;
382 modifiers << i->second.first;
383 gtk_list_store_set(GTK_LIST_STORE(model), &row, 1, modifiers.c_str(), -1);
388 void DoCommandListDlg(){
389 command_list_dialog_t dialog;
391 ui::Window window = MainFrame_getWindow().create_modal_dialog_window("Mapped Commands", dialog, -1, 400);
392 window.on_key_press([](ui::Widget widget, GdkEventKey *event, gpointer dialogptr) {
393 return accelerator_window_key_press(widget, event, dialogptr);
396 auto accel = ui::AccelGroup(ui::New);
397 window.add_accel_group( accel );
399 auto hbox = create_dialog_hbox( 4, 4 );
403 auto scr = create_scrolled_window( ui::Policy::NEVER, ui::Policy::AUTOMATIC );
404 gtk_box_pack_start( GTK_BOX( hbox ), GTK_WIDGET( scr ), TRUE, TRUE, 0 );
407 ui::ListStore store = ui::ListStore(gtk_list_store_new( 4, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_BOOLEAN, G_TYPE_INT ));
409 ui::Widget view = ui::TreeView(ui::TreeModel(GTK_TREE_MODEL(store)));
410 dialog.m_list = GTK_TREE_VIEW( view );
412 gtk_tree_view_set_enable_search( GTK_TREE_VIEW( view ), false ); // annoying
415 auto renderer = ui::CellRendererText(ui::New);
416 GtkTreeViewColumn* column = ui::TreeViewColumn( "Command", renderer, {{"text", 0}, {"weight-set", 2}, {"weight", 3}} );
417 gtk_tree_view_append_column( GTK_TREE_VIEW( view ), column );
421 auto renderer = ui::CellRendererText(ui::New);
422 GtkTreeViewColumn* column = ui::TreeViewColumn( "Key", renderer, {{"text", 1}, {"weight-set", 2}, {"weight", 3}} );
423 gtk_tree_view_append_column( GTK_TREE_VIEW( view ), column );
431 StringOutputStream path( 256 );
432 path << SettingsPath_get() << "commandlist.txt";
433 globalOutputStream() << "Writing the command list to " << path.c_str() << "\n";
434 class BuildCommandList : public CommandVisitor
436 TextFileOutputStream m_commandList;
437 ui::ListStore m_store;
439 BuildCommandList( const char* filename, ui::ListStore store ) : m_commandList( filename ), m_store( store ){
441 void visit( const char* name, Accelerator& accelerator ){
442 StringOutputStream modifiers;
443 modifiers << accelerator;
447 gtk_list_store_append( m_store, &iter );
448 gtk_list_store_set( m_store, &iter, 0, name, 1, modifiers.c_str(), 2, false, 3, 800, -1 );
451 if ( !m_commandList.failed() ) {
452 int l = strlen( name );
453 m_commandList << name;
455 m_commandList << ' ';
456 m_commandList << modifiers.c_str() << '\n';
459 } visitor( path.c_str(), store );
461 GlobalShortcuts_foreach( visitor );
468 GtkVBox* vbox = create_dialog_vbox( 4 );
469 gtk_box_pack_start( GTK_BOX( hbox ), GTK_WIDGET( vbox ), TRUE, TRUE, 0 );
471 GtkButton* editbutton = create_dialog_button( "Edit", (GCallback) accelerator_edit_button_clicked, &dialog );
472 gtk_box_pack_start( GTK_BOX( vbox ), GTK_WIDGET( editbutton ), FALSE, FALSE, 0 );
474 GtkButton* clearbutton = create_dialog_button( "Clear", (GCallback) accelerator_clear_button_clicked, &dialog );
475 gtk_box_pack_start( GTK_BOX( vbox ), GTK_WIDGET( clearbutton ), FALSE, FALSE, 0 );
477 ui::Widget spacer = ui::Image(ui::New);
479 gtk_box_pack_start( GTK_BOX( vbox ), GTK_WIDGET( spacer ), TRUE, TRUE, 0 );
481 auto button = create_modal_dialog_button( "Close", dialog.m_close_button );
482 gtk_box_pack_start( GTK_BOX( vbox ), GTK_WIDGET( button ), FALSE, FALSE, 0 );
483 widget_make_default( button );
484 gtk_widget_grab_default( GTK_WIDGET( button ) );
485 gtk_widget_add_accelerator( GTK_WIDGET( button ), "clicked", accel, GDK_KEY_Return, (GdkModifierType)0, (GtkAccelFlags)0 );
486 gtk_widget_add_accelerator( GTK_WIDGET( button ), "clicked", accel, GDK_KEY_Escape, (GdkModifierType)0, (GtkAccelFlags)0 );
489 modal_dialog_show( window, dialog );
490 gtk_widget_destroy( GTK_WIDGET( window ) );
493 #include "profile/profile.h"
495 const char* const COMMANDS_VERSION = "1.0-gtk-accelnames";
497 void SaveCommandMap( const char* path ){
498 StringOutputStream strINI( 256 );
499 strINI << path << "shortcuts.ini";
501 TextFileOutputStream file( strINI.c_str() );
502 if ( !file.failed() ) {
503 file << "[Version]\n";
504 file << "number=" << COMMANDS_VERSION << "\n";
506 file << "[Commands]\n";
507 class WriteCommandMap : public CommandVisitor
509 TextFileOutputStream& m_file;
511 WriteCommandMap( TextFileOutputStream& file ) : m_file( file ){
513 void visit( const char* name, Accelerator& accelerator ){
514 m_file << name << "=";
516 const char* key = gtk_accelerator_name( accelerator.key, accelerator.modifiers );
521 GlobalShortcuts_foreach( visitor );
525 const char* stringrange_find( const char* first, const char* last, char c ){
526 const char* p = strchr( first, '+' );
533 class ReadCommandMap : public CommandVisitor
535 const char* m_filename;
538 ReadCommandMap( const char* filename ) : m_filename( filename ), m_count( 0 ){
540 void visit( const char* name, Accelerator& accelerator ){
541 auto value = u::buffer<1024>();
542 if ( read_var( m_filename, "Commands", name, value ) ) {
543 if ( string_empty( value ) ) {
545 accelerator.modifiers = (GdkModifierType)0;
549 gtk_accelerator_parse( value, &accelerator.key, &accelerator.modifiers );
550 accelerator = accelerator; // fix modifiers
552 if ( accelerator.key != 0 ) {
557 globalOutputStream() << "WARNING: failed to parse user command " << makeQuoted( name ) << ": unknown key " << makeQuoted( value ) << "\n";
561 std::size_t count() const {
566 void LoadCommandMap( const char* path ){
567 StringOutputStream strINI( 256 );
568 strINI << path << "shortcuts.ini";
570 FILE* f = fopen( strINI.c_str(), "r" );
573 globalOutputStream() << "loading custom shortcuts list from " << makeQuoted( strINI.c_str() ) << "\n";
575 Version version = version_parse( COMMANDS_VERSION );
576 Version dataVersion = { 0, 0 };
579 auto value = u::buffer<1024>();
580 if ( read_var( strINI.c_str(), "Version", "number", value ) ) {
581 dataVersion = version_parse( value );
585 if ( version_compatible( version, dataVersion ) ) {
586 globalOutputStream() << "commands import: data version " << dataVersion << " is compatible with code version " << version << "\n";
587 ReadCommandMap visitor( strINI.c_str() );
588 GlobalShortcuts_foreach( visitor );
589 globalOutputStream() << "parsed " << Unsigned( visitor.count() ) << " custom shortcuts\n";
593 globalOutputStream() << "commands import: data version " << dataVersion << " is not compatible with code version " << version << "\n";
598 globalOutputStream() << "failed to load custom shortcuts from " << makeQuoted( strINI.c_str() ) << "\n";