Update builtin.{txt,jax}

Author: h-east

doc/builtin.jax

@@ -1,4 +1,4 @@
-*builtin.txt*	For Vim バージョン 9.1.  Last change: 2024 Jan 25
+*builtin.txt*	For Vim バージョン 9.1.  Last change: 2024 Feb 01
 
 
 		VIMリファレンスマニュアル    by Bram Moolenaar
@@ -160,6 +160,8 @@ delete({fname} [, {flags}])	数値	ファイルやディレクトリ{fname}を
 deletebufline({buf}, {first} [, {last}])
 				数値	バッファ {buf} から行を削除する
 did_filetype()			数値	FileTypeのautocommandが実行されたか?
+diff({fromlist}, {tolist} [, {options}])
+				リスト	2 つの文字列のリストの差分
 diff_filler({lnum})		数値	差分モードで{lnum}に挿入された行
 diff_hlID({lnum}, {col})	数値	差分モードで{lnum}/{col}位置の強調
 digraph_get({chars})		文字列	{chars} のダイグラフ |digraph| を取得
@@ -2071,6 +2073,64 @@ did_filetype()	autocommandが実行されFileTypeイベントが一度でも起
 		使って 'filetype' を設定し、構文ファイルを読み込むために使え
 		る。
 
+diff({fromlist}, {tolist} [, {options}])		*diff()*
+		{fromlist} と {tolist} の文字列の差分を含む文字列またはリスト
+		を返す。Vim の内部 diff ライブラリを使用して差分を計算する。
+
+							*E106*
+		{options} のオプションの "output" 項目は、返される diff 形式を
+		指定する。次の値がサポートされている:
+		    indices	開始インデックスと終了インデックスのリストと、
+				各 diff hunk (差分の塊) 内の文字列数を返す。
+		    unified	unified diff 出力を文字列として返す。
+				これがデフォルトである。
+
+		{options} の "output" 項目が "indices" の場合、リストが返され
+		る。各リスト項目には、各 diff hunk (差分の塊) の以下の項目を含
+		む辞書が含まれている:
+		    from_idx	この diff hunk の {fromlist} 内の開始インデッ
+				クス。
+		    from_count	この diff hunk で追加/削除/変更された
+				{fromlist} 内の文字列数。
+		    to_idx	この diff hunk の {tolist} 内の開始インデック
+				ス。
+		    to_count	この diff hunk で追加/削除/変更された {tolist}
+				内の文字列数。
+
+		{options} 辞書引数は diff オプション ('diffopt' と同様) も指定
+		し、以下の項目をサポートする:
+		    iblank		行がすべて空白の変更は無視する。
+		    icase		テキストの大小文字の変更を無視する。
+		    iwhite		空白の量の変化を無視する。
+		    iwhiteall		すべての空白の変更を無視する。
+		    iwhiteeol		行末の空白の変更を無視する。
+		    indent-heuristic	内部 diff ライブラリのインデントヒュー
+					リスティックを使用する。
+		    algorithm		使用する diff アルゴリズムを指定する辞
+					書。サポートされている真偽値項目は
+					"myers", "minimal", "patience",
+					"histogram"。
+		これらのオプションの詳細については、'diffopt' を参照。
+
+		{fromlist} と {tolist} が同一の場合、空のリストまたは文字列を
+		返す。
+
+		例:
+		    :echo diff(['abc'], ['xxx'])
+		     @@ -1 +1 @@
+		     -abc
+		     +xxx
+
+		    :echo diff(['abc'], ['xxx'], {'output': 'indices'})
+		     [{'from_idx': 0, 'from_count': 1, 'to_idx': 0, 'to_count': 1}]
+		    :echo diff(readfile('oldfile'), readfile('newfile'))
+		    :echo diff(getbufline(5, 1, '$'), getbufline(6, 1, '$'))
+
+		その他の例については、|diff-func-examples| を参照
+
+		|method| としても使用できる: >
+			GetFromList->diff(to_list)
+<
 diff_filler({lnum})					*diff_filler()*
 		{lnum}行目より上にある削除行の数を返す。削除行とは、差分モード
 		で他方のウィンドウにテキストが挿入されていることを表す行のこと
@@ -4386,13 +4446,13 @@ getwinpos([{timeout}])					*getwinpos()*
 							*getwinposx()*
 getwinposx()	結果はGUIのVimウィンドウの左端の、デスクトップ上でのX座標値(数
 		値)。xtermでも機能する (100 ミリ秒のタイムアウトを使用して)。
-		情報が存在しない(コンソールの)場合は-1となる。
+		情報が存在しない (例: Wayland バックエンド) 場合は-1となる。
 		この値は `:winpos` でも使用される。
 
 							*getwinposy()*
 getwinposy()	結果はGUIのVimウィンドウの上端の、デスクトップ上でのY座標値(数
 		値)。xtermでも機能する (100 ミリ秒のタイムアウトを使用して)。
