Implement a delegate for EmbedderTests.

testing/embedder_test.cpp

 // Copyright (c) 2015 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.
 
 #include "embedder_test.h"
 
 #include <limits.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 
 #include <list>
 #include <string>
 #include <utility>
 #include <vector>
 
-#include "../fpdfsdk/include/fpdf_ext.h"
 #include "../fpdfsdk/include/fpdftext.h"
 #include "../fpdfsdk/include/fpdfview.h"
 #include "../core/include/fxcrt/fx_system.h"
 #include "v8/include/v8.h"
 
 #ifdef _WIN32
 #define snprintf _snprintf
 #define PATH_SEPARATOR '\\'
 #else
 #define PATH_SEPARATOR '/'
@@ skipping 59 matching lines @@
     return false;
   }
   result_data->data = const_cast<const char*>(data_buffer);
   result_data->raw_size = data_length;
   return true;
 }
 #endif  // V8_USE_EXTERNAL_STARTUP_DATA
 
 }  // namespace
 
-int Form_Alert(IPDF_JSPLATFORM*, FPDF_WIDESTRING, FPDF_WIDESTRING, int, int) {
-  printf("Form_Alert called.\n");
-  return 0;
-}
+class EmbedderTestDefaultDelegate : public EmbedderTest::Delegate {
+ public:
+  int Alert(FPDF_WIDESTRING, FPDF_WIDESTRING, int, int) override {
+    printf("Form_Alert called.\n");
+    return 0;
+  }
 
-void Unsupported_Handler(UNSUPPORT_INFO*, int type) {
-  std::string feature = "Unknown";
-  switch (type) {
-    case FPDF_UNSP_DOC_XFAFORM:
-      feature = "XFA";
-      break;
-    case FPDF_UNSP_DOC_PORTABLECOLLECTION:
-      feature = "Portfolios_Packages";
-      break;
-    case FPDF_UNSP_DOC_ATTACHMENT:
-    case FPDF_UNSP_ANNOT_ATTACHMENT:
-      feature = "Attachment";
-      break;
-    case FPDF_UNSP_DOC_SECURITY:
-      feature = "Rights_Management";
-      break;
-    case FPDF_UNSP_DOC_SHAREDREVIEW:
-      feature = "Shared_Review";
-      break;
-    case FPDF_UNSP_DOC_SHAREDFORM_ACROBAT:
-    case FPDF_UNSP_DOC_SHAREDFORM_FILESYSTEM:
-    case FPDF_UNSP_DOC_SHAREDFORM_EMAIL:
-      feature = "Shared_Form";
-      break;
-    case FPDF_UNSP_ANNOT_3DANNOT:
-      feature = "3D";
-      break;
-    case FPDF_UNSP_ANNOT_MOVIE:
-      feature = "Movie";
-      break;
-    case FPDF_UNSP_ANNOT_SOUND:
-      feature = "Sound";
-      break;
-    case FPDF_UNSP_ANNOT_SCREEN_MEDIA:
-    case FPDF_UNSP_ANNOT_SCREEN_RICHMEDIA:
-      feature = "Screen";
-      break;
-    case FPDF_UNSP_ANNOT_SIG:
-      feature = "Digital_Signature";
-      break;
+  void UnsupportedHandler(int type) {
+    std::string feature = "Unknown";
+    switch (type) {
+      case FPDF_UNSP_DOC_XFAFORM:
+        feature = "XFA";
+        break;
+      case FPDF_UNSP_DOC_PORTABLECOLLECTION:
+        feature = "Portfolios_Packages";
+        break;
+      case FPDF_UNSP_DOC_ATTACHMENT:
+      case FPDF_UNSP_ANNOT_ATTACHMENT:
+        feature = "Attachment";
+        break;
+      case FPDF_UNSP_DOC_SECURITY:
+        feature = "Rights_Management";
+        break;
+      case FPDF_UNSP_DOC_SHAREDREVIEW:
+        feature = "Shared_Review";
+        break;
+      case FPDF_UNSP_DOC_SHAREDFORM_ACROBAT:
+      case FPDF_UNSP_DOC_SHAREDFORM_FILESYSTEM:
+      case FPDF_UNSP_DOC_SHAREDFORM_EMAIL:
+        feature = "Shared_Form";
+        break;
+      case FPDF_UNSP_ANNOT_3DANNOT:
+        feature = "3D";
+        break;
+      case FPDF_UNSP_ANNOT_MOVIE:
+        feature = "Movie";
+        break;
+      case FPDF_UNSP_ANNOT_SOUND:
+        feature = "Sound";
+        break;
+      case FPDF_UNSP_ANNOT_SCREEN_MEDIA:
+      case FPDF_UNSP_ANNOT_SCREEN_RICHMEDIA:
+        feature = "Screen";
+        break;
+      case FPDF_UNSP_ANNOT_SIG:
+        feature = "Digital_Signature";
+        break;
+    }
+    printf("Unsupported feature: %s.\n", feature.c_str());
   }
-  printf("Unsupported feature: %s.\n", feature.c_str());
-}
+};
 
 class TestLoader {
  public:
   TestLoader(const char* pBuf, size_t len);
 
   const char* m_pBuf;
   size_t m_Len;
 };
 
 TestLoader::TestLoader(const char* pBuf, size_t len)
     : m_pBuf(pBuf), m_Len(len) {
 }
 
 int Get_Block(void* param, unsigned long pos, unsigned char* pBuf,
               unsigned long size) {
   TestLoader* pLoader = (TestLoader*) param;
   if (pos + size < pos || pos + size > pLoader->m_Len) return 0;
   memcpy(pBuf, pLoader->m_pBuf + pos, size);
   return 1;
 }
 
 bool Is_Data_Avail(FX_FILEAVAIL* pThis, size_t offset, size_t size) {
   return true;
 }
 
 void Add_Segment(FX_DOWNLOADHINTS* pThis, size_t offset, size_t size) {
 }
 
+EmbedderTest::EmbedderTest() :
+      document_(nullptr),
+      form_handle_(nullptr),
+      avail_(nullptr),
+      loader_(nullptr),
+      file_length_(0),
+      file_contents_(nullptr) {
+  memset(&hints_, 0, sizeof(hints_));
+  memset(&file_access_, 0, sizeof(file_access_));
+  memset(&file_avail_, 0, sizeof(file_avail_));
+  original_delegate_ = new EmbedderTestDefaultDelegate();
+  delegate_ = original_delegate_;
+}
+
+EmbedderTest::~EmbedderTest() {
+  delete original_delegate_;
+}
+
 void EmbedderTest::SetUp() {
     v8::V8::InitializeICU();
 
 #ifdef V8_USE_EXTERNAL_STARTUP_DATA
     ASSERT_TRUE(GetExternalData(g_exe_path_, "natives_blob.bin", &natives_));
     ASSERT_TRUE(GetExternalData(g_exe_path_, "snapshot_blob.bin", &snapshot_));
     v8::V8::SetNativesDataBlob(&natives_);
     v8::V8::SetSnapshotDataBlob(&snapshot_);
 #endif  // V8_USE_EXTERNAL_STARTUP_DATA
 
     FPDF_InitLibrary();
 
-    UNSUPPORT_INFO unsuppored_info;
-    memset(&unsuppored_info, '\0', sizeof(unsuppored_info));
-    unsuppored_info.version = 1;
-    unsuppored_info.FSDK_UnSupport_Handler = Unsupported_Handler;
-    FSDK_SetUnSpObjProcessHandler(&unsuppored_info);

[Lei Zhang, 2015/02/25 23:02:50]

I'm surprised this ever worked. Wouldn't |unsuppored_info| have been destroyed
at the end of the function?

[Tom Sepez, 2015/02/25 23:25:22]

I thought it copied its contents, but further inspection disproves that !!!

+    UNSUPPORT_INFO *info = static_cast<UNSUPPORT_INFO*>(this);

[Lei Zhang, 2015/02/25 23:02:50]

nit: * on the left

[Tom Sepez, 2015/02/25 23:25:22]

Done.

+    memset(info, 0, sizeof(UNSUPPORT_INFO));
+    info->version = 1;
+    info->FSDK_UnSupport_Handler = UnsupportedHandlerTrampoline;
+    FSDK_SetUnSpObjProcessHandler(info);
   }
 
 void EmbedderTest::TearDown() {
   if (form_handle_) {
     FORM_DoDocumentAAction(form_handle_, FPDFDOC_AACTION_WC);
     FPDFDOC_ExitFormFillEnvironment(form_handle_);
   }
   if (document_) {
     FPDF_CloseDocument(document_);
   }
@@ skipping 29 matching lines @@
 
   if (!FPDFAvail_IsLinearized(avail_)) {
     document_ = FPDF_LoadCustomDocument(&file_access_, NULL);
   } else {
     document_ = FPDFAvail_GetDocument(avail_, NULL);
   }
 
   (void) FPDF_GetDocPermissions(document_);
   (void) FPDFAvail_IsFormAvail(avail_, &hints_);
 
-  IPDF_JSPLATFORM platform_callbacks;
-  memset(&platform_callbacks, '\0', sizeof(platform_callbacks));
-  platform_callbacks.version = 1;
-  platform_callbacks.app_alert = Form_Alert;
+  IPDF_JSPLATFORM* platform = static_cast<IPDF_JSPLATFORM*>(this);
+  memset(platform, 0, sizeof(IPDF_JSPLATFORM));
+  platform->version = 1;
+  platform->app_alert = AlertTrampoline;
 
-  FPDF_FORMFILLINFO form_callbacks;
-  memset(&form_callbacks, '\0', sizeof(form_callbacks));
-  form_callbacks.version = 1;
-  form_callbacks.m_pJsPlatform = &platform_callbacks;
+  FPDF_FORMFILLINFO* formfillinfo = static_cast<FPDF_FORMFILLINFO*>(this);
+  memset(formfillinfo, 0, sizeof(FPDF_FORMFILLINFO));
+  formfillinfo->version = 1;
+  formfillinfo->m_pJsPlatform = platform;
 
-  form_handle_ = FPDFDOC_InitFormFillEnvironment(document_, &form_callbacks);
+  form_handle_ = FPDFDOC_InitFormFillEnvironment(document_, formfillinfo);
   FPDF_SetFormFieldHighlightColor(form_handle_, 0, 0xFFE4DD);
   FPDF_SetFormFieldHighlightAlpha(form_handle_, 100);
 
   return true;
 }
 
 void EmbedderTest::DoOpenActions() {
   FORM_DoDocumentJSAction(form_handle_);
   FORM_DoDocumentOpenAction(form_handle_);
 }
@@ skipping 31 matching lines @@
   FPDF_FFLDraw(form_handle_, bitmap, page, 0, 0, width, height, 0, 0);
   return bitmap;
 }
 
 void EmbedderTest::UnloadPage(FPDF_PAGE page) {
   FORM_DoPageAAction(page, form_handle_, FPDFPAGE_AACTION_CLOSE);
   FORM_OnBeforeClosePage(page, form_handle_);
   FPDF_ClosePage(page);
 }
 
