9ae0329e30cecf6852504cbfb23779745f537c18
[pdfium.git] / fpdfsdk / include / javascript / IJavaScript.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 _IJAVASCRIPT_H_
8 #define _IJAVASCRIPT_H_
9
10 class IFXJS_Context
11 {
12 public:
13         virtual ~IFXJS_Context() { }
14         virtual FX_BOOL                         Compile(const CFX_WideString& script, CFX_WideString& info) = 0;
15         virtual FX_BOOL                         RunScript(const CFX_WideString& script, CFX_WideString& info) = 0;
16
17         virtual void                            OnApp_Init() = 0;
18
19         virtual void                            OnDoc_Open(CPDFSDK_Document* pDoc, const CFX_WideString& strTargetName) = 0;
20         virtual void                            OnDoc_WillPrint(CPDFSDK_Document* pDoc) = 0;
21         virtual void                            OnDoc_DidPrint(CPDFSDK_Document* pDoc) = 0;
22         virtual void                            OnDoc_WillSave(CPDFSDK_Document* pDoc) = 0;
23         virtual void                            OnDoc_DidSave(CPDFSDK_Document* pDoc) = 0;
24         virtual void                            OnDoc_WillClose(CPDFSDK_Document* pDoc) = 0;
25
26         virtual void                            OnPage_Open(CPDFSDK_Document* pTarget) = 0;
27         virtual void                            OnPage_Close(CPDFSDK_Document* pTarget) = 0;
28         virtual void                            OnPage_InView(CPDFSDK_Document* pTarget) = 0;
29         virtual void                            OnPage_OutView(CPDFSDK_Document* pTarget) = 0;
30
31         virtual void                            OnField_MouseDown(FX_BOOL bModifier, FX_BOOL bShift, CPDF_FormField* pTarget) = 0;
32         virtual void                            OnField_MouseEnter(FX_BOOL bModifier, FX_BOOL bShift, CPDF_FormField* pTarget) = 0;
33         virtual void                            OnField_MouseExit(FX_BOOL bModifier, FX_BOOL bShift, CPDF_FormField* pTarget) = 0;
34         virtual void                            OnField_MouseUp(FX_BOOL bModifier, FX_BOOL bShift, CPDF_FormField* pTarget) = 0;
35         virtual void                            OnField_Focus(FX_BOOL bModifier, FX_BOOL bShift, CPDF_FormField* pTarget, const CFX_WideString& Value) = 0;
36         virtual void                            OnField_Blur(FX_BOOL bModifier, FX_BOOL bShift, CPDF_FormField* pTarget, const CFX_WideString& Value) = 0;
37
38         virtual void                            OnField_Calculate(CPDF_FormField* pSource, CPDF_FormField* pTarget, CFX_WideString& Value, FX_BOOL& bRc) = 0;
39         virtual void                            OnField_Format(int nCommitKey, CPDF_FormField* pTarget, CFX_WideString& Value, FX_BOOL bWillCommit) = 0;
40         virtual void                            OnField_Keystroke(int nCommitKey, CFX_WideString& strChange, const CFX_WideString& strChangeEx,
41                                                                         FX_BOOL KeyDown, FX_BOOL bModifier, int &nSelEnd,int &nSelStart, FX_BOOL bShift,
42                                                                         CPDF_FormField* pTarget, CFX_WideString& Value, FX_BOOL bWillCommit, 
43                                                                         FX_BOOL bFieldFull, FX_BOOL &bRc) = 0;
44         virtual void                            OnField_Validate(CFX_WideString& strChange, const CFX_WideString& strChangeEx, FX_BOOL bKeyDown,
45                                                                         FX_BOOL bModifier, FX_BOOL bShift, CPDF_FormField* pTarget, CFX_WideString& Value, FX_BOOL& bRc) = 0;
46
47         virtual void                            OnScreen_Focus(FX_BOOL bModifier, FX_BOOL bShift, CPDFSDK_Annot* pScreen) = 0;
48         virtual void                            OnScreen_Blur(FX_BOOL bModifier, FX_BOOL bShift, CPDFSDK_Annot* pScreen) = 0;
49         virtual void                            OnScreen_Open(FX_BOOL bModifier, FX_BOOL bShift, CPDFSDK_Annot* pScreen) = 0;
50         virtual void                            OnScreen_Close(FX_BOOL bModifier, FX_BOOL bShift, CPDFSDK_Annot* pScreen) = 0;
51         virtual void                            OnScreen_MouseDown(FX_BOOL bModifier, FX_BOOL bShift, CPDFSDK_Annot* pScreen) = 0;
52         virtual void                            OnScreen_MouseUp(FX_BOOL bModifier, FX_BOOL bShift, CPDFSDK_Annot* pScreen) = 0;
53         virtual void                            OnScreen_MouseEnter(FX_BOOL bModifier, FX_BOOL bShift, CPDFSDK_Annot* pScreen) = 0;
54         virtual void                            OnScreen_MouseExit(FX_BOOL bModifier, FX_BOOL bShift, CPDFSDK_Annot* pScreen) = 0;
55         virtual void                            OnScreen_InView(FX_BOOL bModifier, FX_BOOL bShift, CPDFSDK_Annot* pScreen) = 0;
56         virtual void                            OnScreen_OutView(FX_BOOL bModifier, FX_BOOL bShift, CPDFSDK_Annot* pScreen) = 0;
57
58         virtual void                            OnBookmark_MouseUp(CPDF_Bookmark* pBookMark) = 0;
59         virtual void                            OnLink_MouseUp(CPDFSDK_Document* pTarget) = 0;
60
61         virtual void                            OnMenu_Exec(CPDFSDK_Document* pTarget, const CFX_WideString &) = 0;
62         virtual void                            OnBatchExec(CPDFSDK_Document* pTarget) = 0;
63         virtual void                            OnConsole_Exec() = 0;
64         virtual void                            OnExternal_Exec() = 0;
65
66         virtual void                            EnableMessageBox(FX_BOOL bEnable) = 0;
67 };
68
69 class IFXJS_Runtime
70 {
71 public:
72         virtual IFXJS_Context*          NewContext() = 0;
73         virtual void                            ReleaseContext(IFXJS_Context * pContext) = 0;
74         virtual IFXJS_Context*          GetCurrentContext() = 0;
75
76         virtual void                            SetReaderDocument(CPDFSDK_Document* pReaderDoc) = 0;
77         virtual CPDFSDK_Document*       GetReaderDocument() = 0;        
78
79         virtual void                            GetObjectNames(CFX_WideStringArray& array) = 0;
80         virtual void                            GetObjectConsts(const CFX_WideString& swObjName, CFX_WideStringArray& array) = 0;
81         virtual void                            GetObjectProps(const CFX_WideString& swObjName, CFX_WideStringArray& array) = 0;
82         virtual void                            GetObjectMethods(const CFX_WideString& swObjName, CFX_WideStringArray& array) = 0;
83
84         virtual void                            Exit() = 0;
85         virtual void                            Enter() = 0;
86         virtual FX_BOOL                         IsEntered() = 0;
87
88 protected:
89          ~IFXJS_Runtime() { }
90 };
91
92 class CPDFDoc_Environment;
93 class CJS_GlobalData;
94
95 class CJS_RuntimeFactory
96 {
97 public:
98         CJS_RuntimeFactory():m_bInit(FALSE),m_nRef(0),m_pGlobalData(NULL),m_nGlobalDataCount(0) {}
99         ~CJS_RuntimeFactory();
100         IFXJS_Runtime*                                  NewJSRuntime(CPDFDoc_Environment* pApp);
101         void                                                    DeleteJSRuntime(IFXJS_Runtime* pRuntime);
102         void                                                    AddRef();
103         void                                                    Release();
104
105         CJS_GlobalData*                                 NewGlobalData(CPDFDoc_Environment* pApp);
106         void                                                    ReleaseGlobalData();
107 private:
108         FX_BOOL m_bInit;
109         int m_nRef;
110         CJS_GlobalData*                                 m_pGlobalData;
111         FX_INT32                                                m_nGlobalDataCount;
112 };
113
114 #endif //_IJAVASCRIPT_H_
115