enough with umpteen "i18n.h" files. Consolidate on pbd/i18n.h
[ardour.git] / gtk2_ardour / port_matrix.cc
index 9336d520e8d9a23ab117e6cf5b988d8c2fa48f62..1b588511fdc47c7555555b634b9d70befc4544cc 100644 (file)
 #include <gtkmm/menu_elems.h>
 #include <gtkmm/window.h>
 #include <gtkmm/stock.h>
+#include <gtkmm/messagedialog.h>
 #include "ardour/bundle.h"
 #include "ardour/types.h"
 #include "ardour/session.h"
 #include "ardour/route.h"
 #include "ardour/audioengine.h"
+#include "gtkmm2ext/utils.h"
 #include "port_matrix.h"
 #include "port_matrix_body.h"
 #include "port_matrix_component.h"
 #include "ardour_dialog.h"
-#include "i18n.h"
+#include "pbd/i18n.h"
 #include "gui_thread.h"
 #include "utils.h"
 
 using namespace std;
 using namespace Gtk;
 using namespace ARDOUR;
+using namespace ARDOUR_UI_UTILS;
 
 /** PortMatrix constructor.
  *  @param session Our session.
@@ -150,13 +153,13 @@ PortMatrix::init ()
        _session->RouteAdded.connect (_session_connections, invalidator (*this), boost::bind (&PortMatrix::routes_changed, this), gui_context());
 
        /* and also bundles */
-       _session->BundleAdded.connect (_session_connections, invalidator (*this), boost::bind (&PortMatrix::setup_global_ports, this), gui_context());
+       _session->BundleAddedOrRemoved.connect (_session_connections, invalidator (*this), boost::bind (&PortMatrix::setup_global_ports, this), gui_context());
 
        /* and also ports */
        _session->engine().PortRegisteredOrUnregistered.connect (_session_connections, invalidator (*this), boost::bind (&PortMatrix::setup_global_ports, this), gui_context());
 
        /* watch for route order keys changing, which changes the order of things in our global ports list(s) */
-       _session->RouteOrderKeyChanged.connect (_session_connections, invalidator (*this), boost::bind (&PortMatrix::setup_global_ports_proxy, this), gui_context());
+       PresentationInfo::Change.connect (_session_connections, invalidator (*this), boost::bind (&PortMatrix::setup_global_ports_proxy, this), gui_context());
 
        /* Part 3: other stuff */
 
@@ -178,7 +181,8 @@ PortMatrix::reconnect_to_routes ()
 
        boost::shared_ptr<RouteList> routes = _session->get_routes ();
        for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
-               (*i)->processors_changed.connect (_route_connections, invalidator (*this), ui_bind (&PortMatrix::route_processors_changed, this, _1), gui_context());
+               (*i)->processors_changed.connect (_route_connections, invalidator (*this), boost::bind (&PortMatrix::route_processors_changed, this, _1), gui_context());
+               (*i)->DropReferences.connect (_route_connections, invalidator (*this), boost::bind (&PortMatrix::routes_changed, this), gui_context());
        }
 }
 
@@ -197,6 +201,7 @@ PortMatrix::route_processors_changed (RouteProcessorChange c)
 void
 PortMatrix::routes_changed ()
 {
+       if (!_session) return;
        reconnect_to_routes ();
        setup_global_ports ();
 }
@@ -205,6 +210,11 @@ PortMatrix::routes_changed ()
 void
 PortMatrix::setup ()
 {
+       if (!_session) {
+               _route_connections.drop_connections ();
+               return; // session went away
+       }
+
        /* this needs to be done first, as the visible_ports() method uses the
           notebook state to decide which ports are being shown */
 
@@ -212,6 +222,7 @@ PortMatrix::setup ()
 
        _body->setup ();
        setup_scrollbars ();
+       update_tab_highlighting ();
        queue_draw ();
 }
 
