Differential D2768 Diff 13918 source/gui/Scripting/JSInterface_GUIProxy.h

Changeset View

Standalone View

source/gui/Scripting/JSInterface_GUIProxy.h

This file was added.

				/* Copyright (C) 2019 Wildfire Games.
				* This file is part of 0 A.D.
				*
				* 0 A.D. is free software: you can redistribute it and/or modify
				* it under the terms of the GNU General Public License as published by
				* the Free Software Foundation, either version 2 of the License, or
				* (at your option) any later version.
				*
				* 0 A.D. is distributed in the hope that it will be useful,
				* but WITHOUT ANY WARRANTY; without even the implied warranty of
				* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
				* GNU General Public License for more details.
				*
				* You should have received a copy of the GNU General Public License
				* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
				*/

				#ifndef INCLUDED_JSI_IGUIOBJECT
				#define INCLUDED_JSI_IGUIOBJECT

				StanUnsubmitted Done Inline Actions Shouldn't that match the file name? Stan: Shouldn't that match the file name?
				#include "js/Proxy.h"

				StanUnsubmitted Not Done Inline Actions Typo. Stan: Typo.
				#include "scriptinterface/ScriptInterface.h"

				namespace JSI_GUIProxy
				{
				static js::Class ClassDefinition = \
				PROXY_CLASS_DEF("GUIObjectProxy", JSCLASS_HAS_PRIVATE \| JSCLASS_HAS_CACHED_PROTO(JSProto_Proxy));

				/**
				* Handles the js interface with C++ GUI objects.
				* Proxy handlers must live for at least as long as the JS runtime
				* where a proxy object with that handler was created. The reason is that
				* proxy handlers are called during GC, such as on runtime destruction.
				* In practical terms, this means "just keep them static and store no data".
				*
				* GUI Objects only exist in C++ and have no JS-only properties.
				* As such, there is no "target" JS object that this proxy could point to,
				* and thus we should inherit from BaseProxyHandler and not js::Wrapper.
				*/
				template<typename GUIObjectType>
				class GUIProxy : public js::BaseProxyHandler
				{
				public:
				static void RegisterFunctions(ScriptInterface& scriptInterface);

				// For convenience, this is the single instantiated GUIProxy.
				StanUnsubmitted Done Inline Actions #include <utility> Stan: ```lang=cpp #include <utility> ```
				static GUIProxy singleton;
				protected:
				// @param family can't be nullptr because that's used for some DOM object and it crashes.
				GUIProxy() : BaseProxyHandler(this, false, false) {};
				virtual ~GUIProxy() {};

				// This handles returning function properties.
				// Overload this in your subclass.
				virtual bool funcGetter(ScriptInterface& scriptInterface, const std::string& propName, JS::MutableHandleValue vp) const;

				// Handler for `object.x`
				virtual bool get(JSContext* cx, JS::HandleObject proxy, JS::HandleValue receiver, JS::HandleId id, JS::MutableHandleValue vp) const final;
				// Handler for `object.x = y;`
				virtual bool set(JSContext* cx, JS::HandleObject proxy, JS::HandleId id, JS::HandleValue vp,
				JS::HandleValue receiver, JS::ObjectOpResult& result) const final;
				// Handler for `delete object.x;`
				virtual bool delete_(JSContext* cx, JS::HandleObject proxy, JS::HandleId id, JS::ObjectOpResult& result) const final;

				// The following methods are not provided by BaseProxyHandler.
				// We provide defaults that do nothing (some raise JS exceptions).

				// The JS code will see undefined when querying a property descriptor.
				virtual bool getOwnPropertyDescriptor(JSContext* UNUSED(cx), JS::HandleObject UNUSED(proxy), JS::HandleId UNUSED(id),
				JS::MutableHandle<JS::PropertyDescriptor> UNUSED(desc)) const
				{
				return true;
				}
				// Throw an exception is JS code attempts defining a property.
				virtual bool defineProperty(JSContext* UNUSED(cx), JS::HandleObject UNUSED(proxy), JS::HandleId UNUSED(id),
				JS::Handle<JS::PropertyDescriptor> UNUSED(desc), JS::ObjectOpResult& UNUSED(result)) const
				{
				return false;
				}
				// Return nothing.
				virtual bool ownPropertyKeys(JSContext* UNUSED(cx), JS::HandleObject UNUSED(proxy), JS::AutoIdVector& UNUSED(props)) const
				{
				return true;
				}
				// Return nothing.
				virtual bool enumerate(JSContext* UNUSED(cx), JS::HandleObject UNUSED(proxy), JS::MutableHandleObject UNUSED(objp)) const
				{
				return true;
				}
				// Throw an exception is JS attempts to query the prototype.
				virtual bool getPrototypeIfOrdinary(JSContext* UNUSED(cx), JS::HandleObject UNUSED(proxy), bool* UNUSED(isOrdinary), JS::MutableHandleObject UNUSED(protop)) const
				{
				return false;
				}
				// Throw an exception - no prototype to set.
				virtual bool setImmutablePrototype(JSContext* UNUSED(cx), JS::HandleObject UNUSED(proxy), bool* UNUSED(succeeded)) const
				{
				return false;
				}
				// We are not extensible.
				virtual bool preventExtensions(JSContext* UNUSED(cx), JS::HandleObject UNUSED(proxy), JS::ObjectOpResult& UNUSED(result)) const
				{
				return true;
				}
				virtual bool isExtensible(JSContext* UNUSED(cx), JS::HandleObject UNUSED(proxy), bool* extensible) const
				{
				*extensible = false;
				return true;
				}
				};
				}

				#endif // INCLUDED_JSI_IGUIOBJECT