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/port.h>
24 #include <ardour/audio_port.h>
25 #include <ardour/midi_port.h>
26 #include <ardour/chan_count.h>
31 /** An ordered list of Ports, possibly of various types.
33 * This allows access to all the ports as a list, ignoring type, or accessing
34 * the nth port of a given type. Note that port(n) and nth_audio_port(n) may
35 * NOT return the same port.
41 size_t num_ports() const;
42 size_t num_ports(DataType type) const { return _ports[type.to_index()].size(); }
45 bool remove(Port* port);
48 Port* port(size_t index) const;
50 /** nth port of type @a t, or nth port if t = NIL */
51 Port* port(DataType t, size_t index) const;
53 AudioPort* nth_audio_port(size_t n) const;
55 MidiPort* nth_midi_port(size_t n) const;
57 bool contains(const Port* port) const;
59 /** Remove all ports from the PortSet. Ports are not deregistered with
60 * the engine, it's the caller's responsibility to not leak here!
62 void clear() { _ports.clear(); }
64 const ChanCount& count() const { return _count; }
66 bool empty() const { return (_count.get_total() == 0); }
70 // FIXME: this is a filthy copy-and-paste mess
75 Port& operator*() { return *_set.port(_type, _index); }
76 Port* operator->() { return _set.port(_type, _index); }
77 iterator& operator++() { ++_index; return *this; } // yes, prefix only
78 bool operator==(const iterator& other) { return (_index == other._index); }
79 bool operator!=(const iterator& other) { return (_index != other._index); }
84 iterator(PortSet& list, DataType type, size_t index)
85 : _set(list), _type(type), _index(index) {}
88 DataType _type; ///< Ignored if NIL (to iterator over entire set)
92 iterator begin(DataType type = DataType::NIL)
93 { return iterator(*this, type, 0); }
95 iterator end(DataType type = DataType::NIL)
97 return iterator(*this, type,
98 (type == DataType::NIL) ? _count.get_total() : _count.get(type));
102 class const_iterator {
105 const Port& operator*() { return *_set.port(_index); }
106 const Port* operator->() { return _set.port(_index); }
107 const_iterator& operator++() { ++_index; return *this; } // yes, prefix only
108 bool operator==(const const_iterator& other) { return (_index == other._index); }
109 bool operator!=(const const_iterator& other) { return (_index != other._index); }
112 friend class PortSet;
114 const_iterator(const PortSet& list, size_t index) : _set(list), _index(index) {}
120 const_iterator begin() const { return const_iterator(*this, 0); }
121 const_iterator end() const { return const_iterator(*this, _count.get_total()); }
124 class audio_iterator {
127 AudioPort& operator*() { return *_set.nth_audio_port(_index); }
128 AudioPort* operator->() { return _set.nth_audio_port(_index); }
129 audio_iterator& operator++() { ++_index; return *this; } // yes, prefix only
130 bool operator==(const audio_iterator& other) { return (_index == other._index); }
131 bool operator!=(const audio_iterator& other) { return (_index != other._index); }
134 friend class PortSet;
136 audio_iterator(PortSet& list, size_t index) : _set(list), _index(index) {}
142 audio_iterator audio_begin() { return audio_iterator(*this, 0); }
143 audio_iterator audio_end() { return audio_iterator(*this, _count.n_audio()); }
146 // Prevent copies (undefined)
147 PortSet(const PortSet& copy);
148 void operator=(const PortSet& other);
150 typedef std::vector<Port*> PortVec;
152 // Vector of vectors, indexed by DataType::to_index()
153 std::vector<PortVec> _ports;
159 } // namespace ARDOUR
161 #endif // __ardour_port_set_h__