extend-docx 0.1.1

Rust parser, document model, and serializer for DOCX and legacy Word documents
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
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
use std::collections::HashMap;

use crate::model::{
    NumberingAbstractDefinition, NumberingDefinitionSet, NumberingInstanceDefinition,
    NumberingLevelDefinition, NumberingLevelSuffix, NumberingPictureBulletDefinition,
};
use crate::package::OoxmlPackage;
use super::colors::normalize_hex_color;
use crate::xml::{get_attribute, parse_integer_attribute};

use super::context::ContentTypeLookup;
use super::relationships::{bytes_to_base64, content_type_for_part, parse_part_relationships};
use super::scan::{decode_xml_attribute, starts_with_ignore_ascii_case};
use super::styles::{parse_paragraph_indent_from_xml, parse_text_style_from_xml};

/// Mirrors TypeScript `pointsToPixels`.
pub fn points_to_pixels(points: f64) -> i64 {
    ((points * 96.0) / 72.0).round().max(1.0) as i64
}

/// Mirrors TypeScript `parseCssPointValue`.
pub fn parse_css_point_value(style_value: Option<&str>, css_property: &str) -> Option<i64> {
    let style_value = style_value?;
    let property = css_property.to_ascii_lowercase();
    let mut index = 0;
    let bytes = style_value.as_bytes();

    while index < bytes.len() {
        if starts_with_ignore_ascii_case(&style_value[index..], &property) {
            let mut cursor = index + property.len();
            while cursor < bytes.len() && bytes[cursor].is_ascii_whitespace() {
                cursor += 1;
            }
            if bytes.get(cursor) != Some(&b':') {
                index += 1;
                continue;
            }
            cursor += 1;
            while cursor < bytes.len() && bytes[cursor].is_ascii_whitespace() {
                cursor += 1;
            }

            let value_start = cursor;
            let mut value_end = value_start;
            while value_end < bytes.len()
                && (bytes[value_end].is_ascii_digit() || bytes[value_end] == b'.')
            {
                value_end += 1;
            }

            let number_text = &style_value[value_start..value_end];
            if number_text.is_empty() {
                return None;
            }

            if !starts_with_ignore_ascii_case(&style_value[value_end..], "pt") {
                return None;
            }

            let parsed = number_text.parse::<f64>().ok()?;
            if !parsed.is_finite() || parsed <= 0.0 {
                return None;
            }

            return Some(points_to_pixels(parsed));
        }

        index += 1;
    }

    None
}

/// Mirrors TypeScript `parseNumberingPictureBulletDefinitions`.
pub fn parse_numbering_picture_bullet_definitions(
    pkg: &OoxmlPackage,
    numbering_xml: &str,
    content_types: &ContentTypeLookup,
) -> HashMap<i64, NumberingPictureBulletDefinition> {
    parse_picture_bullets_with_assets(pkg, numbering_xml, content_types, &pkg.binary_assets)
}

fn parse_picture_bullets_with_assets(
    pkg: &OoxmlPackage,
    numbering_xml: &str,
    content_types: &ContentTypeLookup,
    binary_assets: &HashMap<String, Vec<u8>>,
) -> HashMap<i64, NumberingPictureBulletDefinition> {
    let mut picture_bullets = HashMap::new();
    let numbering_relationships = parse_part_relationships(pkg, &crate::package::related_document_part_name(pkg, "numbering"));

    for num_pic_bullet_xml in crate::xml::extract_balanced_tag_slices(numbering_xml, "w:numPicBullet") {
        let num_pic_bullet_tag = super::scan::find_tag_token_ref(&num_pic_bullet_xml, "w:numPicBullet").unwrap_or_default();
        let num_pic_bullet_id = get_attribute(&num_pic_bullet_tag, "w:numPicBulletId")
            .and_then(|raw| raw.parse::<f64>().ok())
            .filter(|value| value.is_finite());
        let Some(num_pic_bullet_id) = num_pic_bullet_id else {
            continue;
        };

        let shape_tag = super::scan::find_tag_token_ref(&num_pic_bullet_xml, "v:shape");
        let shape_style = shape_tag.as_deref().and_then(|tag| get_attribute(tag, "style"));
        let width_px = parse_css_point_value(shape_style.as_deref(), "width").map(|value| value as f64);
        let height_px =
            parse_css_point_value(shape_style.as_deref(), "height").map(|value| value as f64);

        let image_tag = super::scan::find_tag_token_ref(&num_pic_bullet_xml, "v:imagedata");
        let relationship_id = image_tag.as_deref().and_then(|tag| get_attribute(tag, "r:id"));
        let image_part_name = relationship_id
            .as_ref()
            .and_then(|id| numbering_relationships.get(id).cloned());
        let image_bytes = image_part_name
            .as_ref()
            .and_then(|part_name| binary_assets.get(part_name));
        let image_content_type = image_part_name
            .as_ref()
            .and_then(|part_name| content_type_for_part(part_name, content_types));
        let src = match (&image_part_name, &image_bytes, &image_content_type) {
            (Some(_), Some(bytes), Some(content_type)) => Some(format!(
                "data:{content_type};base64,{}",
                bytes_to_base64(bytes)
            )),
            _ => None,
        };

        picture_bullets.insert(
            num_pic_bullet_id.round() as i64,
            NumberingPictureBulletDefinition {
                num_pic_bullet_id: num_pic_bullet_id.round() as i64,
                src,
                width_px,
                height_px,
                part_name: image_part_name,
                content_type: image_content_type,
            },
        );
    }

    picture_bullets
}

