Better fix for non-rearrangement after open for the port matrix.
[ardour.git] / gtk2_ardour / port_matrix.cc
index e04dd3b252db2d7343822c21a573a18c0f1b9b5e..a35ec2f0469c1cc430c57d9ef40f9f65d896cf2c 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2002-2007 Paul Davis 
+    Copyright (C) 2002-2009 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
 
 */
 
+#include <iostream>
+#include <gtkmm/scrolledwindow.h>
+#include <gtkmm/adjustment.h>
 #include <gtkmm/label.h>
-#include <gtkmm/enums.h>
 #include <gtkmm/menu.h>
-#include <gtkmm/menu_elems.h>
-#include <gtkmm/menuitem.h>
 #include <gtkmm/menushell.h>
-#include <glibmm/objectbase.h>
-#include <gtkmm2ext/doi.h>
-#include "ardour/data_type.h"
-#include "i18n.h"
+#include <gtkmm/menu_elems.h>
+#include "ardour/bundle.h"
+#include "ardour/types.h"
+#include "ardour/session.h"
+#include "ardour/route.h"
 #include "port_matrix.h"
+#include "port_matrix_body.h"
+#include "i18n.h"
 
+using namespace std;
+using namespace sigc;
 using namespace Gtk;
 
-PortMatrix::PortMatrix (ARDOUR::Session& session, ARDOUR::DataType type, bool offer_inputs, PortGroupList::Mask mask)
-       : _offer_inputs (offer_inputs), _port_group_list (session, type, offer_inputs, mask), _type (type), matrix (this)
+/** PortMatrix constructor.
+ *  @param session Our session.
+ *  @param type Port type that we are handling.
+ */
+PortMatrix::PortMatrix (ARDOUR::Session& session, ARDOUR::DataType type)
+       : Table (2, 2),
+         _session (session),
+         _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),
+         _realized (false)
 {
-       _side_vbox_pad = 0;
+       _body = new PortMatrixBody (this);
 
-       _visibility_checkbutton_box.pack_start (*(manage (new Label (_("Connections displayed: ")))), false, false, 10);
-       pack_start (_visibility_checkbutton_box, false, false);
+       for (int i = 0; i < 2; ++i) {
+               _ports[i].set_type (type);
+               
+               /* watch for the content of _ports[] changing */
+               _ports[i].Changed.connect (mem_fun (*this, &PortMatrix::setup));
+       }
 
-       _scrolled_window.set_policy (POLICY_ALWAYS, POLICY_AUTOMATIC);
-       _scrolled_window.set_shadow_type (SHADOW_NONE);
+       _hscroll.signal_value_changed().connect (mem_fun (*this, &PortMatrix::hscroll_changed));
+       _vscroll.signal_value_changed().connect (mem_fun (*this, &PortMatrix::vscroll_changed));
 
-       _scrolled_window.add (matrix);
+       /* watch for routes being added or removed */
+       _session.RouteAdded.connect (sigc::hide (mem_fun (*this, &PortMatrix::routes_changed)));
 
-       if (offer_inputs) {
-               _overall_hbox.pack_start (_side_vbox, false, false, 6);
-               _overall_hbox.pack_start (_scrolled_window, true, true);
-       } else {
-               _overall_hbox.pack_start (_scrolled_window, true, true, 6);
-               _overall_hbox.pack_start (_side_vbox, false, false);
-       }
+       /* and also bundles */
+       _session.BundleAdded.connect (sigc::hide (mem_fun (*this, &PortMatrix::setup_global_ports)));
+       
+       reconnect_to_routes ();
 
-       pack_start (_overall_hbox);
+       attach (*_body, 0, 1, 0, 1);
+       attach (_vscroll, 1, 2, 0, 1, SHRINK);
+       attach (_hscroll, 0, 1, 1, 2, FILL | EXPAND, SHRINK);
+       
+       show_all ();
 }
 
 PortMatrix::~PortMatrix ()
 {
-       clear ();
+       delete _body;
+       delete _menu;
 }
 
-void 
-PortMatrix::set_ports (const std::list<std::string>& ports)
+/** Disconnect from and reconnect to routes' signals that we need to watch for things that affect the matrix */
+void
+PortMatrix::reconnect_to_routes ()
 {
-       matrix.set_ports (ports);
+       for (vector<connection>::iterator i = _route_connections.begin(); i != _route_connections.end(); ++i) {
+               i->disconnect ();
+       }
+       _route_connections.clear ();
+
+       boost::shared_ptr<ARDOUR::RouteList> routes = _session.get_routes ();
+       for (ARDOUR::RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
+               _route_connections.push_back (
+                       (*i)->processors_changed.connect (mem_fun (*this, &PortMatrix::setup_global_ports))
+                       );
+       }
 }
 
