rat-text 3.1.0

ratatui text input widgets
Documentation
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
use crate::grapheme::StrGraphemes;
use crate::text_store::TextStore;
use crate::{TextError, TextPosition, TextRange, upos_type};
use std::borrow::Cow;
use std::cell::Cell;
use std::cmp::min;
use std::iter::once;
use std::mem;
use std::ops::Range;
use unicode_segmentation::UnicodeSegmentation;

/// Single line text-store.
#[derive(Debug, Default, Clone)]
pub struct TextString {
    // text
    text: String,
    // len as grapheme count
    len: upos_type,
    // minimum byte position changed since last reset.
    min_changed: Cell<Option<usize>>,
    // tmp buffer
    buf: String,
}

/// Length as grapheme count, excluding line breaks.
#[inline]
fn str_len(s: &str) -> upos_type {
    s.graphemes(true).count() as upos_type
}

impl TextString {
    /// New empty.
    pub fn new() -> Self {
        Self {
            text: Default::default(),
            len: 0,
            min_changed: Default::default(),
            buf: Default::default(),
        }
    }

    /// New from string.
    pub fn new_text(t: &str) -> Self {
        Self {
            text: t.into(),
            len: str_len(t),
            min_changed: Default::default(),
            buf: Default::default(),
        }
    }

    /// New from string.
    pub fn new_string(t: String) -> Self {
        let len = str_len(&t);
        Self {
            text: t,
            len,
            min_changed: Default::default(),
            buf: Default::default(),
        }
    }

    /// str
    pub fn as_str(&self) -> &str {
        self.text.as_str()
    }
}

impl TextString {
    fn invalidate_cache(&self, byte_pos: usize) {
        self.min_changed.update(|v| match v {
            None => Some(byte_pos),
            Some(w) => Some(min(byte_pos, w)),
        });
    }
}

impl TextStore for TextString {
    type GraphemeIter<'a> = StrGraphemes<'a>;

    /// Can store multi-line content?
    #[inline]
    fn is_multi_line(&self) -> bool {
        false
    }

    fn has_final_newline(&self) -> bool {
        true
    }

    /// Number of lines.
    #[inline]
    fn len_lines(&self) -> upos_type {
        1
    }

    /// Length in bytes.
    #[inline]
    fn len_bytes(&self) -> usize {
        self.text.len()
    }

    #[inline]
    fn cache_validity(&self) -> Option<usize> {
        self.min_changed.take()
    }

    /// Get content as string.
    fn string(&self) -> String {
        self.text.to_string()
    }

    /// Set content as string.
    fn set_string(&mut self, t: &str) {
        self.invalidate_cache(0);
        self.text = t.to_string();
        self.len = str_len(&self.text);
    }

    /// Grapheme position to byte position.
    /// This is the (start,end) position of the single grapheme after pos.
    ///
    /// * pos must be a valid position: row <= len_lines, col <= line_width of the row.
    fn byte_range_at(&self, pos: TextPosition) -> Result<Range<usize>, TextError> {
        if pos == TextPosition::new(0, 1) {
            let len = self.text.len();
            return Ok(len..len);
        }

        if pos.y != 0 {
            return Err(TextError::LineIndexOutOfBounds(pos.y, 1));
        };

        let mut byte_range = None;
        for (cidx, (idx, c)) in self
            .text
            .grapheme_indices(true)
            .chain(once((self.text.len(), "")))
            .enumerate()
        {
            if cidx == pos.x as usize {
                byte_range = Some(idx..idx + c.len());
                break;
            }
        }

        if let Some(byte_range) = byte_range {
            Ok(byte_range)
        } else {
            Err(TextError::ColumnIndexOutOfBounds(
                pos.x,
                str_len(&self.text),
            ))
        }
    }

