ios_project/proj.ios_mac/cocos2d-x/cocos/scripting/js-bindings/jswrapper/State.hpp

/****************************************************************************
 Copyright (c) 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.
 ****************************************************************************/
#pragma once

#include "Value.hpp"

namespace se {

    class Object;

    /**
     *  State represents an environment while a function or an accesstor is invoked from JavaScript.
     */
    class State final
    {
    public:
        /**
         *  @brief Gets void* pointer of `this` object's private data.
         *  @return A void* pointer of `this` object's private data.
         */
        void* nativeThisObject() const;

        /**
         *  @brief Gets the arguments of native binding functions or accesstors.
         *  @return The arguments of native binding functions or accesstors.
         */
        const ValueArray& args() const;

        /**
         *  @brief Gets the JavaScript `this` object wrapped in se::Object.
         *  @return The JavaScript `this` object wrapped in se::Object.
         */
        Object* thisObject();

        /**
         *  @brief Gets the return value reference. Used for setting return value for a function.
         *  @return The return value reference.
         */
        Value& rval();

        // Private API used in wrapper
        /**
         *  @brief
         *  @param[in]
         *  @return
         */
        State();

        /**
         *  @brief
         *  @param[in]
         *  @return
         */
        ~State();

        /**
         *  @brief
         *  @param[in]
         *  @return
         */
        State(void* nativeThisObject);

        /**
         *  @brief
         *  @param[in]
         *  @return
         */
        State(void* nativeThisObject, const ValueArray& args);

        /**
         *  @brief
         *  @param[in]
         *  @return
         */
        State(Object* thisObject, const ValueArray& args);
    private:

        // Disable copy/move constructor, copy/move assigment
        State(const State&);
        State(State&&);
        State& operator=(const State&);
        State& operator=(State&&);

        void* _nativeThisObject;  //weak ref
        Object* _thisObject; //weak ref
        const ValueArray* _args; //weak ref
        Value _retVal; //weak ref
    };
}