-/** Clear out the things that change when the number of source or destination ports changes */
+/** A route has been added to or removed from the session */
 void
-PortMatrix::clear ()
+PortMatrix::routes_changed ()
 {
-       /* remove lurking, invisible label and padding */
-       
-       _side_vbox.children().clear ();
-
-       delete _side_vbox_pad;
-       _side_vbox_pad = 0;
+       reconnect_to_routes ();
+       setup_global_ports ();
+}
 
-       for (std::vector<PortGroupUI*>::iterator i = _port_group_ui.begin(); i != _port_group_ui.end(); ++i) {
-               _visibility_checkbutton_box.remove ((*i)->get_visibility_checkbutton());
-               delete *i;
+/** Set up everything that depends on the content of _ports[] */
+void
+PortMatrix::setup ()
+{
+       if (!_realized) {
+               select_arrangement ();
        }
 
-       _port_group_ui.clear ();
+       _body->setup ();
+       setup_scrollbars ();
+       queue_draw ();
+
+       show_all ();
 }
 
-/** Set up the dialogue */
 void
-PortMatrix::setup ()
+PortMatrix::set_type (ARDOUR::DataType t)
 {
-       /* sort out the ports that we'll offer to connect to */
-       _port_group_list.refresh ();
+       _type = t;
+       _ports[0].set_type (_type);
+       _ports[1].set_type (_type);
        
-       clear ();
+       setup_all_ports ();
+}
 
-       _side_vbox_pad = new Label (""); /* unmanaged, explicitly deleted */
+void
+PortMatrix::hscroll_changed ()
+{
+       _body->set_xoffset (_hscroll.get_adjustment()->get_value());
+}
 
-       _side_vbox.pack_start (*_side_vbox_pad, false, false);
-       _side_vbox.pack_start (*manage (new Label ("")));
+void
+PortMatrix::vscroll_changed ()
+{
+       _body->set_yoffset (_vscroll.get_adjustment()->get_value());
+}
 
-       matrix.clear ();
+void
+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);
+
+       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);
+}
 
-       /* Matrix and visibility checkbuttons */
-       for (PortGroupList::iterator i = _port_group_list.begin(); i != _port_group_list.end(); ++i) {
+/** Disassociate all of our ports from each other */
+void
+PortMatrix::disassociate_all ()
+{
+       PortGroup::BundleList a = _ports[0].bundles ();
+       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 (PortGroup::BundleList::iterator k = b.begin(); k != b.end(); ++k) {
+                               for (uint32_t l = 0; l < k->bundle->nchannels(); ++l) {
+                                               
+                                       ARDOUR::BundleChannel c[2] = {
+                                               ARDOUR::BundleChannel (i->bundle, j),
+                                               ARDOUR::BundleChannel (k->bundle, l)
+                                                       };
+
+                                       if (get_state (c) == PortMatrixNode::ASSOCIATED) {
+                                               set_state (c, false);
+                                       }
+
+                               }
+                       }
+               }
+       }
 
-               PortGroupUI* t = new PortGroupUI (*this, **i);
-               
-               _port_group_ui.push_back (t);
+       _body->rebuild_and_draw_grid ();
+}
 
-               matrix.add_group (**i);
+/* Decide how to arrange the components of the matrix */
+void
+PortMatrix::select_arrangement ()
+{
+       uint32_t const N[2] = {
+               _ports[0].total_visible_channels (),
+               _ports[1].total_visible_channels ()
+       };
+
+       /* The list with the most channels goes on left or right, so that the most channel
+          names are printed horizontally and hence more readable.  However we also
+          maintain notional `signal flow' vaguely from left to right.  Subclasses
+          should choose where to put ports based on signal flowing from _ports[0]
+          to _ports[1] */
+       
+       if (N[0] > N[1]) {
 
-               _visibility_checkbutton_box.pack_start (t->get_visibility_checkbutton(), false, false);
+               _row_index = 0;
+               _column_index = 1;
+               _arrangement = LEFT_TO_BOTTOM;
 
-               CheckButton* chk = dynamic_cast<CheckButton*>(&t->get_visibility_checkbutton());
+       } else {
 
-               if (chk) { 
-                       chk->signal_toggled().connect (sigc::mem_fun (*this, &PortMatrix::reset_visibility));
-               }
+               _row_index = 1;
+               _column_index = 0;
+               _arrangement = TOP_TO_RIGHT;
        }
+}
 
-       show_all ();
+/** @return columns list */
+PortGroupList const *
+PortMatrix::columns () const
+{
+       return &_ports[_column_index];
+}
 
