Line data Source code
1 : package keybind
2 :
3 : import (
4 : "strings"
5 :
6 : "github.com/hajimehoshi/ebiten/v2"
7 : "github.com/kijimaD/ruins/internal/consts"
8 : "github.com/kijimaD/ruins/internal/inputmapper"
9 : w "github.com/kijimaD/ruins/internal/world"
10 : "github.com/kijimaD/ruins/internal/world/query"
11 : )
12 :
13 : // HintEntry はキー表記とラベル訳の組。ヒント行とキー一覧ヘルプが共有する表示単位。
14 : // Keys は文字列文脈用の連結表記で、Tokens は粒のままの表記
15 : type HintEntry struct {
16 : Keys string
17 : Label string
18 : Tokens []string
19 : }
20 :
21 : // HintEntries は束縛表から表示単位の一覧を導出する。表の順に並べ、Label が空の行は
22 : // 隠しキーとして出さない。連続する同じ Label の行はキー表記を連結して1項目にまとめる。
23 : // 隠しキーの行を挟んでも連続とみなすため、先に表示行だけへ絞ってからまとめる
24 : func HintEntries(world w.World, table []Binding) []HintEntry {
25 1 : var labeled []Binding
26 1 : for _, b := range table {
27 1 : if b.Label != "" {
28 1 : labeled = append(labeled, b)
29 1 : }
30 : }
31 :
32 1 : var entries []HintEntry
33 1 : for i := 0; i < len(labeled); {
34 : // i から同じ Label が続く範囲が1項目。j が範囲の終端に進む。
35 : // 同ラベルのキーは区切りなしで連結する。左右キーの Tab なら Keys は "←→" になる
36 1 : var keys strings.Builder
37 1 : var tokens []string
38 1 : j := i
39 1 : for ; j < len(labeled) && labeled[j].Label == labeled[i].Label; j++ {
40 1 : keys.WriteString(KeyLabel(labeled[j]))
41 1 : tokens = append(tokens, KeyTokens(labeled[j])...)
42 1 : }
43 1 : entries = append(entries, HintEntry{Keys: keys.String(), Label: query.T(world, labeled[i].Label), Tokens: tokens})
44 1 : i = j
45 : }
46 1 : return entries
47 : }
48 :
49 : // NavHint は束縛表からキー操作ヒントの1行を組む。表を変えれば表示が追随し、
50 : // 挙動とヒントの二重管理をなくす。戻る操作は常に最後に置くため、
51 : // ActionMenuCancel と ActionCloseMenu の行だけ末尾へ回す
52 : func NavHint(world w.World, table []Binding) string {
53 1 : var rows []Binding
54 1 : var closes []Binding
55 1 : for _, b := range table {
56 1 : if b.Action == inputmapper.ActionMenuCancel || b.Action == inputmapper.ActionCloseMenu {
57 1 : closes = append(closes, b)
58 1 : continue
59 : }
60 1 : rows = append(rows, b)
61 : }
62 1 : parts := make([]string, 0, 8)
63 1 : for _, e := range HintEntries(world, append(rows, closes...)) {
64 1 : parts = append(parts, e.Keys+" "+e.Label)
65 1 : }
66 1 : return strings.Join(parts, " ")
67 : }
68 :
69 : // HelpHint はキー一覧ヘルプへの入口だけを示すフッター文字列を組む。
70 : // 各画面の全キー列挙はヘルプ画面が担い、常設のフッターは入口の1項目に絞って画面を静かに保つ
71 : func HelpHint(world w.World) string {
72 1 : var rows []Binding
73 1 : for _, b := range MenuCommon {
74 1 : if b.Action == inputmapper.ActionOpenKeyHelp {
75 1 : rows = append(rows, b)
76 1 : }
77 : }
78 1 : return NavHint(world, rows)
79 : }
80 :
81 : // KeyTokens は Binding のキー表記をトークン列で返す。Shift 併用は Shift 記号のトークンを前置する。
82 : // 表記は全てアイコンフォントの箱なしグリフで、本文フォントの文字は混ぜない。
83 : // フォント合成の倍率差でサイズが割れるのを防ぐ。キーキャップの箱は描画側が一律に敷く
84 : func KeyTokens(b Binding) []string {
85 1 : if b.Key == ebiten.KeySlash && b.Shift == ShiftRequired {
86 1 : return []string{consts.IconQuestion}
87 1 : }
88 : // 数字キーは数字グリフで表す
89 1 : if b.Key >= ebiten.KeyDigit0 && b.Key <= ebiten.KeyDigit9 {
90 1 : return []string{string(consts.IconKeyDigitBase + rune(b.Key-ebiten.KeyDigit0))}
91 1 : }
92 : // 英字キーは英字グリフで表す。Shift 併用は Shift 記号の前置で表す
93 1 : if b.Key >= ebiten.KeyA && b.Key <= ebiten.KeyZ {
94 1 : keycap := string(consts.IconKeyAlphaBase + rune(b.Key-ebiten.KeyA))
95 1 : if b.Shift == ShiftRequired {
96 1 : return []string{consts.IconKeyShift, keycap}
97 1 : }
98 1 : return []string{keycap}
99 : }
100 1 : switch b.Key {
101 : case ebiten.KeyArrowLeft:
102 1 : return []string{consts.IconArrowLeft}
103 : case ebiten.KeyArrowRight:
104 1 : return []string{consts.IconArrowRight}
105 : case ebiten.KeyArrowUp:
106 1 : return []string{consts.IconArrowUp}
107 : case ebiten.KeyArrowDown:
108 1 : return []string{consts.IconArrowDown}
109 : case ebiten.KeyEnter:
110 1 : return []string{consts.IconKeyEnter}
111 : case ebiten.KeyEscape:
112 1 : return []string{consts.IconKeyEsc}
113 : case ebiten.KeySpace:
114 1 : return []string{consts.IconKeySpace}
115 : case ebiten.KeyTab:
116 0 : return []string{consts.IconKeyTab}
117 : case ebiten.KeyPeriod:
118 1 : return []string{consts.IconKeyDot}
119 : default:
120 : // 専用表記の無いキーは内部名をそのまま出す
121 0 : return []string{b.Key.String()}
122 : }
123 : }
124 :
125 : // KeyLabel は Binding のキー表記を文字列文脈用に連結して返す。フッターなど
126 : // 装飾を敷けない場所で使う。表記の規約は KeyTokens が持つが、? だけは ASCII で出す。
127 : // 文字列文脈は本文フォントと混ざるため、倍率の違うアイコングリフではサイズが割れる
128 : func KeyLabel(b Binding) string {
129 1 : if b.Key == ebiten.KeySlash && b.Shift == ShiftRequired {
130 1 : return "?"
131 1 : }
132 1 : return strings.Join(KeyTokens(b), "")
133 : }
|