Module: ListScrollable

Included in:
RubyCurses::Listbox, RubyCurses::MultiTextView, RubyCurses::TextArea, RubyCurses::TextView
Defined in:
lib/rbcurse/listscrollable.rb

Overview

Provides the ability to scroll content, typically an array widget that includes may override on_enter_row and on_leave_row Caller should have

row_count()
scrollatrow() typically @height - 2 (unless a header row, then -3)
@current_index (row of current index, starting with 0 usually)
@toprow : set to 0 for starters, top row to be displayed
@pcol (used for horiz scrolling, starts at 0)

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#find_offset ⇒ Object (readonly)

Returns the value of attribute find_offset.



11
12
13
 
# File 'lib/rbcurse/listscrollable.rb', line 11

def find_offset
  @find_offset
end

#find_offset1 ⇒ Object (readonly)

Returns the value of attribute find_offset1.



11
12
13
 
# File 'lib/rbcurse/listscrollable.rb', line 11

def find_offset1
  @find_offset1
end

#search_found_ix ⇒ Object (readonly)

Returns the value of attribute search_found_ix.



11
12
13
 
# File 'lib/rbcurse/listscrollable.rb', line 11

def search_found_ix
  @search_found_ix
end

#show_caret ⇒ Object

2010-01-23 23:06 our own fake insertion point



12
13
14
 
# File 'lib/rbcurse/listscrollable.rb', line 12

def show_caret
  @show_caret
end

Instance Method Details

#_find_next(regex = @last_regex, start = @search_found_ix) ⇒ Object

find forwards Using this to start a search or continue search



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/rbcurse/listscrollable.rb', line 330

def _find_next regex=@last_regex, start = @search_found_ix 
  raise "No previous search" if regex.nil?
  #$log.debug " _find_next #{@search_found_ix} : #{@current_index}"
  fend = @list.size-1
  if start != fend
  start += 1 unless start == fend
  @last_regex = regex
  @search_start_ix = start
  regex = Regexp.new(regex, Regexp::IGNORECASE) if @search_case
  start.upto(fend) do |ix| 
    row = @list[ix]
    m=row.match(regex)
    if !m.nil?
      @find_offset = m.offset(0)[0]
      @find_offset1 = m.offset(0)[1]
      @search_found_ix = ix
      return ix 
    end
  end
  end
  fend = start-1
  start = 0
  if @search_wrap
    start.upto(fend) do |ix| 
      row = @list[ix]
      m=row.match(regex)
      if !m.nil?
        @find_offset = m.offset(0)[0]
        @find_offset1 = m.offset(0)[1]
        @search_found_ix = ix
        return ix 
      end
    end
  end
  return nil
end

#_find_prev(regex = @last_regex, start = @search_found_ix) ⇒ Object

find backwards Using this to start a search or continue search



391
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
 
# File 'lib/rbcurse/listscrollable.rb', line 391

def _find_prev regex=@last_regex, start = @search_found_ix 
  raise "No previous search" if regex.nil?
  #$log.debug " _find_prev #{@search_found_ix} : #{@current_index}"
  if start != 0
  start -= 1 unless start == 0
  @last_regex = regex
  @search_start_ix = start
  regex = Regexp.new(regex, Regexp::IGNORECASE) if @search_case
  start.downto(0) do |ix| 
    row = @list[ix]
    m=row.match(regex)
    if !m.nil?
      @find_offset = m.offset(0)[0]
      @find_offset1 = m.offset(0)[1]
      @search_found_ix = ix
      return ix 
    end
  end
  end
  fend = start-1
  start = @list.size-1
  if @search_wrap
    start.downto(fend) do |ix| 
      row = @list[ix]
      m=row.match(regex)
      if !m.nil?
        @find_offset = m.offset(0)[0]
      @find_offset1 = m.offset(0)[1]
        @search_found_ix = ix
        return ix 
      end
    end
  end
  return nil
end

#ask_search ⇒ Object 



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/rbcurse/listscrollable.rb', line 301

