rubytext 0.1.22 → 0.1.23

data/lib/effects.rb

@@ -1,21 +1,31 @@
 
+# Helper method: insert text effects while printing
+
 def fx(str, *args, bg: nil)
   eff = RubyText::Effects.new(*args, bg: bg)
   str.define_singleton_method(:effect) { eff } 
   str  # must return str
 end
 
+# Hande text effects (bold, normal, reverse, underline)
+
 class RubyText::Effects   # dumb name?
+
+  # Text modes
   Modes  = {bold:    Curses::A_BOLD,
             normal:  Curses::A_NORMAL,
             reverse: Curses::A_REVERSE, 
             under:   Curses::A_UNDERLINE}
 
+  # Other text modes "of our own"
+
   Others = %[:show, :hide]  # show/hide cursor; more later??
 
   attr_reader :value, :fg, :bg
 
-  # TODO rewrite logic to accommodate color pairs
+  # @todo rewrite logic to accommodate color pairs
+
+  # Initialize an Effects object
   
   def initialize(*args, bg: nil)
     bits = 0
@@ -32,6 +42,8 @@ class RubyText::Effects   # dumb name?
     @value = bits
   end
 
+  # "Turn on" effect to specified window
+
   def set(win)
     @old_fg, @old_bg  = win.fg, win.bg  # Save off current state?
     attr, fg, bg = self.value, self.fg, self.bg
@@ -41,6 +53,8 @@ class RubyText::Effects   # dumb name?
     win.set_colors(fg, bg)
   end
 
+  # "Turn off" effect in specified window
+
   def reset(win)
     attr = self.value
     win.cwin.attroff(attr)

data/lib/keys.rb

@@ -1,4 +1,7 @@
+# Ruby constants for curses key definitions
+
 module RubyText::Keys
+
   Down   = 258
   Up     = 259
   Left   = 260

data/lib/menu.rb

@@ -1,6 +1,13 @@
+# The top-level module
+
 module RubyText
 
+  # Wrapper for a curses window
+
   class Window
+
+    # One-line menu at top of window
+
     def topmenu(items:, curr: 0, fg: Green, bg: Black)
       r, c = 0, 0
       high = 1
@@ -55,14 +62,16 @@ module RubyText
             next if result.nil?
             next if result.empty?
             return result
-          else Curses.beep
+        else Curses.beep
         end
         RubyText.show_cursor
       end
     end
 
+    # Simple menu with rows of strings (or Procs)
+
     def menu(r: :center, c: :center, items:, curr: 0, 
-             border: true,
+             border: true, sticky: false,
              title: nil, fg: Green, bg: Black)
       RubyText.hide_cursor
       if items.is_a?(Hash)
@@ -111,7 +120,7 @@ module RubyText
             RubyText.show_cursor
             return [nil, nil]
           when Enter
-            self.restback(high, wide, r, c)
+            self.restback(high, wide, r, c) unless sticky
             RubyText.show_cursor
             choice = results[sel]
             return [sel, choice] if choice.is_a? String
@@ -124,6 +133,8 @@ module RubyText
       end
     end
 
+    # Menu for multiple selections (buggy/unused?)
+
     def multimenu(r: :center, c: :center, 
                   items:, curr: 0, selected: [],
                   title: nil, sel_fg: Yellow, fg: White, bg: Blue)
@@ -175,6 +186,8 @@ module RubyText
       end
     end
 
+    # Simple yes/no decision
+
     def yesno
       # TODO: Accept YyNn
       r, c = STDSCR.rc
@@ -182,6 +195,8 @@ module RubyText
       num == 0
     end
 
