1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
use std::{
	fmt,
	ops::{Add, AddAssign, RangeInclusive, Sub, SubAssign},
};

/// General position information of string
///
/// ```
/// # use json_peek::util::Span;
/// let a = Span::new(1, 5);
/// let b = Span::from(1..=5);
///
/// assert_eq!(a, b);
/// ```
///
/// ```
/// # use json_peek::util::Span;
/// let span = Span::new(2, 4);
/// span.trim(1); // Equal to: Span::new(3, 3);
/// ```
#[derive(Clone, Copy, PartialEq, Eq, Default, Hash)]
pub struct Span {
	pub start: usize,
	pub end: usize,
}

impl Span {
	pub const fn new(start: usize, end: usize) -> Span {
		Span { start, end }
	}

	/// Get the range of this Span
	pub const fn range(&self) -> RangeInclusive<usize> {
		self.start..=self.end
	}

	/// Create a point out of the start position of this Span
	pub const fn start_point(&self) -> Span {
		Span {
			start: self.start,
			end: self.start,
		}
	}

	/// Create a point out of the end position of this Span
	pub const fn end_point(&self) -> Span {
		Span {
			start: self.end,
			end: self.end,
		}
	}

	/// Zero-width `Span` is considered to be a point
	pub const fn is_point(&self) -> bool {
		self.start == self.end
	}

	/// Shrink the size of Span by some `offset` from both size
	///
	/// **Does not check for overflow**
	/// ```
	/// # use json_peek::util::Span;
	/// let span = Span::new(2, 4);
	///
	/// assert_eq!(span.trim(1), Span::new(3, 3));
	/// assert_eq!(span.trim(2), Span::new(4, 2));
	/// ```
	///
	/// You can cause integer underflow/overflow with this method if not careful.
	/// ```should_panic
	/// # use json_peek::util::Span;
	/// let span = Span::new(0, 4);
	/// span.trim(5); // <- will panic!!
	/// ```
	pub const fn trim(&self, offset: usize) -> Span {
		Span::new(self.start + offset, self.end - offset)
	}

	/// Create Span from two other Spans
	/// This function will construct the biggest possible Span
	/// 
	/// ```
	/// # use json_peek::util::Span;
	/// let a = Span::new(1, 5);
	/// let b = Span::new(4, 10);
	/// 
	/// assert_eq!(Span::from_span(a, b), Span::new(1, 10));
	/// ```
	pub fn from_span(left: Span, right: Span) -> Span {
		let start = left.start.min(right.start);
		let end = left.end.max(right.end);
		Span::new(start, end)
	}

	/// Span value for testing purpose
	pub const fn test() -> Span {
		Span::new(0, 0)
	}
}

impl Add<usize> for Span {
	type Output = Span;

	fn add(self, rhs: usize) -> Span {
		Span {
			start: self.start,
			end: self.end + rhs,
		}
	}
}

impl Sub<usize> for Span {
	type Output = Span;

	fn sub(self, rhs: usize) -> Span {
		Span {
			start: self.start,
			end: self.end - rhs,
		}
	}
}

impl AddAssign<usize> for Span {
	fn add_assign(&mut self, rhs: usize) {
		self.end += rhs;
	}
}

impl SubAssign<usize> for Span {
	fn sub_assign(&mut self, rhs: usize) {
		self.end -= rhs;
	}
}

impl Add<Span> for Span {
	type Output = Span;

	fn add(self, rhs: Span) -> Span {
		Span {
			start: self.start + rhs.start,
			end: self.end + rhs.end,
		}
	}
}

impl Sub<Span> for Span {
	type Output = Span;

	fn sub(self, rhs: Span) -> Span {
		Span {
			start: self.start - rhs.start,
			end: self.end - rhs.end,
		}
	}
}

impl AddAssign<Span> for Span {
	fn add_assign(&mut self, rhs: Span) {
		self.start += rhs.start;
		self.end += rhs.end;
	}
}

impl fmt::Debug for Span {
	fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
		write!(f, "{}..{}", self.start, self.end)
	}
}

impl fmt::Display for Span {
	fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
		write!(f, "{}..{}", self.start, self.end)
	}
}

impl From<RangeInclusive<usize>> for Span {
	fn from(range: RangeInclusive<usize>) -> Span {
		Span::new(*range.start(), *range.end())
	}
}

#[cfg(test)]
mod tests {
	use super::*;

	#[test]
	fn get_range() {
		assert_eq!(Span::new(3, 9).range(), 3..=9);
	}

	#[test]
	fn add_usize() {
		assert_eq!(Span::new(3, 9) + 1, Span { start: 3, end: 10 });
	}

	#[test]
	fn sub_usize() {
		assert_eq!(Span::new(0, 10) - 10, Span { start: 0, end: 0 });
	}

	#[test]
	fn add_span() {
		assert_eq!(
			Span::new(0, 9) + Span::new(5, 8),
			Span { start: 5, end: 17 }
		);
	}

	#[test]
	fn sub_span() {
		assert_eq!(
			Span::new(5, 10) - Span::new(3, 4),
			Span { start: 2, end: 6 }
		);
	}
}