Add GetNumberValue function to fpdf_annot.
Add a function to fpdf_annot public API to allow access to the number
value of an entry in the annotation dictionary by key. Can be used to
obtain int and float values for the annotation such as "MaxLen" for text
fields.
R=thestig@chromium.org
Bug: b/127345911
Change-Id: Ifafeadffdbccf005b35102918cf27cc3dfb1d0ff
Reviewed-on: https://pdfium-review.googlesource.com/c/pdfium/+/51471
Reviewed-by: Lei Zhang <thestig@chromium.org>
Commit-Queue: Lei Zhang <thestig@chromium.org>
diff --git a/fpdfsdk/fpdf_annot.cpp b/fpdfsdk/fpdf_annot.cpp
index 22d09f1..8b4c697 100644
--- a/fpdfsdk/fpdf_annot.cpp
+++ b/fpdfsdk/fpdf_annot.cpp
@@ -730,6 +730,25 @@
}
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
+FPDFAnnot_GetNumberValue(FPDF_ANNOTATION annot,
+ FPDF_BYTESTRING key,
+ float* value) {
+ if (!value)
+ return false;
+
+ CPDF_Dictionary* pAnnotDict = GetAnnotDictFromFPDFAnnotation(annot);
+ if (!pAnnotDict)
+ return false;
+
+ const CPDF_Object* p = pAnnotDict->GetObjectFor(key);
+ if (!p || p->GetType() != FPDF_OBJECT_NUMBER)
+ return false;
+
+ *value = p->GetNumber();
+ return true;
+}
+
+FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
FPDFAnnot_SetAP(FPDF_ANNOTATION annot,
FPDF_ANNOT_APPEARANCEMODE appearanceMode,
FPDF_WIDESTRING value) {
diff --git a/fpdfsdk/fpdf_annot_embeddertest.cpp b/fpdfsdk/fpdf_annot_embeddertest.cpp
index b43940b..df1a25a 100644
--- a/fpdfsdk/fpdf_annot_embeddertest.cpp
+++ b/fpdfsdk/fpdf_annot_embeddertest.cpp
@@ -1146,6 +1146,46 @@
CloseSavedDocument();
}
+TEST_F(FPDFAnnotEmbedderTest, GetNumberValue) {
+ // Open a file with three text annotations and load its first page.
+ ASSERT_TRUE(OpenDocument("text_form_multiple.pdf"));
+ FPDF_PAGE page = LoadPage(0);
+ ASSERT_TRUE(page);
+ {
+ // First two annotations do not have "MaxLen" attribute.
+ for (int i = 0; i < 2; i++) {
+ ScopedFPDFAnnotation annot(FPDFPage_GetAnnot(page, i));
+ ASSERT_TRUE(annot);
+
+ // Verify that no "MaxLen" key present.
+ EXPECT_FALSE(FPDFAnnot_HasKey(annot.get(), "MaxLen"));
+
+ float value;
+ EXPECT_FALSE(FPDFAnnot_GetNumberValue(annot.get(), "MaxLen", &value));
+ }
+
+ // Annotation in index 2 has "MaxLen" of 10.
+ ScopedFPDFAnnotation annot(FPDFPage_GetAnnot(page, 2));
+ ASSERT_TRUE(annot);
+
+ // Verify that "MaxLen" key present.
+ EXPECT_TRUE(FPDFAnnot_HasKey(annot.get(), "MaxLen"));
+
+ float value;
+ EXPECT_TRUE(FPDFAnnot_GetNumberValue(annot.get(), "MaxLen", &value));
+ EXPECT_FLOAT_EQ(10.0f, value);
+
+ // Check bad inputs.
+ EXPECT_FALSE(FPDFAnnot_GetNumberValue(nullptr, "MaxLen", &value));
+ EXPECT_FALSE(FPDFAnnot_GetNumberValue(annot.get(), nullptr, &value));
+ EXPECT_FALSE(FPDFAnnot_GetNumberValue(annot.get(), "MaxLen", nullptr));
+ // Ask for key that exists but is not a number.
+ EXPECT_FALSE(FPDFAnnot_GetNumberValue(annot.get(), "V", &value));
+ }
+
+ UnloadPage(page);
+}
+
TEST_F(FPDFAnnotEmbedderTest, GetSetAP) {
// Open a file with four annotations and load its first page.
ASSERT_TRUE(OpenDocument("annotation_stamp_with_ap.pdf"));
diff --git a/fpdfsdk/fpdf_view_c_api_test.c b/fpdfsdk/fpdf_view_c_api_test.c
index 8e430b3..6788ef9 100644
--- a/fpdfsdk/fpdf_view_c_api_test.c
+++ b/fpdfsdk/fpdf_view_c_api_test.c
@@ -47,6 +47,7 @@
CHK(FPDFAnnot_GetFormFieldAtPoint);
CHK(FPDFAnnot_GetFormFieldFlags);
CHK(FPDFAnnot_GetLinkedAnnot);
+ CHK(FPDFAnnot_GetNumberValue);
CHK(FPDFAnnot_GetObject);
CHK(FPDFAnnot_GetObjectCount);
CHK(FPDFAnnot_GetOptionCount);
diff --git a/public/fpdf_annot.h b/public/fpdf_annot.h
index ae1a14e..4313aae 100644
--- a/public/fpdf_annot.h
+++ b/public/fpdf_annot.h
@@ -432,6 +432,22 @@
unsigned long buflen);
// Experimental API.
+// Get the float value corresponding to |key| in |annot|'s dictionary. Writes
+// value to |value| and returns True if |key| exists in the dictionary and
+// |key|'s corresponding value is a number (FPDF_OBJECT_NUMBER), False
+// otherwise.
+//
+// annot - handle to an annotation.
+// key - the key to the requested dictionary entry, encoded in UTF-8.
+// value - receives the value, must not be NULL.
+//
+// Returns True if value found, False otherwise.
+FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
+FPDFAnnot_GetNumberValue(FPDF_ANNOTATION annot,
+ FPDF_BYTESTRING key,
+ float* value);
+
+// Experimental API.
// Set the AP (appearance string) in |annot|'s dictionary for a given
// |appearanceMode|.
//
