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

core/src/fpdfdoc/doc_link.cpp

 // 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
 
 #include "../../include/fpdfdoc/fpdf_doc.h"
 
+CPDF_LinkList::CPDF_LinkList() {}
+
 CPDF_LinkList::~CPDF_LinkList() {
   FX_POSITION pos = m_PageMap.GetStartPosition();
   while (pos) {
     void* key;
     void* value;
     m_PageMap.GetNextAssoc(pos, key, value);
     delete (CFX_PtrArray*)value;
   }
 }
+
 CFX_PtrArray* CPDF_LinkList::GetPageLinks(CPDF_Page* pPage) {
   FX_DWORD objnum = pPage->m_pFormDict->GetObjNum();
-  if (objnum == 0) {
-    return NULL;
-  }
-  CFX_PtrArray* pPageLinkList = NULL;
+  if (objnum == 0)
+    return nullptr;
+
+  CFX_PtrArray* pPageLinkList = nullptr;
   if (!m_PageMap.Lookup((void*)(uintptr_t)objnum, (void*&)pPageLinkList)) {
     pPageLinkList = new CFX_PtrArray;
     m_PageMap.SetAt((void*)(uintptr_t)objnum, pPageLinkList);
     LoadPageLinks(pPage, pPageLinkList);
   }
   return pPageLinkList;
 }
-int CPDF_LinkList::CountLinks(CPDF_Page* pPage) {
-  CFX_PtrArray* pPageLinkList = GetPageLinks(pPage);
-  if (pPageLinkList == NULL) {
-    return 0;
-  }
-  return pPageLinkList->GetSize();
-}
-CPDF_Link CPDF_LinkList::GetLink(CPDF_Page* pPage, int index) {
-  CFX_PtrArray* pPageLinkList = GetPageLinks(pPage);
-  if (!pPageLinkList) {
-    return CPDF_Link();
-  }
-  return CPDF_Link((CPDF_Dictionary*)pPageLinkList->GetAt(index));
-}
+
 CPDF_Link CPDF_LinkList::GetLinkAtPoint(CPDF_Page* pPage,
                                         FX_FLOAT pdf_x,
-                                        FX_FLOAT pdf_y) {
+                                        FX_FLOAT pdf_y,
+                                        int* z_order) {
   CFX_PtrArray* pPageLinkList = GetPageLinks(pPage);
-  if (!pPageLinkList) {
+  if (!pPageLinkList)
     return CPDF_Link();
-  }
+
   int size = pPageLinkList->GetSize();

[Tom Sepez, 2015/08/07 18:14:06]

Nit: wish this were consistent with the index types and tricks used in the
previous file to do the same thing.

[Lei Zhang, 2015/08/07 23:03:41]

Converting |pPageLinkList| from a CFX_PtrArray to a
std::vector<CPDF_Dictionary*>.

   for (int i = size - 1; i >= 0; --i) {
-    CPDF_Link link((CPDF_Dictionary*)pPageLinkList->GetAt(i));
+    CPDF_Dictionary* pAnnot = (CPDF_Dictionary*)pPageLinkList->GetAt(i);
+    if (!pAnnot)
+      continue;
+
+    CPDF_Link link(pAnnot);
     CPDF_Rect rect = link.GetRect();
-    if (rect.Contains(pdf_x, pdf_y)) {
-      return link;
-    }
+    if (!rect.Contains(pdf_x, pdf_y))
+      continue;
+
+    if (z_order)
+      *z_order = i;
+    return link;
   }
   return CPDF_Link();
 }
+
 void CPDF_LinkList::LoadPageLinks(CPDF_Page* pPage, CFX_PtrArray* pList) {
   CPDF_Array* pAnnotList = pPage->m_pFormDict->GetArray("Annots");
-  if (pAnnotList == NULL) {
+  if (!pAnnotList)
     return;
-  }
-  for (FX_DWORD i = 0; i < pAnnotList->GetCount(); i++) {
+
+  for (FX_DWORD i = 0; i < pAnnotList->GetCount(); ++i) {
     CPDF_Dictionary* pAnnot = pAnnotList->GetDict(i);
-    if (pAnnot == NULL) {
-      continue;
-    }
-    if (pAnnot->GetString("Subtype") != "Link") {
-      continue;
-    }
-    pList->Add(pAnnot);
+    bool add_link = (pAnnot && pAnnot->GetString("Subtype") == "Link");
+    // Add non-links as nullptrs to preserve z-order.
+    pList->Add(add_link ? pAnnot : nullptr);
   }
 }
+
 CPDF_Rect CPDF_Link::GetRect() {
   return m_pDict->GetRect("Rect");
 }
 CPDF_Dest CPDF_Link::GetDest(CPDF_Document* pDoc) {
   CPDF_Object* pDest = m_pDict->GetElementValue("Dest");
   if (pDest == NULL) {
     return CPDF_Dest();
   }
   if (pDest->GetType() == PDFOBJ_STRING || pDest->GetType() == PDFOBJ_NAME) {
     CPDF_NameTree name_tree(pDoc, FX_BSTRC("Dests"));
     CFX_ByteStringC name = pDest->GetString();
     return CPDF_Dest(name_tree.LookupNamedDest(pDoc, name));
   }
   if (pDest->GetType() == PDFOBJ_ARRAY) {
     return CPDF_Dest((CPDF_Array*)pDest);
   }
   return CPDF_Dest();
 }
 CPDF_Action CPDF_Link::GetAction() {
   return CPDF_Action(m_pDict->GetDict("A"));
 }