rixmap 0.1.0

data/lib/rixmap/format/xpm.rb

@@ -0,0 +1,446 @@
+# -*- coding: utf-8 -*-
+
+#
+module Rixmap
+  module Format
+
+    # X-PixMap画像形式実装モジュール.
+    module XPM
+
+      # XPMカラーテーブル
+      #
+      # 文字と対応するカラー表現を持ちます.
+      class XPMColorTable
+        include Enumerable
+
+        # カラー名に使用する文字の一覧
+        #
+        # @return [String] 文字リスト
+        CHARACTERS = " 0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ+/"
+
+        # @return [Integer] 色コードサイズ
+        attr_reader :code_size
+
+        # @return [Array<String>] コードリスト
+        attr_reader :codes
+
+        # @return [Array<String>] 色データ
+        attr_reader :colors
+
+        # パレットからカラーテーブルを作成します.
+        #
+        # @param [Rixmap::Palette] palette 元にするパレット
+        def initialize(palette)
+          @codes = []
+          @colors = []
+          @code_size = 0
+
+          nchars = CHARACTERS.size
+          csize  = Math.log(palette.size, nchars).ceil
+          palette.each_with_index do |c, i|
+            code = []
+            tmp = i
+            csize.downto(1) do |j|
+              base = (nchars ** (j - 1))
+              ch = tmp / base
+              tmp = tmp % base
+              code << CHARACTERS[ch]
+            end
+            @codes[i] = code.join('')
+            @colors[i] = "#%02X%02X%02X" % [c.red, c.green, c.blue]
+          end
+          @code_size = csize
+        end
+
+        # 各カラーテーブルデータを順に処理します.
+        #
+        # カラーテーブルデータは [code, color] の配列で渡されます
+        #
+        # @yield [Array] [code, color] 形式の配列
+        # @return [Enumerator] ブロックを渡さなかった場合はEnumeratorを返します.
+        def each
+          if block_given?
+            @codes.each_with_index do |code, i|
+              yield [code, @colors[i]]
+            end
+          else
+            return Enumerator.new(self)
+          end
+        end
+      end
+
+      # XPM1形式のマジックデータ
+      MAGIC_XPM1 = "/* XPM */"
+
+      # XPM2形式のマジックデータ
+      MAGIC_XPM2 = "! XPM2"
+
+      # XPM1形式のマジックデータを検出するための正規表現
+      MAGIC_XPM1_PATTERN = %r{^/\*\s*XPM\s*\*/.*$}
+
+      # XPM2形式のマジックデータを検出するための正規表現
+      MAGIC_XPM2_PATTERN = %r{^!\s+XPM2.*$}
+
+      # XPM1形式用入出力実装クラス.
+      class XPM1ImageIO < Rixmap::ImageIO::BaseImageIO
+        # XPM1形式で読み込めるかどうかを調べます.
+        #
+        # @param [String] magic 先頭バイトデータ
+        # @return [Boolean] XPM1形式で読み込める場合はtrue
+        def self.readable?(magic)
+          if MAGIC_XPM1_PATTERN.match(magci)
+            return true
+          else
+            return false
+          end
+        end
+
+        # XPM1形式で書き込めるかどうかを調べます.
+        #
+        # @param [Rixmap::Image] image 調べる画像
+        # @return [Boolean] XPM1形式で書き込める場合はtrue
+        def self.writable?(image)
+          if image.indexed?
+            return true
+          else
+            return false
+          end
+        end
+
+        # 画像をXPM1形式でバイト列にエンコードします.
+        #
+        # @param [Rixmap::Image] image 対象画像
+        # @param [Hash] options オプションパラメータ (未使用)
+        # @return [String] バイト列
+        def encode(image, options={})
+          raise ArgumentError.new("input image is not supported") unless image.indexed?
+
+          # 画像データ格納変数名
+          varname = "XFACE"
+
+          # 画像データ
+          tokens  = []
+          tokens << MAGIC_XPM1
+          tokens << "static char* #{varname}[] = {"
+
+          # パレットデータ
+          ctbl = XPMColorTable.new(image.palette)
+          tokens << %Q{"#{image.width} #{image.height} #{image.palette.size} #{ctbl.code_size}",}
+          ctbl.each do |item|
+            tokens << %Q{"#{item[0]}\tc\t#{item[1]}",}
+          end
+
+          # ピクセルデータ
+          image.height.times do |h|
+            line = image[h].collect {|v| ctbl.codes[v] }.join("")
+            tokens << %Q{"#{line}",}
+          end
+          tokens[-1] = tokens[-1].slice(0..-2)    # 最終行の末尾を調整
+
+          # データ終端
+          tokens << "};"
+
+          # 連結
+          return tokens.join("\n")
+        end
+
+        # バイト列データからXPM1形式として画像を復元します.
+        #
+        # @param [String] data XPM1形式画像データ
+        # @param [Hash] options オプションパラメータ (未使用)
+        # @return [Rixmap::Image] 復元された画像
+        def decode(data, options={})
+          magic, imdata = data.split($/, 2)
+          unless MAGIC_XPM1_PATTERN.match(magic)
+            raise ArgumentError.new("input image is not XPM image")
+          end
+
+          # 画像データからコメント部分を除去
+          imdata.gsub!(%r{/\*.*\*/}, "")    # Remove C Style Comments
+          imdata.gsub!(%r{//.*$}, "")       # Remove C++ Style Comments
+
+          # XPM画像かどうかをチェック
+          xpmmatch = %r{static\s+char\s*\*\s*([[:graph:]]+)\s*\[\]\s*=\s*\{(.*)\};}m.match(imdata)
+          unless xpmmatch
+            raise ArgumentError.new("input image data is broken as XPM")
+          end
+
+          # 行分割
+          #xpmlines = Enumerator.new(xpmmatch[2].strip.split($/))
+          xpmlines = xpmmatch[2].strip.split($/).to_enum
+
+          begin
+            # 画像情報を解析
+            xpminfo = %r{"\s*([[:digit:]]+)\s+([[:digit:]]+)\s+([[:digit:]]+)\s+([[:digit:]]+)\s*"}.match(xpmlines.next)
+            unless xpminfo
+              raise ArgumentError.new("input image data is broken as XPM")
+            end
+            width   = xpminfo[1].to_i
+            height  = xpminfo[2].to_i
+            ncolors = xpminfo[3].to_i
+            nchars  = xpminfo[4].to_i   # 一色あたりの文字数
+
+            # 画像オブジェクト
+            palette = Rixmap::Palette.new(ncolors)
+            image   = Rixmap::Image.new(Rixmap::INDEXED, width, height, :palette => palette)
+
+            # 色表を構築
+            ctbl = {}
+            cptn = %r{"\s*(.{#{nchars}})\s+(c)\s+#([0-9A-Fa-f]{6})\s*.*"}
+            ncolors.times do |i|
+              cline  = xpmlines.next
+              cmatch = cptn.match(cline)
+              if cmatch
+                ckey   = cmatch[1]
+                cvalue = cmatch[3]
+                ctbl[ckey] = i
+                palette[i] = Rixmap::Color.new(*(cvalue.unpack('a2a2a2').collect {|e| e.to_i(16) }))
+              end
+            end
+
+            # ピクセルを解析
+            pixptn  = %r{"\s*(.{#{nchars * width}})\s*"}
+            packfmt = "a#{nchars}" * width
+            height.times do |h|
+              pixline  = xpmlines.next
+              pixmatch = pixptn.match(pixline)
+              if pixmatch
+                pixmatch[1].unpack(packfmt).each_with_index do |e, w|
+                  image[w, h] = ctbl[e]
+                end
+              end
+            end
+
+            return image
+          rescue StopIteration
+            raise RuntimeError.new("illegal content")
+          end
+        end
+      end
+
+      # XPM2形式用入出力実装クラス.
+      class XPM2ImageIO < Rixmap::ImageIO::BaseImageIO
+        # XPM2形式で読み込めるかどうかを調べます.
+        #
+        # @param [String] magic 先頭バイトデータ
+        # @return [Boolean] XPM2形式で読み込める場合はtrue
+        def self.readable?(magic)
+          if MAGIC_XPM2_PATTERN.match(magci)
+            return true
+          else
+            return false
+          end
+        end
+
+        # XPM2形式で書き込めるかどうかを調べます.
+        #
+        # @param [Rixmap::Image] image 調べる画像
+        # @return [Boolean] XPM2形式で書き込める場合はtrue
+        def self.writable?(image)
+          if image.indexed?
+            return true
+          else
+            return false
+          end
+        end
+
+        # 画像をXPM2形式でバイト列にエンコードします.
+        #
+        # @param [Rixmap::Image] image 対象画像
+        # @param [Hash] options オプションパラメータ (未使用)
+        # @return [String] バイト列
+        def encode(image, options={})
+          raise ArgumentError.new("input image is not supported") unless image.indexed?
+
+          # 書き込みバッファ
+          tokens = []
+          tokens << MAGIC_XPM2
+
+          # パレット
+          ctbl = XPMColorTable.new(image.palette)
+          tokens << "#{image.width} #{image.height} #{image.palette.size} #{ctbl.code_size}"
+          ctbl.each do |item|
+            tokens << "#{item[0]}\tc\t#{item[1]}"
+          end
+
+          # ピクセルデータ
+          image.height.times do |h|
+            line = image[h].collect {|pixel| ctbl.codes[pixel] }.join("")
+            tokens << line
+          end
+
+          # 連結
+          return tokens.join("\n")
+        end
+
+        # バイト列データからXPM2形式として画像を復元します.
+        #
+        # @param [String] data XPM2形式画像データ
+        # @param [Hash] options オプションパラメータ (未使用)
+        # @return [Rixmap::Image] 復元された画像
+        def decode(data, options={})
+          magic, imdata = data.split($/, 2)
+          unless MAGIC_XPM2_PATTERN.match(magic)
+            raise ArgumentError.new("input image is not XPM image")
+          end
+
+          # 行分割
+          #xpmlines = Enumerator.new(imdata.split($/))
+          xpmlines = imdata.split($/).to_enum
+
+          begin
+            # 画像情報
+            xpminfo = %r{\s*([[:digit:]]+)\s+([[:digit:]]+)\s+([[:digit:]]+)\s+([[:digit:]]+)\s*}.match(xpmlines.next)
+            unless xpminfo
+              raise ArgumentError.new("input image data is broken as XPM")
+            end
+            width   = xpminfo[1].to_i
+            height  = xpminfo[2].to_i
+            ncolors = xpminfo[3].to_i
+            nchars  = xpminfo[4].to_i
+
+            # 画像オブジェクト
+            palette = Rixmap::Palette.new(ncolors)
+            image   = Rixmap::Image.new(Rixmap::INDEXED, width, height, :palette => palette)
+
+            # カラーテーブル
+            ctbl = {}
+            cptn = %r{\s*(.{#{nchars}})\s+(c)\s+#([0-9A-Fa-f]{6})\s*.*}
+            ncolors.times do |i|
+              cmatch = cptn.match(xpmlines.next)
+              if cmatch
+                ckey   = cmatch[1]
+                cvalue = cmatch[3]
+                ctbl[ckey] = i
+                palette[i] = Rixmap::Color.new(*(cvalue.unpack('a2a2a2').collect {|e| e.to_i(16) }))
+              end
+            end
+
+            # ピクセルデータ
+            pixptn  = %r{\s*(.{#{nchars * width}})\s*}
+            packfmt = "a#{nchars}" * width
+            height.times do |h|
+              pixmatch = pixptn.match(xpmlines.next)
+              if pixmatch
+                pixmatch[1].unpack(packfmt).each_with_index do |e, w|
+                  image[w, h] = ctbl[e]
+                end
+              end
+            end
+
+            return image
+          rescue StopIteration
+            raise RuntimeError.new("illegal content")
+          end
+        end
+      end
+
+      # XPM形式用入出力実装クラス.
+      #
+      # XPM1とXPM2の出力を分けたり、読み込み時に自動判定したりします.
+      class XPMImageIO < Rixmap::ImageIO::BaseImageIO
+        # 指定データがXPM1またはXPM2で読み込めるかどうかを調べます.
+        #
+        # XPM1形式が優先されます.
+        #
+        # @param [String] magic 先頭バイトデータ
+        # @return [Boolean] XPM形式で読み込める場合はtrue
+        def self.readable?(magic)
+          return XPM1ImageIO.readable?(magic) || XPM2ImageIO.readable?(magic)
+        end
+
+        # 指定画像がXPM1またはXPM2で書き込めるかを判定します.
+        #
+        # XPM1形式が優先されます.
+        #
+        # @param [Rixmap::Image] image 調べる画像
+        # @return [Boolean] XPM形式で書き込める場合はtrue
+        def self.writable?(image)
+          return XPM1ImageIO.writable?(image) || XPM2ImageIO.writable?(image)
+        end
+
+        # @param [Hash] options オプションパラメータ
+        # @option options [Symbol,Integer,String] :version
+        #   処理する際のバージョン. (default: auto)
+        #   指定できる値は以下の通り.
+        #
+        #   - :auto
+        #   - :xpm1
+        #   - :xpm2
+        #   - 0 (:autoと同じ)
+        #   - 1 (:xpm1と同じ)
+        #   - 2 (:xpm2と同じ)
+        def initialize(options = {})
+          super(options)
+
+          @version = :auto unless defined?(@version)
+          # 書き込み時の指定とかどうしよう
+
+          # インスタンスは初期化しておく
+          @xpm1iio = XPM1ImageIO.new(options)
+          @xpm2iio = XPM2ImageIO.new(options)
+        end
+
+        # 画像をバイト列にエンコードします.
+        #
+        # @param [Rixmap::Image] image 対象画像
+        # @param [Hash] options オプションパラメータ
+        # @option options [Symbol,Integer,String] :version エンコードバージョン. 値は #initialize を参照のこと
+        # @return [String] バイト列
+        # @see XPM1ImageIO#encode
+        # @see XPM2ImageIO#encode
+        def encode(image, options={})
+          version = if options[:version].nil?
+                      @version
+                    else
+                      options[:version]
+                    end
+
+          case version
+          when 0, 1, :xpm1, :auto
+            return @xpm1iio.encode(image, options)
+          when 2, :xpm2
+            return @xpm2iio.encode(image, options)
+          else
+            raise NotImplementedError.new("XPM Version #{version} is not implemented")
+          end
+        end
+
+        # 画像をバイト列から復元します.
+        #
+        # @param [String] data バイト列
+        # @param [Hash] options オプションパラメータ
+        # @option options [Symbol,Integer,String] :version エンコードバージョン. 値は #initialize を参照のこと
+        # @return [Rixmap::Image] 復元された画像
+        # @see XPM1ImageIO#decode
+        # @see XPM2ImageIO#decode
+        def decode(data, options={})
+          version = if options[:version].nil?
+                      @version
+                    else
+                      options[:version]
+                    end
+
+          case version
+          when 0, 1, :xpm1, :auto
+            return @xpm1iio.decode(data, options)
+          when 2, :xpm2
+            return @xpm2iio.decode(data, options)
+          else
+            raise NotImplementedError.new("XPM Version #{version} is not implemented")
+          end
+        end
+      end
+
+      Rixmap::ImageIO.register(:XPM1, XPM1ImageIO)
+      Rixmap::ImageIO.register(:XPM2, XPM2ImageIO)
+      Rixmap::ImageIO.register(:XPM,  XPMImageIO, [".xpm"])
+    end
+
+  end
+end
+
+
+#==============================================================================#
+# $Id: xpm.rb,v 57b1fb2cd6a6 2014/04/20 12:21:27 chikuchikugonzalez $
+# vim: set sts=2 ts=2 sw=2 expandtab:

data/lib/rixmap/format.rb

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+require_relative 'format/bmp'
+require_relative 'format/pcx'
+require_relative 'format/png'
+require_relative 'format/xpm'
+
+
+#==============================================================================#
+# $Id: format.rb,v 57b1fb2cd6a6 2014/04/20 12:21:27 chikuchikugonzalez $
+# vim: set sts=2 ts=2 sw=2 expandtab:

data/lib/rixmap/version.rb

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+
+#
+module Rixmap
+
+  # メジャーバージョン番号
+  VERSION_MAJOR = 0
+
+  # マイナーバージョン番号
+  VERSION_MINOR = 1
+
+  # リビジョン番号のようなもの
+  VERSION_TEENY = 0
+
+  # バージョン番号 (数値表現)
+  VERSION_NUMBER = (VERSION_MAJOR << 16) | (VERSION_MINOR << 8) | VERSION_TEENY
+
+  # バージョン番号 (文字列)
+  VERSION = "#{VERSION_MAJOR}.#{VERSION_MINOR}.#{VERSION_TEENY}"
+
+end
+
+
+#==============================================================================#
+# $Id: version.rb,v 431aac54543a 2014/04/20 15:12:27 chikuchikugonzalez $
+# vim: set sts=2 ts=2 sw=2 expandtab:

data/lib/rixmap.rb

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+#
+# Rixmapルートファイル(｀・ω・´)
+#
+
+# Rixmapライブラリルートモジュール.
+module Rixmap
+end
+
+# 1. バージョンファイルを読み込み
+require_relative 'rixmap/version'
+
+# 2. C拡張を読み込み
+require_relative "#{RUBY_PLATFORM}/rixmap"
+
+# 3. Ruby実装を読み込み
+require_relative 'rixmap/format'
+
+# 4. その他
+
+
+#==============================================================================#
+# $Id: rixmap.rb,v 57b1fb2cd6a6 2014/04/20 12:21:27 chikuchikugonzalez $
+# vim: set sts=2 ts=2 sw=2 expandtab:

data/spec/binary_spec.rb

@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+#
+# Rixmap::Binary Spec
+require_relative '../lib/rixmap'
+
+describe Rixmap::Binary do
+end
+
+
+#==============================================================================#
+# $Id: binary_spec.rb,v add33526d522 2014/04/19 16:27:29 chikuchikugonzalez $
+# vim: set sts=2 ts=2 sw=2 expandtab:

data/spec/color_spec.rb

@@ -0,0 +1,76 @@
+# -*- coding: utf-8 -*-
+#
+# Rixmap::Color Spec
+require_relative '../lib/rixmap'
+
+describe Rixmap::Color do
+  context "Color.new(0)" do
+    before do
+      @color = Rixmap::Color.new(0)
+    end
+
+    it "red should be 0" do expect(@color.red).to eq(0) end
+    it "green should be 0" do expect(@color.green).to eq(0) end
+    it "blue should be 0" do expect(@color.blue).to eq(0) end
+    it "alpha should be 255" do expect(@color.alpha).to eq(255) end
+    it "luminance should be 0" do expect(@color.luminance).to eq(0) end
+    it "convert to array is [0, 0, 0, 255]" do expect(@color.to_a).to eq([0, 0, 0, 255]) end
+  end
+
+  context "Color.new(32, 127)" do
+    before do
+      @color = Rixmap::Color.new(32, 127)
+    end
+
+    it "red should be 32" do expect(@color.red).to eq(32) end
+    it "green should be 32" do expect(@color.green).to eq(32) end
+    it "blue should be 32" do expect(@color.blue).to eq(32) end
+    it "alpha should be 127" do expect(@color.alpha).to eq(127) end
+    it "luminance should be 32" do expect(@color.luminance).to eq(32) end
+    it "convert to array is [32, 32, 32, 127]" do expect(@color.to_a).to eq([32, 32, 32, 127]) end
+  end
+
+  context "Color.new(64, 94, 114)" do
+    before do
+      @color = Rixmap::Color.new(64, 94, 114)
+    end
+
+    it "red should be 64" do expect(@color.red).to eq(64) end
+    it "green should be 94" do expect(@color.green).to eq(94) end
+    it "blue should be 114" do expect(@color.blue).to eq(114) end
+    it "alpha should be 255" do expect(@color.alpha).to eq(255) end
+    it "luminance should be 91" do expect(@color.luminance).to eq(91) end
+    it "convert to array is [64, 94, 114, 255]" do expect(@color.to_a).to eq([64, 94, 114, 255]) end
+  end
+
+  context "Color.new(128, 256, 384, 64)" do
+    before do
+      @color = Rixmap::Color.new(128, 256, 384, 64)
+    end
+
+    it "red should be 128" do expect(@color.red).to eq(128) end
+    it "green should be 255" do expect(@color.green).to eq(255) end
+    it "blue should be 255" do expect(@color.blue).to eq(255) end
+    it "alpha should be 64" do expect(@color.alpha).to eq(64) end
+    it "luminance should be 213" do expect(@color.luminance).to eq(213) end
+    it "convert to array is [128, 255, 255, 64]" do expect(@color.to_a).to eq([128, 255, 255, 64]) end
+  end
+
+  context "Color.new('#9932CC')" do
+    before do
+      @color = Rixmap::Color.new("#9932CC")
+    end
+
+    it "red should be 153" do expect(@color.red).to eq(153) end
+    it "green should be 50" do expect(@color.green).to eq(50) end
+    it "blue should be 204" do expect(@color.blue).to eq(204) end
+    it "alpha should be 255" do expect(@color.alpha).to eq(255) end
+    it "luminance should be 136" do expect(@color.luminance).to eq(136) end
+    it "convert to array is [153, 50, 204, 255]" do expect(@color.to_a).to eq([153, 50, 204, 255]) end
+  end
+end
+
+
+#==============================================================================#
+# $Id: color_spec.rb,v 5b9a0968eca5 2014/04/20 13:37:36 chikuchikugonzalez $
+# vim: set sts=2 ts=2 sw=2 expandtab: