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

pdf_syntax/object/
dict.rs
