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         ID (uint64_t);
  39
  40         void reset ();
  41
  42         bool operator== (const ID& other) const {
  43                 return _id == other._id;
  44         }
  45
  46         bool operator!= (const ID& other) const {
  47                 return _id != other._id;
  48         }
  49
  50         bool operator== (const std::string&) const;
  51         bool operator== (uint64_t n) const {
  52                 return _id == n;
  53         }
  54
  55         ID& operator= (std::string);
  56         ID& operator= (const ID&);
  57
  58         bool operator< (const ID& other) const {
  59                 return _id < other._id;
  60         }
  61
  62         std::string to_s () const;
  63
  64         static uint64_t counter() { return _counter; }
  65         static void init_counter (uint64_t val) { _counter = val; }
  66         static void init ();
  67
  68   private:
  69         uint64_t _id;
  70         bool string_assign (std::string);
  71
  72         static Glib::Threads::Mutex* counter_lock;
  73         static uint64_t _counter;
  74 };
  75
  76 }
  77
  78 LIBPBD_API std::ostream& operator<< (std::ostream& ostr, const PBD::ID&);
  79
  80 #endif /* __pbd_id_h__ */