Class: RubyText::Window

Inherits:
Object
  • Object
show all
Defined in:
lib/menu.rb,
lib/color.rb,
lib/output.rb,
lib/window.rb,
lib/rubytext.rb,
lib/navigation.rb

Defined Under Namespace

Classes: GetString

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(high = nil, wide = nil, r0 = 0, c0 = 0, border = false, fg = White, bg = Blue, scroll = false) ⇒ Window

Better to use Window.window IRL



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/window.rb', line 23

def initialize(high=nil, wide=nil, r0=0, c0=0, border=false, 
               fg=White, bg=Blue, scroll=false)
  @wide, @high, @r0, @c0 = wide, high, r0, c0
  @border, @fg, @bg      = border, fg, bg
  @cwin = Curses::Window.new(high, wide, r0, c0)
  colorize!(fg, bg)
  if @border
    @cwin.box(Vert, Horiz)
    @outer = @cwin
    @outer.refresh
    @cwin = Curses::Window.new(high-2, wide-2, r0+1, c0+1)
    colorize!(fg, bg)
  else
    @outer = @cwin
  end
  @rows, @cols = @cwin.maxy, @cwin.maxx  # unnecessary really...
  @width, @height = @cols + 2, @rows + 2 if @border
  @scrolling = scroll
  @cwin.scrollok(scroll) 
  @cwin.refresh
end

Instance Attribute Details

#bg ⇒ Object

Returns the value of attribute bg.



19
20
21
 
# File 'lib/window.rb', line 19

def bg
  @bg
end

#c0 ⇒ Object (readonly)

Returns the value of attribute c0.



18
19
20
 
# File 'lib/window.rb', line 18

def c0
  @c0
end

#cols ⇒ Object (readonly)

Returns the value of attribute cols.



17
18
19
 
# File 'lib/window.rb', line 17

def cols
  @cols
end

#cwin ⇒ Object (readonly)

Returns the value of attribute cwin.



17
18
19
 
# File 'lib/window.rb', line 17

def cwin
  @cwin
end

#fg ⇒ Object

Returns the value of attribute fg.



19
20
21
 
# File 'lib/window.rb', line 19

def fg
  @fg
end

#height ⇒ Object (readonly)

Returns the value of attribute height.



17
18
19
 
# File 'lib/window.rb', line 17

def height
  @height
end

#r0 ⇒ Object (readonly)

Returns the value of attribute r0.



18
19
20
 
# File 'lib/window.rb', line 18

def r0
  @r0
end

#rows ⇒ Object (readonly)

Returns the value of attribute rows.



17
18
19
 
# File 'lib/window.rb', line 17

def rows
  @rows
end

#scrolling(flag = true) ⇒ Object (readonly)

FIXME refactor bad code



90
91
92
 
# File 'lib/window.rb', line 90

def scrolling
  @scrolling
end

#width ⇒ Object (readonly)

Returns the value of attribute width.



17
18
19
 
# File 'lib/window.rb', line 17

def width
  @width
end

Class Method Details

.clear(win) ⇒ Object

delete this?



99
100
101
102
103
104
105
 
# File 'lib/output.rb', line 99

def self.clear(win)   # delete this?
  num = win.maxx * win.maxy
  win.setpos(0, 0)
  win.addstr(' '*num)
  win.setpos(0, 0)
  win.refresh
end

.colorize!(cwin, fg, bg) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/color.rb', line 31

def self.colorize!(cwin, fg, bg)
  cp = RubyText::Color.pair(fg, bg)
  cwin.color_set(cp)
  num = cwin.maxx * cwin.maxy
  cwin.setpos 0,0
  cwin.addstr(' '*num)
  cwin.setpos 0,0
  cwin.refresh
rescue => err
  File.open("/tmp/#{__method__}.out", "w") do |f|
    f.puts err
    f.puts err.backtrace
  end
end

.main(fg: White, bg: Blue, scroll: false) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/window.rb', line 45

