mirror of
				https://github.com/Icinga/icinga2.git
				synced 2025-11-04 05:34:12 +01:00 
			
		
		
		
	
		
			
				
	
	
		
			151 lines
		
	
	
		
			4.0 KiB
		
	
	
	
		
			C++
		
	
	
	
	
	
			
		
		
	
	
			151 lines
		
	
	
		
			4.0 KiB
		
	
	
	
		
			C++
		
	
	
	
	
	
/******************************************************************************
 | 
						|
 * Icinga 2                                                                   *
 | 
						|
 * Copyright (C) 2012 Icinga Development Team (http://www.icinga.org/)        *
 | 
						|
 *                                                                            *
 | 
						|
 * This program is free software; you can redistribute it and/or              *
 | 
						|
 * modify it under the terms of the GNU General Public License                *
 | 
						|
 * as published by the Free Software Foundation; either version 2             *
 | 
						|
 * of the License, or (at your option) any later version.                     *
 | 
						|
 *                                                                            *
 | 
						|
 * This program is distributed in the hope that it will be useful,            *
 | 
						|
 * but WITHOUT ANY WARRANTY; without even the implied warranty of             *
 | 
						|
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              *
 | 
						|
 * GNU General Public License for more details.                               *
 | 
						|
 *                                                                            *
 | 
						|
 * You should have received a copy of the GNU General Public License          *
 | 
						|
 * along with this program; if not, write to the Free Software Foundation     *
 | 
						|
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.             *
 | 
						|
 ******************************************************************************/
 | 
						|
 | 
						|
#ifndef OBJECT_H
 | 
						|
#define OBJECT_H
 | 
						|
 | 
						|
namespace icinga
 | 
						|
{
 | 
						|
 | 
						|
class SharedPtrHolder;
 | 
						|
 | 
						|
/**
 | 
						|
 * Base class for all heap-allocated objects. At least one of its methods
 | 
						|
 * has to be virtual for RTTI to work.
 | 
						|
 *
 | 
						|
 * @ingroup base
 | 
						|
 */
 | 
						|
class I2_BASE_API Object : public enable_shared_from_this<Object>, public boost::signals::trackable
 | 
						|
{
 | 
						|
public:
 | 
						|
	typedef shared_ptr<Object> Ptr;
 | 
						|
	typedef weak_ptr<Object> WeakPtr;
 | 
						|
 | 
						|
	void Hold(void);
 | 
						|
	static void ClearHeldObjects(void);
 | 
						|
 | 
						|
	/**
 | 
						|
	 * Holds a shared pointer and provides support for implicit upcasts.
 | 
						|
	 *
 | 
						|
	 * @ingroup base
 | 
						|
	 */
 | 
						|
	class SharedPtrHolder
 | 
						|
	{
 | 
						|
	public:
 | 
						|
		/**
 | 
						|
		 * Constructor for the SharedPtrHolder class.
 | 
						|
		 *
 | 
						|
		 * @param object The shared pointer that should be used to
 | 
						|
		 *		 construct this shared pointer holder.
 | 
						|
		 */
 | 
						|
		explicit SharedPtrHolder(const Object::Ptr& object)
 | 
						|
			: m_Object(object)
 | 
						|
		{ }
 | 
						|
 | 
						|
		/**
 | 
						|
		 * Retrieves a shared pointer for the object that is associated
 | 
						|
		 * this holder instance.
 | 
						|
		 *
 | 
						|
		 * @returns A shared pointer.
 | 
						|
		 */
 | 
						|
		template<typename T>
 | 
						|
		operator shared_ptr<T>(void) const
 | 
						|
		{
 | 
						|
#ifdef _DEBUG
 | 
						|
			shared_ptr<T> other = dynamic_pointer_cast<T>(m_Object);
 | 
						|
			assert(other);
 | 
						|
#else /* _DEBUG */
 | 
						|
			shared_ptr<T> other = static_pointer_cast<T>(m_Object);
 | 
						|
#endif /* _DEBUG */
 | 
						|
 | 
						|
			return other;
 | 
						|
		}
 | 
						|
 | 
						|
		/**
 | 
						|
		 * Retrieves a weak pointer for the object that is associated
 | 
						|
		 * with this holder instance.
 | 
						|
		 *
 | 
						|
		 * @returns A weak pointer.
 | 
						|
		 */
 | 
						|
		template<typename T>
 | 
						|
		operator weak_ptr<T>(void) const
 | 
						|
		{
 | 
						|
			return static_cast<shared_ptr<T> >(*this);
 | 
						|
		}
 | 
						|
 | 
						|
	private:
 | 
						|
		Object::Ptr m_Object; /**< The object that belongs to this
 | 
						|
					   holder instance */
 | 
						|
	};
 | 
						|
 | 
						|
	SharedPtrHolder GetSelf(void);
 | 
						|
 | 
						|
#ifdef _DEBUG
 | 
						|
	static int GetAliveObjectsCount(void);
 | 
						|
	static void PrintMemoryProfile(void);
 | 
						|
#endif /* _DEBUG */
 | 
						|
 | 
						|
protected:
 | 
						|
	Object(void);
 | 
						|
	virtual ~Object(void);
 | 
						|
 | 
						|
private:
 | 
						|
	Object(const Object& other);
 | 
						|
	Object& operator=(const Object& rhs);
 | 
						|
 | 
						|
	static boost::mutex& GetMutex(void);
 | 
						|
	static set<Object *>& GetAliveObjects(void);
 | 
						|
	static vector<Object::Ptr>& GetHeldObjects(void);
 | 
						|
};
 | 
						|
 | 
						|
/**
 | 
						|
 * Compares a weak pointer with a raw pointer.
 | 
						|
 *
 | 
						|
 * @ingroup base
 | 
						|
 */
 | 
						|
template<class T>
 | 
						|
struct WeakPtrEqual
 | 
						|
{
 | 
						|
private:
 | 
						|
	const void *m_Ref; /**< The object. */
 | 
						|
 | 
						|
public:
 | 
						|
	/**
 | 
						|
	 * Constructor for the WeakPtrEqual class.
 | 
						|
	 *
 | 
						|
	 * @param ref The object that should be compared with the weak pointer.
 | 
						|
	 */
 | 
						|
	WeakPtrEqual(const void *ref) : m_Ref(ref) { }
 | 
						|
 | 
						|
	/**
 | 
						|
	 * Compares the two pointers.
 | 
						|
	 *
 | 
						|
	 * @param wref The weak pointer.
 | 
						|
	 * @returns true if the pointers point to the same object, false otherwise.
 | 
						|
	 */
 | 
						|
	bool operator()(const weak_ptr<T>& wref) const
 | 
						|
	{
 | 
						|
		return (wref.lock().get() == static_cast<const T *>(m_Ref));
 | 
						|
	}
 | 
						|
};
 | 
						|
 | 
						|
}
 | 
						|
 | 
						|
#endif /* OBJECT_H */
 |