src/misc/autoptr.hpp
author richk
Sun, 22 Jul 2007 21:24:42 +0000
branchNewGRF_ports
changeset 6732 ca1b466db422
parent 6719 4cc327ad39d5
permissions -rw-r--r--
(svn r10653) [NewGRF_ports] -Sync: with trunk r10602-10651
6573
7624f942237f (svn r9050) -Codechange: Foo(void) -> Foo()
rubidium
parents: 6095
diff changeset
     1
/* $Id$ */
6095
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
     2
6719
4cc327ad39d5 (svn r10027) [NewGRF_ports] -Sync: with trunk r9506-10026
richk
parents: 6573
diff changeset
     3
/** @file autoptr.hpp */
4cc327ad39d5 (svn r10027) [NewGRF_ports] -Sync: with trunk r9506-10026
richk
parents: 6573
diff changeset
     4
6095
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
     5
#ifndef AUTOPTR_HPP
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
     6
#define AUTOPTR_HPP
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
     7
55d5c0e6be3a (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
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
     9
 *  deleted when its pointer goes out of scope.
55d5c0e6be3a (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).
55d5c0e6be3a (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
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    12
 *  and original becomes NULL!
55d5c0e6be3a (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).
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    14
 */
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    15
template <class T>
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    16
class AutoPtrT {
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    17
public:
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    18
	typedef T obj_t;
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    19
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    20
protected:
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    21
	mutable T* m_p; ///< points to the data
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    22
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    23
public:
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    24
	FORCEINLINE AutoPtrT()
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    25
	 : m_p(NULL)
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    26
	{};
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    27
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    28
	FORCEINLINE AutoPtrT(const AutoPtrT<T>& src)
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    29
	 : m_p(src.m_p)
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    30
	{
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    31
		if (m_p != NULL) src.m_p = NULL;
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    32
	};
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    33
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    34
	FORCEINLINE AutoPtrT(T *p)
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    35
	 : m_p(p)
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    36
	{}
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    37
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    38
	FORCEINLINE ~AutoPtrT()
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    39
	{
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    40
		if (m_p != NULL) {
6732
ca1b466db422 (svn r10653) [NewGRF_ports] -Sync: with trunk r10602-10651
richk
parents: 6719
diff changeset
    41
			T *p = m_p;
6095
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    42
			m_p = NULL;
6732
ca1b466db422 (svn r10653) [NewGRF_ports] -Sync: with trunk r10602-10651
richk
parents: 6719
diff changeset
    43
			delete p;
6095
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    44
		}
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    45
	}
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    46
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    47
	/** give-up ownership and NULLify the raw pointer */
6732
ca1b466db422 (svn r10653) [NewGRF_ports] -Sync: with trunk r10602-10651
richk
parents: 6719
diff changeset
    48
	FORCEINLINE T* Detach()
6095
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    49
	{
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    50
		T* p = m_p;
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    51
		m_p = NULL;
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    52
		return p;
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    53
	}
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    54
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    55
	/** raw-pointer cast operator (read only) */
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    56
	FORCEINLINE operator const T* () const
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    57
	{
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    58
		return m_p;
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    59
	}
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    60
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    61
	/** raw-pointer cast operator */
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    62
	FORCEINLINE operator T* ()
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    63
	{
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    64
		return m_p;
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    65
	}
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    66
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    67
	/** dereference operator (read only) */
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    68
	FORCEINLINE const T* operator -> () const
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    69
	{
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    70
		assert(m_p != NULL);
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    71
		return m_p;
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    72
	}
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    73
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    74
	/** dereference operator (read / write) */
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    75
	FORCEINLINE T* operator -> ()
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    76
	{
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    77
		assert(m_p != NULL);
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    78
		return m_p;
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    79
	}
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    80
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    81
	/** assignment operator */
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    82
	FORCEINLINE AutoPtrT& operator = (const AutoPtrT& src)
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    83
	{
6732
ca1b466db422 (svn r10653) [NewGRF_ports] -Sync: with trunk r10602-10651
richk
parents: 6719
diff changeset
    84
		/* Save original pointer and replace it with the given one to avoid recursive calls. */
ca1b466db422 (svn r10653) [NewGRF_ports] -Sync: with trunk r10602-10651
richk
parents: 6719
diff changeset
    85
		T* p = m_p;
6095
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    86
		m_p = src.m_p;
6732
ca1b466db422 (svn r10653) [NewGRF_ports] -Sync: with trunk r10602-10651
richk
parents: 6719
diff changeset
    87
6095
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    88
		if (m_p != NULL) src.m_p = NULL;
6732
ca1b466db422 (svn r10653) [NewGRF_ports] -Sync: with trunk r10602-10651
richk
parents: 6719
diff changeset
    89
ca1b466db422 (svn r10653) [NewGRF_ports] -Sync: with trunk r10602-10651
richk
parents: 6719
diff changeset
    90
		if (p != NULL) {
ca1b466db422 (svn r10653) [NewGRF_ports] -Sync: with trunk r10602-10651
richk
parents: 6719
diff changeset
    91
			/* Now we can safely delete the old one. */
ca1b466db422 (svn r10653) [NewGRF_ports] -Sync: with trunk r10602-10651
richk
parents: 6719
diff changeset
    92
			delete p;
ca1b466db422 (svn r10653) [NewGRF_ports] -Sync: with trunk r10602-10651
richk
parents: 6719
diff changeset
    93
		}
6095
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    94
		return *this;
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    95
	}
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    96
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    97
	/** forwarding 'lower than' operator to the underlaying items */
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    98
	FORCEINLINE bool operator < (const AutoPtrT& other) const
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
    99
	{
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
   100
		assert(m_p != NULL);
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
   101
		assert(other.m_p != NULL);
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
   102
		return (*m_p) < (*other.m_p);
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
   103
	}
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
   104
};
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
   105
55d5c0e6be3a (svn r8414) -Codechange: Use own AutoPtrT instead of std::auto_ptr.
KUDr
parents:
diff changeset
   106
#endif /* AUTOPTR_HPP */