rangetype 0.1.1

//! This crate provides a numerical type that automatically performs range
//! checks during all mathematical operations. If a range is violated the code
//! will instantly panic.
//!
//! When using the `range!` macro you'll automatically get compile-time range
//! checks. You'll need to import the `static_assertions` crate to use `range!`.
//!
//! You can also import the `RangeType`, although using the macro is
//! recommended.
//!
//! Example:
//!
//! ```rust
//! #[macro_use]
//! extern crate rangetype;
//! #[macro_use]
//! extern crate static_assertions;
//!
//! use rangetype::RangeType;
//!
//! fn main() {
//!     // A value of 5 that must be between 0 and 128
//!     let x = range!(32, 0..127);
//!     // You can also use floating-point types (and the constructor)
//!     let y = RangeType::new(4.5, 0.1..99.9);
//!     let z = range!(64, 0..127);
//!
//!     // x + z = 96
//!     println!("{}", x + z);
//!     // println!("{}", z + z); // This would panic
//!
//!     // Ranges can be adjusted
//!     let a = x.with_range(0..255);
//!     // And the raw value can be retrieved like so
//!     let b = x.as_raw();
//! }
//! ```
//!
//! The `Mul`, `Div`, `Add`, `Sub`, and `Neg` traits are implemented on the
//! `RangeType` struct.

#[macro_use]
extern crate static_assertions;

#[macro_use]
mod macros;
#[cfg(test)]
mod tests;

use std::fmt::{Debug, Display, Formatter, Error};
use std::ops::{Range, Add, Mul, Neg, Sub, Div};
use std::cmp::Ordering;

/// A range-checked number type.
#[derive(Copy, Clone, PartialEq, Eq)]
pub struct RangeType<T> {
    val: T,
    start: T,
    end: T
}

impl<T: PartialOrd + Display> RangeType<T> {
    /// Create a new RangeType.
    ///
    /// # Arguments:
    /// * `val` - The value for the type.
    /// * `range` - The range between which the value must stay.
    pub fn new(val: T, range: Range<T>) -> RangeType<T> {
        if val < range.start || val > range.end {
            panic!("{} is not in the range {}..{}", val, range.start, range.end);
        }
        RangeType { val: val, start: range.start, end: range.end }
    }

    /// Yield the RangeType's internal value.
    pub fn as_raw(self) -> T {
        self.val
    }

    /// Get the Range.
    pub fn range(self) -> Range<T> {
        self.start..self.end
    }

    /// Convert to a RangeType with a different range.
    ///
    /// # Arguments:
    /// * `range` - The new range.
    pub fn with_range(self, range: Range<T>) -> RangeType<T> {
        RangeType::new(self.val, range)
    }
}

impl<T: Ord> Ord for RangeType<T> {
    fn cmp(&self, other: &RangeType<T>) -> Ordering {
        self.val.cmp(&other.val)
    }
}

impl<T: Ord> PartialOrd for RangeType<T> {
    fn partial_cmp(&self, other: &RangeType<T>) -> Option<Ordering> {
        Some(self.val.cmp(&other.val))
    }
}

impl<T: Debug> Debug for RangeType<T> {
    fn fmt(&self, f: &mut Formatter) -> Result<(), Error> {
        write!(f, "{:?} ", self.val)
    }
}

impl<T: Display> Display for RangeType<T> {
    fn fmt(&self, f: &mut Formatter) -> Result<(), Error> {
        write!(f, "{}", self.val)
    }
}

impl<T: Neg<Output=T> + PartialOrd + Display + Copy> Neg for RangeType<T> {
    type Output = RangeType<T>;

    fn neg(self) -> RangeType<T> {
        RangeType::new(-self.val, self.range())
    }
}

/// Implement a binary operator for RangeType.
macro_rules! impl_range_op {
    ($trait:ident, $method:ident, $op:tt) => {
        impl<T> $trait for RangeType<T>
            where T: $trait<Output=T> + PartialOrd + Display + Copy {
            type Output = RangeType<T>;

            fn $method(self, other: RangeType<T>) -> RangeType<T> {
                if self.range() != other.range() {
                    panic!("Ranges are unequal");
                }
                RangeType::new(self.val $op other.val, self.range())
            }
        }
    }
}

impl_range_op!(Add, add, +);
impl_range_op!(Mul, mul, *);
impl_range_op!(Sub, sub, -);
impl_range_op!(Div, div, /);