summaryrefslogtreecommitdiff
path: root/gtk2_ardour/port_group.h
blob: d6008b61ba4f8980c6d74bc5dd5cbd8bca908e4e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/*
    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_group_h__ 
#define  __gtk_ardour_port_group_h__ 

#include <vector>
#include <string>
#include <gtkmm/widget.h>
#include <gtkmm/checkbutton.h>
#include <boost/shared_ptr.hpp>
#include <ardour/data_type.h>
#include <ardour/types.h>

namespace ARDOUR {
	class Session;
	class Bundle;
}

class PortMatrix;

/** A list of bundles and ports, grouped by some aspect of their
 *  type e.g. busses, tracks, system.  Each group has 0 or more bundles
 *  and 0 or more ports, where the ports are not in the bundles.
 */
class PortGroup : public sigc::trackable
{
public:
	/** PortGroup constructor.
	 * @param n Name.
	 * @param v true if group should be visible in the UI, otherwise false.
	 */
	PortGroup (std::string const & n, bool v)
		: name (n), _visible (v) {}

	void add_bundle (boost::shared_ptr<ARDOUR::Bundle>);
	boost::shared_ptr<ARDOUR::Bundle> only_bundle ();
	void add_port (std::string const &);
	void clear ();

	std::string name; ///< name for the group
	std::vector<std::string> ports;

	ARDOUR::BundleList const & bundles () const {
		return _bundles;
	}
	
	bool visible () const {
		return _visible;
	}

	void set_visible (bool v) {
		_visible = v;
		VisibilityChanged ();
	}

	bool has_port (std::string const &) const;

	sigc::signal<void> VisibilityChanged;

private:	
	ARDOUR::BundleList _bundles;
	bool _visible; ///< true if the group is visible in the UI
};

/// The UI for a PortGroup
class PortGroupUI
{
  public:
	PortGroupUI (PortMatrix*, PortGroup*);

	Gtk::Widget& visibility_checkbutton () {
		return _visibility_checkbutton;
	}

  private:
	void visibility_checkbutton_toggled ();
	void setup_visibility_checkbutton ();

	PortMatrix* _port_matrix; ///< the PortMatrix that we are working for
	PortGroup* _port_group; ///< the PortGroup that we are representing
	Gtk::CheckButton _visibility_checkbutton;
};

/// A list of PortGroups
class PortGroupList : public std::list<PortGroup*>, public sigc::trackable
{
  public:
	PortGroupList (ARDOUR::DataType, bool);

	void gather (ARDOUR::Session &);
	void set_type (ARDOUR::DataType);
	void set_offer_inputs (bool);
	ARDOUR::BundleList const & bundles () const;
	void take_visibility_from (PortGroupList const &);
	void clear_list ();

	sigc::signal<void> VisibilityChanged;
	
  private:
	bool port_has_prefix (std::string const &, std::string const &) const;
	std::string common_prefix (std::vector<std::string> const &) const;
	void visibility_changed ();
	void update_bundles () const;
	
	ARDOUR::DataType _type;
	bool _offer_inputs;
	mutable ARDOUR::BundleList _bundles;
	mutable bool _bundles_dirty;

	PortGroup _buss;
	PortGroup _track;
	PortGroup _system;
	PortGroup _other;

	std::vector<sigc::connection> _visibility_connections;
};

#endif /* __gtk_ardour_port_group_h__ */