rndk 0.2.0 → 1.0.0

data/lib/rndk/core/widget_bind.rb

@@ -0,0 +1,108 @@
+
+module RNDK
+  class Widget
+
+    # Returns the internal Widget that accepts key bindings.
+    #
+    # Some widgets are made of others.
+    # So when we bind keys to those complex widgets,
+    # we can specify which internal Widget accepts keybindings.
+    #
+    # For example, on an Alphalist (which is composed of Scroll
+    # and Entry), we bind keys to the Entry, not Scroll.
+    #
+    def bindable_widget rndktype
+      return nil if rndktype != @widget_type
+
+
+      if [:Fselect, :alphalist].include? @widget_type
+        return @entry_field
+
+      else
+        return self
+      end
+    end
+
+    # Binds a `function` to a `key`.
+    #
+    def bind_key(key, data=nil, &action)
+      obj = self.bindable_widget @widget_type
+
+      if (key.ord >= Ncurses::KEY_MAX) or (key.ord.zero?) or (obj.nil?)
+        return
+      end
+
+      obj.binding_list[key.ord] = [action, data]
+    end
+
+    def unbind_key key
+      obj = self.bindable_widget @widget_type
+
+      obj.binding_list.delete(key) unless obj.nil?
+    end
+
+    def clean_bindings
+      obj = self.bindable_widget @widget_type
+
+      if (not obj.nil?) and (not obj.binding_list.nil?)
+        obj.binding_list.clear
+      end
+    end
+
+    # Runs any binding that's set for `key`.
+    #
+    # @return The binding's return value or `false`, if no
+    #         keybinding for `key` exists.
+
+    def run_key_binding key
+      obj = self.bindable_widget @widget_type
+
+      return false if obj.nil? or (not obj.binding_list.include? key)
+
+      function = obj.binding_list[key][0]
+      data     = obj.binding_list[key][1]
+
+      # What the heck is this?
+      return data if function == :getc
+
+      function.call data
+    end
+
+    # Tells if the key binding for the key exists.
+    def is_bound? key
+      obj = self.bindable_widget @widget_type
+      return false if obj.nil?
+
+      obj.binding_list.include? key
+    end
+
+    # Binds an `action` to be executed when
+    # `signal` is activated.
+    def bind_signal(signal, &action)
+      return unless @supported_signals.include? signal
+
+      @actions[signal] = [] if @actions[signal].nil?
+
+      @actions[signal] << action
+    end
+
+    # Runs all actions based on `signal`, passing `data` as an
+    # argument.
+    #
+    # @note It interrupts executing when any action returns
+    #       `false`.
+    # @return `true` if all actions were executed or no actions
+    #         exist, `false` if they were interrupted.
+    def run_signal_binding(signal, data=nil)
+      return true if @actions[signal].nil?
+
+      @actions[signal].each do |action|
+        return false if action.call(data) == false
+      end
+
+      true
+    end
+
+  end
+end
+

data/lib/rndk/dialog.rb

@@ -1,33 +1,72 @@
 require 'rndk'
 
 module RNDK
-  class DIALOG < Widget
+
+  class Dialog < Widget
+
     attr_reader :current_button
+
     MIN_DIALOG_WIDTH = 10
 
-    def initialize(rndkscreen, xplace, yplace, mesg, rows, button_label,
-        button_count, highlight, separator, box, shadow)
+    def initialize(screen, config={})
       super()
-      box_width = DIALOG::MIN_DIALOG_WIDTH
+      @widget_type = :dialog
+      @supported_signals += [:before_input, :after_input,
+                             :before_pressing, :after_pressing]
+
+      x         = 0
+      y         = 0
+      text      = "dialog"
+      buttons   = ["button"]
+      highlight = RNDK::Color[:reverse]
+      separator = true
+      box       = true
+      shadow    = false
+
+      config.each do |key, val|
+        x            = val if key == :x
+        y            = val if key == :y
+        text         = val if key == :text
+        buttons      = val if key == :buttons
+        highlight    = val if key == :highlight
+        separator    = val if key == :separator
+        box          = val if key == :box
+        shadow       = val if key == :shadow
+      end
+
+      # Adjusting if the user sent us a String as text
+      text = [text] if text.class == String
+      return nil if text.class != Array or text.empty?
+      rows = text.size
+
+      # Adjusting if the user sent us a String as buttons
+      buttons = [buttons] if buttons.class == String
+      return nil if buttons.class != Array or buttons.empty?
+      button_count = buttons.size
+
+      box_width = Dialog::MIN_DIALOG_WIDTH
       max_message_width = -1
       button_width = 0
