Philip P. Moltmann | ac3d58c | 2016-03-04 15:19:21 -0800 | [diff] [blame] | 1 | // Copyright 2015 PDFium Authors. All rights reserved. |
Svet Ganov | e6986e1 | 2015-06-04 14:52:15 -0700 | [diff] [blame] | 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
| 5 | #ifndef TESTING_EMBEDDER_TEST_H_ |
| 6 | #define TESTING_EMBEDDER_TEST_H_ |
| 7 | |
Philip P. Moltmann | ac3d58c | 2016-03-04 15:19:21 -0800 | [diff] [blame] | 8 | #include <map> |
| 9 | #include <memory> |
Svet Ganov | e6986e1 | 2015-06-04 14:52:15 -0700 | [diff] [blame] | 10 | #include <string> |
| 11 | |
Philip P. Moltmann | ac3d58c | 2016-03-04 15:19:21 -0800 | [diff] [blame] | 12 | #include "public/fpdf_dataavail.h" |
| 13 | #include "public/fpdf_ext.h" |
| 14 | #include "public/fpdf_formfill.h" |
| 15 | #include "public/fpdfview.h" |
Svet Ganov | e6986e1 | 2015-06-04 14:52:15 -0700 | [diff] [blame] | 16 | #include "testing/gtest/include/gtest/gtest.h" |
Philip P. Moltmann | ac3d58c | 2016-03-04 15:19:21 -0800 | [diff] [blame] | 17 | #include "testing/test_support.h" |
| 18 | |
| 19 | #ifdef PDF_ENABLE_V8 |
Svet Ganov | e6986e1 | 2015-06-04 14:52:15 -0700 | [diff] [blame] | 20 | #include "v8/include/v8.h" |
Philip P. Moltmann | ac3d58c | 2016-03-04 15:19:21 -0800 | [diff] [blame] | 21 | #endif // PDF_ENABLE_v8 |
Svet Ganov | e6986e1 | 2015-06-04 14:52:15 -0700 | [diff] [blame] | 22 | |
| 23 | class TestLoader; |
| 24 | |
| 25 | // This class is used to load a PDF document, and then run programatic |
| 26 | // API tests against it. |
| 27 | class EmbedderTest : public ::testing::Test, |
| 28 | public UNSUPPORT_INFO, |
| 29 | public IPDF_JSPLATFORM, |
| 30 | public FPDF_FORMFILLINFO { |
| 31 | public: |
| 32 | class Delegate { |
| 33 | public: |
Philip P. Moltmann | ac3d58c | 2016-03-04 15:19:21 -0800 | [diff] [blame] | 34 | virtual ~Delegate() {} |
Svet Ganov | e6986e1 | 2015-06-04 14:52:15 -0700 | [diff] [blame] | 35 | |
| 36 | // Equivalent to UNSUPPORT_INFO::FSDK_UnSupport_Handler(). |
Philip P. Moltmann | ac3d58c | 2016-03-04 15:19:21 -0800 | [diff] [blame] | 37 | virtual void UnsupportedHandler(int type) {} |
Svet Ganov | e6986e1 | 2015-06-04 14:52:15 -0700 | [diff] [blame] | 38 | |
| 39 | // Equivalent to IPDF_JSPLATFORM::app_alert(). |
Philip P. Moltmann | ac3d58c | 2016-03-04 15:19:21 -0800 | [diff] [blame] | 40 | virtual int Alert(FPDF_WIDESTRING message, |
| 41 | FPDF_WIDESTRING title, |
| 42 | int type, |
| 43 | int icon) { |
Svet Ganov | e6986e1 | 2015-06-04 14:52:15 -0700 | [diff] [blame] | 44 | return 0; |
| 45 | } |
| 46 | |
| 47 | // Equivalent to FPDF_FORMFILLINFO::FFI_SetTimer(). |
| 48 | virtual int SetTimer(int msecs, TimerCallback fn) { return 0; } |
| 49 | |
| 50 | // Equivalent to FPDF_FORMFILLINFO::FFI_KillTimer(). |
Philip P. Moltmann | ac3d58c | 2016-03-04 15:19:21 -0800 | [diff] [blame] | 51 | virtual void KillTimer(int id) {} |
| 52 | |
| 53 | // Equivalent to FPDF_FORMFILLINFO::FFI_GetPage(). |
| 54 | virtual FPDF_PAGE GetPage(FPDF_FORMHANDLE form_handle, |
| 55 | FPDF_DOCUMENT document, |
| 56 | int page_index); |
| 57 | |
| 58 | private: |
| 59 | std::map<int, FPDF_PAGE> m_pageMap; |
Svet Ganov | e6986e1 | 2015-06-04 14:52:15 -0700 | [diff] [blame] | 60 | }; |
| 61 | |
| 62 | EmbedderTest(); |
| 63 | virtual ~EmbedderTest(); |
| 64 | |
| 65 | void SetUp() override; |
| 66 | void TearDown() override; |
| 67 | |
Philip P. Moltmann | ac3d58c | 2016-03-04 15:19:21 -0800 | [diff] [blame] | 68 | #ifdef PDF_ENABLE_V8 |
| 69 | // Call before SetUp to pass shared isolate, otherwise PDFium creates one. |
| 70 | void SetExternalIsolate(void* isolate) { |
| 71 | external_isolate_ = static_cast<v8::Isolate*>(isolate); |
| 72 | } |
| 73 | #endif // PDF_ENABLE_V8 |
| 74 | |
Svet Ganov | e6986e1 | 2015-06-04 14:52:15 -0700 | [diff] [blame] | 75 | void SetDelegate(Delegate* delegate) { |
Philip P. Moltmann | ac3d58c | 2016-03-04 15:19:21 -0800 | [diff] [blame] | 76 | delegate_ = delegate ? delegate : default_delegate_.get(); |
Svet Ganov | e6986e1 | 2015-06-04 14:52:15 -0700 | [diff] [blame] | 77 | } |
| 78 | |
| 79 | FPDF_DOCUMENT document() { return document_; } |
| 80 | FPDF_FORMHANDLE form_handle() { return form_handle_; } |
| 81 | |
Philip P. Moltmann | ac3d58c | 2016-03-04 15:19:21 -0800 | [diff] [blame] | 82 | // Create an empty document, and its form fill environment. Returns true |
| 83 | // on success or false on failure. |
| 84 | virtual bool CreateEmptyDocument(); |
| 85 | |
Svet Ganov | e6986e1 | 2015-06-04 14:52:15 -0700 | [diff] [blame] | 86 | // Open the document specified by |filename|, and create its form fill |
| 87 | // environment, or return false on failure. |
Philip P. Moltmann | ac3d58c | 2016-03-04 15:19:21 -0800 | [diff] [blame] | 88 | // The filename is relative to the test data directory where we store all the |
| 89 | // test files. |
| 90 | virtual bool OpenDocument(const std::string& filename, |
| 91 | bool must_linearize = false); |
Svet Ganov | e6986e1 | 2015-06-04 14:52:15 -0700 | [diff] [blame] | 92 | |
| 93 | // Perform JavaScript actions that are to run at document open time. |
| 94 | virtual void DoOpenActions(); |
| 95 | |
| 96 | // Determine the page numbers present in the document. |
| 97 | virtual int GetFirstPageNum(); |
| 98 | virtual int GetPageCount(); |
| 99 | |
| 100 | // Load a specific page of the open document. |
| 101 | virtual FPDF_PAGE LoadPage(int page_number); |
| 102 | |
Philip P. Moltmann | ac3d58c | 2016-03-04 15:19:21 -0800 | [diff] [blame] | 103 | // Load a specific page of the open document using delegate_->GetPage. |
| 104 | // delegate_->GetPage also caches loaded page. |
| 105 | virtual FPDF_PAGE LoadAndCachePage(int page_number); |
| 106 | |
Svet Ganov | e6986e1 | 2015-06-04 14:52:15 -0700 | [diff] [blame] | 107 | // Convert a loaded page into a bitmap. |
| 108 | virtual FPDF_BITMAP RenderPage(FPDF_PAGE page); |
| 109 | |
| 110 | // Relese the resources obtained from LoadPage(). Further use of |page| |
| 111 | // is prohibited after this call is made. |
| 112 | virtual void UnloadPage(FPDF_PAGE page); |
| 113 | |
| 114 | protected: |
Philip P. Moltmann | ac3d58c | 2016-03-04 15:19:21 -0800 | [diff] [blame] | 115 | void SetupFormFillEnvironment(); |
| 116 | |
Svet Ganov | e6986e1 | 2015-06-04 14:52:15 -0700 | [diff] [blame] | 117 | Delegate* delegate_; |
Philip P. Moltmann | ac3d58c | 2016-03-04 15:19:21 -0800 | [diff] [blame] | 118 | std::unique_ptr<Delegate> default_delegate_; |
Svet Ganov | e6986e1 | 2015-06-04 14:52:15 -0700 | [diff] [blame] | 119 | FPDF_DOCUMENT document_; |
| 120 | FPDF_FORMHANDLE form_handle_; |
| 121 | FPDF_AVAIL avail_; |
| 122 | FX_DOWNLOADHINTS hints_; |
| 123 | FPDF_FILEACCESS file_access_; |
| 124 | FX_FILEAVAIL file_avail_; |
Philip P. Moltmann | ac3d58c | 2016-03-04 15:19:21 -0800 | [diff] [blame] | 125 | #ifdef PDF_ENABLE_V8 |
Svet Ganov | e6986e1 | 2015-06-04 14:52:15 -0700 | [diff] [blame] | 126 | v8::Platform* platform_; |
| 127 | v8::StartupData natives_; |
| 128 | v8::StartupData snapshot_; |
Philip P. Moltmann | ac3d58c | 2016-03-04 15:19:21 -0800 | [diff] [blame] | 129 | #endif // PDF_ENABLE_V8 |
| 130 | void* external_isolate_; |
Svet Ganov | e6986e1 | 2015-06-04 14:52:15 -0700 | [diff] [blame] | 131 | TestLoader* loader_; |
| 132 | size_t file_length_; |
Philip P. Moltmann | ac3d58c | 2016-03-04 15:19:21 -0800 | [diff] [blame] | 133 | std::unique_ptr<char, pdfium::FreeDeleter> file_contents_; |
Svet Ganov | e6986e1 | 2015-06-04 14:52:15 -0700 | [diff] [blame] | 134 | |
| 135 | private: |
| 136 | static void UnsupportedHandlerTrampoline(UNSUPPORT_INFO*, int type); |
Philip P. Moltmann | ac3d58c | 2016-03-04 15:19:21 -0800 | [diff] [blame] | 137 | static int AlertTrampoline(IPDF_JSPLATFORM* plaform, |
| 138 | FPDF_WIDESTRING message, |
| 139 | FPDF_WIDESTRING title, |
| 140 | int type, |
| 141 | int icon); |
| 142 | static int SetTimerTrampoline(FPDF_FORMFILLINFO* info, |
| 143 | int msecs, |
Svet Ganov | e6986e1 | 2015-06-04 14:52:15 -0700 | [diff] [blame] | 144 | TimerCallback fn); |
| 145 | static void KillTimerTrampoline(FPDF_FORMFILLINFO* info, int id); |
Philip P. Moltmann | ac3d58c | 2016-03-04 15:19:21 -0800 | [diff] [blame] | 146 | static FPDF_PAGE GetPageTrampoline(FPDF_FORMFILLINFO* info, |
| 147 | FPDF_DOCUMENT document, |
| 148 | int page_index); |
Svet Ganov | e6986e1 | 2015-06-04 14:52:15 -0700 | [diff] [blame] | 149 | }; |
| 150 | |
| 151 | #endif // TESTING_EMBEDDER_TEST_H_ |