libs/pbd/pbd/id.h

   1 /*
   2     Copyright (C) 2000-2007 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __pbd_id_h__
  21 #define __pbd_id_h__
  22
  23 #include <stdint.h>
  24 #include <string>
  25
  26 #include <glibmm/threads.h>
  27
  28 #include "pbd/libpbd_visibility.h"
  29
  30 namespace PBD {
  31
  32 /** a unique ID to identify objects numerically */
  33 class LIBPBD_API ID {
  34   public:
  35         ID ();
  36         ID (std::string);
  37         ID (const ID&);
  38
  39         void reset ();
  40
  41         bool operator== (const ID& other) const {
  42                 return _id == other._id;
  43         }
  44
  45         bool operator!= (const ID& other) const {
  46                 return _id != other._id;
  47         }
  48
  49         bool operator== (const std::string&) const;
  50
  51         ID& operator= (std::string);
  52         ID& operator= (const ID&);
  53
  54         bool operator< (const ID& other) const {
  55                 return _id < other._id;
  56         }
  57
  58         void print (char* buf, uint32_t bufsize) const;
  59         std::string to_s() const;
  60
  61         static uint64_t counter() { return _counter; }
  62         static void init_counter (uint64_t val) { _counter = val; }
  63         static void init ();
  64
  65   private:
  66         uint64_t _id;
  67         int string_assign (std::string);
  68
  69         static Glib::Threads::Mutex* counter_lock;
  70         static uint64_t _counter;
  71 };
  72
  73 }
  74
  75 LIBPBD_API std::ostream& operator<< (std::ostream& ostr, const PBD::ID&);
  76
  77 #endif /* __pbd_id_h__ */