Keys added in PDF 2 for structure tree dicts

Author: reknih

src/structure.rs

@@ -392,6 +392,22 @@ impl StructTreeRoot<'_> {
     pub fn namespaces(&mut self) -> TypedArray<'_, Ref> {
         self.dict.insert(Name(b"Namespaces")).array().typed()
     }
+
+    /// Start writing the `PronunciationLexicon` attribute to specify one or
+    /// multiple pronunciation lexicons for the document. PDF 2.0+.
+    ///
+    /// The lexicons shall be XML files conforming to the Pronunciation Lexicon
+    /// Specification (PLS) Version 1.0. Each entry in the array is an indirect
+    /// reference to a [`FileSpec`] dictionary for a lexicon file.
+    pub fn pronunciation_lexicon(&mut self) -> TypedArray<'_, Ref> {
+        self.dict.insert(Name(b"PronunciationLexicon")).array().typed()
+    }
+
+    /// Start writing the `/AF` attribute to specify one or multiple files
+    /// associated with the entire structure tree. PDF 2.0+.
+    pub fn associated_files(&mut self) -> TypedArray<'_, FileSpec> {
+        self.dict.insert(Name(b"AF")).array().typed()
+    }
 }
 
 deref!('a, StructTreeRoot<'a> => Dict<'a>, dict);
@@ -443,6 +459,16 @@ impl StructElement<'_> {
         self
     }
 
+    /// Write the `/Ref` attribute to specify to which structure element this
+    /// element refers. Used e.g. for footnotes. PDF 2.0+
+    ///
+    /// The parameter `refs` shall be indirect object references to other
+    /// structure elements.
+    pub fn refs(&mut self, refs: impl IntoIterator<Item = Ref>) -> &mut Self {
+        self.dict.insert(Name(b"Ref")).array().typed().items(refs);
+        self
+    }
+
     /// Write the `/Pg` attribute to specify the page some or all of this
     /// structure element is located on.
     pub fn page(&mut self, page: Ref) -> &mut Self {
@@ -538,6 +564,20 @@ impl StructElement<'_> {
         self.dict.pair(Name(b"NS"), ns);
         self
     }
+
+    /// Write the `/PhoneticAlphabet` attribute to specify the phonetic alphabet
+    /// used in the [StructElement::phoneme] attribute. PDF 2.0+
+    pub fn phonetic_alphabet(&mut self, alphabet: PhoneticAlphabet) -> &mut Self {
+        self.dict.pair(Name(b"PhoneticAlphabet"), alphabet.to_name());
+        self
+    }
+
+    /// Write the `/Phoneme` attribute to specify the phonetic pronunciation of
+    /// the text in the structure element. PDF 2.0+
+    pub fn phoneme(&mut self, phoneme: TextStr) -> &mut Self {
+        self.dict.pair(Name(b"Phoneme"), phoneme);
+        self
+    }
 }
 
 deref!('a, StructElement<'a> => Dict<'a>, dict);
@@ -859,6 +899,34 @@ impl StructRole {
         }
     }
 
+/// Which phonetic alphabet to use for the `/Phonetic` key in the
+/// [`StructElement`] dictionary.
+#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
+pub enum PhoneticAlphabet<'a> {
+    /// The International Phonetic Alphabet.
+    Ipa,
+    /// The Extended Speech Assessment Methods Phonetic Alphabet (X-SAMPA).
+    XSampa,
+    /// The Pinyin romanization system for Chinese.
+    Pinyin,
+    /// The Wade-Giles romanization system for Chinese.
+    WadeGiles,
+    /// A custom phonetic alphabet.
+    Custom(Name<'a>),
+}
+
+impl<'a> PhoneticAlphabet<'a> {
+    pub(crate) fn to_name(self) -> Name<'a> {
+        match self {
+            Self::Ipa => Name(b"ipa"),
+            Self::XSampa => Name(b"x-sampa"),
+            Self::Pinyin => Name(b"zh-Latn-pinyin"),
+            Self::WadeGiles => Name(b"zh-Latn-wadegile"),
+            Self::Custom(name) => name,
+        }
+    }
+}
+
 /// Writer for a _namespace dictionary_. PDF 2.0+
 ///
 /// This struct is created by [`Chunk::namespace`].