rndk 0.0.1

data/lib/rndk/scroller.rb

@@ -0,0 +1,183 @@
+require 'rndk'
+module RNDK
+  class SCROLLER < RNDK::Widget
+    def initialize
+      super()
+    end
+
+    def KEY_UP
+      if @list_size > 0
+        if @current_item > 0
+          if @current_high == 0
+            if @current_top != 0
+              @current_top -= 1
+              @current_item -= 1
+            else
+              RNDK.beep
+            end
+          else
+            @current_item -= 1
+            @current_high -= 1
+          end
+        else
+          RNDK.beep
+        end
+      else
+        RNDK.beep
+      end
+    end
+
+    def KEY_DOWN
+      if @list_size > 0
+        if @current_item < @list_size - 1
+          if @current_high == @view_size - 1
+            if @current_top < @max_top_item
+              @current_top += 1
+              @current_item += 1
+            else
+              RNDK.beep
+            end
+          else
+            @current_item += 1
+            @current_high += 1
+          end
+        else
+          RNDK.beep
+        end
+      else
+        RNDK.beep
+      end
+    end
+
+    def KEY_LEFT
+      if @list_size > 0
+        if @left_char == 0
+          RNDK.beep
+        else
+          @left_char -= 1
+        end
+      else
+        RNDK.beep
+      end
+    end
+
+    def KEY_RIGHT
+      if @list_size > 0
+        if @left_char >= @max_left_char
+          RNDK.beep
+        else
+          @left_char += 1
+        end
+      else
+        RNDK.beep
+      end
+    end
+
+    def KEY_PPAGE
+      if @list_size > 0
+        if @current_top > 0
+          if @current_top >= @view_size - 1
+            @current_top -= @view_size - 1
+            @current_item -= @view_size - 1
+          else
+            self.KEY_HOME
+          end
+        else
+          RNDK.beep
+        end
+      else
+        RNDK.beep
+      end
+    end
+
+    def KEY_NPAGE
+      if @list_size > 0
+        if @current_top < @max_top_item
+          if @current_top + @view_size - 1 <= @max_top_item
+            @current_top += @view_size - 1
+            @current_item += @view_size - 1
+          else
+            @current_top = @max_top_item
+            @current_item = @last_item
+            @current_high = @view_size - 1
+          end
+        else
+          RNDK.beep
+        end
+      else
+        RNDK.beep
+      end
+    end
+
+    def KEY_HOME
+      @current_top = 0
+      @current_item = 0
+      @current_high = 0
+    end
+
+    def KEY_END
+      if @max_top_item == -1
+        @current_top = 0
+        @current_item = @last_item - 1
+      else
+        @current_top = @max_top_item
+        @current_item = @last_item
+      end
+      @current_high = @view_size - 1
+    end
+
+    def maxViewSize
+      return @box_height - (2 * @border_size + @title_lines)
+    end
+
+    # Set variables that depend upon the list_size
+    def setViewSize(list_size)
+      @view_size = self.maxViewSize
+      @list_size = list_size
+      @last_item = list_size - 1
+      @max_top_item = list_size - @view_size
+
+      if list_size < @view_size
+        @view_size = list_size
+        @max_top_item = 0
+      end
+
+      if @list_size > 0 && self.maxViewSize > 0
+        @step = 1.0 * self.maxViewSize / @list_size
+        @toggle_size = if @list_size > self.maxViewSize
+                       then 1
+                       else @step.ceil
+                       end
+      else
+        @step = 1
+        @toggle_size = 1
+      end
+    end
+
+    def setPosition(item)
+      if item <= 0
+        self.KEY_HOME
+      elsif item > @list_size - 1
+        @current_top = @max_top_item
+        @current_item = @list_size - 1
+        @current_high = @view_size - 1
+      elsif item >= @current_top && item < @current_top + @view_size
+        @current_item = item
+        @current_high = item - @current_top
+      else
+        @current_top = item - (@view_size - 1)
+        @current_item = item
+        @current_high = @view_size - 1
+      end
+    end
+
+    # Get/Set the current item number of the scroller.
+    def getCurrentItem
+      @current_item
+    end
+
+    def setCurrentItem(item)
+      self.setPosition(item);
+    end
+  end
+end

data/lib/rndk/selection.rb