    /// Grapheme range to byte range.
    ///
    /// Allows the special text-position (0,1) as a substitute for EOL.
    ///
    /// * range must be a valid range. row <= len_lines, col <= line_width of the row.
    fn byte_range(&self, range: TextRange) -> Result<Range<usize>, TextError> {
        if range.start.y != 0 && range.start != TextPosition::new(0, 1) {
            return Err(TextError::LineIndexOutOfBounds(range.start.y, 1));
        };
        if range.end.y != 0 && range.end != TextPosition::new(0, 1) {
            return Err(TextError::LineIndexOutOfBounds(range.end.y, 1));
        };

        let mut byte_start = None;
        let mut byte_end = None;

        if range.start == TextPosition::new(0, 1) {
            byte_start = Some(self.text.len());
        }
        if range.end == TextPosition::new(0, 1) {
            byte_end = Some(self.text.len());
        }

        if byte_start.is_none() || byte_end.is_none() {
            for (cidx, (idx, _)) in self
                .text
                .grapheme_indices(true)
                .chain(once((self.text.len(), "")))
                .enumerate()
            {
                if TextPosition::new(cidx as upos_type, 0) == range.start {
                    byte_start = Some(idx);
                }
                if TextPosition::new(cidx as upos_type, 0) == range.end {
                    byte_end = Some(idx);
                }
                if byte_start.is_some() && byte_end.is_some() {
                    break;
                }
            }
        }

        let Some(byte_start) = byte_start else {
            return Err(TextError::ColumnIndexOutOfBounds(
                range.start.x,
                str_len(&self.text),
            ));
        };
        let Some(byte_end) = byte_end else {
            return Err(TextError::ColumnIndexOutOfBounds(
                range.end.x,
                str_len(&self.text),
            ));
        };

        Ok(byte_start..byte_end)
    }

    /// Byte position to grapheme position.
    /// Returns the position that contains the given byte index.
    ///
    /// * byte must <= byte-len.
    fn byte_to_pos(&self, byte_pos: usize) -> Result<TextPosition, TextError> {
        let mut pos = None;

        for (cidx, (c_start, c)) in self
            .text
            .grapheme_indices(true)
            .chain(once((self.text.len(), " ")))
            .enumerate()
        {
            if byte_pos < c_start + c.len() {
                pos = Some(cidx);
                break;
            }
        }

        if let Some(pos) = pos {
            Ok(TextPosition::new(pos as upos_type, 0))
        } else {
            Err(TextError::ByteIndexOutOfBounds(byte_pos, self.text.len()))
        }
    }

    /// Byte range to grapheme range.
    ///
    /// * byte must <= byte-len.
    fn bytes_to_range(&self, bytes: Range<usize>) -> Result<TextRange, TextError> {
        let mut start = None;
        let mut end = None;
        for (cidx, (c_start, c)) in self
            .text
            .grapheme_indices(true)
            .chain(once((self.text.len(), " ")))
            .enumerate()
        {
            if bytes.start < c_start + c.len() {
                if start.is_none() {
                    start = Some(cidx as upos_type);
                }
            }
            if bytes.end < c_start + c.len() {
                if end.is_none() {
                    end = Some(cidx as upos_type);
                }
            }
            if start.is_some() && end.is_some() {
                break;
            }
        }

        let Some(start) = start else {
            return Err(TextError::ByteIndexOutOfBounds(
                bytes.start,
                self.text.len(),
            ));
        };
        let Some(end) = end else {
            return Err(TextError::ByteIndexOutOfBounds(bytes.end, self.text.len()));
        };

        Ok(TextRange::new((start, 0), (end, 0)))
    }

