Refactor document helper access through `QPDF::Doc`

Replace direct access to document helpers (`acroform()`, `pages()`, `embedded_files()`, etc.) with calls through `QPDF::doc()` for better encapsulation. Adjust related methods, constructors, and memory management accordingly.

Refactor document helper access through `QPDF::Doc`
Replace direct access to document helpers (`acroform()`, `pages()`, `embedded_files()`, etc.) with calls through `QPDF::doc()` for better encapsulation. Adjust related methods, constructors, and memory management accordingly.
m-holger
1 parent c5b728f8
Showing 9 changed files with 98 additions and 107 deletions
include/qpdf/QPDF.hh
libqpdf/QPDFAcroFormDocumentHelper.cc
libqpdf/QPDFEmbeddedFileDocumentHelper.cc
libqpdf/QPDFFormFieldObjectHelper.cc
libqpdf/QPDFJob.cc
libqpdf/QPDFOutlineDocumentHelper.cc
libqpdf/QPDFPageDocumentHelper.cc
libqpdf/QPDFPageLabelDocumentHelper.cc
libqpdf/qpdf/QPDF_private.hh
@@ -62,11 +62,6 @@ class BitWriter;
 class BufferInputSource;
 class QPDFLogger;
 class QPDFParser;
-class QPDFAcroFormDocumentHelper;
-class QPDFEmbeddedFileDocumentHelper;
-class QPDFOutlineDocumentHelper;
-class QPDFPageDocumentHelper;
-class QPDFPageLabelDocumentHelper;
 class QPDF
 {
@@ -803,11 +798,6 @@ class QPDF
     class JobSetter;
     inline bool reconstructed_xref() const;
-    inline QPDFAcroFormDocumentHelper& acroform();
-    inline QPDFEmbeddedFileDocumentHelper& embedded_files();
-    inline QPDFOutlineDocumentHelper& outlines();
-    inline QPDFPageDocumentHelper& pages();
-    inline QPDFPageLabelDocumentHelper& page_labels();
     inline Doc& doc();
     // For testing only -- do not add to DLL
@@ -45,7 +45,7 @@ QPDFAcroFormDocumentHelper::QPDFAcroFormDocumentHelper(QPDF&amp; qpdf) :
 QPDFAcroFormDocumentHelper&
 QPDFAcroFormDocumentHelper::get(QPDF& qpdf)
 {
-    return qpdf.acroform();
+    return qpdf.doc().acroform();
 }
 void
@@ -53,7 +53,7 @@ QPDFEmbeddedFileDocumentHelper::QPDFEmbeddedFileDocumentHelper(QPDF&amp; qpdf) :
 QPDFEmbeddedFileDocumentHelper&
 QPDFEmbeddedFileDocumentHelper::get(QPDF& qpdf)
 {
-    return qpdf.embedded_files();
+    return qpdf.doc().embedded_files();
 }
 void
@@ -337,7 +337,7 @@ QPDFFormFieldObjectHelper::setV(QPDFObjectHandle value, bool need_appearances)
         QPDF& qpdf = oh().getQPDF(
             "QPDFFormFieldObjectHelper::setV called with need_appearances = "
             "true on an object that is not associated with an owning QPDF");
-        qpdf.acroform().setNeedAppearances(true);
+        qpdf.doc().acroform().setNeedAppearances(true);
     }
 }
@@ -751,12 +751,13 @@ QPDFJob::doCheck(QPDF&amp; pdf)
         }
         // Create all document helper to trigger any validations they carry out.
-        auto& pages = pdf.pages();
-        (void)pdf.acroform();
-        (void)pdf.embedded_files();
-        (void)pdf.page_labels();
-        (void)pdf.outlines().resolveNamedDest(QPDFObjectHandle::newString("dummy"));
-        (void)pdf.outlines().getOutlinesForPage(pages.getAllPages().at(0));
+        auto& doc = pdf.doc();
+        auto& pages = doc.pages();
+        (void)doc.acroform();
+        (void)doc.embedded_files();
+        (void)doc.page_labels();
+        (void)doc.outlines().resolveNamedDest(QPDFObjectHandle::newString("dummy"));
+        (void)doc.outlines().getOutlinesForPage(pages.getAllPages().at(0));
         // Write the file to nowhere, uncompressing streams.  This causes full file traversal and
         // decoding of all streams we can decode.
