1

/* $Id$ */

     2

     3

/** @file countedptr.hpp */

     4

     5

#ifndef COUNTEDPTR_HPP

     6

#define COUNTEDPTR_HPP

     7

     8

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

     9

    10

/** CCountedPtr - simple reference counting smart pointer.

    11

 *

    12

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

    13

 *

    14

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

    15

 *   general info about smart pointers.

    16

 *

    17

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

    18

 *   support AddRef() and Release() methods.

    19

 */

    20

template <class Tcls_>

    21

class CCountedPtr {

    22

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

    23

public:

    24

	typedef Tcls_ Tcls;

    25

    26

protected:

    27

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

    28

	Tcls* m_pT;

    29

    30

public:

    31

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

    32

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

    33

    34

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

    35

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

    36

    37

	/** destructor releasing the reference */

    38

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

    39

    40

protected:

    41

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

    42

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

    43

    44

public:

    45

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

    46

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

    47

    48

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

    49

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

    50

    51

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

    52

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

    53

    54

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

    55

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

    56

    57

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

    58

	FORCEINLINE operator Tcls*() {return m_pT;}

    59

    60

	/** operator & to support output arguments */

    61

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

    62

    63

	/** assignment operator from raw ptr */

    64

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

    65

    66

	/** assignment operator from another smart ptr */

    67

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

    68

    69

	/** assignment operator helper */

    70

	FORCEINLINE void Assign(Tcls* pT);

    71

    72

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

    73

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

    74

    75

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

    76

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

    77

    78

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

    79

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

    80

    81

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

    82

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

    83

    84

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

    85

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

    86

};

    87

    88

template <class Tcls_>

    89

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

    90

{

    91

	// if they are the same, we do nothing

    92

	if (pT != m_pT) {

    93

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

    94

		Tcls* pTold = m_pT;          // save original ptr

    95

		m_pT = pT;                   // update m_pT to new value

    96

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

    97

	}

    98

}

    99

   100

/**

   101

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

   102

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

   103

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

   104

 */

   105

template <class T> struct AdaptT {

   106

	T m_t;

   107

   108

	/** construct by wrapping the given object */

   109

	AdaptT(const T &t)

   110

		: m_t(t)

   111

	{}

   112

   113

	/** assignment operator */

   114

	T& operator = (const T &t)

   115

	{

   116

		m_t = t;

   117

		return t;

   118

	}

   119

   120

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

   121

	operator T& ()

   122

	{

   123

		return m_t;

   124

	}

   125

   126

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

   127

	operator const T& () const

   128

	{

   129

		return m_t;

   130

	}

   131

};

   132

   133

   134

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

   135

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

   136

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

   137

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

   138

 *  not using CCountedPtr<T>.

   139

 *

   140

 *  @see misc/countedobj.cpp for implementation.

   141

 */

   142

struct SimpleCountedObject {

   143

	int32 m_ref_cnt;

   144

   145

	SimpleCountedObject()

   146

		: m_ref_cnt(0)

   147

	{}

   148

   149

	virtual ~SimpleCountedObject()

   150

	{};

   151

   152

	virtual int32 AddRef();

   153

	virtual int32 Release();

   154

	virtual void FinalRelease() {};

   155

};

   156

   157

   158

   159

   160

#endif /* COUNTEDPTR_HPP */