summaryrefslogtreecommitdiff
path: root/src/size.rs
diff options
context:
space:
mode:
authorLaurenz <laurmaedje@gmail.com>2020-07-29 18:09:51 +0200
committerLaurenz <laurmaedje@gmail.com>2020-07-29 18:09:51 +0200
commitbbcdeb128cce04cd95714b7bc7af5a23a7e38bd2 (patch)
treee0a1620d335982669cd7671cbd71df46d100e9ea /src/size.rs
parentf34ba3dcda182d9b9c14cc94fdb48810bf18bef0 (diff)
Move, rename and switch some things (boring) 🚚
- Problems -> Diagnostics - Position -> Pos - offset_spans -> Offset trait - Size -> Length (and some more size types renamed) - Paper into its own module - scope::Parser -> parsing::CallParser - Create `Decorations` alias - Remove lots of double newlines - Switch from f32 to f64
Diffstat (limited to 'src/size.rs')
-rw-r--r--src/size.rs503
1 files changed, 0 insertions, 503 deletions
diff --git a/src/size.rs b/src/size.rs
deleted file mode 100644
index e97b9248..00000000
--- a/src/size.rs
+++ /dev/null
@@ -1,503 +0,0 @@
-//! Different-dimensional value and spacing types.
-
-use std::fmt::{self, Debug, Display, Formatter};
-use std::iter::Sum;
-use std::ops::*;
-use std::str::FromStr;
-use serde::Serialize;
-
-use crate::layout::prelude::*;
-
-
-/// A general spacing type.
-#[derive(Default, Copy, Clone, PartialEq, PartialOrd, Serialize)]
-#[serde(transparent)]
-pub struct Size {
- /// The size in typographic points (1/72 inches).
- pub points: f32,
-}
-
-impl Size {
- /// The zeroed size.
- pub const ZERO: Size = Size { points: 0.0 };
-
- /// Create a size from an amount of points.
- pub fn pt(points: f32) -> Size { Size { points } }
-
- /// Create a size from an amount of millimeters.
- pub fn mm(mm: f32) -> Size { Size { points: 2.83465 * mm } }
-
- /// Create a size from an amount of centimeters.
- pub fn cm(cm: f32) -> Size { Size { points: 28.3465 * cm } }
-
- /// Create a size from an amount of inches.
- pub fn inches(inches: f32) -> Size { Size { points: 72.0 * inches } }
-
- /// Convert this size into points.
- pub fn to_pt(self) -> f32 { self.points }
-
- /// Convert this size into millimeters.
- pub fn to_mm(self) -> f32 { self.points * 0.352778 }
-
- /// Convert this size into centimeters.
- pub fn to_cm(self) -> f32 { self.points * 0.0352778 }
-
- /// Convert this size into inches.
- pub fn to_inches(self) -> f32 { self.points * 0.0138889 }
-
- /// The maximum of this and the other size.
- pub fn max(self, other: Size) -> Size {
- if self > other { self } else { other }
- }
-
- /// The minimum of this and the other size.
- pub fn min(self, other: Size) -> Size {
- if self <= other { self } else { other }
- }
-
- /// Set this size to the maximum of itself and the other size.
- pub fn max_eq(&mut self, other: Size) { *self = self.max(other); }
-
- /// Set this size to the minimum of itself and the other size.
- pub fn min_eq(&mut self, other: Size) { *self = self.min(other); }
-
- /// The anchor position along the given direction for an item with the given
- /// alignment in a container with this size.
- pub fn anchor(self, alignment: Alignment, direction: Direction) -> Size {
- match (direction.is_positive(), alignment) {
- (true, Origin) | (false, End) => Size::ZERO,
- (_, Center) => self / 2,
- (true, End) | (false, Origin) => self,
- }
- }
-}
-
-impl Display for Size {
- fn fmt(&self, f: &mut Formatter) -> fmt::Result {
- write!(f, "{}pt", self.points)
- }
-}
-
-impl Debug for Size {
- fn fmt(&self, f: &mut Formatter) -> fmt::Result {
- Display::fmt(self, f)
- }
-}
-
-impl Neg for Size {
- type Output = Size;
-
- fn neg(self) -> Size {
- Size { points: -self.points }
- }
-}
-
-impl Sum for Size {
- fn sum<I>(iter: I) -> Size
- where I: Iterator<Item = Size> {
- iter.fold(Size::ZERO, Add::add)
- }
-}
-
-/// Either an absolute size or a factor of some entity.
-#[derive(Copy, Clone, PartialEq)]
-#[allow(missing_docs)]
-pub enum ScaleSize {
- Absolute(Size),
- Scaled(f32),
-}
-
-impl ScaleSize {
- /// Use the absolute value or scale the entity.
- pub fn scaled(&self, entity: Size) -> Size {
- match self {
- ScaleSize::Absolute(s) => *s,
- ScaleSize::Scaled(s) => *s * entity,
- }
- }
-}
-
-impl Display for ScaleSize {
- fn fmt(&self, f: &mut Formatter) -> fmt::Result {
- match self {
- ScaleSize::Absolute(size) => write!(f, "{}", size),
- ScaleSize::Scaled(scale) => write!(f, "{}%", scale * 100.0),
- }
- }
-}
-
-impl Debug for ScaleSize {
- fn fmt(&self, f: &mut Formatter) -> fmt::Result {
- Display::fmt(self, f)
- }
-}
-
-/// A scale size that is scaled by the font size.
-pub type FSize = ScaleSize;
-
-/// A scale size that is scaled by the size of the padded parent container.
-pub type PSize = ScaleSize;
-
-/// A value in two dimensions.
-#[derive(Default, Copy, Clone, Eq, PartialEq, Serialize)]
-pub struct Value2D<T> {
- /// The horizontal component.
- pub x: T,
- /// The vertical component.
- pub y: T,
-}
-
-impl<T: Clone> Value2D<T> {
- /// Create a new 2D-value from two values.
- pub fn new(x: T, y: T) -> Value2D<T> { Value2D { x, y } }
-
- /// Create a new 2D-value with `x` set to a value and `y` to default.
- pub fn with_x(x: T) -> Value2D<T> where T: Default {
- Value2D { x, y: T::default() }
- }
-
- /// Create a new 2D-value with `y` set to a value and `x` to default.
- pub fn with_y(y: T) -> Value2D<T> where T: Default {
- Value2D { x: T::default(), y }
- }
-
- /// Create a new 2D-value with the primary axis set to a value and the other
- /// one to default.
- pub fn with_primary(v: T, axes: LayoutAxes) -> Value2D<T> where T: Default {
- Value2D::with_x(v).generalized(axes)
- }
-
- /// Create a new 2D-value with the secondary axis set to a value and the
- /// other one to default.
- pub fn with_secondary(v: T, axes: LayoutAxes) -> Value2D<T> where T: Default {
- Value2D::with_y(v).generalized(axes)
- }
-
- /// Create a 2D-value with `x` and `y` set to the same value `s`.
- pub fn with_all(s: T) -> Value2D<T> { Value2D { x: s.clone(), y: s } }
-
- /// Get the specificed component.
- pub fn get(self, axis: SpecificAxis) -> T {
- match axis {
- Horizontal => self.x,
- Vertical => self.y,
- }
- }
-
- /// Borrow the specificed component mutably.
- pub fn get_mut(&mut self, axis: SpecificAxis) -> &mut T {
- match axis {
- Horizontal => &mut self.x,
- Vertical => &mut self.y,
- }
- }
-
- /// Return the primary value of this specialized 2D-value.
- pub fn primary(self, axes: LayoutAxes) -> T {
- if axes.primary.axis() == Horizontal { self.x } else { self.y }
- }
-
- /// Borrow the primary value of this specialized 2D-value mutably.
- pub fn primary_mut(&mut self, axes: LayoutAxes) -> &mut T {
- if axes.primary.axis() == Horizontal { &mut self.x } else { &mut self.y }
- }
-
- /// Return the secondary value of this specialized 2D-value.
- pub fn secondary(self, axes: LayoutAxes) -> T {
- if axes.primary.axis() == Horizontal { self.y } else { self.x }
- }
-
- /// Borrow the secondary value of this specialized 2D-value mutably.
- pub fn secondary_mut(&mut self, axes: LayoutAxes) -> &mut T {
- if axes.primary.axis() == Horizontal { &mut self.y } else { &mut self.x }
- }
-
- /// Returns the generalized version of a `Size2D` dependent on the layouting
- /// axes, that is:
- /// - `x` describes the primary axis instead of the horizontal one.
- /// - `y` describes the secondary axis instead of the vertical one.
- pub fn generalized(self, axes: LayoutAxes) -> Value2D<T> {
- match axes.primary.axis() {
- Horizontal => self,
- Vertical => Value2D { x: self.y, y: self.x },
- }
- }
-
- /// Returns the specialized version of this generalized Size2D (inverse to
- /// `generalized`).
- pub fn specialized(self, axes: LayoutAxes) -> Value2D<T> {
- // In fact, generalized is its own inverse. For reasons of clarity
- // at the call site, we still have this second function.
- self.generalized(axes)
- }
-
- /// Swap the `x` and `y` values.
- pub fn swap(&mut self) {
- std::mem::swap(&mut self.x, &mut self.y);
- }
-}
-
-impl<T> Debug for Value2D<T> where T: Debug {
- fn fmt(&self, f: &mut Formatter) -> fmt::Result {
- f.debug_list()
- .entry(&self.x)
- .entry(&self.y)
- .finish()
- }
-}
-
-/// A position or extent in 2-dimensional space.
-pub type Size2D = Value2D<Size>;
-
-impl Size2D {
- /// The zeroed 2D-size.
- pub const ZERO: Size2D = Size2D { x: Size::ZERO, y: Size::ZERO };
-
- /// Whether the given 2D-size fits into this one, that is, both coordinate
- /// values are smaller or equal.
- pub fn fits(self, other: Size2D) -> bool {
- self.x >= other.x && self.y >= other.y
- }
-
- /// Return a 2D-size padded by the paddings of the given box.
- pub fn padded(self, padding: SizeBox) -> Size2D {
- Size2D {
- x: self.x + padding.left + padding.right,
- y: self.y + padding.top + padding.bottom,
- }
- }
-
- /// Return a 2D-size reduced by the paddings of the given box.
- pub fn unpadded(self, padding: SizeBox) -> Size2D {
- Size2D {
- x: self.x - padding.left - padding.right,
- y: self.y - padding.top - padding.bottom,
- }
- }
-
- /// The anchor position along the given axis for an item with the given
- /// alignment in a container with this size.
- ///
- /// This assumes the size to be generalized such that `x` corresponds to the
- /// primary axis.
- pub fn anchor(self, alignment: LayoutAlignment, axes: LayoutAxes) -> Size2D {
- Size2D {
- x: self.x.anchor(alignment.primary, axes.primary),
- y: self.y.anchor(alignment.secondary, axes.secondary),
- }
- }
-}
-
-impl Neg for Size2D {
- type Output = Size2D;
-
- fn neg(self) -> Size2D {
- Size2D {
- x: -self.x,
- y: -self.y,
- }
- }
-}
-
-/// A value that is stretchable in an interval from a minimal through an optimal
-/// to a maximal value.
-#[derive(Debug, Default, Copy, Clone, Eq, PartialEq, Serialize)]
-pub struct StretchValue<T> {
- /// The minimum this value can be stretched to.
- pub min: T,
- /// The optimum for this value.
- pub opt: T,
- /// The maximum this value can be stretched to.
- pub max: T,
-}
-
-impl<T> StretchValue<T> {
- /// Create a new stretch size from minimum, optimal and maximum values.
- pub fn new(min: T, opt: T, max: T) -> StretchValue<T> {
- StretchValue { min, opt, max }
- }
-}
-
-/// A size that is stretchable.
-pub type StretchSize = StretchValue<Size>;
-
-/// A value in four dimensions.
-#[derive(Debug, Default, Copy, Clone, Eq, PartialEq, Serialize)]
-pub struct ValueBox<T> {
- /// The left extent.
- pub left: T,
- /// The top extent.
- pub top: T,
- /// The right extent.
- pub right: T,
- /// The bottom extent.
- pub bottom: T,
-}
-
-impl<T: Clone> ValueBox<T> {
- /// Create a new box from four sizes.
- pub fn new(left: T, top: T, right: T, bottom: T) -> ValueBox<T> {
- ValueBox { left, top, right, bottom }
- }
-
- /// Create a box with all four fields set to the same value `s`.
- pub fn with_all(value: T) -> ValueBox<T> {
- ValueBox {
- left: value.clone(),
- top: value.clone(),
- right: value.clone(),
- bottom: value
- }
- }
-
- /// Get a mutable reference to the value for the specified direction at the
- /// alignment.
- ///
- /// Center alignment is treated the same as origin alignment.
- pub fn get_mut(&mut self, mut direction: Direction, alignment: Alignment) -> &mut T {
- if alignment == End {
- direction = direction.inv();
- }
-
- match direction {
- LeftToRight => &mut self.left,
- RightToLeft => &mut self.right,
- TopToBottom => &mut self.top,
- BottomToTop => &mut self.bottom,
- }
- }
-
- /// Set all values to the given value.
- pub fn set_all(&mut self, value: T) {
- *self = ValueBox::with_all(value);
- }
-
- /// Set the `left` and `right` values.
- pub fn set_horizontal(&mut self, value: T) {
- self.left = value.clone();
- self.right = value;
- }
-
- /// Set the `top` and `bottom` values.
- pub fn set_vertical(&mut self, value: T) {
- self.top = value.clone();
- self.bottom = value;
- }
-}
-
-/// A size in four dimensions.
-pub type SizeBox = ValueBox<Size>;
-
-impl SizeBox {
- /// The zeroed size box.
- pub const ZERO: SizeBox = SizeBox {
- left: Size::ZERO,
- top: Size::ZERO,
- right: Size::ZERO,
- bottom: Size::ZERO,
- };
-}
-
-impl FromStr for Size {
- type Err = ParseSizeError;
-
- fn from_str(src: &str) -> Result<Size, ParseSizeError> {
- let func = match () {
- _ if src.ends_with("pt") => Size::pt,
- _ if src.ends_with("mm") => Size::mm,
- _ if src.ends_with("cm") => Size::cm,
- _ if src.ends_with("in") => Size::inches,
- _ => return Err(ParseSizeError(())),
- };
-
- Ok(func(src[..src.len() - 2]
- .parse::<f32>()
- .map_err(|_| ParseSizeError(()))?))
-
- }
-}
-
-/// An error which can be returned when parsing a size.
-#[derive(Debug, Copy, Clone, Eq, PartialEq)]
-pub struct ParseSizeError(());
-
-impl std::error::Error for ParseSizeError {}
-
-impl Display for ParseSizeError {
- fn fmt(&self, f: &mut Formatter) -> fmt::Result {
- f.write_str("invalid string for size")
- }
-}
-
-macro_rules! implement_traits {
- ($ty:ident, $t:ident, $o:ident
- reflexive {$(
- ($tr:ident($tf:ident), $at:ident($af:ident), [$($f:ident),*])
- )*}
- numbers { $(($w:ident: $($rest:tt)*))* }
- ) => {
- $(impl $tr for $ty {
- type Output = $ty;
- fn $tf($t, $o: $ty) -> $ty {
- $ty { $($f: $tr::$tf($t.$f, $o.$f),)* }
- }
- }
-
- impl $at for $ty {
- fn $af(&mut $t, $o: $ty) { $($at::$af(&mut $t.$f, $o.$f);)* }
- })*
-
- $(implement_traits!(@$w i32, $ty $t $o $($rest)*);)*
- $(implement_traits!(@$w f32, $ty $t $o $($rest)*);)*
- };
-
- (@front $num:ty, $ty:ident $t:ident $o:ident
- $tr:ident($tf:ident),
- [$($f:ident),*]
- ) => {
- impl $tr<$ty> for $num {
- type Output = $ty;
- fn $tf($t, $o: $ty) -> $ty {
- $ty { $($f: $tr::$tf($t as f32, $o.$f),)* }
- }
- }
- };
-
- (@back $num:ty, $ty:ident $t:ident $o:ident
- $tr:ident($tf:ident), $at:ident($af:ident),
- [$($f:ident),*]
- ) => {
- impl $tr<$num> for $ty {
- type Output = $ty;
- fn $tf($t, $o: $num) -> $ty {
- $ty { $($f: $tr::$tf($t.$f, $o as f32),)* }
- }
- }
-
- impl $at<$num> for $ty {
- fn $af(&mut $t, $o: $num) { $($at::$af(&mut $t.$f, $o as f32);)* }
- }
- };
-}
-
-macro_rules! implement_size {
- ($ty:ident($t:ident, $o:ident) [$($f:ident),*]) => {
- implement_traits! {
- $ty, $t, $o
-
- reflexive {
- (Add(add), AddAssign(add_assign), [$($f),*])
- (Sub(sub), SubAssign(sub_assign), [$($f),*])
- }
-
- numbers {
- (front: Mul(mul), [$($f),*])
- (back: Mul(mul), MulAssign(mul_assign), [$($f),*])
- (back: Div(div), DivAssign(div_assign), [$($f),*])
- }
- }
- };
-}
-
-implement_size! { Size(self, other) [points] }
-implement_size! { Size2D(self, other) [x, y] }