rndk 0.2.0 → 1.0.0

data/lib/rndk/core/utils.rb

@@ -21,7 +21,7 @@ module RNDK
   end
 
   # This looks for a subset of a word in the given list
-  def RNDK.searchList(list, list_size, pattern)
+  def RNDK.search_list(list, list_size, pattern)
     index = -1
 
     if pattern.size > 0
@@ -92,7 +92,7 @@ module RNDK
   # If the dimension is a negative value, the dimension will be the full
   # height/width of the parent window - the value of the dimension. Otherwise,
   # the dimension will be the given value.
-  def RNDK.setWidgetDimension (parent_dim, proposed_dim, adjustment)
+  def RNDK.set_widget_dimension (parent_dim, proposed_dim, adjustment)
     # If the user passed in FULL, return the parents size
     if proposed_dim == FULL or proposed_dim == 0
       parent_dim
@@ -119,7 +119,7 @@ module RNDK
   # Reads a file and concatenate it's lines into `array`.
   #
   # @note The lines don't end with '\n'.
-  def RNDK.read_file(filename, array)
+  def RNDK.read_file filename
     begin
       fd = File.new(filename, "r")
     rescue
@@ -133,10 +133,9 @@ module RNDK
         line
       end
     end
-
-    array.concat lines
     fd.close
-    array.size
+
+    lines
   end
 
 end

data/lib/rndk/core/widget.rb

@@ -1,21 +1,31 @@
 require 'rndk'
+require 'rndk/core/widget_bind'
 
 module RNDK
 
   # Wrapper on common functionality between all RNDK Widgets.
   #
   class Widget
+    # Which widget this is.
+    # It's the name of the widget lowercased.
+    # Example: `:label`, `:calendar`, `:alphalist`
+    attr_reader :widget_type
+
     attr_accessor :screen_index, :screen, :has_focus, :is_visible, :box
     attr_accessor :ULChar, :URChar, :LLChar, :LRChar, :HZChar, :VTChar, :BXAttr
     attr_reader :binding_list, :accepts_focus, :exit_type, :border_size
 
+    # All the signals the current widget supports.
+    # Use them on Widget#bind_signal
+    attr_reader :supported_signals
+
     @@g_paste_buffer = ''
 
     def initialize
       @has_focus  = true
       @is_visible = true
 
-      RNDK::ALL_OBJECTS << self
+      RNDK::ALL_WIDGETS << self
 
       # set default line-drawing characters
       @ULChar = Ncurses::ACS_ULCORNER
@@ -24,7 +34,7 @@ module RNDK
       @LRChar = Ncurses::ACS_LRCORNER
       @HZChar = Ncurses::ACS_HLINE
       @VTChar = Ncurses::ACS_VLINE
-      @BXAttr = Ncurses::A_NORMAL
+      @BXAttr = RNDK::Color[:normal]
 
       # set default exit-types
       @exit_type  = :NEVER_ACTIVATED
@@ -34,16 +44,49 @@ module RNDK
 
       # Bound functions
       @binding_list = {}
+
+      # Actions to be executed at certain signals
+      @actions = {}
+
+      @supported_signals = []
+      @supported_signals << :destroy
     end
 
-    def object_type
-      # no type by default
-      :NULL
+    # Makes `block` execute right before processing input
+    # on the Widget.
+    #
+    # `block` is called with the following arguments:
+    #
+    # * The Widget type (`:scroll`, `:calendar`, etc)
+    # * The Widget itself (`self`)
+    # * That `data` you send as an argument to `before_processing`.
+    # * The input character the Widget just received.
+    #
+    # Make good use of them when making your callback.
+    def before_processing(data=nil, &block)
+      @pre_process_data = data
+      @pre_process_func = block
     end
 
-    def validObjType(type)
-      # dummy version for now
-      true
+    # Makes `block` execute right after processing input
+    # on the Widget.
+    #
+    # `block` is called with the following arguments:
+    #
+    # * The Widget type (`:scroll`, `:calendar`, etc)
+    # * The Widget itself (`self`)
+    # * That `data` you send as an argument to `after_processing`.
+    # * The input character the Widget just received.
+    #
+    # Make good use of them when making your callback.
+    def after_processing(data=nil, &block)
+      @post_process_data = data
+      @post_process_func = block
+    end
+
+    def widget_type
+      # no type by default
+      :NULL
     end
 
     def Screen_XPOS(n)
@@ -64,19 +107,19 @@ module RNDK
 
     # Moves the Widget to the given position.
     #
-    # * `xplace` and `yplace` are the new position of the Widget.
+    # * `x` and `y` are the new position of the Widget.
     #