def self.main(fg: White, bg: Blue, scroll: false)
  debug "Starting #main..."
  main_win = Curses.init_screen
  Curses.start_color
  self.colorize!(main_win, fg, bg)
  rows, cols = main_win.maxy, main_win.maxx
  win = self.make(main_win, rows, cols, 0, 0, border: false,
            fg: fg, bg: bg, scroll: scroll)
  debug "...started #main"
  win
rescue => err
  File.open("/tmp/main.out", "w") {|f| f.puts err.inspect; f.puts err.backtrace } 
end

.make(cwin, high, wide, r0, c0, border: true, fg: White, bg: Black, scroll: false) ⇒ Object

FIXME try again to inline this



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/window.rb', line 61

def self.make(cwin, high, wide, r0, c0, border: true, fg: White, bg: Black, scroll: false)
  obj = self.allocate
  obj.instance_eval do 
    @outer = @cwin = cwin
    @wide, @high, @r0, @c0 = wide, high, r0, c0
    @fg, @bg = fg, bg
    @border = border
    @rows, @cols = high, wide
    @width, @height = @cols + 2, @rows + 2 if @border
  end
  obj.scrolling(scroll)
  obj
end

Instance Method Details

#[](r, c) ⇒ Object 



118
119
120
121
122
123
 
# File 'lib/output.rb', line 118

def [](r, c)
  ch = nil
  go(r, c) { ch = @cwin.inch }
  debug "ch = #{ch}  ch.chr = #{ch.chr}"
  ch.chr
end

#[]=(r, c, char) ⇒ Object 



125
126
127
128
129
130
 
# File 'lib/output.rb', line 125

def []=(r, c, char)
  @cwin.setpos(r, c)
  @cwin.addch(char[0].ord|Curses::A_NORMAL)
  @cwin.setpos(r, c)
  @cwin.refresh
end

#_putch(ch) ⇒ Object 



59
60
61
 
# File 'lib/output.rb', line 59

def _putch(ch)
  @cwin.addch(ch)
end

#add_title(str, align = :center) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/window.rb', line 75

def add_title(str, align = :center)
  raise "No border" unless @border
  len = str.length  # What if it's too long?
  start = case align
            when :left;   1
            when :center; (@outer.maxx - len)/2
            when :right;  @outer.maxx - len - 1
          end
  @outer.setpos 0, start
  @outer.addstr str
  @outer.refresh
end

#beep ⇒ Object 



159
160
161
 
# File 'lib/window.rb', line 159

def beep
  Curses.beep
end

#bottom ⇒ Object 



66
67
68
69
70
 
# File 'lib/navigation.rb', line 66

def bottom 
  r, c = rc
  rmax = self.rows - 1
  go rmax, c
end

#boxme ⇒ Object 



132
133
134
135
 
# File 'lib/output.rb', line 132

def boxme
  @outer.box(Vert, Horiz)
  @outer.refresh
end

#center(str) ⇒ Object 



4
5
6
7
8
9
 
# File 'lib/output.rb', line 4

def center(str)
  r, c = self.rc
  n = @cwin.maxx - str.length
  go r, n/2
  self.puts str
end

#clear ⇒ Object 



107
108
109
110
 
# File 'lib/output.rb', line 107

def clear
  self.home
  self.scroll self.rows
end

#colorize!(fg, bg) ⇒ Object 



51
52
53
54
55
56
57
 
# File 'lib/color.rb', line 51

def colorize!(fg, bg)
  set_colors(fg, bg)
  num = @cwin.maxx * @cwin.maxy
  self.home
  self.go(0, 0) { @cwin.addstr(' '*num) }
  @cwin.refresh
end

#coords(r, c) ⇒ Object 



3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/navigation.rb', line 3

def coords(r, c)
  r = case
        when r == :center
          self.rows / 2 
        when r == :top
          0
        when r == :bottom
          self.rows - 1
        else
          r
        end
  c = case
        when c == :center
          self.cols / 2 
        when c == :left
          0
        when c == :right
          self.cols - 1
        else
          c
        end
  [r, c]
end

#crlf ⇒ Object

