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
// pest. The Elegant Parser // Copyright (C) 2017 Dragoș Tiselice // // This Source Code Form is subject to the terms of the Mozilla Public // License, v. 2.0. If a copy of the MPL was not distributed with this // file, You can obtain one at http://mozilla.org/MPL/2.0/. use std::cmp::Ordering; use std::fmt; use std::hash::{Hash, Hasher}; use std::ops::Range; use std::rc::Rc; use super::input::Input; use super::span; /// A `struct` containing a position that is tied to an `Input` which provides useful methods to /// manually parse it. This leads to an API largely based on the standard `Result`. pub struct Position<I: Input> { input: Rc<I>, pos: usize } pub unsafe fn new<I: Input>(input: Rc<I>, pos: usize) -> Position<I> { Position { input, pos } } pub fn into_input<I: Input>(pos: &Position<I>) -> Rc<I> { pos.input.clone() } impl<I: Input> Position<I> { /// Creates starting `Position` from an `Rc<Input>`. /// /// # Examples /// /// ``` /// # use std::rc::Rc; /// # use pest::inputs::{Position, StringInput}; /// let input = Rc::new(StringInput::new("".to_owned())); /// /// Position::from_start(input); /// ``` #[inline] pub fn from_start(input: Rc<I>) -> Position<I> { // Position 0 is always safe because it's always a valid UTF-8 border. unsafe { new(input, 0) } } /// Returns the current byte position as a `usize`. /// /// # Examples /// /// ``` /// # use std::rc::Rc; /// # use pest::inputs::{Position, StringInput}; /// let input = Rc::new(StringInput::new("ab".to_owned())); /// let start = Position::from_start(input); /// /// assert_eq!(start.pos(), 0); /// assert_eq!(start.match_string("ab").unwrap().pos(), 2); /// ``` #[inline] pub fn pos(&self) -> usize { self.pos } /// Creates a `Span` from two `Position`s. /// /// # Panics /// /// Panics when the positions come from different inputs. /// /// # Examples /// /// ``` /// # use std::rc::Rc; /// # use pest::inputs::{Position, StringInput}; /// let input = Rc::new(StringInput::new("ab".to_owned())); /// let start = Position::from_start(input); /// let end = start.clone().match_string("ab").unwrap(); /// let span = start.span(end); /// /// assert_eq!(span.start(), 0); /// assert_eq!(span.end(), 2); /// ``` #[inline] pub fn span(self, other: Position<I>) -> span::Span<I> { if Rc::ptr_eq(&self.input, &other.input) { span::new(self.input, self.pos, other.pos) } else { panic!("span created from positions from different inputs") } } /// Returns the line - and column number pair of the current `Position`. /// /// # Examples /// /// ``` /// # use std::rc::Rc; /// # use pest::inputs::{Position, StringInput}; /// let input = Rc::new(StringInput::new("\na".to_owned())); /// let start = Position::from_start(input); /// let pos = start.match_string("\na").unwrap(); /// /// assert_eq!(pos.line_col(), (2, 2)); /// ``` #[inline] pub fn line_col(&self) -> (usize, usize) { unsafe { self.input.line_col(self.pos) } } /// Returns the actual line of the current `Position`. /// /// # Examples /// /// ``` /// # use std::rc::Rc; /// # use pest::inputs::{Position, StringInput}; /// let input = Rc::new(StringInput::new("\na".to_owned())); /// let start = Position::from_start(input); /// let pos = start.match_string("\na").unwrap(); /// /// assert_eq!(pos.line_of(), "a"); /// ``` #[inline] pub fn line_of(&self) -> &str { unsafe { self.input.line_of(self.pos) } } /// Returns `Ok` with the current `Position` if it is at the start of its `Input` or `Err` of /// the same `Position` otherwise. /// /// # Examples /// /// ``` /// # use std::rc::Rc; /// # use pest::inputs::{Position, StringInput}; /// let input = Rc::new(StringInput::new("ab".to_owned())); /// let start = Position::from_start(input); /// let end = start.clone().match_string("ab").unwrap(); /// /// assert_eq!(start.clone().at_start(), Ok(start)); /// assert_eq!(end.clone().at_start(), Err(end)); /// ``` #[inline] pub fn at_start(self) -> Result<Position<I>, Position<I>> { if self.pos == 0 { Ok(self) } else { Err(self) } } /// Returns `Ok` with the current `Position` if it is at the end of its `Input` or `Err` of the /// same `Position` otherwise. /// /// # Examples /// /// ``` /// # use std::rc::Rc; /// # use pest::inputs::{Position, StringInput}; /// let input = Rc::new(StringInput::new("ab".to_owned())); /// let start = Position::from_start(input); /// let end = start.clone().match_string("ab").unwrap(); /// /// assert_eq!(start.clone().at_end(), Err(start)); /// assert_eq!(end.clone().at_end(), Ok(end)); /// ``` #[inline] pub fn at_end(self) -> Result<Position<I>, Position<I>> { if self.pos == self.input.len() { Ok(self) } else { Err(self) } } /// Skips `n` `char`s from the `Position` and returns `Ok` with the new `Position` if the skip /// was possible or `Err` with the current `Position` otherwise. /// /// # Examples /// /// ``` /// # use std::rc::Rc; /// # use pest::inputs::{Position, StringInput}; /// let input = Rc::new(StringInput::new("ab".to_owned())); /// let start = Position::from_start(input); /// /// assert_eq!(start.clone().skip(2).unwrap().pos(), 2); /// assert_eq!(start.clone().skip(3), Err(start)); /// ``` #[inline] pub fn skip(mut self, n: usize) -> Result<Position<I>, Position<I>> { let skipped = unsafe { self.input.skip(n, self.pos) }; match skipped { Some(len) => { self.pos += len; Ok(self) } None => Err(self) } } /// Matches `string` from the `Position` and returns `Ok` with the new `Position` if a match was /// made or `Err` with the current `Position` otherwise. /// /// # Examples /// /// ``` /// # use std::rc::Rc; /// # use pest::inputs::{Position, StringInput}; /// let input = Rc::new(StringInput::new("ab".to_owned())); /// let start = Position::from_start(input); /// /// assert_eq!(start.clone().match_string("ab").unwrap().pos(), 2); /// assert_eq!(start.clone().match_string("ac"), Err(start)); /// ``` #[inline] pub fn match_string(mut self, string: &str) -> Result<Position<I>, Position<I>> { // Matching is safe since, even if the string does not fall on UTF-8 borders, that // particular slice is only used for comparison which will be handled correctly. if unsafe { self.input.match_string(string, self.pos) } { self.pos += string.len(); Ok(self) } else { Err(self) } } /// Case-insensitively matches `string` from the `Position` and returns `Ok` with the new /// `Position` if a match was made or `Err` with the current `Position` otherwise. /// /// # Examples /// /// ``` /// # use std::rc::Rc; /// # use pest::inputs::{Position, StringInput}; /// let input = Rc::new(StringInput::new("ab".to_owned())); /// let start = Position::from_start(input); /// /// assert_eq!(start.clone().match_insensitive("AB").unwrap().pos(), 2); /// assert_eq!(start.clone().match_insensitive("AC"), Err(start)); /// ``` #[inline] pub fn match_insensitive(mut self, string: &str) -> Result<Position<I>, Position<I>> { // Matching is safe since, even if the string does not fall on UTF-8 borders, that // particular slice is only used for comparison which will be handled correctly. if unsafe { self.input.match_insensitive(string, self.pos) } { self.pos += string.len(); Ok(self) } else { Err(self) } } /// Matches `char` `range` from the `Position` and returns `Ok` with the new `Position` if a /// match was made or `Err` with the current `Position` otherwise. /// /// # Examples /// /// ``` /// # use std::rc::Rc; /// # use pest::inputs::{Position, StringInput}; /// let input = Rc::new(StringInput::new("ab".to_owned())); /// let start = Position::from_start(input); /// /// assert_eq!(start.clone().match_range('a'..'z').unwrap().pos(), 1); /// assert_eq!(start.clone().match_range('A'..'Z'), Err(start)); /// ``` #[inline] pub fn match_range(mut self, range: Range<char>) -> Result<Position<I>, Position<I>> { // Cannot actually cause undefined behavior. let len = unsafe { self.input.match_range(range, self.pos) }; match len { Some(len) => { self.pos += len; Ok(self) } None => Err(self) } } /// Starts a sequence of transformations provided by `f` from the `Position`. It returns the /// same `Result` returned by `f` in the case of an `Ok` or `Err` with the current `Position` /// otherwise. /// /// This method is useful to parse sequences that only match together which usually come in the /// form of chained `Result`s with /// [`Result::and_then`](https://doc.rust-lang.org/std/result/enum.Result.html#method.and_then). /// Such chains should always be wrapped up in /// [`ParserState::sequence`](../struct.ParserState.html#method.sequence) if they can create /// `Token`s before being wrapped in `Position::sequence`. /// /// # Examples /// /// ``` /// # use std::rc::Rc; /// # use pest::inputs::{Position, StringInput}; /// let input = Rc::new(StringInput::new("ab".to_owned())); /// let start = Position::from_start(input); /// /// assert_eq!( /// start.clone().sequence(|p| { /// p.match_string("a").and_then(|p| { /// p.match_string("b") /// }) /// }).unwrap().pos(), /// 2 /// ); /// assert_eq!( /// start.clone().sequence(|p| { /// p.match_string("a").and_then(|p| { /// p.match_string("c") /// }) /// }), /// Err(start) /// ); /// ``` #[inline] pub fn sequence<F>(self, f: F) -> Result<Position<I>, Position<I>> where F: FnOnce(Position<I>) -> Result<Position<I>, Position<I>> { let initial_pos = self.pos; let result = f(self); match result { Ok(pos) => Ok(pos), Err(mut pos) => { pos.pos = initial_pos; Err(pos) } } } /// Starts a lookahead transformation provided by `f` from the `Position`. It returns `Ok` with /// the current position if `f` also returns an `Ok ` or `Err` with the current `Position` /// otherwise. /// /// If `is_positive` is `false`, it swaps the `Ok` and `Err` together, negating the `Result`. It /// should always be wrapped up in /// [`ParserState::lookahead`](../struct.ParserState.html#method.lookahead) if it can create /// `Token`s before being wrapped in `Position::lookahead`. /// /// # Examples /// /// ``` /// # use std::rc::Rc; /// # use pest::inputs::{Position, StringInput}; /// let input = Rc::new(StringInput::new("ab".to_owned())); /// let start = Position::from_start(input); /// /// assert_eq!( /// start.clone().lookahead(true, |p| { /// p.match_string("ab") /// }), /// Ok(start.clone()) /// ); /// assert_eq!( /// start.clone().lookahead(true, |p| { /// p.match_string("ac") /// }), /// Err(start.clone()) /// ); /// assert_eq!( /// start.clone().lookahead(false, |p| { /// p.match_string("ac") /// }), /// Ok(start) /// ); /// ``` #[inline] pub fn lookahead<F>(self, is_positive: bool, f: F) -> Result<Position<I>, Position<I>> where F: FnOnce(Position<I>) -> Result<Position<I>, Position<I>> { let initial_pos = self.pos; let result = f(self); let result = match result { Ok(mut pos) => { pos.pos = initial_pos; Ok(pos) } Err(mut pos) => { pos.pos = initial_pos; Err(pos) } }; if is_positive { result } else { match result { Ok(pos) => Err(pos), Err(pos) => Ok(pos) } } } /// Optionally applies the transformation provided by `f` from the `Position`. It returns `Ok` /// with the `Position` returned by `f` regardless of the `Result`. /// /// # Examples /// /// ``` /// # use std::rc::Rc; /// # use pest::inputs::{Position, StringInput}; /// let input = Rc::new(StringInput::new("ab".to_owned())); /// let start = Position::from_start(input); /// /// assert_eq!( /// start.clone().optional(|p| { /// p.match_string("a").and_then(|p| { /// p.match_string("b") /// }) /// }).unwrap().pos(), /// 2 /// ); /// assert_eq!( /// start.clone().sequence(|p| { /// p.match_string("a").and_then(|p| { /// p.match_string("c") /// }) /// }), /// Err(start) /// ); /// ``` #[inline] pub fn optional<F>(self, f: F) -> Result<Position<I>, Position<I>> where F: FnOnce(Position<I>) -> Result<Position<I>, Position<I>> { let result = f(self); match result { Ok(pos) | Err(pos) => Ok(pos) } } /// Repeatedly applies the transformation provided by `f` from the `Position`. It returns `Ok` /// with the first `Position` returned by `f` which is wrapped up in an `Err`. /// /// # Examples /// /// ``` /// # use std::rc::Rc; /// # use pest::inputs::{Position, StringInput}; /// let input = Rc::new(StringInput::new("ab".to_owned())); /// let start = Position::from_start(input); /// /// assert_eq!( /// start.clone().repeat(|p| { /// p.match_string("a") /// }).unwrap().pos(), /// 1 /// ); /// assert_eq!( /// start.repeat(|p| { /// p.match_string("b") /// }).unwrap().pos(), /// 0 /// ); /// ``` #[inline] pub fn repeat<F>(self, mut f: F) -> Result<Position<I>, Position<I>> where F: FnMut(Position<I>) -> Result<Position<I>, Position<I>> { let mut result = f(self); while let Ok(pos) = result { result = f(pos); } match result { Err(pos) => Ok(pos), _ => unreachable!() } } } // We don't want to enforce derivable traits on the Input which forces to implement them manually. impl<I: Input> fmt::Debug for Position<I> { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "Position {{ pos: {} }}", self.pos) } } impl<I: Input> Clone for Position<I> { fn clone(&self) -> Position<I> { // Cloning a safe position is safe. unsafe { new(self.input.clone(), self.pos) } } } impl<I: Input> PartialEq for Position<I> { fn eq(&self, other: &Position<I>) -> bool { Rc::ptr_eq(&self.input, &other.input) && self.pos == other.pos } } impl<I: Input> Eq for Position<I> {} impl<I: Input> PartialOrd for Position<I> { fn partial_cmp(&self, other: &Position<I>) -> Option<Ordering> { if Rc::ptr_eq(&self.input, &other.input) { self.pos.partial_cmp(&other.pos) } else { None } } } impl<I: Input> Ord for Position<I> { fn cmp(&self, other: &Position<I>) -> Ordering { self.partial_cmp(other).expect("cannot compare positions from different inputs") } } impl<I: Input> Hash for Position<I> { fn hash<H: Hasher>(&self, state: &mut H) { (&*self.input as *const I).hash(state); self.pos.hash(state); } }