-    # * `xplace` may be an integer or one of the pre-defined
+    # * `x` may be an integer or one of the pre-defined
     #   values `RNDK::TOP`, `RNDK::BOTTOM`, and `RNDK::CENTER`.
     #
-    # * `yplace` may be an integer or one of the pre-defined
+    # * `y` may be an integer or one of the pre-defined
     #   values `RNDK::LEFT`, `RNDK::RIGHT`, and `RNDK::CENTER`.
     #
-    # * `relative` states whether the `xplace`/`yplace` pair is a
+    # * `relative` states whether the `x`/`y` pair is a
     #   relative move over it's current position or an absolute move
     #   over the Screen's top.
     #
-    # For example, if `xplace = 1` and `yplace = 2` and `relative = true`,
+    # For example, if `x = 1` and `y = 2` and `relative = true`,
     # the Widget would move one row down and two columns right.
     #
     # If the value of relative was `false` then the widget would move to
@@ -88,49 +131,51 @@ module RNDK
     # * `refresh_flag` is a boolean value which states whether the
     #   Widget will get refreshed after the move.
     #
-    def move(xplace, yplace, relative, refresh_flag)
-      self.move_specific(xplace, yplace, relative, refresh_flag, [@win, @shadow_win], [])
+    def move(x, y, relative, refresh_flag)
+      self.move_specific(x, y, relative, refresh_flag, [@win, @shadow_win], [])
     end
 
-    def move_specific(xplace, yplace, relative, refresh_flag, windows, subwidgets)
-      current_x = Ncurses.getbegx @win
-      current_y = Ncurses.getbegy @win
-      xpos = xplace
-      ypos = yplace
-
-      # If this is a relative move, then we will adjust where we want
-      # to move to.
-      if relative
-        xpos = Ncurses.getbegx(@win) + xplace
-        ypos = Ncurses.getbegy(@win) + yplace
-      end
-
-      # Adjust the window if we need to
-      xtmp = [xpos]
-      ytmp = [ypos]
-      RNDK.alignxy(@screen.window, xtmp, ytmp, @box_width, @box_height)
-      xpos = xtmp[0]
-      ypos = ytmp[0]
+    # Set the widget's title.
+    def set_title(title, box_width)
+      return if title.nil?
 
-      # Get the difference
-      xdiff = current_x - xpos
-      ydiff = current_y - ypos
+      temp = title.split "\n"
+      @title_lines = temp.size
 
-      # Move the window to the new location.
-      windows.each do |window|
-        RNDK.window_move(window, -xdiff, -ydiff)
+      if box_width >= 0
+        max_width = 0
+        temp.each do |line|
+          len = []
+          align = []
+          holder = RNDK.char2Chtype(line, len, align)
+          max_width = [len[0], max_width].max
+        end
+        box_width = [box_width, max_width + 2 * @border_size].max
+      else
+        box_width = -(box_width - 1)
       end
 
-      subwidgets.each do |subwidget|
-        subwidget.move(xplace, yplace, relative, false)
+      # For each line in the title convert from string to chtype array
+      title_width = box_width - (2 * @border_size)
+      @title = []
+      @title_pos = []
+      @title_len = []
+      (0...@title_lines).each do |x|
+        len_x = []
+        pos_x = []
+        @title << RNDK.char2Chtype(temp[x], len_x, pos_x)
+        @title_len.concat(len_x)
+        @title_pos << RNDK.justifyString(title_width, len_x[0], pos_x[0])
       end
+      box_width
+    end
 
-      # Touch the windows so they 'move'
-      RNDK.window_refresh @screen.window
-
-      # Redraw the window, if they asked for it
-      if refresh_flag
-        self.draw(@box)
+    # Draw the widget's title
+    def draw_title(win)
+      (0...@title_lines).each do |x|
+        Draw.writeChtype(@win, @title_pos[x] + @border_size,
+            x + @border_size, @title[x], RNDK::HORIZONTAL, 0,
+            @title_len[x])
       end
     end
 
@@ -142,15 +187,18 @@ module RNDK
     # Besides normal keybindings (arrow keys and such), see
     # Widget#set_exit_type to see how the Widget exits.
     #
-    def inject char
+    def inject input
     end
 
-    def set_box(box)
+    # Makes the widget have a border if `box` is true,
+    # otherwise, cancel it.
+    def set_box box
       @box = box
       @border_size = if @box then 1 else 0 end
     end
 
-    def getBox
+    # Tells if the widget has borders.
+    def get_box
       return @box
     end
 
