JavaScript.hpp

   1 /* Cycript - The Truly Universal Scripting Language
   2  * Copyright (C) 2009-2016  Jay Freeman (saurik)
   3 */
   4
   5 /* GNU Affero General Public License, Version 3 {{{ */
   6 /*
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 **/
  20 /* }}} */
  21
  22 #ifndef CYCRIPT_JAVASCRIPT_HPP
  23 #define CYCRIPT_JAVASCRIPT_HPP
  24
  25 #include <set>
  26 #include <string>
  27
  28 #include <JavaScriptCore/JSBase.h>
  29 #include <JavaScriptCore/JSContextRef.h>
  30 #include <JavaScriptCore/JSStringRef.h>
  31 #include <JavaScriptCore/JSObjectRef.h>
  32 #include <JavaScriptCore/JSValueRef.h>
  33
  34 #ifdef HAVE_FFI_FFI_H
  35 #include <ffi/ffi.h>
  36 #else
  37 #include <ffi.h>
  38 #endif
  39
  40 #include "Pooling.hpp"
  41 #include "String.hpp"
  42 #include "Utility.hpp"
  43
  44 extern JSStringRef Array_s;
  45 extern JSStringRef constructor_s;
  46 extern JSStringRef cy_s;
  47 extern JSStringRef cyi_s;
  48 extern JSStringRef cyt_s;
  49 extern JSStringRef cyt__s;
  50 extern JSStringRef length_s;
  51 extern JSStringRef message_s;
  52 extern JSStringRef name_s;
  53 extern JSStringRef pop_s;
  54 extern JSStringRef prototype_s;
  55 extern JSStringRef push_s;
  56 extern JSStringRef splice_s;
  57 extern JSStringRef toCYON_s;
  58 extern JSStringRef toJSON_s;
  59 extern JSStringRef toPointer_s;
  60 extern JSStringRef toString_s;
  61 extern JSStringRef weak_s;
  62
  63 void CYInitializeDynamic();
  64 JSGlobalContextRef CYGetJSContext();
  65 JSObjectRef CYGetGlobalObject(JSContextRef context);
  66
  67 extern "C" void CYSetupContext(JSGlobalContextRef context);
  68 const char *CYExecute(JSContextRef context, CYPool &pool, CYUTF8String code);
  69
  70 #ifndef __ANDROID__
  71 void CYCancel();
  72 #endif
  73
  74 void CYSetArgs(const char *argv0, const char *script, int argc, const char *argv[]);
  75
  76 bool CYCastBool(JSContextRef context, JSValueRef value);
  77 double CYCastDouble(JSContextRef context, JSValueRef value);
  78
  79 bool CYIsEqual(JSContextRef context, JSValueRef lhs, JSValueRef rhs);
  80 bool CYIsStrictEqual(JSContextRef context, JSValueRef lhs, JSValueRef rhs);
  81
  82 CYUTF16String CYCastUTF16String(JSStringRef value);
  83 CYUTF8String CYPoolUTF8String(CYPool &pool, JSContextRef context, JSStringRef value);
  84 const char *CYPoolCString(CYPool &pool, JSContextRef context, JSStringRef value);
  85
  86 bool CYHasProperty(JSContextRef context, JSObjectRef object, JSStringRef name);
  87 JSValueRef CYGetProperty(JSContextRef context, JSObjectRef object, size_t index);
  88 JSValueRef CYGetProperty(JSContextRef context, JSObjectRef object, JSStringRef name);
  89
  90 void CYSetProperty(JSContextRef context, JSObjectRef object, size_t index, JSValueRef value);
  91 void CYSetProperty(JSContextRef context, JSObjectRef object, JSStringRef name, JSValueRef value, JSPropertyAttributes attributes = kJSPropertyAttributeNone);
  92 void CYSetProperty(JSContextRef context, JSObjectRef object, JSStringRef name, JSValueRef (*callback)(JSContextRef, JSObjectRef, JSObjectRef, size_t, const JSValueRef[], JSValueRef *), JSPropertyAttributes attributes = kJSPropertyAttributeNone);
  93
  94 JSObjectRef CYGetPrototype(JSContextRef context, JSObjectRef object);
  95 void CYSetPrototype(JSContextRef context, JSObjectRef object, JSValueRef prototype);
  96
  97 JSValueRef CYGetCachedValue(JSContextRef context, JSStringRef name);
  98 JSObjectRef CYGetCachedObject(JSContextRef context, JSStringRef name);
  99
 100 JSValueRef CYCastJSValue(JSContextRef context, bool value);
 101 JSValueRef CYCastJSValue(JSContextRef context, double value);
 102
 103 JSValueRef CYCastJSValue(JSContextRef context, signed short int value);
 104 JSValueRef CYCastJSValue(JSContextRef context, unsigned short int value);
 105 JSValueRef CYCastJSValue(JSContextRef context, signed int value);
 106 JSValueRef CYCastJSValue(JSContextRef context, unsigned int value);
 107 JSValueRef CYCastJSValue(JSContextRef context, signed long int value);
 108 JSValueRef CYCastJSValue(JSContextRef context, unsigned long int value);
 109 JSValueRef CYCastJSValue(JSContextRef context, signed long long int value);
 110 JSValueRef CYCastJSValue(JSContextRef context, unsigned long long int value);
 111
 112 JSValueRef CYCastJSValue(JSContextRef context, JSStringRef value);
 113 JSValueRef CYCastJSValue(JSContextRef context, const char *value);
 114
 115 JSObjectRef CYCastJSObject(JSContextRef context, JSValueRef value);
 116 JSValueRef CYJSUndefined(JSContextRef context);
 117 JSValueRef CYJSNull(JSContextRef context);
 118
 119 void *CYCastPointerEx_(JSContextRef context, JSObjectRef value);
 120
 121 template <typename Type_>
 122 _finline Type_ CYCastPointerEx(JSContextRef context, JSObjectRef value) {
 123     return reinterpret_cast<Type_>(CYCastPointerEx_(context, value));
 124 }
 125
 126 void *CYCastPointer_(JSContextRef context, JSValueRef value, bool *guess = NULL);
 127
 128 template <typename Type_>
 129 _finline Type_ CYCastPointer(JSContextRef context, JSValueRef value, bool *guess = NULL) {
 130     return reinterpret_cast<Type_>(CYCastPointer_(context, value, guess));
 131 }
 132
 133 void CYCallFunction(CYPool &pool, JSContextRef context, ffi_cif *cif, void (*function)(), void *value, void **values);
 134 JSValueRef CYCallFunction(CYPool &pool, JSContextRef context, size_t setups, void *setup[], size_t count, const JSValueRef arguments[], bool initialize, bool variadic, const sig::Signature &signature, ffi_cif *cif, void (*function)());
 135
 136 bool CYIsCallable(JSContextRef context, JSValueRef value);
 137 JSValueRef CYCallAsFunction(JSContextRef context, JSObjectRef function, JSObjectRef _this, size_t count, const JSValueRef arguments[]);
 138
 139 const char *CYPoolCCYON(CYPool &pool, JSContextRef context, JSObjectRef object, std::set<void *> &objects);
 140 std::set<void *> *CYCastObjects(JSContextRef context, JSObjectRef _this, size_t count, const JSValueRef arguments[]);
 141
 142 struct CYHook {
 143     void *(*ExecuteStart)(JSContextRef);
 144     void (*ExecuteEnd)(JSContextRef, void *);
 145
 146     void (*CallFunction)(CYPool &, JSContextRef, ffi_cif *, void (*)(), void *, void **);
 147
 148     void (*Initialize)();
 149     void (*SetupContext)(JSContextRef);
 150
 151     void *(*CastSymbol)(const char *);
 152 };
 153
 154 struct CYRegisterHook {
 155     CYRegisterHook(CYHook *hook);
 156 };
 157
 158 JSObjectRef CYMakePointer(JSContextRef context, void *pointer, const sig::Type &type, ffi_type *ffi, JSObjectRef owner);
 159
 160 JSObjectRef CYMakeType(JSContextRef context, const sig::Type &type);
 161
 162 void CYFinalize(JSObjectRef object);
 163
 164 JSObjectRef CYObjectMakeArray(JSContextRef context, size_t length, const JSValueRef values[]);
 165
 166 size_t CYArrayLength(JSContextRef context, JSObjectRef array);
 167 JSValueRef CYArrayGet(JSContextRef context, JSObjectRef array, size_t index);
 168
 169 void CYArrayPush(JSContextRef context, JSObjectRef array, size_t length, const JSValueRef arguments[]);
 170 void CYArrayPush(JSContextRef context, JSObjectRef array, JSValueRef value);
 171
 172 bool CYGetOffset(CYPool &pool, JSContextRef context, JSStringRef value, ssize_t &index);
 173
 174 const char *CYPoolCString(CYPool &pool, JSContextRef context, JSValueRef value);
 175
 176 JSStringRef CYCopyJSString(const char *value);
 177 JSStringRef CYCopyJSString(JSStringRef value);
 178 JSStringRef CYCopyJSString(CYUTF8String value);
 179 JSStringRef CYCopyJSString(const std::string &value);
 180 JSStringRef CYCopyJSString(CYUTF16String value);
 181 JSStringRef CYCopyJSString(JSContextRef context, JSValueRef value);
 182
 183 void CYGarbageCollect(JSContextRef context);
 184 void CYDestroyContext();
 185
 186 class CYJSString {
 187   private:
 188     JSStringRef string_;
 189
 190     void Clear_() {
 191         if (string_ != NULL)
 192             JSStringRelease(string_);
 193     }
 194
 195   public:
 196     CYJSString() :
 197         string_(NULL)
 198     {
 199     }
 200
 201     CYJSString(const CYJSString &rhs) :
 202         string_(CYCopyJSString(rhs.string_))
 203     {
 204     }
 205
 206     template <typename ...Args_>
 207     CYJSString(Args_ &&... args) :
 208         string_(CYCopyJSString(cy::Forward<Args_>(args)...))
 209     {
 210     }
 211
 212     CYJSString &operator =(const CYJSString &rhs) {
 213         Clear_();
 214         string_ = CYCopyJSString(rhs.string_);
 215         return *this;
 216     }
 217
 218     CYJSString &operator =(CYJSString &&rhs) {
 219         std::swap(string_, rhs.string_);
 220         return *this;
 221     }
 222
 223     ~CYJSString() {
 224         Clear_();
 225     }
 226
 227     void Clear() {
 228         Clear_();
 229         string_ = NULL;
 230     }
 231
 232     operator JSStringRef() const {
 233         return string_;
 234     }
 235 };
 236
 237 template <size_t Size_>
 238 class CYArrayBuilder {
 239   private:
 240     JSContextRef context_;
 241     JSObjectRef &array_;
 242     size_t size_;
 243     JSValueRef values_[Size_];
 244
 245     void flush() {
 246         if (array_ == NULL)
 247             array_ = CYObjectMakeArray(context_, size_, values_);
 248         else
 249             CYArrayPush(context_, array_, size_, values_);
 250     }
 251
 252   public:
 253     CYArrayBuilder(JSContextRef context, JSObjectRef &array) :
 254         context_(context),
 255         array_(array),
 256         size_(0)
 257     {
 258     }
 259
 260     ~CYArrayBuilder() {
 261         flush();
 262     }
 263
 264     void operator ()(JSValueRef value) {
 265         if (size_ == Size_) {
 266             flush();
 267             size_ = 0;
 268         }
 269
 270         values_[size_++] = value;
 271     }
 272 };
 273
 274 #ifdef __APPLE__
 275 #define _weak __attribute__((__weak_import__));
 276 #else
 277 #define _weak
 278 #endif
 279
 280 typedef struct OpaqueJSWeakObjectMap *JSWeakObjectMapRef;
 281 typedef void (*JSWeakMapDestroyedCallback)(JSWeakObjectMapRef map, void *data);
 282
 283 extern "C" JSWeakObjectMapRef JSWeakObjectMapCreate(JSContextRef ctx, void *data, JSWeakMapDestroyedCallback destructor) _weak;
 284 extern "C" void JSWeakObjectMapSet(JSContextRef ctx, JSWeakObjectMapRef map, void *key, JSObjectRef) _weak;
 285 extern "C" JSObjectRef JSWeakObjectMapGet(JSContextRef ctx, JSWeakObjectMapRef map, void *key) _weak;
 286 extern "C" bool JSWeakObjectMapClear(JSContextRef ctx, JSWeakObjectMapRef map, void *key, JSObjectRef object) _weak;
 287 extern "C" void JSWeakObjectMapRemove(JSContextRef ctx, JSWeakObjectMapRef map, void* key) _weak;
 288
 289 typedef bool (*JSShouldTerminateCallback)(JSContextRef ctx, void *context);
 290 extern "C" void JSContextGroupSetExecutionTimeLimit(JSContextGroupRef, double limit, JSShouldTerminateCallback, void *context) _weak;
 291
 292 #endif/*CYCRIPT_JAVASCRIPT_HPP*/