1

/* $Id$ */

     2

     3

#ifndef COUNTEDPTR_HPP

     4

#define COUNTEDPTR_HPP

     5

     6

#if 1 // reenable when needed

     7

/** @file CCountedPtr - smart pointer implementation */

     8

     9

/** CCountedPtr - simple reference counting smart pointer.

    10

 *

    11

 *     One of the standard ways how to maintain object's lifetime.

    12

 *

    13

 *     See http://ootips.org/yonat/4dev/smart-pointers.html for more

    14

 *   general info about smart pointers.

    15

 *

    16

 *     This class implements ref-counted pointer for objects/interfaces that

    17

 *   support AddRef() and Release() methods.

    18

 */

    19

template <class Tcls_>

    20

class CCountedPtr {

    21

	/** redefine the template argument to make it visible for derived classes */

    22

public:

    23

	typedef Tcls_ Tcls;

    24

    25

protected:

    26

	/** here we hold our pointer to the target */

    27

	Tcls* m_pT;

    28

    29

public:

    30

	/** default (NULL) construct or construct from a raw pointer */

    31

	FORCEINLINE CCountedPtr(Tcls* pObj = NULL) : m_pT(pObj) {AddRef();};

    32

    33

	/** copy constructor (invoked also when initializing from another smart ptr) */

    34

	FORCEINLINE CCountedPtr(const CCountedPtr& src) : m_pT(src.m_pT) {AddRef();};

    35

    36

	/** destructor releasing the reference */

    37

	FORCEINLINE ~CCountedPtr() {Release();};

    38

    39

protected:

    40

	/** add one ref to the underlaying object */

    41

	FORCEINLINE void AddRef() {if (m_pT != NULL) m_pT->AddRef();}

    42

    43

public:

    44

	/** release smart pointer (and decrement ref count) if not null */

    45

	FORCEINLINE void Release() {if (m_pT != NULL) {Tcls* pT = m_pT; m_pT = NULL; pT->Release();}}

    46

    47

	/** dereference of smart pointer - const way */

    48

	FORCEINLINE const Tcls* operator -> () const {assert(m_pT != NULL); return m_pT;};

    49

    50

	/** dereference of smart pointer - non const way */

    51

	FORCEINLINE Tcls* operator -> () {assert(m_pT != NULL); return m_pT;};

    52

    53

	/** raw pointer casting operator - const way */

    54

	FORCEINLINE operator const Tcls*() const {assert(m_pT == NULL); return m_pT;}

    55

    56

	/** raw pointer casting operator - non-const way */

    57

	FORCEINLINE operator Tcls*() {return m_pT;}

    58

    59

	/** operator & to support output arguments */

    60

	FORCEINLINE Tcls** operator &() {assert(m_pT == NULL); return &m_pT;}

    61

    62

	/** assignment operator from raw ptr */

    63

	FORCEINLINE CCountedPtr& operator = (Tcls* pT) {Assign(pT); return *this;}

    64

    65

	/** assignment operator from another smart ptr */

    66

	FORCEINLINE CCountedPtr& operator = (const CCountedPtr& src) {Assign(src.m_pT); return *this;}

    67

    68

	/** assignment operator helper */

    69

	FORCEINLINE void Assign(Tcls* pT);

    70

    71

	/** one way how to test for NULL value */

    72

	FORCEINLINE bool IsNull() const {return m_pT == NULL;}

    73

    74

	/** another way how to test for NULL value */

    75

	//FORCEINLINE bool operator == (const CCountedPtr& sp) const {return m_pT == sp.m_pT;}

    76

    77

	/** yet another way how to test for NULL value */

    78

	//FORCEINLINE bool operator != (const CCountedPtr& sp) const {return m_pT != sp.m_pT;}

    79

    80

	/** assign pointer w/o incrementing ref count */

    81

	FORCEINLINE void Attach(Tcls* pT) {Release(); m_pT = pT;}

    82

    83

	/** detach pointer w/o decrementing ref count */

    84

	FORCEINLINE Tcls* Detach() {Tcls* pT = m_pT; m_pT = NULL; return pT;}

    85

};

    86

    87

template <class Tcls_>

    88

FORCEINLINE void CCountedPtr<Tcls_>::Assign(Tcls* pT)

    89

{

    90

	// if they are the same, we do nothing

    91

	if (pT != m_pT) {

    92

		if (pT) pT->AddRef();        // AddRef new pointer if any

    93

		Tcls* pTold = m_pT;          // save original ptr

    94

		m_pT = pT;                   // update m_pT to new value

    95

		if (pTold) pTold->Release(); // release old ptr if any

    96

	}

    97

}

    98

    99

/**

   100

 * Adapter wrapper for CCountedPtr like classes that can't be used directly by stl

   101

 * collections as item type. For example CCountedPtr has overloaded operator & which

   102

 * prevents using CCountedPtr in stl collections (i.e. std::list<CCountedPtr<MyType> >)

   103

 */

   104

template <class T> struct AdaptT {

   105

	T m_t;

   106

   107

	/** construct by wrapping the given object */

   108

	AdaptT(const T &t)

   109

		: m_t(t)

   110

	{}

   111

   112

	/** assignment operator */

   113

	T& operator = (const T &t)

   114

	{

   115

		m_t = t;

   116

		return t;

   117

	}

   118

   119

	/** type-cast operator (used when AdaptT is used instead of T) */

   120

	operator T& ()

   121

	{

   122

		return m_t;

   123

	}

   124

   125

	/** const type-cast operator (used when AdaptT is used instead of const T) */

   126

	operator const T& () const

   127

	{

   128

		return m_t;

   129

	}

   130

};

   131

   132

   133

/** Simple counted object. Use it as base of your struct/class if you want to use

   134

 *  basic reference counting. Your struct/class will destroy and free itself when

   135

 *  last reference to it is released (using Relese() method). The initial reference

   136

 *  count (when it is created) is zero (don't forget AddRef() at least one time if

   137

 *  not using CCountedPtr<T>.

   138

 *

   139

 *  @see misc/countedobj.cpp for implementation.

   140

 */

   141

struct SimpleCountedObject {

   142

	int32 m_ref_cnt;

   143

   144

	SimpleCountedObject()

   145

		: m_ref_cnt(0)

   146

	{}

   147

   148

	virtual ~SimpleCountedObject()

   149

	{};

   150

   151

	virtual int32 AddRef();

   152

	virtual int32 Release();

   153

	virtual void FinalRelease() {};

   154

};

   155

   156

   157

   158

   159

#endif /* 0 */

   160

#endif /* COUNTEDPTR_HPP */