2 Copyright (C) 2006 Paul Davis
4 This program is free software; you can redistribute it and/or modify it
5 under the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2 of the License, or (at your option)
9 This program is distributed in the hope that it will be useful, but WITHOUT
10 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License along
15 with this program; if not, write to the Free Software Foundation, Inc.,
16 675 Mass Ave, Cambridge, MA 02139, USA.
19 #ifndef __ardour_port_set_h__
20 #define __ardour_port_set_h__
23 #include "ardour/chan_count.h"
24 #include <boost/utility.hpp>
32 /** An ordered list of Ports, possibly of various types.
34 * This allows access to all the ports as a list, ignoring type, or accessing
35 * the nth port of a given type. Note that port(n) and nth_audio_port(n) may
36 * NOT return the same port.
38 class PortSet : public boost::noncopyable {
42 size_t num_ports() const;
43 size_t num_ports(DataType type) const { return _ports[type].size(); }
46 bool remove(Port* port);
49 Port* port(size_t index) const;
51 /** nth port of type @a t, or nth port if t = NIL */
52 Port* port(DataType t, size_t index) const;
54 AudioPort* nth_audio_port(size_t n) const;
56 MidiPort* nth_midi_port(size_t n) const;
58 bool contains(const Port* port) const;
60 /** Remove all ports from the PortSet. Ports are not deregistered with
61 * the engine, it's the caller's responsibility to not leak here!
63 void clear() { _ports.clear(); }
65 const ChanCount& count() const { return _count; }
67 bool empty() const { return (_count.n_total() == 0); }
70 // FIXME: possible to combine these? templates?
74 Port& operator*() { return *_set.port(_type, _index); }
75 Port* operator->() { return _set.port(_type, _index); }
76 iterator& operator++() { ++_index; return *this; } // yes, prefix only
77 bool operator==(const iterator& other) { return (_index == other._index); }
78 bool operator!=(const iterator& other) { return (_index != other._index); }
83 iterator(PortSet& list, DataType type, size_t index)
84 : _set(list), _type(type), _index(index) {}
87 DataType _type; ///< Ignored if NIL (to iterator over entire set)
91 iterator begin(DataType type = DataType::NIL) {
92 return iterator(*this, type, 0);
95 iterator end(DataType type = DataType::NIL) {
96 return iterator(*this, type,
97 (type == DataType::NIL) ? _count.n_total() : _count.get(type));
101 class const_iterator {
103 const Port& operator*() { return *_set.port(_index); }
104 const Port* operator->() { return _set.port(_index); }
105 const_iterator& operator++() { ++_index; return *this; } // yes, prefix only
106 bool operator==(const const_iterator& other) { return (_index == other._index); }
107 bool operator!=(const const_iterator& other) { return (_index != other._index); }
110 friend class PortSet;
112 const_iterator(const PortSet& list, size_t index) : _set(list), _index(index) {}
118 const_iterator begin() const { return const_iterator(*this, 0); }
119 const_iterator end() const { return const_iterator(*this, _count.n_total()); }
122 class audio_iterator {
124 AudioPort& operator*() { return *_set.nth_audio_port(_index); }
125 AudioPort* operator->() { return _set.nth_audio_port(_index); }
126 audio_iterator& operator++() { ++_index; return *this; } // yes, prefix only
127 bool operator==(const audio_iterator& other) { return (_index == other._index); }
128 bool operator!=(const audio_iterator& other) { return (_index != other._index); }
131 friend class PortSet;
133 audio_iterator(PortSet& list, size_t index) : _set(list), _index(index) {}
139 audio_iterator audio_begin() { return audio_iterator(*this, 0); }
140 audio_iterator audio_end() { return audio_iterator(*this, _count.n_audio()); }
143 typedef std::vector<Port*> PortVec;
145 // Vector of vectors, indexed by DataType::to_index()
146 std::vector<PortVec> _ports;
152 } // namespace ARDOUR
154 #endif // __ardour_port_set_h__