enough with umpteen "i18n.h" files. Consolidate on pbd/i18n.h
[ardour.git] / gtk2_ardour / actions.cc
index ee688c366006d72e710e15e5769d053523761311..1edbcafaa4e663184b82306d3bef13c0a5211dfa 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2005 Paul Davis 
+    Copyright (C) 2005 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
-    $Id$
 */
 
-#include <vector>
-#include <string.h>
+#include <cstring>
+#include <string>
+#include <list>
 
 #include <gtk/gtkaccelmap.h>
 #include <gtk/gtkuimanager.h>
 #include <gtkmm/accelmap.h>
 #include <gtkmm/uimanager.h>
 
-#include <pbd/error.h>
+#include "pbd/error.h"
+#include "pbd/file_utils.h"
 
-#include <ardour/ardour.h>
+#include "ardour/filesystem_paths.h"
+#include "ardour/rc_configuration.h"
+
+#include "gtkmm2ext/actions.h"
 
 #include "actions.h"
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace std;
 using namespace Gtk;
 using namespace Glib;
-using namespace sigc;
 using namespace PBD;
-
-vector<RefPtr<Gtk::Action> > ActionManager::session_sensitive_actions;
-vector<RefPtr<Gtk::Action> > ActionManager::region_list_selection_sensitive_actions;
-vector<RefPtr<Gtk::Action> > ActionManager::plugin_selection_sensitive_actions;
-vector<RefPtr<Gtk::Action> > ActionManager::region_selection_sensitive_actions;
-vector<RefPtr<Gtk::Action> > ActionManager::track_selection_sensitive_actions;
-vector<RefPtr<Gtk::Action> > ActionManager::point_selection_sensitive_actions;
-vector<RefPtr<Gtk::Action> > ActionManager::time_selection_sensitive_actions;
-vector<RefPtr<Gtk::Action> > ActionManager::line_selection_sensitive_actions;
-vector<RefPtr<Gtk::Action> > ActionManager::playlist_selection_sensitive_actions;
-
-vector<RefPtr<Gtk::Action> > ActionManager::range_sensitive_actions;
-vector<RefPtr<Gtk::Action> > ActionManager::jack_sensitive_actions;
-vector<RefPtr<Gtk::Action> > ActionManager::jack_opposite_sensitive_actions;
-vector<RefPtr<Gtk::Action> > ActionManager::transport_sensitive_actions;
-vector<RefPtr<Gtk::Action> > ActionManager::edit_cursor_in_region_sensitive_actions;
-
-RefPtr<UIManager> ActionManager::ui_manager;
-string ActionManager::unbound_string = "--";
+using namespace ARDOUR;
+
+typedef std::vector<RefPtr<Gtk::Action> > RelatedActions;
+
+RelatedActions ActionManager::session_sensitive_actions;
+RelatedActions ActionManager::write_sensitive_actions;
+RelatedActions ActionManager::region_list_selection_sensitive_actions;
+RelatedActions ActionManager::plugin_selection_sensitive_actions;
+RelatedActions ActionManager::track_selection_sensitive_actions;
+RelatedActions ActionManager::point_selection_sensitive_actions;
+RelatedActions ActionManager::time_selection_sensitive_actions;
+RelatedActions ActionManager::line_selection_sensitive_actions;
+RelatedActions ActionManager::playlist_selection_sensitive_actions;
+RelatedActions ActionManager::mouse_edit_point_requires_canvas_actions;
+RelatedActions ActionManager::range_sensitive_actions;
+RelatedActions ActionManager::engine_sensitive_actions;
+RelatedActions ActionManager::engine_opposite_sensitive_actions;
+RelatedActions ActionManager::transport_sensitive_actions;
+RelatedActions ActionManager::edit_point_in_region_sensitive_actions;
 
 void
 ActionManager::init ()
 {
        ui_manager = UIManager::create ();
-       
-       std::string ui_file = ARDOUR::find_config_file("ardour.menus");
+}
+
+void
+ActionManager::load_menus (const string& menus_file)
+{
+       std::string ui_file;
+
+       find_file (ardour_config_search_path(), menus_file, ui_file);
 
        bool loaded = false;
-       
+
        try {
                ui_manager->add_ui_from_file (ui_file);
+               info << string_compose (_("Loading menus from %1"), ui_file) << endmsg;
                loaded = true;
        } catch (Glib::MarkupError& err) {
-               error << "badly formatted UI definition file" << endmsg;
+               error << string_compose (_("badly formatted menu definition file: %1"), err.what()) << endmsg;
+               cerr << string_compose (_("badly formatted menu definition file: %1"), err.what()) << endl;
        } catch (...) {
-               error << "Ardour menu definition file not found" << endmsg;
+               error << string_compose (_("%1 menu definition file not found"), PROGRAM_NAME) << endmsg;
        }
 
        if (!loaded) {
-               error << "ardour will not work without a valid ardour.menus file" << endmsg;
+               cerr << string_compose (_("%1 will not work without a valid menu definition file"), PROGRAM_NAME) << endl;
+               error << string_compose (_("%1 will not work without a valid menu definition file"), PROGRAM_NAME) << endmsg;
                exit(1);
        }
 }
 
