source/gui/Scripting/JSInterface_IGUIObject.cpp

   1 /* Copyright (C) 2019 Wildfire Games.
   2  * This file is part of 0 A.D.
   3  *
   4  * 0 A.D. is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * 0 A.D. is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #include "precompiled.h"
  19
  20 #include "JSInterface_IGUIObject.h"
  21
  22 #include "gui/CGUI.h"
  23 #include "gui/CGUISetting.h"
  24 #include "gui/ObjectBases/IGUIObject.h"
  25 #include "scriptinterface/ScriptExtraHeaders.h"
  26 #include "scriptinterface/ScriptInterface.h"
  27
  28 JSClass JSI_IGUIObject::JSI_class = {
  29         "GUIObject", JSCLASS_HAS_PRIVATE,
  30         nullptr,
  31         JSI_IGUIObject::deleteProperty,
  32         JSI_IGUIObject::getProperty,
  33         JSI_IGUIObject::setProperty,
  34         nullptr, nullptr, nullptr, nullptr,
  35         nullptr, nullptr, nullptr, nullptr
  36 };
  37
  38 JSFunctionSpec JSI_IGUIObject::JSI_methods[] =
  39 {
  40         JS_FN("toString", JSI_IGUIObject::toString, 0, 0),
  41         JS_FN("focus", JSI_IGUIObject::focus, 0, 0),
  42         JS_FN("blur", JSI_IGUIObject::blur, 0, 0),
  43         JS_FN("getComputedSize", JSI_IGUIObject::getComputedSize, 0, 0),
  44         JS_FS_END
  45 };
  46
  47 void JSI_IGUIObject::RegisterScriptClass(ScriptInterface& scriptInterface)
  48 {
  49         scriptInterface.DefineCustomObjectType(&JSI_class, nullptr, 0, nullptr, JSI_methods, nullptr, nullptr);
  50 }
  51
  52 bool JSI_IGUIObject::getProperty(JSContext* cx, JS::HandleObject obj, JS::HandleId id, JS::MutableHandleValue vp)
  53 {
  54         JSAutoRequest rq(cx);
  55         ScriptInterface* pScriptInterface = ScriptInterface::GetScriptInterfaceAndCBData(cx)->pScriptInterface;
  56
  57         IGUIObject* e = ScriptInterface::GetPrivate<IGUIObject>(cx, obj, &JSI_IGUIObject::JSI_class);
  58         if (!e)
  59                 return false;
  60
  61         JS::RootedValue idval(cx);
  62         if (!JS_IdToValue(cx, id, &idval))
  63                 return false;
  64
  65         std::string propName;
  66         if (!ScriptInterface::FromJSVal(cx, idval, propName))
  67                 return false;
  68
  69         // Skip registered functions and inherited properties
  70         // including JSInterfaces of derived classes
  71         if (propName == "constructor" ||
  72                 propName == "prototype"   ||
  73                 propName == "toString"    ||
  74                 propName == "toJSON"      ||
  75                 propName == "focus"       ||
  76                 propName == "blur"        ||
  77                 propName == "getTextSize" ||
  78                 propName == "getComputedSize"
  79            )
  80                 return true;
  81
  82         // Use onWhatever to access event handlers
  83         if (propName.substr(0, 2) == "on")
  84         {
  85                 CStr eventName(CStr(propName.substr(2)).LowerCase());
  86                 std::map<CStr, JS::Heap<JSObject*>>::iterator it = e->m_ScriptHandlers.find(eventName);
  87                 if (it == e->m_ScriptHandlers.end())
  88                         vp.setNull();
  89                 else
  90                         vp.setObject(*it->second.get());
  91                 return true;
  92         }
  93
  94         if (propName == "parent")
  95         {
  96                 IGUIObject* parent = e->GetParent();
  97
  98                 if (parent)
  99                         vp.set(JS::ObjectValue(*parent->GetJSObject()));
 100                 else
 101                         vp.set(JS::NullValue());
 102
 103                 return true;
 104         }
 105         else if (propName == "children")
 106         {
 107                 ScriptInterface::CreateArray(cx, vp);
 108
 109                 for (size_t i = 0; i < e->m_Children.size(); ++i)
 110                         pScriptInterface->SetPropertyInt(vp, i, e->m_Children[i]);
 111
 112                 return true;
 113         }
 114         else if (propName == "name")
 115         {
 116                 ScriptInterface::ToJSVal(cx, vp, e->GetName());
 117                 return true;
 118         }
 119         else if (e->SettingExists(propName))
 120         {
 121                 e->m_Settings[propName]->ToJSVal(cx, vp);
 122                 return true;
 123         }
 124
 125         JS_ReportError(cx, "Property '%s' does not exist!", propName.c_str());
 126         return false;
 127 }
 128
 129 bool JSI_IGUIObject::setProperty(JSContext* cx, JS::HandleObject obj, JS::HandleId id, JS::MutableHandleValue vp, JS::ObjectOpResult& result)
 130 {
 131         IGUIObject* e = ScriptInterface::GetPrivate<IGUIObject>(cx, obj, &JSI_IGUIObject::JSI_class);
 132         if (!e)
 133                 return result.fail(JSMSG_NOT_NONNULL_OBJECT);
 134
 135         JSAutoRequest rq(cx);
 136         JS::RootedValue idval(cx);
 137         if (!JS_IdToValue(cx, id, &idval))
 138                 return result.fail(JSMSG_NOT_NONNULL_OBJECT);
 139
 140         std::string propName;
 141         if (!ScriptInterface::FromJSVal(cx, idval, propName))
 142                 return result.fail(JSMSG_UNDEFINED_PROP);
 143
 144         if (propName == "name")
 145         {
 146                 std::string value;
 147                 if (!ScriptInterface::FromJSVal(cx, vp, value))
 148                         return result.fail(JSMSG_UNDEFINED_PROP);
 149                 e->SetName(value);
 150                 return result.succeed();
 151         }
 152
 153         JS::RootedObject vpObj(cx);
 154         if (vp.isObject())
 155                 vpObj = &vp.toObject();
 156
 157         // Use onWhatever to set event handlers
 158         if (propName.substr(0, 2) == "on")
 159         {
 160                 if (vp.isPrimitive() || vp.isNull() || !JS_ObjectIsFunction(cx, &vp.toObject()))
 161                 {
 162                         JS_ReportError(cx, "on- event-handlers must be functions");
 163                         return result.fail(JSMSG_NOT_FUNCTION);
 164                 }
 165
 166                 CStr eventName(CStr(propName.substr(2)).LowerCase());
 167                 e->SetScriptHandler(eventName, vpObj);
 168
 169                 return result.succeed();
 170         }
 171
 172         if (e->SettingExists(propName))
 173                 return e->m_Settings[propName]->FromJSVal(cx, vp, true) ? result.succeed() : result.fail(JSMSG_TYPE_ERR_BAD_ARGS);
 174
 175         JS_ReportError(cx, "Property '%s' does not exist!", propName.c_str());
 176         return result.fail(JSMSG_UNDEFINED_PROP);
 177 }
 178
 179 bool JSI_IGUIObject::deleteProperty(JSContext* cx, JS::HandleObject obj, JS::HandleId id, JS::ObjectOpResult& result)
 180 {
 181         IGUIObject* e = ScriptInterface::GetPrivate<IGUIObject>(cx, obj, &JSI_IGUIObject::JSI_class);
 182         if (!e)
 183                 return result.fail(JSMSG_NOT_NONNULL_OBJECT);
 184
 185         JSAutoRequest rq(cx);
 186         JS::RootedValue idval(cx);
 187         if (!JS_IdToValue(cx, id, &idval))
 188                 return result.fail(JSMSG_NOT_NONNULL_OBJECT);
 189
 190         std::string propName;
 191         if (!ScriptInterface::FromJSVal(cx, idval, propName))
 192                 return result.fail(JSMSG_UNDEFINED_PROP);
 193
 194         // event handlers
 195         if (propName.substr(0, 2) == "on")
 196         {
 197                 CStr eventName(CStr(propName.substr(2)).LowerCase());
 198                 e->UnsetScriptHandler(eventName);
 199                 return result.succeed();
 200         }
 201
 202         JS_ReportError(cx, "Only event handlers can be deleted from GUI objects!");
 203         return result.fail(JSMSG_UNDEFINED_PROP);
 204 }
 205
 206 bool JSI_IGUIObject::toString(JSContext* cx, uint argc, JS::Value* vp)
 207 {
 208         // No JSAutoRequest needed for these calls
 209         JS::CallArgs args = JS::CallArgsFromVp(argc, vp);
 210         IGUIObject* e = ScriptInterface::GetPrivate<IGUIObject>(cx, args, &JSI_IGUIObject::JSI_class);
 211         if (!e)
 212                 return false;
 213
 214         ScriptInterface::ToJSVal(cx, args.rval(), "[GUIObject: " + e->GetName() + "]");
 215         return true;
 216 }
 217
 218 bool JSI_IGUIObject::focus(JSContext* cx, uint argc, JS::Value* vp)
 219 {
 220         // No JSAutoRequest needed for these calls
 221         JS::CallArgs args = JS::CallArgsFromVp(argc, vp);
 222         IGUIObject* e = ScriptInterface::GetPrivate<IGUIObject>(cx, args, &JSI_IGUIObject::JSI_class);
 223         if (!e)
 224                 return false;
 225
 226         e->GetGUI().SetFocusedObject(e);
 227         args.rval().setUndefined();
 228         return true;
 229 }
 230
 231 bool JSI_IGUIObject::blur(JSContext* cx, uint argc, JS::Value* vp)
 232 {
 233         // No JSAutoRequest needed for these calls
 234         JS::CallArgs args = JS::CallArgsFromVp(argc, vp);
 235         IGUIObject* e = ScriptInterface::GetPrivate<IGUIObject>(cx, args, &JSI_IGUIObject::JSI_class);
 236         if (!e)
 237                 return false;
 238
 239         e->GetGUI().SetFocusedObject(nullptr);
 240         args.rval().setUndefined();
 241         return true;
 242 }
 243
 244 bool JSI_IGUIObject::getComputedSize(JSContext* cx, uint argc, JS::Value* vp)
 245 {
 246         JSAutoRequest rq(cx);
 247         JS::CallArgs args = JS::CallArgsFromVp(argc, vp);
 248
 249         IGUIObject* e = ScriptInterface::GetPrivate<IGUIObject>(cx, args, &JSI_IGUIObject::JSI_class);
 250         if (!e)
 251                 return false;
 252
 253         e->UpdateCachedSize();
 254         ScriptInterface::ToJSVal(cx, args.rval(), e->m_CachedActualSize);
 255
 256         return true;
 257 }