John Abd-El-Malek | 5110c47 | 2014-05-17 22:33:34 -0700 | [diff] [blame] | 1 | // Copyright 2014 PDFium Authors. All rights reserved. |
| 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
Tom Sepez | 2311b78 | 2015-02-23 10:22:51 -0800 | [diff] [blame] | 4 | |
John Abd-El-Malek | 5110c47 | 2014-05-17 22:33:34 -0700 | [diff] [blame] | 5 | // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com |
| 6 | |
Tom Sepez | ba038bc | 2015-10-08 12:03:00 -0700 | [diff] [blame] | 7 | // FXJS_V8 is a layer that makes it easier to define native objects in V8, but |
| 8 | // has no knowledge of PDF-specific native objects. It could in theory be used |
| 9 | // to implement other sets of native objects. |
| 10 | |
| 11 | // PDFium code should include this file rather than including V8 headers |
| 12 | // directly. |
Tom Sepez | 9a3f812 | 2015-04-07 15:35:48 -0700 | [diff] [blame] | 13 | |
Tom Sepez | 19922bb | 2015-05-28 13:23:12 -0700 | [diff] [blame] | 14 | #ifndef FPDFSDK_INCLUDE_JSAPI_FXJS_V8_H_ |
| 15 | #define FPDFSDK_INCLUDE_JSAPI_FXJS_V8_H_ |
John Abd-El-Malek | 5110c47 | 2014-05-17 22:33:34 -0700 | [diff] [blame] | 16 | |
| 17 | #include <v8.h> |
Lei Zhang | a688a04 | 2015-11-09 13:57:49 -0800 | [diff] [blame] | 18 | |
Lei Zhang | d88a364 | 2015-11-10 09:38:57 -0800 | [diff] [blame] | 19 | #include <vector> |
| 20 | |
| 21 | #include "core/include/fxcrt/fx_string.h" |
| 22 | |
| 23 | class CFXJS_ObjDefinition; |
Tom Sepez | ed7b2b5 | 2015-09-22 08:36:17 -0700 | [diff] [blame] | 24 | |
Tom Sepez | 3342090 | 2015-10-13 15:00:10 -0700 | [diff] [blame] | 25 | // FXJS_V8 places no restrictions on these two classes; it merely passes them |
| 26 | // on to caller-provided methods. |
| 27 | class IJS_Context; // A description of the event that caused JS execution. |
| 28 | class IJS_Runtime; // A native runtime, typically owns the v8::Context. |
Tom Sepez | ed7b2b5 | 2015-09-22 08:36:17 -0700 | [diff] [blame] | 29 | |
| 30 | // FXJS_V8 places no interpreation on this calass; it merely passes it |
| 31 | // along to XFA. |
| 32 | class CFXJSE_RuntimeData; |
John Abd-El-Malek | 5110c47 | 2014-05-17 22:33:34 -0700 | [diff] [blame] | 33 | |
Nico Weber | 9d8ec5a | 2015-08-04 13:00:21 -0700 | [diff] [blame] | 34 | enum FXJSOBJTYPE { |
Tom Sepez | cd56a7d | 2015-10-06 11:45:28 -0700 | [diff] [blame] | 35 | FXJSOBJTYPE_DYNAMIC = 0, // Created by native method and returned to JS. |
| 36 | FXJSOBJTYPE_STATIC, // Created by init and hung off of global object. |
| 37 | FXJSOBJTYPE_GLOBAL, // The global object itself (may only appear once). |
John Abd-El-Malek | 5110c47 | 2014-05-17 22:33:34 -0700 | [diff] [blame] | 38 | }; |
| 39 | |
Nico Weber | 9d8ec5a | 2015-08-04 13:00:21 -0700 | [diff] [blame] | 40 | struct FXJSErr { |
| 41 | const wchar_t* message; |
| 42 | const wchar_t* srcline; |
| 43 | unsigned linnum; |
John Abd-El-Malek | 5110c47 | 2014-05-17 22:33:34 -0700 | [diff] [blame] | 44 | }; |
| 45 | |
Tom Sepez | ed7b2b5 | 2015-09-22 08:36:17 -0700 | [diff] [blame] | 46 | class FXJS_PerIsolateData { |
| 47 | public: |
| 48 | static void SetUp(v8::Isolate* pIsolate); |
| 49 | static FXJS_PerIsolateData* Get(v8::Isolate* pIsolate); |
| 50 | |
Lei Zhang | d88a364 | 2015-11-10 09:38:57 -0800 | [diff] [blame] | 51 | std::vector<CFXJS_ObjDefinition*> m_ObjectDefnArray; |
Tom Sepez | ed7b2b5 | 2015-09-22 08:36:17 -0700 | [diff] [blame] | 52 | CFXJSE_RuntimeData* m_pFXJSERuntimeData; |
| 53 | |
| 54 | protected: |
Tom Sepez | a25fd09 | 2015-09-28 09:06:03 -0700 | [diff] [blame] | 55 | FXJS_PerIsolateData() : m_pFXJSERuntimeData(nullptr) {} |
Tom Sepez | ed7b2b5 | 2015-09-22 08:36:17 -0700 | [diff] [blame] | 56 | }; |
| 57 | |
Tom Sepez | 142165e | 2015-09-11 13:21:50 -0700 | [diff] [blame] | 58 | extern const wchar_t kFXJSValueNameString[]; |
| 59 | extern const wchar_t kFXJSValueNameNumber[]; |
| 60 | extern const wchar_t kFXJSValueNameBoolean[]; |
| 61 | extern const wchar_t kFXJSValueNameDate[]; |
| 62 | extern const wchar_t kFXJSValueNameObject[]; |
| 63 | extern const wchar_t kFXJSValueNameFxobj[]; |
| 64 | extern const wchar_t kFXJSValueNameNull[]; |
| 65 | extern const wchar_t kFXJSValueNameUndefined[]; |
John Abd-El-Malek | 5110c47 | 2014-05-17 22:33:34 -0700 | [diff] [blame] | 66 | |
John Abd-El-Malek | 5110c47 | 2014-05-17 22:33:34 -0700 | [diff] [blame] | 67 | |
Tom Sepez | 39bfe12 | 2015-09-17 15:25:23 -0700 | [diff] [blame] | 68 | class FXJS_ArrayBufferAllocator : public v8::ArrayBuffer::Allocator { |
Tom Sepez | 7d0fcbf | 2015-09-15 15:30:34 -0700 | [diff] [blame] | 69 | void* Allocate(size_t length) override; |
| 70 | void* AllocateUninitialized(size_t length) override; |
| 71 | void Free(void* data, size_t length) override; |
| 72 | }; |
| 73 | |
Tom Sepez | 3342090 | 2015-10-13 15:00:10 -0700 | [diff] [blame] | 74 | using FXJS_CONSTRUCTOR = void (*)(IJS_Runtime* cc, v8::Local<v8::Object> obj); |
Tom Sepez | 39bfe12 | 2015-09-17 15:25:23 -0700 | [diff] [blame] | 75 | using FXJS_DESTRUCTOR = void (*)(v8::Local<v8::Object> obj); |
| 76 | |
| 77 | // Call before making FXJS_PrepareIsolate call. |
Tom Sepez | a72e8e2 | 2015-10-07 10:17:53 -0700 | [diff] [blame] | 78 | void FXJS_Initialize(unsigned int embedderDataSlot, v8::Isolate* pIsolate); |
Tom Sepez | 39bfe12 | 2015-09-17 15:25:23 -0700 | [diff] [blame] | 79 | void FXJS_Release(); |
| 80 | |
Tom Sepez | a72e8e2 | 2015-10-07 10:17:53 -0700 | [diff] [blame] | 81 | // Gets the global isolate set by FXJS_Initialize(), or makes a new one each |
| 82 | // time if there is no such isolate. Returns true if a new isolate had to be |
| 83 | // created. |
| 84 | bool FXJS_GetIsolate(v8::Isolate** pResultIsolate); |
| 85 | |
Lei Zhang | 3fa115b | 2015-10-08 12:04:47 -0700 | [diff] [blame] | 86 | // Get the global isolate's ref count. |
| 87 | size_t FXJS_GlobalIsolateRefCount(); |
| 88 | |
Tom Sepez | 39bfe12 | 2015-09-17 15:25:23 -0700 | [diff] [blame] | 89 | // Call before making FXJS_Define* calls. Resources allocated here are cleared |
| 90 | // as part of FXJS_ReleaseRuntime(). |
| 91 | void FXJS_PrepareIsolate(v8::Isolate* pIsolate); |
John Abd-El-Malek | 5110c47 | 2014-05-17 22:33:34 -0700 | [diff] [blame] | 92 | |
Tom Sepez | 7d0fcbf | 2015-09-15 15:30:34 -0700 | [diff] [blame] | 93 | // Call before making JS_Define* calls. Resources allocated here are cleared |
| 94 | // as part of JS_ReleaseRuntime(). |
| 95 | void JS_PrepareIsolate(v8::Isolate* pIsolate); |
| 96 | |
Tom Sepez | 142165e | 2015-09-11 13:21:50 -0700 | [diff] [blame] | 97 | // Always returns a valid, newly-created objDefnID. |
Tom Sepez | 39bfe12 | 2015-09-17 15:25:23 -0700 | [diff] [blame] | 98 | int FXJS_DefineObj(v8::Isolate* pIsolate, |
| 99 | const wchar_t* sObjName, |
| 100 | FXJSOBJTYPE eObjType, |
| 101 | FXJS_CONSTRUCTOR pConstructor, |
| 102 | FXJS_DESTRUCTOR pDestructor); |
Tom Sepez | 142165e | 2015-09-11 13:21:50 -0700 | [diff] [blame] | 103 | |
Tom Sepez | 39bfe12 | 2015-09-17 15:25:23 -0700 | [diff] [blame] | 104 | void FXJS_DefineObjMethod(v8::Isolate* pIsolate, |
Tom Sepez | 142165e | 2015-09-11 13:21:50 -0700 | [diff] [blame] | 105 | int nObjDefnID, |
Tom Sepez | 39bfe12 | 2015-09-17 15:25:23 -0700 | [diff] [blame] | 106 | const wchar_t* sMethodName, |
| 107 | v8::FunctionCallback pMethodCall); |
| 108 | void FXJS_DefineObjProperty(v8::Isolate* pIsolate, |
| 109 | int nObjDefnID, |
| 110 | const wchar_t* sPropName, |
| 111 | v8::AccessorGetterCallback pPropGet, |
| 112 | v8::AccessorSetterCallback pPropPut); |
| 113 | void FXJS_DefineObjAllProperties(v8::Isolate* pIsolate, |
| 114 | int nObjDefnID, |
| 115 | v8::NamedPropertyQueryCallback pPropQurey, |
| 116 | v8::NamedPropertyGetterCallback pPropGet, |
| 117 | v8::NamedPropertySetterCallback pPropPut, |
| 118 | v8::NamedPropertyDeleterCallback pPropDel); |
| 119 | void FXJS_DefineObjConst(v8::Isolate* pIsolate, |
| 120 | int nObjDefnID, |
| 121 | const wchar_t* sConstName, |
| 122 | v8::Local<v8::Value> pDefault); |
| 123 | void FXJS_DefineGlobalMethod(v8::Isolate* pIsolate, |
| 124 | const wchar_t* sMethodName, |
| 125 | v8::FunctionCallback pMethodCall); |
| 126 | void FXJS_DefineGlobalConst(v8::Isolate* pIsolate, |
| 127 | const wchar_t* sConstName, |
| 128 | v8::Local<v8::Value> pDefault); |
John Abd-El-Malek | 5110c47 | 2014-05-17 22:33:34 -0700 | [diff] [blame] | 129 | |
Tom Sepez | 39bfe12 | 2015-09-17 15:25:23 -0700 | [diff] [blame] | 130 | // Called after FXJS_Define* calls made. |
| 131 | void FXJS_InitializeRuntime(v8::Isolate* pIsolate, |
Tom Sepez | 3342090 | 2015-10-13 15:00:10 -0700 | [diff] [blame] | 132 | IJS_Runtime* pIRuntime, |
Tom Sepez | 39bfe12 | 2015-09-17 15:25:23 -0700 | [diff] [blame] | 133 | v8::Global<v8::Context>& v8PersistentContext); |
| 134 | void FXJS_ReleaseRuntime(v8::Isolate* pIsolate, |
| 135 | v8::Global<v8::Context>& v8PersistentContext); |
Tom Sepez | 4f4603c | 2015-11-10 15:03:12 -0800 | [diff] [blame^] | 136 | |
| 137 | // Called as part of FXJS_InitializeRuntime, exposed so PDF can make its |
| 138 | // own contexts compatible with XFA or vice versa. |
| 139 | void FXJS_SetRuntimeForV8Context(v8::Local<v8::Context> v8Context, |
| 140 | IJS_Runtime* pIRuntime); |
| 141 | |
| 142 | IJS_Runtime* FXJS_GetRuntimeFromV8Context(v8::Local<v8::Context> v8Context); |
Tom Sepez | 7d0fcbf | 2015-09-15 15:30:34 -0700 | [diff] [blame] | 143 | |
Tom Sepez | 39bfe12 | 2015-09-17 15:25:23 -0700 | [diff] [blame] | 144 | // Called after FXJS_InitializeRuntime call made. |
| 145 | int FXJS_Execute(v8::Isolate* pIsolate, |
Tom Sepez | ba038bc | 2015-10-08 12:03:00 -0700 | [diff] [blame] | 146 | IJS_Context* pJSContext, |
Tom Sepez | 39bfe12 | 2015-09-17 15:25:23 -0700 | [diff] [blame] | 147 | const wchar_t* script, |
Tom Sepez | 39bfe12 | 2015-09-17 15:25:23 -0700 | [diff] [blame] | 148 | FXJSErr* perror); |
Tom Sepez | 7d0fcbf | 2015-09-15 15:30:34 -0700 | [diff] [blame] | 149 | |
Tom Sepez | 39bfe12 | 2015-09-17 15:25:23 -0700 | [diff] [blame] | 150 | v8::Local<v8::Object> FXJS_NewFxDynamicObj(v8::Isolate* pIsolate, |
Tom Sepez | 3342090 | 2015-10-13 15:00:10 -0700 | [diff] [blame] | 151 | IJS_Runtime* pJSContext, |
Tom Sepez | 39bfe12 | 2015-09-17 15:25:23 -0700 | [diff] [blame] | 152 | int nObjDefnID); |
| 153 | v8::Local<v8::Object> FXJS_GetThisObj(v8::Isolate* pIsolate); |
| 154 | int FXJS_GetObjDefnID(v8::Local<v8::Object> pObj); |
Tom Sepez | 39bfe12 | 2015-09-17 15:25:23 -0700 | [diff] [blame] | 155 | const wchar_t* FXJS_GetTypeof(v8::Local<v8::Value> pObj); |
John Abd-El-Malek | 5110c47 | 2014-05-17 22:33:34 -0700 | [diff] [blame] | 156 | |
Tom Sepez | 39bfe12 | 2015-09-17 15:25:23 -0700 | [diff] [blame] | 157 | void FXJS_SetPrivate(v8::Isolate* pIsolate, |
| 158 | v8::Local<v8::Object> pObj, |
| 159 | void* p); |
Tom Sepez | 39bfe12 | 2015-09-17 15:25:23 -0700 | [diff] [blame] | 160 | void* FXJS_GetPrivate(v8::Isolate* pIsolate, v8::Local<v8::Object> pObj); |
Tom Sepez | 39bfe12 | 2015-09-17 15:25:23 -0700 | [diff] [blame] | 161 | void FXJS_FreePrivate(void* p); |
| 162 | void FXJS_FreePrivate(v8::Local<v8::Object> pObj); |
John Abd-El-Malek | 5110c47 | 2014-05-17 22:33:34 -0700 | [diff] [blame] | 163 | |
Tom Sepez | 39bfe12 | 2015-09-17 15:25:23 -0700 | [diff] [blame] | 164 | void FXJS_Error(v8::Isolate* isolate, const CFX_WideString& message); |
| 165 | v8::Local<v8::String> FXJS_WSToJSString(v8::Isolate* pIsolate, |
| 166 | const wchar_t* PropertyName, |
| 167 | int Len = -1); |
| 168 | |
| 169 | v8::Local<v8::Value> FXJS_GetObjectElement(v8::Isolate* pIsolate, |
| 170 | v8::Local<v8::Object> pObj, |
| 171 | const wchar_t* PropertyName); |
| 172 | v8::Local<v8::Array> FXJS_GetObjectElementNames(v8::Isolate* pIsolate, |
| 173 | v8::Local<v8::Object> pObj); |
| 174 | |
| 175 | v8::Local<v8::Value> FXJS_GetArrayElement(v8::Isolate* pIsolate, |
| 176 | v8::Local<v8::Array> pArray, |
| 177 | unsigned index); |
| 178 | unsigned FXJS_GetArrayLength(v8::Local<v8::Array> pArray); |
| 179 | |
| 180 | void FXJS_PutObjectString(v8::Isolate* pIsolate, |
| 181 | v8::Local<v8::Object> pObj, |
| 182 | const wchar_t* PropertyName, |
| 183 | const wchar_t* sValue); |
| 184 | void FXJS_PutObjectNumber(v8::Isolate* pIsolate, |
| 185 | v8::Local<v8::Object> pObj, |
| 186 | const wchar_t* PropertyName, |
| 187 | int nValue); |
| 188 | void FXJS_PutObjectNumber(v8::Isolate* pIsolate, |
| 189 | v8::Local<v8::Object> pObj, |
| 190 | const wchar_t* PropertyName, |
| 191 | float fValue); |
| 192 | void FXJS_PutObjectNumber(v8::Isolate* pIsolate, |
| 193 | v8::Local<v8::Object> pObj, |
| 194 | const wchar_t* PropertyName, |
| 195 | double dValue); |
| 196 | void FXJS_PutObjectBoolean(v8::Isolate* pIsolate, |
| 197 | v8::Local<v8::Object> pObj, |
| 198 | const wchar_t* PropertyName, |
| 199 | bool bValue); |
| 200 | void FXJS_PutObjectObject(v8::Isolate* pIsolate, |
| 201 | v8::Local<v8::Object> pObj, |
| 202 | const wchar_t* PropertyName, |
| 203 | v8::Local<v8::Object> pPut); |
| 204 | void FXJS_PutObjectNull(v8::Isolate* pIsolate, |
| 205 | v8::Local<v8::Object> pObj, |
| 206 | const wchar_t* PropertyName); |
| 207 | unsigned FXJS_PutArrayElement(v8::Isolate* pIsolate, |
| 208 | v8::Local<v8::Array> pArray, |
| 209 | unsigned index, |
| 210 | v8::Local<v8::Value> pValue); |
| 211 | |
| 212 | v8::Local<v8::Array> FXJS_NewArray(v8::Isolate* pIsolate); |
| 213 | v8::Local<v8::Value> FXJS_NewNumber(v8::Isolate* pIsolate, int number); |
| 214 | v8::Local<v8::Value> FXJS_NewNumber(v8::Isolate* pIsolate, double number); |
| 215 | v8::Local<v8::Value> FXJS_NewNumber(v8::Isolate* pIsolate, float number); |
| 216 | v8::Local<v8::Value> FXJS_NewBoolean(v8::Isolate* pIsolate, bool b); |
| 217 | v8::Local<v8::Value> FXJS_NewObject(v8::Isolate* pIsolate, |
| 218 | v8::Local<v8::Object> pObj); |
| 219 | v8::Local<v8::Value> FXJS_NewObject2(v8::Isolate* pIsolate, |
| 220 | v8::Local<v8::Array> pObj); |
| 221 | v8::Local<v8::Value> FXJS_NewString(v8::Isolate* pIsolate, |
| 222 | const wchar_t* string); |
| 223 | v8::Local<v8::Value> FXJS_NewNull(); |
| 224 | v8::Local<v8::Value> FXJS_NewDate(v8::Isolate* pIsolate, double d); |
| 225 | |
| 226 | int FXJS_ToInt32(v8::Isolate* pIsolate, v8::Local<v8::Value> pValue); |
| 227 | bool FXJS_ToBoolean(v8::Isolate* pIsolate, v8::Local<v8::Value> pValue); |
| 228 | double FXJS_ToNumber(v8::Isolate* pIsolate, v8::Local<v8::Value> pValue); |
| 229 | v8::Local<v8::Object> FXJS_ToObject(v8::Isolate* pIsolate, |
| 230 | v8::Local<v8::Value> pValue); |
| 231 | CFX_WideString FXJS_ToString(v8::Isolate* pIsolate, |
| 232 | v8::Local<v8::Value> pValue); |
| 233 | v8::Local<v8::Array> FXJS_ToArray(v8::Isolate* pIsolate, |
Nico Weber | 9d8ec5a | 2015-08-04 13:00:21 -0700 | [diff] [blame] | 234 | v8::Local<v8::Value> pValue); |
Tom Sepez | 39bfe12 | 2015-09-17 15:25:23 -0700 | [diff] [blame] | 235 | void FXJS_ValueCopy(v8::Local<v8::Value>& pTo, v8::Local<v8::Value> pFrom); |
John Abd-El-Malek | 5110c47 | 2014-05-17 22:33:34 -0700 | [diff] [blame] | 236 | |
Tom Sepez | 19922bb | 2015-05-28 13:23:12 -0700 | [diff] [blame] | 237 | #endif // FPDFSDK_INCLUDE_JSAPI_FXJS_V8_H_ |