rndk 0.0.1 → 0.1.0

data/lib/rndk/core/widget.rb

@@ -60,13 +60,39 @@ module RNDK
     def erase
     end
 
+    # Moves the Widget to the given position.
+    #
+    # * `xplace` and `yplace` are the new position of the Widget.
+    #
+    # * `xplace` 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
+    #   values `RNDK::LEFT`, `RNDK::RIGHT`, and `RNDK::CENTER`.
+    #
+    # * `relative` states whether the `xplace`/`yplace` 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`,
+    # the Widget would move one row down and two columns right.
+    #
+    # If the value of relative was `false` then the widget would move to
+    # the position `(1,2)`.
+    #
+    # Do not use the values `TOP`, `BOTTOM`, `LEFT`, `RIGHT`, or `CENTER`
+    # when `relative = true` - weird things may happen.
+    #
+    # * `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], [])
     end
 
     def move_specific(xplace, yplace, relative, refresh_flag, windows, subwidgets)
-      current_x = Ncurses.getbegx(@win)
-      current_y = Ncurses.getbegy(@win)
+      current_x = Ncurses.getbegx @win
+      current_y = Ncurses.getbegy @win
       xpos = xplace
       ypos = yplace
 
@@ -90,7 +116,7 @@ module RNDK
 
       # Move the window to the new location.
       windows.each do |window|
-        RNDK.moveCursesWindow(window, -xdiff, -ydiff)
+        RNDK.window_move(window, -xdiff, -ydiff)
       end
 
       subwidgets.each do |subwidget|
@@ -98,7 +124,7 @@ module RNDK
       end
 
       # Touch the windows so they 'move'
-      RNDK::Screen.refresh_window(@screen.window)
+      RNDK.window_refresh @screen.window
 
       # Redraw the window, if they asked for it
       if refresh_flag
@@ -106,10 +132,14 @@ module RNDK
       end
     end
 
-    def inject(a)
+    # Makes the Widget react to `char` just as if the user
+    # had pressed it.
+    #
+    # Nice to simulate batch actions on a Widget.
+    def inject char
     end
 
-    def setBox(box)
+    def set_box(box)
       @box = box
       @border_size = if @box then 1 else 0 end
     end
@@ -169,7 +199,7 @@ module RNDK
     end
 
     # This sets the background color of the widget.
-    def setBackgroundColor(color)
+    def set_bg_color color
       return if color.nil? || color == ''
 
       junk1 = []
@@ -179,43 +209,46 @@ module RNDK
       holder = RNDK.char2Chtype(color, junk1, junk2)
 
       # Set the widget's background color
+
+      ## FIXME BUG WTF
+      ## What does this function do?
+      ## Couldn't find anything on it
       self.SetBackAttrObj(holder[0])
     end
 
     # Set the widget's title.
-    def setTitle (title, box_width)
-      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])
+    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
 
-      return box_width
+      # 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
@@ -244,23 +277,26 @@ module RNDK
       @post_process_data = data
     end
 
-    # Set the object's exit-type based on the input.
-    # The .exitType field should have been part of the Widget struct, but it
-    # is used too pervasively in older applications to move (yet).
-    def setExitType(ch)
-      case ch
-      when Ncurses::ERR
-        @exit_type = :ERROR
-      when RNDK::KEY_ESC
-        @exit_type = :ESCAPE_HIT
+    # Set the Widget#exit_type based on the input `char`.
+    #
+    # According to default keybindings, if `char` is:
+    #
+    # RETURN or TAB:: Sets `:NORMAL`.
+    # ESCAPE::        Sets `:ESCAPE_HIT`.
+    # Otherwise::     Unless treated specifically by the
+    #                 Widget, sets `:EARLY_EXIT`.
+    #
+    def set_exit_type char
+      case char
+      when Ncurses::ERR  then @exit_type = :ERROR
+      when RNDK::KEY_ESC then @exit_type = :ESCAPE_HIT
+      when 0             then @exit_type = :EARLY_EXIT
       when RNDK::KEY_TAB, Ncurses::KEY_ENTER, RNDK::KEY_RETURN
         @exit_type = :NORMAL
