reterm 0.4.2

data/lib/reterm/components/hslider.rb

@@ -0,0 +1,32 @@
+module RETerm
+  module Components
+    # Horizontal Slider, implemented using Slider CDK component
+    class HSlider < Component
+      include CDKComponent
+
+      # Initialize the HSlider component
+      #
+      # @param [Hash] args slider params
+      # @option args [String] :title title of slider
+      # @option args [String] :label label of slider
+      def initialize(args={})
+        @title = args[:title] || " "
+        @label = args[:label] || " "
+
+        @increment     = 1
+        @range         = [0, 100]
+      end
+
+      private
+
+      def _component
+        CDK::SLIDER.new(window.cdk_scr,                       # cdkscreen,
+                        CDK::CENTER, CDK::CENTER,             # xplace, yplace
+                        @title, @label, '#'.ord,              # title, label, filler,
+                        window.cols-6, @range[0], @range[0],  # field_width, start, low,
+                        @range[1], @increment, @increment*2,  # high, inc, fast_inc,
+                        false, false)                         # box, shadow
+      end
+    end # VSlider
+  end # module Components
+end # module RETerm

data/lib/reterm/components/image.rb

@@ -0,0 +1,55 @@
+module RETerm
+  module Components
+    # Renders and image to the screen using drawille and chunkpng.
+    class Image < Component
+
+      # Initialize the Image component
+      #
+      # @param [Hash] args image params
+      # @option args [String] :file path to the file containing
+      #   the image
+      def initialize(args={})
+        @file = args[:file]
+      end
+
+      def draw!
+        refresh_win
+      end
+
+      protected
+
+      def canvas
+        require 'drawille'
+        @canvas ||= Drawille::Canvas.new
+      end
+
+      def image
+        require 'chunky_png'
+        @image ||= ChunkyPNG::Image.from_file(@file)
+      end
+
+      def refresh_win
+        w = [image.dimension.width-1,  window.cols].min
+        h = [image.dimension.height-1, window.rows].min
+
+        (0..w).each do |x|
+          (0..h).each do |y|
+            r = ChunkyPNG::Color.r(image[x,y])
+            g = ChunkyPNG::Color.g(image[x,y])
+            b = ChunkyPNG::Color.b(image[x,y])
+            canvas.set(x, y) if (r + b + g) > 100
+          end
+        end
+
+        y = 1
+        canvas.frame.split("\n").each { |line|
+          window.mvaddstr(y, 1, line)
+          y += 1
+        }
+
+        window.refresh
+        update_reterm
+      end
+    end # class Canvas
+  end # module Components
+end # module RETerm

data/lib/reterm/components/label.rb

@@ -0,0 +1,20 @@
+module RETerm
+  module Components
+    # Simply renders text to window
+    class Label < Component
+
+      # Initialize the Label component
+      #
+      # @param [Hash] args label params
+      # @option args [String] :text text of button
+      def initialize(args={})
+        @text    = args[:text] || ""
+      end
+
+      def draw!
+        window.mvaddstr(1, 1, @text)
+        update_reterm
+      end
+    end # Label
+  end # module Components
+end # module RETerm

data/lib/reterm/components/matrix.rb

@@ -0,0 +1,43 @@
+module RETerm
+  module Components
+    # CDK Matrix Component
+    class Matrix < Component
+      include CDKComponent
+
+      # Initialize the Matrix component
+      #
+      # @param [Hash] args matrix params
+      def initialize(args={})
+        @rows  = args[:rows]
+        @cols  = args[:cols]
+        @title = args[:title]
+
+        @rowtitles = args[:rowtitles] || args[:row_titles] || Array.new(@rows) { "" }
+        @coltitles = args[:coltitles] || args[:col_titles] || Array.new(@cols+1) { "" }
+        @colwidths = args[:colwidths] || args[:col_widths] || Array.new(@cols+1) { 5 }
+        @coltypes  = args[:coltypes]  || args[:col_types]  || Array.new(@cols+1) { :UMIXED }
+      end
+
+      def get(x, y)
+        component.getCell(x, y)
+      end
+
+      private
+
+      def _component
+        CDK::MATRIX.new(window.cdk_scr,
+                        2, 2,                                # xpos, ypos
+                        @rows, @cols,                        # matrix rows, cols
+                        [(window.rows - 2), @rows].min,      # screen rows
+                        [(window.cols - 2), @cols].min,      # screen cols
+                        @title,                              # title
+                        @rowtitles, @coltitles,              # row/col titles
+                        @colwidths, @coltypes,               # col widths and types
+                        -1, -1,                              # row/col spacing
+                        '.',                                 # filler
+                        2,                                   # dominant attribute
+                        true, true, false)                   # box matrix, box cell, shadow
+      end
+    end # Matrix
+  end # module Components
+end # module RETerm