@@ -0,0 +1,630 @@
+require 'rndk/scroller'
+
+module RNDK
+  # TODO This Widget's very buggy! Somehow improve it later!
+  class SELECTION < RNDK::SCROLLER
+    attr_reader :selections
+
+    def initialize(rndkscreen, xplace, yplace, splace, height, width, title,
+        list, list_size, choices, choice_count, highlight, box, shadow)
+      super()
+      widest_item = -1
+      parent_width = Ncurses.getmaxx(rndkscreen.window)
+      parent_height = Ncurses.getmaxy(rndkscreen.window)
+      box_width = width
+      bindings = {
+        RNDK::BACKCHAR => Ncurses::KEY_PPAGE,
+        RNDK::FORCHAR  => Ncurses::KEY_NPAGE,
+        'g'           => Ncurses::KEY_HOME,
+        '1'           => Ncurses::KEY_HOME,
+        'G'           => Ncurses::KEY_END,
+        '<'           => Ncurses::KEY_HOME,
+        '>'           => Ncurses::KEY_END,
+      }
+
+      if choice_count <= 0
+        self.destroy
+        return nil
+      end
+
+      @choice = []
+      @choicelen = []
+
+      self.setBox(box)
+
+      # If the height is a negative value, the height will be ROWS-height,
+      # otherwise the height will be the given height.
+      box_height = RNDK.setWidgetDimension(parent_height, height, 0)
+
+      # If the width is a negative value, the width will be COLS-width,
+      # otherwise the width will be the given width
+      box_width = RNDK.setWidgetDimension(parent_width, width, 0)
+      box_width = self.setTitle(title, box_width)
+
+      # Set the box height.
+      if @title_lines > box_height
+        box_height = @title_lines = [list_size, 8].min, + 2 * border_size
+      end
+
+      @maxchoicelen = 0
+
+      # Adjust the box width if there is a scroll bar.
+      if splace == RNDK::LEFT || splace == RNDK::RIGHT
+        box_width += 1
+        @scrollbar = true
+      else
+        @scrollbar = false
+      end
+
+      # Make sure we didn't extend beyond the dimensions of the window.
+      @box_width = [box_width, parent_width].min
+      @box_height = [box_height, parent_height].min
+
+      self.setViewSize(list_size)
+
+      # Rejustify the x and y positions if we need to.
+      xtmp = [xplace]
+      ytmp = [yplace]
+      RNDK.alignxy(rndkscreen.window, xtmp, ytmp, @box_width, @box_height)
+      xpos = xtmp[0]
+      ypos = ytmp[0]
+
+      # Make the selection window.
+      @win = Ncurses.newwin(@box_height, @box_width, ypos, xpos)
+
+      # Is the window nil?
+      if @win.nil?
+        self.destroy
+        return nil
+      end
+
+      # Turn the keypad on for this window.
+      Ncurses.keypad(@win, true)
+
+      # Create the scrollbar window.
+      if splace == RNDK::RIGHT
+        @scrollbar_win = Ncurses.subwin(@win, self.maxViewSize, 1,
+            self.Screen_YPOS(ypos), xpos + @box_width - @border_size - 1)
+      elsif splace == RNDK::LEFT
+        @scrollbar_win = Ncurses.subwin(@win, self.maxViewSize, 1,
+            self.Screen_YPOS(ypos), self.Screen_XPOS(ypos))
+      else
+        @scrollbar_win = nil
+      end
+
+      # Set the rest of the variables
+      @screen = rndkscreen
+      @parent = rndkscreen.window
+      @scrollbar_placement = splace
+      @max_left_char = 0
+      @left_char = 0
+      @highlight = highlight
+      @choice_count = choice_count
+      @accepts_focus = true
+      @input_window = @win
+      @shadow = shadow
+
+      self.setCurrentItem(0)
+
+      # Each choice has to be converted from string to chtype array
+      (0...choice_count).each do |j|
+        choicelen = []
+        @choice << RNDK.char2Chtype(choices[j], choicelen, [])
+        @choicelen << choicelen[0]
+        @maxchoicelen = [@maxchoicelen, choicelen[0]].max
+      end
+
+      # Each item in the needs to be converted to chtype array
+      widest_item = self.createList(list, list_size)
+      if widest_item > 0
+        self.updateViewWidth(widest_item)
+      elsif list_size > 0
+        self.destroy
+        return nil
+      end
+
+      # Do we need to create a shadow.
+      if shadow
+        @shadow_win = Ncurses.newwin(box_height, box_width,
+            ypos + 1, xpos + 1)
+      end
+
+      # Setup the key bindings
+      bindings.each do |from, to|
+        self.bind(:SELECTION, from, :getc, to)
+      end
+
+      # Register this baby.
+      rndkscreen.register(:SELECTION, self)
+    end
+
+    # Put the cursor on the currently-selected item.
+    def fixCursorPosition
+      scrollbar_adj = if @scrollbar_placement == RNDK::LEFT
+                      then 1
+                      else 0
+                      end
+      ypos = self.Screen_YPOS(@current_item - @current_top)
+      xpos = self.Screen_XPOS(0) + scrollbar_adj
+
+      Ncurses.wmove(@input_window, ypos, xpos)
+      Ncurses.wrefresh @input_window
+    end
+
+    # This actually manages the selection widget
+    def activate(actions)
+      # Draw the selection list
+      self.draw(@box)
+
+      if actions.nil? || actions.size == 0
+        while true
+          self.fixCursorPosition
+          input = self.getch([])
+
+          # Inject the character into the widget.
+          ret = self.inject(input)
+          if @exit_type != :EARLY_EXIT
+            return ret
+          end
+        end
+      else
+        # Inject each character one at a time.
+        actions.each do |action|
+          ret = self.inject(action)
+          if @exit_type != :EARLY_EXIT
+            return ret
+          end
+        end
+      end
+
+      # Set the exit type and return.
+      self.setExitType(0)
+      return 0
+    end
+
+    # This injects a single characer into the widget.
+    def inject(input)
+      pp_return = 1
+      ret = -1
+      complete = false
+
+      # Set the exit type
+      self.setExitType(0)
+
+      # Draw the widget list.
+      self.drawList(@box)
+
+      # Check if there is a pre-process function to be called.
+      unless @pre_process_func.nil?
+        pp_return = @pre_process_func.call(:SELECTION, self,
+            @pre_process_data, input)
+      end
+
+      # Should we continue?
+      if pp_return != 0
+        # Check for a predefined binding.
+        if self.checkBind(:SELECTION, input)
+          complete = true
+        else
+          case input
+          when Ncurses::KEY_UP
+            self.KEY_UP
+          when Ncurses::KEY_DOWN
+            self.KEY_DOWN
+          when Ncurses::KEY_RIGHT
+            self.KEY_RIGHT
+          when Ncurses::KEY_LEFT
+            self.KEY_LEFT
+          when Ncurses::KEY_PPAGE
+            self.KEY_PPAGE
+          when Ncurses::KEY_NPAGE
+            self.KEY_NPAGE
+          when Ncurses::KEY_HOME
+            self.KEY_HOME
+          when Ncurses::KEY_END
+            self.KEY_END
+          when '$'.ord
+            @left_char = @max_left_char
+          when '|'
+            @left_char = 0
+          when ' '.ord
+            if @mode[@current_item] == 0
+              if @selections[@current_item] == @choice_count - 1
+                @selections[@current_item] = 0
+              else
+                @selections[@current_item] += 1
+              end
+            else
+              RNDK.beep
+            end
+          when RNDK::KEY_ESC
+            self.setExitType(input)
+            complete = true
+          when Ncurses::ERR
+            self.setExitType(input)
+            complete = true
+          when Ncurses::KEY_ENTER, RNDK::KEY_TAB, RNDK::KEY_RETURN
+            self.setExitType(input)
+            ret = 1
+            complete = true
+          when RNDK::REFRESH
+            @screen.erase
+            @screen.refresh
+          end
+        end
+
+        # Should we call a post-process?
+        if !complete && !(@post_process_func.nil?)
+          @post_process_func.call(:SELECTION, self, @post_process_data, input)
+        end
+      end
+
+      unless complete
+        self.drawList(@box)
+        self.setExitType(0)
+      end
+
+      @result_data = ret
+      self.fixCursorPosition
+      return ret
+    end
+
+    # This moves the selection field to the given location.
+    def move(xplace, yplace, relative, refresh_flag)
+      windows = [@win, @scrollbar_win, @shadow_win]
+      self.move_specific(xplace, yplace, relative, refresh_flag,
+          windows, [])
+    end
+
+    # This function draws the selection list.
+    def draw(box)
+      # Draw in the shadow if we need to.
+      unless @shadow_win.nil?
+        Draw.drawShadow(@shadow_win)
+      end
+
+      self.drawTitle(@win)
+
+      # Redraw the list
+      self.drawList(box)
+    end
+
+    # This function draws the selection list window.
+    def drawList(box)
+      scrollbar_adj = if @scrollbar_placement == LEFT then 1 else 0 end
+      screen_pos = 0
+      sel_item = -1
+
+      # If there is to be a highlight, assign it now
+      if @has_focus
+        sel_item = @current_item
+      end
+
+      # draw the list...
+      j = 0
+      while j < @view_size && (j + @current_top) < @list_size
+        k = j + @current_top
+        if k < @list_size
+          screen_pos = self.ScreenPOS(k, scrollbar_adj)
+          ypos = self.Screen_YPOS(j)
+          xpos = self.Screen_XPOS(0)
+
+          # Draw the empty line.
+          Draw.writeBlanks(@win, xpos, ypos, RNDK::HORIZONTAL, 0, Ncurses.getmaxx(@win))
+
+          # Draw the selection item.
+          Draw.writeChtypeAttrib(@win,
+              if screen_pos >= 0 then screen_pos else 1 end,
+              ypos, @item[k],
+              if k == sel_item then @highlight else Ncurses::A_NORMAL end,
+              RNDK::HORIZONTAL,
+              if screen_pos >= 0 then 0 else 1 - screen_pos end,
+              @item_len[k])
+
+          # Draw the choice value
+          Draw.writeChtype(@win, xpos + scrollbar_adj, ypos,
+            @choice[@selections[k]], RNDK::HORIZONTAL, 0,
+            @choicelen[@selections[k]])
+        end
+        j += 1
+      end
+
+      # Determine where the toggle is supposed to be.
+      if @scrollbar
+        @toggle_pos = (@current_item * @step).floor
+        @toggle_pos = [@toggle_pos, Ncurses.getmaxy(@scrollbar_win) - 1].min
+
+        Ncurses.mvwvline(@scrollbar_win,
+                         0,
+                         0,
+                         Ncurses::ACS_CKBOARD,
+                         Ncurses.getmaxy(@scrollbar_win))
+
+        Ncurses.mvwvline(@scrollbar_win,
+                         @toggle_pos,
+                         0,
+                         ' '.ord | Ncurses::A_REVERSE, @toggle_size)
+      end
+
+      # Box it if needed
+      if @box
+        Draw.drawObjBox(@win, self)
+      end
+
+      self.fixCursorPosition
+    end
+
+    # This sets the background attribute of the widget.
+    def setBKattr(attrib)
+      Ncurses.wbkgd(@win, attrib)
+      unless @scrollbar_win.nil?
+        Ncurses.wbkgd(@scrollbar_win, attrib)
+      end
+    end
+
+    def destroyInfo
+      @item = []
+    end
+
+    # This function destroys the selection list.
+    def destroy
+      self.cleanTitle
+      self.destroyInfo
+
+      # Clean up the windows.
+      RNDK.deleteCursesWindow(@scrollbar_win)
+      RNDK.deleteCursesWindow(@shadow_win)
+      RNDK.deleteCursesWindow(@win)
+
+      # Clean up the key bindings
+      self.cleanBindings(:SELECTION)
+
+      # Unregister this object.
+      RNDK::Screen.unregister(:SELECTION, self)
+    end
+
+    # This function erases the selection list from the screen.
+    def erase
+      if self.validRNDKObject
+        RNDK.eraseCursesWindow(@win)
+        RNDK.eraseCursesWindow(@shadow_win)
+      end
+    end
+
+    # This function sets a couple of the selection list attributes
+    def set(highlight, choices, box)
+      self.setChoices(choices)
+      self.setHighlight(highlight)
+      self.setBox(box)
+    end
+
+    # This sets the selection list items.
+    def setItems(list, list_size)
+      widest_item = self.createList(list, list_size)
+      if widest_item <= 0
+        return
+      end
+
+      # Clean up the display
+      (0...@view_size).each do |j|
+        Draw.writeBlanks(@win,
+                         self.Screen_XPOS(0),
+                         self.Screen_YPOS(j),
+                         RNDK::HORIZONTAL,
+                         0,
+                         Ncurses.getmaxx(@win))
+      end
+
+      self.setViewSize(list_size)
+      self.setCurrentItem(0)
+
+      self.updateViewWidth(widest_item)
+    end
+
+    def getItems(list)
+      @item.each do |item|
+        list << RNDK.chtype2Char(item)
+      end
+      return @list_size
+    end
+
+    def setSelectionTitle(title)
+      # Make sure the title isn't nil
+      if title.nil?
+        return
+      end
+
+      self.setTitle(title, -(@box_width + 1))
+
+      self.setViewSize(@list_size)
+    end
+
+    def getTitle
+      return RNDK.chtype2Char(@title)
+    end
+
+    # This sets the highlight bar.
+    def setHighlight(highlight)
+      @highlight = highlight
+    end
+
+    def getHighlight
+      @highlight
+    end
+
+    # This sets the default choices for the selection list.
+    def setChoices(choices)
+      # Set the choice values in the selection list.
+      (0...@list_size).each do |j|
+        if choices[j] < 0
+          @selections[j] = 0
+        elsif choices[j] > @choice_count
+          @selections[j] = @choice_count - 1
+        else
+          @selections[j] = choices[j]
+        end
+      end
+    end
+
+    def getChoices
+      @selections
+    end
+
+    # This sets a single item's choice value.
+    def setChoice(index, choice)
+      correct_choice = choice
+      correct_index = index
+
+      # Verify that the choice value is in range.
+      if choice < 0
+        correct_choice = 0
+      elsif choice > @choice_count
+        correct_choice = @choice_count - 1
+      end
+
+      # make sure the index isn't out of range.
+      if index < 0
+        correct_index = 0
+      elsif index > @list_size
+        correct_index = @list_size - 1
+      end
+
+      # Set the choice value.
+      @selections[correct_index] = correct_choice
+    end
+
+    def getChoice(index)
+      # Make sure the index isn't out of range.
+      if index < 0
+        return @selections[0]
+      elsif index > list_size
+        return @selections[@list_size - 1]
+      else
+        return @selections[index]
+      end
+    end
+
+    # This sets the modes of the items in the selection list. Currently
+    # there are only two: editable=0 and read-only=1
+    def setModes(modes)
+      # set the modes
+      (0...@list_size).each do |j|
+        @mode[j] = modes[j]
+      end
+    end
+
+    def getModes
+      return @mode
+    end
+
+    # This sets a single mode of an item in the selection list.
+    def setMode(index, mode)
+      # Make sure the index isn't out of range.
+      if index < 0
+        @mode[0] = mode
+      elsif index > @list_size
+        @mode[@list_size - 1] = mode
+      else
+        @mode[index] = mode
+      end
+    end
+
+    def getMode(index)
+      # Make sure the index isn't out of range
+      if index < 0
+        return @mode[0]
+      elsif index > list_size
+        return @mode[@list_size - 1]
+      else
+        return @mode[index]
+      end
+    end
+
+    def getCurrent
+      return @current_item
+    end
+
+    # methods for generic type methods
+    def focus
+      self.drawList(@box)
+    end
+
+    def unfocus
+      self.drawList(@box)
+    end
+
+    def createList(list, list_size)
+      status = 0
+      widest_item = 0
+
+      if list_size >= 0
+        new_list = []
+        new_len = []
+        new_pos = []
+
+        box_width = self.AvailableWidth
+        adjust = @maxchoicelen + @border_size
+
+        status = 1
+        (0...list_size).each do |j|
+          lentmp = []
+          postmp = []
+          new_list << RNDK.char2Chtype(list[j], lentmp, postmp)
+          new_len << lentmp[0]
+          new_pos << postmp[0]
+          #if new_list[j].size == 0
+          if new_list[j].nil?
+            status = 0
+            break
+          end
+          new_pos[j] =
+              RNDK.justifyString(box_width, new_len[j], new_pos[j]) + adjust
+          widest_item = [widest_item, new_len[j]].max
+        end
+
+        if status
+          self.destroyInfo
+
+          @item = new_list
+          @item_pos = new_pos
+          @item_len = new_len
+          @selections = [0] * list_size
+          @mode = [0] * list_size
+        end
+      else
+        self.destroyInfo
+      end
+
+      return (if status then widest_item else 0 end)
+    end
+
+    # Determine how many characters we can shift to the right
+    # before all the items have been scrolled off the screen.
+    def AvailableWidth
+      @box_width - 2 * @border_size - @maxchoicelen
+    end
+
+    def updateViewWidth(widest)
+      @max_left_char = if @box_width > widest
+                       then 0
+                       else widest - self.AvailableWidth
+                       end
+    end
+
+    def WidestItem
+      @max_left_char + self.AvailableWidth
+    end
+
+    def ScreenPOS(n, scrollbar_adj)
+      @item_pos[n] - @left_char + scrollbar_adj
+    end
+
+    def position
+      super(@win)
+    end
+
+    def object_type
+      :SELECTION
+    end
+  end
+end