rndk 0.0.1 → 0.1.0

data/lib/rndk/core/quick_widgets.rb

@@ -4,15 +4,23 @@
 # ## Usage
 #
 # They're all methods to the RNDK::Screen class.
+#
 # For example:
 #
-#     curses_win = Ncurses.initscr
-#     rndkscreen = RNDK::Screen.new(curses_win)
+#     rndkscreen = RNDK::Screen.new
 #     message = ["awesome quick label!"]
-#     rndkscreen.popupLabel message
+#     rndkscreen.popup_label message
 #
+
+# Since I'm including a lot of widgets here, maybe I
+# should make the user require 'quick_widgets'
+# explicitly?
 require 'rndk/label'
 require 'rndk/dialog'
+require 'rndk/viewer'
+require 'rndk/fselect'
+require 'rndk/entry'
+require 'rndk/scroll'
 
 module RNDK
   class Screen
@@ -37,13 +45,11 @@ module RNDK
     # waits until the user hits a character.
     #
     # @note: `message` must be an array of strings.
-    def popupLabel message
+    def popup_label message
       return if message.class != Array or message.empty?
 
       self.cleanly do
-        count = message.size
-
-        popup = RNDK::LABEL.new(self, CENTER, CENTER, message, count, true, false)
+        popup = RNDK::LABEL.new(self, CENTER, CENTER, message, true, false)
         popup.draw(true)
 
         # Wait for some input.
@@ -57,11 +63,11 @@ module RNDK
     # the background of the dialog.
     #
     # @note: `message` must be an array of strings.
-    def popupLabelAttrib(message, attrib)
+    def popup_label_attrib(message, attrib)
       return if message.class != Array or message.empty?
 
       self.cleanly do
-        popup = RNDK::LABEL.new(self, CENTER, CENTER, message, message.size, true, false)
+        popup = RNDK::LABEL.new(self, CENTER, CENTER, message, true, false)
         popup.setBackgroundAttrib attrib
         popup.draw(true)
 
@@ -76,14 +82,15 @@ module RNDK
     # Shows a centered pop-up Dialog box with `message` label and
     # each button label on `buttons`.
     #
-    # @returns The user choice or `nil` if wrong parameters
-    #          were given.
+    # @return The user choice or `nil` if wrong parameters
+    #         were given.
     #
     # @note: `message` and `buttons` must be Arrays of Strings.
-    def popupDialog(message, buttons)
+    def popup_dialog(message, buttons)
       return nil if message.class != Array or message.empty?
       return nil if buttons.class != Array or buttons.empty?
 