/// Mirrors TypeScript `parseNumberingLevelDefinition`.
pub fn parse_numbering_level_definition(
    level_xml: &str,
    picture_bullets_by_id: &HashMap<i64, NumberingPictureBulletDefinition>,
) -> Option<NumberingLevelDefinition> {
    if level_xml.is_empty() {
        return None;
    }

    let level_tag = super::scan::find_tag_token_ref(level_xml, "w:lvl").unwrap_or_default();
    let ilvl = get_attribute(&level_tag, "w:ilvl")
        .and_then(|raw| raw.parse::<f64>().ok())
        .filter(|value| value.is_finite())?;

    let start_tag = super::scan::find_tag_token_ref(level_xml, "w:start");
    let lvl_restart_tag = super::scan::find_tag_token_ref(level_xml, "w:lvlRestart");
    let is_lgl_tag = super::scan::find_tag_token_ref(level_xml, "w:isLgl");
    let num_fmt_tag = super::scan::find_tag_token_ref(level_xml, "w:numFmt");
    let lvl_text_tag = super::scan::find_tag_token_ref(level_xml, "w:lvlText");
    let suffix_tag = super::scan::find_tag_token_ref(level_xml, "w:suff");
    let level_run_properties_xml = crate::xml::extract_balanced_tag_slices(level_xml, "w:rPr")
        .into_iter()
        .next()
        .or_else(|| super::scan::find_tag_token_ref(level_xml, "w:rPr"))
        .unwrap_or_default();
    let level_paragraph_properties_xml = crate::xml::extract_balanced_tag_slices(level_xml, "w:pPr")
        .into_iter()
        .next()
        .or_else(|| super::scan::find_tag_token_ref(level_xml, "w:pPr"))
        .unwrap_or_default();
    let level_fonts_tag = super::scan::find_tag_token_ref(&level_run_properties_xml, "w:rFonts");
    let level_color_tag = super::scan::find_tag_token_ref(&level_run_properties_xml, "w:color");
    let level_run_style = parse_text_style_from_xml(&level_run_properties_xml, &Default::default());
    let picture_bullet_tag = super::scan::find_tag_token_ref(level_xml, "w:lvlPicBulletId");
    let suffix_raw = suffix_tag
        .as_deref()
        .and_then(|tag| get_attribute(tag, "w:val"))
        .map(|value| value.to_ascii_lowercase());
    let picture_bullet_id = picture_bullet_tag
        .as_deref()
        .and_then(|tag| get_attribute(tag, "w:val"))
        .and_then(|raw| raw.parse::<f64>().ok())
        .filter(|value| value.is_finite());

    let bullet_font_family = level_fonts_tag
        .as_deref()
        .and_then(|tag| {
            get_attribute(tag, "w:ascii")
                .or_else(|| get_attribute(tag, "w:hAnsi"))
                .or_else(|| get_attribute(tag, "w:eastAsia"))
                .or_else(|| get_attribute(tag, "w:cs"))
        })
        .and_then(|value| decode_xml_attribute(Some(&value)))
        .map(|value| value.trim().to_string())
        .filter(|value| !value.is_empty());

    let bullet_color = level_color_tag
        .as_deref()
        .and_then(|tag| get_attribute(tag, "w:val"))
        .as_deref()
        .and_then(|value| normalize_hex_color(Some(value)));

    let suffix = match suffix_raw.as_deref() {
        Some("tab") => Some(NumberingLevelSuffix::Tab),
        Some("space") => Some(NumberingLevelSuffix::Space),
        Some("nothing") => Some(NumberingLevelSuffix::Nothing),
        _ => None,
    };

    let indent = if level_paragraph_properties_xml.is_empty() {
        None
    } else {
        parse_paragraph_indent_from_xml(&level_paragraph_properties_xml)
    };

    let rounded_picture_bullet_id = picture_bullet_id.map(|value| value.round() as i64);

    Some(NumberingLevelDefinition {
        ilvl: ilvl.round().max(0.0) as i64,
        start: start_tag
            .as_deref()
            .and_then(|tag| parse_integer_attribute(tag, "w:val")),
        lvl_restart: lvl_restart_tag
            .as_deref()
            .and_then(|tag| parse_integer_attribute(tag, "w:val")),
        is_lgl: is_lgl_tag.as_deref().map(|tag| {
            !matches!(
                get_attribute(tag, "w:val").as_deref(),
                Some("0") | Some("false") | Some("off")
            )
        }),
        format: num_fmt_tag.as_deref().and_then(|tag| get_attribute(tag, "w:val")),
        text: lvl_text_tag
            .as_deref()
            .and_then(|tag| get_attribute(tag, "w:val"))
            .and_then(|value| decode_xml_attribute(Some(&value))),
        suffix,
        indent,
        run_style: level_run_style,
        bullet_font_family,
        bullet_color,
        picture_bullet_id: rounded_picture_bullet_id,
        picture_bullet: rounded_picture_bullet_id
            .and_then(|id| picture_bullets_by_id.get(&id).cloned()),
    })
}

