libs/gtkmm2ext/bindings.cc

   1 /*
   2   Copyright (C) 2012 Paul Davis
   3
   4   This program is free software; you can redistribute it and/or modify
   5   it under the terms of the GNU General Public License as published by
   6   the Free Software Foundation; either version 2 of the License, or
   7   (at your option) any later version.
   8
   9   This program is distributed in the hope that it will be useful,
  10   but WITHOUT ANY WARRANTY; without even the implied warranty of
  11   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12   GNU General Public License for more details.
  13
  14   You should have received a copy of the GNU General Public License
  15   along with this program; if not, write to the Free Software
  16   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <iostream>
  21
  22 #include "pbd/gstdio_compat.h"
  23 #include <gtkmm/accelmap.h>
  24 #include <gtkmm/uimanager.h>
  25
  26 #include "pbd/convert.h"
  27 #include "pbd/debug.h"
  28 #include "pbd/error.h"
  29 #include "pbd/replace_all.h"
  30 #include "pbd/xml++.h"
  31
  32 #include "gtkmm2ext/actions.h"
  33 #include "gtkmm2ext/bindings.h"
  34 #include "gtkmm2ext/debug.h"
  35 #include "gtkmm2ext/keyboard.h"
  36 #include "gtkmm2ext/utils.h"
  37
  38 #include "pbd/i18n.h"
  39
  40 using namespace std;
  41 using namespace Glib;
  42 using namespace Gtk;
  43 using namespace Gtkmm2ext;
  44 using namespace PBD;
  45
  46 list<Bindings*> Bindings::bindings; /* global. Gulp */
  47 PBD::Signal1<void,Bindings*> Bindings::BindingsChanged;
  48
  49 template <typename IteratorValueType>
  50 struct ActionNameRegistered
  51 {
  52         ActionNameRegistered(std::string const& name)
  53                 : action_name(name)
  54         {}
  55
  56         bool operator()(IteratorValueType elem) const {
  57                 return elem.second.action_name == action_name;
  58         }
  59         std::string const& action_name;
  60 };
  61
  62 MouseButton::MouseButton (uint32_t state, uint32_t keycode)
  63 {
  64         uint32_t ignore = ~Keyboard::RelevantModifierKeyMask;
  65
  66         /* this is a slightly wierd test that relies on
  67          * gdk_keyval_is_{upper,lower}() returning true for keys that have no
  68          * case-sensitivity. This covers mostly non-alphanumeric keys.
  69          */
  70
  71         if (gdk_keyval_is_upper (keycode) && gdk_keyval_is_lower (keycode)) {
  72                 /* key is not subject to case, so ignore SHIFT
  73                  */
  74                 ignore |= GDK_SHIFT_MASK;
  75         }
  76
  77         _val = (state & ~ignore);
  78         _val <<= 32;
  79         _val |= keycode;
  80 };
  81
  82 bool
  83 MouseButton::make_button (const string& str, MouseButton& b)
  84 {
  85         int s = 0;
  86
  87         if (str.find ("Primary") != string::npos) {
  88                 s |= Keyboard::PrimaryModifier;
  89         }
  90
  91         if (str.find ("Secondary") != string::npos) {
  92                 s |= Keyboard::SecondaryModifier;
  93         }
  94
  95         if (str.find ("Tertiary") != string::npos) {
  96                 s |= Keyboard::TertiaryModifier;
  97         }
  98
  99         if (str.find ("Level4") != string::npos) {
 100                 s |= Keyboard::Level4Modifier;
 101         }
 102
 103         string::size_type lastmod = str.find_last_of ('-');
 104         uint32_t button_number;
 105
 106         if (lastmod == string::npos) {
 107                 button_number = PBD::atoi (str);
 108         } else {
 109                 button_number = PBD::atoi (str.substr (lastmod+1));
 110         }
 111
 112         b = MouseButton (s, button_number);
 113         return true;
 114 }
 115
 116 string
 117 MouseButton::name () const
 118 {
 119         int s = state();
 120
 121         string str;
 122
 123         if (s & Keyboard::PrimaryModifier) {
 124                 str += "Primary";
 125         }
 126         if (s & Keyboard::SecondaryModifier) {
 127                 if (!str.empty()) {
 128                         str += '-';
 129                 }
 130                 str += "Secondary";
 131         }
 132         if (s & Keyboard::TertiaryModifier) {
 133                 if (!str.empty()) {
 134                         str += '-';
 135                 }
 136                 str += "Tertiary";
 137         }
 138         if (s & Keyboard::Level4Modifier) {
 139                 if (!str.empty()) {
 140                         str += '-';
 141                 }
 142                 str += "Level4";
 143         }
 144
 145         if (!str.empty()) {
 146                 str += '-';
 147         }
 148
 149         char buf[16];
 150         snprintf (buf, sizeof (buf), "%u", button());
 151         str += buf;
 152
 153         return str;
 154 }
 155
 156 /*================================ KeyboardKey ================================*/
 157 KeyboardKey::KeyboardKey (uint32_t state, uint32_t keycode)
 158 {
 159         uint32_t ignore = ~Keyboard::RelevantModifierKeyMask;
 160
 161         _val = (state & ~ignore);
 162         _val <<= 32;
 163         _val |= keycode;
 164 }
 165
 166 string
 167 KeyboardKey::display_label () const
 168 {
 169         if (key() == 0) {
 170                 return string();
 171         }
 172
 173         /* This magically returns a string that will display the right thing
 174          *  on all platforms, notably the command key on OS X.
 175          */
 176
 177         uint32_t mod = state();
 178
 179         return gtk_accelerator_get_label (key(), (GdkModifierType) mod);
 180 }
 181
 182 string
 183 KeyboardKey::name () const
 184 {
 185         int s = state();
 186
 187         string str;
 188
 189         if (s & Keyboard::PrimaryModifier) {
 190                 str += "Primary";
 191         }
 192         if (s & Keyboard::SecondaryModifier) {
 193                 if (!str.empty()) {
 194                         str += '-';
 195                 }
 196                 str += "Secondary";
 197         }
 198         if (s & Keyboard::TertiaryModifier) {
 199                 if (!str.empty()) {
 200                         str += '-';
 201                 }
 202                 str += "Tertiary";
 203         }
 204         if (s & Keyboard::Level4Modifier) {
 205                 if (!str.empty()) {
 206                         str += '-';
 207                 }
 208                 str += "Level4";
 209         }
 210
 211         if (!str.empty()) {
 212                 str += '-';
 213         }
 214
 215         char const *gdk_name = gdk_keyval_name (key());
 216
 217         if (gdk_name) {
 218                 str += gdk_name;
 219         } else {
 220                 /* fail! */
 221                 return string();
 222         }
 223
 224         return str;
 225 }
 226
 227 string
 228 KeyboardKey::native_name () const
 229 {
 230         int s = state();
 231
 232         string str;
 233
 234         if (s & Keyboard::PrimaryModifier) {
 235                 str += Keyboard::primary_modifier_name ();
 236         }
 237         if (s & Keyboard::SecondaryModifier) {
 238                 if (!str.empty()) {
 239                         str += '-';
 240                 }
 241                 str += Keyboard::secondary_modifier_name ();
 242         }
 243         if (s & Keyboard::TertiaryModifier) {
 244                 if (!str.empty()) {
 245                         str += '-';
 246                 }
 247                 str += Keyboard::tertiary_modifier_name ();
 248         }
 249         if (s & Keyboard::Level4Modifier) {
 250                 if (!str.empty()) {
 251                         str += '-';
 252                 }
 253                 str += Keyboard::level4_modifier_name ();
 254         }
 255
 256         if (!str.empty()) {
 257                 str += '-';
 258         }
 259
 260         char const *gdk_name = gdk_keyval_name (key());
 261
 262         if (gdk_name) {
 263                 str += gdk_name;
 264         } else {
 265                 /* fail! */
 266                 return string();
 267         }
 268
 269         return str;
 270 }
 271
 272 string
 273 KeyboardKey::native_short_name () const
 274 {
 275         int s = state();
 276
 277         string str;
 278
 279         if (s & Keyboard::PrimaryModifier) {
 280                 str += Keyboard::primary_modifier_short_name ();
 281         }
 282         if (s & Keyboard::SecondaryModifier) {
 283                 if (!str.empty()) {
 284                         str += '-';
 285                 }
 286                 str += Keyboard::secondary_modifier_short_name ();
 287         }
 288         if (s & Keyboard::TertiaryModifier) {
 289                 if (!str.empty()) {
 290                         str += '-';
 291                 }
 292                 str += Keyboard::tertiary_modifier_short_name ();
 293         }
 294         if (s & Keyboard::Level4Modifier) {
 295                 if (!str.empty()) {
 296                         str += '-';
 297                 }
 298                 str += Keyboard::level4_modifier_short_name ();
 299         }
 300
 301         if (!str.empty()) {
 302                 str += '-';
 303         }
 304
 305         char const *gdk_name = gdk_keyval_name (key());
 306
 307         if (gdk_name) {
 308                 str += gdk_name;
 309         } else {
 310                 /* fail! */
 311                 return string();
 312         }
 313
 314         return str;
 315 }
 316
 317 bool
 318 KeyboardKey::make_key (const string& str, KeyboardKey& k)
 319 {
 320         int s = 0;
 321
 322         if (str.find ("Primary") != string::npos) {
 323                 s |= Keyboard::PrimaryModifier;
 324         }
 325
 326         if (str.find ("Secondary") != string::npos) {
 327                 s |= Keyboard::SecondaryModifier;
 328         }
 329
 330         if (str.find ("Tertiary") != string::npos) {
 331                 s |= Keyboard::TertiaryModifier;
 332         }
 333
 334         if (str.find ("Level4") != string::npos) {
 335                 s |= Keyboard::Level4Modifier;
 336         }
 337
 338         /* since all SINGLE key events keycodes are changed to lower case
 339          * before looking them up, make sure we only store lower case here. The
 340          * Shift part will be stored in the modifier part of the KeyboardKey.
 341          *
 342          * And yes Mildred, this doesn't cover CapsLock cases. Oh well.
 343          */
 344
 345         string actual;
 346
 347         string::size_type lastmod = str.find_last_of ('-');
 348
 349         if (lastmod != string::npos) {
 350                 actual = str.substr (lastmod+1);
 351         }
 352         else {
 353                 actual = str;
 354         }
 355
 356         if (actual.size() == 1) {
 357                 actual = PBD::downcase (actual);
 358         }
 359
 360         guint keyval;
 361         keyval = gdk_keyval_from_name (actual.c_str());
 362
 363         if (keyval == GDK_VoidSymbol || keyval == 0) {
 364                 return false;
 365         }
 366
 367         k = KeyboardKey (s, keyval);
 368
 369         return true;
 370 }
 371
 372 /*================================= Bindings =================================*/
 373 Bindings::Bindings (std::string const& name)
 374         : _name (name)
 375 {
 376         bindings.push_back (this);
 377 }
 378
 379 Bindings::~Bindings()
 380 {
 381         bindings.remove (this);
 382 }
 383
 384 string
 385 Bindings::ardour_action_name (RefPtr<Action> action)
 386 {
 387         /* Skip "<Actions>/" */
 388         return action->get_accel_path ().substr (10);
 389 }
 390
 391 KeyboardKey
 392 Bindings::get_binding_for_action (RefPtr<Action> action, Operation& op)
 393 {
 394         const string action_name = ardour_action_name (action);
 395
 396         for (KeybindingMap::iterator k = press_bindings.begin(); k != press_bindings.end(); ++k) {
 397
 398                 /* option one: action has already been associated with the
 399                  * binding
 400                  */
 401
 402                 if (k->second.action == action) {
 403                         return k->first;
 404                 }
 405
 406                 /* option two: action name matches, so lookup the action,
 407                  * setup the association while we're here, and return the binding.
 408                  */
 409
 410                 if (k->second.action_name == action_name) {
 411                         k->second.action = ActionManager::get_action (action_name, false);
 412                         return k->first;
 413                 }
 414
 415         }
 416
 417         for (KeybindingMap::iterator k = release_bindings.begin(); k != release_bindings.end(); ++k) {
 418
 419                 /* option one: action has already been associated with the
 420                  * binding
 421                  */
 422
 423                 if (k->second.action == action) {
 424                         return k->first;
 425                 }
 426
 427                 /* option two: action name matches, so lookup the action,
 428                  * setup the association while we're here, and return the binding.
 429                  */
 430
 431                 if (k->second.action_name == action_name) {
 432                         k->second.action = ActionManager::get_action (action_name, false);
 433                         return k->first;
 434                 }
 435
 436         }
 437
 438         return KeyboardKey::null_key();
 439 }
 440
 441 void
 442 Bindings::reassociate ()
 443 {
 444         dissociate ();
 445         associate ();
 446 }
 447
 448 bool
 449 Bindings::empty_keys() const
 450 {
 451         return press_bindings.empty() && release_bindings.empty();
 452 }
 453
 454 bool
 455 Bindings::empty_mouse () const
 456 {
 457         return button_press_bindings.empty() && button_release_bindings.empty();
 458 }
 459
 460 bool
 461 Bindings::empty() const
 462 {
 463         return empty_keys() && empty_mouse ();
 464 }
 465
 466 bool
 467 Bindings::activate (KeyboardKey kb, Operation op)
 468 {
 469         KeybindingMap& kbm = get_keymap (op);
 470
 471         /* if shift was pressed, GDK will send us (e.g) 'E' rather than 'e'.
 472            Our bindings all use the lower case character/keyname, so switch
 473            to the lower case before doing the lookup.
 474         */
 475
 476         KeyboardKey unshifted (kb.state(), gdk_keyval_to_lower (kb.key()));
 477
 478         KeybindingMap::iterator k = kbm.find (unshifted);
 479
 480         if (k == kbm.end()) {
 481                 /* no entry for this key in the state map */
 482                 DEBUG_TRACE (DEBUG::Bindings, string_compose ("no binding for %1\n", unshifted));
 483                 return false;
 484         }
 485
 486         RefPtr<Action> action;
 487
 488         if (k->second.action) {
 489                 action = k->second.action;
 490         } else {
 491                 action = ActionManager::get_action (k->second.action_name, false);
 492         }
 493
 494         if (action) {
 495                 /* lets do it ... */
 496                 DEBUG_TRACE (DEBUG::Bindings, string_compose ("binding for %1: %2\n", unshifted, k->second.action_name));
 497                 action->activate ();
 498         }
 499
 500         /* return true even if the action could not be found */
 501
 502         return true;
 503 }
 504
 505 void
 506 Bindings::associate ()
 507 {
 508         KeybindingMap::iterator k;
 509
 510         for (k = press_bindings.begin(); k != press_bindings.end(); ++k) {
 511                 k->second.action = ActionManager::get_action (k->second.action_name, false);
 512                 if (k->second.action) {
 513                         push_to_gtk (k->first, k->second.action);
 514                 } else {
 515                         cerr << _name << " didn't find " << k->second.action_name << endl;
 516                 }
 517         }
 518
 519         for (k = release_bindings.begin(); k != release_bindings.end(); ++k) {
 520                 k->second.action = ActionManager::get_action (k->second.action_name, false);
 521                 /* no working support in GTK for release bindings */
 522         }
 523
 524         MouseButtonBindingMap::iterator b;
 525
 526         for (b = button_press_bindings.begin(); b != button_press_bindings.end(); ++b) {
 527                 b->second.action = ActionManager::get_action (b->second.action_name, false);
 528         }
 529
 530         for (b = button_release_bindings.begin(); b != button_release_bindings.end(); ++b) {
 531                 b->second.action = ActionManager::get_action (b->second.action_name, false);
 532         }
 533 }
 534
 535 void
 536 Bindings::dissociate ()
 537 {
 538         KeybindingMap::iterator k;
 539
 540         for (k = press_bindings.begin(); k != press_bindings.end(); ++k) {
 541                 k->second.action.clear ();
 542         }
 543         for (k = release_bindings.begin(); k != release_bindings.end(); ++k) {
 544                 k->second.action.clear ();
 545         }
 546 }
 547
 548 void
 549 Bindings::push_to_gtk (KeyboardKey kb, RefPtr<Action> what)
 550 {
 551         /* GTK has the useful feature of showing key bindings for actions in
 552          * menus. As of August 2015, we have no interest in trying to
 553          * reimplement this functionality, so we will use it even though we no
 554          * longer use GTK accelerators for handling key events. To do this, we
 555          * need to make sure that there is a fully populated GTK AccelMap set
 556          * up with all bindings/actions.
 557          */
 558
 559         Gtk::AccelKey gtk_key;
 560         bool entry_exists = Gtk::AccelMap::lookup_entry (what->get_accel_path(), gtk_key);
 561
 562         if (!entry_exists) {
 563
 564                 /* there is a trick happening here. It turns out that
 565                  * gtk_accel_map_add_entry() performs no validation checks on
 566                  * the accelerator keyval. This means we can use it to define
 567                  * ANY accelerator, even if they violate GTK's rules
 568                  * (e.g. about not using navigation keys). This works ONLY when
 569                  * the entry in the GTK accelerator map has not already been
 570                  * added. The entries will be added by the GTK UIManager when
 571                  * building menus, so this code must be called before that
 572                  * happens.
 573                  */
 574
 575
 576                 int mod = kb.state();
 577
 578                 Gtk::AccelMap::add_entry (what->get_accel_path(), kb.key(), (Gdk::ModifierType) mod);
 579         }
 580 }
 581
 582 bool
 583 Bindings::replace (KeyboardKey kb, Operation op, string const & action_name, bool can_save)
 584 {
 585         if (is_registered(op, action_name)) {
 586                 remove (op, action_name, can_save);
 587         }
 588
 589         /* XXX need a way to get the old group name */
 590         add (kb, op, action_name, 0, can_save);
 591
 592         return true;
 593 }
 594
 595 bool
 596 Bindings::add (KeyboardKey kb, Operation op, string const& action_name, XMLProperty const* group, bool can_save)
 597 {
 598         if (is_registered (op, action_name)) {
 599                 return false;
 600         }
 601
 602         KeybindingMap& kbm = get_keymap (op);
 603         if (group) {
 604                 KeybindingMap::value_type new_pair = make_pair (kb, ActionInfo (action_name, group->value()));
 605                 (void) kbm.insert (new_pair).first;
 606         } else {
 607                 KeybindingMap::value_type new_pair = make_pair (kb, ActionInfo (action_name));
 608                 (void) kbm.insert (new_pair).first;
 609         }
 610
 611         DEBUG_TRACE (DEBUG::Bindings, string_compose ("add binding between %1 and %2, group [%3]\n",
 612                                                       kb, action_name, (group ? group->value() : string())));
 613
 614         if (can_save) {
 615                 Keyboard::keybindings_changed ();
 616         }
 617
 618         BindingsChanged (this); /* EMIT SIGNAL */
 619         return true;
 620 }
 621
 622 bool
 623 Bindings::remove (Operation op, std::string const& action_name, bool can_save)
 624 {
 625         bool erased_action = false;
 626         KeybindingMap& kbm = get_keymap (op);
 627         for (KeybindingMap::iterator k = kbm.begin(); k != kbm.end(); ++k) {
 628                 if (k->second.action_name == action_name) {
 629                         kbm.erase (k);
 630                         erased_action = true;
 631                         break;
 632                 }
 633         }
 634
 635         if (!erased_action) {
 636                 return erased_action;
 637         }
 638
 639         if (can_save) {
 640                 Keyboard::keybindings_changed ();
 641         }
 642
 643         BindingsChanged (this); /* EMIT SIGNAL */
 644         return erased_action;
 645 }
 646
 647
 648 bool
 649 Bindings::activate (MouseButton bb, Operation op)
 650 {
 651         MouseButtonBindingMap& bbm = get_mousemap(op);
 652
 653         MouseButtonBindingMap::iterator b = bbm.find (bb);
 654
 655         if (b == bbm.end()) {
 656                 /* no entry for this key in the state map */
 657                 return false;
 658         }
 659
 660         RefPtr<Action> action;
 661
 662         if (b->second.action) {
 663                 action = b->second.action;
 664         } else {
 665                 action = ActionManager::get_action (b->second.action_name, false);
 666         }
 667
 668         if (action) {
 669                 /* lets do it ... */
 670                 DEBUG_TRACE (DEBUG::Bindings, string_compose ("activating action %1\n", ardour_action_name (action)));
 671                 action->activate ();
 672         }
 673
 674         /* return true even if the action could not be found */
 675
 676         return true;
 677 }
 678
 679 void
 680 Bindings::add (MouseButton bb, Operation op, string const& action_name, XMLProperty const* /*group*/)
 681 {
 682         MouseButtonBindingMap& bbm = get_mousemap(op);
 683
 684         MouseButtonBindingMap::value_type newpair (bb, ActionInfo (action_name));
 685         bbm.insert (newpair);
 686 }
 687
 688 void
 689 Bindings::remove (MouseButton bb, Operation op)
 690 {
 691         MouseButtonBindingMap& bbm = get_mousemap(op);
 692         MouseButtonBindingMap::iterator b = bbm.find (bb);
 693
 694         if (b != bbm.end()) {
 695                 bbm.erase (b);
 696         }
 697 }
 698
 699 void
 700 Bindings::save (XMLNode& root)
 701 {
 702         XMLNode* presses = new XMLNode (X_("Press"));
 703
 704         for (KeybindingMap::iterator k = press_bindings.begin(); k != press_bindings.end(); ++k) {
 705                 XMLNode* child;
 706
 707                 if (k->first.name().empty()) {
 708                         continue;
 709                 }
 710
 711                 child = new XMLNode (X_("Binding"));
 712                 child->set_property (X_("key"), k->first.name());
 713                 child->set_property (X_("action"), k->second.action_name);
 714                 presses->add_child_nocopy (*child);
 715         }
 716
 717         for (MouseButtonBindingMap::iterator k = button_press_bindings.begin(); k != button_press_bindings.end(); ++k) {
 718                 XMLNode* child;
 719                 child = new XMLNode (X_("Binding"));
 720                 child->set_property (X_("button"), k->first.name());
 721                 child->set_property (X_("action"), k->second.action_name);
 722                 presses->add_child_nocopy (*child);
 723         }
 724
 725         XMLNode* releases = new XMLNode (X_("Release"));
 726
 727         for (KeybindingMap::iterator k = release_bindings.begin(); k != release_bindings.end(); ++k) {
 728                 XMLNode* child;
 729
 730                 if (k->first.name().empty()) {
 731                         continue;
 732                 }
 733
 734                 child = new XMLNode (X_("Binding"));
 735                 child->set_property (X_("key"), k->first.name());
 736                 child->set_property (X_("action"), k->second.action_name);
 737                 releases->add_child_nocopy (*child);
 738         }
 739
 740         for (MouseButtonBindingMap::iterator k = button_release_bindings.begin(); k != button_release_bindings.end(); ++k) {
 741                 XMLNode* child;
 742                 child = new XMLNode (X_("Binding"));
 743                 child->set_property (X_("button"), k->first.name());
 744                 child->set_property (X_("action"), k->second.action_name);
 745                 releases->add_child_nocopy (*child);
 746         }
 747
 748         root.add_child_nocopy (*presses);
 749         root.add_child_nocopy (*releases);
 750 }
 751
 752 void
 753 Bindings::save_all_bindings_as_html (ostream& ostr)
 754 {
 755         if (bindings.empty()) {
 756                 return;
 757         }
 758
 759
 760         ostr << "<html>\n<head>\n<title>";
 761         ostr << PROGRAM_NAME;
 762         ostr << "</title>\n";
 763         ostr << "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\" />\n";
 764
 765         ostr << "</head>\n<body>\n";
 766
 767         ostr << "<table border=\"2\" cellpadding=\"6\"><tbody>\n\n";
 768         ostr << "<tr>\n\n";
 769
 770         /* first column: separate by group */
 771         ostr << "<td>\n\n";
 772         for (list<Bindings*>::const_iterator b = bindings.begin(); b != bindings.end(); ++b) {
 773                 (*b)->save_as_html (ostr, true);
 774         }
 775         ostr << "</td>\n\n";
 776
 777         //second column
 778         ostr << "<td style=\"vertical-align:top\">\n\n";
 779         for (list<Bindings*>::const_iterator b = bindings.begin(); b != bindings.end(); ++b) {
 780                 (*b)->save_as_html (ostr, false);
 781         }
 782         ostr << "</td>\n\n";
 783
 784
 785         ostr << "</tr>\n\n";
 786         ostr << "</tbody></table>\n\n";
 787
 788         ostr << "</br></br>\n\n";
 789         ostr << "<table border=\"2\" cellpadding=\"6\"><tbody>\n\n";
 790         ostr << "<tr>\n\n";
 791         ostr << "<td>\n\n";
 792         ostr << "<h2><u> Partial List of Available Actions { => with current shortcut, where applicable } </u></h2>\n\n";
 793         {
 794                 vector<string> paths;
 795                 vector<string> labels;
 796                 vector<string> tooltips;
 797                 vector<string> keys;
 798                 vector<Glib::RefPtr<Gtk::Action> > actions;
 799
 800                 ActionManager::get_all_actions (paths, labels, tooltips, keys, actions);
 801
 802                 vector<string>::iterator k;
 803                 vector<string>::iterator p;
 804                 vector<string>::iterator l;
 805
 806                 for (p = paths.begin(), k = keys.begin(), l = labels.begin(); p != paths.end(); ++k, ++p, ++l) {
 807
 808                         string print_path = *p;
 809                         /* strip <Actions>/ from the start */
 810                         print_path = print_path.substr (10);
 811
 812                         if ((*k).empty()) {
 813                                 ostr << print_path  << " ( " << *l << " ) "  << "</br>" << endl;
 814                         } else {
 815                                 ostr << print_path << " ( " << *l << " ) " << " => " << *k << "</br>" << endl;
 816                         }
 817                 }
 818         }
 819         ostr << "</td>\n\n";
 820         ostr << "</tr>\n\n";
 821         ostr << "</tbody></table>\n\n";
 822
 823         ostr << "</body>\n";
 824         ostr << "</html>\n";
 825 }
 826
 827 void
 828 Bindings::save_as_html (ostream& ostr, bool categorize) const
 829 {
 830
 831         if (!press_bindings.empty()) {
 832
 833                 ostr << "<h2><u>";
 834                 if (categorize)
 835                         ostr << _("Window") << ": " << name() << _(" (Categorized)");
 836                 else
 837                         ostr << _("Window") << ": " << name() << _(" (Alphabetical)");
 838                 ostr << "</u></h2>\n\n";
 839
 840                 typedef std::map<std::string, std::vector<KeybindingMap::const_iterator> > GroupMap;
 841                 GroupMap group_map;
 842
 843                 for (KeybindingMap::const_iterator k = press_bindings.begin(); k != press_bindings.end(); ++k) {
 844
 845                         if (k->first.name().empty()) {
 846                                 continue;
 847                         }
 848
 849                         string group_name;
 850                         if (categorize && !k->second.group_name.empty()) {
 851                                 group_name = k->second.group_name;
 852                         } else {
 853                                 group_name = _("Uncategorized");
 854                         }
 855
 856                         GroupMap::iterator gm = group_map.find (group_name);
 857                         if (gm == group_map.end()) {
 858                                 std::vector<KeybindingMap::const_iterator> li;
 859                                 li.push_back (k);
 860                                 group_map.insert (make_pair (group_name,li));
 861                         } else {
 862                                 gm->second.push_back (k);
 863                         }
 864                 }
 865
 866
 867                 for (GroupMap::const_iterator gm = group_map.begin(); gm != group_map.end(); ++gm) {
 868
 869                         if (categorize) {
 870                                 ostr << "<h3>" << gm->first << "</h3>\n";
 871                         }
 872
 873                         for (vector<KeybindingMap::const_iterator>::const_iterator k = gm->second.begin(); k != gm->second.end(); ++k) {
 874
 875                                 if ((*k)->first.name().empty()) {
 876                                         continue;
 877                                 }
 878
 879                                 RefPtr<Action> action;
 880
 881                                 if ((*k)->second.action) {
 882                                         action = (*k)->second.action;
 883                                 } else {
 884                                         action = ActionManager::get_action ((*k)->second.action_name, false);
 885                                 }
 886
 887                                 if (!action) {
 888                                         continue;
 889                                 }
 890
 891                                 string key_name = (*k)->first.native_short_name ();
 892                                 replace_all (key_name, X_("KP_"), X_("Numpad "));
 893                                 replace_all (key_name, X_("nabla"), X_("Tab"));
 894
 895                                 string::size_type pos;
 896
 897                                 char const *targets[] = { X_("Separator"), X_("Add"), X_("Subtract"), X_("Decimal"), X_("Divide"),
 898                                                           X_("grave"), X_("comma"), X_("period"), X_("asterisk"), X_("backslash"),
 899                                                           X_("apostrophe"), X_("minus"), X_("plus"), X_("slash"), X_("semicolon"),
 900                                                           X_("colon"), X_("equal"), X_("bracketleft"), X_("bracketright"),
 901                                                           X_("ampersand"), X_("numbersign"), X_("parenleft"), X_("parenright"),
 902                                                           X_("quoteright"), X_("quoteleft"), X_("exclam"), X_("quotedbl"),
 903                                                           0
 904                                 };
 905
 906                                 char const *replacements[] = { X_("-"), X_("+"), X_("-"), X_("."), X_("/"),
 907                                                                X_("`"), X_(","), X_("."), X_("*"), X_("\\"),
 908                                                                X_("'"), X_("-"), X_("+"), X_("/"), X_(";"),
 909                                                                X_(":"), X_("="), X_("{"), X_("{"),
 910                                                                X_("&"), X_("#"), X_("("), X_(")"),
 911                                                                X_("`"), X_("'"), X_("!"), X_("\""),
 912                                 };
 913
 914                                 for (size_t n = 0; targets[n]; ++n) {
 915                                         if ((pos = key_name.find (targets[n])) != string::npos) {
 916                                                 key_name.replace (pos, strlen (targets[n]), replacements[n]);
 917                                         }
 918                                 }
 919
 920                                 key_name.append(" ");
 921
 922                                 while (key_name.length()<28)
 923                                         key_name.append("-");
 924
 925                                 ostr << "<span style=\"font-family:monospace;\">" << key_name;
 926                                 ostr << "<i>" << action->get_label() << "</i></span></br>\n";
 927                         }
 928                         ostr << "\n\n";
 929
 930                 }
 931
 932                 ostr << "\n";
 933         }
 934 }
 935
 936 bool
 937 Bindings::load (XMLNode const& node)
 938 {
 939         const XMLNodeList& children (node.children());
 940
 941         press_bindings.clear ();
 942         release_bindings.clear ();
 943
 944         for (XMLNodeList::const_iterator i = children.begin(); i != children.end(); ++i) {
 945                 /* each node could be Press or Release */
 946                 load_operation (**i);
 947         }
 948
 949         return true;
 950 }
 951
 952 void
 953 Bindings::load_operation (XMLNode const& node)
 954 {
 955         if (node.name() == X_("Press") || node.name() == X_("Release")) {
 956
 957                 Operation op;
 958
 959                 if (node.name() == X_("Press")) {
 960                         op = Press;
 961                 } else {
 962                         op = Release;
 963                 }
 964
 965                 const XMLNodeList& children (node.children());
 966
 967                 for (XMLNodeList::const_iterator p = children.begin(); p != children.end(); ++p) {
 968
 969                         XMLProperty const * ap;
 970                         XMLProperty const * kp;
 971                         XMLProperty const * bp;
 972                         XMLProperty const * gp;
 973                         XMLNode const * child = *p;
 974
 975                         ap = child->property ("action");
 976                         kp = child->property ("key");
 977                         bp = child->property ("button");
 978                         gp = child->property ("group");
 979
 980                         if (!ap || (!kp && !bp)) {
 981                                 continue;
 982                         }
 983
 984                         if (kp) {
 985                                 KeyboardKey k;
 986                                 if (!KeyboardKey::make_key (kp->value(), k)) {
 987                                         continue;
 988                                 }
 989                                 add (k, op, ap->value(), gp);
 990                         } else {
 991                                 MouseButton b;
 992                                 if (!MouseButton::make_button (bp->value(), b)) {
 993                                         continue;
 994                                 }
 995                                 add (b, op, ap->value(), gp);
 996                         }
 997                 }
 998         }
 999 }
