Merge pull request #281 from mnishz/change_for_Vim_8.1

Update change from Vim 8.0 to 8.1

Author: k-takata

doc/change.jax

@@ -1,4 +1,4 @@
-*change.txt*    For Vim バージョン 8.0.  Last change: 2017 Feb 17
+*change.txt*    For Vim バージョン 8.1.  Last change: 2018 May 12
 
 
 		  VIMリファレンスマニュアル    by Bram Moolenaar
@@ -515,9 +515,10 @@ Note: 'nrformats' が "bin" を含んでいるとき、'0x' または '0X' で
 
 'shiftround' がオンのとき、インデントは 'shiftwidth' の倍数に丸められる。
 
-'shiftwidth' がオンのとき、あるいは 'cindent' がオンで 'cinkeys' が値 0 の '#'
-を含むとき、右方向へのシフトは '#' で始まる行に適用されない (これらの行は、行
-の最初に位置すべきCプリプロセッサー指令であると考えられる)。
+'smartindent' がオンのとき、あるいは 'cindent' がオンで 'cinkeys' が値 0 の
+'#' を含むとき、右方向へのシフトは '#' で始まる行に適用されない (これらの行は、
+行の最初に位置すべきCプリプロセッサー指令であると考えられる)。これは 'cino' オ
+プションで変更することができる、|cino-#| を参照。
 
 'expandtab' がオフ (既定値) のとき、Vimはインデントにできる限り多くの <Tab> を
 使う。">><<" によって、空白のみで構成されたインデントを、<Tab> (と必要ならばい
@@ -959,6 +960,11 @@ NOTE: 以前のバージョンでは CTRL-V が特別に扱われていた。こ
 			慣である)。
 			`:retab!` も空白の連続を <Tab> 文字に変えてしまい、
 			printf() の出力をめちゃくちゃにするかもしれない。
+			|+vartabs| 機能が有効な場合、 単一の tabstop の代わり
+			にコンマで分けられたタブ幅のリストが使用されるだろう。
+			リストのそれぞれの値は 1 つの tabstop の幅を意味する
+			が、最後の値だけは後続するすべての tabstop に適用され
+			る。
 			{Vi にはない}
 
 							*retab-example*
@@ -1404,6 +1410,55 @@ gww			"gw" と同様にして現在行を整形する。 {Vi にはない}
 外部プログラムによる整形処理には、'textwidth' や他のオプションは何の影響も与え
 ない。
 
+                                                        *format-formatexpr*
+'formatexpr' オプションには、バッファの再整形を行う Vim script 関数を設定する
+ことができる。整形はファイルの種類に強く依存するので、これは通常 |ftplugin| で
+発生するべきである。対応するスクリプトは実際に必要とされるときにだけ読み込ま
+れ、かつそのスクリプト名は <filetype>format.vim とされるべきなので、|autoload|
+スクリプトを使用することは理にかなっている。
+
+例えば、Vim と共に配布され $VIMRUNTIME ディレクトリに配置されている XML ファイ
+ルタイププラグインは、オプション 'formatexpr' を以下のように設定する: >
+
+   setlocal formatexpr=xmlformat#Format()
+
+これは、xmlformat#Format() を定義している対応したスクリプトが以下のディレクト
+リで見つかることを意味している:
+`$VIMRUNTIME/autoload/xmlformat.vim`
+
+以下は、選択されたテキストから末尾の空白を取り除くスクリプトの例である。これを
+autoload ディレクトリに置くこと。例、~/.vim/autoload/format.vim: >
+
+  func! format#Format()
+    " 明示的な gq コマンドの場合だけ再整形する
+    if mode() != 'n'
+      " Vim の内部再整形に立ち戻る
+      return 1
+    endif
+    let lines = getline(v:lnum, v:lnum + v:count - 1)
+    call map(lines, {key, val -> substitute(val, '\s\+$', '', 'g')})
+    call setline('.', lines)
+
+    " 内部の整形は実行させない
+    return 0
+  endfunc
+
+その後以下のように整形を有効にすることができる: >
+  setlocal formatexpr=format#Format()
+>
+Note: この関数は、挿入モードから呼ばれた場合に明示的に非ゼロを返す (基本的に
+'textwidth' の制限を超えてテキストが挿入されることを意味する)。これは Vim に内
+部の整形機能に立ち戻って再整形させることになる。
+
+しかしながら、テキストを再整形するために |gq| コマンドが使用された場合、その関
+数は選択された行を受け取り、それらの行から末尾の空白を取り除き、そして所定の位
+置にそのテキストを配置しなおす。もし 1 つの行を複数行に分割しようとしている場
+合、何か上書きしてしまわないよう注意すること。
+
+挿入もしくは置換モードからのテキストの再整形を可能にしたい場合、関数が再帰的に
+呼び出されることがあるため注意しなければならない。これをデバッグするためには、
+'debug' オプションを設定することが役に立つ。
+
 							*right-justify*
 テキストを右揃えするコマンドは、Vimには存在しない。"par" 等の外部コマンド (例:
 "!}par" で段落の最後までを整形する) を実行したり、'formatprg' に "par" を指定