/// Mirrors TypeScript `parseNumberingDefinitions`.
pub fn parse_numbering_definitions(
    pkg: &OoxmlPackage,
    content_types: &ContentTypeLookup,
) -> Option<NumberingDefinitionSet> {
    parse_numbering_with_assets(pkg, content_types, &pkg.binary_assets)
}

pub(crate) fn parse_numbering_with_assets(
    pkg: &OoxmlPackage,
    content_types: &ContentTypeLookup,
    binary_assets: &HashMap<String, Vec<u8>>,
) -> Option<NumberingDefinitionSet> {
    let numbering_xml = crate::package::related_document_part(pkg, "numbering")?.content.as_str();
    #[cfg(not(target_arch = "wasm32"))]
    if numbering_xml.len() <= 128 * 1024
        && !super::scan::contains_tag(numbering_xml, "w:numPicBullet")
    {
        return numbering_templates::parse(numbering_xml);
    }
    let picture_bullets_by_id =
        parse_picture_bullets_with_assets(pkg, numbering_xml, content_types, binary_assets);
    parse_numbering_xml(numbering_xml, &picture_bullets_by_id)
}

fn parse_numbering_xml(
    numbering_xml: &str,
    picture_bullets_by_id: &HashMap<i64, NumberingPictureBulletDefinition>,
) -> Option<NumberingDefinitionSet> {
    let parsed_abstracts: Vec<IntermediateAbstractDefinition> =
        crate::xml::extract_balanced_tag_slices(numbering_xml, "w:abstractNum")
            .into_iter()
            .filter_map(|abstract_xml| {
                let abstract_tag =
                    super::scan::find_tag_token_ref(&abstract_xml, "w:abstractNum").unwrap_or_default();
                let abstract_num_id = get_attribute(&abstract_tag, "w:abstractNumId")
                    .and_then(|raw| raw.parse::<f64>().ok())
                    .filter(|value| value.is_finite())?;

                let style_link_tag = super::scan::find_tag_token_ref(&abstract_xml, "w:styleLink");
                let num_style_link_tag = super::scan::find_tag_token_ref(&abstract_xml, "w:numStyleLink");
                let mut levels: Vec<NumberingLevelDefinition> =
                    crate::xml::extract_balanced_tag_slices(&abstract_xml, "w:lvl")
                        .into_iter()
                        .filter_map(|level_xml| {
                            parse_numbering_level_definition(&level_xml, picture_bullets_by_id)
                        })
                        .collect();
                levels.sort_by_key(|level| level.ilvl);

                Some(IntermediateAbstractDefinition {
                    abstract_num_id: abstract_num_id.round() as i64,
                    style_link: style_link_tag
                        .as_deref()
                        .and_then(|tag| get_attribute(tag, "w:val")),
                    num_style_link: num_style_link_tag
                        .as_deref()
                        .and_then(|tag| get_attribute(tag, "w:val")),
                    levels,
                })
            })
            .collect();

    let mut style_linked_levels = HashMap::new();
    for abstract_definition in &parsed_abstracts {
        if let Some(style_link) = abstract_definition.style_link.as_deref() {
            if !abstract_definition.levels.is_empty() {
                style_linked_levels.insert(style_link.to_string(), abstract_definition.levels.clone());
            }
        }
    }

    let abstracts: Vec<NumberingAbstractDefinition> = parsed_abstracts
        .into_iter()
        .map(|abstract_definition| {
            let linked_levels = if !abstract_definition.levels.is_empty() {
                abstract_definition.levels
            } else {
                abstract_definition
                    .num_style_link
                    .as_deref()
                    .and_then(|style_link| style_linked_levels.get(style_link).cloned())
                    .unwrap_or_default()
            };

            NumberingAbstractDefinition {
                abstract_num_id: abstract_definition.abstract_num_id,
                levels: linked_levels,
            }
        })
        .collect();

    let instances: Vec<NumberingInstanceDefinition> =
        crate::xml::extract_balanced_tag_slices(numbering_xml, "w:num")
            .into_iter()
            .filter_map(|num_xml| {
                let num_tag = super::scan::find_tag_token_ref(&num_xml, "w:num").unwrap_or_default();
                let num_id = get_attribute(&num_tag, "w:numId")
                    .and_then(|raw| raw.parse::<f64>().ok())
                    .filter(|value| value.is_finite())?;

                let abstract_num_id_tag = super::scan::find_tag_token_ref(&num_xml, "w:abstractNumId");
                let abstract_num_id = abstract_num_id_tag
                    .as_deref()
                    .and_then(|tag| get_attribute(tag, "w:val"))
                    .and_then(|raw| raw.parse::<f64>().ok())
                    .filter(|value| value.is_finite())?;

                let mut level_start_overrides = HashMap::new();
                let mut level_overrides = Vec::new();

                for override_xml in crate::xml::extract_balanced_tag_slices(&num_xml, "w:lvlOverride") {
                    let override_tag =
                        super::scan::find_tag_token_ref(&override_xml, "w:lvlOverride").unwrap_or_default();
                    let override_level = get_attribute(&override_tag, "w:ilvl")
                        .and_then(|raw| raw.parse::<f64>().ok())
                        .filter(|value| value.is_finite())?;

                    let start_override_tag = super::scan::find_tag_token_ref(&override_xml, "w:startOverride");
                    let start_override = start_override_tag
                        .as_deref()
                        .and_then(|tag| parse_integer_attribute(tag, "w:val"));
                    if let Some(start_override) = start_override.filter(|value| *value > 0) {
                        level_start_overrides
                            .insert(override_level.round().max(0.0) as i64, start_override);
                    }

                    if let Some(level_xml) =
                        crate::xml::extract_balanced_tag_slices(&override_xml, "w:lvl").into_iter().next()
                    {
                        if let Some(parsed_level) =
                            parse_numbering_level_definition(&level_xml, picture_bullets_by_id)
                        {
                            level_overrides.push(parsed_level);
                        }
                    }
                }

                Some(NumberingInstanceDefinition {
                    num_id: num_id.round() as i64,
                    abstract_num_id: abstract_num_id.round() as i64,
                    level_start_overrides: if level_start_overrides.is_empty() {
                        None
                    } else {
                        Some(
                            level_start_overrides
                                .into_iter()
                                .map(|(key, value)| (key.to_string(), value))
                                .collect(),
                        )
                    },
                    level_overrides: if level_overrides.is_empty() {
                        None
                    } else {
                        Some(level_overrides)
                    },
                })
            })
            .collect();

    if abstracts.is_empty() && instances.is_empty() {
        return None;
    }

    Some(NumberingDefinitionSet {
        abstracts,
        instances,
    })
}

