Vvars

Nvim の:help ページ。 生成されたもので、 ソースtree-sitter-vimdoc パーサーを使用して生成されています。


定義済み変数
一部の変数はユーザーが設定できますが、型を変更することはできません。
v:argv argv-variable v:argv Vim の起動時に与えられたコマンドライン引数。これは文字列のリストです。最初の項目は Vim コマンドです。完全なパスを含むコマンドについては、v:progpath を参照してください。
v:char char-variable v:char 'formatexpr' の評価時の引数であり、略語で<expr> を使用する場合に入力された文字に使用されます。:map-<expr>。また、InsertCharPreInsertEnter イベントでも使用されます。
v:charconvert_from charconvert_from-variable v:charconvert_from 変換されるファイルの文字エンコーディングの名前。'charconvert' オプションの評価中にのみ有効です。
v:charconvert_to charconvert_to-variable v:charconvert_to 変換後のファイルの文字エンコーディングの名前。'charconvert' オプションの評価中にのみ有効です。
v:cmdarg cmdarg-variable v:cmdarg ファイルの読み書きコマンドに与えられた追加の引数("++p"、"++enc="、"++ff=")。ファイルの読み書きコマンドのオートコマンドイベントがトリガーされる前に設定されます。読み書きコマンドの直後にこの変数を直接追加できるように、先頭にスペースがあります。注意: "+cmd" はここに含まれていません。これは常に実行されるためです。
v:cmdbang cmdbang-variable v:cmdbang ファイルの読み書きコマンドに対して v:cmdarg と同様に設定されます。"!" が使用された場合、値は 1 になり、そうでない場合は 0 になります。これはオートコマンドでのみ使用できることに注意してください。ユーザーコマンドでは<bang> を使用できます。
v:collate collate-variable v:collate ランタイム環境の照合順序に関する現在のロケール設定。これにより、Vim スクリプトは現在のロケールエンコーディングを認識できます。技術的には、LC_COLLATE の値です。ロケールを使用しない場合は "C" です。この変数を直接設定することはできません。:language コマンドを使用してください。multi-lang を参照してください。
v:completed_item completed_item-variable v:completed_item CompleteDone の後に最近完了した単語のcomplete-items を含む辞書。完了に失敗した場合、または挿入モードを出入りした後は空になります。注意: プラグインは、組み込みのCompleteDone イベントの動作をエミュレートするために値を変更できます。
v:count count-variable v:count 最後に実行されたノーマルモードコマンドに与えられた回数。マッピングの前に回数を取得するために使用できます。読み取り専用です。例
:map _x :<C-U>echo "the count is " .. v:count<CR>
注意: 回数の後に「:」を入力したときに得られる行範囲を削除するには、<C-U> が必要です。 "3d2w" のように回数が 2 つの場合は、コマンド "d6w" の例のように、それらは掛け合わされます。'formatexpr' オプションの評価にも使用されます。
v:count1 count1-variable v:count1 "v:count" と同じですが、回数が使用されていない場合は 1 にデフォルト設定されます。
v:ctype ctype-variable v:ctype ランタイム環境の文字に関する現在のロケール設定。これにより、Vim スクリプトは現在のロケールエンコーディングを認識できます。技術的には、LC_CTYPE の値です。ロケールを使用しない場合は "C" です。この変数を直接設定することはできません。:language コマンドを使用してください。multi-lang を参照してください。
v:dying dying-variable v:dying 通常はゼロです。致命的シグナルがキャッチされると 1 に設定されます。複数のシグナルがキャッチされると、数値が増加します。オートコマンドで使用して、Vim が正常に終了しなかったかどうかを確認できます。例
:au VimLeave * if v:dying | echo "\nAAAAaaaarrrggghhhh!!!\n" | endif
注意: v:dying が 1 のときに別の致命的シグナルがキャッチされると、VimLeave オートコマンドは実行されません。
v:echospace echospace-variable v:echospace hit-enter-prompt を発生させる前に、最後の行で:echo メッセージに使用できる画面セルの数。'showcmd''ruler'、および'columns' に依存します。最後の行の上にフル幅の行があるかどうかについては、'cmdheight' を確認する必要があります。
v:errmsg errmsg-variable v:errmsg 最後に表示されたエラーメッセージ。変更可能(設定可能)です。例
let v:errmsg = ""
silent! next
if v:errmsg != ""
  " ... handle error