-       reset_visibility ();
+/* @return rows list */
+PortGroupList const *
+PortMatrix::rows () const
+{
+       return &_ports[_row_index];
 }
 
 void
-PortMatrix::reset_visibility ()
+PortMatrix::popup_menu (
+       pair<boost::shared_ptr<PortGroup>, ARDOUR::BundleChannel> column,
+       pair<boost::shared_ptr<PortGroup>, ARDOUR::BundleChannel> row,
+       uint32_t t
+       )
 {
-       for (std::vector<PortGroupUI*>::iterator i = _port_group_ui.begin(); i != _port_group_ui.end(); ++i) {
+       using namespace Menu_Helpers;
+       
+       delete _menu;
 
-               (*i)->setup_visibility ();
-               
-               if ((*i)->port_group().visible) {
-                       matrix.show_group ((*i)->port_group());
-               } else {
-                       matrix.hide_group ((*i)->port_group());
+       _menu = new Menu;
+       _menu->set_name ("ArdourContextMenu");
+       
+       MenuList& items = _menu->items ();
+
+       boost::shared_ptr<PortGroup> pg[2];
+       pg[_column_index] = column.first;
+       pg[_row_index] = row.first;
+
+       ARDOUR::BundleChannel bc[2];
+       bc[_column_index] = column.second;
+       bc[_row_index] = row.second;
+
+       char buf [64];
+
+       for (int dim = 0; dim < 2; ++dim) {
+
+               if (pg[dim]) {
+
+                       boost::weak_ptr<PortGroup> wp (pg[dim]);
+                       
+                       if (pg[dim]->visible()) {
+                               if (dim == 0) {
+                                       snprintf (buf, sizeof (buf), _("Hide '%s' sources"), pg[dim]->name.c_str());
+                               } else {
+                                       snprintf (buf, sizeof (buf), _("Hide '%s' destinations"), pg[dim]->name.c_str());
+                               }
+
+                               items.push_back (MenuElem (buf, bind (mem_fun (*this, &PortMatrix::hide_group), wp)));
+                       } else {
+                               if (dim == 0) {
+                                       snprintf (buf, sizeof (buf), _("Show '%s' sources"), pg[dim]->name.c_str());
+                               } else {
+                                       snprintf (buf, sizeof (buf), _("Show '%s' destinations"), pg[dim]->name.c_str());
+                               }
+                               items.push_back (MenuElem (buf, bind (mem_fun (*this, &PortMatrix::show_group), wp)));
+                       }
+               }
+
+               if (bc[dim].bundle) {
+                       bool have_one = false;
+                       
+                       if (can_rename_channels (dim)) {
+                               snprintf (buf, sizeof (buf), _("Rename '%s'..."), bc[dim].bundle->channel_name (bc[dim].channel).c_str());
+                               boost::weak_ptr<ARDOUR::Bundle> w (bc[dim].bundle);
+                               items.push_back (
+                                       MenuElem (
+                                               buf,
+                                               bind (mem_fun (*this, &PortMatrix::rename_channel_proxy), w, bc[dim].channel)
+                                               )
+                                       );
+                               
+                               have_one = true;
+                       }
+                       
+                       if (can_remove_channels (dim)) {
+                               snprintf (buf, sizeof (buf), _("Remove '%s'"), bc[dim].bundle->channel_name (bc[dim].channel).c_str());
+                               boost::weak_ptr<ARDOUR::Bundle> w (bc[dim].bundle);
+                               items.push_back (
+                                       MenuElem (
+                                               buf,
+                                               bind (mem_fun (*this, &PortMatrix::remove_channel_proxy), w, bc[dim].channel)
+                                               )
+                                       );
+                               
+                               have_one = true;
+                       }
+                       
+                       boost::weak_ptr<ARDOUR::Bundle> w (bc[dim].bundle);
+
+                       if (_show_only_bundles) {
+                               snprintf (buf, sizeof (buf), _("Disassociate all from '%s'"), bc[dim].bundle->name().c_str());
+                       } else {
+                               snprintf (
+                                       buf, sizeof (buf), _("Disassociate all from '%s/%s'"),
+                                       bc[dim].bundle->name().c_str(), bc[dim].bundle->channel_name (bc[dim].channel).c_str()
+                                       );
+                       }
+                       
+                       items.push_back (
+                               MenuElem (buf, bind (mem_fun (*this, &PortMatrix::disassociate_all_on_channel), w, bc[dim].channel, dim))
+                               );
+                       
                }
        }
+
+       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)));
+       CheckMenuItem* i = dynamic_cast<CheckMenuItem*> (&items.back());
+       _inhibit_toggle_show_only_bundles = true;
+       i->set_active (!_show_only_bundles);
+       _inhibit_toggle_show_only_bundles = false;
+       
+       _menu->popup (1, t);
 }
 
 
