Skip to content

Commit 6a7edaf

Browse files
h-easth-east
authored
Merge pull request #1926 from h-east/update-builtin
Update builtin.{txt,jax}
2 parents a9bbf05 + 5b484ae commit 6a7edaf

File tree

2 files changed

+168
-17
lines changed

2 files changed

+168
-17
lines changed

‎doc/builtin.jax‎

Lines changed: 82 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*builtin.txt* For Vim バージョン 9.1. Last change: 2025 Jan 02
1+
*builtin.txt* For Vim バージョン 9.1. Last change: 2025 Jan 17
22

33

44
VIMリファレンスマニュアル by Bram Moolenaar
@@ -79,6 +79,7 @@ bindtextdomain({package}, {path})
7979
なし 指定されたパスにテキストドメインをバイ
8080
ンドする
8181
blob2list({blob}) リスト {blob} を数値のリストに変換する
82+
blob2str({blob} [, {options}]) リスト {blob} を文字列のリストに変換する
8283
browse({save}, {title}, {initdir}, {default})
8384
文字列 ファイル選択ダイアログを表示
8485
browsedir({title}, {initdir}) 文字列 ディレクトリ選択ダイアログを表示
@@ -664,6 +665,8 @@ split({expr} [, {pat} [, {keepempty}]])
664665
sqrt({expr}) 浮動小数点数 {expr} の平方根
665666
srand([{expr}]) リスト |rand()| 用の種を取得する
666667
state([{what}]) 文字列 Vimの現在の状態
668+
str2blob({list} [, {options}])
669+
Blob 文字列のリストを Blob に変換する
667670
str2float({expr} [, {quoted}]) 浮動小数点数 文字列を浮動小数点数に変換する
668671
str2list({expr} [, {utf8}]) リスト {expr}の各文字をASCII/UTF-8値に変換する
669672
str2nr({expr} [, {base} [, {quoted}]])
@@ -1311,7 +1314,7 @@ base64_decode({string}) *base64_decode()*
13111314
" デコードされた内容をバイナリファイルに書き込む
13121315
call writefile(base64_decode(s), 'tools.bmp')
13131316
" Base64でエンコードされた文字列をデコードする
1314-
echo list2str(blob2list(base64_decode(encodedstr)))
1317+
echo blob2str(base64_decode(encodedstr))
13151318
<
13161319
|method| としても使用できる: >
13171320
GetEncodedString()->base64_decode()
@@ -1327,7 +1330,7 @@ base64_encode({blob}) *base64_encode()*
13271330
" バイナリファイルの内容をエンコードする
13281331
echo base64_encode(readblob('somefile.bin'))
13291332
" 文字列をエンコードする
1330-
echo base64_encode(list2blob(str2list(somestr)))
1333+
echo base64_encode(str2blob([somestr]))
13311334
<
13321335
|method| としても使用できる: >
13331336
GetBinaryData()->base64_encode()
@@ -1356,6 +1359,42 @@ blob2list({blob}) *blob2list()*
13561359
<
13571360
戻り値の型: list<any> または list<number>
13581361

1362+
1363+
blob2str({blob} [, {options}]) *blob2str()*
1364+
{blob} 内のバイト列を文字に変換した現在の 'encoding' の文字列
1365+
のリストを返す。
1366+
1367+
blob 内の各 <NL> バイトは文字列の末尾として解釈され、新しいリ
1368+
スト項目が追加される。blob 内の各 <NUL> バイトは <NL> 文字に変
1369+
換される。
1370+
1371+
{options} が指定されていない場合、現在の 'encoding' 値を使用し
1372+
て {blob} 内のバイトがデコードされる。
1373+
1374+
引数 {options} は |Dict| であり、次の項目をサポートする:
1375+
encoding このエンコーディングを使用して {blob} 内のバイ
1376+
ト列をデコードする。値は |String| である。サ
1377+
ポートされている値については |encoding-names|
1378+
を参照。
1379+
*E1515*
1380+
{blob} で無効なバイトシーケンスが検出された場合はエラーが発生
1381+
し、空のリストが返される。
1382+
1383+
blob が空の場合は空のリストが返される。
1384+
1385+
|str2blob()| も参照
1386+
1387+
例: >
1388+
blob2str(0z6162) returns ["ab"]
1389+
blob2str(0zC2ABC2BB) returns ["束損"]
1390+
blob2str(0zABBB, {'encoding': 'latin1'}) returns ["束損"]
1391+
<
1392+
|method| としても使用できる: >
1393+
GetBlob()->blob2str()
1394+
<
1395+
戻り値の型: list<string>
1396+
1397+
13591398
*browse()*
13601399
browse({save}, {title}, {initdir}, {default})
13611400
ファイル選択ダイアログを起動。"has("browse")" が|TRUE|を返すと
@@ -1955,6 +1994,8 @@ complete_info([{what}]) *complete_info()*
19551994
や <Down> キーを利用した最後の補完後に選択しな
19561995
かった場合)。
19571996
inserted 入力された文字列。[現時点では未実装]
1997+
completed 現在選択されているインデックス項目のエントリを
1998+
含む辞書を返す。
19581999