-      when 0
-        @exit_type = :EARLY_EXIT
       end
     end
 
-    def validRNDKObject
+    def valid_widget?
       result = false
       if RNDK::ALL_OBJECTS.include?(self)
         result = self.validObjType(self.object_type)
@@ -268,47 +304,12 @@ module RNDK
       result
     end
 
-    def getc
-      rndktype = self.object_type
-      test = self.bindableObject(rndktype)
-      result = Ncurses.wgetch @input_window
-
-      if result >= 0 && !(test.nil?) && test.binding_list.include?(result) &&
-          test.binding_list[result][0] == :getc
-        result = test.binding_list[result][1]
-      elsif test.nil? || !(test.binding_list.include?(result)) ||
-          test.binding_list[result][0].nil?
-        case result
-        when "\r".ord, "\n".ord
-          result = Ncurses::KEY_ENTER
-        when "\t".ord
-          result = RNDK::KEY_TAB
-        when RNDK::DELETE
-          result = Ncurses::KEY_DC
-        when "\b".ord
-          result = Ncurses::KEY_BACKSPACE
-        when RNDK::BEGOFLINE
-          result = Ncurses::KEY_HOME
-        when RNDK::ENDOFLINE
-          result = Ncurses::KEY_END
-        when RNDK::FORCHAR
-          result = Ncurses::KEY_RIGHT
-        when RNDK::BACKCHAR
-          result = Ncurses::KEY_LEFT
-        when RNDK::NEXT
-          result = RNDK::KEY_TAB
-        when RNDK::PREV
-          result = Ncurses::KEY_BTAB
-        end
-      end
-
-      return result
-    end
-
-    def getch(function_key)
+    # FIXME TODO What does `function_key` does?
+    def getch(function_key=[])
       key = self.getc
       function_key << (key >= Ncurses::KEY_MIN && key <= Ncurses::KEY_MAX)
-      return key
+
+      key
     end
 
     def bindableObject(rndktype)
@@ -337,7 +338,7 @@ module RNDK
       end
     end
 
-    def cleanBindings(type)
+    def clean_bindings(type)
       obj = self.bindableObject(type)
       if !(obj.nil?) && !(obj.binding_list.nil?)
         obj.binding_list.clear
@@ -374,8 +375,11 @@ module RNDK
       return result
     end
 
-    # Allows the user to move the Widget around the screen
-    # via the cursor/keypad keys.
+    # Allows the user to move the Widget around
+    # the screen via the cursor/keypad keys.
+    #
+    # `win` is the main window of the Widget - from which
+    # subwins derive.
     #
     # The following key bindings can be used to move the
     # Widget around the screen:
@@ -402,7 +406,7 @@ module RNDK
     # Escape::      Returns the widget to its original position.
     # Return::      Exits the function and leaves the Widget where it was.
     #
-    def position(win)
+    def position win
       parent = @screen.window
       orig_x = Ncurses.getbegx win
       orig_y = Ncurses.getbegy win
@@ -501,6 +505,43 @@ module RNDK
       end
     end
 
