Adding APIs to get name, type and value of form fields
This change adds three public APIs to get name, type and value of an
interactive form annotation. The APIs FPDFAnnot_GetFormFieldName,
FPDFAnnot_GetFormFieldType and FPDFAnnot_GetFormFieldValue are added in
fpdf_annot.h.
This CL also includes tests to test these APIs for text fields and
combo boxes.
Bug: pdfium:1459
Change-Id: I50ce63d132aaad4dd93891a1083aa033ddd16377
Reviewed-on: https://pdfium-review.googlesource.com/c/pdfium/+/65370
Commit-Queue: Mansi Awasthi <maawas@microsoft.com>
Reviewed-by: Lei Zhang <thestig@chromium.org>
diff --git a/fpdfsdk/fpdf_annot.cpp b/fpdfsdk/fpdf_annot.cpp
index 923bcff..c08ba5a 100644
--- a/fpdfsdk/fpdf_annot.cpp
+++ b/fpdfsdk/fpdf_annot.cpp
@@ -957,6 +957,36 @@
return FPDFPage_GetAnnot(page, annot_index);
}
+FPDF_EXPORT unsigned long FPDF_CALLCONV
+FPDFAnnot_GetFormFieldName(FPDF_FORMHANDLE hHandle,
+ FPDF_ANNOTATION annot,
+ FPDF_WCHAR* buffer,
+ unsigned long buflen) {
+ CPDF_FormField* pFormField = GetFormField(hHandle, annot);
+ if (!pFormField)
+ return 0;
+ return Utf16EncodeMaybeCopyAndReturnLength(pFormField->GetFullName(), buffer,
+ buflen);
+}
+
+FPDF_EXPORT int FPDF_CALLCONV
+FPDFAnnot_GetFormFieldType(FPDF_FORMHANDLE hHandle, FPDF_ANNOTATION annot) {
+ CPDF_FormField* pFormField = GetFormField(hHandle, annot);
+ return pFormField ? static_cast<int>(pFormField->GetFieldType()) : -1;
+}
+
+FPDF_EXPORT unsigned long FPDF_CALLCONV
+FPDFAnnot_GetFormFieldValue(FPDF_FORMHANDLE hHandle,
+ FPDF_ANNOTATION annot,
+ FPDF_WCHAR* buffer,
+ unsigned long buflen) {
+ CPDF_FormField* pFormField = GetFormField(hHandle, annot);
+ if (!pFormField)
+ return 0;
+ return Utf16EncodeMaybeCopyAndReturnLength(pFormField->GetValue(), buffer,
+ buflen);
+}
+
FPDF_EXPORT int FPDF_CALLCONV FPDFAnnot_GetOptionCount(FPDF_FORMHANDLE hHandle,
FPDF_ANNOTATION annot) {
CPDF_FormField* pFormField = GetFormField(hHandle, annot);
diff --git a/fpdfsdk/fpdf_annot_embeddertest.cpp b/fpdfsdk/fpdf_annot_embeddertest.cpp
index a6cfaf3..1e0ebd8 100644
--- a/fpdfsdk/fpdf_annot_embeddertest.cpp
+++ b/fpdfsdk/fpdf_annot_embeddertest.cpp
@@ -14,6 +14,7 @@
#include "public/cpp/fpdf_scopers.h"
#include "public/fpdf_annot.h"
#include "public/fpdf_edit.h"
+#include "public/fpdf_formfill.h"
#include "public/fpdfview.h"
#include "testing/embedder_test.h"
#include "testing/fx_string_testhelpers.h"
@@ -2236,3 +2237,151 @@
UnloadPage(page);
}
+
+TEST_F(FPDFAnnotEmbedderTest, GetFormFieldTypeTextField) {
+ ASSERT_TRUE(OpenDocument("text_form.pdf"));
+ FPDF_PAGE page = LoadPage(0);
+ ASSERT_TRUE(page);
+
+ {
+ EXPECT_EQ(-1, FPDFAnnot_GetFormFieldType(form_handle(), nullptr));
+
+ ScopedFPDFAnnotation annot(FPDFPage_GetAnnot(page, 0));
+ ASSERT_TRUE(annot);
+
+ EXPECT_EQ(-1, FPDFAnnot_GetFormFieldType(nullptr, annot.get()));
+
+ EXPECT_EQ(FPDF_FORMFIELD_TEXTFIELD,
+ FPDFAnnot_GetFormFieldType(form_handle(), annot.get()));
+ }
+ UnloadPage(page);
+}
+
+TEST_F(FPDFAnnotEmbedderTest, GetFormFieldTypeComboBox) {
+ ASSERT_TRUE(OpenDocument("combobox_form.pdf"));
+ FPDF_PAGE page = LoadPage(0);
+ ASSERT_TRUE(page);
+
+ {
+ ScopedFPDFAnnotation annot(FPDFPage_GetAnnot(page, 0));
+ ASSERT_TRUE(annot);
+ EXPECT_EQ(FPDF_FORMFIELD_COMBOBOX,
+ FPDFAnnot_GetFormFieldType(form_handle(), annot.get()));
+ }
+ UnloadPage(page);
+}
+
+TEST_F(FPDFAnnotEmbedderTest, GetFormFieldValueTextField) {
+ ASSERT_TRUE(OpenDocument("text_form_multiple.pdf"));
+ FPDF_PAGE page = LoadPage(0);
+ ASSERT_TRUE(page);
+
+ {
+ EXPECT_EQ(0u,
+ FPDFAnnot_GetFormFieldValue(form_handle(), nullptr, nullptr, 0));
+
+ ScopedFPDFAnnotation annot(FPDFPage_GetAnnot(page, 0));
+ ASSERT_TRUE(annot);
+
+ EXPECT_EQ(0u,
+ FPDFAnnot_GetFormFieldValue(nullptr, annot.get(), nullptr, 0));
+
+ unsigned long length_bytes =
+ FPDFAnnot_GetFormFieldValue(form_handle(), annot.get(), nullptr, 0);
+ ASSERT_EQ(2u, length_bytes);
+ std::vector<FPDF_WCHAR> buf = GetFPDFWideStringBuffer(length_bytes);
+ EXPECT_EQ(2u, FPDFAnnot_GetFormFieldValue(form_handle(), annot.get(),
+ buf.data(), length_bytes));
+ EXPECT_EQ(L"", GetPlatformWString(buf.data()));
+ }
+ {
+ ScopedFPDFAnnotation annot(FPDFPage_GetAnnot(page, 2));
+ ASSERT_TRUE(annot);
+
+ unsigned long length_bytes =
+ FPDFAnnot_GetFormFieldValue(form_handle(), annot.get(), nullptr, 0);
+ ASSERT_EQ(18u, length_bytes);
+ std::vector<FPDF_WCHAR> buf = GetFPDFWideStringBuffer(length_bytes);
+ EXPECT_EQ(18u, FPDFAnnot_GetFormFieldValue(form_handle(), annot.get(),
+ buf.data(), length_bytes));
+ EXPECT_EQ(L"Elephant", GetPlatformWString(buf.data()));
+ }
+ UnloadPage(page);
+}
+
+TEST_F(FPDFAnnotEmbedderTest, GetFormFieldValueComboBox) {
+ ASSERT_TRUE(OpenDocument("combobox_form.pdf"));
+ FPDF_PAGE page = LoadPage(0);
+ ASSERT_TRUE(page);
+
+ {
+ ScopedFPDFAnnotation annot(FPDFPage_GetAnnot(page, 0));
+ ASSERT_TRUE(annot);
+
+ unsigned long length_bytes =
+ FPDFAnnot_GetFormFieldValue(form_handle(), annot.get(), nullptr, 0);
+ ASSERT_EQ(2u, length_bytes);
+ std::vector<FPDF_WCHAR> buf = GetFPDFWideStringBuffer(length_bytes);
+ EXPECT_EQ(2u, FPDFAnnot_GetFormFieldValue(form_handle(), annot.get(),
+ buf.data(), length_bytes));
+ EXPECT_EQ(L"", GetPlatformWString(buf.data()));
+ }
+ {
+ ScopedFPDFAnnotation annot(FPDFPage_GetAnnot(page, 1));
+ ASSERT_TRUE(annot);
+
+ unsigned long length_bytes =
+ FPDFAnnot_GetFormFieldValue(form_handle(), annot.get(), nullptr, 0);
+ ASSERT_EQ(14u, length_bytes);
+ std::vector<FPDF_WCHAR> buf = GetFPDFWideStringBuffer(length_bytes);
+ EXPECT_EQ(14u, FPDFAnnot_GetFormFieldValue(form_handle(), annot.get(),
+ buf.data(), length_bytes));
+ EXPECT_EQ(L"Banana", GetPlatformWString(buf.data()));
+ }
+ UnloadPage(page);
+}
+
+TEST_F(FPDFAnnotEmbedderTest, GetFormFieldNameTextField) {
+ ASSERT_TRUE(OpenDocument("text_form.pdf"));
+ FPDF_PAGE page = LoadPage(0);
+ ASSERT_TRUE(page);
+
+ {
+ EXPECT_EQ(0u,
+ FPDFAnnot_GetFormFieldName(form_handle(), nullptr, nullptr, 0));
+
+ ScopedFPDFAnnotation annot(FPDFPage_GetAnnot(page, 0));
+ ASSERT_TRUE(annot);
+
+ EXPECT_EQ(0u, FPDFAnnot_GetFormFieldName(nullptr, annot.get(), nullptr, 0));
+
+ unsigned long length_bytes =
+ FPDFAnnot_GetFormFieldName(form_handle(), annot.get(), nullptr, 0);
+ ASSERT_EQ(18u, length_bytes);
+ std::vector<FPDF_WCHAR> buf = GetFPDFWideStringBuffer(length_bytes);
+ EXPECT_EQ(18u, FPDFAnnot_GetFormFieldName(form_handle(), annot.get(),
+ buf.data(), length_bytes));
+ EXPECT_EQ(L"Text Box", GetPlatformWString(buf.data()));
+ }
+ UnloadPage(page);
+}
+
+TEST_F(FPDFAnnotEmbedderTest, GetFormFieldNameComboBox) {
+ ASSERT_TRUE(OpenDocument("combobox_form.pdf"));
+ FPDF_PAGE page = LoadPage(0);
+ ASSERT_TRUE(page);
+
+ {
+ ScopedFPDFAnnotation annot(FPDFPage_GetAnnot(page, 0));
+ ASSERT_TRUE(annot);
+
+ unsigned long length_bytes =
+ FPDFAnnot_GetFormFieldName(form_handle(), annot.get(), nullptr, 0);
+ ASSERT_EQ(30u, length_bytes);
+ std::vector<FPDF_WCHAR> buf = GetFPDFWideStringBuffer(length_bytes);
+ EXPECT_EQ(30u, FPDFAnnot_GetFormFieldName(form_handle(), annot.get(),
+ buf.data(), length_bytes));
+ EXPECT_EQ(L"Combo_Editable", GetPlatformWString(buf.data()));
+ }
+ UnloadPage(page);
+}
diff --git a/fpdfsdk/fpdf_view_c_api_test.c b/fpdfsdk/fpdf_view_c_api_test.c
index f8a3f1e..94cd3ce 100644
--- a/fpdfsdk/fpdf_view_c_api_test.c
+++ b/fpdfsdk/fpdf_view_c_api_test.c
@@ -49,6 +49,9 @@
CHK(FPDFAnnot_GetFontSize);
CHK(FPDFAnnot_GetFormFieldAtPoint);
CHK(FPDFAnnot_GetFormFieldFlags);
+ CHK(FPDFAnnot_GetFormFieldName);
+ CHK(FPDFAnnot_GetFormFieldType);
+ CHK(FPDFAnnot_GetFormFieldValue);
CHK(FPDFAnnot_GetLinkedAnnot);
CHK(FPDFAnnot_GetNumberValue);
CHK(FPDFAnnot_GetObject);
diff --git a/public/fpdf_annot.h b/public/fpdf_annot.h
index f458748..58da809 100644
--- a/public/fpdf_annot.h
+++ b/public/fpdf_annot.h
@@ -539,6 +539,57 @@
const FS_POINTF* point);
// Experimental API.
+// Gets the name of |annot|, which is an interactive form annotation.
+// |buffer| is only modified if |buflen| is longer than the length of contents.
+// In case of error, nothing will be added to |buffer| and the return value will
+// be 0. Note that return value of empty string is 2 for "\0\0".
+//
+// hHandle - handle to the form fill module, returned by
+// FPDFDOC_InitFormFillEnvironment().
+// annot - handle to an interactive form annotation.
+// buffer - buffer for holding the name string, encoded in UTF-16LE.
+// buflen - length of the buffer in bytes.
+//
+// Returns the length of the string value in bytes.
+FPDF_EXPORT unsigned long FPDF_CALLCONV
+FPDFAnnot_GetFormFieldName(FPDF_FORMHANDLE hHandle,
+ FPDF_ANNOTATION annot,
+ FPDF_WCHAR* buffer,
+ unsigned long buflen);
+
+// Experimental API.
+// Gets the form field type of |annot|, which is an interactive form annotation.
+//
+// hHandle - handle to the form fill module, returned by
+// FPDFDOC_InitFormFillEnvironment().
+// annot - handle to an interactive form annotation.
+//
+// Returns the type of the form field (one of the FPDF_FORMFIELD_* values) on
+// success. Returns -1 on error.
+// See field types in fpdf_formfill.h.
+FPDF_EXPORT int FPDF_CALLCONV
+FPDFAnnot_GetFormFieldType(FPDF_FORMHANDLE hHandle, FPDF_ANNOTATION annot);
+
+// Experimental API.
+// Gets the value of |annot|, which is an interactive form annotation.
+// |buffer| is only modified if |buflen| is longer than the length of contents.
+// In case of error, nothing will be added to |buffer| and the return value will
+// be 0. Note that return value of empty string is 2 for "\0\0".
+//
+// hHandle - handle to the form fill module, returned by
+// FPDFDOC_InitFormFillEnvironment().
+// annot - handle to an interactive form annotation.
+// buffer - buffer for holding the value string, encoded in UTF-16LE.
+// buflen - length of the buffer in bytes.
+//
+// Returns the length of the string value in bytes.
+FPDF_EXPORT unsigned long FPDF_CALLCONV
+FPDFAnnot_GetFormFieldValue(FPDF_FORMHANDLE hHandle,
+ FPDF_ANNOTATION annot,
+ FPDF_WCHAR* buffer,
+ unsigned long buflen);
+
+// Experimental API.
// Get the number of options in the |annot|'s "Opt" dictionary. Intended for
// use with listbox and combobox widget annotations.
//