-RefPtr<Action>
-ActionManager::register_action (RefPtr<ActionGroup> group, const char * name, const char * label, slot<void> sl, guint key, Gdk::ModifierType mods)
+/** Examine the state of a Configuration setting and a toggle action, and toggle the Configuration
+ * setting if its state doesn't match the toggle action.
+ * @param group Action group.
+ * @param action Action name.
+ * @param Method to set the state of the Configuration setting.
+ * @param Method to get the state of the Configuration setting.
+ */
+void
+ActionManager::toggle_config_state (const char* group, const char* action, bool (RCConfiguration::*set)(bool), bool (RCConfiguration::*get)(void) const)
 {
-       RefPtr<Action> act = register_action (group, name, label, sl);
-       AccelMap::add_entry (act->get_accel_path(), key, mods);
-
-       return act;
-}
+       Glib::RefPtr<Action> act = ActionManager::get_action (group, action);
 
-RefPtr<Action>
-ActionManager::register_action (RefPtr<ActionGroup> group, const char * name, const char * label, slot<void> sl)
-{
-       RefPtr<Action> act;
+       if (act) {
+               Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
 
-       act = Action::create (name, label);
-       group->add (act, sl);
+               if (tact) {
+                       bool x = (Config->*get)();
 
-       return act;
+                       if (x != tact->get_active()) {
+                               (Config->*set) (!x);
+                       }
+               }
+       }
 }
 
-RefPtr<Action>
-ActionManager::register_action (RefPtr<ActionGroup> group, const char * name, const char * label)
+/** Examine the state of a Configuration setting and a toggle action, and toggle the Configuration
+ * setting if its state doesn't match the toggle action.
+ * @param group Action group.
+ * @param action Action name.
+ * @param Method to set the state of the Configuration setting.
+ * @param Method to get the state of the Configuration setting.
+ */
+void
+ActionManager::toggle_config_state (const char* group, const char* action, bool (UIConfiguration::*set)(bool), bool (UIConfiguration::*get)(void) const)
 {
-       RefPtr<Action> act;
-
-       act = Action::create (name, label);
-       group->add (act);
-
-       return act;
-}
+       Glib::RefPtr<Action> act = ActionManager::get_action (group, action);
 
+       if (act) {
+               Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
 
-RefPtr<Action>
-ActionManager::register_radio_action (RefPtr<ActionGroup> group, RadioAction::Group& rgroup, const char * name, const char * label, slot<void> sl, guint key, Gdk::ModifierType mods)
-{
-       RefPtr<Action> act = register_radio_action (group, rgroup, name, label, sl);
-       AccelMap::add_entry (act->get_accel_path(), key, mods);
+               if (tact) {
+                       bool x = (UIConfiguration::instance().*get)();
 
-       return act;
+                       if (x != tact->get_active()) {
+                               (UIConfiguration::instance().*set) (!x);
+                       }
+               }
+       }
 }
 
-RefPtr<Action>
-ActionManager::register_radio_action (RefPtr<ActionGroup> group, RadioAction::Group& rgroup, const char * name, const char * label, slot<void> sl)
+void
+ActionManager::toggle_config_state_foo (const char* group, const char* action, sigc::slot<bool, bool> set, sigc::slot<bool> get)
 {
-       RefPtr<Action> act;
+       Glib::RefPtr<Action> act = ActionManager::get_action (group, action);
 
-       act = RadioAction::create (rgroup, name, label);
-       group->add (act, sl);
-
-       return act;
-}
+       if (act) {
+               Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
 
-RefPtr<Action>
-ActionManager::register_toggle_action (RefPtr<ActionGroup> group, const char * name, const char * label, slot<void> sl, guint key, Gdk::ModifierType mods)
-{
-       RefPtr<Action> act = register_toggle_action (group,name, label, sl);
-       AccelMap::add_entry (act->get_accel_path(), key, mods);
+               if (tact) {
+                       bool const x = get ();
 
-       return act;
+                       if (x != tact->get_active ()) {
+                               set (!x);
+                       }
+               }
+       }
 }
 
-RefPtr<Action>
-ActionManager::register_toggle_action (RefPtr<ActionGroup> group, const char * name, const char * label, slot<void> sl)
-{
-       RefPtr<Action> act;
-
-       act = ToggleAction::create (name, label);
-       group->add (act, sl);
-
-       return act;
-}
 