v:errors errors-variable assert-return v:errors assert_true() など、アサーション関数によって検出されたエラー。これは文字列のリストです。アサーションが失敗すると、アサーション関数は項目を追加します。戻り値はこれを示します。項目が v:errors に追加された場合は 1 が返され、そうでない場合は 0 が返されます。古い結果を削除するには、空にします。
let v:errors = []
v:errors がリスト以外のものに設定されている場合、アサーション関数によって空のリストになります。
v:event event-variable v:event 現在のautocommand のイベントデータの辞書。イベントの存続期間中のみ有効です。v:event の保存や渡すことは無効です!代わりにコピーしてください。
au TextYankPost * let g:foo = deepcopy(v:event)
キーはイベントによって異なります。特定のイベントのドキュメントを参照してください(例:DirChanged または TextYankPost)。
キー 説明
abort イベントが中止条件中にトリガーされたかどうか(例:c_Esc または c_CTRL-C for CmdlineLeave)。chan channel-id cmdlevel cmdline のレベル。cmdtype cmdline の種類、cmdline-char。cwd カレントワーキングディレクトリ。inclusive モーションがinclusive である場合、そうでない場合は exclusive。scope イベント固有のスコープ名。operator 現在のoperator。Ex コマンドにも設定されます(v:operator とは異なります)。たとえば、TextYankPost:yank Ex コマンドによってトリガーされた場合、v:event.operator は "y" になります。regcontents レジスタに格納されているテキスト。readfile() スタイルの行のリスト。regname 要求されたレジスタ(例:"x" for "xyy") または名前のない操作の場合は空文字列。regtype getregtype() によって返されるレジスタの種類。visual 選択がビジュアル(モーションなどによるものではない)であるかどうか。completed_item CompleteChanged で現在選択されている項目。選択された項目がない場合は{}。height CompleteChanged のポップアップメニューの高さ。width CompleteChanged のポップアップメニューの幅。row CompleteChanged のポップアップメニューの行数(画面を基準とする)。col CompleteChanged のポップアップメニューの列数(画面を基準とする)。size CompleteChanged の完了項目の総数。scrollbar ポップアップメニューにスクロールバーがある場合はv:true、ない場合はv:false。changed_window DirChanged でウィンドウ(またはタブ)の変更中にイベントが発生した場合、v:true。status ジョブの状態または終了コード。-1 は「不明」を意味します。TermClose reason 完了の理由。CompleteDone
v:exception exception-variable v:exception 最近キャッチされ、終了していない例外の値。v:throwpointthrow-variables も参照してください。例
try
  throw "oops"
catch /.*/
  echo "caught " .. v:exception