+// static
+void EmbedderTest::UnsupportedHandlerTrampoline(UNSUPPORT_INFO* info,
+                                                int type) {
+  EmbedderTest* test = static_cast<EmbedderTest*>(info);
+  if (test->delegate_) {

[Lei Zhang, 2015/02/25 23:02:51]

Should we just assume |delegate_| is always valid? i.e. SetDelegate(nullptr) is
disallowed.

[Tom Sepez, 2015/02/25 23:25:22]

Yep.  In fact, we can make SetDelegate(0) mean restore default since we still
have it.

+    test->delegate_->UnsupportedHandler(type);
+  }
+}
+
+// static
+int EmbedderTest::AlertTrampoline(IPDF_JSPLATFORM* platform,
+                                  FPDF_WIDESTRING message,
+                                  FPDF_WIDESTRING title,
+                                  int type,
+                                  int icon) {
+  EmbedderTest* test = static_cast<EmbedderTest*>(platform);
+  if (!test->delegate_) {
+    return 0;
+  }
+  return test->delegate_->Alert(message, title, type, icon);
+}
+
 // Can't use gtest-provided main since we need to stash the path to the
 // executable in order to find the external V8 binary data files.
 int main(int argc, char** argv) {
   g_exe_path_ = argv[0];
   testing::InitGoogleTest(&argc, argv);
   return RUN_ALL_TESTS();
 }