-/** Handle a button press on a row label */
-bool
-PortMatrix::row_label_button_pressed (GdkEventButton* e, int r)
+void
+PortMatrix::remove_channel_proxy (boost::weak_ptr<ARDOUR::Bundle> b, uint32_t c)
 {
-       if (e->type != GDK_BUTTON_PRESS || e->button != 3) {
-               return false;
+       boost::shared_ptr<ARDOUR::Bundle> sb = b.lock ();
+       if (!sb) {
+               return;
        }
 
-       Menu* menu = manage (new Menu);
-       Menu_Helpers::MenuList& items = menu->items ();
-       menu->set_name ("ArdourContextMenu");
+       remove_channel (ARDOUR::BundleChannel (sb, c));
 
-       bool const can_add = maximum_rows () > n_rows ();
-       bool const can_remove = minimum_rows () < n_rows ();
-       std::string const name = row_name (r);
-       
-       items.push_back (
-               Menu_Helpers::MenuElem (string_compose(_("Add %1"), row_descriptor()), sigc::mem_fun (*this, &PortMatrix::add_row))
-               );
+}
 
-       items.back().set_sensitive (can_add);
+void
+PortMatrix::rename_channel_proxy (boost::weak_ptr<ARDOUR::Bundle> b, uint32_t c)
+{
+       boost::shared_ptr<ARDOUR::Bundle> sb = b.lock ();
+       if (!sb) {
+               return;
+       }
 
-       items.push_back (
-               Menu_Helpers::MenuElem (string_compose(_("Remove %1 \"%2\""), row_descriptor(), name), sigc::bind (sigc::mem_fun (*this, &PortMatrix::remove_row), r))
-               );
+       rename_channel (ARDOUR::BundleChannel (sb, c));
+}
+
+void
+PortMatrix::disassociate_all_on_channel (boost::weak_ptr<ARDOUR::Bundle> bundle, uint32_t channel, int dim)
+{
+       boost::shared_ptr<ARDOUR::Bundle> sb = bundle.lock ();
+       if (!sb) {
+               return;
+       }
+
+       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) {
+
+                       ARDOUR::BundleChannel c[2];
+                       c[dim] = ARDOUR::BundleChannel (sb, channel);
+                       c[1-dim] = ARDOUR::BundleChannel (i->bundle, j);
+
+                       if (get_state (c) == PortMatrixNode::ASSOCIATED) {
+                               set_state (c, false);
+                       }
+               }
+       }
+
+       _body->rebuild_and_draw_grid ();
+}
+
+void
+PortMatrix::setup_global_ports ()
+{
+       for (int i = 0; i < 2; ++i) {
+               if (list_is_global (i)) {
+                       setup_ports (i);
+               }
+       }
+}
 
-       items.back().set_sensitive (can_remove);
+void
+PortMatrix::setup_all_ports ()
+{
+       setup_ports (0);
+       setup_ports (1);
+}
 
-       menu->popup (e->button, e->time);
+void
+PortMatrix::toggle_show_only_bundles ()
+{
+       if (_inhibit_toggle_show_only_bundles) {
+               return;
+       }
        
-       return true;
+       _show_only_bundles = !_show_only_bundles;
+       _body->setup ();
+       setup_scrollbars ();
+       queue_draw ();
 }
 
 void
-PortMatrix::set_type (ARDOUR::DataType t)
+PortMatrix::hide_group (boost::weak_ptr<PortGroup> w)
 {
-       _type = t;
-       _port_group_list.set_type (t);
-       setup ();
+       boost::shared_ptr<PortGroup> g = w.lock ();
+       if (!g) {
+               return;
+       }
+
+       g->set_visible (false);
 }
 
 void
-PortMatrix::set_offer_inputs (bool i)
+PortMatrix::show_group (boost::weak_ptr<PortGroup> w)
 {
-       _offer_inputs = i;
-       _port_group_list.set_offer_inputs (i);
-       setup ();
+       boost::shared_ptr<PortGroup> g = w.lock ();
+       if (!g) {
+               return;
+       }
+
+       g->set_visible (true);
 }
 
+pair<uint32_t, uint32_t>
+PortMatrix::max_size () const
+{
+       pair<uint32_t, uint32_t> m = _body->max_size ();
+
+       m.first += _vscroll.get_width ();
+       m.second += _hscroll.get_height ();
+
+       return m;
+}
+
+void
+PortMatrix::on_realize ()
+{
+       Widget::on_realize ();
+       _realized = true;
+}
+
+void
+PortMatrix::on_unrealize ()
+{
+       Widget::on_unrealize ();
+       _realized = false;
+}