Python

授業でPygameを触り、グループワーク時にタイピングゲームを作ったので、その時に面倒だったテキスト入力の備忘録。 Pygame 1.9.5(SDL2.0.0)以降のテキスト入力 Pygame1.9.5以降、新たなイベントが加わり、テキスト入力が比較的楽になったようです(多分)。とはいえ、Pygameの日本語のドキュメントにそれがまだ載ってない上に、公式のテキスト入力のサンプル(この記事の執筆時の最新コミット)も分かりづらかったので、改めて書くことにしました。テキスト入力系で追加されたのは、TEXTINPUTとTEXTEDITINGの2つです。TEXTINPUTは直接入力モード時に受け取るイベント、TEXTEDITINGがIMEを使っている時に受け取るイベントらしいです。また、SDLのバグの関係で、IMEの予測変換は使えないので今回はそれを扱っていません。 プログラム ライブラリ化したものを上げておきました。ご活用ください。 以下がテキストの処理をするロジック(text.py) from typing import List class Text: """ PygameのINPUT、EDITINGイベントで使うクラス カーソル操作や文字列処理に使う """ def __init__(self) -> None: self.text = ["|"] # 入力されたテキストを格納していく変数 self.editing: List[str] = [] # 全角の文字編集中(変換前)の文字を格納するための変数 self.is_editing = False # 編集中文字列の有無(全角入力時に使用) self.cursor_pos = 0 # 文字入力のカーソル(パイプ|)の位置 def __str__(self) -> str: """self.textリストを文字列にして返す""" return "".join(self.text) def edit(self, text: str, editing_cursor_pos: int) -> str: """ edit(編集中)であるときに呼ばれるメソッド 全角かつ漢字変換前の確定していないときに呼ばれる """ if text: # テキストがあるなら self.is_editing = True for x in text: self.editing.append(x) # 編集中の文字列をリストに格納していく self.editing.insert(editing_cursor_pos, "|") # カーソル位置にカーソルを追加 disp = "[" + "".join(self.editing) + "]" else: self.is_editing = False # テキストが空の時はFalse disp = "|" self.editing = [] # 次のeditで使うために空にする # self.cursorを読み飛ばして結合する return ( format(self)[0 : self.cursor_pos] + disp + format(self)[self.cursor_pos + 1 :] ) def input(self, text: str) -> str: """半角文字が打たれたとき、もしくは全角で変換が確定したときに呼ばれるメソッド""" self.is_editing = False # 編集中ではなくなったのでFalseにする for x in text: self.text.insert(self.cursor_pos, x) # カーソル位置にテキストを追加 # 現在のカーソル位置にテキストを追加したので、カーソル位置を後ろにずらす self.cursor_pos += 1 return format(self) def delete_left_of_cursor(self) -> str: """カーソルの左の文字を削除するためのメソッド""" # カーソル位置が0であるとき if self.cursor_pos == 0: return format(self) self.text.pop(self.cursor_pos - 1) # カーソル位置の一個前(左)を消す self.cursor_pos -= 1 # カーソル位置を前にずらす return format(self) def delete_right_of_cursor(self) -> str: """カーソルの右の文字を削除するためのメソッド""" # カーソル位置より後ろに文字がないとき if len(self.text[self.cursor_pos+1:]) == 0: return format(self) self.text.pop(self.cursor_pos + 1) # カーソル位置の一個後(右)を消す return format(self) def enter(self) -> str: """入力文字が確定したときに呼ばれるメソッド""" # カーソルを読み飛ばす entered = ( format(self)[0 : self.cursor_pos] + format(self)[self.cursor_pos + 1 :] ) self.text = ["|"] # 次回の入力で使うためにself.textを空にする self.cursor_pos = 0 # self.text[0] == "|"となる return entered def move_cursor_left(self) -> str: """inputされた文字のカーソル(パイプ|)の位置を左に動かすメソッド""" if self.cursor_pos > 0: # カーソル位置をカーソル位置の前の文字と交換する self.text[self.cursor_pos], self.text[self.cursor_pos - 1] = ( self.text[self.cursor_pos - 1], self.text[self.cursor_pos], ) self.cursor_pos -= 1 # カーソルが1つ前に行ったのでデクリメント return format(self) def move_cursor_right(self) -> str: """inputされた文字のカーソル(パイプ|)の位置を右に動かすメソッド""" if len(self.text) - 1 > self.cursor_pos: # カーソル位置をカーソル位置の後ろの文字と交換する self.text[self.cursor_pos], self.text[self.cursor_pos + 1] = ( self.text[self.cursor_pos + 1], self.text[self.cursor_pos], ) self.cursor_pos += 1 # カーソルが1つ後ろに行ったのでインクリメント return format(self) 次に、プログラム本体(text_input.py)ですが、日本語が扱えるフォントを用意しておく必要があります(Windowsならコピペでも動くかもしれません)。追記をご参照ください。 ...