blitz-pdf 0.1.1 → 0.1.2

package/vendor/krilla/src/configure/PDF_A4.md

@@ -0,0 +1,211 @@
+# Description
+PDF/A-4 requires PDF version 2.0.
+
+See `README.md` for the meaning of each color.
+
+## 5.1 Conforming files
+- krilla does not use any deprecated features for PDF 2.0. 🟢
+
+## 6.1 File structure
+-
+
+### 6.1.2 File header
+- krilla only allows exporting with PDF 2.0 in this mode. 🟢
+- krilla always writes the binary marker as written. 🟢
+
+### 6.1.3 File trailer
+- The trailer is written as defined. 🟢
+- krilla does not support encryption. 🟢
+- krilla does not write the `Info` attribute into the trailer. 🟢
+
+### 6.1.4 Cross reference table
+- The cross-reference table is always written as defined. 🟢
+
+### 6.1.5 String objects
+- pdf-writer always writes an even amount of digits for hexadecimal strings. 🟢
+
+### 6.1.6 Stream objects
+- krilla writes streams as mandated. 🟢
+- krilla does not use the `F`, `FFilter` or `FDecodeParams` attributes. 🟢
+- krilla does not use LZWDecode. 🟢
+- krilla does not support the `Crypt` filter. 🟢
+
+### 6.1.7 Name objects
+- krilla does not use non-UTF8 names. 🟢 (TODO: what about user supplied ones?)
+
+### 6.1.8 Indirect objects
+- krilla always writes indirect objects as defined. 🟢
+
+### 6.1.9 Inline image dictionaries
+- krilla does not use inline images. 🟢
+
+### 6.1.10 Linearized PDF
+- krilla does not support linearization. 🟢
+
+### 6.1.11 Permissions
+- krilla does not support permissions. 🟢
+
+### 6.1.12 Document catalog dictionary
+- krilla writes the PDF file header version as 2.0 and does not write a conflicting catalog
+  `Version` entry. 🟢
+
+## 6.2 Graphics
+
+### 6.2.1 General
+
+### 6.2.2 Content streams
+- krilla does not use custom content stream operators. 🟢
+
+### 6.2.3 Output intent
+- krilla always writes the output intent for this export mode. 🟢
+- krilla does not use the `DestOutputProfileRef` attribute. 🟢
+- krilla does not write multiple output intents (since PDF/X and PDF/E are not supported). 🟢
+- krilla only uses a Display ICC profile for output intent. 🟢
+- krilla only uses RGB for output intents. 🟢
+
+### 6.2.4 Colour spaces
+- krilla only uses device-independent colors in this export mode. 🟢 
+- krilla uses compatible ICC profiles. 🟢
+- krilla does not use the OPM entry. 🟢
+- krilla never uses CMYK profiles as the destination profile. 🟢
+- krilla does not use device color spaces in this mode. 🟢
+- krilla ensures the Alternate space in Separation color spaces obeys the restrictions
+  in the applicable clauses 🟢
+- krilla does not support DeviceN color spaces. 🔵
+- krilla fails export if a Separation colorant is associated with multiple different
+  fallback color spaces 🟢
+- krilla manages the `tintTransform` function and will always write the same function for
+  the same color space 🟢
+
+### 6.2.5 Extended graphics state
+- krilla does not use the `TR`, `HTO`, `TR2` or `HT` keys. 🟢
+- krilla does not use halftones. 🟢
+- krilla does not use the `FL`, `BG`, `BG2`, `UCR` or `URC2` functions. 🟢
+
+### 6.2.6 Flatness
+- krilla does not use the flatness parameter. 🟢
+
+### 6.2.7 Images
+- krilla does not use the `Alternates` or `OPI` key. 🟢
+- krilla disallows the `Interpolate` key in this mode. 🟢
+- krilla does not support thumbnails. 🟢
+- krilla does not support JPEG2000 images. 🟢
+
+### 6.2.8 XObjects
+- krilla does not use the `OPI` key in FormXObjects. 🟢
+- krilla does not use reference XObjects. 🟢
+
+### 6.2.9 Transparency
+- krilla uses transparency as mandated. 🟢
+
+### 6.2.10 Fonts
+- krilla uses fonts as described in the spec. 🟢
+- krilla always uses the IDENTITY-H encoding. 🟢
+- krilla always embeds a CIDtoGIDMap for Type2 CID fonts. 🟢
+- krilla always embeds cmaps and adds the WMode entry. 🟢
+- krilla always embeds the font programs. 🟢
+- krilla only uses glyphs referenced in the font. 🟢
+- krilla derives the glyph width information from the font program, also for Type3 fonts. 🟢
+- krilla does not use fonts in vertical writing mode. 🟢
+- krilla only writes symbolic TrueType fonts. 🟢
+- krilla does not use the `Encoding` entry in the font dictionary. 🟢
+- krilla always writes the `ToUnicode` entry. 🟢
+- krilla ensures Unicode values are always greater than 0 and not equal to U+FEFF or U+FFFE. 🟢
+- krilla straight out forbids characters in the private use area. 🟢
+- krilla disallows the .notdef glyph in this export mode. 🟢
+- krilla checks the OpenType fsType field to ensure that fonts are legally embeddable. 🟢
+
+## 6.3 Annotations
+
+### 6.3.1 Annotation types
+- krilla only supports link annotations. 🟢
+
+### 6.3.2 Annotation dictionaries
+- Annotation dictionaries always contain the `F` key and sets the values accordingly. 🟢
+- krilla does not support text annotations. 🟢
+
+### 6.3.3 Annotation appearances
+- This section only contains provisions for readers. 🟢
+
+### 6.3.4 Display of annotation contents
+- krilla does not use appearence dictionaries. 🟢
+
+## 6.4 Interactive forms
+
+- krilla does not support interactive forms. 🟢
+
+## 6.5 Digital signatures
+
+- krilla does not support digital signatures. 🟢
+
+## 6.6 Action
+
+### 6.6.1 General
+- krilla does not support any of the named actions. 🟢
+
+### 6.6.2 Handling of JavaScript actions
+- krilla does not support JavaScript actions. 🟢
+
+### 6.6.3 Trigger events
+- krilla does not use the `AA` entry anywhere. 🟢
+
+### 6.6.4 Handling of GoToR, GoToE, URI and SubmitForm actions
+- This section only contains provisions for readers. 🟢
+
+## 6.7 Metadata
+
+### 6.7.1 General
+
+### 6.7.2 Metadata streams
+- krilla always requires metadata in this export mode. 🟢
+- krilla does not use the `bytes` and `encoding` attributes. 🟢
+- krilla uses the outlined namespaces and prefixes. 🟢
+- krilla does not currently have an associated file containing the embedded file specification. However,
+  it seems like there is an issue with the spec because I can't find that table entry in the PDF 2.0 spec? 
+  And no validator I tried seems to complain about this.🔴
+
+### 6.7.3 Version identification
+- krilla always writes the required version identification parts. 🟢
+
+### 6.7.4 File identifiers
+- krilla always adds a document identifier to the metadata. 🟢
+- krilla writes a minimal `xmpMM:History` entry when a creation date is provided. 🟢
+
+### 6.7.5 File provenance information
+- krilla writes a minimal `xmpMM:History` entry when a creation date is provided. 🟢
+
+## 6.8 Logical structure
+- Logical structure is only optional, so krilla does not make any enforcements here, but the
+  recommendation is documented. 🟢
+
+## 6.9 Embedded files
+- krilla straight out forbids embedding files in this export mode. 🟢
+
+## 6.10 Optional content
+- krilla does not support optional content. 🟢
+
+## 6.11 Use of alternate presentations and transitions
+- krilla does not use the `AlternatePresentations` entry. 🟢
+
+## 6.12 Document requirements
+- krilla does not use the `Requirements` key. 🟢
+
+## 6.13 Print scaling
+- This section only contains provisions for processors. 🟢
+
+## 6.14 Geospatial
+- krilla does not support any of the geospatial features. 🟢
+
+## 6.15 Measurement Properties
+- krilla does not use any of the measurement properties. 🟢
+
+# A4-F
+- krilla allows embedding any files in this export mode. 🟢
+- krilla always writes the `AFRelationship`, `Desc`, `UF` and `F` strings in this case. 🟢
+- krilla always writes the corresponding file identification. 🟢
+
+# A4-E
+- krilla does not support any of the 3D features. 🟢
+- krilla deals similarly with embedded files similarly to A4-F. 🟢
+- krilla always writes the corresponding file identification. 🟢
+

