//! Modified for gitoxide from the upstream imara-diff crate. //! Upstream source: git cat-file -p 32d1e45d3df061e6ccba6db7fdce92db29e345d8:src/sources.rs //! //! Utilities for creating token sources from common data types. //! //! This module provides implementations of [`TokenSource`] for //! strings and byte slices, splitting them into lines by default. use std::str::from_utf8_unchecked; use bstr::ByteSlice; use crate::TokenSource; /// Returns a [`TokenSource`] that uses the lines in `data` as Tokens. The newline /// separator (`\r\n` or `\n`) is included in the emitted tokens. This means that changing /// the newline separator from `\r\n` to `\n` (or omitting it fully on the last line) is /// detected by [`Diff`](crate::Diff). pub fn lines(data: &str) -> Lines<'_> { Lines(ByteLines(data.as_bytes())) } /// Returns a [`TokenSource`] that uses the words in `data` as Tokens. A word is /// a sequence of alphanumeric characters as determined by /// `char::is_alphanumeric`, or a sequence of just the space character ' '. Any /// other characters are their own word. pub fn words(data: &str) -> Words<'_> { Words(data) } /// Returns a [`TokenSource`] that uses the lines in `data` as Tokens. The newline /// separator (`\r\n` or `\n`) is included in the emitted tokens. This means that changing /// the newline separator from `\r\n` to `\n` (or omitting it fully on the last line) is /// detected when computing a [`Diff`](crate::Diff). pub fn bstr_lines(data: &bstr::BStr) -> BStrLines<'_> { BStrLines(data) } /// Returns a [`TokenSource`] that uses the lines in `data` as Tokens. The newline /// separator (`\r\n` or `\n`) is included in the emitted tokens. This means that changing /// the newline separator from `\r\n` to `\n` (or omitting it fully on the last line) is /// detected when computing a [`Diff`](crate::Diff). pub fn byte_lines(data: &[u8]) -> ByteLines<'_> { ByteLines(data) } /// By default, a line diff is produced for a string impl<'a> TokenSource for &'a str { type Token = &'a str; type Tokenizer = Lines<'a>; fn tokenize(&self) -> Self::Tokenizer { lines(self) } fn estimate_tokens(&self) -> u32 { lines(self).estimate_tokens() } } /// By default, a line diff is produced for a `BStr`. impl<'a> TokenSource for &'a bstr::BStr { type Token = Self; type Tokenizer = BStrLines<'a>; fn tokenize(&self) -> Self::Tokenizer { bstr_lines(self) } fn estimate_tokens(&self) -> u32 { bstr_lines(self).estimate_tokens() } } /// By default, a line diff is produced for a bytes impl<'a> TokenSource for &'a [u8] { type Token = Self; type Tokenizer = ByteLines<'a>; fn tokenize(&self) -> Self::Tokenizer { byte_lines(self) } fn estimate_tokens(&self) -> u32 { byte_lines(self).estimate_tokens() } } /// A [`TokenSource`] that returns the lines of a `str` as tokens. See [`lines`] for /// details. #[derive(Clone, Copy, PartialEq, Eq)] pub struct Lines<'a>(ByteLines<'a>); impl<'a> Iterator for Lines<'a> { type Item = &'a str; fn next(&mut self) -> Option { // safety invariant: this struct may only contain valid utf8 // dividing valid utf8 bytes by ascii characters always produces valid utf-8 self.0.next().map(|it| unsafe { from_utf8_unchecked(it) }) } } /// By default, a line diff is produced for a string impl<'a> TokenSource for Lines<'a> { type Token = &'a str; type Tokenizer = Self; fn tokenize(&self) -> Self::Tokenizer { *self } fn estimate_tokens(&self) -> u32 { self.0.estimate_tokens() } } /// A [`TokenSource`] that returns the words of a string as tokens. See /// [`words`] for details. #[derive(Clone, Copy, PartialEq, Eq)] pub struct Words<'a>(&'a str); impl<'a> Iterator for Words<'a> { type Item = &'a str; fn next(&mut self) -> Option { if self.0.is_empty() { return None; } let initial = self.0.chars().next().unwrap(); let word_len = if initial == ' ' { self.0 .char_indices() .find(|(_, c)| *c != ' ') .map_or(self.0.len(), |(index, _)| index) } else if initial.is_alphanumeric() { self.0 .char_indices() .find(|(_, c)| !c.is_alphanumeric() && *c != '_') .map_or(self.0.len(), |(index, _)| index) } else { initial.len_utf8() }; let (word, rem) = self.0.split_at(word_len); self.0 = rem; Some(word) } } impl<'a> TokenSource for Words<'a> { type Token = &'a str; type Tokenizer = Self; fn tokenize(&self) -> Self::Tokenizer { *self } fn estimate_tokens(&self) -> u32 { (self.0.len() / 3) as u32 } } /// A [`TokenSource`] that returns the lines of a `BStr` as tokens. See [`bstr_lines`] for details. #[derive(Clone, Copy, PartialEq, Eq)] pub struct BStrLines<'a>(&'a bstr::BStr); impl<'a> Iterator for BStrLines<'a> { type Item = &'a bstr::BStr; fn next(&mut self) -> Option { if self.0.is_empty() { return None; } let line_len = self.0.find_byte(b'\n').map_or(self.0.len(), |len| len + 1); let (line, rem) = self.0.split_at(line_len); self.0 = rem.into(); Some(line.into()) } } impl<'a> TokenSource for BStrLines<'a> { type Token = &'a bstr::BStr; type Tokenizer = Self; fn tokenize(&self) -> Self::Tokenizer { *self } fn estimate_tokens(&self) -> u32 { let len: usize = self.take(20).map(|line| line.len()).sum(); (self.0.len() * 20).checked_div(len).unwrap_or(100) as u32 } } /// A [`TokenSource`] that returns the lines of a byte slice as tokens. See [`byte_lines`] /// for details. #[derive(Clone, Copy, PartialEq, Eq)] pub struct ByteLines<'a>(&'a [u8]); impl<'a> Iterator for ByteLines<'a> { type Item = &'a [u8]; fn next(&mut self) -> Option { if self.0.is_empty() { return None; } let line_len = self.0.find_byte(b'\n').map_or(self.0.len(), |len| len + 1); let (line, rem) = self.0.split_at(line_len); self.0 = rem; Some(line) } } /// By default, a line diff is produced for a string impl<'a> TokenSource for ByteLines<'a> { type Token = &'a [u8]; type Tokenizer = Self; fn tokenize(&self) -> Self::Tokenizer { *self } fn estimate_tokens(&self) -> u32 { let len: usize = self.take(20).map(|line| line.len()).sum(); (self.0.len() * 20).checked_div(len).unwrap_or(100) as u32 } }