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