feat: opt-in internal clipboard

Author: NathanRoyer

README.md

@@ -41,6 +41,7 @@ See [how-to-use.md](assets/how-to-use.md) in the `assets` folder.
 ## Using the Clipboard
 
 `hop` relies on external executables for clipboard management.
+If this is a problem for you, try setting `internal-clipboard` to `true` in your config.
 
 #### Copying with Ctrl + C
 
@@ -66,9 +67,10 @@ There you will also find a default syntax file.
 
 ### TOML Contents
 
-- `background`: hexadecimal color code for the background
-- `tree-width`: decimal number of columns for the file tree
-- `syntax-file`: path to a syntax file for syntax highligting
+- `internal-clipboard`: set to `true` if you don't want to use the system-wide clipboard
 - `hide-folders`: list of folders to hide in the file tree
-- `hover`: hexadecimal color code for hovering color (tree & tabs)
+- `syntax-file`: path to a syntax file for syntax highligting
+- `tree-width`: decimal number of columns for the file tree
+- `background`: hexadecimal color code for the background
 - `syntax`: map of syntax token types to hexadecimal color codes
+- `hover`: hexadecimal color code for hovering color (tree & tabs)

assets/config.toml

@@ -1,6 +1,8 @@
 [general]
 # syntax-file = '/opt/syntax.toml'
 # background = '#111'
+
+internal-clipboard = true
 hide-folders = ['.git', 'target']
 tree-width = 30
 hover = '#444'

src/config.rs

@@ -24,6 +24,7 @@ struct General {
     background: Option<HexColor>,
     syntax_file: Option<String>,
     hide_folders: Vec<String>,
+    internal_clipboard: bool,
     hover: HexColor,
     tree_width: u16,
 }
@@ -119,6 +120,10 @@ pub fn hide_folder(folder: &String) -> bool {
     config().general.hide_folders.contains(folder)
 }
 
+pub fn internal_clipboard() -> bool {
+    config().general.internal_clipboard
+}
+
 pub fn ansi_color(name: &str) -> Color {
     color(config().syntax.get(name))
 }

src/main.rs

@@ -348,23 +348,25 @@ fn main() -> Result<(), &'static str> {
 
     for arg in args {
         let Ok(path) = fs::canonicalize(arg) else {
+            restore_term();
             return Err("invalid path");
         };
 
         let Some(path_str) = path.to_str().map(String::from) else {
+            restore_term();
             return Err("invalid path");
         };
 
         if path.is_dir() {
             globals.tree.add_folder(path_str);
         } else if let Err(err) = globals.tabs.open(&globals.syntaxes, path_str) {
+            restore_term();
             println!("{err:?}");
             return Err("failed to open some files");
         }
     }
 
     globals.run();
-
     globals.interface.close();
 
     Ok(())

src/tab/clipboard.rs

@@ -1,4 +1,5 @@
 use std::process::Command;
+use crate::config::internal_clipboard;
 use super::*;
 
 const TMP_PATH: &str = "/tmp/hop-clipboard.txt";
@@ -17,6 +18,11 @@ impl Tab {
             }
         }
 
+        if internal_clipboard() {
+            self.internal_clipboard = text;
+            return;
+        }
+
         if let Err(error) = fs::write(TMP_PATH, text) {
             confirm!("failed to write clipboard-file ({TMP_PATH}):\n{error:?}");
             return;
@@ -31,14 +37,19 @@ impl Tab {
     }
 
     pub fn paste(&mut self) {
-        try_exec(false);
+        let mut text = take(&mut self.internal_clipboard);
+        let cursors = self.cursors.len();
 
-        let Ok(text) = fs::read_to_string(TMP_PATH) else {
-            confirm!("failed to read clipboard-file ({TMP_PATH})");
-            return;
-        };
+        if !internal_clipboard() {
+            try_exec(false);
 
-        let cursors = self.cursors.len();
+            let Ok(contents) = fs::read_to_string(TMP_PATH) else {
+                confirm!("failed to read clipboard-file ({TMP_PATH})");
+                return;
+            };
+
+            text = contents;
+        }
 
         if cursors > 1 {
             let regions = text.split(DELIMITER).count();
@@ -106,6 +117,8 @@ fn try_exec(copy: bool) {
 
     if !success {
         let ln1 = "failed to use wl-clipboard, xclip or macOS equivalents.";
-        confirm!("{ln1}\nplease make sure at least one of these works.");
+        let ln2 = "please make sure at least one of these works.";
+        let ln3 = "alternatively, set `internal-clipboard` to `true` in config.";
+        confirm!("{ln1}\n{ln2}\n{ln3}");
     }
 }

src/tab/mod.rs

@@ -37,6 +37,7 @@ pub struct DirtyLine<'a> {
 pub struct Tab {
     file_path: Option<String>,
     tmp_buf: String,
+    internal_clipboard: String,
     name: Arc<str>,
     lines: Vec<Line>,
     scroll: isize,
@@ -148,6 +149,7 @@ impl Tab {
             name,
             lines: vec![line],
             scroll: 0,
+            internal_clipboard: String::new(),
             cursors: vec![Cursor::new(0)],
             modified: false,
             tab_width_m1: 3,