update german translation
[ardour.git] / libs / gtkmm2ext / bindings.cc
index 168e2cd24cc8f702b9377edef9ed76a8d9505071..9100ddabc6bd73720860fa21812f13904e028e8f 100644 (file)
@@ -26,6 +26,7 @@
 #include "pbd/convert.h"
 #include "pbd/debug.h"
 #include "pbd/error.h"
+#include "pbd/replace_all.h"
 #include "pbd/xml++.h"
 
 #include "gtkmm2ext/actions.h"
@@ -34,7 +35,7 @@
 #include "gtkmm2ext/keyboard.h"
 #include "gtkmm2ext/utils.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace std;
 using namespace Glib;
@@ -46,8 +47,6 @@ list<Bindings*> Bindings::bindings; /* global. Gulp */
 list<ActionMap*> ActionMap::action_maps; /* global. Gulp */
 PBD::Signal1<void,Bindings*> Bindings::BindingsChanged;
 
-
-/*============================ ActionNameRegistered ===========================*/
 template <typename IteratorValueType>
 struct ActionNameRegistered
 {
@@ -61,7 +60,6 @@ struct ActionNameRegistered
        std::string const& action_name;
 };
 
-/*================================ MouseButton ================================*/
 MouseButton::MouseButton (uint32_t state, uint32_t keycode)
 {
        uint32_t ignore = ~Keyboard::RelevantModifierKeyMask;
@@ -181,14 +179,16 @@ KeyboardKey::display_label () const
 
 #ifdef __APPLE__
        /* We use both bits (MOD2|META) for Primary on OS X,
-        * but we don't want MOD2 showing up in listings.
+        * but we don't want MOD2 showing up in listings. So remove
+        * it and add back META.
         */
 
        if (mod & GDK_MOD2_MASK) {
-               mod &= ~GDK_MOD2_MASK;
+               mod = (mod & ~GDK_MOD2_MASK) | GDK_META_MASK;
        }
 #endif
 
+
        return gtk_accelerator_get_label (key(), (GdkModifierType) mod);
 }
 
@@ -237,6 +237,96 @@ KeyboardKey::name () const
        return str;
 }
 