en/change.txt

@@ -1,4 +1,4 @@
-*change.txt*    For Vim version 8.0.  Last change: 2017 Feb 12
+*change.txt*    For Vim version 8.1.  Last change: 2018 May 12
 
 
 		  VIM REFERENCE MANUAL    by Bram Moolenaar
@@ -110,7 +110,7 @@ is an error when 'cpoptions' includes the 'E' flag.
 J			Join [count] lines, with a minimum of two lines.
 			Remove the indent and insert up to two spaces (see
 			below).  Fails when on the last line of the buffer.
-			If [count] is too big it is reduce to the number of
+			If [count] is too big it is reduced to the number of
 			lines available.
 
 							*v_J*
@@ -446,7 +446,7 @@ This depends on the 'nrformats' option:
 
 For decimals a leading negative sign is considered for incrementing/
 decrementing, for binary, octal and hex values, it won't be considered.  To
-ignore the sign Visually select the number before using CTRL-A or CTRL-X. 
+ignore the sign Visually select the number before using CTRL-A or CTRL-X.
 
 For numbers with leading zeros (including all octal and hexadecimal numbers),
 Vim preserves the number of characters in the number when possible.  CTRL-A on
@@ -533,6 +533,7 @@ If the 'shiftround' option is on, the indent is rounded to a multiple of
 If the 'smartindent' option is on, or 'cindent' is on and 'cinkeys' contains
 '#' with a zero value, shift right does not affect lines starting with '#'
 (these are supposed to be C preprocessor lines that must stay in column 1).
+This can be changed with the 'cino' option, see |cino-#|.
 
 When the 'expandtab' option is off (this is the default) Vim uses <Tab>s as
 much as possible to make the indent.  You can use ">><<" to replace an indent
@@ -986,6 +987,11 @@ This replaces each 'E' character with a euro sign.  Read more in |<Char->|.
 			this (that's a good habit anyway).
 			`:retab!` may also change a sequence of spaces by
 			<Tab> characters, which can mess up a printf().
+			If the |+vartabs| feature is enabled then a list of
+			tab widths separated by commas may be used in place of
+			a single tabstop.  Each value in the list represents
+			the width of one tabstop, except the final value which
+			applies to all following tabstops.
 			{not in Vi}
 
 							*retab-example*
@@ -1444,6 +1450,55 @@ to the name of an external program for Vim to use for text formatting.  The
 'textwidth' and other options have no effect on formatting by an external
 program.
 
+                                                        *format-formatexpr*
+The 'formatexpr' option can be set to a Vim Script function that performs
+reformatting of the buffer.  This should usually happen in an |ftplugin|,
+since formatting is highly dependent on the type of file.  It makes
+sense to use an |autoload| script, so the corresponding script is only loaded
+when actually needed and the script should be called <filetype>format.vim.
+
+For example, the XML filetype plugin distributed with Vim in the $VIMRUNTIME
+directory, sets the 'formatexpr' option to: >
+
+   setlocal formatexpr=xmlformat#Format()
+
+That means, you will find the corresponding script, defining the
+xmlformat#Format() function, in the directory:
+`$VIMRUNTIME/autoload/xmlformat.vim`
+
+Here is an example script that removes trailing whitespace from the selected
+text.  Put it in your autoload directory, e.g. ~/.vim/autoload/format.vim: >
+
+  func! format#Format()
+    " only reformat on explicit gq command
+    if mode() != 'n'
+      " fall back to Vims internal reformatting
+      return 1
+    endif
+    let lines = getline(v:lnum, v:lnum + v:count - 1)
+    call map(lines, {key, val -> substitute(val, '\s\+$', '', 'g')})
+    call setline('.', lines)
+
+    " do not run internal formatter!
+    return 0
+  endfunc
+
+You can then enable the formatting by executing: >
+  setlocal formatexpr=format#Format()
+>
+Note: this function explicitly returns non-zero when called from insert mode
+(which basically means, text is inserted beyond the 'textwidth' limit).  This
+causes Vim to fall back to reformat the text by using the internal formatter.
+
+However, if the |gq| command is used to reformat the text, the function
+will receive the selected lines, trim trailing whitespace from those lines and
+put them back in place.  If you are going to split single lines into multiple
+lines, be careful not to overwrite anything.
+
+If you want to allow reformatting of text from insert or replace mode, one has
+to be very careful, because the function might be called recursively.  For
+debugging it helps to set the 'debug' option.
+
 							*right-justify*
 There is no command in Vim to right justify text.  You can do it with
 an external command, like "par" (e.g.: "!}par" to format until the end of the