Add test for #3356.
[ardour.git] / gtk2_ardour / port_matrix.cc
index 604fecbe6bbd30b20c1dc6226095ee76dafb4251..6113412df91e4d7b89874fe8279d8d58304d60a2 100644 (file)
@@ -35,9 +35,9 @@
 #include "port_matrix_component.h"
 #include "i18n.h"
 #include "gui_thread.h"
+#include "utils.h"
 
 using namespace std;
-using namespace sigc;
 using namespace Gtk;
 using namespace ARDOUR;
 
@@ -46,21 +46,22 @@ using namespace ARDOUR;
  *  @param type Port type that we are handling.
  */
 PortMatrix::PortMatrix (Window* parent, Session* session, DataType type)
-       : Table (3, 3),
-         _session (session),
-         _parent (parent),
-         _type (type),
-         _menu (0),
-         _arrangement (TOP_TO_RIGHT),
-         _row_index (0),
-         _column_index (1),
-         _min_height_divisor (1),
-         _show_only_bundles (false),
-         _inhibit_toggle_show_only_bundles (false),
-         _ignore_notebook_page_selected (false)
-{
+       : Table (3, 3)
+       , _parent (parent)
+       , _type (type)
+       , _menu (0)
+       , _arrangement (TOP_TO_RIGHT)
+       , _row_index (0)
+       , _column_index (1)
+       , _min_height_divisor (1)
+       , _show_only_bundles (false)
+       , _inhibit_toggle_show_only_bundles (false)
+       , _ignore_notebook_page_selected (false)
+{
+       set_session (session);
+
        _body = new PortMatrixBody (this);
-       _body->DimensionsChanged.connect (mem_fun (*this, &PortMatrix::body_dimensions_changed));
+       _body->DimensionsChanged.connect (sigc::mem_fun (*this, &PortMatrix::body_dimensions_changed));
 
        _vbox.pack_start (_vspacer, false, false);
        _vbox.pack_start (_vnotebook, false, false);
@@ -69,17 +70,13 @@ PortMatrix::PortMatrix (Window* parent, Session* session, DataType type)
        _hbox.pack_start (_hnotebook, false, false);
        _hbox.pack_start (_hlabel, true, true);
 
-       _vnotebook.signal_switch_page().connect (mem_fun (*this, &PortMatrix::notebook_page_selected));
+       _vnotebook.signal_switch_page().connect (sigc::mem_fun (*this, &PortMatrix::notebook_page_selected));
        _vnotebook.property_tab_border() = 4;
        _vnotebook.set_name (X_("PortMatrixLabel"));
-       _hnotebook.signal_switch_page().connect (mem_fun (*this, &PortMatrix::notebook_page_selected));
+       _hnotebook.signal_switch_page().connect (sigc::mem_fun (*this, &PortMatrix::notebook_page_selected));
        _hnotebook.property_tab_border() = 4;
        _hnotebook.set_name (X_("PortMatrixLabel"));
 
-       for (int i = 0; i < 2; ++i) {
-               _ports[i].set_type (type);
-       }
-
        _vlabel.set_use_markup ();
        _vlabel.set_alignment (1, 1);
        _vlabel.set_padding (4, 16);
@@ -98,6 +95,8 @@ PortMatrix::PortMatrix (Window* parent, Session* session, DataType type)
        _hlabel.show ();
        _hspacer.show ();
        _vspacer.show ();
+       _vnotebook.show ();
+       _hnotebook.show ();
 }
 
 PortMatrix::~PortMatrix ()
@@ -118,7 +117,7 @@ PortMatrix::init ()
 {
        select_arrangement ();
 
-       /* Signal handling is kind of split into two parts:
+       /* Signal handling is kind of split into three parts:
         *
         * 1.  When _ports[] changes, we call setup().  This essentially sorts out our visual
         *     representation of the information in _ports[].
@@ -126,6 +125,8 @@ PortMatrix::init ()
         * 2.  When certain other things change, we need to get our subclass to clear and
         *     re-fill _ports[], which in turn causes appropriate signals to be raised to
         *     hook into part (1).
+        *
+        * 3.  Assorted other signals.
         */
 
 
@@ -133,29 +134,32 @@ PortMatrix::init ()
 
        for (int i = 0; i < 2; ++i) {
                /* watch for the content of _ports[] changing */
-               _ports[i].Changed.connect (mem_fun (*this, &PortMatrix::setup));
+               _ports[i].Changed.connect (_changed_connections, invalidator (*this), boost::bind (&PortMatrix::setup, this), gui_context());
 
                /* and for bundles in _ports[] changing */
-               _ports[i].BundleChanged.connect (sigc::hide (mem_fun (*this, &PortMatrix::setup)));
+               _ports[i].BundleChanged.connect (_bundle_changed_connections, invalidator (*this), boost::bind (&PortMatrix::setup, this), gui_context());
        }
 
-       /* scrolling stuff */
-       _hscroll.signal_value_changed().connect (mem_fun (*this, &PortMatrix::hscroll_changed));
-       _vscroll.signal_value_changed().connect (mem_fun (*this, &PortMatrix::vscroll_changed));
-
-
        /* Part 2: notice when things have changed that require our subclass to clear and refill _ports[] */
        
        /* watch for routes being added or removed */
-       _session->RouteAdded.connect (sigc::hide (mem_fun (*this, &PortMatrix::routes_changed)));
+       _session->RouteAdded.connect (_session_connections, invalidator (*this), boost::bind (&PortMatrix::routes_changed, this), gui_context());
 
        /* and also bundles */
-       _session->BundleAdded.connect (sigc::hide (mem_fun (*this, &PortMatrix::setup_global_ports)));
+       _session->BundleAdded.connect (_session_connections, invalidator (*this), boost::bind (&PortMatrix::setup_global_ports, this), gui_context());
 
        /* and also ports */
-       _session->engine().PortRegisteredOrUnregistered.connect (mem_fun (*this, &PortMatrix::setup_global_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, this), gui_context());
+
+       /* Part 3: other stuff */
+       
+       _session->engine().PortConnectedOrDisconnected.connect (_session_connections, invalidator (*this), boost::bind (&PortMatrix::port_connected_or_disconnected, this), gui_context ());
 
-       _session->GoingAway.connect (mem_fun (*this, &PortMatrix::session_going_away));
+       _hscroll.signal_value_changed().connect (sigc::mem_fun (*this, &PortMatrix::hscroll_changed));
+       _vscroll.signal_value_changed().connect (sigc::mem_fun (*this, &PortMatrix::vscroll_changed));
 
        reconnect_to_routes ();
        
@@ -166,16 +170,11 @@ PortMatrix::init ()
 void
 PortMatrix::reconnect_to_routes ()
 {
-       for (vector<connection>::iterator i = _route_connections.begin(); i != _route_connections.end(); ++i) {
-               i->disconnect ();
-       }
-       _route_connections.clear ();
+       _route_connections.drop_connections ();
 
        boost::shared_ptr<RouteList> routes = _session->get_routes ();
        for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
-               _route_connections.push_back (
-                       (*i)->processors_changed.connect (mem_fun (*this, &PortMatrix::route_processors_changed))
-                       );
+               (*i)->processors_changed.connect (_route_connections, invalidator (*this), ui_bind (&PortMatrix::route_processors_changed, this, _1), gui_context());
        }
 }
 
@@ -204,7 +203,7 @@ PortMatrix::setup ()
 {
        /* this needs to be done first, as the visible_ports() method uses the
           notebook state to decide which ports are being shown */
-       
+
        setup_notebooks ();
        
        _body->setup ();
@@ -216,8 +215,6 @@ void
 PortMatrix::set_type (DataType t)
 {
        _type = t;
-       _ports[0].set_type (_type);
-       _ports[1].set_type (_type);
 
        setup_all_ports ();
 }
@@ -260,13 +257,17 @@ PortMatrix::disassociate_all ()
        PortGroup::BundleList b = _ports[1].bundles ();
 
        for (PortGroup::BundleList::iterator i = a.begin(); i != a.end(); ++i) {
-               for (uint32_t j = 0; j < i->bundle->nchannels(); ++j) {
+               for (uint32_t j = 0; j < (*i)->bundle->nchannels().n_total(); ++j) {
                        for (PortGroup::BundleList::iterator k = b.begin(); k != b.end(); ++k) {
-                               for (uint32_t l = 0; l < k->bundle->nchannels(); ++l) {
+                               for (uint32_t l = 0; l < (*k)->bundle->nchannels().n_total(); ++l) {
+
+                                       if (!should_show ((*i)->bundle->channel_type(j)) || !should_show ((*k)->bundle->channel_type(l))) {
+                                               continue;
+                                       }
 
                                        BundleChannel c[2] = {
-                                               BundleChannel (i->bundle, j),
-                                               BundleChannel (k->bundle, l)
+                                               BundleChannel ((*i)->bundle, j),
+                                               BundleChannel ((*k)->bundle, l)
                                                        };
 
                                        if (get_state (c) == PortMatrixNode::ASSOCIATED) {
@@ -286,8 +287,8 @@ void
 PortMatrix::select_arrangement ()
 {
        uint32_t const N[2] = {
-               _ports[0].total_channels (),
-               _ports[1].total_channels ()
+               count_of_our_type (_ports[0].total_channels()),
+               count_of_our_type (_ports[1].total_channels())
        };
 
        /* The list with the most channels goes on left or right, so that the most channel
@@ -390,19 +391,23 @@ PortMatrix::popup_menu (BundleChannel column, BundleChannel row, uint32_t t)
 
                        bool can_add_or_rename = false;
 
-                       if (can_add_channel (bc[dim].bundle)) {
-                               snprintf (buf, sizeof (buf), _("Add %s"), channel_noun().c_str());
-                               sub.push_back (MenuElem (buf, bind (mem_fun (*this, &PortMatrix::add_channel_proxy), w)));
-                               can_add_or_rename = true;
+                       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)));
+                                       can_add_or_rename = true;
+                               }
                        }
 
-
                        if (can_rename_channels (bc[dim].bundle)) {
-                               snprintf (buf, sizeof (buf), _("Rename '%s'..."), bc[dim].bundle->channel_name (bc[dim].channel).c_str());
+                               snprintf (
+                                       buf, sizeof (buf), _("Rename '%s'..."),
+                                       escape_underscores (bc[dim].bundle->channel_name (bc[dim].channel)).c_str()
+                                       );
                                sub.push_back (
                                        MenuElem (
                                                buf,
-                                               bind (mem_fun (*this, &PortMatrix::rename_channel_proxy), w, bc[dim].channel)
+                                               sigc::bind (sigc::mem_fun (*this, &PortMatrix::rename_channel_proxy), w, bc[dim].channel)
                                                )
                                        );
                                can_add_or_rename = true;
@@ -413,30 +418,48 @@ PortMatrix::popup_menu (BundleChannel column, BundleChannel row, uint32_t t)
                        }
 
                        if (can_remove_channels (bc[dim].bundle)) {
-                               snprintf (buf, sizeof (buf), _("Remove '%s'"), bc[dim].bundle->channel_name (bc[dim].channel).c_str());
-                               sub.push_back (
-                                       MenuElem (
-                                               buf,
-                                               bind (mem_fun (*this, &PortMatrix::remove_channel_proxy), w, bc[dim].channel)
-                                               )
-                                       );
+                               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))
+                                               );
+                                       
+                                       for (uint32_t i = 0; i < bc[dim].bundle->nchannels().n_total(); ++i) {
+                                               if (should_show (bc[dim].bundle->channel_type(i))) {
+                                                       add_remove_option (sub, w, i);
+                                               }
+                                       }
+                               }
                        }
 
-                       if (_show_only_bundles || bc[dim].bundle->nchannels() <= 1) {
+                       if (_show_only_bundles || count_of_our_type (bc[dim].bundle->nchannels()) <= 1) {
                                snprintf (buf, sizeof (buf), _("%s all"), disassociation_verb().c_str());
-                       } else {
-                               snprintf (
-                                       buf, sizeof (buf), _("%s all from '%s'"),
-                                       disassociation_verb().c_str(),
-                                       bc[dim].bundle->channel_name (bc[dim].channel).c_str()
+                               sub.push_back (
+                                       MenuElem (buf, sigc::bind (sigc::mem_fun (*this, &PortMatrix::disassociate_all_on_channel), w, bc[dim].channel, dim))
                                        );
+                               
+                       } else {
+                               
+                               if (bc[dim].channel != -1) {
+                                       add_disassociate_option (sub, w, dim, bc[dim].channel);
+                               } else {
+                                       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))
+                                               );
+                                                       
+                                       for (uint32_t i = 0; i < bc[dim].bundle->nchannels().n_total(); ++i) {
+                                               if (should_show (bc[dim].bundle->channel_type(i))) {
+                                                       add_disassociate_option (sub, w, dim, i);
+                                               }
+                                       }
+                               }
                        }
 
-                       sub.push_back (
-                               MenuElem (buf, bind (mem_fun (*this, &PortMatrix::disassociate_all_on_channel), w, bc[dim].channel, dim))
-                               );
-
-                       items.push_back (MenuElem (bc[dim].bundle->name().c_str(), *m));
+                       items.push_back (MenuElem (escape_underscores (bc[dim].bundle->name()).c_str(), *m));
                        need_separator = true;
                }
 
@@ -446,8 +469,8 @@ PortMatrix::popup_menu (BundleChannel column, BundleChannel row, uint32_t t)
                items.push_back (SeparatorElem ());
        }
 
-       items.push_back (MenuElem (_("Rescan"), mem_fun (*this, &PortMatrix::setup_all_ports)));
-       items.push_back (CheckMenuElem (_("Show individual ports"), mem_fun (*this, &PortMatrix::toggle_show_only_bundles)));
+       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());
        _inhibit_toggle_show_only_bundles = true;
        i->set_active (!_show_only_bundles);
@@ -479,6 +502,21 @@ PortMatrix::rename_channel_proxy (boost::weak_ptr<Bundle> b, uint32_t c)
        rename_channel (BundleChannel (sb, c));
 }
 
+void
+PortMatrix::disassociate_all_on_bundle (boost::weak_ptr<Bundle> bundle, int dim)
+{
+       boost::shared_ptr<Bundle> sb = bundle.lock ();
+       if (!sb) {
+               return;
+       }
+
+       for (uint32_t i = 0; i < sb->nchannels().n_total(); ++i) {
+               if (should_show (sb->channel_type(i))) {
+                       disassociate_all_on_channel (bundle, i, dim);
+               }
+       }
+}
+
 void
 PortMatrix::disassociate_all_on_channel (boost::weak_ptr<Bundle> bundle, uint32_t channel, int dim)
 {
@@ -490,11 +528,15 @@ PortMatrix::disassociate_all_on_channel (boost::weak_ptr<Bundle> bundle, uint32_
        PortGroup::BundleList a = _ports[1-dim].bundles ();
 
        for (PortGroup::BundleList::iterator i = a.begin(); i != a.end(); ++i) {
-               for (uint32_t j = 0; j < i->bundle->nchannels(); ++j) {
+               for (uint32_t j = 0; j < (*i)->bundle->nchannels().n_total(); ++j) {
+
+                       if (should_show ((*i)->bundle->channel_type(j))) {
+                               continue;
+                       }
 
                        BundleChannel c[2];
                        c[dim] = BundleChannel (sb, channel);
-                       c[1-dim] = BundleChannel (i->bundle, j);
+                       c[1-dim] = BundleChannel ((*i)->bundle, j);
 
                        if (get_state (c) == PortMatrixNode::ASSOCIATED) {
                                set_state (c, false);
@@ -508,7 +550,7 @@ PortMatrix::disassociate_all_on_channel (boost::weak_ptr<Bundle> bundle, uint32_
 void
 PortMatrix::setup_global_ports ()
 {
-       ENSURE_GUI_THREAD (mem_fun (*this, &PortMatrix::setup_global_ports));
+       ENSURE_GUI_THREAD (*this, &PortMatrix::setup_global_ports)
 
        for (int i = 0; i < 2; ++i) {
                if (list_is_global (i)) {
@@ -524,7 +566,7 @@ PortMatrix::setup_all_ports ()
                return;
        }
 
-       ENSURE_GUI_THREAD (mem_fun (*this, &PortMatrix::setup_all_ports));
+       ENSURE_GUI_THREAD (*this, &PortMatrix::setup_all_ports)
 
        setup_ports (0);
        setup_ports (1);
@@ -595,12 +637,12 @@ PortMatrix::can_add_channel (boost::shared_ptr<Bundle> b) const
 }
 
 void
-PortMatrix::add_channel (boost::shared_ptr<Bundle> b)
+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, _type);
+               io->add_port ("", this, t);
        }
 }
 
@@ -624,14 +666,29 @@ PortMatrix::remove_channel (ARDOUR::BundleChannel b)
 }
 
 void
-PortMatrix::add_channel_proxy (boost::weak_ptr<Bundle> w)
+PortMatrix::remove_all_channels (boost::weak_ptr<Bundle> w)
+{
+       boost::shared_ptr<Bundle> b = w.lock ();
+       if (!b) {
+               return;
+       }
+
+       for (uint32_t i = 0; i < b->nchannels().n_total(); ++i) {
+               if (should_show (b->channel_type(i))) {
+                       remove_channel (ARDOUR::BundleChannel (b, i));
+               }
+       }
+}
+
+void
+PortMatrix::add_channel_proxy (boost::weak_ptr<Bundle> w, DataType t)
 {
        boost::shared_ptr<Bundle> b = w.lock ();
        if (!b) {
                return;
        }
 
-       add_channel (b);
+       add_channel (b, t);
 }
 
 void
@@ -653,6 +710,7 @@ PortMatrix::setup_notebooks ()
                dummy->show ();
                Label* label = manage (new Label ((*i)->name));
                label->set_angle (_arrangement == LEFT_TO_BOTTOM ? 90 : -90);
+               label->show ();
                _vnotebook.prepend_page (*dummy, *label);
        }
 
@@ -759,3 +817,62 @@ PortMatrix::visible_ports (int d) const
 
        return *j;
 }
+
+void
+PortMatrix::add_remove_option (Menu_Helpers::MenuList& m, boost::weak_ptr<Bundle> w, int c)
+{
+       using namespace Menu_Helpers;
+
+       boost::shared_ptr<Bundle> b = w.lock ();
+       if (!b) {
+               return;
+       }
+       
+       char buf [64];
+       snprintf (buf, sizeof (buf), _("Remove '%s'"), escape_underscores (b->channel_name (c)).c_str());
+       m.push_back (MenuElem (buf, sigc::bind (sigc::mem_fun (*this, &PortMatrix::remove_channel_proxy), w, c)));
+}
+
+void
+PortMatrix::add_disassociate_option (Menu_Helpers::MenuList& m, boost::weak_ptr<Bundle> w, int d, int c)
+{
+       using namespace Menu_Helpers;
+
+       boost::shared_ptr<Bundle> b = w.lock ();
+       if (!b) {
+               return;
+       }
+       
+       char buf [64];
+       snprintf (buf, sizeof (buf), _("%s all from '%s'"), disassociation_verb().c_str(), escape_underscores (b->channel_name (c)).c_str());
+       m.push_back (MenuElem (buf, sigc::bind (sigc::mem_fun (*this, &PortMatrix::disassociate_all_on_channel), w, c, d)));
+}
+
+void
+PortMatrix::port_connected_or_disconnected ()
+{
+       _body->rebuild_and_draw_grid ();
+}
+
+string
+PortMatrix::channel_noun () const
+{
+       return _("channel");
+}
+
+/** @return true if this matrix should show bundles / ports of type \t */
+bool
+PortMatrix::should_show (DataType t) const
+{
+       return (_type == DataType::NIL || t == _type);
+}
+       
+uint32_t
+PortMatrix::count_of_our_type (ChanCount c) const
+{
+       if (_type == DataType::NIL) {
+               return c.n_total ();
+       }
+
+       return c.get (_type);
+}