299958dc00ddb93713cf68802f4d5419c0f07c75
[xonotic/netradiant.git] / radiant / commands.cpp
1 /*
2    Copyright (C) 2001-2006, William Joseph.
3    All Rights Reserved.
4
5    This file is part of GtkRadiant.
6
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.
11
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.
16
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
20  */
21
22 #include "commands.h"
23
24 #include "gtk/gtk.h"
25 #include "debugging/debugging.h"
26 #include "warnings.h"
27
28 #include <map>
29 #include "string/string.h"
30 #include "versionlib.h"
31 #include "gtkutil/messagebox.h"
32 #include "gtkmisc.h"
33
34 typedef std::pair<Accelerator, int> ShortcutValue; // accelerator, isRegistered
35 typedef std::map<CopiedString, ShortcutValue> Shortcuts;
36
37 void Shortcuts_foreach( Shortcuts& shortcuts, CommandVisitor& visitor ){
38         for ( Shortcuts::iterator i = shortcuts.begin(); i != shortcuts.end(); ++i )
39         {
40                 visitor.visit( ( *i ).first.c_str(), ( *i ).second.first );
41         }
42 }
43
44 Shortcuts g_shortcuts;
45
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;
48 }
49
50 void GlobalShortcuts_foreach( CommandVisitor& visitor ){
51         Shortcuts_foreach( g_shortcuts, visitor );
52 }
53
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;
58         }
59 }
60
61 void GlobalShortcuts_reportUnregistered(){
62         for ( Shortcuts::iterator i = g_shortcuts.begin(); i != g_shortcuts.end(); ++i )
63         {
64                 if ( ( *i ).second.first.key != 0 && !( *i ).second.second ) {
65                         globalOutputStream() << "shortcut not registered: " << ( *i ).first.c_str() << "\n";
66                 }
67         }
68 }
69
70 typedef std::map<CopiedString, Command> Commands;
71
72 Commands g_commands;
73
74 void GlobalCommands_insert( const char* name, const Callback<void()>& 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 ) );
77 }
78
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 ) );
82         return ( *i ).second;
83 }
84
85 typedef std::map<CopiedString, Toggle> Toggles;
86
87
88 Toggles g_toggles;
89
90 void GlobalToggles_insert( const char* name, const Callback<void()>& callback, const ImportExportCallback<bool>::Export_t& 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 ) );
93 }
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 ) );
97         return ( *i ).second;
98 }
99
100 typedef std::map<CopiedString, KeyEvent> KeyEvents;
101
102
103 KeyEvents g_keyEvents;
104
105 void GlobalKeyEvents_insert( const char* name, const Accelerator& accelerator, const Callback<void()>& keyDown, const Callback<void()>& 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 ) );
108 }
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;
113 }
114
115
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 )
120                 {
121                 case 1:
122                         // command
123                         command_disconnect_accelerator( name );
124                         break;
125                 case 2:
126                         // toggle
127                         toggle_remove_accelerator( name );
128                         break;
129                 }
130         }
131 }
132
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 )
137                 {
138                 case 1:
139                         // command
140                         command_connect_accelerator( name );
141                         break;
142                 case 2:
143                         // toggle
144                         toggle_add_accelerator( name );
145                         break;
146                 }
147         }
148 }
149
150
151 #include <uilib/uilib.h>
152 #include <gdk/gdkkeysyms.h>
153
154 #include "gtkutil/dialog.h"
155 #include "mainframe.h"
156
157 #include "stream/textfilestream.h"
158 #include "stream/stringstream.h"
159
160
161 struct command_list_dialog_t : public ModalDialog
162 {
163         command_list_dialog_t()
164                 : m_close_button( *this, eIDCANCEL ), m_list( NULL ), m_command_iter(), m_model( NULL ), m_waiting_for_key( false ){
165         }
166         ModalDialogButton m_close_button;
167
168         ui::TreeView m_list;
169         GtkTreeIter m_command_iter;
170         ui::TreeModel m_model;
171         bool m_waiting_for_key;
172 };
173
174 void accelerator_clear_button_clicked( ui::Button btn, gpointer dialogptr ){
175         command_list_dialog_t &dialog = *(command_list_dialog_t *) dialogptr;
176
177         if ( dialog.m_waiting_for_key ) {
178                 // just unhighlight, user wanted to cancel
179                 dialog.m_waiting_for_key = false;
180                 gtk_list_store_set( ui::ListStore::from( dialog.m_model ), &dialog.m_command_iter, 2, false, -1 );
181                 gtk_widget_set_sensitive( dialog.m_list , true );
182                 dialog.m_model = ui::TreeModel(ui::null);
183                 return;
184         }
185
186         auto sel = gtk_tree_view_get_selection( dialog.m_list );
187         GtkTreeModel *model;
188         GtkTreeIter iter;
189         if ( !gtk_tree_selection_get_selected( sel, &model, &iter ) ) {
190                 return;
191         }
192
193         GValue val;
194         memset( &val, 0, sizeof( val ) );
195         gtk_tree_model_get_value(model, &iter, 0, &val );
196         const char *commandName = g_value_get_string( &val );;
197
198         // clear the ACTUAL accelerator too!
199         disconnect_accelerator( commandName );
200
201         Shortcuts::iterator thisShortcutIterator = g_shortcuts.find( commandName );
202         if ( thisShortcutIterator == g_shortcuts.end() ) {
203                 return;
204         }
205         thisShortcutIterator->second.first = accelerator_null();
206
207         gtk_list_store_set( ui::ListStore::from( model ), &iter, 1, "", -1 );
208
209         g_value_unset( &val );
210 }
211
212 void accelerator_edit_button_clicked( ui::Button btn, gpointer dialogptr ){
213         command_list_dialog_t &dialog = *(command_list_dialog_t *) dialogptr;
214
215         // 1. find selected row
216         auto sel = gtk_tree_view_get_selection( dialog.m_list );
217         GtkTreeModel *model;
218         GtkTreeIter iter;
219         if ( !gtk_tree_selection_get_selected( sel, &model, &iter ) ) {
220                 return;
221         }
222         dialog.m_command_iter = iter;
223         dialog.m_model = ui::TreeModel(model);
224
225         // 2. disallow changing the row
226         //gtk_widget_set_sensitive(dialog.m_list, false);
227
228         // 3. highlight the row
229         gtk_list_store_set( ui::ListStore::from( model ), &iter, 2, true, -1 );
230
231         // 4. grab keyboard focus
232         dialog.m_waiting_for_key = true;
233 }
234
235 bool accelerator_window_key_press( ui::Window widget, GdkEventKey *event, gpointer dialogptr ){
236         command_list_dialog_t &dialog = *(command_list_dialog_t *) dialogptr;
237
238         if ( !dialog.m_waiting_for_key ) {
239                 return false;
240         }
241
242 #if 0
243         if ( event->is_modifier ) {
244                 return false;
245         }
246 #else
247         switch ( event->keyval )
248         {
249         case GDK_KEY_Shift_L:
250         case GDK_KEY_Shift_R:
251         case GDK_KEY_Control_L:
252         case GDK_KEY_Control_R:
253         case GDK_KEY_Caps_Lock:
254         case GDK_KEY_Shift_Lock:
255         case GDK_KEY_Meta_L:
256         case GDK_KEY_Meta_R:
257         case GDK_KEY_Alt_L:
258         case GDK_KEY_Alt_R:
259         case GDK_KEY_Super_L:
260         case GDK_KEY_Super_R:
261         case GDK_KEY_Hyper_L:
262         case GDK_KEY_Hyper_R:
263                 return false;
264         }
265 #endif
266
267         dialog.m_waiting_for_key = false;
268
269         // 7. find the name of the accelerator
270         GValue val;
271         memset( &val, 0, sizeof( val ) );
272         gtk_tree_model_get_value(dialog.m_model, &dialog.m_command_iter, 0, &val );
273         const char *commandName = g_value_get_string( &val );;
274         Shortcuts::iterator thisShortcutIterator = g_shortcuts.find( commandName );
275         if ( thisShortcutIterator == g_shortcuts.end() ) {
276                 gtk_list_store_set( ui::ListStore::from( dialog.m_model ), &dialog.m_command_iter, 2, false, -1 );
277                 gtk_widget_set_sensitive( dialog.m_list , true );
278                 return true;
279         }
280
281         // 8. build an Accelerator
282         Accelerator newAccel( event->keyval, (GdkModifierType) event->state );
283
284         // 8. verify the key is still free, show a dialog to ask what to do if not
285         class VerifyAcceleratorNotTaken : public CommandVisitor
286         {
287         const char *commandName;
288         const Accelerator &newAccel;
289         ui::Widget widget;
290         ui::TreeModel model;
291 public:
292         bool allow;
293         VerifyAcceleratorNotTaken( const char *name, const Accelerator &accelerator, ui::Widget w, ui::TreeModel m ) : commandName( name ), newAccel( accelerator ), widget( w ), model( m ), allow( true ){
294         }
295         void visit( const char* name, Accelerator& accelerator ){
296                 if ( !strcmp( name, commandName ) ) {
297                         return;
298                 }
299                 if ( !allow ) {
300                         return;
301                 }
302                 if ( accelerator.key == 0 ) {
303                         return;
304                 }
305                 if ( accelerator == newAccel ) {
306                         StringOutputStream msg;
307                         msg << "The command " << name << " is already assigned to the key " << accelerator << ".\n\n"
308                                 << "Do you want to unassign " << name << " first?";
309                         auto r = widget.window().alert( msg.c_str(), "Key already used", ui::alert_type::YESNOCANCEL );
310                         if ( r == ui::alert_response::YES ) {
311                                 // clear the ACTUAL accelerator too!
312                                 disconnect_accelerator( name );
313                                 // delete the modifier
314                                 accelerator = accelerator_null();
315                                 // empty the cell of the key binds dialog
316                                 GtkTreeIter i;
317                                 if ( gtk_tree_model_get_iter_first(model, &i ) ) {
318                                         for (;; )
319                                         {
320                                                 GValue val;
321                                                 memset( &val, 0, sizeof( val ) );
322                                                 gtk_tree_model_get_value(model, &i, 0, &val );
323                                                 const char *thisName = g_value_get_string( &val );;
324                                                 if ( !strcmp( thisName, name ) ) {
325                                                         gtk_list_store_set( ui::ListStore::from( model ), &i, 1, "", -1 );
326                                                 }
327                                                 g_value_unset( &val );
328                                                 if ( !gtk_tree_model_iter_next(model, &i ) ) {
329                                                         break;
330                                                 }
331                                         }
332                                 }
333                         }
334                         else if ( r == ui::alert_response::CANCEL ) {
335                                 // aborted
336                                 allow = false;
337                         }
338                 }
339         }
340         } verify_visitor( commandName, newAccel, widget, dialog.m_model );
341         GlobalShortcuts_foreach( verify_visitor );
342
343         gtk_list_store_set( ui::ListStore::from( dialog.m_model ), &dialog.m_command_iter, 2, false, -1 );
344         gtk_widget_set_sensitive( dialog.m_list , true );
345
346         if ( verify_visitor.allow ) {
347                 // clear the ACTUAL accelerator first
348                 disconnect_accelerator( commandName );
349
350                 thisShortcutIterator->second.first = newAccel;
351
352                 // write into the cell
353                 StringOutputStream modifiers;
354                 modifiers << newAccel;
355                 gtk_list_store_set( ui::ListStore::from( dialog.m_model ), &dialog.m_command_iter, 1, modifiers.c_str(), -1 );
356
357                 // set the ACTUAL accelerator too!
358                 connect_accelerator( commandName );
359         }
360
361         g_value_unset( &val );
362
363         dialog.m_model = ui::TreeModel(ui::null);
364
365         return true;
366 }
367
368 /*
369     GtkTreeIter row;
370     GValue val;
371     if(!model) {g_error("Unable to get model from cell renderer");}
372     gtk_tree_model_get_iter_from_string(model, &row, path_string);
373
374     gtk_tree_model_get_value(model, &row, 0, &val);
375     const char *name = g_value_get_string(&val);
376     Shortcuts::iterator i = g_shortcuts.find(name);
377     if(i != g_shortcuts.end())
378     {
379         accelerator_parse(i->second.first, new_text);
380         StringOutputStream modifiers;
381         modifiers << i->second.first;
382         gtk_list_store_set(ui::ListStore::from(model), &row, 1, modifiers.c_str(), -1);
383     }
384    };
385  */
386
387 void DoCommandListDlg(){
388         command_list_dialog_t dialog;
389
390         ui::Window window = MainFrame_getWindow().create_modal_dialog_window("Mapped Commands", dialog, -1, 400);
391         window.on_key_press([](ui::Widget widget, GdkEventKey *event, gpointer dialogptr) {
392                 return accelerator_window_key_press(ui::Window::from(widget), event, dialogptr);
393         }, &dialog);
394
395         auto accel = ui::AccelGroup(ui::New);
396         window.add_accel_group( accel );
397
398         auto hbox = create_dialog_hbox( 4, 4 );
399         window.add(hbox);
400
401         {
402                 auto scr = create_scrolled_window( ui::Policy::NEVER, ui::Policy::AUTOMATIC );
403                 hbox.pack_start( scr, TRUE, TRUE, 0 );
404
405                 {
406                         ui::ListStore store = ui::ListStore(gtk_list_store_new( 4, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_BOOLEAN, G_TYPE_INT ));
407
408                         auto view = ui::TreeView(ui::TreeModel(store));
409                         dialog.m_list = view;
410
411                         gtk_tree_view_set_enable_search(view, false ); // annoying
412
413                         {
414                                 auto renderer = ui::CellRendererText(ui::New);
415                                 auto column = ui::TreeViewColumn( "Command", renderer, {{"text", 0}, {"weight-set", 2}, {"weight", 3}} );
416                                 gtk_tree_view_append_column(view, column );
417                         }
418
419                         {
420                                 auto renderer = ui::CellRendererText(ui::New);
421                                 auto column = ui::TreeViewColumn( "Key", renderer, {{"text", 1}, {"weight-set", 2}, {"weight", 3}} );
422                                 gtk_tree_view_append_column(view, column );
423                         }
424
425                         view.show();
426                         scr.add(view);
427
428                         {
429                                 // Initialize dialog
430                                 StringOutputStream path( 256 );
431                                 path << SettingsPath_get() << "commandlist.txt";
432                                 globalOutputStream() << "Writing the command list to " << path.c_str() << "\n";
433                                 class BuildCommandList : public CommandVisitor
434                                 {
435                                 TextFileOutputStream m_commandList;
436                                 ui::ListStore m_store;
437 public:
438                                 BuildCommandList( const char* filename, ui::ListStore store ) : m_commandList( filename ), m_store( store ){
439                                 }
440                                 void visit( const char* name, Accelerator& accelerator ){
441                                         StringOutputStream modifiers;
442                                         modifiers << accelerator;
443
444                                         m_store.append(0, name, 1, modifiers.c_str(), 2, false, 3, 800);
445
446                                         if ( !m_commandList.failed() ) {
447                                                 int l = strlen( name );
448                                                 m_commandList << name;
449                                                 while ( l++ < 25 )
450                                                         m_commandList << ' ';
451                                                 m_commandList << modifiers.c_str() << '\n';
452                                         }
453                                 }
454                                 } visitor( path.c_str(), store );
455
456                                 GlobalShortcuts_foreach( visitor );
457                         }
458
459                         store.unref();
460                 }
461         }
462
463         auto vbox = create_dialog_vbox( 4 );
464         hbox.pack_start( vbox, TRUE, TRUE, 0 );
465         {
466                 auto editbutton = create_dialog_button( "Edit", (GCallback) accelerator_edit_button_clicked, &dialog );
467                 vbox.pack_start( editbutton, FALSE, FALSE, 0 );
468
469                 auto clearbutton = create_dialog_button( "Clear", (GCallback) accelerator_clear_button_clicked, &dialog );
470                 vbox.pack_start( clearbutton, FALSE, FALSE, 0 );
471
472                 ui::Widget spacer = ui::Image(ui::New);
473                 spacer.show();
474                 vbox.pack_start( spacer, TRUE, TRUE, 0 );
475
476                 auto button = create_modal_dialog_button( "Close", dialog.m_close_button );
477                 vbox.pack_start( button, FALSE, FALSE, 0 );
478                 widget_make_default( button );
479                 gtk_widget_grab_default( button  );
480                 gtk_widget_add_accelerator( button , "clicked", accel, GDK_KEY_Return, (GdkModifierType)0, (GtkAccelFlags)0 );
481                 gtk_widget_add_accelerator( button , "clicked", accel, GDK_KEY_Escape, (GdkModifierType)0, (GtkAccelFlags)0 );
482         }
483
484         modal_dialog_show( window, dialog );
485         window.destroy();
486 }
487
488 #include "profile/profile.h"
489
490 const char* const COMMANDS_VERSION = "1.0-gtk-accelnames";
491
492 void SaveCommandMap( const char* path ){
493         StringOutputStream strINI( 256 );
494         strINI << path << "shortcuts.ini";
495
496         TextFileOutputStream file( strINI.c_str() );
497         if ( !file.failed() ) {
498                 file << "[Version]\n";
499                 file << "number=" << COMMANDS_VERSION << "\n";
500                 file << "\n";
501                 file << "[Commands]\n";
502                 class WriteCommandMap : public CommandVisitor
503                 {
504                 TextFileOutputStream& m_file;
505 public:
506                 WriteCommandMap( TextFileOutputStream& file ) : m_file( file ){
507                 }
508                 void visit( const char* name, Accelerator& accelerator ){
509                         m_file << name << "=";
510
511                         const char* key = gtk_accelerator_name( accelerator.key, accelerator.modifiers );
512                         m_file << key;
513                         m_file << "\n";
514                 }
515                 } visitor( file );
516                 GlobalShortcuts_foreach( visitor );
517         }
518 }
519
520 const char* stringrange_find( const char* first, const char* last, char c ){
521         const char* p = strchr( first, '+' );
522         if ( p == 0 ) {
523                 return last;
524         }
525         return p;
526 }
527
528 class ReadCommandMap : public CommandVisitor
529 {
530 const char* m_filename;
531 std::size_t m_count;
532 public:
533 ReadCommandMap( const char* filename ) : m_filename( filename ), m_count( 0 ){
534 }
535 void visit( const char* name, Accelerator& accelerator ){
536         char value[1024];
537         if ( read_var( m_filename, "Commands", name, value ) ) {
538                 if ( string_empty( value ) ) {
539                         accelerator.key = 0;
540                         accelerator.modifiers = (GdkModifierType)0;
541                         return;
542                 }
543
544                 gtk_accelerator_parse( value, &accelerator.key, &accelerator.modifiers );
545                 accelerator = accelerator; // fix modifiers
546
547                 if ( accelerator.key != 0 ) {
548                         ++m_count;
549                 }
550                 else
551                 {
552                         globalOutputStream() << "WARNING: failed to parse user command " << makeQuoted( name ) << ": unknown key " << makeQuoted( value ) << "\n";
553                 }
554         }
555 }
556 std::size_t count() const {
557         return m_count;
558 }
559 };
560
561 void LoadCommandMap( const char* path ){
562         StringOutputStream strINI( 256 );
563         strINI << path << "shortcuts.ini";
564
565         FILE* f = fopen( strINI.c_str(), "r" );
566         if ( f != 0 ) {
567                 fclose( f );
568                 globalOutputStream() << "loading custom shortcuts list from " << makeQuoted( strINI.c_str() ) << "\n";
569
570                 Version version = version_parse( COMMANDS_VERSION );
571                 Version dataVersion = { 0, 0 };
572
573                 {
574                         char value[1024];
575                         if ( read_var( strINI.c_str(), "Version", "number", value ) ) {
576                                 dataVersion = version_parse( value );
577                         }
578                 }
579
580                 if ( version_compatible( version, dataVersion ) ) {
581                         globalOutputStream() << "commands import: data version " << dataVersion << " is compatible with code version " << version << "\n";
582                         ReadCommandMap visitor( strINI.c_str() );
583                         GlobalShortcuts_foreach( visitor );
584                         globalOutputStream() << "parsed " << Unsigned( visitor.count() ) << " custom shortcuts\n";
585                 }
586                 else
587                 {
588                         globalOutputStream() << "commands import: data version " << dataVersion << " is not compatible with code version " << version << "\n";
589                 }
590         }
591         else
592         {
593                 globalOutputStream() << "failed to load custom shortcuts from " << makeQuoted( strINI.c_str() ) << "\n";
594         }
595 }