Merge branch 'master' into log

Author: CatsDeservePets

CHANGELOG.md

@@ -17,11 +17,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 - The `cmd-history-next` and `cmd-history-prev` commands will now select only matching entries if part of the command is typed beforehand (#2161). Consecutive duplicate entries will also be skipped for convenience.
 - The string representation of commands shown when displaying keybindings is simplified (e.g. `cd ~` instead of `cd -- [~]`) (#2165).
 - `yes-no-prompts` now use the same design everywhere (#2212).
+- Logs generated by `-log <path>` now get appended to `<path>` instead of overwriting it (#2215).
 
 ### Added
 
 - A new command `cmd-menu-discard` is added to allow exiting the completion menu with completions discarded (#2146).
 - The `lf_mode` environment variable will now be set to `compmenu` if the completion menu is active (#2146).
+- A `ruler` config file is added as an alternate method for customizing the ruler (#2186). This is intended to eventually replace the existing `rulerfmt`/`statfmt` options and must be enabled using the new `rulerfile` option. **This feature is currently experimental.**
 
 ### Fixed
 
@@ -31,6 +33,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 - A bug where the `source` command does not show an error message upon failure is now fixed (#2189).
 - The `addcustominfo` command as well as the `cleaner` and `previewer` options now support file completions (#2198) (#2211).
 - A bug where an empty `custom` info property would still take up space is now fixed (#2208).
+- A bug where setting `drawbox` could lead to scrolling outside the view is now fixed (#2210) (#2218).
+- The preview cache is now not cleared when setting `ratios` to its current value (#2218).
 
 ## [r38](https://github.com/gokcehan/lf/releases/tag/r38)
 

app.go

@@ -149,7 +149,7 @@ func loadFiles() (clipboard clipboard, err error) {
 		return
 	}
 
-	infof("loading files: %v", clipboard.paths)
+	infof("loading clipboard: %v", clipboard.paths)
 
 	return
 }
@@ -165,7 +165,7 @@ func saveFiles(clipboard clipboard) error {
 	}
 	defer files.Close()
 
-	infof("saving files: %v", clipboard.paths)
+	infof("saving clipboard: %v", clipboard.paths)
 
 	if clipboard.mode == clipboardCopy {
 		fmt.Fprintln(files, "copy")
@@ -329,8 +329,7 @@ func (app *app) loop() {
 
 			app.nav.previewChan <- ""
 
-			pid := os.Getpid()
-			infof("*************** closing client, PID: %d ***************", pid)
+			infof("*************** closing client, PID: %d ***************", os.Getpid())
 
 			return
 		case n := <-app.nav.copyJobsChan:

client.go

@@ -27,7 +27,7 @@ func init() {
 
 func run() {
 	if gLogPath != "" {
-		f, err := os.OpenFile(gLogPath, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0o600)
+		f, err := os.OpenFile(gLogPath, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0o600)
 		if err != nil {
 			log.Fatalf("failed to open log file: %s", err)
 		}
@@ -53,7 +53,7 @@ func run() {
 	screen.EnablePaste()
 
 	ui := newUI(screen)
-	nav := newNav(ui.wins[0].h)
+	nav := newNav(ui)
 	app := newApp(ui, nav)
 
 	if err := nav.sync(); err != nil {

doc.md

@@ -299,6 +299,7 @@ The following options can be used to customize the behavior of lf:
 	relativenumber    bool      (default false)
 	reverse           bool      (default false)
 	roundbox          bool      (default false)
+	rulerfile         bool      (default false)
 	rulerfmt          string    (default "  %a|  %p|  \033[7;31m %m \033[0m|  \033[7;33m %c \033[0m|  \033[7;35m %s \033[0m|  \033[7;36m %v \033[0m|  \033[7;34m %f \033[0m|  %i/%t")
 	scrolloff         int       (default 0)
 	searchmethod      string    (default 'text')
@@ -447,6 +448,12 @@ The icons file should be located at:
 	Unix     /etc/lf/icons             ~/.config/lf/icons
 	Windows  C:\ProgramData\lf\icons   C:\Users\<user>\AppData\Roaming\lf\icons
 
+The ruler file should be located at:
+
+	OS       system-wide               user-specific
+	Unix     /etc/lf/ruler             ~/.config/lf/ruler
+	Windows  C:\ProgramData\lf\ruler   C:\Users\<user>\AppData\Roaming\lf\ruler
+
 The selection file should be located at:
 
 	Unix     ~/.local/share/lf/files
@@ -1089,6 +1096,11 @@ Reverse the direction of sort.
 
 Draw rounded outer corners when the `drawbox` option is enabled.
 
+## rulerfile (bool) (default false)
+
+Use the ruler file instead of the `rulerfmt` and `statfmt` options when drawing the ruler at the bottom.
+Refer to the [RULER section](https://github.com/gokcehan/lf/blob/master/doc.md#ruler) for more information about how the ruler file works.
+
 ## rulerfmt (string) (default `  %a|  %p|  \033[7;31m %m \033[0m|  \033[7;33m %c \033[0m|  \033[7;35m %s \033[0m|  \033[7;36m %v \033[0m|  \033[7;34m %f \033[0m|  %i/%t`)
 
 Format string of the ruler shown in the bottom right corner.
@@ -2187,3 +2199,52 @@ https://github.com/gokcehan/lf/blob/master/etc/icons.example
 
 A sample colored icons file can be found at
 https://github.com/gokcehan/lf/blob/master/etc/icons_colored.example
+
+# RULER
+
+The ruler can be configured using a ruler file (refer to the [CONFIGURATION section](https://github.com/gokcehan/lf/blob/master/doc.md#configuration)).
+The contents of the ruler file should be a Go template which is then rendered to create the actual output (refer to https://pkg.go.dev/text/template for more details on the syntax).
+This feature is currently experimental and must be enabled via the `rulerfile` option.
+
+The following data fields are exported:
+
+	.Message          string              Includes internal messages, errors, and messages generated by the `echo`/`echomsg`/`echoerr` commands
+	.Keys             string              Keys pressed by the user
+	.Progress         []string            Progress indicators for copied, moved and deleted files
+	.Copy             []string            List of files in the clipboard to be copied
+	.Cut              []string            List of files in the clipboard to be moved
+	.Select           []string            Selection list
+	.Visual           []string            Visual selection
+	.Index            int                 Index of the cursor
+	.Total            int                 Number of visible files in the current directory
+	.Hidden           int                 Number of hidden files in the current directory
+	.LinePercentage   string              Line percentage (analagous to `%p` for the `statusline` option in Vim)
+	.ScrollPercentage string              Scroll percentage (analagous to `%P` for the `statusline` option in Vim)
+	.Filter           []string            Filter currently being applied
+	.Mode             string              Current mode ("NORMAL" for Normal mode, and "VISUAL" for Visual mode)
+	.Options          map[string]string   The value of options (e.g. `{{.Options.hidden}}`)
+	.UserOptions      map[string]string   The value of user-defined options (e.g. `{{.UserOptions.foo}}`)
+	.Stat.Path        string              Path of the current file
+	.Stat.Name        string              Name of the current file
+	.Stat.Size        uint64              Size of the current file
+	.Stat.Permissions string              Permissions of the current file
+	.Stat.ModTime     string              Last modified time of the current file (formatted based on the `timefmt` option)
+	.Stat.LinkCount   string              Number of hard links for the current file
+	.Stat.User        string              User of the current file
+	.Stat.Group       string              Group of the current file
+	.Stat.Target      string              Target if the current file is a symbolic link, otherwise a blank string
+
+The following functions are exported:
+
+	df       func() string                   Get an indicator representing the amount of free disk space available
+	env      func(string) string             Get the value of an environment variable
+	humanize func(uint64) string             Express a file size in a human-readable format
+	join     func([]string, string) string   Join a string array by a separator
+	lower    func(string) string             Convert a string to lowercase
+	substr   func(string, int, int) string   Get a substring based on starting index and length
+	upper    func(string) string             Convert a string to uppercase
+
+The special identifier `{{.SPACER}}` can be used to divide the ruler into sections that are spaced evenly from each other.
+
+The default ruler file can be found at
+https://github.com/gokcehan/lf/blob/master/etc/ruler.default

doc.txt

@@ -311,6 +311,7 @@ The following options can be used to customize the behavior of lf:
     relativenumber    bool      (default false)
     reverse           bool      (default false)
     roundbox          bool      (default false)
+    rulerfile         bool      (default false)
     rulerfmt          string    (default "  %a|  %p|  \033[7;31m %m \033[0m|  \033[7;33m %c \033[0m|  \033[7;35m %s \033[0m|  \033[7;36m %v \033[0m|  \033[7;34m %f \033[0m|  %i/%t")
     scrolloff         int       (default 0)
     searchmethod      string    (default 'text')
@@ -461,6 +462,12 @@ The icons file should be located at:
     Unix     /etc/lf/icons             ~/.config/lf/icons
     Windows  C:\ProgramData\lf\icons   C:\Users\<user>\AppData\Roaming\lf\icons
 
+The ruler file should be located at:
+
+    OS       system-wide               user-specific
+    Unix     /etc/lf/ruler             ~/.config/lf/ruler
+    Windows  C:\ProgramData\lf\ruler   C:\Users\<user>\AppData\Roaming\lf\ruler
+
 The selection file should be located at:
 
     Unix     ~/.local/share/lf/files
@@ -1181,6 +1188,12 @@ roundbox (bool) (default false)
 
 Draw rounded outer corners when the drawbox option is enabled.
 
+rulerfile (bool) (default false)
+
+Use the ruler file instead of the rulerfmt and statfmt options when
+drawing the ruler at the bottom. Refer to the RULER section for more
+information about how the ruler file works.
+
 rulerfmt (string) (default   %a|  %p|  \033[7;31m %m \033[0m|  \033[7;33m %c \033[0m|  \033[7;35m %s \033[0m|  \033[7;36m %v \033[0m|  \033[7;34m %f \033[0m|  %i/%t)
 
 Format string of the ruler shown in the bottom right corner.
@@ -2451,3 +2464,56 @@ https://github.com/gokcehan/lf/blob/master/etc/icons.example
 
 A sample colored icons file can be found at
 https://github.com/gokcehan/lf/blob/master/etc/icons_colored.example
+
+RULER
+
+The ruler can be configured using a ruler file (refer to the
+CONFIGURATION section). The contents of the ruler file should be a Go
+template which is then rendered to create the actual output (refer to
+https://pkg.go.dev/text/template for more details on the syntax). This
+feature is currently experimental and must be enabled via the rulerfile
+option.
+
+The following data fields are exported:
+
+    .Message          string              Includes internal messages, errors, and messages generated by the `echo`/`echomsg`/`echoerr` commands
+    .Keys             string              Keys pressed by the user
+    .Progress         []string            Progress indicators for copied, moved and deleted files
+    .Copy             []string            List of files in the clipboard to be copied
+    .Cut              []string            List of files in the clipboard to be moved
+    .Select           []string            Selection list
+    .Visual           []string            Visual selection
+    .Index            int                 Index of the cursor
+    .Total            int                 Number of visible files in the current directory
+    .Hidden           int                 Number of hidden files in the current directory
+    .LinePercentage   string              Line percentage (analagous to `%p` for the `statusline` option in Vim)
+    .ScrollPercentage string              Scroll percentage (analagous to `%P` for the `statusline` option in Vim)
+    .Filter           []string            Filter currently being applied
+    .Mode             string              Current mode ("NORMAL" for Normal mode, and "VISUAL" for Visual mode)
+    .Options          map[string]string   The value of options (e.g. `{{.Options.hidden}}`)
+    .UserOptions      map[string]string   The value of user-defined options (e.g. `{{.UserOptions.foo}}`)
+    .Stat.Path        string              Path of the current file
+    .Stat.Name        string              Name of the current file
+    .Stat.Size        uint64              Size of the current file
+    .Stat.Permissions string              Permissions of the current file
+    .Stat.ModTime     string              Last modified time of the current file (formatted based on the `timefmt` option)
+    .Stat.LinkCount   string              Number of hard links for the current file
+    .Stat.User        string              User of the current file
+    .Stat.Group       string              Group of the current file
+    .Stat.Target      string              Target if the current file is a symbolic link, otherwise a blank string
+
+The following functions are exported:
+
+    df       func() string                   Get an indicator representing the amount of free disk space available
+    env      func(string) string             Get the value of an environment variable
+    humanize func(uint64) string             Express a file size in a human-readable format
+    join     func([]string, string) string   Join a string array by a separator
+    lower    func(string) string             Convert a string to lowercase
+    substr   func(string, int, int) string   Get a substring based on starting index and length
+    upper    func(string) string             Convert a string to uppercase
+
+The special identifier {{.SPACER}} can be used to divide the ruler into
+sections that are spaced evenly from each other.
+
+The default ruler file can be found at
+https://github.com/gokcehan/lf/blob/master/etc/ruler.default

etc/ruler.default

@@ -0,0 +1,20 @@
+{{with .Message -}}
+    {{. -}}
+{{else with .Stat -}}
+    {{.Permissions | printf "\033[36m%s\033[0m" -}}
+    {{with .LinkCount}} {{.}}{{end -}}
+    {{with .User}} {{.}}{{end -}}
+    {{with .Group}} {{.}}{{end -}}
+    {{.Size | humanize | printf " %5s" -}}
+    {{.ModTime | printf " %s" -}}
+    {{with .Target}} -> {{.}}{{end -}}
+{{end -}}
+{{.SPACER -}}
+{{with .Keys}}  {{.}}{{end -}}
+{{with .Progress}}  {{join . " "}}{{end -}}
+{{with .Copy}}  {{len . | printf "%s %d \033[0m" $.Options.copyfmt}}{{end -}}
+{{with .Cut}}  {{len . | printf "%s %d \033[0m" $.Options.cutfmt}}{{end -}}
+{{with .Select}}  {{len . | printf "%s %d \033[0m" $.Options.selectfmt}}{{end -}}
+{{with .Visual}}  {{len . | printf "%s %d \033[0m" $.Options.visualfmt}}{{end -}}
+{{with .Filter}}  {{join . " " | printf "\033[7;34m %s \033[0m"}}{{end -}}
+{{printf "  %d/%d" .Index .Total}}

eval.go

@@ -89,7 +89,7 @@ func (e *setExpr) eval(app *app, args []string) {
 		err = applyBoolOpt(&gOpts.drawbox, e)
 		if err == nil {
 			app.ui.renew()
-			clear(app.nav.regCache)
+			app.nav.resize(app.ui)
 			app.ui.loadFile(app, true)
 		}
 	case "hidden", "nohidden", "hidden!":
@@ -156,6 +156,8 @@ func (e *setExpr) eval(app *app, args []string) {
 		}
 	case "roundbox", "noroundbox", "roundbox!":
 		err = applyBoolOpt(&gOpts.roundbox, e)
+	case "rulerfile", "norulerfile", "rulerfile!":
+		err = applyBoolOpt(&gOpts.rulerfile, e)
 	case "showbinds", "noshowbinds", "showbinds!":
 		err = applyBoolOpt(&gOpts.showbinds, e)
 	// DEPRECATED: remove after r38 is released
@@ -340,7 +342,7 @@ func (e *setExpr) eval(app *app, args []string) {
 		}
 		gOpts.ratios = rats
 		app.ui.wins = getWins(app.ui.screen)
-		clear(app.nav.regCache)
+		app.nav.resize(app.ui)
 		app.ui.loadFile(app, true)
 	case "rulerfmt":
 		gOpts.rulerfmt = e.val
@@ -1279,15 +1281,9 @@ func (e *callExpr) eval(app *app, args []string) {
 		if !app.nav.init {
 			return
 		}
-		app.ui.renew()
 		app.ui.screen.Sync()
-		if app.nav.height != app.ui.wins[0].h {
-			app.nav.height = app.ui.wins[0].h
-			clear(app.nav.regCache)
-		}
-		for _, dir := range app.nav.dirs {
-			dir.boundPos(app.nav.height)
-		}
+		app.ui.renew()
+		app.nav.resize(app.ui)
 		app.ui.sxScreen.forceClear = true
 		app.ui.loadFile(app, true)
 		onRedraw(app)