Allow separeate styles for cursor in normal and preview panes

This defines new `cursorfmt` and `crusorpreviewfmt` options to style cursor in normal/preview panes. This allows using a different style for the normal and preview cursor. The documentation includes several possible values these options can be set to. The default behavior is an underline, same as in gokcehan#1072, since it should not cause severe problems and be visible on all terminals. It can now be easily changed, as explained in the docs. I also added an example to `etc/lfrc.example`. See linked issues and PRs for the more context. Fixes gokcehan#1038 Follows up on: gokcehan#1072 gokcehan#924 gokcehan@b47cf6d5a5
ilyagr · Jan 19, 2023 · 1656284 · 1656284
1 parent b47cf6d
commit 1656284
Show file tree

Hide file tree

Showing 8 changed files with 270 additions and 211 deletions.
diff --git a/complete.go b/complete.go
@@ -113,6 +113,8 @@ var (
 		"autoquit",
 		"noautoquit",
 		"autoquit!",
+		"cursorfmt",
+		"cursorpreviewfmt",
 		"dircache",
 		"nodircache",
 		"dircache!",

diff --git a/doc.go b/doc.go
@@ -111,57 +111,59 @@ The following command line commands are provided by lf:
 
 The following options can be used to customize the behavior of lf:
 
-	anchorfind     bool      (default on)
-	autoquit       bool      (default off)
-	cleaner        string    (default '')
-	dircache       bool      (default on)
-	dircounts      bool      (default off)
-	dirfirst       bool      (default on)
-	dironly        bool      (default off)
-	dirpreviews    bool      (default off)
-	drawbox        bool      (default off)
-	errorfmt       string    (default "\033[7;31;47m%s\033[0m")
-	filesep        string    (default "\n")
-	findlen        int       (default 1)
-	globsearch     bool      (default off)
-	hidden         bool      (default off)
-	hiddenfiles    []string  (default '.*')
-	history        bool      (default on)
-	icons          bool      (default off)
-	ifs            string    (default '')
-	ignorecase     bool      (default on)
-	ignoredia      bool      (default on)
-	incfilter      bool      (default off)
-	incsearch      bool      (default off)
-	info           []string  (default '')
-	infotimefmtnew string    (default 'Jan _2 15:04')
-	infotimefmtold string    (default 'Jan _2  2006')
-	mouse          bool      (default off)
-	number         bool      (default off)
-	period         int       (default 0)
-	preview        bool      (default on)
-	previewer      string    (default '')
-	promptfmt      string    (default "\033[32;1m%u@%h\033[0m:\033[34;1m%d\033[0m\033[1m%f\033[0m")
-	ratios         []int     (default '1:2:3')
-	relativenumber bool      (default off)
-	reverse        bool      (default off)
-	scrolloff      int       (default 0)
-	selmode        string    (default 'all')
-	shell          string    (default 'sh' for Unix and 'cmd' for Windows)
-	shellflag      string    (default '-c' for Unix and '/c' for Windows)
-	shellopts      []string  (default '')
-	smartcase      bool      (default on)
-	smartdia       bool      (default off)
-	sortby         string    (default 'natural')
-	tabstop        int       (default 8)
-	tagfmt         string    (default "\033[31m%s\033[0m")
-	tempmarks      string    (default '')
-	timefmt        string    (default 'Mon Jan _2 15:04:05 2006')
-	truncatechar   string    (default '~')
-	waitmsg        string    (default 'Press any key to continue')
-	wrapscan       bool      (default on)
-	wrapscroll     bool      (default off)
-	user_{option}  string    (default none)
+	anchorfind       bool      (default on)
+	autoquit         bool      (default off)
+	cleaner          string    (default '')
+	cursorfmt        string    (default "\033[7m%s\033[0m")
+	cursorpreviewfmt string    (default "\033[4m%s\033[0m")
+	dircache         bool      (default on)
+	dircounts        bool      (default off)
+	dirfirst         bool      (default on)
+	dironly          bool      (default off)
+	dirpreviews      bool      (default off)
+	drawbox          bool      (default off)
+	errorfmt         string    (default "\033[7;31;47m%s\033[0m")
+	filesep          string    (default "\n")
+	findlen          int       (default 1)
+	globsearch       bool      (default off)
+	hidden           bool      (default off)
+	hiddenfiles      []string  (default '.*')
+	history          bool      (default on)
+	icons            bool      (default off)
+	ifs              string    (default '')
+	ignorecase       bool      (default on)
+	ignoredia        bool      (default on)
+	incfilter        bool      (default off)
+	incsearch        bool      (default off)
+	info             []string  (default '')
+	infotimefmtnew   string    (default 'Jan _2 15:04')
+	infotimefmtold   string    (default 'Jan _2  2006')
+	mouse            bool      (default off)
+	number           bool      (default off)
+	period           int       (default 0)
+	preview          bool      (default on)
+	previewer        string    (default '')
+	promptfmt        string    (default "\033[32;1m%u@%h\033[0m:\033[34;1m%d\033[0m\033[1m%f\033[0m")
+	ratios           []int     (default '1:2:3')
+	relativenumber   bool      (default off)
+	reverse          bool      (default off)
+	scrolloff        int       (default 0)
+	selmode          string    (default 'all')
+	shell            string    (default 'sh' for Unix and 'cmd' for Windows)
+	shellflag        string    (default '-c' for Unix and '/c' for Windows)
+	shellopts        []string  (default '')
+	smartcase        bool      (default on)
+	smartdia         bool      (default off)
+	sortby           string    (default 'natural')
+	tabstop          int       (default 8)
+	tagfmt           string    (default "\033[31m%s\033[0m")
+	tempmarks        string    (default '')
+	timefmt          string    (default 'Mon Jan _2 15:04:05 2006')
+	truncatechar     string    (default '~')
+	waitmsg          string    (default 'Press any key to continue')
+	wrapscan         bool      (default on)
+	wrapscroll       bool      (default off)
+	user_{option}    string    (default none)
 
 The following environment variables are exported for shell commands:
 
@@ -606,6 +608,16 @@ This file is called if previewing is enabled, the previewer is set, and the prev
 Five arguments are passed to the file, (1) current file name, (2) width, (3) height, (4) horizontal position, and (5) vertical position of preview pane respectively.
 Preview clearing is disabled when the value of this option is left empty.
 
+	cursorfmt         string    (default "\033[7m%s\033[0m")
+	cursorpreviewfmt  string    (default "\033[4m%s\033[0m")
+
+Format strings for highlighting the cursor.
+`cursorpreviewfmt` applies in panes that preview directories, and `cursorfmt` applies in all other panes.
+
+The default is to make the normal cursor inverted and the preview cursor underlined.
+
+Some other possibilities to consider for the preview cursor: "%s" for no cursor, "\033[7;2m%s\044[0m" for dimmed inverted text (visibility varies by terminal), "\033[7;90m%s\044[0m" for inverted text with grey background.
+
 	dircache       bool      (default on)
 
 Cache directory contents.

diff --git a/docstring.go b/docstring.go
diff --git a/etc/lfrc.example b/etc/lfrc.example
@@ -20,6 +20,9 @@ set ifs "\n"
 # leave some space at the top and the bottom of the screen
 set scrolloff 10
 
+# Use the `dim` attribute instead of underline for the cursor in the preview pane
+set cursorpreviewfmt "\033[7;2m%s\033[0m"
+
 # use enter for shell commands
 map <enter> shell
 

diff --git a/eval.go b/eval.go
@@ -26,6 +26,10 @@ func (e *setExpr) eval(app *app, args []string) {
 		gOpts.autoquit = true
 	case "noautoquit":
 		gOpts.autoquit = false
+	case "cursorfmt":
+		gOpts.cursorfmt = e.val
+	case "cursorpreviewfmt":
+		gOpts.cursorpreviewfmt = e.val
 	case "autoquit!":
 		gOpts.autoquit = !gOpts.autoquit
 	case "dircache":