safe_arch 1.0.0

Crate that exposes `core::arch` safely via `#[cfg()]`.
Documentation
//! This module is for the `m128i` wrapper type, its bonus methods, and all
//! necessary trait impls.
//!
//! Intrinsics should _not_ be in this module! They should all be free-functions
//! in the other modules, sorted by CPU target feature.

use super::*;

/// The data for a 128-bit SSE register of integer data.
///
/// * The exact layout to view the type as depends on the operation used.
/// * `From` and `Into` impls are provided for all the relevant signed integer
///   array types.
/// * Formatting impls print as four `i32` values just because they have to pick
///   something. If you want an alternative you can turn it into an array and
///   print as you like.
#[repr(transparent)]
#[allow(non_camel_case_types)]
pub struct m128i(pub __m128i);

#[cfg(feature = "bytemuck")]
unsafe impl bytemuck::Zeroable for m128i {}
#[cfg(feature = "bytemuck")]
unsafe impl bytemuck::Pod for m128i {}
#[cfg(feature = "bytemuck")]
unsafe impl bytemuck::TransparentWrapper<__m128i> for m128i {}

impl Clone for m128i {
  #[inline(always)]
  fn clone(&self) -> Self {
    *self
  }
}
impl Copy for m128i {}

impl Default for m128i {
  #[inline(always)]
  fn default() -> Self {
    unsafe { core::mem::zeroed() }
  }
}

// 8-bit

impl From<[i8; 16]> for m128i {
  #[inline(always)]
  fn from(arr: [i8; 16]) -> Self {
    unsafe { core::mem::transmute(arr) }
  }
}

impl From<m128i> for [i8; 16] {
  #[inline(always)]
  fn from(m: m128i) -> Self {
    unsafe { core::mem::transmute(m) }
  }
}

impl From<[u8; 16]> for m128i {
  #[inline(always)]
  fn from(arr: [u8; 16]) -> Self {
    unsafe { core::mem::transmute(arr) }
  }
}

impl From<m128i> for [u8; 16] {
  #[inline(always)]
  fn from(m: m128i) -> Self {
    unsafe { core::mem::transmute(m) }
  }
}

// 16-bit

impl From<[i16; 8]> for m128i {
  #[inline(always)]
  fn from(arr: [i16; 8]) -> Self {
    unsafe { core::mem::transmute(arr) }
  }
}

impl From<m128i> for [i16; 8] {
  #[inline(always)]
  fn from(m: m128i) -> Self {
    unsafe { core::mem::transmute(m) }
  }
}

impl From<[u16; 8]> for m128i {
  #[inline(always)]
  fn from(arr: [u16; 8]) -> Self {
    unsafe { core::mem::transmute(arr) }
  }
}

impl From<m128i> for [u16; 8] {
  #[inline(always)]
  fn from(m: m128i) -> Self {
    unsafe { core::mem::transmute(m) }
  }
}

// 32-bit

impl From<[i32; 4]> for m128i {
  #[inline(always)]
  fn from(arr: [i32; 4]) -> Self {
    unsafe { core::mem::transmute(arr) }
  }
}

impl From<m128i> for [i32; 4] {
  #[inline(always)]
  fn from(m: m128i) -> Self {
    unsafe { core::mem::transmute(m) }
  }
}

impl From<[u32; 4]> for m128i {
  #[inline(always)]
  fn from(arr: [u32; 4]) -> Self {
    unsafe { core::mem::transmute(arr) }
  }
}

impl From<m128i> for [u32; 4] {
  #[inline(always)]
  fn from(m: m128i) -> Self {
    unsafe { core::mem::transmute(m) }
  }
}

// 64-bit

impl From<[i64; 2]> for m128i {
  #[inline(always)]
  fn from(arr: [i64; 2]) -> Self {
    unsafe { core::mem::transmute(arr) }
  }
}

impl From<m128i> for [i64; 2] {
  #[inline(always)]
  fn from(m: m128i) -> Self {
    unsafe { core::mem::transmute(m) }
  }
}

impl From<[u64; 2]> for m128i {
  #[inline(always)]
  fn from(arr: [u64; 2]) -> Self {
    unsafe { core::mem::transmute(arr) }
  }
}

impl From<m128i> for [u64; 2] {
  #[inline(always)]
  fn from(m: m128i) -> Self {
    unsafe { core::mem::transmute(m) }
  }
}

// 128-bit

impl From<i128> for m128i {
  #[inline(always)]
  fn from(i: i128) -> Self {
    unsafe { core::mem::transmute(i) }
  }
}

impl From<m128i> for i128 {
  #[inline(always)]
  fn from(m: m128i) -> Self {
    unsafe { core::mem::transmute(m) }
  }
}

