tco 0.0.1 → 0.1.0

data/examples/tux.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "tco"
+require "rmagick"
+
+Magick::Image.read("tux.png")[0].each_pixel do |pixel, col, row|
+  c = [pixel.red, pixel.green, pixel.blue].map { |v| 255*(v/65535.0) }
+  print "  ".bg c
+  puts if col >= 53
+end

data/examples/union_jack.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+require "tco"
+
+flag = <<-EOS
+RRR    BBBBBBBBBB  RR  BBBBBBBBBB    RRR
+  RR     BBBBBBBB  RR  BBBBBBBB     RR  
+B   RR     BBBBBB  RR  BBBBBB     RR   B
+BBB   RR     BBBB  RR  BBBB     RR   BBB
+BBBBB   RR    BBB  RR  BBB    RR   BBBBB
+                   RR                   
+RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR
+                   RR                   
+BBBBB   RR    BBB  RR  BBB    RR   BBBBB
+BBB   RR     BBBB  RR  BBBB     RR   BBB
+B   RR     BBBBBB  RR  BBBBBB     RR   B
+  RR     BBBBBBBB  RR  BBBBBBBB     RR  
+RRR    BBBBBBBBBB  RR  BBBBBBBBBB    RRR
+EOS
+
+flag.split("").each do |c|
+  case c
+  when "R" then print " ".bg "#c9120a"
+  when "B" then print " ".bg "#10116d"
+  when " " then print " ".bg "#ffffff"
+  when "\n" then print "\n"
+  end
+end

data/lib/tco.rb

@@ -0,0 +1,173 @@
+# tco - terminal colouring application and library
+# Copyright (c) 2013, 2014 Radek Pazdera
+
+# MIT License
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require "tco/version"
+require "tco/config"
+require "tco/colouring"
+require "tco/style"
+require "tco/parser"
+
+module Tco
+  @config = Config.new ["/etc/tco.conf", "~/.tco.conf"]
+  @colouring = Colouring.new @config
+
+  def self.colour(fg, bg, string)
+    decorate string, Style.new(fg, bg)
+  end
+
+  def self.fg(colour, string)
+    decorate string, Style.new(colour)
+  end
+
+  def self.bg(colour, string)
+    decorate string, Style.new(nil, colour)
+  end
+
+  def self.bright(string)
+    decorate string, Style.new(nil, nil, true, false)
+  end
+
+  def self.underline(string)
+    decorate string, Style.new(nil, nil, false, true)
+  end
+
+  def self.style(style_name, string)
+    @colouring.decorate(string, @colouring.get_style(style_name))
+  end
+
+  def self.get_style(style_name)
+    @colouring.get_style style_name
+  end
+
+  def self.parse(string, default_style)
+    p = Parser.new default_style
+    segments = p.parse string
+
+    output = ""
+    segments.each do |seg|
+      style = if seg.params[:base_style]
+                @colouring.get_style seg.params[:base_style]
+              else
+                Style.new
+              end
+
+      style.fg = seg.params[:fg]
+      style.bg = seg.params[:bg]
+      style.bright = seg.params[:bright]
+      style.underline = seg.params[:underline]
+
+      output << decorate(seg.to_s, style)
+    end
+    output
+  end
+
+  def self.decorate(string, (fg, bg, bright, underline))
+    @colouring.decorate string, [fg, bg, bright, underline]
+  end
+
+  def self.config
+    @config
+  end
+
+  def self.reconfigure(config)
+    @config = config
+    @colouring = Colouring.new config
+  end
+
+  def self.display_palette
+    # TODO: Might be worth sorting, so the pallete is easier to navigate
+    colours = @colouring.palette.colours
+    colours_per_line = (`tput cols`.to_i / 9 - 0.5).ceil
+
+    c = 0
+    while c < colours.length do
+      if (c + colours_per_line) < colours.length
+        squares = colours_per_line
+      else
+        squares = colours.length - c
+      end
+
+      # Prepare the squares for the line
+      square_styles = []
+      squares.times do
+        black = Tco::Colour.new([0,0,0])
+        white = Tco::Colour.new([255,255,255])
+
+        font_colour = if (colours[c] - black).abs > (colours[c] - white).abs
+                        black
+                      else
+                        white
+                      end
+
+        square_styles.push [c, font_colour, colours[c]]
+        c += 1
+      end
+
+      # The first empty line
+      square_styles.each { |c, fg, bg| print Tco::colour fg, bg, " "*9 }
+      puts
+
+      # Colour index
+      square_styles.each do |c, fg, bg|
+        print Tco::colour fg, bg, c.to_s.center(9)
+      end
+      puts
+
+      # Colour value
+      square_styles.each do |c, fg, bg|
+        print Tco::colour fg, bg, bg.to_s.center(9)
+      end
+      puts
+
+      # Final empty line
+      square_styles.each { |c, fg, bg| print Tco::colour fg, bg, " "*9 }
+      puts
+    end
+  end
+end
+
+class String
+  def decorate
+    Tco::parse self, Tco::Style.new
+  end
+
+  def fg(colour)
+    Tco::fg colour, self
+  end
+
+  def bg(colour)
+    Tco::bg colour, self
+  end
+
+  def bright
+    Tco::bright self
+  end
+
+  def underline
+    Tco::underline self
+  end
+
+  def style(style)
+    Tco::style style, self
+  end
+end

