Store object definition ID in each js_class.
[pdfium.git] / fpdfsdk / include / jsapi / fxjs_v8.h
index 7f23380..289a73e 100644 (file)
 // PDFium wrapper around V8 APIs. PDFium code should include this file rather
 // than including V8 headers directly.
 
-#ifndef FXJSAPI_H
-#define FXJSAPI_H
+#ifndef FPDFSDK_INCLUDE_JSAPI_FXJS_V8_H_
+#define FPDFSDK_INCLUDE_JSAPI_FXJS_V8_H_
 
 #include <v8.h>
-#include "../../../core/include/fxcrt/fx_string.h"  // For CFX_WideString
+#include "../../../core/include/fxcrt/fx_basic.h"
 
-typedef v8::Value                      JSValue;
-typedef v8::Handle<v8::Object> JSObject;
-typedef v8::Handle<v8::Object> JSFXObject;
+// FXJS_V8 places no interpretation on these two classes; it merely
+// passes them on to the caller-provided FXJS_CONSTRUCTORs.
+class IFXJS_Context;
+class IFXJS_Runtime;
 
-enum FXJSOBJTYPE
-{
-       JS_DYNAMIC = 0,
-       JS_STATIC = 1,
+enum FXJSOBJTYPE {
+  FXJSOBJTYPE_DYNAMIC = 0,  // Created by native method and returned to JS.
+  FXJSOBJTYPE_STATIC,       // Created by init and hung off of global object.
+  FXJSOBJTYPE_GLOBAL,       // The global object itself (may only appear once).
 };
 
-enum FXJSVALUETYPE
-{
-       VT_unknown,
-       VT_string,
-       VT_number,
-       VT_boolean,
-       VT_date,
-       VT_object,
-       VT_fxobject,
-       VT_null,
-       VT_undefined
+struct FXJSErr {
+  const wchar_t* message;
+  const wchar_t* srcline;
+  unsigned linnum;
 };
 
-struct FXJSErr
-{
-       const wchar_t* message;
-    const wchar_t* srcline;
-    unsigned linnum;
+class FXJS_PerIsolateData {
+ public:
+  static void SetUp(v8::Isolate* pIsolate);
+  static FXJS_PerIsolateData* Get(v8::Isolate* pIsolate);
+
+  CFX_PtrArray m_ObjectDefnArray;
+
+ protected:
+  FXJS_PerIsolateData() {}
 };
 
-/* --------------------------------------------- API --------------------------------------------- */
+extern const wchar_t kFXJSValueNameString[];
+extern const wchar_t kFXJSValueNameNumber[];
+extern const wchar_t kFXJSValueNameBoolean[];
+extern const wchar_t kFXJSValueNameDate[];
+extern const wchar_t kFXJSValueNameObject[];
+extern const wchar_t kFXJSValueNameFxobj[];
+extern const wchar_t kFXJSValueNameNull[];
+extern const wchar_t kFXJSValueNameUndefined[];
 
-typedef v8::Isolate IJS_Runtime;
-class IFXJS_Context;
-class IFXJS_Runtime;
 
-typedef void (*LP_CONSTRUCTOR)(IFXJS_Context* cc, v8::Handle<v8::Object> obj, v8::Handle<v8::Object> global);
-typedef void (*LP_DESTRUCTOR)(v8::Handle<v8::Object> obj);
-
-
-int                                                            JS_DefineObj(IJS_Runtime* pJSRuntime, const wchar_t* sObjName, FXJSOBJTYPE eObjType, LP_CONSTRUCTOR pConstructor, LP_DESTRUCTOR pDestructor, unsigned bApplyNew);
-int                                                            JS_DefineObjMethod(IJS_Runtime* pJSRuntime, int nObjDefnID, const wchar_t* sMethodName, v8::FunctionCallback pMethodCall);
-int                                                            JS_DefineObjProperty(IJS_Runtime* pJSRuntime, int nObjDefnID, const wchar_t* sPropName, v8::AccessorGetterCallback pPropGet, v8::AccessorSetterCallback pPropPut);
-int                                                            JS_DefineObjAllProperties(IJS_Runtime* pJSRuntime, int nObjDefnID, v8::NamedPropertyQueryCallback pPropQurey, v8::NamedPropertyGetterCallback pPropGet, v8::NamedPropertySetterCallback pPropPut, v8::NamedPropertyDeleterCallback pPropDel);
-int                                                            JS_DefineObjConst(IJS_Runtime* pJSRuntime, int nObjDefnID, const wchar_t* sConstName, v8::Handle<v8::Value> pDefault);
-int                                                            JS_DefineGlobalMethod(IJS_Runtime* pJSRuntime, const wchar_t* sMethodName, v8::FunctionCallback pMethodCall);
-int                                                            JS_DefineGlobalConst(IJS_Runtime* pJSRuntime, const wchar_t* sConstName, v8::Handle<v8::Value> pDefault);
-
-void                                                   JS_InitialRuntime(IJS_Runtime* pJSRuntime,IFXJS_Runtime* pFXRuntime, IFXJS_Context* context, v8::Persistent<v8::Context>& v8PersistentContext);
-void                                                   JS_ReleaseRuntime(IJS_Runtime* pJSRuntime, v8::Persistent<v8::Context>& v8PersistentContext);
-void                                                   JS_Initial();
-void                                                   JS_Release();
-int                                                            JS_Parse(IJS_Runtime* pJSRuntime, IFXJS_Context* pJSContext, const wchar_t* script, long length, FXJSErr* perror);
-int                                                            JS_Execute(IJS_Runtime* pJSRuntime, IFXJS_Context* pJSContext, const wchar_t* script, long length, FXJSErr* perror);
-v8::Handle<v8::Object>                 JS_NewFxDynamicObj(IJS_Runtime* pJSRuntime, IFXJS_Context* pJSContext, int nObjDefnID);
-v8::Handle<v8::Object>                 JS_GetStaticObj(IJS_Runtime* pJSRuntime, int nObjDefnID);
-void                                                   JS_SetThisObj(IJS_Runtime* pJSRuntime, int nThisObjID);
-v8::Handle<v8::Object>                 JS_GetThisObj(IJS_Runtime * pJSRuntime);
-int                                                            JS_GetObjDefnID(v8::Handle<v8::Object> pObj);
-IJS_Runtime*                                   JS_GetRuntime(v8::Handle<v8::Object> pObj);
-int                                                            JS_GetObjDefnID(IJS_Runtime * pJSRuntime, const wchar_t* pObjName);
-void                                                   JS_Error(v8::Isolate* isolate, const CFX_WideString& message);
-unsigned                                               JS_CalcHash(const wchar_t* main, unsigned nLen);
-unsigned                                               JS_CalcHash(const wchar_t* main);
-const wchar_t*                                 JS_GetTypeof(v8::Handle<v8::Value> pObj);
-void                                                   JS_SetPrivate(IJS_Runtime* pJSRuntime, v8::Handle<v8::Object> pObj, void* p);
-void*                                                  JS_GetPrivate(IJS_Runtime* pJSRuntime, v8::Handle<v8::Object> pObj);
-void                                                   JS_SetPrivate(v8::Handle<v8::Object> pObj, void* p);
-void*                                                  JS_GetPrivate(v8::Handle<v8::Object> pObj);
-void                                                   JS_FreePrivate(void* p);
-void                                                   JS_FreePrivate(v8::Handle<v8::Object> pObj);
-v8::Handle<v8::Value>                  JS_GetObjectValue(v8::Handle<v8::Object> pObj);
-v8::Handle<v8::Value>                  JS_GetObjectElement(IJS_Runtime* pJSRuntime, v8::Handle<v8::Object> pObj,const wchar_t* PropertyName);
-v8::Handle<v8::Array>                  JS_GetObjectElementNames(v8::Handle<v8::Object> pObj);
-void                                                   JS_PutObjectString(IJS_Runtime* pJSRuntime,v8::Handle<v8::Object> pObj, const wchar_t* PropertyName, const wchar_t* sValue);
-void                                                   JS_PutObjectNumber(IJS_Runtime* pJSRuntime,v8::Handle<v8::Object> pObj, const wchar_t* PropertyName, int nValue);
-void                                                   JS_PutObjectNumber(IJS_Runtime* pJSRuntime,v8::Handle<v8::Object> pObj, const wchar_t* PropertyName, float fValue);
-void                                                   JS_PutObjectNumber(IJS_Runtime* pJSRuntime,v8::Handle<v8::Object> pObj, const wchar_t* PropertyName, double dValue);
-void                                                   JS_PutObjectBoolean(IJS_Runtime* pJSRuntime,v8::Handle<v8::Object> pObj, const wchar_t* PropertyName, bool bValue);
-void                                                   JS_PutObjectObject(IJS_Runtime* pJSRuntime,v8::Handle<v8::Object> pObj, const wchar_t* PropertyName, v8::Handle<v8::Object> pPut);
-void                                                   JS_PutObjectNull(IJS_Runtime* pJSRuntime,v8::Handle<v8::Object> pObj, const wchar_t* PropertyName);
-unsigned                                               JS_PutArrayElement(v8::Handle<v8::Array> pArray,unsigned index,v8::Handle<v8::Value> pValue,FXJSVALUETYPE eType);
-v8::Handle<v8::Value>                  JS_GetArrayElemnet(v8::Handle<v8::Array> pArray,unsigned index);
-unsigned                                               JS_GetArrayLength(v8::Handle<v8::Array> pArray);
-v8::Handle<v8::Value>                  JS_GetListValue(v8::Handle<v8::Value> pList, int index);
-
-
-v8::Handle<v8::Array>                  JS_NewArray(IJS_Runtime* pJSRuntime);
-v8::Handle<v8::Value>                  JS_NewNumber(IJS_Runtime* pJSRuntime,int number);
-v8::Handle<v8::Value>                  JS_NewNumber(IJS_Runtime* pJSRuntime,double number);
-v8::Handle<v8::Value>                  JS_NewNumber(IJS_Runtime* pJSRuntime,float number);
-v8::Handle<v8::Value>                  JS_NewBoolean(IJS_Runtime* pJSRuntime,bool b);
-v8::Handle<v8::Value>                  JS_NewObject(IJS_Runtime* pJSRuntime,v8::Handle<v8::Object> pObj);
-v8::Handle<v8::Value>                  JS_NewObject2(IJS_Runtime* pJSRuntime,v8::Handle<v8::Array> pObj);
-v8::Handle<v8::Value>                  JS_NewString(IJS_Runtime* pJSRuntime,const wchar_t* string);
-v8::Handle<v8::Value>                  JS_NewString(IJS_Runtime* pJSRuntime,const wchar_t* string, unsigned nLen);
-v8::Handle<v8::Value>                  JS_NewNull();
-v8::Handle<v8::Value>                  JS_NewDate(IJS_Runtime* pJSRuntime,double d);
-v8::Handle<v8::Value>                  JS_NewValue(IJS_Runtime* pJSRuntime);
-
-
-int                                                            JS_ToInt32(v8::Handle<v8::Value> pValue);
-bool                                                   JS_ToBoolean(v8::Handle<v8::Value> pValue);
-double                                                 JS_ToNumber(v8::Handle<v8::Value> pValue);
-v8::Handle<v8::Object>                 JS_ToObject(v8::Handle<v8::Value> pValue);
-CFX_WideString                                 JS_ToString(v8::Handle<v8::Value> pValue);
-v8::Handle<v8::Array>                  JS_ToArray(v8::Handle<v8::Value> pValue);
-void                                                   JS_ValueCopy(v8::Handle<v8::Value>& pTo, v8::Handle<v8::Value> pFrom);
-
-double                                                 JS_GetDateTime();
-int                                                            JS_GetYearFromTime(double dt);
-int                                                            JS_GetMonthFromTime(double dt);
-int                                                            JS_GetDayFromTime(double dt);
-int                                                            JS_GetHourFromTime(double dt);
-int                                                            JS_GetMinFromTime(double dt);
-int                                                            JS_GetSecFromTime(double dt);
-double                                                 JS_DateParse(const wchar_t* string);
-double                                                 JS_MakeDay(int nYear, int nMonth, int nDay);
-double                                                 JS_MakeTime(int nHour, int nMin, int nSec, int nMs);
-double                                                 JS_MakeDate(double day, double time);
-bool                                                   JS_PortIsNan(double d);
-double                                                 JS_LocalTime(double d);
-
-#endif //FXJSAPI_H
+class FXJS_ArrayBufferAllocator : public v8::ArrayBuffer::Allocator {
+  void* Allocate(size_t length) override;
+  void* AllocateUninitialized(size_t length) override;
+  void Free(void* data, size_t length) override;
+};
+
+using FXJS_CONSTRUCTOR = void (*)(IFXJS_Context* cc,
+                                  v8::Local<v8::Object> obj,
+                                  v8::Local<v8::Object> global);
+using FXJS_DESTRUCTOR = void (*)(v8::Local<v8::Object> obj);
+
+// Call before making FXJS_PrepareIsolate call.
+void FXJS_Initialize(unsigned int embedderDataSlot, v8::Isolate* pIsolate);
+void FXJS_Release();
+
+// Gets the global isolate set by FXJS_Initialize(), or makes a new one each
+// time if there is no such isolate. Returns true if a new isolate had to be
+// created.
+bool FXJS_GetIsolate(v8::Isolate** pResultIsolate);
+
+// Get the global isolate's ref count.
+size_t FXJS_GlobalIsolateRefCount();
+
+// Call before making FXJS_Define* calls. Resources allocated here are cleared
+// as part of FXJS_ReleaseRuntime().
+void FXJS_PrepareIsolate(v8::Isolate* pIsolate);
+
+// Call before making JS_Define* calls. Resources allocated here are cleared
+// as part of JS_ReleaseRuntime().
+void JS_PrepareIsolate(v8::Isolate* pIsolate);
+
+// Always returns a valid, newly-created objDefnID.
+int FXJS_DefineObj(v8::Isolate* pIsolate,
+                   const wchar_t* sObjName,
+                   FXJSOBJTYPE eObjType,
+                   FXJS_CONSTRUCTOR pConstructor,
+                   FXJS_DESTRUCTOR pDestructor);
+
+void FXJS_DefineObjMethod(v8::Isolate* pIsolate,
+                          int nObjDefnID,
+                          const wchar_t* sMethodName,
+                          v8::FunctionCallback pMethodCall);
+void FXJS_DefineObjProperty(v8::Isolate* pIsolate,
+                            int nObjDefnID,
+                            const wchar_t* sPropName,
+                            v8::AccessorGetterCallback pPropGet,
+                            v8::AccessorSetterCallback pPropPut);
+void FXJS_DefineObjAllProperties(v8::Isolate* pIsolate,
+                                 int nObjDefnID,
+                                 v8::NamedPropertyQueryCallback pPropQurey,
+                                 v8::NamedPropertyGetterCallback pPropGet,
+                                 v8::NamedPropertySetterCallback pPropPut,
+                                 v8::NamedPropertyDeleterCallback pPropDel);
+void FXJS_DefineObjConst(v8::Isolate* pIsolate,
+                         int nObjDefnID,
+                         const wchar_t* sConstName,
+                         v8::Local<v8::Value> pDefault);
+void FXJS_DefineGlobalMethod(v8::Isolate* pIsolate,
+                             const wchar_t* sMethodName,
+                             v8::FunctionCallback pMethodCall);
+void FXJS_DefineGlobalConst(v8::Isolate* pIsolate,
+                            const wchar_t* sConstName,
+                            v8::Local<v8::Value> pDefault);
+
+// Called after FXJS_Define* calls made.
+void FXJS_InitializeRuntime(v8::Isolate* pIsolate,
+                            IFXJS_Runtime* pFXRuntime,
+                            IFXJS_Context* context,
+                            v8::Global<v8::Context>& v8PersistentContext);
+void FXJS_ReleaseRuntime(v8::Isolate* pIsolate,
+                         v8::Global<v8::Context>& v8PersistentContext);
+IFXJS_Runtime* FXJS_GetRuntimeFromIsolate(v8::Isolate* pIsolate);
+
+// Called after FXJS_InitializeRuntime call made.
+int FXJS_Execute(v8::Isolate* pIsolate,
+                 IFXJS_Context* pJSContext,
+                 const wchar_t* script,
+                 long length,
+                 FXJSErr* perror);
+
+v8::Local<v8::Object> FXJS_NewFxDynamicObj(v8::Isolate* pIsolate,
+                                           IFXJS_Context* pJSContext,
+                                           int nObjDefnID);
+v8::Local<v8::Object> FXJS_GetThisObj(v8::Isolate* pIsolate);
+int FXJS_GetObjDefnID(v8::Local<v8::Object> pObj);
+v8::Isolate* FXJS_GetRuntime(v8::Local<v8::Object> pObj);
+const wchar_t* FXJS_GetTypeof(v8::Local<v8::Value> pObj);
+
+void FXJS_SetPrivate(v8::Isolate* pIsolate,
+                     v8::Local<v8::Object> pObj,
+                     void* p);
+void* FXJS_GetPrivate(v8::Isolate* pIsolate, v8::Local<v8::Object> pObj);
+void FXJS_FreePrivate(void* p);
+void FXJS_FreePrivate(v8::Local<v8::Object> pObj);
+
+void FXJS_Error(v8::Isolate* isolate, const CFX_WideString& message);
+v8::Local<v8::String> FXJS_WSToJSString(v8::Isolate* pIsolate,
+                                        const wchar_t* PropertyName,
+                                        int Len = -1);
+
+v8::Local<v8::Value> FXJS_GetObjectElement(v8::Isolate* pIsolate,
+                                           v8::Local<v8::Object> pObj,
+                                           const wchar_t* PropertyName);
+v8::Local<v8::Array> FXJS_GetObjectElementNames(v8::Isolate* pIsolate,
+                                                v8::Local<v8::Object> pObj);
+
+v8::Local<v8::Value> FXJS_GetArrayElement(v8::Isolate* pIsolate,
+                                          v8::Local<v8::Array> pArray,
+                                          unsigned index);
+unsigned FXJS_GetArrayLength(v8::Local<v8::Array> pArray);
+
+void FXJS_PutObjectString(v8::Isolate* pIsolate,
+                          v8::Local<v8::Object> pObj,
+                          const wchar_t* PropertyName,
+                          const wchar_t* sValue);
+void FXJS_PutObjectNumber(v8::Isolate* pIsolate,
+                          v8::Local<v8::Object> pObj,
+                          const wchar_t* PropertyName,
+                          int nValue);
+void FXJS_PutObjectNumber(v8::Isolate* pIsolate,
+                          v8::Local<v8::Object> pObj,
+                          const wchar_t* PropertyName,
+                          float fValue);
+void FXJS_PutObjectNumber(v8::Isolate* pIsolate,
+                          v8::Local<v8::Object> pObj,
+                          const wchar_t* PropertyName,
+                          double dValue);
+void FXJS_PutObjectBoolean(v8::Isolate* pIsolate,
+                           v8::Local<v8::Object> pObj,
+                           const wchar_t* PropertyName,
+                           bool bValue);
+void FXJS_PutObjectObject(v8::Isolate* pIsolate,
+                          v8::Local<v8::Object> pObj,
+                          const wchar_t* PropertyName,
+                          v8::Local<v8::Object> pPut);
+void FXJS_PutObjectNull(v8::Isolate* pIsolate,
+                        v8::Local<v8::Object> pObj,
+                        const wchar_t* PropertyName);
+unsigned FXJS_PutArrayElement(v8::Isolate* pIsolate,
+                              v8::Local<v8::Array> pArray,
+                              unsigned index,
+                              v8::Local<v8::Value> pValue);
+
+v8::Local<v8::Array> FXJS_NewArray(v8::Isolate* pIsolate);
+v8::Local<v8::Value> FXJS_NewNumber(v8::Isolate* pIsolate, int number);
+v8::Local<v8::Value> FXJS_NewNumber(v8::Isolate* pIsolate, double number);
+v8::Local<v8::Value> FXJS_NewNumber(v8::Isolate* pIsolate, float number);
+v8::Local<v8::Value> FXJS_NewBoolean(v8::Isolate* pIsolate, bool b);
+v8::Local<v8::Value> FXJS_NewObject(v8::Isolate* pIsolate,
+                                    v8::Local<v8::Object> pObj);
+v8::Local<v8::Value> FXJS_NewObject2(v8::Isolate* pIsolate,
+                                     v8::Local<v8::Array> pObj);
+v8::Local<v8::Value> FXJS_NewString(v8::Isolate* pIsolate,
+                                    const wchar_t* string);
+v8::Local<v8::Value> FXJS_NewNull();
+v8::Local<v8::Value> FXJS_NewDate(v8::Isolate* pIsolate, double d);
+
+int FXJS_ToInt32(v8::Isolate* pIsolate, v8::Local<v8::Value> pValue);
+bool FXJS_ToBoolean(v8::Isolate* pIsolate, v8::Local<v8::Value> pValue);
+double FXJS_ToNumber(v8::Isolate* pIsolate, v8::Local<v8::Value> pValue);
+v8::Local<v8::Object> FXJS_ToObject(v8::Isolate* pIsolate,
+                                    v8::Local<v8::Value> pValue);
+CFX_WideString FXJS_ToString(v8::Isolate* pIsolate,
+                             v8::Local<v8::Value> pValue);
+v8::Local<v8::Array> FXJS_ToArray(v8::Isolate* pIsolate,
+                                  v8::Local<v8::Value> pValue);
+void FXJS_ValueCopy(v8::Local<v8::Value>& pTo, v8::Local<v8::Value> pFrom);
+
+#endif  // FPDFSDK_INCLUDE_JSAPI_FXJS_V8_H_