@@ -238,17 +249,26 @@ PortMatrix::setup_scrollbars ()
 {
        Adjustment* a = _hscroll.get_adjustment ();
        a->set_lower (0);
-       a->set_upper (_body->full_scroll_width());
        a->set_page_size (_body->alloc_scroll_width());
        a->set_step_increment (32);
        a->set_page_increment (128);
 
+       /* Set the adjustment to zero if the size has changed.*/
+       if (a->get_upper() != _body->full_scroll_width()) {
+               a->set_upper (_body->full_scroll_width());
+               a->set_value (0);
+       }
+
        a = _vscroll.get_adjustment ();
        a->set_lower (0);
-       a->set_upper (_body->full_scroll_height());
        a->set_page_size (_body->alloc_scroll_height());
        a->set_step_increment (32);
        a->set_page_increment (128);
+
+       if (a->get_upper() != _body->full_scroll_height()) {
+               a->set_upper (_body->full_scroll_height());
+               a->set_value (0);
+       }
 }
 
 /** Disassociate all of our ports from each other */
@@ -326,6 +346,13 @@ PortMatrix::select_arrangement ()
                _vbox.pack_end (_vnotebook, false, false);
                _vbox.pack_end (_vspacer, true, true);
 
+#define REMOVE_FROM_GTK_PARENT(WGT) if ((WGT).get_parent()) { (WGT).get_parent()->remove(WGT);}
+               REMOVE_FROM_GTK_PARENT(*_body)
+               REMOVE_FROM_GTK_PARENT(_vscroll)
+               REMOVE_FROM_GTK_PARENT(_hscroll)
+               REMOVE_FROM_GTK_PARENT(_vbox)
+               REMOVE_FROM_GTK_PARENT(_hbox)
+
                attach (*_body, 2, 3, 1, 2, FILL | EXPAND, FILL | EXPAND);
                attach (_vscroll, 3, 4, 1, 2, SHRINK);
                attach (_hscroll, 2, 3, 3, 4, FILL | EXPAND, SHRINK);
@@ -345,6 +372,12 @@ PortMatrix::select_arrangement ()
                _vbox.pack_end (_vnotebook, false, false);
                _vbox.pack_end (_vlabel, false, false);
 
+               REMOVE_FROM_GTK_PARENT(*_body)
+               REMOVE_FROM_GTK_PARENT(_vscroll)
+               REMOVE_FROM_GTK_PARENT(_hscroll)
+               REMOVE_FROM_GTK_PARENT(_vbox)
+               REMOVE_FROM_GTK_PARENT(_hbox)
+
                attach (*_body, 1, 2, 2, 3, FILL | EXPAND, FILL | EXPAND);
                attach (_vscroll, 3, 4, 2, 3, SHRINK);
                attach (_hscroll, 1, 2, 3, 4, FILL | EXPAND, SHRINK);