data/lib/reterm/components/radio.rb

@@ -0,0 +1,33 @@
+module RETerm
+  module Components
+    # CDK Radio Component
+    class Radio < Component
+      include CDKComponent
+
+      # Initialize the Radio component
+      #
+      # @param [Hash] args radio params
+      # @option args [String] :title title of radio
+      # @option args [Array<String>] :items items to
+      #   populate radio with
+      def initialize(args={})
+        @title  = args[:title] || ""
+        @items  = args[:items] || []
+      end
+
+      private
+
+      def _component
+        CDK::RADIO.new(window.cdk_scr,                         # cdkscreen,
+                       2, 1, CDK::RIGHT,                       # xplace, yplace, scroll pos
+                       window.rows - 2,                        # widget height
+                       window.cols  - 2,                       # widget width
+                       @title, @items, @items.size,            # title and items
+                       '#'.ord | Ncurses::A_REVERSE,           # choice char
+                       true,                                   # default item
+                       Ncurses::A_REVERSE,                     # highlight
+                       true, false)                            # box, shadow
+      end
+    end # Radio
+  end # module Components
+end # module RETerm

data/lib/reterm/components/rocker.rb

@@ -0,0 +1,71 @@
+module RETerm
+  module Components
+    # Rocker component, allowing use to select one of several values
+    class Rocker < Component
+      include ComponentInput
+
+      attr_accessor :values, :index, :labels
+
+      # Initialize the Rocker component
+      #
+      # @param [Hash] args rocker params
+      #
+      # @example using the Rocker
+      #   win    = Window.new
+      #   rocker = Rocker.new
+      #   win.component = rocker
+      #   rocker.values = ['Foo', 'Bar', 'Baz']
+      #   val = rocker.activate!
+      #
+      def initialize(args={})
+        @values = []
+        @index  = nil
+        @labels = true
+        @index  = 0
+      end
+
+      def draw!
+        refresh_win
+      end
+
+      def activatable?
+        true
+      end
+
+      def activate!
+        refresh_win
+        handle_input
+        @values[@index]
+      end
+
+      private
+
+      def on_inc
+        @index += 1
+        @index  = @values.size - 1 if @index == @values.size
+        refresh_win
+      end
+
+      def on_dec
+        @index -= 1
+        @index  = 0 if @index < 0
+        refresh_win
+      end
+
+      def refresh_win
+        pre  = post = ' '
+        pre  = '-' if @labels
+        post = '+' if @labels
+
+        window.mvaddstr(1, 1, " |#{pre}|")
+        @values.each_with_index { |v, i|
+          sel = @index == i ? "#" : " "
+          window.mvaddstr(i+2, 1, " |" + sel + "|" + @values[i])
+        }
+        window.mvaddstr(@values.size+2, 1, " |#{post}|")
+        window.refresh
+        update_reterm
+      end
+    end # Rocker
+  end # module Components
+end # module RETerm

data/lib/reterm/components/slist.rb

@@ -0,0 +1,32 @@
+module RETerm
+  module Components
+    # Scrolling List CDK Component
+    class SList < Component
+      include CDKComponent
+
+      # Initialize the SList component
+      #
+      # @param [Hash] args list params
+      # @option args [String] :title title of list
+      # @option args [Array<String>] :items items to
+      #   populate list with
+      def initialize(args={})
+        @title  = args[:title] || ""
+        @items  = args[:items] || []
+      end
+
+      private
+
+      def _component
+        CDK::SCROLL.new(window.cdk_scr,                          # cdkscreen,
+                        2, 1, CDK::RIGHT,                       # xplace, yplace, scroll pos
+                        window.rows - 2,                        # widget height
+                        window.cols  - 2,                       # widget width
+                        @title, @items, @items.size,            # title and items
+                        false,                                  # prefix numbers
+                        Ncurses::A_REVERSE,                     # highlight
+                        true, false)                            # box, shadow
+      end
+    end # SList
+  end # module Components
+end # module RETerm

data/lib/reterm/components/template.rb

@@ -0,0 +1,23 @@
+module RETerm
+  module Components
+    # Template which may be used as the basis for other components
+    class Template < Component
+      # All components must accept args hash (specified via loader)
+      def initialize(args={})
+      end
+
+      # Override this method to draw component on screen
+      def draw!
+      end
+
+      # Return true if the user should be able to focus and
+      # interact with this component, default to false
+      def activatable?
+      end
+
+      # Method call when this component is activated
+      def activate!
+      end
+    end # class Template
+  end # module Components
+end # module RETerm