+    protected
+
+    # 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
+      result = Ncurses.wgetch @input_window
+
+      if (result >= 0) and
+          (not test.nil?) and
+          (test.binding_list.include? result) and
+          (test.binding_list[result][0] == :getc)
+
+        result = test.binding_list[result][1]
+
+      elsif (test.nil?) or
+          (not test.binding_list.include? result) or
+          (test.binding_list[result][0].nil?)
+
+        case result
+        when "\r".ord, "\n".ord then result = Ncurses::KEY_ENTER
+        when "\t".ord           then result = RNDK::KEY_TAB
+        when RNDK::DELETE       then result = Ncurses::KEY_DC
+        when "\b".ord           then result = Ncurses::KEY_BACKSPACE
+        when RNDK::BEGOFLINE    then result = Ncurses::KEY_HOME
+        when RNDK::ENDOFLINE    then result = Ncurses::KEY_END
+        when RNDK::FORCHAR      then result = Ncurses::KEY_RIGHT
+        when RNDK::BACKCHAR     then result = Ncurses::KEY_LEFT
+        when RNDK::NEXT         then result = RNDK::KEY_TAB
+        when RNDK::PREV         then result = Ncurses::KEY_BTAB
+        end
+      end
+
+      return result
+    end
+
   end
 end
 

data/lib/rndk/dialog.rb

@@ -27,7 +27,7 @@ module RNDK
         return nil
       end
 
-      self.setBox(box)
+      self.set_box(box)
       box_height = if separator then 1 else 0 end
       box_height += rows + 2 * @border_size + 1
 
@@ -146,7 +146,7 @@ module RNDK
       end
 
       # Set the exit type and exit
-      self.setExitType(0)
+      self.set_exit_type(0)
       return -1
     end
 
@@ -159,7 +159,7 @@ module RNDK
       complete = false
 
       # Set the exit type.
-      self.setExitType(0)
+      self.set_exit_type(0)
 
       # Check if there is a pre-process function to be called.
       unless @pre_process_func.nil?
@@ -192,12 +192,12 @@ module RNDK
             @screen.erase
             @screen.refresh
           when RNDK::KEY_ESC
-            self.setExitType(input)
+            self.set_exit_type(input)
             complete = true
           when Ncurses::ERR
-            self.setExitType(input)
+            self.set_exit_type(input)
           when Ncurses::KEY_ENTER, RNDK::KEY_RETURN
-            self.setExitType(input)
+            self.set_exit_type(input)
             ret = @current_button
             complete = true
           end
@@ -213,7 +213,7 @@ module RNDK
       unless complete
         self.drawButtons
         Ncurses.wrefresh @win
-        self.setExitType(0)
+        self.set_exit_type(0)
       end
 
       @result_data = ret
@@ -257,11 +257,11 @@ module RNDK
     # This function destroys the dialog widget.
     def destroy
       # Clean up the windows.
-      RNDK.deleteCursesWindow(@win)
-      RNDK.deleteCursesWindow(@shadow_win)
+      RNDK.window_delete(@win)
+      RNDK.window_delete(@shadow_win)
 
       # Clean the key bindings
-      self.cleanBindings(:DIALOG)
+      self.clean_bindings(:DIALOG)
 
       # Unregister this object
       RNDK::Screen.unregister(:DIALOG, self)
@@ -269,21 +269,21 @@ module RNDK
 
     # This function erases the dialog widget from the screen.
     def erase
-      if self.validRNDKObject
-        RNDK.eraseCursesWindow(@win)
-        RNDK.eraseCursesWindow(@shadow_win)
+      if self.valid_widget?
+        RNDK.window_erase(@win)
+        RNDK.window_erase(@shadow_win)
       end
     end
 
     # This sets attributes of the dialog box.
     def set(highlight, separator, box)
-      self.setHighlight(highlight)
+      self.set_highlight(highlight)
       self.setSeparator(separator)
-      self.setBox(box)
+      self.set_box(box)
     end
 
     # This sets the highlight attribute for the buttons.
-    def setHighlight(highlight)
+    def set_highlight(highlight)
       @highlight = highlight
     end
 
@@ -301,7 +301,7 @@ module RNDK
     end
 
     # This sets the background attribute of the widget.
-    def setBKattr(attrib)
+    def set_bg_attrib(attrib)
       Ncurses.wbkgd(@win, attrib)
     end
 

data/lib/rndk/entry.rb

@@ -28,7 +28,7 @@ module RNDK
       xpos = xplace
       ypos = yplace
 
