bioshogi 0.0.3

data/lib/bioshogi/official_formatter.rb

@@ -0,0 +1,433 @@
+# frozen-string-literal: true
+
+module Bioshogi
+  class OfficialFormatter
+    attr_reader :hand_log
+    attr_reader :options
+
+    delegate :drop_hand, :move_hand, :soldier, :hand, :candidate_soldiers, :handicap, to: :hand_log
+    delegate :place, :piece, :location, :promoted, to: :soldier
+
+    def initialize(hand_log, options = {})
+      @options = {
+        :with_location => false,         # 先手後手のマークを入れる？
+        :force_drop    => false,         # 「打」を省略できるときでも「打」を明示する？
+        :same_suffix   => "",            # 「同」の後に入れる文字列
+        :separator     => "",            # "34歩" を "34 歩" のようにしたいときの隙間文字列
+        :compact_if_gt => 7,             # 半角7文字幅以上なら空白除去
+        :place_format  => :name,         # name は "3四" で zenkaku_number は "３４" で hankaku_number なら "34"
+        :char_type     => :formal_sheet, # :formal_sheet => 駒表記を「全」ではなく「成銀」のようにする nil: 「全」
+      }.merge(options)
+
+      @hand_log = hand_log
+
+      unless candidate_soldiers
+        raise BioshogiError, "candidate_enable オプションが有効になっていないため KI2 の特殊な移動表記を作れません"
+      end
+    end
+
+    def to_s
+      s = []
+
+      if location_name
+        s << location_name
+      end
+
+      if hand_log.place_same
+        s << kw("同") + @options[:same_suffix]
+      else
+        s << place_name
+        s << @options[:separator]
+      end
+
+      if type == "t_drop"
+        s << piece_name
+        # 日本将棋連盟 棋譜の表記方法
+        # https://www.shogi.or.jp/faq/kihuhyouki.html
+        #
+        # > 到達地点に盤上の駒が移動することも、持駒を打つこともできる場合
+        # > 盤上の駒が動いた場合は通常の表記と同じ
+        # > 持駒を打った場合は「打」と記入
+        # > ※「打」と記入するのはあくまでもその地点に盤上の駒を動かすこともできる場合のみです。
+        # > それ以外の場合は、持駒を打つ場合も「打」はつけません。
+        if @options[:force_drop] || !candidate_soldiers.empty?
+          s << kw("打")
+        end
+      elsif type == "t_promote_on"
+        s << piece_name
+        s << motion
+        s << kw("成")
+      elsif type == "t_promote_throw"
+        s << piece_name
+        s << motion
+        s << kw("不成") # or "生"
+      elsif type == "t_move"
+        s << soldier_name
+        s << motion
+      else
+        raise "must not happen"
+      end
+
+      s = s.join
+      s = str_compact(s)
+
+      if @options[:with_location]
+        s = location.mark + s
+      end
+
+      s
+    end
+
+    def to_debug_hash
+      {
+        :place_from     => place_from,
+        :place_to       => place_to,
+        :candidate_soldiers      => candidate_soldiers.collect(&:name),
+        :koreru_c       => koreru_c,
+        :_migi_idou     => _migi_idou?,
+        :_hidari_idou   => _hidari_idou?,
+        :_ue_idou       => _ue_idou?,
+        :_shita_idou    => _shita_idou?,
+        :_hidari_kara_c => _hidari_kara_c,
+        :_migi_kara_c   => _migi_kara_c,
+        :yoreru_c       => yoreru_c,
+        :agareru_c      => agareru_c,
+        :sagareru_c     => sagareru_c,
+        :shita_y        => shita_y,
+        :_tx            => _tx,
+        :_ty            => _ty,
+        :_ox            => _ox,
+        :_oy            => _oy,
+        :_xr            => _xr,
+        :_yr            => _yr,
+      }
+    end
+
+    private
+
+    def type
+      @type ||= hand.type
+    end
+
+    # 3文字以上なら空白を詰める
+    def str_compact(str)
+      if v = @options[:compact_if_gt]
+        if str.encode("EUC-JP").bytesize >= v
+          str = str.remove(/\p{blank}/)
+        end
+      end
+      str
+    end
+
+    def motion
+      if koreru_c >= 2
+        if piece.brave?
+          brave_motion
+        else
+          basic_motion
+        end
+      end
+    end
+
+    def brave_motion
+      # 連盟の複雑そうなルールをコードに落とし込むには次の方法でよさそう
+      #
+      #  左右だけがつく場合
+      #
+      #   1. 移動元で二つの龍が水平線上にいる
+      #   2. または、水平線上よりすべて上かすべて下
+      #
+      #  1, 2 に該当しなかったら
+      #
+      #   ・下移動なら → 引
+      #   ・上移動なら → 上
+      #   ・横移動なら → 寄
+      #
+      if idou_moto_no_ryu_ga_suihei_ni_iru? || idousakino_suiheisenjou_yori_subete_ue_mataha_shita?
+        case
+        when _xr.max == _ox
+          _i("右")
+        when _xr.min == _ox
+          _i("左")
+        else
+          raise MustNotHappen
+        end
+      else
+        case
+        when _shita_idou?
+          _i("引")
+        when _ue_idou?
+          _i("上")
+        when yoko_idou?
+          kw("寄")
+        end
+      end
+    end
+
+    def basic_motion
+      case
+      when koreru_c >= 3
+        case
+        when yoko_idou? && yoreru_c == 1 # 3B 寄る(ことができる)駒が1枚しかないので「寄」のみ
+          "寄"
+        when yoko_idou? && yoreru_c >= 2 # P3B_A 寄る(ことができる)駒が2枚以上なので「左右」＋「寄」
+          case
+          when _hidari_idou?
+            _i("右") + kw("寄")
+          when _migi_idou?
+            _i("左") + kw("寄")
+          else
+            raise MustNotHappen
+          end
+        when tate_idou? && (_ty + 1) == _oy # P3B
+          _w("直", "引")
+        when tate_idou? && (_ty - 1) == _oy # P3B
+          _w("引", "直")
+
+        when _hidari_idou? && _migi_kara_c == 1 # P3B, P3C
+          _i("右")
+        when _hidari_idou? && _migi_kara_c >= 2 && _ue_idou? # P3B
+          _i("右") + _i("上")
+        when _hidari_idou? && _migi_kara_c >= 2 && _shita_idou? # P3B, P3C
+          _i("右") + _i("引")
+
+        when _migi_idou? && _hidari_kara_c == 1
+          _i("左")
+        when _migi_idou? && _hidari_kara_c >= 2 && _ue_idou? # P3B
+          _i("左") + _i("上")
+        when _migi_idou? && _hidari_kara_c >= 2 && _shita_idou? # P3B, P3C
+          _i("左") + _i("引")
+        else
+          raise MustNotHappen
+        end
+      when agareru_c >= 2 && shita_y == _oy && tate_idou? # P2D 例外で、金銀が横に2枚以上並んでいる場合のみ1段上に上がる時「直」
+        kw("直")
+      when agareru_c == 2 # P2A 上がる駒が2枚ある場合「上」を省略して「左」「右」
+        case
+        when _hidari_idou?
+          _i("右")
+        when _migi_idou?
+          _i("左")
+        else
+          raise MustNotHappen
+        end
+      when yoreru_c == 2 # P2B 寄る駒が2枚ある場合「寄」を省略して「左」「右」
+        case
+        when _hidari_idou?
+          _i("右")
+        when _migi_idou?
+          _i("左")
+        else
+          raise MustNotHappen
+        end
+      when sagareru_c == 2 # P2C 引く駒が2枚ある場合「引」を省略して「左」「右」
+        case
+        when _hidari_idou?
+          _i("右")
+        when _migi_idou?
+          _i("左")
+        else
+          raise MustNotHappen
+        end
+      else
+        # P1A P1B P1C P1D P1E 到達地点に複数の同じ駒が動ける場合、「上」または「寄」または「引」
+        case
+        when _ue_idou?
+          _w("上", "引")
+        when _shita_idou?
+          _w("引", "上")
+        when _ty == _oy
+          kw("寄")
+        else
+          raise MustNotHappen
+        end
+      end
+    end
+
+    # 右に移動する？
+    def _migi_idou?
+      _ox < _tx
+    end
+
+    # 左に移動する？
+    def _hidari_idou?
+      _tx < _ox
+    end
+
+    # 上に移動する？
+    def _ue_idou?
+      _ty < _oy
+    end
+
+    # 下に移動する？
+    def _shita_idou?
+      _oy < _ty
+    end
+
+    # 水平に移動する？
+    def yoko_idou?
+      _oy == _ty
+    end
+
+    # 垂直に移動する？
+    def tate_idou?
+      _ox == _tx
+    end
+
+    # 移動先にこれる駒の数
+    def koreru_c
+      candidate_soldiers.count
+    end
+
+    # 左からこれる駒の数
+    def _hidari_kara_c
+      candidate_soldiers.count { |s| s.place.x.value < _tx }
+    end
+
+    # 右からこれる駒の数
+    def _migi_kara_c
+      candidate_soldiers.count { |s| s.place.x.value > _tx }
+    end
+
+    # 水平に寄れる駒の数
+    def yoreru_c
+      candidate_soldiers.count { |s| s.place.y.value == _ty }
+    end
+
+    # 上がれる駒の数(移動先より下にある数)
+    def agareru_c
+      candidate_soldiers.count { |s| s.place.y.value.send(_i(:>), _ty) }
+    end
+
+    # 下がれる駒の数(移動先より上にある数)
+    def sagareru_c
+      candidate_soldiers.count { |s| s.place.y.value.send(_i(:<), _ty) }
+    end
+
+    # 移動先X
+    def _tx
+      @_tx ||= place_to.x.value
+    end
+
+    # 移動元Y
+    def _ty
+      @_ty ||= place_to.y.value
+    end
+
+    # プレイヤー視点から見た移動先の一つ下
+    def shita_y
+      _ty + _i(1)
+    end
+
+    # プレイヤー視点から見た移動先の一つ上
+    def ue_y
+      _ty + _i(-1)
+    end
+
+    # 移動元X
+    def _ox
+      @_ox ||= place_from.x.value
+    end
+
+    # 移動先Y
+    def _oy
+      @_oy ||= place_from.y.value
+    end
+
+    # 候補手の座標範囲
+    def _xr
+      @_xr ||= Range.new(*candidate_soldiers.collect { |e| e.place.x.value }.minmax)
+    end
+
+    def _yr
+      @_yr ||= Range.new(*candidate_soldiers.collect { |e| e.place.y.value }.minmax)
+    end
+
+    # 移動元で二つの龍が水平線上にいる？
+    def idou_moto_no_ryu_ga_suihei_ni_iru?
+      candidate_soldiers.collect { |e| e.place.y.value }.uniq.size == 1
+    end
+
+    # 移動先の水平線上よりすべて上 or すべて下
+    # つまり、移動先のYが候補のYの範囲に含まれている
+    # だから candidate_soldiers.all?{|s|s.place.y.value < _ty} || candidate_soldiers.all?{|s|s.place.y.value > _ty} から !_yr.cover?(_ty) に変更できる
+    def idousakino_suiheisenjou_yori_subete_ue_mataha_shita?
+      !_yr.cover?(_ty)
+    end
+
+    # # 「打」？
+    # def drop_trigger?
+    #   drop_hand
+    # end
+
+    # 「成」？
+    # def promote_trigger?
+    #   if move_hand
+    #     move_hand.promote_trigger?
+    #   end
+    # end
+
+    # 移動元
+    def place_from
+      if move_hand
+        move_hand.origin_soldier.place
+      end
+    end
+
+    # 移動先
+    def place_to
+      place
+    end
+
+    def location_name
+    end
+
+    ################################################################################ 読み方
+
+    def piece_name
+      piece.name
+    end
+
+    def place_name
+      place_to.public_send(@options[:place_format])
+    end
+
+    def soldier_name
+      soldier.any_name(char_type: @options[:char_type])
+    end
+
+    def kw(s)
+      s
+    end
+
+    concerning :InvertMethods do
+      private
+
+      def _w(*values)
+        if s = location.which_value(*values)
+          if s.kind_of?(String)
+            s = kw(s)
+          end
+        end
+        s
+      end
+
+      def _i(v)
+        _w(v, invertable_hash.fetch(v))
+      end
+
+      def invertable_hash
+        @invertable_hash ||= invertable_one_side_hash.merge(invertable_one_side_hash.invert)
+      end
+
+      def invertable_one_side_hash
+        {
+          1    => -1,
+          "右" => "左",
+          "引" => "上",
+          :<   => :>,
+        }
+      end
+    end
+  end
+end