@@ -387,13 +420,6 @@ PortMatrix::popup_menu (BundleChannel column, BundleChannel row, uint32_t t)
 {
        using namespace Menu_Helpers;
 
-       if ((row.bundle && row.bundle->nchannels().n_total() == 0) || (column.bundle && column.bundle->nchannels().n_total() == 0)) {
-               /* One of the bundles has no channels, which means that it has none of the appropriate type,
-                  and is only being displayed to look pretty.  So we don't need to do anything.
-               */
-               return;
-       }
-       
        delete _menu;
 
        _menu = new Menu;
@@ -417,23 +443,25 @@ PortMatrix::popup_menu (BundleChannel column, BundleChannel row, uint32_t t)
 
                        boost::weak_ptr<Bundle> w (bc[dim].bundle);
 
-                       /* Start off with options for the `natural' port type */
-                       for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
-                               if (should_show (*i)) {
-                                       snprintf (buf, sizeof (buf), _("Add %s %s"), (*i).to_i18n_string(), channel_noun().c_str());
-                                       sub.push_back (MenuElem (buf, sigc::bind (sigc::mem_fun (*this, &PortMatrix::add_channel_proxy), w, *i)));
+                       if (can_add_channels (bc[dim].bundle)) {
+                               /* Start off with options for the `natural' port type */
+                               for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
+                                       if (should_show (*i)) {
+                                               snprintf (buf, sizeof (buf), _("Add %s %s"), (*i).to_i18n_string(), channel_noun().c_str());
+                                               sub.push_back (MenuElem (buf, sigc::bind (sigc::mem_fun (*this, &PortMatrix::add_channel_proxy), w, *i)));
+                                       }
                                }
-                       }
 
-                       /* Now add other ones */
-                       for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
-                               if (!should_show (*i)) {
-                                       snprintf (buf, sizeof (buf), _("Add %s %s"), (*i).to_i18n_string(), channel_noun().c_str());
-                                       sub.push_back (MenuElem (buf, sigc::bind (sigc::mem_fun (*this, &PortMatrix::add_channel_proxy), w, *i)));
+                               /* Now add other ones */
+                               for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
+                                       if (!should_show (*i)) {
+                                               snprintf (buf, sizeof (buf), _("Add %s %s"), (*i).to_i18n_string(), channel_noun().c_str());
+                                               sub.push_back (MenuElem (buf, sigc::bind (sigc::mem_fun (*this, &PortMatrix::add_channel_proxy), w, *i)));
+                                       }
                                }
                        }
 
