hwp2md 0.5.0

HWP/HWPX ↔ Markdown bidirectional converter
Documentation 
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303

use super::*;
use crate::ir;

fn section(xml: &str) -> ir::Section {
    parse_section_xml(xml).expect("parse_section_xml must not fail")
}

// -----------------------------------------------------------------------
// B-4: header/footer parsing from <hp:headerFooter>
// -----------------------------------------------------------------------

#[test]
fn header_footer_parsed() {
    let xml = r"<root>
        <hp:p><hp:run><hp:t>body text</hp:t></hp:run></hp:p>
        <hp:headerFooter>
            <hp:header>
                <hp:p><hp:run><hp:t>Header text</hp:t></hp:run></hp:p>
            </hp:header>
            <hp:footer>
                <hp:p><hp:run><hp:t>Footer text</hp:t></hp:run></hp:p>
            </hp:footer>
        </hp:headerFooter>
    </root>";
    let s = section(xml);

    // Main body block still present.
    assert_eq!(s.blocks.len(), 1, "main body must have one paragraph");

    // Header is parsed.
    let header = s.header.as_ref().expect("section.header must be Some");
    assert_eq!(header.len(), 1, "header must have one block");
    match &header[0] {
        ir::Block::Paragraph { inlines } => {
            let text: String = inlines.iter().map(|i| i.text.as_str()).collect();
            assert_eq!(text, "Header text");
        }
        other => panic!("expected Paragraph in header, got {other:?}"),
    }

    // Footer is parsed.
    let footer = s.footer.as_ref().expect("section.footer must be Some");
    assert_eq!(footer.len(), 1, "footer must have one block");
    match &footer[0] {
        ir::Block::Paragraph { inlines } => {
            let text: String = inlines.iter().map(|i| i.text.as_str()).collect();
            assert_eq!(text, "Footer text");
        }
        other => panic!("expected Paragraph in footer, got {other:?}"),
    }
}

#[test]
fn header_only_no_footer() {
    let xml = r"<root>
        <hp:headerFooter>
            <hp:header>
                <hp:p><hp:run><hp:t>Only header</hp:t></hp:run></hp:p>
            </hp:header>
        </hp:headerFooter>
    </root>";
    let s = section(xml);

    let header = s.header.as_ref().expect("section.header must be Some");
    assert_eq!(header.len(), 1);
    match &header[0] {
        ir::Block::Paragraph { inlines } => {
            let text: String = inlines.iter().map(|i| i.text.as_str()).collect();
            assert_eq!(text, "Only header");
        }
        other => panic!("expected Paragraph, got {other:?}"),
    }

    assert!(
        s.footer.is_none(),
        "section.footer must be None when no footer element is present"
    );
}

#[test]
fn no_header_footer_remains_none() {
    // A section without <hp:headerFooter> must leave header/footer as None.
    let xml = r"<root>
        <hp:p><hp:run><hp:t>plain body</hp:t></hp:run></hp:p>
    </root>";
    let s = section(xml);

    assert!(
        s.header.is_none(),
        "header must be None when no headerFooter element present"
    );
    assert!(
        s.footer.is_none(),
        "footer must be None when no headerFooter element present"
    );
}

#[test]
fn footer_only_no_header() {
    let xml = r"<root>
        <hp:headerFooter>
            <hp:footer>
                <hp:p><hp:run><hp:t>Only footer</hp:t></hp:run></hp:p>
            </hp:footer>
        </hp:headerFooter>
    </root>";
    let s = section(xml);

    assert!(
        s.header.is_none(),
        "section.header must be None when only footer present"
    );

    let footer = s.footer.as_ref().expect("section.footer must be Some");
    assert_eq!(footer.len(), 1);
    match &footer[0] {
        ir::Block::Paragraph { inlines } => {
            let text: String = inlines.iter().map(|i| i.text.as_str()).collect();
            assert_eq!(text, "Only footer");
        }
        other => panic!("expected Paragraph in footer, got {other:?}"),
    }
}

#[test]
fn header_footer_body_text_not_mixed_into_header() {
    // Body paragraphs that appear outside <hp:headerFooter> must NOT end up
    // in section.header / section.footer.
    let xml = r"<root>
        <hp:p><hp:run><hp:t>body para 1</hp:t></hp:run></hp:p>
        <hp:headerFooter>
            <hp:header>
                <hp:p><hp:run><hp:t>hdr</hp:t></hp:run></hp:p>
            </hp:header>
        </hp:headerFooter>
        <hp:p><hp:run><hp:t>body para 2</hp:t></hp:run></hp:p>
    </root>";
    let s = section(xml);

    // Two body blocks.
    assert_eq!(s.blocks.len(), 2, "two body paragraphs expected");

    // Header has exactly one block.
    let header = s.header.as_ref().expect("header must be Some");
    assert_eq!(header.len(), 1, "header must have exactly one block");
    match &header[0] {
        ir::Block::Paragraph { inlines } => {
            let text: String = inlines.iter().map(|i| i.text.as_str()).collect();
            assert_eq!(text, "hdr");
        }
        other => panic!("unexpected header block: {other:?}"),
    }
}