-bool 
-ActionManager::lookup_entry (const ustring accel_path, Gtk::AccelKey& key)
+/** Set the state of a ToggleAction using a particular Configuration get() method
+ * @param group Action group.
+ * @param action Action name.
+ * @param get Method to obtain the state that the ToggleAction should have.
+ */
+void
+ActionManager::map_some_state (const char* group, const char* action, bool (RCConfiguration::*get)() const)
 {
-       GtkAccelKey gkey;
-       bool known = gtk_accel_map_lookup_entry (accel_path.c_str(), &gkey);
-       
-       if (known) {
-               key = AccelKey (gkey.accel_key, Gdk::ModifierType (gkey.accel_mods));
-       } else {
-               key = AccelKey (GDK_VoidSymbol, Gdk::ModifierType (0));
-       }
+       Glib::RefPtr<Action> act = ActionManager::get_action (group, action);
+       if (act) {
+               Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
 
-       return known;
-}
+               if (tact) {
 
-void
-ActionManager::get_all_actions (vector<string>& names, vector<string>& paths, vector<string>& keys, vector<AccelKey>& bindings)
-{
-       ListHandle<RefPtr<ActionGroup> > uim_groups = ui_manager->get_action_groups ();
-       
-       for (ListHandle<RefPtr<ActionGroup> >::iterator g = uim_groups.begin(); g != uim_groups.end(); ++g) {
-               
-               ListHandle<RefPtr<Action> > group_actions = (*g)->get_actions();
-               
-               for (ListHandle<RefPtr<Action> >::iterator a = group_actions.begin(); a != group_actions.end(); ++a) {
-                       
-                       ustring accel_path;
-                       
-                       accel_path = (*a)->get_accel_path();
-                       
-                       names.push_back ((*a)->get_name());
-                       paths.push_back (accel_path);
-                       
-                       AccelKey key;
-                       bool known = lookup_entry (accel_path, key);
-                       
-                       if (known) {
-                               keys.push_back (ui_manager->get_accel_group()->name (key.get_key(), Gdk::ModifierType (key.get_mod())));
-                       } else {
-                               keys.push_back (unbound_string);
+                       bool x = (Config->*get)();
+
+                       if (tact->get_active() != x) {
+                               tact->set_active (x);
                        }
-                       
-                       bindings.push_back (AccelKey (key.get_key(), Gdk::ModifierType (key.get_mod())));
                }
        }
 }
 
+/** Set the state of a ToggleAction using a particular Configuration get() method
+ * @param group Action group.
+ * @param action Action name.
+ * @param get Method to obtain the state that the ToggleAction should have.
+ */
 void
-ActionManager::add_action_group (RefPtr<ActionGroup> grp)
+ActionManager::map_some_state (const char* group, const char* action, bool (UIConfiguration::*get)() const)
 {
-       ui_manager->insert_action_group (grp);
-}
+       Glib::RefPtr<Action> act = ActionManager::get_action (group, action);
+       if (act) {
+               Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
 
-Widget*
-ActionManager::get_widget (const char * name)
-{
-       return ui_manager->get_widget (name);
-}
+               if (tact) {
 
-RefPtr<Action>
-ActionManager::get_action (const char* group_name, const char* action_name)
-{
-       /* the C++ API for functions used here appears to be broken in
-          gtkmm2.6, so we fall back to the C level.
-       */
-
-       GList* list = gtk_ui_manager_get_action_groups (ui_manager->gobj());
-       GList* node;
-       RefPtr<Action> act;
-
-       for (node = list; node; node = g_list_next (node)) {
-
-               GtkActionGroup* _ag = (GtkActionGroup*) node->data;
-               
-               if (strcmp (group_name,  gtk_action_group_get_name (_ag)) == 0) {
-                       
-                       GtkAction* _act;
-                       
-                       if ((_act = gtk_action_group_get_action (_ag, action_name)) != 0) {
-                               act = Glib::wrap (_act, true);
-                               break;
+                       bool x = (UIConfiguration::instance().*get)();
+
+                       if (tact->get_active() != x) {
+                               tact->set_active (x);
                        }
                }
        }
-
-       return act;
-}
-
-void 
-ActionManager::set_sensitive (vector<RefPtr<Action> >& actions, bool state)
-{
-       for (vector<RefPtr<Action> >::iterator i = actions.begin(); i != actions.end(); ++i) {
-               (*i)->set_sensitive (state);
-       }
 }
 
 void
-ActionManager::uncheck_toggleaction (const char * name)
+ActionManager::map_some_state (const char* group, const char* action, sigc::slot<bool> get)
 {
-       char *last_slash = strrchr (name, '/');
-
-       if (last_slash == 0) {
-               fatal << string_compose (_("programmer error: %1 %2"), X_("illegal toggle action name"), name) << endmsg;
-               /*NOTREACHED*/
-               return;
-       }
-
-       /* 10 = strlen ("<Actions>/") */
-       size_t len = last_slash - (name + 10);
+       Glib::RefPtr<Action> act = ActionManager::get_action (group, action);
+       if (act) {
+               Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
 
-       char* group_name = new char[len+1];
-       memcpy (group_name, name + 10, len);
-       group_name[len] = '\0';
+               if (tact) {
 
-       char* action_name = last_slash + 1;
+                       bool const x = get ();
 
-        RefPtr<Action> act = get_action (group_name, action_name);
-       if (act) {
-               RefPtr<ToggleAction> tact = RefPtr<ToggleAction>::cast_dynamic(act);
-                       tact->set_active (false);
-       } else {
-               error << "Unknown action name: " << name << endmsg;
+                       if (tact->get_active() != x) {
+                               tact->set_active (x);
+                       }
+               }
        }
-
-       delete [] group_name;
 }