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

hayro_syntax/object/
dict.rs
