aboutsummaryrefslogtreecommitdiff
path: root/runtime
diff options
context:
space:
mode:
authorMarco Hinz <mh.codebro@gmail.com>2019-04-03 22:13:00 +0200
committerMarco Hinz <mh.codebro@gmail.com>2019-04-04 20:24:39 +0200
commit5510361a8ca8b47e9c3a46fae9ec0f0b00b507d3 (patch)
treea253694c81ccc15ed8dab8c0374c1f489cb122c9 /runtime
parent6b75d9f865b9a1ef56dbf9e4485aaf133efa2f22 (diff)
downloadrneovim-5510361a8ca8b47e9c3a46fae9ec0f0b00b507d3.tar.gz
rneovim-5510361a8ca8b47e9c3a46fae9ec0f0b00b507d3.tar.bz2
rneovim-5510361a8ca8b47e9c3a46fae9ec0f0b00b507d3.zip
vim-patch:8.1.0493: argv() and argc() only work on the current argument list
Problem: argv() and argc() only work on the current argument list. Solution: Add a window ID argument. (Yegappan Lakshmanan, closes vim/vim#832) https://github.com/vim/vim/commit/e6e3989c1b3f18907a0c305712b867e9a3821369
Diffstat (limited to 'runtime')
-rw-r--r--runtime/doc/eval.txt31
1 files changed, 20 insertions, 11 deletions
diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
index db278b2fb0..f5817279df 100644
--- a/runtime/doc/eval.txt
+++ b/runtime/doc/eval.txt
@@ -1970,11 +1970,11 @@ and({expr}, {expr}) Number bitwise AND
api_info() Dict api metadata
append({lnum}, {string}) Number append {string} below line {lnum}
append({lnum}, {list}) Number append lines {list} below line {lnum}
-argc() Number number of files in the argument list
+argc([{winid}]) Number number of files in the argument list
argidx() Number current index in the argument list
arglistid([{winnr} [, {tabnr}]]) Number argument list id
-argv({nr}) String {nr} entry of the argument list
-argv() List the argument list
+argv({nr} [, {winid}]) String {nr} entry of the argument list
+argv([-1, {winid}]) List the argument list
assert_equal({exp}, {act} [, {msg}])
none assert {exp} is equal to {act}
assert_exception({error} [, {msg}])
@@ -2446,8 +2446,15 @@ append({lnum}, {text}) *append()*
:let failed = append(0, ["Chapter 1", "the beginning"])
<
*argc()*
-argc() The result is the number of files in the argument list of the
- current window. See |arglist|.
+argc([{winid}])
+ The result is the number of files in the argument list. See
+ |arglist|.
+ If {winid} is not supplied, the argument list of the current
+ window is used.
+ If {winid} is -1, the global argument list is used.
+ Otherwise {winid} specifies the window of which the argument
+ list is used: either the window number or the window ID.
+ Returns -1 if the {winid} argument is invalid.
*argidx()*
argidx() The result is the current index in the argument list. 0 is
@@ -2458,7 +2465,7 @@ arglistid([{winnr} [, {tabnr}]])
Return the argument list ID. This is a number which
identifies the argument list being used. Zero is used for the
global argument list. See |arglist|.
- Return -1 if the arguments are invalid.
+ Returns -1 if the arguments are invalid.
Without arguments use the current window.
With {winnr} only use this window in the current tab page.
@@ -2467,17 +2474,19 @@ arglistid([{winnr} [, {tabnr}]])
{winnr} can be the window number or the |window-ID|.
*argv()*
-argv([{nr}]) The result is the {nr}th file in the argument list of the
- current window. See |arglist|. "argv(0)" is the first one.
- Example: >
+argv([{nr} [, {winid}])
+ The result is the {nr}th file in the argument list. See
+ |arglist|. "argv(0)" is the first one. Example: >
:let i = 0
:while i < argc()
: let f = escape(fnameescape(argv(i)), '.')
: exe 'amenu Arg.' . f . ' :e ' . f . '<CR>'
: let i = i + 1
:endwhile
-< Without the {nr} argument a |List| with the whole |arglist| is
- returned.
+< Without the {nr} argument, or when {nr} is -1, a |List| with
+ the whole |arglist| is returned.
+
+ The {winid} argument specifies the window ID, see |argc()|.
*assert_equal()*
assert_equal({expected}, {actual}, [, {msg}])