struct IntermediateAbstractDefinition {
    abstract_num_id: i64,
    style_link: Option<String>,
    num_style_link: Option<String>,
    levels: Vec<NumberingLevelDefinition>,
}

#[cfg(not(target_arch = "wasm32"))]
mod numbering_templates {
    use super::*;
    use std::collections::VecDeque;
    use std::sync::{Arc, LazyLock};

    type Entry = Arc<(String, Arc<Option<NumberingDefinitionSet>>)>;
    static TEMPLATES: LazyLock<super::super::cache::Snapshot<VecDeque<Entry>>> =
        LazyLock::new(|| super::super::cache::Snapshot::new(VecDeque::new()));

    pub(super) fn parse(xml: &str) -> Option<NumberingDefinitionSet> {
        if let Some(value) = TEMPLATES.read(|entries| entries.iter()
            .find(|entry| entry.0 == xml).map(|entry| Arc::clone(&entry.1))) {
            return (*value).clone();
        }
        let parsed = parse_numbering_xml(xml, &HashMap::new());
        let entry = Arc::new((xml.to_owned(), Arc::new(parsed.clone())));
        TEMPLATES.publish(move |entries| {
            let mut next = entries.clone();
            if !next.iter().any(|existing| existing.0 == entry.0) {
                if next.len() == 4 { next.pop_front(); }
                next.push_back(entry);
            }
            next
        });
        parsed
    }
}

