geode/loader/include/Geode/cocos/cocoa/CCObject.h

/****************************************************************************
Copyright (c) 2010 cocos2d-x.org

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 __CCOBJECT_H__
#define __CCOBJECT_H__

#include "CCDataVisitor.h"
#include "../include/ccMacros.h"
#include <unordered_map>

// Geode macros
#include "../../DefaultInclude.hpp"

#ifdef EMSCRIPTEN
#include <GLES2/gl2.h>
#endif // EMSCRIPTEN

// @note RobTop Addition
class DS_Dictionary;

NS_CC_BEGIN

/**
 * @addtogroup base_nodes
 * @{
 */

// please someone tell we why in higher being(s)'s name rob did this
enum class CCObjectType {
    PlayLayer = 5,
    LevelEditorLayer = 6,
    GameObject = 13,
    MenuLayer = 15,
};

class CCZone;
class CCObject;
class CCNode;
class CCEvent;



/**
 * @js NA
 * @lua NA
 */
class CC_DLL CCCopying
{
    GEODE_FRIEND_MODIFY
public:
    virtual CCObject* copyWithZone(CCZone* pZone)  { return 0; }
};

/**
 * This class is used to fix the problem of destructor recursion.
 */
class CCDestructor : public CCCopying {
private:
	static std::unordered_map<void*, bool>& destructorLock();
public:
	static bool& globalLock();
	static bool& lock(void* self);
	~CCDestructor();
};

#pragma warning(push)
#pragma warning(disable: 4275)
/**
 * @js NA
 */
class CC_DLL CCObject : public CCDestructor
{
    GEODE_FRIEND_MODIFY
public:
    // object id, CCScriptSupport need public m_uID
    unsigned int        m_uID;
    // Lua reference id
    int                 m_nLuaID;
protected:
    // the object's tag
    int m_nTag;
    // count of references
    unsigned int        m_uReference;
    // count of autorelease
    unsigned int        m_uAutoReleaseCount;

    CCObjectType m_eObjType;

    int m_uIndexInArray; // used in some ccarray stuff, I don't remember what it does rn

    // 2.2 additions

    int m_uUnknown; // -1 by default
    int m_unknown2;
    int m_nZOrder; // moved from CCNode, why rob
    int m_uOrderOfArrival; // moved from CCNode, why rob
    int m_unknown5;
public:
	GEODE_CUSTOM_CONSTRUCTOR_BEGIN(CCObject)
    CCObject(void);
    /**
     *  @lua NA
     */
    virtual ~CCObject(void);
    
    void release(void);
    void retain(void);
    CCObject* autorelease(void);
    CCObject* copy(void);
    bool isSingleReference(void) const;
    inline unsigned int retainCount(void) const {
        return m_uReference;
    }
    virtual bool isEqual(const CCObject* pObject);

    virtual void acceptVisitor(CCDataVisitor &visitor);

    virtual void update(float dt) {CC_UNUSED_PARAM(dt);};
    
    virtual void encodeWithCoder(DS_Dictionary*);

    static CCObject* createWithCoder(DS_Dictionary*);
    
    virtual bool canEncode();

    inline CCObjectType getObjType() const {
        return m_eObjType;
    }
 
    virtual int getTag() const;

    virtual void setTag(int nTag);
    
    inline void setObjType(CCObjectType type) {
        m_eObjType = type;
    }

    friend class CCAutoreleasePool;
};
#pragma warning(pop)

typedef void (CCObject::*SEL_SCHEDULE)(float);
typedef void (CCObject::*SEL_CallFunc)();
typedef void (CCObject::*SEL_CallFuncN)(CCNode*);
typedef void (CCObject::*SEL_CallFuncND)(CCNode*, void*);
typedef void (CCObject::*SEL_CallFuncO)(CCObject*);
typedef void (CCObject::*SEL_MenuHandler)(CCObject*);
typedef void (CCObject::*SEL_EventHandler)(CCEvent*);
typedef int (CCObject::*SEL_Compare)(CCObject*);

#define schedule_selector(...) (cocos2d::SEL_SCHEDULE)(&__VA_ARGS__)
#define callfunc_selector(...) (cocos2d::SEL_CallFunc)(&__VA_ARGS__)
#define callfuncN_selector(...) (cocos2d::SEL_CallFuncN)(&__VA_ARGS__)
#define callfuncND_selector(...) (cocos2d::SEL_CallFuncND)(&__VA_ARGS__)
#define callfuncO_selector(...) (cocos2d::SEL_CallFuncO)(&__VA_ARGS__)
#define menu_selector(...) (cocos2d::SEL_MenuHandler)(&__VA_ARGS__)
#define event_selector(...) (cocos2d::SEL_EventHandler)(&__VA_ARGS__)
#define compare_selector(...) (cocos2d::SEL_Compare)(&__VA_ARGS__)

// end of base_nodes group
/// @}

NS_CC_END

#endif // __CCOBJECT_H__