Add functions to collect bookmarks from Pdfium

pdf/pdfium/pdfium_engine.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "pdf/pdfium/pdfium_engine.h"
 
 #include <math.h>
 
 #include "base/json/json_writer.h"
 #include "base/logging.h"
@@ skipping 12 matching lines @@
 #include "ppapi/c/ppb_core.h"
 #include "ppapi/c/private/ppb_pdf.h"
 #include "ppapi/cpp/dev/memory_dev.h"
 #include "ppapi/cpp/input_event.h"
 #include "ppapi/cpp/instance.h"
 #include "ppapi/cpp/module.h"
 #include "ppapi/cpp/private/pdf.h"
 #include "ppapi/cpp/trusted/browser_font_trusted.h"
 #include "ppapi/cpp/url_response_info.h"
 #include "ppapi/cpp/var.h"
+#include "ppapi/cpp/var_dictionary.h"
 #include "third_party/pdfium/fpdfsdk/include/fpdf_ext.h"
 #include "third_party/pdfium/fpdfsdk/include/fpdf_flatten.h"
 #include "third_party/pdfium/fpdfsdk/include/fpdf_searchex.h"
 #include "third_party/pdfium/fpdfsdk/include/fpdf_sysfontinfo.h"
 #include "third_party/pdfium/fpdfsdk/include/fpdf_transformpage.h"
 #include "third_party/pdfium/fpdfsdk/include/fpdfedit.h"
 #include "third_party/pdfium/fpdfsdk/include/fpdfoom.h"
 #include "third_party/pdfium/fpdfsdk/include/fpdfppo.h"
 #include "third_party/pdfium/fpdfsdk/include/fpdfsave.h"
 #include "third_party/pdfium/fpdfsdk/include/pdfwindow/PDFWindow.h"
@@ skipping 477 matching lines @@
   static const base::char16 kCr[] = {L'\r', L'\0'};
   static const base::char16 kBlank[] = {L'\0'};
   base::ReplaceChars(*text, kCr, kBlank, text);
 #elif defined(OS_WIN)
   // Do nothing
 #else
   NOTIMPLEMENTED();
 #endif
 }
 
+pp::VarDictionary TraverseBookmarks(FPDF_DOCUMENT doc, FPDF_BOOKMARK bookmark) {

[raymes, 2014/12/16 23:35:53]

Add a comment about what this returns (include details about the "root"
bookmark) and what happens when "NULL" is passed in as |bookmark|.

[Alexandre Carlton, 2014/12/17 00:51:13]

Done.

+

[raymes, 2014/12/16 23:35:53]

nit: remove this blank line

[Alexandre Carlton, 2014/12/17 00:51:13]

Done.

+  pp::VarDictionary dict;
+  base::string16 title;
+  size_t buffer_size = FPDFBookmark_GetTitle(bookmark, NULL, 0);
+  if (buffer_size > 1) {

[raymes, 2014/12/16 23:35:54]

buffer_size > 0

[Alexandre Carlton, 2014/12/17 00:51:13]

Done.

+    FPDFBookmark_GetTitle(bookmark,
+            WriteInto(&title, buffer_size + 1), buffer_size);

[raymes, 2014/12/16 23:35:53]

-buffer_size should already include the null characters, so remove the + 1
-use a 4 space indent here

[Alexandre Carlton, 2014/12/17 00:51:13]

Done.

+  }
+  dict.Set(pp::Var("title"), pp::Var(base::UTF16ToUTF8(title)));
+
+

[raymes, 2014/12/16 23:35:54]

nit: remove a blink line here

[Alexandre Carlton, 2014/12/17 00:51:13]

Done.

+  FPDF_DEST dest = FPDFBookmark_GetDest(doc, bookmark);
+  if (dest) {
+    int pageIndex = FPDFDest_GetPageIndex(doc, dest);

[raymes, 2014/12/16 23:35:53]

we don't use camel case in chrome C++ so this should be page_index

[Alexandre Carlton, 2014/12/17 00:51:13]

Done.

+    dict.Set(pp::Var("page"), pp::Var(pageIndex));
+  }

[raymes, 2014/12/16 23:35:53]

if the dest is invalid, should we still set "page" to 0?

[Alexandre Carlton, 2014/12/17 00:51:13]

As discussed, some bookmarks don't have pages at all (they can open urls in a
browser, for example).

+
+  pp::VarArray children;
+
+  FPDF_BOOKMARK childBookmark = FPDFBookmark_GetFirstChild(doc, bookmark);

[raymes, 2014/12/16 23:35:53]

child_bookmark

[Alexandre Carlton, 2014/12/17 00:51:13]

Done.

+  for (int i = 0; childBookmark != NULL; i++) {

[raymes, 2014/12/16 23:35:53]

This is a little unconventional. Maybe just have a while loop.

int child_index = 0;
while (child_bookmark != NULL) {
  ...
  child_index++;
}

[Alexandre Carlton, 2014/12/17 00:51:13]

Done.

+    pp::VarDictionary childDict = TraverseBookmarks(doc, childBookmark);
+    children.Set(i, childDict);
+    childBookmark = FPDFBookmark_GetNextSibling(doc, childBookmark);
+  }
+  dict.Set(pp::Var("children"), children);
+  return dict;
+}
+
 }  // namespace
 
 bool InitializeSDK(void* data) {
   FPDF_InitLibrary(data);
 
 #if defined(OS_LINUX)
   // Font loading doesn't work in the renderer sandbox in Linux.
   FPDF_SetSystemFontInfo(&g_font_info);
 #endif
 
@@ skipping 1750 matching lines @@
     if (pages_[i]->available()) {
       selection_.push_back(PDFiumRange(pages_[i], 0,
                            pages_[i]->GetCharCount()));
     }
 }
 
 int PDFiumEngine::GetNumberOfPages() {
   return pages_.size();
 }
 
+
+pp::VarDictionary PDFiumEngine::GetBookmarks() {
+  pp::VarDictionary dict = TraverseBookmarks(doc_, NULL);

[raymes, 2014/12/16 23:35:53]

as mentioned, let's pull out the array from the root bookmark and return that.

[Alexandre Carlton, 2014/12/17 00:51:13]

Done.

+  return dict;

[raymes, 2014/12/16 23:35:53]

or just:
return TraverseBookmarks(doc_, NULL);

+}
+
 int PDFiumEngine::GetNamedDestinationPage(const std::string& destination) {
   // Look for the destination.
   FPDF_DEST dest = FPDF_GetNamedDestByName(doc_, destination.c_str());
   if (!dest) {
     // Look for a bookmark with the same name.
     base::string16 destination_wide = base::UTF8ToUTF16(destination);
     FPDF_WIDESTRING destination_pdf_wide =
         reinterpret_cast<FPDF_WIDESTRING>(destination_wide.c_str());
     FPDF_BOOKMARK bookmark = FPDFBookmark_Find(doc_, destination_pdf_wide);
     if (!bookmark)
@@ skipping 1586 matching lines @@
     double* height) {
   FPDF_DOCUMENT doc = FPDF_LoadMemDocument(pdf_buffer, pdf_buffer_size, NULL);
   if (!doc)
     return false;
   bool success = FPDF_GetPageSizeByIndex(doc, page_number, width, height) != 0;
   FPDF_CloseDocument(doc);
   return success;
 }
 
 }  // namespace chrome_pdf