Added zen-view mode

Author: lizclipse

book/src/configuration.md

@@ -94,7 +94,7 @@ The `[editor.statusline]` key takes the following sub-keys:
 
 | Key           | Description | Default |
 | ---           | ---         | ---     |
-| `left`        | A list of elements aligned to the left of the statusline | `["mode", "spinner", "file-name", "read-only-indicator", "file-modification-indicator"]` |
+| `left`        | A list of elements aligned to the left of the statusline | `["mode", "spinner", "file-name", "read-only-indicator", "zoom", "file-modification-indicator"]` |
 | `center`      | A list of elements aligned to the middle of the statusline | `[]` |
 | `right`       | A list of elements aligned to the right of the statusline | `["diagnostics", "selections", "register", "position", "file-encoding"]` |
 | `separator`   | The character used to separate elements in the statusline | `"│"` |
@@ -127,6 +127,7 @@ The following statusline elements can be configured:
 | `spacer` | Inserts a space between elements (multiple/contiguous spacers may be specified) |
 | `version-control` | The current branch name or detached commit hash of the opened workspace |
 | `register` | The current selected register |
+| `zoom` | The current window zoom/zen state |
 
 ### `[editor.lsp]` Section
 
@@ -402,3 +403,20 @@ S-tab = "move_parent_node_start"
 tab = "extend_parent_node_end"
 S-tab = "extend_parent_node_start"
 ```
+
+### `[editor.zen-view]` Section
+
+Options for the zen-view mode.
+
+Zen-view will center the currently-focused editor on the screen and hide all the others, useful for when you want to focus on editing
+a single file with either a wider monitor or if you have a lot of splits at once.
+
+| Key          | Description | Default |
+|--------------|-------------|---------|
+| `max-width`  | The maximum width that the zen-view will take up. | `120` |
+| `auto-enter` | Whether zen-view should be automatically entered on startup. Can be one of `"off"` (never auto-enter), `"single-file"` (only auto-enter if Helix is opened with a single file), `"multi-file"` (only auto-enter if opened with >1 files), `"always"` (always start in zen-view). | `"off"` |
+
+#### `[editor.zen-view.gutters]` Section
+
+Same as the [normal gutters](#editorgutters-section) option, but specifically for zen-view.
+It only supports the `layout` option currently (including setting `gutters = [...]` directly).

book/src/keymap.md

@@ -195,6 +195,7 @@ useful when you're simply looking over text and not actively editing it.
 | `Ctrl-b`, `PageUp`   | Move page up                                              | `page_up`               |
 | `Ctrl-u`             | Move cursor and page half page up                         | `page_cursor_half_up`   |
 | `Ctrl-d`             | Move cursor and page half page down                       | `page_cursor_half_down` |
+| `Z`                  | Toggle 'zen-mode' for the focused view                    | `toggle_zen_view`       |
 
 #### Goto mode
 

helix-term/src/application.rs

@@ -204,6 +204,12 @@ impl Application {
                     nr_of_files,
                     if nr_of_files == 1 { "" } else { "s" } // avoid "Loaded 1 files." grammo
                 ));
+                editor.tree.zoom = editor
+                    .config()
+                    .zen_view
+                    .auto_enter
+                    .should_enter(nr_of_files);
+                editor.tree.recalculate();
                 // align the view to center after all files are loaded,
                 // does not affect views without pos since it is at the top
                 let (view, doc) = current!(editor);

helix-term/src/commands.rs

@@ -457,6 +457,8 @@ impl MappableCommand {
         vsplit_new, "Vertical right split scratch buffer",
         wclose, "Close window",
         wonly, "Close windows except current",
+        toggle_zoom, "Toggle zoom for current window",
+        toggle_zen_view, "Toggle zen view for current window",
         select_register, "Select register",
         insert_register, "Insert register",
         align_view_middle, "Align view middle",
@@ -5119,6 +5121,22 @@ fn wonly(cx: &mut Context) {
     }
 }
 
+fn toggle_zoom(cx: &mut Context) {
+    cx.editor.tree.zoom = match cx.editor.tree.zoom {
+        Some(tree::ZoomMode::Normal) => None,
+        _ => Some(tree::ZoomMode::Normal),
+    };
+    cx.editor.tree.recalculate();
+}
+
+fn toggle_zen_view(cx: &mut Context) {
+    cx.editor.tree.zoom = match cx.editor.tree.zoom {
+        Some(tree::ZoomMode::Zen) => None,
+        _ => Some(tree::ZoomMode::Zen),
+    };
+    cx.editor.tree.recalculate();
+}
+
 fn select_register(cx: &mut Context) {
     cx.editor.autoinfo = Some(Info::from_registers(&cx.editor.registers));
     cx.on_next_key(move |cx, event| {

helix-term/src/keymap/default.rs

@@ -205,6 +205,8 @@ pub fn default() -> HashMap<Mode, KeyTrie> {
                 "C-s" | "s" => hsplit_new,
                 "C-v" | "v" => vsplit_new,
             },
+            "z" => toggle_zoom,
+            "Z" => toggle_zen_view,
         },
 
         // move under <space>c
@@ -270,6 +272,8 @@ pub fn default() -> HashMap<Mode, KeyTrie> {
                     "C-s" | "s" => hsplit_new,
                     "C-v" | "v" => vsplit_new,
                 },
+                "z" => toggle_zoom,
+                "Z" => toggle_zen_view,
             },
             "y" => yank_to_clipboard,
             "Y" => yank_main_selection_to_clipboard,

helix-term/src/ui/editor.rs

@@ -666,7 +666,14 @@ impl EditorView {
         let gutter_style_virtual = theme.get("ui.gutter.virtual");
         let gutter_selected_style_virtual = theme.get("ui.gutter.selected.virtual");
 
-        for gutter_type in view.gutters() {
+        let config = editor.config();
+        let gutters = if matches!(editor.tree.zoom, Some(helix_view::tree::ZoomMode::Zen)) {
+            &config.zen_view.gutters.layout
+        } else {
+            view.gutters()
+        };
+
+        for gutter_type in gutters {
             let mut gutter = gutter_type.style(editor, doc, view, theme, is_focused);
             let width = gutter_type.width(view, doc);
             // avoid lots of small allocations by reusing a text buffer for each line
@@ -1499,8 +1506,10 @@ impl Component for EditorView {
         }
 
         for (view, is_focused) in cx.editor.tree.views() {
-            let doc = cx.editor.document(view.doc).unwrap();
-            self.render_view(cx.editor, doc, view, area, surface, is_focused);
+            if cx.editor.tree.zoom.is_none() || is_focused {
+                let doc = cx.editor.document(view.doc).unwrap();
+                self.render_view(cx.editor, doc, view, area, surface, is_focused);
+            }
         }
 
         if config.auto_info {

helix-term/src/ui/statusline.rs

@@ -155,6 +155,7 @@ fn get_render_function<'a>(
         helix_view::editor::StatusLineElement::Spacer => render_spacer,
         helix_view::editor::StatusLineElement::VersionControl => render_version_control,
         helix_view::editor::StatusLineElement::Register => render_register,
+        helix_view::editor::StatusLineElement::Zoom => render_zoom,
     }
 }
 
@@ -459,3 +460,13 @@ fn render_register<'a>(context: &RenderContext) -> Spans<'a> {
         Spans::default()
     }
 }
+
+fn render_zoom<'a>(context: &RenderContext) -> Spans<'a> {
+    let Some(zoom) = context.editor.tree.zoom else { return Spans::default() };
+
+    use helix_view::tree::ZoomMode as E;
+    match zoom {
+        E::Normal => "[zoom]".into(),
+        E::Zen => "[zen]".into(),
+    }
+}

helix-view/src/editor.rs

@@ -7,7 +7,7 @@ use crate::{
     input::KeyEvent,
     register::Registers,
     theme::{self, Theme},
-    tree::{self, Tree},
+    tree::{self, Tree, ZoomMode},
     view::ViewPosition,
     Align, Document, DocumentId, View, ViewId,
 };
@@ -336,6 +336,9 @@ pub struct Config {
         deserialize_with = "deserialize_alphabet"
     )]
     pub jump_label_alphabet: Vec<char>,
+    /// Zen-view config.
+    #[serde(default)]
+    pub zen_view: ZenViewConfig,
 }
 
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, Eq, PartialOrd, Ord)]
@@ -469,6 +472,7 @@ impl Default for StatusLineConfig {
                 E::Spinner,
                 E::FileName,
                 E::ReadOnlyIndicator,
+                E::Zoom,
                 E::FileModificationIndicator,
             ],
             center: vec![],
@@ -568,6 +572,9 @@ pub enum StatusLineElement {
 
     /// Indicator for selected register
     Register,
+
+    /// Current zoom/zen state
+    Zoom,
 }
 
 // Cursor shape is read and used on every rendered frame and so needs
@@ -862,6 +869,69 @@ pub enum PopupBorderConfig {
     Menu,
 }
 
+#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
+#[serde(rename_all = "kebab-case")]
+pub struct ZenViewConfig {
+    #[serde(default = "ZenViewConfig::default_max_width")]
+    pub max_width: u16,
+    #[serde(default)]
+    pub auto_enter: ZenViewAutoEnter,
+    // Currently the line-numbers option isn't used, but it will
+    // be once the updated config system is implemented in #9318
+    // TODO(lizclipse): Once that PR is in implement the per-mode line_numbers config
+    #[serde(default = "ZenViewConfig::default_gutters")]
+    pub gutters: GutterConfig,
+}
+
+impl ZenViewConfig {
+    const fn default_max_width() -> u16 {
+        120
+    }
+
+    fn default_gutters() -> GutterConfig {
+        GutterConfig {
+            layout: vec![],
+            ..Default::default()
+        }
+    }
+}
+
+impl Default for ZenViewConfig {
+    fn default() -> Self {
+        Self {
+            max_width: Self::default_max_width(),
+            auto_enter: ZenViewAutoEnter::default(),
+            gutters: Self::default_gutters(),
+        }
+    }
+}
+
+#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
+#[serde(rename_all = "kebab-case")]
+pub enum ZenViewAutoEnter {
+    Off,
+    SingleFile,
+    MultiFile,
+    Always,
+}
+
+impl ZenViewAutoEnter {
+    pub fn should_enter(&self, files: i32) -> Option<ZoomMode> {
+        match self {
+            Self::Always => Some(ZoomMode::Zen),
+            Self::SingleFile if files == 1 => Some(ZoomMode::Zen),
+            Self::MultiFile if files > 1 => Some(ZoomMode::Zen),
+            _ => None,
+        }
+    }
+}
+
+impl Default for ZenViewAutoEnter {
+    fn default() -> Self {
+        Self::Off
+    }
+}
+
 impl Default for Config {
     fn default() -> Self {
         Self {
@@ -913,6 +983,7 @@ impl Default for Config {
             popup_border: PopupBorderConfig::None,
             indent_heuristic: IndentationHeuristic::default(),
             jump_label_alphabet: ('a'..='z').collect(),
+            zen_view: ZenViewConfig::default(),
         }
     }
 }
@@ -1087,13 +1158,19 @@ impl Editor {
         let language_servers = helix_lsp::Registry::new(syn_loader.clone());
         let conf = config.load();
         let auto_pairs = (&conf.auto_pairs).into();
+        let mut tree = Tree::new(area);
+        tree.zen_max_width = conf.zen_view.max_width;
+        tree.zoom = match conf.zen_view.auto_enter {
+            ZenViewAutoEnter::Always => Some(ZoomMode::Zen),
+            _ => None,
+        };
 
         // HAXX: offset the render area height by 1 to account for prompt/commandline
         area.height -= 1;
 
         Self {
             mode: Mode::Normal,
-            tree: Tree::new(area),
+            tree,
             next_document_id: DocumentId::default(),
             documents: BTreeMap::new(),
             saves: HashMap::new(),
@@ -1169,6 +1246,8 @@ impl Editor {
     pub fn refresh_config(&mut self) {
         let config = self.config();
         self.auto_pairs = (&config.auto_pairs).into();
+        self.tree.zen_max_width = config.zen_view.max_width;
+        self.tree.recalculate();
         self.reset_idle_timer();
         self._refresh();
     }

helix-view/src/tree.rs

@@ -8,8 +8,11 @@ pub struct Tree {
     root: ViewId,
     // (container, index inside the container)
     pub focus: ViewId,
-    // fullscreen: bool,
     area: Rect,
+    // Maximum width to aim for when in zen-view.
+    pub zen_max_width: u16,
+    // The current zoom state.
+    pub zoom: Option<ZoomMode>,
 
     nodes: HopSlotMap<ViewId, Node>,
 
@@ -29,6 +32,12 @@ pub enum Content {
     Container(Box<Container>),
 }
 
+#[derive(Debug, Clone, Copy)]
+pub enum ZoomMode {
+    Normal,
+    Zen,
+}
+
 impl Node {
     pub fn container(layout: Layout) -> Self {
         Self {
@@ -98,6 +107,8 @@ impl Tree {
             focus: root,
             // fullscreen: false,
             area,
+            zen_max_width: 150,
+            zoom: None,
             nodes,
             stack: Vec::new(),
         }
@@ -360,6 +371,26 @@ impl Tree {
             return;
         }
 
+        if let Some(zoom) = self.zoom {
+            let width = match (zoom, self.zen_max_width) {
+                (ZoomMode::Normal, _) => self.area.width,
+                (ZoomMode::Zen, max_width) if max_width == 0 => self.area.width,
+                (ZoomMode::Zen, max_width) => std::cmp::min(max_width, self.area.width),
+            };
+            let area = Rect::new(
+                self.area.width / 2 - width / 2,
+                self.area.y,
+                width,
+                self.area.height,
+            );
+
+            for (view, _focused) in self.views_mut() {
+                view.area = area;
+            }
+
+            return;
+        }
+
         self.stack.push((self.root, self.area));
 
         // take the area