Merge pull request #1606 from m-holger/cover

Refactor error handling in `Pipeline` and `QPDFXRefEntry`

Merge pull request #1606 from m-holger/cover
Refactor error handling in `Pipeline` and `QPDFXRefEntry`
m-holger · GitHub
2 parents f3063577 a750b8b9
Showing 6 changed files with 82 additions and 59 deletions
libqpdf/CMakeLists.txt
libqpdf/Pipeline.cc
libqpdf/QPDFXRefEntry.cc
libqpdf/QPDF_objects.cc
qpdf/qtest/misc.test
qpdf/test_driver.cc
@@ -83,7 +83,6 @@ set(libqpdf_SOURCES
   QPDFTokenizer.cc
   QPDFUsage.cc
   QPDFWriter.cc
-  QPDFXRefEntry.cc
   QPDF_Array.cc
   QPDF_Dictionary.cc
   QPDF_Stream.cc
 #include <qpdf/Pipeline.hh>
+#include <qpdf/Util.hh>
+
 #include <cstring>
 #include <stdexcept>
+using namespace qpdf;
+
 Pipeline::Pipeline(char const* identifier, Pipeline* next) :
     identifier(identifier),
     next_(next)
@@ -12,10 +16,8 @@ Pipeline::Pipeline(char const* identifier, Pipeline* next) :
 Pipeline*
 Pipeline::getNext(bool allow_null)
 {
-    if (!next_ && !allow_null) {
-        throw std::logic_error(
-            identifier + ": Pipeline::getNext() called on pipeline with no next");
-    }
+    util::assertion(
+        next_ || allow_null, identifier + ": Pipeline::getNext() called on pipeline with no next");
     return next_;
 }
-#include <qpdf/QPDFXRefEntry.hh>
-
-#include <qpdf/QIntC.hh>
-#include <qpdf/QPDFExc.hh>
-
-QPDFXRefEntry::QPDFXRefEntry() // NOLINT (modernize-use-equals-default)
-{
-}
-
-QPDFXRefEntry::QPDFXRefEntry(int type, qpdf_offset_t field1, int field2) :
-    type(type),
-    field1(field1),
-    field2(field2)
-{
-    if ((type < 1) || (type > 2)) {
-        throw std::logic_error("invalid xref type " + std::to_string(type));
-    }
-}
-
-int
-QPDFXRefEntry::getType() const
-{
-    return this->type;
-}
-
-qpdf_offset_t
-QPDFXRefEntry::getOffset() const
-{
-    if (this->type != 1) {
-        throw std::logic_error("getOffset called for xref entry of type != 1");
-    }
-    return this->field1;
-}
-
-int
-QPDFXRefEntry::getObjStreamNumber() const
-{
-    if (this->type != 2) {
-        throw std::logic_error("getObjStreamNumber called for xref entry of type != 2");
-    }
-    return QIntC::to_int(this->field1);
-}
-
-int
-QPDFXRefEntry::getObjStreamIndex() const
-{
-    if (this->type != 2) {
-        throw std::logic_error("getObjStreamIndex called for xref entry of type != 2");
-    }
-    return this->field2;
-}
@@ -26,6 +26,43 @@ using namespace std::literals;
 using Objects = QPDF::Doc::Objects;
+QPDFXRefEntry::QPDFXRefEntry() = default;
+
+QPDFXRefEntry::QPDFXRefEntry(int type, qpdf_offset_t field1, int field2) :
+    type(type),
+    field1(field1),
+    field2(field2)
+{
+    util::assertion(type == 1 || type == 2, "invalid xref type " + std::to_string(type));
+}
+
+int
+QPDFXRefEntry::getType() const
+{
+    return type;
+}
+
+qpdf_offset_t
+QPDFXRefEntry::getOffset() const
+{
+    util::assertion(type == 1, "getOffset called for xref entry of type != 1");
+    return this->field1;
+}
+
+int
+QPDFXRefEntry::getObjStreamNumber() const
+{
+    util::assertion(type == 2, "getObjStreamNumber called for xref entry of type != 2");
+    return QIntC::to_int(field1);
+}
+
+int
+QPDFXRefEntry::getObjStreamIndex() const
+{
+    util::assertion(type == 2, "getObjStreamIndex called for xref entry of type != 2");
+    return field2;
+}
+
 namespace
 {
     class InvalidInputSource: public InputSource
+#!/usr/bin/env perl
+require 5.008;
+use warnings;
+use strict;
+
+unshift(@INC, '.');
+require qpdf_test_helpers;
+
+chdir("qpdf") or die "chdir testdir failed: $!\n";
+
+require TestDriver;
+
+my $dev_null = File::Spec->devnull();
+cleanup();
+
+my $td = new TestDriver('misc');
+
+my $n_tests = 1;
+
+$td->runtest("pipeline",
+             {$td->COMMAND => "test_driver 62 -"},
+             {$td->STRING => "test 62 done\n",
+                  $td->EXIT_STATUS => 0},
+             $td->NORMALIZE_NEWLINES);
+
+cleanup();
+$td->report($n_tests);
@@ -2279,8 +2279,17 @@ test_61(QPDF&amp; pdf, char const* arg2)
 static void
 test_62(QPDF& pdf, char const* arg2)
 {
-    // Test int size checks. This test will fail if int and long long are the same size.
-    // Moved to libtests/objects
+    // Was test int size checks - Moved to libtests/objects.
+    // Test Pipeline methods
+    std::string out;
+    Pl_String pl("", nullptr, out);
+    unsigned short us = 1;
+    unsigned int ui = 2;
+    unsigned long long ull = 3;
+    long l = 4;
+    short s = 5;
+    pl << us << ui << ull << l << s;
+    assert(out == "12345");
 }
 static void
@@ -3548,7 +3557,7 @@ runtest(int n, char const* filename1, char const* arg2)
     // the test suite to see how the test is invoked to find the file
     // that the test is supposed to operate on.
-    std::set<int> ignore_filename = {61, 81, 83, 84, 85, 86, 87, 92, 95, 96};
+    std::set<int> ignore_filename = {61, 62, 81, 83, 84, 85, 86, 87, 92, 95, 96};
     if (n == 0) {
         // Throw in some random test cases that don't fit anywhere