Class: RNDK::Template

Inherits:
Widget
  • Object
show all
Defined in:
lib/rndk/template.rb

Instance Attribute Summary

Attributes inherited from Widget

#BXAttr, #HZChar, #LLChar, #LRChar, #ULChar, #URChar, #VTChar, #accepts_focus, #binding_list, #border_size, #box, #exit_type, #has_focus, #is_visible, #screen, #screen_index, #supported_signals, #widget_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Widget

#Screen_XPOS, #Screen_YPOS, #after_processing, #before_processing, #bind_key, #bind_signal, #bindable_widget, #clean_bindings, #clean_title, #draw_title, #get_box, #getch, #is_bound?, #refresh_data, #run_key_binding, #run_signal_binding, #save_data, #setBXattr, #setHZchar, #setLLchar, #setLRchar, #setULchar, #setURchar, #setVTchar, #set_box, #set_exit_type, #set_title, #unbind_key, #valid?, #valid_type?

Constructor Details

#initialize(screen, config = {}) ⇒ Template

Returns a new instance of Template.



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
119
120
121
122
123
124
125
126
127
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
156
157
158
159
160
161
162
163
164
165
166
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
 
# File 'lib/rndk/template.rb', line 5

def initialize(screen, config={})
  super()
  @widget_type = :template
  @supported_signals += [:before_input, :after_input]

  x       = 0
  y       = 0
  title   = "template"
  label   = "label"
  plate   = "##/##/####"
  overlay = "dd/mm/yyyy"
  box     = true
  shadow  = false

  config.each do |key, val|
    x       = val if key == :x
    y       = val if key == :y
    title   = val if key == :title
    label   = val if key == :label
    plate   = val if key == :plate
    overlay = val if key == :overlay
    box     = val if key == :box
    shadow  = val if key == :shadow
  end

  parent_width  = Ncurses.getmaxx(screen.window)
  parent_height = Ncurses.getmaxy(screen.window)
  box_width = 0
  box_height = if box then 3 else 1 end
  plate_len = 0

  return nil if plate.nil? || plate.size == 0

  self.set_box box

  field_width = plate.size + 2 * @border_size

  # Set some basic values of the template field.
  @label = []
  @label_len = 0
  @label_win = nil

  # Translate the label string to achtype array
  if !(label.nil?) && label.size > 0
    label_len = []
    @label = RNDK.char2Chtype(label, label_len, [])
    @label_len = label_len[0]
  end

  # Translate the char * overlay to a chtype array
  if !(overlay.nil?) && overlay.size > 0
    overlay_len = []
    @overlay = RNDK.char2Chtype(overlay, overlay_len, [])
    @overlay_len = overlay_len[0]
    @field_attr = @overlay[0] & RNDK::Color[:extract]
  else
    @overlay = []
    @overlay_len = 0
    @field_attr = RNDK::Color[:normal]
  end

  # Set the box width.
  box_width = field_width + @label_len + 2 * @border_size

  old_width = box_width
  box_width = self.set_title(title, box_width)
  horizontal_adjust = (box_width - old_width) / 2

  box_height += @title_lines

  # Make sure we didn't extend beyond the dimensions of the window.
  box_width = [box_width, parent_width].min
  box_height = [box_height, parent_height].min
  field_width = [field_width,
      box_width - @label_len - 2 * @border_size].min

  # Rejustify the x and y positions if we need to.
  xtmp = [x]
  ytmp = [y]
  RNDK.alignxy(screen.window, xtmp, ytmp, box_width, box_height)
  xpos = xtmp[0]
  ypos = ytmp[0]

  # Make the template window
  @win = Ncurses.newwin(box_height, box_width, ypos, xpos)

  # Is the template window nil?
  if @win.nil?
    self.destroy
    return nil
  end
  Ncurses.keypad(@win, true)

  # Make the label window.
  if label.size > 0
    @label_win = Ncurses.subwin(@win, 1, @label_len,
        ypos + @title_lines + @border_size,
        xpos + horizontal_adjust + @border_size)
  end

  # Make the field window
  @field_win = Ncurses.subwin(@win, 1, field_width,
        ypos + @title_lines + @border_size,
        xpos + @label_len + horizontal_adjust + @border_size)
  Ncurses.keypad(@field_win, true)

  # Set up the info field.
  @plate_len = plate.size
  @info = ''
  # Copy the plate to the template
  @plate = plate.clone

  # Set up the rest of the structure.
  @screen = screen
  @parent = screen.window
  @shadow_win = nil
  @field_width = field_width
  @box_height = box_height
  @box_width = box_width
  @plate_pos = 0
  @screen_pos = 0
  @info_pos = 0
  @min = 0
  @input_window = @win
  @accepts_focus = true
  @shadow = shadow
  @callbackfn = lambda do |template, input|
    failed = false
    change = false
    moveby = false
    amount = 0
    mark = @info_pos
    have = @info.size

    if input == Ncurses::KEY_LEFT
      if mark != 0
        moveby = true
        amount = -1
      else
        failed = true
      end
    elsif input == Ncurses::KEY_RIGHT
      if mark < @info.size
        moveby = true
        amount = 1
      else
        failed = true
      end
    else
      test = @info.clone
      if input == Ncurses::KEY_BACKSPACE
        if mark != 0
          front = @info[0...mark-1] || ''
          back = @info[mark..-1] || ''
          test = front + back
          change = true
          amount = -1
        else
          failed = true
        end
      elsif input == Ncurses::KEY_DC
        if mark < @info.size
          front = @info[0...mark] || ''
          back = @info[mark+1..-1] || ''
          test = front + back
          change = true
          amount = 0
        else
          failed = true
        end
      elsif RNDK.is_char?(input) && @plate_pos < @plate.size
        test[mark] = input.chr
        change = true
        amount = 1
      else
        failed = true
      end

      if change
        if self.valid_template? test
          @info = test
          self.drawField
        else
          failed = true
        end
      end
    end

    if failed
      RNDK.beep
    elsif change || moveby
      @info_pos += amount
      @plate_pos += amount
      @screen_pos += amount

      self.adjustCursor(amount)
    end
  end

  # Do we need to create a shadow?
  if shadow
    @shadow_win = Ncurses.newwin(box_height, box_width,
        ypos + 1, xpos + 1)
  end

  screen.register(@widget_type, self)