endtry
出力: "caught oops"
v:exiting exiting-variable v:exiting 終了コード、またはVimLeavePreVimLeave オートコマンドを呼び出す前のv:null:q:x、および:cquit を参照してください。例
:au VimLeave * echo "Exit value is " .. v:exiting
v:false false-variable v:false JSON と msgpack に「false」を入れるために使用される特別な値。json_encode() を参照してください。この値は、文字列として使用されると "v:false" に、数値として使用されるとゼロに変換されます(例:文字列連結演算子を使用したexpr5、または数値演算子を使用したexpr5 または expr7)。読み取り専用です。
v:fcs_choice fcs_choice-variable v:fcs_choice FileChangedShell イベントがトリガーされた後に何が起こるべきか。オートコマンドで使用して、影響を受けたバッファーに対して Vim に実行させる操作を指定できます。reload バッファーを再読み込みする(ファイルが削除された場合は機能しません)。edit バッファーを再読み込みし、'fileformat''fileencoding''binary' などのオプションの値を検出する(ファイルが削除された場合は機能しません)。ask オートコマンドがない場合と同様に、ユーザーに実行する操作を尋ねる。ただし、タイムスタンプだけが変更された場合は何も起こりません。<empty> 何もしない。オートコマンドが必要なすべての操作を実行する必要があります。デフォルトは空です。別の(無効な)値が使用されている場合、Vim は空であるかのように動作し、警告メッセージは表示されません。
v:fcs_reason fcs_reason-variable v:fcs_reason FileChangedShell イベントがトリガーされた理由。オートコマンドで使用して、実行する操作や v:fcs_choice に設定する値を決定できます。可能な値: deleted ファイルが存在しなくなった conflict ファイルの内容、モード、またはタイムスタンプが変更され、バッファーが変更されている changed ファイルの内容が変更された mode ファイルのモードが変更された time ファイルのタイムスタンプだけが変更された
v:fname fname-variable v:fname 'includeexpr' を評価する場合: 検出されたファイル名。それ以外の場合は空です。
v:fname_diff fname_diff-variable v:fname_diff 差分(パッチ)ファイルの名前。'patchexpr' を評価中にのみ有効です。
v:fname_in fname_in-variable v:fname_in 入力ファイルの名前。評価中に有効です
オプションに使用されます
'charconvert' 変換されるファイル 'diffexpr' 元のファイル 'patchexpr' 元のファイル また、SwapExists に対してスワップファイル名に設定されます。
v:fname_new fname_new-variable v:fname_new ファイルの新しいバージョン名。'diffexpr' を評価中にのみ有効です。
v:fname_out fname_out-variable v:fname_out 出力ファイルの名前。評価時のみ有効。
オプションに使用されます
'charconvert' 変換後のファイル [1] 'diffexpr' diff の出力 'patchexpr' パッチ適用後のファイル [1] 書き込みコマンド(例:「:w file」)の変換を行う場合、v:fname_in と同じになります。読み込みコマンド(例:「:e file」)の変換を行う場合、一時ファイルになり、v:fname_in とは異なります。
v:folddashes folddashes-variable v:folddashes 'foldtext'で使用されます。閉じられた折り畳みの折り畳みレベルを表すダッシュ。 サンドボックス内では読み取り専用です。fold-foldtext
v:foldend foldend-variable v:foldend 'foldtext'で使用されます。閉じられた折り畳みの最終行。 サンドボックス内では読み取り専用です。fold-foldtext
v:foldlevel foldlevel-variable v:foldlevel 'foldtext'で使用されます。閉じられた折り畳みの折り畳みレベル。 サンドボックス内では読み取り専用です。fold-foldtext
v:foldstart foldstart-variable v:foldstart 'foldtext'で使用されます。閉じられた折り畳みの最初の行。 サンドボックス内では読み取り専用です。fold-foldtext
v:hlsearch hlsearch-variable v:hlsearch 検索の強調表示が有効かどうかを示す変数。'hlsearch'が有効になっている場合のみ設定が意味を持ちます。この変数を0に設定すると:nohlsearchコマンドと同じように動作し、1に設定すると…
let &hlsearch = &hlsearch
関数の戻り時に値が復元されます。function-search-undo
v:insertmode insertmode-variable v:insertmode InsertEnterInsertChangeのautocommandイベントで使用されます。値:i インサートモード r 置換モード v 仮想置換モード
v:key key-variable v:key Dictionaryの現在のアイテムのキー。map()filter()で使用される式を評価している間のみ有効です。読み取り専用。
v:lang lang-variable v:lang ランタイム環境のメッセージに対する現在のロケール設定。Vimスクリプトが現在の言語を認識できるようにします。技術的には、LC_MESSAGESの値です。値はシステムに依存します。この変数は直接設定できません。:languageコマンドを使用してください。v:ctypeとは、メッセージを文字エンコーディングに使用されるものとは異なる言語で表示したい場合に異なる場合があります。multi-langを参照してください。
v:lc_time lc_time-variable v:lc_time ランタイム環境の時間メッセージに対する現在のロケール設定。Vimスクリプトが現在の言語を認識できるようにします。技術的には、LC_TIMEの値です。この変数は直接設定できません。:languageコマンドを使用してください。multi-langを参照してください。
v:lnum lnum-variable v:lnum 'foldexpr' fold-expr'formatexpr''indentexpr''statuscolumn'式の行番号。'guitablabel''guitabtooltip'の場合はタブページ番号。これらの式のいずれかが評価されている間のみ有効です。サンドボックス内では読み取り専用です。
v:lua lua-variable v:lua 式からLua関数を呼び出すためのプレフィックス。v:lua-callで詳細情報をご覧ください。
v:maxcol maxcol-variable v:maxcol 最大行長。使用場所によって、画面の列数、文字数、バイト数が変わります。現在の値はすべてのシステムで2147483647です。
v:mouse_col mouse_col-variable v:mouse_col getchar()で取得したマウスクリックのカラム番号。virtcol()と同様に、画面のカラム番号です。マウスボタンをクリックしなかった場合は0になります。
v:mouse_lnum mouse_lnum-variable v:mouse_lnum getchar()で取得したマウスクリックの行番号。画面の行番号ではなく、テキストの行番号です。マウスボタンをクリックしなかった場合は0になります。
v:mouse_win mouse_win-variable v:mouse_win getchar()で取得したマウスクリックのウィンドウ番号。winnr()と同様に、最初のウィンドウの番号は1です。マウスボタンをクリックしなかった場合は0になります。
v:mouse_winid mouse_winid-variable v:mouse_winid getchar()で取得したマウスクリックのwindow-ID。マウスボタンをクリックしなかった場合は0になります。
v:msgpack_types msgpack_types-variable v:msgpack_types msgpackparse()msgpackdump()で使用されるmsgpack型のDictionary。Dictionary内のすべての型は固定された(編集不可)空リストです。リストがmsgpack型のいずれかであるかどうかを確認するには、is演算子を使用します。
v:null null-variable v:null JSONに「null」、msgpackにNILを入れるために使用される特別な値。json_encode()を参照してください。文字列として使用する場合(例:文字列連結演算子を使用したexpr5)、"v:null"に変換され、数値として使用する場合(例:数値演算子を使用したexpr5またはexpr7)、0に変換されます。読み取り専用。いくつかの場所で、v:nullは設定されていないリスト、辞書などを表すことができます。これは、空のリスト、辞書などとは少し異なります。
v:numbermax numbermax-variable v:numbermax 数値の最大値。
v:numbermin numbermin-variable v:numbermin 数値の最小値(負)。
v:numbersize numbersize-variable v:numbersize 数値のビット数。通常は64ですが、一部のシステムでは32の場合があります。
v:oldfiles oldfiles-variable v:oldfiles 起動時にshadaファイルから読み込まれるファイル名のリスト。これらは、Vimがマークを記憶しているファイルです。'shada'オプションの'引数によってリストの長さが制限されます(デフォルトは100)。shadaファイルが使用されていない場合、リストは空です。:oldfilesc_#<も参照してください。リストは変更できますが、これは後でshadaファイルに保存される内容には影響しません。文字列以外の値を使用すると問題が発生します。
v:operator operator-variable v:operator ノーマルモードで最後に指定された演算子。<g>または<z>で始まるコマンドを除き、1文字です。その場合、2文字になります。v:prevcountv:registerと一緒に使用するのが最適です。演算子保留モードをキャンセルして演算子を使用する場合などに役立ちます。例:
:omap O <Esc>:call MyMotion(v:operator)<CR>
別の演算子が入力されるまで値は設定されたままなので、空になることは期待しないでください。v:operatorは:delete:yank、その他のExコマンドでは設定されません。読み取り専用。
v:option_command option_command-variable v:option_command オプションを設定するために使用されたコマンド。OptionSet autocommandの実行中に有効。
値オプションは次によって設定されました。
"setlocal" :setlocalまたは:let l:xxx "setglobal" :setglobalまたは:let g:xxx "set" :setまたは:let "modeline" modeline
v:option_new option_new-variable v:option_new オプションの新しい値。OptionSet autocommandの実行中に有効。
v:option_old option_old-variable v:option_old オプションの古い値。OptionSet autocommandの実行中に有効。設定に使用されたコマンドとオプションの種類によっては、ローカルの古い値またはグローバルの古い値のいずれかになります。
v:option_oldglobal option_oldglobal-variable v:option_oldglobal オプションの古いグローバル値。OptionSet autocommandの実行中に有効。
v:option_oldlocal option_oldlocal-variable v:option_oldlocal オプションの古いローカル値。OptionSet autocommandの実行中に有効。
v:option_type option_type-variable v:option_type setコマンドのスコープ。OptionSet autocommandの実行中に有効。"global"または"local"のいずれかになります。
v:prevcount prevcount-variable v:prevcount 一つ前のノーマルモードコマンドに指定されたカウント。前のコマンドのv:count値です。ビジュアルモードまたは演算子保留モードをキャンセルしてカウントを使用する場合などに役立ちます。例:
:vmap % <Esc>:call MyFilter(v:prevcount)<CR>
読み取り専用。
v:profiling profiling-variable v:profiling 通常は0。「:profile start」を使用した後に1に設定されます。profilingを参照してください。
v:progname progname-variable v:progname Nvimが起動された名前(パスを除く)。読み取り専用。
v:progpath progpath-variable v:progpath 現在実行中のNvimへの絶対パス。読み取り専用。
v:register register-variable v:register 現在有効なレジスタの名前です。これは、コマンドが実際にレジスタを使用しているかどうかに関係なく、現在のノーマルモードコマンド、または現在実行中のノーマルモードマッピングに対して有効です(レジスタを引数にとるカスタムコマンドで使用します)。レジスタが指定されていない場合、デフォルトレジスタである'"'になります。ただし、'clipboard'に"unnamed"または"unnamedplus"が含まれている場合は、'*'または'+'になります。getreg()およびsetreg()も参照してください。
v:relnum relnum-variable v:relnum 'statuscolumn'式に対する相対行番号です。読み取り専用です。
v:scrollstart scrollstart-variable v:scrollstart 画面をスクロールアップさせたスクリプトまたは関数を記述した文字列です。空の場合のみ設定され、最初の原因が記憶されます。タイプされたコマンドの場合は"Unknown"に設定されます。これは、スクリプトがヒットエンタープロンプトの原因となっている理由を突き止めるために使用できます。
v:searchforward searchforward-variable v:searchforward 検索方向:前方検索の後では1、後方検索の後では0。最後の検索パターンを直接設定すると前方検索にリセットされます。quote/を参照してください。関数の戻り値では値が復元されます。function-search-undo。読み書き可能です。
v:servername servername-variable v:servername Nvimのプライマリリスンアドレスです。serverlist()によって返される最初の項目です。通常、これは起動時にNvimによって作成される、または--listen(または非推奨の$NVIM_LISTEN_ADDRESS環境変数)によって指定される名前付きパイプです。
serverstart() serverstop()も参照してください。読み取り専用です。
$NVIM
$NVIM はterminaljobstart()によって設定され、現在の環境がNvimのサブプロセスであることを示唆するヒントです。例
if $NVIM
  echo nvim_get_chan_info(v:parent)