-		情報が存在しない(コンソールの)場合は-1となる。
+		情報が存在しない (例: Wayland バックエンド) 場合は-1となる。
 		この値は `:winpos` でも使用される。
 
 getwinvar({winnr}, {varname} [, {def}])				*getwinvar()*

en/builtin.txt

@@ -1,4 +1,4 @@
-*builtin.txt*	For Vim version 9.1.  Last change: 2024 Jan 25
+*builtin.txt*	For Vim version 9.1.  Last change: 2024 Feb 01
 
 
 		  VIM REFERENCE MANUAL	  by Bram Moolenaar
@@ -147,6 +147,8 @@ delete({fname} [, {flags}])	Number	delete the file or directory {fname}
 deletebufline({buf}, {first} [, {last}])
 				Number	delete lines from buffer {buf}
 did_filetype()			Number	|TRUE| if FileType autocmd event used
+diff({fromlist}, {tolist} [, {options}])
+				List	diff two Lists of strings
 diff_filler({lnum})		Number	diff filler lines about {lnum}
 diff_hlID({lnum}, {col})	Number	diff highlighting at {lnum}/{col}
 digraph_get({chars})		String	get the |digraph| of {chars}
@@ -2046,6 +2048,67 @@ did_filetype()	Returns |TRUE| when autocommands are being executed and the
 		editing another buffer to set 'filetype' and load a syntax
 		file.
 
+diff({fromlist}, {tolist} [, {options}])		*diff()*
+		Returns a String or a List containing the diff between the
+		strings in {fromlist} and {tolist}.  Uses the Vim internal
+		diff library to compute the diff.
+
+							*E106*
+		The optional "output" item in {options} specifies the returned
+		diff format.  The following values are supported:
+		    indices	Return a List of the starting and ending
+				indices and a count of the strings in each
+				diff hunk.
+		    unified	Return the unified diff output as a String.
+				This is the default.
+
+		If the "output" item in {options} is "indices", then a List is
+		returned.  Each List item contains a Dict with the following
+		items for each diff hunk:
+		    from_idx	start index in {fromlist} for this diff hunk.
+		    from_count	number of strings in {fromlist} that are
+				added/removed/modified in this diff hunk.
+		    to_idx	start index in {tolist} for this diff hunk.
+		    to_count	number of strings in {tolist} that are
+				added/removed/modified in this diff hunk.
+
+		The {options} Dict argument also specifies diff options
+		(similar to 'diffopt') and supports the following items:
+		    iblank		ignore changes where lines are all
+					blank.
+		    icase		ignore changes in case of text.
+		    iwhite		ignore changes in amount of white
+					space.
+		    iwhiteall		ignore all white space changes.
+		    iwhiteeol		ignore white space changes at end of
+					line.
+		    indent-heuristic	use the indent heuristic for the
+					internal diff library.
+		    algorithm		Dict specifying the diff algorithm to
+					use.  Supported boolean items are
+					"myers", "minimal", "patience" and
+					"histogram".
+		For more information about these options, refer to 'diffopt'.
+
+		Returns an empty List or String if {fromlist} and {tolist} are
+		identical.
+
+		Examples:
+		    :echo diff(['abc'], ['xxx'])
+		     @@ -1 +1 @@
+		     -abc
+		     +xxx
+
+		    :echo diff(['abc'], ['xxx'], {'output': 'indices'})
+		     [{'from_idx': 0, 'from_count': 1, 'to_idx': 0, 'to_count': 1}]
+		    :echo diff(readfile('oldfile'), readfile('newfile'))
+		    :echo diff(getbufline(5, 1, '$'), getbufline(6, 1, '$'))
+
+		For more examples, refer to |diff-func-examples|
+
+		Can also be used as a |method|: >
+			GetFromList->diff(to_list)
+<
 diff_filler({lnum})					*diff_filler()*
 		Returns the number of filler lines above line {lnum}.
 		These are the lines that were inserted at this point in
@@ -4424,14 +4487,16 @@ getwinpos([{timeout}])					*getwinpos()*
 getwinposx()	The result is a Number, which is the X coordinate in pixels of
 		the left hand side of the GUI Vim window. Also works for an
 		xterm (uses a timeout of 100 msec).
-		The result will be -1 if the information is not available.
+		The result will be -1 if the information is not available
+		(e.g. on the Wayland backend).
 		The value can be used with `:winpos`.
 
 							*getwinposy()*
 getwinposy()	The result is a Number, which is the Y coordinate in pixels of
 		the top of the GUI Vim window.  Also works for an xterm (uses
 		a timeout of 100 msec).
-		The result will be -1 if the information is not available.
+		The result will be -1 if the information is not available
+		(e.g. on the Wayland backend).
 		The value can be used with `:winpos`.
 
 getwinvar({winnr}, {varname} [, {def}])				*getwinvar()*