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 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
//! Haystacks.
//!
//! A *haystack* refers to any linear structure which can be split or sliced
//! into smaller, non-overlapping parts. Examples are strings and vectors.
//!
//! ```rust
//! let haystack: &str = "hello"; // a string slice (`&str`) is a haystack.
//! let (a, b) = haystack.split_at(4); // it can be split into two strings.
//! let c = &a[1..3]; // it can be sliced.
//! ```
//!
//! The minimal haystack which cannot be further sliced is called a *codeword*.
//! For instance, the codeword of a string would be a UTF-8 sequence. A haystack
//! can therefore be viewed as a consecutive list of codewords.
//!
//! The boundary between codewords can be addressed using an *index*. The
//! numbers 1, 3 and 4 in the snippet above are sample indices of a string. An
//! index is usually a `usize`.
//!
//! An arbitrary number may point outside of a haystack, or in the interior of a
//! codeword. These indices are invalid. A *valid index* of a certain haystack
//! would only point to the boundaries.
use std::ops::{Deref, Range};
use std::fmt::Debug;
use std::mem;
/// Borrowed [`Haystack`].
///
/// Every `Haystack` type can be borrowed as references to `Hay` types. This
/// allows multiple similar types to share the same implementation (e.g. the
/// haystacks `&[T]`, `&mut [T]` and `Vec<T>` all have the same corresponding
/// hay type `[T]`).
///
/// In the other words, a `Haystack` is a generalized reference to `Hay`.
/// `Hay`s are typically implemented on unsized slice types like `str` and `[T]`.
///
/// # Safety
///
/// This trait is unsafe as there are some unchecked requirements which the
/// implementor must uphold. Failing to meet these requirements would lead to
/// out-of-bound access. The safety requirements are written in each member of
/// this trait.
pub unsafe trait Hay {
/// The index type of the haystack. Typically a `usize`.
///
/// Splitting a hay must be sublinear using this index type. For instance,
/// if we implement `Hay` for a linked list, the index should not be an
/// integer offset (`usize`) as this would require O(n) time to chase the
/// pointer and find the split point. Instead, for a linked list we should
/// directly use the node pointer as the index.
///
/// # Safety
///
/// Valid indices of a single hay have a total order, even this type does
/// not require an `Ord` bound — for instance, to order two linked list
/// cursors, we need to chase the links and see if they meet; this is slow
/// and not suitable for implementing `Ord`, but conceptually an ordering
/// can be defined on linked list cursors.
type Index: Copy + Debug + Eq;
/// Creates an empty hay.
///
/// # Safety
///
/// An empty hay's start and end indices must be the same, e.g.
///
/// ```rust
/// extern crate pattern_3;
/// use pattern_3::Hay;
///
/// let empty = <str>::empty();
/// assert_eq!(empty.start_index(), empty.end_index());
/// ```
///
/// This also suggests that there is exactly one valid index for an empty
/// hay.
///
/// There is no guarantee that two separate calls to `.empty()` will produce
/// the same hay reference.
fn empty<'a>() -> &'a Self;
/// Obtains the index to the start of the hay.
///
/// Usually this method returns `0`.
///
/// # Safety
///
/// Implementation must ensure that the start index of hay is the first
/// valid index, i.e. for all valid indices `i` of `self`, we have
/// `self.start_index() <= i`.
fn start_index(&self) -> Self::Index;
/// Obtains the index to the end of the hay.
///
/// Usually this method returns the length of the hay.
///
/// # Safety
///
/// Implementation must ensure that the end index of hay is the last valid
/// index, i.e. for all valid indices `i` of `self`, we have
/// `i <= self.end_index()`.
fn end_index(&self) -> Self::Index;
/// Returns the next immediate index in this haystack.
///
/// # Safety
///
/// The `index` must be a valid index, and also must not equal to
/// `self.end_index()`.
///
/// Implementation must ensure that if `j = self.next_index(i)`, then `j`
/// is also a valid index satisfying `j > i`.
///
/// # Examples
///
/// ```rust
/// use pattern_3::Hay;
///
/// let sample = "A→😀";
/// unsafe {
/// assert_eq!(sample.next_index(0), 1);
/// assert_eq!(sample.next_index(1), 4);
/// assert_eq!(sample.next_index(4), 8);
/// }
/// ```
unsafe fn next_index(&self, index: Self::Index) -> Self::Index;
/// Returns the previous immediate index in this haystack.
///
/// # Safety
///
/// The `index` must be a valid index, and also must not equal to
/// `self.start_index()`.
///
/// Implementation must ensure that if `j = self.prev_index(i)`, then `j`
/// is also a valid index satisfying `j < i`.
///
/// # Examples
///
/// ```rust
/// use pattern_3::Hay;
///
/// let sample = "A→😀";
/// unsafe {
/// assert_eq!(sample.prev_index(8), 4);
/// assert_eq!(sample.prev_index(4), 1);
/// assert_eq!(sample.prev_index(1), 0);
/// }
/// ```
unsafe fn prev_index(&self, index: Self::Index) -> Self::Index;
/// Obtains a child hay by slicing `self`.
///
/// # Safety
///
/// The two ends of the range must be valid indices. The start of the range
/// must be before the end of the range (`range.start <= range.end`).
unsafe fn slice_unchecked(&self, range: Range<Self::Index>) -> &Self;
}
/// Linear splittable structure.
///
/// A `Haystack` is implemented for reference and collection types such as
/// `&str`, `&mut [T]` and `Vec<T>`. Every haystack can be borrowed as an
/// underlying representation called a [`Hay`]. Multiple haystacks may share the
/// same hay type, and thus share the same implementation of string search
/// algorithms.
///
/// In the other words, a `Haystack` is a generalized reference to `Hay`.
///
/// # Safety
///
/// This trait is unsafe as there are some unchecked requirements which the
/// implementor must uphold. Failing to meet these requirements would lead to
/// out-of-bound access. The safety requirements are written in each member of
/// this trait.
pub unsafe trait Haystack: Deref + Sized where Self::Target: Hay {
/// Creates an empty haystack.
fn empty() -> Self;
/// Splits the haystack into 3 slices around the given range.
///
/// This method splits `self` into 3 non-overlapping parts:
///
/// 1. Before the range (`self[..range.start]`),
/// 2. Inside the range (`self[range]`), and
/// 3. After the range (`self[range.end..]`)
///
/// The returned array contains these 3 parts in order.
///
/// # Safety
///
/// Caller should ensure that the starts and end indices of `range` are
/// valid indices for the haystack `self` with `range.start <= range.end`.
///
/// If the haystack is a mutable reference (`&mut A`), implementation must
/// ensure that the 3 returned haystack are truly non-overlapping in memory.
/// This is required to uphold the "Aliasing XOR Mutability" guarantee. If a
/// haystack cannot be physically split into non-overlapping parts (e.g. in
/// `OsStr`), then `&mut A` should not implement `Haystack` either.
///
/// # Examples
///
/// ```rust
/// use pattern_3::Haystack;
///
/// let haystack = &mut [0, 1, 2, 3, 4, 5, 6];
/// let [left, middle, right] = unsafe { haystack.split_around(2..6) };
/// assert_eq!(left, &mut [0, 1]);
/// assert_eq!(middle, &mut [2, 3, 4, 5]);
/// assert_eq!(right, &mut [6]);
/// ```
unsafe fn split_around(self, range: Range<<Self::Target as Hay>::Index>) -> [Self; 3];
/// Subslices this haystack.
///
/// # Safety
///
/// The starts and end indices of `range` must be valid indices for the
/// haystack `self` with `range.start <= range.end`.
unsafe fn slice_unchecked(self, range: Range<<Self::Target as Hay>::Index>) -> Self {
let [_, middle, _] = self.split_around(range);
middle
}
/// Transforms the range from relative to self's parent to the original
/// haystack it was sliced from.
///
/// Typically this method can be simply implemented as
///
/// ```text
/// (original.start + parent.start)..(original.start + parent.end)
/// ```
///
/// If this haystack is a [`SharedHaystack`], this method would never be
/// called.
///
/// # Safety
///
/// The `parent` range should be a valid range relative to a hay *a*, which
/// was used to slice out *self*: `self == &a[parent]`.
///
/// Similarly, the `original` range should be a valid range relative to
/// another hay *b* used to slice out *a*: `a == &b[original]`.
///
/// The distance of `parent` must be consistent with the length of `self`.
///
/// This method should return a range which satisfies:
///
/// ```text
/// self == &b[parent][original] == &b[range]
/// ```
///
/// Slicing can be destructive and *invalidates* some indices, in particular
/// for owned type with a pointer-like index, e.g. linked list. In this
/// case, one should derive an entirely new index range from `self`, e.g.
/// returning `self.start_index()..self.end_index()`.
///
/// # Examples
///
/// ```rust
/// use pattern_3::Haystack;
///
/// let hay = b"This is a sample haystack";
/// let this = hay[2..23][3..19].to_vec();
/// assert_eq!(&*this, &hay[this.restore_range(2..23, 3..19)]);
/// ```
fn restore_range(
&self,
original: Range<<Self::Target as Hay>::Index>,
parent: Range<<Self::Target as Hay>::Index>,
) -> Range<<Self::Target as Hay>::Index>;
}
/// A [`Haystack`] which can be shared and cheaply cloned (e.g. `&H`, `Rc<H>`).
///
/// If a haystack implements this marker trait, during internal operations the
/// original haystack will be retained in full and cloned, rather than being
/// sliced and splitted. Being a shared haystack allows searcher to see the
/// entire haystack, including the consumed portion.
pub trait SharedHaystack: Haystack + Clone
where Self::Target: Hay // FIXME: RFC 2089 or 2289
{}
/// The borrowing behavior differs between a (unique) haystack and shared
/// haystack. We use *specialization* to distinguish between these behavior:
///
/// * When using `split_around()` and `slice_unchecked()` with a unique
/// haystack, the original haystack will be splitted or sliced accordingly
/// to maintain unique ownership.
/// * When using these functions with a shared haystack, the original haystack
/// will be cloned in full as that could provide more context into
/// searchers.
///
/// This trait will never be public.
trait SpanBehavior: Haystack
where Self::Target: Hay // FIXME: RFC 2089 or 2289
{
fn take(&mut self) -> Self;
fn from_span(span: Span<Self>) -> Self;
unsafe fn split_around_for_span(self, subrange: Range<<Self::Target as Hay>::Index>) -> [Self; 3];
unsafe fn slice_unchecked_for_span(self, subrange: Range<<Self::Target as Hay>::Index>) -> Self;
fn borrow_range(
&self,
range: Range<<Self::Target as Hay>::Index>,
) -> Range<<Self::Target as Hay>::Index>;
fn do_restore_range(
&self,
range: Range<<Self::Target as Hay>::Index>,
subrange: Range<<Self::Target as Hay>::Index>,
) -> Range<<Self::Target as Hay>::Index>;
}
impl<H: Haystack> SpanBehavior for H
where H::Target: Hay // FIXME: RFC 2089 or 2289
{
#[inline]
default fn take(&mut self) -> Self {
mem::replace(self, Self::empty())
}
#[inline]
default fn from_span(span: Span<Self>) -> Self {
span.haystack
}
#[inline]
default fn borrow_range(&self, _: Range<<Self::Target as Hay>::Index>) -> Range<<Self::Target as Hay>::Index> {
self.start_index()..self.end_index()
}
#[inline]
default fn do_restore_range(
&self,
range: Range<<Self::Target as Hay>::Index>,
subrange: Range<<Self::Target as Hay>::Index>,
) -> Range<<Self::Target as Hay>::Index> {
self.restore_range(range, subrange)
}
#[inline]
default unsafe fn split_around_for_span(self, subrange: Range<<Self::Target as Hay>::Index>) -> [Self; 3] {
self.split_around(subrange)
}
#[inline]
default unsafe fn slice_unchecked_for_span(self, subrange: Range<<Self::Target as Hay>::Index>) -> Self {
self.slice_unchecked(subrange)
}
}
impl<H: SharedHaystack> SpanBehavior for H
where H::Target: Hay // FIXME: RFC 2089 or 2289
{
#[inline]
fn take(&mut self) -> Self {
self.clone()
}
#[inline]
fn from_span(span: Span<Self>) -> Self {
unsafe {
span.haystack.slice_unchecked(span.range)
}
}
#[inline]
fn borrow_range(&self, range: Range<<Self::Target as Hay>::Index>) -> Range<<Self::Target as Hay>::Index> {
range
}
#[inline]
fn do_restore_range(
&self,
_: Range<<Self::Target as Hay>::Index>,
subrange: Range<<Self::Target as Hay>::Index>,
) -> Range<<Self::Target as Hay>::Index> {
subrange
}
#[inline]
unsafe fn split_around_for_span(self, _: Range<<Self::Target as Hay>::Index>) -> [Self; 3] {
[self.clone(), self.clone(), self]
}
#[inline]
unsafe fn slice_unchecked_for_span(self, _: Range<<Self::Target as Hay>::Index>) -> Self {
self
}
}
/// A span is a haystack coupled with the original range where the haystack is found.
///
/// It can be considered as a tuple `(H, Range<H::Target::Index>)`
/// where the range is guaranteed to be valid for the haystack.
///
/// # Examples
///
/// ```
/// use pattern_3::Span;
///
/// let orig_str = "Hello世界";
/// let orig_span = Span::<&str>::from(orig_str);
///
/// // slice a span.
/// let span = unsafe { orig_span.slice_unchecked(3..8) };
///
/// // further slicing (note the range is relative to the original span)
/// let subspan = unsafe { span.slice_unchecked(4..8) };
///
/// // obtains the substring.
/// let substring = subspan.into();
/// assert_eq!(substring, "o世");
/// ```
///
/// Visualizing the spans:
///
/// ```text
///
/// 0 1 2 3 4 5 6 7 8 9 10 11
/// +---+---+---+---+---+---+---+---+---+---+---+
/// | H | e | l | l | o | U+4E16 | U+754C | orig_str
/// +---+---+---+---+---+---+---+---+---+---+---+
///
/// ^___________________________________________^ orig_span = (orig_str, 0..11)
///
/// ^___________________^ span = (orig_str, 3..8)
///
/// ^_______________^ subspan = (orig_str, 4..8)
/// ```
#[derive(Debug, Clone)]
pub struct Span<H: Haystack>
where H::Target: Hay // FIXME: RFC 2089 or 2289
{
haystack: H,
range: Range<<<H as Deref>::Target as Hay>::Index>,
//^ The `<H as Trait>` is to trick `#[derive]` not to generate
// the where bound for `H::Hay`.
}
/// Creates a span which covers the entire haystack.
impl<H: Haystack> From<H> for Span<H>
where H::Target: Hay // FIXME: RFC 2089 or 2289
{
#[inline]
fn from(haystack: H) -> Self {
let range = haystack.start_index()..haystack.end_index();
Self { haystack, range }
}
}
impl<H: SharedHaystack> Span<H>
where H::Target: Hay // FIXME: RFC 2089 or 2289
{
/// Decomposes this span into the original haystack, and the range it focuses on.
#[inline]
pub fn into_parts(self) -> (H, Range<<H::Target as Hay>::Index>) {
(self.haystack, self.range)
}
/// Creates a span from a haystack, and a range it should focus on.
///
/// # Safety
///
/// The `range` must be a valid range relative to `haystack`.
#[inline]
pub unsafe fn from_parts(haystack: H, range: Range<<H::Target as Hay>::Index>) -> Self {
Self { haystack, range }
}
}
impl<'h> Span<&'h str> {
/// Reinterprets the string span as a byte-array span.
#[inline]
pub fn as_bytes(self) -> Span<&'h [u8]> {
Span {
haystack: self.haystack.as_bytes(),
range: self.range,
}
}
}
impl<H: Haystack> Span<H>
where H::Target: Hay // FIXME: RFC 2089 or 2289
{
/// The range of the span, relative to the ultimate original haystack it was sliced from.
#[inline]
pub fn original_range(&self) -> Range<<H::Target as Hay>::Index> {
self.range.clone()
}
/// Borrows a shared span.
#[inline]
pub fn borrow(&self) -> Span<&H::Target> {
Span {
haystack: &*self.haystack,
range: self.haystack.borrow_range(self.range.clone()),
}
}
/// Checks whether this span is empty.
#[inline]
pub fn is_empty(&self) -> bool {
self.range.start == self.range.end
}
/// Returns this span by value, and replaces the original span by an empty
/// span.
#[inline]
pub fn take(&mut self) -> Self {
let haystack = self.haystack.take();
let range = self.range.clone();
self.range.end = self.range.start;
Span { haystack, range }
}
// FIXME: This should be changed to an `impl From<Span<H>> for H`.
/// Slices the original haystack to the focused range.
#[inline]
pub fn into(self) -> H {
H::from_span(self)
}
/// Splits this span into 3 spans around the given range.
///
/// # Safety
///
/// `subrange` must be a valid range relative to `self.borrow()`. A safe
/// usage is like:
///
/// ```rust
/// # use pattern_3::{Span, Needle, Searcher};
/// # let span = Span::from("foo");
/// # let mut searcher = <&str as Needle<&str>>::into_searcher("o");
/// # (|| -> Option<()> {
/// let range = searcher.search(span.borrow())?;
/// let [left, middle, right] = unsafe { span.split_around(range) };
/// # Some(()) })();
/// ```
#[inline]
pub unsafe fn split_around(self, subrange: Range<<H::Target as Hay>::Index>) -> [Self; 3] {
let self_range = self.haystack.borrow_range(self.range.clone());
let [left, middle, right] = self.haystack.split_around_for_span(subrange.clone());
let left_range = left.do_restore_range(self.range.clone(), self_range.start..subrange.start);
let right_range = right.do_restore_range(self.range.clone(), subrange.end..self_range.end);
let middle_range = middle.do_restore_range(self.range, subrange);
[
Self { haystack: left, range: left_range },
Self { haystack: middle, range: middle_range },
Self { haystack: right, range: right_range },
]
}
/// Slices this span to the given range.
///
/// # Safety
///
/// `subrange` must be a valid range relative to `self.borrow()`.
#[inline]
pub unsafe fn slice_unchecked(self, subrange: Range<<H::Target as Hay>::Index>) -> Self {
let haystack = self.haystack.slice_unchecked_for_span(subrange.clone());
let range = haystack.do_restore_range(self.range, subrange);
Self { haystack, range }
}
}
unsafe impl<'a, A: Hay + ?Sized + 'a> Haystack for &'a A {
#[inline]
fn empty() -> Self {
A::empty()
}
#[inline]
unsafe fn split_around(self, range: Range<A::Index>) -> [Self; 3] {
[
self.slice_unchecked(self.start_index()..range.start),
self.slice_unchecked(range.clone()),
self.slice_unchecked(range.end..self.end_index()),
]
}
#[inline]
unsafe fn slice_unchecked(self, range: Range<A::Index>) -> Self {
A::slice_unchecked(self, range)
}
#[inline]
fn restore_range(&self, _: Range<A::Index>, _: Range<A::Index>) -> Range<A::Index> {
unreachable!()
}
}
impl<'a, A: Hay + ?Sized + 'a> SharedHaystack for &'a A {}