aboutsummaryrefslogtreecommitdiff
path: root/helix-core
diff options
context:
space:
mode:
Diffstat (limited to 'helix-core')
-rw-r--r--helix-core/src/lib.rs6
-rw-r--r--helix-core/src/line_ending.rs169
2 files changed, 175 insertions, 0 deletions
diff --git a/helix-core/src/lib.rs b/helix-core/src/lib.rs
index 03741719..9ac506a6 100644
--- a/helix-core/src/lib.rs
+++ b/helix-core/src/lib.rs
@@ -6,6 +6,7 @@ pub mod diagnostic;
pub mod graphemes;
pub mod history;
pub mod indent;
+pub mod line_ending;
pub mod macros;
pub mod match_brackets;
pub mod movement;
@@ -102,6 +103,7 @@ pub use unicode_general_category::get_general_category;
#[doc(inline)]
pub use {regex, tree_sitter};
+pub use graphemes::RopeGraphemes;
pub use position::{coords_at_pos, pos_at_coords, Position};
pub use selection::{Range, Selection};
pub use smallvec::SmallVec;
@@ -110,4 +112,8 @@ pub use syntax::Syntax;
pub use diagnostic::Diagnostic;
pub use state::State;
+pub use line_ending::{
+ auto_detect_line_ending, get_line_ending, rope_slice_to_line_ending, LineEnding,
+ DEFAULT_LINE_ENDING,
+};
pub use transaction::{Assoc, Change, ChangeSet, Operation, Transaction};
diff --git a/helix-core/src/line_ending.rs b/helix-core/src/line_ending.rs
new file mode 100644
index 00000000..2cc5b5d8
--- /dev/null
+++ b/helix-core/src/line_ending.rs
@@ -0,0 +1,169 @@
+use crate::{Rope, RopeGraphemes, RopeSlice};
+
+/// Represents one of the valid Unicode line endings.
+#[derive(PartialEq, Copy, Clone, Debug)]
+pub enum LineEnding {
+ Crlf, // CarriageReturn followed by LineFeed
+ LF, // U+000A -- LineFeed
+ CR, // U+000D -- CarriageReturn
+ Nel, // U+0085 -- NextLine
+ LS, // U+2028 -- Line Separator
+ VT, // U+000B -- VerticalTab
+ FF, // U+000C -- FormFeed
+ PS, // U+2029 -- ParagraphSeparator
+}
+
+impl LineEnding {
+ pub fn len_chars(&self) -> usize {
+ match self {
+ Self::Crlf => 2,
+ _ => 1,
+ }
+ }
+
+ pub fn as_str(&self) -> &str {
+ match self {
+ Self::Crlf => "\u{000D}\u{000A}",
+ Self::LF => "\u{000A}",
+ Self::Nel => "\u{0085}",
+ Self::LS => "\u{2028}",
+ Self::CR => "\u{000D}",
+ Self::VT => "\u{000B}",
+ Self::FF => "\u{000C}",
+ Self::PS => "\u{2029}",
+ }
+ }
+}
+
+pub fn rope_slice_to_line_ending(g: &RopeSlice) -> Option<LineEnding> {
+ if let Some(text) = g.as_str() {
+ str_to_line_ending(text)
+ } else if g == "\u{000D}\u{000A}" {
+ Some(LineEnding::Crlf)
+ } else {
+ // Not a line ending
+ None
+ }
+}
+
+pub fn str_to_line_ending(g: &str) -> Option<LineEnding> {
+ match g {
+ "\u{000D}\u{000A}" => Some(LineEnding::Crlf),
+ "\u{000A}" => Some(LineEnding::LF),
+ "\u{000D}" => Some(LineEnding::CR),
+ "\u{0085}" => Some(LineEnding::Nel),
+ "\u{2028}" => Some(LineEnding::LS),
+ "\u{000B}" => Some(LineEnding::VT),
+ "\u{000C}" => Some(LineEnding::FF),
+ "\u{2029}" => Some(LineEnding::PS),
+ // Not a line ending
+ _ => None,
+ }
+}
+
+pub fn auto_detect_line_ending(doc: &Rope) -> Option<LineEnding> {
+ // based on https://github.com/cessen/led/blob/27572c8838a1c664ee378a19358604063881cc1d/src/editor/mod.rs#L88-L162
+
+ let mut ending = None;
+ // return first matched line ending. Not all possible line endings are being matched, as they might be special-use only
+ for line in doc.lines().take(100) {
+ ending = match line.len_chars() {
+ 1 => {
+ let g = RopeGraphemes::new(line.slice((line.len_chars() - 1)..))
+ .last()
+ .unwrap();
+ rope_slice_to_line_ending(&g)
+ }
+ n if n > 1 => {
+ let g = RopeGraphemes::new(line.slice((line.len_chars() - 2)..))
+ .last()
+ .unwrap();
+ rope_slice_to_line_ending(&g)
+ }
+ _ => None,
+ };
+ if ending.is_some() {
+ match ending {
+ Some(LineEnding::VT) | Some(LineEnding::FF) | Some(LineEnding::PS) => {}
+ _ => return ending,
+ }
+ }
+ }
+ ending
+}
+
+/// Returns the passed line's line ending, if any.
+pub fn get_line_ending(line: &RopeSlice) -> Option<LineEnding> {
+ // Last character as str.
+ let g1 = line
+ .slice(line.len_chars().saturating_sub(1)..)
+ .as_str()
+ .unwrap();
+
+ // Last two characters as str, or empty str if they're not contiguous.
+ // It's fine to punt on the non-contiguous case, because Ropey guarantees
+ // that CRLF is always contiguous.
+ let g2 = line
+ .slice(line.len_chars().saturating_sub(2)..)
+ .as_str()
+ .unwrap_or("");
+
+ // First check the two-character case for CRLF, then check the single-character case.
+ str_to_line_ending(g2).or_else(|| str_to_line_ending(g1))
+}
+
+#[cfg(target_os = "windows")]
+pub const DEFAULT_LINE_ENDING: LineEnding = LineEnding::Crlf;
+#[cfg(not(target_os = "windows"))]
+pub const DEFAULT_LINE_ENDING: LineEnding = LineEnding::LF;
+
+#[cfg(test)]
+mod line_ending_tests {
+ use super::*;
+
+ #[test]
+ fn test_autodetect() {
+ assert_eq!(
+ auto_detect_line_ending(&Rope::from_str("\n")),
+ Some(LineEnding::LF)
+ );
+ assert_eq!(
+ auto_detect_line_ending(&Rope::from_str("\r\n")),
+ Some(LineEnding::Crlf)
+ );
+ assert_eq!(auto_detect_line_ending(&Rope::from_str("hello")), None);
+ assert_eq!(auto_detect_line_ending(&Rope::from_str("")), None);
+ assert_eq!(
+ auto_detect_line_ending(&Rope::from_str("hello\nhelix\r\n")),
+ Some(LineEnding::LF)
+ );
+ assert_eq!(
+ auto_detect_line_ending(&Rope::from_str("a formfeed\u{000C}")),
+ None
+ );
+ assert_eq!(
+ auto_detect_line_ending(&Rope::from_str("\n\u{000A}\n \u{000A}")),
+ Some(LineEnding::LF)
+ );
+ assert_eq!(
+ auto_detect_line_ending(&Rope::from_str(
+ "a formfeed\u{000C} with a\u{000C} linefeed\u{000A}"
+ )),
+ Some(LineEnding::LF)
+ );
+ assert_eq!(auto_detect_line_ending(&Rope::from_str("a formfeed\u{000C} with a\u{000C} carriage return linefeed\u{000D}\u{000A} and a linefeed\u{000A}")), Some(LineEnding::Crlf));
+ }
+
+ #[test]
+ fn test_rope_slice_to_line_ending() {
+ let r = Rope::from_str("\r\n");
+ assert_eq!(
+ rope_slice_to_line_ending(&r.slice(1..2)),
+ Some(LineEnding::LF)
+ );
+ assert_eq!(
+ rope_slice_to_line_ending(&r.slice(0..2)),
+ Some(LineEnding::Crlf)
+ );
+ }
+}