reterm 0.4.2

data/lib/reterm.rb

@@ -0,0 +1,22 @@
+# The Ruby Enhanced Terminal interactive framework
+# facilitating dynmaic/feature rich terminal applications.
+module RETerm
+end # end module RETerm
+
+require 'reterm/init'
+require 'reterm/color_pair'
+
+require 'reterm/mixins/event_dispatcher'
+require 'reterm/mixins/component_input'
+require 'reterm/mixins/nav_input'
+require 'reterm/mixins/cdk_component'
+
+require 'reterm/terminal'
+require 'reterm/window'
+require 'reterm/panel'
+require 'reterm/menu'
+
+require 'reterm/components'
+require 'reterm/layouts'
+
+require 'reterm/loader'

data/lib/reterm/color_pair.rb

@@ -0,0 +1,66 @@
+require 'set'
+
+module RETerm
+  # Defines a pair of colors used for foreground / background
+  # rendering associated with id and tag list.
+  class ColorPair
+    attr_accessor :id
+    attr_accessor :tags
+
+    attr_accessor :fg
+    attr_accessor :bg
+
+    # Redefined system RGB color. Color name should be specified
+    # as well as new RGB components
+    #
+    # @param [String, Symbol] color name of color to change,
+    #   ex "red", "blue", etc
+    # @param [Integer] r value to assign to red component
+    # @param [Integer] g value to assign to green component
+    # @param [Integer] b value to assign to blue component
+    def self.change(color, r, g, b)
+      Ncurses::init_color Ncurses.const_get("COLOR_#{color.to_s.upcase}"), r, g, b
+    end
+
+    # Instantiate a new ColorPair, specifying foreground and background
+    # colors as well as any tags.
+    #
+    # A unique id for this color pair will be autogenerated
+    #
+    # @param [String, Symbol] fg forground color name
+    # @param [String, Symbol] bg background color name
+    # @param [Array<String, Symbol>] tags array of tags to assign
+    #   to color pair
+    def initialize(fg, bg, *tags)
+      @@id ||= 0
+      @@id  += 1
+      @id    = @@id
+
+      @tags = Set.new(tags)
+
+      # FIXME need to verify input is in valid domain
+      # before conveRETermng it to symbol w/ "intern"
+      fg = fg.to_s.downcase.intern
+      bg = bg.to_s.downcase.intern
+
+      Ncurses.init_pair(@id,
+        Ncurses.const_get("COLOR_#{fg.to_s.upcase}"),
+        Ncurses.const_get("COLOR_#{bg.to_s.upcase}"))
+    end
+
+    # Create and store a new Color Pair in a static
+    # registry
+    def self.register(fg, bg, *tags)
+      @@registry ||= []
+      @@registry  << new(fg, bg, *tags)
+      @@registry.last
+    end
+
+    # Return first Color Pair found with the given tag
+    # or nil for no matches
+    def self.for(tag)
+      @@registry ||= []
+      @@registry.find { |cp| cp.tags.include?(tag) }
+    end
+  end # class ColorPair
+end # module RETerm

data/lib/reterm/component.rb

@@ -0,0 +1,40 @@
+module RETerm
+  # A Component is a generic widget container associated with a window.
+  # Subclasses each implement a specific UI artifact.
+  class Component
+      attr_accessor :window
+
+      # This method is invoked to cleanup the component on shutdown.
+      # It should be be overriden by subclasses that needs to clean
+      # resources before being deallocated
+      def finalize!
+      end
+
+      # Return a boolean indicating if a {ColorPair} has been
+      # assign to component
+      def colored?
+        !!@colors
+      end
+
+      # Assign the specified {ColorPair} to the component
+      def colors=(c)
+        @colors = c
+      end
+
+      # Returns a boolean indicating if the user should be
+      # able to focus on and activate the component. By default
+      # this is false, but interactive components should override
+      # and return true.
+      def activatable?
+        false
+      end
+
+      # Actual activation mechanism, invoked by the navigation
+      # logic when the user has selected an activatable? component.
+      # Should be overriden by interactive subcomponents to
+      # process user inpute specific to that component
+      def activate!
+        raise RuntimeError, "should not be activated"
+      end
+  end # class Component
+end # module RETerm

data/lib/reterm/components.rb

@@ -0,0 +1,32 @@
+module RETerm
+  # Encapsulates all the Components which have been
+  # currently implemented
+  module Components
+    def self.all
+      @a ||= Components.constants
+    end
+
+    def self.names
+      @n ||= all.collect { |c| c.to_s }
+    end
+  end
+end
+
+require 'reterm/component'
+
+# custom
+require 'reterm/components/dial'
+require 'reterm/components/rocker'
+require 'reterm/components/vslider'
+require 'reterm/components/label'
+require 'reterm/components/ascii_text'
+require 'reterm/components/image'
+
+# cdk
+require 'reterm/components/hslider'
+require 'reterm/components/button'
+require 'reterm/components/dialog'
+require 'reterm/components/radio'
+require 'reterm/components/slist'
+require 'reterm/components/entry'
+require 'reterm/components/matrix'

data/lib/reterm/components/ascii_text.rb

