hayro_syntax/object/
dict.rs

1//! Dictionaries.
2
3use crate::object::macros::object;
4use crate::object::r#ref::{MaybeRef, ObjRef};
5use crate::object::{Name, ObjectIdentifier};
6use crate::object::{Object, ObjectLike};
7use crate::reader::Reader;
8use crate::reader::{Readable, ReaderContext, ReaderExt, Skippable};
9use crate::xref::XRef;
10use std::collections::HashMap;
11use std::fmt::{Debug, Formatter};
12use std::ops::Deref;
13use std::sync::Arc;
14
15/// A dictionary, which is a key-value map, keys being names, and values being any PDF object or
16/// objetc reference.
17#[derive(Clone)]
18pub struct Dict<'a>(Arc<Repr<'a>>);
19
20impl Default for Dict<'_> {
21    fn default() -> Self {
22        Self::empty()
23    }
24}
25
26// Note that this is not structural equality, i.e. two dictionaries with the same
27// items are still considered different if they have different whitespaces.
28impl PartialEq for Dict<'_> {
29    fn eq(&self, other: &Self) -> bool {
30        self.0.data == other.0.data
31    }
32}
33
34impl<'a> Dict<'a> {
35    /// Create a new empty dictionary.
36    pub fn empty() -> Self {
37        let repr = Repr {
38            data: &[],
39            offsets: HashMap::default(),
40            ctx: ReaderContext::new(XRef::dummy(), false),
41        };
42
43        Self(Arc::new(repr))
44    }
45
46    /// Get the raw bytes underlying to the dictionary.
47    pub fn data(&self) -> &'a [u8] {
48        self.0.data
49    }
50
51    /// Returns the number of entries in the dictionary.
52    pub fn len(&self) -> usize {
53        self.0.offsets.len()
54    }
55
56    /// Return whether the dictionary is empty.
57    pub fn is_empty(&self) -> bool {
58        self.0.offsets.is_empty()
59    }
60
61    /// Checks whether the dictionary contains an entry with a specific key.
62    pub fn contains_key(&self, key: impl Deref<Target = [u8]>) -> bool {
63        self.0
64            .offsets
65            .contains_key(&Name::from_unescaped(key.deref()))
66    }
67
68    /// Returns the entry of a key as a specific object, or try to resolve it in case it's
69    /// an object reference.
70    #[allow(
71        private_bounds,
72        reason = "users shouldn't be able to implement `ObjectLike` for custom objects."
73    )]
74    pub fn get<T>(&self, key: impl Deref<Target = [u8]>) -> Option<T>
75    where
76        T: ObjectLike<'a>,
77    {
78        self.get_raw::<T>(key.as_ref())?.resolve(&self.0.ctx)
79    }
80
81    /// Get the object reference linked to a key.
82    pub fn get_ref(&self, key: impl Deref<Target = [u8]>) -> Option<ObjRef> {
83        let offset = *self.0.offsets.get(&Name::from_unescaped(key.as_ref()))?;
84
85        Reader::new(&self.0.data[offset..]).read_with_context::<ObjRef>(&self.0.ctx)
86    }
87
88    /// Returns an iterator over all keys in the dictionary.
89    pub fn keys(&self) -> impl Iterator<Item = Name<'a>> {
90        self.0.offsets.keys().cloned()
91    }
92
93    /// An iterator over all entries in the dictionary, sorted by key.
94    pub fn entries(&self) -> impl Iterator<Item = (Name<'a>, MaybeRef<Object<'a>>)> {
95        let mut sorted_keys = self.keys().collect::<Vec<_>>();
96        sorted_keys.sort_by(|n1, n2| n1.as_ref().cmp(n2.as_ref()));
97        sorted_keys.into_iter().map(|k| {
98            let obj = self.get_raw(k.deref()).unwrap();
99            (k, obj)
100        })
101    }
102
103    /// Return the object identifier of the dict, if it's an indirect object.
104    pub fn obj_id(&self) -> Option<ObjectIdentifier> {
105        self.0.ctx.obj_number
106    }
107
108    /// Return the raw entry for a specific key.
109    #[allow(private_bounds)]
110    pub fn get_raw<T>(&self, key: impl Deref<Target = [u8]>) -> Option<MaybeRef<T>>
111    where
112        T: Readable<'a>,
113    {
114        let offset = *self.0.offsets.get(&Name::from_unescaped(key.as_ref()))?;
115
116        Reader::new(&self.0.data[offset..]).read_with_context::<MaybeRef<T>>(&self.0.ctx)
117    }
118
119    pub(crate) fn ctx(&self) -> &ReaderContext<'a> {
120        &self.0.ctx
121    }
122}
123
124impl Debug for Dict<'_> {
125    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
126        let mut r = Reader::new(self.0.data);
127        let mut debug_struct = f.debug_struct("Dict");
128
129        for (key, val) in &self.0.offsets {
130            r.jump(*val);
131            debug_struct.field(
132                &format!("{:?}", key.as_str()),
133                &r.read_with_context::<MaybeRef<Object<'_>>>(&ReaderContext::dummy())
134                    .unwrap(),
135            );
136        }
137        Ok(())
138    }
139}
140
141impl Skippable for Dict<'_> {
142    fn skip(r: &mut Reader<'_>, is_content_stream: bool) -> Option<()> {
143        r.forward_tag(b"<<")?;
144
145        loop {
146            r.skip_white_spaces_and_comments();
147
148            if let Some(()) = r.forward_tag(b">>") {
149                break Some(());
150            } else {
151                let Some(_) = r.skip::<Name<'_>>(is_content_stream) else {
152                    // In case there is garbage in-between, be lenient and just try to skip it.
153                    r.skip::<Object<'_>>(is_content_stream)?;
154                    continue;
155                };
156
157                r.skip_white_spaces_and_comments();
158
159                if is_content_stream {
160                    r.skip::<Object<'_>>(is_content_stream)?;
161                } else {
162                    r.skip::<MaybeRef<Object<'_>>>(is_content_stream)?;
163                }
164            }
165        }
166    }
167}
168
169impl<'a> Readable<'a> for Dict<'a> {
170    fn read(r: &mut Reader<'a>, ctx: &ReaderContext<'a>) -> Option<Self> {
171        read_inner(r, ctx, Some(b"<<"), b">>")
172    }
173}
174
175fn read_inner<'a>(
176    r: &mut Reader<'a>,
177    ctx: &ReaderContext<'a>,
178    start_tag: Option<&[u8]>,
179    end_tag: &[u8],
180) -> Option<Dict<'a>> {
181    let mut offsets = HashMap::new();
182
183    let data = {
184        let dict_data = r.tail()?;
185        let start_offset = r.offset();
186
187        // Inline image dictionaries don't start with '<<'.
188        if let Some(start_tag) = start_tag {
189            r.forward_tag(start_tag)?;
190        }
191
192        loop {
193            r.skip_white_spaces_and_comments();
194
195            // Normal dictionaries end with '>>', inline image dictionaries end with BD.
196            if let Some(()) = r.peek_tag(end_tag) {
197                r.forward_tag(end_tag)?;
198                let end_offset = r.offset() - start_offset;
199
200                break &dict_data[..end_offset];
201            } else {
202                let Some(name) = r.read_without_context::<Name<'_>>() else {
203                    if start_tag.is_some() {
204                        // In case there is garbage in-between, be lenient and just try to skip it.
205                        // But only do this if we are parsing a proper dictionary as opposed to an
206                        // inline dictionary.
207                        r.read::<Object<'_>>(ctx)?;
208                        continue;
209                    } else {
210                        return None;
211                    }
212                };
213                r.skip_white_spaces_and_comments();
214
215                // Do note that we are including objects in our dictionary even if they
216                // are the null object, meaning that a call to `contains_key` will return `true`
217                // even if the object is the null object. The PDF reference in theory requires
218                // us to treat them as non-existing. Previously, we included a check to determine
219                // whether the object is `null` before inserting it, but that caused problems
220                // in some test cases where encryption + object streams are involved (as we would
221                // attempt to read an object stream before having resolved the encryption dictionary).
222                let offset = r.offset() - start_offset;
223                offsets.insert(name, offset);
224
225                if ctx.in_content_stream {
226                    r.skip::<Object<'_>>(ctx.in_content_stream)?;
227                } else {
228                    r.skip::<MaybeRef<Object<'_>>>(ctx.in_content_stream)?;
229                }
230            }
231        }
232    };
233
234    Some(Dict(Arc::new(Repr {
235        data,
236        offsets,
237        ctx: ctx.clone(),
238    })))
239}
240
241object!(Dict<'a>, Dict);
242
243struct Repr<'a> {
244    data: &'a [u8],
245    offsets: HashMap<Name<'a>, usize>,
246    ctx: ReaderContext<'a>,
247}
248
249pub(crate) struct InlineImageDict<'a>(Dict<'a>);
250
251impl<'a> InlineImageDict<'a> {
252    pub(crate) fn get_dict(&self) -> &Dict<'a> {
253        &self.0
254    }
255}
256
257impl<'a> Readable<'a> for InlineImageDict<'a> {
258    fn read(r: &mut Reader<'a>, ctx: &ReaderContext<'a>) -> Option<Self> {
259        Some(Self(read_inner(r, ctx, None, b"ID")?))
260    }
261}
262
263/// A collection of possible keys in a PDF dictionary. Copied and adapted from `PDFBox`.
264#[allow(missing_docs)]
265pub mod keys {
266    macro_rules! key {
267        ($i:ident, $e:expr) => {
268            pub const $i: &'static [u8] = $e;
269        };
270    }
271
272    // A
273    key!(A, b"A");
274    key!(AA, b"AA");
275    key!(ABSOLUTE_COLORIMETRIC, b"AbsoluteColorimetric");
276    key!(AC, b"AC");
277    key!(ACRO_FORM, b"AcroForm");
278    key!(ACTUAL_TEXT, b"ActualText");
279    key!(ADBE, b"ADBE");
280    key!(ADBE_PKCS7_DETACHED, b"adbe.pkcs7.detached");
281    key!(ADBE_PKCS7_SHA1, b"adbe.pkcs7.sha1");
282    key!(ADBE_X509_RSA_SHA1, b"adbe.x509.rsa_sha1");
283    key!(ADOBE_PPKLITE, b"Adobe.PPKLite");
284    key!(AESV2, b"AESV2");
285    key!(AESV3, b"AESV3");
286    key!(AF, b"AF");
287    key!(AF_RELATIONSHIP, b"AFRelationship");
288    key!(AFTER, b"After");
289    key!(AI_META_DATA, b"AIMetaData");
290    key!(AIS, b"AIS");
291    key!(ALL_OFF, b"AllOff");
292    key!(ALL_ON, b"AllOn");
293    key!(ALT, b"Alt");
294    key!(ALPHA, b"Alpha");
295    key!(ALTERNATE, b"Alternate");
296    key!(ANNOT, b"Annot");
297    key!(ANNOTS, b"Annots");
298    key!(ANTI_ALIAS, b"AntiAlias");
299    key!(ANY_OFF, b"AnyOff");
300    key!(ANY_ON, b"AnyOn");
301    key!(AP, b"AP");
302    key!(AP_REF, b"APRef");
303    key!(APP, b"App");
304    key!(ART_BOX, b"ArtBox");
305    key!(ARTIFACT, b"Artifact");
306    key!(AS, b"AS");
307    key!(ASCENT, b"Ascent");
308    key!(ASCII_HEX_DECODE, b"ASCIIHexDecode");
309    key!(ASCII_HEX_DECODE_ABBREVIATION, b"AHx");
310    key!(ASCII85_DECODE, b"ASCII85Decode");
311    key!(ASCII85_DECODE_ABBREVIATION, b"A85");
312    key!(ATTACHED, b"Attached");
313    key!(AUTHOR, b"Author");
314    key!(AVG_WIDTH, b"AvgWidth");
315
316    // B
317    key!(B, b"B");
318    key!(BACKGROUND, b"Background");
319    key!(BASE_ENCODING, b"BaseEncoding");
320    key!(BASE_FONT, b"BaseFont");
321    key!(BASE_STATE, b"BaseState");
322    key!(BASE_VERSION, b"BaseVersion");
323    key!(BBOX, b"BBox");
324    key!(BC, b"BC");
325    key!(BE, b"BE");
326    key!(BEAD, b"BEAD");
327    key!(BEFORE, b"Before");
328    key!(BG, b"BG");
329    key!(BITS_PER_COMPONENT, b"BitsPerComponent");
330    key!(BITS_PER_COORDINATE, b"BitsPerCoordinate");
331    key!(BITS_PER_FLAG, b"BitsPerFlag");
332    key!(BITS_PER_SAMPLE, b"BitsPerSample");
333    key!(BL, b"Bl");
334    key!(BLACK_IS_1, b"BlackIs1");
335    key!(BLACK_POINT, b"BlackPoint");
336    key!(BLEED_BOX, b"BleedBox");
337    key!(BM, b"BM");
338    key!(BORDER, b"Border");
339    key!(BOUNDS, b"Bounds");
340    key!(BPC, b"BPC");
341    key!(BS, b"BS");
342    key!(BTN, b"Btn");
343    key!(BYTERANGE, b"ByteRange");
344
345    // C
346    key!(C, b"C");
347    key!(C0, b"C0");
348    key!(C1, b"C1");
349    key!(CA, b"CA");
350    key!(CA_NS, b"ca");
351    key!(CALGRAY, b"CalGray");
352    key!(CALRGB, b"CalRGB");
353    key!(CALCMYK, b"CalCMYK");
354    key!(CAP, b"Cap");
355    key!(CAP_HEIGHT, b"CapHeight");
356    key!(CATALOG, b"Catalog");
357    key!(CCITTFAX_DECODE, b"CCITTFaxDecode");
358    key!(CCITTFAX_DECODE_ABBREVIATION, b"CCF");
359    key!(CENTER_WINDOW, b"CenterWindow");
360    key!(CERT, b"Cert");
361    key!(CERTS, b"Certs");
362    key!(CF, b"CF");
363    key!(CFM, b"CFM");
364    key!(CH, b"Ch");
365    key!(CHAR_PROCS, b"CharProcs");
366    key!(CHAR_SET, b"CharSet");
367    key!(CHECK_SUM, b"CheckSum");
368    key!(CI, b"CI");
369    key!(CICI_SIGNIT, b"CICI.SignIt");
370    key!(CID_FONT_TYPE0, b"CIDFontType0");
371    key!(CID_FONT_TYPE0C, b"CIDFontType0C");
372    key!(CID_FONT_TYPE2, b"CIDFontType2");
373    key!(CID_TO_GID_MAP, b"CIDToGIDMap");
374    key!(CID_SET, b"CIDSet");
375    key!(CIDSYSTEMINFO, b"CIDSystemInfo");
376    key!(CL, b"CL");
377    key!(CLASS_MAP, b"ClassMap");
378    key!(CLR_F, b"ClrF");
379    key!(CLR_FF, b"ClrFf");
380    key!(CMAP, b"CMap");
381    key!(CMAPNAME, b"CMapName");
382    key!(CMYK, b"CMYK");
383    key!(CO, b"CO");
384    key!(COLOR, b"Color");
385    key!(COLLECTION, b"Collection");
386    key!(COLLECTION_ITEM, b"CollectionItem");
387    key!(COLLECTION_FIELD, b"CollectionField");
388    key!(COLLECTION_SCHEMA, b"CollectionSchema");
389    key!(COLLECTION_SORT, b"CollectionSort");
390    key!(COLLECTION_SUBITEM, b"CollectionSubitem");
391    key!(COLOR_BURN, b"ColorBurn");
392    key!(COLOR_DODGE, b"ColorDodge");
393    key!(COLORANTS, b"Colorants");
394    key!(COLORS, b"Colors");
395    key!(COLORSPACE, b"ColorSpace");
396    key!(COLOR_TRANSFORM, b"ColorTransform");
397    key!(COLUMNS, b"Columns");
398    key!(COMPATIBLE, b"Compatible");
399    key!(COMPONENTS, b"Components");
400    key!(CONTACT_INFO, b"ContactInfo");
401    key!(CONTENTS, b"Contents");
402    key!(COORDS, b"Coords");
403    key!(COUNT, b"Count");
404    key!(CP, b"CP");
405    key!(CREATION_DATE, b"CreationDate");
406    key!(CREATOR, b"Creator");
407    key!(CRL, b"CRL");
408    key!(CRLS, b"CRLS");
409    key!(CROP_BOX, b"CropBox");
410    key!(CRYPT, b"Crypt");
411    key!(CS, b"CS");
412    key!(CYX, b"CYX");
413
414    // D
415    key!(D, b"D");
416    key!(DA, b"DA");
417    key!(DARKEN, b"Darken");
418    key!(DATE, b"Date");
419    key!(DCT_DECODE, b"DCTDecode");
420    key!(DCT_DECODE_ABBREVIATION, b"DCT");
421    key!(DECODE, b"Decode");
422    key!(DECODE_PARMS, b"DecodeParms");
423    key!(DEFAULT, b"default");
424    key!(DEFAULT_CMYK, b"DefaultCMYK");
425    key!(DEFAULT_CRYPT_FILTER, b"DefaultCryptFilter");
426    key!(DEFAULT_GRAY, b"DefaultGray");
427    key!(DEFAULT_RGB, b"DefaultRGB");
428    key!(DESC, b"Desc");
429    key!(DESCENDANT_FONTS, b"DescendantFonts");
430    key!(DESCENT, b"Descent");
431    key!(DEST, b"Dest");
432    key!(DEST_OUTPUT_PROFILE, b"DestOutputProfile");
433    key!(DESTS, b"Dests");
434    key!(DEVICE_CMYK, b"DeviceCMYK");
435    key!(DEVICE_GRAY, b"DeviceGray");
436    key!(DEVICE_N, b"DeviceN");
437    key!(DEVICE_RGB, b"DeviceRGB");
438    key!(DI, b"Di");
439    key!(DIFFERENCE, b"Difference");
440    key!(DIFFERENCES, b"Differences");
441    key!(DIGEST_METHOD, b"DigestMethod");
442    key!(DIGEST_RIPEMD160, b"RIPEMD160");
443    key!(DIGEST_SHA1, b"SHA1");
444    key!(DIGEST_SHA256, b"SHA256");
445    key!(DIGEST_SHA384, b"SHA384");
446    key!(DIGEST_SHA512, b"SHA512");
447    key!(DIRECTION, b"Direction");
448    key!(DISPLAY_DOC_TITLE, b"DisplayDocTitle");
449    key!(DL, b"DL");
450    key!(DM, b"Dm");
451    key!(DOC, b"Doc");
452    key!(DOC_CHECKSUM, b"DocChecksum");
453    key!(DOC_TIME_STAMP, b"DocTimeStamp");
454    key!(DOCMDP, b"DocMDP");
455    key!(DOCUMENT, b"Document");
456    key!(DOMAIN, b"Domain");
457    key!(DOS, b"DOS");
458    key!(DP, b"DP");
459    key!(DR, b"DR");
460    key!(DS, b"DS");
461    key!(DSS, b"DSS");
462    key!(DUPLEX, b"Duplex");
463    key!(DUR, b"Dur");
464    key!(DV, b"DV");
465    key!(DW, b"DW");
466    key!(DW2, b"DW2");
467
468    // E
469    key!(E, b"E");
470    key!(EARLY_CHANGE, b"EarlyChange");
471    key!(EF, b"EF");
472    key!(EMBEDDED_FDFS, b"EmbeddedFDFs");
473    key!(EMBEDDED_FILE, b"EmbeddedFile");
474    key!(EMBEDDED_FILES, b"EmbeddedFiles");
475    key!(EMPTY, b"");
476    key!(ENCODE, b"Encode");
477    key!(ENCODED_BYTE_ALIGN, b"EncodedByteAlign");
478    key!(ENCODING, b"Encoding");
479    key!(ENCODING_90MS_RKSJ_H, b"90ms-RKSJ-H");
480    key!(ENCODING_90MS_RKSJ_V, b"90ms-RKSJ-V");
481    key!(ENCODING_ETEN_B5_H, b"ETen-B5-H");
482    key!(ENCODING_ETEN_B5_V, b"ETen-B5-V");
483    key!(ENCRYPT, b"Encrypt");
484    key!(ENCRYPT_META_DATA, b"EncryptMetadata");
485    key!(ENCRYPTED_PAYLOAD, b"EncryptedPayload");
486    key!(END_OF_BLOCK, b"EndOfBlock");
487    key!(END_OF_LINE, b"EndOfLine");
488    key!(ENTRUST_PPKEF, b"Entrust.PPKEF");
489    key!(EXCLUSION, b"Exclusion");
490    key!(EXTENSIONS, b"Extensions");
491    key!(EXTENSION_LEVEL, b"ExtensionLevel");
492    key!(EX_DATA, b"ExData");
493    key!(EXPORT, b"Export");
494    key!(EXPORT_STATE, b"ExportState");
495    key!(EXT_G_STATE, b"ExtGState");
496    key!(EXTEND, b"Extend");
497    key!(EXTENDS, b"Extends");
498
499    // F
500    key!(F, b"F");
501    key!(F_DECODE_PARMS, b"FDecodeParms");
502    key!(F_FILTER, b"FFilter");
503    key!(FB, b"FB");
504    key!(FDF, b"FDF");
505    key!(FF, b"Ff");
506    key!(FIELDS, b"Fields");
507    key!(FILESPEC, b"Filespec");
508    key!(FILTER, b"Filter");
509    key!(FIRST, b"First");
510    key!(FIRST_CHAR, b"FirstChar");
511    key!(FIT_WINDOW, b"FitWindow");
512    key!(FL, b"FL");
513    key!(FLAGS, b"Flags");
514    key!(FLATE_DECODE, b"FlateDecode");
515    key!(FLATE_DECODE_ABBREVIATION, b"Fl");
516    key!(FO, b"Fo");
517    key!(FOLDERS, b"Folders");
518    key!(FONT, b"Font");
519    key!(FONT_BBOX, b"FontBBox");
520    key!(FONT_DESC, b"FontDescriptor");
521    key!(FONT_FAMILY, b"FontFamily");
522    key!(FONT_FILE, b"FontFile");
523    key!(FONT_FILE2, b"FontFile2");
524    key!(FONT_FILE3, b"FontFile3");
525    key!(FONT_MATRIX, b"FontMatrix");
526    key!(FONT_NAME, b"FontName");
527    key!(FONT_STRETCH, b"FontStretch");
528    key!(FONT_WEIGHT, b"FontWeight");
529    key!(FORM, b"Form");
530    key!(FORMTYPE, b"FormType");
531    key!(FRM, b"FRM");
532    key!(FS, b"FS");
533    key!(FT, b"FT");
534    key!(FUNCTION, b"Function");
535    key!(FUNCTION_TYPE, b"FunctionType");
536    key!(FUNCTIONS, b"Functions");
537
538    // G
539    key!(G, b"G");
540    key!(GAMMA, b"Gamma");
541    key!(GROUP, b"Group");
542    key!(GTS_PDFA1, b"GTS_PDFA1");
543
544    // H
545    key!(H, b"H");
546    key!(HARD_LIGHT, b"HardLight");
547    key!(HEIGHT, b"Height");
548    key!(HELV, b"Helv");
549    key!(HIDE_MENUBAR, b"HideMenubar");
550    key!(HIDE_TOOLBAR, b"HideToolbar");
551    key!(HIDE_WINDOWUI, b"HideWindowUI");
552    key!(HUE, b"Hue");
553
554    // I
555    key!(I, b"I");
556    key!(IC, b"IC");
557    key!(ICC_BASED, b"ICCBased");
558    key!(ID, b"ID");
559    key!(ID_TREE, b"IDTree");
560    key!(IDENTITY, b"Identity");
561    key!(IDENTITY_H, b"Identity-H");
562    key!(IDENTITY_V, b"Identity-V");
563    key!(IF, b"IF");
564    key!(ILLUSTRATOR, b"Illustrator");
565    key!(IM, b"IM");
566    key!(IMAGE, b"Image");
567    key!(IMAGE_MASK, b"ImageMask");
568    key!(INDEX, b"Index");
569    key!(INDEXED, b"Indexed");
570    key!(INFO, b"Info");
571    key!(INKLIST, b"InkList");
572    key!(INTENT, b"Intent");
573    key!(INTERPOLATE, b"Interpolate");
574    key!(IRT, b"IRT");
575    key!(IT, b"IT");
576    key!(ITALIC_ANGLE, b"ItalicAngle");
577    key!(ISSUER, b"Issuer");
578    key!(IX, b"IX");
579
580    // J
581    key!(JAVA_SCRIPT, b"JavaScript");
582    key!(JBIG2_DECODE, b"JBIG2Decode");
583    key!(JBIG2_GLOBALS, b"JBIG2Globals");
584    key!(JPX_DECODE, b"JPXDecode");
585    key!(JS, b"JS");
586
587    // K
588    key!(K, b"K");
589    key!(KEYWORDS, b"Keywords");
590    key!(KEY_USAGE, b"KeyUsage");
591    key!(KIDS, b"Kids");
592
593    // L
594    key!(L, b"L");
595    key!(LAB, b"Lab");
596    key!(LANG, b"Lang");
597    key!(LAST, b"Last");
598    key!(LAST_CHAR, b"LastChar");
599    key!(LAST_MODIFIED, b"LastModified");
600    key!(LC, b"LC");
601    key!(LE, b"LE");
602    key!(LEADING, b"Leading");
603    key!(LEGAL_ATTESTATION, b"LegalAttestation");
604    key!(LENGTH, b"Length");
605    key!(LENGTH1, b"Length1");
606    key!(LENGTH2, b"Length2");
607    key!(LENGTH3, b"Length3");
608    key!(LIGHTEN, b"Lighten");
609    key!(LIMITS, b"Limits");
610    key!(LINEARIZED, b"Linearized");
611    key!(LJ, b"LJ");
612    key!(LL, b"LL");
613    key!(LLE, b"LLE");
614    key!(LLO, b"LLO");
615    key!(LOCATION, b"Location");
616    key!(LUMINOSITY, b"Luminosity");
617    key!(LW, b"LW");
618    key!(LZW_DECODE, b"LZWDecode");
619    key!(LZW_DECODE_ABBREVIATION, b"LZW");
620
621    // M
622    key!(M, b"M");
623    key!(MAC, b"Mac");
624    key!(MAC_EXPERT_ENCODING, b"MacExpertEncoding");
625    key!(MAC_ROMAN_ENCODING, b"MacRomanEncoding");
626    key!(MARK_INFO, b"MarkInfo");
627    key!(MASK, b"Mask");
628    key!(MATRIX, b"Matrix");
629    key!(MATTE, b"Matte");
630    key!(MAX_LEN, b"MaxLen");
631    key!(MAX_WIDTH, b"MaxWidth");
632    key!(MCID, b"MCID");
633    key!(MDP, b"MDP");
634    key!(MEDIA_BOX, b"MediaBox");
635    key!(MEASURE, b"Measure");
636    key!(METADATA, b"Metadata");
637    key!(MISSING_WIDTH, b"MissingWidth");
638    key!(MIX, b"Mix");
639    key!(MK, b"MK");
640    key!(ML, b"ML");
641    key!(MM_TYPE1, b"MMType1");
642    key!(MOD_DATE, b"ModDate");
643    key!(MULTIPLY, b"Multiply");
644
645    // N
646    key!(N, b"N");
647    key!(NAME, b"Name");
648    key!(NAMES, b"Names");
649    key!(NAVIGATOR, b"Navigator");
650    key!(NEED_APPEARANCES, b"NeedAppearances");
651    key!(NEW_WINDOW, b"NewWindow");
652    key!(NEXT, b"Next");
653    key!(NM, b"NM");
654    key!(NON_EFONT_NO_WARN, b"NonEFontNoWarn");
655    key!(NON_FULL_SCREEN_PAGE_MODE, b"NonFullScreenPageMode");
656    key!(NONE, b"None");
657    key!(NORMAL, b"Normal");
658    key!(NUMS, b"Nums");
659
660    // O
661    key!(O, b"O");
662    key!(OBJ, b"Obj");
663    key!(OBJR, b"OBJR");
664    key!(OBJ_STM, b"ObjStm");
665    key!(OC, b"OC");
666    key!(OCG, b"OCG");
667    key!(OCGS, b"OCGs");
668    key!(OCMD, b"OCMD");
669    key!(OCPROPERTIES, b"OCProperties");
670    key!(OCSP, b"OCSP");
671    key!(OCSPS, b"OCSPs");
672    key!(OE, b"OE");
673    key!(OID, b"OID");
674    key!(OFF, b"OFF");
675    key!(ON, b"ON");
676    key!(OP, b"OP");
677    key!(OP_NS, b"op");
678    key!(OPEN_ACTION, b"OpenAction");
679    key!(OPEN_TYPE, b"OpenType");
680    key!(OPI, b"OPI");
681    key!(OPM, b"OPM");
682    key!(OPT, b"Opt");
683    key!(ORDER, b"Order");
684    key!(ORDERING, b"Ordering");
685    key!(OS, b"OS");
686    key!(OUTLINES, b"Outlines");
687    key!(OUTPUT_CONDITION, b"OutputCondition");
688    key!(OUTPUT_CONDITION_IDENTIFIER, b"OutputConditionIdentifier");
689    key!(OUTPUT_INTENT, b"OutputIntent");
690    key!(OUTPUT_INTENTS, b"OutputIntents");
691    key!(OVERLAY, b"Overlay");
692
693    // P
694    key!(P, b"P");
695    key!(PA, b"PA");
696    key!(PAGE, b"Page");
697    key!(PAGE_LABELS, b"PageLabels");
698    key!(PAGE_LAYOUT, b"PageLayout");
699    key!(PAGE_MODE, b"PageMode");
700    key!(PAGES, b"Pages");
701    key!(PAINT_TYPE, b"PaintType");
702    key!(PANOSE, b"Panose");
703    key!(PARAMS, b"Params");
704    key!(PARENT, b"Parent");
705    key!(PARENT_TREE, b"ParentTree");
706    key!(PARENT_TREE_NEXT_KEY, b"ParentTreeNextKey");
707    key!(PART, b"Part");
708    key!(PATH, b"Path");
709    key!(PATTERN, b"Pattern");
710    key!(PATTERN_TYPE, b"PatternType");
711    key!(PC, b"PC");
712    key!(PDF_DOC_ENCODING, b"PDFDocEncoding");
713    key!(PERMS, b"Perms");
714    key!(PERCEPTUAL, b"Perceptual");
715    key!(PIECE_INFO, b"PieceInfo");
716    key!(PG, b"Pg");
717    key!(PI, b"PI");
718    key!(PO, b"PO");
719    key!(POPUP, b"Popup");
720    key!(PRE_RELEASE, b"PreRelease");
721    key!(PREDICTOR, b"Predictor");
722    key!(PREV, b"Prev");
723    key!(PRINT, b"Print");
724    key!(PRINT_AREA, b"PrintArea");
725    key!(PRINT_CLIP, b"PrintClip");
726    key!(PRINT_SCALING, b"PrintScaling");
727    key!(PRINT_STATE, b"PrintState");
728    key!(PRIVATE, b"Private");
729    key!(PROC_SET, b"ProcSet");
730    key!(PROCESS, b"Process");
731    key!(PRODUCER, b"Producer");
732    key!(PROP_BUILD, b"Prop_Build");
733    key!(PROPERTIES, b"Properties");
734    key!(PS, b"PS");
735    key!(PT_DATA, b"PtData");
736    key!(PUB_SEC, b"PubSec");
737    key!(PV, b"PV");
738
739    // Q
740    key!(Q, b"Q");
741    key!(QUADPOINTS, b"QuadPoints");
742
743    // R
744    key!(R, b"R");
745    key!(RANGE, b"Range");
746    key!(RC, b"RC");
747    key!(RD, b"RD");
748    key!(REASON, b"Reason");
749    key!(REASONS, b"Reasons");
750    key!(RECIPIENTS, b"Recipients");
751    key!(RECT, b"Rect");
752    key!(REF, b"Ref");
753    key!(REFERENCE, b"Reference");
754    key!(REGISTRY, b"Registry");
755    key!(REGISTRY_NAME, b"RegistryName");
756    key!(RELATIVE_COLORIMETRIC, b"RelativeColorimetric");
757    key!(RENAME, b"Rename");
758    key!(REPEAT, b"Repeat");
759    key!(RES_FORK, b"ResFork");
760    key!(RESOURCES, b"Resources");
761    key!(RGB, b"RGB");
762    key!(RI, b"RI");
763    key!(ROLE_MAP, b"RoleMap");
764    key!(ROOT, b"Root");
765    key!(ROTATE, b"Rotate");
766    key!(ROWS, b"Rows");
767    key!(RT, b"RT");
768    key!(RUN_LENGTH_DECODE, b"RunLengthDecode");
769    key!(RUN_LENGTH_DECODE_ABBREVIATION, b"RL");
770    key!(RV, b"RV");
771
772    // S
773    key!(S, b"S");
774    key!(SA, b"SA");
775    key!(SATURATION, b"Saturation");
776    key!(SCHEMA, b"Schema");
777    key!(SCREEN, b"Screen");
778    key!(SE, b"SE");
779    key!(SEPARATION, b"Separation");
780    key!(SET_F, b"SetF");
781    key!(SET_FF, b"SetFf");
782    key!(SHADING, b"Shading");
783    key!(SHADING_TYPE, b"ShadingType");
784    key!(SIG, b"Sig");
785    key!(SIG_FLAGS, b"SigFlags");
786    key!(SIG_REF, b"SigRef");
787    key!(SIZE, b"Size");
788    key!(SM, b"SM");
789    key!(SMASK, b"SMask");
790    key!(SMASK_IN_DATA, b"SMaskInData");
791    key!(SOFT_LIGHT, b"SoftLight");
792    key!(SORT, b"Sort");
793    key!(SOUND, b"Sound");
794    key!(SPLIT, b"Split");
795    key!(SS, b"SS");
796    key!(ST, b"St");
797    key!(STANDARD_ENCODING, b"StandardEncoding");
798    key!(STATE, b"State");
799    key!(STATE_MODEL, b"StateModel");
800    key!(STATUS, b"Status");
801    key!(STD_CF, b"StdCF");
802    key!(STEM_H, b"StemH");
803    key!(STEM_V, b"StemV");
804    key!(STM_F, b"StmF");
805    key!(STR_F, b"StrF");
806    key!(STRUCT_ELEM, b"StructElem");
807    key!(STRUCT_PARENT, b"StructParent");
808    key!(STRUCT_PARENTS, b"StructParents");
809    key!(STRUCT_TREE_ROOT, b"StructTreeRoot");
810    key!(STYLE, b"Style");
811    key!(SUB_FILTER, b"SubFilter");
812    key!(SUBJ, b"Subj");
813    key!(SUBJECT, b"Subject");
814    key!(SUBJECT_DN, b"SubjectDN");
815    key!(SUBTYPE, b"Subtype");
816    key!(SUPPLEMENT, b"Supplement");
817    key!(SV, b"SV");
818    key!(SV_CERT, b"SVCert");
819    key!(SW, b"SW");
820    key!(SY, b"Sy");
821    key!(SYNCHRONOUS, b"Synchronous");
822    key!(T, b"T");
823    key!(TARGET, b"Target");
824    key!(TEMPLATES, b"Templates");
825    key!(THREAD, b"Thread");
826    key!(THREADS, b"Threads");
827    key!(THREE_DD, b"3DD");
828    key!(THUMB, b"Thumb");
829    key!(TI, b"TI");
830    key!(TILING_TYPE, b"TilingType");
831    key!(TIME_STAMP, b"TimeStamp");
832    key!(TITLE, b"Title");
833    key!(TK, b"TK");
834    key!(TM, b"TM");
835    key!(TO_UNICODE, b"ToUnicode");
836    key!(TR, b"TR");
837    key!(TR2, b"TR2");
838    key!(TRAPPED, b"Trapped");
839    key!(TRANS, b"Trans");
840    key!(TRANSFORM_METHOD, b"TransformMethod");
841    key!(TRANSFORM_PARAMS, b"TransformParams");
842    key!(TRANSPARENCY, b"Transparency");
843    key!(TREF, b"TRef");
844    key!(TRIM_BOX, b"TrimBox");
845    key!(TRUE_TYPE, b"TrueType");
846    key!(TRUSTED_MODE, b"TrustedMode");
847    key!(TU, b"TU");
848    key!(TX, b"Tx");
849    key!(TYPE, b"Type");
850    key!(TYPE0, b"Type0");
851    key!(TYPE1, b"Type1");
852    key!(TYPE3, b"Type3");
853
854    // U
855    key!(U, b"U");
856    key!(UE, b"UE");
857    key!(UF, b"UF");
858    key!(UNCHANGED, b"Unchanged");
859    key!(UNIX, b"Unix");
860    key!(URI, b"URI");
861    key!(URL, b"URL");
862    key!(URL_TYPE, b"URLType");
863    key!(USAGE, b"Usage");
864    key!(USE_CMAP, b"UseCMap");
865    key!(USER_UNIT, b"UserUnit");
866
867    // V
868    key!(V, b"V");
869    key!(VE, b"VE");
870    key!(VERISIGN_PPKVS, b"VeriSign.PPKVS");
871    key!(VERSION, b"Version");
872    key!(VERTICES, b"Vertices");
873    key!(VERTICES_PER_ROW, b"VerticesPerRow");
874    key!(VIEW, b"View");
875    key!(VIEW_AREA, b"ViewArea");
876    key!(VIEW_CLIP, b"ViewClip");
877    key!(VIEW_STATE, b"ViewState");
878    key!(VIEWER_PREFERENCES, b"ViewerPreferences");
879    key!(VOLUME, b"Volume");
880    key!(VP, b"VP");
881    key!(VRI, b"VRI");
882
883    // W
884    key!(W, b"W");
885    key!(W2, b"W2");
886    key!(WC, b"WC");
887    key!(WHITE_POINT, b"WhitePoint");
888    key!(WIDGET, b"Widget");
889    key!(WIDTH, b"Width");
890    key!(WIDTHS, b"Widths");
891    key!(WIN, b"Win");
892    key!(WIN_ANSI_ENCODING, b"WinAnsiEncoding");
893    key!(WMODE, b"WMode");
894    key!(WP, b"WP");
895    key!(WS, b"WS");
896
897    // X
898    key!(X, b"X");
899    key!(XFA, b"XFA");
900    key!(X_STEP, b"XStep");
901    key!(XHEIGHT, b"XHeight");
902    key!(XOBJECT, b"XObject");
903    key!(XREF, b"XRef");
904    key!(XREF_STM, b"XRefStm");
905
906    // Y
907    key!(Y, b"Y");
908    key!(Y_STEP, b"YStep");
909    key!(YES, b"Yes");
910
911    // Z
912    key!(ZA_DB, b"ZaDb");
913}
914
915#[cfg(test)]
916mod tests {
917    use crate::object::Number;
918    use crate::object::dict::keys::{COLORSPACE, EXT_G_STATE, FONT, PROC_SET};
919    use crate::object::dict::{Dict, InlineImageDict};
920    use crate::object::string;
921    use crate::object::{Name, ObjRef};
922    use crate::reader::Reader;
923    use crate::reader::{ReaderContext, ReaderExt};
924
925    fn dict_impl(data: &[u8]) -> Option<Dict<'_>> {
926        Reader::new(data).read_with_context::<Dict<'_>>(&ReaderContext::dummy())
927    }
928
929    #[test]
930    fn empty_dict_1() {
931        let dict_data = b"<<>>";
932        let dict = dict_impl(dict_data).unwrap();
933
934        assert_eq!(dict.len(), 0);
935    }
936
937    #[test]
938    fn empty_dict_2() {
939        let dict_data = b"<<   \n >>";
940        let dict = dict_impl(dict_data).unwrap();
941
942        assert_eq!(dict.len(), 0);
943    }
944
945    #[test]
946    fn dict_1() {
947        let dict_data = b"<<  /Hi 34.0 >>";
948        let dict = dict_impl(dict_data).unwrap();
949
950        assert_eq!(dict.len(), 1);
951        assert!(dict.get::<Number>(Name::new(b"Hi")).is_some());
952    }
953
954    #[test]
955    fn dict_2() {
956        let dict_data = b"<<  /Hi \n 34.0 /Second true >>";
957        let dict = dict_impl(dict_data).unwrap();
958
959        assert_eq!(dict.len(), 2);
960        assert!(dict.get::<Number>(Name::new(b"Hi")).is_some());
961        assert!(dict.get::<bool>(Name::new(b"Second")).is_some());
962    }
963
964    #[test]
965    fn dict_complex() {
966        let data = "<< /Type /Example
967/Subtype /DictionaryExample
968/Version 0.01
969/IntegerItem 12
970/StringItem ( a string )
971/Subdictionary << /Item1 0.4
972                /Item2 true
973                /LastItem ( not ! )
974                /VeryLastItem ( OK )
975                >>
976>>";
977
978        let dict = Reader::new(data.as_bytes())
979            .read_with_context::<Dict<'_>>(&ReaderContext::dummy())
980            .unwrap();
981        assert_eq!(dict.len(), 6);
982        assert!(dict.get::<Name<'_>>(Name::new(b"Type")).is_some());
983        assert!(dict.get::<Name<'_>>(Name::new(b"Subtype")).is_some());
984        assert!(dict.get::<Number>(Name::new(b"Version")).is_some());
985        assert!(dict.get::<i32>(Name::new(b"IntegerItem")).is_some());
986        assert!(
987            dict.get::<string::String<'_>>(Name::new(b"StringItem"))
988                .is_some()
989        );
990        assert!(dict.get::<Dict<'_>>(Name::new(b"Subdictionary")).is_some());
991    }
992
993    #[test]
994    fn dict_with_trailing() {
995        let dict_data = b"<<  /Hi 67.0  >>trailing data";
996        let dict = dict_impl(dict_data).unwrap();
997
998        assert_eq!(dict.len(), 1);
999    }
1000
1001    #[test]
1002    fn dict_with_comment() {
1003        let dict_data = b"<<  /Hi % A comment \n 67.0 % Another comment \n >>";
1004        let dict = dict_impl(dict_data).unwrap();
1005
1006        assert_eq!(dict.len(), 1);
1007    }
1008
1009    #[test]
1010    fn inline_dict() {
1011        let dict_data = b"/W 17 /H 17 /CS /RGB /BPC 8 /F [ /A85 /LZW ] ID ";
1012
1013        let dict = Reader::new(&dict_data[..])
1014            .read_with_context::<InlineImageDict<'_>>(&ReaderContext::dummy())
1015            .unwrap();
1016
1017        assert_eq!(dict.get_dict().len(), 5);
1018    }
1019
1020    #[test]
1021    fn dict_with_escaped_name() {
1022        let dict_data = b"<< /PANTONE#20104#20C 234 >>";
1023        let dict = dict_impl(dict_data).unwrap();
1024
1025        assert!(dict.contains_key(b"PANTONE 104 C".as_ref()));
1026    }
1027
1028    #[test]
1029    fn garbage_in_between() {
1030        let dict_data = b"<< 
1031/ProcSet [ /PDF /Text ] 
1032/Font << /F4 31 0 R /F6 23 0 R >> 
1033/ExtGState << /GS2 14 0 R
10342000
1035 /GS3 15 0 R >> 
1036/ColorSpace << /Cs5 13 0 R >> 
1037>> ";
1038        let dict = dict_impl(dict_data).unwrap();
1039
1040        assert!(dict.contains_key(PROC_SET));
1041        assert!(dict.contains_key(FONT));
1042        assert!(dict.contains_key(EXT_G_STATE));
1043        assert!(dict.contains_key(COLORSPACE));
1044
1045        let Some(dict) = dict.get::<Dict<'_>>(EXT_G_STATE) else {
1046            panic!("failed to parse ext g state");
1047        };
1048
1049        assert_eq!(dict.get_ref("GS2".as_ref()), Some(ObjRef::new(14, 0)));
1050        assert_eq!(dict.get_ref("GS3".as_ref()), Some(ObjRef::new(15, 0)));
1051    }
1052}
hayro_syntax/object/dict.rs

hayro_syntax/object/
dict.rs
