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>
  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 private:
  43         Object(const Object& other);
  44         Object operator=(const Object& rhs);
  45 };
  46
  47 /**
  48  * Compares a weak pointer with a raw pointer.
  49  */
  50 template<class T>
  51 struct WeakPtrEqual
  52 {
  53 private:
  54         const void *m_Ref;
  55
  56 public:
  57         WeakPtrEqual(const void *ref) : m_Ref(ref) { }
  58
  59         /**
  60          * Compares the two pointers.
  61          *
  62          * @param wref The weak pointer.
  63          * @returns true if the pointers point to the same object, false otherwise.
  64          */
  65         bool operator()(const weak_ptr<T>& wref) const
  66         {
  67                 return (wref.lock().get() == (const T *)m_Ref);
  68         }
  69 };
  70
  71 }
  72
  73 #endif /* OBJECT_H */