@@ -160,10 +208,23 @@ module RNDK
     def unfocus
     end
 
-    def saveData
+    # Somehow saves all data within this Widget.
+    #
+    # @note This method isn't called whatsoever!
+    #       It only exists at Traverse module.
+    #
+    # TODO Find out how can I insert this on Widgets.
+    def save_data
     end
 
-    def refreshData
+
+    # Somehow refreshes all data within this Widget.
+    #
+    # @note This method isn't called whatsoever!
+    #       It only exists at Traverse module.
+    #
+    # TODO Find out how can I insert this on Widgets.
+    def refresh_data
     end
 
     # Destroys all windows inside the Widget and
@@ -171,42 +232,44 @@ module RNDK
     def destroy
     end
 
-    # Set the object's upper-left-corner line-drawing character.
+    # Set the widget's upper-left-corner line-drawing character.
     def setULchar(ch)
       @ULChar = ch
     end
 
-    # Set the object's upper-right-corner line-drawing character.
+    # Set the widget's upper-right-corner line-drawing character.
     def setURchar(ch)
       @URChar = ch
     end
 
-    # Set the object's lower-left-corner line-drawing character.
+    # Set the widget's lower-left-corner line-drawing character.
     def setLLchar(ch)
       @LLChar = ch
     end
 
-    # Set the object's upper-right-corner line-drawing character.
+    # Set the widget's upper-right-corner line-drawing character.
     def setLRchar(ch)
       @LRChar = ch
     end
 
-    # Set the object's horizontal line-drawing character
+    # Set the widget's horizontal line-drawing character
     def setHZchar(ch)
       @HZChar = ch
     end
 
-    # Set the object's vertical line-drawing character
+    # Set the widget's vertical line-drawing character
     def setVTchar(ch)
       @VTChar = ch
     end
 
-    # Set the object's box-attributes.
+    # Set the widget's box-attributes.
     def setBXattr(ch)
       @BXAttr = ch
     end
 
     # This sets the background color of the widget.
+    #
+    # FIXME BUG
     def set_bg_color color
       return if color.nil? || color == ''
 
@@ -224,67 +287,11 @@ module RNDK
       self.SetBackAttrObj(holder[0])
     end
 
-    # Set the widget's title.
-    def set_title (title, box_width)
-      return if title.nil?
-
-      temp = title.split "\n"
-      @title_lines = temp.size
-
-      if box_width >= 0
-        max_width = 0
-        temp.each do |line|
-          len = []
-          align = []
-          holder = RNDK.char2Chtype(line, len, align)
-          max_width = [len[0], max_width].max
-        end
-        box_width = [box_width, max_width + 2 * @border_size].max
-      else
-        box_width = -(box_width - 1)
-      end
-
-      # For each line in the title convert from string to chtype array
-      title_width = box_width - (2 * @border_size)
-      @title = []
-      @title_pos = []
-      @title_len = []
-      (0...@title_lines).each do |x|
-        len_x = []
-        pos_x = []
-        @title << RNDK.char2Chtype(temp[x], len_x, pos_x)
-        @title_len.concat(len_x)
-        @title_pos << RNDK.justifyString(title_width, len_x[0], pos_x[0])
-      end
-      box_width
-    end
-
-    # Draw the widget's title
-    def drawTitle(win)
-      (0...@title_lines).each do |x|
-        Draw.writeChtype(@win, @title_pos[x] + @border_size,
-            x + @border_size, @title[x], RNDK::HORIZONTAL, 0,
-            @title_len[x])
-      end
-    end
-
     # Remove storage for the widget's title.
-    def cleanTitle
+    def clean_title
       @title_lines = ''
     end
 
-    # Set data for preprocessing
-    def setPreProcess (fn, data)
-      @pre_process_func = fn
-      @pre_process_data = data
-    end
-
-    # Set data for postprocessing
-    def setPostProcess (fn, data)
-      @post_process_func = fn
-      @post_process_data = data
-    end
-
     # Set the Widget#exit_type based on the input `char`.
     #
     # According to default keybindings, if `char` is:
@@ -304,14 +311,6 @@ module RNDK
       end
     end
 
-    def valid_widget?
-      result = false
-      if RNDK::ALL_OBJECTS.include?(self)
-        result = self.validObjType(self.object_type)
-      end
-      result
-    end
-
     # FIXME TODO What does `function_key` does?
     def getch(function_key=[])
       key = self.getc
@@ -320,69 +319,6 @@ module RNDK
       key
     end
 
