Rename Init methods to more accurately describe purpose
[pdfium.git] / fpdfsdk / include / javascript / JS_Object.h
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.
4
5 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
6
7 #ifndef FPDFSDK_INCLUDE_JAVASCRIPT_JS_OBJECT_H_
8 #define FPDFSDK_INCLUDE_JAVASCRIPT_JS_OBJECT_H_
9
10 #include <map>
11
12 #include "../../../third_party/base/nonstd_unique_ptr.h"
13
14 #include "../fsdk_define.h"       // For FX_UINT
15 #include "../fsdk_mgr.h"          // For CPDFDoc_Environment
16 #include "../fx_systemhandler.h"  // For IFX_SystemHandler
17 #include "../jsapi/fxjs_v8.h"
18
19 class CPDFSDK_PageView;
20 class CJS_Context;
21 class CJS_Object;
22 class CJS_Runtime;
23 class CJS_Timer;
24
25 class CJS_EmbedObj {
26  public:
27   explicit CJS_EmbedObj(CJS_Object* pJSObject);
28   virtual ~CJS_EmbedObj();
29
30   virtual void TimerProc(CJS_Timer* pTimer) {}
31   CJS_Timer* BeginTimer(CPDFDoc_Environment* pApp, FX_UINT nElapse);
32   void EndTimer(CJS_Timer* pTimer);
33
34   CJS_Object* GetJSObject() const { return m_pJSObject; }
35
36   CPDFSDK_PageView* JSGetPageView(IFXJS_Context* cc);
37   int MsgBox(CPDFDoc_Environment* pApp,
38              CPDFSDK_PageView* pPageView,
39              const FX_WCHAR* swMsg,
40              const FX_WCHAR* swTitle = NULL,
41              FX_UINT nType = 0,
42              FX_UINT nIcon = 0);
43   void Alert(CJS_Context* pContext, const FX_WCHAR* swMsg);
44
45  protected:
46   CJS_Object* m_pJSObject;
47 };
48
49 class CJS_Object {
50  public:
51   explicit CJS_Object(v8::Local<v8::Object> pObject);
52   virtual ~CJS_Object();
53
54   void MakeWeak();
55   void Dispose();
56
57   virtual FX_BOOL IsType(const FX_CHAR* sClassName) { return TRUE; }
58   virtual CFX_ByteString GetClassName() { return ""; }
59
60   virtual FX_BOOL InitInstance(IFXJS_Context* cc) { return TRUE; }
61   virtual FX_BOOL ExitInstance() { return TRUE; }
62
63   operator v8::Local<v8::Object>() {
64     return v8::Local<v8::Object>::New(m_pIsolate, m_pObject);
65   }
66
67   // Takes ownership of |pObj|.
68   void SetEmbedObject(CJS_EmbedObj* pObj) { m_pEmbedObj.reset(pObj); }
69   CJS_EmbedObj* GetEmbedObject() const { return m_pEmbedObj.get(); }
70
71   static CPDFSDK_PageView* JSGetPageView(IFXJS_Context* cc);
72   static int MsgBox(CPDFDoc_Environment* pApp,
73                     CPDFSDK_PageView* pPageView,
74                     const FX_WCHAR* swMsg,
75                     const FX_WCHAR* swTitle = NULL,
76                     FX_UINT nType = 0,
77                     FX_UINT nIcon = 0);
78   static void Alert(CJS_Context* pContext, const FX_WCHAR* swMsg);
79
80   v8::Isolate* GetIsolate() { return m_pIsolate; }
81
82  protected:
83   nonstd::unique_ptr<CJS_EmbedObj> m_pEmbedObj;
84   v8::Global<v8::Object> m_pObject;
85   v8::Isolate* m_pIsolate;
86 };
87
88 class CJS_Timer {
89  public:
90   CJS_Timer(CJS_EmbedObj* pObj, CPDFDoc_Environment* pApp)
91       : m_nTimerID(0),
92         m_pEmbedObj(pObj),
93         m_bProcessing(FALSE),
94         m_dwStartTime(0),
95         m_dwTimeOut(0),
96         m_dwElapse(0),
97         m_pRuntime(NULL),
98         m_nType(0),
99         m_pApp(pApp) {}
100
101   virtual ~CJS_Timer() { KillJSTimer(); }
102
103  public:
104   FX_UINT SetJSTimer(FX_UINT nElapse);
105   void KillJSTimer();
106
107   void SetType(int nType) { m_nType = nType; }
108   int GetType() const { return m_nType; }
109
110   void SetStartTime(FX_DWORD dwStartTime) { m_dwStartTime = dwStartTime; }
111   FX_DWORD GetStartTime() const { return m_dwStartTime; }
112
113   void SetTimeOut(FX_DWORD dwTimeOut) { m_dwTimeOut = dwTimeOut; }
114   FX_DWORD GetTimeOut() const { return m_dwTimeOut; }
115
116   void SetRuntime(CJS_Runtime* pRuntime) { m_pRuntime = pRuntime; }
117   CJS_Runtime* GetRuntime() const { return m_pRuntime; }
118
119   void SetJScript(const CFX_WideString& script) { m_swJScript = script; }
120   CFX_WideString GetJScript() const { return m_swJScript; }
121
122   static void TimerProc(int idEvent);
123
124  private:
125   using TimerMap = std::map<FX_UINT, CJS_Timer*>;
126   static TimerMap* GetGlobalTimerMap();
127
128   FX_UINT m_nTimerID;
129   CJS_EmbedObj* m_pEmbedObj;
130   FX_BOOL m_bProcessing;
131
132   // data
133   FX_DWORD m_dwStartTime;
134   FX_DWORD m_dwTimeOut;
135   FX_DWORD m_dwElapse;
136   CJS_Runtime* m_pRuntime;
137   CFX_WideString m_swJScript;
138   int m_nType;  // 0:Interval; 1:TimeOut
139
140   CPDFDoc_Environment* m_pApp;
141 };
142
143 #endif  // FPDFSDK_INCLUDE_JAVASCRIPT_JS_OBJECT_H_