def ask_search
  options = ["Search backwards", "case insensitive", "Wrap around"]
  sel,regex,hash =  get_string_with_options("Enter regex to search", 20, @last_regex||"", "checkboxes"=>options, "checkbox_defaults"=>[@search_direction_prev,@search_case,@search_wrap])
  return if sel != 0
  @search_direction_prev =  hash[options[0]]
  @search_case = hash[options[1]]
  @search_wrap = hash[options[2]]
  if @search_direction_prev == true
    ix = _find_prev regex, @current_index
  else
    ix = _find_next regex, @current_index
  end
  if ix.nil?
    alert("No matching data for: #{regex}")
  else
    set_focus_on(ix)
    set_form_col @find_offset1
    @cell_editor.component.curpos = (@find_offset||0) if @cell_editing_allowed
  end
end

#bounds_check ⇒ Object

please set oldrow before calling this. Store current_index as oldrow before changing. NOTE



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/rbcurse/listscrollable.rb', line 72

def bounds_check
  h = scrollatrow()
  rc = row_count
  #$log.debug " PRE CURR:#{@current_index}, TR: #{@toprow} RC: #{rc} H:#{h}"
  @current_index = 0 if @current_index < 0  # not lt 0
  @current_index = rc-1 if @current_index >= rc and rc>0 # not gt rowcount
  @toprow = rc-h-1 if rc > h and @toprow > rc - h - 1 # toprow shows full page if possible
  # curr has gone below table,  move toprow forward
  if @current_index - @toprow > h
    @toprow = @current_index - h
  elsif @current_index < @toprow
    # curr has gone above table,  move toprow up
    @toprow = @current_index
  end
  #$log.debug " POST CURR:#{@current_index}, TR: #{@toprow} RC: #{rc} H:#{h}"
  if @oldrow != @current_index
    #$log.debug "going to call on leave and on enter"
    on_leave_row @oldrow if respond_to? :on_leave_row     # to be defined by widget that has included this
    on_enter_row @current_index   if respond_to? :on_enter_row  # to be defined by widget that has included this
  end
  set_form_row
  #set_form_col 0 # added 2009-02-15 23:33  # this works for lists but we don't want this in TextArea's
  @repaint_required = true
end

#find_more ⇒ Object 



321
322
323
324
325
326
327
 
# File 'lib/rbcurse/listscrollable.rb', line 321

def find_more
  if @search_direction_prev 
    find_prev
  else
    find_next
  end
end

#find_next ⇒ Object 



366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/rbcurse/listscrollable.rb', line 366

def find_next
    ix = _find_next
    regex = @last_regex 
    if ix.nil?
      alert("No more matching data for: #{regex}")
    else
      set_focus_on(ix) 
      set_form_col @find_offset1
    @cell_editor.component.curpos = (@find_offset||0) if @cell_editing_allowed
    end
end

#find_prev ⇒ Object 



377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/rbcurse/listscrollable.rb', line 377

def find_prev
    ix = _find_prev
    regex = @last_regex 
    if ix.nil?
      alert("No previous matching data for: #{regex}")
    else
      set_focus_on(ix)
      set_form_col @find_offset
      @cell_editor.component.curpos = (@find_offset||0) if @cell_editing_allowed
    end
end

#focussed_index ⇒ Object Also known as: selected_index

not that saving content_rows is buggy since we add rows.

caution, this now uses winrow not prow for user to know which row is being focussed on



179
180
181
 
# File 'lib/rbcurse/listscrollable.rb', line 179

def focussed_index
  @current_index # 2009-01-07 14:35 
end

#forward_char(char = nil) ⇒ Object

goes to next occurence of <char> (or nth occurence) Actually, we can club this with forward_word so no duplication Or call one from the other



458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
 
# File 'lib/rbcurse/listscrollable.rb', line 458

def forward_char char=nil
  if char.nil?
    $log.debug " XXX acceptng char"
    ch = @graphic.getchar
    return -1 if ch < 0 or ch > 255 # or 127 ???
    char = ch.chr
  end
  $log.debug " forward_char char:#{char}:"
  $multiplier = 1 if !$multiplier or $multiplier == 0
  line = @current_index
  buff = @list[line]
  pos = @curpos
  $multiplier.times {
    found = false
    while !found
      found = buff.index(char, pos)
      if !found
        line += 1 # unless eof
        buff = @list[line]
        pos = 0
      else
        pos = found + 1
      end
      break if line >= @list.size
      $log.debug " #{found} forward_word: pos #{pos} line #{line} buff: #{buff}"
    end
  }
  @current_index = line
  @curpos = pos
  @buffer = @list[@current_index]
  set_form_row
  set_form_col pos
  @repaint_required = true
