#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"
#include "gtkmm2ext/keyboard.h"
#include "gtkmm2ext/utils.h"
-#include "i18n.h"
+#include "pbd/i18n.h"
using namespace std;
using namespace Glib;
using namespace PBD;
list<Bindings*> Bindings::bindings; /* global. Gulp */
-list<ActionMap*> ActionMap::action_maps; /* global. Gulp */
PBD::Signal1<void,Bindings*> Bindings::BindingsChanged;
template <typename IteratorValueType>
uint32_t mod = state();
-#ifdef __APPLE__
- /* We use both bits (MOD2|META) for Primary on OS X,
- * but we don't want MOD2 showing up in listings.
- */
-
- if (mod & GDK_MOD2_MASK) {
- mod &= ~GDK_MOD2_MASK;
- }
-#endif
-
return gtk_accelerator_get_label (key(), (GdkModifierType) mod);
}
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)
{
/*================================= Bindings =================================*/
Bindings::Bindings (std::string const& name)
: _name (name)
- , _action_map (0)
{
bindings.push_back (this);
}
* setup the association while we're here, and return the binding.
*/
- if (_action_map && k->second.action_name == action_name) {
- k->second.action = _action_map->find_action (action_name);
+ if (k->second.action_name == action_name) {
+ k->second.action = ActionManager::get_action (action_name, false);
return k->first;
}
* setup the association while we're here, and return the binding.
*/
- if (_action_map && k->second.action_name == action_name) {
- k->second.action = _action_map->find_action (action_name);
+ if (k->second.action_name == action_name) {
+ k->second.action = ActionManager::get_action (action_name, false);
return k->first;
}
}
void
-Bindings::set_action_map (ActionMap& actions)
+Bindings::reassociate ()
{
- if (_action_map) {
- _action_map->set_bindings (0);
- }
-
- _action_map = &actions;
- _action_map->set_bindings (this);
-
dissociate ();
associate ();
}
if (k->second.action) {
action = k->second.action;
} else {
- if (_action_map) {
- action = _action_map->find_action (k->second.action_name);
- }
+ action = ActionManager::get_action (k->second.action_name, false);
}
if (action) {
{
KeybindingMap::iterator k;
- if (!_action_map) {
- return;
- }
-
for (k = press_bindings.begin(); k != press_bindings.end(); ++k) {
- k->second.action = _action_map->find_action (k->second.action_name);
+ k->second.action = ActionManager::get_action (k->second.action_name, false);
if (k->second.action) {
push_to_gtk (k->first, k->second.action);
} else {
- cerr << _name << " didn't find " << k->second.action_name << " in " << _action_map->name() << endl;
+ cerr << _name << " didn't find " << k->second.action_name << endl;
}
}
for (k = release_bindings.begin(); k != release_bindings.end(); ++k) {
- k->second.action = _action_map->find_action (k->second.action_name);
+ k->second.action = ActionManager::get_action (k->second.action_name, false);
/* no working support in GTK for release bindings */
}
MouseButtonBindingMap::iterator b;
for (b = button_press_bindings.begin(); b != button_press_bindings.end(); ++b) {
- b->second.action = _action_map->find_action (b->second.action_name);
+ b->second.action = ActionManager::get_action (b->second.action_name, false);
}
for (b = button_release_bindings.begin(); b != button_release_bindings.end(); ++b) {
- b->second.action = _action_map->find_action (b->second.action_name);
+ b->second.action = ActionManager::get_action (b->second.action_name, false);
}
}
* happens.
*/
- Gtk::AccelMap::add_entry (what->get_accel_path(), kb.key(), (Gdk::ModifierType) kb.state());
+
+ int mod = kb.state();
+
+ Gtk::AccelMap::add_entry (what->get_accel_path(), kb.key(), (Gdk::ModifierType) mod);
}
}
bool
Bindings::replace (KeyboardKey kb, Operation op, string const & action_name, bool can_save)
{
- if (!_action_map) {
- return false;
- }
-
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 ();
if (b->second.action) {
action = b->second.action;
} else {
- if (_action_map) {
- action = _action_map->find_action (b->second.action_name);
- }
+ action = ActionManager::get_action (b->second.action_name, false);
}
if (action) {
}
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);
}
child = new XMLNode (X_("Binding"));
- child->add_property (X_("key"), k->first.name());
- child->add_property (X_("action"), k->second.action_name);
+ child->set_property (X_("key"), k->first.name());
+ child->set_property (X_("action"), k->second.action_name);
presses->add_child_nocopy (*child);
}
for (MouseButtonBindingMap::iterator k = button_press_bindings.begin(); k != button_press_bindings.end(); ++k) {
XMLNode* child;
child = new XMLNode (X_("Binding"));
- child->add_property (X_("button"), k->first.name());
- child->add_property (X_("action"), k->second.action_name);
+ child->set_property (X_("button"), k->first.name());
+ child->set_property (X_("action"), k->second.action_name);
presses->add_child_nocopy (*child);
}
}
child = new XMLNode (X_("Binding"));
- child->add_property (X_("key"), k->first.name());
- child->add_property (X_("action"), k->second.action_name);
+ child->set_property (X_("key"), k->first.name());
+ child->set_property (X_("action"), k->second.action_name);
releases->add_child_nocopy (*child);
}
for (MouseButtonBindingMap::iterator k = button_release_bindings.begin(); k != button_release_bindings.end(); ++k) {
XMLNode* child;
child = new XMLNode (X_("Binding"));
- child->add_property (X_("button"), k->first.name());
- child->add_property (X_("action"), k->second.action_name);
+ child->set_property (X_("button"), k->first.name());
+ child->set_property (X_("action"), k->second.action_name);
releases->add_child_nocopy (*child);
}
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 << "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\" />\n";
+
+ ostr << "</head>\n<body>\n";
+
+ ostr << "<table border=\"2\" cellpadding=\"6\"><tbody>\n\n";
+ ostr << "<tr>\n\n";
+
+ /* first column: separate by group */
+ ostr << "<td>\n\n";
+ for (list<Bindings*>::const_iterator b = bindings.begin(); b != bindings.end(); ++b) {
+ (*b)->save_as_html (ostr, true);
+ }
+ ostr << "</td>\n\n";
+
+ //second column
+ ostr << "<td style=\"vertical-align:top\">\n\n";
+ for (list<Bindings*>::const_iterator b = bindings.begin(); b != bindings.end(); ++b) {
+ (*b)->save_as_html (ostr, false);
+ }
+ ostr << "</td>\n\n";
+
+
+ ostr << "</tr>\n\n";
+ ostr << "</tbody></table>\n\n";
+
+ ostr << "</br></br>\n\n";
+ ostr << "<table border=\"2\" cellpadding=\"6\"><tbody>\n\n";
+ ostr << "<tr>\n\n";
+ ostr << "<td>\n\n";
+ ostr << "<h2><u> Partial List of Available Actions { => with current shortcut, where applicable } </u></h2>\n\n";
+ {
+ vector<string> paths;
+ vector<string> labels;
+ vector<string> tooltips;
+ vector<string> keys;
+ vector<Glib::RefPtr<Gtk::Action> > actions;
+
+ ActionManager::get_all_actions (paths, labels, tooltips, keys, actions);
+
+ vector<string>::iterator k;
+ vector<string>::iterator p;
+ vector<string>::iterator l;
+
+ for (p = paths.begin(), k = keys.begin(), l = labels.begin(); p != paths.end(); ++k, ++p, ++l) {
+
+ string print_path = *p;
+ /* strip <Actions>/ from the start */
+ print_path = print_path.substr (10);
+
+ if ((*k).empty()) {
+ ostr << print_path << " ( " << *l << " ) " << "</br>" << endl;
+ } else {
+ ostr << print_path << " ( " << *l << " ) " << " => " << *k << "</br>" << endl;
+ }
+ }
+ }
+ ostr << "</td>\n\n";
+ ostr << "</tr>\n\n";
+ ostr << "</tbody></table>\n\n";
+
+ ostr << "</body>\n";
+ ostr << "</html>\n";
+}
+
+void
+Bindings::save_as_html (ostream& ostr, bool categorize) const
+{
+
+ if (!press_bindings.empty()) {
+
+ ostr << "<h2><u>";
+ if (categorize)
+ ostr << _("Window") << ": " << name() << _(" (Categorized)");
+ else
+ ostr << _("Window") << ": " << name() << _(" (Alphabetical)");
+ ostr << "</u></h2>\n\n";
+
+ 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 (categorize && !k->second.group_name.empty()) {
+ group_name = k->second.group_name;
+ } else {
+ group_name = _("Uncategorized");
+ }
+
+ 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) {
+
+ if (categorize) {
+ ostr << "<h3>" << gm->first << "</h3>\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 {
+ action = ActionManager::get_action ((*k)->second.action_name, false);
+ }
+
+ if (!action) {
+ continue;
+ }
+
+ string key_name = (*k)->first.native_short_name ();
+ replace_all (key_name, X_("KP_"), X_("Numpad "));
+ replace_all (key_name, X_("nabla"), X_("Tab"));
+
+ 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]);
+ }
+ }
+
+ key_name.append(" ");
+
+ while (key_name.length()<28)
+ key_name.append("-");
+
+ ostr << "<span style=\"font-family:monospace;\">" << key_name;
+ ostr << "<i>" << action->get_label() << "</i></span></br>\n";
+ }
+ ostr << "\n\n";
+
+ }
+
+ ostr << "\n";
+ }
+}
+
bool
Bindings::load (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;
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);
}
}
}
std::vector<std::string>& keys,
std::vector<RefPtr<Action> >& actions)
{
- if (!_action_map) {
- return;
- }
-
/* build a reverse map from actions to bindings */
typedef map<Glib::RefPtr<Gtk::Action>,KeyboardKey> ReverseMap;
rmap.insert (make_pair (k->second.action, k->first));
}
- /* get a list of all actions */
+#if 0
+
+ /* get a list of all actions XXX relevant for these bindings */
ActionMap::Actions all_actions;
- _action_map->get_actions (all_actions);
+ ActionManager::get_actions (all_actions);
for (ActionMap::Actions::const_iterator act = all_actions.begin(); act != all_actions.end(); ++act) {
actions.push_back (*act);
}
+#endif
}
Bindings*
-Bindings::get_bindings (string const& name, ActionMap& map)
+Bindings::get_bindings (string const& name)
{
for (list<Bindings*>::iterator b = bindings.begin(); b != bindings.end(); b++) {
if ((*b)->name() == name) {
- (*b)->set_action_map (map);
return *b;
}
}
return km.find(kb) != km.end();
}
+std::string
+Bindings::bound_name (KeyboardKey const& kb, Operation op) const
+{
+ const KeybindingMap& km = get_keymap(op);
+ KeybindingMap::const_iterator b = km.find(kb);
+ if (b == km.end()) {
+ return "";
+ }
+ return b->second.action_name;
+}
+
bool
Bindings::is_registered (Operation op, std::string const& action_name) const
{
}
}
-/*==========================================ACTION MAP =========================================*/
-
-ActionMap::ActionMap (string const & name)
- : _name (name)
- , _bindings (0)
-{
- action_maps.push_back (this);
-}
-
-ActionMap::~ActionMap ()
-{
- action_maps.remove (this);
-}
-
-void
-ActionMap::set_bindings (Bindings* b)
-{
- _bindings = b;
-}
-
-void
-ActionMap::get_actions (ActionMap::Actions& acts)
-{
- for (_ActionMap::iterator a = _actions.begin(); a != _actions.end(); ++a) {
- acts.push_back (a->second);
- }
-}
-
-RefPtr<Action>
-ActionMap::find_action (const string& name)
-{
- _ActionMap::iterator a = _actions.find (name);
-
- if (a != _actions.end()) {
- return a->second;
- }
-
- return RefPtr<Action>();
-}
-
-RefPtr<ActionGroup>
-ActionMap::create_action_group (const string& name)
-{
- RefPtr<ActionGroup> g = ActionGroup::create (name);
-
- /* this is one of the places where our own Action management code
- has to touch the GTK one, because we want the GtkUIManager to
- be able to create widgets (particularly Menus) from our actions.
-
- This is a a necessary step for that to happen.
- */
-
- if (g) {
- ActionManager::ui_manager->insert_action_group (g);
- }
-
- return g;
-}
-
-RefPtr<Action>
-ActionMap::register_action (RefPtr<ActionGroup> group, const char* name, const char* label)
-{
- string fullpath;
-
- RefPtr<Action> act = Action::create (name, label);
-
- fullpath = group->get_name();
- fullpath += '/';
- fullpath += name;
-
- if (_actions.insert (_ActionMap::value_type (fullpath, act)).second) {
- group->add (act);
- return act;
- }
-
- /* already registered */
- return RefPtr<Action> ();
-}
-
-RefPtr<Action>
-ActionMap::register_action (RefPtr<ActionGroup> group,
- const char* name, const char* label, sigc::slot<void> sl)
-{
- string fullpath;
-
- RefPtr<Action> act = Action::create (name, label);
-
- fullpath = group->get_name();
- fullpath += '/';
- fullpath += name;
-
- if (_actions.insert (_ActionMap::value_type (fullpath, act)).second) {
- group->add (act, sl);
- return act;
- }
-
- /* already registered */
- return RefPtr<Action>();
-}
-
-RefPtr<Action>
-ActionMap::register_radio_action (RefPtr<ActionGroup> group,
- Gtk::RadioAction::Group& rgroup,
- const char* name, const char* label,
- sigc::slot<void> sl)
-{
- string fullpath;
-
- RefPtr<Action> act = RadioAction::create (rgroup, name, label);
- RefPtr<RadioAction> ract = RefPtr<RadioAction>::cast_dynamic(act);
-
- fullpath = group->get_name();
- fullpath += '/';
- fullpath += name;
-
- if (_actions.insert (_ActionMap::value_type (fullpath, act)).second) {
- group->add (act, sl);
- return act;
- }
-
- /* already registered */
- return RefPtr<Action>();
-}
-
-RefPtr<Action>
-ActionMap::register_radio_action (RefPtr<ActionGroup> group,
- Gtk::RadioAction::Group& rgroup,
- const char* name, const char* label,
- sigc::slot<void,GtkAction*> sl,
- int value)
-{
- string fullpath;
-
- RefPtr<Action> act = RadioAction::create (rgroup, name, label);
- RefPtr<RadioAction> ract = RefPtr<RadioAction>::cast_dynamic(act);
- ract->property_value() = value;
-
- fullpath = group->get_name();
- fullpath += '/';
- fullpath += name;
-
- if (_actions.insert (_ActionMap::value_type (fullpath, act)).second) {
- group->add (act, sigc::bind (sl, act->gobj()));
- return act;
- }
-
- /* already registered */
-
- return RefPtr<Action>();
-}
-
-RefPtr<Action>
-ActionMap::register_toggle_action (RefPtr<ActionGroup> group,
- const char* name, const char* label, sigc::slot<void> sl)
-{
- string fullpath;
-
- fullpath = group->get_name();
- fullpath += '/';
- fullpath += name;
-
- RefPtr<Action> act = ToggleAction::create (name, label);
-
- if (_actions.insert (_ActionMap::value_type (fullpath, act)).second) {
- group->add (act, sl);
- return act;
- }
-
- /* already registered */
- return RefPtr<Action>();
-}
-
-void
-ActionMap::get_all_actions (std::vector<std::string>& paths,
- std::vector<std::string>& labels,
- std::vector<std::string>& tooltips,
- std::vector<std::string>& keys,
- std::vector<RefPtr<Action> >& actions)
-{
- for (list<ActionMap*>::const_iterator map = action_maps.begin(); map != action_maps.end(); ++map) {
-
- ActionMap::Actions these_actions;
- (*map)->get_actions (these_actions);
-
- for (ActionMap::Actions::const_iterator act = these_actions.begin(); act != these_actions.end(); ++act) {
-
- paths.push_back ((*act)->get_accel_path());
- labels.push_back ((*act)->get_label());
- tooltips.push_back ((*act)->get_tooltip());
- actions.push_back (*act);
-
- Bindings* bindings = (*map)->bindings();
-
- if (bindings) {
-
- KeyboardKey key;
- Bindings::Operation op;
-
- key = bindings->get_binding_for_action (*act, op);
-
- if (key == KeyboardKey::null_key()) {
- keys.push_back (string());
- } else {
- keys.push_back (key.display_label());
- }
- } else {
- keys.push_back (string());
- }
- }
-
- these_actions.clear ();
- }
-}
-
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());
}