You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
114 lines
3.5 KiB
114 lines
3.5 KiB
/****************************************************************************
|
|
Copyright (c) 2016 Chukong Technologies Inc.
|
|
Copyright (c) 2017-2023 Xiamen Yaji Software Co., Ltd.
|
|
|
|
http://www.cocos.com
|
|
|
|
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.
|
|
****************************************************************************/
|
|
|
|
#pragma once
|
|
|
|
#include <cstddef>
|
|
|
|
namespace se {
|
|
|
|
class Object;
|
|
|
|
/**
|
|
* HandleObject is a helper class for easily release, root and unroot an non-native-binding se::Object.
|
|
|
|
{
|
|
se::HandleObject obj(se::Object::createPlainObject());
|
|
obj->setProperty(...);
|
|
otherObject->setProperty("foo", se::Value(obj));
|
|
}
|
|
|
|
is equal to:
|
|
|
|
{
|
|
se::Object* obj = se::Object::createPlainObject();
|
|
obj->root(); // root after object created to avoid object is garbage collected
|
|
|
|
obj->setProperty(...);
|
|
otherObject->setProperty("foo", se::Value(obj));
|
|
|
|
obj->unroot(); // unroot object after obj is used.
|
|
obj->decRef(); // Decrement referent count to avoid memory leak.
|
|
}
|
|
|
|
HandleObject should not be used to create a native binding object since the created binding object
|
|
should be holded by JavaScript VM and released in finalize callback internally.
|
|
|
|
*/
|
|
class HandleObject {
|
|
public:
|
|
/**
|
|
* @brief The constructor of HandleObject
|
|
* @param[in] obj The se::Object to attach.
|
|
*/
|
|
explicit HandleObject(Object *obj);
|
|
|
|
/**
|
|
* @brief The destructor of HandleObject
|
|
*/
|
|
~HandleObject();
|
|
|
|
/**
|
|
* @brief The pointer operator
|
|
* @return The se::Object attached.
|
|
*/
|
|
inline Object *operator->() const {
|
|
return _obj;
|
|
}
|
|
|
|
inline operator Object *() const { // NOLINT
|
|
return _obj;
|
|
}
|
|
|
|
/**
|
|
* @brief Gets the se::Object attached.
|
|
* @return The se::Object attached.
|
|
*/
|
|
inline Object *get() const {
|
|
return _obj;
|
|
}
|
|
|
|
/**
|
|
* @brief Tests whether HandleObject holds an invalid se::Object.
|
|
* @return true if HandleObject holds an invalid se::Object, otherwise false.
|
|
*/
|
|
inline bool isEmpty() const {
|
|
return (_obj == nullptr);
|
|
}
|
|
HandleObject(HandleObject &&) noexcept;
|
|
HandleObject& operator=(HandleObject &&) noexcept;
|
|
|
|
HandleObject(const HandleObject &) = delete;
|
|
HandleObject& operator=(const HandleObject &) = delete;
|
|
|
|
void *operator new(size_t size) = delete;
|
|
void operator delete(void *, size_t) = delete;
|
|
|
|
private:
|
|
Object *_obj;
|
|
friend class Object;
|
|
};
|
|
|
|
} // namespace se
|
|
|