    /// A range of the text as `Cow<str>`.
    ///
    /// * range must be a valid range. row <= len_lines, col <= line_width of the row.
    /// * pos must be inside of range.
    #[inline]
    fn str_slice(&self, range: TextRange) -> Result<Cow<'_, str>, TextError> {
        let range = self.byte_range(range)?;
        Ok(Cow::Borrowed(&self.text[range.start..range.end]))
    }

    /// A range of the text as `Cow<str>`.
    ///
    /// * range must be valid
    #[inline]
    fn str_slice_byte(&self, range: Range<usize>) -> Result<Cow<'_, str>, TextError> {
        Ok(Cow::Borrowed(&self.text[range.start..range.end]))
    }

    fn graphemes_byte(
        &self,
        range: Range<usize>,
        pos: usize,
    ) -> Result<Self::GraphemeIter<'_>, TextError> {
        if !range.contains(&pos) && range.end != pos {
            return Err(TextError::ByteIndexOutOfBounds(pos, range.end));
        }
        if !self.text.is_char_boundary(range.start) || !self.text.is_char_boundary(range.end) {
            return Err(TextError::ByteRangeNotCharBoundary(
                Some(range.start),
                Some(range.end),
            ));
        }
        if !self.text.is_char_boundary(pos) {
            return Err(TextError::ByteIndexNotCharBoundary(pos));
        }

        Ok(StrGraphemes::new_offset(
            range.start,
            &self.text[range.clone()],
            pos - range.start,
        ))
    }

    /// Line as str.
    ///
    /// * row must be <= len_lines
    #[inline]
    fn line_at(&self, row: upos_type) -> Result<Cow<'_, str>, TextError> {
        if row == 0 {
            Ok(Cow::Borrowed(&self.text))
        } else if row == 1 {
            Ok(Cow::Borrowed(""))
        } else {
            Err(TextError::LineIndexOutOfBounds(row, 1))
        }
    }

    /// Iterate over text-lines, starting at line-offset.
    ///
    /// * row must be <= len_lines
    #[inline]
    fn lines_at(&self, row: upos_type) -> Result<impl Iterator<Item = Cow<'_, str>>, TextError> {
        if row == 0 {
            Ok(once(Cow::Borrowed(self.text.as_str())))
        } else if row == 1 {
            Ok(once(Cow::Borrowed("")))
        } else {
            Err(TextError::LineIndexOutOfBounds(row, 1))
        }
    }

    /// Return a line as an iterator over the graphemes.
    /// This contains the '\n' at the end.
    ///
    /// * row must be <= len_lines
    #[inline]
    fn line_graphemes(&self, row: upos_type) -> Result<Self::GraphemeIter<'_>, TextError> {
        if row == 0 {
            Ok(StrGraphemes::new(0, &self.text))
        } else if row == 1 {
            Ok(StrGraphemes::new(self.text.len(), ""))
        } else {
            Err(TextError::LineIndexOutOfBounds(row, 1))
        }
    }

    /// Line width of row as grapheme count.
    /// Excludes the terminating '\n'.
    ///
    /// * row must be <= len_lines
    #[inline]
    fn line_width(&self, row: upos_type) -> Result<upos_type, TextError> {
        if row == 0 {
            Ok(self.len)
        } else if row == 1 {
            Ok(0)
        } else {
            Err(TextError::LineIndexOutOfBounds(row, 1))
        }
    }

    /// Insert a char at the given position.
    ///
    /// * range must be a valid range. row <= len_lines, col <= line_width of the row.
    fn insert_char(
        &mut self,
        mut pos: TextPosition,
        c: char,
    ) -> Result<(TextRange, Range<usize>), TextError> {
        if pos == TextPosition::new(0, 1) {
            pos = TextPosition::new(self.len, 0);
        }

        if pos.y != 0 {
            return Err(TextError::TextPositionOutOfBounds(pos));
        }

        let byte_pos = self.byte_range_at(pos)?;
        let (before, after) = self.text.split_at(byte_pos.start);

        self.invalidate_cache(byte_pos.start);

        let old_len = self.len;
        self.buf.clear();
        self.buf.push_str(before);
        self.buf.push(c);
        self.buf.push_str(after);

        let before_bytes = before.len();
        let new_len = str_len(&self.buf);

        mem::swap(&mut self.text, &mut self.buf);
        self.len = new_len;

        Ok((
            TextRange::new((pos.x, 0), (pos.x + (new_len - old_len), 0)),
            before_bytes..before_bytes + c.len_utf8(),
        ))
    }

    /// Insert a str at position.
    fn insert_str(
        &mut self,
        mut pos: TextPosition,
        t: &str,
    ) -> Result<(TextRange, Range<usize>), TextError> {
        if pos == TextPosition::new(0, 1) {
            pos = TextPosition::new(self.len, 0);
        }

        if pos.y != 0 {
            return Err(TextError::TextPositionOutOfBounds(pos));
        }

        let byte_pos = self.byte_range_at(pos)?;
        let (before, after) = self.text.split_at(byte_pos.start);

        self.invalidate_cache(byte_pos.start);

        let old_len = self.len;
        self.buf.clear();
        self.buf.push_str(before);
        self.buf.push_str(t);
        self.buf.push_str(after);

        let before_bytes = before.len();
        let new_len = str_len(&self.buf);

        mem::swap(&mut self.text, &mut self.buf);
        self.len = new_len;

        Ok((
            TextRange::new((pos.x, 0), (pos.x + (new_len - old_len), 0)),
            before_bytes..before_bytes + t.len(),
        ))
    }

    /// Remove a range.
    fn remove(
        &mut self,
        mut range: TextRange,
    ) -> Result<(String, (TextRange, Range<usize>)), TextError> {
        if range.start == TextPosition::new(0, 1) {
            range.start = TextPosition::new(self.len, 0);
        }
        if range.end == TextPosition::new(0, 1) {
            range.end = TextPosition::new(self.len, 0);
        }

        if range.start.y != 0 {
            return Err(TextError::TextRangeOutOfBounds(range));
        }
        if range.end.y != 0 {
            return Err(TextError::TextRangeOutOfBounds(range));
        }

        let bytes = self.byte_range(range)?;

        self.invalidate_cache(bytes.start);

        let (before, remove, after) = (
            &self.text[..bytes.start],
            &self.text[bytes.start..bytes.end],
            &self.text[bytes.end..],
        );

        self.buf.clear();
        self.buf.push_str(before);
        self.buf.push_str(after);

        let remove_str = remove.to_string();
        let before_bytes = before.len();
        let remove_bytes = remove.len();
        let new_len = str_len(&self.buf);

        mem::swap(&mut self.text, &mut self.buf);
        self.len = new_len;

        Ok((
            remove_str,
            (range, before_bytes..before_bytes + remove_bytes),
        ))
    }

    /// Insert a string at the given byte index.
    fn insert_b(&mut self, byte_pos: usize, t: &str) -> Result<(), TextError> {
        let Some((before, after)) = self.text.split_at_checked(byte_pos) else {
            return Err(TextError::ByteIndexNotCharBoundary(byte_pos));
        };

        self.invalidate_cache(byte_pos);

        self.buf.clear();
        self.buf.push_str(before);
        self.buf.push_str(t);
        self.buf.push_str(after);
        let new_len = str_len(&self.buf);

        mem::swap(&mut self.text, &mut self.buf);
        self.len = new_len;

        Ok(())
    }

    /// Remove the given byte-range.
    fn remove_b(&mut self, byte_range: Range<usize>) -> Result<(), TextError> {
        let Some((before, after)) = self.text.split_at_checked(byte_range.start) else {
            return Err(TextError::ByteIndexNotCharBoundary(byte_range.start));
        };
        let Some((_remove, after)) = after.split_at_checked(byte_range.end - byte_range.start)
        else {
            return Err(TextError::ByteIndexNotCharBoundary(byte_range.end));
        };

        self.invalidate_cache(byte_range.start);

        self.buf.clear();
        self.buf.push_str(before);
        self.buf.push_str(after);
        let new_len = str_len(&self.buf);

        mem::swap(&mut self.text, &mut self.buf);
        self.len = new_len;

        Ok(())
    }
}