end

Class Method Details

.isPlateChar(c) ⇒ Object 



562
563
564
 
# File 'lib/rndk/template.rb', line 562

def self.isPlateChar(c)
  '#ACcMXz'.include?(c.chr)
end

Instance Method Details

#activate(actions = []) ⇒ Object

This actually manages the tempalte widget



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/rndk/template.rb', line 214

def activate(actions=[])
  self.draw

  if actions.nil? || actions.size == 0
    while true
      input = self.getch

      # Inject each character into the widget.
      ret = self.inject(input)
      if @exit_type != :EARLY_EXIT
        return ret
      end
    end
  else
    # Inject each character one at a time.
    actions.each do |action|
      ret = self.inject(action)
      if @exit_type != :EARLY_EXIT
        return ret
      end
    end
  end

  # Set the exit type and return.
  self.set_exit_type(0)
  return ret
end

#adjustCursor(direction) ⇒ Object

Adjust the cursor for the template



456
457
458
459
460
461
462
463
464
 
# File 'lib/rndk/template.rb', line 456

def adjustCursor(direction)
  while @plate_pos < [@field_width, @plate.size].min &&
      !RNDK::Template.isPlateChar(@plate[@plate_pos])
    @plate_pos += direction
    @screen_pos += direction
  end
  Ncurses.wmove(@field_win, 0, @screen_pos)
  Ncurses.wrefresh @field_win
end

#clean ⇒ Object

Erase the information in the template widget.



542
543
544
545
546
547
 
# File 'lib/rndk/template.rb', line 542

def clean
  @info = ''
  @screen_pos = 0
  @info_pos = 0
  @plaste_pos = 0
end

#destroy ⇒ Object

Destroy this widget.



474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/rndk/template.rb', line 474

def destroy
  self.clean_title

  # Delete the windows
  RNDK.window_delete(@field_win)
  RNDK.window_delete(@label_win)
  RNDK.window_delete(@shadow_win)
  RNDK.window_delete(@win)

  # Clean the key bindings.
  self.clean_bindings

  @screen.unregister self
