dxpdf 0.2.1

A fast DOCX-to-PDF converter powered by Skia
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

//! Parser for footnotes.xml and endnotes.xml.

use std::collections::HashMap;

use log::warn;
use quick_xml::events::Event;
use quick_xml::Reader;

use crate::docx::error::Result;
use crate::docx::model::{Block, NoteId};
use crate::docx::xml;

use super::body;

/// Parse footnotes.xml or endnotes.xml into a map of note ID → blocks.
/// `note_tag` is "footnote" or "endnote"; root element is "footnotes" or "endnotes".
pub fn parse_notes(data: &[u8], note_tag: &str) -> Result<HashMap<NoteId, Vec<Block>>> {
    let mut reader = Reader::from_reader(data);
    // Do NOT trim text — whitespace in <w:t> runs is significant.
    let mut buf = Vec::new();
    let mut notes = HashMap::new();

    let note_tag_bytes = note_tag.as_bytes();
    let root_tag = format!("{note_tag}s");
    let root_tag_bytes = root_tag.as_bytes();

    // Find root element (<w:footnotes> or <w:endnotes>).
    loop {
        match xml::next_event(&mut reader, &mut buf)? {
            Event::Start(ref e) if xml::local_name(e.name().as_ref()) == root_tag_bytes => break,
            Event::Eof => return Ok(notes),
            _ => {}
        }
    }

    // Parse scoped to root.
    loop {
        match xml::next_event(&mut reader, &mut buf)? {
            Event::Start(ref e) if xml::local_name(e.name().as_ref()) == note_tag_bytes => {
                let id = xml::optional_attr(e, b"id")?.and_then(|s| s.parse::<i64>().ok());

                if let Some(note_id) = id {
                    let blocks = parse_note_content(&mut reader, &mut buf, note_tag_bytes)?;
                    notes.insert(NoteId::new(note_id), blocks);
                } else {
                    xml::skip_to_end(&mut reader, &mut buf, note_tag_bytes)?;
                }
            }
            Event::End(ref e) if xml::local_name(e.name().as_ref()) == root_tag_bytes => break,
            Event::Eof => return Err(xml::unexpected_eof(root_tag_bytes)),
            _ => {}
        }
    }

    Ok(notes)
}

fn parse_note_content(
    reader: &mut Reader<&[u8]>,
    buf: &mut Vec<u8>,
    end_tag: &[u8],
) -> Result<Vec<Block>> {
    let mut blocks = Vec::new();

    loop {
        match xml::next_event(reader, buf)? {
            Event::Start(ref e) => {
                let qn = e.name();
                let local = xml::local_name(qn.as_ref());
                match local {
                    b"p" => {
                        let (para, sect) = body::parse_paragraph_public(e, reader, buf)?;
                        blocks.push(Block::Paragraph(Box::new(para)));
                        if let Some(sp) = sect {
                            blocks.push(Block::SectionBreak(Box::new(sp)));
                        }
                    }
                    b"tbl" => {
                        let table = body::parse_table_public(reader, buf)?;
                        blocks.push(Block::Table(Box::new(table)));
                    }
                    _ => {
                        warn!(
                            "note: unsupported block element <{}>",
                            String::from_utf8_lossy(local)
                        );
                    }
                }
            }
            Event::End(ref e) if xml::local_name(e.name().as_ref()) == end_tag => break,
            Event::Eof => return Err(xml::unexpected_eof(b"container")),
            _ => {}
        }
    }

    Ok(blocks)
}