rndk 0.0.1 → 0.1.0

data/lib/rndk/core/color.rb

@@ -0,0 +1,136 @@
+
+module RNDK
+
+  # The colors that we can print text with.
+  #
+  # Internally we call Colors attributes - or attribs.
+  #
+  # ## Usage
+  #
+  # First of all, you should call Color#init. If your terminal
+  # doesn't support colors (come on, at 2010s?) Colors#has_colors?
+  # will tell.
+  #
+  # All Widgets that have an `attrib` argument can use a Color.
+  # You call them like this:
+  #
+  #     color = RNDK::Color[:foreground_background]
+  #
+  # If you want to use your terminal's current default
+  # background/foreground, use:
+  #
+  #     color = RNDK::Color[:default_background]
+  #     color = RNDK::Color[:foreground]
+  #
+  # ## Examples
+  #
+  #     wb  = Color[:white_black]
+  #     gm  = Color[:green_magenta]
+  #     red = Color[:red]
+  #     bl  = Color[:default_black]
+  #
+  # ## Developer Notes
+  #
+  # Color#init creates 80 color pairs.
+  #
+  module Color
+
+    # All possible colors on format `:foreground_background`.
+    #
+    # When `background` is not specified, it's the current
+    # terminal's default.
+    #
+    # They're defined on Color#init.
+    @@colors = {}
+
+    # Start support for colors, initializing all color pairs.
+    def self.init
+      return unless self.has_colors?
+
+      Ncurses.start_color
+
+      # Will be able to use current terminal's
+      # background color (value -1)
+      Ncurses.use_default_colors
+
+      # We will initialize 80 color pairs with all
+      # combinations from the current Array.
+      #
+      # They'll have symbols with their names.
+      # For example:
+      #     Color[:white_black]
+      #     Color[:green_magenta]
+      color = [[Ncurses::COLOR_WHITE,   :white],
+               [Ncurses::COLOR_RED,     :red],
+               [Ncurses::COLOR_GREEN,   :green],
+               [Ncurses::COLOR_YELLOW,  :yellow],
+               [Ncurses::COLOR_BLUE,    :blue],
+               [Ncurses::COLOR_MAGENTA, :magenta],
+               [Ncurses::COLOR_CYAN,    :cyan],
+               [Ncurses::COLOR_BLACK,   :black]]
+
+      limit = if Ncurses.COLORS < 8
+              then Ncurses.COLORS
+              else 8
+              end
+
+      pair = 1
+      # Create the color pairs
+      (0...limit).each do |fg|
+        (0...limit).each do |bg|
+          Ncurses.init_pair(pair, color[fg][0], color[bg][0])
+
+          label = "#{color[fg][1]}_#{color[bg][1]}".to_sym
+          @@colors[label] = pair
+          pair += 1
+        end
+      end
+
+      # The color pairs with default background and foreground.
+      #
+      # They'll have symbols with their names and 'default'
+      # where the default color is.
+      # For example:
+      #     Color[:default_black]
+      #     Color[:magenta]
+      color.each do |bg|
+        Ncurses.init_pair(pair, -1, bg[0])
+
+        label = "default_#{bg[1]}".to_sym
+        @@colors[label] = pair
+        pair += 1
+      end
+      color.each do |fg|
+        Ncurses.init_pair(pair, fg[0], -1)
+
+        label = "#{fg[1]}".to_sym
+        @@colors[label] = pair
+        pair += 1
+      end
+    end
+
+    # Tells if the current terminal supports colors.
+    #
+    # Unless you've been living under a rock, this
+    # shouldn't be of any concern.
+    def self.has_colors?
+      Ncurses.has_colors
+    end
+
+    # Access individual color pairs.
+    #
+    # If colors were not initialized, 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
+
+      Ncurses.COLOR_PAIR @@colors[label]
+    end
+
+  end
+end
+

data/lib/rndk/core/display.rb

@@ -1,7 +1,12 @@
+
 module RNDK
+
+  # ...I still don't know what this module does...
+  #
   module Display
+
     # Given a string, returns the equivalent display type