+    # Menu to choose a single setting and retain it
+
     def radio_menu(r: :center, c: :center, items:, curr: 0, 
              # Handle current value better?
              border: true,
@@ -251,6 +266,11 @@ module RubyText
       end
     end
   end
+end
+
+module RubyText
+
+  # Two-paned widget with menu on left, informtional area on right
 
   def self.selector(win: STDSCR, r: 0, c: 0, rows: 10, cols: 20, 
                     items:, fg: White, bg: Blue,
@@ -301,5 +321,59 @@ module RubyText
   rescue
     retry
   end
+
+  # "Menu" for checklists
+
+    def checklist(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 + 8
+      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.find {|x| x[0] == row } ? sel_fg : fg
+          label = "[ ]" + item
+          mwin.print fx(label, color, style)
+        end
+        ch = getch
+        case ch
+          when Up
+            sel -= 1 if sel > 0
+          when Down
+            sel += 1 if sel < max
+          when Esc
+            self.restback(high, wide, r, c)
+            RubyText.show_cursor
+            return []
+          when Enter
+            self.restback(high, wide, r, c)
+            RubyText.show_cursor
+            return selected.map {|i| items[i] }
+          when " "
+            selected << [sel, items[sel]]
+            sel += 1 if sel < max
+        else Curses.beep
+        end
+        RubyText.show_cursor
+      end
+    end
+
 end
 

data/lib/navigation.rb

@@ -1,5 +1,9 @@
+# Reopening: Coordinate handling (1-based!)
+
 class RubyText::Window
 
+  # Handle special coordinate names (symbols)
+
   def coords(r, c)
     r = case
           when r == :center
@@ -24,10 +28,17 @@ class RubyText::Window
     [r, c]
   end
 
+  # Go to specified row/column in current window
+
   def goto(r, c)  # only accepts numbers!
     @cwin.setpos(r, c)
+    @cwin.refresh
   end
 
+
+  # Go to specified row/column in current window,
+  #   execute block, and return cursor
+
   def go(r0, c0)
     r, c = coords(r0, c0)
     save = self.rc
@@ -38,60 +49,84 @@ class RubyText::Window
     end
   end
 
+  # Move cursor up
+
   def up(n=1)
     r, c = rc
     go r-n, c
   end
 
+  # Move cursor down
+
   def down(n=1)
     r, c = rc
     go r+n, c
   end
 
+  # Move cursor left
+
   def left(n=1)
     r, c = rc
     go r, c-n
   end
 
+  # Move cursor right
+
   def right(n=1)
     r, c = rc
     go r, c+n
   end
 
+  # Move cursor to top of window
+
   def top
     r, c = rc
     go 0, c
   end
 
+  # Move cursor to bottom of window
+
   def bottom 
     r, c = rc
     rmax = self.rows - 1
     go rmax, c
   end
 
+  # Move cursor to top of window
+
   def up!
     top
   end
 
+  # Move cursor to bottom of window
+
   def down!
     bottom
   end
 
+  # Move cursor to far left of window
+
   def left!
     r, c = rc
     go r, 0
   end
 
+  # Move cursor to far left of window
+
   def right!
     r, c = rc
     cmax = self.cols - 1
     go r, cmax
   end
 
+  # Move cursor to home (upper left)
+
   def home
     go 0, 0
   end
 
+  # Return current row/column
+
   def rc
     [@cwin.cury, @cwin.curx]
   end

data/lib/output.rb

@@ -123,17 +123,31 @@ class RubyText::Window
     $stdscr = STDSCR
   end
 
+=begin
+  def go(r0, c0)
+    r, c = coords(r0, c0)
+    save = self.rc
+    goto r, c 
+    if block_given?
+      yield 
+      goto *save
+    end
+  end
+=end
+
   def [](r, c)
-    ch = nil
-    go(r, c) { ch = @cwin.inch }
-    debug "ch = #{ch}  ch.chr = #{ch.chr}"
+    r0, c0 = self.rc
+    @cwin.setpos(r, c)
+    ch = @cwin.inch
+    @cwin.setpos(r0, c0)
     ch.chr
   end
 
   def []=(r, c, char)
+    r0, c0 = self.rc
     @cwin.setpos(r, c)
     @cwin.addch(char[0].ord|Curses::A_NORMAL)
-    @cwin.setpos(r, c)
+    @cwin.setpos(r0, c0)
     @cwin.refresh
   end
 

data/lib/rubytext_version.rb

@@ -1,6 +1,6 @@
 
 module RubyText
-  VERSION = "0.1.22"
+  VERSION = "0.1.23"
 
   Path  = File.expand_path(File.join(File.dirname(__FILE__)))
 end

data/lib/settings.rb

@@ -101,6 +101,7 @@ module RubyText
     Object.const_set(:STDSCR, main) unless defined? STDSCR
     $stdscr = STDSCR  # FIXME global needed?
     Object.include(WindowIO)
+    Curses.ESCDELAY = 10
     @started = true
 # rescue => err
 #   puts(err.inspect)

data/lib/window.rb

@@ -6,6 +6,7 @@ module RubyText
     c ||= (STDSCR.cols - wide)/2
     win = RubyText::Window.new(high, wide, r, c, border, fg, bg, scroll)
     win.add_title(title) if title
+    0.upto(high) {|row| 0.upto(wide) {|col| win[row, col] = " " } }
     win
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubytext
 version: !ruby/object:Gem::Version
-  version: 0.1.22
+  version: 0.1.23
 platform: ruby
 authors:
 - Hal Fulton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-06 00:00:00.000000000 Z
+date: 2020-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curses
@@ -76,7 +76,33 @@ files:
 - examples/updown_etc.rb
 - examples/win_centering.rb
 - examples/window_full.rb
+- lib/.yardoc/checksums
+- lib/.yardoc/complete
+- lib/.yardoc/object_types
+- lib/.yardoc/objects/root.dat
+- lib/.yardoc/proxy_types
 - lib/color.rb
+- lib/doc/RubyText.html
+- lib/doc/RubyText/Color.html
+- lib/doc/RubyText/Effects.html
+- lib/doc/RubyText/Keys.html
+- lib/doc/RubyText/Settings.html
+- lib/doc/RubyText/Window.html
+- lib/doc/RubyText/Window/GetString.html
+- lib/doc/WindowIO.html
+- lib/doc/_index.html
+- lib/doc/class_list.html
+- lib/doc/css/common.css
+- lib/doc/css/full_list.css
+- lib/doc/css/style.css
+- lib/doc/file_list.html
+- lib/doc/frames.html
+- lib/doc/index.html
+- lib/doc/js/app.js
+- lib/doc/js/full_list.js
+- lib/doc/js/jquery.js
+- lib/doc/method_list.html
+- lib/doc/top-level-namespace.html
 - lib/effects.rb
 - lib/keys.rb
 - lib/menu.rb