umya-spreadsheet 3.0.0

umya-spreadsheet is a library written in pure Rust to read and write xlsx file.
Documentation
// a:xfrm
use std::io::Cursor;

use quick_xml::{
    Reader,
    Writer,
    events::{
        BytesStart,
        Event,
    },
};

use crate::{
    StringValue,
    reader::driver::{
        get_attribute,
        xml_read_loop,
    },
    structs::drawing::{
        Point2DType,
        PositiveSize2DType,
    },
    writer::driver::{
        write_end_tag,
        write_start_tag,
    },
};

#[derive(Clone, Default, Debug)]
pub struct Transform2D {
    offset:        Point2DType,
    extents:       PositiveSize2DType,
    child_offset:  Option<Box<Point2DType>>,
    child_extents: Option<Box<PositiveSize2DType>>,
    rot:           StringValue,
    flip_v:        StringValue,
    flip_h:        StringValue,
}

impl Transform2D {
    #[inline]
    #[must_use]
    pub fn offset(&self) -> &Point2DType {
        &self.offset
    }

    #[inline]
    #[must_use]
    #[deprecated(since = "3.0.0", note = "Use offset()")]
    pub fn get_offset(&self) -> &Point2DType {
        self.offset()
    }

    #[inline]
    pub fn offset_mut(&mut self) -> &mut Point2DType {
        &mut self.offset
    }

    #[inline]
    #[deprecated(since = "3.0.0", note = "Use offset_mut()")]
    pub fn get_offset_mut(&mut self) -> &mut Point2DType {
        self.offset_mut()
    }

    #[inline]
    pub fn set_offset(&mut self, value: Point2DType) {
        self.offset = value;
    }

    #[inline]
    #[must_use]
    pub fn extents(&self) -> &PositiveSize2DType {
        &self.extents
    }

    #[inline]
    #[must_use]
    #[deprecated(since = "3.0.0", note = "Use extents()")]
    pub fn get_extents(&self) -> &PositiveSize2DType {
        self.extents()
    }

    #[inline]
    pub fn extents_mut(&mut self) -> &mut PositiveSize2DType {
        &mut self.extents
    }

    #[inline]
    #[deprecated(since = "3.0.0", note = "Use extents_mut()")]
    pub fn get_extents_mut(&mut self) -> &mut PositiveSize2DType {
        self.extents_mut()
    }

    #[inline]
    pub fn set_extents(&mut self, value: PositiveSize2DType) {
        self.extents = value;
    }

    #[inline]
    #[must_use]
    pub fn child_offset(&self) -> Option<&Point2DType> {
        self.child_offset.as_deref()
    }

    #[inline]
    #[must_use]
    #[deprecated(since = "3.0.0", note = "Use child_offset()")]
    pub fn get_child_offset(&self) -> Option<&Point2DType> {
        self.child_offset()
    }

    #[inline]
    pub fn child_offset_mut(&mut self) -> Option<&mut Point2DType> {
        self.child_offset.as_deref_mut()
    }

    #[inline]
    #[deprecated(since = "3.0.0", note = "Use child_offset_mut()")]
    pub fn get_child_offset_mut(&mut self) -> Option<&mut Point2DType> {
        self.child_offset_mut()
    }

    #[inline]
    pub fn set_child_offset(&mut self, value: Point2DType) {
        self.child_offset = Some(Box::new(value));
    }

    #[inline]
    #[must_use]
    pub fn child_extents(&self) -> Option<&PositiveSize2DType> {
        self.child_extents.as_deref()
    }

    #[inline]
    #[must_use]
    #[deprecated(since = "3.0.0", note = "Use child_extents()")]
    pub fn get_child_extents(&self) -> Option<&PositiveSize2DType> {
        self.child_extents()
    }

    #[inline]
    pub fn child_extents_mut(&mut self) -> Option<&mut PositiveSize2DType> {
        self.child_extents.as_deref_mut()
    }

    #[inline]
    #[deprecated(since = "3.0.0", note = "Use child_extents_mut()")]
    pub fn get_child_extents_mut(&mut self) -> Option<&mut PositiveSize2DType> {
        self.child_extents_mut()
    }

    #[inline]
    pub fn set_child_extents(&mut self, value: PositiveSize2DType) {
        self.child_extents = Some(Box::new(value));
    }