endif
将来、$NVIMの内容が変更される可能性があることに注意してください。
v:shell_error shell_error-variable v:shell_error 最後のシェルコマンドの結果です。0以外の場合、最後のシェルコマンドにエラーがありました。0の場合は問題ありませんでした。これは、シェルがエラーコードをVimに返す場合にのみ機能します。コマンドを実行できなかった場合は、-1がよく使用されます。読み取り専用です。例
!mv foo bar
if v:shell_error
  echo 'could not rename "foo" to "bar"!'
endif
v:statusmsg statusmsg-variable v:statusmsg 最後に表示されたステータスメッセージです。変更可能です(設定できます)。
v:stderr stderr-variable v:stderr channel-id はstderrに対応します。値は常に2です。コードをより記述的にするためにこの変数を使用します。stdioopen()で示すstdinとstdoutとは異なり、stderrは常に書き込み用に開かれています。例
:call chansend(v:stderr, "error: toaster empty\n")
v:swapchoice swapchoice-variable v:swapchoice SwapExists autoコマンドは、既存のswapファイルの処理方法について選択された選択肢をこれに設定できます。'o' 読み取り専用で開く 'e' いずれにせよ編集する 'r' 復元する 'd' swapファイルを削除する 'q' 終了する 'a' 中断する。値は1文字の文字列である必要があります。空の値の場合、ユーザーに確認を求めるようになり、SwapExists autoコマンドがない場合と同じになります。デフォルトは空です。
v:swapcommand swapcommand-variable v:swapcommand ファイルが開かれた後に実行されるノーマルモードコマンドです。SwapExists autoコマンドを使用して、別のVimでファイルを開き、適切な場所にジャンプさせるために使用できます。たとえば、タグにジャンプするときの値は":tag tagname\r"です。":edit +cmd file"の場合は、値は":cmd\r"です。
v:swapname swapname-variable v:swapname 見つかったswapファイルの名前です。SwapExistsイベント中にのみ有効です。読み取り専用です。
v:t_blob t_blob-variable v:t_TYPE v:t_blob Blob型の値です。読み取り専用です。type()を参照してください。
v:t_bool t_bool-variable v:t_bool Boolean型の値です。読み取り専用です。type()を参照してください。
v:t_dict t_dict-variable v:t_dict Dictionary型の値です。読み取り専用です。type()を参照してください。
v:t_float t_float-variable v:t_float Float型の値です。読み取り専用です。type()を参照してください。
v:t_func t_func-variable v:t_func Funcref型の値です。読み取り専用です。type()を参照してください。
v:t_list t_list-variable v:t_list List型の値です。読み取り専用です。type()を参照してください。
v:t_number t_number-variable v:t_number Number型の値です。読み取り専用です。type()を参照してください。
v:t_string t_string-variable v:t_string String型の値です。読み取り専用です。type()を参照してください。
v:termrequest termrequest-variable v:termrequest 組み込みターミナルで実行されているプロセスから送信された最新のOSCまたはDCS制御シーケンスの値です。TermRequestイベントハンドラで読み取り、組み込みアプリケーションからのクエリに応答できます。
v:termresponse termresponse-variable v:termresponse ターミナルからNvimが受信した最新のOSCまたはDCS制御シーケンスの値です。別のエスケープシーケンスを使用してターミナルにクエリを実行した後、TermResponseイベントハンドラで読み取ることができます。
v:testing testing-variable v:testing test_garbagecollect_now()を使用する前に設定する必要があります。
v:this_session this_session-variable v:this_session 最後に読み込まれたか保存されたセッションファイルの完全なファイル名です。セッションファイルが保存されていない場合は空です。:mksessionを参照してください。変更可能です(設定できます)。
v:throwpoint throwpoint-variable v:throwpoint 最近キャッチされて終了していない例外がスローされた場所です。コマンドが入力された場合は設定されません。v:exceptionおよびthrow-variablesも参照してください。例
try
  throw "oops"
