Unnamed repository; edit this file 'description' to name the repository.
Diffstat (limited to 'helix-tui/src/buffer.rs')
| -rw-r--r-- | helix-tui/src/buffer.rs | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/helix-tui/src/buffer.rs b/helix-tui/src/buffer.rs index 2cd30324..4f57e8e5 100644 --- a/helix-tui/src/buffer.rs +++ b/helix-tui/src/buffer.rs @@ -1,3 +1,4 @@ +//! Contents of a terminal screen. A [Buffer] is made up of [Cell]s. use crate::text::{Span, Spans}; use helix_core::unicode::width::UnicodeWidthStr; use std::cmp::min; @@ -5,7 +6,7 @@ use unicode_segmentation::UnicodeSegmentation; use helix_view::graphics::{Color, Modifier, Rect, Style, UnderlineStyle}; -/// A buffer cell +/// One cell of the terminal. Contains one stylized grapheme. #[derive(Debug, Clone, PartialEq, Eq)] pub struct Cell { pub symbol: String, @@ -17,28 +18,33 @@ pub struct Cell { } impl Cell { + /// Set the cell's grapheme pub fn set_symbol(&mut self, symbol: &str) -> &mut Cell { self.symbol.clear(); self.symbol.push_str(symbol); self } + /// Set the cell's grapheme to a [char] pub fn set_char(&mut self, ch: char) -> &mut Cell { self.symbol.clear(); self.symbol.push(ch); self } + /// Set the foreground [Color] pub fn set_fg(&mut self, color: Color) -> &mut Cell { self.fg = color; self } + /// Set the background [Color] pub fn set_bg(&mut self, color: Color) -> &mut Cell { self.bg = color; self } + /// Set the [Style] of the cell pub fn set_style(&mut self, style: Style) -> &mut Cell { if let Some(c) = style.fg { self.fg = c; @@ -58,6 +64,7 @@ impl Cell { self } + /// Returns the current style of the cell pub fn style(&self) -> Style { Style::default() .fg(self.fg) @@ -67,6 +74,7 @@ impl Cell { .add_modifier(self.modifier) } + /// Resets the cell to a default blank state pub fn reset(&mut self) { self.symbol.clear(); self.symbol.push(' '); @@ -495,6 +503,8 @@ impl Buffer { (x_offset as u16, y) } + /// Print at most the first `width` characters of a [Spans] if enough space is available + /// until the end of the line. Appends a `…` at the end of truncated lines. pub fn set_spans_truncated(&mut self, x: u16, y: u16, spans: &Spans, width: u16) -> (u16, u16) { // prevent panic if out of range if !self.in_bounds(x, y) || width == 0 { @@ -536,6 +546,8 @@ impl Buffer { (x_offset as u16, y) } + /// Print at most the first `width` characters of a [Spans] if enough space is available + /// until the end of the line pub fn set_spans(&mut self, x: u16, y: u16, spans: &Spans, width: u16) -> (u16, u16) { let mut remaining_width = width; let mut x = x; @@ -557,6 +569,8 @@ impl Buffer { (x, y) } + /// Print at most the first `width` characters of a [Span] if enough space is available + /// until the end of the line pub fn set_span(&mut self, x: u16, y: u16, span: &Span, width: u16) -> (u16, u16) { self.set_stringn(x, y, span.content.as_ref(), width as usize, span.style) } @@ -573,6 +587,7 @@ impl Buffer { } } + /// Set all cells in the [area](Rect) to the given [Style] pub fn set_style(&mut self, area: Rect, style: Style) { for y in area.top()..area.bottom() { for x in area.left()..area.right() { |