bioshogi 0.0.3

data/lib/bioshogi/formatter/core.rb

@@ -0,0 +1,239 @@
+# frozen-string-literal: true
+
+module Bioshogi
+  module Formatter
+    class Core
+      attr_accessor :pi
+      attr_accessor :parser_options
+
+      def initialize(pi, parser_options)
+        @pi = pi
+        @parser_options = parser_options
+      end
+
+      delegate *[
+        :to_bod,
+        :screen_image_renderer,
+        :to_image,
+        :to_png,
+        :to_jpg,
+        :to_gif,
+        :to_webp,
+        :to_yomiage,
+        :to_yomiage_list,
+      ], to: :container
+
+      def to_sfen(options = {})
+        container.to_history_sfen(options)
+      end
+
+      def to_kif(options = {})
+        KifBuilder.new(self, options).to_s
+      end
+
+      def to_ki2(options = {})
+        Ki2Builder.new(self, options).to_s
+      end
+
+      def to_csa(options = {})
+        CsaBuilder.new(self, options).to_s
+      end
+
+      def to_akf(options = {})
+        AkfBuilder.new(self, options).to_h
+      end
+
+      ################################################################################
+
+      def to_animation_mp4(options = {})
+        Animation::AnimationMp4Builder.new(self, options).to_binary
+      end
+
+      def to_animation_gif(options = {})
+        Animation::AnimationGifBuilder.new(self, options).to_binary
+      end
+
+      def to_animation_apng(options = {})
+        Animation::AnimationApngBuilder.new(self, options).to_binary
+      end
+
+      def to_animation_webp(options = {})
+        Animation::AnimationWebpBuilder.new(self, options).to_binary
+      end
+
+      def to_animation_zip(options = {})
+        Animation::AnimationZipBuilder.new(self, options).to_binary
+      end
+
+      def container_run_once
+        container
+      end
+
+      def container_class
+        @parser_options[:container_class] || Container::Basic
+      end
+
+      def container_new
+        container_class.new.tap do |e|
+          e.params.update(@parser_options.slice(*[
+                :skill_monitor_enable,
+                :skill_monitor_technique_enable,
+                :candidate_enable,
+                :validate_enable,
+                :validate_double_pawn_skip,
+                :validate_warp_skip,
+              ]))
+        end
+      end
+
+      # 画像生成のための container の初期状態を返す
+      def container_for_image
+        container = Container::Basic.new
+        container.params.update({
+            :skill_monitor_enable           => false,
+            :skill_monitor_technique_enable => false,
+            :candidate_enable               => false,
+            :validate_enable                => false,
+          })
+        container_init(container) # FIXME: これ、必要ない SFEN を生成したりして遅い
+        container
+      end
+
+      def container
+        @container ||= container_new.tap do |e|
+          container_init(e)
+          container_run_all(e)
+        end
+      end
+
+      # FIXME: container の最初の状態をコピーしておく
+      def initial_container
+        @initial_container ||= container_new.tap do |e|
+          container_init(e)
+        end
+      end
+
+      def container_init(container)
+        if @pi.sfen_info
+          container.placement_from_sfen(@pi.sfen_info)
+        else
+          players_piece_box_set(container)
+
+          if @pi.board_source
+            container.board.placement_from_shape(@pi.board_source)
+          else
+            preset_info = PresetInfo[pi.header["手合割"]] || PresetInfo["平手"]
+            container.placement_from_preset(preset_info.key)
+          end
+
+          if pi.force_location
+            container.turn_info.turn_base = pi.force_location.code
+          end
+
+          if pi.force_handicap
+            container.turn_info.handicap = pi.force_handicap
+          end
+        end
+        container.before_run_process # 最初の状態を記録
+      end
+
+      # 持駒を反映する
+      def players_piece_box_set(container)
+        pi.player_piece_boxes.each do |k, v|
+          container.player_at(k).piece_box.set(v)
+        end
+      end
+
+      # 盤面の指定があるとき、盤面だけを見て、手合割を得る
+      def board_preset_info
+        @board_preset_info ||= yield_self do
+          if @pi.board_source
+            Board.guess_preset_info(@pi.board_source)
+          end
+        end
+      end
+
+      # 手合割
+      def preset_info
+        @preset_info ||= @pi.force_preset_info
+        @preset_info ||= initial_container.board.preset_info
+        @preset_info ||= PresetInfo[pi.header["手合割"]]
+        @preset_info ||= PresetInfo["平手"]
+      end
+
+      def container_run_all(container)
+        Runner.new(self, container).call
+        if @parser_options[:skill_monitor_enable]
+          SkillEmbed.new(self, container).call
+        end
+      end
+
+      def skill_set_hash
+        @skill_set_hash ||= {}
+      end
+
+      def raw_header_part_hash
+        pi.header.object.collect { |key, value|
+          if value
+            if e = CsaHeaderInfo[key]
+              if e.as_kif
+                value = e.instance_exec(value, &e.as_kif)
+              end
+            end
+            [key, value]
+          end
+        }.compact.to_h
+      end
+
+      def judgment_message
+        if e = last_action_info
+          e.judgment_message(container)
+        end
+      end
+
+      def last_action_info
+        @last_action_info ||= yield_self do
+          key = nil
+
+          # エラーなら最優先
+          unless key
+            if @pi.error_message
+              key = :ILLEGAL_MOVE
+            end
+          end
+
+          # 元の棋譜の記載を優先 (CSA語, 柿木語 のみ対応)
+          unless key
+            if @pi.last_action_params
+              v = @pi.last_action_params[:last_action_key]
+              if LastActionInfo[v]
+                key = v
+              end
+            end
+          end
+
+          # 何の指定もないときだけ投了とする
+          unless key
+            unless @pi.last_action_params
+              key = :TORYO
+            end
+          end
+
+          LastActionInfo[key]
+        end
+      end
+
+      def used_seconds_at(index)
+        @pi.move_infos.dig(index, :used_seconds).to_i
+      end
+
+      def error_message_part(comment_mark = "*")
+        if @pi.error_message
+          v = @pi.error_message.strip + "\n"
+          s = "-" * 76 + "\n"
+          [s, *v.lines, s].collect {|e| "#{comment_mark} #{e}" }.join
+        end
+      end
+    end
+  end
+end

