Merge pull request #1447 from m-holger/i1433

Fix QPDFFormFieldObjectHelper::getChoices (fixes #1433)

Merge pull request #1447 from m-holger/i1433
Fix QPDFFormFieldObjectHelper::getChoices (fixes #1433)
m-holger · GitHub
2 parents ad3bac2c c46cfae7
Showing 5 changed files with 3799 additions and 9 deletions
include/qpdf/QPDFFormFieldObjectHelper.hh
libqpdf/QPDFFormFieldObjectHelper.cc
manual/release-notes.rst
qpdf/qtest/appearance-streams.test
qpdf/qtest/qpdf/need-appearances2.pdf
@@ -147,7 +147,7 @@ class QPDFFormFieldObjectHelper: public QPDFObjectHelper
     // Returns true if fields if of type /Ch
     QPDF_DLL
     bool isChoice();
-    // Returns choices as UTF-8 strings
+    // Returns choices display values as UTF-8 strings
     QPDF_DLL
     std::vector<std::string> getChoices();
@@ -281,6 +281,11 @@ QPDFFormFieldObjectHelper::getChoices()
     for (auto const& item: getInheritableFieldValue("/Opt").as_array()) {
         if (item.isString()) {
             result.emplace_back(item.getUTF8Value());
+        } else if (item.isArray() && item.getArrayNItems() == 2) {
+            auto display = item.getArrayItem(1);
+            if (display.isString()) {
+                result.emplace_back(display.getUTF8Value());
+            }
         }
     }
     return result;
@@ -16,20 +16,25 @@ more detail.
 12.1.1: not yet released
   - Bug fixes
-    - In QPDF::getAllPages detect shared /Kids arrays to avoid stack overflows
-      in (specially constructed) damaged input files.
+    - In ``QPDF::getAllPages`` detect shared ``/Kids`` arrays to avoid stack
+      overflows in (specially constructed) damaged input files.
-    - Fix severe performance issues in QPDFFormFieldObjectHelper with some
+    - Fix severe performance issues in ``QPDFFormFieldObjectHelper`` with some
       (specially constructed) damaged input files.
-    - Add missing QPDFFormFieldObjectHelper::isChecked implementation.
+    - Add missing ``QPDFFormFieldObjectHelper::isChecked`` implementation.
-    - Fix bug in QPDFNameTreeObjectHelper / QPDFNumberTreeObjectHelper. Under
-      certain conditions tree insertions resulted in a /Range entry being
-      written to the tree root node, which is not permitted. One of the
+    - Fix bug in ``QPDFNameTreeObjectHelper`` / ``QPDFNumberTreeObjectHelper``.
+      Under certain conditions tree insertions resulted in a ``/Range`` entry
+      being written to the tree root node, which is not permitted. One of the
       possible consequences is that some readers would not recognize
       embedded / attached files.
+    - In ``QPDFFormFieldObjectHelper::getChoices`` return the display string
+      if an ``/Opt`` entry is a pair of export value and display string rather
+      than a single string representing both values. Previously no value was
+      returned if the entry was not a single string.
+
   - Build fixes
     - Improve experience for local development on Windows. Perl is no
@@ -16,7 +16,7 @@ my $td = new TestDriver(&#39;appearance-streams&#39;);
 my $n_tests = 12;
-foreach my $f ('need-appearances',
+foreach my $f ('need-appearances2',
                'need-appearances-more',
                'need-appearances-more2',
                'need-appearances-more3')