+string
+KeyboardKey::native_name () const
+{
+       int s = state();
+
+       string str;
+
+       if (s & Keyboard::PrimaryModifier) {
+               str += Keyboard::primary_modifier_name ();
+       }
+       if (s & Keyboard::SecondaryModifier) {
+               if (!str.empty()) {
+                       str += '-';
+               }
+               str += Keyboard::secondary_modifier_name ();
+       }
+       if (s & Keyboard::TertiaryModifier) {
+               if (!str.empty()) {
+                       str += '-';
+               }
+               str += Keyboard::tertiary_modifier_name ();
+       }
+       if (s & Keyboard::Level4Modifier) {
+               if (!str.empty()) {
+                       str += '-';
+               }
+               str += Keyboard::level4_modifier_name ();
+       }
+
+       if (!str.empty()) {
+               str += '-';
+       }
+
+       char const *gdk_name = gdk_keyval_name (key());
+
+       if (gdk_name) {
+               str += gdk_name;
+       } else {
+               /* fail! */
+               return string();
+       }
+
+       return str;
+}
+
+string
+KeyboardKey::native_short_name () const
+{
+       int s = state();
+
+       string str;
+
+       if (s & Keyboard::PrimaryModifier) {
+               str += Keyboard::primary_modifier_short_name ();
+       }
+       if (s & Keyboard::SecondaryModifier) {
+               if (!str.empty()) {
+                       str += '-';
+               }
+               str += Keyboard::secondary_modifier_short_name ();
+       }
+       if (s & Keyboard::TertiaryModifier) {
+               if (!str.empty()) {
+                       str += '-';
+               }
+               str += Keyboard::tertiary_modifier_short_name ();
+       }
+       if (s & Keyboard::Level4Modifier) {
+               if (!str.empty()) {
+                       str += '-';
+               }
+               str += Keyboard::level4_modifier_short_name ();
+       }
+
+       if (!str.empty()) {
+               str += '-';
+       }
+
+       char const *gdk_name = gdk_keyval_name (key());
+
+       if (gdk_name) {
+               str += gdk_name;
+       } else {
+               /* fail! */
+               return string();
+       }
+
+       return str;
+}
+
 bool
 KeyboardKey::make_key (const string& str, KeyboardKey& k)
 {
@@ -267,19 +357,20 @@ KeyboardKey::make_key (const string& str, KeyboardKey& k)
 
        string actual;
 
-       if (str.size() == 1) {
-               actual = PBD::downcase (str);
-       } else {
+       string::size_type lastmod = str.find_last_of ('-');
+
+       if (lastmod != string::npos) {
+               actual = str.substr (lastmod+1);
+       }
+       else {
                actual = str;
        }
 
-       string::size_type lastmod = actual.find_last_of ('-');
-       guint keyval;
-
-       if (lastmod != string::npos) {
-               actual = PBD::downcase (str.substr (lastmod+1));
+       if (actual.size() == 1) {
+               actual = PBD::downcase (actual);
        }
 
+       guint keyval;
        keyval = gdk_keyval_from_name (actual.c_str());
 
        if (keyval == GDK_VoidSymbol || keyval == 0) {
@@ -508,7 +599,20 @@ Bindings::push_to_gtk (KeyboardKey kb, RefPtr<Action> what)
                 * happens.
                 */
 
-               Gtk::AccelMap::add_entry (what->get_accel_path(), kb.key(), (Gdk::ModifierType) kb.state());
+
+               int mod = kb.state();
+#ifdef __APPLE__
+               /* See comments in Keyboard::Keyboard about GTK handling of MOD2, META and the Command key.
+                *
+                * If we do not do this, GTK+ won't show the correct text for shortcuts in menus.
+                */
+
+               if (mod & GDK_MOD2_MASK) {
+                       mod =  mod | GDK_META_MASK;
+               }
+#endif
+
+               Gtk::AccelMap::add_entry (what->get_accel_path(), kb.key(), (Gdk::ModifierType) mod);
        }
 }
 
@@ -520,23 +624,33 @@ Bindings::replace (KeyboardKey kb, Operation op, string const & action_name, boo
        }
 
        if (is_registered(op, action_name)) {
-               remove(op, action_name, can_save);
+               remove (op, action_name, can_save);
        }
-       add (kb, op, action_name, can_save);
+
+       /* XXX need a way to get the old group name */
+       add (kb, op, action_name, 0, can_save);
+
        return true;
 }
 
 bool
-Bindings::add (KeyboardKey kb, Operation op, string const& action_name, bool can_save)
+Bindings::add (KeyboardKey kb, Operation op, string const& action_name, XMLProperty const* group, bool can_save)
 {
-       if (is_registered(op, action_name)) {
+       if (is_registered (op, action_name)) {
                return false;
        }
 
        KeybindingMap& kbm = get_keymap (op);
+       if (group) {
+               KeybindingMap::value_type new_pair = make_pair (kb, ActionInfo (action_name, group->value()));
+               (void) kbm.insert (new_pair).first;
+       } else {
+               KeybindingMap::value_type new_pair = make_pair (kb, ActionInfo (action_name));
+               (void) kbm.insert (new_pair).first;
+       }
 
-       KeybindingMap::value_type new_pair (kb, ActionInfo (action_name));
-       kbm.insert (new_pair).first;
+       DEBUG_TRACE (DEBUG::Bindings, string_compose ("add binding between %1 and %2, group [%3]\n",
+                                                     kb, action_name, (group ? group->value() : string())));
 
        if (can_save) {
                Keyboard::keybindings_changed ();
@@ -606,7 +720,7 @@ Bindings::activate (MouseButton bb, Operation op)
 }
 
 void
-Bindings::add (MouseButton bb, Operation op, string const& action_name)
+Bindings::add (MouseButton bb, Operation op, string const& action_name, XMLProperty const* /*group*/)
 {
        MouseButtonBindingMap& bbm = get_mousemap(op);
 
@@ -678,6 +792,147 @@ Bindings::save (XMLNode& root)
        root.add_child_nocopy (*releases);
 }
 
+void
+Bindings::save_all_bindings_as_html (ostream& ostr)
+{
+       if (bindings.empty()) {
+               return;
+       }
+
+
+       ostr << "<html>\n<head>\n<title>";
+       ostr << PROGRAM_NAME;
+       ostr << "</title>\n";
+
+
+       ostr << "<style>\n";
+       ostr << "\n\
+.key-name-even, .key-name-odd\n\
+{\n\
+    font-weight: bold;\n\
+}\n\
+\n\
+.key-action-odd, .key-action-even\n\
+{\n\
+    font-weight: normal;\n\
+    font-style: italic;\n\
+}";
+       ostr << "</style>\n";
+
+       ostr << "</head>\n<body>\n";
+
+       ostr << "<div class=\"container\">\n";
+
+       for (list<Bindings*>::const_iterator b = bindings.begin(); b != bindings.end(); ++b) {
+               (*b)->save_as_html (ostr);
+       }
+
+       ostr << "</div>\n";
+       ostr << "</body>\n";
+       ostr << "</html>\n";
+}
+
+void
+Bindings::save_as_html (ostream& ostr) const
+{
+
+       if (!press_bindings.empty()) {
+
+               ostr << "<div class=\"binding-set\">\n";
+               ostr << "<h1>";
+               ostr << name();
+               ostr << "</h1>\n\n";
+
+               /* first pass: separate by group */
+
+               typedef std::map<std::string, std::vector<KeybindingMap::const_iterator> > GroupMap;
+               GroupMap group_map;
+
+               for (KeybindingMap::const_iterator k = press_bindings.begin(); k != press_bindings.end(); ++k) {
+                       if (k->first.name().empty()) {
+                               continue;
+                       }
+
+                       string group_name;
+                       if (!k->second.group_name.empty()) {
+                               group_name = k->second.group_name;
+                       } else {
+                               group_name = X_("nogroup");
+                       }
+
+                       GroupMap::iterator gm = group_map.find (group_name);
+                       if (gm == group_map.end()) {
+                               std::vector<KeybindingMap::const_iterator> li;
+                               li.push_back (k);
+                               group_map.insert (make_pair (group_name,li));
+                       } else {
+                               gm->second.push_back (k);
+                       }
+               }
+
+               for (GroupMap::const_iterator gm = group_map.begin(); gm != group_map.end(); ++gm) {
+
+                       ostr << "<div class=\"group\">\n";
+                       ostr << "<div class=\"group-name\">" << gm->first << "</div>\n";
+
+                       for (vector<KeybindingMap::const_iterator>::const_iterator k = gm->second.begin(); k != gm->second.end(); ++k) {
+
+                               if ((*k)->first.name().empty()) {
+                                       continue;
+                               }
+
+                               RefPtr<Action> action;
+
+                               if ((*k)->second.action) {
+                                       action = (*k)->second.action;
+                               } else {
+                                       if (_action_map) {
+                                               action = _action_map->find_action ((*k)->second.action_name);
+                                       }
+                               }
+
+                               if (!action) {
+                                       continue;
+                               }
+
+                               string key_name = (*k)->first.native_short_name ();
+                               replace_all (key_name, X_("KP_"), X_("Numpad "));
+
+                               string::size_type pos;
+
+                               char const *targets[] = { X_("Separator"), X_("Add"), X_("Subtract"), X_("Decimal"), X_("Divide"),
+                                                         X_("grave"), X_("comma"), X_("period"), X_("asterisk"), X_("backslash"),
+                                                         X_("apostrophe"), X_("minus"), X_("plus"), X_("slash"), X_("semicolon"),
+                                                         X_("colon"), X_("equal"), X_("bracketleft"), X_("bracketright"),
+                                                         X_("ampersand"), X_("numbersign"), X_("parenleft"), X_("parenright"),
+                                                         X_("quoteright"), X_("quoteleft"), X_("exclam"), X_("quotedbl"),
+                                                         0
+                               };
+
+                               char const *replacements[] = { X_("-"), X_("+"), X_("-"), X_("."), X_("/"),
+                                                              X_("`"), X_(","), X_("."), X_("*"), X_("\\"),
+                                                              X_("'"), X_("-"), X_("+"), X_("/"), X_(";"),
+                                                              X_(":"), X_("="), X_("{"), X_("{"),
+                                                              X_("&"), X_("#"), X_("("), X_(")"),
+                                                              X_("`"), X_("'"), X_("!"), X_("\""),
+                               };
+
+                               for (size_t n = 0; targets[n]; ++n) {
+                                       if ((pos = key_name.find (targets[n])) != string::npos) {
+                                               key_name.replace (pos, strlen (targets[n]), replacements[n]);
+                                       }
+                               }
+
+                               ostr << "<div class=\"key\">" << key_name << "</div>";
+                               ostr << "<div class=\"action\">" << action->get_label() << "</div>\n";
+                       }
+                       ostr << "</div>\n\n";
+               }
+
+               ostr << "</div>\n";
+       }
+}
+
 bool
 Bindings::load (XMLNode const& node)
 {
@@ -711,13 +966,16 @@ Bindings::load_operation (XMLNode const& node)
 
                for (XMLNodeList::const_iterator p = children.begin(); p != children.end(); ++p) {
 
-                       XMLProperty* ap;
-                       XMLProperty* kp;
-                       XMLProperty* bp;
+                       XMLProperty const * ap;
+                       XMLProperty const * kp;
+                       XMLProperty const * bp;
+                       XMLProperty const * gp;
+                       XMLNode const * child = *p;
 
-                       ap = (*p)->property ("action");
-                       kp = (*p)->property ("key");
-                       bp = (*p)->property ("button");
+                       ap = child->property ("action");
+                       kp = child->property ("key");
+                       bp = child->property ("button");
+                       gp = child->property ("group");
 
                        if (!ap || (!kp && !bp)) {
                                continue;
@@ -728,13 +986,13 @@ Bindings::load_operation (XMLNode const& node)
                                if (!KeyboardKey::make_key (kp->value(), k)) {
                                        continue;
                                }
-                               add (k, op, ap->value());
+                               add (k, op, ap->value(), gp);
                        } else {
                                MouseButton b;
                                if (!MouseButton::make_button (bp->value(), b)) {
                                        continue;
                                }
-                               add (b, op, ap->value());
+                               add (b, op, ap->value(), gp);
                        }
                }
        }
@@ -1070,5 +1328,6 @@ ActionMap::get_all_actions (std::vector<std::string>& paths,
 
 std::ostream& operator<<(std::ostream& out, Gtkmm2ext::KeyboardKey const & k) {
        char const *gdk_name = gdk_keyval_name (k.key());
-       return out << "Key " << k.key() << " (" << (gdk_name ? gdk_name : "no-key") << ") state " << hex << k.state() << dec;
+       return out << "Key " << k.key() << " (" << (gdk_name ? gdk_name : "no-key") << ") state "
+                  << hex << k.state() << dec << ' ' << show_gdk_event_state (k.state());
 }