excel_reader 2.0.2 

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

use std::io::Read;

use anyhow::bail;
use quick_xml::events::Event;

use crate::{
    excel::XmlReader,
    raw::drawing::{
        graphic::graphic_frame::XlsxGraphicFrame,
        image::picture::XlsxPicture,
        non_visual_properties::non_visual_group_shape_properties::XlsxNonVisualGroupShapeProperties,
        shape::{
            connection_shape::XlsxConnectionShape,
            visual_group_shape_properties::XlsxVisualGroupShapeProperties,
        },
        worksheet_drawing::{
            drawing_content_type::XlsxWorksheetDrawingContentType, spreadsheet_shape::XlsxShape,
        },
    },
};

/// - https://learn.microsoft.com/en-us/dotnet/api/documentformat.openxml.drawing.spreadsheet.groupshape?view=openxml-3.0.1
///
/// This element specifies a group shape that represents many shapes grouped together.
/// This shape is to be treated just as if it were a regular shape but instead of being described by a single geometry it is made up of all the shape geometries encompassed within it.
/// Within a group shape each of the shapes that make up the group are specified just as they normally would.
/// The idea behind grouping elements however is that a single transform can apply to many shapes at the same time.
///
/// Example:
///
/// ```
/// <p:grpSp>
///   <p:nvGrpSpPr>
///     <p:cNvPr id="10" name="Group 9"/>
///     <p:cNvGrpSpPr/>
///     <p:nvPr/>
///   </p:nvGrpSpPr>
///   <p:grpSpPr>
///     <a:xfrm>
///       <a:off x="838200" y="990600"/>
///       <a:ext cx="2426208" cy="978408"/>
///       <a:chOff x="838200" y="990600"/>
///       <a:chExt cx="2426208" cy="978408"/>
///     </a:xfrm>
///   </p:grpSpPr>
///   <p:sp>
///   …  </p:sp>
///   <p:sp>
///   …  </p:sp>
///   <p:sp>
///   …  </p:sp>
/// </p:grpSp>
/// ```
///
/// grpSp (Group shape)
#[derive(Debug, Clone, PartialEq)]
pub struct XlsxGroupShape {
    // Child Elements
    // extLst (Extension List) Not supported
    /// grpSpPr (Visual Group Shape Properties)	§20.1.2.2.22
    pub visual_group_shape_properties: Option<XlsxVisualGroupShapeProperties>,

    /// nvGrpSpPr (Non-Visual Properties for a Group Shape)	§20.1.2.2.27
    pub non_visual_group_shape_properties: Option<XlsxNonVisualGroupShapeProperties>,

    /// group of the following
    /// - pic (Picture)
    /// - sp (Shape)
    /// - grpSp (Group shape)
    /// - graphicFrame (Graphic Frame) (Ex: Charts)
    /// - cxnSp (Connection Shape)	§20.1.2.2.10
    ///
    /// (content parts cannot appear in a group shape)
    pub drawing_contents: Option<Box<Vec<XlsxWorksheetDrawingContentType>>>,
}

impl XlsxGroupShape {
    pub(crate) fn load(reader: &mut XmlReader<impl Read>) -> anyhow::Result<Self> {
        let mut shape = Self {
            visual_group_shape_properties: None,
            non_visual_group_shape_properties: None,
            drawing_contents: None,
        };

        let mut shapes: Vec<XlsxWorksheetDrawingContentType> = vec![];

        let mut buf: Vec<u8> = Vec::new();
        loop {
            buf.clear();

            match reader.read_event_into(&mut buf) {
                Ok(Event::Start(ref e)) if e.local_name().as_ref() == b"extLst" => {
                    let _ = reader.read_to_end_into(e.to_end().to_owned().name(), &mut Vec::new());
                }
                Ok(Event::Start(ref e)) if e.local_name().as_ref() == b"cxnSp" => {
                    shapes.push(XlsxWorksheetDrawingContentType::ConnectionShape(
                        XlsxConnectionShape::load(reader, e)?,
                    ));
                }
                Ok(Event::Start(ref e)) if e.local_name().as_ref() == b"grpSp" => {
                    shapes.push(XlsxWorksheetDrawingContentType::GroupShape(
                        XlsxGroupShape::load(reader)?,
                    ));
                }
                Ok(Event::Start(ref e)) if e.local_name().as_ref() == b"grpSpPr" => {
                    shape.visual_group_shape_properties =
                        Some(XlsxVisualGroupShapeProperties::load(reader, e)?);
                }
                Ok(Event::Start(ref e)) if e.local_name().as_ref() == b"graphicFrame" => {
                    shapes.push(XlsxWorksheetDrawingContentType::GraphicFrame(
                        XlsxGraphicFrame::load(reader, e)?,
                    ));
                }
                Ok(Event::Start(ref e)) if e.local_name().as_ref() == b"nvGrpSpPr" => {
                    shape.non_visual_group_shape_properties =
                        Some(XlsxNonVisualGroupShapeProperties::load(reader)?);
                }
                Ok(Event::Start(ref e)) if e.local_name().as_ref() == b"pic" => {
                    shapes.push(XlsxWorksheetDrawingContentType::Picture(XlsxPicture::load(
                        reader, e,
                    )?));
                }
                Ok(Event::Start(ref e)) if e.local_name().as_ref() == b"sp" => {
                    shapes.push(XlsxWorksheetDrawingContentType::Shape(XlsxShape::load(
                        reader, e,
                    )?));
                }
                Ok(Event::End(ref e)) if e.local_name().as_ref() == b"grpSp" => break,
                Ok(Event::Eof) => bail!("unexpected end of file at `grpSp`."),
                Err(e) => bail!(e.to_string()),
                _ => (),
            }
        }
        shape.drawing_contents = Some(Box::new(shapes));

        return Ok(shape);
    }
}