Blame view

repos/robbyrussell/oh-my-zsh/plugins/zsh-navigation-tools/n-list 14 KB
7378b55de   mj   Squashed 'repos/r...
1
2
3
  # $1, $2, ... - elements of the list
  # $NLIST_NONSELECTABLE_ELEMENTS - array of indexes (1-based) that cannot be selected
  # $REPLY is the output variable - contains index (1-based) or -1 when no selection
271945d1f   mj   Squashed 'repos/r...
4
  # $reply (array) is the second part of the output - use the index (REPLY) to get selected element
7378b55de   mj   Squashed 'repos/r...
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
  #
  # Copy this file into /usr/share/zsh/site-functions/
  # and add 'autoload n-list` to .zshrc
  #
  # This function outputs a list of elements that can be
  # navigated with keyboard. Uses curses library
  
  emulate -LR zsh
  
  setopt typesetsilent extendedglob noshortloops
  
  _nlist_has_terminfo=0
  
  zmodload zsh/curses
  zmodload zsh/terminfo 2>/dev/null && _nlist_has_terminfo=1
  
  trap "REPLY=-2; reply=(); return" TERM INT QUIT
  trap "_nlist_exit" EXIT
  
  # Drawing and input
  autoload n-list-draw n-list-input
  
  # Cleanup before any exit
  _nlist_exit() {
      setopt localoptions
      setopt extendedglob
  
      [[ "$REPLY" = -(#c0,1)[0-9]## ]] || REPLY="-1"
      zcurses 2>/dev/null delwin inner
      zcurses 2>/dev/null delwin main
      zcurses 2>/dev/null refresh
      zcurses end
      _nlist_alternate_screen 0
      _nlist_cursor_visibility 1
      unset _nlist_has_terminfo
  }
  
  # Outputs a message in the bottom of the screen
  _nlist_status_msg() {
      # -1 for border, -1 for 0-based indexing
      zcurses move main $(( term_height - 1 - 1 )) 2
      zcurses clear main eol
      zcurses string main "$1"
      #status_msg_strlen is localized in caller
      status_msg_strlen=$#1
  }
  
  # Prefer tput, then module terminfo
  _nlist_cursor_visibility() {
      if type tput 2>/dev/null 1>&2; then
          [ "$1" = "1" ] && { tput cvvis; tput cnorm }
          [ "$1" = "0" ] && tput civis
      elif [ "$_nlist_has_terminfo" = "1" ]; then
          [ "$1" = "1" ] && { [ -n $terminfo[cvvis] ] && echo -n $terminfo[cvvis];
                             [ -n $terminfo[cnorm] ] && echo -n $terminfo[cnorm] }
          [ "$1" = "0" ] && [ -n $terminfo[civis] ] && echo -n $terminfo[civis]
      fi 
  }
  
  # Reason for this function is that on some systems
  # smcup and rmcup are not knowing why left empty
  _nlist_alternate_screen() {
      [ "$_nlist_has_terminfo" -ne "1" ] && return
      [[ "$1" = "1" && -n "$terminfo[smcup]" ]] && return
      [[ "$1" = "0" && -n "$terminfo[rmcup]" ]] && return
  
      case "$TERM" in
          *rxvt*)
              [ "$1" = "1" ] && echo -n $'\x1b7\x1b[?47h'
              [ "$1" = "0" ] && echo -n $'\x1b[2J\x1b[?47l\x1b8'
              ;;
          *)
              [ "$1" = "1" ] && echo -n $'\x1b[?1049h'
              [ "$1" = "0" ] && echo -n $'\x1b[?1049l'
              # just to remember two other that work: $'\x1b7\x1b[r\x1b[?47h', $'\x1b[?47l\x1b8'
              ;;
      esac
  }
  
  _nlist_compute_user_vars_difference() {
          if [[ "${(t)NLIST_NONSELECTABLE_ELEMENTS}" != "array" &&
                  "${(t)NLIST_NONSELECTABLE_ELEMENTS}" != "array-local" ]]
          then
              last_element_difference=0
              current_difference=0
          else
              last_element_difference=$#NLIST_NONSELECTABLE_ELEMENTS
              current_difference=0
              local idx
              for idx in "${(n)NLIST_NONSELECTABLE_ELEMENTS[@]}"; do
                  [ "$idx" -le "$NLIST_CURRENT_IDX" ] && current_difference+=1 || break
              done
          fi
  }
  
  # List was processed, check if variables aren't off range
  _nlist_verify_vars() {
      [ "$NLIST_CURRENT_IDX" -gt "$last_element" ] && NLIST_CURRENT_IDX="$last_element"
      [[ "$NLIST_CURRENT_IDX" -eq 0 && "$last_element" -ne 0 ]] && NLIST_CURRENT_IDX=1
      (( NLIST_FROM_WHAT_IDX_LIST_IS_SHOWN=0+((NLIST_CURRENT_IDX-1)/page_height)*page_height+1 ))
  }
  
  # Compute the variables which are shown to the user
  _nlist_setup_user_vars() {
      if [ "$1" = "1" ]; then
          # Basic values when there are no non-selectables
          NLIST_USER_CURRENT_IDX="$NLIST_CURRENT_IDX"
          NLIST_USER_LAST_ELEMENT="$last_element"
      else
          _nlist_compute_user_vars_difference
          NLIST_USER_CURRENT_IDX=$(( NLIST_CURRENT_IDX - current_difference ))
          NLIST_USER_LAST_ELEMENT=$(( last_element - last_element_difference ))
      fi
  }
61aaa7b58   mj   Squashed 'repos/r...
119
  _nlist_colorify_disp_list() {
7378b55de   mj   Squashed 'repos/r...
120
121
122
123
124
      local col=$'\x1b[00;34m' reset=$'\x1b[0m'
      [ -n "$NLIST_COLORING_COLOR" ] && col="$NLIST_COLORING_COLOR"
      [ -n "$NLIST_COLORING_END_COLOR" ] && reset="$NLIST_COLORING_END_COLOR"
  
      if [ "$NLIST_COLORING_MATCH_MULTIPLE" -eq 1 ]; then
61aaa7b58   mj   Squashed 'repos/r...
125
          disp_list=( "${(@)disp_list//(#mi)$~NLIST_COLORING_PATTERN/$col${MATCH}$reset}" )
7378b55de   mj   Squashed 'repos/r...
126
      else
61aaa7b58   mj   Squashed 'repos/r...
127
          disp_list=( "${(@)disp_list/(#mi)$~NLIST_COLORING_PATTERN/$col${MATCH}$reset}" )
7378b55de   mj   Squashed 'repos/r...
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
      fi
  }
  
  #
  # Main code
  #
  
  # Check if there is proper input
  if [ "$#" -lt 1 ]; then
      echo "Usage: n-list element_1 ..."
      return 1
  fi
  
  REPLY="-1"
  typeset -ga reply
  reply=()
  
  integer term_height="$LINES"
  integer term_width="$COLUMNS"
  if [[ "$term_height" -lt 1 || "$term_width" -lt 1 ]]; then
      local stty_out=$( stty size )
      term_height="${stty_out% *}"
      term_width="${stty_out#* }"
  fi
  integer inner_height=term_height-3
  integer inner_width=term_width-3
  integer page_height=inner_height
  integer page_width=inner_width
61aaa7b58   mj   Squashed 'repos/r...
156
  typeset -a list disp_list
7378b55de   mj   Squashed 'repos/r...
157
158
159
160
161
162
163
164
165
  integer last_element=$#
  local action
  local final_key
  integer selection
  integer last_element_difference=0
  integer current_difference=0
  local prev_search_buffer=""
  integer prev_uniq_mode=0
  integer prev_start_idx=-1
271945d1f   mj   Squashed 'repos/r...
166
  local MBEGIN MEND MATCH mbegin mend match
7378b55de   mj   Squashed 'repos/r...
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
  
  # Ability to remember the list between calls
  if [[ -z "$NLIST_REMEMBER_STATE" || "$NLIST_REMEMBER_STATE" -eq 0 || "$NLIST_REMEMBER_STATE" -eq 2 ]]; then
      NLIST_FROM_WHAT_IDX_LIST_IS_SHOWN=1
      NLIST_CURRENT_IDX=1
      NLIST_IS_SEARCH_MODE=0
      NLIST_SEARCH_BUFFER=""
      NLIST_TEXT_OFFSET=0
      NLIST_IS_UNIQ_MODE=0
  
      # Zero - because it isn't known, unless we
      # confirm that first element is selectable
      NLIST_USER_CURRENT_IDX=0
      [[ ${NLIST_NONSELECTABLE_ELEMENTS[(r)1]} != 1 ]] && NLIST_USER_CURRENT_IDX=1
      NLIST_USER_LAST_ELEMENT=$(( last_element - $#NLIST_NONSELECTABLE_ELEMENTS ))
  
      # 2 is init once, then remember
      [ "$NLIST_REMEMBER_STATE" -eq 2 ] && NLIST_REMEMBER_STATE=1
  fi
  
  if [ "$NLIST_START_IN_SEARCH_MODE" -eq 1 ]; then
      NLIST_START_IN_SEARCH_MODE=0
      NLIST_IS_SEARCH_MODE=1
  fi
  
  if [ -n "$NLIST_SET_SEARCH_TO" ]; then
      NLIST_SEARCH_BUFFER="$NLIST_SET_SEARCH_TO"
      NLIST_SET_SEARCH_TO=""
  fi
  
  if [ "$NLIST_START_IN_UNIQ_MODE" -eq 1 ]; then
      NLIST_START_IN_UNIQ_MODE=0
      NLIST_IS_UNIQ_MODE=1
  fi
  
  _nlist_alternate_screen 1
  zcurses init
  zcurses delwin main 2>/dev/null
  zcurses delwin inner 2>/dev/null
  zcurses addwin main "$term_height" "$term_width" 0 0
  zcurses addwin inner "$inner_height" "$inner_width" 1 2
  zcurses bg main white/black
  zcurses bg inner white/black
  if [ "$NLIST_IS_SEARCH_MODE" -ne 1 ]; then
      _nlist_cursor_visibility 0
  fi
  
  #
  # Listening for input
  #
  
  local key keypad
  
  # Clear input buffer
  zcurses timeout main 0
  zcurses input main key keypad
  zcurses timeout main -1
  key=""
  keypad=""
61aaa7b58   mj   Squashed 'repos/r...
226
227
228
229
  # This loop makes script faster on some Zsh's (e.g. 5.0.8)
  repeat 1; do
      list=( "$@" )
  done
7378b55de   mj   Squashed 'repos/r...
230

61aaa7b58   mj   Squashed 'repos/r...
231
  last_element="$#list"
7378b55de   mj   Squashed 'repos/r...
232
233
234
235
  
  while (( 1 )); do
      # Do searching (filtering with string)
      if [ -n "$NLIST_SEARCH_BUFFER" ]; then
61aaa7b58   mj   Squashed 'repos/r...
236
          # Compute new list?
7378b55de   mj   Squashed 'repos/r...
237
238
239
240
241
242
243
244
          if [[ "$NLIST_SEARCH_BUFFER" != "$prev_search_buffer" || "$NLIST_IS_UNIQ_MODE" -ne "$prev_uniq_mode" ]]; then
              prev_search_buffer="$NLIST_SEARCH_BUFFER"
              prev_uniq_mode="$NLIST_IS_UNIQ_MODE"
              # regenerating list -> regenerating disp_list
              prev_start_idx=-1
  
              # Take all elements, including duplicates and non-selectables
              typeset +U list
61aaa7b58   mj   Squashed 'repos/r...
245
246
247
              repeat 1; do
                  list=( "$@" )
              done
7378b55de   mj   Squashed 'repos/r...
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
  
              # Remove non-selectable elements
              [ "$#NLIST_NONSELECTABLE_ELEMENTS" -gt 0 ] && for i in "${(nO)NLIST_NONSELECTABLE_ELEMENTS[@]}"; do
                  list[$i]=()
              done
  
              # Remove duplicates
              [ "$NLIST_IS_UNIQ_MODE" -eq 1 ] && typeset -U list
  
              last_element="$#list"
  
              # Next do the filtering
              local search_buffer="${NLIST_SEARCH_BUFFER%% ##}"
              search_buffer="${search_buffer## ##}"
              search_buffer="${search_buffer//(#m)[][*?|#~^()><\\]/\\$MATCH}"
f5c7faa5a   mj   Squashed 'repos/r...
263
264
              local search_pattern=""
              local colsearch_pattern=""
7378b55de   mj   Squashed 'repos/r...
265
              if [ -n "$search_buffer" ]; then
271945d1f   mj   Squashed 'repos/r...
266
                  # Patterns will be *foo*~^*bar* and (foo|bar)
f5c7faa5a   mj   Squashed 'repos/r...
267
268
                  search_pattern="${search_buffer// ##/*~^*}"
                  colsearch_pattern="${search_buffer// ##/|}"
7378b55de   mj   Squashed 'repos/r...
269

271945d1f   mj   Squashed 'repos/r...
270
271
272
273
                  # The repeat will make the matching work on a fresh heap
                  repeat 1; do
                      list=( "${(@M)list:#(#i)*$~search_pattern*}" )
                  done
7378b55de   mj   Squashed 'repos/r...
274
                  last_element="$#list"
7378b55de   mj   Squashed 'repos/r...
275
276
277
278
279
280
281
282
283
284
285
286
287
              fi
  
              # Called after processing list
              _nlist_verify_vars
          fi
  
          _nlist_setup_user_vars 1
  
          integer end_idx=$(( NLIST_FROM_WHAT_IDX_LIST_IS_SHOWN + page_height - 1 ))
          [ "$end_idx" -gt "$last_element" ] && end_idx=last_element
  
          if [ "$prev_start_idx" -ne "$NLIST_FROM_WHAT_IDX_LIST_IS_SHOWN" ]; then
              prev_start_idx="$NLIST_FROM_WHAT_IDX_LIST_IS_SHOWN"
f5c7faa5a   mj   Squashed 'repos/r...
288
289
290
291
              disp_list=( "${(@)list[NLIST_FROM_WHAT_IDX_LIST_IS_SHOWN, end_idx]}" )
  
              if [ -n "$colsearch_pattern" ]; then
                  local red=$'\x1b[00;31m' reset=$'\x1b[00;00m'
271945d1f   mj   Squashed 'repos/r...
292
293
294
295
                  # The repeat will make the matching work on a fresh heap
                  repeat 1; do
                      disp_list=( "${(@)disp_list//(#mi)($~colsearch_pattern)/$red${MATCH}$reset}" )
                  done
f5c7faa5a   mj   Squashed 'repos/r...
296
              fi
7378b55de   mj   Squashed 'repos/r...
297

61aaa7b58   mj   Squashed 'repos/r...
298
299
              # We have display list, lets replace newlines with "
  " when needed (1/2)
7378b55de   mj   Squashed 'repos/r...
300
301
302
303
304
305
306
307
308
309
310
311
312
              [ "$NLIST_REPLACE_NEWLINES" -eq 1 ] && disp_list=( "${(@)disp_list//$'
  '/\
  }" )
          fi
  
          # Output colored list
          n-list-draw "$(( (NLIST_CURRENT_IDX-1) % page_height + 1 ))" \
              "$page_height" "$page_width" 0 0 "$NLIST_TEXT_OFFSET" inner \
              "$disp_list[@]"
      else
          # There is no search, but there was in previous loop
          # OR
          # Uniq mode was entered or left out
61aaa7b58   mj   Squashed 'repos/r...
313
          # -> compute new list
7378b55de   mj   Squashed 'repos/r...
314
315
316
317
318
319
320
321
          if [[ -n "$prev_search_buffer" || "$NLIST_IS_UNIQ_MODE" -ne "$prev_uniq_mode" ]]; then
              prev_search_buffer=""
              prev_uniq_mode="$NLIST_IS_UNIQ_MODE"
              # regenerating list -> regenerating disp_list
              prev_start_idx=-1
  
              # Take all elements, including duplicates and non-selectables
              typeset +U list
61aaa7b58   mj   Squashed 'repos/r...
322
323
324
              repeat 1; do
                  list=( "$@" )
              done
7378b55de   mj   Squashed 'repos/r...
325
326
327
328
329
330
331
332
333
  
              # Remove non-selectable elements only when in uniq mode
              [ "$NLIST_IS_UNIQ_MODE" -eq 1 ] && [ "$#NLIST_NONSELECTABLE_ELEMENTS" -gt 0 ] &&
              for i in "${(nO)NLIST_NONSELECTABLE_ELEMENTS[@]}"; do
                  list[$i]=()
              done
  
              # Remove duplicates when in uniq mode
              [ "$NLIST_IS_UNIQ_MODE" -eq 1 ] && typeset -U list
7378b55de   mj   Squashed 'repos/r...
334
335
336
337
338
339
340
341
342
343
              last_element="$#list"
              # Called after processing list
              _nlist_verify_vars
          fi
  
          # "1" - shouldn't bother with non-selectables
          _nlist_setup_user_vars "$NLIST_IS_UNIQ_MODE"
  
          integer end_idx=$(( NLIST_FROM_WHAT_IDX_LIST_IS_SHOWN + page_height - 1 ))
          [ "$end_idx" -gt "$last_element" ] && end_idx=last_element
61aaa7b58   mj   Squashed 'repos/r...
344
345
346
          if [ "$prev_start_idx" -ne "$NLIST_FROM_WHAT_IDX_LIST_IS_SHOWN" ]; then
              prev_start_idx="$NLIST_FROM_WHAT_IDX_LIST_IS_SHOWN"
              disp_list=( "${(@)list[NLIST_FROM_WHAT_IDX_LIST_IS_SHOWN, end_idx]}" )
7378b55de   mj   Squashed 'repos/r...
347

61aaa7b58   mj   Squashed 'repos/r...
348
              [ -n "$NLIST_COLORING_PATTERN" ] && _nlist_colorify_disp_list
7378b55de   mj   Squashed 'repos/r...
349

61aaa7b58   mj   Squashed 'repos/r...
350
351
352
353
354
              # We have display list, lets replace newlines with "
  " when needed (2/2)
              [ "$NLIST_REPLACE_NEWLINES" -eq 1 ] && disp_list=( "${(@)disp_list//$'
  '/\
  }" )
7378b55de   mj   Squashed 'repos/r...
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
          fi
  
          # Output the list
          n-list-draw "$(( (NLIST_CURRENT_IDX-1) % page_height + 1 ))" \
              "$page_height" "$page_width" 0 0 "$NLIST_TEXT_OFFSET" inner \
              "$disp_list[@]"
      fi
  
      local status_msg_strlen
      if [ "$NLIST_IS_SEARCH_MODE" = "1" ]; then
          local _txt2=""
          [ "$NLIST_IS_UNIQ_MODE" -eq 1 ] && _txt2="[-UNIQ-] "
          _nlist_status_msg "${_txt2}Filtering with: ${NLIST_SEARCH_BUFFER// /+}"
      elif [[ ${NLIST_NONSELECTABLE_ELEMENTS[(r)$NLIST_CURRENT_IDX]} != $NLIST_CURRENT_IDX ||
              -n "$NLIST_SEARCH_BUFFER" || "$NLIST_IS_UNIQ_MODE" -eq 1 ]]; then
          local _txt="" _txt2=""
          [ -n "$NLIST_GREP_STRING" ] && _txt=" [$NLIST_GREP_STRING]"
          [ "$NLIST_IS_UNIQ_MODE" -eq 1 ] && _txt2="[-UNIQ-] "
          _nlist_status_msg "${_txt2}Current #$NLIST_USER_CURRENT_IDX (of #$NLIST_USER_LAST_ELEMENT entries)$_txt"
      else
          _nlist_status_msg ""
      fi
  
      zcurses border main
61aaa7b58   mj   Squashed 'repos/r...
379
380
381
382
  
      local top_msg="${(C)ZSH_NAME} $ZSH_VERSION, shell level $SHLVL, $USER"
      zcurses move main 0 $(( term_width / 2 - $#top_msg / 2 ))
      zcurses string main $top_msg
7378b55de   mj   Squashed 'repos/r...
383
384
385
386
387
388
389
390
      zcurses refresh main inner
      zcurses move main $(( term_height - 1 - 1 )) $(( status_msg_strlen + 2 ))
  
      # Wait for input
      zcurses input main key keypad
  
      # Get the special (i.e. "keypad") key or regular key
      if [ -n "$key" ]; then
271945d1f   mj   Squashed 'repos/r...
391
          final_key="$key"
7378b55de   mj   Squashed 'repos/r...
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
      elif [ -n "$keypad" ]; then
          final_key="$keypad"
      else
          _nlist_status_msg "Inproper input detected"
          zcurses refresh main inner
      fi
  
      n-list-input "$NLIST_CURRENT_IDX" "$NLIST_FROM_WHAT_IDX_LIST_IS_SHOWN" \
                      "$page_height" "$page_width" "$last_element" "$NLIST_TEXT_OFFSET" \
                      "$final_key" "$NLIST_IS_SEARCH_MODE" "$NLIST_SEARCH_BUFFER" \
                      "$NLIST_IS_UNIQ_MODE"
  
      selection="$reply[1]"
      action="$reply[2]"
      NLIST_CURRENT_IDX="$reply[3]"
      NLIST_FROM_WHAT_IDX_LIST_IS_SHOWN="$reply[4]"
      NLIST_TEXT_OFFSET="$reply[5]"
      NLIST_IS_SEARCH_MODE="$reply[6]"
      NLIST_SEARCH_BUFFER="$reply[7]"
      NLIST_IS_UNIQ_MODE="$reply[8]"
  
      if [ "$action" = "SELECT" ]; then
          REPLY="$selection"
          reply=( "$list[@]" )
          break
      elif [ "$action" = "QUIT" ]; then
          REPLY=-1
          reply=( "$list[@]" )
          break
      elif [ "$action" = "REDRAW" ]; then
          zcurses clear main redraw
          zcurses clear inner redraw
      fi
  done
  
  # vim: set filetype=zsh: