riel 1.1.12 → 1.1.13

data/lib/riel/text/highlight.rb

@@ -0,0 +1,130 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+module Text
+  # Highlights text using either ANSI terminal codes, or HTML.
+
+  # Note that the foreground and background sections can have modifiers
+  # (attributes).
+  # 
+  # Examples:
+  #     black
+  #     blue on white
+  #     bold green on yellow
+  #     underscore bold magenta on cyan
+  #     underscore red on cyan
+  
+  class Highlighter
+    VERSION = "1.0.4"
+    
+    COLORS      = %w{ black red green yellow blue magenta cyan white }
+    DECORATIONS = %w{ none reset bold underscore underline blink negative concealed }
+
+    BACKGROUND_COLORS = COLORS.collect { |color| "on_#{color}" }
+    FOREGROUND_COLORS = COLORS
+
+    COLORS_RE = Regexp.new('(?: ' + 
+                                # background will be in capture 0
+                                'on(?:\s+|_) ( ' + COLORS.join(' | ') + ' ) | ' +
+                                # foreground will be in capture 1
+                                '( ' + (COLORS + DECORATIONS).join(' | ') + ' ) ' +
+                            ')', Regexp::EXTENDED);
+
+    DEFAULT_COLORS = [
+      "black on yellow",
+      "black on green",
+      "black on magenta",
+      "yellow on black",
+      "magenta on black",
+      "green on black",
+      "cyan on black",
+      "blue on yellow",
+      "blue on magenta",
+      "blue on green",
+      "blue on cyan",
+      "yellow on blue",
+      "magenta on blue",
+      "green on blue",
+      "cyan on blue",
+    ]
+
+    attr_reader :colors
+    
+    def parse_colors str
+      str.scan(Regexp.new(COLORS_RE)).collect do |color|
+        color[0] ? "on_" + color[0] : color[1]
+      end
+    end
+
+    # returns a list of all color combinations.
+    def self.all_colors
+      all_colors = Array.new
+      ([ nil ] + DECORATIONS).each do |dec|
+        ([ nil ] + FOREGROUND_COLORS).each do |fg|
+          ([ nil ] + BACKGROUND_COLORS).each do |bg|
+            name = [ dec, fg, bg ].compact.join("_")
+            all_colors << name if name && name.length > 0
+          end
+        end
+      end
+      all_colors
+    end
+    
+    def highlight str
+      # implemented by subclasses
+    end
+
+    # Colorizes the given object. If a block is passed, its return value is used
+    # and the stream is reset. If a String is provided as the object, it is
+    # colorized and the stream is reset. Otherwise, only the code for the given
+    # color name is returned.
+    
+    def color colorstr, obj = nil, &blk
+      colornames = parse_colors colorstr
+      result = names_to_code colornames
+      
+      if blk
+        result << blk.call
+      elsif obj.respond_to? :to_s
+        result << obj.to_s
+      end
+      result << names_to_code("reset")
+      result
+    end
+
+    # returns the code for the given color string, which is in the format:
+    # foreground* [on background]?
+    # 
+    # Note that the foreground and background sections can have modifiers
+    # (attributes).
+    # 
+    # Examples:
+    #     black
+    #     blue on white
+    #     bold green on yellow
+    #     underscore bold magenta on cyan
+    #     underscore red on cyan
+    def code str
+      fg, bg = str.split(/\s*\bon_?\s*/)
+      (fg ? foreground(fg) : "") + (bg ? background(bg) : "")
+    end
+
+    # Returns the code for the given background color(s).
+    def background bgcolor
+      names_to_code "on_" + bgcolor
+    end
+
+    # Returns the code for the given foreground color(s).
+    def foreground fgcolor
+      fgcolor.split(/\s+/).collect { |fg| names_to_code fg }.join("")
+    end
+  
+    # Returns a highlighted (colored) version of the string, applying the regular
+    # expressions in the array, which are paired with the desired color.
+    def gsub str, re, color
+      str.gsub(re) do |match|
+        self.color color, match
+      end
+    end
+  end
+end

data/lib/riel/text/highlightable.rb

