octoleo/qpdf
2
1
Fork 0
mirror of https://github.com/qpdf/qpdf.git synced 2024-11-01 03:12:29 +00:00
Code Issues Releases Wiki Activity
8ba968bd86
qpdf/libqpdf/QPDFPageDocumentHelper.cc

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

159 lines
6.0 KiB
C++
Raw Normal View History

Add QPDFPageDocumentHelper and QPDFPageObjectHelper This is the beginning of higher-level API support using helper classes. The goal is to be able to add more helpers without continuing to pollute QPDF's and QPDFObjectHandle's public interfaces.
2018-06-18 19:05:53 +00:00
#include <qpdf/QPDFPageDocumentHelper.hh>
Add a blank line after the first header included in each source
2022-02-04 21:31:31 +00:00
Annotation flattening including form fields Flatten annotations by integrating their appearance streams into the content stream of the containing page. In the case of form fields, only flatten if /NeedAppearance is false (or equivalently absent). If flattening form fields, also remove /AcroForm from the document catalog.
2019-01-01 04:08:57 +00:00
#include <qpdf/QPDFAcroFormDocumentHelper.hh>
#include <qpdf/QTC.hh>
Switch annotation flattening to use the form xobjects Instead of directly putting the contents of the annotation appearance streams into the page's content stream, add commands to render the form xobjects directly. This is a more robust way to do it than the original solution as it works properly with patterns and avoids problems with resource name clashes between the pages and the form xobjects.
2019-01-03 02:44:10 +00:00
#include <qpdf/QUtil.hh>
Add QPDFPageDocumentHelper and QPDFPageObjectHelper This is the beginning of higher-level API support using helper classes. The goal is to be able to add more helpers without continuing to pollute QPDF's and QPDFObjectHandle's public interfaces.
2018-06-18 19:05:53 +00:00
QPDFPageDocumentHelper::QPDFPageDocumentHelper(QPDF& qpdf) :
QPDFDocumentHelper(qpdf)
{
}
std::vector<QPDFPageObjectHelper>
QPDFPageDocumentHelper::getAllPages()
{
std::vector<QPDFPageObjectHelper> pages;
Code clean up: use range-style for loops wherever possible Remove variables obsoleted by commit 4f24617.
2022-05-21 14:18:15 +00:00
for (auto const& iter: this->qpdf.getAllPages()) {
Code tidy - Clang-Tidy rule modernize-use-emplace
2023-05-27 22:49:18 +00:00
pages.emplace_back(iter);
Add QPDFPageDocumentHelper and QPDFPageObjectHelper This is the beginning of higher-level API support using helper classes. The goal is to be able to add more helpers without continuing to pollute QPDF's and QPDFObjectHandle's public interfaces.
2018-06-18 19:05:53 +00:00
}
return pages;
}
void
QPDFPageDocumentHelper::pushInheritedAttributesToPage()
{
this->qpdf.pushInheritedAttributesToPage();
}
When splitting files, remove unreferenced objects (fixes #203)
2018-06-22 00:16:05 +00:00
void
QPDFPageDocumentHelper::removeUnreferencedResources()
{
Code clean up: use range-style for loops wherever possible Remove variables obsoleted by commit 4f24617.
2022-05-21 14:18:15 +00:00
for (auto& ph: getAllPages()) {
Code clean up: use range-style for loops wherever possible Where not possible, use "auto" to get the iterator type. Editorial note: I have avoid this change for a long time because of not wanting to make gratuitous changes to version history, which can obscure when certain changes were made, but with having recently touched every single file to apply automatic code formatting and with making several broad changes to the API, I decided it was time to take the plunge and get rid of the older (pre-C++11) verbose iterator syntax. The new code is just easier to read and understand, and in many cases, it will be more effecient as fewer temporary copies are being made. m-holger, if you're reading, you can see that I've finally come around. :-)
2022-04-30 17:23:18 +00:00
ph.removeUnreferencedResources();
When splitting files, remove unreferenced objects (fixes #203)
2018-06-22 00:16:05 +00:00
}
}
Add QPDFPageDocumentHelper and QPDFPageObjectHelper This is the beginning of higher-level API support using helper classes. The goal is to be able to add more helpers without continuing to pollute QPDF's and QPDFObjectHandle's public interfaces.
2018-06-18 19:05:53 +00:00
void
QPDFPageDocumentHelper::addPage(QPDFPageObjectHelper newpage, bool first)
{
this->qpdf.addPage(newpage.getObjectHandle(), first);
}
void
QPDFPageDocumentHelper::addPageAt(
QPDFPageObjectHelper newpage, bool before, QPDFPageObjectHelper refpage)
{
this->qpdf.addPageAt(newpage.getObjectHandle(), before, refpage.getObjectHandle());
}
void
QPDFPageDocumentHelper::removePage(QPDFPageObjectHelper page)
{
this->qpdf.removePage(page.getObjectHandle());
}
Annotation flattening including form fields Flatten annotations by integrating their appearance streams into the content stream of the containing page. In the case of form fields, only flatten if /NeedAppearance is false (or equivalently absent). If flattening form fields, also remove /AcroForm from the document catalog.
2019-01-01 04:08:57 +00:00
void
Honor flags when flattening annotations
2019-01-03 16:51:58 +00:00
QPDFPageDocumentHelper::flattenAnnotations(int required_flags, int forbidden_flags)
Annotation flattening including form fields Flatten annotations by integrating their appearance streams into the content stream of the containing page. In the case of form fields, only flatten if /NeedAppearance is false (or equivalently absent). If flattening form fields, also remove /AcroForm from the document catalog.
2019-01-01 04:08:57 +00:00
{
QPDFAcroFormDocumentHelper afdh(this->qpdf);
if (afdh.getNeedAppearances()) {
this->qpdf.getRoot()
.getKey("/AcroForm")
.warnIfPossible("document does not have updated appearance streams, so form fields "
"will not be flattened");
}
Code clean up: use range-style for loops wherever possible Remove variables obsoleted by commit 4f24617.
2022-05-21 14:18:15 +00:00
for (auto& ph: getAllPages()) {
Handle inheritable page attributes Add getAttribute for handling inheritable page attributes, and fix getPageImages and annotation flattening code to use it.
2019-01-25 11:55:31 +00:00
QPDFObjectHandle resources = ph.getAttribute("/Resources", true);
Annotation flattening including form fields Flatten annotations by integrating their appearance streams into the content stream of the containing page. In the case of form fields, only flatten if /NeedAppearance is false (or equivalently absent). If flattening form fields, also remove /AcroForm from the document catalog.
2019-01-01 04:08:57 +00:00
if (!resources.isDictionary()) {
Fix annotations properly for page with no /Resources (fixes #827)
2023-01-09 12:31:39 +00:00
QTC::TC("qpdf", "QPDFPageDocumentHelper flatten resources missing or invalid");
resources = ph.getObjectHandle().replaceKeyAndGetNew(
"/Resources", QPDFObjectHandle::newDictionary());
Annotation flattening including form fields Flatten annotations by integrating their appearance streams into the content stream of the containing page. In the case of form fields, only flatten if /NeedAppearance is false (or equivalently absent). If flattening form fields, also remove /AcroForm from the document catalog.
2019-01-01 04:08:57 +00:00
}
Honor flags when flattening annotations
2019-01-03 16:51:58 +00:00
flattenAnnotationsForPage(ph, resources, afdh, required_flags, forbidden_flags);
Annotation flattening including form fields Flatten annotations by integrating their appearance streams into the content stream of the containing page. In the case of form fields, only flatten if /NeedAppearance is false (or equivalently absent). If flattening form fields, also remove /AcroForm from the document catalog.
2019-01-01 04:08:57 +00:00
}
if (!afdh.getNeedAppearances()) {
this->qpdf.getRoot().removeKey("/AcroForm");
}
}
void
QPDFPageDocumentHelper::flattenAnnotationsForPage(
QPDFPageObjectHelper& page,
QPDFObjectHandle& resources,
Honor flags when flattening annotations
2019-01-03 16:51:58 +00:00
QPDFAcroFormDocumentHelper& afdh,
int required_flags,
int forbidden_flags)
Annotation flattening including form fields Flatten annotations by integrating their appearance streams into the content stream of the containing page. In the case of form fields, only flatten if /NeedAppearance is false (or equivalently absent). If flattening form fields, also remove /AcroForm from the document catalog.
2019-01-01 04:08:57 +00:00
{
bool need_appearances = afdh.getNeedAppearances();
std::vector<QPDFAnnotationObjectHelper> annots = page.getAnnotations();
std::vector<QPDFObjectHandle> new_annots;
std::string new_content;
int rotate = 0;
QPDFObjectHandle rotate_obj = page.getObjectHandle().getKey("/Rotate");
if (rotate_obj.isInteger() && rotate_obj.getIntValue()) {
Fix sign and conversion warnings (major) This makes all integer type conversions that have potential data loss explicit with calls that do range checks and raise an exception. After this commit, qpdf builds with no warnings when -Wsign-conversion -Wconversion is used with gcc or clang or when -W3 -Wd4800 is used with MSVC. This significantly reduces the likelihood of potential crashes from bogus integer values. There are some parts of the code that take int when they should take size_t or an offset. Such places would make qpdf not support files with more than 2^31 of something that usually wouldn't be so large. In the event that such a file shows up and is valid, at least qpdf would raise an error in the right spot so the issue could be legitimately addressed rather than failing in some weird way because of a silent overflow condition.
2019-06-21 03:35:23 +00:00
rotate = rotate_obj.getIntValueAsInt();
Annotation flattening including form fields Flatten annotations by integrating their appearance streams into the content stream of the containing page. In the case of form fields, only flatten if /NeedAppearance is false (or equivalently absent). If flattening form fields, also remove /AcroForm from the document catalog.
2019-01-01 04:08:57 +00:00
}
Switch annotation flattening to use the form xobjects Instead of directly putting the contents of the annotation appearance streams into the page's content stream, add commands to render the form xobjects directly. This is a more robust way to do it than the original solution as it works properly with patterns and avoids problems with resource name clashes between the pages and the form xobjects.
2019-01-03 02:44:10 +00:00
int next_fx = 1;
Code clean up: use range-style for loops wherever possible Where not possible, use "auto" to get the iterator type. Editorial note: I have avoid this change for a long time because of not wanting to make gratuitous changes to version history, which can obscure when certain changes were made, but with having recently touched every single file to apply automatic code formatting and with making several broad changes to the API, I decided it was time to take the plunge and get rid of the older (pre-C++11) verbose iterator syntax. The new code is just easier to read and understand, and in many cases, it will be more effecient as fewer temporary copies are being made. m-holger, if you're reading, you can see that I've finally come around. :-)
2022-04-30 17:23:18 +00:00
for (auto& aoh: annots) {
Annotation flattening including form fields Flatten annotations by integrating their appearance streams into the content stream of the containing page. In the case of form fields, only flatten if /NeedAppearance is false (or equivalently absent). If flattening form fields, also remove /AcroForm from the document catalog.
2019-01-01 04:08:57 +00:00
QPDFObjectHandle as = aoh.getAppearanceStream("/N");
bool is_widget = (aoh.getSubtype() == "/Widget");
bool process = true;
if (need_appearances && is_widget) {
QTC::TC("qpdf", "QPDFPageDocumentHelper skip widget need appearances");
process = false;
}
When flattening, remove annotations with no appearance stream With the exception of form field annotations when /NeedAppearances is true, remove annotations that don't have appearance streams when flattening. There is no reason to keep these when flattening since they are invisible. This may include unchecked checkboxes, unshown popup windows, etc.
2019-01-21 01:40:56 +00:00
if (process && as.isStream()) {
Annotation flattening including form fields Flatten annotations by integrating their appearance streams into the content stream of the containing page. In the case of form fields, only flatten if /NeedAppearance is false (or equivalently absent). If flattening form fields, also remove /AcroForm from the document catalog.
2019-01-01 04:08:57 +00:00
if (is_widget) {
QTC::TC("qpdf", "QPDFPageDocumentHelper merge DR");
QPDFFormFieldObjectHelper ff = afdh.getFieldForAnnotation(aoh);
Switch annotation flattening to use the form xobjects Instead of directly putting the contents of the annotation appearance streams into the page's content stream, add commands to render the form xobjects directly. This is a more robust way to do it than the original solution as it works properly with patterns and avoids problems with resource name clashes between the pages and the form xobjects.
2019-01-03 02:44:10 +00:00
QPDFObjectHandle as_resources = as.getDict().getKey("/Resources");
if (as_resources.isIndirect()) {
QTC::TC("qpdf", "QPDFPageDocumentHelper indirect as resources");
as.getDict().replaceKey("/Resources", as_resources.shallowCopy());
as_resources = as.getDict().getKey("/Resources");
}
Fix behavior for finding /Q, /DA, and /DR for form fields If not found in the field hierarchy, /Q and /DA are supposed to be looked up in the document-level form dictionary. /DR is supposed to only come from the document dictionary.
2021-02-26 19:47:52 +00:00
as_resources.mergeResources(ff.getDefaultResources());
Annotation flattening including form fields Flatten annotations by integrating their appearance streams into the content stream of the containing page. In the case of form fields, only flatten if /NeedAppearance is false (or equivalently absent). If flattening form fields, also remove /AcroForm from the document catalog.
2019-01-01 04:08:57 +00:00
} else {
QTC::TC("qpdf", "QPDFPageDocumentHelper non-widget annotation");
}
Add QPDFObjectHandle::getUniqueResourceName
2019-01-25 23:15:23 +00:00
std::string name = resources.getUniqueResourceName("/Fxo", next_fx);
Honor flags when flattening annotations
2019-01-03 16:51:58 +00:00
std::string content =
aoh.getPageContentForAppearance(name, rotate, required_flags, forbidden_flags);
if (!content.empty()) {
Add operator ""_qpdf for creating QPDFObjectHandle literals
2022-02-05 14:18:58 +00:00
resources.mergeResources("<< /XObject << >> >>"_qpdf);
Honor flags when flattening annotations
2019-01-03 16:51:58 +00:00
resources.getKey("/XObject").replaceKey(name, as);
++next_fx;
}
new_content += content;
Preserve annotations that inherently lack appearance (fixes #1039) ...when flattening annotations. This includes /Link, /Popup, and /Projection.
2023-12-29 18:35:29 +00:00
} else if (process && !aoh.getAppearanceDictionary().isNull()) {
// If an annotation has no selected appearance stream, just drop the annotation when
// flattening. This can happen for unchecked checkboxes and radio buttons, popup windows
// associated with comments that aren't visible, and other types of annotations that
// aren't visible. Annotations that have no appearance streams at all, such as Link,
// Popup, and Projection, should be preserved.
When flattening, remove annotations with no appearance stream With the exception of form field annotations when /NeedAppearances is true, remove annotations that don't have appearance streams when flattening. There is no reason to keep these when flattening since they are invisible. This may include unchecked checkboxes, unshown popup windows, etc.
2019-01-21 01:40:56 +00:00
QTC::TC("qpdf", "QPDFPageDocumentHelper ignore annotation with no appearance");
Annotation flattening including form fields Flatten annotations by integrating their appearance streams into the content stream of the containing page. In the case of form fields, only flatten if /NeedAppearance is false (or equivalently absent). If flattening form fields, also remove /AcroForm from the document catalog.
2019-01-01 04:08:57 +00:00
} else {
new_annots.push_back(aoh.getObjectHandle());
}
}
if (new_annots.size() != annots.size()) {
QPDFObjectHandle page_oh = page.getObjectHandle();
if (new_annots.empty()) {
QTC::TC("qpdf", "QPDFPageDocumentHelper remove annots");
page_oh.removeKey("/Annots");
} else {
QPDFObjectHandle old_annots = page_oh.getKey("/Annots");
QPDFObjectHandle new_annots_oh = QPDFObjectHandle::newArray(new_annots);
if (old_annots.isIndirect()) {
QTC::TC("qpdf", "QPDFPageDocumentHelper replace indirect annots");
this->qpdf.replaceObject(old_annots.getObjGen(), new_annots_oh);
} else {
QTC::TC("qpdf", "QPDFPageDocumentHelper replace direct annots");
page_oh.replaceKey("/Annots", new_annots_oh);
}
}
Use QPDF::newStream in library
2022-09-26 19:11:27 +00:00
page.addPageContents(qpdf.newStream("q\n"), true);
page.addPageContents(qpdf.newStream("\nQ\n" + new_content), false);
Annotation flattening including form fields Flatten annotations by integrating their appearance streams into the content stream of the containing page. In the case of form fields, only flatten if /NeedAppearance is false (or equivalently absent). If flattening form fields, also remove /AcroForm from the document catalog.
2019-01-01 04:08:57 +00:00
}
}
Copy Permalink