(The English version is below the Japanese version)

Vz Keymap for VS Code

Vz KeymapはVZエディタのキーバインドを再現するVisual Studio Code拡張です。

• ダイヤモンドカーソルを始めとするVZのほとんどの基本操作をカバー（ESC系とファンクションキー以外）。
• スタック式のクリップボードを再現。カット、コピー、ペーストでクリップボードにPUSH、POPできる。
• トグル式の選択モード（CTRL+B）と矩形選択モード（CTRL+K B）も再現。
• 削除文字列のストック機能もサポート。DeleteやBackspaceで消した文字列をCTRL+Uで取り出せる。
• キーボードマクロ機能も実現。キー操作を記録して繰り返し再生できる（CTRL+_で記録開始、CTRL+^で記録終了・再生）。
• ページスクロール時に画面内のカーソル位置が移動しない挙動を再現。
• 設定で全画面/半画面スクロールを選択可能。
• タグジャンプ機能（SHIFT+F10）もサポート。
• 2ストロークキーの2文字目はVZと同様にCTRLキーを押しても離してもOK。
• VS Code内のリスト操作でもVZ風のキーが使用可能。例えばファイル選択や推測候補リストなどでダイヤモンドカーソルが使える。
• いくつか設定オプションあり。設定で "vz" を検索してみてください。

対応キー一覧

カーソル移動、スクロール、選択、ジャンプ

削除、挿入、編集、クリップボード

検索、置換

履歴操作

キーボードマクロ

ウィンドウ操作

被ったキーの代替

被ったキーの元からある代替操作（ご参考）

VZエディタとの違いと注意点

Vz KeymapではVZエディタと同様に2ストロークキーの2文字目でCTRLキーを押すか離すかを区別しません。VS Codeのキー定義ではこれが区別されるため、Vz Keymapはすべての2ストロークキーを2通りずつ登録しています。

VZエディタの選択モードはトグル式のため、VS Codeにおいては単純なキー割り当てでは実現できません。CTRL+Bで選択モードを開始したあとは、普通の（SHIFTキーなしの）カーソルキーで範囲選択ができる必要があるからです。 このため、Vz Keymapでは内部で選択モード状態を保持してカーソルキーの動作を変えています。 また、keybindings.json の'when'節では、Vz Keymapが選択モード中かどうかを判定する 'vz.inSelectionMode' という変数が使えるようにしてあります。 元からある変数 'editorHasSelection' と 'vz.inSelectionMode' は、選択範囲が空（選択モードを開始した直後）でも真になるかどうか、という違いがあります。

いくつかのショートカットキーはVS Codeの対応する機能に直接割り当てられますが、その挙動はVZエディタと異なる場合があります。 例えば次の単語へカーソルを移動するCTRL+Fは、VS CodeとVZエディタで単語境界の判定が異なるため、動きも異なります。

Vz Keymapでは、VZエディタのESCキーで始まる2ストロークキー（例えばESC Sで保存など）は定義しません。これはVS Codeに元からある短押しの（普通の）ESCキーの機能を壊さないようにするためです。 代わりに、ALT+F Sで保存（メインメニューのFile > Save）のようにアクセラレータキーで代用することをお薦めします。

キーボードマクロ機能は文字入力だけでなく、カーソル移動、選択、スクロール、削除やカット&ペースト、検索、置換、さらにUndoとRedoなど、Vz Keymapが提供するほぼすべてのキー操作を記録し再生できます。 ただしこれはキー入力そのものを直接記録するのではなく、キー入力によって呼び出されたVz Keymapのコマンドを内部的に記録する仕組みです。そのため、Vz Keymap以外のコマンド実行などは記録されないことに注意してください。

検索と置換の操作について

• 検索
  • CTRL+Q F（検索）で検索ウィジェットを開き、検索文字列を入力してENTERまたはCTRL+Mで確定して下さい。
  • このとき検索ウィジェットは表示されたままですが、キーボードフォーカスがドキュメントに戻っているので、CTRL+R（前候補）とCTRL+C（次候補）で検索結果にジャンプしながら通常の操作でテキスト編集もできます。
  • ESCなどで検索ウィジェットを閉じれば、検索モードは終了します。
  • 備考:
    • CTRL+Q Fの代わりにCTRL+L（文字列を選択して検索）でも検索ウィジェットが開きます。この場合はカーソル位置にある文字列（単語）が検索文字列として設定され、キーボードフォーカスはドキュメントにとどまります。ここでCTRL+Lを繰り返せばカーソル位置から取得する文字列を単語単位で伸ばしていくことができます。オリジナルのVZエディタに近い動作を再現しています。
    • 検索ウィジェットにフォーカスがあるときに、CTRL+Mなどで検索文字列を確定する操作を省略して、いきなりCTRL+C（次候補）などのキーで検索を開始することもできます。その時点でキーボードフォーカスがドキュメントに移ります。