+      choice = 0
       self.cleanly do
         popup = RNDK::DIALOG.new(self,
                                  RNDK::CENTER,
@@ -101,6 +108,219 @@ module RNDK
       choice
     end
 
+    # Display a long string set `info` in a Viewer Widget.
+    #
+    # `title` and `buttons` are applied to the Widget.
+    #
+    # `hide_control_chars` tells if we want to hide those
+    # ugly `^J`, `^M` chars.
+    #
+    # @return The index of the selected button.
+    # @note `info` and `buttons` must be Arrays of Strings.
+    def view_info(title, info, buttons, hide_control_chars=true)
+      return nil if info.class != Array or info.empty?
+      return nil if buttons.class != Array or buttons.empty?
+
+      selected = -1
+
+      # Create the file viewer to view the file selected.
+      viewer = RNDK::VIEWER.new(self,
+                                RNDK::CENTER,
+                                RNDK::CENTER,
+                                -6,
+                                -16,
+                                buttons,
+                                buttons.size,
+                                Ncurses::A_REVERSE,
+                                true,
+                                true)
+
+      # Set up the viewer title, and the contents of the widget.
+      viewer.set(title,
+                 info,
+                 info.size,
+                 Ncurses::A_REVERSE,
+                 hide_control_chars,
+                 true,
+                 true)
+
+      selected = viewer.activate([])
+
+      # Make sure they exited normally.
+      if viewer.exit_type != :NORMAL
+        viewer.destroy
+        return -1
+      end
+
+      # Clean up and return the button index selected
+      viewer.destroy
+      selected
+    end
+
+    # Reads `filename`'s contents and display it on a Viewer Widget.
+    #
+    # `title` and `buttons` are applied to the Widget.
+    #
+    # The viewer shows the contents of the file supplied by the
+    # `filename` value.
+    #
+    # It returns the index of the button selected, or -1 if the file
+    # does not exist or if the widget was exited early.
+    def view_file(title, filename, buttons)
+
+      info = []
+      result = 0
+
+      # Open the file and read the contents.
+      lines = RNDK.read_file(filename, info)
+
+      # If we couldn't read the file, return an error.
+      if lines == -1
+        result = lines
+      else
+        result = self.view_info(title,
+                                info,
+                                buttons,
+                                true)
+      end
+      result
+    end
+
+    # Displays a file-selection dialog with `title`.
+    #
+    # @return The selected filename, or `nil` if none was selected.
+    #
+    # TODO FIXME This widget is VERY buggy.
+    #
+    def select_file title
+
+      fselect = RNDK::FSELECT.new(self,
+                                  RNDK::CENTER,
+                                  RNDK::CENTER,
+                                  -4,
+                                  -20,
+                                  title,
+                                  'File: ',
+                                  Ncurses::A_NORMAL,
+                                  '_',
+                                  Ncurses::A_REVERSE,
+                                  '</5>',
+                                  '</48>',
+                                  '</N>',
+                                  '</N>',
+                                  true,
+                                  false)
+
+      filename = fselect.activate([])
+
+      # Check the way the user exited the selector.
+      if fselect.exit_type != :NORMAL
+        fselect.destroy
+        self.refresh
+        return nil
+      end
+
+      # Otherwise...
+      fselect.destroy
+      self.refresh
+      filename
+    end
+
+    # Display a scrollable `list` of strings in a Dialog, allowing
+    # the user to select one.
+    #
+    # @return The index in the list of the value selected.
+    #
+    # If `numbers` is true, the displayed list items will
+    # be numbered.
+    #
+    # @note `list` must be Arrays of Strings.
+    def get_list_index(title, list, numbers)
+      return nil if list.class != Array or list.empty?
+
+      selected = -1
+      height = 10
+      width = -1
+      len = 0
+
+      # Determine the height of the list.
+      if list.size < 10
+        height = list.size + if title.size == 0 then 2 else 3 end
+      end
+
+      # Determine the width of the list.
+      list.each { |item| width = [width, item.size + 10].max }
+
+      width = [width, title.size].max
+      width += 5
+
+      scrollp = RNDK::SCROLL.new(self,
+                                 RNDK::CENTER,
+                                 RNDK::CENTER,
+                                 RNDK::RIGHT,
+                                 height,
+                                 width,
+                                 title,
+                                 list,
+                                 list.size,
+                                 numbers,
+                                 Ncurses::A_REVERSE,
+                                 true,
+                                 false)
+      if scrollp.nil?
+        self.refresh
+        return -1
+      end
+
+      selected = scrollp.activate([])
+
+      # Check how they exited.
+      if scrollp.exit_type != :NORMAL
+        selected = -1
+      end
+
+      scrollp.destroy
+      self.refresh
+
+      selected
+    end
+
+    # Pops up an Entry Widget and returns the value supplied
+    # by the user.
+    #
+    # `title`, `label` and `initial_value` are passed to the Widget.
+    def get_string(title, label, initial_value="")
+
+      widget = RNDK::ENTRY.new(self,
+                               RNDK::CENTER,
+                               RNDK::CENTER,
+                               title,
+                               label,
+                               Ncurses::A_NORMAL,
+                               '.',
+                               :MIXED,
+                               40,
+                               0,
+                               5000,
+                               true,
+                               false)
+
+      widget.setValue(initial_value)
+
+      value = widget.activate([])
+
+      # Make sure they exited normally.
+      if widget.exit_type != :NORMAL
+        widget.destroy
+        return nil
+      end
+
+      # Return a copy of the string typed in.
+      value = widget.getValue.clone
+      widget.destroy
+
+      value
+    end
   end
 end
 

data/lib/rndk/core/screen.rb

@@ -1,3 +1,4 @@
+require 'rndk/core/quick_widgets'
 
 module RNDK
 
@@ -8,10 +9,10 @@ module RNDK
   #
   # The only methods you should worry about are:
   #
-  # * #initialize
-  # * #end_rndk
-  # * #draw or #refresh
-  # * #erase
+  # * Screen#initialize
+  # * Screen#end_rndk
+  # * Screen#draw or #refresh
+  # * Screen#erase
   #
   # ## Developer Notes
   #
@@ -27,6 +28,16 @@ module RNDK
     EXITOK     = 1
     EXITCANCEL = 2
 
+    # Returns the whole terminal screen width.
+    def self.width
+      Ncurses.COLS
+    end
+
+    # Returns the whole terminal screen height.
+    def self.height
+      Ncurses.LINES
+    end
+
     # Takes a Ncurses `WINDOW*` pointer and creates a CDKScreen.
     #
     # This also starts Ncurses, if it wasn't started before or
@@ -173,16 +184,6 @@ module RNDK
       end
     end
 
-    # Refresh a raw Ncurses window.
-    #
-    # FIXME(original): this should be rewritten to use the panel library, so
-    # it would not be necessary to touch the window to ensure that it covers
-    # other windows.
-    def self.refresh_window win
-      Ncurses.touchwin win
-      Ncurses.wrefresh win
-    end
-
     # Redraws all Widgets inside this Screen.
     def draw
       self.refresh
@@ -193,7 +194,7 @@ module RNDK
       focused = -1
       visible = -1
 
-      RNDK::Screen.refresh_window(@window)
+      RNDK.window_refresh(@window)
 
       # We erase all the invisible objects, then only draw it all back, so
       # that the objects can overlap, and the visible ones will always be
@@ -265,5 +266,3 @@ module RNDK
   end
 end
 
-require 'rndk/core/quick_widgets'
-

data/lib/rndk/core/utils.rb

@@ -0,0 +1,143 @@
+# Utility functions - misc things.
+
+module RNDK
+
+  # Number of digits `value` has when represented as a String.
+  def RNDK.intlen value
+    value.to_str.size
+  end
+
+  # Opens the current directory and reads the contents.
+  def RNDK.getDirectoryContents(directory, list)
+    counter = 0
+
+    Dir.foreach(directory) do |filename|
+      next if filename == '.'
+      list << filename
+    end
+
+    list.sort!
+    return list.size
+  end
+
+  # This looks for a subset of a word in the given list
+  def RNDK.searchList(list, list_size, pattern)
+    index = -1
+
+    if pattern.size > 0
+      (0...list_size).each do |x|
+        len = [list[x].size, pattern.size].min
+        ret = (list[x][0...len] <=> pattern)
+
+        # If 'ret' is less than 0 then the current word is alphabetically
+        # less than the provided word.  At this point we will set the index
+        # to the current position.  If 'ret' is greater than 0, then the
+        # current word is alphabetically greater than the given word. We
+        # should return with index, which might contain the last best match.
+        # If they are equal then we've found it.
+        if ret < 0
+          index = ret
+        else
+          if ret == 0
+            index = x
+          end
+          break
+        end
+      end
+    end
+    return index
+  end
+
+  # This function checks to see if a link has been requested
+  def RNDK.checkForLink (line, filename)
+    f_pos = 0
+    x = 3
+    if line.nil?
+      return -1
+    end
+
+    # Strip out the filename.
+    if line[0] == L_MARKER && line[1] == 'F' && line[2] == '='
+      while x < line.size
+        if line[x] == R_MARKER
+          break
+        end
+        if f_pos < RNDK_PATHMAX
+          filename << line[x]
+          f_pos += 1
+        end
+        x += 1
+      end
+    end
+    return f_pos != 0
+  end
+
+  # Returns the filename portion of the given pathname, i.e.
+  # after the last slash.
+  #
+  # For now this function is just a wrapper for `File.basename`,
+  # being kept for portability.
+  def RNDK.baseName (pathname)
+    File.basename(pathname)
+  end
+
+  # Returns the directory for the given pathname, i.e. the part before the
+  # last slash
+  # For now this function is just a wrapper for File.dirname kept for ease of
+  # porting and will be completely replaced in the future
+  def RNDK.dirName (pathname)
+    File.dirname(pathname)
+  end
+
+  # 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)
+    # If the user passed in FULL, return the parents size
+    if proposed_dim == FULL or proposed_dim == 0
+      parent_dim
+    elsif proposed_dim >= 0
+      # if they gave a positive value, return it
+
+      if proposed_dim >= parent_dim
+        parent_dim
+      else
+        proposed_dim + adjustment
+      end
+    else
+      # if they gave a negative value then return the dimension
+      # of the parent plus the value given
+      #
+      if parent_dim + proposed_dim < 0
+        parent_dim
+      else
+        parent_dim + proposed_dim
+      end
+    end
+  end
+
+  # Reads a file and concatenate it's lines into `array`.
+  #
+  # @note The lines don't end with '\n'.
+  def RNDK.read_file(filename, array)
+    begin
+      fd = File.new(filename, "r")
+    rescue
+      return nil
+    end
+
+    lines = fd.readlines.map do |line|
+      if line.size > 0 && line[-1] == "\n"
+        line[0...-1]
+      else
+        line
+      end
+    end
+
+    array.concat lines
+    fd.close
+    array.size
+  end
+
+end
+