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          * WARNING: The number of non-NIL entries here must match num_types.
  48          */
  49         enum Symbol {
  50                 AUDIO = 0,
  51                 MIDI = 1,
  52                 NIL = 2,
  53         };
  54
  55         /** Number of types (not including NIL).
  56          * WARNING: make sure this matches Symbol!
  57          */
  58         static const uint32_t num_types = 2;
  59
  60         DataType(const Symbol& symbol)
  61         : _symbol(symbol)
  62         {}
  63
  64         /** Construct from a string (Used for loading from XML and Ports)
  65          * The string can be as in an XML file (eg "audio" or "midi"), or a
  66          */
  67         DataType(const std::string& str)
  68         : _symbol(NIL) {
  69                 if (!g_ascii_strncasecmp(str.c_str(), "audio", str.length())) {
  70                         _symbol = AUDIO;
  71                 } else if (!g_ascii_strncasecmp(str.c_str(), "midi", str.length())) {
  72                         _symbol = MIDI;
  73                 }
  74         }
  75
  76         /** Inverse of the from-string constructor */
  77         const char* to_string() const {
  78                 switch (_symbol) {
  79                 case AUDIO: return "audio";
  80                 case MIDI:  return "midi";
  81                 default:    return "unknown"; // reeeally shouldn't ever happen
  82                 }
  83         }
  84
  85         const char* to_i18n_string () const;
  86
  87         inline operator uint32_t() const { return (uint32_t)_symbol; }
  88
  89         /** DataType iterator, for writing generic loops that iterate over all
  90          * available types.
  91          */
  92         class iterator {
  93         public:
  94
  95                 iterator(uint32_t index) : _index(index) {}
  96
  97                 DataType  operator*()  { return DataType((Symbol)_index); }
  98                 iterator& operator++() { ++_index; return *this; } // yes, prefix only
  99                 bool operator==(const iterator& other) { return (_index == other._index); }
 100                 bool operator!=(const iterator& other) { return (_index != other._index); }
 101
 102         private:
 103                 friend class DataType;
 104
 105                 uint32_t _index;
 106         };
 107
 108         static iterator begin() { return iterator(0); }
 109         static iterator end()   { return iterator(num_types); }
 110
 111         bool operator==(const Symbol symbol) { return (_symbol == symbol); }
 112         bool operator!=(const Symbol symbol) { return (_symbol != symbol); }
 113
 114         bool operator==(const DataType other) { return (_symbol == other._symbol); }
 115         bool operator!=(const DataType other) { return (_symbol != other._symbol); }
 116
 117 private:
 118         Symbol _symbol; // could be const if not for the string constructor
 119 };
 120
 121
 122 } // namespace ARDOUR
 123
 124 #endif // __ardour_data_type_h__
 125