-      xpos = xplace
-      ypos = yplace
+      xpos = x
+      ypos = y
       temp = 0
       buttonadj = 0
       @info = []
       @info_len = []
       @info_pos = []
-      @button_label = []
+      @buttons = []
       @button_len = []
       @button_pos = []
 
+      @screen = screen
+      @parent = screen.window
+
       if rows <= 0 || button_count <= 0
         self.destroy
         return nil
       end
 
-      self.set_box(box)
+      self.set_box box
       box_height = if separator then 1 else 0 end
       box_height += rows + 2 * @border_size + 1
 
@@ -35,7 +74,7 @@ module RNDK
       (0...rows).each do |x|
         info_len = []
         info_pos = []
-        @info << RNDK.char2Chtype(mesg[x], info_len, info_pos)
+        @info << RNDK.char2Chtype(text[x], info_len, info_pos)
         @info_len << info_len[0]
         @info_pos << info_pos[0]
         max_message_width = [max_message_width, info_len[0]].max
@@ -44,7 +83,7 @@ module RNDK
       # Translate the button label string to a chtype array
       (0...button_count).each do |x|
         button_len = []
-        @button_label << RNDK.char2Chtype(button_label[x], button_len, [])
+        @buttons << RNDK.char2Chtype(buttons[x], button_len, [])
         @button_len << button_len[0]
         button_width += button_len[0] + 1
       end
@@ -58,13 +97,11 @@ module RNDK
       # Now we have to readjust the x and y positions.
       xtmp = [xpos]
       ytmp = [ypos]
-      RNDK.alignxy(rndkscreen.window, xtmp, ytmp, box_width, box_height)
+      RNDK.alignxy(screen.window, xtmp, ytmp, box_width, box_height)
       xpos = xtmp[0]
       ypos = ytmp[0]
 
       # Set up the dialog box attributes.
-      @screen = rndkscreen
-      @parent = rndkscreen.window
       @win = Ncurses.newwin(box_height, box_width, ypos, xpos)
       @shadow_win = nil
       @button_count = button_count
@@ -105,20 +142,20 @@ module RNDK
       end
 
       # Register this baby.
-      rndkscreen.register(:DIALOG, self)
+      screen.register(@widget_type, self)
     end
 
     # This lets the user select the button.
-    def activate(actions)
+    def activate(actions=[])
       input = 0
 
       # Draw the dialog box.