@@ -0,0 +1,46 @@
+module RETerm
+  module Components
+    # Renders specified text via ascii graphics.
+    #
+    # This Component depends on the 'artii' gem.
+    class AsciiText < Component
+
+      # Initialize the AsciiText component
+      #
+      # @param [Hash] args ascii text params
+      # @option args [String] :text actual text to render,
+      #   default empty string
+      # @option args [String] :font font to use
+      def initialize(args={})
+        @text = args[:text] || ""
+        @font = args[:font]
+      end
+
+      def draw!
+        refresh_win
+      end
+
+      private
+
+      def atext
+        @atext ||= begin
+          require 'artii'
+          art = @font.nil? ? Artii::Base.new :
+                             Artii::Base.new(:font => @font)
+          art.asciify @text
+        end
+      end
+
+      def refresh_win
+        y = 1
+        atext.split("\n").each { |t|
+          window.mvaddstr(y, 1, t)
+          y += 1
+        }
+
+        window.refresh
+        update_reterm
+      end
+    end # class AsciiText
+  end # module Components
+end # module RETerm

data/lib/reterm/components/button.rb

@@ -0,0 +1,31 @@
+module RETerm
+  module Components
+    # CDK Button Component
+    class Button < Component
+      include CDKComponent
+
+      # Initialize the Button component
+      #
+      # @param [Hash] args button params
+      # @option args [String] :title title of button
+      def initialize(args={})
+        @title = args[:title] || ""
+      end
+
+      private
+
+      def callback
+        proc { |b|
+          puts "Clicked"
+        }
+      end
+
+      def _component
+        CDK::BUTTON.new(window.cdk_scr,  # cdk screen
+                        2, 1, @title,    # x, y, title
+                        callback,        # click callback
+                        false, false)    # box, shadow
+      end
+    end # Button
+  end # module Components
+end # module RETerm

data/lib/reterm/components/dial.rb

@@ -0,0 +1,95 @@
+module RETerm
+  module Components
+    class Dial < Component
+      include ComponentInput
+
+      attr_accessor :initial_value, :increment, :range, :labels
+
+      attr_accessor :value
+
+      # Enapsulating window should be at least 4x4 for decent effect,
+      # at least 7x7 provides best resolution
+      #
+      # @param [Hash] args dial params
+      #
+      # @example activating a dial
+      #   win  = Window.new
+      #   dial = Dial.new
+      #   win.component = dial
+      #
+      #   val = dial.activate!
+      #
+      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
+        @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
+        if @labels
+          window.mvaddstr(1,    1,   '-')
+          window.mvaddstr(1, window.cols-2, '+')
+        end
+
+        rad = Math.sqrt((window.rows/2)**2 + (window.cols/2)**2)
+        padding = rad/2 + 1
+
+        rows = window.rows - padding
+        cols  = window.cols  - padding
+        rad   = Math.sqrt((rows/2)**2 + (cols/2)**2)
+
+        a = 0
+        while a < @value
+          ar = a * (2 * Math::PI)
+          x = rad * Math.cos(3*Math::PI/2 - ar) + cols/2  + padding/2
+          y = rad * Math.sin(3*Math::PI/2 - ar) + rows/2 + padding/2
+          a += increment
+
+          window.mvaddstr(y, x, '*')
+        end
+
+        while a < 1
+          ar = a * (2 * Math::PI)
+          x = rad * Math.cos(3*Math::PI/2 - ar) + cols/2  + padding/2
+          y = rad * Math.sin(3*Math::PI/2 - ar) + rows/2 + padding/2
+          a += increment
+
+          window.mvaddstr(y, x, ' ')
+        end
+
+        window.refresh
+        update_reterm
+      end
+    end # class Dial
+  end # module Components
+end # module RETerm

data/lib/reterm/components/dialog.rb

@@ -0,0 +1,34 @@
+module RETerm
+  module Components
+    # CDK Dialog Component
+    class Dialog < Component
+      include CDKComponent
+
+      # Initialize the Dialog component
+      #
+      # @param [Hash] args dialog params
+      # @option args [String, Array<String>] :message string
+      #   message(s) to assign to dialog
+      # @option args [String, Array<String>] :buttons string
+      #   buttons to assign to dialog
+      #
+      def initialize(args={})
+        @message = [args[:message]].flatten.compact
+        @buttons = [args[:buttons]].flatten.compact
+
+        @buttons = ["</B/24>OK", "</B16>Cancel"] if @buttons.empty?
+      end
+
+      private
+
+      def _component
+        CDK::DIALOG.new(window.cdk_scr,
+                        CDK::CENTER, CDK::CENTER,
+                        @message, @message.size,
+                        @buttons, @buttons.size,
+                        Ncurses.COLOR_PAIR(2) | Ncurses::A_REVERSE, # highlight
+                        true, true, false)                          # seperate, box, shadow
+      end
+    end # Dialog
+  end # module Components
+end # module RETerm

data/lib/reterm/components/entry.rb

@@ -0,0 +1,38 @@
+module RETerm
+  module Components
+    # CDK Entry Component
+    class Entry < Component
+      include CDKComponent
+
+      # Initialize the Entry component
+      #
+      # @param [Hash] args entry params
+      # @option args [String] :title title to assign
+      #   to entry
+      # @option args [String] :label label to assign
+      #   to entry
+      # @option args [Integer] :min min entry length
+      # @option args [Integer] :max max entry length
+      def initialize(args={})
+        @title   = args[:title] || ""
+        @label   = args[:label] || ""
+        @min_len = args[:min]   || 0
+        @max_len = args[:max]   || 100
+      end
+
+      private
+
+      def _component
+        CDK::ENTRY.new(window.cdk_scr,            # cdkscreen,
+                       CDK::CENTER, CDK::CENTER,  # xpos, ypos
+                       @title, @label,            # title, label
+                       Ncurses::A_NORMAL,         # field attribute (eg typed chars)
+                       '.',                       # filler char
+                       :MIXED,                    # display type
+                       window.cols-@label.size-5, # field width
+                       0, 256,                    # min/max len
+                       false, false)              # box, shadow
+      end
+    end # Radio
+  end # module Components
+end # module RETerm