@@ -0,0 +1,85 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'riel/text/highlight'
+require 'riel/text/ansi/ansi_highlight'
+require 'riel/text/html_highlight'
+require 'riel/text/non_highlight'
+
+module Text
+  # An object that can be highlighted. This is used by the String class.
+  module Highlightable
+    # The highlighter for the class in which this module is included.
+    @@highlighter = ANSIHighlighter.instance
+
+    # this dynamically adds methods for individual colors.
+    def method_missing(meth, *args, &blk)
+      if has_color? meth.to_s
+        methdecl = Array.new
+        methdecl << "def #{meth}(&blk);"
+        methdecl << "  @@highlighter.color(\"#{meth}\", self, &blk);"
+        methdecl << "end"
+        self.class.class_eval methdecl.join("\n")
+        send meth, *args, &blk
+      elsif Text::ANSIHighlighter.instance.has_alias? meth
+        methdecl = Array.new
+        methdecl << "def #{meth}(&blk);"
+        methdecl << "  @@highlighter.#{meth}(self, &blk);"
+        methdecl << "end"
+        self.class.class_eval methdecl.join("\n")
+        send meth, *args, &blk
+      else
+        super
+      end
+    end
+
+    def respond_to? meth
+      has_color?(meth.to_s) || Text::ANSIHighlighter.instance.has_alias?(meth) || super
+    end
+
+    def has_color? color
+      Text::Highlighter::all_colors.include? color
+    end
+
+    # Sets the highlighter for this class. This can be either by type or by
+    # String.
+    def highlighter= hl
+      @@highlighter = case hl
+                      when Text::Highlighter
+                        hl
+                      when :none, "NONE", nil
+                        Text::NonHighlighter.new
+                      when :html, "HTML"
+                        Text::HTMLHighlighter.new
+                      when :ansi, "ANSI"
+                        Text::ANSIHighlighter.instance
+                      else
+                        Text::NonHighlighter.new
+                      end
+      
+    end
+
+    def rgb red, green, blue
+      @@highlighter.rgb self, red, green, blue
+    end
+
+    def on_rgb red, green, blue
+      @@highlighter.on_rgb self, red, green, blue
+    end
+
+    def grey value
+      @@highlighter.grey self, value
+    end
+
+    def on_grey value
+      @@highlighter.on_grey self, value
+    end
+
+    alias_method :gray, :grey
+    alias_method :on_gray, :on_grey
+
+    def self.add_to cls
+      cls.send :include, Text::Highlightable
+    end
+  end
+end

data/lib/riel/text/html_highlight.rb

@@ -0,0 +1,98 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'riel/text/highlight'
+
+module Text
+  # Highlights using HTML. Fonts are highlighted using <span> tags, not <font>.
+  # Also note that negative is translated to white on black.
+  # According to http://www.w3.org/TR/REC-CSS2/syndata.html#value-def-color,
+  # valid color keywords are: aqua, black, blue, fuchsia, gray, green, lime,
+  # maroon, navy, olive, purple, red, silver, teal, white, and yellow.
+  # Thus, no magenta or cyan.
+
+  class HTMLHighlighter < Highlighter
+    def initialize
+      # we need to know what we're resetting from (bold, font, underlined ...)
+      @stack = []
+    end
+
+    # Returns the start tag for the given name.
+    
+    def start_style name
+      case name
+      when "negative"
+        "<span style=\"color: white; background-color: black\">"
+      when /on_(\w+)/
+        colval = color_value $1
+        "<span style=\"background-color: #{colval}\">"
+      else
+        colval = color_value name
+        "<span style=\"color: #{colval}\">"
+      end
+    end
+
+    # Returns the end tag ("</span>").
+
+    def end_style
+      "</span>"
+    end
+
+    def color_value cname
+      case cname
+      when "cyan"
+        "#00FFFF"
+      when "magenta"
+        "#FF00FF"
+      else
+        cname
+      end
+    end
+
+    # Returns the code for the given name.
+    def names_to_code names
+      str = ""
+
+      names = [ names ] unless names.kind_of? Array
+
+      names.each do |name|
+        @stack << name
+
+        case name
+        when "none", "reset"
+          @stack.pop
+          if @stack.length > 0
+            begin
+              prev = @stack.pop
+              case prev
+              when "bold"
+                str << "</b>"
+              when "underscore", "underline"
+                str << "</u>"
+              when "blink"
+                str << "</blink>"
+              when "concealed"
+                str << " -->"
+              else
+                str << end_style
+              end
+            end while @stack.length > 0
+          end
+          str
+        when "bold"
+          str << "<b>"
+        when "underscore", "underline"
+          str << "<u>"
+        when "blink"
+          str << "<blink>"
+        when "concealed"
+          str << "<!-- "
+        else
+          str << start_style(name)
+        end
+      end
+
+      str
+    end
+  end
+end

data/lib/riel/text/non_highlight.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'riel/text/highlight'
+
+module Text
+  # Does no highlighting.
+  class NonHighlighter < Highlighter
+    def initialize
+      super nil
+    end
+
+    def names_to_code colorname
+      ""
+    end
+  end
+end

data/lib/riel/text/string.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'riel/text/highlightable'
+
+# String is extended to support highlighting.
+class String
+  include Text::Highlightable
+  extend Text::Highlightable
+end