-      self.draw(@box)
+      self.draw
 
       # Lets move to the first button.
       Draw.writeChtypeAttrib(@win,
                              @button_pos[@current_button],
-                             @box_height - 1 - @border_size, @button_label[@current_button],
+                             @box_height - 1 - @border_size, @buttons[@current_button],
                              @highlight,
                              RNDK::HORIZONTAL,
                              0,
@@ -127,7 +164,7 @@ module RNDK
 
       if actions.nil? || actions.size == 0
         while true
-          input = self.getch([])
+          input = self.getch
 
           # Inject the character into the widget.
           ret = self.inject(input)
@@ -151,27 +188,26 @@ module RNDK
     end
 
     # This injects a single character into the dialog widget
-    def inject(input)
+    def inject input
       first_button = 0
       last_button = @button_count - 1
-      pp_return = 1
-      ret = -1
+      pp_return = true
+      ret = false
       complete = false
 
       # Set the exit type.
       self.set_exit_type(0)
 
       # Check if there is a pre-process function to be called.
-      unless @pre_process_func.nil?
-        pp_return = @pre_process_func.call(:DIALOG, self,
-            @pre_process_data, input)
-      end
+      keep_going = self.run_signal_binding(:before_input, input)
+
+      if keep_going
 
-      # Should we continue?
-      if pp_return != 0
         # Check for a key binding.
-        if self.checkBind(:DIALOG, input)
-          complete = true
+        if self.is_bound? input
+          self.run_key_binding input
+          #complete = true
+
         else
           case input
           when Ncurses::KEY_LEFT, Ncurses::KEY_BTAB, Ncurses::KEY_BACKSPACE
@@ -196,22 +232,24 @@ module RNDK
             complete = true
           when Ncurses::ERR
             self.set_exit_type(input)
+
           when Ncurses::KEY_ENTER, RNDK::KEY_RETURN
-            self.set_exit_type(input)
-            ret = @current_button
-            complete = true
+            keep_going = self.run_signal_binding(:before_pressing, @current_button)
+            if keep_going
+              self.set_exit_type(input)
+              ret = @current_button
+              complete = true
+              self.run_signal_binding(:after_pressing, ret)
+            end
           end
         end
 
         # Should we call a post_process?
-        if !complete && !(@post_process_func.nil?)
-          @post_process_func.call(:DIALOG, self,
-              @post_process_data, input)
-        end
+        self.run_signal_binding(:after_input) if not complete
       end
 
       unless complete
-        self.drawButtons
+        self.draw_buttons
         Ncurses.wrefresh @win
         self.set_exit_type(0)
       end
@@ -221,16 +259,14 @@ module RNDK
     end
 
     # This function draws the dialog widget.
-    def draw(box)
+    def draw
       # Is there a shadow?
       unless @shadow_win.nil?
         Draw.drawShadow(@shadow_win)
       end
 
       # Box the widget if they asked.
-      if box
-        Draw.drawObjBox(@win, self)
-      end
+      Draw.drawObjBox(@win, self) if @box
 
       # Draw in the message.
       (0...@message_rows).each do |x|
@@ -244,7 +280,7 @@ module RNDK
       end
 
       # Draw in the buttons.
-      self.drawButtons
+      self.draw_buttons
 
       Ncurses.wrefresh @win
     end
@@ -256,15 +292,15 @@ module RNDK
       RNDK.window_delete(@shadow_win)
 
       # Clean the key bindings
-      self.clean_bindings(:DIALOG)
+      self.clean_bindings
 
-      # Unregister this object
-      RNDK::Screen.unregister(:DIALOG, self)
+      # Unregister this widget
+      @screen.unregister self
     end
 
     # This function erases the dialog widget from the screen.
     def erase
-      if self.valid_widget?
+      if self.valid?
         RNDK.window_erase(@win)
         RNDK.window_erase(@shadow_win)
       end
@@ -296,17 +332,17 @@ module RNDK
     end
 
     # This sets the background attribute of the widget.
-    def set_bg_attrib(attrib)
+    def set_bg_color(attrib)
       Ncurses.wbkgd(@win, attrib)
     end
 
     # This draws the dialog buttons and the separation line.
-    def drawButtons
+    def draw_buttons
       (0...@button_count).each do |x|
         Draw.writeChtype(@win,
                          @button_pos[x],
                          @box_height -1 - @border_size,
-                         @button_label[x],
+                         @buttons[x],
                          RNDK::HORIZONTAL,
                          0,
                          @button_len[x])
@@ -335,7 +371,7 @@ module RNDK
       Draw.writeChtypeAttrib(@win,
                              @button_pos[@current_button],
                              @box_height - 1 - @border_size,
-                             @button_label[@current_button],
+                             @buttons[@current_button],
                              @highlight,
                              RNDK::HORIZONTAL,
                              0,
@@ -343,15 +379,11 @@ module RNDK
     end
 
     def focus
-      self.draw @box
+      self.draw
     end
 
     def unfocus
-      self.draw @box
-    end
-
-    def object_type
-      :DIALOG
+      self.draw
     end
 
     def position

data/lib/rndk/entry.rb

@@ -84,26 +84,25 @@ module RNDK
     attr_reader :win, :box_height, :box_width, :max, :field_width
     attr_reader :min, :max
 
-
     # Creates an Entry Widget.
     #
     # ## Arguments
     #
-    # * `xplace` is the x position - can be an integer or
+    # * `x` is the x position - can be an integer or
     #   `RNDK::LEFT`, `RNDK::RIGHT`, `RNDK::CENTER`.
-    # * `yplace` is the y position - can be an integer or
+    # * `y` is the y position - can be an integer or
     #   `RNDK::TOP`, `RNDK::BOTTOM`, `RNDK::CENTER`.
     # * `title` can be more than one line - just split them
     #   with `\n`s.
     # * `label` is the String that will appear on the label
     #   of the Entry field.
-    # * `field_attr` is the attribute/color of the characters
+    # * `field_color` is the attribute/color of the characters
     #   that are typed in.
     # * `filler_char` is the character to display on the
     #   empty spaces in the entry field.
     # * `disp_type` tells how the entry field will behave.
     #   _See main Entry documentation_.
-    # * `f_width` is the width of the field. It it's 0,
+    # * `field_width` is the width of the field. It it's 0,
     #   will be created with full width of the screen.
     #   If it's a negative value, will create with full width
     #   minus that value.
@@ -114,36 +113,57 @@ module RNDK
     # * `box` if the Widget is drawn with a box outside it.
     # * `shadow` turns on/off the shadow around the Widget.
     #
-    def initialize(rndkscreen,
-                   xplace,
-                   yplace,
-                   title,
-                   label,
-                   field_attr,
-                   filler,
-                   disp_type,
-                   f_width,
-                   min,
-                   max,
-                   box,
-                   shadow)
+    def initialize(screen, config={})
       super()
+      @widget_type = :entry
+      @supported_signals += [:before_input, :after_input]
+
+      x            = 0
+      y            = 0
+      title        = "entry"
+      label        = "label"
+      field_color  = RNDK::Color[:normal]
+      filler       = '.'
+      disp_type    = :MIXED
+      field_width  = 0
+      initial_text = ""
+      min          = 0
+      max          = 9001
+      box          = true
+      shadow       = false
+
+      config.each do |key, val|
+        x            = val if key == :x
+        y            = val if key == :y
+        title        = val if key == :title
+        label        = val if key == :label
+        field_color  = val if key == :field_color
+        filler       = val if key == :filler
+        disp_type    = val if key == :disp_type
+        field_width  = val if key == :field_width
+        initial_text = val if key == :initial_text
+        min          = val if key == :min
+        max          = val if key == :max
+        box          = val if key == :box
+        shadow       = val if key == :shadow
+      end
 
-      parent_width  = Ncurses.getmaxx rndkscreen.window
-      parent_height = Ncurses.getmaxy rndkscreen.window
+      parent_width  = Ncurses.getmaxx screen.window
+      parent_height = Ncurses.getmaxy screen.window
 
-      field_width = f_width
+      field_width = field_width
       box_width   = 0
 
-      xpos = xplace
-      ypos = yplace
+      xpos = x
+      ypos = y
 
       self.set_box box
       box_height = @border_size*2 + 1
 
-      # If the field_width is a negative value, the field_width will be
-      # COLS-field_width, otherwise the field_width will be the given width.
-      field_width = RNDK.setWidgetDimension(parent_width, field_width, 0)
+      # If the field_width is a negative value, the field_width
+      # WILL be COLS-field_width, otherwise the field_width will
+      # be the given width.
+      field_width = RNDK.set_widget_dimension(parent_width, field_width, 0)
       box_width = field_width + 2*@border_size
 
       # Set some basic values of the entry field.
@@ -174,12 +194,12 @@ module RNDK
       # Rejustify the x and y positions if we need to.
       xtmp = [xpos]
       ytmp = [ypos]
-      RNDK.alignxy(rndkscreen.window, xtmp, ytmp, box_width, box_height)
+      RNDK.alignxy(screen.window, xtmp, ytmp, box_width, box_height)
       xpos = xtmp[0]
       ypos = ytmp[0]
 
       # Make the label window.
-      @win = Ncurses.subwin(rndkscreen.window, box_height, box_width, ypos, xpos)
+      @win = Ncurses.subwin(screen.window, box_height, box_width, ypos, xpos)
       if @win.nil?
         self.destroy
         return nil
@@ -211,10 +231,10 @@ module RNDK
       @info_width = max + 3
 
       # Set up the rest of the structure.
-      @screen = rndkscreen
-      @parent = rndkscreen.window
+      @screen = screen
+      @parent = screen.window
       @shadow_win = nil
-      @field_attr = field_attr
+      @field_color = field_color
       @field_width = field_width
       @filler = filler
       @hidden = filler
@@ -255,16 +275,18 @@ module RNDK
         end
       end
 
+      self.set_text initial_text
+
       # Do we want a shadow?
       if shadow
-        @shadow_win = Ncurses.subwin(rndkscreen.window,
+        @shadow_win = Ncurses.subwin(screen.window,
                                      box_height,
                                      box_width,
                                      ypos + 1,
                                      xpos + 1)
       end
 
-      rndkscreen.register(:entry, self)
+      screen.register(:entry, self)
     end
 
     # Activates the Entry Widget, letting the user interact with it.
@@ -280,11 +302,11 @@ module RNDK
       ret = 0
 
       # Draw the widget.
-      self.draw(@box)
+      self.draw
 
       if actions.nil? or actions.size == 0
         while true
-          input = self.getch([])
+          input = self.getch
 
           # Inject the character into the widget.
           ret = self.inject(input)
@@ -312,7 +334,7 @@ module RNDK
 
     # @see Widget#inject
     def inject input
-      pp_return = 1
+      pp_return = true
       ret = 1
       complete = false
 
@@ -322,17 +344,15 @@ module RNDK
       # Refresh the widget field.
       self.drawField
 
-      unless @pre_process_func.nil?
-        pp_return = @pre_process_func.call(:entry, self,
-            @pre_process_data, input)
-      end
+      # Check if there is a pre-process function to be called.
+      keep_going = self.run_signal_binding(:before_input, input)
 
-      # Should we continue?
-      if pp_return != 0
+      if keep_going
 
         # Check a predefined binding
-        if self.checkBind(:entry, input)
-          complete = true
+        if self.is_bound? input
+          self.run_key_binding input
+          #complete = true
 
         else
           curr_pos = @screen_col + @left_char
@@ -472,9 +492,8 @@ module RNDK
           end
         end
 
-        if !complete && !(@post_process_func.nil?)
-          @post_process_func.call(:entry, self, @post_process_data, input)
-        end
+        # Should we do a post-process?
+        self.run_signal_binding(:after_input) if not complete
       end
 
       unless complete
@@ -486,10 +505,10 @@ module RNDK
     end
 
     # @see Widget#move
-    def move(xplace, yplace, relative, refresh_flag)
+    def move(x, y, relative, refresh_flag)
       windows = [@win, @field_win, @label_win, @shadow_win]
 
-      self.move_specific(xplace, yplace, relative, refresh_flag, windows, [])
+      self.move_specific(x, y, relative, refresh_flag, windows, [])
     end
 
     # Clears the text from the entry field.
@@ -512,14 +531,14 @@ module RNDK
     # Draws the Widget on the Screen.
     #
     # If `box` is true, it is drawn with a box.
-    def draw box
+    def draw
       # Did we ask for a shadow?
       Draw.drawShadow @shadow_win unless @shadow_win.nil?
 
       # Box the widget if asked.
-      Draw.drawObjBox(@win, self) if box
+      Draw.drawObjBox(@win, self) if @box
 
-      self.drawTitle @win
+      self.draw_title @win
       Ncurses.wrefresh @win
 
       # Draw in the label to the widget.
@@ -540,7 +559,7 @@ module RNDK
 
     # @see Widget#erase
     def erase
-      if self.valid_widget?
+      if self.valid?
         RNDK.window_erase(@field_win)
         RNDK.window_erase(@label_win)
         RNDK.window_erase(@win)
@@ -550,16 +569,16 @@ module RNDK
 
     # @see Widget#destroy
     def destroy
-      self.cleanTitle
+      self.clean_title
 
       RNDK.window_delete(@field_win)
       RNDK.window_delete(@label_win)
       RNDK.window_delete(@shadow_win)
       RNDK.window_delete(@win)
 
-      self.clean_bindings(:entry)
+      self.clean_bindings
 
-      RNDK::Screen.unregister(:entry, self)
+      @screen.unregister self
     end
 
     # Sets multiple attributes of the Widget.
@@ -635,7 +654,7 @@ module RNDK
     end
 
     # Sets the background attribute/color of the widget.
-    def set_bg_attrib attrib
+    def set_bg_color attrib
       Ncurses.wbkgd(@win, attrib)
       Ncurses.wbkgd(@field_win, attrib)
 
@@ -648,7 +667,7 @@ module RNDK
     # See Ncurses#curs_set.
     def set_highlight(highlight, cursor)
       Ncurses.wbkgd(@field_win, highlight)
-      @field_attr = highlight
+      @field_color = highlight
       Ncurses.curs_set cursor
 
       # FIXME(original) - if (cursor) { move the cursor to this widget }
@@ -660,7 +679,7 @@ module RNDK
     end
 
     def unfocus
-      self.draw box
+      self.draw
       Ncurses.wrefresh @field_win
     end
 
@@ -669,10 +688,6 @@ module RNDK
       super @win
     end
 
-    def object_type
-      :entry
-    end
-
     # Allows the programmer to set a different widget input handler.
     #
     # @note Unless you're very low-level and know what you're doing
@@ -696,7 +711,7 @@ module RNDK
           end
         else
           (@left_char...@info.size).each do |x|
-            Ncurses.mvwaddch(@field_win, 0, x - @left_char, @info[x].ord | @field_attr)
+            Ncurses.mvwaddch(@field_win, 0, x - @left_char, @info[x].ord | @field_color)
           end
         end
         Ncurses.wmove(@field_win, 0, @screen_col)