Lothario
/
axmol
mirror of https://github.com/axmolengine/axmol.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[ci skip]Update comments

This commit is contained in:
WenhaiLin 2015-03-24 15:13:05 +08:00
parent 9e7e819eab
commit 3b555be91a
9 changed files with 104 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
cocos/base/allocator/CCAllocatorBase.h
View File

@ -1,9 +1,5 @@
#ifndef CC_ALLOCATOR_BASE_H
#define CC_ALLOCATOR_BASE_H
/**************************************************************************** /****************************************************************************
Copyright (c) 2014 Chukong Technologies Inc. Copyright (c) 2014-2015 Chukong Technologies Inc.
Author: Justin Graham (https://github.com/mannewalis) Author: Justin Graham (https://github.com/mannewalis)
http://www.cocos2d-x.org http://www.cocos2d-x.org
@ -27,11 +23,17 @@
THE SOFTWARE. THE SOFTWARE.
****************************************************************************/ ****************************************************************************/
#ifndef CC_ALLOCATOR_BASE_H
#define CC_ALLOCATOR_BASE_H
/// @cond
#include <string> #include <string>
#include "platform/CCPlatformMacros.h" #include "platform/CCPlatformMacros.h"
#include "base/allocator/CCAllocatorMacros.h" #include "base/allocator/CCAllocatorMacros.h"
NS_CC_BEGIN NS_CC_BEGIN
NS_CC_ALLOCATOR_BEGIN NS_CC_ALLOCATOR_BEGIN
@ -110,4 +112,6 @@ public:
NS_CC_ALLOCATOR_END NS_CC_ALLOCATOR_END
NS_CC_END NS_CC_END
/// @endcond
#endif//CC_ALLOCATOR_BASE_H #endif//CC_ALLOCATOR_BASE_H

12
cocos/base/allocator/CCAllocatorDiagnostics.h
View File

@ -1,9 +1,5 @@
#ifndef CC_ALLOCATOR_DIAGNOSTICS_H
#define CC_ALLOCATOR_DIAGNOSTICS_H
/**************************************************************************** /****************************************************************************
Copyright (c) 2014 Chukong Technologies Inc. Copyright (c) 2014-2015 Chukong Technologies Inc.
Author: Justin Graham (https://github.com/mannewalis) Author: Justin Graham (https://github.com/mannewalis)
http://www.cocos2d-x.org http://www.cocos2d-x.org
@ -27,6 +23,10 @@
THE SOFTWARE. THE SOFTWARE.
****************************************************************************/ ****************************************************************************/
#ifndef CC_ALLOCATOR_DIAGNOSTICS_H
#define CC_ALLOCATOR_DIAGNOSTICS_H
/// @cond
#include <unordered_set> #include <unordered_set>
#include "base/allocator/CCAllocatorMacros.h" #include "base/allocator/CCAllocatorMacros.h"
@ -58,4 +58,6 @@ protected:
NS_CC_ALLOCATOR_END NS_CC_ALLOCATOR_END
NS_CC_END NS_CC_END
/// @endcond
#endif//CC_ALLOCATOR_DIAGNOSTICS_H #endif//CC_ALLOCATOR_DIAGNOSTICS_H

14
cocos/base/allocator/CCAllocatorGlobal.h
View File

@ -1,9 +1,5 @@
#ifndef CC_ALLOCATOR_GLOBAL_H
#define CC_ALLOCATOR_GLOBAL_H
/**************************************************************************** /****************************************************************************
Copyright (c) 2014 Chukong Technologies Inc. Copyright (c) 2014-2015 Chukong Technologies Inc.
Author: Justin Graham (https://github.com/mannewalis) Author: Justin Graham (https://github.com/mannewalis)
http://www.cocos2d-x.org http://www.cocos2d-x.org
@ -27,16 +23,22 @@
THE SOFTWARE. THE SOFTWARE.
****************************************************************************/ ****************************************************************************/
#ifndef CC_ALLOCATOR_GLOBAL_H
#define CC_ALLOCATOR_GLOBAL_H
/// @cond
#include "base/allocator/CCAllocatorMacros.h" #include "base/allocator/CCAllocatorMacros.h"
#include "base/allocator/CCAllocatorStrategyDefault.h" #include "base/allocator/CCAllocatorStrategyDefault.h"
NS_CC_BEGIN NS_CC_BEGIN
NS_CC_ALLOCATOR_BEGIN NS_CC_ALLOCATOR_BEGIN
// @brief Make visible at the global scope. /** Make visible at the global scope.*/
extern CC_ALLOCATOR_GLOBAL ccAllocatorGlobal; extern CC_ALLOCATOR_GLOBAL ccAllocatorGlobal;
NS_CC_ALLOCATOR_END NS_CC_ALLOCATOR_END
NS_CC_END NS_CC_END
/// @endcond
#endif//CC_ALLOCATOR_GLOBAL_H #endif//CC_ALLOCATOR_GLOBAL_H