-      self.setBox(box)
+      self.set_box(box)
       box_height = @border_size * 2 + 1
 
       # If the field_width is a negative value, the field_width will be
@@ -50,7 +50,7 @@ module RNDK
       end
 
       old_width = box_width
-      box_width = self.setTitle(title, box_width)
+      box_width = self.set_title(title, box_width)
       horizontal_adjust = (box_width - old_width) / 2
 
       box_height += @title_lines
@@ -120,7 +120,7 @@ module RNDK
       @box_height = box_height
       @disp_type = disp_type
       @callbackfn = lambda do |entry, character|
-        plainchar = Display.filterByDisplayType(entry, character)
+        plainchar = Display.filter_by_display_type(entry, character)
 
         if plainchar == Ncurses::ERR || entry.info.size >= entry.max
           RNDK.beep
@@ -215,7 +215,7 @@ module RNDK
       complete = false
 
       # Set the exit type
-      self.setExitType(0)
+      self.set_exit_type(0)
 
       # Refresh the widget field.
       self.drawField
@@ -308,7 +308,7 @@ module RNDK
               end
             end
           when RNDK::KEY_ESC
-            self.setExitType(input)
+            self.set_exit_type(input)
             complete = true
           when RNDK::ERASE
             if @info.size != 0
@@ -338,14 +338,14 @@ module RNDK
             end
           when RNDK::KEY_TAB, RNDK::KEY_RETURN, Ncurses::KEY_ENTER
             if @info.size >= @min
-              self.setExitType(input)
+              self.set_exit_type(input)
               ret = @info
               complete = true
             else
               RNDK.beep
             end
           when Ncurses::ERR
-            self.setExitType(input)
+            self.set_exit_type(input)
             complete = true
           when RNDK::REFRESH
             @screen.erase
@@ -361,7 +361,7 @@ module RNDK
       end
 
       unless complete
-        self.setExitType(0)
+        self.set_exit_type(0)
       end
 
       @result_data = ret
@@ -431,7 +431,7 @@ module RNDK
       # If there is information in the field then draw it in.
       if !(@info.nil?) && @info.size > 0
         # Redraw the field.
-        if Display.isHiddenDisplayType(@disp_type)
+        if Display.is_hidden_display_type(@disp_type)
           (@left_char...@info.size).each do |x|
             Ncurses.mvwaddch(@field_win, 0, x - @left_char, @hidden)
           end
@@ -448,11 +448,11 @@ module RNDK
 
     # This erases an entry widget from the screen.
     def erase
-      if self.validRNDKObject
-        RNDK.eraseCursesWindow(@field_win)
-        RNDK.eraseCursesWindow(@label_win)
-        RNDK.eraseCursesWindow(@win)
-        RNDK.eraseCursesWindow(@shadow_win)
+      if self.valid_widget?
+        RNDK.window_erase(@field_win)
+        RNDK.window_erase(@label_win)
+        RNDK.window_erase(@win)
+        RNDK.window_erase(@shadow_win)
       end
     end
 
@@ -460,12 +460,12 @@ module RNDK
     def destroy
       self.cleanTitle
 
-      RNDK.deleteCursesWindow(@field_win)
-      RNDK.deleteCursesWindow(@label_win)
-      RNDK.deleteCursesWindow(@shadow_win)
-      RNDK.deleteCursesWindow(@win)
+      RNDK.window_delete(@field_win)
+      RNDK.window_delete(@label_win)
+      RNDK.window_delete(@shadow_win)
+      RNDK.window_delete(@win)
 
-      self.cleanBindings(:ENTRY)
+      self.clean_bindings(:ENTRY)
 
       RNDK::Screen.unregister(:ENTRY, self)
     end
@@ -533,7 +533,7 @@ module RNDK
     end
 
     # This sets the background attribute of the widget.