19592000
*complete_info_mode*
19602001
mode の値は:
@@ -4964,11 +5005,11 @@ getstacktrace() *getstacktrace()*
49645005
スタックトレースは |List| で、各項目は次の項目を含む
49655006
|Dictionary| である。
49665007
funcref スタックが関数にある場合は funcref、そうでない
4967-
場合はこの項目は存在しない。
5008+
場合はこの項目は省略される。
49685009
event スタックが autocmd イベントの場合、イベント説
4969-
明の文字列。それ以外の場合、この項目は存在しな
4970-
い。
4971-
lnum スタック上のスクリプトの行番号。
5010+
明の文字列。それ以外の場合、この項目は省略され
5011+
る。
5012+
lnum スタック上のスクリプト内の行番号。
49725013
filepath スタック上のスクリプトのファイルパス。
49735014

49745015
戻り値の型: list<dict<any>>
@@ -10341,6 +10382,40 @@ state([{what}]) *state()*
1034110382
戻り値の型: |String|
1034210383

1034310384

10385+
str2blob({list} [, {options}]) *str2blob()*
10386+
{list} 内の文字列リスト内の文字をバイト列に変換して Blob を返
10387+
す。
10388+
10389+
各リスト項目の後に <NL> バイトが blob に追加される。文字列内の
10390+
改行文字は、blob 内で <NUL> バイトに変換される。
10391+
10392+
{options} が指定されていない場合は、現在の 'encoding' 値を使用
10393+
して文字をバイト列に変換する。
10394+
10395+
引数 {options} は |Dict| であり、次の項目をサポートする:
10396+
encoding このエンコーディングを使用して文字をエンコード
10397+
する。値は |String| である。サポートされている
10398+
値については|encoding-names| を参照。
10399+
10400+
文字エンコードが失敗した場合はエラーが発生し、空の blob が返さ
10401+
れる。
10402+
10403+
{list} が空の場合、空の Blob を返す。
10404+
10405+
|blob2str()| も参照
10406+
10407+
例: >
10408+
str2blob(["ab"]) returns 0z6162
10409+
str2blob(["束損"]) returns 0zC2ABC2BB
10410+
str2blob(["a\nb"]) returns 0z610A62
10411+
str2blob(readfile('myfile.txt'))
10412+
str2blob(["束損"], {'encoding': 'latin1'}) returns 0zABBB
10413+
<
10414+
|method| としても使用できる: >
10415+
GetListOfStrings()->str2blob()
10416+
<
10417+
戻り値の型: |Blob|
10418+
1034410419
str2float({string} [, {quoted}]) *str2float()*
1034510420
文字列 {string} を浮動小数点数に変換する。これは式の中で浮動小
1034610421
数点数を使っているときと同じように働く

‎en/builtin.txt‎

Lines changed: 86 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*builtin.txt* For Vim version 9.1. Last change: 2025 Jan 02
1+
*builtin.txt* For Vim version 9.1. Last change: 2025 Jan 17
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -72,6 +72,7 @@ base64_encode({blob}) String base64 encode the bytes in {blob}
7272
bindtextdomain({package}, {path})
7373
Bool bind text domain to specified path
7474
blob2list({blob}) List convert {blob} into a list of numbers
75+
blob2str({blob} [, {options}]) List convert {blob} into a list of strings
7576
browse({save}, {title}, {initdir}, {default})
7677
String put up a file requester
7778
browsedir({title}, {initdir}) String put up a directory requester
@@ -609,6 +610,8 @@ split({expr} [, {pat} [, {keepempty}]])
609610
sqrt({expr}) Float square root of {expr}
610611
srand([{expr}]) List get seed for |rand()|
611612
state([{what}]) String current state of Vim
613+
str2blob({list} [, {options}])
614+
Blob convert list of strings into a Blob
612615
str2float({expr} [, {quoted}]) Float convert String to Float
613616
str2list({expr} [, {utf8}]) List convert each character of {expr} to
614617
ASCII/UTF-8 value
@@ -1241,7 +1244,7 @@ base64_decode({string}) *base64_decode()*
12411244
" Write the decoded contents to a binary file
12421245
call writefile(base64_decode(s), 'tools.bmp')
12431246
" Decode a base64-encoded string
1244-
echo list2str(blob2list(base64_decode(encodedstr)))
1247+
echo blob2str(base64_decode(encodedstr))
12451248
<
12461249
Can also be used as a |method|: >
12471250
GetEncodedString()->base64_decode()
@@ -1257,7 +1260,7 @@ base64_encode({blob}) *base64_encode()*
12571260
" Encode the contents of a binary file
12581261
echo base64_encode(readblob('somefile.bin'))
12591262
" Encode a string
1260-
echo base64_encode(list2blob(str2list(somestr)))
1263+
echo base64_encode(str2blob([somestr]))
12611264
<
12621265
Can also be used as a |method|: >
12631266
GetBinaryData()->base64_encode()
@@ -1289,6 +1292,42 @@ blob2list({blob}) *blob2list()*
12891292
<
12901293
Return type: list<any> or list<number>
12911294