data/lib/tco/colouring.rb

@@ -0,0 +1,227 @@
+# tco - terminal colouring application and library
+# Copyright (c) 2013, 2014 Radek Pazdera
+
+# MIT License
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'tco/palette'
+require 'tco/style'
+
+module Tco
+  class Colouring
+    ANSI_FG_BASE = 30
+    ANSI_BG_BASE = 40
+
+    attr_reader :palette
+
+    def initialize(configuration)
+      @palette = Palette.new configuration.options["palette"]
+      @output_type = configuration.options["output"]
+
+      configuration.colour_values.each do |id, value|
+        @palette.set_colour_value(parse_colour_id(id), parse_rgb_value(value))
+      end
+
+      @names = {}
+      configuration.names.each do |name, colour_def|
+        @names[name] = resolve_colour_def colour_def
+      end
+
+      @styles = {}
+      configuration.styles.each do |name, style|
+        @styles[name] = Style.new(resolve_colour_def(style[:fg]),
+                                  resolve_colour_def(style[:bg]),
+                                  style[:bright], style[:underline])
+      end
+    end
+
+    # Decorate a string according to the style passed. The input string
+    # is processed line-by-line (the escape sequences are added to each
+    # line). This is due to some problems I've been having with some
+    # terminal emulators not handling multi-line coloured sequences well.
+    def decorate(string, (fg, bg, bright, underline))
+      return string unless STDOUT.isatty || @output_type == :raw
+
+      fg = to_colour fg
+      bg = to_colour bg
+
+      output = []
+      lines = string.lines.map(&:chomp)
+      lines.each do |line|
+        unless line.length <= 0
+          line = case @palette.type
+                 when "ansi" then colour_ansi line, fg, bg
+                 when "extended" then colour_extended line, fg, bg
+                 else raise "Unknown palette '#{@palette.type}'."
+                 end
+
+          if bright
+            line = e(1) + line
+          end
+
+          if underline
+            line = e(4) + line
+          end
+
+          if (bright or underline) and fg == nil and bg == nil
+            line << e(0)
+          end
+        end
+
+        output.push line
+      end
+
+      output << "" if string =~ /\n$/
+      output.join "\n"
+    end
+
+    def get_style(name)
+      raise "Style '#{name}' not found." unless @styles.has_key? name
+
+      @styles[name]
+    end
+
+    def set_output(output_type)
+      unless [:term, :raw].include? output_type
+        raise "Output '#{output_type}' not supported."
+      end
+      @output_type = output_type
+    end
+
+    private
+    def e(seq)
+      if @output_type == :raw
+        "\\033[#{seq}m"
+      else
+        "\033[#{seq}m"
+      end
+    end
+
+    def colour_ansi(string, fg=nil, bg=nil)
+      unless fg == nil
+        colour_id = @palette.match_colour(fg)
+        string = e(colour_id + 30) + string
+      end
+
+      unless bg == nil
+        colour_id = @palette.match_colour(bg)
+        string = e(colour_id + 40) + string
+      end
+
+      unless fg == nil and bg == nil
+        string << e(0)
+      end
+
+      string
+    end
+
+    def colour_extended(string, fg=nil, bg=nil)
+      unless fg == nil
+        colour_id = @palette.match_colour(fg)
+        string = e("38;5;#{colour_id}") + string
+      end
+
+      unless bg == nil
+        colour_id = @palette.match_colour(bg)
+        string = e("48;5;#{colour_id}") + string
+      end
+
+      unless fg == nil and bg == nil
+        string << e(0)
+      end
+
+      string
+    end
+
+    def parse_colour_id(id_in_string)
+      id = String.new(id_in_string)
+      if id[0] == '@'
+        id[0] = ''
+        return id.to_i
+      end
+
+      raise "Invalid colour id #{id_in_string}."
+    end
+
+    def parse_rgb_value(rgb_value_in_string)
+      error_msg = "Invalid RGB value '#{rgb_value_in_string}'."
+      rgb_value = String.new rgb_value_in_string
+      case
+      when rgb_value[0] == '#'
+        rgb_value[0] = ''
+      when rgb_value[0..1] == '0x'
+        rgb_value[0..1] = ''
+      else
+        raise error_msg
+      end
+
+      raise error_msg unless rgb_value =~ /^[0-9a-fA-F]+$/
+
+      case rgb_value.length
+      when 3
+        rgb_value.scan(/./).map { |c| c.to_i 16 }
+      when 6
+        rgb_value.scan(/../).map { |c| c.to_i 16 }
+      else
+        raise error_msg
+      end
+    end
+
+    def resolve_colour_name(name)
+      raise "Name '#{name}' not found." unless @names.has_key? name
+
+      @names[name]
+    end
+
+    def resolve_colour_def(colour_def)
+      return nil if colour_def == "" || colour_def == "default"
+      begin
+        @palette.get_colour_value parse_colour_id colour_def
+      rescue RuntimeError
+        begin
+          parse_rgb_value colour_def
+        rescue RuntimeError
+          begin
+            colour_def = resolve_colour_name colour_def
+            if colour_def.is_a? String
+              resolve_colour_def colour_def
+            else
+              colour_def
+            end
+          rescue RuntimeError
+            raise "Invalid colour definition '#{colour_def}'."
+          end
+        end
+      end
+    end
+
+    def to_colour(value)
+      rgb = case
+            when value.is_a?(String) then resolve_colour_def value
+            when value.is_a?(Array) then value
+            when value.is_a?(Colour) then value.rgb
+            when value == nil then return nil
+            else raise "Colour value type '#{value.class}' not supported."
+            end
+
+      Colour.new rgb
+    end
+  end
+end

