Add API for getting page labels.

fpdfsdk/fpdfdoc.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 "public/fpdf_doc.h"
 
 #include <memory>
 #include <set>
 
 #include "core/fpdfapi/page/cpdf_page.h"
 #include "core/fpdfapi/parser/cpdf_array.h"
 #include "core/fpdfapi/parser/cpdf_document.h"
 #include "core/fpdfdoc/cpdf_bookmark.h"
 #include "core/fpdfdoc/cpdf_bookmarktree.h"
 #include "core/fpdfdoc/cpdf_dest.h"
+#include "core/fpdfdoc/cpdf_pagelabel.h"
 #include "fpdfsdk/fsdk_define.h"
 #include "third_party/base/stl_util.h"
 
 namespace {
 
 CPDF_Bookmark FindBookmark(const CPDF_BookmarkTree& tree,
                            CPDF_Bookmark bookmark,
                            const CFX_WideString& title,
                            std::set<CPDF_Dictionary*>* visited) {
   // Return if already checked to avoid circular calling.
@@ skipping 23 matching lines @@
   if (!page)
     return nullptr;
 
   CPDF_Document* pDoc = page->m_pDocument;
   std::unique_ptr<CPDF_LinkList>* pHolder = pDoc->LinksContext();
   if (!pHolder->get())
     pHolder->reset(new CPDF_LinkList);
   return pHolder->get();
 }
 
+unsigned long Utf16EncodeMaybeCopyAndReturnLength(const CFX_WideString& text,
+                                                  void* buffer,
+                                                  unsigned long buflen) {
+  CFX_ByteString encodedText = text.UTF16LE_Encode();
+  unsigned long len = encodedText.GetLength();
+  if (buffer && buflen >= len)
+    FXSYS_memcpy(buffer, encodedText.c_str(), len);

[dsinclair, 2016/11/22 14:14:58]

Doesn't this need to copy len+1 to get the \0?

[Lei Zhang, 2016/11/23 00:20:43]

This is lifted out of FPDFBookmark_GetTitle(), and that has unit tests...

So I don't think we can change the APIs at this point. All we can do is update
the documentation. FPDFAction_GetFilePath() is wrong as well.

[Lei Zhang, 2016/11/23 01:53:42]

UTF16LE_Encode() already added a double NUL.

+  return len;
+}
+
 }  // namespace
 
 DLLEXPORT FPDF_BOOKMARK STDCALL
 FPDFBookmark_GetFirstChild(FPDF_DOCUMENT document, FPDF_BOOKMARK pDict) {
   CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
   if (!pDoc)
     return nullptr;
   CPDF_BookmarkTree tree(pDoc);
   CPDF_Bookmark bookmark =
       CPDF_Bookmark(ToDictionary(static_cast<CPDF_Object*>(pDict)));
@@ skipping 13 matching lines @@
   return tree.GetNextSibling(bookmark).GetDict();
 }
 
 DLLEXPORT unsigned long STDCALL FPDFBookmark_GetTitle(FPDF_BOOKMARK pDict,
                                                       void* buffer,
                                                       unsigned long buflen) {
   if (!pDict)
     return 0;
   CPDF_Bookmark bookmark(ToDictionary(static_cast<CPDF_Object*>(pDict)));
   CFX_WideString title = bookmark.GetTitle();
-  CFX_ByteString encodedTitle = title.UTF16LE_Encode();
-  unsigned long len = encodedTitle.GetLength();
-  if (buffer && buflen >= len) {
-    FXSYS_memcpy(buffer, encodedTitle.c_str(), len);
-  }
-  return len;
+  return Utf16EncodeMaybeCopyAndReturnLength(title, buffer, buflen);
 }
 
 DLLEXPORT FPDF_BOOKMARK STDCALL FPDFBookmark_Find(FPDF_DOCUMENT document,
                                                   FPDF_WIDESTRING title) {
   if (!title || title[0] == 0)
     return nullptr;
   CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
   if (!pDoc)
     return nullptr;
   CPDF_BookmarkTree tree(pDoc);
@@ skipping 255 matching lines @@
     quadPoints->y2 = pArray->GetNumberAt(quadIndex * 8 + 3);
     quadPoints->x3 = pArray->GetNumberAt(quadIndex * 8 + 4);
     quadPoints->y3 = pArray->GetNumberAt(quadIndex * 8 + 5);
     quadPoints->x4 = pArray->GetNumberAt(quadIndex * 8 + 6);
     quadPoints->y4 = pArray->GetNumberAt(quadIndex * 8 + 7);
     return true;
   }
   return false;
 }
 
-DLLEXPORT unsigned long STDCALL FPDF_GetMetaText(FPDF_DOCUMENT doc,
+DLLEXPORT unsigned long STDCALL FPDF_GetMetaText(FPDF_DOCUMENT document,
                                                  FPDF_BYTESTRING tag,
                                                  void* buffer,
                                                  unsigned long buflen) {
   if (!tag)
     return 0;
-  CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(doc);
+  CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
   if (!pDoc)
     return 0;
   CPDF_Dictionary* pInfo = pDoc->GetInfo();
   if (!pInfo)
     return 0;
   CFX_WideString text = pInfo->GetUnicodeTextFor(tag);
-  // Use UTF-16LE encoding
-  CFX_ByteString encodedText = text.UTF16LE_Encode();
-  unsigned long len = encodedText.GetLength();
-  if (buffer && buflen >= len) {
-    FXSYS_memcpy(buffer, encodedText.c_str(), len);
-  }
-  return len;
+  return Utf16EncodeMaybeCopyAndReturnLength(text, buffer, buflen);
 }
+
+DLLEXPORT unsigned long STDCALL FPDF_GetPagelLabel(FPDF_DOCUMENT document,
+                                                   int page_index,
+                                                   void* buffer,
+                                                   unsigned long buflen) {
+  if (page_index < 0)
+    return 0;
+
+  // CPDF_PageLabel can deal with NULL |document|.
+  CPDF_PageLabel label(CPDFDocumentFromFPDFDocument(document));
+  CFX_WideString text = label.GetLabel(page_index);

[dsinclair, 2016/11/22 14:14:58]

Don't need to store text as it's only used once.

[Lei Zhang, 2016/11/23 01:53:42]

Done.

+  return Utf16EncodeMaybeCopyAndReturnLength(text, buffer, buflen);
+}