data/lib/bioshogi/formatter/csa_builder.rb

@@ -0,0 +1,150 @@
+# frozen-string-literal: true
+#
+# CSA標準棋譜ファイル形式
+# http://www.computer-shogi.org/protocol/record_v22.html ← 見れなくなった
+# http://www2.computer-shogi.org/protocol/tcp_ip_server_121.html
+#
+#   V2.2
+#   N+久保利明 王将
+#   N-都成竜馬 四段
+#   $EVENT:王位戦
+#   $SITE:関西将棋会館
+#   $START_TIME:2017/11/16 10:00:00
+#   $END_TIME:2017/11/16 19:04:00
+#   $OPENING:相振飛車
+#   P1-KY-KE-GI-KI-OU-KI-GI-KE-KY
+#   P2 * -HI *  *  *  *  * -KA *
+#   P3-FU-FU-FU-FU-FU-FU-FU-FU-FU
+#   P4 *  *  *  *  *  *  *  *  *
+#   P5 *  *  *  *  *  *  *  *  *
+#   P6 *  *  *  *  *  *  *  *  *
+#   P7+FU+FU+FU+FU+FU+FU+FU+FU+FU
+#   P8 * +KA *  *  *  *  * +HI *
+#   P9+KY+KE+GI+KI+OU+KI+GI+KE+KY
+#   +
+#   +7776FU
+#   -3334FU
+#   %TORYO
+#
+#
+module Bioshogi
+  module Formatter
+    class CsaBuilder
+      include Builder
+
+      CSA_VERSION = "2.2"
+
+      class << self
+        def default_params
+          super.merge({
+              :board_expansion => false, # 平手であっても P1 形式で表示
+              :compact         => false, # 指し手の部分だけ一行にする
+              :oneline         => false, # 一行にする。改行もなし
+              :has_header      => true,
+              :has_footer      => true,
+            })
+        end
+      end
+
+      def initialize(formatter, params = {})
+        @formatter = formatter
+        @params = self.class.default_params.merge(params)
+      end
+
+      def to_s
+        @formatter.container_run_once
+
+        out = []
+        out << "V#{CSA_VERSION}\n"
+
+        if @params[:has_header]
+          out << header_content
+        end
+
+        obj = Container::Basic.new
+        @formatter.container_init(obj) # なぜ？
+        out << obj.to_csa(@params)
+
+        out << body_hands
+
+        if @params[:has_footer]
+          out << footer_content
+        end
+
+        if @formatter.pi.error_message
+          out << @formatter.error_message_part(Parser::CsaParser::SYSTEM_COMMENT_CHAR)
+        end
+
+        out = out.join
+
+        if @params[:oneline]
+          out = out.gsub(/\n/, ",")
+        else
+          out += "\n"
+          out = out.gsub(/\s+\n/, "\n")
+        end
+
+        out
+      end
+
+      private
+
+      def header_content
+        CsaHeaderInfo.collect { |e|
+          if v = @formatter.pi.header[e.kif_side_key].presence
+            if e.as_csa
+              v = e.instance_exec(v, &e.as_csa)
+            end
+            "#{e.csa_key}#{v}\n"
+          end
+        }.join
+      end
+
+      def body_hands
+        out = []
+
+        # 2通りある
+        # 1. 初期盤面の状態から調べた手合割を利用して最初の手番を得る  (turn_info = TurnInfo.new(preset_key))
+        # 2. container.turn_info を利用して container.turn_info.base_location.csa_sign を参照
+        # ↑どちらも違う
+        # 3. これが正しい
+        out << @formatter.container.turn_info.turn_offset_zero_location.csa_sign + "\n"
+
+        if @formatter.container.hand_logs.present?
+          list = @formatter.container.hand_logs.collect.with_index do |e, i|
+            if @formatter.pi.clock_exist?
+              [e.to_csa, "T#{@formatter.used_seconds_at(i)}"].join(",")
+            else
+              e.to_csa
+            end
+          end
+          out << list.join(separator) + "\n"
+        end
+
+        out.join
+      end
+
+      # 将棋倶楽部24の棋譜は先手の手番で後手が投了できる「反則勝ち」が last_action_key 入っているたため、LastActionInfo を fetch できない
+      # なので仕方なく TORYO にしている。これは実際には後手が投了したのに先手が投了したことになってしまう表記なのでおかしい
+      # これは将棋倶楽部24に仕様を正してもらうか、CSA 側でそれに対応するキーワードを用意してもらうしかない
+      def footer_content
+        av = []
+        hv = @formatter.pi.last_action_params || { last_action_key: "TORYO" }
+        last_action_info = LastActionInfo[hv[:last_action_key]] || LastActionInfo[:TORYO]
+        av << "%#{last_action_info.csa_key}"
+        if v = hv[:used_seconds]
+          av << "T#{v}"
+        end
+        av.join(",") + "\n"
+      end
+
+      def separator
+        if @params[:compact]
+          ","
+        else
+          "\n"
+        end
+      end
+    end
+  end
+end