Technically not output…



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/output.rb', line 81

def crlf     # Technically not output...
  r, c = rc
  if @scrolling
    if r == @rows - 1  # bottom row
      scroll
      left!
    else
      go r+1, 0
    end
  else
    if r == @rows - 1  # bottom row
      left!
    else
      go r+1, 0
    end
  end
end

#delegate_output(sym, *args) ⇒ Object 



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/output.rb', line 17

def delegate_output(sym, *args)
  self.cwin.attrset(0)
  args = [""] if args.empty?
  args += ["\n"] if sym == :puts
  set_colors(@fg, @bg)
  meth = sym == :p ? :inspect : :to_s
  args.map! {|x| effect?(x) ? x : x.send(meth) }
  args.each do |arg|  
    if arg.is_a?(RubyText::Effects)
      arg.set(self)
    else
      arg.effect.set(self) if arg.respond_to? :effect
      arg.each_char {|ch| ch == "\n" ? crlf : @cwin.addch(ch) }
      @cwin.refresh
    end
  end
  crlf if sym == :p   # no implicit newline
  set_colors(@fg, @bg)
  @cwin.refresh
end

#down(n = 1) ⇒ Object 



46
47
48
49
 
# File 'lib/navigation.rb', line 46

def down(n=1)
  r, c = rc
  go r+n, c
end

#down! ⇒ Object 



76
77
78
 
# File 'lib/navigation.rb', line 76

def down!
  bottom
end

#effect?(arg) ⇒ Boolean

FIXME Please refactor the Hal out of this.

Returns:

  • (Boolean) 


13
14
15
 
# File 'lib/output.rb', line 13

def effect?(arg)
  arg.is_a?(RubyText::Effects)
end

#flash ⇒ Object 



163
164
165
 
# File 'lib/window.rb', line 163

def flash
  Curses.flash
end

#gets(history: [], limit: nil, default: "") ⇒ Object

still needs improvement



224
225
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
 
# File 'lib/output.rb', line 224

def gets(history: [], limit: nil, default: "")  # still needs improvement
  # echo assumed to be OFF, keypad ON
  @history = history
  gs = GetString.new(self, default, history: history, limit: limit)
  loop do
    ch = self.getch
    case ch
      when 10
        gs.enter
        break
      when 8, 127, 63   # backspace, del, ^H (huh?)
        gs.backspace
      when 260   # left-arrow
        gs.left_arrow
      when 261   # right-arrow
        gs.right_arrow
      when 259   # up
        next if @history.nil?  # move this?
        gs.history_prev
      when 258   # down
        next if @history.nil?  # move this?
        gs.history_next
      when Integer
        Curses.beep
      else
        gs.add(ch)
    end
  end
  gs.value
end

#go(r0, c0) ⇒ Object 



31
32
33
34
35
36
37
38
39
 
# File 'lib/navigation.rb', line 31

def go(r0, c0)
  r, c = coords(r0, c0)
  save = self.rc
  goto r, c 
  if block_given?
    yield 
    goto *save
  end
end

#goto(r, c) ⇒ Object

only accepts numbers!



27
28
29
 
# File 'lib/navigation.rb', line 27

def goto(r, c)  # only accepts numbers!
  @cwin.setpos(r, c)
end

#home ⇒ Object 



91
92
93
 
# File 'lib/navigation.rb', line 91

def home
  go 0, 0
end

#left(n = 1) ⇒ Object 



51
52
53
54
 
# File 'lib/navigation.rb', line 51

def left(n=1)
  r, c = rc
  go r, c-n
end

#left! ⇒ Object 



80
81
82
83
 
# File 'lib/navigation.rb', line 80

def left!
  r, c = rc
  go r, 0
end

#menu(r: :center, c: :center, items:, curr: 0, title: nil, fg: White, bg: Blue) ⇒ Object 



4
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
 
# File 'lib/menu.rb', line 4

