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