#[cfg(all(test, not(target_arch = "wasm32")))]
mod template_tests {
    use super::*;
    use crate::package::OoxmlPart;

    fn package(xml: String) -> OoxmlPackage {
        let name = "word/numbering.xml".to_owned();
        OoxmlPackage {
            parts: HashMap::from([(name.clone(), OoxmlPart { name, content: xml })]),
            binary_assets: HashMap::new(),
            warnings: Vec::new(),
        }
    }

    #[test]
    fn definition_reuse_preserves_changes_and_owned_results() {
        for value in (1..13).chain((1..13).rev()) {
            let xml = format!(r#"<w:numbering><w:abstractNum w:abstractNumId="1"><w:lvl w:ilvl="0"><w:start w:val="{value}"/><w:numFmt w:val="decimal"/><w:lvlText w:val="%1.{value}"/><w:rPr><w:color w:val="123456"/></w:rPr></w:lvl></w:abstractNum><w:num w:numId="2"><w:abstractNumId w:val="1"/><w:lvlOverride w:ilvl="0"><w:startOverride w:val="{value}"/></w:lvlOverride></w:num></w:numbering>"#);
            let expected = parse_numbering_xml(&xml, &HashMap::new());
            let pkg = package(xml);
            let mut actual = parse_numbering_definitions(&pkg, &ContentTypeLookup::default());
            assert_eq!(actual, expected);
            actual.as_mut().unwrap().abstracts.clear();
            assert_eq!(parse_numbering_definitions(&pkg, &ContentTypeLookup::default()), expected);
        }
    }

    #[test]
    fn picture_bullet_assets_are_resolved_for_each_package() {
        let xml = r#"<w:numbering><w:numPicBullet w:numPicBulletId="5"><w:pict><v:shape><v:imagedata r:id="rId1"/></v:shape></w:pict></w:numPicBullet><w:abstractNum w:abstractNumId="1"><w:lvl w:ilvl="0"><w:lvlPicBulletId w:val="5"/></w:lvl></w:abstractNum></w:numbering>"#;
        let mut pkg = package(xml.to_owned());
        let name = "word/_rels/numbering.xml.rels".to_owned();
        pkg.parts.insert(name.clone(), OoxmlPart { name, content: r#"<Relationships><Relationship Id="rId1" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/image" Target="media/bullet.png"/></Relationships>"#.to_owned() });
        let mut types = ContentTypeLookup::default();
        types.default_by_extension.insert("png".to_owned(), "image/png".to_owned());
        pkg.binary_assets.insert("word/media/bullet.png".to_owned(), vec![1, 2, 3]);
        let before = parse_numbering_definitions(&pkg, &types).unwrap();
        pkg.binary_assets.insert("word/media/bullet.png".to_owned(), vec![4, 5, 6]);
        let after = parse_numbering_definitions(&pkg, &types).unwrap();
        assert_ne!(before.abstracts[0].levels[0].picture_bullet, after.abstracts[0].levels[0].picture_bullet);
    }
}