end

#draw(box) ⇒ Object

Draw the template widget.



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/rndk/template.rb', line 403

def draw(box)
  # Do we need to draw the shadow.
  unless @shadow_win.nil?
    Draw.drawShadow(@shadow_win)
  end

  # Box it if needed
  if box
    Draw.drawObjBox(@win, self)
  end

  self.draw_title(@win)

  Ncurses.wrefresh @win

  self.drawField
end

#drawField ⇒ Object

Draw the template field



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/rndk/template.rb', line 422

def drawField
  field_color = 0

  # Draw in the label and the template widget.
  unless @label_win.nil?
    Draw.writeChtype(@label_win, 0, 0, @label, RNDK::HORIZONTAL,
        0, @label_len)
    Ncurses.wrefresh @label_win
  end

  # Draw in the template
  if @overlay.size > 0
    Draw.writeChtype(@field_win, 0, 0, @overlay, RNDK::HORIZONTAL,
        0, @overlay_len)
  end

  # Adjust the cursor.
  if @info.size > 0
    pos = 0
    (0...[@field_width, @plate.size].min).each do |x|
      if RNDK::Template.isPlateChar(@plate[x]) && pos < @info.size
        field_color = @overlay[x] & RNDK::Color[:extract]
        Ncurses.mvwaddch(@field_win, 0, x, @info[pos].ord | field_color)
        pos += 1
      end
    end
    Ncurses.wmove(@field_win, 0, @screen_pos)
  else
    self.adjustCursor(1)
  end
  Ncurses.wrefresh @field_win
end

#erase ⇒ Object

Erase the widget.



490
491
492
493
494
495
496
497
 
# File 'lib/rndk/template.rb', line 490

def erase
  if self.valid?
    RNDK.window_erase(@field_win)
    RNDK.window_erase(@label_win)
    RNDK.window_erase(@shadow_win)
    RNDK.window_erase(@win)
  end
end

#focus ⇒ Object 



554
555
556
 
# File 'lib/rndk/template.rb', line 554

def focus
  self.draw
end

#getMin ⇒ Object 



537
538
539
 
# File 'lib/rndk/template.rb', line 537

def getMin
  return @min
end

#getValue ⇒ Object 



526
527
528
 
# File 'lib/rndk/template.rb', line 526

def getValue
  return @info
end

#inject(input) ⇒ Object

This injects a character into the widget.



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/rndk/template.rb', line 243

def inject input
  pp_return = true
  complete = false
  ret = false

  self.set_exit_type(0)

  # Move the cursor.
  self.drawField

  # Check if there is a pre-process function to be called.
  keep_going = self.run_signal_binding(:before_input, input)

  if keep_going

    # Check a predefined binding
    if self.is_bound? input
      self.run_key_binding input
      #complete = true
    else
      case input
      when RNDK::ERASE
        if @info.size > 0
          self.clean
          self.drawField
        end
      when RNDK::CUT
        if @info.size > 0
          @@g_paste_buffer = @info.clone
          self.clean
          self.drawField
        else
          RNDK.beep
        end
      when RNDK::COPY
        if @info.size > 0
          @@g_paste_buffer = @info.clone
        else
          RNDK.beep
        end
      when RNDK::PASTE
        if @@g_paste_buffer.size > 0
          self.clean

          # Start inserting each character one at a time.
          (0...@@g_paste_buffer.size).each do |x|
            @callbackfn.call(self, @@g_paste_buffer[x])
          end
          self.drawField
        else
          RNDK.beep
        end
      when RNDK::KEY_TAB, RNDK::KEY_RETURN, Ncurses::KEY_ENTER
        if @info.size < @min
          RNDK.beep
        else
          self.set_exit_type(input)
          ret = @info
          complete = true
        end
      when RNDK::KEY_ESC
        self.set_exit_type(input)
        complete = true
      when Ncurses::ERR
        self.set_exit_type(input)
        complete = true
      when RNDK::REFRESH
        @screen.erase
        @screen.refresh
      else
        @callbackfn.call(self, input)
      end
    end

    self.run_signal_binding(:after_input) if not complete
  end


  self.set_exit_type(0) if not complete
  @return_data = ret

  ret