end

#forward_word ⇒ Object

goes to start of next word (or n words) - vi’s w



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/rbcurse/listscrollable.rb', line 429

def forward_word
  $multiplier = 1 if !$multiplier or $multiplier == 0
  line = @current_index
  buff = @list[line]
  pos = @curpos
  $multiplier.times {
    found = buff.index(/[[:punct:][:space:]]/, pos)
    if !found
      # if not found, we've lost a counter
      line += 1 # unless eof
      buff = @list[line]
      pos = 0
    else
      pos = found + 1
    end
    $log.debug " forward_word: pos #{pos} line #{line} buff: #{buff}"
  }
  @current_index = line
  @curpos = pos
  @buffer = @list[@current_index]
  set_form_row
  set_form_col pos
  @repaint_required = true
end

#goto_bottom ⇒ Object Also known as: goto_end 



32
33
34
35
36
37
 
# File 'lib/rbcurse/listscrollable.rb', line 32

def goto_bottom
  @oldrow = @current_index
  rc = row_count
  @current_index = rc -1
  bounds_check
end

#goto_last_position ⇒ Object

returns cursor to last row (if moving columns in same row, won’t work) Useful after a large move such as 12j, 20 C-n etc, Mapped to ” in textview



170
171
172
173
174
 
# File 'lib/rbcurse/listscrollable.rb', line 170

def goto_last_position
  return unless @oldrow
  @current_index = @oldrow
  bounds_check
end

#goto_top ⇒ Object Also known as: goto_start 



39
40
41
42
43
 
# File 'lib/rbcurse/listscrollable.rb', line 39

def goto_top
  @oldrow = @current_index
  @current_index = 0
  bounds_check
end

#install_keys ⇒ Object

bounds_check



291
292
293
294
295
296
297
298
299
300
 
# File 'lib/rbcurse/listscrollable.rb', line 291

def install_keys
=begin
  @KEY_ASK_FIND_FORWARD ||= ?\M-f.getbyte(0)
  @KEY_ASK_FIND_BACKWARD ||= ?\M-F.getbyte(0)
  @KEY_FIND_NEXT ||= ?\M-g.getbyte(0)
  @KEY_FIND_PREV ||= ?\M-G.getbyte(0)
=end
  @KEY_ASK_FIND ||= ?\M-f.getbyte(0)
  @KEY_FIND_MORE ||= ?\M-g.getbyte(0)
end

#next_match(char) ⇒ Object

2008-12-18 18:03 finds the next match for the char pressed returning the index



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/rbcurse/listscrollable.rb', line 232

def next_match char
  data = get_content
  row = focussed_index + 1
  row.upto(data.length-1) do |ix|
    val = data[ix].chomp rescue return  # 2010-01-05 15:28 crashed on trueclass
    #if val[0,1] == char #and val != currval
    if val[0,1].casecmp(char) == 0 #AND VAL != CURRval
      return ix
    end
  end
  row = focussed_index - 1
  0.upto(row) do |ix|
    val = data[ix].chomp
    #if val[0,1] == char #and val != currval
    if val[0,1].casecmp(char) == 0 #and val != currval
      return ix
    end
  end
  return -1
end

#next_row(num = (($multiplier.nil? or $multiplier == 0) ? 1 : $multiplier)) ⇒ Object Also known as: down 



24
25
26
27
28
29
30
 
# File 'lib/rbcurse/listscrollable.rb', line 24

def next_row num=(($multiplier.nil? or $multiplier == 0) ? 1 : $multiplier)
  @oldrow = @current_index
  rc = row_count
  @current_index += 1*num if @current_index < rc
  bounds_check
  $multiplier = 0
end

#OLDscrollable_handle_key(ch) ⇒ Object 



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
226
227
228
 
# File 'lib/rbcurse/listscrollable.rb', line 189