12
cocos/base/allocator/CCAllocatorMacros.h
View File

@ -1,9 +1,5 @@
#ifndef CC_ALLOCATOR_MACROS_H
#define CC_ALLOCATOR_MACROS_H
/**************************************************************************** /****************************************************************************
Copyright (c) 2014 Chukong Technologies Inc. Copyright (c) 2014-2015 Chukong Technologies Inc.
Author: Justin Graham (https://github.com/mannewalis) Author: Justin Graham (https://github.com/mannewalis)
http://www.cocos2d-x.org http://www.cocos2d-x.org
@ -27,6 +23,10 @@
THE SOFTWARE. THE SOFTWARE.
****************************************************************************/ ****************************************************************************/
#ifndef CC_ALLOCATOR_MACROS_H
#define CC_ALLOCATOR_MACROS_H
/// @cond
#include "base/ccConfig.h" #include "base/ccConfig.h"
#include "platform/CCPlatformMacros.h" #include "platform/CCPlatformMacros.h"
@ -127,4 +127,6 @@
} \ } \
} }
/// @endcond
#endif//CC_ALLOCATOR_MACROS_H #endif//CC_ALLOCATOR_MACROS_H

12
cocos/base/allocator/CCAllocatorMutex.h
View File

@ -1,9 +1,5 @@
#ifndef CC_ALLOCATOR_MUTEX_H
#define CC_ALLOCATOR_MUTEX_H
/**************************************************************************** /****************************************************************************
Copyright (c) 2014 Chukong Technologies Inc. Copyright (c) 2014-2015 Chukong Technologies Inc.
Author: Justin Graham (https://github.com/mannewalis) Author: Justin Graham (https://github.com/mannewalis)
http://www.cocos2d-x.org http://www.cocos2d-x.org
@ -27,6 +23,10 @@
THE SOFTWARE. THE SOFTWARE.
****************************************************************************/ ****************************************************************************/
#ifndef CC_ALLOCATOR_MUTEX_H
#define CC_ALLOCATOR_MUTEX_H
/// @cond
#include "platform/CCPlatformMacros.h" #include "platform/CCPlatformMacros.h"
#if CC_TARGET_PLATFORM == CC_PLATFORM_IOS || CC_TARGET_PLATFORM == CC_PLATFORM_MAC || CC_TARGET_PLATFORM == CC_PLATFORM_ANDROID || CC_TARGET_PLATFORM == CC_PLATFORM_LINUX #if CC_TARGET_PLATFORM == CC_PLATFORM_IOS || CC_TARGET_PLATFORM == CC_PLATFORM_MAC || CC_TARGET_PLATFORM == CC_PLATFORM_ANDROID || CC_TARGET_PLATFORM == CC_PLATFORM_LINUX
@ -121,4 +121,6 @@ struct lockless_semantics
NS_CC_ALLOCATOR_END NS_CC_ALLOCATOR_END
NS_CC_END NS_CC_END
/// @endcond
#endif//CC_ALLOCATOR_MUTEX_H #endif//CC_ALLOCATOR_MUTEX_H

12
cocos/base/allocator/CCAllocatorStrategyDefault.h
View File

@ -1,9 +1,5 @@
#ifndef CC_ALLOCATOR_STRATEGY_DEFAULT_H
#define CC_ALLOCATOR_STRATEGY_DEFAULT_H
/**************************************************************************** /****************************************************************************
Copyright (c) 2014 Chukong Technologies Inc. Copyright (c) 2014-2015 Chukong Technologies Inc.
Author: Justin Graham (https://github.com/mannewalis) Author: Justin Graham (https://github.com/mannewalis)
http://www.cocos2d-x.org http://www.cocos2d-x.org
@ -27,6 +23,10 @@
THE SOFTWARE. THE SOFTWARE.
****************************************************************************/ ****************************************************************************/
#ifndef CC_ALLOCATOR_STRATEGY_DEFAULT_H
#define CC_ALLOCATOR_STRATEGY_DEFAULT_H
/// @cond
#include "base/allocator/CCAllocatorMacros.h" #include "base/allocator/CCAllocatorMacros.h"
#include "base/allocator/CCAllocatorBase.h" #include "base/allocator/CCAllocatorBase.h"
@ -55,4 +55,6 @@ public:
NS_CC_ALLOCATOR_END NS_CC_ALLOCATOR_END
NS_CC_END NS_CC_END
/// @endcond
#endif//CC_ALLOCATOR_STRATEGY_DEFAULT_H #endif//CC_ALLOCATOR_STRATEGY_DEFAULT_H

