libs/ardour/ardour/data_type.h

   1 /*
   2     Copyright (C) 2006 Paul Davis
   3     Author: David Robillard
   4
   5     This program is free software; you can redistribute it and/or modify it
   6     under the terms of the GNU General Public License as published by the Free
   7     Software Foundation; either version 2 of the License, or (at your option)
   8     any later version.
   9
  10     This program is distributed in the hope that it will be useful, but WITHOUT
  11     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13     for more details.
  14
  15     You should have received a copy of the GNU General Public License along
  16     with this program; if not, write to the Free Software Foundation, Inc.,
  17     675 Mass Ave, Cambridge, MA 02139, USA.
  18 */
  19
  20 #ifndef __ardour_data_type_h__
  21 #define __ardour_data_type_h__
  22
  23 #include <string>
  24 #include <stdint.h>
  25 #include <glib.h>
  26
  27 #include "ardour/libardour_visibility.h"
  28
  29 namespace ARDOUR {
  30
  31 /** A type of Data Ardour is capable of processing.
  32  *
  33  * The majority of this class is dedicated to conversion to and from various
  34  * other type representations, simple comparison between then, etc.  This code
  35  * is deliberately 'ugly' so other code doesn't have to be.
  36  */
  37 class LIBARDOUR_API DataType
  38 {
  39 public:
  40         /** Numeric symbol for this DataType.
  41          *
  42          * Castable to int for use as an array index (e.g. by ChanCount).
  43          * Note this means NIL is (ntypes-1) and guaranteed to change when
  44          * types are added, so this number is NOT suitable for serialization,
  45          * network, or binary anything.
  46          *
  47          * Some heuristics in Ardour's UI assume that the DataTypes are ordered
  48          * from most to least likely to be the main intended type of a route.
  49          *
  50          * WARNING: The number of non-NIL entries here must match num_types.
  51          */
  52         enum Symbol {
  53                 AUDIO = 0,
  54                 MIDI = 1,
  55                 NIL = 2,
  56         };
  57
  58         /** Number of types (not including NIL).
  59          * WARNING: make sure this matches Symbol!
  60          */
  61         static const uint32_t num_types = 2;
  62
  63         DataType(const Symbol& symbol)
  64         : _symbol(symbol)
  65         {}
  66
  67         static DataType front() { return DataType((Symbol) 0); }
  68
  69         /** Construct from a string (Used for loading from XML and Ports)
  70          * The string can be as in an XML file (eg "audio" or "midi"), or a
  71          */
  72         DataType(const std::string& str)
  73         : _symbol(NIL) {
  74                 if (!g_ascii_strncasecmp(str.c_str(), "audio", str.length())) {
  75                         _symbol = AUDIO;
  76                 } else if (!g_ascii_strncasecmp(str.c_str(), "midi", str.length())) {
  77                         _symbol = MIDI;
  78                 }
  79         }
  80
  81         /** Inverse of the from-string constructor */
  82         const char* to_string() const {
  83                 switch (_symbol) {
  84                 case AUDIO: return "audio";
  85                 case MIDI:  return "midi";
  86                 default:    return "unknown"; // reeeally shouldn't ever happen
  87                 }
  88         }
  89
  90         const char* to_i18n_string () const;
  91
  92         inline operator uint32_t() const { return (uint32_t)_symbol; }
  93
  94         /** DataType iterator, for writing generic loops that iterate over all
  95          * available types.
  96          */
  97         class iterator {
  98         public:
  99
 100                 iterator(uint32_t index) : _index(index) {}
 101
 102                 DataType  operator*()  { return DataType((Symbol)_index); }
 103                 iterator& operator++() { ++_index; return *this; } // yes, prefix only
 104                 bool operator==(const iterator& other) { return (_index == other._index); }
 105                 bool operator!=(const iterator& other) { return (_index != other._index); }
 106
 107         private:
 108                 friend class DataType;
 109
 110                 uint32_t _index;
 111         };
 112
 113         static iterator begin() { return iterator(0); }
 114         static iterator end()   { return iterator(num_types); }
 115
 116         bool operator==(const Symbol symbol) { return (_symbol == symbol); }
 117         bool operator!=(const Symbol symbol) { return (_symbol != symbol); }
 118
 119         bool operator==(const DataType other) { return (_symbol == other._symbol); }
 120         bool operator!=(const DataType other) { return (_symbol != other._symbol); }
 121
 122 private:
 123         Symbol _symbol; // could be const if not for the string constructor
 124 };
 125
 126
 127 } // namespace ARDOUR
 128
 129 #endif // __ardour_data_type_h__
 130