def OLDscrollable_handle_key ch
  begin
    ###pre_key # 2009-01-07 13:23 
    case ch
    when ?\C-n.getbyte(0)
      scroll_forward
    when 32
      scroll_forward
    when ?\C-p.getbyte(0)
      scroll_backward
    when ?0.getbyte(0)
      #goto_start
      goto_top
    when ?9.getbyte(0)
      #goto_end
      goto_bottom
    when KEY_UP
      #select_prev_row
      #up
      #$log.debug " GOT KEY UP NEW SCROLL"
      previous_row
    when KEY_LEFT
    when KEY_RIGHT
    when KEY_DOWN
      #down
      #$log.debug " GOT KEY DOWN NEW SCROLL"
      next_row
    when KEY_ENTER, 10, 13
      if respond_to? :fire
        fire
      end
    when ?A.getbyte(0)..?Z.getbyte(0), ?a.getbyte(0)..?z.getbyte(0)
      ret = set_selection_for_char ch.chr
    else
      return :UNHANDLED #if ret == -1
    end
  ensure
    #post_key
  end
end

#OLDset_focus_on(arow) ⇒ Object

2008-12-18 18:05 set focus on given index



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/rbcurse/listscrollable.rb', line 274

def OLDset_focus_on arow
  return if arow > row_count()-1 or arow < 0
  @oldrow = @current_index
  total = row_count()
  @current_index = arow
  sar = scrollatrow + 1
  @toprow = (@current_index / sar) * sar

  #$log.debug "1 set_focus #{total}, sar #{sar}, toprow #{@toprow}, current_index #{@current_index}"
  if total - @toprow < sar
    @toprow = (total - sar) 
  end
  #$log.debug "2 set_focus #{total}, sar #{sar}, toprow #{@toprow}, current_index #{@current_index}"
  set_form_row # 2009-01-17 12:44 
  @repaint_required = true
  #bounds_check
end

#previous_row(num = (($multiplier.nil? or $multiplier == 0) ? 1 : $multiplier)) ⇒ Object Also known as: up 



13
14
15
16
17
18
19
20
21
22
 
# File 'lib/rbcurse/listscrollable.rb', line 13

def previous_row num=(($multiplier.nil? or $multiplier == 0) ? 1 : $multiplier)
  @oldrow = @current_index
  # NOTE that putting a multiplier inside, prevents an event from being triggered for each row's
  # on leave and on enter
  num.times { 
    @current_index -= 1 if @current_index > 0
  }
  bounds_check
  $multiplier = 0
end

#scroll_backward ⇒ Object 



45
46
47
48
49
50
51
52
 
# File 'lib/rbcurse/listscrollable.rb', line 45

def scroll_backward
  @oldrow = @current_index
  h = scrollatrow()
  m = $multiplier == 0? 1 : $multiplier
  @current_index -= h * m
  bounds_check
  $multiplier = 0
end

#scroll_forward ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/rbcurse/listscrollable.rb', line 53

def scroll_forward
  @oldrow = @current_index
  h = scrollatrow()
  rc = row_count
  m = $multiplier == 0? 1 : $multiplier
  # more rows than box
  if h * m < rc
    @toprow += h+1 #if @current_index+h < rc
    @current_index = @toprow
  else
    # fewer rows than box
    @current_index = rc -1
  end
  #@current_index += h+1 #if @current_index+h < rc
  bounds_check
end

#scroll_left ⇒ Object 



162
163
164
165
166
167
 
# File 'lib/rbcurse/listscrollable.rb', line 162

def scroll_left
  hscrollcols = $multiplier > 0 ? $multiplier : @width/2
  @pcol -= hscrollcols if @pcol > 0
  @pcol = 0 if @pcol < 0
  @repaint_required = true
end

#scroll_right ⇒ Object 



153
154
155
156
157
158
159
160
161
 
# File 'lib/rbcurse/listscrollable.rb', line 153

def scroll_right
  $log.debug " inside scroll_right "
  hscrollcols = $multiplier > 0 ? $multiplier : @width/2
  $log.debug " scroll_right  mult:#{$multiplier} , hscrollcols  #{hscrollcols}, w: #{@width} ll:#{@longest_line} "
  #blen = @buffer.rstrip.length
  blen = @longest_line
  @pcol += hscrollcols if @pcol + @width < blen 
  @repaint_required = true