impl From<u128> for m128i {
  #[inline(always)]
  fn from(u: u128) -> Self {
    unsafe { core::mem::transmute(u) }
  }
}

impl From<m128i> for u128 {
  #[inline(always)]
  fn from(m: m128i) -> Self {
    unsafe { core::mem::transmute(m) }
  }
}

//
// PLEASE KEEP ALL THE FORMAT IMPL JUNK AT THE END OF THE FILE
//

impl Debug for m128i {
  /// Debug formats each `i32`.
  /// ```
  /// # use safe_arch::*;
  /// let f = format!("{:?}", m128i::default());
  /// assert_eq!(&f, "m128i(0, 0, 0, 0)");
  /// ```
  fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
    write!(f, "m128i(")?;
    for (i, int) in <[i32; 4]>::from(*self).iter().enumerate() {
      if i != 0 {
        write!(f, ", ")?;
      }
      Debug::fmt(int, f)?;
    }
    write!(f, ")")
  }
}

impl Display for m128i {
  /// Display formats each `i32`, and leaves the type name off of the font.
  /// ```
  /// # use safe_arch::*;
  /// let f = format!("{}", m128i::default());
  /// assert_eq!(&f, "(0, 0, 0, 0)");
  /// ```
  fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
    write!(f, "(")?;
    for (i, int) in <[i32; 4]>::from(*self).iter().enumerate() {
      if i != 0 {
        write!(f, ", ")?;
      }
      Display::fmt(int, f)?;
    }
    write!(f, ")")
  }
}

impl Binary for m128i {
  /// Binary formats each `i32`.
  /// ```
  /// # use safe_arch::*;
  /// let f = format!("{:b}", m128i::default());
  /// assert_eq!(&f, "(0, 0, 0, 0)");
  /// ```
  fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
    write!(f, "(")?;
    for (i, int) in <[i32; 4]>::from(*self).iter().enumerate() {
      if i != 0 {
        write!(f, ", ")?;
      }
      Binary::fmt(int, f)?;
    }
    write!(f, ")")
  }
}

impl LowerExp for m128i {
  /// LowerExp formats each `i32`.
  /// ```
  /// # use safe_arch::*;
  /// let f = format!("{:e}", m128i::default());
  /// assert_eq!(&f, "(0e0, 0e0, 0e0, 0e0)");
  /// ```
  fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
    write!(f, "(")?;
    for (i, int) in <[i32; 4]>::from(*self).iter().enumerate() {
      if i != 0 {
        write!(f, ", ")?;
      }
      LowerExp::fmt(int, f)?;
    }
    write!(f, ")")
  }
}

impl UpperExp for m128i {
  /// UpperExp formats each `i32`.
  /// ```
  /// # use safe_arch::*;
  /// let f = format!("{:E}", m128i::default());
  /// assert_eq!(&f, "(0E0, 0E0, 0E0, 0E0)");
  /// ```
  fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
    write!(f, "(")?;
    for (i, int) in <[i32; 4]>::from(*self).iter().enumerate() {
      if i != 0 {
        write!(f, ", ")?;
      }
      UpperExp::fmt(int, f)?;
    }
    write!(f, ")")
  }
}

impl LowerHex for m128i {
  /// LowerHex formats each `i32`.
  /// ```
  /// # use safe_arch::*;
  /// let f = format!("{:x}", m128i::default());
  /// assert_eq!(&f, "(0, 0, 0, 0)");
  /// ```
  fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
    write!(f, "(")?;
    for (i, int) in <[i32; 4]>::from(*self).iter().enumerate() {
      if i != 0 {
        write!(f, ", ")?;
      }
      LowerHex::fmt(int, f)?;
    }
    write!(f, ")")
  }
}

impl UpperHex for m128i {
  /// UpperHex formats each `i32`.
  /// ```
  /// # use safe_arch::*;
  /// let f = format!("{:X}", m128i::default());
  /// assert_eq!(&f, "(0, 0, 0, 0)");
  /// ```
  fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
    write!(f, "(")?;
    for (i, int) in <[i32; 4]>::from(*self).iter().enumerate() {
      if i != 0 {
        write!(f, ", ")?;
      }
      UpperHex::fmt(int, f)?;
    }
    write!(f, ")")
  }
}

impl Octal for m128i {
  /// Octal formats each `i32`.
  /// ```
  /// # use safe_arch::*;
  /// let f = format!("{:o}", m128i::default());
  /// assert_eq!(&f, "(0, 0, 0, 0)");
  /// ```
  fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
    write!(f, "(")?;
    for (i, int) in <[i32; 4]>::from(*self).iter().enumerate() {
      if i != 0 {
        write!(f, ", ")?;
      }
      Octal::fmt(int, f)?;
    }
    write!(f, ")")
  }
}