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 length_s;
  50 extern JSStringRef message_s;
  51 extern JSStringRef name_s;
  52 extern JSStringRef pop_s;
  53 extern JSStringRef prototype_s;
  54 extern JSStringRef push_s;
  55 extern JSStringRef splice_s;
  56 extern JSStringRef toCYON_s;
  57 extern JSStringRef toJSON_s;
  58 extern JSStringRef toPointer_s;
  59 extern JSStringRef toString_s;
  60 extern JSStringRef weak_s;
  61
  62 void CYInitializeDynamic();
  63 JSGlobalContextRef CYGetJSContext();
  64 JSObjectRef CYGetGlobalObject(JSContextRef context);
  65
  66 extern "C" void CYSetupContext(JSGlobalContextRef context);
  67 const char *CYExecute(JSContextRef context, CYPool &pool, CYUTF8String code);
  68
  69 #ifndef __ANDROID__
  70 void CYCancel();
  71 #endif
  72
  73 void CYSetArgs(const char *argv0, const char *script, int argc, const char *argv[]);
  74
  75 bool CYCastBool(JSContextRef context, JSValueRef value);
  76 double CYCastDouble(JSContextRef context, JSValueRef value);
  77
  78 bool CYIsEqual(JSContextRef context, JSValueRef lhs, JSValueRef rhs);
  79 bool CYIsStrictEqual(JSContextRef context, JSValueRef lhs, JSValueRef rhs);
  80
  81 CYUTF16String CYCastUTF16String(JSStringRef value);
  82 CYUTF8String CYPoolUTF8String(CYPool &pool, JSContextRef context, JSStringRef value);
  83 const char *CYPoolCString(CYPool &pool, JSContextRef context, JSStringRef value);
  84
  85 bool CYHasProperty(JSContextRef context, JSObjectRef object, JSStringRef name);
  86 JSValueRef CYGetProperty(JSContextRef context, JSObjectRef object, size_t index);
  87 JSValueRef CYGetProperty(JSContextRef context, JSObjectRef object, JSStringRef name);
  88
  89 void CYSetProperty(JSContextRef context, JSObjectRef object, size_t index, JSValueRef value);
  90 void CYSetProperty(JSContextRef context, JSObjectRef object, JSStringRef name, JSValueRef value, JSPropertyAttributes attributes = kJSPropertyAttributeNone);
  91 void CYSetProperty(JSContextRef context, JSObjectRef object, JSStringRef name, JSValueRef (*callback)(JSContextRef, JSObjectRef, JSObjectRef, size_t, const JSValueRef[], JSValueRef *), JSPropertyAttributes attributes = kJSPropertyAttributeNone);
  92
  93 JSObjectRef CYGetPrototype(JSContextRef context, JSObjectRef object);
  94 void CYSetPrototype(JSContextRef context, JSObjectRef object, JSValueRef prototype);
  95
  96 JSValueRef CYGetCachedValue(JSContextRef context, JSStringRef name);
  97 JSObjectRef CYGetCachedObject(JSContextRef context, JSStringRef name);
  98
  99 JSValueRef CYCastJSValue(JSContextRef context, bool value);
 100 JSValueRef CYCastJSValue(JSContextRef context, double value);
 101
 102 JSValueRef CYCastJSValue(JSContextRef context, signed short int value);
 103 JSValueRef CYCastJSValue(JSContextRef context, unsigned short int value);
 104 JSValueRef CYCastJSValue(JSContextRef context, signed int value);
 105 JSValueRef CYCastJSValue(JSContextRef context, unsigned int value);
 106 JSValueRef CYCastJSValue(JSContextRef context, signed long int value);
 107 JSValueRef CYCastJSValue(JSContextRef context, unsigned long int value);
 108 JSValueRef CYCastJSValue(JSContextRef context, signed long long int value);
 109 JSValueRef CYCastJSValue(JSContextRef context, unsigned long long int value);
 110
 111 JSValueRef CYCastJSValue(JSContextRef context, JSStringRef value);
 112 JSValueRef CYCastJSValue(JSContextRef context, const char *value);
 113
 114 JSObjectRef CYCastJSObject(JSContextRef context, JSValueRef value);
 115 JSValueRef CYJSUndefined(JSContextRef context);
 116 JSValueRef CYJSNull(JSContextRef context);
 117
 118 void *CYCastPointerEx_(JSContextRef context, JSObjectRef value);
 119
 120 template <typename Type_>
 121 _finline Type_ CYCastPointerEx(JSContextRef context, JSObjectRef value) {
 122     return reinterpret_cast<Type_>(CYCastPointerEx_(context, value));
 123 }
 124
 125 void *CYCastPointer_(JSContextRef context, JSValueRef value, bool *guess = NULL);
 126
 127 template <typename Type_>
 128 _finline Type_ CYCastPointer(JSContextRef context, JSValueRef value, bool *guess = NULL) {
 129     return reinterpret_cast<Type_>(CYCastPointer_(context, value, guess));
 130 }
 131
 132 void CYCallFunction(CYPool &pool, JSContextRef context, ffi_cif *cif, void (*function)(), void *value, void **values);
 133 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)());
 134
 135 bool CYIsCallable(JSContextRef context, JSValueRef value);
 136 JSValueRef CYCallAsFunction(JSContextRef context, JSObjectRef function, JSObjectRef _this, size_t count, const JSValueRef arguments[]);
 137
 138 const char *CYPoolCCYON(CYPool &pool, JSContextRef context, JSObjectRef object, std::set<void *> &objects);
 139 std::set<void *> *CYCastObjects(JSContextRef context, JSObjectRef _this, size_t count, const JSValueRef arguments[]);
 140
 141 struct CYHook {
 142     void *(*ExecuteStart)(JSContextRef);
 143     void (*ExecuteEnd)(JSContextRef, void *);
 144
 145     void (*CallFunction)(CYPool &, JSContextRef, ffi_cif *, void (*)(), void *, void **);
 146
 147     void (*Initialize)();
 148     void (*SetupContext)(JSContextRef);
 149
 150     void *(*CastSymbol)(const char *);
 151 };
 152
 153 struct CYRegisterHook {
 154     CYRegisterHook(CYHook *hook);
 155 };
 156
 157 JSObjectRef CYMakePointer(JSContextRef context, void *pointer, const sig::Type &type, ffi_type *ffi, JSObjectRef owner);
 158
 159 JSObjectRef CYMakeType(JSContextRef context, const sig::Type &type);
 160
 161 void CYFinalize(JSObjectRef object);
 162
 163 JSObjectRef CYObjectMakeArray(JSContextRef context, size_t length, const JSValueRef values[]);
 164
 165 size_t CYArrayLength(JSContextRef context, JSObjectRef array);
 166 JSValueRef CYArrayGet(JSContextRef context, JSObjectRef array, size_t index);
 167
 168 void CYArrayPush(JSContextRef context, JSObjectRef array, size_t length, const JSValueRef arguments[]);
 169 void CYArrayPush(JSContextRef context, JSObjectRef array, JSValueRef value);
 170
 171 bool CYGetOffset(CYPool &pool, JSContextRef context, JSStringRef value, ssize_t &index);
 172
 173 const char *CYPoolCString(CYPool &pool, JSContextRef context, JSValueRef value);
 174
 175 JSStringRef CYCopyJSString(const char *value);
 176 JSStringRef CYCopyJSString(JSStringRef value);
 177 JSStringRef CYCopyJSString(CYUTF8String value);
 178 JSStringRef CYCopyJSString(const std::string &value);
 179 JSStringRef CYCopyJSString(CYUTF16String value);
 180 JSStringRef CYCopyJSString(JSContextRef context, JSValueRef value);
 181
 182 void CYGarbageCollect(JSContextRef context);
 183 void CYDestroyContext();
 184
 185 class CYJSString {
 186   private:
 187     JSStringRef string_;
 188
 189     void Clear_() {
 190         if (string_ != NULL)
 191             JSStringRelease(string_);
 192     }
 193
 194   public:
 195     CYJSString() :
 196         string_(NULL)
 197     {
 198     }
 199
 200     CYJSString(const CYJSString &rhs) :
 201         string_(CYCopyJSString(rhs.string_))
 202     {
 203     }
 204
 205     template <typename ...Args_>
 206     CYJSString(Args_ &&... args) :
 207         string_(CYCopyJSString(cy::Forward<Args_>(args)...))
 208     {
 209     }
 210
 211     CYJSString &operator =(const CYJSString &rhs) {
 212         Clear_();
 213         string_ = CYCopyJSString(rhs.string_);
 214         return *this;
 215     }
 216
 217     CYJSString &operator =(CYJSString &&rhs) {
 218         std::swap(string_, rhs.string_);
 219         return *this;
 220     }
 221
 222     ~CYJSString() {
 223         Clear_();
 224     }
 225
 226     void Clear() {
 227         Clear_();
 228         string_ = NULL;
 229     }
 230
 231     operator JSStringRef() const {
 232         return string_;
 233     }
 234 };
 235
 236 template <size_t Size_>
 237 class CYArrayBuilder {
 238   private:
 239     JSContextRef context_;
 240     JSObjectRef &array_;
 241     size_t size_;
 242     JSValueRef values_[Size_];
 243
 244     void flush() {
 245         if (array_ == NULL)
 246             array_ = CYObjectMakeArray(context_, size_, values_);
 247         else
 248             CYArrayPush(context_, array_, size_, values_);
 249     }
 250
 251   public:
 252     CYArrayBuilder(JSContextRef context, JSObjectRef &array) :
 253         context_(context),
 254         array_(array),
 255         size_(0)
 256     {
 257     }
 258
 259     ~CYArrayBuilder() {
 260         flush();
 261     }
 262
 263     void operator ()(JSValueRef value) {
 264         if (size_ == Size_) {
 265             flush();
 266             size_ = 0;
 267         }
 268
 269         values_[size_++] = value;
 270     }
 271 };
 272
 273 #ifdef __APPLE__
 274 #define _weak __attribute__((__weak_import__));
 275 #else
 276 #define _weak
 277 #endif
 278
 279 typedef struct OpaqueJSWeakObjectMap *JSWeakObjectMapRef;
 280 typedef void (*JSWeakMapDestroyedCallback)(JSWeakObjectMapRef map, void *data);
 281
 282 extern "C" JSWeakObjectMapRef JSWeakObjectMapCreate(JSContextRef ctx, void *data, JSWeakMapDestroyedCallback destructor) _weak;
 283 extern "C" void JSWeakObjectMapSet(JSContextRef ctx, JSWeakObjectMapRef map, void *key, JSObjectRef) _weak;
 284 extern "C" JSObjectRef JSWeakObjectMapGet(JSContextRef ctx, JSWeakObjectMapRef map, void *key) _weak;
 285 extern "C" bool JSWeakObjectMapClear(JSContextRef ctx, JSWeakObjectMapRef map, void *key, JSObjectRef object) _weak;
 286 extern "C" void JSWeakObjectMapRemove(JSContextRef ctx, JSWeakObjectMapRef map, void* key) _weak;
 287
 288 typedef bool (*JSShouldTerminateCallback)(JSContextRef ctx, void *context);
 289 extern "C" void JSContextGroupSetExecutionTimeLimit(JSContextGroupRef, double limit, JSShouldTerminateCallback, void *context) _weak;
 290
 291 #endif/*CYCRIPT_JAVASCRIPT_HPP*/