data/lib/bioshogi/formatter/ki2_builder.rb

@@ -0,0 +1,58 @@
+# frozen-string-literal: true
+
+module Bioshogi
+  module Formatter
+    class Ki2Builder
+      include Builder
+      include KifKi2Shared
+
+      class << self
+        def default_params
+          super.merge({
+              :column_style => :auto, # auto: 自動的に揃える, fixed: 指定の幅(column_width)で揃える
+              :column_max   => 8,     # 最大N列
+              :column_width => 12,    # column_style が fixed のときのカラム幅
+              :same_suffix  => "　",  # "同角" みたいなときに "同" と "角" の間に入れる文字列
+            })
+        end
+      end
+
+      private
+
+      def body_hands
+        send "#{@params[:column_style]}_width_body_hands"
+      end
+
+      # 固定幅で整列
+      # 値が小さいと揃わない場合がある
+      def fixed_width_body_hands
+        @formatter.container.hand_logs.group_by.with_index {|_, i| i / @params[:column_max] }.values.collect { |v|
+          v.collect { |e|
+            s = e.to_ki2(with_location: true, same_suffix: @params[:same_suffix])
+            mb_ljust(s, @params[:column_width])
+          }.join.strip + "\n"
+        }.join
+      end
+
+      # 自動整列
+      # かならず揃う
+      def auto_width_body_hands
+        list = @formatter.container.hand_logs.collect do |e|
+          e.to_ki2(with_location: true, same_suffix: @params[:same_suffix])
+        end
+
+        list2 = list.in_groups_of(@params[:column_max])
+        column_widths = list2.transpose.collect do |e|
+          e.collect { |e| e.to_s.toeuc.bytesize }.max
+        end
+
+        list2 = list2.collect do |a|
+          a.collect.with_index do |e, i|
+            mb_ljust(e.to_s, column_widths[i])
+          end
+        end
+        list2.collect { |e| e.join(" ").strip + "\n" }.join
+      end
+    end
+  end
+end

