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