maligned 0.2.1

use core::mem::size_of;
#[cfg(test)]
use core::mem::{align_of, size_of_val};

mod sealed_traits {
  pub trait SealedAlignment {}

  pub trait SealedAsBytes {}

  pub trait SealedAsBytesMut: SealedAsBytes {}
}

/// Marker trait used for bounds.
/// All structs that implement this trait have their size and alignment equal.
pub trait Alignment: sealed_traits::SealedAlignment + Sized + Clone + Default + Send + Sync {}

/// Trait that allows reinterpretation of a struct as bytes. This is unsafe since the
/// returned slice must always have a length equal to the size of the struct and because
/// every bit pattern within the structs size must be valid.
#[allow(unsafe_code)]
pub unsafe trait AsBytes: sealed_traits::SealedAsBytes + Sized {
  /// Turn a reference to self to a byte slice.
  #[must_use]
  fn as_bytes(&self) -> &[u8];
}

/// Trait that allows reinterpretation of a mutable struct as mutable bytes. This is unsafe since the
/// returned slice must always have a length equal to the size of the struct and because
/// every bit pattern within the structs size must be valid.
#[allow(unsafe_code)]
pub unsafe trait AsBytesMut: sealed_traits::SealedAsBytesMut + AsBytes {
  /// Turn a mutable reference to self to a mutable byte slice.
  #[must_use]
  fn as_bytes_mut(&mut self) -> &mut [u8];
}

/// Representation of failure to convert from a byte slice to some alignment type.
#[derive(Debug)]
pub struct FromByteSliceError {
  actual_len: usize,
  expected_len: usize,
}

impl FromByteSliceError {
  #[must_use]
  /// Returns the length of the slice that failed to convert to an alignment type.
  pub fn actual_len(&self) -> usize {
    self.actual_len
  }
  #[must_use]
  /// Returns the length that the alignment type expected the slice to be when converting.
  pub fn expected_len(&self) -> usize {
    self.expected_len
  }
}

impl core::fmt::Display for FromByteSliceError {
  fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
    write!(
      f,
      "Invalid length. Expected slice of length {} got {}",
      self.expected_len, self.actual_len
    )
  }
}

macro_rules! doc_comment {
    ($x:expr, $($tt:tt)*) => {
        #[doc = $x]
        $($tt)*
    };
}