end

#selected_item ⇒ Object

only to be used in single selection cases as focussed item FIXME. best not to use, as can be implementation dep, use current_index



184
185
186
 
# File 'lib/rbcurse/listscrollable.rb', line 184

def selected_item
  get_content()[focussed_index()]
end

#set_focus_on(arow) ⇒ Object

ensures that the given row is focussed new version of older one that was not perfect. 2009-01-17 13:25



266
267
268
269
270
 
# File 'lib/rbcurse/listscrollable.rb', line 266

def set_focus_on arow
  @oldrow = @current_index
  @current_index = arow
  bounds_check if @oldrow != @current_index
end

#set_form_row ⇒ Object

the cursor should be appropriately positioned



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/rbcurse/listscrollable.rb', line 97

def set_form_row
  r,c = rowcol
  @rows_panned ||= 0
  
  #[email protected]
  win_row=@win_top # 2010-02-11 15:12 RFED16
  win_row = 0 # 2010-02-07 21:44 now ext offset added by widget
  #win_row = 0 # new approach, we have it 
  #[email protected]
  # added 1 ?? in copywin too 2010-02-11 18:51  RFED16 this results in extra in normal situations.
  row = win_row + r + (@current_index-@toprow) + @rows_panned 
  $log.debug " #{@name} LIST set_form_row #{row} = ci #{@current_index} + r #{r} + winrow: #{win_row} - tr:#{@toprow} #{@toprow} + rowsp #{@rows_panned} "
  $log.debug "  - LIST set_form_row row_offset: #{@row_offset} + r #{r} + ci - topr + rowsp: #{@rows_panned}. c= #{c}  "

  ## 2009-12-28 23:05 TRYING OUT but i really can't do this everywhere. BUFFERED
  ## this needs to percolate up a heirarchy.
  ## 2010-01-05 21:09 changed c to nil, since c is not cursor col pos but where printing starts, i think
  #@form.setrowcol row, nil
  #setformrowcol row, nil
  setrowcol row, nil
  show_caret_func
end

#set_selection_for_char(char) ⇒ Object

2008-12-18 18:03 sets the selection to the next row starting with char



254
255
256
257
258
259
260
 
# File 'lib/rbcurse/listscrollable.rb', line 254

def set_selection_for_char char
  @oldrow = @current_index
  ix = next_match char
  @current_index = ix if ix && ix != -1
  bounds_check
  return ix
end

#show_caret_func ⇒ Object

paint the cursor ourselves on the widget, rather than rely on getting to the top window with the correct coordinates. I do need to erase cursor too. Can be dicey, but is worth the attempt. This works perfectly, except for when placed in a Tabbedpane since that prints the form with a row offset + of 2 and the widget does not know of the offset. cursor gets it correct since the form has an add_row.



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/rbcurse/listscrollable.rb', line 129

def show_caret_func
    return unless @show_caret
    # trying highlighting cursor 2010-01-23 19:07 TABBEDPANE TRYING
    # TODO take into account rows_panned etc ? I don't think so.
    @rows_panned ||= 0
    r,c = rowcol
    yy = r + @current_index - @toprow - @win_top
    #xx = @form.col # how do we know what value has been set earlier ?
    yy = r + @current_index - @toprow #- @win_top
    yy = @row_offset + @current_index - @toprow #- @win_top
    xx = @col_offset + @curpos || 0
    #yy = @row_offset if yy < @row_offset # sometimes r is 0, we are missing something in tabbedpane+scroll
    #xx = @col_offset if xx < @col_offset
    #xx = 0 if xx < 0

    $log.debug " #{@name} printing CARET at #{yy},#{xx}: fwt:- #{@win_top} r:#{@row} tr:-#{@toprow}+ci:#{@current_index},+r #{r}  "
    if !@oldcursorrow.nil?
        @graphic.mvchgat(y=@oldcursorrow, x=@oldcursorcol, 1, Ncurses::A_NORMAL, $datacolor, NIL)
    end
    @oldcursorrow = yy
    @oldcursorcol = xx
    @graphic.mvchgat(y=yy, x=xx, 1, Ncurses::A_NORMAL, $reversecolor, nil)
    @buffer_modified = true
end