Skip to content

Commit

Permalink
Allow to use character to draw rulers
Browse files Browse the repository at this point in the history
  • Loading branch information
codingjerk committed Sep 29, 2024
1 parent 2ce4c6d commit 6ae04aa
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 3 deletions.
1 change: 1 addition & 0 deletions book/src/editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
| `true-color` | Set to `true` to override automatic detection of terminal truecolor support in the event of a false negative | `false` |
| `undercurl` | Set to `true` to override automatic detection of terminal undercurl support in the event of a false negative | `false` |
| `rulers` | List of column positions at which to display the rulers. Can be overridden by language specific `rulers` in `languages.toml` file | `[]` |
| `ruler-char` | Specifies the character used to display the rulers. When unset, the rulers will be indicated by a subtle background or style change, depending on the theme in use | `none` |
| `bufferline` | Renders a line at the top of the editor displaying open buffers. Can be `always`, `never` or `multiple` (only shown if more than one buffer is in use) | `never` |
| `color-modes` | Whether to color the mode indicator with different colors depending on the mode itself | `false` |
| `text-width` | Maximum line length. Used for the `:reflow` command and soft-wrapping if `soft-wrap.wrap-at-text-width` is set | `80` |
Expand Down
1 change: 1 addition & 0 deletions book/src/themes.md
Original file line number Diff line number Diff line change
Expand Up @@ -307,6 +307,7 @@ These scopes are used for theming the editor interface:
| `ui.text.inactive` | Same as `ui.text` but when the text is inactive (e.g. suggestions) |
| `ui.text.info` | The key: command text in `ui.popup.info` boxes |
| `ui.virtual.ruler` | Ruler columns (see the [`editor.rulers` config][editor-section]) |
| `ui.virtual.ruler.char` | Ruler columns, ([only if `editor.ruler-char` is set][editor-section] |
| `ui.virtual.whitespace` | Visible whitespace characters |
| `ui.virtual.indent-guide` | Vertical indent width guides |
| `ui.virtual.inlay-hint` | Default style for inlay hints of all kinds |
Expand Down
23 changes: 20 additions & 3 deletions helix-term/src/ui/editor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,9 @@ impl EditorView {
inline_diagnostic_config,
config.end_of_line_diagnostics,
));

Self::render_rulers(editor, doc, view, inner, surface, theme);

render_document(
surface,
inner,
Expand All @@ -212,7 +215,6 @@ impl EditorView {
theme,
decorations,
);
Self::render_rulers(editor, doc, view, inner, surface, theme);

// if we're not at the edge of the screen, draw a right border
if viewport.right() != view.area.right() {
Expand Down Expand Up @@ -252,8 +254,15 @@ impl EditorView {
theme: &Theme,
) {
let editor_rulers = &editor.config().rulers;
let editor_ruler_char = editor.config().ruler_char.map(|c| c.to_string());

let theme_key = match &editor_ruler_char {
None => "ui.virtual.ruler",
Some(_) => "ui.virtual.ruler.char",
};

let ruler_theme = theme
.try_get("ui.virtual.ruler")
.try_get(theme_key)
.unwrap_or_else(|| Style::default().bg(Color::Red));

let rulers = doc
Expand All @@ -270,7 +279,15 @@ impl EditorView {
.filter_map(|ruler| ruler.checked_sub(1 + view_offset.horizontal_offset as u16))
.filter(|ruler| ruler < &viewport.width)
.map(|ruler| viewport.clip_left(ruler).with_width(1))
.for_each(|area| surface.set_style(area, ruler_theme))
.for_each(|area| {
if let Some(ruler_char) = &editor_ruler_char {
for y in area.y..area.height {
surface.set_string(area.x, y, ruler_char, ruler_theme)
}
} else {
surface.set_style(area, ruler_theme)
}
})
}

fn viewport_byte_range(
Expand Down
3 changes: 3 additions & 0 deletions helix-view/src/editor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,8 @@ pub struct Config {
pub terminal: Option<TerminalConfig>,
/// Column numbers at which to draw the rulers. Defaults to `[]`, meaning no rulers.
pub rulers: Vec<u16>,
/// Character used to draw the rulers when specified. If `None`, rulers are drawn using style only.
pub ruler_char: Option<char>,
#[serde(default)]
pub whitespace: WhitespaceConfig,
/// Persistently display open buffers along the top
Expand Down Expand Up @@ -963,6 +965,7 @@ impl Default for Config {
lsp: LspConfig::default(),
terminal: get_terminal_provider(),
rulers: Vec::new(),
ruler_char: None,
whitespace: WhitespaceConfig::default(),
bufferline: BufferLine::default(),
indent_guides: IndentGuidesConfig::default(),
Expand Down

0 comments on commit 6ae04aa

Please sign in to comment.