package/vendor/krilla/src/configure/PDF_UA1.md

@@ -0,0 +1,202 @@
+# Description
+PDF/UA-1 requires a version <= PDF 1.7.
+
+See `README.md` for the meaning of each color.
+
+# 6.1 General
+
+- krilla defaults to PDF 1.7 for this mode, but allows any PDF version up to PDF 1.7. 🟢
+
+# 6.2 Conforming files
+
+- krilla writes the `pdfuaid:part` attribute. 🟢
+- krilla does adhere to the file format provisions. 🟢
+
+# 6.3 Conforming reader
+
+- Not applicable to krilla as a writer. -
+
+# 6.4 Conforming assistive technology
+
+- Not applicable to krilla as a writer. -
+
+# 7.1 General
+
+- The fact that real content should be tagged is documented. 🟣
+- The fact that artifacts should be marked is documented.  🟣
+- krilla never includes artifacts in the structure tree. 🟢
+- krilla role maps all non-standard structure types. 🟢
+- krilla does not overwrite non-standard structure types. 🟢
+- krilla doesn't support any elements that flicker, flash or blink. 🟢
+- The fact that information shall not be conveyed by contrast, colour, format or layout is documented. 🟣
+- krilla does not support sounds. 🔵
+- krilla forces the user to provide a document title. 🟢
+- krilla always sets `DisplayDocTitle` to true for this mode. 🟢
+- krilla can't really control if the user provides raster-based images as content. 🟠
+- krilla always writes the `Suspects` value as false. 🟢
+
+# 7.2 Text
+- The fact that logical reading order should be followed is documented. 🟣
+- krilla checks that every character is mapped to a codepoint. 🟢
+- The fact that the user should make use of the natural language attributes is documented. 🟣
+- The fact that stretchable characters should be marked with `ActualText` is documented. 🟣
+- krilla allows setting the language of spans. 🟢
+
+# 7.3 Graphics
+- The fact that figures should be tagged (as a figure or an artifact) is documented. 🟣
+- The fact that figures should be followed by a caption is documented. 🟣
+- The fact that an alternate text should be provided to figures is checked. 🟢
+- The fact graphics that possess semantic value only in combination with other graphics should be tagged with a single Figure tag for each group is documented. 🟣
+- The fact that a more accessible representation should be used if it exists is documented. 🟣
+
+# 7.4 Headings
+
+7.4.1:
+- The fact that headings should be tagged is documented. 🟣
+- krilla supports the `T` key for headings. 🟢
+
+7.4.2:
+- The information there is hardly enforceable in an automated way, so not documented yet. 🟠
+
+7.4.3:
+- krilla adds tags for heading levels higher than 6 as prescribed. 🟢
+
+7.4.4:
+- The information there is hardly enforceable in an automated way, so not documented yet. 🟠
+
+# 7.5 Tables
+- The fact that tables should include headers is documented. 🟣
+- krilla always requires the user to provide a table header scope. 🟢
+- The fact that table tagging structures should only be used to tag content presented within logical row and/or column relationships is documented. 🟣
+
+# 7.6 Lists
+- The fact that lists should be tagged is documented. 🟣
+- The fact that Li, Lbl and LBody should be used is documented. 🟣
+- krilla always forces writing the `ListNumbering` attribute for lists. 🟢
+
+# 7.7 Mathematical expressions
+- The fact that mathematical expressions should be wrapped in `Formula` is documented. 🟣
+- The fact that mathematical expressions should have an alternate text is checked. 🟢
+
+# 7.8 Page headers and footers
+- The fact that headers and footers should be tagged is documented. 🟣
+
+# 7.9 Notes and references
+- The fact that footnotes, endnotes, note labels and references should be tagged is documented. 🟣
+- The fact that footnotes and endnotes should be tagged with `Note` is documented. 🟣
+- krilla always generates an ID for notes. 🟢
+
+# 7.10 Optional content
+- krilla does currently not support optional content. 🔵
+
+# 7.11 Embedded files
+- krilla supports embedded files, and requires a description in this export mode. 🟢
+- The fact that embedded files should be accessible in their own right is documented. 🟣
+
+# 7.12 Article threads
+- The fact that the logical reading order should be preserved is documented. 🟣
+
+# 7.13 Digital signatures
+- krilla does not support digital signatures. 🔵
+
+# 7.14 Non-interactive forms
+- krilla does not support forms. 🔵
+
+# 7.15 XFA
+- krilla does not support forms. 🔵
+
+# 7.16 Security
+- krilla does not support encryption. 🔵
+
+# 7.17 Navigation
+- krilla enforces setting a document outline. 🟢
+- The fact that the outline should reflect the reading order is
+  documented. 🟣
+- The fact that page labels should be semantically appropriate is documented. 🟣
+
+# 7.18 Annotations
+7.18.1:
+- The fact that annotations should reflect the reading order is documented. 🟣
+- The fact that for visual formatting, annotations should 
+  be tagged according to their semantic function is not documented. 🟠
+- krilla ensures that annotations have an alternate text. 🟢
+
+7.18.2:
+- krilla only supports the default annotation types. 🟢
+- krilla does not use the `TrapNet` annotation. 🔵
+
+7.18.3
+- krilla always writes the `TabOrder` property for pages that have a struct parent. 🟢
+
+7.18.4
+- krilla does not support widget annotations. 🔵
+
+7.18.5
+- The best practices for link tagging are documented. 🟣
+- krilla enforces an alt text for all annotations. 🟢
+- krilla never writes the `IMap` key for URIs. 🔵
+
+7.18.6
+- krilla does not support media annotations. 🔵
+
+7.18.7
+- krilla does not support file attachment annotations. 🔵
+
+7.18.8
+- krilla does not support printer mark annotations. 🔵
+
+# 7.19 Actions
+- krilla does not support adding (JavaScript) scripts. 🔵
+
+# 7.20 XObjects
+- krilla never creates reference XObjects. 🔵
+- krilla doesn't allow references to XObjects for tagging. 🔵
+
+# 7.21 Fonts
+
+7.21.1: -
+
+7.21.2:
+- krilla ensures to always conform to the PDF specification. 🟢
+
+7.21.3.1:
+- krilla always uses Identity-H for encoding. 🟢
+
+7.21.3.2:
+- krilla always includes a `CIDToGIDMap`. 🟢
+
+7.21.3.3
+- krilla always includes a cmap. 🟢
+- krilla always writes the `WMode` entry in cmaps. 🟢
+- krilla never references other cmaps in a cmap. 🟢
+
+7.21.4.1
+- krilla always embeds a cmap for all used fonts. 🟢
+- The fact that only legally embeddable fonts should be used is
+  documented. 🟣
+- krilla export only succeeds if all glyphs are available in the font (otherwise subsetting fails). 🟢
+
+7.21.4.2
+- krilla doesn't include a CharSet in font descriptors. 🟢
+- krilla always includes all CIDs in `CIDSet`. 🟢
+
+7.21.5
+- Font metrics should (hopefully) be as consistent as possible. 🟢
+
+7.21.6
+- krilla only uses CID fonts and not (PDF) TrueType fonts. 🟢
+
+7.21.7
+- krilla always includes the `ToUnicode` entry with corresponding mappings. 🟢
+- krilla will fail export if 0, U+FEFF or U+FFFE is included. 🟢
+
+7.21.8
+- krilla will fail export if the .notdef glyph is included. 🟢
+
+# 8 Reader Requirements
+
+- Not applicable to krilla as a writer. -
+
+# 9 Assistive Technology Requirements
+
+- Not applicable to krilla as a writer. -

