2023年4月15日
multiple-cursors.el は、複数のカーソルによる編集機能を提供するEmacs パッケージです。これにより、単語、フレーズに複数のカーソルを出現させ、それら全てに対して同時にアクションを実行することができます。一度に数行のテキストを編集したり、コード内の変数、関数名を一度に書き換えたりするために使用できます。
こちらが完成済みのコードです。
(use-package multiple-cursors
:ensure t
:bind (
;; カーソルを当てているキーワードと同じキーワードにカーソルを複製する
;; リージョンが選ばれている場合は、選ばれたキーワードと同じ場所にカーソルを複製する
("C-." . mc/mark-next-like-this-symbol)
("C-," . mc/mark-previous-like-this-symbol)
;; カーソルを1行下または上に複製する
;; リージョンが選ばれている場合は、厳密にそのキーワードとマッチする箇所にカーソルを複製する
("C-c C-." . mc/mark-next-symbol-like-this)
("C-c C-," . mc/mark-previous-symbol-like-this)
;; カーソルを当てているキーワードで、同一ファイル上全ての場所にカーソルを複製する
;; リージョンが選ばれている場合は、選ばれたキーワードと同じ箇所全てにカーソルを複製する
("C-c C-;" . mc/mark-all-like-this-dwim)
))
使い方
このサンプルコードを編集するという体で説明します。
def replace_file_string(filename, oldstring, newstring):
with open(filename, 'r') as f:
contents = f.read()
contents = contents.replace(oldstring, newstring)
with open(filename, 'w') as f:
f.write(contents)
replace_file_string('file.txt', 'old', 'new')
コードの
contents
変数を別のものに変更してみましょう。一番最初のcontents
変数にカーソルを合わせた後、("C-." mc/mark-next-like-this-symbol)
で同じキーワードをにカーソルを置いてゆきます。![article image](https://prod-files-secure.s3.us-west-2.amazonaws.com/a3d79190-572a-4604-a045-8b27c534a5b2/a6f9995f-7e33-4df4-b6b6-f37a0ac5e67d/set.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45HZZMZUHI%2F20240727%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240727T063543Z&X-Amz-Expires=3600&X-Amz-Signature=35a58ffd2fb67d56f4f9452bfe48483a03e7e07fc20dc999fb40dd7e4ed9f9fa&X-Amz-SignedHeaders=host&x-id=GetObject)
この状態では全てのカーソルでリージョン選択状態になっています。
普通のカーソルとして、操作をしたい場合は1度
C-g
で選択モードを解除します。contents
を適当にabc
みたいな変数に変更してみます。バックスペースで文字を消して、最後にabc
とタイプすれば全ての変数が変換されます。![article image](https://prod-files-secure.s3.us-west-2.amazonaws.com/a3d79190-572a-4604-a045-8b27c534a5b2/758cf75a-b3bb-4a21-b11e-c45cc8dcc8af/change_name.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45HZZMZUHI%2F20240727%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240727T063543Z&X-Amz-Expires=3600&X-Amz-Signature=e0373f1f64bf6723952a0b5db1efdfb63d3f913463f67b666ebd272faba4c7b4&X-Amz-SignedHeaders=host&x-id=GetObject)
マルチカーソルを解除したい場合は
C-g
でできます。注意キャメルケースをうまく認知できない
このカーソル複製方法は、キャメルケースによる変数の違いをうまく認知できません。
コードをこのように変更してみます。
def replace_file_string(filename, oldstring, newstring):
with open(filename, 'r') as f:
contents = f.read()
contentsEdited = contents.replace(oldstring, newstring)
with open(filename, 'w') as f:
f.write(contentsEdited)
replace_file_string('file.txt', 'old', 'new')
下の画像のように、
contents
とcontentsEdited
は別の変数であるにも関わらず、どちらもcontents
が含まれているため、カーソルが複製されてしまいます。![article image](https://prod-files-secure.s3.us-west-2.amazonaws.com/a3d79190-572a-4604-a045-8b27c534a5b2/93dacea8-b72f-42dc-9353-d5ce281b64ab/mistake.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45HZZMZUHI%2F20240727%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240727T063543Z&X-Amz-Expires=3600&X-Amz-Signature=221e613a8c0da8822b1f6db4da19d0f6d2167c3bab99a5a59a32ba953415e461&X-Amz-SignedHeaders=host&x-id=GetObject)
より厳密にカーソルを複製
上で利用した
mark-next-like-this-symbol
はざっくりとしたキーワードの範囲でカーソルを複製します。そうではなく、リージョンで選んだ範囲でマッチするものにカーソルを複製する方法もあります。
contents
に正確にマッチする場所にカーソルを複製してみましょう。一番上のcontents
変数をC-SPC
で選択して、("C-c C-." . mc/mark-next-symbol-like-this)
でカーソルを複製します。![article image](https://prod-files-secure.s3.us-west-2.amazonaws.com/a3d79190-572a-4604-a045-8b27c534a5b2/a0bcb85a-f8a0-4af8-b57a-3d957d555727/strict.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45HZZMZUHI%2F20240727%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240727T063545Z&X-Amz-Expires=3600&X-Amz-Signature=30c7e82dba2c3a1c11b662927efe828cda08460611d0e7026a4b2b1e15a0c21f&X-Amz-SignedHeaders=host&x-id=GetObject)
一気にカーソルを複製する
1つ1つ
C-.
でカーソルを増やすのが面倒な場合は、カーソルを複製したいキーワードにカーソルを当てて、"C-c C-." mc/mark-all-like-this-dwim
一括選択できます。注意としましてはバッファ内全てのキーワードにカーソルを複製するので、もしかすると意図しない場所にもカーソルが生まれているかもしれません。あとは同じように一度にカーソルを操作できます。メインカーソルを移動する
カーソルが複製されている場所が、必ずしも、現在見えているバッファの中だけに収まる訳ではありません。正しい場所にカーソルが複製できるかチェックするためにも移動はできると良いしょう。メインのカーソルは複製を始めたところにあります。私のテーマでは灰色になっているカーソルがメインで、黒色が複製されたカーソルです。メインのカーソルを次の候補に移動させるには
C-v
前に戻るにはM-v
で移動できます。![article image](https://prod-files-secure.s3.us-west-2.amazonaws.com/a3d79190-572a-4604-a045-8b27c534a5b2/a6f9995f-7e33-4df4-b6b6-f37a0ac5e67d/set.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45HZZMZUHI%2F20240727%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240727T063547Z&X-Amz-Expires=3600&X-Amz-Signature=184c61fccf775b937f31a0ed9ab56e869c87ac08d3853b9c52bb3ab6c5c97a8d&X-Amz-SignedHeaders=host&x-id=GetObject)
マルチカーソルでよく使うパターン
例えば、マークダウンを書いていて、このようなリストがあるとします。
- 項目1
- サブ項目1
- サブ項目2
- サブ項目3
- サブ項目4
一連の
サブ項目
をトップの階層に移動させたい場合、普通に操作すると、各行のインデントを削除していく必要があります。multiple-cursorsはこれをうまい具合にやってくれます。カーソルを
- サブ項目1
の -
に合わせて、("C-c C-." mc/mark-next-symbol-like-this)
を実行します。このコマンドははリージョンを選択していない場合は、現在のカーソルの1つ下にカーソルを複製してくれます。ババっとこんな感じにカーソルを複製します。![article image](https://prod-files-secure.s3.us-west-2.amazonaws.com/a3d79190-572a-4604-a045-8b27c534a5b2/ec399e2c-fd05-4a8d-b9cc-8fe2820ee0e5/list-cursor.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45HZZMZUHI%2F20240727%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240727T063543Z&X-Amz-Expires=3600&X-Amz-Signature=b14dc4c9e7beb628c0eeb82e37b38812f1d58725f230636930669d7ea4e9d8e4&X-Amz-SignedHeaders=host&x-id=GetObject)
そのまま、バックスペースをタイプすると、良い感じに階層を上に移動できます。
![article image](https://prod-files-secure.s3.us-west-2.amazonaws.com/a3d79190-572a-4604-a045-8b27c534a5b2/e71b0d56-9ee9-4165-8c9e-cfb631d753dd/cursor.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45HZZMZUHI%2F20240727%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240727T063546Z&X-Amz-Expires=3600&X-Amz-Signature=8244cc0ee8996eda84c02765a95f078651491f960ce3eedbcc9b447207da3053&X-Amz-SignedHeaders=host&x-id=GetObject)
まとめ
カーソル複製の操作は正直複雑です。このブログを書いているときも思ったような複製が出来なくて色々試していました。もしも操作に迷った時は上のサンプルコードのコメントを参考にしてください。
![profile image](/prof.jpg)
Ted
大学でコンセンサスアルゴリズムを研究。卒業後ベンチャー企業に入社してフルスタックでWebサービスを開発。現在は大手IT企業に転職し、プログラミングを行っている。AIにプログラマーの仕事を奪って欲しいと願っている。