rndk 0.2.0 → 1.0.0

data/lib/rndk/core/color.rb

@@ -22,16 +22,42 @@ module RNDK
   #     color = RNDK::Color[:default_background]
   #     color = RNDK::Color[:foreground]
   #
+  # Also, there are special color modifiers. They change how
+  # the color appears and can make some interesting effects:
+  #
+  # * RNDK::Color[:normal]
+  # * RNDK::Color[:bold]
+  # * RNDK::Color[:reverse]
+  # * RNDK::Color[:underline]
+  # * RNDK::Color[:blink]
+  # * RNDK::Color[:dim]
+  # * RNDK::Color[:invisible]
+  # * RNDK::Color[:standout]
+  #
+  # To apply them, "add" to the regular colors with the
+  # pipe ('|'):
+  #
+  #     color = RNDK::Color[:red] | RNDK::Color[:bold]
+  #
   # ## Examples
   #
-  #     wb  = Color[:white_black]
-  #     gm  = Color[:green_magenta]
-  #     red = Color[:red]
-  #     bl  = Color[:default_black]
+  #```
+  # wb  = Color[:white_black]
+  # gm  = Color[:green_magenta]
+  # red = Color[:red]
+  # bl  = Color[:default_black]
+  # x   = RNDK::Color[:blue_yellow] | RNDK::Color[:reverse] # guess what?
+  # y   = RNDK::Color[:cyan] | RNDK::Color[:invisible] # opps
+  #```
   #
   # ## Developer Notes
   #
-  # Color#init creates 80 color pairs.
+  # Color#init creates 80 color pairs. Neat!
+  #
+  # Also, to extract attributes from a chtype (mix between
+  # characters and ncurses colors) use
+  #
+  #     chtype & RNDK::Color[:extract]
   #
   module Color
 
@@ -43,6 +69,27 @@ module RNDK
     # They're defined on Color#init.
     @@colors = {}
 
+    # These special attributes exist even if no color
+    # were initialized.
+    #
+    # They modify the way colors show on the screen.
+
+    @@attributes = {
+      :normal    => Ncurses::A_NORMAL,
+      :bold      => Ncurses::A_BOLD,
+      :reverse   => Ncurses::A_REVERSE,
+      :underline => Ncurses::A_UNDERLINE,
+      :blink     => Ncurses::A_BLINK,
+      :dim       => Ncurses::A_DIM,
+      :invisible => Ncurses::A_INVIS,
+      :standout  => Ncurses::A_STANDOUT,
+
+      # To extract attributes from a chtype (mix between
+      # characters and ncurses colors) use
+      # `chtype & RNDK::Color[:extract]
+      :extract   => Ncurses::A_ATTRIBUTES
+    }
+
     # Start support for colors, initializing all color pairs.
     def self.init
       return unless self.has_colors?
@@ -117,18 +164,21 @@ module RNDK
       Ncurses.has_colors
     end
 
-    # Access individual color pairs.
+    # Access individual color pairs or attributes.
     #
-    # If colors were not initialized, returns white foreground
-    # over default background.
+    # If colors were not initialized and user request colors,
+    # returns **white foreground over default background**.
     #
-    # @return Ncurses `COLOR_PAIR` over `label` color.
     def self.[] label
-      unless @@colors.include? label
-        return Ncurses.COLOR_PAIR(0)
-      end
+      if @@attributes.include? label
+        @@attributes[label]
 
-      Ncurses.COLOR_PAIR @@colors[label]
+      elsif @@colors.include? label
+        Ncurses.COLOR_PAIR @@colors[label]
+
+      else
+        Ncurses.COLOR_PAIR 0
+      end
     end
 
   end

data/lib/rndk/core/display.rb

@@ -26,7 +26,7 @@ module RNDK
         0          => :INVALID
       }
 
-      if table.include?(string)
+      if table.include? string
         table[string]
       else
         :INVALID

data/lib/rndk/core/draw.rb

@@ -71,12 +71,12 @@ module RNDK
       end
     end
 
-    # Draw a box around the given window using the object's defined
+    # Draw a box around the given window using the widget's defined
     # line-drawing characters