1000
1001 void
1002 Bindings::get_all_actions (std::vector<std::string>& paths,
1003                            std::vector<std::string>& labels,
1004                            std::vector<std::string>& tooltips,
1005                            std::vector<std::string>& keys,
1006                            std::vector<RefPtr<Action> >& actions)
1007 {
1008         /* build a reverse map from actions to bindings */
1009
1010         typedef map<Glib::RefPtr<Gtk::Action>,KeyboardKey> ReverseMap;
1011         ReverseMap rmap;
1012
1013         for (KeybindingMap::const_iterator k = press_bindings.begin(); k != press_bindings.end(); ++k) {
1014                 rmap.insert (make_pair (k->second.action, k->first));
1015         }
1016
1017 #if 0
1018
1019         /* get a list of all actions XXX relevant for these bindings */
1020
1021         ActionMap::Actions all_actions;
1022         ActionManager::get_actions (all_actions);
1023
1024         for (ActionMap::Actions::const_iterator act = all_actions.begin(); act != all_actions.end(); ++act) {
1025
1026                 paths.push_back ((*act)->get_accel_path());
1027                 labels.push_back ((*act)->get_label());
1028                 tooltips.push_back ((*act)->get_tooltip());
1029
1030                 ReverseMap::iterator r = rmap.find (*act);
1031
1032                 if (r != rmap.end()) {
1033                         keys.push_back (r->second.display_label());
1034                 } else {
1035                         keys.push_back (string());
1036                 }
1037
1038                 actions.push_back (*act);
1039         }
1040 #endif
1041 }
1042
1043 Bindings*
1044 Bindings::get_bindings (string const& name)
1045 {
1046         for (list<Bindings*>::iterator b = bindings.begin(); b != bindings.end(); b++) {
1047                 if ((*b)->name() == name) {
1048                         return *b;
1049                 }
1050         }
1051
1052         return 0;
1053 }
1054
1055 void
1056 Bindings::associate_all ()
1057 {
1058         for (list<Bindings*>::iterator b = bindings.begin(); b != bindings.end(); b++) {
1059                 (*b)->associate ();
1060         }
1061 }
1062
1063 bool
1064 Bindings::is_bound (KeyboardKey const& kb, Operation op) const
1065 {
1066         const KeybindingMap& km = get_keymap(op);
1067         return km.find(kb) != km.end();
1068 }
1069
1070 std::string
1071 Bindings::bound_name (KeyboardKey const& kb, Operation op) const
1072 {
1073         const KeybindingMap& km = get_keymap(op);
1074         KeybindingMap::const_iterator b = km.find(kb);
1075         if (b == km.end()) {
1076                 return "";
1077         }
1078         return b->second.action_name;
1079 }
1080
1081 bool
1082 Bindings::is_registered (Operation op, std::string const& action_name) const
1083 {
1084         const KeybindingMap& km = get_keymap(op);
1085         return std::find_if(km.begin(),  km.end(),  ActionNameRegistered<KeybindingMap::const_iterator::value_type>(action_name)) != km.end();
1086 }
1087
1088 Bindings::KeybindingMap&
1089 Bindings::get_keymap (Operation op)
1090 {
1091         switch (op) {
1092         case Press:
1093                 return press_bindings;
1094         case Release:
1095         default:
1096                 return release_bindings;
1097         }
1098 }
1099
1100 const Bindings::KeybindingMap&
1101 Bindings::get_keymap (Operation op) const
1102 {
1103         switch (op) {
1104         case Press:
1105                 return press_bindings;
1106         case Release:
1107         default:
1108                 return release_bindings;
1109         }
1110 }
1111
1112 Bindings::MouseButtonBindingMap&
1113 Bindings::get_mousemap (Operation op)
1114 {
1115         switch (op) {
1116         case Press:
1117                 return button_press_bindings;
1118         case Release:
1119         default:
1120                 return button_release_bindings;
1121         }
1122 }
1123
1124 std::ostream& operator<<(std::ostream& out, Gtkmm2ext::KeyboardKey const & k) {
1125         char const *gdk_name = gdk_keyval_name (k.key());
1126         return out << "Key " << k.key() << " (" << (gdk_name ? gdk_name : "no-key") << ") state "
1127                    << hex << k.state() << dec << ' ' << show_gdk_event_state (k.state());
1128 }