Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / pdfium / 3342090d65e852f3f37a8f04d3fbe3ff2467d05c / . / fpdfsdk / include / javascript / IJavaScript.h
blob: c8962bd343c53b496ba2a0a7cf089b0af36ffe38 [file] [log] [blame]
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -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.
Lei Zhanga6d9f0e2015-06-13 00:48:38 -0700[diff] [blame]4
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]5// Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
6
Tom Sepez19922bb2015-05-28 13:23:12 -0700[diff] [blame]7#ifndef FPDFSDK_INCLUDE_JAVASCRIPT_IJAVASCRIPT_H_
8#define FPDFSDK_INCLUDE_JAVASCRIPT_IJAVASCRIPT_H_
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]9
Lei Zhange5b0bd12015-06-19 17:15:41 -0700[diff] [blame]10#include "../../../core/include/fxcrt/fx_string.h"
11#include "../../../core/include/fxcrt/fx_system.h"
Tom Sepez3a832662015-03-02 12:59:05 -0800[diff] [blame]12#include "../../../xfa/include/fxjse/fxjse.h"
13
Tom Sepezf4583622015-09-14 15:06:53 -0700[diff] [blame]14class CPDFDoc_Environment;
Tom Sepez3a832662015-03-02 12:59:05 -0800[diff] [blame]15class CPDFSDK_Annot;
16class CPDFSDK_Document;
Tom Sepezf4583622015-09-14 15:06:53 -0700[diff] [blame]17class CPDF_Bookmark;
18class CPDF_FormField;
Tom Sepez3a832662015-03-02 12:59:05 -0800[diff] [blame]19
Tom Sepez33420902015-10-13 15:00:10 -0700[diff] [blame^]20// Records the details of an event and triggers JS execution for it.
Tom Sepezba038bc2015-10-08 12:03:00 -0700[diff] [blame]21class IJS_Context {
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]22 public:
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]23 virtual FX_BOOL RunScript(const CFX_WideString& script,
Tom Sepez33420902015-10-13 15:00:10 -0700[diff] [blame^]24 CFX_WideString* info) = 0;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]25
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]26 virtual void OnApp_Init() = 0;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]27
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]28 virtual void OnDoc_Open(CPDFSDK_Document* pDoc,
29 const CFX_WideString& strTargetName) = 0;
30 virtual void OnDoc_WillPrint(CPDFSDK_Document* pDoc) = 0;
31 virtual void OnDoc_DidPrint(CPDFSDK_Document* pDoc) = 0;
32 virtual void OnDoc_WillSave(CPDFSDK_Document* pDoc) = 0;
33 virtual void OnDoc_DidSave(CPDFSDK_Document* pDoc) = 0;
34 virtual void OnDoc_WillClose(CPDFSDK_Document* pDoc) = 0;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]35
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]36 virtual void OnPage_Open(CPDFSDK_Document* pTarget) = 0;
37 virtual void OnPage_Close(CPDFSDK_Document* pTarget) = 0;
38 virtual void OnPage_InView(CPDFSDK_Document* pTarget) = 0;
39 virtual void OnPage_OutView(CPDFSDK_Document* pTarget) = 0;
Tom Sepeze5b59ca2015-01-09 11:46:17 -0800[diff] [blame]40
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]41 virtual void OnField_MouseDown(FX_BOOL bModifier,
42 FX_BOOL bShift,
43 CPDF_FormField* pTarget) = 0;
44 virtual void OnField_MouseEnter(FX_BOOL bModifier,
45 FX_BOOL bShift,
46 CPDF_FormField* pTarget) = 0;
47 virtual void OnField_MouseExit(FX_BOOL bModifier,
48 FX_BOOL bShift,
49 CPDF_FormField* pTarget) = 0;
50 virtual void OnField_MouseUp(FX_BOOL bModifier,
51 FX_BOOL bShift,
52 CPDF_FormField* pTarget) = 0;
53 virtual void OnField_Focus(FX_BOOL bModifier,
54 FX_BOOL bShift,
55 CPDF_FormField* pTarget,
56 const CFX_WideString& Value) = 0;
57 virtual void OnField_Blur(FX_BOOL bModifier,
58 FX_BOOL bShift,
59 CPDF_FormField* pTarget,
60 const CFX_WideString& Value) = 0;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]61
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]62 virtual void OnField_Calculate(CPDF_FormField* pSource,
63 CPDF_FormField* pTarget,
64 CFX_WideString& Value,
65 FX_BOOL& bRc) = 0;
66 virtual void OnField_Format(CPDF_FormField* pTarget,
67 CFX_WideString& Value,
68 FX_BOOL bWillCommit) = 0;
69 virtual void OnField_Keystroke(CFX_WideString& strChange,
70 const CFX_WideString& strChangeEx,
71 FX_BOOL KeyDown,
72 FX_BOOL bModifier,
73 int& nSelEnd,
74 int& nSelStart,
75 FX_BOOL bShift,
76 CPDF_FormField* pTarget,
77 CFX_WideString& Value,
78 FX_BOOL bWillCommit,
79 FX_BOOL bFieldFull,
80 FX_BOOL& bRc) = 0;
81 virtual void OnField_Validate(CFX_WideString& strChange,
82 const CFX_WideString& strChangeEx,
83 FX_BOOL bKeyDown,
84 FX_BOOL bModifier,
85 FX_BOOL bShift,
86 CPDF_FormField* pTarget,
87 CFX_WideString& Value,
88 FX_BOOL& bRc) = 0;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]89
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]90 virtual void OnScreen_Focus(FX_BOOL bModifier,
91 FX_BOOL bShift,
92 CPDFSDK_Annot* pScreen) = 0;
93 virtual void OnScreen_Blur(FX_BOOL bModifier,
94 FX_BOOL bShift,
95 CPDFSDK_Annot* pScreen) = 0;
96 virtual void OnScreen_Open(FX_BOOL bModifier,
97 FX_BOOL bShift,
98 CPDFSDK_Annot* pScreen) = 0;
99 virtual void OnScreen_Close(FX_BOOL bModifier,
100 FX_BOOL bShift,
101 CPDFSDK_Annot* pScreen) = 0;
102 virtual void OnScreen_MouseDown(FX_BOOL bModifier,
103 FX_BOOL bShift,
104 CPDFSDK_Annot* pScreen) = 0;
105 virtual void OnScreen_MouseUp(FX_BOOL bModifier,
106 FX_BOOL bShift,
107 CPDFSDK_Annot* pScreen) = 0;
108 virtual void OnScreen_MouseEnter(FX_BOOL bModifier,
109 FX_BOOL bShift,
110 CPDFSDK_Annot* pScreen) = 0;
111 virtual void OnScreen_MouseExit(FX_BOOL bModifier,
112 FX_BOOL bShift,
113 CPDFSDK_Annot* pScreen) = 0;
114 virtual void OnScreen_InView(FX_BOOL bModifier,
115 FX_BOOL bShift,
116 CPDFSDK_Annot* pScreen) = 0;
117 virtual void OnScreen_OutView(FX_BOOL bModifier,
118 FX_BOOL bShift,
119 CPDFSDK_Annot* pScreen) = 0;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]120
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]121 virtual void OnBookmark_MouseUp(CPDF_Bookmark* pBookMark) = 0;
122 virtual void OnLink_MouseUp(CPDFSDK_Document* pTarget) = 0;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]123
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]124 virtual void OnMenu_Exec(CPDFSDK_Document* pTarget,
125 const CFX_WideString&) = 0;
126 virtual void OnBatchExec(CPDFSDK_Document* pTarget) = 0;
127 virtual void OnConsole_Exec() = 0;
128 virtual void OnExternal_Exec() = 0;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]129
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]130 virtual void EnableMessageBox(FX_BOOL bEnable) = 0;
Lei Zhang2b1a2d52015-08-14 22:16:22 -0700[diff] [blame]131
132 protected:
Tom Sepezba038bc2015-10-08 12:03:00 -0700[diff] [blame]133 virtual ~IJS_Context() {}
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]134};
135
Tom Sepez33420902015-10-13 15:00:10 -0700[diff] [blame^]136// Owns the FJXS objects needed to actually execute JS.
Tom Sepezba038bc2015-10-08 12:03:00 -0700[diff] [blame]137class IJS_Runtime {
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]138 public:
Tom Sepez452b4f32015-10-13 09:27:27 -0700[diff] [blame]139 static void Initialize(unsigned int slot, void* isolate);
Tom Sepezba038bc2015-10-08 12:03:00 -0700[diff] [blame]140 static IJS_Runtime* Create(CPDFDoc_Environment* pEnv);
141 virtual ~IJS_Runtime() {}
Tom Sepez854a7f62015-09-21 17:07:49 -0700[diff] [blame]142
Tom Sepezba038bc2015-10-08 12:03:00 -0700[diff] [blame]143 virtual IJS_Context* NewContext() = 0;
144 virtual void ReleaseContext(IJS_Context* pContext) = 0;
145 virtual IJS_Context* GetCurrentContext() = 0;
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]146 virtual void SetReaderDocument(CPDFSDK_Document* pReaderDoc) = 0;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]147
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]148 virtual CPDFSDK_Document* GetReaderDocument() = 0;
Tom Sepez33420902015-10-13 15:00:10 -0700[diff] [blame^]149 virtual int Execute(IJS_Context* cc,
150 const wchar_t* script,
151 CFX_WideString* info) = 0;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]152
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]153 virtual FX_BOOL GetHValueByName(const CFX_ByteStringC& utf8Name,
154 FXJSE_HVALUE hValue) = 0;
155 virtual FX_BOOL SetHValueByName(const CFX_ByteStringC& utf8Name,
156 FXJSE_HVALUE hValue) = 0;
Tom Sepez37458412015-10-06 11:33:46 -0700[diff] [blame]157
158 protected:
Tom Sepezba038bc2015-10-08 12:03:00 -0700[diff] [blame]159 IJS_Runtime() {}
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]160};
161
Tom Sepez19922bb2015-05-28 13:23:12 -0700[diff] [blame]162#endif // FPDFSDK_INCLUDE_JAVASCRIPT_IJAVASCRIPT_H_