macro_rules! impl_alignment_traits {
  {
    $(#[$outer:meta])*
    $v:vis struct $t:ident or $bit:ident $(or $k_alias:ident)?(pub [u8; $c:literal]);
    test = $test:ident
  }
    => {
    doc_comment! {
      concat!(
        "Struct representing an alignment of ",
        stringify!($c),
        "\n\n",
        "This implements the [Alignment](Alignment) trait and can also be used as a byte buffer\n",
        "of `[u8; ", stringify!($c), "]`. Since `AsBytes` is implemented for a `&[T: AsBytes]` a `&[A", stringify!($c), "]`\n",
        "can be used as a buffer of bytes that will always be aligned to at least ", stringify!($c), " bytes.\n\n",
        "Also aliased by [", stringify!($bit), "](", stringify!($bit), ")", $(" and [", stringify!($k_alias), "](", stringify!($k_alias), ")",)? "\n\n",
      ),
      $(#[$outer])*
      #[repr(align($c))]
      $v struct $t(pub [u8; $c]);
    }
    impl sealed_traits::SealedAlignment for $t {}
    impl Alignment for $t {}
    doc_comment! {
      concat!("Type alias for [", stringify!($t), "](", stringify!($t), ") in bits"),
      pub type $bit = $t;
    }
    $(
      doc_comment! {
        concat!("Type alias for [", stringify!($t), "](struct.", stringify!($t), ".html) in kilobytes"),
        pub type $k_alias = $t;
      }
    )?
    // Not a trait since const generics aren't stable yet
    #[doc(hidden)]
    impl $t {
      #[must_use]
      pub fn as_array(&self) -> &[u8; size_of::<Self>()] {
        &self.0
      }
      #[must_use]
      pub fn as_array_mut(&mut self) -> &mut [u8; size_of::<Self>()] {
        &mut self.0
      }
      #[must_use]
      pub fn into_array(self) -> [u8; size_of::<Self>()] {
        self.0
      }
    }
    impl sealed_traits::SealedAsBytes for $t {}
    #[allow(unsafe_code)]
    unsafe impl AsBytes for $t {
      #[inline]
      #[must_use]
      fn as_bytes(&self) -> &[u8] {
        unsafe { core::slice::from_raw_parts(&self.0 as *const [u8; size_of::<Self>()] as *const u8, size_of::<Self>()) }
      }
    }
    impl sealed_traits::SealedAsBytesMut for $t {}
    #[allow(unsafe_code)]
    unsafe impl AsBytesMut for $t {
      #[inline]
      #[must_use]
      fn as_bytes_mut(&mut self) -> &mut [u8] {
        unsafe { core::slice::from_raw_parts_mut(&mut self.0 as *mut [u8; size_of::<Self>()] as *mut u8, size_of::<Self>()) }
      }
    }
    impl Default for $t {
      fn default() -> Self {
        Self([0; size_of::<Self>()])
      }
    }
    // Allow this so that some types can be copy and
    // this implentation should be what is already generated
    #[allow(clippy::expl_impl_clone_on_copy)]
    impl Clone for $t {
      fn clone(&self) -> Self {
        let mut clone = Self::default();
        #[allow(unsafe_code)]
        unsafe {core::ptr::copy_nonoverlapping(self.as_bytes().as_ptr(), clone.as_bytes_mut().as_mut_ptr(), $c)}
        clone
      }
    }
    impl core::ops::Deref for $t {
      type Target = [u8];
      fn deref(&self) -> &Self::Target {
        self.as_bytes()
      }
    }
    impl core::ops::DerefMut for $t {
      fn deref_mut(&mut self) -> &mut Self::Target {
        self.as_bytes_mut()
      }
    }
    impl From<[u8; size_of::<$t>()]> for $t {
      fn from(a: [u8; size_of::<Self>()]) -> Self {
        Self(a)
      }
    }
    impl core::convert::TryFrom<&[u8]> for $t {
      type Error = FromByteSliceError;
      fn try_from(v: &[u8]) -> Result<Self, Self::Error> {
        if v.len() == $c {
          let mut s = Self::default();
          v.iter().zip(s.as_bytes_mut()).for_each(|(v, s)| *s = *v);
          Ok(s)
        } else {
          Err(FromByteSliceError {
            actual_len: v.len(),
            expected_len: $c,
          })
        }
      }
    }
    impl AsRef<[u8]> for $t {
      fn as_ref(&self) -> &[u8] {
        self.as_bytes()
      }
    }
    impl AsMut<[u8]> for $t {
      fn as_mut(&mut self) -> &mut [u8] {
        self.as_bytes_mut()
      }
    }
    impl Ord for $t {
      fn cmp(&self, other: &Self) -> core::cmp::Ordering {
        self.as_bytes()
          .iter()
          .zip(other.as_bytes())
          .filter_map(|(l, r)| {
            let cmp = l.cmp(r);
            if let core::cmp::Ordering::Equal = cmp {
              None
            } else {
              Some(cmp)
            }
          })
          .next()
          .unwrap_or(core::cmp::Ordering::Equal)
      }
    }
    impl PartialOrd for $t {
      fn partial_cmp(&self, other: &Self) -> Option<core::cmp::Ordering> {
        self.as_bytes()
          .iter()
          .zip(other.as_bytes())
          .filter_map(|(l, r)|{
            let cmp = l.partial_cmp(r);
            if let Some(core::cmp::Ordering::Equal) = cmp {
              None
            } else {
              cmp
            }
          })
          .next()
          .or(Some(core::cmp::Ordering::Equal))
      }
    }
    impl Eq for $t {}
    impl PartialEq for $t {
      fn eq(&self, other: &Self) -> bool {
        self.as_bytes().iter().zip(other.as_bytes()).all(|(l, r)| l == r)
      }
    }
    impl core::hash::Hash for $t {
      fn hash<H: core::hash::Hasher>(&self, state: &mut H) {
        self.as_bytes().hash(state)
      }
    }
    impl core::fmt::Debug for $t {
      fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
        f.debug_tuple(stringify!($t)).field(&self.as_bytes()).finish()
      }
    }
    #[cfg(test)]
    mod $test {
      #[test]
      fn $test() {
        use super::*;
        use std::convert::TryFrom;
        use std::collections::hash_map::DefaultHasher;
        use std::hash::{Hash, Hasher};
        use alloc::string::ToString;
        assert_eq!(align_of::<$t>(), $c);
        assert_eq!(size_of::<$t>(), $c);
        assert_eq!(align_of::<$t>(), size_of::<$t>());
        assert_eq!(size_of_val(&*<$t>::default()), size_of::<$t>());
        assert_eq!(align_of::<$t>(), size_of::<$bit>());
        assert_eq!(size_of::<$t>(), size_of::<$bit>());
        assert_eq!(size_of_val(&*<$t>::default()), size_of_val(&*<$bit>::default()));
        assert_eq!(<$t>::default().as_bytes().len(), $c);
        assert_eq!(<$t>::default().as_bytes_mut().len(), $c);
        let vec_length = 17;
        let mut v = vec![<$t>::default(); vec_length];
        assert_eq!(v.len(), vec_length);
        let mut v_ref: &mut [$t] = &mut v;
        assert_eq!(v_ref.as_bytes().len(), $c * vec_length);
        assert_eq!(v_ref.as_bytes_mut().len(), $c * vec_length);
        let v_big = vec![42_u8; 18];
        let v = (0_usize..$c).map(|i|i as u8).collect::<std::vec::Vec<_>>();
        // test TryFrom impl
        let a = $t::try_from(&v[..]).expect("TryFrom should work for a slice of the same length");
        let err = $t::try_from(&v_big[..]).unwrap_err();
        assert_eq!(err.expected_len(), $c);
        assert_eq!(err.actual_len(), 18);
        // test Clone impl
        let mut clone = a.clone();
        assert_eq!(&*a, &*clone);
        assert_eq!(a, clone);
        let mut hasher = DefaultHasher::new();
        a.hash(&mut hasher);
        let a_hash = hasher.finish();
        hasher = DefaultHasher::new();
        clone.hash(&mut hasher);
        assert_eq!(a_hash, hasher.finish());

        clone.as_bytes_mut()[3.min($c - 1)] = 42;
        assert!(a < clone);
        hasher = DefaultHasher::new();
        clone.hash(&mut hasher);
        assert_ne!(a_hash, hasher.finish());
        // Ensure proper names
        let x: usize = $c;
        assert!(stringify!($t).ends_with(&x.to_string()));
      }
    }
  };
}

impl_alignment_traits! {
  #[derive(Copy)]
  pub struct A2 or Bit16(pub [u8; 2]);
  test = test_a2
}

impl_alignment_traits! {
  #[derive(Copy)]
  pub struct A4 or Bit32(pub [u8; 4]);
  test = test_a4
}

impl_alignment_traits! {
  #[derive(Copy)]
  pub struct A8 or Bit64(pub [u8; 8]);
  test = test_a8
}

impl_alignment_traits! {
  #[derive(Copy)]
  pub struct A16 or Bit128(pub [u8; 16]);
  test = test_a16
}

impl_alignment_traits! {
  #[derive(Copy)]
  pub struct A32 or Bit256(pub [u8; 32]);
  test = test_a32
}

impl_alignment_traits! {
  pub struct A64 or Bit512(pub [u8; 64]);
  test = test_a64
}

impl_alignment_traits! {
  pub struct A128 or Bit1024(pub [u8; 128]);
  test = test_a128
}

impl_alignment_traits! {
  pub struct A256 or Bit2048(pub [u8; 256]);
  test = test_a256
}

impl_alignment_traits! {
  pub struct A512 or Bit4096(pub [u8; 512]);
  test = test_a512
}

#[cfg(feature = "align-1k")]
impl_alignment_traits! {
  /// Requires feature `align-1k`
  pub struct A1024 or Bit8192 or A1k(pub [u8; 1024]);
  test = test_a1024
}

#[cfg(feature = "align-2k")]
impl_alignment_traits! {
  /// Requires feature `align-2k`
  pub struct A2048 or Bit16384 or A2k(pub [u8; 2048]);
  test = test_a2048
}

#[cfg(feature = "align-4k")]
impl_alignment_traits! {
  /// Requires feature `align-4k`
  pub struct A4096 or Bit32768 or A4k(pub [u8; 4096]);
  test = test_a4096
}

#[cfg(feature = "align-8k")]
impl_alignment_traits! {
  /// Requires feature `align-8k`
  pub struct A8192 or Bit65536 or A8k(pub [u8; 8192]);
  test = test_a8192
}

#[cfg(feature = "align-16k")]
impl_alignment_traits! {
  /// Requires feature `align-16k`
  pub struct A16384 or Bit131072 or A16k(pub [u8; 16384]);
  test = test_a16384
}

#[cfg(feature = "align-32k")]
impl_alignment_traits! {
  /// Requires feature `align-32k`
  pub struct A32768 or Bit262144 or A32k(pub [u8; 32768]);
  test = test_a32768
}

#[cfg(feature = "align-64k")]
impl_alignment_traits! {
  /// Requires feature `align-64k`
  pub struct A65536 or Bit524288 or A64k(pub [u8; 65536]);
  test = test_a65536
}

#[cfg(feature = "align-128k")]
impl_alignment_traits! {
  /// Requires feature `align-128k`
  pub struct A131072 or Bit1048576 or A128K(pub [u8; 131_072]);
  test = test_a131072
}

/// Wrapper type that aligns `T` to at least `Alignment`
/// It adds no size to the layout of the struct if the size is a multiple of the alignment,
/// otherwise the size is rounded up to the next multiple of the alignment
/// ```
/// # use maligned::*;
/// # use std::mem::*;
/// assert_eq!(size_of::<Aligned<A16, u8>>(), size_of::<A16>());
/// assert_eq!(size_of::<Aligned<A256, [u8; 256]>>(), size_of::<[u8; 256]>());
/// assert_eq!(size_of::<Aligned<A512, [u8; 81920]>>(), size_of::<[u8; 81920]>());
/// ```
#[derive(Clone, Copy, Default, Debug, Ord, PartialOrd, Eq, PartialEq, Hash)]
pub struct Aligned<A: Alignment, T> {
  _alignment: [A; 0],
  t: T,
}

impl<A: Alignment, T> Aligned<A, T> {
  /// Creates a new instance of Aligned
  pub fn new(t: T) -> Self {
    Self { _alignment: [], t }
  }
  /// Consumes Aligned and returns the wrapped value
  pub fn into_inner(self) -> T {
    self.t
  }
}

/// Convenience function for creating a new Aligned
/// Because of the current interaction between generics and impl arguments
/// the function requires both types to be given, though the second one can
/// be given the default `_`
/// To align a byte array to a 256 bit boundary
/// ```
/// # use maligned::*;
/// let a = aligned::<Bit256, _>([0_u8; 1024]);
/// assert_eq!(&a[0] as *const u8 as usize % std::mem::align_of::<Bit256>(), 0);
/// ```
pub fn aligned<A: Alignment, T>(t: T) -> Aligned<A, T> {
  Aligned::new(t)
}

impl<A: Alignment, T> core::ops::Deref for Aligned<A, T> {
  type Target = T;

  fn deref(&self) -> &Self::Target {
    &self.t
  }
}

impl<A: Alignment, T> core::ops::DerefMut for Aligned<A, T> {
  fn deref_mut(&mut self) -> &mut Self::Target {
    &mut self.t
  }
}

impl<A: Alignment, T> From<T> for Aligned<A, T> {
  fn from(t: T) -> Self {
    Self::new(t)
  }
}

impl<A: Alignment, T> AsRef<T> for Aligned<A, T> {
  fn as_ref(&self) -> &T {
    &self.t
  }
}

impl<A: Alignment, T> AsMut<T> for Aligned<A, T> {
  fn as_mut(&mut self) -> &mut T {
    &mut self.t
  }
}

//TODO: Figure out a more generic implementation of this
impl<T: AsBytes> sealed_traits::SealedAsBytes for &[T] {}
#[allow(unsafe_code)]
unsafe impl<T: AsBytes> AsBytes for &[T] {
  fn as_bytes(&self) -> &[u8] {
    unsafe { core::slice::from_raw_parts(self.as_ptr() as *const T as *const u8, self.len() * size_of::<T>()) }
  }
}

impl<T: AsBytes> sealed_traits::SealedAsBytes for &mut [T] {}
#[allow(unsafe_code)]
unsafe impl<T: AsBytes> AsBytes for &mut [T] {
  fn as_bytes(&self) -> &[u8] {
    unsafe { core::slice::from_raw_parts(self.as_ptr() as *const T as *const u8, self.len() * size_of::<T>()) }
  }
}

impl<T: AsBytesMut> sealed_traits::SealedAsBytesMut for &mut [T] {}
#[allow(unsafe_code)]
unsafe impl<T: AsBytesMut> AsBytesMut for &mut [T] {
  fn as_bytes_mut(&mut self) -> &mut [u8] {
    unsafe { core::slice::from_raw_parts_mut(self.as_mut_ptr() as *mut T as *mut u8, self.len() * size_of::<T>()) }
  }
}

#[cfg(feature = "alloc")]
impl<T: AsBytes> sealed_traits::SealedAsBytes for alloc::vec::Vec<T> {}

#[cfg(feature = "alloc")]
#[allow(unsafe_code)]
unsafe impl<T: AsBytes> AsBytes for alloc::vec::Vec<T> {
  fn as_bytes(&self) -> &[u8] {
    unsafe { core::slice::from_raw_parts(self.as_ptr() as *const T as *const u8, self.len() * size_of::<T>()) }
  }
}

#[cfg(feature = "alloc")]
impl<T: AsBytesMut> sealed_traits::SealedAsBytesMut for alloc::vec::Vec<T> {}

#[cfg(feature = "alloc")]
#[allow(unsafe_code)]
unsafe impl<T: AsBytesMut> AsBytesMut for alloc::vec::Vec<T> {
  fn as_bytes_mut(&mut self) -> &mut [u8] {
    unsafe { core::slice::from_raw_parts_mut(self.as_mut_ptr() as *mut T as *mut u8, self.len() * size_of::<T>()) }
  }
}