Add type cast definitions for CPDF_Array.
[pdfium.git] / fpdfsdk / include / fsdk_mgr.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_FSDK_MGR_H_
8 #define FPDFSDK_INCLUDE_FSDK_MGR_H_
9
10 #include <map>
11
12 #include "../../core/include/fpdftext/fpdf_text.h"
13 #include "../../public/fpdf_formfill.h"
14 #include "../../public/fpdf_fwlevent.h"  // cross platform keycode and events define.
15 #include "fsdk_common.h"
16 #include "fsdk_define.h"
17 #include "fx_systemhandler.h"
18 #include "fsdk_baseannot.h"
19 #include "fsdk_baseform.h"
20 #include "fsdk_annothandler.h"
21 #include "fsdk_actionhandler.h"
22 #include "javascript/IJavaScript.h"
23
24 class CFFL_IFormFiller;
25 class CPDFSDK_ActionHandler;
26 class CPDFSDK_Annot;
27 class CPDFSDK_Document;
28 class CPDFSDK_InterForm;
29 class CPDFSDK_PageView;
30 class CPDFSDK_Widget;
31 class IFX_SystemHandler;
32
33 class CPDFDoc_Environment final {
34  public:
35   CPDFDoc_Environment(CPDF_Document* pDoc, FPDF_FORMFILLINFO* pFFinfo);
36   ~CPDFDoc_Environment();
37
38   void FFI_Invalidate(FPDF_PAGE page,
39                       double left,
40                       double top,
41                       double right,
42                       double bottom) {
43     if (m_pInfo && m_pInfo->FFI_Invalidate)
44       m_pInfo->FFI_Invalidate(m_pInfo, page, left, top, right, bottom);
45   }
46
47   void FFI_OutputSelectedRect(FPDF_PAGE page,
48                               double left,
49                               double top,
50                               double right,
51                               double bottom) {
52     if (m_pInfo && m_pInfo->FFI_OutputSelectedRect)
53       m_pInfo->FFI_OutputSelectedRect(m_pInfo, page, left, top, right, bottom);
54   }
55
56   void FFI_SetCursor(int nCursorType) {
57     if (m_pInfo && m_pInfo->FFI_SetCursor)
58       m_pInfo->FFI_SetCursor(m_pInfo, nCursorType);
59   }
60
61   int FFI_SetTimer(int uElapse, TimerCallback lpTimerFunc) {
62     if (m_pInfo && m_pInfo->FFI_SetTimer)
63       return m_pInfo->FFI_SetTimer(m_pInfo, uElapse, lpTimerFunc);
64     return -1;
65   }
66
67   void FFI_KillTimer(int nTimerID) {
68     if (m_pInfo && m_pInfo->FFI_KillTimer)
69       m_pInfo->FFI_KillTimer(m_pInfo, nTimerID);
70   }
71
72   FX_SYSTEMTIME FFI_GetLocalTime() const {
73     FX_SYSTEMTIME fxtime;
74     if (m_pInfo && m_pInfo->FFI_GetLocalTime) {
75       FPDF_SYSTEMTIME systime = m_pInfo->FFI_GetLocalTime(m_pInfo);
76       fxtime.wDay = systime.wDay;
77       fxtime.wDayOfWeek = systime.wDayOfWeek;
78       fxtime.wHour = systime.wHour;
79       fxtime.wMilliseconds = systime.wMilliseconds;
80       fxtime.wMinute = systime.wMinute;
81       fxtime.wMonth = systime.wMonth;
82       fxtime.wSecond = systime.wSecond;
83       fxtime.wYear = systime.wYear;
84     }
85     return fxtime;
86   }
87
88   void FFI_OnChange() {
89     if (m_pInfo && m_pInfo->FFI_OnChange)
90       m_pInfo->FFI_OnChange(m_pInfo);
91   }
92
93   FX_BOOL FFI_IsSHIFTKeyDown(FX_DWORD nFlag) const {
94     return (nFlag & FWL_EVENTFLAG_ShiftKey) != 0;
95   }
96
97   FX_BOOL FFI_IsCTRLKeyDown(FX_DWORD nFlag) const {
98     return (nFlag & FWL_EVENTFLAG_ControlKey) != 0;
99   }
100
101   FX_BOOL FFI_IsALTKeyDown(FX_DWORD nFlag) const {
102     return (nFlag & FWL_EVENTFLAG_AltKey) != 0;
103   }
104
105   FX_BOOL FFI_IsINSERTKeyDown(FX_DWORD nFlag) const { return FALSE; }
106
107   int JS_appAlert(const FX_WCHAR* Msg,
108                   const FX_WCHAR* Title,
109                   FX_UINT Type,
110                   FX_UINT Icon);
111   int JS_appResponse(const FX_WCHAR* Question,
112                      const FX_WCHAR* Title,
113                      const FX_WCHAR* Default,
114                      const FX_WCHAR* cLabel,
115                      FPDF_BOOL bPassword,
116                      void* response,
117                      int length);
118
119   void JS_appBeep(int nType) {
120     if (m_pInfo && m_pInfo->m_pJsPlatform && m_pInfo->m_pJsPlatform->app_beep)
121       m_pInfo->m_pJsPlatform->app_beep(m_pInfo->m_pJsPlatform, nType);
122   }
123
124   CFX_WideString JS_fieldBrowse();
125   CFX_WideString JS_docGetFilePath();
126
127   void JS_docSubmitForm(void* formData, int length, const FX_WCHAR* URL);
128   void JS_docmailForm(void* mailData,
129                       int length,
130                       FPDF_BOOL bUI,
131                       const FX_WCHAR* To,
132                       const FX_WCHAR* Subject,
133                       const FX_WCHAR* CC,
134                       const FX_WCHAR* BCC,
135                       const FX_WCHAR* Msg);
136
137   void JS_docprint(FPDF_BOOL bUI,
138                    int nStart,
139                    int nEnd,
140                    FPDF_BOOL bSilent,
141                    FPDF_BOOL bShrinkToFit,
142                    FPDF_BOOL bPrintAsImage,
143                    FPDF_BOOL bReverse,
144                    FPDF_BOOL bAnnotations) {
145     if (m_pInfo && m_pInfo->m_pJsPlatform && m_pInfo->m_pJsPlatform->Doc_print)
146       m_pInfo->m_pJsPlatform->Doc_print(m_pInfo->m_pJsPlatform, bUI, nStart,
147                                         nEnd, bSilent, bShrinkToFit,
148                                         bPrintAsImage, bReverse, bAnnotations);
149   }
150
151   void JS_docgotoPage(int nPageNum) {
152     if (m_pInfo && m_pInfo->m_pJsPlatform &&
153         m_pInfo->m_pJsPlatform->Doc_gotoPage)
154       m_pInfo->m_pJsPlatform->Doc_gotoPage(m_pInfo->m_pJsPlatform, nPageNum);
155   }
156
157   FPDF_PAGE FFI_GetPage(FPDF_DOCUMENT document, int nPageIndex) {
158     if (m_pInfo && m_pInfo->FFI_GetPage)
159       return m_pInfo->FFI_GetPage(m_pInfo, document, nPageIndex);
160     return NULL;
161   }
162
163   FPDF_PAGE FFI_GetCurrentPage(FPDF_DOCUMENT document) {
164     if (m_pInfo && m_pInfo->FFI_GetCurrentPage)
165       return m_pInfo->FFI_GetCurrentPage(m_pInfo, document);
166     return NULL;
167   }
168
169   int FFI_GetRotation(FPDF_PAGE page) {
170     if (m_pInfo && m_pInfo->FFI_GetRotation)
171       return m_pInfo->FFI_GetRotation(m_pInfo, page);
172     return 0;
173   }
174
175   void FFI_ExecuteNamedAction(const FX_CHAR* namedAction) {
176     if (m_pInfo && m_pInfo->FFI_ExecuteNamedAction)
177       m_pInfo->FFI_ExecuteNamedAction(m_pInfo, namedAction);
178   }
179
180   void FFI_OnSetFieldInputFocus(void* field,
181                                 FPDF_WIDESTRING focusText,
182                                 FPDF_DWORD nTextLen,
183                                 FX_BOOL bFocus) {
184     if (m_pInfo && m_pInfo->FFI_SetTextFieldFocus)
185       m_pInfo->FFI_SetTextFieldFocus(m_pInfo, focusText, nTextLen, bFocus);
186   }
187
188   void FFI_DoURIAction(const FX_CHAR* bsURI) {
189     if (m_pInfo && m_pInfo->FFI_DoURIAction)
190       m_pInfo->FFI_DoURIAction(m_pInfo, bsURI);
191   }
192
193   void FFI_DoGoToAction(int nPageIndex,
194                         int zoomMode,
195                         float* fPosArray,
196                         int sizeOfArray) {
197     if (m_pInfo && m_pInfo->FFI_DoGoToAction)
198       m_pInfo->FFI_DoGoToAction(m_pInfo, nPageIndex, zoomMode, fPosArray,
199                                 sizeOfArray);
200   }
201
202   FX_BOOL IsJSInitiated() const { return m_pInfo && m_pInfo->m_pJsPlatform; }
203   void SetSDKDocument(CPDFSDK_Document* pFXDoc) { m_pSDKDoc = pFXDoc; }
204   CPDFSDK_Document* GetSDKDocument() const { return m_pSDKDoc; }
205   CPDF_Document* GetPDFDocument() const { return m_pPDFDoc; }
206   CFX_ByteString GetAppName() const { return ""; }
207   IFX_SystemHandler* GetSysHandler() const { return m_pSysHandler; }
208   FPDF_FORMFILLINFO* GetFormFillInfo() const { return m_pInfo; }
209
210   CFFL_IFormFiller* GetIFormFiller();             // Creates if not present.
211   CPDFSDK_AnnotHandlerMgr* GetAnnotHandlerMgr();  // Creates if not present.
212   IJS_Runtime* GetJSRuntime();                    // Creates if not present.
213   CPDFSDK_ActionHandler* GetActionHander();       // Creates if not present.
214
215  private:
216   CPDFSDK_AnnotHandlerMgr* m_pAnnotHandlerMgr;
217   CPDFSDK_ActionHandler* m_pActionHandler;
218   nonstd::unique_ptr<IJS_Runtime> m_pJSRuntime;
219   FPDF_FORMFILLINFO* const m_pInfo;
220   CPDFSDK_Document* m_pSDKDoc;
221   CPDF_Document* const m_pPDFDoc;
222   CFFL_IFormFiller* m_pIFormFiller;
223   IFX_SystemHandler* m_pSysHandler;
224 };
225
226 class CPDFSDK_Document {
227  public:
228   CPDFSDK_Document(CPDF_Document* pDoc, CPDFDoc_Environment* pEnv);
229   ~CPDFSDK_Document();
230
231   CPDFSDK_InterForm* GetInterForm();
232
233   // Gets the document object for the next layer down; for master this is
234   // a CPDF_Document, but for XFA it is a CPDFXFA_Document.
235   CPDF_Document* GetDocument() const { return m_pDoc; }
236
237   // Gets the CPDF_Document, either directly in master, or from the
238   // CPDFXFA_Document for XFA.
239   CPDF_Document* GetPDFDocument() const { return m_pDoc; }
240
241   CPDFSDK_PageView* GetPageView(CPDF_Page* pPDFPage, FX_BOOL ReNew = TRUE);
242   CPDFSDK_PageView* GetPageView(int nIndex);
243   CPDFSDK_PageView* GetCurrentView();
244   void ReMovePageView(CPDF_Page* pPDFPage);
245   void UpdateAllViews(CPDFSDK_PageView* pSender, CPDFSDK_Annot* pAnnot);
246
247   CPDFSDK_Annot* GetFocusAnnot();
248
249   IJS_Runtime* GetJsRuntime();
250
251   FX_BOOL SetFocusAnnot(CPDFSDK_Annot* pAnnot, FX_UINT nFlag = 0);
252   FX_BOOL KillFocusAnnot(FX_UINT nFlag = 0);
253
254   FX_BOOL ExtractPages(const CFX_WordArray& arrExtraPages,
255                        CPDF_Document* pDstDoc);
256   FX_BOOL InsertPages(int nInsertAt,
257                       const CPDF_Document* pSrcDoc,
258                       const CFX_WordArray& arrSrcPages);
259   FX_BOOL ReplacePages(int nPage,
260                        const CPDF_Document* pSrcDoc,
261                        const CFX_WordArray& arrSrcPages);
262
263   void OnCloseDocument();
264
265   int GetPageCount() { return m_pDoc->GetPageCount(); }
266   FX_BOOL GetPermissions(int nFlag);
267   FX_BOOL GetChangeMark() { return m_bChangeMask; }
268   void SetChangeMark() { m_bChangeMask = TRUE; }
269   void ClearChangeMark() { m_bChangeMask = FALSE; }
270   CFX_WideString GetPath();
271   CPDF_Page* GetPage(int nIndex);
272   CPDFDoc_Environment* GetEnv() { return m_pEnv; }
273   void ProcJavascriptFun();
274   FX_BOOL ProcOpenAction();
275   CPDF_OCContext* GetOCContext();
276
277  private:
278   std::map<CPDF_Page*, CPDFSDK_PageView*> m_pageMap;
279   CPDF_Document* m_pDoc;
280   CPDFSDK_InterForm* m_pInterForm;
281   CPDFSDK_Annot* m_pFocusAnnot;
282   CPDFDoc_Environment* m_pEnv;
283   CPDF_OCContext* m_pOccontent;
284   FX_BOOL m_bChangeMask;
285 };
286 class CPDFSDK_PageView final {
287  public:
288   CPDFSDK_PageView(CPDFSDK_Document* pSDKDoc, CPDF_Page* page);
289   ~CPDFSDK_PageView();
290   void PageView_OnDraw(CFX_RenderDevice* pDevice,
291                        CPDF_Matrix* pUser2Device,
292                        CPDF_RenderOptions* pOptions);
293   CPDF_Annot* GetPDFAnnotAtPoint(FX_FLOAT pageX, FX_FLOAT pageY);
294   CPDFSDK_Annot* GetFXAnnotAtPoint(FX_FLOAT pageX, FX_FLOAT pageY);
295   CPDF_Annot* GetPDFWidgetAtPoint(FX_FLOAT pageX, FX_FLOAT pageY);
296   CPDFSDK_Annot* GetFXWidgetAtPoint(FX_FLOAT pageX, FX_FLOAT pageY);
297   CPDFSDK_Annot* GetFocusAnnot();
298   void SetFocusAnnot(CPDFSDK_Annot* pSDKAnnot, FX_UINT nFlag = 0) {
299     m_pSDKDoc->SetFocusAnnot(pSDKAnnot, nFlag);
300   }
301   FX_BOOL KillFocusAnnot(FX_UINT nFlag = 0) {
302     return m_pSDKDoc->KillFocusAnnot(nFlag);
303   }
304   FX_BOOL Annot_HasAppearance(CPDF_Annot* pAnnot);
305
306   CPDFSDK_Annot* AddAnnot(CPDF_Dictionary* pDict);
307   CPDFSDK_Annot* AddAnnot(const FX_CHAR* lpSubType, CPDF_Dictionary* pDict);
308   CPDFSDK_Annot* AddAnnot(CPDF_Annot* pPDFAnnot);
309   FX_BOOL DeleteAnnot(CPDFSDK_Annot* pAnnot);
310   int CountAnnots();
311   CPDFSDK_Annot* GetAnnot(int nIndex);
312   CPDFSDK_Annot* GetAnnotByDict(CPDF_Dictionary* pDict);
313   CPDF_Page* GetPDFPage() { return m_page; }
314   CPDF_Document* GetPDFDocument();
315   CPDFSDK_Document* GetSDKDocument() { return m_pSDKDoc; }
316   FX_BOOL OnLButtonDown(const CPDF_Point& point, FX_UINT nFlag);
317   FX_BOOL OnLButtonUp(const CPDF_Point& point, FX_UINT nFlag);
318   FX_BOOL OnChar(int nChar, FX_UINT nFlag);
319   FX_BOOL OnKeyDown(int nKeyCode, int nFlag);
320   FX_BOOL OnKeyUp(int nKeyCode, int nFlag);
321
322   FX_BOOL OnMouseMove(const CPDF_Point& point, int nFlag);
323   FX_BOOL OnMouseWheel(double deltaX,
324                        double deltaY,
325                        const CPDF_Point& point,
326                        int nFlag);
327   FX_BOOL IsValidAnnot(void* p);
328   void GetCurrentMatrix(CPDF_Matrix& matrix) { matrix = m_curMatrix; }
329   void UpdateRects(CFX_RectArray& rects);
330   void UpdateView(CPDFSDK_Annot* pAnnot);
331   CFX_PtrArray* GetAnnotList() { return &m_fxAnnotArray; }
332
333   int GetPageIndex();
334   void LoadFXAnnots();
335   void SetValid(FX_BOOL bValid) { m_bValid = bValid; }
336   FX_BOOL IsValid() { return m_bValid; }
337   void SetLock(FX_BOOL bLocked) { m_bLocked = bLocked; }
338   FX_BOOL IsLocked() { return m_bLocked; }
339   void TakeOverPage() { m_bTakeOverPage = TRUE; }
340
341  private:
342   void PageView_OnHighlightFormFields(CFX_RenderDevice* pDevice,
343                                       CPDFSDK_Widget* pWidget);
344   CPDF_Matrix m_curMatrix;
345   CPDF_Page* m_page;
346   CPDF_AnnotList* m_pAnnotList;
347   // CPDFSDK_Annot* m_pFocusAnnot;
348   CFX_PtrArray m_fxAnnotArray;
349   CPDFSDK_Document* m_pSDKDoc;
350   CPDFSDK_Widget* m_CaptureWidget;
351   FX_BOOL m_bEnterWidget;
352   FX_BOOL m_bExitWidget;
353   FX_BOOL m_bOnWidget;
354   FX_BOOL m_bValid;
355   FX_BOOL m_bLocked;
356   FX_BOOL m_bTakeOverPage;
357 };
358
359 template <class TYPE>
360 class CGW_ArrayTemplate : public CFX_ArrayTemplate<TYPE> {
361  public:
362   CGW_ArrayTemplate() {}
363   ~CGW_ArrayTemplate() {}
364
365   typedef int (*LP_COMPARE)(TYPE p1, TYPE p2);
366
367   void Sort(LP_COMPARE pCompare, FX_BOOL bAscent = TRUE) {
368     int nSize = this->GetSize();
369     QuickSort(0, nSize - 1, bAscent, pCompare);
370   }
371
372  private:
373   void QuickSort(FX_UINT nStartPos,
374                  FX_UINT nStopPos,
375                  FX_BOOL bAscend,
376                  LP_COMPARE pCompare) {
377     if (nStartPos >= nStopPos)
378       return;
379
380     if ((nStopPos - nStartPos) == 1) {
381       TYPE Value1 = this->GetAt(nStartPos);
382       TYPE Value2 = this->GetAt(nStopPos);
383
384       int iGreate = (*pCompare)(Value1, Value2);
385       if ((bAscend && iGreate > 0) || (!bAscend && iGreate < 0)) {
386         this->SetAt(nStartPos, Value2);
387         this->SetAt(nStopPos, Value1);
388       }
389       return;
390     }
391
392     FX_UINT m = nStartPos + (nStopPos - nStartPos) / 2;
393     FX_UINT i = nStartPos;
394
395     TYPE Value = this->GetAt(m);
396
397     while (i < m) {
398       TYPE temp = this->GetAt(i);
399
400       int iGreate = (*pCompare)(temp, Value);
401       if ((bAscend && iGreate > 0) || (!bAscend && iGreate < 0)) {
402         this->InsertAt(m + 1, temp);
403         this->RemoveAt(i);
404         m--;
405       } else {
406         i++;
407       }
408     }
409
410     FX_UINT j = nStopPos;
411
412     while (j > m) {
413       TYPE temp = this->GetAt(j);
414
415       int iGreate = (*pCompare)(temp, Value);
416       if ((bAscend && iGreate < 0) || (!bAscend && iGreate > 0)) {
417         this->RemoveAt(j);
418         this->InsertAt(m, temp);
419         m++;
420       } else {
421         j--;
422       }
423     }
424
425     if (nStartPos < m)
426       QuickSort(nStartPos, m, bAscend, pCompare);
427     if (nStopPos > m)
428       QuickSort(m, nStopPos, bAscend, pCompare);
429   }
430 };
431
432 #endif  // FPDFSDK_INCLUDE_FSDK_MGR_H_