def menu(r: :center, c: :center, items:, curr: 0,
         title: nil, fg: White, bg: Blue)
  RubyText.hide_cursor
  high = items.size + 2
  wide = items.map(&:length).max + 5
  tlen = title.length + 8 rescue 0
  wide = [wide, tlen].max
  row, col = self.coords(r, c)
  row = row - high/2 if r == :center
  col = col - wide/2 if c == :center
  r, c = row, col
  self.saveback(high, wide, r, c)
  mr, mc = r+self.r0, c+self.c0
  mwin = RubyText.window(high, wide, r: mr, c: mc, 
                         fg: fg, bg: bg, title: title)
  Curses.stdscr.keypad(true)
  sel = curr
  max = items.size - 1
  loop do
    RubyText.hide_cursor  # FIXME should be unnecessary
    items.each.with_index do |item, row|
      mwin.go row, 0
      style = (sel == row) ? :reverse : :normal
      label = (" "*2 + item + " "*8)[0..wide-1]
      mwin.print fx(label, style)
    end
    ch = getch
    case ch
      when Curses::KEY_UP
        sel -= 1 if sel > 0
      when Curses::KEY_DOWN
        sel += 1 if sel < max
      when 27
        self.restback(high, wide, r, c)
        RubyText.show_cursor
        return [nil, nil]
      when 10
        self.restback(high, wide, r, c)
        RubyText.show_cursor
        return [sel, items[sel]]
      else Curses.beep
    end
    RubyText.show_cursor
  end
end

#multimenu(r: :center, c: :center, items:, curr: 0, selected: [], title: nil, sel_fg: Yellow, fg: White, bg: Blue) ⇒ Object 



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
 
# File 'lib/menu.rb', line 50

def multimenu(r: :center, c: :center, 
              items:, curr: 0, selected: [],
              title: nil, sel_fg: Yellow, fg: White, bg: Blue)
  RubyText.hide_cursor
  high = items.size + 2
  wide = items.map(&:length).max + 5
  tlen = title.length + 8 rescue 0
  wide = [wide, tlen].max
  row, col = self.coords(r, c)
  row = row - high/2 if r == :center
  col = col - wide/2 if c == :center
  r, c = row, col
  self.saveback(high, wide, r, c)
  mr, mc = r+self.r0, c+self.c0
  mwin = RubyText.window(high, wide, r: mr, c: mc, 
                         fg: fg, bg: bg, title: title)
  Curses.stdscr.keypad(true)
  sel = curr
  max = items.size - 1
  loop do
    RubyText.hide_cursor  # FIXME should be unnecessary
    items.each.with_index do |item, row|
      mwin.go row, 0
      style = (sel == row) ? :reverse : :normal
      color = selected.include?(row) ? sel_fg : fg
      label = (" "*2 + item + " "*8)[0..wide-1]
      mwin.print fx(label, color, style)
    end
    ch = getch
    case ch
      when Curses::KEY_UP
        sel -= 1 if sel > 0
      when Curses::KEY_DOWN
        sel += 1 if sel < max
      when 27
        self.restback(high, wide, r, c)
        RubyText.show_cursor
        return []
      when 10
        self.restback(high, wide, r, c)
        RubyText.show_cursor
        return selected.map {|i| items[i] }
      when " "
        selected << sel
        sel += 1 if sel < max
      else Curses.beep
    end
    RubyText.show_cursor
  end
end

#output(&block) ⇒ Object 



112
113
114
115
116
 
# File 'lib/output.rb', line 112

def output(&block)
  $stdscr = self
  block.call
  $stdscr = STDSCR
end

#p(*args) ⇒ Object 



46
47
48
 
# File 'lib/output.rb', line 46

def p(*args)
  delegate_output(:p, *args)
end

#print(*args) ⇒ Object 



42
43
44
 
# File 'lib/output.rb', line 42

def print(*args)
  delegate_output(:print, *args)
end

#putch(ch, r: nil, c: nil, fx: nil) ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/output.rb', line 63