• 置換
  • CTRL+Q A（置換）で検索置換ウィジェットを開き、検索文字列と置換文字列を入力します。
  • 検索文字列を入力したあと置換文字列の入力に移るときにはTABを使います。SHIFT+TABで戻ることもできます。
  • キーボードフォーカスが置換文字列の入力欄にある状態で、ENTERまたはCTRL+Mを押すと置換が1つ実行され、カーソルは次の候補に進みます。
  • カーソルの位置にある候補を置換しないでスキップするときはCTRL+C（次候補）が使えます。
  • ESCで検索置換ウィジェットを閉じることができます。
  • 備考:
    • 上記の操作を実現するため、キーボードフォーカスが置換文字列にあるときのCTRL+R（前候補）とCTRL+C（次候補）はキーボードフォーカスをウィジェットに残したまま検索を実行するようになっています。
    • CTRL+Q Oでも置換を実行できます。この方法はキーボードフォーカスがドキュメントにあるときでも有効です。

English

Vz Keymap for VS Code

This is a Visual Studio Code extension which provides a keymap similar to good old VZ Editor.

• Covers the basic experience which is almost identical to VZ Editor (except ESC-* and function keys)
• Emulates the Text stack (push/pop to the clibboard) with Cut, Copy and Paste
• Toogle-style Selection mode (toggle by Ctrl+B) and Column selection mode (toggle by Ctrk+K B)
• Undelete stack (Ctrl+U to restore deleted characters)
• Keyboard macro (record/replay keyboard sequence)
• Page scroll doesn't move the cursor position in the view
• Half-page scroll as an option
• Tag jump (Shift+F10)
• Permissive two-stroke keys (e.g. Ctrl+Q Ctrl+X is equivalent to Ctrl+Q X)
• List view operation with VZ-style cursor keys (e.g. selecting files on Explorer, selecting Suggestion)
• Some options are available (search for 'vz' in the Settings)

Supported keys

Cursor, Scroll, Selection, Jump

Delete, Insert, Edit, Clipboard

Search

Undo, Redo

Keyboard Macro

Window Management

Alternatives for conflicts

Existing alternatives (Just for your information)

Compatibility in detail

For basic compatibility, every two-stroke shortcuts provided by this extension allow you either to press the Ctrl key or not when pressing the second stroke. (e.g. Ctrl+Q Ctrl+X is equivalent to Ctrl+Q X)

The selection mode of VZ Editor is something a little unique feature. Once you start it by Ctrl+B, you can make a selection range using cursor keys without the Shift key. To emulate that behavior on VS Code, this extension holds the selection mode status internally. You can use a context variable 'vz.inSelectionMode' in the 'when' clause in your keybindings.json to determine whether it is in selection mode or not. The difference between standard 'editorHasSelection' and 'vz.inSelectionMode' is whether it includes the state in which the selection range is empty.

Note that, since some shortcut keys are mapped to the corresponding functionality of the VS Code directly, the behavior may be different than on VZ Editor. For example, the result of Ctrl+F which moves the cursor to the next word may differ since word borders are defined differently in VS Code and VZ Editor.

This extension does not provide any two-stroke shortcut keys starting from ESC key, such as ESC S to save the document, to avoid breaking existing functionalities of ESC key that are single-stroke. Instead, it is recommended to use acceleration keys such as Alt+F S to save the document.

The keyboard macro function can record and replay keyboard operations not only character input but also almost all keyboard operations provided by Vz Keymap such as cursor movement, selection, scrolling, delete, cut & paste, search, replace and even undo and redo. However it doesn't record the keyboard inputs itself directly, instead, it records the commands of Vz Keymap invoked internally by the keyboard input. Thus, please be notified that it can't record the execution of commands other than Vz Keymap.

How to use Find and Replace

• Find
  • Press Ctrl+Q F (Find) to open the find widget, input your search string, and press Enter or Ctrl+M to confirm.
  • At this moment the find widget should still be open, but the keyboard focus has moved back to the document, so you can edit the document in a normal way while also you move around by Ctrl+R (Previous match) and Ctrl+C (Next match).
  • Press ESC to close the find widget and finish the finding mode.
  • Note:
    • Ctrl+L (Select Word to Find) instead of Ctrl+Q F is also available for opening the find widget, and in this case, the string (word) which starts from the location of the cursor is set as the new search string and the keyboard focus stays on the document. If you repeat pressing Ctrl+L here, you can make the string longer by the word repeatedly. It simulates a similar behavior as the original VZ Editor.
    • When the keyboard focus is on the find widget, you can also skip the confirmation step like pressing Ctrl+M, and immediately start searching matches by pressing Ctrl+C (Next match) for instance. Either way, the keyboard focus will move to the document.
• Replace
  • Press Ctrl+Q A (Replace) to open the find and replace widget, input your search string and your replacement string.
  • You can use TAB when you move from search string input to replacement string input. Also, you can use Shift+TAB to go back.
  • While the keyboard focus is on replacement string input, press Enter or Ctrl+M to execute one replacement and jump to the next match.
  • You can skip applying the replacement to the match at current cursor position by pressing Ctrl+C (Next match).
  • Press ESC to close the find and replace widget and finish the replacement mode.
  • Note:
    • In order to achieve the above way of operations, the keyboard focus is retained on the find widget when you press Ctrl+R (Previous match) or Ctrl+C (Next match) with the focus on the replacement string input.
    • You can also use CtrL+Q O to execute the replacement. This way is available even the keyboard focus is on the document.