mirror of https://github.com/dylanaraps/shfm.git
Compare commits
43 Commits
Author | SHA1 | Date |
---|---|---|
dylan | 696318e947 | |
dylan | 9a968b2c48 | |
dylan | 25d4f809d7 | |
Nathan Sketch | 01ae386143 | |
Nathan Sketch | 1bbd788ee0 | |
Nathan Sketch | 7b21d545b3 | |
Nathan Sketch | ec27f90096 | |
Dylan Araps | 8920178753 | |
dylan | b8efa71b97 | |
dylan | e9fbd754ce | |
Crestwave | 6849998609 | |
Gregory Chamberlain | 2a70030c02 | |
Dylan Araps | 8ad3756a1c | |
Dylan Araps | 2e3fc777b4 | |
Dylan Araps | 0868399d04 | |
Dylan Araps | fa04365aa2 | |
Dylan Araps | 33ce6cce78 | |
Dylan Araps | e55cdf00ac | |
Dylan Araps | efd8a9a233 | |
Dylan Araps | ab3a6932fe | |
Dylan Araps | 0bd79a5f00 | |
dylan | 0b12c5397b | |
Henrik Aalto | d1c1439fa8 | |
Dylan Araps | b9f475ac6b | |
Dylan Araps | 9741e308d5 | |
Dylan Araps | e5fbeb04a0 | |
Dylan Araps | 16d1bd77f7 | |
Dylan Araps | 60ce38bbcf | |
Dylan Araps | 7e1d89fdfa | |
Dylan Araps | e2f2aa9caf | |
Dylan Araps | 73075390e7 | |
Dylan Araps | 0b73009821 | |
Dylan Araps | 86389b3dbf | |
Dylan Araps | c285271d05 | |
Dylan Araps | 9d86a19f34 | |
Dylan Araps | e52a161f02 | |
Dylan Araps | c20abb5dad | |
Dylan Araps | c820159f43 | |
Dylan Araps | c9d6c52edf | |
Dylan Araps | 2355810262 | |
Dylan Araps | 0e0759c480 | |
Dylan Araps | d62f4bf798 | |
Dylan Araps | c34a9fc1ce |
59
README
59
README
|
@ -9,12 +9,14 @@ screenshot: https://user-images.githubusercontent.com/6799467/89270554-2b40ab00-
|
|||
features
|
||||
________________________________________________________________________________
|
||||
|
||||
* no dependencies other than a POSIX shell + POSIX test, printf, dd and stty ***
|
||||
* no dependencies other than a POSIX shell + POSIX [, printf, dd and stty ***
|
||||
* tiny
|
||||
* single file
|
||||
* no compilation needed
|
||||
* correctly handles files with funky names (newlines, etc)
|
||||
* works with very small terminal sizes.
|
||||
* cd on exit
|
||||
* works when run in subshell $(shfm)
|
||||
|
||||
*** see portability notes towards bottom of README.
|
||||
|
||||
|
@ -30,21 +32,22 @@ g - go to top
|
|||
G - go to bottom
|
||||
q - quit
|
||||
: - cd to <input>
|
||||
/ - search current directory *<input>*
|
||||
/ - search current directory <input>*
|
||||
- - go to last directory
|
||||
~ - go home
|
||||
! - spawn shell
|
||||
. - toggle hidden files
|
||||
? - show help
|
||||
|
||||
Additional keybinds:
|
||||
Also supported:
|
||||
|
||||
down arrow - down
|
||||
up arrow - up
|
||||
right arrow - open file or directory
|
||||
left arrow - go up level
|
||||
down arrow - down
|
||||
up arrow - up
|
||||
left arrow - go up level
|
||||
right arrow - open file or directory
|
||||
|
||||
enter/return - open file or directory
|
||||
backspace - go up level
|
||||
backspace - up
|
||||
enter - open file or directory
|
||||
|
||||
|
||||
todo
|
||||
|
@ -60,6 +63,29 @@ ________________________________________________________________________________
|
|||
- [x] look into whether tput is feasible.
|
||||
|
||||
|
||||
cd on exit
|
||||
________________________________________________________________________________
|
||||
|
||||
On exit, the utility will print the path to working directory to <stdout>. To
|
||||
disable this behavior, run with 'shfm >/dev/null'. Usage of this output is
|
||||
rather flexible.
|
||||
|
||||
# cd to directory on exit
|
||||
cd "$(shfm)"
|
||||
|
||||
# store pwd in var on exit
|
||||
var=$(shfm)
|
||||
|
||||
# store pwd in a file on exit
|
||||
shfm > file
|
||||
|
||||
For ease of use, a wrapper function can be added to your .shellrc (.bashrc, etc).
|
||||
|
||||
shfm() {
|
||||
cd "$(command shfm "$@")"
|
||||
}
|
||||
|
||||
|
||||
opener
|
||||
________________________________________________________________________________
|
||||
|
||||
|
@ -149,9 +175,9 @@ ________________________________________________________________________________
|
|||
* VT100/ANSI escape sequences (widely available) are used in place of tput. A
|
||||
few non-VT100 sequences /are/ needed however.
|
||||
|
||||
- IL vt102 \033[L: controls upwards scroll. (required)
|
||||
- ? xterm \033[?1049[lh]: controls alternate screen. (optional)
|
||||
- DECTCEM vt520 \033[?25[lh]: controls cursor visibility. (optional)
|
||||
- IL vt102 \033[L: upwards scroll. (required)
|
||||
- xterm \033[?1049[lh]: alternate screen. (optional)
|
||||
- DECTCEM vt520 \033[?25[lh]: cursor visibility. (optional)
|
||||
|
||||
Why avoid tput?
|
||||
|
||||
|
@ -229,15 +255,6 @@ ________________________________________________________________________________
|
|||
- If input doesn't follow this sequence, 'esc' is reset to '0'.
|
||||
|
||||
|
||||
* There is no usage of '[' or 'test'.
|
||||
|
||||
Despite these being commonly provided as "shell builtins" (part of the shell),
|
||||
a lot of shells still use the external utilities from the coreutils. All usage
|
||||
of these has been replaced with 'case' as it is always a "shell keyword".
|
||||
|
||||
This is one of the approaches taken to reduce the need for anything external.
|
||||
|
||||
|
||||
* Filename escaping works via looping over a string char by char.
|
||||
|
||||
I didn't think this was possible in POSIX shell until I needed to do this in
|
||||
|
|
242
shfm
242
shfm
|
@ -2,28 +2,29 @@
|
|||
|
||||
esc() {
|
||||
case $1 in
|
||||
# vt100 (IL is vt102)
|
||||
CUD) printf '%s[%sB' "$esc_c" "$2" ;; # cursor down
|
||||
CUP) printf '%s[%s;%sH' "$esc_c" "$2" "$3" ;; # cursor home
|
||||
CUU) printf '%s[%sA' "$esc_c" "$2" ;; # cursor up
|
||||
DECAWM) printf '%s[?7%s' "$esc_c" "$2" ;; # line wrap
|
||||
DECRC) printf '%s8' "$esc_c" ;; # cursor restore
|
||||
DECSC) printf '%s7' "$esc_c" ;; # cursor save
|
||||
DECSTBM) printf '%s[%s;%sr' "$esc_c" "$2" "$3" ;; # scroll region
|
||||
ED[0-2]) printf '%s[%sJ' "$esc_c" "${1#ED}" ;; # clear screen
|
||||
EL[0-2]) printf '%s[%sK' "$esc_c" "${1#EL}" ;; # clear line
|
||||
IL) printf '%s[%sL' "$esc_c" "$2" ;; # insert line
|
||||
SGR) printf '%s[%s;%sm' "$esc_c" "$2" "$3" ;; # colors
|
||||
# vt100 (IL is vt102) (DECTCEM is vt520)
|
||||
CUD) printf '%s[%sB' "$esc_c" "$2" ;; # cursor down
|
||||
CUP) printf '%s[%s;%sH' "$esc_c" "$2" "$3" ;; # cursor home
|
||||
CUU) printf '%s[%sA' "$esc_c" "$2" ;; # cursor up
|
||||
DECAWM) printf '%s[?7%s' "$esc_c" "$2" ;; # line wrap
|
||||
DECRC) printf '%s8' "$esc_c" ;; # cursor restore
|
||||
DECSC) printf '%s7' "$esc_c" ;; # cursor save
|
||||
DECSTBM) printf '%s[%s;%sr' "$esc_c" "$2" "$3" ;; # scroll region
|
||||
DECTCEM) printf '%s[?25%s' "$esc_c" "$2" ;; # cursor visible
|
||||
ED[0-2]) printf '%s[%sJ' "$esc_c" "${1#ED}" ;; # clear screen
|
||||
EL[0-2]) printf '%s[%sK' "$esc_c" "${1#EL}" ;; # clear line
|
||||
IL) printf '%s[%sL' "$esc_c" "$2" ;; # insert line
|
||||
SGR) printf '%s[%s;%sm' "$esc_c" "$2" "$3" ;; # colors
|
||||
|
||||
# private (and optional)
|
||||
DECTCEM) printf '%s[?25%s' "$esc_c" "$2" ;; # cursor visible (vt520)
|
||||
screen_alt) printf '%s[?1049%s' "$esc_c" "$2" ;; # alternate buf (xterm)
|
||||
# xterm (since 1988, supported widely)
|
||||
screen_alt) printf '%s[?1049%s' "$esc_c" "$2" ;; # alternate buffer
|
||||
esac
|
||||
}
|
||||
|
||||
term_setup() {
|
||||
stty=$(stty -g)
|
||||
stty -icanon -echo
|
||||
esc screen_alt h
|
||||
esc DECAWM l
|
||||
esc DECTCEM l
|
||||
esc ED2
|
||||
|
@ -31,11 +32,15 @@ term_setup() {
|
|||
}
|
||||
|
||||
term_reset() {
|
||||
esc DECAWM h
|
||||
esc DECTCEM h
|
||||
esc ED2
|
||||
esc DECSTBM
|
||||
esc DECAWM h >&2
|
||||
esc DECTCEM h >&2
|
||||
esc ED2 >&2
|
||||
esc DECSTBM >&2
|
||||
esc screen_alt l >&2
|
||||
stty "$stty"
|
||||
|
||||
# needed for cd-on-exit
|
||||
printf '%s\n' "$PWD" >&1
|
||||
}
|
||||
|
||||
term_resize() {
|
||||
|
@ -54,47 +59,46 @@ term_resize() {
|
|||
|
||||
term_scroll_down() {
|
||||
case $((y - $#)) in
|
||||
-*)
|
||||
y=$((y + 1))
|
||||
y2=$((y2 + 1 < bottom ? y2 + 1 : bottom))
|
||||
|
||||
line_print "$((y - 1))" "$@"
|
||||
printf '\n'
|
||||
line_print "$y" "$@"
|
||||
status_line "($y/$#) $PWD"
|
||||
;;
|
||||
[0-9]*) return
|
||||
esac
|
||||
|
||||
y=$((y + 1))
|
||||
y2=$((y2 + 1 < bottom ? y2 + 1 : bottom))
|
||||
|
||||
line_print "$((y - 1))" "$@"
|
||||
printf '\n'
|
||||
line_print "$y" "$@"
|
||||
status_line "$#"
|
||||
}
|
||||
|
||||
term_scroll_up() {
|
||||
case $y in
|
||||
-*|0|1) ;;
|
||||
|
||||
*)
|
||||
y=$((y - 1))
|
||||
|
||||
line_print "$((y + 1))" "$@"
|
||||
|
||||
case $y2 in
|
||||
1) esc IL ;;
|
||||
*) esc CUU; y2=$((y2 > 1 ? y2 - 1 : 1))
|
||||
esac
|
||||
|
||||
line_print "$y" "$@"
|
||||
status_line "($y/$#) $PWD"
|
||||
;;
|
||||
-*|0|1) return
|
||||
esac
|
||||
|
||||
y=$((y - 1))
|
||||
|
||||
line_print "$((y + 1))" "$@"
|
||||
|
||||
case $y2 in
|
||||
1) esc IL ;;
|
||||
*) esc CUU; y2=$((y2 > 1 ? y2 - 1 : 1))
|
||||
esac
|
||||
|
||||
line_print "$y" "$@"
|
||||
status_line "$#"
|
||||
}
|
||||
|
||||
cmd_run() {
|
||||
esc screen_alt h
|
||||
stty "$stty"
|
||||
esc DECTCEM h
|
||||
esc DECSTBM
|
||||
"$@"
|
||||
esc ED2
|
||||
"$@" ||:
|
||||
esc DECSTBM 1 "$((LINES - 2))"
|
||||
esc screen_alt l
|
||||
esc DECTCEM l
|
||||
esc CUP "$y2"
|
||||
stty -icanon -echo
|
||||
hist=2
|
||||
}
|
||||
|
||||
file_escape() {
|
||||
|
@ -103,9 +107,9 @@ file_escape() {
|
|||
# loop over string char by char
|
||||
while c=${tmp%"${tmp#?}"}; do
|
||||
case $c in
|
||||
[[:print:]]) safe=$safe$c ;;
|
||||
'') return ;;
|
||||
*) safe=$safe\? ;;
|
||||
[[:cntrl:]]) safe=$safe\? ;;
|
||||
*) safe=$safe$c ;;
|
||||
esac
|
||||
|
||||
tmp=${tmp#?}
|
||||
|
@ -117,7 +121,7 @@ hist_search() {
|
|||
|
||||
for file do
|
||||
case ${PWD%%/}/$file in
|
||||
"$old_pwd") y=$j y2=$((j > bottom ? mid : j)) cur=$file
|
||||
"$old_pwd") y=$j y2=$((j >= bottom ? mid : j)) cur=$file
|
||||
esac
|
||||
|
||||
j=$((j + 1))
|
||||
|
@ -132,20 +136,28 @@ list_print() {
|
|||
end=$((bottom + 1))
|
||||
mid=$((bottom / 4 < 5 ? 1 : bottom / 4))
|
||||
|
||||
case $# in
|
||||
1) [ -e "$1" ] || [ "$1" = 'no results' ] || set -- empty
|
||||
esac
|
||||
|
||||
case $hist in
|
||||
1)
|
||||
2) # redraw after cmd run
|
||||
shift "$((y > y2 ? y - y2 : 0))"
|
||||
;;
|
||||
|
||||
1) # redraw after go-to-parent
|
||||
hist_search "$@"
|
||||
shift "$((y >= bottom ? y - mid : 0))"
|
||||
;;
|
||||
|
||||
*)
|
||||
*) # everything else
|
||||
shift "$((y >= bottom ? y - bottom : 0))"
|
||||
;;
|
||||
esac
|
||||
|
||||
for file do
|
||||
case $i in
|
||||
"$y2") esc SGR 34 7
|
||||
"$y2") esc SGR 0 7
|
||||
esac
|
||||
|
||||
case $((i - end)) in
|
||||
|
@ -158,20 +170,31 @@ list_print() {
|
|||
i=$((i + 1))
|
||||
done
|
||||
|
||||
esc CUP "$((y > bottom ? y2 : y))"
|
||||
esc CUP "$((y > y2 ? y2 : y))"
|
||||
}
|
||||
|
||||
redraw() {
|
||||
list_print "$@"
|
||||
status_line "($y/$#) $PWD"
|
||||
status_line "$#"
|
||||
}
|
||||
|
||||
status_line() {
|
||||
esc DECSC
|
||||
esc CUP "$LINES"
|
||||
esc SGR 31 7
|
||||
printf '%-*s' "$COLUMNS" "$1"
|
||||
esc SGR
|
||||
|
||||
case $USER in
|
||||
root) esc SGR 31 7 ;;
|
||||
*) esc SGR 34 7 ;;
|
||||
esac
|
||||
|
||||
printf '%*s\r%s ' "$COLUMNS" "" "($y/$1)"
|
||||
|
||||
case $ltype in
|
||||
'') printf %s "$PWD" ;;
|
||||
*) printf %s "$ltype"
|
||||
esac
|
||||
|
||||
esc SGR 0 0
|
||||
esc DECRC
|
||||
}
|
||||
|
||||
|
@ -199,7 +222,7 @@ line_print() {
|
|||
offset=$1
|
||||
|
||||
case $offset in
|
||||
"$y") esc SGR 34 7
|
||||
"$y") esc SGR 0 7
|
||||
esac
|
||||
|
||||
shift "$offset"
|
||||
|
@ -213,10 +236,11 @@ line_print() {
|
|||
|
||||
line_format() {
|
||||
file_escape "$1"
|
||||
esc EL0
|
||||
[ -d "$1" ] && esc SGR 1 31
|
||||
printf %s "$safe"
|
||||
test -d "$1" && printf /
|
||||
esc SGR
|
||||
[ -d "$1" ] && printf /
|
||||
esc SGR 0 0
|
||||
esc EL0
|
||||
printf '\r'
|
||||
}
|
||||
|
||||
|
@ -224,16 +248,24 @@ main() {
|
|||
set -e
|
||||
|
||||
case $1 in
|
||||
-v)
|
||||
printf '%s 0.2\n' "${0##*/}"
|
||||
-h|--help)
|
||||
printf 'shfm -[hv] <starting dir>\n'
|
||||
exit 0
|
||||
;;
|
||||
|
||||
-v|--version)
|
||||
printf 'shfm 0.4.2\n'
|
||||
exit 0
|
||||
;;
|
||||
|
||||
*)
|
||||
cd -- "${1:-"$PWD"}"
|
||||
;;
|
||||
esac
|
||||
|
||||
esc_c=$(printf '\033')
|
||||
bs_char=$(printf '\177')
|
||||
|
||||
cd "${1:-"$PWD"}"
|
||||
set -- *
|
||||
cur=$1
|
||||
|
||||
|
@ -257,21 +289,23 @@ main() {
|
|||
;;
|
||||
|
||||
l?|C2|"$esc") # ARROW RIGHT
|
||||
if cd "$cur" >/dev/null 2>&1; then
|
||||
if [ -d "$cur" ] && cd -- "$cur" >/dev/null 2>&1; then
|
||||
set -- *
|
||||
y=1 y2=1 cur=$1 search=0
|
||||
y=1 y2=1 cur=$1 ltype=
|
||||
redraw "$@"
|
||||
else
|
||||
|
||||
elif [ -e "$cur" ]; then
|
||||
cmd_run "${SHFM_OPENER:="${EDITOR:=vi}"}" "$cur"
|
||||
redraw "$@"
|
||||
fi
|
||||
;;
|
||||
|
||||
h?|D2|"$bs_char"?) # ARROW LEFT
|
||||
old_pwd=$PWD
|
||||
|
||||
case $search in
|
||||
1) search=0 ;;
|
||||
*) cd .. || continue ;;
|
||||
case $ltype in
|
||||
'') cd .. || continue ;;
|
||||
*) ltype= ;;
|
||||
esac
|
||||
|
||||
set -- *
|
||||
|
@ -291,20 +325,14 @@ main() {
|
|||
G?)
|
||||
y=$#
|
||||
y2=$(($# < bottom ? $# : bottom))
|
||||
line_print "$y" "$@"
|
||||
redraw "$@"
|
||||
;;
|
||||
|
||||
.?)
|
||||
case ${hidden:=1} in
|
||||
1)
|
||||
hidden=0
|
||||
set -- .[!.]*
|
||||
;;
|
||||
|
||||
*)
|
||||
hidden=1
|
||||
set -- *
|
||||
;;
|
||||
1) hidden=0; set -- .* ;;
|
||||
0) hidden=1; set -- *
|
||||
esac
|
||||
|
||||
y=1 y2=1 cur=$1
|
||||
|
@ -313,7 +341,15 @@ main() {
|
|||
|
||||
:?)
|
||||
prompt "cd: " r
|
||||
cd "${ans:="$0"}" >/dev/null 2>&1|| continue
|
||||
|
||||
# false positive, behavior intentional
|
||||
# shellcheck disable=2088
|
||||
case $ans in
|
||||
'~') ans=$HOME ;;
|
||||
'~/'*) ans=$HOME/${ans#"~/"}
|
||||
esac
|
||||
|
||||
cd -- "${ans:="$0"}" >/dev/null 2>&1|| continue
|
||||
set -- *
|
||||
y=1 y2=1 cur=$1
|
||||
redraw "$@"
|
||||
|
@ -321,14 +357,24 @@ main() {
|
|||
|
||||
/?)
|
||||
prompt / r
|
||||
set -- *"$ans"*
|
||||
y=1 y2=1 cur=$1 search=1
|
||||
|
||||
IFS=
|
||||
# globbing intentional, word splitting is disabled.
|
||||
# shellcheck disable=2086
|
||||
set -- $ans*
|
||||
unset IFS
|
||||
|
||||
case $1$# in
|
||||
"$ans*1") set -- 'no results'
|
||||
esac
|
||||
|
||||
y=1 y2=1 cur=$1 ltype="search $PWD/$ans*"
|
||||
redraw "$@"
|
||||
status_line "($y/$#) search $ans"
|
||||
status_line "$#"
|
||||
;;
|
||||
|
||||
-?)
|
||||
cd "$OLDPWD" >/dev/null 2>&1|| continue
|
||||
cd -- "$OLDPWD" >/dev/null 2>&1|| continue
|
||||
set -- *
|
||||
y=1 y2=1 cur=$1
|
||||
redraw "$@"
|
||||
|
@ -345,12 +391,32 @@ main() {
|
|||
export SHFM_LEVEL
|
||||
SHFM_LEVEL=$((SHFM_LEVEL + 1))
|
||||
cmd_run "${SHELL:=/bin/sh}"
|
||||
redraw "$@"
|
||||
;;
|
||||
|
||||
q?)
|
||||
exit 0
|
||||
\??)
|
||||
set -- 'j - down' \
|
||||
'k - up' \
|
||||
'l - open file or directory' \
|
||||
'h - go up level' \
|
||||
'g - go to top' \
|
||||
'G - go to bottom' \
|
||||
'q - quit' \
|
||||
': - cd to <input>' \
|
||||
'/ - search current directory <input>*' \
|
||||
'- - go to last directory' \
|
||||
'~ - go home' \
|
||||
'! - spawn shell' \
|
||||
'. - toggle hidden files' \
|
||||
'? - show keybinds'
|
||||
|
||||
y=1 y2=1 cur=$1 ltype=keybinds
|
||||
redraw "$@"
|
||||
status_line "$#"
|
||||
;;
|
||||
|
||||
q?) exit 0 ;;
|
||||
|
||||
# handle keys which emit escape sequences
|
||||
"$esc_c"*) esc=1 ;;
|
||||
'[1') esc=2 ;;
|
||||
|
@ -359,4 +425,4 @@ main() {
|
|||
done
|
||||
}
|
||||
|
||||
main "$@"
|
||||
main "$@" >/dev/tty
|
||||
|
|
Loading…
Reference in New Issue