data/lib/bioshogi/formatter/kif_builder.rb

@@ -0,0 +1,83 @@
+# frozen-string-literal: true
+
+module Bioshogi
+  module Formatter
+    class KifBuilder
+      include Builder
+      include KifKi2Shared
+
+      HEADER_BODY_SEPARATOR = "手数----指手---------消費時間--"
+
+      class << self
+        def default_params
+          super.merge({
+              :hand_width       => 12,
+              :number_width     => 4,
+              :time_embed_force => false, # 強制的に時間を含めるか？
+            })
+        end
+      end
+
+      private
+
+      def build_before
+        if @params[:time_embed_force] || @formatter.pi.clock_exist?
+          @main_clock = MainClock.new
+        end
+      end
+
+      def body_header
+        HEADER_BODY_SEPARATOR + "\n"
+      end
+
+      def body_hands
+        @formatter.container.hand_logs.collect.with_index { |e, i|
+          if @main_clock
+            @main_clock.add(@formatter.used_seconds_at(i))
+          end
+          s = e.to_kif(char_type: :formal_sheet)
+          s = mb_ljust(s, @params[:hand_width])
+          n = "%*d" % [@params[:number_width], i.next]
+          s = [n, s, @main_clock].compact.join(" ")
+          s = s.rstrip + "\n"
+          if v = e.to_skill_set_kif_comment
+            s += v
+          end
+          s
+        }.join
+      end
+
+      def footer_content
+        out = []
+
+        left_part = nil
+        right_part = nil
+
+        if @formatter.last_action_info
+          if kakinoki_word = @formatter.last_action_info.kakinoki_word
+            left_part = "%*d %s" % [
+              @params[:number_width],
+              @formatter.container.hand_logs.size.next,
+              mb_ljust(kakinoki_word, @params[:hand_width]),
+            ]
+          end
+
+          if @formatter.pi.last_action_params
+            if used_seconds = @formatter.pi.last_action_params[:used_seconds]
+              if @main_clock
+                @main_clock.add(used_seconds)
+                right_part = @main_clock.to_s
+              end
+            end
+          end
+
+          if left_part
+            out << "#{left_part} #{right_part}".rstrip + "\n"
+          end
+        end
+
+        out
+      end
+    end
+  end
+end

