hayro_syntax/object/
dict.rs

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

hayro_syntax/object/
dict.rs
