LCOV - code coverage report
Current view: top level - keybind - keybind.go Coverage Total Hit
Test: coverage.lcov Lines: 100.0 % 37 37
Test Date: 2026-11-19 00:25:22 Functions: - 0 0

            Line data    Source code
       1              : // Package keybind はキーボード入力を Action へ変換し、再生時は world の供給源へ差し替える。
       2              : // メニュー・overlay・フィールドの全文脈から使い、入力層の差し替え点を1つにする。
       3              : // menuloop は overlay を import するため overlay から menuloop は呼べない。両者より下の
       4              : // このパッケージに置くことで、循環せず入力経路を共有できる。
       5              : //
       6              : // 文脈ごとのキーは Binding の表で宣言し、変換の実行はこのパッケージが担う。
       7              : // キー読み取りが呼び出し側へ散らないので、キー→Action 対応をまとめて単体テストできる。
       8              : package keybind
       9              : 
      10              : import (
      11              :         "fmt"
      12              : 
      13              :         "github.com/kijimaD/ruins/internal/i18n"
      14              : 
      15              :         "github.com/hajimehoshi/ebiten/v2"
      16              :         "github.com/kijimaD/ruins/internal/input"
      17              :         "github.com/kijimaD/ruins/internal/inputmapper"
      18              :         w "github.com/kijimaD/ruins/internal/world"
      19              : )
      20              : 
      21              : // ShiftMode は Binding が Shift 押下をどう扱うかを表す
      22              : type ShiftMode int
      23              : 
      24              : const (
      25              :         // ShiftAny は Shift の押下状態を問わない
      26              :         ShiftAny ShiftMode = iota
      27              :         // ShiftRequired は Shift が押されているときだけ一致する
      28              :         ShiftRequired
      29              :         // ShiftForbidden は Shift が押されていないときだけ一致する
      30              :         ShiftForbidden
      31              : )
      32              : 
      33              : // PressMode はキーの押下判定の種類
      34              : type PressMode int
      35              : 
      36              : const (
      37              :         // PressJust は押した瞬間の1フレームだけ発火する
      38              :         PressJust PressMode = iota
      39              :         // PressRepeat は押しっぱなしでリピート発火する。移動やカーソル送りに使う
      40              :         PressRepeat
      41              : )
      42              : 
      43              : // Binding は1つのキー操作と Action の対応。表の順で評価する
      44              : type Binding struct {
      45              :         Key    ebiten.Key
      46              :         Shift  ShiftMode
      47              :         Press  PressMode
      48              :         Action inputmapper.ActionID
      49              :         Label  i18n.Msgid // ヒント表示。空なら隠しキーとしてヒントに出さない
      50              : }
      51              : 
      52              : // MenuCommon はメニュー共通のキー束縛。画面固有の断片と MustMerge で1枚に合成して使う。
      53              : // 左右キーはタブ切替に固定する。全メニューで意味を揃え、ページ送りには使わない。
      54              : // 長い一覧は上下でカーソルがページ境界を越えると自動でページが繰られる。
      55              : // 全行の条件が互いに素なので、行の順序に意味は無い。
      56              : // Tab キーは左右の別名なので Label を持たせずヒントに出さない
      57              : var MenuCommon = []Binding{
      58              :         {Key: ebiten.KeyArrowLeft, Press: PressRepeat, Action: inputmapper.ActionMenuTabPrev, Label: "Tab"},
      59              :         {Key: ebiten.KeyArrowRight, Press: PressRepeat, Action: inputmapper.ActionMenuTabNext, Label: "Tab"},
      60              :         {Key: ebiten.KeyArrowUp, Press: PressRepeat, Action: inputmapper.ActionMenuUp, Label: "Select"},
      61              :         {Key: ebiten.KeyArrowDown, Press: PressRepeat, Action: inputmapper.ActionMenuDown, Label: "Select"},
      62              :         {Key: ebiten.KeyTab, Shift: ShiftRequired, Press: PressJust, Action: inputmapper.ActionMenuTabPrev},
      63              :         {Key: ebiten.KeyTab, Shift: ShiftForbidden, Press: PressJust, Action: inputmapper.ActionMenuTabNext},
      64              :         {Key: ebiten.KeyEnter, Press: PressJust, Action: inputmapper.ActionMenuSelect, Label: "Confirm"},
      65              :         {Key: ebiten.KeySlash, Shift: ShiftRequired, Press: PressJust, Action: inputmapper.ActionOpenKeyHelp, Label: "Help"},
      66              :         {Key: ebiten.KeyEscape, Press: PressJust, Action: inputmapper.ActionMenuCancel, Label: "Back"},
      67              : }
      68              : 
      69              : // ReadInput は1フレームぶんの入力を Action として読む。world が入力供給源を
      70              : // 持つならそこから読み、持たない本番ではキーボードから変換する。
      71              : // ここで入れ替わるのはキー入力の有無だけで、後段の DoAction 以降は本番と完全に同じ経路を通る。
      72              : // table は MustMerge 済みの1枚を渡す。実行時に表を重ねる階層は持たない
      73              : func ReadInput(world w.World, table []Binding) (inputmapper.ActionID, bool) {
      74            1 :         if src := world.Resources.InputSource; src != nil {
      75            1 :                 return src()
      76            1 :         }
      77            1 :         return Convert(input.GetSharedKeyboardInput(), table)
      78              : }
      79              : 
      80              : // Convert はキー入力を Action に変換する。本番の入力経路。
      81              : // 表の行は条件が互いに素になるよう MustMerge が検証済みなので、評価順に意味は無い。
      82              : // Shift 条件を押下判定より先に見て、リピート判定の副作用を条件外の行で起こさない
      83              : func Convert(ki input.KeyboardInput, table []Binding) (inputmapper.ActionID, bool) {
      84            1 :         shift := ki.IsKeyPressed(ebiten.KeyShift)
      85            1 :         for _, b := range table {
      86            1 :                 if b.Shift == ShiftRequired && !shift {
      87            1 :                         continue
      88              :                 }
      89            1 :                 if b.Shift == ShiftForbidden && shift {
      90            1 :                         continue
      91              :                 }
      92            1 :                 if !pressed(ki, b) {
      93            1 :                         continue
      94              :                 }
      95            1 :                 return b.Action, true
      96              :         }
      97            1 :         return "", false
      98              : }
      99              : 
     100              : // MustMerge は束縛表の断片を1枚に合成する。条件が重なる行の組があれば panic で拒否し、
     101              : // ある断片が別の断片のキーを黙って影で食う継承的な事故を構築時に締め出す。
     102              : // 検査が走るのは合成の実行時。パッケージ変数の表は起動時に、Screen の表はその画面の構築時に走る
     103              : func MustMerge(fragments ...[]Binding) []Binding {
     104            1 :         var table []Binding
     105            1 :         for _, f := range fragments {
     106            1 :                 table = append(table, f...)
     107            1 :         }
     108            1 :         if err := validate(table); err != nil {
     109            1 :                 panic(err)
     110              :         }
     111            1 :         return table
     112              : }
     113              : 
     114              : // validate は表の全行対で条件の重なりを検査する。同じキーで Shift 条件が交差する組は、
     115              : // どちらが発火するかが行順に依存するため拒否する。
     116              : // PressMode は検査に含めない。ShiftRequired と ShiftForbidden は同時に真になれない排他条件だが、
     117              : // PressRepeat と PressJust は押した瞬間に両方成立しうるので、キーを分ける条件として使えない。
     118              : // 同じキーを押下モードで振り分けるのでなく、キー自体を分けて設計する
     119              : func validate(table []Binding) error {
     120            1 :         for i, a := range table {
     121            1 :                 for _, b := range table[i+1:] {
     122            1 :                         if a.Key != b.Key {
     123            1 :                                 continue
     124              :                         }
     125            1 :                         shiftOverlap := a.Shift == ShiftAny || b.Shift == ShiftAny || a.Shift == b.Shift
     126            1 :                         if !shiftOverlap {
     127            1 :                                 continue
     128              :                         }
     129            1 :                         return fmt.Errorf("keybind: overlapping bindings: %s and %s compete for key %v", a.Action, b.Action, a.Key)
     130              :                 }
     131              :         }
     132            1 :         return nil
     133              : }
     134              : 
     135              : // pressed は Binding の押下モードに応じたキー判定を返す。
     136              : // Enter は押下押上のワンセット検出というデバイス層の癖を持つため、ここでだけ特別に扱う
     137              : func pressed(ki input.KeyboardInput, b Binding) bool {
     138            1 :         if b.Press == PressRepeat {
     139            1 :                 return ki.IsKeyPressedWithRepeat(b.Key)
     140            1 :         }
     141            1 :         if b.Key == ebiten.KeyEnter {
     142            1 :                 return ki.IsEnterJustPressedOnce()
     143            1 :         }
     144            1 :         return ki.IsKeyJustPressed(b.Key)
     145              : }
        

Generated by: LCOV version 2.0-1