libs/ardour/ardour/port_set.h

   1 /*
   2     Copyright (C) 2006 Paul Davis
   3
   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)
   7     any later version.
   8
   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
  12     for more details.
  13
  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.
  17 */
  18
  19 #ifndef __ardour_port_set_h__
  20 #define __ardour_port_set_h__
  21
  22 #include <vector>
  23 #include <ardour/port.h>
  24 #include <ardour/audio_port.h>
  25 #include <ardour/midi_port.h>
  26 #include <ardour/chan_count.h>
  27
  28 namespace ARDOUR {
  29
  30
  31 /** An ordered list of Ports, possibly of various types.
  32  *
  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.
  36  */
  37 class PortSet {
  38 public:
  39         PortSet();
  40
  41         size_t num_ports() const;
  42         size_t num_ports(DataType type) const { return _ports[type.to_index()].size(); }
  43
  44         void add_port(Port* port);
  45
  46         /** nth port */
  47         Port* port(size_t index) const;
  48
  49         /** nth port of type @a t, or nth port if t = NIL */
  50         Port* port(DataType t, size_t index) const;
  51
  52         AudioPort* nth_audio_port(size_t n) const;
  53
  54         MidiPort* nth_midi_port(size_t n) const;
  55
  56         bool contains(const Port* port) const;
  57
  58         /** Remove all ports from the PortSet.  Ports are not deregistered with
  59          * the engine, it's the caller's responsibility to not leak here!
  60          */
  61         void clear() { _ports.clear(); }
  62
  63         const ChanCount& count() const { return _count; }
  64
  65         bool empty() const { return (_count.get_total() == 0); }
  66
  67         // ITERATORS
  68
  69         // FIXME: this is a filthy copy-and-paste mess
  70
  71         class iterator {
  72         public:
  73
  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); }
  79
  80         private:
  81                 friend class PortSet;
  82
  83                 iterator(PortSet& list, DataType type, size_t index)
  84                         : _set(list), _type(type), _index(index) {}
  85
  86                 PortSet& _set;
  87                 DataType _type; ///< Ignored if NIL (to iterator over entire set)
  88                 size_t   _index;
  89         };
  90
  91         iterator begin(DataType type = DataType::NIL)
  92                 { return iterator(*this, type, 0); }
  93
  94         iterator end(DataType type = DataType::NIL)
  95         {
  96                 return iterator(*this, type,
  97                         (type == DataType::NIL) ? _count.get_total() : _count.get(type));
  98         }
  99
 100         // FIXME: typeify
 101         class const_iterator {
 102         public:
 103
 104                 const Port& operator*()  { return *_set.port(_index); }
 105                 const Port* operator->() { return _set.port(_index); }
 106                 const_iterator& operator++() { ++_index; return *this; } // yes, prefix only
 107                 bool operator==(const const_iterator& other) { return (_index == other._index); }
 108                 bool operator!=(const const_iterator& other) { return (_index != other._index); }
 109
 110         private:
 111                 friend class PortSet;
 112
 113                 const_iterator(const PortSet& list, size_t index) : _set(list), _index(index) {}
 114
 115                 const PortSet& _set;
 116                 size_t          _index;
 117         };
 118
 119         const_iterator begin() const { return const_iterator(*this, 0); }
 120         const_iterator end()   const { return const_iterator(*this, _count.get_total()); }
 121
 122
 123         class audio_iterator {
 124         public:
 125
 126                 AudioPort& operator*()  { return *_set.nth_audio_port(_index); }
 127                 AudioPort* operator->()  { return _set.nth_audio_port(_index); }
 128                 audio_iterator& operator++() { ++_index; return *this; } // yes, prefix only
 129                 bool operator==(const audio_iterator& other) { return (_index == other._index); }
 130                 bool operator!=(const audio_iterator& other) { return (_index != other._index); }
 131
 132         private:
 133                 friend class PortSet;
 134
 135                 audio_iterator(PortSet& list, size_t index) : _set(list), _index(index) {}
 136
 137                 PortSet& _set;
 138                 size_t    _index;
 139         };
 140
 141         audio_iterator audio_begin() { return audio_iterator(*this, 0); }
 142         audio_iterator audio_end()   { return audio_iterator(*this, _count.get(DataType::AUDIO)); }
 143
 144
 145
 146
 147 private:
 148         // Prevent copies (undefined)
 149         PortSet(const PortSet& copy);
 150         void operator=(const PortSet& other);
 151
 152         typedef std::vector<Port*> PortVec;
 153
 154         // Vector of vectors, indexed by DataType::to_index()
 155         std::vector<PortVec> _ports;
 156
 157         ChanCount _count;
 158 };
 159
 160
 161 } // namespace ARDOUR
 162
 163 #endif // __ardour_port_set_h__