package/vendor/krilla/src/configure/README.md

@@ -0,0 +1,23 @@
+# Introduction
+
+The files in this folder track the properties that are required to achieve 
+different compliance level, as well as a description of how/why krilla achieves those. 
+As krilla evolves and new features are added, these documents
+might have to be updated, and we always need to ensure that all invariants are still enforced,
+when adding new features.
+
+# Legend
+🟢: This means that krilla actively checks that this property is enforced, either by an
+invariant in the code, or by returning an error to the user in case it's not fulfillable.
+
+🔵: This means that krilla fulfills this property because it's not supported.
+
+🟣: This means that this property cannot be enforced by krilla, and thus is only documented.  
+It is upon the user of the library to enforce it.
+
+🔴: This means that the property is currently not enforced by krilla.
+
+🟠: This means that the property should perhaps be documented/checked, but is
+currently not because it seems unnecessary or hard to implement.
+
+-: This means that the clause is not applicable to krilla (for example because it's not a reader application)

package/vendor/krilla/src/configure/mod.rs

@@ -0,0 +1,197 @@
+//! Configuring PDF version and export mode.
+
+pub mod validate;
+mod version;
+
+pub use validate::{Accessibility, Archival, ValidationError, Validator, Validators};
+pub use version::PdfVersion;
+
+use crate::configure::validate::ValidatorsBuilder;
+
+/// A configuration of validator and PDF version.
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
+pub struct Configuration {
+    validators: Validators,
+    version: PdfVersion,
+}
+
+impl Configuration {
+    /// Return the validators of the configuration.
+    pub fn validators(self) -> Validators {
+        self.validators
+    }
+
+    /// Return the PDF version of the configuration.
+    pub fn version(self) -> PdfVersion {
+        self.version
+    }
+}
+
+/// A configuration of validator and PDF version.
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
+pub struct ConfigurationBuilder {
+    validators: ValidatorsBuilder,
+    version: Option<PdfVersion>,
+}
+
+impl ConfigurationBuilder {
+    /// Create a new `ConfigurationBuilder` with default settings.
+    pub fn new() -> Self {
+        Self::default()
+    }
+
+    /// Set the PDF version, overwriting the current one if already set.
+    pub fn with_version(mut self, version: PdfVersion) -> Self {
+        self.version = Some(version);
+        self
+    }
+
+    /// Set a validator, overwriting the current one if the same standard family is already set.
+    pub fn set_validator(mut self, validator: Validator) -> Self {
+        self.validators = self.validators.set_validator(validator);
+        self
+    }
+
+    /// Set the PDF/A validator, overwriting the current one if already set.
+    pub fn with_archival_validator(mut self, archival: Archival) -> Self {
+        self.validators = self.validators.with_archival_validator(archival);
+        self
+    }
+
+    /// Set the PDF/UA accessibility validator, overwriting the current one if already set.
+    pub fn with_accessibility_validator(mut self, ua: Accessibility) -> Self {
+        self.validators = self.validators.with_accessibility_validator(ua);
+        self
+    }
+
+    /// Build the [`Configuration`], returning an error if the validators and version are incompatible.
+    pub fn finish(self) -> Result<Configuration, ConfigurationError> {
+        let validators = self
+            .validators
+            .finish()
+            .map_err(ConfigurationError::NoOverlappingValidatorsRange)?;
+
+        let validator_range = validators.min().unwrap_or(PdfVersion::MIN)..=validators.max();
+        match self.version {
+            Some(version) if validator_range.contains(&version) => Ok(Configuration {
+                validators,
+                version,
+            }),
+            Some(version) => Err(ConfigurationError::VersionDoesNotMatchValidatorsRange(
+                version, validators,
+            )),
+            None if !validators.is_empty() => Ok(Configuration {
+                validators,
+                version: *validator_range.end(),
+            }),
+            None => {
+                let version = PdfVersion::default();
+                debug_assert!(validator_range.contains(&version));
+                Ok(Configuration {
+                    validators,
+                    version,
+                })
+            }
+        }
+    }
+}
+
+/// An error that occurred while building a [`Configuration`].
+#[derive(Clone, Debug, PartialEq, Eq)]
+pub enum ConfigurationError {
+    /// The selected validators have no overlapping valid PDF version range.
+    NoOverlappingValidatorsRange(Validators),
+    /// The explicitly set PDF version falls outside the range allowed by the validators.
+    VersionDoesNotMatchValidatorsRange(PdfVersion, Validators),
+}
+
+#[cfg(test)]
+mod tests {
+    use crate::configure::{
+        Accessibility, Archival, Configuration, ConfigurationBuilder, ConfigurationError,
+        PdfVersion,
+    };
+
+    #[test]
+    fn invalid_combination_1() {
+        // A1_B max is PDF 1.4; explicit PDF 1.7 is out of range.
+        assert!(matches!(
+            ConfigurationBuilder::new()
+                .with_version(PdfVersion::Pdf17)
+                .with_archival_validator(Archival::A1_B)
+                .finish(),
+            Err(ConfigurationError::VersionDoesNotMatchValidatorsRange(
+                PdfVersion::Pdf17,
+                _
+            ))
+        ));
+    }
+
+    #[test]
+    fn invalid_combination_2() {
+        // A4 requires PDF 2.0; UA1 max is PDF 1.7 → no overlapping range.
+        assert!(matches!(
+            ConfigurationBuilder::new()
+                .with_archival_validator(Archival::A4)
+                .with_accessibility_validator(Accessibility::UA1)
+                .finish(),
+            Err(ConfigurationError::NoOverlappingValidatorsRange(_))
+        ));
+    }
+
+    #[test]
+    fn invalid_combination_3() {
+        // A1_B max is PDF 1.4; UA1 max is PDF 1.7 → intersection is PDF14..=PDF14.
+        // Explicitly setting PDF 1.7 is out of range.
+        assert!(matches!(
+            ConfigurationBuilder::new()
+                .with_archival_validator(Archival::A1_B)
+                .with_accessibility_validator(Accessibility::UA1)
+                .with_version(PdfVersion::Pdf17)
+                .finish(),
+            Err(ConfigurationError::VersionDoesNotMatchValidatorsRange(
+                PdfVersion::Pdf17,
+                _
+            ))
+        ));
+    }
+
+    #[test]
+    fn multi_validator_pdf_a3b_pdf_ua1() {
+        let config = ConfigurationBuilder::new()
+            .with_archival_validator(Archival::A3_B)
+            .with_accessibility_validator(Accessibility::UA1)
+            .finish()
+            .unwrap();
+        assert_eq!(config.validators().archival(), Some(Archival::A3_B));
+        assert_eq!(
+            config.validators().accessibility(),
+            Some(Accessibility::UA1)
+        );
+        assert_eq!(config.version(), PdfVersion::Pdf17);
+    }
+
+    #[test]
+    fn multi_validator_pdfa2a_pdfua1() {
+        assert!(ConfigurationBuilder::new()
+            .with_archival_validator(Archival::A2_A)
+            .with_accessibility_validator(Accessibility::UA1)
+            .finish()
+            .is_ok());
+    }
+
+    #[test]
+    fn empty_validators() {
+        let config = ConfigurationBuilder::new().finish().unwrap();
+        assert!(config.validators().is_empty());
+        assert_eq!(config.version(), PdfVersion::Pdf17);
+    }
+
+    #[test]
+    fn default_config() {
+        assert_eq!(
+            ConfigurationBuilder::new().finish().unwrap(),
+            Configuration::default()
+        );
+    }
+}