Add one-pager examples for PDFium initialization.
We typically point developers at pdfium_test.cc as an example of how
to initialize and call into PDFium, but that has become vastly complex
over the years as we've added features to meet our testing needs. Here
we have two stripped-down self-contained examples that hopefully will
form a starting point for other developers.
-- I've omitted building binaries from these as part of the PDFium
build scripts, since that would bloat the output directories.
Change-Id: I89c40c2656ba85e918db0d34352d438346024ee4
Reviewed-on: https://pdfium-review.googlesource.com/c/pdfium/+/76290
Commit-Queue: Tom Sepez <tsepez@chromium.org>
Reviewed-by: Hui Yingst <nigi@chromium.org>
diff --git a/samples/simple_no_v8.c b/samples/simple_no_v8.c
new file mode 100644
index 0000000..e3b15d1
--- /dev/null
+++ b/samples/simple_no_v8.c
@@ -0,0 +1,52 @@
+// Copyright 2020 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.
+
+// No-frills example of how to initialize and call into a PDFium environment,
+// from C. The PDFium API is compatible with C (the C++ internals are hidden
+// beneath it).
+
+#include <string.h>
+
+#include "public/fpdf_edit.h"
+#include "public/fpdf_formfill.h"
+#include "public/fpdfview.h"
+
+int main(int argc, const char* argv[]) {
+ // The PDF library must be initialized before creating a document.
+ FPDF_LIBRARY_CONFIG config;
+ memset(&config, 0, sizeof(config));
+ config.version = 3;
+ FPDF_InitLibraryWithConfig(&config);
+
+ // The document must be created before creating a form-fill environment.
+ // Typically use FPDF_LoadDocument() for pre-existing documents. Here, we
+ // create a new blank document for simplicity.
+ FPDF_DOCUMENT doc = FPDF_CreateNewDocument();
+
+ FPDF_FORMFILLINFO formfillinfo;
+ memset(&formfillinfo, 0, sizeof(formfillinfo));
+ formfillinfo.version = 1;
+
+ FPDF_FORMHANDLE form_handle =
+ FPDFDOC_InitFormFillEnvironment(doc, &formfillinfo);
+
+ // Typically use FPDF_LoadPage() for pre-existing pages. Here, we
+ // create a new blank page for simplicity.
+ FPDF_PAGE page = FPDFPage_New(doc, 0, 640.0, 480.0);
+ FORM_OnAfterLoadPage(page, form_handle);
+ FORM_DoPageAAction(page, form_handle, FPDFPAGE_AACTION_OPEN);
+
+ // Do actual work with the page here.
+
+ FORM_DoPageAAction(page, form_handle, FPDFPAGE_AACTION_CLOSE);
+ FORM_OnBeforeClosePage(page, form_handle);
+ FPDF_ClosePage(page);
+
+ FORM_DoDocumentAAction(form_handle, FPDFDOC_AACTION_WC);
+ FPDFDOC_ExitFormFillEnvironment(form_handle);
+ FPDF_CloseDocument(doc);
+ FPDF_DestroyLibrary();
+
+ return 0;
+}
diff --git a/samples/simple_with_v8.cc b/samples/simple_with_v8.cc
new file mode 100644
index 0000000..e4081fb
--- /dev/null
+++ b/samples/simple_with_v8.cc
@@ -0,0 +1,76 @@
+// Copyright 2020 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.
+
+// No-frills example of how to initialize and call into a PDFium environment
+// including V8 support (but not XFA) from C++. Since the V8 API is in C++,
+// C++ is required in this case (not just C).
+
+#include <string.h>
+
+#include "public/fpdf_edit.h"
+#include "public/fpdf_formfill.h"
+#include "public/fpdfview.h"
+#include "v8/include/libplatform/libplatform.h"
+#include "v8/include/v8.h"
+
+int main(int argc, const char* argv[]) {
+ // V8 must be initialized before the PDFium library if using V8.
+ v8::V8::InitializeICUDefaultLocation(argv[0]);
+ v8::V8::InitializeExternalStartupData(argv[0]);
+ v8::Platform* platform = v8::platform::NewDefaultPlatform().release();
+ v8::V8::InitializePlatform(platform);
+ v8::V8::Initialize();
+
+ v8::Isolate::CreateParams params;
+ params.array_buffer_allocator = static_cast<v8::ArrayBuffer::Allocator*>(
+ FPDF_GetArrayBufferAllocatorSharedInstance());
+ v8::Isolate* isolate = v8::Isolate::New(params);
+
+ // The PDF library must be initialized before creating a document.
+ FPDF_LIBRARY_CONFIG config;
+ memset(&config, 0, sizeof(config));
+ config.version = 3;
+ config.m_pIsolate = isolate;
+ config.m_pPlatform = platform;
+ FPDF_InitLibraryWithConfig(&config);
+
+ // The document must be created before creating a form-fill environment.
+ // Typically use FPDF_LoadDocument() for pre-existing documents. Here, we
+ // create a new blank document for simplicity.
+ FPDF_DOCUMENT doc = FPDF_CreateNewDocument();
+
+ IPDF_JSPLATFORM jsplatform;
+ memset(&jsplatform, 0, sizeof(jsplatform));
+
+ FPDF_FORMFILLINFO formfillinfo;
+ memset(&formfillinfo, 0, sizeof(formfillinfo));
+ formfillinfo.version = 1;
+ formfillinfo.m_pJsPlatform = &jsplatform;
+
+ FPDF_FORMHANDLE form_handle =
+ FPDFDOC_InitFormFillEnvironment(doc, &formfillinfo);
+
+ // Typically use FPDF_LoadPage() for pre-existing pages. Here, we
+ // create a new blank page for simplicity.
+ FPDF_PAGE page = FPDFPage_New(doc, 0, 640.0, 480.0);
+ FORM_OnAfterLoadPage(page, form_handle);
+ FORM_DoPageAAction(page, form_handle, FPDFPAGE_AACTION_OPEN);
+
+ // Do actual work with the page here.
+
+ FORM_DoPageAAction(page, form_handle, FPDFPAGE_AACTION_CLOSE);
+ FORM_OnBeforeClosePage(page, form_handle);
+ FPDF_ClosePage(page);
+
+ FORM_DoDocumentAAction(form_handle, FPDFDOC_AACTION_WC);
+ FPDFDOC_ExitFormFillEnvironment(form_handle);
+ FPDF_CloseDocument(doc);
+ FPDF_DestroyLibrary();
+
+ isolate->Dispose();
+ v8::V8::ShutdownPlatform();
+ delete platform;
+
+ return 0;
+}
