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
use std::error::Error;
use std::fmt::{Debug, Display, Formatter};
use std::ops::Range;
pub mod clipboard;
pub mod date_input;
pub mod line_number;
pub mod number_input;
pub mod text_area;
pub mod text_input;
pub mod text_input_mask;
pub mod undo_buffer;
mod grapheme;
mod range_map;
mod text_core;
mod text_mask_core;
mod text_store;
pub use grapheme::{Glyph, Grapheme};
pub mod event {
//!
//! Event-handler traits and Keybindings.
//!
pub use rat_event::{
crossterm, ct_event, flow, try_flow, util, ConsumedEvent, Dialog, DoubleClick, HandleEvent,
MouseOnly, Outcome, Popup, Regular,
};
/// Runs only the navigation events, not any editing.
#[derive(Debug)]
pub struct ReadOnly;
/// Result of event handling.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
pub enum TextOutcome {
/// The given event has not been used at all.
Continue,
/// The event has been recognized, but the result was nil.
/// Further processing for this event may stop.
Unchanged,
/// The event has been recognized and there is some change
/// due to it.
/// Further processing for this event may stop.
/// Rendering the ui is advised.
Changed,
/// Text content has changed.
TextChanged,
}
impl ConsumedEvent for TextOutcome {
fn is_consumed(&self) -> bool {
*self != TextOutcome::Continue
}
}
// Useful for converting most navigation/edit results.
impl From<bool> for TextOutcome {
fn from(value: bool) -> Self {
if value {
TextOutcome::Changed
} else {
TextOutcome::Unchanged
}
}
}
impl From<Outcome> for TextOutcome {
fn from(value: Outcome) -> Self {
match value {
Outcome::Continue => TextOutcome::Continue,
Outcome::Unchanged => TextOutcome::Unchanged,
Outcome::Changed => TextOutcome::Changed,
}
}
}
impl From<TextOutcome> for Outcome {
fn from(value: TextOutcome) -> Self {
match value {
TextOutcome::Continue => Outcome::Continue,
TextOutcome::Unchanged => Outcome::Unchanged,
TextOutcome::Changed => Outcome::Changed,
TextOutcome::TextChanged => Outcome::Changed,
}
}
}
}
pub mod core {
//!
//! Core structs for text-editing.
//! Used to implement the widgets.
//!
pub use crate::text_core::TextCore;
pub use crate::text_mask_core::MaskedCore;
pub use crate::text_store::text_rope::TextRope;
pub use crate::text_store::text_string::TextString;
pub use crate::text_store::TextStore;
}
#[derive(Debug, PartialEq)]
pub enum TextError {
/// Invalid text.
InvalidText(String),
/// Clipboard error occurred.
Clipboard,
/// Indicates that the passed text-range was out of bounds.
TextRangeOutOfBounds(TextRange),
/// Indicates that the passed text-position was out of bounds.
TextPositionOutOfBounds(TextPosition),
/// Indicates that the passed line index was out of bounds.
///
/// Contains the index attempted and the actual length of the
/// `Rope`/`RopeSlice` in lines, in that order.
LineIndexOutOfBounds(upos_type, upos_type),
/// Column index is out of bounds.
ColumnIndexOutOfBounds(upos_type, upos_type),
/// Indicates that the passed byte index was out of bounds.
///
/// Contains the index attempted and the actual length of the
/// `Rope`/`RopeSlice` in bytes, in that order.
ByteIndexOutOfBounds(usize, usize),
/// Indicates that the passed char index was out of bounds.
///
/// Contains the index attempted and the actual length of the
/// `Rope`/`RopeSlice` in chars, in that order.
CharIndexOutOfBounds(usize, usize),
/// out of bounds.
///
/// Contains the [start, end) byte indices of the range and the actual
/// length of the `Rope`/`RopeSlice` in bytes, in that order. When
/// either the start or end are `None`, that indicates a half-open range.
ByteRangeOutOfBounds(Option<usize>, Option<usize>, usize),
/// Indicates that the passed char-index range was partially or fully
/// out of bounds.
///
/// Contains the [start, end) char indices of the range and the actual
/// length of the `Rope`/`RopeSlice` in chars, in that order. When
/// either the start or end are `None`, that indicates a half-open range.
CharRangeOutOfBounds(Option<usize>, Option<usize>, usize),
/// Indicates that the passed byte index was not a char boundary.
///
/// Contains the passed byte index.
ByteIndexNotCharBoundary(usize),
/// Indicates that the passed byte range didn't line up with char
/// boundaries.
///
/// Contains the [start, end) byte indices of the range, in that order.
/// When either the start or end are `None`, that indicates a half-open
/// range.
ByteRangeNotCharBoundary(
Option<usize>, // Start.
Option<usize>, // End.
),
/// Indicates that a reversed byte-index range (end < start) was
/// encountered.
///
/// Contains the [start, end) byte indices of the range, in that order.
ByteRangeInvalid(
usize, // Start.
usize, // End.
),
/// Indicates that a reversed char-index range (end < start) was
/// encountered.
///
/// Contains the [start, end) char indices of the range, in that order.
CharRangeInvalid(
usize, // Start.
usize, // End.
),
}
impl Display for TextError {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(f, "{:?}", self)
}
}
impl Error for TextError {}
/// Row/Column type.
#[allow(non_camel_case_types)]
pub type upos_type = u32;
/// Row/Column type.
#[allow(non_camel_case_types)]
pub type ipos_type = i32;
/// Text position.
#[derive(Default, PartialEq, Eq, PartialOrd, Ord, Clone, Copy)]
pub struct TextPosition {
pub y: upos_type,
pub x: upos_type,
}
impl TextPosition {
/// New position.
pub const fn new(x: upos_type, y: upos_type) -> TextPosition {
Self { y, x }
}
}
impl Debug for TextPosition {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(f, "{}|{}", self.x, self.y)
}
}
impl From<(upos_type, upos_type)> for TextPosition {
fn from(value: (upos_type, upos_type)) -> Self {
Self {
y: value.1,
x: value.0,
}
}
}
impl From<TextPosition> for (upos_type, upos_type) {
fn from(value: TextPosition) -> Self {
(value.x, value.y)
}
}
/// Exclusive range for text ranges.
#[derive(Default, PartialEq, Eq, PartialOrd, Ord, Clone, Copy)]
pub struct TextRange {
/// column, row
pub start: TextPosition,
/// column, row
pub end: TextPosition,
}
impl Debug for TextRange {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(
f,
"{}|{}-{}|{}",
self.start.x, self.start.y, self.end.x, self.end.y
)
}
}
impl From<Range<TextPosition>> for TextRange {
fn from(value: Range<TextPosition>) -> Self {
assert!(value.start <= value.end);
Self {
start: value.start,
end: value.end,
}
}
}
impl From<TextRange> for Range<TextPosition> {
fn from(value: TextRange) -> Self {
value.start..value.end
}
}
impl TextRange {
/// New text range.
///
/// Panic
/// Panics if start > end.
pub fn new(start: impl Into<TextPosition>, end: impl Into<TextPosition>) -> Self {
let start = start.into();
let end = end.into();
assert!(start <= end);
TextRange { start, end }
}
/// Empty range
#[inline]
pub fn is_empty(&self) -> bool {
self.start == self.end
}
/// Range contains the given position.
#[inline]
pub fn contains_pos(&self, pos: impl Into<TextPosition>) -> bool {
let pos = pos.into();
pos >= self.start && pos < self.end
}
/// Range fully before the given position.
#[inline]
pub fn before_pos(&self, pos: impl Into<TextPosition>) -> bool {
let pos = pos.into();
pos >= self.end
}
/// Range fully after the given position.
#[inline]
pub fn after_pos(&self, pos: impl Into<TextPosition>) -> bool {
let pos = pos.into();
pos < self.start
}
/// Range contains the other range.
#[inline(always)]
pub fn contains(&self, other: TextRange) -> bool {
other.start >= self.start && other.end <= self.end
}
/// Range before the other range.
#[inline(always)]
pub fn before(&self, other: TextRange) -> bool {
other.start > self.end
}
/// Range after the other range.
#[inline(always)]
pub fn after(&self, other: TextRange) -> bool {
other.end < self.start
}
/// Range overlaps with other range.
#[inline(always)]
pub fn intersects(&self, other: TextRange) -> bool {
other.start <= self.end && other.end >= self.start
}
/// Return the modified value range, that accounts for a
/// text insertion of range.
#[inline]
pub fn expand(&self, range: TextRange) -> TextRange {
TextRange::new(self.expand_pos(range.start), self.expand_pos(range.end))
}
/// Return the modified position, that accounts for a
/// text insertion of range.
#[inline]
pub fn expand_pos(&self, pos: TextPosition) -> TextPosition {
let delta_lines = self.end.y - self.start.y;
// swap x and y to enable tuple comparison
if pos < self.start {
pos
} else if pos == self.start {
self.end
} else {
if pos.y > self.start.y {
TextPosition::new(pos.x, pos.y + delta_lines)
} else if pos.y == self.start.y {
if pos.x >= self.start.x {
TextPosition::new(pos.x - self.start.x + self.end.x, pos.y + delta_lines)
} else {
pos
}
} else {
pos
}
}
}
/// Return the modified value range, that accounts for a
/// text deletion of range.
#[inline]
pub fn shrink(&self, range: TextRange) -> TextRange {
TextRange::new(self.shrink_pos(range.start), self.shrink_pos(range.end))
}
/// Return the modified position, that accounts for a
/// text deletion of the range.
#[inline]
pub fn shrink_pos(&self, pos: TextPosition) -> TextPosition {
let delta_lines = self.end.y - self.start.y;
// swap x and y to enable tuple comparison
if pos < self.start {
pos
} else if pos >= self.start && pos <= self.end {
self.start
} else {
// after row
if pos.y > self.end.y {
TextPosition::new(pos.x, pos.y - delta_lines)
} else if pos.y == self.end.y {
if pos.x >= self.end.x {
TextPosition::new(pos.x - self.end.x + self.start.x, pos.y - delta_lines)
} else {
pos
}
} else {
pos
}
}
}
}
/// Trait for a cursor.
///
/// This is not a [DoubleEndedIterator] which can iterate from both ends of
/// the iterator, but moves a cursor forward/back over the collection.
pub trait Cursor: Iterator {
/// Return the previous item.
fn prev(&mut self) -> Option<Self::Item>;
/// Return a cursor with prev/next reversed.
/// All iterator functions work backwards.
fn rev_cursor(self) -> impl Cursor<Item = Self::Item>
where
Self: Sized;
/// Offset of the current cursor position into the underlying text.
fn text_offset(&self) -> usize;
}
mod _private {
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct NonExhaustive;
}