Merge pull request #1423 from vim-jp/hh-update-builtin

Update builtin.{txt,jax}

Author: h-east

doc/builtin.jax

@@ -1,4 +1,4 @@
-*builtin.txt*	For Vim バージョン 9.1.  Last change: 2023 Nov 20
+*builtin.txt*	For Vim バージョン 9.1.  Last change: 2024 Jan 25
 
 
 		VIMリファレンスマニュアル    by Bram Moolenaar
@@ -215,6 +215,9 @@ foldclosedend({lnum})		数値	{lnum}の折り畳みの最後の行(閉じてい
 foldlevel({lnum})		数値	{lnum}の折り畳みレベル
 foldtext()			文字列	閉じた折り畳みに表示されている行
 foldtextresult({lnum})		文字列	{lnum}で閉じている折り畳みのテキスト
+foreach({expr1}, {expr2})	リスト/辞書/Blob/文字列
+					{expr1} の各項目に対して {expr2} を呼
+					び出す
 foreground()			数値	Vimウィンドウを前面に移動する
 fullcommand({name} [, {vim9}])	文字列	{name} から完全なコマンドを取得
 funcref({name} [, {arglist}] [, {dict}])
@@ -392,6 +395,9 @@ matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]])
 matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]])
 				数値	位置を {group} で強調表示する
 matcharg({nr})			リスト	|:match|の引数
