Class: Canis::CommandWindow

Inherits:
Object show all
Includes:
Utils
Defined in:
lib/canis/core/util/rcommandwindow.rb

Overview

Creates a window at the bottom of the screen for some operations.

Used for some operations such as:
  - display a menu
  - display some interactive text
  - display some text

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Utils

#ORIG_process_key, #ORIGbind_key, #ORIGkeycode_tos, #_process_key, #bind_composite_mapping, #bind_key, #bind_keys, #check_composite_mapping, #create_logger, #define_key, #define_prefix_command, #execute_mapping, #get_attrib, #get_color, #key, #key_tos, #print_key_bindings, #repeatm, #run_command, #shell_out, #shell_output, #suspend, #view, #xxxbind_composite_mapping

Constructor Details

#initialize(form = nil, aconfig = {}, &block) ⇒ CommandWindow

— {{{



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/canis/core/util/rcommandwindow.rb', line 138

def initialize form=nil, aconfig={}, &block  # --- {{{
  @config = aconfig
  @config.each_pair { |k,v| instance_variable_set("@#{k}",v) }
  instance_eval &block if block_given?
  if @layout.nil? 
      set_layout(1,Ncurses.COLS, -1, 0) 
  end
  @height = @layout[:height]
  @width = @layout[:width]
  @window = Canis::Window.new(@layout)
  @start = 0 # row for display of text with paging
  @list = []
  draw_box
  @window.wrefresh
  @panel = @window.panel
  Ncurses::Panel.update_panels
  @window.wrefresh
  @row_offset = 0
  if @box
    @row_offset = 1
  end
end

Instance Attribute Details

#config ⇒ Object (readonly)

Returns the value of attribute config.



133
134
135
 
# File 'lib/canis/core/util/rcommandwindow.rb', line 133

def config
  @config
end

#layout ⇒ Object (readonly)

Returns the value of attribute layout.



134
135
136
 
# File 'lib/canis/core/util/rcommandwindow.rb', line 134

def layout
  @layout
end

#window ⇒ Object (readonly)

required for keyboard or printing



135
136
137
 
# File 'lib/canis/core/util/rcommandwindow.rb', line 135

def window
  @window
end

Instance Method Details

#cget(param) ⇒ Object 



271
272
273
 
# File 'lib/canis/core/util/rcommandwindow.rb', line 271

def cget param
  @config[param]
end

#clear ⇒ Object

clears the window, leaving the title line as is, from row 1 onwards



315
316
317
318
319
320
321
322
 
# File 'lib/canis/core/util/rcommandwindow.rb', line 315

def clear
  @window.wmove 1,1
  @window.wclrtobot
  #@window.box 0,0 if @box == :border
  draw_box
  # lower line of border will get erased currently since we are writing to 
  # last line FIXME
end

#configure(*val, &block) ⇒ Object

might as well add more keys for paging.



261
262
263
264
265
266
267
268
269
270
 
# File 'lib/canis/core/util/rcommandwindow.rb', line 261

def configure(*val , &block)
  case val.size
  when 1
    return @config[val[0]]
  when 2
    @config[val[0]] = val[1]
    instance_variable_set("@#{val[0]}", val[1]) 
  end
  instance_eval &block if block_given?
end

#destroy ⇒ Object 



294
295
296
 
# File 'lib/canis/core/util/rcommandwindow.rb', line 294

def destroy
  @window.destroy
end

#display_menu(list, options = {}) ⇒ Object

Displays list in a window at bottom of screen, if large then 2 or 3 columns. indexing - can be letter or number. Anything else will be ignored, however

it will result in first letter being highlighted in indexcolor

indexcolor - color of mnemonic, default green

Parameters:

  • list (Array) —

    of string to be displayed

  • configuration (Hash) —

    options: indexing and indexcolor



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
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
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
426
427
428
 
# File 'lib/canis/core/util/rcommandwindow.rb', line 339

def display_menu list, options={}  # --- {{{
  indexing = options[:indexing]
  #indexcolor = options[:indexcolor] || get_color($normalcolor, :yellow, :black)
  indexcolor = $datacolor || 7 # XXX above line crashing on choose()
  indexatt = Ncurses::A_BOLD
  #
  # the index to start from (used when scrolling a long menu such as file list)
  startindex = options[:startindex] || 0

  max_cols = 3 #  maximum no of columns, we will reduce based on data size
  l_succ = "`"
  act_height = @height
  if @box
    act_height = @height - 2
  end
  lh = list.size
  if lh < act_height
    $log.debug "DDD inside one window" if $log.debug? 
    list.each_with_index { |e, i| 
      text = e
      case e
      when Array
        text = e.first + " ..."
      end
      if indexing == :number
        mnem = i+1
        text = "%d. %s" % [i+1, text] 
      elsif indexing == :letter
        mnem = l_succ.succ!
        text = "%s. %s" % [mnem, text] 
      end
      @window.printstring i+@row_offset, 1, text, $normalcolor  
      if indexing
        @window.mvchgat(y=i+@row_offset, x=1, max=1, indexatt, indexcolor, nil)
      end
    }
  else
    $log.debug "DDD inside two window" if $log.debug? 
    row = 0
    h = act_height
    cols = (lh*1.0 / h).ceil
    cols = max_cols if cols > max_cols
    # sometimes elements are large like directory paths, so check size
    datasize = list.first.length
    if datasize > @width/3 # keep safety margin since checking only first row
      cols = 1
    elsif datasize > @width/2
      cols = [2,cols].min
    end
    adv = (@width/cols).to_i
    colct = 0
    col = 1
    $log.debug "DDDcols #{cols}, adv #{adv} size: #{lh} h: #{act_height} w #{@width} " if $log.debug? 
    list.each_with_index { |e, i| 
      text = e
      # signify that there's a deeper level
      case e
      when Array
        text = e.first + "..."
      end
      if indexing == :number
        mnem = i+1
        text = "%d. %s" % [mnem, text] 
      elsif indexing == :letter
        mnem = l_succ.succ!
        text = "%s. %s" % [mnem, text] 
      end
      # print only within range and window height
      #if i >= startindex && row < @window.actual_height
      if i >= startindex && row < @window.height
        $log.debug "XXX: MENU #{i} > #{startindex} row #{row} col #{col} "
        @window.printstring row+@row_offset, col, text, $normalcolor  
        if indexing
          @window.mvchgat(y=row+@row_offset, x=col, max=1, indexatt, indexcolor, nil)
        end
      colct += 1
      if colct == cols
        col = 1
        row += 1
        colct = 0
      else
        col += adv
      end
      end # startindex
    }
  end
  Ncurses::Panel.update_panels();
  Ncurses.doupdate();
  @window.wrefresh
end

#draw_box ⇒ Object

draw the box, needed to redo this upon clear since clearing of windows was removing the top border 2014-05-04 - 20:14



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/canis/core/util/rcommandwindow.rb', line 163

def draw_box
  if @box == :border
    @window.box 0,0
  elsif @box
    @window.attron(Ncurses.COLOR_PAIR($normalcolor) | Ncurses::A_REVERSE)

    # 2016-01-14 - replacing 1 with space since junk is showing up in some cases.
    space_char = " ".codepoints.first
    #@window.mvhline 0,0,1,@width
    @window.mvhline 0,0,space_char,@width
    @window.printstring 0,0,@title, $normalcolor #, 'normal' if @title
    @window.attroff(Ncurses.COLOR_PAIR($normalcolor) | Ncurses::A_REVERSE)
  else
    #@window.printstring 0,0,@title, $normalcolor,  'reverse' if @title
    title @title
  end
end

#handle_keys ⇒ Object

todo handle mappings, so user can map keys TODO



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/canis/core/util/rcommandwindow.rb', line 207

def handle_keys
  begin
    while((ch = @window.getchar()) != 999 )
      case ch
      when -1
        next
      else
        press ch
        break if @stop
        yield ch if block_given?
      end
    end
  ensure
    destroy  
  end
  return #@selected_index
end

#hide ⇒ Object

this really helps if we are creating another window over this and we find the lower window still showing through. destroy does not often work so this clears current window. However, lower window may still have a black region. FIXME



290
291
292
293
 
# File 'lib/canis/core/util/rcommandwindow.rb', line 290

def hide
  @window.hide
  Window.refresh_all
end

#OLDdestroy ⇒ Object 



297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/canis/core/util/rcommandwindow.rb', line 297

def OLDdestroy
  $log.debug "DESTROY : rcommandwindow"
  if @window
    begin
      panel = @window.panel
      Ncurses::Panel.del_panel(panel.pointer) if panel
      @window.delwin
    rescue => exc
    end
  end
end

#press(ch) ⇒ Object

handles a key, commandline



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/canis/core/util/rcommandwindow.rb', line 226

def press ch 
  ch = ch.getbyte(0) if ch.class==String ## 1.9
  $log.debug " XXX press #{ch} " if $log.debug? 
  case ch
  when -1
    return
  when KEY_F1, 27, ?\C-q.getbyte(0)   
    @stop = true
    return
  when KEY_ENTER, 10, 13
    #$log.debug "popup ENTER : #{@selected_index} "
    #$log.debug "popup ENTER :  #{field.name}" if !field.nil?
    @stop = true
    return
  when ?\C-d.getbyte(0)
    @start += @height-1
    bounds_check
  when KEY_UP
    @start -= 1
    @start = 0 if @start < 0
  when KEY_DOWN
    @start += 1
    bounds_check
  when ?\C-b.getbyte(0)
    @start -= @height-1
    @start = 0 if @start < 0
  when 0
    @start = 0
  end
  Ncurses::Panel.update_panels();
  Ncurses.doupdate();
  @window.wrefresh
end

#print_str(text, config = {}) ⇒ Object

not sure if this is really required. print_string is just fine. print a string. config can be :x :y :color_pair



184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/canis/core/util/rcommandwindow.rb', line 184

def print_str text, config={}
  win = config.fetch(:window, @window) # assuming its in App
  x = config.fetch :x, 0 
  y = config.fetch :y, 0
  color = config[:color_pair] || $datacolor
  raise "no window for ask print in #{self.class} name: #{name} " unless win
  color=Ncurses.COLOR_PAIR(color);
  win.attron(color);
  win.mvprintw(x, y, "%s" % text);
  win.attroff(color);
  win.refresh 
end

#refresh ⇒ Object

refresh whatevers painted onto the window



309
310
311
312
313
 
# File 'lib/canis/core/util/rcommandwindow.rb', line 309

def refresh
  Ncurses::Panel.update_panels();
  Ncurses.doupdate();
  @window.wrefresh
end

#set_layout(height = 0, width = 0, top = 0, left = 0) ⇒ Object 



275
276
277
278
279
280
281
282
283
 
# File 'lib/canis/core/util/rcommandwindow.rb', line 275

def set_layout(height=0, width=0, top=0, left=0)
  # negative means top should be n rows from last line. -1 is last line
  if top < 0
    top = Ncurses.LINES-top
  end
  @layout = { :height => height, :width => width, :top => top, :left => left } 
  @height = height
  @width = width
end

#show ⇒ Object 



284
285
286
 
# File 'lib/canis/core/util/rcommandwindow.rb', line 284

def show
  @window.show
end

#stopping? ⇒ Boolean

—- windowing functions {{{

message box

Returns:

  • (Boolean) 


202
203
204
 
# File 'lib/canis/core/util/rcommandwindow.rb', line 202

def stopping?
  @stop
end

#title(t = nil) ⇒ Object

modify the window title, or get it if no params passed.



326
327
328
329
330
 
# File 'lib/canis/core/util/rcommandwindow.rb', line 326

def title t=nil  # --- {{{
  return @title unless t
  @title = t
  @window.printstring 0,0,@title, $normalcolor,  'reverse' if @title
end