12
cocos/base/allocator/CCAllocatorStrategyFixedBlock.h
View File

@ -1,9 +1,5 @@
#ifndef CC_ALLOCATOR_STRATEGY_FIXED_BLOCK_H
#define CC_ALLOCATOR_STRATEGY_FIXED_BLOCK_H
/**************************************************************************** /****************************************************************************
Copyright (c) 2014 Chukong Technologies Inc. Copyright (c) 2014-2015 Chukong Technologies Inc.
Author: Justin Graham (https://github.com/mannewalis) Author: Justin Graham (https://github.com/mannewalis)
http://www.cocos2d-x.org http://www.cocos2d-x.org
@ -27,6 +23,10 @@
THE SOFTWARE. THE SOFTWARE.
****************************************************************************/ ****************************************************************************/
#ifndef CC_ALLOCATOR_STRATEGY_FIXED_BLOCK_H
#define CC_ALLOCATOR_STRATEGY_FIXED_BLOCK_H
/// @cond
/**************************************************************************** /****************************************************************************
WARNING! WARNING!
Do not use Console::log or any other methods that use NEW inside of this Do not use Console::log or any other methods that use NEW inside of this
@ -273,4 +273,6 @@ protected:
NS_CC_ALLOCATOR_END NS_CC_ALLOCATOR_END
NS_CC_END NS_CC_END
/// @endcond
#endif//CC_ALLOCATOR_STRATEGY_FIXED_BLOCK_H #endif//CC_ALLOCATOR_STRATEGY_FIXED_BLOCK_H

12
cocos/base/allocator/CCAllocatorStrategyGlobalSmallBlock.h
View File

@ -1,9 +1,5 @@
#ifndef CC_ALLOCATOR_STRATEGY_GLOBAL_SMALL_BLOCK_H
#define CC_ALLOCATOR_STRATEGY_GLOBAL_SMALL_BLOCK_H
/**************************************************************************** /****************************************************************************
Copyright (c) 2014 Chukong Technologies Inc. Copyright (c) 2014-2015 Chukong Technologies Inc.
Author: Justin Graham (https://github.com/mannewalis) Author: Justin Graham (https://github.com/mannewalis)
http://www.cocos2d-x.org http://www.cocos2d-x.org
@ -27,6 +23,10 @@
THE SOFTWARE. THE SOFTWARE.
****************************************************************************/ ****************************************************************************/
#ifndef CC_ALLOCATOR_STRATEGY_GLOBAL_SMALL_BLOCK_H
#define CC_ALLOCATOR_STRATEGY_GLOBAL_SMALL_BLOCK_H
/// @cond
/**************************************************************************** /****************************************************************************
WARNING! WARNING!
Do not use Console::log or any other methods that use NEW inside of this Do not use Console::log or any other methods that use NEW inside of this
@ -315,4 +315,6 @@ protected:
NS_CC_ALLOCATOR_END NS_CC_ALLOCATOR_END
NS_CC_END NS_CC_END
/// @endcond
#endif//CC_ALLOCATOR_STRATEGY_GLOBAL_SMALL_BLOCK_H #endif//CC_ALLOCATOR_STRATEGY_GLOBAL_SMALL_BLOCK_H

77
cocos/base/allocator/CCAllocatorStrategyPool.h
View File

@ -1,9 +1,5 @@
#ifndef CC_ALLOCATOR_STRATEGY_POOL_H
#define CC_ALLOCATOR_STRATEGY_POOL_H
/**************************************************************************** /****************************************************************************
Copyright (c) 2014 Chukong Technologies Inc. Copyright (c) 2014-2015 Chukong Technologies Inc.
Author: Justin Graham (https://github.com/mannewalis) Author: Justin Graham (https://github.com/mannewalis)
http://www.cocos2d-x.org http://www.cocos2d-x.org
@ -26,6 +22,11 @@
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE. THE SOFTWARE.
****************************************************************************/ ****************************************************************************/
#ifndef CC_ALLOCATOR_STRATEGY_POOL_H
#define CC_ALLOCATOR_STRATEGY_POOL_H
/// @cond
#include <vector> #include <vector>
#include <typeinfo> #include <typeinfo>
#include <sstream> #include <sstream>
@ -39,12 +40,16 @@
NS_CC_BEGIN NS_CC_BEGIN
NS_CC_ALLOCATOR_BEGIN NS_CC_ALLOCATOR_BEGIN
// @brief ObjectTraits describes an allocatable object /**
// Templated class that represents a default allocatable object. * ObjectTraits describes an allocatable object.
// Provide custom implementations to change the constructor/destructor behavior, *
// or to change the default alignment of the object in memory. * Template class that represents a default allocatable object.
// @param T Type of object * Provide custom implementations to change the constructor/destructor behavior,
// @param _alignment Alignment of object T * or to change the default alignment of the object in memory.
*
* @param T Type of object.
* @param _alignment Alignment of object T.
*/
template <typename T, size_t _alignment = sizeof(uint32_t)> template <typename T, size_t _alignment = sizeof(uint32_t)>
class ObjectTraits class ObjectTraits
{ {
@ -57,36 +62,36 @@ public:
virtual ~ObjectTraits() virtual ~ObjectTraits()
{} {}
// @brief constructor implementation for type T /** Constructor implementation for type T.*/
void construct(T* address) void construct(T* address)
{ {
::new(address) T(); ::new(address) T();
} }
// @brief destructor implementation for type T /** Destructor implementation for type T.*/
void destroy(T* address) void destroy(T* address)
{ {
address->~T(); address->~T();
} }
// @brief returns the name of this object type T /** Returns the name of this object type T.*/
const char* name() const const char* name() const
{ {
return typeid(T).name(); return typeid(T).name();
} }
}; };
/**
// @brief * Fixed sized pool allocator strategy for objects of type T.
// Fixed sized pool allocator strategy for objects of type T *
// Optionally takes a page size which determines how many objects * Optionally takes a page size which determines how many objects are added when the allocator needs more storage.
// are added when the allocator needs more storage. * ObjectTraits allows you to control the alignment, construction and destruction of an object in the pool.
// ObjectTraits allows you to control the alignment, construction *
// and destruction of an object in the pool. * @param T Type of object.
// @param T Type of object. * @param _page_size Number of objects of T in each page.
// @param _page_size Number of objects of T in each page. * @param O ObjectTraits for type T
// @param O ObjectTraits for type T * @see CC_USE_ALLOCATOR_POOL
// @see CC_USE_ALLOCATOR_POOL */
template <typename T, typename O = ObjectTraits<T>, typename locking_traits = lockless_semantics> template <typename T, typename O = ObjectTraits<T>, typename locking_traits = lockless_semantics>
class AllocatorStrategyPool class AllocatorStrategyPool
: public AllocatorStrategyFixedBlock<sizeof(T), O::alignment, locking_traits> : public AllocatorStrategyFixedBlock<sizeof(T), O::alignment, locking_traits>
@ -97,7 +102,7 @@ public:
typedef T value_type; typedef T value_type;
typedef value_type* pointer; typedef value_type* pointer;
// ugh wish I knew a way that I could declare this just once /** Ugh wish I knew a way that I could declare this just once.*/
typedef AllocatorStrategyFixedBlock<sizeof(T), O::alignment, locking_traits> tParentStrategy; typedef AllocatorStrategyFixedBlock<sizeof(T), O::alignment, locking_traits> tParentStrategy;
AllocatorStrategyPool(const char* tag = nullptr, size_t poolSize = 100) AllocatorStrategyPool(const char* tag = nullptr, size_t poolSize = 100)
@ -107,9 +112,12 @@ public:
tParentStrategy::_pageSize = poolSize; tParentStrategy::_pageSize = poolSize;
} }
// @brief Allocate block of size T /**
// if size does not match sizeof(T) then the global allocator is called instead. * Allocate block of size T.
// @see CC_USE_ALLOCATOR_POOL *
* If size does not match sizeof(T) then the global allocator is called instead.
* @see CC_USE_ALLOCATOR_POOL
*/
CC_ALLOCATOR_INLINE void* allocate(size_t size) CC_ALLOCATOR_INLINE void* allocate(size_t size)
{ {
T* object; T* object;
@ -125,9 +133,12 @@ public:
return object; return object;
} }
// @brief Deallocate block of size T /**
// if size does not match sizeof(T) then the global allocator is called instead. * Deallocate block of size T.
// @see CC_USE_ALLOCATOR_POOL *
* If size does not match sizeof(T) then the global allocator is called instead.
* @see CC_USE_ALLOCATOR_POOL
*/
CC_ALLOCATOR_INLINE void deallocate(void* address, size_t size = 0) CC_ALLOCATOR_INLINE void deallocate(void* address, size_t size = 0)
{ {
if (address) if (address)
@ -157,4 +168,6 @@ public:
NS_CC_ALLOCATOR_END NS_CC_ALLOCATOR_END
NS_CC_END NS_CC_END
/// @endcond
#endif//CC_ALLOCATOR_STRATEGY_POOL_H #endif//CC_ALLOCATOR_STRATEGY_POOL_H