/*
    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
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef __gtk_ardour_port_matrix_h__
#define __gtk_ardour_port_matrix_h__

#include <list>
#include <gtkmm/box.h>
#include <gtkmm/scrollbar.h>
#include <gtkmm/table.h>
#include <gtkmm/label.h>
#include <gtkmm/checkbutton.h>
#include <boost/shared_ptr.hpp>
#include "ardour/bundle.h"
#include "port_group.h"

/** The `port matrix' UI.  This is a widget which lets the user alter
 *  associations between one set of ports and another.  e.g. to connect
 *  things together.
 *
 *  It is made up of a body, PortMatrixBody, which is rendered using cairo,
 *  and some scrollbars and other stuff.  All of this is arranged inside the
 *  VBox that we inherit from.
 */

namespace ARDOUR {
	class Bundle;
}

class PortMatrixBody;

class PortMatrix : public Gtk::VBox
{
public:
	PortMatrix (ARDOUR::Session&, ARDOUR::DataType);
	~PortMatrix ();

	void set_type (ARDOUR::DataType);

	ARDOUR::DataType type () const {
		return _type;
	}
	
	void disassociate_all ();
	void setup_scrollbars ();
	void popup_channel_context_menu (int, uint32_t, uint32_t);

	int min_height_divisor () const {
		return _min_height_divisor;
	}
	void set_min_height_divisor (int f) {
		_min_height_divisor = f;
	}

	enum Arrangement {
		TOP_TO_RIGHT,  ///< column labels on top, row labels to the right
		LEFT_TO_BOTTOM ///< row labels to the left, column labels on the bottom
	};

	/** @return Arrangement in use */
	Arrangement arrangement () const {
		return _arrangement;
	}

	PortGroupList const * columns () const;

	/** @return index into the _ports array for the list which is displayed as columns */
	int column_index () const {
		return _column_index;
	}

	PortGroupList const * rows () const;

	/** @return index into the _ports array for the list which is displayed as rows */
	int row_index () const {
		return _row_index;
	}

	PortGroupList const * ports (int d) const {
		return &_ports[d];
	}
	
	void setup ();
	virtual void setup_ports (int) = 0;
	void setup_all_ports ();

	/** @param c Channels; where c[0] is from _ports[0] and c[1] is from _ports[1].
	 *  @param s New state.
	 */
	virtual void set_state (ARDOUR::BundleChannel c[2], bool s) = 0;

	enum State {
		ASSOCIATED,     ///< the ports are associaed
		NOT_ASSOCIATED, ///< the ports are not associated
		UNKNOWN         ///< we don't know anything about these two ports' relationship
	};

	/** @param c Channels; where c[0] is from _ports[0] and c[1] is from _ports[1].
	 *  @return state
	 */
	virtual State get_state (ARDOUR::BundleChannel c[2]) const = 0;
	virtual bool list_is_global (int) const = 0;

	virtual void add_channel (boost::shared_ptr<ARDOUR::Bundle>) = 0;
	virtual bool can_remove_channels (int) const = 0;
	virtual void remove_channel (ARDOUR::BundleChannel) = 0;
	virtual bool can_rename_channels (int) const = 0;
	virtual void rename_channel (ARDOUR::BundleChannel) {}
	
	enum Result {
		Cancelled,
		Accepted
	};

	sigc::signal<void, Result> Finished;

protected:

	/** We have two port group lists.  One will be presented on the rows of the matrix,
	    the other on the columns.  The PortMatrix chooses the arrangement based on which has
	    more ports in it.  Subclasses must fill these two lists with the port groups that they
	    wish to present.  The PortMatrix will arrange its layout such that signal flow is vaguely
	    from left to right as you go from list 0 to list 1.  Hence subclasses which deal with
	    inputs and outputs should put outputs in list 0 and inputs in list 1. */
	PortGroupList _ports[2];
	ARDOUR::Session& _session;
	
private:

	void hscroll_changed ();
	void vscroll_changed ();
	void routes_changed ();
	void reconnect_to_routes ();
	void visibility_toggled (boost::weak_ptr<PortGroup>, Gtk::CheckButton *);
	void select_arrangement ();
	void remove_channel_proxy (boost::weak_ptr<ARDOUR::Bundle>, uint32_t);
	void rename_channel_proxy (boost::weak_ptr<ARDOUR::Bundle>, uint32_t);
	void disassociate_all_on_channel (boost::weak_ptr<ARDOUR::Bundle>, uint32_t, int);
	void setup_global_ports ();

	/// port type that we are working with
	ARDOUR::DataType _type;
	std::vector<sigc::connection> _route_connections;

	PortMatrixBody* _body;
	Gtk::HScrollbar _hscroll;
	Gtk::VScrollbar _vscroll;
	Gtk::HBox _main_hbox;
	Gtk::HBox _column_visibility_box;
	bool _column_visibility_box_added;
	Gtk::Label _column_visibility_label;
	std::vector<Gtk::CheckButton*> _column_visibility_buttons;
	Gtk::VBox _row_visibility_box;
	bool _row_visibility_box_added;
	Gtk::Label _row_visibility_label;
	std::vector<Gtk::CheckButton*> _row_visibility_buttons;
	Gtk::Table _scroller_table;
	Gtk::Menu* _menu;
	bool _setup_once;
	Arrangement _arrangement;
	int _row_index;
	int _column_index;
	int _min_height_divisor;
};

#endif