Add new public APIs to find the z-order for links and widgets.

core/include/fpdfdoc/fpdf_doc.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 CORE_INCLUDE_FPDFDOC_FPDF_DOC_H_
 #define CORE_INCLUDE_FPDFDOC_FPDF_DOC_H_
 
 #include <map>
+#include <vector>
 
 #include "../../../third_party/base/nonstd_unique_ptr.h"
 #include "../fpdfapi/fpdf_parser.h"
 #include "../fpdfapi/fpdf_render.h"
 
 class CFieldTree;
 class CPDF_AAction;
 class CPDF_Action;
 class CPDF_ActionFields;
 class CPDF_Annot;
 class CPDF_AnnotList;
 class CPDF_ApSettings;
 class CPDF_Bookmark;
 class CPDF_BookmarkTree;
 class CPDF_DefaultAppearance;
 class CPDF_Dest;
 class CPDF_DocJSActions;
 class CPDF_FileSpec;
 class CPDF_FormControl;
 class CPDF_FormField;
 class CPDF_FormNotify;
 class CPDF_IconFit;
 class CPDF_InterForm;
 class CPDF_Link;
-class CPDF_LinkList;
 class CPDF_LWinParam;
 class CPDF_Metadata;
 class CPDF_NumberTree;
 class CPDF_OCContext;
 class CPDF_Page;
 class CPDF_RenderOptions;
 class CPDF_TextObject;
 class CPDF_ViewerPreferences;
 class CXML_Element;
 
@@ skipping 304 matching lines @@
 
   FX_BOOL GetFileName(CFX_WideString& wsFileName) const;
 
   CPDF_Stream* GetFileStream() const;
 
   void SetFileName(const CFX_WideStringC& wsFileName, FX_BOOL bURL = FALSE);
 
  protected:
   CPDF_Object* m_pObj;
 };
+
 class CPDF_LinkList {
  public:
-  CPDF_LinkList(CPDF_Document* pDoc) { m_pDocument = pDoc; }
-
+  CPDF_LinkList();
   ~CPDF_LinkList();
 
-  CPDF_Link GetLinkAtPoint(CPDF_Page* pPage, FX_FLOAT pdf_x, FX_FLOAT pdf_y);
+  CPDF_Link GetLinkAtPoint(CPDF_Page* pPage,
+                           FX_FLOAT pdf_x,
+                           FX_FLOAT pdf_y,
+                           int* z_order);
 
-  int CountLinks(CPDF_Page* pPage);
+ private:
+  const std::vector<CPDF_Dictionary*>* GetPageLinks(CPDF_Page* pPage);
 
-  CPDF_Link GetLink(CPDF_Page* pPage, int index);
+  void LoadPageLinks(CPDF_Page* pPage, std::vector<CPDF_Dictionary*>* pList);
 
-  CPDF_Document* GetDocument() const { return m_pDocument; }
+  std::map<FX_DWORD, std::vector<CPDF_Dictionary*>> m_PageMap;
+};
 
- protected:
-  CPDF_Document* m_pDocument;
-
-  CFX_MapPtrToPtr m_PageMap;
-
-  CFX_PtrArray* GetPageLinks(CPDF_Page* pPage);
-
-  void LoadPageLinks(CPDF_Page* pPage, CFX_PtrArray* pList);
-};
 class CPDF_Link {
  public:
   CPDF_Link() : m_pDict(nullptr) {}
   explicit CPDF_Link(CPDF_Dictionary* pDict) : m_pDict(pDict) {}
 
   CPDF_Dictionary* GetDict() const { return m_pDict; }
 
   CFX_FloatRect GetRect();
   CPDF_Dest GetDest(CPDF_Document* pDoc);
   CPDF_Action GetAction();
@@ skipping 242 matching lines @@
 
   CPDF_FormField* GetField(FX_DWORD index,
                            const CFX_WideString& csFieldName = L"");
 
   void GetAllFieldNames(CFX_WideStringArray& allFieldNames);
 
   FX_BOOL IsValidFormField(const void* pField);
 
   CPDF_FormField* GetFieldByDict(CPDF_Dictionary* pFieldDict) const;
 
-  FX_DWORD CountControls(CFX_WideString csFieldName = L"");
-
-  CPDF_FormControl* GetControl(FX_DWORD index,
-                               CFX_WideString csFieldName = L"");
-
-  FX_BOOL IsValidFormControl(const void* pControl);
-
-  int CountPageControls(CPDF_Page* pPage) const;
-
-  CPDF_FormControl* GetPageControl(CPDF_Page* pPage, int index) const;
-
   CPDF_FormControl* GetControlAtPoint(CPDF_Page* pPage,
                                       FX_FLOAT pdf_x,
-                                      FX_FLOAT pdf_y) const;
+                                      FX_FLOAT pdf_y,
+                                      int* z_order) const;
 
   CPDF_FormControl* GetControlByDict(CPDF_Dictionary* pWidgetDict) const;
 