1295+
1296+
blob2str({blob} [, {options}]) *blob2str()*
1297+
Return a List of Strings in the current 'encoding' by
1298+
converting the bytes in {blob} into characters.
1299+
1300+
Each <NL> byte in the blob is interpreted as the end of a
1301+
string and a new list item is added. Each <NUL> byte in the
1302+
blob is converted into a <NL> character.
1303+
1304+
If {options} is not supplied, the current 'encoding' value is
1305+
used to decode the bytes in {blob}.
1306+
1307+
The argument {options} is a |Dict| and supports the following
1308+
items:
1309+
encoding Decode the bytes in {blob} using this
1310+
encoding. The value is a |String|. See
1311+
|encoding-names| for the supported values.
1312+
*E1515*
1313+
An error is given and an empty List is returned if
1314+
an invalid byte sequence is encountered in {blob},
1315+
1316+
Returns an empty List if blob is empty.
1317+
1318+
See also |str2blob()|
1319+
1320+
Examples: >
1321+
blob2str(0z6162) returns ["ab"]
1322+
blob2str(0zC2ABC2BB) returns ["«»"]
1323+
blob2str(0zABBB, {'encoding': 'latin1'}) returns ["«»"]
1324+
<
1325+
Can also be used as a |method|: >
1326+
GetBlob()->blob2str()
1327+
<
1328+
Return type: list<string>
1329+
1330+
12921331
*browse()*
12931332
browse({save}, {title}, {initdir}, {default})
12941333
Put up a file requester. This only works when "has("browse")"
@@ -1911,7 +1950,8 @@ complete_info([{what}]) *complete_info()*
19111950
typed text only, or the last completion after
19121951
no item is selected when using the <Up> or
19131952
<Down> keys)
1914-
inserted Inserted string. [NOT IMPLEMENTED YET]
1953+
completed Return a dictionary containing the entries of
1954+
the currently selected index item.
19151955

19161956
*complete_info_mode*
19171957
mode values are:
@@ -5002,12 +5042,12 @@ getstacktrace() *getstacktrace()*
50025042
Returns the current stack trace of Vim scripts.
50035043
Stack trace is a |List|, of which each item is a |Dictionary|
50045044
with the following items:
5005-
funcref The funcref if the stack is at the function,
5006-
otherwise this item is not exist.
5045+
funcref The funcref if the stack is at a function,
5046+
otherwise this item is omitted.
50075047
event The string of the event description if the
5008-
stack is at autocmd event, otherwise this item
5009-
is not exist.
5010-
lnum The line number of the script on the stack.
5048+
stack is at an autocmd event, otherwise this
5049+
item is omitted.
5050+
lnum The line number in the script on the stack.
50115051
filepath The file path of the script on the stack.
50125052

50135053
Return type: list<dict<any>>
@@ -9038,7 +9078,7 @@ search({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
90389078
's' Set the ' mark at the previous location of the cursor
90399079
'w' Wrap around the end of the file
90409080
'W' don't Wrap around the end of the file
9041-
'z' start searching at the cursor column instead of zero
9081+
'z' start searching at the cursor column instead of Zero
90429082
If neither 'w' or 'W' is given, the 'wrapscan' option applies.
90439083

90449084
If the 's' flag is supplied, the ' mark is set, only if the
@@ -10556,6 +10596,42 @@ state([{what}]) *state()*
1055610596
Return type: |String|
1055710597

1055810598

10599+
str2blob({list} [, {options}]) *str2blob()*
10600+
Return a Blob by converting the characters in the List of
10601+
strings in {list} into bytes.
10602+
10603+
A <NL> byte is added to the blob after each list item. A
10604+
newline character in the string is translated into a <NUL>
10605+
byte in the blob.
10606+
10607+
If {options} is not supplied, the current 'encoding' value is
10608+
used to convert the characters into bytes.
10609+
10610+
The argument {options} is a |Dict| and supports the following
10611+
items:
10612+
encoding Encode the characters using this encoding.
10613+
The value is a |String|. See |encoding-names|
10614+
for the supported values.
10615+
10616+
An error is given and an empty blob is returned if the
10617+
character encoding fails.
10618+
10619+
Returns an empty Blob if {list} is empty.
10620+
10621+
See also |blob2str()|
10622+
10623+
Examples: >
10624+
str2blob(["ab"]) returns 0z6162
10625+
str2blob(["«»"]) returns 0zC2ABC2BB
10626+
str2blob(["a\nb"]) returns 0z610A62
10627+
str2blob(readfile('myfile.txt'))
10628+
str2blob(["«»"], {'encoding': 'latin1'}) returns 0zABBB
10629+
<
10630+
Can also be used as a |method|: >
10631+
GetListOfStrings()->str2blob()
10632+
<
10633+
Return type: |Blob|
10634+
1055910635
str2float({string} [, {quoted}]) *str2float()*
1056010636
Convert String {string} to a Float. This mostly works the
1056110637
same as when using a floating point number in an expression,

0 commit comments

Comments
 (0)