reterm 0.4.2 → 0.5.0

data/lib/reterm/components/rocker.rb

@@ -1,10 +1,11 @@
 module RETerm
   module Components
-    # Rocker component, allowing use to select one of several values
+    # Rocker component, allowing use to select one of several items
     class Rocker < Component
       include ComponentInput
+      include ItemHelpers
 
-      attr_accessor :values, :index, :labels
+      attr_accessor :items, :index, :labels
 
       # Initialize the Rocker component
       #
@@ -14,16 +15,25 @@ module RETerm
       #   win    = Window.new
       #   rocker = Rocker.new
       #   win.component = rocker
-      #   rocker.values = ['Foo', 'Bar', 'Baz']
+      #   rocker.items = ['Foo', 'Bar', 'Baz']
       #   val = rocker.activate!
       #
       def initialize(args={})
-        @values = []
+        super
+        @items = []
         @index  = nil
         @labels = true
         @index  = 0
       end
 
+      def requested_rows
+        @items.size + 3
+      end
+
+      def requested_cols
+        max_item_size + 3
+      end
+
       def draw!
         refresh_win
       end
@@ -32,17 +42,17 @@ module RETerm
         true
       end
 
-      def activate!
+      def activate!(*input)
         refresh_win
-        handle_input
-        @values[@index]
+        handle_input(*input)
+        @items[@index]
       end
 
       private
 
       def on_inc
         @index += 1
-        @index  = @values.size - 1 if @index == @values.size
+        @index  = @items.size - 1 if @index == @items.size
         refresh_win
       end
 
@@ -58,11 +68,11 @@ module RETerm
         post = '+' if @labels
 
         window.mvaddstr(1, 1, " |#{pre}|")