-                       if (can_rename_channels (bc[dim].bundle)) {
+                       if (can_rename_channels (bc[dim].bundle) && bc[dim].channel != -1) {
                                snprintf (
                                        buf, sizeof (buf), _("Rename '%s'..."),
                                        escape_underscores (bc[dim].bundle->channel_name (bc[dim].channel)).c_str()
@@ -450,10 +478,8 @@ PortMatrix::popup_menu (BundleChannel column, BundleChannel row, uint32_t t)
                                if (bc[dim].channel != -1) {
                                        add_remove_option (sub, w, bc[dim].channel);
                                } else {
-
-                                       snprintf (buf, sizeof (buf), _("Remove all"));
                                        sub.push_back (
-                                               MenuElem (buf, sigc::bind (sigc::mem_fun (*this, &PortMatrix::remove_all_channels), w))
+                                               MenuElem (_("Remove all"), sigc::bind (sigc::mem_fun (*this, &PortMatrix::remove_all_channels), w))
                                                );
 
                                        if (bc[dim].bundle->nchannels().n_total() > 1) {
@@ -468,16 +494,23 @@ PortMatrix::popup_menu (BundleChannel column, BundleChannel row, uint32_t t)
 
                        uint32_t c = count_of_our_type (bc[dim].bundle->nchannels ());
                        if ((_show_only_bundles && c > 0) || c == 1) {
+
+                               /* we're looking just at bundles, or our bundle has only one channel, so just offer
+                                  to disassociate all on the bundle.
+                               */
+
                                snprintf (buf, sizeof (buf), _("%s all"), disassociation_verb().c_str());
                                sub.push_back (
-                                       MenuElem (buf, sigc::bind (sigc::mem_fun (*this, &PortMatrix::disassociate_all_on_channel), w, bc[dim].channel, dim))
+                                       MenuElem (buf, sigc::bind (sigc::mem_fun (*this, &PortMatrix::disassociate_all_on_bundle), w, dim))
                                        );
 
-                       } else {
+                       } else if (c != 0) {
 
                                if (bc[dim].channel != -1) {
+                                       /* specific channel under the menu, so just offer to disassociate that */
                                        add_disassociate_option (sub, w, dim, bc[dim].channel);
-                               } else if (count_of_our_type (bc[dim].bundle->nchannels()) != 0) {
+                               } else {
+                                       /* no specific channel; offer to disassociate all, or any one in particular */
                                        snprintf (buf, sizeof (buf), _("%s all"), disassociation_verb().c_str());
                                        sub.push_back (
                                                MenuElem (buf, sigc::bind (sigc::mem_fun (*this, &PortMatrix::disassociate_all_on_bundle), w, dim))
@@ -502,12 +535,16 @@ PortMatrix::popup_menu (BundleChannel column, BundleChannel row, uint32_t t)
        }
 
        items.push_back (MenuElem (_("Rescan"), sigc::mem_fun (*this, &PortMatrix::setup_all_ports)));
+
        items.push_back (CheckMenuElem (_("Show individual ports"), sigc::mem_fun (*this, &PortMatrix::toggle_show_only_bundles)));
-       CheckMenuItem* i = dynamic_cast<CheckMenuItem*> (&items.back());
+       Gtk::CheckMenuItem* i = dynamic_cast<Gtk::CheckMenuItem*> (&items.back());
        _inhibit_toggle_show_only_bundles = true;
        i->set_active (!_show_only_bundles);
        _inhibit_toggle_show_only_bundles = false;
 
+       items.push_back (MenuElem (_("Flip"), sigc::mem_fun (*this, &PortMatrix::flip)));
+       items.back().set_sensitive (can_flip ());
+
        _menu->popup (1, t);
 }
 
@@ -562,7 +599,7 @@ PortMatrix::disassociate_all_on_channel (boost::weak_ptr<Bundle> bundle, uint32_
        for (PortGroup::BundleList::iterator i = a.begin(); i != a.end(); ++i) {
                for (uint32_t j = 0; j < (*i)->bundle->nchannels().n_total(); ++j) {
 
-                       if (should_show ((*i)->bundle->channel_type(j))) {
+                       if (!should_show ((*i)->bundle->channel_type(j))) {
                                continue;
                        }
 
@@ -582,6 +619,7 @@ PortMatrix::disassociate_all_on_channel (boost::weak_ptr<Bundle> bundle, uint32_
 void
 PortMatrix::setup_global_ports ()
 {
+       if (!_session || _session->deletion_in_progress()) return;
        ENSURE_GUI_THREAD (*this, &PortMatrix::setup_global_ports)
 
        for (int i = 0; i < 2; ++i) {
@@ -624,6 +662,11 @@ PortMatrix::toggle_show_only_bundles ()
        _show_only_bundles = !_show_only_bundles;
 
        setup ();
+
+       /* The way in which hardware ports are grouped changes depending on the _show_only_bundles
+          setting, so we need to set things up again now.
+       */
+       setup_all_ports ();
 }
 
 pair<uint32_t, uint32_t>
@@ -673,9 +716,9 @@ PortMatrix::io_from_bundle (boost::shared_ptr<Bundle> b) const
 }
 
 bool
-PortMatrix::can_add_channel (boost::shared_ptr<Bundle> b) const
+PortMatrix::can_add_channels (boost::shared_ptr<Bundle> b) const
 {
-       return io_from_bundle (b);
+       return io_from_bundle (b) != 0;
 }
 
 void
@@ -684,36 +727,49 @@ PortMatrix::add_channel (boost::shared_ptr<Bundle> b, DataType t)
        boost::shared_ptr<IO> io = io_from_bundle (b);
 
        if (io) {
-               io->add_port ("", this, t);
+               int const r = io->add_port ("", this, t);
+               if (r == -1) {
+                       Gtk::MessageDialog msg (_("It is not possible to add a port here."));
+                       msg.set_title (_("Cannot add port"));
+                       msg.run ();
+               }
        }
 }
 
 bool
 PortMatrix::can_remove_channels (boost::shared_ptr<Bundle> b) const
 {
-       return io_from_bundle (b);
+       return io_from_bundle (b) != 0;
 }
 
 void
 PortMatrix::remove_channel (ARDOUR::BundleChannel b)
 {
+       std::string errmsg;
        boost::shared_ptr<IO> io = io_from_bundle (b.bundle);
+       boost::shared_ptr<Port> p = io->nth (b.channel);
 
-       if (io) {
-               boost::shared_ptr<Port> p = io->nth (b.channel);
-               if (p) {
-                       int const r = io->remove_port (p, this);
-                       if (r == -1) {
-                               ArdourDialog d (_("Port removal not allowed"));
-                               Label l (_("This port cannot be removed, as the first plugin in the track or buss cannot accept the new number of inputs."));
-                               d.get_vbox()->pack_start (l);
-                               d.add_button (Stock::OK, RESPONSE_ACCEPT);
-                               d.set_modal (true);
-                               d.show_all ();
-                               d.run ();
-                       }
+       if (!io || !p) {
+               return;
+       }
+
+       if (io->n_ports ().n_total () == 1) {
+               errmsg = _("The last port cannot be removed");
+       } else {
+               if (-1 == io->remove_port (p, this)) {
+                       errmsg = _("This port cannot be removed.");
                }
        }
+
+       if (!errmsg.empty ()) {
+               ArdourDialog d (_("Port removal not allowed"));
+               Label l (errmsg);
+               d.get_vbox()->pack_start (l);
+               d.add_button (Stock::OK, RESPONSE_ACCEPT);
+               d.set_modal (true);
+               d.show_all ();
+               d.run ();
+       }
 }
 
 void
@@ -764,14 +820,26 @@ PortMatrix::setup_notebooks ()
                dummy->show ();
                Label* label = manage (new Label ((*i)->name));
                label->set_angle (_arrangement == LEFT_TO_BOTTOM ? 90 : -90);
+               label->set_use_markup ();
                label->show ();
-               _vnotebook.prepend_page (*dummy, *label);
+               if (_arrangement == LEFT_TO_BOTTOM) {
+                       _vnotebook.prepend_page (*dummy, *label);
+               } else {
+                       /* Reverse the order of vertical tabs when they are on the right hand side
+                          so that from top to bottom it is the same order as that from left to right
+                          for the top tabs.
+                       */
+                       _vnotebook.append_page (*dummy, *label);
+               }
        }
 
        for (PortGroupList::List::const_iterator i = _ports[_column_index].begin(); i != _ports[_column_index].end(); ++i) {
                HBox* dummy = manage (new HBox);
                dummy->show ();
-               _hnotebook.append_page (*dummy, (*i)->name);
+               Label* label = manage (new Label ((*i)->name));
+               label->set_use_markup ();
+               label->show ();
+               _hnotebook.append_page (*dummy, *label);
        }
 
        _ignore_notebook_page_selected = false;
@@ -870,9 +938,18 @@ PortMatrix::visible_ports (int d) const
        PortGroupList const & p = _ports[d];
        PortGroupList::List::const_iterator j = p.begin ();
 
+       /* The logic to compute the index here is a bit twisty because for
+          the TOP_TO_RIGHT arrangement we reverse the order of the vertical
+          tabs in setup_notebooks ().
+       */
+
        int n = 0;
        if (d == _row_index) {
-               n = p.size() - _vnotebook.get_current_page () - 1;
+               if (_arrangement == LEFT_TO_BOTTOM) {
+                       n = p.size() - _vnotebook.get_current_page () - 1;
+               } else {
+                       n = _vnotebook.get_current_page ();
+               }
        } else {
                n = _hnotebook.get_current_page ();
        }
@@ -924,6 +1001,59 @@ void
 PortMatrix::port_connected_or_disconnected ()
 {
        _body->rebuild_and_draw_grid ();
+       update_tab_highlighting ();
+}
+
+/** Update the highlighting of tab names to reflect which ones
+ *  have connections.  This is pretty inefficient, unfortunately,
+ *  but maybe that doesn't matter too much.
+ */
+void
+PortMatrix::update_tab_highlighting ()
+{
+       if (!_session) {
+               return;
+       }
+
+       for (int i = 0; i < 2; ++i) {
+
+               Gtk::Notebook* notebook = row_index() == i ? &_vnotebook : &_hnotebook;
+
+               PortGroupList const * gl = ports (i);
+               int p = 0;
+               for (PortGroupList::List::const_iterator j = gl->begin(); j != gl->end(); ++j) {
+                       bool has_connection = false;
+                       PortGroup::BundleList const & bl = (*j)->bundles ();
+                       PortGroup::BundleList::const_iterator k = bl.begin ();
+                       while (k != bl.end()) {
+                               if ((*k)->bundle->connected_to_anything (_session->engine())) {
+                                       has_connection = true;
+                                       break;
+                               }
+                               ++k;
+                       }
+
+                       /* Find the page index that we should update; this is backwards
+                          for the vertical tabs in the LEFT_TO_BOTTOM arrangement.
+                       */
+                       int page = p;
+                       if (i == row_index() && _arrangement == LEFT_TO_BOTTOM) {
+                               page = notebook->get_n_pages() - p - 1;
+                       }
+
+                       Gtk::Label* label = dynamic_cast<Gtk::Label*> (notebook->get_tab_label(*notebook->get_nth_page (page)));
+                       string c = label->get_label ();
+                       if (c.length() && c[0] == '<' && !has_connection) {
+                               /* this label is marked up with <b> but shouldn't be */
+                               label->set_text ((*j)->name);
+                       } else if (c.length() && c[0] != '<' && has_connection) {
+                               /* this label is not marked up with <b> but should be */
+                               label->set_markup (string_compose ("<b>%1</b>", Gtkmm2ext::markup_escape_text ((*j)->name)));
+                       }
+
+                       ++p;
+               }
+       }
 }
 
 string
@@ -1024,7 +1154,7 @@ PortMatrix::get_association (PortMatrixNode node) const
 
        }
 
-       /* NOTREACHED */
+       abort(); /* NOTREACHED */
        return PortMatrixNode::NOT_ASSOCIATED;
 }
 
@@ -1034,3 +1164,75 @@ PortMatrix::bundle_with_channels (boost::shared_ptr<ARDOUR::Bundle> b)
 {
        return b && b->nchannels() != ARDOUR::ChanCount::ZERO;
 }
+
+/** See if a `flip' is possible.
+ *  @return If flip is possible, the new (row, column) notebook indices that
+ *  should be selected; otherwise, (-1, -1)
+ */
+pair<int, int>
+PortMatrix::check_flip () const
+{
+       /* Look for the row's port group name in the columns */
+
+       int new_column = 0;
+       boost::shared_ptr<const PortGroup> r = visible_ports (_row_index);
+       PortGroupList::List::const_iterator i = _ports[_column_index].begin();
+       while (i != _ports[_column_index].end() && (*i)->name != r->name) {
+               ++i;
+               ++new_column;
+       }
+
+       if (i == _ports[_column_index].end ()) {
+               return make_pair (-1, -1);
+       }
+
+       /* Look for the column's port group name in the rows */
+
+       int new_row = 0;
+       boost::shared_ptr<const PortGroup> c = visible_ports (_column_index);
+       i = _ports[_row_index].begin();
+       while (i != _ports[_row_index].end() && (*i)->name != c->name) {
+               ++i;
+               ++new_row;
+       }
+
+       if (i == _ports[_row_index].end ()) {
+               return make_pair (-1, -1);
+       }
+
+       if (_arrangement == LEFT_TO_BOTTOM) {
+               new_row = _ports[_row_index].size() - new_row - 1;
+       }
+
+       return make_pair (new_row, new_column);
+}
+
+bool
+PortMatrix::can_flip () const
+{
+       return check_flip().first != -1;
+}
+
+/** Flip the column and row pages around, if possible */
+void
+PortMatrix::flip ()
+{
+       pair<int, int> n = check_flip ();
+       if (n.first == -1) {
+               return;
+       }
+
+       _vnotebook.set_current_page (n.first);
+       _hnotebook.set_current_page (n.second);
+}
+
+bool
+PortMatrix::key_press (GdkEventKey* k)
+{
+       if (k->keyval == GDK_f) {
+               flip ();
+               return true;
+       }
+
+       return false;
+}