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

pdf_syntax/object/
dict.rs