@@ -839,8 +840,8 @@ QPDFJob::doShowPages(QPDF&amp; pdf)
 {
     int pageno = 0;
     auto& cout = *m->log->getInfo();
-    for (auto& ph: pdf.pages().getAllPages()) {
-        QPDFObjectHandle page = ph.getObjectHandle();
+    for (auto& page: pdf.getAllPages()) {
+        QPDFPageObjectHelper ph(page);
         ++pageno;
         cout << "page " << pageno << ": " << page.getObjectID() << " " << page.getGeneration()
@@ -871,7 +872,7 @@ QPDFJob::doShowPages(QPDF&amp; pdf)
 void
 QPDFJob::doListAttachments(QPDF& pdf)
 {
-    auto& efdh = pdf.embedded_files();
+    auto& efdh = pdf.doc().embedded_files();
     if (efdh.hasEmbeddedFiles()) {
         for (auto const& i: efdh.getEmbeddedFiles()) {
             std::string const& key = i.first;
@@ -911,7 +912,7 @@ QPDFJob::doListAttachments(QPDF&amp; pdf)
 void
 QPDFJob::doShowAttachment(QPDF& pdf)
 {
-    auto& efdh = pdf.embedded_files();
+    auto& efdh = pdf.doc().embedded_files();
     auto fs = efdh.getEmbeddedFile(m->attachment_to_show);
     if (!fs) {
         throw std::runtime_error("attachment " + m->attachment_to_show + " not found");
@@ -1030,13 +1031,13 @@ QPDFJob::doJSONPages(Pipeline* p, bool&amp; first, QPDF&amp; pdf)
     JSON::writeDictionaryKey(p, first, "pages", 1);
     bool first_page = true;
     JSON::writeArrayOpen(p, first_page, 2);
-    auto& pldh = pdf.page_labels();
-    auto& odh = pdf.outlines();
+    auto& pldh = pdf.doc().page_labels();
+    auto& odh = pdf.doc().outlines();
     int pageno = -1;
-    for (auto& ph: pdf.pages().getAllPages()) {
+    for (auto& page: pdf.getAllPages()) {
         ++pageno;
         JSON j_page = JSON::makeDictionary();
-        QPDFObjectHandle page = ph.getObjectHandle();
+        QPDFPageObjectHelper ph(page);
         j_page.addDictionaryMember("object", page.getJSON(m->json_version));
         JSON j_images = j_page.addDictionaryMember("images", JSON::makeArray());
         for (auto const& iter2: ph.getImages()) {
@@ -1093,8 +1094,8 @@ void
 QPDFJob::doJSONPageLabels(Pipeline* p, bool& first, QPDF& pdf)
 {
     JSON j_labels = JSON::makeArray();
-    auto& pldh = pdf.page_labels();
-    long long npages = QIntC::to_longlong(pdf.pages().getAllPages().size());
+    auto& pldh = pdf.doc().page_labels();
+    long long npages = QIntC::to_longlong(pdf.getAllPages().size());
     if (pldh.hasPageLabels()) {
         std::vector<QPDFObjectHandle> labels;
         pldh.getLabelsForPageRange(0, npages - 1, 0, labels);
@@ -1142,13 +1143,12 @@ QPDFJob::doJSONOutlines(Pipeline* p, bool&amp; first, QPDF&amp; pdf)
 {
     std::map<QPDFObjGen, int> page_numbers;
     int n = 0;
-    for (auto const& ph: pdf.pages().getAllPages()) {
-        QPDFObjectHandle oh = ph.getObjectHandle();
-        page_numbers[oh.getObjGen()] = ++n;
+    for (auto const& oh: pdf.getAllPages()) {
+        page_numbers[oh] = ++n;
     }
     JSON j_outlines = JSON::makeArray();
-    addOutlinesToJson(pdf.outlines().getTopLevelOutlines(), j_outlines, page_numbers);
+    addOutlinesToJson(pdf.doc().outlines().getTopLevelOutlines(), j_outlines, page_numbers);
     JSON::writeDictionaryItem(p, first, "outlines", j_outlines, 1);
 }
@@ -1156,14 +1156,14 @@ void
 QPDFJob::doJSONAcroform(Pipeline* p, bool& first, QPDF& pdf)
 {
     JSON j_acroform = JSON::makeDictionary();
-    auto& afdh = pdf.acroform();
+    auto& afdh = pdf.doc().acroform();
     j_acroform.addDictionaryMember("hasacroform", JSON::makeBool(afdh.hasAcroForm()));
     j_acroform.addDictionaryMember("needappearances", JSON::makeBool(afdh.getNeedAppearances()));
     JSON j_fields = j_acroform.addDictionaryMember("fields", JSON::makeArray());
     int pagepos1 = 0;
-    for (auto const& page: pdf.pages().getAllPages()) {
+    for (auto const& page: pdf.getAllPages()) {
         ++pagepos1;
-        for (auto& aoh: afdh.getWidgetAnnotationsForPage(page)) {
+        for (auto& aoh: afdh.getWidgetAnnotationsForPage({page})) {
             QPDFFormFieldObjectHelper ffh = afdh.getFieldForAnnotation(aoh);
             if (!ffh.getObjectHandle().isDictionary()) {
                 continue;
@@ -1297,7 +1297,7 @@ QPDFJob::doJSONAttachments(Pipeline* p, bool&amp; first, QPDF&amp; pdf)
     };
     JSON j_attachments = JSON::makeDictionary();
-    auto& efdh = pdf.embedded_files();
+    auto& efdh = pdf.doc().embedded_files();
     for (auto const& iter: efdh.getEmbeddedFiles()) {
         std::string const& key = iter.first;
         auto fsoh = iter.second;
@@ -1873,7 +1873,7 @@ QPDFJob::doUnderOverlayForPage(
     if (!(uo.pdf && pagenos[pageno.idx].contains(uo_idx))) {
         return "";
     }
-    auto& dest_afdh = dest_page.qpdf()->acroform();
+    auto& dest_afdh = dest_page.qpdf()->doc().acroform();
     auto const& pages = uo.pdf->getAllPages();
     std::string content;
@@ -1894,7 +1894,7 @@ QPDFJob::doUnderOverlayForPage(
         QPDFMatrix cm;
         std::string new_content = dest_page.placeFormXObject(
             fo[from_no.no][uo_idx], name, dest_page.getTrimBox().getArrayAsRectangle(), cm);
-        dest_page.copyAnnotations(from_page, cm, &dest_afdh, &from_page.qpdf()->acroform());
+        dest_page.copyAnnotations(from_page, cm, &dest_afdh, &from_page.qpdf()->doc().acroform());
         if (!new_content.empty()) {
             resources.mergeResources("<< /XObject << >> >>"_qpdf);
             auto xobject = resources.getKey("/XObject");
@@ -2019,7 +2019,7 @@ void
 QPDFJob::addAttachments(QPDF& pdf)
 {
     maybe_set_pagemode(pdf, "/UseAttachments");
-    auto& efdh = pdf.embedded_files();
+    auto& efdh = pdf.doc().embedded_files();
     std::vector<std::string> duplicated_keys;
     for (auto const& to_add: m->attachments_to_add) {
         if ((!to_add.replace) && efdh.getEmbeddedFile(to_add.key)) {
@@ -2063,7 +2063,7 @@ void
 QPDFJob::copyAttachments(QPDF& pdf)
 {
     maybe_set_pagemode(pdf, "/UseAttachments");
-    auto& efdh = pdf.embedded_files();
+    auto& efdh = pdf.doc().embedded_files();
     std::vector<std::string> duplicates;
     for (auto const& to_copy: m->attachments_to_copy) {
         doIfVerbose([&](Pipeline& v, std::string const& prefix) {
@@ -2071,7 +2071,7 @@ QPDFJob::copyAttachments(QPDF&amp; pdf)
         });
         std::unique_ptr<QPDF> other;
         processFile(other, to_copy.path.c_str(), to_copy.password.c_str(), false, false);
-        auto& other_efdh = other->embedded_files();
+        auto& other_efdh = other->doc().embedded_files();
         auto other_attachments = other_efdh.getEmbeddedFiles();
         for (auto const& iter: other_attachments) {
             std::string new_key = to_copy.prefix + iter.first;
@@ -2114,7 +2114,7 @@ QPDFJob::handleTransformations(QPDF&amp; pdf)
     QPDFAcroFormDocumentHelper* afdh_ptr = nullptr;
     auto afdh = [&]() -> QPDFAcroFormDocumentHelper& {
         if (!afdh_ptr) {
-            afdh_ptr = &pdf.acroform();
+            afdh_ptr = &pdf.doc().acroform();
         }
         return *afdh_ptr;
     };
@@ -2205,7 +2205,7 @@ QPDFJob::handleTransformations(QPDF&amp; pdf)
         pdf.getRoot().replaceKey("/PageLabels", page_labels);
     }
     if (!m->attachments_to_remove.empty()) {
-        auto& efdh = pdf.embedded_files();
+        auto& efdh = pdf.doc().embedded_files();
         for (auto const& key: m->attachments_to_remove) {
             if (efdh.removeEmbeddedFile(key)) {
                 doIfVerbose([&](Pipeline& v, std::string const& prefix) {
@@ -2344,7 +2344,7 @@ QPDFJob::Input::initialize(Inputs&amp; in, QPDF* a_qpdf)
         if (in.job.m->remove_unreferenced_page_resources != QPDFJob::re_no) {
             remove_unreferenced = in.job.shouldRemoveUnreferencedResources(*qpdf);
         }
-        if (qpdf->page_labels().hasPageLabels()) {
+        if (qpdf->doc().page_labels().hasPageLabels()) {
             in.any_page_labels = true;
         }
     }
@@ -2574,15 +2574,15 @@ QPDFJob::handlePageSpecs(QPDF&amp; pdf)
     // original file that we are selecting.
     std::vector<QPDFObjectHandle> new_labels;
     int out_pageno = 0;
-    auto& this_afdh = pdf.acroform();
+    auto& this_afdh = pdf.doc().acroform();
     std::set<QPDFObjGen> referenced_fields;
     for (auto& selection: new_specs.empty() ? m->inputs.selections : new_specs) {
         auto& input = selection.input();
         if (input.cfis) {
             input.cfis->stayOpen(true);
         }
-        auto* pldh = m->inputs.any_page_labels ? &input.qpdf->page_labels() : nullptr;
-        auto& other_afdh = input.qpdf->acroform();
+        auto* pldh = m->inputs.any_page_labels ? &input.qpdf->doc().page_labels() : nullptr;
+        auto& other_afdh = input.qpdf->doc().acroform();
         doIfVerbose([&](Pipeline& v, std::string const& prefix) {
             v << prefix << ": adding pages from " << selection.filename() << "\n";
         });
@@ -3012,8 +3012,8 @@ QPDFJob::doSplitPages(QPDF&amp; pdf)
         QPDFPageDocumentHelper dh(pdf);
         dh.removeUnreferencedResources();
     }
-    auto& pldh = pdf.page_labels();
-    auto& afdh = pdf.acroform();
+    auto& pldh = pdf.doc().page_labels();
+    auto& afdh = pdf.doc().acroform();
     std::vector<QPDFObjectHandle> const& pages = pdf.getAllPages();
     size_t pageno_len = std::to_string(pages.size()).length();
     size_t num_pages = pages.size();
@@ -3025,7 +3025,8 @@ QPDFJob::doSplitPages(QPDF&amp; pdf)
         }
         QPDF outpdf;
         outpdf.emptyPDF();
-        QPDFAcroFormDocumentHelper* out_afdh = afdh.hasAcroForm() ? &outpdf.acroform() : nullptr;
+        QPDFAcroFormDocumentHelper* out_afdh =
+            afdh.hasAcroForm() ? &outpdf.doc().acroform() : nullptr;
         if (m->suppress_warnings) {
             outpdf.setSuppressWarnings(true);
         }
@@ -34,7 +34,7 @@ QPDFOutlineDocumentHelper::QPDFOutlineDocumentHelper(QPDF&amp; qpdf) :
 QPDFOutlineDocumentHelper&
 QPDFOutlineDocumentHelper::get(QPDF& qpdf)
 {
-    return qpdf.outlines();
+    return qpdf.doc().outlines();
 }
 void
@@ -18,7 +18,7 @@ QPDFPageDocumentHelper::QPDFPageDocumentHelper(QPDF&amp; qpdf) :
 QPDFPageDocumentHelper&
 QPDFPageDocumentHelper::get(QPDF& qpdf)
 {
-    return qpdf.pages();
+    return qpdf.doc().pages();
 }
 void
@@ -72,7 +72,7 @@ QPDFPageDocumentHelper::removePage(QPDFPageObjectHelper page)
 void
 QPDFPageDocumentHelper::flattenAnnotations(int required_flags, int forbidden_flags)
 {
-    auto& afdh = qpdf.acroform();
+    auto& afdh = qpdf.doc().acroform();
     if (afdh.getNeedAppearances()) {
         qpdf.getRoot()
             .getKey("/AcroForm")
@@ -26,7 +26,7 @@ QPDFPageLabelDocumentHelper::QPDFPageLabelDocumentHelper(QPDF&amp; qpdf) :
 QPDFPageLabelDocumentHelper&
 QPDFPageLabelDocumentHelper::get(QPDF& qpdf)
 {
-    return qpdf.page_labels();
+    return qpdf.doc().page_labels();
 }
 void
@@ -425,9 +425,61 @@ class QPDF::Doc
     {
     }
+    QPDFAcroFormDocumentHelper&
+    acroform()
+    {
+        if (!acroform_) {
+            acroform_ = std::make_unique<QPDFAcroFormDocumentHelper>(qpdf);
+        }
+        return *acroform_;
+    }
+
+    QPDFEmbeddedFileDocumentHelper&
+    embedded_files()
+    {
+        if (!embedded_files_) {
+            embedded_files_ = std::make_unique<QPDFEmbeddedFileDocumentHelper>(qpdf);
+        }
+        return *embedded_files_;
+    }
+
+    QPDFOutlineDocumentHelper&
+    outlines()
+    {
+        if (!outlines_) {
+            outlines_ = std::make_unique<QPDFOutlineDocumentHelper>(qpdf);
+        }
+        return *outlines_;
+    }
+
+    QPDFPageDocumentHelper&
+    pages()
+    {
+        if (!pages_) {
+            pages_ = std::make_unique<QPDFPageDocumentHelper>(qpdf);
+        }
+        return *pages_;
+    }
+
+    QPDFPageLabelDocumentHelper&
+    page_labels()
+    {
+        if (!page_labels_) {
+            page_labels_ = std::make_unique<QPDFPageLabelDocumentHelper>(qpdf);
+        }
+        return *page_labels_;
+    }
+
   private:
     QPDF& qpdf;
     QPDF::Members& m;
+
+    // Document Helpers;
+    std::unique_ptr<QPDFAcroFormDocumentHelper> acroform_;
+    std::unique_ptr<QPDFEmbeddedFileDocumentHelper> embedded_files_;
+    std::unique_ptr<QPDFOutlineDocumentHelper> outlines_;
+    std::unique_ptr<QPDFPageDocumentHelper> pages_;
+    std::unique_ptr<QPDFPageLabelDocumentHelper> page_labels_;
 };
 class QPDF::Members
@@ -514,13 +566,6 @@ class QPDF::Members
     // Optimization data
     std::map<ObjUser, std::set<QPDFObjGen>> obj_user_to_objects;
     std::map<QPDFObjGen, std::set<ObjUser>> object_to_obj_users;
-
-    // Document Helpers;
-    std::unique_ptr<QPDFAcroFormDocumentHelper> acroform;
-    std::unique_ptr<QPDFEmbeddedFileDocumentHelper> embedded_files;
-    std::unique_ptr<QPDFOutlineDocumentHelper> outlines;
-    std::unique_ptr<QPDFPageDocumentHelper> pages;
-    std::unique_ptr<QPDFPageLabelDocumentHelper> page_labels;
 };
 // JobSetter class is restricted to QPDFJob.
@@ -543,51 +588,6 @@ QPDF::reconstructed_xref() const
     return m->reconstructed_xref;
 }
-inline QPDFAcroFormDocumentHelper&
-QPDF::acroform()
-{
-    if (!m->acroform) {
-        m->acroform = std::make_unique<QPDFAcroFormDocumentHelper>(*this);
-    }
-    return *m->acroform;
-}
-
-inline QPDFEmbeddedFileDocumentHelper&
-QPDF::embedded_files()
-{
-    if (!m->embedded_files) {
-        m->embedded_files = std::make_unique<QPDFEmbeddedFileDocumentHelper>(*this);
-    }
-    return *m->embedded_files;
-}
-
-inline QPDFOutlineDocumentHelper&
-QPDF::outlines()
-{
-    if (!m->outlines) {
-        m->outlines = std::make_unique<QPDFOutlineDocumentHelper>(*this);
-    }
-    return *m->outlines;
-}
-
-inline QPDFPageDocumentHelper&
-QPDF::pages()
-{
-    if (!m->pages) {
-        m->pages = std::make_unique<QPDFPageDocumentHelper>(*this);
-    }
-    return *m->pages;
-}
-
-inline QPDFPageLabelDocumentHelper&
-QPDF::page_labels()
-{
-    if (!m->page_labels) {
-        m->page_labels = std::make_unique<QPDFPageLabelDocumentHelper>(*this);
-    }
-    return *m->page_labels;
-}
-
 inline QPDF::Doc&
 QPDF::doc()
 {