-    def setBKattr(attrib)
+    def set_bg_attrib(attrib)
       Ncurses.wbkgd(@win, attrib)
       Ncurses.wbkgd(@field_win, attrib)
       unless @label_win.nil?
@@ -542,7 +542,7 @@ module RNDK
     end
 
     # This sets the attribute of the entry field.
-    def setHighlight(highlight, cursor)
+    def set_highlight(highlight, cursor)
       Ncurses.wbkgd(@field_win, highlight)
       @field_attr = highlight
       Ncurses.curs_set(cursor)

data/lib/rndk/fselect.rb

@@ -18,7 +18,7 @@ module RNDK
           RNDK::FORCHAR  => Ncurses::KEY_NPAGE,
       }
 
-      self.setBox(box)
+      self.set_box(box)
 
       # If the height is a negative value the height will be ROWS-height,
       # otherwise the height will be the given height
@@ -312,7 +312,7 @@ module RNDK
             # mesg[0] = copyChar (errorMessage ("<C>Cannot delete file: %s"));
             # mesg[1] = copyChar (" ");
             # mesg[2] = copyChar("<C>Press any key to continue.");
-            # popupLabel(ScreenOf (fselect), (RNDK_CSTRING2) mesg, 3);
+            # popup_label(ScreenOf (fselect), (RNDK_CSTRING2) mesg, 3);
             # freeCharList (mesg, 3);
           end
         end
@@ -392,10 +392,10 @@ module RNDK
 
     # This erases the file selector from the screen.
     def erase
-      if self.validRNDKObject
+      if self.valid_widget?
         @scroll_field.erase
         @entry_field.erase
-        RNDK.eraseCursesWindow(@win)
+        RNDK.window_erase(@win)
       end
     end
 
@@ -479,7 +479,7 @@ module RNDK
       end
 
       # Set the exit type and exit.
-      self.setExitType(0)
+      self.set_exit_type(0)
       return 0
     end
 
@@ -524,7 +524,7 @@ module RNDK
       end
 
       if !complete
-        self.setExitType(0)
+        self.set_exit_type(0)
       end
 
       @result_data = ret
@@ -545,7 +545,7 @@ module RNDK
 
       # Set the attributes of the entry field/scrolling list.
       self.setFillerChar(filler)
-      self.setHighlight(highlight)
+      self.set_highlight(highlight)
 
       # Only do the directory stuff if the directory is not nil.
       if !(directory.nil?) && directory.size > 0
@@ -569,7 +569,7 @@ module RNDK
           ]
 
           # Pop up a message.
-          @screen.popupLabel(mesg, 4)
+          @screen.popup_label(mesg, 4)
 
           # Get out of here.
           self.erase
@@ -699,9 +699,9 @@ module RNDK
     end
 
     # This sets the highlight bar of the scrolling list.
-    def setHighlight(highlight)
+    def set_highlight(highlight)
       @highlight = highlight
-      @scroll_field.setHighlight(highlight)
+      @scroll_field.set_highlight(highlight)
     end
 
     def getHighlight
@@ -835,22 +835,22 @@ module RNDK
     end
 
     # This sets the background attribute of the widget.
-    def setBKattr(attrib)
-      @entry_field.setBKattr(attrib)
-      @scroll_field.setBKattr(attrib)
+    def set_bg_attrib(attrib)
+      @entry_field.set_bg_attrib(attrib)
+      @scroll_field.set_bg_attrib(attrib)
     end
 
     # This destroys the file selector.
     def destroy
-      self.cleanBindings(:FSELECT)
+      self.clean_bindings(:FSELECT)
 
       # Destroy the other RNDK objects
       @scroll_field.destroy
       @entry_field.destroy
 
       # Free up the windows
-      RNDK.deleteCursesWindow(@shadow_win)
-      RNDK.deleteCursesWindow(@win)
+      RNDK.window_delete(@shadow_win)
+      RNDK.window_delete(@win)
 
       # Clean the key bindings.
       # Unregister the object.