Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove deprecated ruler option #1766

Merged
merged 2 commits into from
Jul 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 0 additions & 15 deletions doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,6 @@ The following options can be used to customize the behavior of lf:
relativenumber bool (default false)
reverse bool (default false)
roundbox bool (default false)
ruler []string (default 'acc:progress:selection:filter:ind')
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;34m %f \033[0m| %i/%t")
scrolloff int (default 0)
selectfmt string (default "\033[7;35m")
Expand Down Expand Up @@ -892,20 +891,6 @@ Reverse the direction of sort.

Draw rounded outer corners when the `drawbox` option is enabled.

## ruler ([]string) (default `acc:progress:selection:filter:ind`)

This option is deprecated in favor of using the `rulerfmt` option (see below).
List of information shown in status line ruler.
Currently supported information types are `acc`, `progress`, `selection`, `filter`, `ind`, `df` and names starting with `lf_`.
`acc` shows the pressed keys (e.g. for bindings with multiple key presses or counts given to bindings).
`progress` shows the progress of file operations (e.g. copying a large directory).
`selection` shows the number of files that are selected, or designated for being cut/copied.
`filter` shows `F` if a filter is currently being applied.
`ind` shows the current position of the cursor as well as the number of files in the current directory.
`df` shows the amount of free disk space remaining.
Names starting with `lf_` show the value of environment variables exported by lf. This is useful for displaying the current settings (e.g. `lf_selmode` displays the current setting for the `selmode` option).
User-defined options starting with `lf_user_` are also supported, so it is possible to display information set from external sources.

## 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;34m %f \033[0m| %i/%t`)

Format string of the ruler shown in the bottom right corner.
Expand Down
20 changes: 0 additions & 20 deletions doc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,6 @@ The following options can be used to customize the behavior of lf:
relativenumber bool (default false)
reverse bool (default false)
roundbox bool (default false)
ruler []string (default 'acc:progress:selection:filter:ind')
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;34m %f \033[0m| %i/%t")
scrolloff int (default 0)
selectfmt string (default "\033[7;35m")
Expand Down Expand Up @@ -962,25 +961,6 @@ roundbox (bool) (default false)

Draw rounded outer corners when the drawbox option is enabled.

ruler ([]string) (default acc:progress:selection:filter:ind)

This option is deprecated in favor of using the rulerfmt option (see
below). List of information shown in status line ruler. Currently
supported information types are acc, progress, selection, filter, ind,
df and names starting with lf_. acc shows the pressed keys (e.g. for
bindings with multiple key presses or counts given to bindings).
progress shows the progress of file operations (e.g. copying a large
directory). selection shows the number of files that are selected, or
designated for being cut/copied. filter shows F if a filter is currently
being applied. ind shows the current position of the cursor as well as
the number of files in the current directory. df shows the amount of
free disk space remaining. Names starting with lf_ show the value of
environment variables exported by lf. This is useful for displaying the
current settings (e.g. lf_selmode displays the current setting for the
selmode option). User-defined options starting with lf_user_ are also
supported, so it is possible to display information set from external
sources.

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;34m %f \033[0m| %i/%t)

Format string of the ruler shown in the bottom right corner. Special
Expand Down
19 changes: 0 additions & 19 deletions eval.go
Original file line number Diff line number Diff line change
Expand Up @@ -267,25 +267,6 @@ func (e *setExpr) eval(app *app, args []string) {
}
}
gOpts.info = toks
case "ruler":
if e.val == "" {
gOpts.ruler = nil
return
}
toks := strings.Split(e.val, ":")
for _, s := range toks {
switch s {
case "df", "acc", "progress", "selection", "filter", "ind":
default:
if !strings.HasPrefix(s, "lf_") {
app.ui.echoerr("ruler: should consist of 'df', 'acc', 'progress', 'selection', 'filter', 'ind' or 'lf_<option_name>' separated with colon")
return
}
}
}
gOpts.ruler = toks
app.ui.echoerr("option 'ruler' is deprecated, use 'rulerfmt' instead")
return
case "rulerfmt":
gOpts.rulerfmt = e.val
case "preserve":
Expand Down
30 changes: 1 addition & 29 deletions lf.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 2.11.4
.\"
.TH "LF" "1" "2024-06-30" "" "DOCUMENTATION"
.TH "LF" "1" "2024-07-01" "" "DOCUMENTATION"
.hy
.SH NAME
.PP
Expand Down Expand Up @@ -189,7 +189,6 @@ ratios []int (default \[aq]1:2:3\[aq])
relativenumber bool (default false)
reverse bool (default false)
roundbox bool (default false)
ruler []string (default \[aq]acc:progress:selection:filter:ind\[aq])
rulerfmt string (default \[dq] %a| %p| \[rs]033[7;31m %m \[rs]033[0m| \[rs]033[7;33m %c \[rs]033[0m| \[rs]033[7;35m %s \[rs]033[0m| \[rs]033[7;34m %f \[rs]033[0m| %i/%t\[dq])
scrolloff int (default 0)
selectfmt string (default \[dq]\[rs]033[7;35m\[dq])
Expand Down Expand Up @@ -977,33 +976,6 @@ Reverse the direction of sort.
.SS roundbox (bool) (default false)
.PP
Draw rounded outer corners when the \f[C]drawbox\f[R] option is enabled.
.SS ruler ([]string) (default \f[C]acc:progress:selection:filter:ind\f[R])
.PP
This option is deprecated in favor of using the \f[C]rulerfmt\f[R]
option (see below).
List of information shown in status line ruler.
Currently supported information types are \f[C]acc\f[R],
\f[C]progress\f[R], \f[C]selection\f[R], \f[C]filter\f[R],
\f[C]ind\f[R], \f[C]df\f[R] and names starting with \f[C]lf_\f[R].
\f[C]acc\f[R] shows the pressed keys (e.g.
for bindings with multiple key presses or counts given to bindings).
\f[C]progress\f[R] shows the progress of file operations (e.g.
copying a large directory).
\f[C]selection\f[R] shows the number of files that are selected, or
designated for being cut/copied.
\f[C]filter\f[R] shows \f[C]F\f[R] if a filter is currently being
applied.
\f[C]ind\f[R] shows the current position of the cursor as well as the
number of files in the current directory.
\f[C]df\f[R] shows the amount of free disk space remaining.
Names starting with \f[C]lf_\f[R] show the value of environment
variables exported by lf.
This is useful for displaying the current settings (e.g.
\f[C]lf_selmode\f[R] displays the current setting for the
\f[C]selmode\f[R] option).
User-defined options starting with \f[C]lf_user_\f[R] are also
supported, so it is possible to display information set from external
sources.
.SS rulerfmt (string) (default \f[C] %a| %p| \[rs]033[7;31m %m \[rs]033[0m| \[rs]033[7;33m %c \[rs]033[0m| \[rs]033[7;35m %s \[rs]033[0m| \[rs]033[7;34m %f \[rs]033[0m| %i/%t\f[R])
.PP
Format string of the ruler shown in the bottom right corner.
Expand Down
2 changes: 0 additions & 2 deletions opts.go
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,6 @@ var gOpts struct {
hiddenfiles []string
history bool
info []string
ruler []string
rulerfmt string
preserve []string
shellopts []string
Expand Down Expand Up @@ -238,7 +237,6 @@ func init() {
gOpts.hiddenfiles = gDefaultHiddenFiles
gOpts.history = true
gOpts.info = nil
gOpts.ruler = nil
gOpts.rulerfmt = " %a| %p| \033[7;31m %m \033[0m| \033[7;33m %c \033[0m| \033[7;35m %s \033[0m| \033[7;34m %f \033[0m| %i/%t"
gOpts.preserve = []string{"mode"}
gOpts.shellopts = nil
Expand Down
47 changes: 0 additions & 47 deletions ui.go
Original file line number Diff line number Diff line change
Expand Up @@ -848,8 +848,6 @@ func (ui *ui) drawRuler(nav *nav) {
hid := len(dir.allFiles) - tot
acc := string(ui.keyCount) + string(ui.keyAcc)

selection := []string{}

copy := 0
move := 0
if len(nav.saves) > 0 {
Expand All @@ -860,21 +858,9 @@ func (ui *ui) drawRuler(nav *nav) {
move++
}
}
if copy > 0 {
copyStr := fmt.Sprintf(optionToFmtstr(gOpts.copyfmt), fmt.Sprintf(" %d ", copy))
selection = append(selection, copyStr)
}
if move > 0 {
moveStr := fmt.Sprintf(optionToFmtstr(gOpts.cutfmt), fmt.Sprintf(" %d ", move))
selection = append(selection, moveStr)
}
}

currSelections := nav.currSelections()
if len(currSelections) > 0 {
selectStr := fmt.Sprintf(optionToFmtstr(gOpts.selectfmt), fmt.Sprintf(" %d ", len(currSelections)))
selection = append(selection, selectStr)
}

progress := []string{}

Expand All @@ -893,39 +879,6 @@ func (ui *ui) drawRuler(nav *nav) {

opts := getOptsMap()

// 'ruler' option is deprecated and can be removed in future
if len(gOpts.ruler) > 0 {
ruler := []string{}
for _, s := range gOpts.ruler {
switch s {
case "df":
df := diskFree(dir.path)
if df != "" {
ruler = append(ruler, df)
}
case "acc":
ruler = append(ruler, acc)
case "progress":
ruler = append(ruler, progress...)
case "selection":
ruler = append(ruler, selection...)
case "filter":
if len(dir.filter) != 0 {
ruler = append(ruler, "\033[34;7m F \033[0m")
}
case "ind":
ruler = append(ruler, fmt.Sprintf("%d/%d", ind, tot))
default:
if val, ok := opts[s]; ok {
ruler = append(ruler, formatRulerOpt(s, val))
}
}
}

ui.msgWin.printRight(ui.screen, 0, st, strings.Join(ruler, " "))
return
}

rulerfmt := strings.ReplaceAll(gOpts.rulerfmt, "|", "\x1f")
rulerfmt = reRulerSub.ReplaceAllStringFunc(rulerfmt, func(s string) string {
var result string
Expand Down