mirror of
https://github.com/smallmain/cocos-enhance-kit.git
synced 2024-12-26 11:48:29 +00:00
155 lines
3.6 KiB
C++
155 lines
3.6 KiB
C++
/****************************************************************************
|
|
Copyright (c) 2010-2012 cocos2d-x.org
|
|
Copyright (c) 2013-2016 Chukong Technologies Inc.
|
|
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
|
|
|
|
http://www.cocos2d-x.org
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
THE SOFTWARE.
|
|
****************************************************************************/
|
|
|
|
#ifndef __BASE_CCREF_H__
|
|
#define __BASE_CCREF_H__
|
|
|
|
#include "base/ccMacros.h"
|
|
#include "base/ccConfig.h"
|
|
|
|
#define CC_REF_LEAK_DETECTION 0
|
|
|
|
/**
|
|
* @addtogroup base
|
|
* @{
|
|
*/
|
|
NS_CC_BEGIN
|
|
|
|
|
|
class Ref;
|
|
|
|
/**
|
|
* Interface that defines how to clone an Ref.
|
|
* @lua NA
|
|
* @js NA
|
|
*/
|
|
class CC_DLL Clonable
|
|
{
|
|
public:
|
|
/** Returns a copy of the Ref. */
|
|
virtual Clonable* clone() const = 0;
|
|
|
|
/**
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
virtual ~Clonable() {};
|
|
};
|
|
|
|
/**
|
|
* Ref is used for reference count management. If a class inherits from Ref,
|
|
* then it is easy to be shared in different places.
|
|
* @js NA
|
|
*/
|
|
class CC_DLL Ref
|
|
{
|
|
public:
|
|
/**
|
|
* Retains the ownership.
|
|
*
|
|
* This increases the Ref's reference count.
|
|
*
|
|
* @see release, autorelease
|
|
* @js NA
|
|
*/
|
|
void retain();
|
|
|
|
/**
|
|
* Releases the ownership immediately.
|
|
*
|
|
* This decrements the Ref's reference count.
|
|
*
|
|
* If the reference count reaches 0 after the decrement, this Ref is
|
|
* destructed.
|
|
*
|
|
* @see retain, autorelease
|
|
* @js NA
|
|
*/
|
|
void release();
|
|
|
|
/**
|
|
* Releases the ownership sometime soon automatically.
|
|
*
|
|
* This decrements the Ref's reference count at the end of current
|
|
* autorelease pool block.
|
|
*
|
|
* If the reference count reaches 0 after the decrement, this Ref is
|
|
* destructed.
|
|
*
|
|
* @returns The Ref itself.
|
|
*
|
|
* @see AutoreleasePool, retain, release
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
Ref* autorelease();
|
|
|
|
/**
|
|
* Returns the Ref's current reference count.
|
|
*
|
|
* @returns The Ref's reference count.
|
|
* @js NA
|
|
*/
|
|
unsigned int getReferenceCount() const;
|
|
|
|
protected:
|
|
/**
|
|
* Constructor
|
|
*
|
|
* The Ref's reference count is 1 after construction.
|
|
* @js NA
|
|
*/
|
|
Ref();
|
|
|
|
/**
|
|
* Destructor
|
|
*
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
virtual ~Ref();
|
|
|
|
protected:
|
|
/// count of references
|
|
unsigned int _referenceCount;
|
|
|
|
friend class AutoreleasePool;
|
|
|
|
// Memory leak diagnostic data (only included when CC_REF_LEAK_DETECTION is defined and its value isn't zero)
|
|
#if CC_REF_LEAK_DETECTION
|
|
public:
|
|
static void printLeaks();
|
|
#endif
|
|
};
|
|
|
|
|
|
NS_CC_END
|
|
// end of base group
|
|
/** @} */
|
|
|
|
#endif // __BASE_CCREF_H__
|
|
|