-    def Draw.drawObjBox(win, object)
+    def Draw.drawObjBox(win, widget)
       Draw.attrbox(win,
-          object.ULChar, object.URChar, object.LLChar, object.LRChar,
-          object.HZChar, object.VTChar, object.BXAttr)
+          widget.ULChar, widget.URChar, widget.LLChar, widget.LRChar,
+          widget.HZChar, widget.VTChar, widget.BXAttr)
     end
 
     # This draws a line on the given window. (odd angle lines not working yet)
@@ -135,14 +135,14 @@ module RNDK
         y_hi = Ncurses.getmaxy(shadow_win) - 1
 
         # Draw the line on the bottom.
-        Ncurses.mvwhline(shadow_win, y_hi, 1, Ncurses::ACS_HLINE | Ncurses::A_DIM, x_hi)
+        Ncurses.mvwhline(shadow_win, y_hi, 1, Ncurses::ACS_HLINE | RNDK::Color[:dim], x_hi)
 
         # Draw the line on teh right.
-        Ncurses.mvwvline(shadow_win, 0, x_hi, Ncurses::ACS_VLINE | Ncurses::A_DIM, y_hi)
+        Ncurses.mvwvline(shadow_win, 0, x_hi, Ncurses::ACS_VLINE | RNDK::Color[:dim], y_hi)
 
-        Ncurses.mvwaddch(shadow_win, 0, x_hi, Ncurses::ACS_URCORNER | Ncurses::A_DIM)
-        Ncurses.mvwaddch(shadow_win, y_hi, 0, Ncurses::ACS_LLCORNER | Ncurses::A_DIM)
-        Ncurses.mvwaddch(shadow_win, y_hi, x_hi, Ncurses::ACS_LRCORNER | Ncurses::A_DIM)
+        Ncurses.mvwaddch(shadow_win, 0, x_hi, Ncurses::ACS_URCORNER | RNDK::Color[:dim])
+        Ncurses.mvwaddch(shadow_win, y_hi, 0, Ncurses::ACS_LLCORNER | RNDK::Color[:dim])
+        Ncurses.mvwaddch(shadow_win, y_hi, x_hi, Ncurses::ACS_LRCORNER | RNDK::Color[:dim])
         Ncurses.wrefresh shadow_win
       end
     end
@@ -160,7 +160,7 @@ module RNDK
 
     # This writes out a char string with no attributes
     def Draw.writeChar(window, xpos, ypos, string, align, start, endn)