end

#mix ⇒ Object

Return a mixture of the plate-overlay and field-info



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/rndk/template.rb', line 361

def mix
  mixed_string = ''
  plate_pos = 0
  info_pos = 0

  if @info.size > 0
    mixed_string = ''
    while plate_pos < @plate_len && info_pos < @info.size
      mixed_string << if RNDK::Template.isPlateChar(@plate[plate_pos])
                      then info_pos += 1; @info[info_pos - 1]
                      else @plate[plate_pos]
                      end
      plate_pos += 1
    end
  end

  return mixed_string
end

#move(x, y, relative, refresh_flag) ⇒ Object

Move the template field to the given location.



396
397
398
399
400
 
# File 'lib/rndk/template.rb', line 396

def move(x, y, relative, refresh_flag)
  windows = [@win, @label_win, @field_win, @shadow_win]
  self.move_specific(x, y, relative, refresh_flag,
      windows, [])
end

#position ⇒ Object 



566
567
568
 
# File 'lib/rndk/template.rb', line 566

def position
  super(@win)
end

#set(new_value, box) ⇒ Object

Set the value given to the template



500
501
502
503
 
# File 'lib/rndk/template.rb', line 500

def set(new_value, box)
  self.setValue(new_value)
  self.set_box(box)
end

#set_bg_color(attrib) ⇒ Object

Set the background attribute of the widget.



467
468
469
470
471
 
# File 'lib/rndk/template.rb', line 467

def set_bg_color(attrib)
  Ncurses.wbkgd(@win, attrib)
  Ncurses.wbkgd(@field_win, attrib)
  Ncurses.wbkgd(@label_win, attrib) unless @label_win.nil?
end

#setCB(callback) ⇒ Object

Set the callback function for the widget.



550
551
552
 
# File 'lib/rndk/template.rb', line 550

def setCB(callback)
  @callbackfn = callback
end

#setMin(min) ⇒ Object

Set the minimum number of characters to enter into the widget.



531
532
533
534
535
 
# File 'lib/rndk/template.rb', line 531

def setMin(min)
  if min >= 0
    @min = min
  end
end

#setValue(new_value) ⇒ Object

Set the value given to the template.



506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'lib/rndk/template.rb', line 506

def setValue(new_value)
  len = 0

  # Just to be sure, let's make sure the new value isn't nil
  if new_value.nil?
    self.clean
    return
  end

  # Determine how many characters we need to copy.
  copychars = [@new_value.size, @field_width, @plate.size].min

  @info = new_value[0...copychars]

  # Use the function which handles the input of the characters.
  (0...new_value.size).each do |x|
    @callbackfn.call(self, new_value[x].ord)
  end
end

#unfocus ⇒ Object 



558
559
560
 
# File 'lib/rndk/template.rb', line 558

def unfocus
  self.draw
end

#unmix(info) ⇒ Object

Return the field_info from the mixed string.



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/rndk/template.rb', line 381

def unmix(info)
  pos = 0
  unmixed_string = ''

  while pos < @info.size
    if RNDK::Template.isPlateChar(@plate[pos])
      unmixed_string << info[pos]
    end
    pos += 1
  end

  return unmixed_string
end

#valid_template?(input) ⇒ Boolean

Returns:

  • (Boolean) 


327
328
329
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
 
# File 'lib/rndk/template.rb', line 327

def valid_template? input
  pp = 0
  ip = 0
  while ip < input.size && pp < @plate.size
    newchar = input[ip]
    while pp < @plate.size && !RNDK::Template.isPlateChar(@plate[pp])
      pp += 1
    end
    if pp == @plate.size
      return false
    end

    # Check if the input matches the plate
    if RNDK.digit?(newchar) && 'ACc'.include?(@plate[pp])
      return false
    end
    if !RNDK.digit?(newchar) && @plate[pp] == '#'
      return false
    end

    # Do we need to convert the case?
    if @plate[pp] == 'C' || @plate[pp] == 'X'
      newchar = newchar.upcase
    elsif @plate[pp] == 'c' || @plate[pp] == 'x'
      newchar = newchar.downcase
    end
    input[ip] = newchar
    ip += 1
    pp += 1
  end
  return true
end