catch /.*/
  echo "Exception from" v:throwpoint
endtry
出力:"Exception from test.vim, line 2"
v:true true-variable v:true JSONとmsgpackに"true"を入れるために使用される特別な値です。json_encode()を参照してください。この値は、文字列として使用された場合(たとえば、expr5で文字列連結演算子を使用する場合)、"v:true"に変換され、数値として使用された場合(たとえば、expr5またはexpr7で数値演算子と一緒に使用する場合)、1に変換されます。読み取り専用です。
v:val val-variable v:val ListまたはDictionaryの現在の項目の値です。map()およびfilter()で使用される式を評価している間のみ有効です。読み取り専用です。
v:version version-variable v:version Vimのバージョン番号です。メジャーバージョン×100 + マイナーバージョンです。Vim 5.0は500、Vim 5.1は501です。読み取り専用です。Nvim(Vimではない)のバージョンを確認するにはhas()を使用します。
:if has("nvim-0.2.1")
v:vim_did_enter vim_did_enter-variable v:vim_did_enter 起動中は0、VimEnterの直前は1です。読み取り専用です。
v:virtnum virtnum-variable v:virtnum 'statuscolumn'式に対する仮想行番号です。仮想行のステータス列を描画するときは負、実際のバッファ行を描画するときは0、バッファ行の折り返された部分を描画するときは正になります。読み取り専用です。
v:warningmsg warningmsg-variable v:warningmsg 最後に表示された警告メッセージです。変更可能です(設定できます)。
v:windowid windowid-variable v:windowid 添付されたUIによって設定できるアプリケーション固有のウィンドウ「ハンドル」です。デフォルトは0です。**注:** Nvim ウィンドウについては、winnr()またはwin_getid()を使用してください。window-IDを参照してください。
メイン
コマンド索引
クイックリファレンス