musicxml 1.1.2

MusicXML parsing, manipulation, and export library
Documentation
use super::{AccordionHigh, AccordionLow, AccordionMiddle};
use crate::datatypes::{Color, FontFamily, FontSize, FontStyle, FontWeight, Id, LeftCenterRight, Tenths, Valign};
use alloc::{string::String, vec::Vec};
use musicxml_internal::*;
use musicxml_macros::*;

/// Attributes pertaining to the [AccordionRegistration] element.
#[derive(Debug, Default, PartialEq, Eq, AttributeDeserialize, AttributeSerialize)]
pub struct AccordionRegistrationAttributes {
  /// Indicates the color of an element.
  pub color: Option<Color>,
  /// Changes the computation of the default horizontal position.
  /// The origin is changed relative to the left-hand side of the note or the musical position within the bar.
  /// Positive x is right and negative x is left.
  ///
  /// This attribute provides higher-resolution positioning data than the [Offset][super::Offset] element.
  /// Applications reading a MusicXML file that can understand both features should generally rely on this attribute for its greater accuracy.
  pub default_x: Option<Tenths>,
  /// Changes the computation of the default vertical position.
  /// The origin is changed relative to the top line of the staff. Positive y is up and negative y is down.
  ///
  /// This attribute provides higher-resolution positioning data than the `placement` attribute.
  /// Applications reading a MusicXML file that can understand both attributes should generally rely on this attribute for its greater accuracy.
  pub default_y: Option<Tenths>,
  /// A comma-separated list of font names.
  pub font_family: Option<FontFamily>,
  /// One of the CSS sizes or a numeric point size.
  pub font_size: Option<FontSize>,
  /// Normal or italic style.
  pub font_style: Option<FontStyle>,
  /// Normal or bold weight.
  pub font_weight: Option<FontWeight>,
  /// In cases where text extends over more than one line, horizontal alignment and justify values can be different.
  /// The most typical case is for credits, such as:
  ///
  /// ```text
  /// Words and music by
  ///   Pat Songwriter
  /// ```
  /// Typically this type of credit is aligned to the right, so that the position information refers to the right-most part of the text.
  /// But in this example, the text is center-justified, not right-justified.
  ///
  /// The `halign` attribute is used in these situations. If it is not present, its value is the same as for the `justify` attribute.
  /// For elements where a justify attribute is not allowed, the default is implementation-dependent.
  pub halign: Option<LeftCenterRight>,
  /// Specifies an ID that is unique to the entire document.
  pub id: Option<Id>,
  /// Changes the horizontal position relative to the default position, either as computed by the individual program, or as overridden by the `default_x` attribute.
  /// Positive x is right and negative x is left. It should be interpreted in the context of the [Offset][super::Offset] element or directive attribute if those are present.
  pub relative_x: Option<Tenths>,
  /// Changes the vertical position relative to the default position, either as computed by the individual program, or as overridden by the `default_y` attribute.
  /// Positive y is up and negative y is down. It should be interpreted in the context of the `placement` attribute if that is present.
  pub relative_y: Option<Tenths>,
  /// Indicates vertical alignment to the top, middle, bottom, or baseline of the text. The default is implementation-dependent.
  pub valign: Option<Valign>,
}

/// Contents of the [AccordionRegistration] element.
#[derive(Debug, Default, PartialEq, Eq, ContentDeserialize, ContentSerialize)]
pub struct AccordionRegistrationContents {
  /// The [AccordionHigh] element represents the presence of one or more dots in the high section of the registration symbol.
  pub accordion_high: Option<AccordionHigh>,
  /// The [AccordionMiddle] element represents the presence of one or more dots in the middle section of the registration symbol.
  pub accordion_middle: Option<AccordionMiddle>,
  /// The [AccordionLow] element represents the presence of one or more dots in the low section of the registration symbol.
  pub accordion_low: Option<AccordionLow>,
}

/// The [AccordionRegistration] element is used for accordion registration symbols.
///
/// These are circular symbols divided horizontally into high, middle, and low sections that correspond to 4', 8', and 16' pipes.
/// Each [AccordionHigh], [AccordionLow], and [AccordionMiddle] element represents the presence of one or more dots in the registration diagram.
/// An [AccordionRegistration] element needs to have at least one of the child elements present.
#[derive(Debug, PartialEq, Eq, ElementDeserialize, ElementSerialize)]
#[rename("accordion-registration")]
pub struct AccordionRegistration {
  /// Element-specific attributes
  pub attributes: AccordionRegistrationAttributes,
  #[flatten]
  /// Element-specific content
  pub content: AccordionRegistrationContents,
}

#[cfg(test)]
mod accordion_registration_tests {
  use super::*;
  use crate::parser::parse_from_xml_str;

  #[test]
  fn deserialize_valid1() {
    let result = parse_from_xml_str::<AccordionRegistration>(
      "
    <accordion-registration id=\"testID\" valign=\"baseline\">
      <accordion-low/>
    </accordion-registration>",
    );
    assert!(result.is_ok());
    assert_eq!(
      result.unwrap(),
      AccordionRegistration {
        attributes: AccordionRegistrationAttributes {
          id: Some(Id(String::from("testID"))),
          valign: Some(Valign::Baseline),
          ..Default::default()
        },
        content: AccordionRegistrationContents {
          accordion_low: Some(AccordionLow {
            attributes: (),
            content: ()
          }),
          ..Default::default()
        }
      }
    );
  }
}