#[test]
fn header_footer_without_hp_prefix_also_parsed() {
    // The parser must accept bare element names (no namespace prefix).
    let xml = r"<root>
        <headerFooter>
            <header>
                <p><run><t>bare header</t></run></p>
            </header>
        </headerFooter>
    </root>";
    let s = section(xml);

    let header = s
        .header
        .as_ref()
        .expect("header must be Some even without hp: prefix");
    assert!(!header.is_empty(), "header blocks must not be empty");
    match &header[0] {
        ir::Block::Paragraph { inlines } => {
            let text: String = inlines.iter().map(|i| i.text.as_str()).collect();
            assert_eq!(text, "bare header");
        }
        other => panic!("expected Paragraph in header (bare prefix), got {other:?}"),
    }
}

#[test]
fn image_in_header_stays_in_header() {
    let xml = r#"<root>
        <hp:p><hp:run><hp:t>body</hp:t></hp:run></hp:p>
        <hp:headerFooter>
            <hp:header>
                <hp:p><hp:run><hp:t>hdr text</hp:t></hp:run></hp:p>
                <hp:p>
                    <hp:run>
                        <hp:img binaryItemIDRef="logo.png" width="100" height="50"/>
                    </hp:run>
                </hp:p>
            </hp:header>
        </hp:headerFooter>
    </root>"#;
    let s = section(xml);

    assert_eq!(s.blocks.len(), 1, "body must have only one paragraph");
    let header = s.header.as_ref().expect("header must be Some");
    assert!(
        header.len() >= 2,
        "header must have at least 2 blocks (text + image), got {}",
        header.len()
    );
    let has_image = header.iter().any(|b| matches!(b, ir::Block::Image { .. }));
    assert!(
        has_image,
        "image block must stay in header, not leak to body"
    );
}

#[test]
fn page_break_in_footer_stays_in_footer() {
    let xml = r#"<root>
        <hp:headerFooter>
            <hp:footer>
                <hp:p><hp:run><hp:t>ftr text</hp:t></hp:run></hp:p>
                <hp:p><hp:run><hp:ctrl id="newPage"/></hp:run></hp:p>
            </hp:footer>
        </hp:headerFooter>
    </root>"#;
    let s = section(xml);

    assert!(s.blocks.is_empty(), "body must be empty");
    let footer = s.footer.as_ref().expect("footer must be Some");
    let has_pb = footer.iter().any(|b| matches!(b, ir::Block::PageBreak));
    assert!(has_pb, "page break must stay in footer, not leak to body");
}

#[test]
fn header_footer_type_both_parsed() {
    // Test that type="both" attribute is parsed correctly.
    let xml = r#"<root>
        <hp:headerFooter type="both">
            <hp:header>
                <hp:p><hp:run><hp:t>Header</hp:t></hp:run></hp:p>
            </hp:header>
        </hp:headerFooter>
    </root>"#;
    let s = section(xml);

    assert_eq!(
        s.header_footer_type,
        Some(ir::HeaderFooterType::Both),
        "type attribute 'both' must be parsed"
    );
}

#[test]
fn header_footer_type_even_parsed() {
    // Test that type="even" attribute is parsed correctly.
    let xml = r#"<root>
        <hp:headerFooter type="even">
            <hp:header>
                <hp:p><hp:run><hp:t>Header</hp:t></hp:run></hp:p>
            </hp:header>
        </hp:headerFooter>
    </root>"#;
    let s = section(xml);

    assert_eq!(
        s.header_footer_type,
        Some(ir::HeaderFooterType::Even),
        "type attribute 'even' must be parsed"
    );
}

#[test]
fn header_footer_type_odd_parsed() {
    // Test that type="odd" attribute is parsed correctly.
    let xml = r#"<root>
        <hp:headerFooter type="odd">
            <hp:footer>
                <hp:p><hp:run><hp:t>Footer</hp:t></hp:run></hp:p>
            </hp:footer>
        </hp:headerFooter>
    </root>"#;
    let s = section(xml);

    assert_eq!(
        s.header_footer_type,
        Some(ir::HeaderFooterType::Odd),
        "type attribute 'odd' must be parsed"
    );
}

#[test]
fn header_footer_type_none_when_not_specified() {
    // Test that header_footer_type is None when type attribute is not present.
    let xml = r"<root>
        <hp:headerFooter>
            <hp:header>
                <hp:p><hp:run><hp:t>Header</hp:t></hp:run></hp:p>
            </hp:header>
        </hp:headerFooter>
    </root>";
    let s = section(xml);

    assert!(
        s.header_footer_type.is_none(),
        "header_footer_type must be None when type attribute is not present"
    );
}