def putch(ch, r: nil, c: nil, fx: nil)
  debug("putch: #{[ch, r, c, fx].inspect}")
  if r.nil? && c.nil? && fx.nil?
    _putch(ch) 
  else
    r0, c0 = self.rc
    r ||= r0
    c ||= c0
    go(r, c) do
      fx.set(self) if fx
      val = fx.value rescue 0
      @cwin.addch(ch.ord|val)
    end
    fx.reset(self) if fx
  end
  @cwin.refresh
end

#puts(*args) ⇒ Object 



38
39
40
 
# File 'lib/output.rb', line 38

def puts(*args)
  delegate_output(:puts, *args)
end

#rc ⇒ Object 



95
96
97
 
# File 'lib/navigation.rb', line 95

def rc
  [@cwin.cury, @cwin.curx]
end

#rcprint(r, c, *args) ⇒ Object 



50
51
52
 
# File 'lib/output.rb', line 50

def rcprint(r, c, *args)
  self.go(r, c) { self.print *args }
end

#rcprint!(r, c, *args) ⇒ Object 



54
55
56
57
 
# File 'lib/output.rb', line 54

def rcprint!(r, c, *args)
  self.go(r, c)  # Cursor isn't restored
  self.print *args
end

#refresh ⇒ Object 



137
138
139
 
# File 'lib/output.rb', line 137

def refresh
  @cwin.refresh
end

#restback(high, wide, r, c) ⇒ Object 



137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/window.rb', line 137

def restback(high, wide, r, c)
  0.upto(high-1) do |h|
    line = ""
    0.upto(wide-1) {|w| line << @save.shift }
    row, col = h+r-1, c-1
    row += 1 if self == STDSCR   # wtf?
    col += 1 if self == STDSCR
    self.go row, col
    self.print line
  end
  self.go *@pos
  @cwin.refresh
end

#right(n = 1) ⇒ Object 



56
57
58
59
 
# File 'lib/navigation.rb', line 56

def right(n=1)
  r, c = rc
  go r, c+n
end

#right! ⇒ Object 



85
86
87
88
89
 
# File 'lib/navigation.rb', line 85

def right!
  r, c = rc
  cmax = self.cols - 1
  go r, cmax
end

#saveback(high, wide, r, c) ⇒ Object 



123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/window.rb', line 123

def saveback(high, wide, r, c)
  debug "saveback: #{[high, wide, r, c].inspect}"
  @pos = self.rc
  @save = []
  0.upto(high-1) do |h|
    0.upto(wide-1) do |w|
      row, col = h+r-1, w+c-1
      row += 1 if self == STDSCR   # wtf?
      col += 1 if self == STDSCR
      @save << self[row, col]
    end
  end
end

#screen_text(file = nil) ⇒ Object

rename?



110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/window.rb', line 110

def screen_text(file = nil)   # rename?
  lines = []
  0.upto(self.rows-1) do |r|
    line = ""
    0.upto(self.cols-1) do |c|
      line << self[r, c]
    end
    lines << line
  end
  File.open(file, "w") {|f| f.puts lines }  if file
  lines
end

#scroll(n = 1) ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/window.rb', line 95

def scroll(n=1)
  if n < 0
    @cwin.scrl(n)
    (-n).times {|i| rcprint i, 0, (' '*@cols) }
  else
    n.times do |i|
      @cwin.scroll
      scrolling(false)
      rcprint @rows-1, 0, (' '*@cols)
      scrolling
    end
  end
  @cwin.refresh
end

#set_colors(fg, bg) ⇒ Object 



46
47
48
49
 
# File 'lib/color.rb', line 46

def set_colors(fg, bg)
  cp = RubyText::Color.pair(fg, bg)
  @cwin.color_set(cp)
end

#top ⇒ Object 



61
62
63
64
 
# File 'lib/navigation.rb', line 61

def top
  r, c = rc
  go 0, c
end

#up(n = 1) ⇒ Object 



41
42
43
44
 
# File 'lib/navigation.rb', line 41

def up(n=1)
  r, c = rc
  go r-n, c
end

#up! ⇒ Object 



72
73
74
 
# File 'lib/navigation.rb', line 72

def up!
  top
end