-    def Display.char2DisplayType(string)
+    def Display.char_to_display_type string
       table = {
         "CHAR"     => :CHAR,
         "HCHAR"    => :HCHAR,
@@ -29,7 +34,7 @@ module RNDK
     end
 
     # Tell if a display type is "hidden"
-    def Display.isHiddenDisplayType(type)
+    def Display.is_hidden_display_type type
       case type
       when :HCHAR, :HINT, :HMIXED, :LHCHAR, :LHMIXED, :UHCHAR, :UHMIXED
         true
@@ -39,25 +44,31 @@ module RNDK
       end
     end
 
-    # Given a character input, check if it is allowed by the display type
-    # and return the character to apply to the display, or ERR if not
-    def Display.filterByDisplayType(type, input)
+    # Given a character input, check if it is allowed by the
+    # display type and return the character to apply to the display,
+    # or ERR if not.
+    def Display.filter_by_display_type(type, input)
       result = input
-      if !RNDK.isChar(input)
+      if not RNDK.is_char? input
         result = Ncurses::ERR
-      elsif [:INT, :HINT].include?(type) && !RNDK.digit?(result.chr)
+
+      elsif ([:INT, :HINT].include? type) and (not RNDK.digit? result.chr)
         result = Ncurses::ERR
-      elsif [:CHAR, :UCHAR, :LCHAR, :UHCHAR, :LHCHAR].include?(type) && RNDK.digit?(result.chr)
+
+      elsif ([:CHAR, :UCHAR, :LCHAR, :UHCHAR, :LHCHAR].include? type) and (RNDK.digit? result.chr)
         result = Ncurses::ERR
+
       elsif type == :VIEWONLY
         result = ERR
-      elsif [:UCHAR, :UHCHAR, :UMIXED, :UHMIXED].include?(type) && RNDK.alpha?(result.chr)
+
+      elsif ([:UCHAR, :UHCHAR, :UMIXED, :UHMIXED].include? type) and (RNDK.is_alpha? result.chr)
         result = result.chr.upcase.ord
-      elsif [:LCHAR, :LHCHAR, :LMIXED, :LHMIXED].include?(type) && RNDK.alpha?(result.chr)
+
+      elsif ([:LCHAR, :LHCHAR, :LMIXED, :LHMIXED].include? type) and (RNDK.is_alpha? result.chr)
         result = result.chr.downcase.ord
       end
-
-      return result
+      result
     end
+
   end
 end

data/lib/rndk/core/draw.rb

@@ -1,31 +1,37 @@
+
 module RNDK
+
   module Draw
-    # This sets up a basic set of color pairs. These can be redefined if wanted
-    def Draw.initRNDKColor
-      color = [Ncurses::COLOR_WHITE,
-               Ncurses::COLOR_RED,
-               Ncurses::COLOR_GREEN,
-               Ncurses::COLOR_YELLOW,
-               Ncurses::COLOR_BLUE,
-               Ncurses::COLOR_MAGENTA,
-               Ncurses::COLOR_CYAN,
-               Ncurses::COLOR_BLACK]
-      pair = 1
-
-      if Ncurses.has_colors
-        # XXX: Only checks if terminal has colours not if colours are started
-        Ncurses.start_color
-        limit = if Ncurses.COLORS < 8 then Ncurses.COLORS else 8 end
-
-        # Create the color pairs
-        (0...limit).each do |fg|
-          (0...limit).each do |bg|
-            Ncurses.init_pair(pair, color[fg], color[bg])
-            pair += 1
-          end
-        end
-      end
-    end
+    # # This sets up a basic set of color pairs.
+    # # These can be redefined if wanted
+    # def Draw.initRNDKColor
+    #   color = [Ncurses::COLOR_WHITE,
+    #            Ncurses::COLOR_RED,
+    #            Ncurses::COLOR_GREEN,
+    #            Ncurses::COLOR_YELLOW,
+    #            Ncurses::COLOR_BLUE,
+    #            Ncurses::COLOR_MAGENTA,
+    #            Ncurses::COLOR_CYAN,
+    #            Ncurses::COLOR_BLACK]
+    #   pair = 1
+
+    #   if Ncurses.has_colors
+    #     # XXX: Only checks if terminal has colours not if colours are started
+    #     Ncurses.start_color
+    #     limit = if Ncurses.COLORS < 8
+    #             then Ncurses.COLORS
+    #             else 8
+    #             end
+
+    #     # Create the color pairs
+    #     (0...limit).each do |fg|
+    #       (0...limit).each do |bg|
+    #         Ncurses.init_pair(pair, color[fg], color[bg])
+    #         pair += 1
+    #       end
+    #     end
+    #   end
+    # end
 
     # This prints out a box around a window with attributes
     def Draw.boxWindow(window, attr)