data/lib/bioshogi/formatter/kif_ki2_shared.rb

@@ -0,0 +1,144 @@
+module Bioshogi
+  module Formatter
+    # kif, ki2 変換の共通処理
+    concern :KifKi2Shared do
+      attr_accessor :formatter
+      attr_accessor :params
+      attr_accessor :header
+
+      class_methods do
+        def default_params
+          super.merge({
+              :has_header => true,
+              :has_footer => true,
+            })
+        end
+      end
+
+      def initialize(formatter, params = {})
+        @formatter = formatter
+        @params = self.class.default_params.merge(params)
+        # Assertion.assert { formatter.pi.header.object_id != @pi.header.object.object_id }
+      end
+
+      def to_s
+        build_before
+        @formatter.container_run_once
+        @header = @formatter.pi.header.clone
+
+        out = []
+
+        if @params[:has_header]
+          if @header.present?
+            out << header_part_string
+          end
+        end
+
+        out << body_header
+        out << body_hands
+
+        if @params[:has_footer]
+          out << footer_content
+          if s = @formatter.judgment_message
+            out << "#{s}\n"
+          end
+          if s = illegal_judgement_message
+            out << s
+          end
+          out << @formatter.error_message_part
+        end
+
+        out.join
+      end
+
+      private
+
+      def build_before
+      end
+
+      def body_header
+        "\n"
+      end
+
+      def body_hands
+        raise NotImplementedError, "#{__method__} is not implemented"
+      end
+
+      def footer_content
+      end
+
+      def header_part_string
+        m = @formatter.initial_container
+        if e = m.board.preset_info
+          # 手合割がわかる場合
+          @header["手合割"] = e.name
+          mochigoma_delete_if_blank # 手合割がわかるとき持駒が空なら消す
+          raw_header_part_string
+        else
+          # ".*の持駒" を消してBODを埋める
+          mochigoma_delete_force
+          raw_header_part_string + m.to_bod(display_turn_skip: true, compact: true)
+        end
+      end
+
+      def raw_header_part_hash
+        @header.object.collect { |key, value|
+          if value
+            if e = CsaHeaderInfo[key]
+              if e.as_kif
+                value = e.instance_exec(value, &e.as_kif)
+              end
+            end
+            [key, value]
+          end
+        }.compact.to_h
+      end
+
+      def raw_header_part_string
+        raw_header_part_hash.collect { |key, value| "#{key}：#{value}\n" }.join
+      end
+
+      def mochigoma_delete_force
+        Location.call_names.each do |e|
+          @header.delete("#{e}の持駒")
+        end
+      end
+
+      def mochigoma_delete_if_blank
+        Location.call_names.each do |e|
+          key = "#{e}の持駒"
+          if v = @header[key]
+            if v.blank? || v == "なし"
+              @header.delete(key)
+            end
+          end
+        end
+      end
+
+      # 将棋倶楽部24の棋譜だけに存在する、自分の手番で相手が投了したときの文言に対応する
+      # "*" のあとにスペースを入れると、激指でコメントの先頭にスペースが入ってしまうため、仕方なくくっつけている
+      def illegal_judgement_message
+        if @formatter.pi.last_action_params
+          v = @formatter.pi.last_action_params[:last_action_key]
+          unless LastActionInfo[v]
+            "*#{v}\n"
+          end
+        end
+      end
+
+      # 全角対応 ljust
+      #
+      #  mb_ljust("あ", 3)  # => "あ "
+      #  mb_ljust("1", 3)   # => "1  "
+      #  mb_ljust("123", 3) # => "123"
+      #
+      def mb_ljust(str, width)
+        n = width - str.encode("EUC-JP").bytesize
+        if n < 0
+          n = 0
+        end
+        str + " " * n
+      end
+    end
+  end
+end