data/lib/bioshogi/order_info.rb

@@ -0,0 +1,12 @@
+# frozen-string-literal: true
+
+# ▲△とは関係がない
+module Bioshogi
+  class OrderInfo
+    include ApplicationMemoryRecord
+    memory_record [
+      { key: :sente, name: "先手"}, # 奇数回に指す側
+      { key: :gote,  name: "後手"}, # 偶数回に指す側
+    ]
+  end
+end

data/lib/bioshogi/parser/base.rb

@@ -0,0 +1,61 @@
+# -*- compile-command: "bundle execute rspec ../../spec/kif_format_spec.rb" -*-
+# frozen-string-literal: true
+
+module Bioshogi
+  module Parser
+    class Base
+      include Formatter::ParserMethods
+
+      class << self
+        def parse(source, options = {})
+          new(source, options).tap(&:parse)
+        end
+
+        def file_parse(file, options = {})
+          parse(Pathname(file).expand_path.read, options)
+        end
+
+        def accept?(source)
+          raise NotImplementedError, "#{__method__} is not implemented"
+        end
+
+        def default_parser_options
+          {
+            # embed: 二歩の棋譜なら例外を出さずに直前で止めて反則であることを棋譜に記す
+            #  skip: 棋譜には記さない
+            # false: 例外を出す(デフォルト)
+            :typical_error_case             => false,
+            :skill_monitor_enable           => true,
+            :skill_monitor_technique_enable => true,
+            :candidate_enable               => true,  # ki2にしないのであれば指定するとかなり速くなる
+
+            :validate_enable                => true,  # 将棋ウォーズの棋譜なら指定すると少し速くなる
+            :validate_double_pawn_skip      => false, # 二歩を無視するか？
+            :validate_warp_skip             => false, # 角ワープを無視するか？
+          }
+        end
+      end
+
+      attr_accessor :pi
+      attr_accessor :parser_options
+
+      def initialize(source, parser_options = {})
+        @source = Source.wrap(source)
+        @parser_options = self.class.default_parser_options.merge(parser_options)
+        @pi = Pi.new
+      end
+
+      def parse
+        raise NotImplementedError, "#{__method__} is not implemented"
+      end
+
+      def normalized_source
+        @normalized_source ||= @source.to_s
+      end
+
+      def inspect
+        Inspector.new(self).inspect
+      end
+    end
+  end
+end