-    def bindableObject(rndktype)
-      if rndktype != self.object_type
-        return nil
-      elsif [:FSELECT, :alphalist].include?(self.object_type)
-        return @entry_field
-      else
-        return self
-      end
-    end
-
-    def bind(type, key, function, data)
-      obj = self.bindableObject(type)
-      if key.ord < Ncurses::KEY_MAX && !(obj.nil?)
-        if key.ord != 0
-          obj.binding_list[key.ord] = [function, data]
-        end
-      end
-    end
-
-    def unbind(type, key)
-      obj = self.bindableObject(type)
-      unless obj.nil?
-        obj.binding_list.delete(key)
-      end
-    end
-
-    def clean_bindings(type)
-      obj = self.bindableObject(type)
-      if !(obj.nil?) && !(obj.binding_list.nil?)
-        obj.binding_list.clear
-      end
-    end
-
-    # Checks to see if the binding for the key exists:
-    # If it does then it runs the command and returns its value, normally true
-    # If it doesn't it returns a false.  This way we can 'overwrite' coded
-    # bindings.
-    def checkBind(type, key)
-      obj = self.bindableObject(type)
-      if !(obj.nil?) && obj.binding_list.include?(key)
-        function = obj.binding_list[key][0]
-        data = obj.binding_list[key][1]
-
-        if function == :getc
-          return data
-        else
-          return function.call(type, obj, data, key)
-        end
-      end
-      return false
-    end
-
-    # Checks to see if the binding for the key exists.
-    def isBind(type, key)
-      result = false
-      obj = self.bindableObject(type)
-      unless obj.nil?
-        result = obj.binding_list.include?(key)
-      end
-
-      return result
-    end
-
     # Allows the user to move the Widget around
     # the screen via the cursor/keypad keys.
     #
@@ -424,7 +360,7 @@ module RNDK
       end_y = beg_y + Ncurses.getmaxy(@screen.window)
 
       loop do
-        key = self.getch([])
+        key = self.getch
 
         # Let them move the widget around until they hit return.
         break if [RNDK::KEY_RETURN, Ncurses::KEY_ENTER].include? key
@@ -513,13 +449,93 @@ module RNDK
       end
     end
 
+    # Tells if a widget is valid.
+    def valid?
+      RNDK::ALL_WIDGETS.include?(self) and self.valid_type?
+    end
+
+    # Tells if current widget's type is the
+    # type of an existing Widget.
+    def valid_type?
+      [:graph,
+       :histogram,
+       :label,
+       :marquee,
+       :viewer,
+       :alphalist,
+       :button,
+       :buttonbox,
+       :calendar,
+       :dialog,
+       :dscale,
+       :entry,
+       :fscale,
+       :fselect,
+       :fslider,
+       :itemlist,
+       :matrix,
+       :mentry,
+       :radio,
+       :scale,
+       :scroll,
+       :selection,
+       :slider,
+       :swindow,
+       :template,
+       :uscale,
+       :uslider].include? @widget_type
+    end
+
     protected
 
+    # Actually moves the widget.
+    def move_specific(x, y, relative, refresh_flag, windows, subwidgets)
+      current_x = Ncurses.getbegx @win
+      current_y = Ncurses.getbegy @win
+      xpos = x
+      ypos = y
+
+      # If this is a relative move, then we will adjust where we want
+      # to move to.
+      if relative
+        xpos = Ncurses.getbegx(@win) + x
+        ypos = Ncurses.getbegy(@win) + y
+      end
+
+      # Adjust the window if we need to
+      xtmp = [xpos]
+      ytmp = [ypos]
+      RNDK.alignxy(@screen.window, xtmp, ytmp, @box_width, @box_height)
+      xpos = xtmp[0]
+      ypos = ytmp[0]
+
+      # Get the difference
+      xdiff = current_x - xpos
+      ydiff = current_y - ypos
+
+      # Move the window to the new location.
+      windows.each do |window|
+        RNDK.window_move(window, -xdiff, -ydiff)
+      end
+
+      subwidgets.each do |subwidget|
+        subwidget.move(x, y, relative, false)
+      end
+
+      # Touch the windows so they 'move'
+      RNDK.window_refresh @screen.window
+
+      # Redraw the window, if they asked for it
+      if refresh_flag
+        self.draw
+      end
+    end
+
     # Gets a raw character from internal Ncurses window
     # and returns the result, capped to sane values.
     def getc
-      rndktype = self.object_type
-      test   = self.bindableObject rndktype
+      rndktype = self.widget_type
+      test   = self.bindable_widget rndktype
       result = Ncurses.wgetch @input_window
 
       if (result >= 0) and