+matchbufline({buf}, {pat}, {lnum}, {end}, [, {dict})
+				リスト	バッファ {buf} 内のすべての {pat} の
+					マッチ
 matchdelete({id} [, {win}])	数値	{id} で指定されるマッチを削除する
 matchend({expr}, {pat} [, {start} [, {count}]])
 				数値	{expr}内で{pat}が終了する位置
@@ -405,6 +411,8 @@ matchlist({expr}, {pat} [, {start} [, {count}]])
 				リスト	{expr}内の{pat}のマッチと部分マッチ
 matchstr({expr}, {pat} [, {start} [, {count}]])
 				文字列	{expr}内の{count}番目の{pat}のマッチ
+matchstrlist({list}, {pat} [, {dict})
+				リスト	{list} 内のすべての {pat} にマッチ
 matchstrpos({expr}, {pat} [, {start} [, {count}]])
 				リスト	{expr}内の{count}番目の{pat}のマッチ
 max({expr})			数値	{expr}内の要素の最大値
@@ -2995,6 +3003,48 @@ foldtextresult({lnum})					*foldtextresult()*
 
 		|method| としても使用できる: >
 			GetLnum()->foldtextresult()
+
+foreach({expr1}, {expr2})					*foreach()*
+		{expr1} は |List|, |String|, |Blob| または |Dictionary| でなけ
+		ればならない。
+		{expr1} の各項目に対して {expr2} を実行する。{expr1} は変更さ
+		れない。その値は |:lockvar| 1 と同様に変更されるかもしれない。
+		|E741|
+		{expr1} を変更するには |map()| および |filter()| を参照。
+
+		{expr2} は |string| か |Funcref| でなければならない。
+
+		{expr2} が |string| の場合、{expr2} 内では |v:val| は現在の項
+		目の値を持つ。|Dictionary| の場合、|v:key| は現在の項目のキー
+		を持ち、|List| の場合、|v:key| は現在の項目のインデックスを持
+		つ。
+		|Blob| の場合、|v:key| は現在のバイトインデックスを持つ。
+		|String| の場合、|v:key| は現在の文字インデックスを持つ。
+
+		例: >
+			call foreach(mylist, 'used[v:val] = true')
+<		これは {expr1} リスト内の項目を記録する。
+
+		Note {expr2} は式の結果であり、コマンドとして使用されることに
+		注意。多くの場合、|literal-string| を使用するのが良い。バック
+		スラッシュを 2 重にする必要がないようにするためである。
+
+		{expr2} が |Funcref| の場合 2 つの引数を取る必要がある:
+			1. 現在の項目のキーまたはインデックス。
+			2. 現在の項目の値。
+		旧来のスクリプトの lambda では引数を 1 つだけ受け入れてもエラー
+		は発生しないが、Vim9 の lambda では "E1106: One argument too
+		many" になり、引数の数は一致する必要がある。
+		関数が値を返した場合、その値は無視される。
+
+		すべてのケースで {expr1} を返す。
+		{expr2} の実行中にエラーが発生した場合、{expr1} 内の項目はそれ
+		以上処理されない。
+		{expr2} が Funcref の場合、"abort" フラグを使用して定義されて
+		いない限り、関数内のエラーは無視される。
+
+		|method| としても使用できる: >
+			mylist->foreach(expr2)
 <
 							*foreground()*
 foreground()	Vimのウィンドウを前面に移動する。この関数はクライアントからVim
@@ -3198,6 +3248,8 @@ getbufinfo([{dict}])
 			bufnr		バッファ番号。
 			changed		バッファが変更されている場合はTRUE。
 			changedtick	バッファに加えられた変更の数。
+			command		バッファがコマンドラインウィンドウ
+					|cmdwin| に属する場合は TRUE。
 			hidden		バッファが隠されている場合はTRUE。
 			lastused	バッファが最後に使用されたときの
 					|localtime()| のような秒単位のタイムス
@@ -3414,7 +3466,7 @@ getcharmod()						*getcharmod()*
 			32	マウスのダブルクリック
 			64	マウスのトリプルクリック
 			96	マウスのクアドラプルクリック (== 32 + 64)
-			128	command (Macintosh のみ)
+			128	command (Mac) または super (GTK)
 		文字自身に含まれていない修飾キーのみ取得できる。つまり、
 		Shift-aは修飾キーなしの "A" となる。修飾なしの場合は 0 を返す。
 
@@ -3547,6 +3599,7 @@ getcompletion({pat}, {type} [, {filtered}])		*getcompletion()*
 		help		ヘルプ項目
 		highlight	ハイライトグループ
 		history		|:history| サブオプション
+		keymap		キーボードマッピング
 		locale		ロケール名 (locale -aの出力)
 		mapclear	バッファ引数
 		mapping		マッピング名
@@ -5091,8 +5144,12 @@ items({dict})						*items()*
 			for [key, value] in items(mydict)
 			   echo key .. ': ' .. value
 			endfor
+<
+		リストまたは文字列引数もサポートされている。このようなケースで
+		は、items() はインデックスとインデックスの値を含むリストを返
+		す。
 
-<		|method| としても使用できる: >
+		|method| としても使用できる: >
 			mydict->items()
 
 job_ 関数群はここに文書化されている: |job-functions-details|
@@ -5948,6 +6005,51 @@ matcharg({nr})							*matcharg()*
 
 		|method| としても使用できる: >
 			GetMatch()->matcharg()
+<
+							*matchbufline()*
+matchbufline({buf}, {pat}, {lnum}, {end}, [, {dict}])
+		バッファ {buf} 内の {lnum} から {end} までの行で、{pat} がマッ
+		チした行の |List| を返す。
+
+		{lnum} と {end} には、行番号または {buf} の最後の行を参照する
+		文字列 "$" を指定できる。
+
+		{dict} 引数は次の項目をサポートする:
+		    submatches	サブマッチ情報を含める (|/\(|)
+
+		マッチごとに、次の項目を含む |Dict| が返される:
+		    byteidx	マッチの開始バイトインデックス
+		    lnum	マッチする行番号
+		    text	マッチした文字列
+		Note 単一行に複数のマッチが存在する可能性があることに注意。
+
+		この関数はロードされたバッファに対してのみ機能する。必要であれ
+		ば、最初に |bufload()| を呼び出す。
+
+		{buf} が有効なバッファでない場合、バッファがロードされていない
+		場合、{lnum} または {end} が有効でない場合は、エラー発生し、空
+		の |List| が返される。
+
+		例: >
+		    " バッファ 5 の 3 行目に "a" が含まれていると仮定
+		    :echo matchbufline(5, '\<\k\+\>', 3, 3)
+		    [{'lnum': 3, 'byteidx': 0, 'text': 'a'}]
+		    " バッファ 10 の 4 行目に "tik tok" が含まれていると仮定
+		    :echo matchbufline(10, '\<\k\+\>', 1, 4)
+		    [{'lnum': 4, 'byteidx': 0, 'text': 'tik'}, {'lnum': 4, 'byteidx': 4, 'text': 'tok'}]
+<
+		{submatch} が存在し、v:true の場合、"\1"、"\2" 等のサブマッチ
+		も返される。例: >
+		    " バッファ 2 の 2 行目に "acd" が含まれていると仮定
+		    :echo matchbufline(2, '\(a\)\?\(b\)\?\(c\)\?\(.*\)', 2, 2
+						\ {'submatches': v:true})
+		    [{'lnum': 2, 'byteidx': 0, 'text': 'acd', 'submatches': ['a', '', 'c', 'd', '', '', '', '', '']}]
+<		"submatches" リストには常に 9 個のアイテムが含まれる。サブマッ
+		チが見つからない場合、そのサブマッチに対しては空文字列が返され
+		る。
+
+		|method| としても使用できる: >
+			GetBuffer()->matchbufline('mypat', 1, '$')
 
 matchdelete({id}, [, {win}])		       *matchdelete()* *E802* *E803*
 		|matchadd()| または |:match| で定義したマッチの中で ID が {id}
@@ -6075,6 +6177,40 @@ matchlist({expr}, {pat} [, {start} [, {count}]])		*matchlist()*
 
 		|method| としても使用できる: >
 			GetText()->matchlist('word')
+<
+						*matchstrlist()*
+matchstrlist({list}, {pat} [, {dict}])
+		{pat} がマッチする {list} 内のマッチの |List| を返す。
+		{list} は文字列の |List| である。{list} 内の各文字列に対して
+		{pat} がマッチする。
+
+		{dict} 引数は次の項目をサポートする:
+		    submatches	サブマッチ情報を含める (|/\(|)
+
+		マッチごとに、次の項目を含む |Dict| が返される:
+		    byteidx	マッチの開始バイトインデックス。
+		    idx		{list} 内のマッチのインデックス。
+		    text	マッチした文字列
+		    submatches	サブマッチのリスト。{dict} で "submatches" が
+				v:true に設定されている場合にのみ存在する。
+
+		例: >
+		    :echo matchstrlist(['tik tok'], '\<\k\+\>')
+		    [{'idx': 0, 'byteidx': 0, 'text': 'tik'}, {'idx': 0, 'byteidx': 4, 'text': 'tok'}]
+		    :echo matchstrlist(['a', 'b'], '\<\k\+\>')
+		    [{'idx': 0, 'byteidx': 0, 'text': 'a'}, {'idx': 1, 'byteidx': 0, 'text': 'b'}]
+<
+		"submatch" が存在し、v:true の場合、"\1"、"\2" 等のサブマッチ
+		も返される。例: >
+		    :echo matchstrlist(['acd'], '\(a\)\?\(b\)\?\(c\)\?\(.*\)',
+						\ #{submatches: v:true})
+		    [{'idx': 0, 'byteidx': 0, 'text': 'acd', 'submatches': ['a', '', 'c', 'd', '', '', '', '', '']}]
+<		"submatches" リストには常に 9 個のアイテムが含まれる。サブマッ
+		チが見つからない場合、そのサブマッチに対しては空文字列が返され
+		る。
+
+		|method| としても使用できる: >
+			GetListOfStrings()->matchstrlist('mypat')
 
 matchstr({expr}, {pat} [, {start} [, {count}]])			*matchstr()*
 		|match()| と同じだが、マッチした文字列を返す。例: >
@@ -9928,6 +10064,7 @@ type({expr})	{expr}の型を示す数値を返す。
 			Blob:	      10  |v:t_blob|
 			クラス:	      12  |v:t_class|
 			オブジェクト: 13  |v:t_object|
+			型エイリアス: 14  |v:t_typealias|
 		後方互換性のためには、次のような使い方ができる: >
 			:if type(myvar) == type(0)
 			:if type(myvar) == type("")