granicus.if.org Git - icinga2/blob - base/object.h

   1 /******************************************************************************
   2  * Icinga 2                                                                   *
   3  * Copyright (C) 2012 Icinga Development Team (http://www.icinga.org/)        *
   4  *                                                                            *
   5  * This program is free software; you can redistribute it and/or              *
   6  * modify it under the terms of the GNU General Public License                *
   7  * as published by the Free Software Foundation; either version 2             *
   8  * of the License, or (at your option) any later version.                     *
   9  *                                                                            *
  10  * This program is distributed in the hope that it will be useful,            *
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of             *
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              *
  13  * GNU General Public License for more details.                               *
  14  *                                                                            *
  15  * You should have received a copy of the GNU General Public License          *
  16  * along with this program; if not, write to the Free Software Foundation     *
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.             *
  18  ******************************************************************************/
  19
  20 #ifndef OBJECT_H
  21 #define OBJECT_H
  22
  23 namespace icinga
  24 {
  25
  26 /**
  27  * Base class for all heap-allocated objects. At least one of its methods
  28  * has to be virtual for RTTI to work.
  29  *
  30  * @ingroup base
  31  */
  32 class I2_BASE_API Object : public enable_shared_from_this<Object>, boost::signals::trackable
  33 {
  34 public:
  35         typedef shared_ptr<Object> Ptr;
  36         typedef weak_ptr<Object> WeakPtr;
  37
  38 protected:
  39         Object(void);
  40         virtual ~Object(void);
  41
  42         static void ClearHeldObjects(void);
  43
  44 protected:
  45         void Hold(void);
  46
  47 private:
  48         Object(const Object& other);
  49         Object operator=(const Object& rhs);
  50
  51         static vector<Object::Ptr> m_HeldObjects;
  52 };
  53
  54 /**
  55  * Compares a weak pointer with a raw pointer.
  56  */
  57 template<class T>
  58 struct WeakPtrEqual
  59 {
  60 private:
  61         const void *m_Ref;
  62
  63 public:
  64         WeakPtrEqual(const void *ref) : m_Ref(ref) { }
  65
  66         /**
  67          * Compares the two pointers.
  68          *
  69          * @param wref The weak pointer.
  70          * @returns true if the pointers point to the same object, false otherwise.
  71          */
  72         bool operator()(const weak_ptr<T>& wref) const
  73         {
  74                 return (wref.lock().get() == (const T *)m_Ref);
  75         }
  76 };
  77
  78 }
  79
  80 #endif /* OBJECT_H */