-      Draw.writeCharAttrib(window, xpos, ypos, string, Ncurses::A_NORMAL,
+      Draw.writeCharAttrib(window, xpos, ypos, string, RNDK::Color[:normal],
           align, start, endn)
     end
 
@@ -186,7 +186,7 @@ module RNDK
 
     # This writes out a chtype string
     def Draw.writeChtype (window, xpos, ypos, string, align, start, endn)
-      Draw.writeChtypeAttrib(window, xpos, ypos, string, Ncurses::A_NORMAL,
+      Draw.writeChtypeAttrib(window, xpos, ypos, string, RNDK::Color[:normal],
           align, start, endn)
     end
 

data/lib/rndk/core/markup.rb

@@ -150,6 +150,10 @@
 
 module RNDK
 
+  def RNDK.char_of chtype
+    (chtype.ord & 255).chr
+  end
+
   # Takes a String full of format markers and translates it
   # into a chtype array.
   #
@@ -166,7 +170,7 @@ module RNDK
       # The original code makes two passes since it has to pre-allocate space but
       # we should be able to make do with one since we can dynamically size it
       adjust = 0
-      attrib = Ncurses::A_NORMAL
+      attrib = RNDK::Color[:normal]
       last_char = 0
       start = 0
       used = 0
@@ -188,7 +192,7 @@ module RNDK
 
           # Pull out the bullet marker.
           while x < string.size and string[x] != R_MARKER
-            result << (string[x].ord | Ncurses::A_BOLD)
+            result << (string[x].ord | RNDK::Color[:bold])
             x += 1
           end
           adjust = 1
@@ -386,10 +390,6 @@ module RNDK
     end
   end
 
-  def RNDK.CharOf chtype
-    (chtype.ord & 255).chr
-  end
-
   # This returns a string from a chtype array
   # Formatting codes are omitted.
   def RNDK.chtype2Char(string)
@@ -397,7 +397,7 @@ module RNDK
 
     unless string.nil?
       string.each do |char|
-        newstring << RNDK.CharOf(char)
+        newstring << RNDK.char_of(char)
       end
     end
 
@@ -448,17 +448,17 @@ module RNDK
     mask << 0
     case string[from + 1]
     when 'B'
-      mask[0] = Ncurses::A_BOLD
+      mask[0] = RNDK::Color[:bold]
     when 'D'
-      mask[0] = Ncurses::A_DIM
+      mask[0] = RNDK::Color[:dim]
     when 'K'
-      mask[0] = Ncurses::A_BLINK
+      mask[0] = RNDK::Color[:blink]
     when 'R'
-      mask[0] = Ncurses::A_REVERSE
+      mask[0] = RNDK::Color[:reverse]
     when 'S'
-      mask[0] = Ncurses::A_STANDOUT
+      mask[0] = RNDK::Color[:standout]
     when 'U'
-      mask[0] = Ncurses::A_UNDERLINE
+      mask[0] = RNDK::Color[:underline]
     end
 
     if mask[0] != 0
@@ -494,19 +494,19 @@ module RNDK
   # Also, alignment markers and tabs are lost.
   def RNDK.decodeAttribute (string, from, oldattr, newattr)
     table = {
-      'B' => Ncurses::A_BOLD,
-      'D' => Ncurses::A_DIM,
-      'K' => Ncurses::A_BLINK,
-      'R' => Ncurses::A_REVERSE,
-      'S' => Ncurses::A_STANDOUT,
-      'U' => Ncurses::A_UNDERLINE
+      'B' => RNDK::Color[:bold],
+      'D' => RNDK::Color[:dim],
+      'K' => RNDK::Color[:blink],
+      'R' => RNDK::Color[:reverse],
+      'S' => RNDK::Color[:standout],
+      'U' => RNDK::Color[:underline]
     }
 
     result = if string.nil? then '' else string end
     base_len = result.size
-    tmpattr = oldattr & Ncurses::A_ATTRIBUTES
+    tmpattr = oldattr & RNDK::Color[:extract]
 
-    newattr &= Ncurses::A_ATTRIBUTES
+    newattr &= RNDK::Color[:extract]
     if tmpattr != newattr
       while tmpattr != newattr
         found = false

data/lib/rndk/core/quick_widgets.rb

@@ -7,9 +7,9 @@
 #
 # For example:
 #
-#     rndkscreen = RNDK::Screen.new
+#     screen = RNDK::Screen.new
 #     message = ["awesome quick label!"]
-#     rndkscreen.popup_label message
+#     screen.popup_label message
 #
 
 # Since I'm including a lot of widgets here, maybe I
@@ -44,17 +44,19 @@ module RNDK
     # Creates a centered pop-up Label Widget that
     # waits until the user hits a character.
     #
-    # @note: `message` must be an array of strings.
+    # @note: `message` must be a String or an Array of Strings.
     def popup_label message
-      return if message.class != Array or message.empty?
-
       self.cleanly do
-        popup = RNDK::Label.new(self, CENTER, CENTER, message, true, false)
-        popup.draw(true)
+        popup = RNDK::Label.new(self, {
+                                  :x => RNDK::CENTER,
+                                  :y => RNDK::CENTER,
+                                  :text => message
+                                })
+        popup.draw
 
         # Wait for some input.
         Ncurses.keypad(popup.win, true)
-        popup.getch([])
+        popup.getch
         popup.destroy
       end
     end
@@ -63,18 +65,20 @@ module RNDK
     # the background of the dialog.
     #
     # @note: `message` must be an array of strings.
-    def popup_label_attrib(message, attrib)
-      return if message.class != Array or message.empty?
-
+    def popup_label_color(message, attrib)
       self.cleanly do
-        popup = RNDK::Label.new(self, CENTER, CENTER, message, true, false)
-        popup.setBackgroundAttrib attrib
-        popup.draw(true)
+        popup = RNDK::Label.new(self, {
+                                  :x => RNDK::CENTER,
+                                  :y => RNDK::CENTER,
+                                  :text => message
+                                })
+
+        popup.set_bg_color attrib
+        popup.draw
 
         # Wait for some input
         Ncurses.keypad(popup.win, true)
-        popup.getch([])
-
+        popup.getch
         popup.destroy
       end
     end
@@ -87,22 +91,19 @@ module RNDK
     #
     # @note: `message` and `buttons` must be Arrays of Strings.
     def popup_dialog(message, buttons)
-      return nil if message.class != Array or message.empty?
-      return nil if buttons.class != Array or buttons.empty?
+      return nil if message.empty? or buttons.empty?
 
       choice = 0
       self.cleanly do
-        popup = RNDK::DIALOG.new(self,
-                                 RNDK::CENTER,
-                                 RNDK::CENTER,
-                                 message,
-                                 message.size,
-                                 buttons,
-                                 buttons.size,
-                                 Ncurses::A_REVERSE,
-                                 true, true, false)
-        popup.draw(true)
-        choice = popup.activate('')
+        popup = RNDK::Dialog.new(self, {
+                                   :x => RNDK::CENTER,
+                                   :y => RNDK::CENTER,
+                                   :text => message,
+                                   :buttons => buttons
+                                 })
+
+        popup.draw
+        choice = popup.activate
         popup.destroy
       end
       choice
@@ -124,27 +125,23 @@ module RNDK
       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)
+      viewer = RNDK::Viewer.new(self, {
+                                  :x => RNDK::CENTER,
+                                  :y => RNDK::CENTER,
+                                  :width => -6,
+                                  :height => -16,
+                                  :buttons => buttons,
+                                  :shadow => 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)
+      viewer.set({
+                   :title => title,
+                   :items => info,
+                   :hide_control_chars => hide_control_chars
+                 })
 
-      selected = viewer.activate([])
+      selected = viewer.activate
 
       # Make sure they exited normally.
       if viewer.exit_type != :NORMAL
@@ -172,7 +169,7 @@ module RNDK
       result = 0
 
       # Open the file and read the contents.
-      lines = RNDK.read_file(filename, info)
+      lines = RNDK.read_file filename
 
       # If we couldn't read the file, return an error.
       if lines == -1
@@ -194,24 +191,16 @@ module RNDK
     #
     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([])
+      fselect = RNDK::Fselect.new(self, {
+                                    :x => RNDK::CENTER,
+                                    :y => RNDK::CENTER,
+                                    :width =>-20,
+                                    :height => -4,
+                                    :title => title,
+                                    :label => 'File: '
+                                  })
+
+      filename = fselect.activate
 
       # Check the way the user exited the selector.
       if fselect.exit_type != :NORMAL
@@ -254,24 +243,21 @@ module RNDK
       width = [width, title.size].max
       width += 5
 
-      scrollp = RNDK::Scroll.new(self,
-                                 RNDK::CENTER,
-                                 RNDK::CENTER,
-                                 RNDK::RIGHT,
-                                 width,
-                                 height,
-                                 title,
-                                 list,
-                                 numbers,
-                                 Ncurses::A_REVERSE,
-                                 true,
-                                 false)
+      scrollp = RNDK::Scroll.new(self, {
+                                   :x => RNDK::CENTER,
+                                   :y => RNDK::CENTER,
+                                   :width => width,
+                                   :height => height,
+                                   :title => title,
+                                   :items => list,
+                                   :numbers => numbers
+                                 })
       if scrollp.nil?
         self.refresh
         return -1
       end
 
-      selected = scrollp.activate([])
+      selected = scrollp.activate
 
       # Check how they exited.
       if scrollp.exit_type != :NORMAL
@@ -290,23 +276,16 @@ module RNDK
     # `title`, `label` and `initial_text` are passed to the Widget.
     def get_string(title, label, initial_text="")
 
-      widget = RNDK::Entry.new(self,
-                               RNDK::CENTER,
-                               RNDK::CENTER,
-                               title,
-                               label,
-                               Ncurses::A_NORMAL,
-                               '.',
-                               :MIXED,
-                               40,
-                               0,
-                               5000,
-                               true,
-                               false)
-
-      widget.set_text(initial_text)
-
-      value = widget.activate([])
+      widget = RNDK::Entry.new(self, {
+                                 :x => RNDK::CENTER,
+                                 :y => RNDK::CENTER,
+                                 :title => title,
+                                 :label => label,
+                                 :field_width => 40,
+                                 :initial_text => initial_text
+                               })
+
+      value = widget.activate
 
       # Make sure they exited normally.
       if widget.exit_type != :NORMAL