    #[inline]
    #[must_use]
    pub fn rot(&self) -> Option<&str> {
        self.rot.value()
    }

    #[inline]
    #[must_use]
    #[deprecated(since = "3.0.0", note = "Use rot()")]
    pub fn get_rot(&self) -> Option<&str> {
        self.rot()
    }

    #[inline]
    pub fn set_rot<S: Into<String>>(&mut self, value: S) {
        self.rot.set_value(value);
    }

    #[inline]
    #[must_use]
    pub fn flip_v(&self) -> Option<&str> {
        self.flip_v.value()
    }

    #[inline]
    #[must_use]
    #[deprecated(since = "3.0.0", note = "Use flip_v()")]
    pub fn get_flip_v(&self) -> Option<&str> {
        self.flip_v()
    }

    #[inline]
    pub fn set_flip_v<S: Into<String>>(&mut self, value: S) {
        self.flip_v.set_value(value);
    }

    #[inline]
    #[must_use]
    pub fn flip_h(&self) -> Option<&str> {
        self.flip_h.value()
    }

    #[inline]
    #[must_use]
    #[deprecated(since = "3.0.0", note = "Use flip_h()")]
    pub fn get_flip_h(&self) -> Option<&str> {
        self.flip_h()
    }

    #[inline]
    pub fn set_flip_h<S: Into<String>>(&mut self, value: S) {
        self.flip_h.set_value(value);
    }

    pub(crate) fn set_attributes<R: std::io::BufRead>(
        &mut self,
        reader: &mut Reader<R>,
        e: &BytesStart,
    ) {
        if let Some(v) = get_attribute(e, b"rot") {
            self.set_rot(v);
        }

        if let Some(v) = get_attribute(e, b"flipH") {
            self.set_flip_h(v);
        }

        if let Some(v) = get_attribute(e, b"flipV") {
            self.set_flip_v(v);
        }

        xml_read_loop!(
            reader,
            Event::Empty(ref e) => {
                match e.name().into_inner() {
                    b"a:off" => {
                        self.offset.set_attributes(reader, e, true);
                    }
                    b"a:ext" => {
                        self.extents.set_attributes(reader, e, true);
                    }
                    b"a:chOff" => {
                        let mut obj = Point2DType::default();
                        obj.set_attributes(reader, e, true);
                        self.set_child_offset(obj);
                    }
                    b"a:chExt" => {
                        let mut obj = PositiveSize2DType::default();
                        obj.set_attributes(reader, e, true);
                        self.set_child_extents(obj);
                    }
                    _ => (),
                }
            },
            Event::Start(ref e) => {
                match e.name().into_inner() {
                    b"a:off" => {
                        self.offset.set_attributes(reader, e, false);
                    }
                    b"a:ext" => {
                        self.extents.set_attributes(reader, e, false);
                    }
                    b"a:chOff" => {
                        let mut obj = Point2DType::default();
                        obj.set_attributes(reader, e, false);
                        self.set_child_offset(obj);
                    }
                    b"a:chExt" => {
                        let mut obj = PositiveSize2DType::default();
                        obj.set_attributes(reader, e, false);
                        self.set_child_extents(obj);
                    }
                    _ => (),
                }
            },
            Event::End(ref e) => {
                if e.name().into_inner() == b"a:xfrm" {
                    return;
                }
            },
            Event::Eof => panic!("Error: Could not find {} end element", "a:xfrm")
        );
    }

    pub(crate) fn write_to(&self, writer: &mut Writer<Cursor<Vec<u8>>>) {
        // a:xfrm
        let mut attributes: crate::structs::AttrCollection = Vec::new();
        if let Some(v) = self.rot.value() {
            attributes.push(("rot", v).into());
        }
        if let Some(v) = self.flip_h.value() {
            attributes.push(("flipH", v).into());
        }
        if let Some(v) = self.flip_v.value() {
            attributes.push(("flipV", v).into());
        }
        write_start_tag(writer, "a:xfrm", attributes, false);

        // a:off
        self.offset.write_to_off(writer);

        // a:ext
        self.extents.write_to_ext(writer);

        // a:chOff
        if let Some(v) = &self.child_offset {
            v.write_to_ch_off(writer);
        }

        // a:chExt
        if let Some(v) = &self.child_extents {
            v.write_to_ch_ext(writer);
        }

        write_end_tag(writer, "a:xfrm");
    }
}