XFA: Fix a crashier in SetFocus()

public/fpdf_formfill.h

 // Copyright 2014 PDFium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
 
 #ifndef PUBLIC_FPDF_FORMFILL_H_
 #define PUBLIC_FPDF_FORMFILL_H_
 
 #include "fpdfview.h"
@@ skipping 691 matching lines @@
   *   pointer to IPDF_JSPLATFORM interface
   **/
   IPDF_JSPLATFORM* m_pJsPlatform;
 
 #ifdef PDF_ENABLE_XFA
   /* Version 2. */
   /**
     * Method: FFI_DisplayCaret
     *           This method will show the caret at specified position.
     * Interface Version:
-    *           1
+    *           2

[Tom Sepez, 2016/01/29 16:47:11]

Thanks for correcting these comments.

     * Implementation Required:
     *           yes
     * Parameters:
     *       pThis           -   Pointer to the interface structure itself.
     *       page            -   Handle to page. Returned by FPDF_LoadPage
     *function.
     *       left            -   Left position of the client area in PDF page
     *coordinate.
     *       top             -   Top position of the client area in PDF page
     *coordinate.
     *       right           -   Right position of the client area in PDF page
     *coordinate.
     *       bottom          -   Bottom position of the client area in PDF page
     *coordinate.
     * Return value:
     *       None.
     **/
   void (*FFI_DisplayCaret)(struct _FPDF_FORMFILLINFO* pThis,
                            FPDF_PAGE page,
                            FPDF_BOOL bVisible,
                            double left,
                            double top,
                            double right,
                            double bottom);
 
   /**
   * Method: FFI_GetCurrentPageIndex
   *           This method will get the current page index.
   * Interface Version:
-  *           1
+  *           2
   * Implementation Required:
   *           yes
   * Parameters:
   *       pThis           -   Pointer to the interface structure itself.
   *       document        -   Handle to document. Returned by FPDF_LoadDocument
   *function.
   * Return value:
   *       The index of current page.
   **/
   int (*FFI_GetCurrentPageIndex)(struct _FPDF_FORMFILLINFO* pThis,
                                  FPDF_DOCUMENT document);
 
   /**
   * Method: FFI_SetCurrentPage
   *           This method will set the current page.
   * Interface Version:
-  *           1
+  *           2
   * Implementation Required:
   *           yes
   * Parameters:
   *       pThis           -   Pointer to the interface structure itself.
   *       document        -   Handle to document. Returned by FPDF_LoadDocument
   *function.
   *       iCurPage        -   The index of the PDF page.
   * Return value:
   *       None.
   **/
   void (*FFI_SetCurrentPage)(struct _FPDF_FORMFILLINFO* pThis,
                              FPDF_DOCUMENT document,
                              int iCurPage);
 
   /**
   * Method: FFI_GotoURL
   *           This method will link to the specified URL.
   * Interface Version:
-  *           1
+  *           2
   * Implementation Required:
   *           no
   * Parameters:
   *       pThis           -   Pointer to the interface structure itself.
   *       document        -   Handle to document. Returned by FPDF_LoadDocument
   *function.
   *       wsURL           -   The string value of the URL, in UTF-16LE format.
   * Return value:
   *       None.
   **/
   void (*FFI_GotoURL)(struct _FPDF_FORMFILLINFO* pThis,
                       FPDF_DOCUMENT document,
                       FPDF_WIDESTRING wsURL);
 
   /**
   * Method: FFI_GetPageViewRect
   *           This method will get the current page view rectangle.
   * Interface Version:
-  *           1
+  *           2
   * Implementation Required:
   *           yes
   * Parameters:
   *       pThis           -   Pointer to the interface structure itself.
   *       page            -   Handle to page. Returned by FPDF_LoadPage
   *function.
   *       left            -   The pointer to receive left position of the page
   *view area in PDF page coordinate.
   *       top             -   The pointer to receive top position of the page
   *view area in PDF page coordinate.
   *       right           -   The pointer to receive right position of the
   *client area in PDF page coordinate.
   *       bottom          -   The pointer to receive bottom position of the
   *client area in PDF page coordinate.
   * Return value:
   *       None.
   **/
   void (*FFI_GetPageViewRect)(struct _FPDF_FORMFILLINFO* pThis,
                               FPDF_PAGE page,
                               double* left,
                               double* top,
                               double* right,
                               double* bottom);
   /**
   * Method: FFI_PopupMenu
   *           This method will track the right context menu for XFA fields.
   * Interface Version:
-  *           1
+  *           2
   * Implementation Required:
   *           yes
   * Parameters:
   *       pThis           -   Pointer to the interface structure itself.
   *       page            -   Handle to page. Returned by FPDF_LoadPage
   *function.
   *       hWidget         -   Handle to XFA fields.
   *       menuFlag        -   The menu flags. Please refer to macro definition
   *of FXFA_MEMU_XXX and this can be one or a combination of these macros.
   *       x               -   X position of the client area in PDF page
   *coordinate.
   *       y               -   Y position of the client area in PDF page
   *coordinate.
   * Return value:
   *       TRUE indicates success; otherwise false.
   **/
   FPDF_BOOL (*FFI_PopupMenu)(struct _FPDF_FORMFILLINFO* pThis, FPDF_PAGE page, FPDF_WIDGET hWidget, int menuFlag, float x, float y);
 
   /**
   * Method: FFI_OpenFile
   *           This method will open the specified file with the specified mode.
   * Interface Version
-  *           1
+  *           2
   * Implementation Required:
   *           yes
   * Parameters:
   *       pThis           -   Pointer to the interface structure itself.
   *       fileFlag        -   The file flag.Please refer to macro definition of
   *FXFA_SAVEAS_XXX and this can be one of these macros.
   *       wsURL           -   The string value of the file URL, in UTF-16LE
   *format.
   *       mode            -   The mode for open file.
   * Return value:
   *       The handle to FPDF_FILEHANDLER.
   **/
   FPDF_FILEHANDLER* (*FFI_OpenFile)(struct _FPDF_FORMFILLINFO* pThis,
                                     int fileFlag,
                                     FPDF_WIDESTRING wsURL,
                                     const char* mode);
 
   /**
   * Method: FFI_EmailTo
   *           This method will email the specified file stream to the specified
   *contacter.
   * Interface Version:
-  *           1
+  *           2
   * Implementation Required:
   *           yes
   * Parameters:
   *       pThis           -   Pointer to the interface structure itself.
   *       pFileHandler    -   Handle to the FPDF_FILEHANDLER.
   *       pTo             -   A semicolon-delimited list of recipients for the
   *message,in UTF-16LE format.
   *       pSubject        -   The subject of the message,in UTF-16LE format.
   *       pCC             -   A semicolon-delimited list of CC recipients for
   *the message,in UTF-16LE format.
@@ skipping 10 matching lines @@
                       FPDF_WIDESTRING pSubject,
                       FPDF_WIDESTRING pCC,
                       FPDF_WIDESTRING pBcc,
                       FPDF_WIDESTRING pMsg);
 
   /**
   * Method: FFI_UploadTo
   *           This method will get upload the specified file stream to the
   *specified URL.
   * Interface Version:
-  *           1
+  *           2
   * Implementation Required:
   *           yes
   * Parameters:
   *       pThis           -   Pointer to the interface structure itself.
   *       pFileHandler    -   Handle to the FPDF_FILEHANDLER.
   *       fileFlag        -   The file flag.Please refer to macro definition of
   *FXFA_SAVEAS_XXX and this can be one of these macros.
   *       uploadTo        -   Pointer to the URL path, in UTF-16LE format.
   * Return value:
   *       None.
   **/
   void (*FFI_UploadTo)(struct _FPDF_FORMFILLINFO* pThis,
                        FPDF_FILEHANDLER* fileHandler,
                        int fileFlag,
                        FPDF_WIDESTRING uploadTo);
 
   /**
   * Method: FFI_GetPlatform
   *           This method will get the current platform.
   * Interface Version:
-  *           1
+  *           2
   * Implementation Required:
   *           yes
   * Parameters:
   *       pThis           -   Pointer to the interface structure itself.
   *       platform        -   Pointer to the data buffer to receive the
   *platform.Can be NULL,in UTF-16LE format.
   *       length          -   The length of the buffer, number of bytes. Can be
   *0.
   * Return value:
   *       The length of the buffer, number of bytes.
   **/
   int (*FFI_GetPlatform)(struct _FPDF_FORMFILLINFO* pThis,
                          void* platform,
                          int length);
 
   /**
   * Method: FFI_GetLanguage
   *           This method will get the current language.
   * Interface Version:
-  *           1
+  *           2
   * Implementation Required:
   *           yes
   * Parameters:
   *       pThis           -   Pointer to the interface structure itself.
   *       language        -   Pointer to the data buffer to receive the current
   *language.Can be NULL.
   *       length          -   The length of the buffer, number of bytes. Can be
   *0.
   * Return value:
   *       The length of the buffer, number of bytes.
   **/
   int (*FFI_GetLanguage)(struct _FPDF_FORMFILLINFO* pThis,
                          void* language,
                          int length);
 
   /**
   * Method: FFI_DownloadFromURL
   *           This method will download the specified file from the URL.
   * Interface Version:
-  *           1
+  *           2
   * Implementation Required:
   *           yes
   * Parameters:
   *       pThis           -   Pointer to the interface structure itself.
   *       URL             -   The string value of the file URL, in UTF-16LE
   *format.
   * Return value:
   *       The handle to FPDF_FILEHANDLER.
   **/
   FPDF_LPFILEHANDLER  (*FFI_DownloadFromURL)(struct _FPDF_FORMFILLINFO* pThis, FPDF_WIDESTRING URL);
   /**
   * Method: FFI_PostRequestURL
   *           This method will post the request to the server URL.
   * Interface Version:
-  *           1
+  *           2
   * Implementation Required:
   *           yes
   * Parameters:
   *       pThis           -   Pointer to the interface structure itself.
   *       wsURL           -   The string value of the server URL, in UTF-16LE
   *format.
   *       wsData          -   The post data,in UTF-16LE format.
   *       wsContentType   -   The content type of the request data,in UTF-16LE
   *format.
   *       wsEncode        -   The encode type,in UTF-16LE format.
   *       wsHeader        -   The request header,in UTF-16LE format.
   *       response        -   Pointer to the FPDF_BSTR to receive the response
   *data from server,,in UTF-16LE format.
   * Return value:
   *       TRUE indicates success, otherwise FALSE.
   **/
   FPDF_BOOL   (*FFI_PostRequestURL)(struct _FPDF_FORMFILLINFO* pThis, FPDF_WIDESTRING wsURL, FPDF_WIDESTRING wsData, FPDF_WIDESTRING wsContentType, FPDF_WIDESTRING wsEncode, FPDF_WIDESTRING wsHeader, FPDF_BSTR* respone);
 
   /**
   * Method: FFI_PutRequestURL
   *           This method will put the request to the server URL.
   * Interface Version:
-  *           1
+  *           2
   * Implementation Required:
   *           yes
   * Parameters:
   *       pThis           -   Pointer to the interface structure itself.
   *       wsURL           -   The string value of the server URL, in UTF-16LE
   *format.
   *       wsData          -   The put data, in UTF-16LE format.
   *       wsEncode        -   The encode type, in UTR-16LE format.
   * Return value:
   *       TRUE indicates success, otherwise FALSE.
   **/
   FPDF_BOOL   (*FFI_PutRequestURL)(struct _FPDF_FORMFILLINFO* pThis, FPDF_WIDESTRING wsURL, FPDF_WIDESTRING wsData, FPDF_WIDESTRING wsEncode);