-        @values.each_with_index { |v, i|
+        @items.each_with_index { |v, i|
           sel = @index == i ? "#" : " "
-          window.mvaddstr(i+2, 1, " |" + sel + "|" + @values[i])
+          window.mvaddstr(i+2, 1, " |" + sel + "|" + @items[i])
         }
-        window.mvaddstr(@values.size+2, 1, " |#{post}|")
+        window.mvaddstr(@items.size+2, 1, " |#{post}|")
         window.refresh
         update_reterm
       end

data/lib/reterm/components/scroll_list.rb

@@ -0,0 +1,96 @@
+module RETerm
+  module Components
+    # Scrolling List CDK Component
+    class ScrollList < Component
+      include CDKComponent
+      include ItemHelpers
+
+      attr_reader :items
+
+      # Initialize the ScrollList 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={})
+        super
+        @title  = args[:title] || ""
+        @items  = args[:items] || []
+      end
+
+      def quit_on_enter=(v)
+        component.quit_on_enter = v
+      end
+
+      def requested_rows
+        2 + @items.size
+      end
+
+      def requested_cols
+        [@title.size, max_item_size].max + 2
+      end
+
+      def <<(item)
+        @items << item
+
+        if window.expand? &&
+           (window.rows < (requested_rows + extra_padding) ||
+            window.cols < (requested_cols + extra_padding))
+          window.request_expansion requested_rows + extra_padding,
+                                   requested_cols + extra_padding
+        end
+      end
+
+      def reset!
+        component.setCurrentItem(0)
+      end
+
+      def empty!
+        @items.clear
+      end
+
+      def selected
+        @items[component.getCurrentItem]
+      end
+
+      def current
+        selected
+      end
+
+      def current_index
+        component.getCurrentItem
+      end
+
+      def activate!(*input)
+        i = super
+        return nil unless normal_exit?
+        dispatch(:selected)
+        @items[i]
+      end
+
+      private
+
+      def _component
+        c = CDK::SCROLL.new(window.cdk_scr,          # cdkscreen,
+                        CDK::CENTER, CDK::CENTER,    # xplace, yplace,
+                        CDK::RIGHT,                  # scroll pos
+                        window.rows-2,               # widget height
+                        window.cols-3,               # widget width
+                        @title, @items, @items.size, # title and items
+                        false,                       # prefix numbers
+                        Ncurses::A_REVERSE,          # highlight
+                        true, false)                 # box, shadow
+
+        pp = lambda do |cdktype, list, scroll_list, key|
+          scroll_list.dispatch(:entry, key)
+          scroll_list.dispatch(:changed)
+        end
+
+        c.setPostProcess(pp, self)
+
+        c
+      end
+    end # ScrollList
+  end # module Components
+end # module RETerm

data/lib/reterm/components/scrolling_area.rb

@@ -0,0 +1,50 @@
+module RETerm
+  module Components
+    # Scrolling Area CDK Component
+    class ScrollingArea < Component
+      include CDKComponent
+
+      attr_accessor :title, :lines
+
+      # Initialize the ScrollingArea component
+      #
+      # @param [Hash] args scrolling area params
+      # @option args [String] :title title of area
+      # @option args [Integer] :lines number of lines
+      #   in the area
+      def initialize(args={})
+        super
+        @title  = args[:title] || ""
+        @lines  = args[:lines] || 10
+      end
+
+      # XXX swindow results in weird keyboard interactions, disable for now
+      def activatable?
+        false
+      end
+
+      def requested_rows
+        10
+      end
+
+      def requested_cols
+        [@title.size, 10].min
+      end
+
+      def <<(item)
+        component.add item, CDK::BOTTOM
+      end
+
+      private
+
+      def _component
+        CDK::SWINDOW.new(window.cdk_scr, # cdkscreen,
+                         0, 1,           # xplace, yplace, scroll pos
+                         window.rows,    # widget height
+                         window.cols,    # widget width
+                         @title, @lines, # title, lines
+                         true, false)    # box, shadow
+      end
+    end # ScrollList
+  end # module Components
+end # module RETerm

data/lib/reterm/components/select_list.rb

@@ -0,0 +1,67 @@
+module RETerm
+  module Components
+    # Select List CDK Component
+    class SelectList < Component
+      include CDKComponent
+      include ItemHelpers
+
+      # Initialize the SelectList 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={})
+        super
+        @title  = args[:title] || ""
+        @items  = args[:items] || []
+      end
+
+      def requested_rows
+        5 + @items.size
+      end
+
+      def requested_cols
+        [@title.size, max_item_size].max + 2
+      end
+
+      def reset!
+        component.setCurrentItem(0)
+      end
+
+      def current
+        @items[component.getCurrentItem]
+      end
+
+      def selected
+        (0...@items.size).collect { |i|
+          component.selections[i] == 1 ? @items[i] : nil
+        }.compact
+      end
+
+      def activate!(*input)
+        super
+        selected
+      end
+
+      private
+
+      def _component
+        choices = [
+            "   ",
+            "-->"
+        ]
+
+        CDK::SELECTION.new(window.cdk_scr,                          # cdkscreen,
+                           2, 1, CDK::RIGHT,                       # xplace, yplace, select pos
+                           window.rows - 2,                        # widget height
+                           window.cols  - 2,                       # widget width
+                           @title,                                 # title
+                           @items, @items.size,                    # items
+                           choices, choices.size,                  # space bar choices
+                           Ncurses::A_REVERSE,                     # highlight
+                           true, false)                            # box, shadow
+      end
+    end # ScrollList
+  end # module Components
+end # module RETerm

data/lib/reterm/components/splash.rb

@@ -0,0 +1,85 @@
+module RETerm
+  module Components
+    # Splash Screen
+    class Splash < Component
+      attr_reader :widget, :callback
+
+      # Initialize the Splash component
+      #
+      # @param [Hash] args splash params
+      # @option args [Component] :widget component
+      #   to include in the slash window
+      def initialize(args={})
+        super
+        @widget    = args[:widget]
+        @callback  = args[:callback]
+        @terminate = false
+      end
+
+      # Client may invoke this to
+      #   - create dialog and window
+      #   - activate it
+      #   - periodically invoke callback,
+      #     check return value
+      #   - close / cleanup
+      def self.show(args={}, &bl)
+        splash = self.new args.merge(:callback => bl)
+        win    = Window.new args.merge(:component => splash,
+                                       :x         => :center,
+                                       :y         => :center)
+        #win.component = splash
+        splash.activate!
+        update_reterm(true)
+        splash.close!
+      end
+
+      def requested_rows
+        @widget.requested_rows + 3
+      end
+
+      def requested_cols
+        @widget.requested_cols + 3
+      end
+
+      def close!
+        widget.erase
+        widget.finalize!
+
+        window.erase
+        window.finalize!
+
+        # get rid of all outstanding input
+        flush_input
+      end
+
+      def sync!
+        widget.sync!
+      end
+
+      def draw!
+        window.border!
+        widget.draw!
+      end
+
+      def window=(win)
+        super(win)
+        cw = win.create_child :rows => widget.requested_rows,
+                              :cols => widget.requested_cols,
+                              :x    => 1,
+                              :y    => 1
+        raise ArgumentError, "could not create child" if cw.win.nil?
+        cw.component = widget
+      end
+
+      def activate!(*input)
+        until @terminate
+          window.draw!
+
+          sleep SYNC_TIMEOUT.to_f / 1000
+          run_sync!
+          @terminate = !!callback.call
+        end
+      end
+    end # class Splash
+  end # module Components
+end # module RETerm

data/lib/reterm/components/template.rb

@@ -4,6 +4,17 @@ module RETerm
     class Template < Component
       # All components must accept args hash (specified via loader)
       def initialize(args={})
+        super
+      end
+
+      # Override this to request minimum rows
+      # for window allocation
+      def requested_rows
+      end
+
+      # Override this to request minimum cols
+      # for window allocation
+      def requested_cols
       end
 
       # Override this method to draw component on screen
@@ -16,7 +27,7 @@ module RETerm
       end
 
       # Method call when this component is activated
-      def activate!
+      def activate!(*input)
       end
     end # class Template
   end # module Components

data/lib/reterm/components/treeview.rb

@@ -0,0 +1 @@
+# TODO treeview component

data/lib/reterm/components/vslider.rb

@@ -10,6 +10,7 @@ module RETerm
       #
       # @param [Hash] args slider params
       def initialize(args={})
+        super
         @initial_value = 0
         @increment     = 0.01
         @range         = [0, 1]
@@ -17,6 +18,14 @@ module RETerm
         @value = initial_value
       end
 
+      def requested_rows
+        10
+      end
+
+      def requested_cols
+        3
+      end
+
       def draw!
         refresh_win
       end
@@ -25,9 +34,9 @@ module RETerm
         true
       end
 
-      def activate!
+      def activate!(*input)
         refresh_win
-        handle_input
+        handle_input(*input)
         (range[1] - range[0]) * @value
       end
 

data/lib/reterm/components/youtube.rb

@@ -0,0 +1,20 @@
+module RETerm
+  module Components
+    # YouTube viewer, use cmds to render youtube to ascii:
+    #   youtube-dl <url>
+    #   mplayer -vo aa <file>    -or-
+    #   CACA_DRIVER=ncurses mplayer -vo caca <file>
+    class YouTube < CmdOutput
+      # Initialize the YouTube component
+      #
+      # @param [Hash] args youtube params
+      # @option args [String] :url url of the video
+      #   to load
+      def initialize(args={})
+        @url = args[:url]
+        cmd = "..."
+        super(args.merge(:cmd => cmd))
+      end
+    end # YouTube
+  end # module Components
+end # module RETerm