data/lib/tco/config.rb

@@ -0,0 +1,137 @@
+# tco - terminal colouring application and library
+# Copyright (c) 2013, 2014 Radek Pazdera
+
+# MIT License
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'yaml'
+
+module Tco
+  class Config
+    attr_accessor :options, :colour_values, :names, :styles
+
+    def initialize(locations=[])
+      @options = {
+        "palette" => "extended",
+        "output"  => "term"
+      }
+      @colour_values = {}
+      @names = {
+        "black" => "@0",
+        "red" => "@1",
+        "green" => "@2",
+        "yellow" => "@3",
+        "blue" => "@4",
+        "magenta" => "@5",
+        "cyan" => "@6",
+        "light-grey" => "@7",
+        "grey" => "@8",
+        "light-red" => "@9",
+        "light-green" => "@10",
+        "light-yellow" => "@11",
+        "light-blue" => "@12",
+        "light-magenta" => "@13",
+        "light-cyan" => "@14",
+        "white" => "@15"
+      }
+
+      @styles = {}
+
+      locations.each do |conf_file|
+        conf_file = File.expand_path conf_file
+        next unless File.exists? conf_file
+        load conf_file
+      end
+    end
+
+    def load(path)
+      conf_file = YAML::load_file path
+
+      if conf_file.has_key? "options"
+        if conf_file["options"].is_a? Hash
+          conf_file["options"].each do |id, value|
+            @colour_values[id] = value
+          end
+        else
+          raise "The 'colour_values' config option must be a hash."
+        end
+      end
+
+      if conf_file.has_key? "colour_values"
+        if conf_file["colour_values"].is_a? Hash
+          conf_file["colour_values"].each do |id, value|
+            @colour_values[id] = value
+          end
+        else
+          raise "The 'colour_values' config option must be a hash."
+        end
+      end
+
+      if conf_file.has_key? "names"
+        if conf_file["names"].is_a? Hash
+          conf_file["names"].each do |name, colour|
+            @names[name] = colour
+          end
+        else
+          raise "Invalid format of the 'names' option."
+        end
+      end
+
+      if conf_file.has_key? "styles"
+        if conf_file["styles"].is_a? Hash
+          conf_file["styles"].each do |name, styledef|
+            style = {:fg => nil, :bg => nil, :bright => false,
+                     :underline => false}
+
+            if styledef.has_key? "fg"
+              style[:fg] = styledef["fg"]
+            end
+
+            if styledef.has_key? "bg"
+              style[:bg] = styledef["bg"]
+            end
+
+            if styledef.has_key? "bright"
+              style[:bright] = parse_bool styledef["bright"]
+            end
+
+            if styledef.has_key? "underline"
+              style[:underline] = parse_bool styledef["underline"]
+            end
+
+            @styles[name] = style
+          end
+        else
+          raise "Invalid format of the 'styles' option."
+        end
+      end
+    end
+
+    private
+    def name_exists?(colour_name)
+      @names.has_key? colour_name
+    end
+
+    def parse_bool(value)
+     return true if value =~ /true/i || value =~ /yes/i || value.to_i >= 1
+     return false
+    end
+  end
+end