src/misc/autoptr.hpp
author rubidium
Wed, 11 Jul 2007 15:03:29 +0000
changeset 7229 a5f262f6df1b
parent 6481 85ad87daf4b0
child 7296 84069e62f29d
permissions -rw-r--r--
(svn r10508) -Codechange: allow customizable animation schemes for industries.
6247
7d81e3a5d803 (svn r9050) -Codechange: Foo(void) -> Foo()
rubidium
parents: 5844
diff changeset
     1
/* $Id$ */
5844
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
     2
6481
85ad87daf4b0 (svn r9662) -Documentation: Doxygen corrections and @file omissions
belugas
parents: 6247
diff changeset
     3
/** @file autoptr.hpp */
85ad87daf4b0 (svn r9662) -Documentation: Doxygen corrections and @file omissions
belugas
parents: 6247
diff changeset
     4
5844
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
     5
#ifndef AUTOPTR_HPP
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
     6
#define AUTOPTR_HPP
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
     7
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
     8
/** AutoPtrT - kind of smart pointer that ensures the owned object gets
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
     9
 *  deleted when its pointer goes out of scope.
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    10
 *  It is non-invasive smart pointer (no reference counter).
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    11
 *  When copied, the copy takes ownership of underlying object
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    12
 *  and original becomes NULL!
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    13
 *  Can be used also for polymorphic data types (interfaces).
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    14
 */
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    15
template <class T>
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    16
class AutoPtrT {
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    17
public:
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    18
	typedef T obj_t;
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    19
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    20
protected:
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    21
	mutable T* m_p; ///< points to the data
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    22
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    23
public:
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    24
	FORCEINLINE AutoPtrT()
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    25
	 : m_p(NULL)
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    26
	{};
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    27
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    28
	FORCEINLINE AutoPtrT(const AutoPtrT<T>& src)
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    29
	 : m_p(src.m_p)
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    30
	{
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    31
		if (m_p != NULL) src.m_p = NULL;
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    32
	};
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    33
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    34
	FORCEINLINE AutoPtrT(T *p)
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    35
	 : m_p(p)
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    36
	{}
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    37
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    38
	FORCEINLINE ~AutoPtrT()
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    39
	{
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    40
		if (m_p != NULL) {
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    41
			delete m_p;
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    42
			m_p = NULL;
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    43
		}
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    44
	}
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    45
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    46
	/** give-up ownership and NULLify the raw pointer */
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    47
	FORCEINLINE T* Release()
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    48
	{
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    49
		T* p = m_p;
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    50
		m_p = NULL;
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    51
		return p;
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    52
	}
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    53
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    54
	/** raw-pointer cast operator (read only) */
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    55
	FORCEINLINE operator const T* () const
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    56
	{
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    57
		return m_p;
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    58
	}
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    59
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    60
	/** raw-pointer cast operator */
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    61
	FORCEINLINE operator T* ()
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    62
	{
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    63
		return m_p;
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    64
	}
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    65
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    66
	/** dereference operator (read only) */
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    67
	FORCEINLINE const T* operator -> () const
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    68
	{
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    69
		assert(m_p != NULL);
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    70
		return m_p;
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    71
	}
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    72
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    73
	/** dereference operator (read / write) */
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    74
	FORCEINLINE T* operator -> ()
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    75
	{
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    76
		assert(m_p != NULL);
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    77
		return m_p;
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    78
	}
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    79
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    80
	/** assignment operator */
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    81
	FORCEINLINE AutoPtrT& operator = (const AutoPtrT& src)
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    82
	{
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    83
		m_p = src.m_p;
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    84
		if (m_p != NULL) src.m_p = NULL;
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    85
		return *this;
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    86
	}
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    87
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    88
	/** forwarding 'lower than' operator to the underlaying items */
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    89
	FORCEINLINE bool operator < (const AutoPtrT& other) const
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    90
	{
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    91
		assert(m_p != NULL);
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    92
		assert(other.m_p != NULL);
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    93
		return (*m_p) < (*other.m_p);
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    94
	}
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    95
};
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    96
60231b36473e (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    97
#endif /* AUTOPTR_HPP */