+
+  /**
+  * Method: FFI_PageEvent
+  *           This method will notify applications when a page is deleted or
+  *removed.
+  * Interface Version:
+  *           2
+  * Implementation Required:
+  *           yes
+  * Parameters:
+  *       pThis           -   Pointer to the interface structure itself.
+  *       iPageIndex      -   The index of which page is modified.
+  *       iEventType      -   Type of events. It can be one of
+  *the following marcos:
+  *                           1. FXFA_PAGEVIEWEVENT_POSTADDED
+  *                           2. FXFA_PAGEVIEWEVENT_POSTREMOVED
+  * Return value:
+  *       None.
+  **/
+  void (*FFI_PageEvent)(struct _FPDF_FORMFILLINFO* pThis,
+                        int iPageIndex,
+                        int iEventType);
+
 #endif  // PDF_ENABLE_XFA
 
 } FPDF_FORMFILLINFO;
 
 /**
  * Function: FPDFDOC_InitFormFillEnvironment
  *          Init form fill environment.
  * Comments:
  *          This function should be called before any form fill operation.
  * Parameters:
@@ skipping 662 matching lines @@
 FPDF_StringHandleAddString(FPDF_STRINGHANDLE stringHandle,
                            FPDF_BYTESTRING bsText,
                            FPDF_DWORD size);
 #endif  // PDF_ENABLE_XFA
 
 #ifdef __cplusplus
 }
 #endif
 
 #endif  // PUBLIC_FPDF_FORMFILL_H_