data/lib/reterm/components/vslider.rb

@@ -0,0 +1,61 @@
+module RETerm
+  module Components
+    # Vertical Slider Component
+    class VSlider < Component
+      include ComponentInput
+
+      attr_accessor :initial_value, :increment, :range, :labels
+
+      # Initialize the slider component
+      #
+      # @param [Hash] args slider params
+      def initialize(args={})
+        @initial_value = 0
+        @increment     = 0.01
+        @range         = [0, 1]
+        @labels        = true
+        @value = initial_value
+      end
+
+      def draw!
+        refresh_win
+      end
+
+      def activatable?
+        true
+      end
+
+      def activate!
+        refresh_win
+        handle_input
+        (range[1] - range[0]) * @value
+      end
+
+      private
+
+      def on_inc
+        @value += increment
+        @value  = 1 if @value > 1
+        refresh_win
+      end
+
+      def on_dec
+        @value -= increment
+        @value  = 0 if @value < 0
+        refresh_win
+      end
+
+      def refresh_win
+        0.upto(window.rows) do |l|
+          pre  = " "
+          pre  = "+" if @labels && l == 0
+          pre  = "-" if @labels && l == (window.rows-1)
+          fill = (l.to_f / window.rows) >= (1-@value)
+          window.mvaddstr(l, 0, pre + (fill ? "#" : " ") + "\n")
+        end
+
+        window.refresh
+      end
+    end # VSlider
+  end # module Components
+end # module RETerm

data/lib/reterm/init.rb

@@ -0,0 +1,95 @@
+require 'ncursesw'
+require_relative './resize'
+
+module RETerm
+  # Initializes the RETerm subsystem before invoking block.
+  # After block is finished regardless of execution state
+  # (return, exception, etc) this will cleanup the terminal
+  # environment before returning control to the TTY.
+  #
+  # This method is the first method the user should invoke
+  # after requiring the reterm library.
+  #
+  # @example
+  #   init_reterm {
+  #     win = Window.new :rows => 20, :cols => 40
+  #     # ... more UI logic
+  #   }
+  #
+  def init_reterm(opts={}, &bl)
+    begin
+      Terminal.load # XXX: not sure why but loading terminal
+                    #      info after changing terminal settings via
+                    #      ncurses seems to corrupt the terminal
+                    #      state to the point it cannot be restored
+                    #      without a 'reset' (see below).
+                    #      So just preload terminal info here.
+
+      stdscr = Ncurses::initscr
+      Ncurses::start_color
+      Ncurses::noecho
+      Ncurses::cbreak
+      Ncurses::curs_set(0)
+      Ncurses::keypad(stdscr, true)
+
+      track_resize if opts[:resize]
+
+      bl.call
+
+    #ensure
+      stop_track_resize
+      Ncurses.curs_set(1)
+      Window.all.each { |w| w.finalize! }
+      CDK::SCREEN.endCDK if cdk_enabled?
+      Ncurses.endwin()
+      #`reset -Q` # XXX only way to guarantee a full reset (see above)
+    end
+  end
+
+  # This method resyncs the visible terminal with the internal
+  # RETerm environment. It should be called any time the user
+  # needs to update the UI after making changes.
+  #
+  # @example
+  #   init_reterm {
+  #     win = Window.new
+  #     win.border! # draw window border
+  #     update_rti  # resync terminal ouput
+  #     win.getch   # wait for input
+  #   }
+  #
+  def update_reterm
+    Window.top.each { |w| w.refresh }
+    Ncurses::Panel.update_panels
+    Ncurses.doupdate
+  end
+
+  # XXX Ncurses is exposed so that users
+  # may employ any constants if desired.
+  # This should not be needed though and
+  # is discouraged to maintain portability
+  NC = Ncurses
+
+  # Enable the CDK subsystem. Used by CDKbased components
+  #
+  # @see #cdk_enabled?
+  def enable_cdk!
+    return if @cdk_enabled
+
+    @cdk_enabled = true
+    require 'cdk'
+
+    # XXX defines standard color pairs, but we use our own
+    # for standarization across components, but we need
+    # to set cdk components to the correct color scheme
+    # manually
+    # CDK::Draw.initCDKColor
+  end
+
+  # Return boolean indicating if the CDK subsystem is enabled.
+  # CDK is a library used by various components providing
+  # many various ready to use ncurses widgets.
+  def cdk_enabled?
+    !!@cdk_enabled
+  end
+end # module RETerm