-  FX_DWORD CountInternalFields(const CFX_WideString& csFieldName = L"") const;
-
-  CPDF_Dictionary* GetInternalField(
-      FX_DWORD index,
-      const CFX_WideString& csFieldName = L"") const;
-
   CPDF_Document* GetDocument() const { return m_pDocument; }
 
   CPDF_Dictionary* GetFormDict() const { return m_pFormDict; }
 
   FX_BOOL NeedConstructAP();
 
   void NeedConstructAP(FX_BOOL bNeedAP);
 
   int CountFieldsInCalculationOrder();
 
@@ skipping 53 matching lines @@
                              FX_BOOL bSimpleFileSpec = FALSE) const;
 
   FX_BOOL ImportFromFDF(const CFDF_Document* pFDFDoc, FX_BOOL bNotify = FALSE);
 
   FX_BOOL ResetForm(const CFX_PtrArray& fields,
                     FX_BOOL bIncludeOrExclude = TRUE,
                     FX_BOOL bNotify = FALSE);
 
   FX_BOOL ResetForm(FX_BOOL bNotify = FALSE);
 
-  void ReloadForm();
-
   CPDF_FormNotify* GetFormNotify() const { return m_pFormNotify; }
 
   void SetFormNotify(const CPDF_FormNotify* pNotify);
 
-  int GetPageWithWidget(int iCurPage, FX_BOOL bNext);
-
   FX_BOOL IsUpdated() { return m_bUpdated; }
 
   void ClearUpdatedFlag() { m_bUpdated = FALSE; }
 
   FX_BOOL HasXFAForm() const;
 
   void FixPageFields(const CPDF_Page* pPage);
 
  protected:
   static FX_BOOL m_bUpdateAP;
@@ skipping 22 matching lines @@
 
   int CompareFieldName(const CFX_ByteString& name1,
                        const CFX_ByteString& name2);
 
   CPDF_Document* m_pDocument;
 
   FX_BOOL m_bGenerateAP;
 
   CPDF_Dictionary* m_pFormDict;
 
-  CFX_MapPtrToPtr m_ControlMap;
+  std::map<const CPDF_Dictionary*, CPDF_FormControl*> m_ControlMap;
 
   CFieldTree* m_pFieldTree;
 
   CFX_ByteString m_bsEncoding;
 
   CPDF_FormNotify* m_pFormNotify;
 
   FX_BOOL m_bUpdated;
   friend class CPDF_FormControl;
   friend class CPDF_FormField;
@@ skipping 23 matching lines @@
     ComboBox,
     Sign
   };
 
   CFX_WideString GetFullName();
 
   Type GetType() { return m_Type; }
 
   FX_DWORD GetFlags() { return m_Flags; }
 
-  CPDF_InterForm* GetInterForm() const { return m_pForm; }
-
   CPDF_Dictionary* GetFieldDict() const { return m_pDict; }
 
   void SetFieldDict(CPDF_Dictionary* pDict) { m_pDict = pDict; }
 
   FX_BOOL ResetField(FX_BOOL bNotify = FALSE);
 
   int CountControls() { return m_ControlList.GetSize(); }
 
   CPDF_FormControl* GetControl(int index) {
     return (CPDF_FormControl*)m_ControlList.GetAt(index);
@@ skipping 146 matching lines @@
 class CPDF_FormControl {
  public:
   CPDF_FormField::Type GetType() { return m_pField->GetType(); }
 
   CPDF_InterForm* GetInterForm() const { return m_pForm; }
 
   CPDF_FormField* GetField() const { return m_pField; }
 
   CPDF_Dictionary* GetWidget() const { return m_pWidgetDict; }
 
-  CFX_FloatRect GetRect();
+  CFX_FloatRect GetRect() const;
 
   void DrawControl(CFX_RenderDevice* pDevice,
                    CFX_AffineMatrix* pMatrix,
                    CPDF_Page* pPage,
                    CPDF_Annot::AppearanceMode mode,
                    const CPDF_RenderOptions* pOptions = NULL);
 
   CFX_ByteString GetCheckedAPState();
 
   CFX_WideString GetExportValue();
@@ skipping 232 matching lines @@
                         FX_FLOAT fc[4],
                         const CFX_ByteStringC& csEntry);
 
   CFX_WideString GetCaption(const CFX_ByteStringC& csEntry);
 
   CPDF_Stream* GetIcon(const CFX_ByteStringC& csEntry);
   friend class CPDF_FormControl;
 };
 
 #endif  // CORE_INCLUDE_FPDFDOC_FPDF_DOC_H_