data/lib/bioshogi/parser/bod_parser.rb

@@ -0,0 +1,8 @@
+# frozen-string-literal: true
+
+module Bioshogi
+  module Parser
+    class BodParser < KifParser
+    end
+  end
+end

data/lib/bioshogi/parser/csa_parser.rb

@@ -0,0 +1,198 @@
+# frozen-string-literal: true
+module Bioshogi
+  module Parser
+    class CsaParser < Base
+      SYSTEM_COMMENT_CHAR = "'"
+      KEY_VALUE_REGEXP = /^(N[+-]|\$\w+:)(.*)$/
+
+      # 将棋ウォーズの時間はバグっていてマイナスの時間になることがあるため T-123 形式も考慮する。
+      # ただし、これを最後まで許容すると KIF の時間もマイナス表記になり、KENTOが読み込みに失敗する。
+      # いまは MainClock クラスの add でチェックしてしかたなくマイナスにならないようにしている。
+      TIME_REGEXP = /[A-Z]([+-]?\d+)/
+
+      # 指し手
+      MOVE_REGEXP = /^([+-]?\d+\w+)\R+(?:#{TIME_REGEXP})?/o
+
+      class << self
+        def accept?(source)
+          str = Source.wrap(source).to_s
+          v = false
+          v ||= str.match?(/^\s*\b(V\d+\.\d+)\b/)  # V2.2 '# Kifu for iPhone V4.01 棋譜ファイル' の V4.01 がひっかかってしまうため ^\s* を入れるの重要
+          v ||= str.match?(/\b(PI|P\d|P[\+\-])\b/) # PI P1 P+ P-
+          v ||= str.match?(/[+-]\d{4}[A-Z]{2}/)    # +1828OU
+          v ||= str.match?(/\b(N[+-])\b/)          # 対局者名
+        end
+      end
+
+      def parse
+        key_value_store
+
+        case1_PI
+        case2_P1
+        case3_Psign
+
+        guess_preset
+
+        read_turn
+        read_moves
+        read_last
+
+        pi.header.normalize
+      end
+
+      private
+
+      def normalized_source
+        @normalized_source ||= Source.wrap(@source).to_s.yield_self do |s|
+          s = s.gsub(/^#{SYSTEM_COMMENT_CHAR}.*/o, "")  # コメント行の削除
+          s = s.gsub(/,/, "\n")                         # カンマは改行と見なす
+        end
+      end
+
+      # ヘッダーっぽいのもを収集
+      def key_value_store
+        normalized_source.scan(KEY_VALUE_REGEXP) do |key, value|
+          # キーをKIF側に統一
+          if e = CsaHeaderInfo[key]
+            key = e.kif_side_key
+          end
+          # ヘッダー情報が重複した場合は最初に出てきたものを優先
+          pi.header[key] ||= value
+        end
+      end
+
+      ################################################################################ (1)
+      # > (1) 平手初期配置と駒落ち
+      # > 平手初期配置は、"PI"とする。駒落ちは、"PI"に続き、落とす駒の位置と種類を必要なだけ記述する。
+      # > 例:二枚落ち PI82HI22KA
+      def case1_PI
+        if md = normalized_source.match(/^PI(?<handicap_piece_list>.*)/)
+          @board = Board.new
+          @board.placement_from_preset("平手")
+          if v = md[:handicap_piece_list]
+            v.scan(/(\d+)(\D+)/i) do |xy, piece_key|
+              place = Place.fetch(xy)
+              piece = Piece.fetch(piece_key)
+              soldier = @board.fetch(place)
+              if soldier.piece != piece
+                raise SyntaxDefact, "#{v}として#{place}#{piece.name}を落とす指定がありましたがそこにある駒は#{soldier.any_name}です"
+              end
+              @board.safe_delete_on(soldier.place)
+            end
+          end
+        end
+      end
+
+      ################################################################################ (2)
+      # > (2) 一括表現
+      # > 1行の駒を以下のように示す。行番号に続き、先後の区別と駒の種類を記述する。
+      # > 先後の区別が"+""-"以外のとき、駒がないとする。
+      # > 1枡3文字で9枡分記述しないといけない。
+      # > 例:
+      # > P1-KY-KE-GI-KI-OU-KI-GI-KE-KY
+      # > P2 * -HI *  *  *  *  * -KA *
+      def case2_P1
+        if normalized_source.match?(/^P\d/)
+          if @board
+            raise SyntaxDefact, "1行表現の PI と、複数行一括表現の P1 の定義が干渉しています"
+          end
+          str = normalized_source.scan(/^P\d.*\n/).join
+
+          @board = Board.new
+          @board.placement_from_shape(str)
+        end
+      end
+
+      ################################################################################ (3)
+      # > (3) 駒別単独表現
+      # > 一つ一つの駒を示すときは、先後の区別に続き、位置と駒の種類を記述する。持駒に限り、駒の種類として"AL"が使用でき、残りの駒すべてを表す。駒台は"00"である。
+      # > 玉は、駒台へはいかない。
+      #
+      # P-51OU        …… 後手 ５一玉          を配置
+      # P+53KI00GI    …… 先手 ５三金 駒台に銀 を配置
+      # P-00AL        …… 後手 残りすべての駒を駒台に配置
+      #
+      # NOTE: (2)の一括表現と(3)の駒別単独表現は共存する
+      # ドキュメントにはこのあたりの言及がなかったため @pi.board_source がすでにあればスキップしていたが
+      # 詰将棋などではここで持駒を調整される
+      def case3_Psign
+        if normalized_source.match?(/^P[\+\-](.*)/)
+          # この時点で盤が用意されていなかったら空の盤を用意する
+          unless @board
+            @board = Board.new
+          end
+
+          # 駒箱
+          piece_box = PieceBox.real_box
+
+          # 両者の駒台
+          hold_pieces = Location.inject({}) { |a, e| a.merge(e => []) }
+
+          normalized_source.scan(/^P([\+\-])(.*)$/) do |location_key, piece_list|
+            location = Location.fetch(location_key)
+            piece_list.scan(/(\d+)(\D+)/i) do |xy, piece_ch|
+              if piece_ch == "AL"
+                if xy != "00"
+                  raise SyntaxDefact, "AL が指定されているのに座標が 00 になっていません"
+                end
+                # 残りすべてを駒台に置く
+                hold_pieces[location] += piece_box.pick_out_without_king
+              else
+                attrs = Soldier.piece_and_promoted(piece_ch)
+                # 駒箱から取り出す
+                piece = piece_box.pick_out(attrs[:piece])
+                if xy == "00"
+                  # 駒台に置く
+                  hold_pieces[location] << piece
+                else
+                  # 盤に置く
+                  # if @pi.board_source
+                  #   raise SyntaxDefact, "P#{location_key}#{xy}#{piece_ch} としましたがすでに、PI か P1 表記で盤面の指定があります。無駄にややこしくなるので PI P1 P+59OU 表記を同時に使わないでください"
+                  # end
+                  soldier = Soldier.create(attrs.merge(location: location, place: Place.fetch(xy)))
+                  @board.place_on(soldier, validate: true)
+                end
+              end
+            end
+          end
+
+          hold_pieces.each do |location, pieces|
+            pi.player_piece_boxes[location.key].set(Piece.a_to_h(pieces))
+          end
+        end
+      end
+
+      def guess_preset
+        if @board
+          @pi.board_source = @board.to_s # FIXME: 元に戻すのは無駄
+          if e = @board.preset_info
+            @pi.force_preset_info = e
+          end
+        end
+      end
+
+      def read_turn
+        if md = normalized_source.match(/^(?<csa_sign>[+-])$/)
+          if Location.fetch(md["csa_sign"]).key == :white
+            @pi.force_handicap = true # 微妙な判定
+          end
+        end
+      end
+
+      def read_moves
+        @pi.move_infos += normalized_source.scan(MOVE_REGEXP).collect do |input, n|
+          if n
+            n = n.to_i.seconds
+          end
+          { input: input, used_seconds: n }
+        end
+      end
+
+      def read_last
+        if md = normalized_source.match(/^%(?<last_action_key>\S+)(\R+[A-Z](?<used_seconds>(\d+)))?/)
+          @pi.last_action_params = md.named_captures.symbolize_keys
+        end
+      end
+    end
+  end
+end