2022-02-10 23:07:11 +01:00
|
|
|
/* SPDX-License-Identifier: GPL-2.0-or-later
|
|
|
|
* Copyright 2001-2002 NaN Holding BV. All rights reserved. */
|
2011-02-25 12:47:18 +01:00
|
|
|
|
2019-02-17 22:08:12 +01:00
|
|
|
/** \file
|
2021-12-14 08:35:31 +01:00
|
|
|
* \ingroup intern_memutil
|
2019-02-06 05:42:22 +01:00
|
|
|
*
|
2002-12-30 13:11:03 +01:00
|
|
|
* Declaration of MEM_RefCounted class.
|
2002-10-12 13:37:38 +02:00
|
|
|
*/
|
|
|
|
|
2012-02-17 19:59:41 +01:00
|
|
|
#ifndef __MEM_REFCOUNTED_H__
|
|
|
|
#define __MEM_REFCOUNTED_H__
|
2002-10-12 13:37:38 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* An object with reference counting.
|
|
|
|
* Base class for objects with reference counting.
|
|
|
|
* When a shared object is ceated, it has reference count == 1.
|
2014-10-29 14:11:19 +01:00
|
|
|
* If the reference count of a shared object reaches zero, the object self-destructs.
|
2002-10-12 13:37:38 +02:00
|
|
|
* The default destructor of this object has been made protected on purpose.
|
|
|
|
* This disables the creation of shared objects on the stack.
|
|
|
|
*
|
2019-09-05 04:56:55 +02:00
|
|
|
* \author Maarten Gribnau
|
|
|
|
* \date March 31, 2001
|
2002-10-12 13:37:38 +02:00
|
|
|
*/
|
|
|
|
|
|
|
|
class MEM_RefCounted {
|
|
|
|
public:
|
|
|
|
/**
|
2022-01-05 15:09:53 +01:00
|
|
|
* Constructs a shared object.
|
2002-10-12 13:37:38 +02:00
|
|
|
*/
|
2023-03-29 16:50:54 +02:00
|
|
|
MEM_RefCounted() : m_refCount(1) {}
|
2002-10-12 13:37:38 +02:00
|
|
|
|
2019-01-24 06:20:16 +01:00
|
|
|
/**
|
2002-10-12 13:37:38 +02:00
|
|
|
* Returns the reference count of this object.
|
2019-09-05 04:56:55 +02:00
|
|
|
* \return the reference count.
|
2002-10-12 13:37:38 +02:00
|
|
|
*/
|
|
|
|
inline virtual int getRef() const;
|
|
|
|
|
2019-01-24 06:20:16 +01:00
|
|
|
/**
|
2002-10-12 13:37:38 +02:00
|
|
|
* Increases the reference count of this object.
|
2019-09-05 04:56:55 +02:00
|
|
|
* \return the new reference count.
|
2002-10-12 13:37:38 +02:00
|
|
|
*/
|
|
|
|
inline virtual int incRef();
|
|
|
|
|
2019-01-24 06:20:16 +01:00
|
|
|
/**
|
2002-10-12 13:37:38 +02:00
|
|
|
* Decreases the reference count of this object.
|
2014-10-29 14:11:19 +01:00
|
|
|
* If the reference count reaches zero, the object self-destructs.
|
2019-09-05 04:56:55 +02:00
|
|
|
* \return the new reference count.
|
2002-10-12 13:37:38 +02:00
|
|
|
*/
|
|
|
|
inline virtual int decRef();
|
|
|
|
|
|
|
|
protected:
|
|
|
|
/**
|
|
|
|
* Destructs a shared object.
|
|
|
|
* The destructor is protected to force the use of incRef and decRef.
|
|
|
|
*/
|
2023-03-29 16:50:54 +02:00
|
|
|
virtual ~MEM_RefCounted() {}
|
2002-10-12 13:37:38 +02:00
|
|
|
|
|
|
|
protected:
|
|
|
|
/** The reference count. */
|
|
|
|
int m_refCount;
|
|
|
|
};
|
|
|
|
|
|
|
|
inline int MEM_RefCounted::getRef() const
|
|
|
|
{
|
|
|
|
return m_refCount;
|
|
|
|
}
|
|
|
|
|
|
|
|
inline int MEM_RefCounted::incRef()
|
|
|
|
{
|
|
|
|
return ++m_refCount;
|
|
|
|
}
|
|
|
|
|
|
|
|
inline int MEM_RefCounted::decRef()
|
|
|
|
{
|
|
|
|
m_refCount--;
|
|
|
|
if (m_refCount == 0) {
|
|
|
|
delete this;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
return m_refCount;
|
|
|
|
}
|
|
|
|
|
2012-02-17 19:59:41 +01:00
|
|
|
#endif // __MEM_REFCOUNTED_H__
|