Add `no_ci_stop_if`, `no_ci_stop_damaged_if`, and `no_ci_warn_if` methods to enh…

…ance error and warning handling within `BaseHandle` and `QPDF`, highlighting that the error condition is not covered in CI testing without generating codecov noise.

Add `no_ci_stop_if`, `no_ci_stop_damaged_if`, and `no_ci_warn_if` methods to enh…
…ance error and warning handling within `BaseHandle` and `QPDF`, highlighting that the error condition is not covered in CI testing without generating codecov noise.
m-holger
1 parent f6d8da10
Showing 5 changed files with 43 additions and 1 deletions
include/qpdf/ObjectHandle.hh
include/qpdf/QPDF.hh
libqpdf/QPDF.cc
libqpdf/qpdf/QPDFObjectHandle_private.hh
libqpdf/qpdf/QPDF_private.hh
@@ -127,6 +127,10 @@ namespace qpdf
         inline void assign(qpdf_object_type_e required, BaseHandle&& other);
         std::string description() const;
+
+        void no_ci_warn_if(bool condition, std::string const& warning) const;
+        void no_ci_stop_if(bool condition, std::string const& warning) const;
+        void no_ci_stop_damaged_if(bool condition, std::string const& warning) const;
         std::invalid_argument invalid_error(std::string const& method) const;
         std::runtime_error type_error(char const* expected_type) const;
         QPDFExc type_error(char const* expected_type, std::string const& message) const;
@@ -874,6 +874,8 @@ class QPDF
     std::shared_ptr<QPDFObject> const& resolve(QPDFObjGen og);
     void resolveObjectsInStream(int obj_stream_number);
     void stopOnError(std::string const& message);
+    inline void
+    no_ci_stop_if(bool condition, std::string const& message, std::string const& context = {});
     QPDFObjGen nextObjGen();
     QPDFObjectHandle newIndirect(QPDFObjGen, std::shared_ptr<QPDFObject> const&);
     QPDFObjectHandle makeIndirectFromQPDFObject(std::shared_ptr<QPDFObject> const& obj);
@@ -946,7 +946,7 @@ QPDF::pipeForeignStreamData(
 }
 // Throw a generic exception when we lack context for something more specific. New code should not
-// use this. This method exists to improve somewhat from calling assert in very old code.
+// use this.
 void
 QPDF::stopOnError(std::string const& message)
 {
@@ -624,6 +624,33 @@ namespace qpdf
         return obj ? obj->og.isIndirect() : false;
     }
+    inline void
+    BaseHandle::no_ci_stop_if(bool condition, std::string const& message) const
+    {
+        if (condition) {
+            if (qpdf()) {
+                throw QPDFExc(qpdf_e_damaged_pdf, "", description(), 0, message);
+            }
+            throw std::runtime_error(message);
+        }
+    }
+
+    inline void
+    BaseHandle::no_ci_stop_damaged_if(bool condition, std::string const& message) const
+    {
+        if (condition) {
+            throw std::runtime_error(message);
+        }
+    }
+
+    inline void
+    BaseHandle::no_ci_warn_if(bool condition, std::string const& warning) const
+    {
+        if (condition) {
+            warn(warning);
+        }
+    }
+
     inline bool
     BaseHandle::null() const
     {
@@ -628,4 +628,13 @@ QPDF::page_labels()
     return *m->page_labels;
 }
+// Throw a generic exception for unusual error conditions that do not be covered during CI testing.
+inline void
+QPDF::no_ci_stop_if(bool condition, std::string const& message, std::string const& context)
+{
+    if (condition) {
+        throw damagedPDF(context, message);
+    }
+}
+
 #endif // QPDF_PRIVATE_HH