update; this now lies in MirBSD CVS as master copy
[shellsnippets/shellsnippets.git] / mksh / progress-bar
1 # -*- mode: sh -*-
2 # $MirOS: contrib/hosted/tg/progress-bar,v 1.2 2018/12/02 07:01:17 tg Exp $
3 #-
4 # Copyright © 2018
5 #       mirabilos <m@mirbsd.org>
6 # Copyright © 2017
7 #       mirabilos <t.glaser@tarent.de>
8 # Copyright © 2015, 2017
9 #       mirabilos <thorsten.glaser@teckids.org>
10 #
11 # Provided that these terms and disclaimer and all copyright notices
12 # are retained or reproduced in an accompanying document, permission
13 # is granted to deal in this work without restriction, including un‐
14 # limited rights to use, publicly perform, distribute, sell, modify,
15 # merge, give away, or sublicence.
16 #
17 # This work is provided “AS IS” and WITHOUT WARRANTY of any kind, to
18 # the utmost extent permitted by applicable law, neither express nor
19 # implied; without malicious intent or gross negligence. In no event
20 # may a licensor, author or contributor be held liable for indirect,
21 # direct, other damage, loss, or other issues arising in any way out
22 # of dealing in the work, even if advised of the possibility of such
23 # damage or existence of a defect, except proven that it results out
24 # of said person’s immediate fault when using the work as intended.
25 #-
26 # Shell library for easy display of a progress bar
27 #
28 # Usage:
29 # – before:   init_progress_bar $n
30 # – $n times: draw_progress_bar
31 # – after:    done_progress_bar
32 #
33 # init_progress_bar trashes the EXIT and SIGWINCH traps, which later
34 # are cleared, again, by done_progress_bar; note this forces using a
35 # “while [[ -n $(jobs) ]]; do wait; done” loop instead of just wait.
36 # Use “redo_progress_bar [±]$n” to rerender updating the estimate.
37
38 # global variables used by this library
39 _cnt_progress_bar=0
40 _cur_progress_bar=0
41 isin_progress_bar=0
42 nlin_progress_bar=0
43
44 if [[ $KSH_VERSION = @(\@\(#\)MIRBSD KSH R)@(5[5-9]|[6-9][0-9]|[1-9][0-9][0-9])\ * ]]; then
45         alias global='typeset -g'
46 else
47         alias global=global
48 fi
49
50 # args: $1 = number of draw_progress_bar calls to make up 100%
51 function init_progress_bar {
52         global -i _cnt_progress_bar=$1 _cur_progress_bar=0
53         global -i nlin_progress_bar=$LINES isin_progress_bar=1
54
55         trap 'done_progress_bar 1' EXIT
56         trap 'sigwinch_progress_bar' WINCH
57         # set up scrolling region, draw initial empty bar
58         sigwinch_progress_bar
59 }
60
61 unalias global
62
63 function sigwinch_progress_bar {
64         (( isin_progress_bar )) || return 0
65
66         # get new terminal size
67         nlin_progress_bar=$LINES
68
69         # save position; clear scrolling region; restore position; newline;
70         # up one line (to ensure we are not in the last line); save position;
71         # clear rest of screen; set new scrolling region; restore position
72         print -nu2 "\\e7\\e[0;0r\\e8\\n\\e[A\\e7\\e[J\\e[1;$((# nlin_progress_bar - 1))r\\e8"
73
74         # redraw progress bar
75         draw_progress_bar_internal
76 }
77
78 function done_progress_bar {
79         (( isin_progress_bar )) || return 0
80         isin_progress_bar=0
81         # save position; clear scrolling region; restore position;
82         # save position; clear rest of screen; restore position
83         print -nu2 "\\e7\\e[0;0r\\e8\\e7\\e[J\\e8"
84         trap - WINCH
85         trap - EXIT
86         [[ -n $1 ]] || (( _cur_progress_bar == _cnt_progress_bar )) || \
87             print -ru2 W: expected $_cnt_progress_bar draw_progress_bar calls, \
88             got only $_cur_progress_bar
89 }
90
91 function draw_progress_bar {
92         # increment current progress
93         if (( ++_cur_progress_bar > _cnt_progress_bar )); then
94                 print -ru2 "W: too many draw_progress_bar calls"
95                 _cur_progress_bar=$_cnt_progress_bar
96         fi
97         # remaining drawing code
98         draw_progress_bar_internal
99 }
100
101 function redo_progress_bar {
102         if [[ $1 = +* ]]; then
103                 (( _cnt_progress_bar += ${1#+} ))
104         elif [[ $1 = -* ]]; then
105                 (( _cnt_progress_bar -= ${1#-} ))
106         else
107                 _cnt_progress_bar=$1
108         fi
109         if (( _cur_progress_bar > _cnt_progress_bar )); then
110                 print -ru2 W: new estimate $_cnt_progress_bar too low \
111                     after $_cur_progress_bar calls
112                 _cur_progress_bar=$_cnt_progress_bar
113         fi
114         draw_progress_bar_internal
115 }
116
117 function draw_progress_bar_internal {
118         local bar num w=$COLUMNS
119
120         ((# num = (_cur_progress_bar * w * 8) / _cnt_progress_bar ))
121         while ((# num >= 8 )); do
122                 bar+=█
123                 ((# num -= 8 ))
124         done
125         case $num {
126         (7) bar+=▉ ;;
127         (6) bar+=▊ ;;
128         (5) bar+=▋ ;;
129         (4) bar+=▌ ;;
130         (3) bar+=▍ ;;
131         (2) bar+=▎ ;;
132         (1) bar+=▏ ;;
133         }
134         # fill complete line, right-align completion percentage display
135         local -R$w spc="$((# _cur_progress_bar * 100 / _cnt_progress_bar))%"
136         # elide percentage when it stops fitting
137         ((# (_cur_progress_bar * w / _cnt_progress_bar) > (w - 4) )) && spc=
138         # save position; go to last line; set colours;
139         # output a line full of spaces (and completion percentage);
140         # jump to first column; output bar (line præfix); restore position
141         print -nu2 -- "\\e7\\e[$nlin_progress_bar;1H\\e[0;1;33;44m$spc\\r$bar\\e8"
142 }