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 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551
// pest. The Elegant Parser
// Copyright (c) 2018 DragoČ™ Tiselice
//
// Licensed under the Apache License, Version 2.0
// <LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0> or the MIT
// license <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. All files in the project carrying such notice may not be copied,
// modified, or distributed except according to those terms.
use core::fmt;
use core::hash::{Hash, Hasher};
use core::ops::{Bound, RangeBounds};
use core::ptr;
use core::str;
use crate::position;
/// A span over a `&str`. It is created from either [two `Position`s] or from a [`Pair`].
///
/// [two `Position`s]: struct.Position.html#method.span
/// [`Pair`]: ../iterators/struct.Pair.html#method.span
#[derive(Clone, Copy)]
pub struct Span<'i> {
input: &'i str,
start: usize,
end: usize,
}
impl<'i> Span<'i> {
/// Create a new `Span` without checking invariants. (Checked with `debug_assertions`.)
pub(crate) fn new_internal(input: &str, start: usize, end: usize) -> Span<'_> {
debug_assert!(input.get(start..end).is_some());
Span { input, start, end }
}
/// Attempts to create a new span. Will return `None` if `input[start..end]` is an invalid index
/// into `input`.
///
/// # Examples
///
/// ```
/// # use pest::Span;
/// let input = "Hello!";
/// assert_eq!(None, Span::new(input, 100, 0));
/// assert!(Span::new(input, 0, input.len()).is_some());
/// ```
pub fn new(input: &str, start: usize, end: usize) -> Option<Span<'_>> {
if input.get(start..end).is_some() {
Some(Span { input, start, end })
} else {
None
}
}
/// Attempts to create a new span based on a sub-range.
///
/// ```
/// use pest::Span;
/// let input = "Hello World!";
/// let world = Span::new(input, 6, input.len()).unwrap();
/// let orl = world.get(1..=3);
/// assert!(orl.is_some());
/// assert_eq!(orl.unwrap().as_str(), "orl");
/// ```
///
/// # Examples
pub fn get(&self, range: impl RangeBounds<usize>) -> Option<Span<'i>> {
let start = match range.start_bound() {
Bound::Included(offset) => *offset,
Bound::Excluded(offset) => *offset + 1,
Bound::Unbounded => 0,
};
let end = match range.end_bound() {
Bound::Included(offset) => *offset + 1,
Bound::Excluded(offset) => *offset,
Bound::Unbounded => self.as_str().len(),
};
self.as_str().get(start..end).map(|_| Span {
input: self.input,
start: self.start + start,
end: self.start + end,
})
}
/// Returns the `Span`'s start byte position as a `usize`.
///
/// # Examples
///
/// ```
/// # use pest::Position;
/// let input = "ab";
/// let start = Position::from_start(input);
/// let end = start.clone();
/// let span = start.span(&end);
///
/// assert_eq!(span.start(), 0);
/// ```
#[inline]
pub fn start(&self) -> usize {
self.start
}
/// Returns the `Span`'s end byte position as a `usize`.
///
/// # Examples
///
/// ```
/// # use pest::Position;
/// let input = "ab";
/// let start = Position::from_start(input);
/// let end = start.clone();
/// let span = start.span(&end);
///
/// assert_eq!(span.end(), 0);
/// ```
#[inline]
pub fn end(&self) -> usize {
self.end
}
/// Returns the `Span`'s start `Position`.
///
/// # Examples
///
/// ```
/// # use pest::Position;
/// let input = "ab";
/// let start = Position::from_start(input);
/// let end = start.clone();
/// let span = start.clone().span(&end);
///
/// assert_eq!(span.start_pos(), start);
/// ```
#[inline]
pub fn start_pos(&self) -> position::Position<'i> {
position::Position::new_internal(self.input, self.start)
}
/// Returns the `Span`'s end `Position`.
///
/// # Examples
///
/// ```
/// # use pest::Position;
/// let input = "ab";
/// let start = Position::from_start(input);
/// let end = start.clone();
/// let span = start.span(&end);
///
/// assert_eq!(span.end_pos(), end);
/// ```
#[inline]
pub fn end_pos(&self) -> position::Position<'i> {
position::Position::new_internal(self.input, self.end)
}
/// Splits the `Span` into a pair of `Position`s.
///
/// # Examples
///
/// ```
/// # use pest::Position;
/// let input = "ab";
/// let start = Position::from_start(input);
/// let end = start.clone();
/// let span = start.clone().span(&end);
///
/// assert_eq!(span.split(), (start, end));
/// ```
#[inline]
pub fn split(self) -> (position::Position<'i>, position::Position<'i>) {
let pos1 = position::Position::new_internal(self.input, self.start);
let pos2 = position::Position::new_internal(self.input, self.end);
(pos1, pos2)
}
/// Captures a slice from the `&str` defined by the `Span`.
///
/// # Examples
///
/// ```
/// # use pest;
/// # #[allow(non_camel_case_types)]
/// # #[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
/// enum Rule {}
///
/// let input = "abc";
/// let mut state: Box<pest::ParserState<'_, Rule>> = pest::ParserState::new(input).skip(1).unwrap();
/// let start_pos = state.position().clone();
/// state = state.match_string("b").unwrap();
/// let span = start_pos.span(&state.position().clone());
/// assert_eq!(span.as_str(), "b");
/// ```
#[inline]
pub fn as_str(&self) -> &'i str {
// Span's start and end positions are always a UTF-8 borders.
&self.input[self.start..self.end]
}
/// Returns the input string of the `Span`.
///
/// This function returns the input string of the `Span` as a `&str`. This is the source string
/// from which the `Span` was created. The returned `&str` can be used to examine the contents of
/// the `Span` or to perform further processing on the string.
///
/// # Examples
///
/// ```
/// # use pest;
/// # use pest::Span;
///
/// // Example: Get input string from a span
/// let input = "abc\ndef\nghi";
/// let span = Span::new(input, 1, 7).unwrap();
/// assert_eq!(span.get_input(), input);
/// ```
pub fn get_input(&self) -> &'i str {
self.input
}
/// Iterates over all lines (partially) covered by this span. Yielding a `&str` for each line.
///
/// # Examples
///
/// ```
/// # use pest;
/// # #[allow(non_camel_case_types)]
/// # #[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
/// enum Rule {}
///
/// let input = "a\nb\nc";
/// let mut state: Box<pest::ParserState<'_, Rule>> = pest::ParserState::new(input).skip(2).unwrap();
/// let start_pos = state.position().clone();
/// state = state.match_string("b\nc").unwrap();
/// let span = start_pos.span(&state.position().clone());
/// assert_eq!(span.lines().collect::<Vec<_>>(), vec!["b\n", "c"]);
/// ```
#[inline]
pub fn lines(&self) -> Lines<'_> {
Lines {
inner: self.lines_span(),
}
}
/// Iterates over all lines (partially) covered by this span. Yielding a `Span` for each line.
///
/// # Examples
///
/// ```
/// # use pest;
/// # use pest::Span;
/// # #[allow(non_camel_case_types)]
/// # #[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
/// enum Rule {}
///
/// let input = "a\nb\nc";
/// let mut state: Box<pest::ParserState<'_, Rule>> = pest::ParserState::new(input).skip(2).unwrap();
/// let start_pos = state.position().clone();
/// state = state.match_string("b\nc").unwrap();
/// let span = start_pos.span(&state.position().clone());
/// assert_eq!(span.lines_span().collect::<Vec<_>>(), vec![Span::new(input, 2, 4).unwrap(), Span::new(input, 4, 5).unwrap()]);
/// ```
pub fn lines_span(&self) -> LinesSpan<'_> {
LinesSpan {
span: self,
pos: self.start,
}
}
}
impl<'i> fmt::Debug for Span<'i> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("Span")
.field("str", &self.as_str())
.field("start", &self.start)
.field("end", &self.end)
.finish()
}
}
impl<'i> PartialEq for Span<'i> {
fn eq(&self, other: &Span<'i>) -> bool {
ptr::eq(self.input, other.input) && self.start == other.start && self.end == other.end
}
}
impl<'i> Eq for Span<'i> {}
impl<'i> Hash for Span<'i> {
fn hash<H: Hasher>(&self, state: &mut H) {
(self.input as *const str).hash(state);
self.start.hash(state);
self.end.hash(state);
}
}
/// Merges two spans into one.
///
/// This function merges two spans that are contiguous or overlapping into a single span
/// that covers the entire range of the two input spans. This is useful when you want to
/// aggregate information from multiple spans into a single entity.
///
/// The function checks if the input spans are overlapping or contiguous by comparing their
/// start and end positions. If they are, a new span is created with the minimum start position
/// and the maximum end position of the two input spans.
///
/// If the input spans are neither overlapping nor contiguous, the function returns None,
/// indicating that a merge operation was not possible.
///
/// # Examples
///
/// ```
/// # use pest;
/// # use pest::Span;
/// # use pest::merge_spans;
///
/// // Example 1: Contiguous spans
/// let input = "abc\ndef\nghi";
/// let span1 = Span::new(input, 1, 7).unwrap();
/// let span2 = Span::new(input, 7, 11).unwrap();
/// let merged = merge_spans(&span1, &span2).unwrap();
/// assert_eq!(merged, Span::new(input, 1, 11).unwrap());
///
/// // Example 2: Overlapping spans
/// let input = "abc\ndef\nghi";
/// let span1 = Span::new(input, 1, 7).unwrap();
/// let span2 = Span::new(input, 5, 11).unwrap();
/// let merged = merge_spans(&span1, &span2).unwrap();
/// assert_eq!(merged, Span::new(input, 1, 11).unwrap());
///
/// // Example 3: Non-contiguous spans
/// let input = "abc\ndef\nghi";
/// let span1 = Span::new(input, 1, 7).unwrap();
/// let span2 = Span::new(input, 8, 11).unwrap();
/// let merged = merge_spans(&span1, &span2);
/// assert!(merged.is_none());
/// ```
pub fn merge_spans<'i>(a: &Span<'i>, b: &Span<'i>) -> Option<Span<'i>> {
if a.end() >= b.start() && a.start() <= b.end() {
// The spans overlap or are contiguous, so they can be merged.
Span::new(
a.get_input(),
core::cmp::min(a.start(), b.start()),
core::cmp::max(a.end(), b.end()),
)
} else {
// The spans don't overlap and aren't contiguous, so they can't be merged.
None
}
}
/// Line iterator for Spans, created by [`Span::lines_span()`].
///
/// Iterates all lines that are at least _partially_ covered by the span. Yielding a `Span` for each.
///
/// [`Span::lines_span()`]: struct.Span.html#method.lines_span
pub struct LinesSpan<'i> {
span: &'i Span<'i>,
pos: usize,
}
impl<'i> Iterator for LinesSpan<'i> {
type Item = Span<'i>;
fn next(&mut self) -> Option<Self::Item> {
if self.pos > self.span.end {
return None;
}
let pos = position::Position::new(self.span.input, self.pos)?;
if pos.at_end() {
return None;
}
let line_start = pos.find_line_start();
self.pos = pos.find_line_end();
Span::new(self.span.input, line_start, self.pos)
}
}
/// Line iterator for Spans, created by [`Span::lines()`].
///
/// Iterates all lines that are at least _partially_ covered by the span. Yielding a `&str` for each.
///
/// [`Span::lines()`]: struct.Span.html#method.lines
pub struct Lines<'i> {
inner: LinesSpan<'i>,
}
impl<'i> Iterator for Lines<'i> {
type Item = &'i str;
fn next(&mut self) -> Option<Self::Item> {
self.inner.next().map(|span| span.as_str())
}
}
#[cfg(test)]
mod tests {
use super::*;
use alloc::borrow::ToOwned;
use alloc::vec::Vec;
#[test]
fn get() {
let input = "abc123abc";
let span = Span::new(input, 3, input.len()).unwrap();
assert_eq!(span.as_str(), "123abc");
assert_eq!(span.input, input);
let span1 = span.get(..=2);
assert!(span1.is_some());
assert_eq!(span1.unwrap().input, input);
assert_eq!(span1.unwrap().as_str(), "123");
let span2 = span.get(..);
assert!(span2.is_some());
assert_eq!(span2.unwrap().input, input);
assert_eq!(span2.unwrap().as_str(), "123abc");
let span3 = span.get(3..);
assert!(span3.is_some());
assert_eq!(span3.unwrap().input, input);
assert_eq!(span3.unwrap().as_str(), "abc");
let span4 = span.get(0..0);
assert!(span4.is_some());
assert_eq!(span4.unwrap().input, input);
assert_eq!(span4.unwrap().as_str(), "");
}
#[test]
fn get_fails() {
let input = "abc";
let span = Span::new(input, 0, input.len()).unwrap();
let span1 = span.get(0..100);
assert!(span1.is_none());
let span2 = span.get(100..200);
assert!(span2.is_none());
}
#[test]
fn span_comp() {
let input = "abc\ndef\nghi";
let span = Span::new(input, 1, 7).unwrap();
let span2 = Span::new(input, 50, 51);
assert!(span2.is_none());
let span3 = Span::new(input, 0, 8).unwrap();
assert!(span != span3);
}
#[test]
fn split() {
let input = "a";
let start = position::Position::from_start(input);
let mut end = start;
assert!(end.skip(1));
let span = start.clone().span(&end.clone());
assert_eq!(span.split(), (start, end));
}
#[test]
fn lines_mid() {
let input = "abc\ndef\nghi";
let span = Span::new(input, 1, 7).unwrap();
let lines: Vec<_> = span.lines().collect();
let lines_span: Vec<_> = span.lines_span().map(|span| span.as_str()).collect();
assert_eq!(lines.len(), 2);
assert_eq!(lines[0], "abc\n".to_owned());
assert_eq!(lines[1], "def\n".to_owned());
assert_eq!(lines, lines_span) // Verify parity with lines_span()
}
#[test]
fn lines_eof() {
let input = "abc\ndef\nghi";
let span = Span::new(input, 5, 11).unwrap();
assert!(span.end_pos().at_end());
assert_eq!(span.end(), 11);
let lines: Vec<_> = span.lines().collect();
let lines_span: Vec<_> = span.lines_span().map(|span| span.as_str()).collect();
assert_eq!(lines.len(), 2);
assert_eq!(lines[0], "def\n".to_owned());
assert_eq!(lines[1], "ghi".to_owned());
assert_eq!(lines, lines_span) // Verify parity with lines_span()
}
#[test]
fn lines_span() {
let input = "abc\ndef\nghi";
let span = Span::new(input, 1, 7).unwrap();
let lines_span: Vec<_> = span.lines_span().collect();
let lines: Vec<_> = span.lines().collect();
assert_eq!(lines_span.len(), 2);
assert_eq!(lines_span[0], Span::new(input, 0, 4).unwrap());
assert_eq!(lines_span[1], Span::new(input, 4, 8).unwrap());
assert_eq!(
lines_span
.iter()
.map(|span| span.as_str())
.collect::<Vec<_>>(),
lines
);
}
#[test]
fn get_input_of_span() {
let input = "abc\ndef\nghi";
let span = Span::new(input, 1, 7).unwrap();
assert_eq!(span.get_input(), input);
}
#[test]
fn merge_contiguous() {
let input = "abc\ndef\nghi";
let span1 = Span::new(input, 1, 7).unwrap();
let span2 = Span::new(input, 7, 11).unwrap();
let merged = merge_spans(&span1, &span2).unwrap();
assert_eq!(merged, Span::new(input, 1, 11).unwrap());
}
#[test]
fn merge_overlapping() {
let input = "abc\ndef\nghi";
let span1 = Span::new(input, 1, 7).unwrap();
let span2 = Span::new(input, 5, 11).unwrap();
let merged = merge_spans(&span1, &span2).unwrap();
assert_eq!(merged, Span::new(input, 1, 11).unwrap());
}
#[test]
fn merge_non_contiguous() {
let input = "abc\ndef\nghi";
let span1 = Span::new(input, 1, 7).unwrap();
let span2 = Span::new(input, 8, 11).unwrap();
let merged = merge_spans(&span1, &span2);
assert!(merged.is_none());
}
}