vim: runtime/doc/builtin.txt annotate

annotate runtime/doc/builtin.txt @ 31811:c5ff7d053fa1 v9.0.1238

patch 9.0.1238: :runtime completion can be further improved Commit: https://github.com/vim/vim/commit/5c8771bc5a2be123ab8e6325fa60ed524e8efb09 Author: zeertzjq <zeertzjq@outlook.com> Date: Tue Jan 24 12:34:03 2023 +0000 patch 9.0.1238: :runtime completion can be further improved Problem: :runtime completion can be further improved. Solution: Also complete the {where} argument values and adjust the completion for that. (closes #11874)

author	Bram Moolenaar <Bram@vim.org>
date	Tue, 24 Jan 2023 13:45:06 +0100
parents	5948cc887603
children	cc751d944b7e

rev	line source
31579 7d68a90cbf5c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31503 diff changeset	1 builtin.txt For Vim version 9.0. Last change: 2022 Dec 23
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4 VIM REFERENCE MANUAL by Bram Moolenaar
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7 Builtin functions builtin-functions
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8
30634 f68f43043842 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30574 diff changeset	9 Note: Expression evaluation can be disabled at compile time, the builtin
f68f43043842 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30574 diff changeset	10 functions are not available then. See \|+eval\| and \|no-eval-feature\|.
f68f43043842 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30574 diff changeset	11
f68f43043842 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30574 diff changeset	12 For functions grouped by what they are used for see \|function-list\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	13
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	14 1. Overview \|builtin-function-list\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	15 2. Details \|builtin-function-details\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	16 3. Feature list \|feature-list\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	17 4. Matching a pattern in a String \|string-match\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	18
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	19 ==============================================================================
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	20 1. Overview builtin-function-list
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	21
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	22 Use CTRL-] on the function name to jump to the full explanation.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	23
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	24 USAGE RESULT DESCRIPTION ~
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	25
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	26 abs({expr}) Float or Number absolute value of {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	27 acos({expr}) Float arc cosine of {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	28 add({object}, {item}) List/Blob append {item} to {object}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	29 and({expr}, {expr}) Number bitwise AND
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	30 append({lnum}, {text}) Number append {text} below line {lnum}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	31 appendbufline({expr}, {lnum}, {text})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	32 Number append {text} below line {lnum}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	33 in buffer {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	34 argc([{winid}]) Number number of files in the argument list
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	35 argidx() Number current index in the argument list
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	36 arglistid([{winnr} [, {tabnr}]]) Number argument list id
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	37 argv({nr} [, {winid}]) String {nr} entry of the argument list
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	38 argv([-1, {winid}]) List the argument list
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	39 asin({expr}) Float arc sine of {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	40 assert_beeps({cmd}) Number assert {cmd} causes a beep
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	41 assert_equal({exp}, {act} [, {msg}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	42 Number assert {exp} is equal to {act}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	43 assert_equalfile({fname-one}, {fname-two} [, {msg}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	44 Number assert file contents are equal
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	45 assert_exception({error} [, {msg}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	46 Number assert {error} is in v:exception
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	47 assert_fails({cmd} [, {error} [, {msg} [, {lnum} [, {context}]]]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	48 Number assert {cmd} fails
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	49 assert_false({actual} [, {msg}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	50 Number assert {actual} is false
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	51 assert_inrange({lower}, {upper}, {actual} [, {msg}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	52 Number assert {actual} is inside the range
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	53 assert_match({pat}, {text} [, {msg}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	54 Number assert {pat} matches {text}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	55 assert_nobeep({cmd}) Number assert {cmd} does not cause a beep
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	56 assert_notequal({exp}, {act} [, {msg}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	57 Number assert {exp} is not equal {act}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	58 assert_notmatch({pat}, {text} [, {msg}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	59 Number assert {pat} not matches {text}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	60 assert_report({msg}) Number report a test failure
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	61 assert_true({actual} [, {msg}]) Number assert {actual} is true
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	62 atan({expr}) Float arc tangent of {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	63 atan2({expr1}, {expr2}) Float arc tangent of {expr1} / {expr2}
28917 c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	64 autocmd_add({acmds}) Bool add a list of autocmds and groups
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	65 autocmd_delete({acmds}) Bool delete a list of autocmds and groups
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	66 autocmd_get([{opts}]) List return a list of autocmds
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	67 balloon_gettext() String current text in the balloon
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	68 balloon_show({expr}) none show {expr} inside the balloon
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	69 balloon_split({msg}) List split {msg} as used for a balloon
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	70 blob2list({blob}) List convert {blob} into a list of numbers
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	71 browse({save}, {title}, {initdir}, {default})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	72 String put up a file requester
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	73 browsedir({title}, {initdir}) String put up a directory requester
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	74 bufadd({name}) Number add a buffer to the buffer list
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	75 bufexists({buf}) Number \|TRUE\| if buffer {buf} exists
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	76 buflisted({buf}) Number \|TRUE\| if buffer {buf} is listed
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	77 bufload({buf}) Number load buffer {buf} if not loaded yet
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	78 bufloaded({buf}) Number \|TRUE\| if buffer {buf} is loaded
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	79 bufname([{buf}]) String Name of the buffer {buf}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	80 bufnr([{buf} [, {create}]]) Number Number of the buffer {buf}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	81 bufwinid({buf}) Number window ID of buffer {buf}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	82 bufwinnr({buf}) Number window number of buffer {buf}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	83 byte2line({byte}) Number line number at byte count {byte}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	84 byteidx({expr}, {nr}) Number byte index of {nr}'th char in {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	85 byteidxcomp({expr}, {nr}) Number byte index of {nr}'th char in {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	86 call({func}, {arglist} [, {dict}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	87 any call {func} with arguments {arglist}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	88 ceil({expr}) Float round {expr} up
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	89 ch_canread({handle}) Number check if there is something to read
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	90 ch_close({handle}) none close {handle}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	91 ch_close_in({handle}) none close in part of {handle}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	92 ch_evalexpr({handle}, {expr} [, {options}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	93 any evaluate {expr} on JSON {handle}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	94 ch_evalraw({handle}, {string} [, {options}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	95 any evaluate {string} on raw {handle}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	96 ch_getbufnr({handle}, {what}) Number get buffer number for {handle}/{what}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	97 ch_getjob({channel}) Job get the Job of {channel}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	98 ch_info({handle}) String info about channel {handle}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	99 ch_log({msg} [, {handle}]) none write {msg} in the channel log file
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	100 ch_logfile({fname} [, {mode}]) none start logging channel activity
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	101 ch_open({address} [, {options}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	102 Channel open a channel to {address}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	103 ch_read({handle} [, {options}]) String read from {handle}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	104 ch_readblob({handle} [, {options}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	105 Blob read Blob from {handle}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	106 ch_readraw({handle} [, {options}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	107 String read raw from {handle}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	108 ch_sendexpr({handle}, {expr} [, {options}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	109 any send {expr} over JSON {handle}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	110 ch_sendraw({handle}, {expr} [, {options}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	111 any send {expr} over raw {handle}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	112 ch_setoptions({handle}, {options})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	113 none set options for {handle}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	114 ch_status({handle} [, {options}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	115 String status of channel {handle}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	116 changenr() Number current change number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	117 char2nr({expr} [, {utf8}]) Number ASCII/UTF-8 value of first char in {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	118 charclass({string}) Number character class of {string}
31057 1a32f1a4f823 patch 9.0.0863: col() and charcol() only work for the current window Bram Moolenaar <Bram@vim.org> parents: 31028 diff changeset	119 charcol({expr} [, {winid}]) Number column number of cursor or mark
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	120 charidx({string}, {idx} [, {countcc}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	121 Number char index of byte {idx} in {string}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	122 chdir({dir}) String change current working directory
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	123 cindent({lnum}) Number C indent for line {lnum}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	124 clearmatches([{win}]) none clear all matches
31057 1a32f1a4f823 patch 9.0.0863: col() and charcol() only work for the current window Bram Moolenaar <Bram@vim.org> parents: 31028 diff changeset	125 col({expr} [, {winid}]) Number column byte index of cursor or mark
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	126 complete({startcol}, {matches}) none set Insert mode completion
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	127 complete_add({expr}) Number add completion match
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	128 complete_check() Number check for key typed during completion
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	129 complete_info([{what}]) Dict get current completion information
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	130 confirm({msg} [, {choices} [, {default} [, {type}]]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	131 Number number of choice picked by user
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	132 copy({expr}) any make a shallow copy of {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	133 cos({expr}) Float cosine of {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	134 cosh({expr}) Float hyperbolic cosine of {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	135 count({comp}, {expr} [, {ic} [, {start}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	136 Number count how many {expr} are in {comp}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	137 cscope_connection([{num}, {dbpath} [, {prepend}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	138 Number checks existence of cscope connection
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	139 cursor({lnum}, {col} [, {off}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	140 Number move cursor to {lnum}, {col}, {off}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	141 cursor({list}) Number move cursor to position in {list}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	142 debugbreak({pid}) Number interrupt process being debugged
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	143 deepcopy({expr} [, {noref}]) any make a full copy of {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	144 delete({fname} [, {flags}]) Number delete the file or directory {fname}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	145 deletebufline({buf}, {first} [, {last}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	146 Number delete lines from buffer {buf}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	147 did_filetype() Number \|TRUE\| if FileType autocmd event used
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	148 diff_filler({lnum}) Number diff filler lines about {lnum}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	149 diff_hlID({lnum}, {col}) Number diff highlighting at {lnum}/{col}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	150 digraph_get({chars}) String get the \|digraph\| of {chars}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	151 digraph_getlist([{listall}]) List get all \|digraph\|s
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	152 digraph_set({chars}, {digraph}) Boolean register \|digraph\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	153 digraph_setlist({digraphlist}) Boolean register multiple \|digraph\|s
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	154 echoraw({expr}) none output {expr} as-is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	155 empty({expr}) Number \|TRUE\| if {expr} is empty
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	156 environ() Dict return environment variables
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	157 escape({string}, {chars}) String escape {chars} in {string} with '\'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	158 eval({string}) any evaluate {string} into its value
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	159 eventhandler() Number \|TRUE\| if inside an event handler
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	160 executable({expr}) Number 1 if executable {expr} exists
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	161 execute({command}) String execute {command} and get the output
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	162 exepath({expr}) String full path of the command {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	163 exists({expr}) Number \|TRUE\| if {expr} exists
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	164 exists_compiled({expr}) Number \|TRUE\| if {expr} exists at compile time
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	165 exp({expr}) Float exponential of {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	166 expand({expr} [, {nosuf} [, {list}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	167 any expand special keywords in {expr}
28307 425700af491b patch 8.2.4679: cannot have expandcmd() give an error message for mistakes Bram Moolenaar <Bram@vim.org> parents: 28283 diff changeset	168 expandcmd({string} [, {options}])
425700af491b patch 8.2.4679: cannot have expandcmd() give an error message for mistakes Bram Moolenaar <Bram@vim.org> parents: 28283 diff changeset	169 String expand {string} like with `:edit`
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	170 extend({expr1}, {expr2} [, {expr3}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	171 List/Dict insert items of {expr2} into {expr1}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	172 extendnew({expr1}, {expr2} [, {expr3}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	173 List/Dict like \|extend()\| but creates a new
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	174 List or Dictionary
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	175 feedkeys({string} [, {mode}]) Number add key sequence to typeahead buffer
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	176 filereadable({file}) Number \|TRUE\| if {file} is a readable file
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	177 filewritable({file}) Number \|TRUE\| if {file} is a writable file
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	178 filter({expr1}, {expr2}) List/Dict/Blob/String
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	179 remove items from {expr1} where
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	180 {expr2} is 0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	181 finddir({name} [, {path} [, {count}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	182 String find directory {name} in {path}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	183 findfile({name} [, {path} [, {count}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	184 String find file {name} in {path}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	185 flatten({list} [, {maxdepth}]) List flatten {list} up to {maxdepth} levels
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	186 flattennew({list} [, {maxdepth}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	187 List flatten a copy of {list}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	188 float2nr({expr}) Number convert Float {expr} to a Number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	189 floor({expr}) Float round {expr} down
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	190 fmod({expr1}, {expr2}) Float remainder of {expr1} / {expr2}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	191 fnameescape({fname}) String escape special characters in {fname}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	192 fnamemodify({fname}, {mods}) String modify file name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	193 foldclosed({lnum}) Number first line of fold at {lnum} if closed
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	194 foldclosedend({lnum}) Number last line of fold at {lnum} if closed
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	195 foldlevel({lnum}) Number fold level at {lnum}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	196 foldtext() String line displayed for closed fold
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	197 foldtextresult({lnum}) String text for closed fold at {lnum}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	198 foreground() Number bring the Vim window to the foreground
30275 121d28008c14 patch 9.0.0473: fullcommand() only works for the current script version Bram Moolenaar <Bram@vim.org> parents: 30226 diff changeset	199 fullcommand({name} [, {vim9}]) String get full command from {name}
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	200 funcref({name} [, {arglist}] [, {dict}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	201 Funcref reference to function {name}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	202 function({name} [, {arglist}] [, {dict}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	203 Funcref named reference to function {name}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	204 garbagecollect([{atexit}]) none free memory, breaking cyclic references
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	205 get({list}, {idx} [, {def}]) any get item {idx} from {list} or {def}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	206 get({dict}, {key} [, {def}]) any get item {key} from {dict} or {def}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	207 get({func}, {what}) any get property of funcref/partial {func}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	208 getbufinfo([{buf}]) List information about buffers
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	209 getbufline({buf}, {lnum} [, {end}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	210 List lines {lnum} to {end} of buffer {buf}
31164 7831da568864 patch 9.0.0916: getbufline() is inefficient for getting a single line Bram Moolenaar <Bram@vim.org> parents: 31139 diff changeset	211 getbufoneline({buf}, {lnum}) String line {lnum} of buffer {buf}
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	212 getbufvar({buf}, {varname} [, {def}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	213 any variable {varname} in buffer {buf}
31760 f348559ce426 patch 9.0.1212: cannot read back what setcellwidths() has done Bram Moolenaar <Bram@vim.org> parents: 31712 diff changeset	214 getcellwidths() List get character cell width overrides
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	215 getchangelist([{buf}]) List list of change list items
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	216 getchar([expr]) Number or String
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	217 get one character from the user
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	218 getcharmod() Number modifiers for the last typed character
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	219 getcharpos({expr}) List position of cursor, mark, etc.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	220 getcharsearch() Dict last character search
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	221 getcharstr([expr]) String get one character from the user
28757 add09d468c0d patch 8.2.4903: cannot get the current cmdline completion type and position Bram Moolenaar <Bram@vim.org> parents: 28674 diff changeset	222 getcmdcompltype() String return the type of the current
add09d468c0d patch 8.2.4903: cannot get the current cmdline completion type and position Bram Moolenaar <Bram@vim.org> parents: 28674 diff changeset	223 command-line completion
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	224 getcmdline() String return the current command-line
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	225 getcmdpos() Number return cursor position in command-line
28757 add09d468c0d patch 8.2.4903: cannot get the current cmdline completion type and position Bram Moolenaar <Bram@vim.org> parents: 28674 diff changeset	226 getcmdscreenpos() Number return cursor screen position in
add09d468c0d patch 8.2.4903: cannot get the current cmdline completion type and position Bram Moolenaar <Bram@vim.org> parents: 28674 diff changeset	227 command-line
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	228 getcmdtype() String return current command-line type
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	229 getcmdwintype() String return current command-line window type
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	230 getcompletion({pat}, {type} [, {filtered}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	231 List list of cmdline completion matches
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	232 getcurpos([{winnr}]) List position of the cursor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	233 getcursorcharpos([{winnr}]) List character position of the cursor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	234 getcwd([{winnr} [, {tabnr}]]) String get the current working directory
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	235 getenv({name}) String return environment variable
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	236 getfontname([{name}]) String name of font being used
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	237 getfperm({fname}) String file permissions of file {fname}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	238 getfsize({fname}) Number size in bytes of file {fname}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	239 getftime({fname}) Number last modification time of file
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	240 getftype({fname}) String description of type of file {fname}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	241 getimstatus() Number \|TRUE\| if the IME status is active
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	242 getjumplist([{winnr} [, {tabnr}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	243 List list of jump list items
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	244 getline({lnum}) String line {lnum} of current buffer
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	245 getline({lnum}, {end}) List lines {lnum} to {end} of current buffer
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	246 getloclist({nr}) List list of location list items
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	247 getloclist({nr}, {what}) Dict get specific location list properties
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	248 getmarklist([{buf}]) List list of global/local marks
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	249 getmatches([{win}]) List list of current matches
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	250 getmousepos() Dict last known mouse position
31093 004aee2845d2 patch 9.0.0881: cannot get the currently showing mouse shape Bram Moolenaar <Bram@vim.org> parents: 31057 diff changeset	251 getmouseshape() String current mouse shape name
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	252 getpid() Number process ID of Vim
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	253 getpos({expr}) List position of cursor, mark, etc.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	254 getqflist() List list of quickfix items
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	255 getqflist({what}) Dict get specific quickfix list properties
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	256 getreg([{regname} [, 1 [, {list}]]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	257 String or List contents of a register
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	258 getreginfo([{regname}]) Dict information about a register
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	259 getregtype([{regname}]) String type of a register
29861 8dca33bca038 patch 9.0.0269: getscriptinfo() does not include the version Bram Moolenaar <Bram@vim.org> parents: 29853 diff changeset	260 getscriptinfo([{opts}]) List list of sourced scripts
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	261 gettabinfo([{expr}]) List list of tab pages
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	262 gettabvar({nr}, {varname} [, {def}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	263 any variable {varname} in tab {nr} or {def}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	264 gettabwinvar({tabnr}, {winnr}, {name} [, {def}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	265 any {name} in {winnr} in tab page {tabnr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	266 gettagstack([{nr}]) Dict get the tag stack of window {nr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	267 gettext({text}) String lookup translation of {text}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	268 getwininfo([{winid}]) List list of info about each window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	269 getwinpos([{timeout}]) List X and Y coord in pixels of the Vim window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	270 getwinposx() Number X coord in pixels of the Vim window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	271 getwinposy() Number Y coord in pixels of the Vim window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	272 getwinvar({nr}, {varname} [, {def}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	273 any variable {varname} in window {nr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	274 glob({expr} [, {nosuf} [, {list} [, {alllinks}]]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	275 any expand file wildcards in {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	276 glob2regpat({expr}) String convert a glob pat into a search pat
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	277 globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	278 String do glob({expr}) for all dirs in {path}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	279 has({feature} [, {check}]) Number \|TRUE\| if feature {feature} supported
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	280 has_key({dict}, {key}) Number \|TRUE\| if {dict} has entry {key}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	281 haslocaldir([{winnr} [, {tabnr}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	282 Number \|TRUE\| if the window executed \|:lcd\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	283 or \|:tcd\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	284 hasmapto({what} [, {mode} [, {abbr}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	285 Number \|TRUE\| if mapping to {what} exists
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	286 histadd({history}, {item}) Number add an item to a history
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	287 histdel({history} [, {item}]) Number remove an item from a history
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	288 histget({history} [, {index}]) String get the item {index} from a history
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	289 histnr({history}) Number highest index of a history
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	290 hlID({name}) Number syntax ID of highlight group {name}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	291 hlexists({name}) Number \|TRUE\| if highlight group {name} exists
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	292 hlget([{name} [, {resolve}]]) List get highlight group attributes
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	293 hlset({list}) Number set highlight group attributes
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	294 hostname() String name of the machine Vim is running on
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	295 iconv({expr}, {from}, {to}) String convert encoding of {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	296 indent({lnum}) Number indent of line {lnum}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	297 index({object}, {expr} [, {start} [, {ic}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	298 Number index in {object} where {expr} appears
29712 bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	299 indexof({object}, {expr} [, {opts}]])
bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	300 Number index in {object} where {expr} is true
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	301 input({prompt} [, {text} [, {completion}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	302 String get input from the user
29450 67f31c24291b Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29403 diff changeset	303 inputdialog({prompt} [, {text} [, {cancelreturn}]])
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	304 String like input() but in a GUI dialog
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	305 inputlist({textlist}) Number let the user pick from a choice list
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	306 inputrestore() Number restore typeahead
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	307 inputsave() Number save and clear typeahead
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	308 inputsecret({prompt} [, {text}]) String like input() but hiding the text
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	309 insert({object}, {item} [, {idx}]) List insert {item} in {object} [before {idx}]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	310 interrupt() none interrupt script execution
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	311 invert({expr}) Number bitwise invert
28629 5ef46b938c6e patch 8.2.4838: checking for absolute path is not trivial Bram Moolenaar <Bram@vim.org> parents: 28620 diff changeset	312 isabsolutepath({path}) Number \|TRUE\| if {path} is an absolute path
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	313 isdirectory({directory}) Number \|TRUE\| if {directory} is a directory
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	314 isinf({expr}) Number determine if {expr} is infinity value
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	315 (positive or negative)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	316 islocked({expr}) Number \|TRUE\| if {expr} is locked
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	317 isnan({expr}) Number \|TRUE\| if {expr} is NaN
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	318 items({dict}) List key-value pairs in {dict}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	319 job_getchannel({job}) Channel get the channel handle for {job}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	320 job_info([{job}]) Dict get information about {job}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	321 job_setoptions({job}, {options}) none set options for {job}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	322 job_start({command} [, {options}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	323 Job start a job
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	324 job_status({job}) String get the status of {job}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	325 job_stop({job} [, {how}]) Number stop {job}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	326 join({list} [, {sep}]) String join {list} items into one String
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	327 js_decode({string}) any decode JS style JSON
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	328 js_encode({expr}) String encode JS style JSON
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	329 json_decode({string}) any decode JSON
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	330 json_encode({expr}) String encode JSON
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	331 keys({dict}) List keys in {dict}
30226 b6b803ed4a53 patch 9.0.0449: there is no easy way to translate a key code into a string Bram Moolenaar <Bram@vim.org> parents: 30202 diff changeset	332 keytrans({string}) String translate internal keycodes to a form
b6b803ed4a53 patch 9.0.0449: there is no easy way to translate a key code into a string Bram Moolenaar <Bram@vim.org> parents: 30202 diff changeset	333 that can be used by \|:map\|
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	334 len({expr}) Number the length of {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	335 libcall({lib}, {func}, {arg}) String call {func} in library {lib} with {arg}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	336 libcallnr({lib}, {func}, {arg}) Number idem, but return a Number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	337 line({expr} [, {winid}]) Number line nr of cursor, last line or mark
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	338 line2byte({lnum}) Number byte count of line {lnum}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	339 lispindent({lnum}) Number Lisp indent for line {lnum}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	340 list2blob({list}) Blob turn {list} of numbers into a Blob
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	341 list2str({list} [, {utf8}]) String turn {list} of numbers into a String
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	342 listener_add({callback} [, {buf}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	343 Number add a callback to listen to changes
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	344 listener_flush([{buf}]) none invoke listener callbacks
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	345 listener_remove({id}) none remove a listener callback
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	346 localtime() Number current time
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	347 log({expr}) Float natural logarithm (base e) of {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	348 log10({expr}) Float logarithm of Float {expr} to base 10
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	349 luaeval({expr} [, {expr}]) any evaluate \|Lua\| expression
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	350 map({expr1}, {expr2}) List/Dict/Blob/String
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	351 change each item in {expr1} to {expr2}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	352 maparg({name} [, {mode} [, {abbr} [, {dict}]]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	353 String or Dict
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	354 rhs of mapping {name} in mode {mode}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	355 mapcheck({name} [, {mode} [, {abbr}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	356 String check for mappings matching {name}
28602 398c5b3211f9 patch 8.2.4825: can only get a list of mappings Bram Moolenaar <Bram@vim.org> parents: 28592 diff changeset	357 maplist([{abbr}]) List list of all mappings, a dict for each
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	358 mapnew({expr1}, {expr2}) List/Dict/Blob/String
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	359 like \|map()\| but creates a new List or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	360 Dictionary
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	361 mapset({mode}, {abbr}, {dict}) none restore mapping from \|maparg()\| result
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	362 match({expr}, {pat} [, {start} [, {count}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	363 Number position where {pat} matches in {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	364 matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	365 Number highlight {pattern} with {group}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	366 matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	367 Number highlight positions with {group}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	368 matcharg({nr}) List arguments of \|:match\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	369 matchdelete({id} [, {win}]) Number delete match identified by {id}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	370 matchend({expr}, {pat} [, {start} [, {count}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	371 Number position where {pat} ends in {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	372 matchfuzzy({list}, {str} [, {dict}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	373 List fuzzy match {str} in {list}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	374 matchfuzzypos({list}, {str} [, {dict}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	375 List fuzzy match {str} in {list}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	376 matchlist({expr}, {pat} [, {start} [, {count}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	377 List match and submatches of {pat} in {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	378 matchstr({expr}, {pat} [, {start} [, {count}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	379 String {count}'th match of {pat} in {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	380 matchstrpos({expr}, {pat} [, {start} [, {count}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	381 List {count}'th match of {pat} in {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	382 max({expr}) Number maximum value of items in {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	383 menu_info({name} [, {mode}]) Dict get menu item information
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	384 min({expr}) Number minimum value of items in {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	385 mkdir({name} [, {path} [, {prot}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	386 Number create directory {name}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	387 mode([expr]) String current editing mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	388 mzeval({expr}) any evaluate \|MzScheme\| expression
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	389 nextnonblank({lnum}) Number line nr of non-blank line >= {lnum}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	390 nr2char({expr} [, {utf8}]) String single char with ASCII/UTF-8 value {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	391 or({expr}, {expr}) Number bitwise OR
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	392 pathshorten({expr} [, {len}]) String shorten directory names in a path
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	393 perleval({expr}) any evaluate \|Perl\| expression
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	394 popup_atcursor({what}, {options}) Number create popup window near the cursor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	395 popup_beval({what}, {options}) Number create popup window for 'ballooneval'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	396 popup_clear() none close all popup windows
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	397 popup_close({id} [, {result}]) none close popup window {id}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	398 popup_create({what}, {options}) Number create a popup window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	399 popup_dialog({what}, {options}) Number create a popup window used as a dialog
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	400 popup_filter_menu({id}, {key}) Number filter for a menu popup window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	401 popup_filter_yesno({id}, {key}) Number filter for a dialog popup window
30697 d914a3812d5b patch 9.0.0683: cannot specify a time for :echowindow Bram Moolenaar <Bram@vim.org> parents: 30634 diff changeset	402 popup_findecho() Number get window ID of popup for `:echowin`
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	403 popup_findinfo() Number get window ID of info popup window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	404 popup_findpreview() Number get window ID of preview popup window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	405 popup_getoptions({id}) Dict get options of popup window {id}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	406 popup_getpos({id}) Dict get position of popup window {id}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	407 popup_hide({id}) none hide popup menu {id}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	408 popup_list() List get a list of window IDs of all popups
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	409 popup_locate({row}, {col}) Number get window ID of popup at position
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	410 popup_menu({what}, {options}) Number create a popup window used as a menu
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	411 popup_move({id}, {options}) none set position of popup window {id}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	412 popup_notification({what}, {options})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	413 Number create a notification popup window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	414 popup_setoptions({id}, {options})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	415 none set options for popup window {id}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	416 popup_settext({id}, {text}) none set the text of popup window {id}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	417 popup_show({id}) none unhide popup window {id}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	418 pow({x}, {y}) Float {x} to the power of {y}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	419 prevnonblank({lnum}) Number line nr of non-blank line <= {lnum}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	420 printf({fmt}, {expr1}...) String format text
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	421 prompt_getprompt({buf}) String get prompt text
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	422 prompt_setcallback({buf}, {expr}) none set prompt callback function
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	423 prompt_setinterrupt({buf}, {text}) none set prompt interrupt function
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	424 prompt_setprompt({buf}, {text}) none set prompt text
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	425 prop_add({lnum}, {col}, {props}) none add one text property
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	426 prop_add_list({props}, [[{lnum}, {col}, {end-lnum}, {end-col}], ...])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	427 none add multiple text properties
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	428 prop_clear({lnum} [, {lnum-end} [, {props}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	429 none remove all text properties
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	430 prop_find({props} [, {direction}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	431 Dict search for a text property
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	432 prop_list({lnum} [, {props}]) List text properties in {lnum}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	433 prop_remove({props} [, {lnum} [, {lnum-end}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	434 Number remove a text property
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	435 prop_type_add({name}, {props}) none define a new property type
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	436 prop_type_change({name}, {props})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	437 none change an existing property type
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	438 prop_type_delete({name} [, {props}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	439 none delete a property type
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	440 prop_type_get({name} [, {props}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	441 Dict get property type values
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	442 prop_type_list([{props}]) List get list of property types
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	443 pum_getpos() Dict position and size of pum if visible
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	444 pumvisible() Number whether popup menu is visible
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	445 py3eval({expr}) any evaluate \|python3\| expression
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	446 pyeval({expr}) any evaluate \|Python\| expression
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	447 pyxeval({expr}) any evaluate \|python_x\| expression
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	448 rand([{expr}]) Number get pseudo-random number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	449 range({expr} [, {max} [, {stride}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	450 List items from {expr} to {max}
30922 ed6acfafa17e patch 9.0.0795: readblob() always reads the whole file Bram Moolenaar <Bram@vim.org> parents: 30875 diff changeset	451 readblob({fname} [, {offset} [, {size}]])
ed6acfafa17e patch 9.0.0795: readblob() always reads the whole file Bram Moolenaar <Bram@vim.org> parents: 30875 diff changeset	452 Blob read a \|Blob\| from {fname}
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	453 readdir({dir} [, {expr} [, {dict}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	454 List file names in {dir} selected by {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	455 readdirex({dir} [, {expr} [, {dict}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	456 List file info in {dir} selected by {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	457 readfile({fname} [, {type} [, {max}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	458 List get list of lines from file {fname}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	459 reduce({object}, {func} [, {initial}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	460 any reduce {object} using {func}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	461 reg_executing() String get the executing register name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	462 reg_recording() String get the recording register name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	463 reltime([{start} [, {end}]]) List get time value
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	464 reltimefloat({time}) Float turn the time value into a Float
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	465 reltimestr({time}) String turn time value into a String
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	466 remote_expr({server}, {string} [, {idvar} [, {timeout}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	467 String send expression
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	468 remote_foreground({server}) Number bring Vim server to the foreground
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	469 remote_peek({serverid} [, {retvar}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	470 Number check for reply string
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	471 remote_read({serverid} [, {timeout}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	472 String read reply string
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	473 remote_send({server}, {string} [, {idvar}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	474 String send key sequence
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	475 remote_startserver({name}) none become server {name}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	476 remove({list}, {idx} [, {end}]) any/List
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	477 remove items {idx}-{end} from {list}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	478 remove({blob}, {idx} [, {end}]) Number/Blob
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	479 remove bytes {idx}-{end} from {blob}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	480 remove({dict}, {key}) any remove entry {key} from {dict}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	481 rename({from}, {to}) Number rename (move) file from {from} to {to}
30188 ba22d5536d3e patch 9.0.0430: cannot use repeat() with a blob Bram Moolenaar <Bram@vim.org> parents: 30150 diff changeset	482 repeat({expr}, {count}) List/Blob/String
ba22d5536d3e patch 9.0.0430: cannot use repeat() with a blob Bram Moolenaar <Bram@vim.org> parents: 30150 diff changeset	483 repeat {expr} {count} times
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	484 resolve({filename}) String get filename a shortcut points to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	485 reverse({list}) List reverse {list} in-place
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	486 round({expr}) Float round off {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	487 rubyeval({expr}) any evaluate \|Ruby\| expression
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	488 screenattr({row}, {col}) Number attribute at screen position
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	489 screenchar({row}, {col}) Number character at screen position
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	490 screenchars({row}, {col}) List List of characters at screen position
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	491 screencol() Number current cursor column
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	492 screenpos({winid}, {lnum}, {col}) Dict screen row and col of a text character
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	493 screenrow() Number current cursor row
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	494 screenstring({row}, {col}) String characters at screen position
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	495 search({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	496 Number search for {pattern}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	497 searchcount([{options}]) Dict get or update search stats
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	498 searchdecl({name} [, {global} [, {thisblock}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	499 Number search for variable declaration
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	500 searchpair({start}, {middle}, {end} [, {flags} [, {skip} [...]]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	501 Number search for other end of start/end pair
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	502 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} [...]]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	503 List search for other end of start/end pair
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	504 searchpos({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	505 List search for {pattern}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	506 server2client({clientid}, {string})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	507 Number send reply string
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	508 serverlist() String get a list of available servers
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	509 setbufline({expr}, {lnum}, {text})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	510 Number set line {lnum} to {text} in buffer
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	511 {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	512 setbufvar({buf}, {varname}, {val})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	513 none set {varname} in buffer {buf} to {val}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	514 setcellwidths({list}) none set character cell width overrides
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	515 setcharpos({expr}, {list}) Number set the {expr} position to {list}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	516 setcharsearch({dict}) Dict set character search from {dict}
29894 d8fc1effa724 patch 9.0.0285: it is not easy to change the command line from a plugin Bram Moolenaar <Bram@vim.org> parents: 29883 diff changeset	517 setcmdline({str} [, {pos}]) Number set command-line
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	518 setcmdpos({pos}) Number set cursor position in command-line
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	519 setcursorcharpos({list}) Number move cursor to position in {list}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	520 setenv({name}, {val}) none set environment variable
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	521 setfperm({fname}, {mode}) Number set {fname} file permissions to {mode}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	522 setline({lnum}, {line}) Number set line {lnum} to {line}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	523 setloclist({nr}, {list} [, {action}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	524 Number modify location list using {list}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	525 setloclist({nr}, {list}, {action}, {what})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	526 Number modify specific location list props
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	527 setmatches({list} [, {win}]) Number restore a list of matches
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	528 setpos({expr}, {list}) Number set the {expr} position to {list}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	529 setqflist({list} [, {action}]) Number modify quickfix list using {list}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	530 setqflist({list}, {action}, {what})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	531 Number modify specific quickfix list props
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	532 setreg({n}, {v} [, {opt}]) Number set register to value and type
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	533 settabvar({nr}, {varname}, {val}) none set {varname} in tab page {nr} to {val}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	534 settabwinvar({tabnr}, {winnr}, {varname}, {val})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	535 none set {varname} in window {winnr} in tab
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	536 page {tabnr} to {val}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	537 settagstack({nr}, {dict} [, {action}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	538 Number modify tag stack using {dict}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	539 setwinvar({nr}, {varname}, {val}) none set {varname} in window {nr} to {val}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	540 sha256({string}) String SHA256 checksum of {string}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	541 shellescape({string} [, {special}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	542 String escape {string} for use as shell
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	543 command argument
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	544 shiftwidth([{col}]) Number effective value of 'shiftwidth'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	545 sign_define({name} [, {dict}]) Number define or update a sign
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	546 sign_define({list}) List define or update a list of signs
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	547 sign_getdefined([{name}]) List get a list of defined signs
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	548 sign_getplaced([{buf} [, {dict}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	549 List get a list of placed signs
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	550 sign_jump({id}, {group}, {buf})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	551 Number jump to a sign
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	552 sign_place({id}, {group}, {name}, {buf} [, {dict}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	553 Number place a sign
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	554 sign_placelist({list}) List place a list of signs
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	555 sign_undefine([{name}]) Number undefine a sign
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	556 sign_undefine({list}) List undefine a list of signs
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	557 sign_unplace({group} [, {dict}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	558 Number unplace a sign
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	559 sign_unplacelist({list}) List unplace a list of signs
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	560 simplify({filename}) String simplify filename as much as possible
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	561 sin({expr}) Float sine of {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	562 sinh({expr}) Float hyperbolic sine of {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	563 slice({expr}, {start} [, {end}]) String, List or Blob
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	564 slice of a String, List or Blob
27859 3cb1a109e987 patch 8.2.4455: accepting one and zero for second sort() argument is strange Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	565 sort({list} [, {how} [, {dict}]])
3cb1a109e987 patch 8.2.4455: accepting one and zero for second sort() argument is strange Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	566 List sort {list}, compare with {how}
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	567 sound_clear() none stop playing all sounds
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	568 sound_playevent({name} [, {callback}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	569 Number play an event sound
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	570 sound_playfile({path} [, {callback}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	571 Number play sound file {path}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	572 sound_stop({id}) none stop playing sound {id}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	573 soundfold({word}) String sound-fold {word}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	574 spellbadword() String badly spelled word at cursor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	575 spellsuggest({word} [, {max} [, {capital}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	576 List spelling suggestions
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	577 split({expr} [, {pat} [, {keepempty}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	578 List make \|List\| from {pat} separated {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	579 sqrt({expr}) Float square root of {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	580 srand([{expr}]) List get seed for \|rand()\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	581 state([{what}]) String current state of Vim
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	582 str2float({expr} [, {quoted}]) Float convert String to Float
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	583 str2list({expr} [, {utf8}]) List convert each character of {expr} to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	584 ASCII/UTF-8 value
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	585 str2nr({expr} [, {base} [, {quoted}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	586 Number convert String to Number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	587 strcharlen({expr}) Number character length of the String {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	588 strcharpart({str}, {start} [, {len} [, {skipcc}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	589 String {len} characters of {str} at
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	590 character {start}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	591 strchars({expr} [, {skipcc}]) Number character count of the String {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	592 strdisplaywidth({expr} [, {col}]) Number display length of the String {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	593 strftime({format} [, {time}]) String format time with a specified format
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	594 strgetchar({str}, {index}) Number get char {index} from {str}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	595 stridx({haystack}, {needle} [, {start}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	596 Number index of {needle} in {haystack}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	597 string({expr}) String String representation of {expr} value
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	598 strlen({expr}) Number length of the String {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	599 strpart({str}, {start} [, {len} [, {chars}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	600 String {len} bytes/chars of {str} at
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	601 byte {start}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	602 strptime({format}, {timestring})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	603 Number Convert {timestring} to unix timestamp
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	604 strridx({haystack}, {needle} [, {start}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	605 Number last index of {needle} in {haystack}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	606 strtrans({expr}) String translate string to make it printable
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	607 strwidth({expr}) Number display cell length of the String {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	608 submatch({nr} [, {list}]) String or List
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	609 specific match in ":s" or substitute()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	610 substitute({expr}, {pat}, {sub}, {flags})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	611 String all {pat} in {expr} replaced with {sub}
31347 56a2af8c0980 patch 9.0.1007: there is no way to get a list of swap file names Bram Moolenaar <Bram@vim.org> parents: 31200 diff changeset	612 swapfilelist() List swap files found in 'directory'
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	613 swapinfo({fname}) Dict information about swap file {fname}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	614 swapname({buf}) String swap file of buffer {buf}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	615 synID({lnum}, {col}, {trans}) Number syntax ID at {lnum} and {col}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	616 synIDattr({synID}, {what} [, {mode}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	617 String attribute {what} of syntax ID {synID}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	618 synIDtrans({synID}) Number translated syntax ID of {synID}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	619 synconcealed({lnum}, {col}) List info about concealing
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	620 synstack({lnum}, {col}) List stack of syntax IDs at {lnum} and {col}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	621 system({expr} [, {input}]) String output of shell command/filter {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	622 systemlist({expr} [, {input}]) List output of shell command/filter {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	623 tabpagebuflist([{arg}]) List list of buffer numbers in tab page
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	624 tabpagenr([{arg}]) Number number of current or last tab page
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	625 tabpagewinnr({tabarg} [, {arg}]) Number number of current window in tab page
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	626 tagfiles() List tags files used
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	627 taglist({expr} [, {filename}]) List list of tags matching {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	628 tan({expr}) Float tangent of {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	629 tanh({expr}) Float hyperbolic tangent of {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	630 tempname() String name for a temporary file
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	631 term_dumpdiff({filename}, {filename} [, {options}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	632 Number display difference between two dumps
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	633 term_dumpload({filename} [, {options}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	634 Number displaying a screen dump
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	635 term_dumpwrite({buf}, {filename} [, {options}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	636 none dump terminal window contents
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	637 term_getaltscreen({buf}) Number get the alternate screen flag
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	638 term_getansicolors({buf}) List get ANSI palette in GUI color mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	639 term_getattr({attr}, {what}) Number get the value of attribute {what}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	640 term_getcursor({buf}) List get the cursor position of a terminal
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	641 term_getjob({buf}) Job get the job associated with a terminal
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	642 term_getline({buf}, {row}) String get a line of text from a terminal
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	643 term_getscrolled({buf}) Number get the scroll count of a terminal
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	644 term_getsize({buf}) List get the size of a terminal
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	645 term_getstatus({buf}) String get the status of a terminal
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	646 term_gettitle({buf}) String get the title of a terminal
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	647 term_gettty({buf}, [{input}]) String get the tty name of a terminal
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	648 term_list() List get the list of terminal buffers
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	649 term_scrape({buf}, {row}) List get row of a terminal screen
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	650 term_sendkeys({buf}, {keys}) none send keystrokes to a terminal
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	651 term_setansicolors({buf}, {colors})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	652 none set ANSI palette in GUI color mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	653 term_setapi({buf}, {expr}) none set \|terminal-api\| function name prefix
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	654 term_setkill({buf}, {how}) none set signal to stop job in terminal
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	655 term_setrestore({buf}, {command}) none set command to restore terminal
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	656 term_setsize({buf}, {rows}, {cols})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	657 none set the size of a terminal
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	658 term_start({cmd} [, {options}]) Number open a terminal window and run a job
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	659 term_wait({buf} [, {time}]) Number wait for screen to be updated
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	660 terminalprops() Dict properties of the terminal
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	661 test_alloc_fail({id}, {countdown}, {repeat})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	662 none make memory allocation fail
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	663 test_autochdir() none enable 'autochdir' during startup
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	664 test_feedinput({string}) none add key sequence to input buffer
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	665 test_garbagecollect_now() none free memory right now for testing
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	666 test_garbagecollect_soon() none free memory soon for testing
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	667 test_getvalue({string}) any get value of an internal variable
27462 b43f6c879d52 patch 8.2.4259: number of test functions for GUI events is growing Bram Moolenaar <Bram@vim.org> parents: 27459 diff changeset	668 test_gui_event({event}, {args}) bool generate a GUI event for testing
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	669 test_ignore_error({expr}) none ignore a specific error
31503 b9a4699d6a35 patch 9.0.1084: code handling low level MS-Windows events cannot be tested Bram Moolenaar <Bram@vim.org> parents: 31383 diff changeset	670 test_mswin_event({event}, {args})
b9a4699d6a35 patch 9.0.1084: code handling low level MS-Windows events cannot be tested Bram Moolenaar <Bram@vim.org> parents: 31383 diff changeset	671 bool generate MS-Windows event for testing
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	672 test_null_blob() Blob null value for testing
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	673 test_null_channel() Channel null value for testing
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	674 test_null_dict() Dict null value for testing
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	675 test_null_function() Funcref null value for testing
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	676 test_null_job() Job null value for testing
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	677 test_null_list() List null value for testing
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	678 test_null_partial() Funcref null value for testing
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	679 test_null_string() String null value for testing
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	680 test_option_not_set({name}) none reset flag indicating option was set
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	681 test_override({expr}, {val}) none test with Vim internal overrides
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	682 test_refcount({expr}) Number get the reference count of {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	683 test_setmouse({row}, {col}) none set the mouse position for testing
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	684 test_settime({expr}) none set current time for testing
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	685 test_srand_seed([seed]) none set seed for testing srand()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	686 test_unknown() any unknown value for testing
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	687 test_void() any void value for testing
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	688 timer_info([{id}]) List information about timers
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	689 timer_pause({id}, {pause}) none pause or unpause a timer
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	690 timer_start({time}, {callback} [, {options}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	691 Number create a timer
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	692 timer_stop({timer}) none stop a timer
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	693 timer_stopall() none stop all timers
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	694 tolower({expr}) String the String {expr} switched to lowercase
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	695 toupper({expr}) String the String {expr} switched to uppercase
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	696 tr({src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	697 to chars in {tostr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	698 trim({text} [, {mask} [, {dir}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	699 String trim characters in {mask} from {text}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	700 trunc({expr}) Float truncate Float {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	701 type({expr}) Number type of value {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	702 typename({expr}) String representation of the type of {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	703 undofile({name}) String undo file name for {name}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	704 undotree() List undo file tree
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	705 uniq({list} [, {func} [, {dict}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	706 List remove adjacent duplicates from a list
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	707 values({dict}) List values in {dict}
28994 644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	708 virtcol({expr} [, {list}]) Number or List
644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	709 screen column of cursor or mark
29024 9f25e0ed831d patch 8.2.5034: there is no way to get the byte index from a virtual column Bram Moolenaar <Bram@vim.org> parents: 29016 diff changeset	710 virtcol2col({winid}, {lnum}, {col})
9f25e0ed831d patch 8.2.5034: there is no way to get the byte index from a virtual column Bram Moolenaar <Bram@vim.org> parents: 29016 diff changeset	711 Number byte index of a character on screen
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	712 visualmode([expr]) String last visual mode used
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	713 wildmenumode() Number whether 'wildmenu' mode is active
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	714 win_execute({id}, {command} [, {silent}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	715 String execute {command} in window {id}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	716 win_findbuf({bufnr}) List find windows containing {bufnr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	717 win_getid([{win} [, {tab}]]) Number get window ID for {win} in {tab}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	718 win_gettype([{nr}]) String type of window {nr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	719 win_gotoid({expr}) Number go to window with ID {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	720 win_id2tabwin({expr}) List get tab and window nr from window ID
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	721 win_id2win({expr}) Number get window nr from window ID
27047 b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	722 win_move_separator({nr}) Number move window vertical separator
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	723 win_move_statusline({nr}) Number move window status line
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	724 win_screenpos({nr}) List get screen position of window {nr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	725 win_splitmove({nr}, {target} [, {options}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	726 Number move window {nr} to split of {target}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	727 winbufnr({nr}) Number buffer number of window {nr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	728 wincol() Number window column of the cursor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	729 windowsversion() String MS-Windows OS version
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	730 winheight({nr}) Number height of window {nr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	731 winlayout([{tabnr}]) List layout of windows in tab {tabnr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	732 winline() Number window line of the cursor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	733 winnr([{expr}]) Number number of current window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	734 winrestcmd() String returns command to restore window sizes
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	735 winrestview({dict}) none restore view of current window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	736 winsaveview() Dict save view of current window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	737 winwidth({nr}) Number width of window {nr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	738 wordcount() Dict get byte/char/word statistics
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	739 writefile({object}, {fname} [, {flags}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	740 Number write \|Blob\| or \|List\| of lines to file
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	741 xor({expr}, {expr}) Number bitwise XOR
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	742
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	743 ==============================================================================
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	744 2. Details builtin-function-details
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	745
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	746 Not all functions are here, some have been moved to a help file covering the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	747 specific functionality.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	748
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	749 abs({expr}) abs()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	750 Return the absolute value of {expr}. When {expr} evaluates to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	751 a \|Float\| abs() returns a \|Float\|. When {expr} can be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	752 converted to a \|Number\| abs() returns a \|Number\|. Otherwise
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	753 abs() gives an error message and returns -1.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	754 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	755 echo abs(1.456)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	756 < 1.456 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	757 echo abs(-5.456)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	758 < 5.456 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	759 echo abs(-4)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	760 < 4
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	761
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	762 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	763 Compute()->abs()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	764
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	765
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	766 acos({expr}) acos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	767 Return the arc cosine of {expr} measured in radians, as a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	768 \|Float\| in the range of [0, pi].
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	769 {expr} must evaluate to a \|Float\| or a \|Number\| in the range
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	770 [-1, 1]. Otherwise acos() returns "nan".
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	771 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	772 :echo acos(0)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	773 < 1.570796 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	774 :echo acos(-0.5)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	775 < 2.094395
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	776
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	777 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	778 Compute()->acos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	779
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	780
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	781 add({object}, {expr}) add()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	782 Append the item {expr} to \|List\| or \|Blob\| {object}. Returns
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	783 the resulting \|List\| or \|Blob\|. Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	784 :let alist = add([1, 2, 3], item)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	785 :call add(mylist, "woodstock")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	786 < Note that when {expr} is a \|List\| it is appended as a single
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	787 item. Use \|extend()\| to concatenate \|Lists\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	788 When {object} is a \|Blob\| then {expr} must be a number.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	789 Use \|insert()\| to add an item at another position.
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	790 Returns 1 if {object} is not a \|List\| or a \|Blob\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	791
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	792 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	793 mylist->add(val1)->add(val2)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	794
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	795
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	796 and({expr}, {expr}) and()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	797 Bitwise AND on the two arguments. The arguments are converted
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	798 to a number. A List, Dict or Float argument causes an error.
28994 644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	799 Also see `or()` and `xor()`.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	800 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	801 :let flag = and(bits, 0x80)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	802 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	803 :let flag = bits->and(0x80)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	804
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	805
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	806 append({lnum}, {text}) append()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	807 When {text} is a \|List\|: Append each item of the \|List\| as a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	808 text line below line {lnum} in the current buffer.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	809 Otherwise append {text} as one text line below line {lnum} in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	810 the current buffer.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	811 Any type of item is accepted and converted to a String.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	812 {lnum} can be zero to insert a line before the first one.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	813 {lnum} is used like with \|getline()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	814 Returns 1 for failure ({lnum} out of range or out of memory),
31004 eb145a4d6bf8 patch 9.0.0837: append() reports failure when not appending anything Bram Moolenaar <Bram@vim.org> parents: 30967 diff changeset	815 0 for success. When {text} is an empty list zero is returned,
eb145a4d6bf8 patch 9.0.0837: append() reports failure when not appending anything Bram Moolenaar <Bram@vim.org> parents: 30967 diff changeset	816 no matter the value of {lnum}.
eb145a4d6bf8 patch 9.0.0837: append() reports failure when not appending anything Bram Moolenaar <Bram@vim.org> parents: 30967 diff changeset	817 In \|Vim9\| script an invalid argument or negative number
eb145a4d6bf8 patch 9.0.0837: append() reports failure when not appending anything Bram Moolenaar <Bram@vim.org> parents: 30967 diff changeset	818 results in an error. Example: >
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	819 :let failed = append(line('$'), "# THE END")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	820 :let failed = append(0, ["Chapter 1", "the beginning"])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	821
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	822 < Can also be used as a \|method\| after a List, the base is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	823 passed as the second argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	824 mylist->append(lnum)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	825
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	826
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	827 appendbufline({buf}, {lnum}, {text}) appendbufline()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	828 Like \|append()\| but append the text in buffer {buf}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	829
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	830 This function works only for loaded buffers. First call
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	831 \|bufload()\| if needed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	832
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	833 For the use of {buf}, see \|bufname()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	834
26782 b7b82279426f patch 8.2.3919: Vim9: wrong argument for append() results in two errors Bram Moolenaar <Bram@vim.org> parents: 26777 diff changeset	835 {lnum} is the line number to append below. Note that using
b7b82279426f patch 8.2.3919: Vim9: wrong argument for append() results in two errors Bram Moolenaar <Bram@vim.org> parents: 26777 diff changeset	836 \|line()\| would use the current buffer, not the one appending
b7b82279426f patch 8.2.3919: Vim9: wrong argument for append() results in two errors Bram Moolenaar <Bram@vim.org> parents: 26777 diff changeset	837 to. Use "$" to append at the end of the buffer. Other string
b7b82279426f patch 8.2.3919: Vim9: wrong argument for append() results in two errors Bram Moolenaar <Bram@vim.org> parents: 26777 diff changeset	838 values are not supported.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	839
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	840 On success 0 is returned, on failure 1 is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	841 In \|Vim9\| script an error is given for an invalid {lnum}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	842
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	843 If {buf} is not a valid buffer or {lnum} is not valid, an
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	844 error message is given. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	845 :let failed = appendbufline(13, 0, "# THE START")
31004 eb145a4d6bf8 patch 9.0.0837: append() reports failure when not appending anything Bram Moolenaar <Bram@vim.org> parents: 30967 diff changeset	846 < However, when {text} is an empty list then no error is given
eb145a4d6bf8 patch 9.0.0837: append() reports failure when not appending anything Bram Moolenaar <Bram@vim.org> parents: 30967 diff changeset	847 for an invalid {lnum}, since {lnum} isn't actually used.
eb145a4d6bf8 patch 9.0.0837: append() reports failure when not appending anything Bram Moolenaar <Bram@vim.org> parents: 30967 diff changeset	848
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	849 Can also be used as a \|method\| after a List, the base is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	850 passed as the second argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	851 mylist->appendbufline(buf, lnum)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	852
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	853
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	854 argc([{winid}]) argc()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	855 The result is the number of files in the argument list. See
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	856 \|arglist\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	857 If {winid} is not supplied, the argument list of the current
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	858 window is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	859 If {winid} is -1, the global argument list is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	860 Otherwise {winid} specifies the window of which the argument
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	861 list is used: either the window number or the window ID.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	862 Returns -1 if the {winid} argument is invalid.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	863
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	864 argidx()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	865 argidx() The result is the current index in the argument list. 0 is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	866 the first file. argc() - 1 is the last one. See \|arglist\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	867
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	868 arglistid()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	869 arglistid([{winnr} [, {tabnr}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	870 Return the argument list ID. This is a number which
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	871 identifies the argument list being used. Zero is used for the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	872 global argument list. See \|arglist\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	873 Returns -1 if the arguments are invalid.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	874
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	875 Without arguments use the current window.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	876 With {winnr} only use this window in the current tab page.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	877 With {winnr} and {tabnr} use the window in the specified tab
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	878 page.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	879 {winnr} can be the window number or the \|window-ID\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	880
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	881 argv()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	882 argv([{nr} [, {winid}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	883 The result is the {nr}th file in the argument list. See
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	884 \|arglist\|. "argv(0)" is the first one. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	885 :let i = 0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	886 :while i < argc()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	887 : let f = escape(fnameescape(argv(i)), '.')
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	888 : exe 'amenu Arg.' .. f .. ' :e ' .. f .. '<CR>'
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	889 : let i = i + 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	890 :endwhile
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	891 < Without the {nr} argument, or when {nr} is -1, a \|List\| with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	892 the whole \|arglist\| is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	893
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	894 The {winid} argument specifies the window ID, see \|argc()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	895 For the Vim command line arguments see \|v:argv\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	896
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	897 Returns an empty string if {nr}th argument is not present in
f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	898 the argument list. Returns an empty List if the {winid}
f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	899 argument is invalid.
f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	900
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	901 asin({expr}) asin()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	902 Return the arc sine of {expr} measured in radians, as a \|Float\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	903 in the range of [-pi/2, pi/2].
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	904 {expr} must evaluate to a \|Float\| or a \|Number\| in the range
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	905 [-1, 1].
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	906 Returns "nan" if {expr} is outside the range [-1, 1]. Returns
f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	907 0.0 if {expr} is not a \|Float\| or a \|Number\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	908 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	909 :echo asin(0.8)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	910 < 0.927295 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	911 :echo asin(-0.5)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	912 < -0.523599
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	913
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	914 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	915 Compute()->asin()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	916
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	917
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	918 assert_ functions are documented here: \|assert-functions-details\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	919
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	920
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	921
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	922 atan({expr}) atan()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	923 Return the principal value of the arc tangent of {expr}, in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	924 the range [-pi/2, +pi/2] radians, as a \|Float\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	925 {expr} must evaluate to a \|Float\| or a \|Number\|.
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	926 Returns 0.0 if {expr} is not a \|Float\| or a \|Number\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	927 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	928 :echo atan(100)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	929 < 1.560797 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	930 :echo atan(-4.01)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	931 < -1.326405
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	932
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	933 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	934 Compute()->atan()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	935
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	936
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	937 atan2({expr1}, {expr2}) atan2()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	938 Return the arc tangent of {expr1} / {expr2}, measured in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	939 radians, as a \|Float\| in the range [-pi, pi].
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	940 {expr1} and {expr2} must evaluate to a \|Float\| or a \|Number\|.
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	941 Returns 0.0 if {expr1} or {expr2} is not a \|Float\| or a
f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	942 \|Number\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	943 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	944 :echo atan2(-1, 1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	945 < -0.785398 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	946 :echo atan2(1, -1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	947 < 2.356194
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	948
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	949 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	950 Compute()->atan2(1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	951
28917 c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	952
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	953 autocmd_add({acmds}) autocmd_add()
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	954 Adds a List of autocmds and autocmd groups.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	955
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	956 The {acmds} argument is a List where each item is a Dict with
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	957 the following optional items:
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	958 bufnr buffer number to add a buffer-local autocmd.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	959 If this item is specified, then the "pattern"
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	960 item is ignored.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	961 cmd Ex command to execute for this autocmd event
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	962 event autocmd event name. Refer to \|autocmd-events\|.
29016 aadeddf38d9b patch 8.2.5030: autocmd_add() can only handle one event and pattern Bram Moolenaar <Bram@vim.org> parents: 28994 diff changeset	963 This can be either a String with a single
aadeddf38d9b patch 8.2.5030: autocmd_add() can only handle one event and pattern Bram Moolenaar <Bram@vim.org> parents: 28994 diff changeset	964 event name or a List of event names.
28917 c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	965 group autocmd group name. Refer to \|autocmd-groups\|.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	966 If this group doesn't exist then it is
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	967 created. If not specified or empty, then the
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	968 default group is used.
28978 3c3bdb8069f5 patch 8.2.5011: Replacing an autocommand requires several lines Bram Moolenaar <Bram@vim.org> parents: 28956 diff changeset	969 nested boolean flag, set to v:true to add a nested
3c3bdb8069f5 patch 8.2.5011: Replacing an autocommand requires several lines Bram Moolenaar <Bram@vim.org> parents: 28956 diff changeset	970 autocmd. Refer to \|autocmd-nested\|.
28994 644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	971 once boolean flag, set to v:true to add an autocmd
28978 3c3bdb8069f5 patch 8.2.5011: Replacing an autocommand requires several lines Bram Moolenaar <Bram@vim.org> parents: 28956 diff changeset	972 which executes only once. Refer to
3c3bdb8069f5 patch 8.2.5011: Replacing an autocommand requires several lines Bram Moolenaar <Bram@vim.org> parents: 28956 diff changeset	973 \|autocmd-once\|.
28917 c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	974 pattern autocmd pattern string. Refer to
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	975 \|autocmd-patterns\|. If "bufnr" item is
29016 aadeddf38d9b patch 8.2.5030: autocmd_add() can only handle one event and pattern Bram Moolenaar <Bram@vim.org> parents: 28994 diff changeset	976 present, then this item is ignored. This can
aadeddf38d9b patch 8.2.5030: autocmd_add() can only handle one event and pattern Bram Moolenaar <Bram@vim.org> parents: 28994 diff changeset	977 be a String with a single pattern or a List of
aadeddf38d9b patch 8.2.5030: autocmd_add() can only handle one event and pattern Bram Moolenaar <Bram@vim.org> parents: 28994 diff changeset	978 patterns.
28978 3c3bdb8069f5 patch 8.2.5011: Replacing an autocommand requires several lines Bram Moolenaar <Bram@vim.org> parents: 28956 diff changeset	979 replace boolean flag, set to v:true to remove all the
3c3bdb8069f5 patch 8.2.5011: Replacing an autocommand requires several lines Bram Moolenaar <Bram@vim.org> parents: 28956 diff changeset	980 commands associated with the specified autocmd
3c3bdb8069f5 patch 8.2.5011: Replacing an autocommand requires several lines Bram Moolenaar <Bram@vim.org> parents: 28956 diff changeset	981 event and group and add the {cmd}. This is
3c3bdb8069f5 patch 8.2.5011: Replacing an autocommand requires several lines Bram Moolenaar <Bram@vim.org> parents: 28956 diff changeset	982 useful to avoid adding the same command
28994 644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	983 multiple times for an autocmd event in a group.
28917 c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	984
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	985 Returns v:true on success and v:false on failure.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	986 Examples: >
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	987 " Create a buffer-local autocmd for buffer 5
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	988 let acmd = {}
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	989 let acmd.group = 'MyGroup'
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	990 let acmd.event = 'BufEnter'
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	991 let acmd.bufnr = 5
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	992 let acmd.cmd = 'call BufEnterFunc()'
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	993 call autocmd_add([acmd])
31004 eb145a4d6bf8 patch 9.0.0837: append() reports failure when not appending anything Bram Moolenaar <Bram@vim.org> parents: 30967 diff changeset	994 <
28917 c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	995 Can also be used as a \|method\|: >
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	996 GetAutocmdList()->autocmd_add()
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	997 <
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	998 autocmd_delete({acmds}) autocmd_delete()
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	999 Deletes a List of autocmds and autocmd groups.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1000
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1001 The {acmds} argument is a List where each item is a Dict with
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1002 the following optional items:
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1003 bufnr buffer number to delete a buffer-local autocmd.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1004 If this item is specified, then the "pattern"
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1005 item is ignored.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1006 cmd Ex command for this autocmd event
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1007 event autocmd event name. Refer to \|autocmd-events\|.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1008 If '*' then all the autocmd events in this
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1009 group are deleted.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1010 group autocmd group name. Refer to \|autocmd-groups\|.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1011 If not specified or empty, then the default
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1012 group is used.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1013 nested set to v:true for a nested autocmd.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1014 Refer to \|autocmd-nested\|.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1015 once set to v:true for an autocmd which executes
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1016 only once. Refer to \|autocmd-once\|.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1017 pattern autocmd pattern string. Refer to
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1018 \|autocmd-patterns\|. If "bufnr" item is
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1019 present, then this item is ignored.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1020
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1021 If only {group} is specified in a {acmds} entry and {event},
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1022 {pattern} and {cmd} are not specified, then that autocmd group
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1023 is deleted.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1024
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	1025 Returns \|v:true\| on success and \|v:false\| on failure.
28917 c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1026 Examples: >
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1027 " :autocmd! BufLeave *.vim
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1028 let acmd = #{event: 'BufLeave', pattern: '*.vim'}
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1029 call autocmd_delete([acmd]})
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1030 " :autocmd! MyGroup1 BufLeave
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1031 let acmd = #{group: 'MyGroup1', event: 'BufLeave'}
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1032 call autocmd_delete([acmd])
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1033 " :autocmd! MyGroup2 BufEnter *.c
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1034 let acmd = #{group: 'MyGroup2', event: 'BufEnter',
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1035 \ pattern: '*.c'}
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1036 " :autocmd! MyGroup2 * *.c
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1037 let acmd = #{group: 'MyGroup2', event: '*',
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1038 \ pattern: '*.c'}
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1039 call autocmd_delete([acmd])
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1040 " :autocmd! MyGroup3
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1041 let acmd = #{group: 'MyGroup3'}
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1042 call autocmd_delete([acmd])
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1043 <
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1044 Can also be used as a \|method\|: >
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1045 GetAutocmdList()->autocmd_delete()
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1046
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1047 autocmd_get([{opts}]) autocmd_get()
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1048 Returns a \|List\| of autocmds. If {opts} is not supplied, then
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1049 returns the autocmds for all the events in all the groups.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1050
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1051 The optional {opts} Dict argument supports the following
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1052 items:
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1053 group Autocmd group name. If specified, returns only
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1054 the autocmds defined in this group. If the
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1055 specified group doesn't exist, results in an
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1056 error message. If set to an empty string,
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1057 then the default autocmd group is used.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1058 event Autocmd event name. If specified, returns only
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1059 the autocmds defined for this event. If set
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1060 to "*", then returns autocmds for all the
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1061 events. If the specified event doesn't exist,
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1062 results in an error message.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1063 pattern Autocmd pattern. If specified, returns only
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1064 the autocmds defined for this pattern.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1065 A combination of the above three times can be supplied in
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1066 {opts}.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1067
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1068 Each Dict in the returned List contains the following items:
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1069 bufnr For buffer-local autocmds, buffer number where
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1070 the autocmd is defined.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1071 cmd Command executed for this autocmd.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1072 event Autocmd event name.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1073 group Autocmd group name.
28978 3c3bdb8069f5 patch 8.2.5011: Replacing an autocommand requires several lines Bram Moolenaar <Bram@vim.org> parents: 28956 diff changeset	1074 nested Boolean flag, set to v:true for a nested
3c3bdb8069f5 patch 8.2.5011: Replacing an autocommand requires several lines Bram Moolenaar <Bram@vim.org> parents: 28956 diff changeset	1075 autocmd. See \|autocmd-nested\|.
3c3bdb8069f5 patch 8.2.5011: Replacing an autocommand requires several lines Bram Moolenaar <Bram@vim.org> parents: 28956 diff changeset	1076 once Boolean flag, set to v:true, if the autocmd
3c3bdb8069f5 patch 8.2.5011: Replacing an autocommand requires several lines Bram Moolenaar <Bram@vim.org> parents: 28956 diff changeset	1077 will be executed only once. See \|autocmd-once\|.
28917 c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1078 pattern Autocmd pattern. For a buffer-local
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1079 autocmd, this will be of the form "<buffer=n>".
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1080 If there are multiple commands for an autocmd event in a
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1081 group, then separate items are returned for each command.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1082
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	1083 Returns an empty List if an autocmd with the specified group
f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	1084 or event or pattern is not found.
f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	1085
28917 c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1086 Examples: >
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1087 " :autocmd MyGroup
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1088 echo autocmd_get(#{group: 'Mygroup'})
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1089 " :autocmd G BufUnload
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1090 echo autocmd_get(#{group: 'G', event: 'BufUnload'})
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1091 " :autocmd G * *.ts
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1092 let acmd = #{group: 'G', event: '', pattern: '.ts'}
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1093 echo autocmd_get(acmd)
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1094 " :autocmd Syntax
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1095 echo autocmd_get(#{event: 'Syntax'})
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1096 " :autocmd G BufEnter *.ts
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1097 let acmd = #{group: 'G', event: 'BufEnter',
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1098 \ pattern: '*.ts'}
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1099 echo autocmd_get(acmd)
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1100 <
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1101 Can also be used as a \|method\|: >
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1102 Getopts()->autocmd_get()
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1103 <
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1104 balloon_gettext() balloon_gettext()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1105 Return the current text in the balloon. Only for the string,
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	1106 not used for the List. Returns an empty string if balloon
f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	1107 is not present.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1108
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1109 balloon_show({expr}) balloon_show()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1110 Show {expr} inside the balloon. For the GUI {expr} is used as
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1111 a string. For a terminal {expr} can be a list, which contains
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1112 the lines of the balloon. If {expr} is not a list it will be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1113 split with \|balloon_split()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1114 If {expr} is an empty string any existing balloon is removed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1115
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1116 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1117 func GetBalloonContent()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1118 " ... initiate getting the content
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1119 return ''
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1120 endfunc
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1121 set balloonexpr=GetBalloonContent()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1122
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1123 func BalloonCallback(result)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1124 call balloon_show(a:result)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1125 endfunc
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1126 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1127 GetText()->balloon_show()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1128 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1129 The intended use is that fetching the content of the balloon
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1130 is initiated from 'balloonexpr'. It will invoke an
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1131 asynchronous method, in which a callback invokes
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1132 balloon_show(). The 'balloonexpr' itself can return an
29307 0b1d7e910b23 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29290 diff changeset	1133 empty string or a placeholder, e.g. "loading...".
0b1d7e910b23 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29290 diff changeset	1134
0b1d7e910b23 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29290 diff changeset	1135 When showing a balloon is not possible then nothing happens,
0b1d7e910b23 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29290 diff changeset	1136 no error message is given.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1137 {only available when compiled with the \|+balloon_eval\| or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1138 \|+balloon_eval_term\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1139
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1140 balloon_split({msg}) balloon_split()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1141 Split String {msg} into lines to be displayed in a balloon.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1142 The splits are made for the current window size and optimize
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1143 to show debugger output.
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	1144 Returns a \|List\| with the split lines. Returns an empty List
f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	1145 on error.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1146 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1147 GetText()->balloon_split()->balloon_show()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1148
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1149 < {only available when compiled with the \|+balloon_eval_term\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1150 feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1151
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1152 blob2list({blob}) blob2list()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1153 Return a List containing the number value of each byte in Blob
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1154 {blob}. Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1155 blob2list(0z0102.0304) returns [1, 2, 3, 4]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1156 blob2list(0z) returns []
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1157 < Returns an empty List on error. \|list2blob()\| does the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1158 opposite.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1159
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1160 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1161 GetBlob()->blob2list()
29450 67f31c24291b Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29403 diff changeset	1162 <
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1163 browse()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1164 browse({save}, {title}, {initdir}, {default})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1165 Put up a file requester. This only works when "has("browse")"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1166 returns \|TRUE\| (only in some GUI versions).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1167 The input fields are:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1168 {save} when \|TRUE\|, select file to write
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1169 {title} title for the requester
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1170 {initdir} directory to start browsing in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1171 {default} default file name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1172 An empty string is returned when the "Cancel" button is hit,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1173 something went wrong, or browsing is not possible.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1174
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1175 browsedir()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1176 browsedir({title}, {initdir})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1177 Put up a directory requester. This only works when
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1178 "has("browse")" returns \|TRUE\| (only in some GUI versions).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1179 On systems where a directory browser is not supported a file
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1180 browser is used. In that case: select a file in the directory
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1181 to be used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1182 The input fields are:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1183 {title} title for the requester
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1184 {initdir} directory to start browsing in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1185 When the "Cancel" button is hit, something went wrong, or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1186 browsing is not possible, an empty string is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1187
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1188 bufadd({name}) bufadd()
29845 349517ab7398 patch 9.0.0261: bufload() reads a file even if the name is not a file name Bram Moolenaar <Bram@vim.org> parents: 29840 diff changeset	1189 Add a buffer to the buffer list with name {name} (must be a
349517ab7398 patch 9.0.0261: bufload() reads a file even if the name is not a file name Bram Moolenaar <Bram@vim.org> parents: 29840 diff changeset	1190 String).
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1191 If a buffer for file {name} already exists, return that buffer
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1192 number. Otherwise return the buffer number of the newly
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1193 created buffer. When {name} is an empty string then a new
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1194 buffer is always created.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1195 The buffer will not have 'buflisted' set and not be loaded
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1196 yet. To add some text to the buffer use this: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1197 let bufnr = bufadd('someName')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1198 call bufload(bufnr)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1199 call setbufline(bufnr, 1, ['some', 'text'])
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	1200 < Returns 0 on error.
f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	1201 Can also be used as a \|method\|: >
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1202 let bufnr = 'somename'->bufadd()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1203
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1204 bufexists({buf}) bufexists()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1205 The result is a Number, which is \|TRUE\| if a buffer called
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1206 {buf} exists.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1207 If the {buf} argument is a number, buffer numbers are used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1208 Number zero is the alternate buffer for the current window.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1209
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1210 If the {buf} argument is a string it must match a buffer name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1211 exactly. The name can be:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1212 - Relative to the current directory.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1213 - A full path.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1214 - The name of a buffer with 'buftype' set to "nofile".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1215 - A URL name.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1216 Unlisted buffers will be found.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1217 Note that help files are listed by their short name in the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1218 output of \|:buffers\|, but bufexists() requires using their
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1219 long name to be able to find them.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1220 bufexists() may report a buffer exists, but to use the name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1221 with a \|:buffer\| command you may need to use \|expand()\|. Esp
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1222 for MS-Windows 8.3 names in the form "c:\DOCUME~1"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1223 Use "bufexists(0)" to test for the existence of an alternate
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1224 file name.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1225
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1226 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1227 let exists = 'somename'->bufexists()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1228 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1229 Obsolete name: buffer_exists(). buffer_exists()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1230
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1231 buflisted({buf}) buflisted()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1232 The result is a Number, which is \|TRUE\| if a buffer called
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1233 {buf} exists and is listed (has the 'buflisted' option set).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1234 The {buf} argument is used like with \|bufexists()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1235
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1236 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1237 let listed = 'somename'->buflisted()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1238
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1239 bufload({buf}) bufload()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1240 Ensure the buffer {buf} is loaded. When the buffer name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1241 refers to an existing file then the file is read. Otherwise
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1242 the buffer will be empty. If the buffer was already loaded
29845 349517ab7398 patch 9.0.0261: bufload() reads a file even if the name is not a file name Bram Moolenaar <Bram@vim.org> parents: 29840 diff changeset	1243 then there is no change. If the buffer is not related to a
349517ab7398 patch 9.0.0261: bufload() reads a file even if the name is not a file name Bram Moolenaar <Bram@vim.org> parents: 29840 diff changeset	1244 file the no file is read (e.g., when 'buftype' is "nofile").
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1245 If there is an existing swap file for the file of the buffer,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1246 there will be no dialog, the buffer will be loaded anyway.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1247 The {buf} argument is used like with \|bufexists()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1248
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1249 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1250 eval 'somename'->bufload()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1251
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1252 bufloaded({buf}) bufloaded()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1253 The result is a Number, which is \|TRUE\| if a buffer called
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1254 {buf} exists and is loaded (shown in a window or hidden).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1255 The {buf} argument is used like with \|bufexists()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1256
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1257 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1258 let loaded = 'somename'->bufloaded()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1259
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1260 bufname([{buf}]) bufname()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1261 The result is the name of a buffer. Mostly as it is displayed
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1262 by the `:ls` command, but not using special names such as
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1263 "[No Name]".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1264 If {buf} is omitted the current buffer is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1265 If {buf} is a Number, that buffer number's name is given.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1266 Number zero is the alternate buffer for the current window.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1267 If {buf} is a String, it is used as a \|file-pattern\| to match
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1268 with the buffer names. This is always done like 'magic' is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1269 set and 'cpoptions' is empty. When there is more than one
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1270 match an empty string is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1271 "" or "%" can be used for the current buffer, "#" for the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1272 alternate buffer.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1273 A full match is preferred, otherwise a match at the start, end
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1274 or middle of the buffer name is accepted. If you only want a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1275 full match then put "^" at the start and "$" at the end of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1276 pattern.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1277 Listed buffers are found first. If there is a single match
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1278 with a listed buffer, that one is returned. Next unlisted
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1279 buffers are searched for.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1280 If the {buf} is a String, but you want to use it as a buffer
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1281 number, force it to be a Number by adding zero to it: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1282 :echo bufname("3" + 0)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1283 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1284 echo bufnr->bufname()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1285
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1286 < If the buffer doesn't exist, or doesn't have a name, an empty
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1287 string is returned. >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1288 bufname("#") alternate buffer name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1289 bufname(3) name of buffer 3
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1290 bufname("%") name of current buffer
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1291 bufname("file2") name of buffer where "file2" matches.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1292 < buffer_name()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1293 Obsolete name: buffer_name().
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1294
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1295 bufnr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1296 bufnr([{buf} [, {create}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1297 The result is the number of a buffer, as it is displayed by
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1298 the `:ls` command. For the use of {buf}, see \|bufname()\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1299 above.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1300
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1301 If the buffer doesn't exist, -1 is returned. Or, if the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1302 {create} argument is present and TRUE, a new, unlisted,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1303 buffer is created and its number is returned. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1304 let newbuf = bufnr('Scratch001', 1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1305 < Using an empty name uses the current buffer. To create a new
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1306 buffer with an empty name use \|bufadd()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1307
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1308 bufnr("$") is the last buffer: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1309 :let last_buffer = bufnr("$")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1310 < The result is a Number, which is the highest buffer number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1311 of existing buffers. Note that not all buffers with a smaller
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1312 number necessarily exist, because ":bwipeout" may have removed
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1313 them. Use bufexists() to test for the existence of a buffer.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1314
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1315 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1316 echo bufref->bufnr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1317 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1318 Obsolete name: buffer_number(). buffer_number()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1319 last_buffer_nr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1320 Obsolete name for bufnr("$"): last_buffer_nr().
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1321
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1322 bufwinid({buf}) bufwinid()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1323 The result is a Number, which is the \|window-ID\| of the first
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1324 window associated with buffer {buf}. For the use of {buf},
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1325 see \|bufname()\| above. If buffer {buf} doesn't exist or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1326 there is no such window, -1 is returned. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1327
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	1328 echo "A window containing buffer 1 is " .. (bufwinid(1))
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1329 <
31028 5acd6f02ea35 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31004 diff changeset	1330 Only deals with the current tab page. See \|win_findbuf()\| for
5acd6f02ea35 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31004 diff changeset	1331 finding more.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1332
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1333 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1334 FindBuffer()->bufwinid()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1335
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1336 bufwinnr({buf}) bufwinnr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1337 Like \|bufwinid()\| but return the window number instead of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1338 \|window-ID\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1339 If buffer {buf} doesn't exist or there is no such window, -1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1340 is returned. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1341
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	1342 echo "A window containing buffer 1 is " .. (bufwinnr(1))
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1343
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1344 < The number can be used with \|CTRL-W_w\| and ":wincmd w"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1345 \|:wincmd\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1346
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1347 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1348 FindBuffer()->bufwinnr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1349
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1350 byte2line({byte}) byte2line()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1351 Return the line number that contains the character at byte
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1352 count {byte} in the current buffer. This includes the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1353 end-of-line character, depending on the 'fileformat' option
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1354 for the current buffer. The first character has byte count
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1355 one.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1356 Also see \|line2byte()\|, \|go\| and \|:goto\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1357
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	1358 Returns -1 if the {byte} value is invalid.
f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	1359
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1360 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1361 GetOffset()->byte2line()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1362
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1363 < {not available when compiled without the \|+byte_offset\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1364 feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1365
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1366 byteidx({expr}, {nr}) byteidx()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1367 Return byte index of the {nr}'th character in the String
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1368 {expr}. Use zero for the first character, it then returns
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1369 zero.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1370 If there are no multibyte characters the returned value is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1371 equal to {nr}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1372 Composing characters are not counted separately, their byte
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1373 length is added to the preceding base character. See
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1374 \|byteidxcomp()\| below for counting composing characters
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1375 separately.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1376 Example : >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1377 echo matchstr(str, ".", byteidx(str, 3))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1378 < will display the fourth character. Another way to do the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1379 same: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1380 let s = strpart(str, byteidx(str, 3))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1381 echo strpart(s, 0, byteidx(s, 1))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1382 < Also see \|strgetchar()\| and \|strcharpart()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1383
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1384 If there are less than {nr} characters -1 is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1385 If there are exactly {nr} characters the length of the string
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1386 in bytes is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1387
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1388 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1389 GetName()->byteidx(idx)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1390
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1391 byteidxcomp({expr}, {nr}) byteidxcomp()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1392 Like byteidx(), except that a composing character is counted
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1393 as a separate character. Example: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	1394 let s = 'e' .. nr2char(0x301)
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1395 echo byteidx(s, 1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1396 echo byteidxcomp(s, 1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1397 echo byteidxcomp(s, 2)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1398 < The first and third echo result in 3 ('e' plus composing
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1399 character is 3 bytes), the second echo results in 1 ('e' is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1400 one byte).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1401 Only works differently from byteidx() when 'encoding' is set
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1402 to a Unicode encoding.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1403
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1404 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1405 GetName()->byteidxcomp(idx)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1406
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1407 call({func}, {arglist} [, {dict}]) call() E699
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1408 Call function {func} with the items in \|List\| {arglist} as
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1409 arguments.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1410 {func} can either be a \|Funcref\| or the name of a function.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1411 a:firstline and a:lastline are set to the cursor line.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1412 Returns the return value of the called function.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1413 {dict} is for functions with the "dict" attribute. It will be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1414 used to set the local variable "self". \|Dictionary-function\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1415
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1416 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1417 GetFunc()->call([arg, arg], dict)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1418
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1419 ceil({expr}) ceil()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1420 Return the smallest integral value greater than or equal to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1421 {expr} as a \|Float\| (round up).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1422 {expr} must evaluate to a \|Float\| or a \|Number\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1423 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1424 echo ceil(1.456)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1425 < 2.0 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1426 echo ceil(-5.456)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1427 < -5.0 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1428 echo ceil(4.0)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1429 < 4.0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1430
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	1431 Returns 0.0 if {expr} is not a \|Float\| or a \|Number\|.
f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	1432
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1433 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1434 Compute()->ceil()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1435
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1436
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1437 ch_ functions are documented here: \|channel-functions-details\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1438
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1439
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1440 changenr() changenr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1441 Return the number of the most recent change. This is the same
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1442 number as what is displayed with \|:undolist\| and can be used
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1443 with the \|:undo\| command.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1444 When a change was made it is the number of that change. After
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1445 redo it is the number of the redone change. After undo it is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1446 one less than the number of the undone change.
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	1447 Returns 0 if the undo list is empty.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1448
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1449 char2nr({string} [, {utf8}]) char2nr()
28933 57c9377b9c62 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 28917 diff changeset	1450 Return Number value of the first char in {string}.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1451 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1452 char2nr(" ") returns 32
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1453 char2nr("ABC") returns 65
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1454 < When {utf8} is omitted or zero, the current 'encoding' is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1455 Example for "utf-8": >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1456 char2nr("á") returns 225
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1457 char2nr("á"[0]) returns 195
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1458 < When {utf8} is TRUE, always treat as UTF-8 characters.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1459 A combining character is a separate character.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1460 \|nr2char()\| does the opposite.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1461 To turn a string into a list of character numbers: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1462 let str = "ABC"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1463 let list = map(split(str, '\zs'), {_, val -> char2nr(val)})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1464 < Result: [65, 66, 67]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1465
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	1466 Returns 0 if {string} is not a \|String\|.
f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	1467
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1468 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1469 GetChar()->char2nr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1470
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1471 charclass({string}) charclass()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1472 Return the character class of the first character in {string}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1473 The character class is one of:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1474 0 blank
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1475 1 punctuation
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1476 2 word character
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1477 3 emoji
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1478 other specific Unicode class
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1479 The class is used in patterns and word motions.
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	1480 Returns 0 if {string} is not a \|String\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1481
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1482
31057 1a32f1a4f823 patch 9.0.0863: col() and charcol() only work for the current window Bram Moolenaar <Bram@vim.org> parents: 31028 diff changeset	1483 charcol({expr} [, {winid}]) charcol()
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1484 Same as \|col()\| but returns the character index of the column
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1485 position given with {expr} instead of the byte position.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1486
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1487 Example:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1488 With the cursor on '세' in line 5 with text "여보세요": >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1489 charcol('.') returns 3
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1490 col('.') returns 7
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1491
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1492 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1493 GetPos()->col()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1494 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1495 charidx()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1496 charidx({string}, {idx} [, {countcc}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1497 Return the character index of the byte at {idx} in {string}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1498 The index of the first character is zero.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1499 If there are no multibyte characters the returned value is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1500 equal to {idx}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1501 When {countcc} is omitted or \|FALSE\|, then composing characters
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1502 are not counted separately, their byte length is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1503 added to the preceding base character.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1504 When {countcc} is \|TRUE\|, then composing characters are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1505 counted as separate characters.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1506 Returns -1 if the arguments are invalid or if {idx} is greater
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1507 than the index of the last byte in {string}. An error is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1508 given if the first argument is not a string, the second
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1509 argument is not a number or when the third argument is present
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1510 and is not zero or one.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1511 See \|byteidx()\| and \|byteidxcomp()\| for getting the byte index
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1512 from the character index.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1513 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1514 echo charidx('áb́ć', 3) returns 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1515 echo charidx('áb́ć', 6, 1) returns 4
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1516 echo charidx('áb́ć', 16) returns -1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1517 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1518 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1519 GetName()->charidx(idx)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1520
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1521 chdir({dir}) chdir()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1522 Change the current working directory to {dir}. The scope of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1523 the directory change depends on the directory of the current
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1524 window:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1525 - If the current window has a window-local directory
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1526 (\|:lcd\|), then changes the window local directory.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1527 - Otherwise, if the current tabpage has a local
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1528 directory (\|:tcd\|) then changes the tabpage local
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1529 directory.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1530 - Otherwise, changes the global directory.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1531 {dir} must be a String.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1532 If successful, returns the previous working directory. Pass
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1533 this to another chdir() to restore the directory.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1534 On failure, returns an empty string.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1535
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1536 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1537 let save_dir = chdir(newdir)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1538 if save_dir != ""
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1539 " ... do some work
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1540 call chdir(save_dir)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1541 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1542
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1543 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1544 GetDir()->chdir()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1545 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1546 cindent({lnum}) cindent()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1547 Get the amount of indent for line {lnum} according the C
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1548 indenting rules, as with 'cindent'.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1549 The indent is counted in spaces, the value of 'tabstop' is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1550 relevant. {lnum} is used just like in \|getline()\|.
28942 6cdf55afaae9 patch 8.2.4993: smart/C/lisp indenting is optional Bram Moolenaar <Bram@vim.org> parents: 28933 diff changeset	1551 When {lnum} is invalid -1 is returned.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1552 See \|C-indenting\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1553
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1554 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1555 GetLnum()->cindent()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1556
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1557 clearmatches([{win}]) clearmatches()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1558 Clears all matches previously defined for the current window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1559 by \|matchadd()\| and the \|:match\| commands.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1560 If {win} is specified, use the window with this number or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1561 window ID instead of the current window.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1562
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1563 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1564 GetWin()->clearmatches()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1565 <
31057 1a32f1a4f823 patch 9.0.0863: col() and charcol() only work for the current window Bram Moolenaar <Bram@vim.org> parents: 31028 diff changeset	1566 col({expr} [, {winid}) col()
1a32f1a4f823 patch 9.0.0863: col() and charcol() only work for the current window Bram Moolenaar <Bram@vim.org> parents: 31028 diff changeset	1567 The result is a Number, which is the byte index of the column
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1568 position given with {expr}. The accepted positions are:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1569 . the cursor position
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1570 $ the end of the cursor line (the result is the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1571 number of bytes in the cursor line plus one)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1572 'x position of mark x (if the mark is not set, 0 is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1573 returned)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1574 v In Visual mode: the start of the Visual area (the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1575 cursor is the end). When not in Visual mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1576 returns the cursor position. Differs from \|'<\| in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1577 that it's updated right away.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1578 Additionally {expr} can be [lnum, col]: a \|List\| with the line
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1579 and column number. Most useful when the column is "$", to get
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1580 the last column of a specific line. When "lnum" or "col" is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1581 out of range then col() returns zero.
31057 1a32f1a4f823 patch 9.0.0863: col() and charcol() only work for the current window Bram Moolenaar <Bram@vim.org> parents: 31028 diff changeset	1582 With the optional {winid} argument the values are obtained for
1a32f1a4f823 patch 9.0.0863: col() and charcol() only work for the current window Bram Moolenaar <Bram@vim.org> parents: 31028 diff changeset	1583 that window instead of the current window.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1584 To get the line number use \|line()\|. To get both use
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1585 \|getpos()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1586 For the screen column position use \|virtcol()\|. For the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1587 character position use \|charcol()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1588 Note that only marks in the current file can be used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1589 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1590 col(".") column of cursor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1591 col("$") length of cursor line plus one
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1592 col("'t") column of mark t
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	1593 col("'" .. markname) column of mark markname
31057 1a32f1a4f823 patch 9.0.0863: col() and charcol() only work for the current window Bram Moolenaar <Bram@vim.org> parents: 31028 diff changeset	1594 < The first column is 1. Returns 0 if {expr} is invalid or when
1a32f1a4f823 patch 9.0.0863: col() and charcol() only work for the current window Bram Moolenaar <Bram@vim.org> parents: 31028 diff changeset	1595 the window with ID {winid} is not found.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1596 For an uppercase mark the column may actually be in another
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1597 buffer.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1598 For the cursor position, when 'virtualedit' is active, the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1599 column is one higher if the cursor is after the end of the
30967 eb2638f278bf Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30958 diff changeset	1600 line. Also, when using a <Cmd> mapping the cursor isn't
eb2638f278bf Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30958 diff changeset	1601 moved, this can be used to obtain the column in Insert mode: >
31028 5acd6f02ea35 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31004 diff changeset	1602 :imap <F2> <Cmd>echowin col(".")<CR>
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1603
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1604 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1605 GetPos()->col()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1606 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1607
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1608 complete({startcol}, {matches}) complete() E785
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1609 Set the matches for Insert mode completion.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1610 Can only be used in Insert mode. You need to use a mapping
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1611 with CTRL-R = (see \|i_CTRL-R\|). It does not work after CTRL-O
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1612 or with an expression mapping.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1613 {startcol} is the byte offset in the line where the completed
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1614 text start. The text up to the cursor is the original text
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1615 that will be replaced by the matches. Use col('.') for an
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1616 empty string. "col('.') - 1" will replace one character by a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1617 match.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1618 {matches} must be a \|List\|. Each \|List\| item is one match.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1619 See \|complete-items\| for the kind of items that are possible.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1620 "longest" in 'completeopt' is ignored.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1621 Note that the after calling this function you need to avoid
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1622 inserting anything that would cause completion to stop.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1623 The match can be selected with CTRL-N and CTRL-P as usual with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1624 Insert mode completion. The popup menu will appear if
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1625 specified, see \|ins-completion-menu\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1626 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1627 inoremap <F5> <C-R>=ListMonths()<CR>
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1628
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1629 func! ListMonths()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1630 call complete(col('.'), ['January', 'February', 'March',
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1631 \ 'April', 'May', 'June', 'July', 'August', 'September',
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1632 \ 'October', 'November', 'December'])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1633 return ''
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1634 endfunc
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1635 < This isn't very useful, but it shows how it works. Note that
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1636 an empty string is returned to avoid a zero being inserted.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1637
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1638 Can also be used as a \|method\|, the base is passed as the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1639 second argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1640 GetMatches()->complete(col('.'))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1641
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1642 complete_add({expr}) complete_add()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1643 Add {expr} to the list of matches. Only to be used by the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1644 function specified with the 'completefunc' option.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1645 Returns 0 for failure (empty string or out of memory),
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1646 1 when the match was added, 2 when the match was already in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1647 the list.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1648 See \|complete-functions\| for an explanation of {expr}. It is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1649 the same as one item in the list that 'omnifunc' would return.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1650
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1651 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1652 GetMoreMatches()->complete_add()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1653
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1654 complete_check() complete_check()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1655 Check for a key typed while looking for completion matches.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1656 This is to be used when looking for matches takes some time.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1657 Returns \|TRUE\| when searching for matches is to be aborted,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1658 zero otherwise.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1659 Only to be used by the function specified with the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1660 'completefunc' option.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1661
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1662
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1663 complete_info([{what}]) complete_info()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1664 Returns a \|Dictionary\| with information about Insert mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1665 completion. See \|ins-completion\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1666 The items are:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1667 mode Current completion mode name string.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1668 See \|complete_info_mode\| for the values.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1669 pum_visible \|TRUE\| if popup menu is visible.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1670 See \|pumvisible()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1671 items List of completion matches. Each item is a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1672 dictionary containing the entries "word",
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1673 "abbr", "menu", "kind", "info" and "user_data".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1674 See \|complete-items\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1675 selected Selected item index. First index is zero.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1676 Index is -1 if no item is selected (showing
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1677 typed text only, or the last completion after
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1678 no item is selected when using the <Up> or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1679 <Down> keys)
30085 ebed259f919f Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30083 diff changeset	1680 inserted Inserted string. [NOT IMPLEMENTED YET]
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1681
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1682 complete_info_mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1683 mode values are:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1684 "" Not in completion mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1685 "keyword" Keyword completion \|i_CTRL-X_CTRL-N\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1686 "ctrl_x" Just pressed CTRL-X \|i_CTRL-X\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1687 "scroll" Scrolling with \|i_CTRL-X_CTRL-E\| or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1688 \|i_CTRL-X_CTRL-Y\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1689 "whole_line" Whole lines \|i_CTRL-X_CTRL-L\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1690 "files" File names \|i_CTRL-X_CTRL-F\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1691 "tags" Tags \|i_CTRL-X_CTRL-]\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1692 "path_defines" Definition completion \|i_CTRL-X_CTRL-D\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1693 "path_patterns" Include completion \|i_CTRL-X_CTRL-I\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1694 "dictionary" Dictionary \|i_CTRL-X_CTRL-K\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1695 "thesaurus" Thesaurus \|i_CTRL-X_CTRL-T\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1696 "cmdline" Vim Command line \|i_CTRL-X_CTRL-V\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1697 "function" User defined completion \|i_CTRL-X_CTRL-U\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1698 "omni" Omni completion \|i_CTRL-X_CTRL-O\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1699 "spell" Spelling suggestions \|i_CTRL-X_s\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1700 "eval" \|complete()\| completion
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1701 "unknown" Other internal modes
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1702
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1703 If the optional {what} list argument is supplied, then only
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1704 the items listed in {what} are returned. Unsupported items in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1705 {what} are silently ignored.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1706
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1707 To get the position and size of the popup menu, see
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1708 \|pum_getpos()\|. It's also available in \|v:event\| during the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1709 \|CompleteChanged\| event.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1710
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	1711 Returns an empty \|Dictionary\| on error.
f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	1712
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1713 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1714 " Get all items
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1715 call complete_info()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1716 " Get only 'mode'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1717 call complete_info(['mode'])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1718 " Get only 'mode' and 'pum_visible'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1719 call complete_info(['mode', 'pum_visible'])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1720
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1721 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1722 GetItems()->complete_info()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1723 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1724 confirm()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1725 confirm({msg} [, {choices} [, {default} [, {type}]]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1726 confirm() offers the user a dialog, from which a choice can be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1727 made. It returns the number of the choice. For the first
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1728 choice this is 1.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1729 Note: confirm() is only supported when compiled with dialog
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1730 support, see \|+dialog_con\| and \|+dialog_gui\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1731
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1732 {msg} is displayed in a \|dialog\| with {choices} as the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1733 alternatives. When {choices} is missing or empty, "&OK" is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1734 used (and translated).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1735 {msg} is a String, use '\n' to include a newline. Only on
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1736 some systems the string is wrapped when it doesn't fit.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1737
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1738 {choices} is a String, with the individual choices separated
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1739 by '\n', e.g. >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1740 confirm("Save changes?", "&Yes\n&No\n&Cancel")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1741 < The letter after the '&' is the shortcut key for that choice.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1742 Thus you can type 'c' to select "Cancel". The shortcut does
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1743 not need to be the first letter: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1744 confirm("file has been modified", "&Save\nSave &All")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1745 < For the console, the first letter of each choice is used as
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1746 the default shortcut key. Case is ignored.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1747
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1748 The optional {default} argument is the number of the choice
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1749 that is made if the user hits <CR>. Use 1 to make the first
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1750 choice the default one. Use 0 to not set a default. If
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1751 {default} is omitted, 1 is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1752
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1753 The optional {type} String argument gives the type of dialog.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1754 This is only used for the icon of the GTK, Mac, Motif and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1755 Win32 GUI. It can be one of these values: "Error",
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1756 "Question", "Info", "Warning" or "Generic". Only the first
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1757 character is relevant. When {type} is omitted, "Generic" is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1758 used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1759
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1760 If the user aborts the dialog by pressing <Esc>, CTRL-C,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1761 or another valid interrupt key, confirm() returns 0.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1762
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1763 An example: >
28246 e3d6184b89fa Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28183 diff changeset	1764 let choice = confirm("What do you want?",
28933 57c9377b9c62 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 28917 diff changeset	1765 \ "&Apples\n&Oranges\n&Bananas", 2)
28246 e3d6184b89fa Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28183 diff changeset	1766 if choice == 0
28933 57c9377b9c62 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 28917 diff changeset	1767 echo "make up your mind!"
28246 e3d6184b89fa Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28183 diff changeset	1768 elseif choice == 3
28933 57c9377b9c62 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 28917 diff changeset	1769 echo "tasteful"
28246 e3d6184b89fa Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28183 diff changeset	1770 else
28933 57c9377b9c62 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 28917 diff changeset	1771 echo "I prefer bananas myself."
28246 e3d6184b89fa Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28183 diff changeset	1772 endif
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1773 < In a GUI dialog, buttons are used. The layout of the buttons
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1774 depends on the 'v' flag in 'guioptions'. If it is included,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1775 the buttons are always put vertically. Otherwise, confirm()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1776 tries to put the buttons in one horizontal line. If they
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1777 don't fit, a vertical layout is used anyway. For some systems
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1778 the horizontal layout is always used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1779
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1780 Can also be used as a \|method\|in: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1781 BuildMessage()->confirm("&Yes\n&No")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1782 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1783 copy()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1784 copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1785 different from using {expr} directly.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1786 When {expr} is a \|List\| a shallow copy is created. This means
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1787 that the original \|List\| can be changed without changing the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1788 copy, and vice versa. But the items are identical, thus
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1789 changing an item changes the contents of both \|Lists\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1790 A \|Dictionary\| is copied in a similar way as a \|List\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1791 Also see \|deepcopy()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1792 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1793 mylist->copy()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1794
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1795 cos({expr}) cos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1796 Return the cosine of {expr}, measured in radians, as a \|Float\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1797 {expr} must evaluate to a \|Float\| or a \|Number\|.
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	1798 Returns 0.0 if {expr} is not a \|Float\| or a \|Number\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1799 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1800 :echo cos(100)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1801 < 0.862319 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1802 :echo cos(-4.01)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1803 < -0.646043
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1804
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1805 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1806 Compute()->cos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1807
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1808
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1809 cosh({expr}) cosh()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1810 Return the hyperbolic cosine of {expr} as a \|Float\| in the range
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1811 [1, inf].
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1812 {expr} must evaluate to a \|Float\| or a \|Number\|.
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	1813 Returns 0.0 if {expr} is not a \|Float\| or a \|Number\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1814 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1815 :echo cosh(0.5)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1816 < 1.127626 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1817 :echo cosh(-0.5)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1818 < -1.127626
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1819
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1820 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1821 Compute()->cosh()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1822
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1823
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1824 count({comp}, {expr} [, {ic} [, {start}]]) count()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1825 Return the number of times an item with value {expr} appears
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1826 in \|String\|, \|List\| or \|Dictionary\| {comp}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1827
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1828 If {start} is given then start with the item with this index.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1829 {start} can only be used with a \|List\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1830
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1831 When {ic} is given and it's \|TRUE\| then case is ignored.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1832
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1833 When {comp} is a string then the number of not overlapping
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1834 occurrences of {expr} is returned. Zero is returned when
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1835 {expr} is an empty string.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1836
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1837 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1838 mylist->count(val)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1839 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1840 cscope_connection()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1841 cscope_connection([{num} , {dbpath} [, {prepend}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1842 Checks for the existence of a \|cscope\| connection. If no
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1843 parameters are specified, then the function returns:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1844 0, if cscope was not available (not compiled in), or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1845 if there are no cscope connections;
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1846 1, if there is at least one cscope connection.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1847
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1848 If parameters are specified, then the value of {num}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1849 determines how existence of a cscope connection is checked:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1850
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1851 {num} Description of existence check
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1852 ----- ------------------------------
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1853 0 Same as no parameters (e.g., "cscope_connection()").
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1854 1 Ignore {prepend}, and use partial string matches for
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1855 {dbpath}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1856 2 Ignore {prepend}, and use exact string matches for
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1857 {dbpath}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1858 3 Use {prepend}, use partial string matches for both
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1859 {dbpath} and {prepend}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1860 4 Use {prepend}, use exact string matches for both
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1861 {dbpath} and {prepend}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1862
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1863 Note: All string comparisons are case sensitive!
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1864
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1865 Examples. Suppose we had the following (from ":cs show"): >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1866
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1867 # pid database name prepend path
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1868 0 27664 cscope.out /usr/local
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1869 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1870 Invocation Return Val ~
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1871 ---------- ---------- >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1872 cscope_connection() 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1873 cscope_connection(1, "out") 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1874 cscope_connection(2, "out") 0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1875 cscope_connection(3, "out") 0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1876 cscope_connection(3, "out", "local") 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1877 cscope_connection(4, "out") 0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1878 cscope_connection(4, "out", "local") 0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1879 cscope_connection(4, "cscope.out", "/usr/local") 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1880 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1881 cursor({lnum}, {col} [, {off}]) cursor()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1882 cursor({list})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1883 Positions the cursor at the column (byte count) {col} in the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1884 line {lnum}. The first column is one.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1885
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1886 When there is one argument {list} this is used as a \|List\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1887 with two, three or four item:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1888 [{lnum}, {col}]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1889 [{lnum}, {col}, {off}]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1890 [{lnum}, {col}, {off}, {curswant}]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1891 This is like the return value of \|getpos()\| or \|getcurpos()\|,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1892 but without the first item.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1893
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1894 To position the cursor using the character count, use
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1895 \|setcursorcharpos()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1896
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1897 Does not change the jumplist.
30785 02b5d6f20db2 patch 9.0.0727: help in the repository differs from patched version too much Bram Moolenaar <Bram@vim.org> parents: 30719 diff changeset	1898 {lnum} is used like with \|getline()\|, except that if {lnum} is
02b5d6f20db2 patch 9.0.0727: help in the repository differs from patched version too much Bram Moolenaar <Bram@vim.org> parents: 30719 diff changeset	1899 zero, the cursor will stay in the current line.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1900 If {lnum} is greater than the number of lines in the buffer,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1901 the cursor will be positioned at the last line in the buffer.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1902 If {col} is greater than the number of bytes in the line,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1903 the cursor will be positioned at the last character in the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1904 line.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1905 If {col} is zero, the cursor will stay in the current column.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1906 If {curswant} is given it is used to set the preferred column
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1907 for vertical movement. Otherwise {col} is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1908
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1909 When 'virtualedit' is used {off} specifies the offset in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1910 screen columns from the start of the character. E.g., a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1911 position within a <Tab> or after the last character.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1912 Returns 0 when the position could be set, -1 otherwise.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1913
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1914 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1915 GetCursorPos()->cursor()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1916
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1917 debugbreak({pid}) debugbreak()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1918 Specifically used to interrupt a program being debugged. It
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1919 will cause process {pid} to get a SIGTRAP. Behavior for other
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1920 processes is undefined. See \|terminal-debugger\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1921 {only available on MS-Windows}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1922
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	1923 Returns \|TRUE\| if successfully interrupted the program.
f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	1924 Otherwise returns \|FALSE\|.
f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	1925
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1926 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1927 GetPid()->debugbreak()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1928
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1929 deepcopy({expr} [, {noref}]) deepcopy() E698
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1930 Make a copy of {expr}. For Numbers and Strings this isn't
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1931 different from using {expr} directly.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1932 When {expr} is a \|List\| a full copy is created. This means
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1933 that the original \|List\| can be changed without changing the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1934 copy, and vice versa. When an item is a \|List\| or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1935 \|Dictionary\|, a copy for it is made, recursively. Thus
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1936 changing an item in the copy does not change the contents of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1937 the original \|List\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1938 A \|Dictionary\| is copied in a similar way as a \|List\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1939
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1940 When {noref} is omitted or zero a contained \|List\| or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1941 \|Dictionary\| is only copied once. All references point to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1942 this single copy. With {noref} set to 1 every occurrence of a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1943 \|List\| or \|Dictionary\| results in a new copy. This also means
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1944 that a cyclic reference causes deepcopy() to fail.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1945 E724
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1946 Nesting is possible up to 100 levels. When there is an item
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1947 that refers back to a higher level making a deep copy with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1948 {noref} set to 1 will fail.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1949 Also see \|copy()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1950
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1951 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1952 GetObject()->deepcopy()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1953
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1954 delete({fname} [, {flags}]) delete()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1955 Without {flags} or with {flags} empty: Deletes the file by the
28379 6dd88e45d47d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28307 diff changeset	1956 name {fname}.
6dd88e45d47d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28307 diff changeset	1957
6dd88e45d47d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28307 diff changeset	1958 This also works when {fname} is a symbolic link. The symbolic
6dd88e45d47d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28307 diff changeset	1959 link itself is deleted, not what it points to.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1960
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1961 When {flags} is "d": Deletes the directory by the name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1962 {fname}. This fails when directory {fname} is not empty.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1963
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1964 When {flags} is "rf": Deletes the directory by the name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1965 {fname} and everything in it, recursively. BE CAREFUL!
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1966 Note: on MS-Windows it is not possible to delete a directory
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1967 that is being used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1968
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1969 The result is a Number, which is 0/false if the delete
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1970 operation was successful and -1/true when the deletion failed
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1971 or partly failed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1972
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1973 Use \|remove()\| to delete an item from a \|List\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1974 To delete a line from the buffer use \|:delete\| or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1975 \|deletebufline()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1976
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1977 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1978 GetName()->delete()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1979
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1980 deletebufline({buf}, {first} [, {last}]) deletebufline()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1981 Delete lines {first} to {last} (inclusive) from buffer {buf}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1982 If {last} is omitted then delete line {first} only.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1983 On success 0 is returned, on failure 1 is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1984
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1985 This function works only for loaded buffers. First call
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1986 \|bufload()\| if needed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1987
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1988 For the use of {buf}, see \|bufname()\| above.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1989
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1990 {first} and {last} are used like with \|getline()\|. Note that
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1991 when using \|line()\| this refers to the current buffer. Use "$"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1992 to refer to the last line in buffer {buf}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1993
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1994 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1995 GetBuffer()->deletebufline(1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1996 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1997 did_filetype()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1998 did_filetype() Returns \|TRUE\| when autocommands are being executed and the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1999 FileType event has been triggered at least once. Can be used
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2000 to avoid triggering the FileType event again in the scripts
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2001 that detect the file type. \|FileType\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2002 Returns \|FALSE\| when `:setf FALLBACK` was used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2003 When editing another file, the counter is reset, thus this
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2004 really checks if the FileType event has been triggered for the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2005 current buffer. This allows an autocommand that starts
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2006 editing another buffer to set 'filetype' and load a syntax
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2007 file.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2008
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2009 diff_filler({lnum}) diff_filler()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2010 Returns the number of filler lines above line {lnum}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2011 These are the lines that were inserted at this point in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2012 another diff'ed window. These filler lines are shown in the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2013 display but don't exist in the buffer.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2014 {lnum} is used like with \|getline()\|. Thus "." is the current
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2015 line, "'m" mark m, etc.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2016 Returns 0 if the current window is not in diff mode.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2017
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2018 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2019 GetLnum()->diff_filler()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2020
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2021 diff_hlID({lnum}, {col}) diff_hlID()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2022 Returns the highlight ID for diff mode at line {lnum} column
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2023 {col} (byte index). When the current line does not have a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2024 diff change zero is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2025 {lnum} is used like with \|getline()\|. Thus "." is the current
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2026 line, "'m" mark m, etc.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2027 {col} is 1 for the leftmost column, {lnum} is 1 for the first
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2028 line.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2029 The highlight ID can be used with \|synIDattr()\| to obtain
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2030 syntax information about the highlighting.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2031
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2032 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2033 GetLnum()->diff_hlID(col)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2034 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2035
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2036 digraph_get({chars}) digraph_get() E1214
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2037 Return the digraph of {chars}. This should be a string with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2038 exactly two characters. If {chars} are not just two
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2039 characters, or the digraph of {chars} does not exist, an error
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2040 is given and an empty string is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2041
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2042 The character will be converted from Unicode to 'encoding'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2043 when needed. This does require the conversion to be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2044 available, it might fail.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2045
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2046 Also see \|digraph_getlist()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2047
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2048 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2049 " Get a built-in digraph
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2050 :echo digraph_get('00') " Returns '∞'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2051
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2052 " Get a user-defined digraph
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2053 :call digraph_set('aa', 'あ')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2054 :echo digraph_get('aa') " Returns 'あ'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2055 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2056 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2057 GetChars()->digraph_get()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2058 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2059 This function works only when compiled with the \|+digraphs\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2060 feature. If this feature is disabled, this function will
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2061 display an error message.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2062
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2063
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2064 digraph_getlist([{listall}]) digraph_getlist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2065 Return a list of digraphs. If the {listall} argument is given
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2066 and it is TRUE, return all digraphs, including the default
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2067 digraphs. Otherwise, return only user-defined digraphs.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2068
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2069 The characters will be converted from Unicode to 'encoding'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2070 when needed. This does require the conservation to be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2071 available, it might fail.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2072
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2073 Also see \|digraph_get()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2074
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2075 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2076 " Get user-defined digraphs
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2077 :echo digraph_getlist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2078
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2079 " Get all the digraphs, including default digraphs
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2080 :echo digraph_getlist(1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2081 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2082 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2083 GetNumber()->digraph_getlist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2084 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2085 This function works only when compiled with the \|+digraphs\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2086 feature. If this feature is disabled, this function will
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2087 display an error message.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2088
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2089
27537 063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27497 diff changeset	2090 digraph_set({chars}, {digraph}) digraph_set()
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2091 Add digraph {chars} to the list. {chars} must be a string
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2092 with two characters. {digraph} is a string with one UTF-8
27537 063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27497 diff changeset	2093 encoded character. E1215
063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27497 diff changeset	2094 Be careful, composing characters are NOT ignored. This
063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27497 diff changeset	2095 function is similar to \|:digraphs\| command, but useful to add
063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27497 diff changeset	2096 digraphs start with a white space.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2097
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2098 The function result is v:true if \|digraph\| is registered. If
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2099 this fails an error message is given and v:false is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2100
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2101 If you want to define multiple digraphs at once, you can use
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2102 \|digraph_setlist()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2103
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2104 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2105 call digraph_set(' ', 'あ')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2106 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2107 Can be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2108 GetString()->digraph_set('あ')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2109 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2110 This function works only when compiled with the \|+digraphs\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2111 feature. If this feature is disabled, this function will
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2112 display an error message.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2113
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2114
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2115 digraph_setlist({digraphlist}) digraph_setlist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2116 Similar to \|digraph_set()\| but this function can add multiple
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2117 digraphs at once. {digraphlist} is a list composed of lists,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2118 where each list contains two strings with {chars} and
27537 063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27497 diff changeset	2119 {digraph} as in \|digraph_set()\|. E1216
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2120 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2121 call digraph_setlist([['aa', 'あ'], ['ii', 'い']])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2122 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2123 It is similar to the following: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2124 for [chars, digraph] in [['aa', 'あ'], ['ii', 'い']]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2125 call digraph_set(chars, digraph)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2126 endfor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2127 < Except that the function returns after the first error,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2128 following digraphs will not be added.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2129
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2130 Can be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2131 GetList()->digraph_setlist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2132 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2133 This function works only when compiled with the \|+digraphs\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2134 feature. If this feature is disabled, this function will
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2135 display an error message.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2136
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2137
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2138 echoraw({string}) echoraw()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2139 Output {string} as-is, including unprintable characters.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2140 This can be used to output a terminal code. For example, to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2141 disable modifyOtherKeys: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2142 call echoraw(&t_TE)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2143 < and to enable it again: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2144 call echoraw(&t_TI)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2145 < Use with care, you can mess up the terminal this way.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2146
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2147
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2148 empty({expr}) empty()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2149 Return the Number 1 if {expr} is empty, zero otherwise.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2150 - A \|List\| or \|Dictionary\| is empty when it does not have any
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2151 items.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2152 - A \|String\| is empty when its length is zero.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2153 - A \|Number\| and \|Float\| are empty when their value is zero.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2154 - \|v:false\|, \|v:none\| and \|v:null\| are empty, \|v:true\| is not.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2155 - A \|Job\| is empty when it failed to start.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2156 - A \|Channel\| is empty when it is closed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2157 - A \|Blob\| is empty when its length is zero.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2158
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2159 For a long \|List\| this is much faster than comparing the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2160 length with zero.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2161
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2162 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2163 mylist->empty()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2164
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2165 environ() environ()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2166 Return all of environment variables as dictionary. You can
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2167 check if an environment variable exists like this: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2168 :echo has_key(environ(), 'HOME')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2169 < Note that the variable name may be CamelCase; to ignore case
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2170 use this: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2171 :echo index(keys(environ()), 'HOME', 0, 1) != -1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2172
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2173 escape({string}, {chars}) escape()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2174 Escape the characters in {chars} that occur in {string} with a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2175 backslash. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2176 :echo escape('c:\program files\vim', ' \')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2177 < results in: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2178 c:\\program\ files\\vim
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2179 < Also see \|shellescape()\| and \|fnameescape()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2180
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2181 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2182 GetText()->escape(' \')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2183 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2184 eval()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2185 eval({string}) Evaluate {string} and return the result. Especially useful to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2186 turn the result of \|string()\| back into the original value.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2187 This works for Numbers, Floats, Strings, Blobs and composites
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2188 of them. Also works for \|Funcref\|s that refer to existing
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2189 functions.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2190
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2191 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2192 argv->join()->eval()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2193
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2194 eventhandler() eventhandler()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2195 Returns 1 when inside an event handler. That is that Vim got
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2196 interrupted while waiting for the user to type a character,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2197 e.g., when dropping a file on Vim. This means interactive
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2198 commands cannot be used. Otherwise zero is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2199
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2200 executable({expr}) executable()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2201 This function checks if an executable with the name {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2202 exists. {expr} must be the name of the program without any
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2203 arguments.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2204 executable() uses the value of $PATH and/or the normal
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2205 searchpath for programs. PATHEXT
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2206 On MS-Windows the ".exe", ".bat", etc. can optionally be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2207 included. Then the extensions in $PATHEXT are tried. Thus if
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2208 "foo.exe" does not exist, "foo.exe.bat" can be found. If
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2209 $PATHEXT is not set then ".com;.exe;.bat;.cmd" is used. A dot
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2210 by itself can be used in $PATHEXT to try using the name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2211 without an extension. When 'shell' looks like a Unix shell,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2212 then the name is also tried without adding an extension.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2213 On MS-Windows it only checks if the file exists and is not a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2214 directory, not if it's really executable.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2215 On MS-Windows an executable in the same directory as Vim is
28672 e4de5b5193b4 patch 8.2.4860: MS-Windows: always uses current directory for executables Bram Moolenaar <Bram@vim.org> parents: 28629 diff changeset	2216 normally found. Since this directory is added to $PATH it
e4de5b5193b4 patch 8.2.4860: MS-Windows: always uses current directory for executables Bram Moolenaar <Bram@vim.org> parents: 28629 diff changeset	2217 should also work to execute it \|win32-PATH\|. This can be
e4de5b5193b4 patch 8.2.4860: MS-Windows: always uses current directory for executables Bram Moolenaar <Bram@vim.org> parents: 28629 diff changeset	2218 disabled by setting the $NoDefaultCurrentDirectoryInExePath
e4de5b5193b4 patch 8.2.4860: MS-Windows: always uses current directory for executables Bram Moolenaar <Bram@vim.org> parents: 28629 diff changeset	2219 environment variable. NoDefaultCurrentDirectoryInExePath
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2220 The result is a Number:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2221 1 exists
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2222 0 does not exist
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2223 -1 not implemented on this system
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2224 \|exepath()\| can be used to get the full path of an executable.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2225
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2226 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2227 GetCommand()->executable()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2228
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2229 execute({command} [, {silent}]) execute()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2230 Execute an Ex command or commands and return the output as a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2231 string.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2232 {command} can be a string or a List. In case of a List the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2233 lines are executed one by one.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2234 This is equivalent to: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2235 redir => var
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2236 {command}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2237 redir END
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2238 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2239 The optional {silent} argument can have these values:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2240 "" no `:silent` used
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2241 "silent" `:silent` used
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2242 "silent!" `:silent!` used
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2243 The default is "silent". Note that with "silent!", unlike
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2244 `:redir`, error messages are dropped. When using an external
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2245 command the screen may be messed up, use `system()` instead.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2246 E930
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2247 It is not possible to use `:redir` anywhere in {command}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2248
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2249 To get a list of lines use \|split()\| on the result: >
28517 f73a9bdff3a3 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28471 diff changeset	2250 execute('args')->split("\n")
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2251
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2252 < To execute a command in another window than the current one
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2253 use `win_execute()`.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2254
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2255 When used recursively the output of the recursive call is not
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2256 included in the output of the higher level call.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2257
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2258 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2259 GetCommand()->execute()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2260
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2261 exepath({expr}) exepath()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2262 If {expr} is an executable and is either an absolute path, a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2263 relative path or found in $PATH, return the full path.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2264 Note that the current directory is used when {expr} starts
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2265 with "./", which may be a problem for Vim: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2266 echo exepath(v:progpath)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2267 < If {expr} cannot be found in $PATH or is not executable then
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2268 an empty string is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2269
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2270 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2271 GetCommand()->exepath()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2272 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2273 exists()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2274 exists({expr}) The result is a Number, which is \|TRUE\| if {expr} is defined,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2275 zero otherwise.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2276
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2277 Note: In a compiled \|:def\| function the evaluation is done at
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2278 runtime. Use `exists_compiled()` to evaluate the expression
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2279 at compile time.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2280
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2281 For checking for a supported feature use \|has()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2282 For checking if a file exists use \|filereadable()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2283
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2284 The {expr} argument is a string, which contains one of these:
27459 5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2285 varname internal variable (see
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2286 dict.key \|internal-variables\|). Also works
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2287 list[i] for \|curly-braces-names\|, \|Dictionary\|
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2288 import.Func entries, \|List\| items, imported
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	2289 items, etc.
27459 5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2290 Does not work for local variables in a
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2291 compiled `:def` function.
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	2292 Also works for a function in \|Vim9\|
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	2293 script, since it can be used as a
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	2294 function reference.
27459 5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2295 Beware that evaluating an index may
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2296 cause an error message for an invalid
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2297 expression. E.g.: >
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2298 :let l = [1, 2, 3]
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2299 :echo exists("l[5]")
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2300 < 0 >
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2301 :echo exists("l[xx]")
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2302 < E121: Undefined variable: xx
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2303 0
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2304 &option-name Vim option (only checks if it exists,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2305 not if it really works)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2306 +option-name Vim option that works.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2307 $ENVNAME environment variable (could also be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2308 done by comparing with an empty
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2309 string)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2310 *funcname built-in function (see \|functions\|)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2311 or user defined function (see
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2312 \|user-functions\|) that is implemented.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2313 Also works for a variable that is a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2314 Funcref.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2315 ?funcname built-in function that could be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2316 implemented; to be used to check if
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2317 "funcname" is valid
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2318 :cmdname Ex command: built-in command, user
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2319 command or command modifier \|:command\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2320 Returns:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2321 1 for match with start of a command
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2322 2 full match with a command
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2323 3 matches several user commands
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2324 To check for a supported command
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2325 always check the return value to be 2.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2326 :2match The \|:2match\| command.
29450 67f31c24291b Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29403 diff changeset	2327 :3match The \|:3match\| command (but you
67f31c24291b Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29403 diff changeset	2328 probably should not use it, it is
67f31c24291b Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29403 diff changeset	2329 reserved for internal usage)
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2330 #event autocommand defined for this event
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2331 #event#pattern autocommand defined for this event and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2332 pattern (the pattern is taken
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2333 literally and compared to the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2334 autocommand patterns character by
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2335 character)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2336 #group autocommand group exists
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2337 #group#event autocommand defined for this group and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2338 event.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2339 #group#event#pattern
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2340 autocommand defined for this group,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2341 event and pattern.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2342 ##event autocommand for this event is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2343 supported.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2344
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2345 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2346 exists("&shortname")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2347 exists("$HOSTNAME")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2348 exists("*strftime")
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	2349 exists("*s:MyFunc") " only for legacy script
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	2350 exists("*MyFunc")
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2351 exists("bufcount")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2352 exists(":Make")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2353 exists("#CursorHold")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2354 exists("#BufReadPre#*.gz")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2355 exists("#filetypeindent")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2356 exists("#filetypeindent#FileType")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2357 exists("#filetypeindent#FileType#*")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2358 exists("##ColorScheme")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2359 < There must be no space between the symbol (&/$/*/#) and the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2360 name.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2361 There must be no extra characters after the name, although in
28933 57c9377b9c62 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 28917 diff changeset	2362 a few cases this is ignored. That may become stricter in the
57c9377b9c62 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 28917 diff changeset	2363 future, thus don't count on it!
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2364 Working example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2365 exists(":make")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2366 < NOT working example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2367 exists(":make install")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2368
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2369 < Note that the argument must be a string, not the name of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2370 variable itself. For example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2371 exists(bufcount)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2372 < This doesn't check for existence of the "bufcount" variable,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2373 but gets the value of "bufcount", and checks if that exists.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2374
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2375 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2376 Varname()->exists()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2377 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2378
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2379 exists_compiled({expr}) exists_compiled()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2380 Like `exists()` but evaluated at compile time. This is useful
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2381 to skip a block where a function is used that would otherwise
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2382 give an error: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2383 if exists_compiled('*ThatFunction')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2384 ThatFunction('works')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2385 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2386 < If `exists()` were used then a compilation error would be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2387 given if ThatFunction() is not defined.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2388
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2389 {expr} must be a literal string. E1232
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2390 Can only be used in a \|:def\| function. E1233
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2391 This does not work to check for arguments or local variables.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2392
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2393
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2394 exp({expr}) exp()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2395 Return the exponential of {expr} as a \|Float\| in the range
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2396 [0, inf].
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2397 {expr} must evaluate to a \|Float\| or a \|Number\|.
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	2398 Returns 0.0 if {expr} is not a \|Float\| or a \|Number\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2399 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2400 :echo exp(2)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2401 < 7.389056 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2402 :echo exp(-1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2403 < 0.367879
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2404
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2405 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2406 Compute()->exp()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2407
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2408
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2409 expand({string} [, {nosuf} [, {list}]]) expand()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2410 Expand wildcards and the following special keywords in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2411 {string}. 'wildignorecase' applies.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2412
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2413 If {list} is given and it is \|TRUE\|, a List will be returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2414 Otherwise the result is a String and when there are several
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2415 matches, they are separated by <NL> characters. [Note: in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2416 version 5.0 a space was used, which caused problems when a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2417 file name contains a space]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2418
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2419 If the expansion fails, the result is an empty string. A name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2420 for a non-existing file is not included, unless {string} does
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2421 not start with '%', '#' or '<', see below.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2422
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2423 When {string} starts with '%', '#' or '<', the expansion is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2424 done like for the \|cmdline-special\| variables with their
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2425 associated modifiers. Here is a short overview:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2426
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2427 % current file name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2428 # alternate file name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2429 #n alternate file name n
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2430 <cfile> file name under the cursor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2431 <afile> autocmd file name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2432 <abuf> autocmd buffer number (as a String!)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2433 <amatch> autocmd matched name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2434 <cexpr> C expression under the cursor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2435 <sfile> sourced script file or function name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2436 <slnum> sourced script line number or function
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2437 line number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2438 <sflnum> script file line number, also when in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2439 a function
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2440 <SID> "<SNR>123_" where "123" is the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2441 current script ID \|<SID>\|
28517 f73a9bdff3a3 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28471 diff changeset	2442 <script> sourced script file, or script file
f73a9bdff3a3 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28471 diff changeset	2443 where the current function was defined
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2444 <stack> call stack
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2445 <cword> word under the cursor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2446 <cWORD> WORD under the cursor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2447 <client> the {clientid} of the last received
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2448 message \|server2client()\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2449 Modifiers:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2450 :p expand to full path
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2451 :h head (last path component removed)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2452 :t tail (last path component only)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2453 :r root (one extension removed)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2454 :e extension only
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2455
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2456 Example: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	2457 :let &tags = expand("%:p:h") .. "/tags"
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2458 < Note that when expanding a string that starts with '%', '#' or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2459 '<', any following text is ignored. This does NOT work: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2460 :let doesntwork = expand("%:h.bak")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2461 < Use this: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	2462 :let doeswork = expand("%:h") .. ".bak"
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2463 < Also note that expanding "<cfile>" and others only returns the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2464 referenced file name without further expansion. If "<cfile>"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2465 is "~/.cshrc", you need to do another expand() to have the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2466 "~/" expanded into the path of the home directory: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2467 :echo expand(expand("<cfile>"))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2468 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2469 There cannot be white space between the variables and the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2470 following modifier. The \|fnamemodify()\| function can be used
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2471 to modify normal file names.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2472
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2473 When using '%' or '#', and the current or alternate file name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2474 is not defined, an empty string is used. Using "%:p" in a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2475 buffer with no name, results in the current directory, with a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2476 '/' added.
28431 4fbdd4ce9edb patch 8.2.4740: when expand() fails there is no error message Bram Moolenaar <Bram@vim.org> parents: 28379 diff changeset	2477 When 'verbose' is set then expanding '%', '#' and <> items
4fbdd4ce9edb patch 8.2.4740: when expand() fails there is no error message Bram Moolenaar <Bram@vim.org> parents: 28379 diff changeset	2478 will result in an error message if the argument cannot be
4fbdd4ce9edb patch 8.2.4740: when expand() fails there is no error message Bram Moolenaar <Bram@vim.org> parents: 28379 diff changeset	2479 expanded.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2480
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2481 When {string} does not start with '%', '#' or '<', it is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2482 expanded like a file name is expanded on the command line.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2483 'suffixes' and 'wildignore' are used, unless the optional
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2484 {nosuf} argument is given and it is \|TRUE\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2485 Names for non-existing files are included. The "**" item can
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2486 be used to search in a directory tree. For example, to find
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2487 all "README" files in the current directory and below: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2488 :echo expand("**/README")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2489 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2490 expand() can also be used to expand variables and environment
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2491 variables that are only known in a shell. But this can be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2492 slow, because a shell may be used to do the expansion. See
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2493 \|expr-env-expand\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2494 The expanded variable is still handled like a list of file
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2495 names. When an environment variable cannot be expanded, it is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2496 left unchanged. Thus ":echo expand('$FOOBAR')" results in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2497 "$FOOBAR".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2498
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2499 See \|glob()\| for finding existing files. See \|system()\| for
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2500 getting the raw output of an external command.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2501
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2502 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2503 Getpattern()->expand()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2504
28307 425700af491b patch 8.2.4679: cannot have expandcmd() give an error message for mistakes Bram Moolenaar <Bram@vim.org> parents: 28283 diff changeset	2505 expandcmd({string} [, {options}]) expandcmd()
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2506 Expand special items in String {string} like what is done for
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2507 an Ex command such as `:edit`. This expands special keywords,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2508 like with \|expand()\|, and environment variables, anywhere in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2509 {string}. "~user" and "~/path" are only expanded at the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2510 start.
28307 425700af491b patch 8.2.4679: cannot have expandcmd() give an error message for mistakes Bram Moolenaar <Bram@vim.org> parents: 28283 diff changeset	2511
425700af491b patch 8.2.4679: cannot have expandcmd() give an error message for mistakes Bram Moolenaar <Bram@vim.org> parents: 28283 diff changeset	2512 The following items are supported in the {options} Dict
425700af491b patch 8.2.4679: cannot have expandcmd() give an error message for mistakes Bram Moolenaar <Bram@vim.org> parents: 28283 diff changeset	2513 argument:
425700af491b patch 8.2.4679: cannot have expandcmd() give an error message for mistakes Bram Moolenaar <Bram@vim.org> parents: 28283 diff changeset	2514 errmsg If set to TRUE, error messages are displayed
425700af491b patch 8.2.4679: cannot have expandcmd() give an error message for mistakes Bram Moolenaar <Bram@vim.org> parents: 28283 diff changeset	2515 if an error is encountered during expansion.
425700af491b patch 8.2.4679: cannot have expandcmd() give an error message for mistakes Bram Moolenaar <Bram@vim.org> parents: 28283 diff changeset	2516 By default, error messages are not displayed.
425700af491b patch 8.2.4679: cannot have expandcmd() give an error message for mistakes Bram Moolenaar <Bram@vim.org> parents: 28283 diff changeset	2517
28283 2fd2ce8a556c patch 8.2.4667: expandcmd() fails on an error Bram Moolenaar <Bram@vim.org> parents: 28246 diff changeset	2518 Returns the expanded string. If an error is encountered
2fd2ce8a556c patch 8.2.4667: expandcmd() fails on an error Bram Moolenaar <Bram@vim.org> parents: 28246 diff changeset	2519 during expansion, the unmodified {string} is returned.
28307 425700af491b patch 8.2.4679: cannot have expandcmd() give an error message for mistakes Bram Moolenaar <Bram@vim.org> parents: 28283 diff changeset	2520
28283 2fd2ce8a556c patch 8.2.4667: expandcmd() fails on an error Bram Moolenaar <Bram@vim.org> parents: 28246 diff changeset	2521 Example: >
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2522 :echo expandcmd('make %<.o')
28307 425700af491b patch 8.2.4679: cannot have expandcmd() give an error message for mistakes Bram Moolenaar <Bram@vim.org> parents: 28283 diff changeset	2523 make /path/runtime/doc/builtin.o
425700af491b patch 8.2.4679: cannot have expandcmd() give an error message for mistakes Bram Moolenaar <Bram@vim.org> parents: 28283 diff changeset	2524 :echo expandcmd('make %<.o', {'errmsg': v:true})
425700af491b patch 8.2.4679: cannot have expandcmd() give an error message for mistakes Bram Moolenaar <Bram@vim.org> parents: 28283 diff changeset	2525 <
28283 2fd2ce8a556c patch 8.2.4667: expandcmd() fails on an error Bram Moolenaar <Bram@vim.org> parents: 28246 diff changeset	2526 Can also be used as a \|method\|: >
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2527 GetCommand()->expandcmd()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2528 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2529 extend({expr1}, {expr2} [, {expr3}]) extend()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2530 {expr1} and {expr2} must be both \|Lists\| or both
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2531 \|Dictionaries\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2532
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2533 If they are \|Lists\|: Append {expr2} to {expr1}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2534 If {expr3} is given insert the items of {expr2} before the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2535 item with index {expr3} in {expr1}. When {expr3} is zero
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2536 insert before the first item. When {expr3} is equal to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2537 len({expr1}) then {expr2} is appended.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2538 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2539 :echo sort(extend(mylist, [7, 5]))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2540 :call extend(mylist, [2, 3], 1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2541 < When {expr1} is the same List as {expr2} then the number of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2542 items copied is equal to the original length of the List.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2543 E.g., when {expr3} is 1 you get N new copies of the first item
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2544 (where N is the original length of the List).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2545 Use \|add()\| to concatenate one item to a list. To concatenate
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2546 two lists into a new list use the + operator: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2547 :let newlist = [1, 2, 3] + [4, 5]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2548 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2549 If they are \|Dictionaries\|:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2550 Add all entries from {expr2} to {expr1}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2551 If a key exists in both {expr1} and {expr2} then {expr3} is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2552 used to decide what to do:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2553 {expr3} = "keep": keep the value of {expr1}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2554 {expr3} = "force": use the value of {expr2}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2555 {expr3} = "error": give an error message E737
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2556 When {expr3} is omitted then "force" is assumed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2557
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2558 {expr1} is changed when {expr2} is not empty. If necessary
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2559 make a copy of {expr1} first.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2560 {expr2} remains unchanged.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2561 When {expr1} is locked and {expr2} is not empty the operation
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2562 fails.
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	2563 Returns {expr1}. Returns 0 on error.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2564
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2565 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2566 mylist->extend(otherlist)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2567
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2568
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2569 extendnew({expr1}, {expr2} [, {expr3}]) extendnew()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2570 Like \|extend()\| but instead of adding items to {expr1} a new
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2571 List or Dictionary is created and returned. {expr1} remains
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2572 unchanged. Items can still be changed by {expr2}, if you
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2573 don't want that use \|deepcopy()\| first.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2574
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2575
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2576 feedkeys({string} [, {mode}]) feedkeys()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2577 Characters in {string} are queued for processing as if they
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2578 come from a mapping or were typed by the user.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2579
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2580 By default the string is added to the end of the typeahead
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2581 buffer, thus if a mapping is still being executed the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2582 characters come after them. Use the 'i' flag to insert before
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2583 other characters, they will be executed next, before any
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2584 characters from a mapping.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2585
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2586 The function does not wait for processing of keys contained in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2587 {string}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2588
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2589 To include special keys into {string}, use double-quotes
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2590 and "\..." notation \|expr-quote\|. For example,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2591 feedkeys("\<CR>") simulates pressing of the <Enter> key. But
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2592 feedkeys('\<CR>') pushes 5 characters.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2593 A special code that might be useful is <Ignore>, it exits the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2594 wait for a character without doing anything. <Ignore>
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2595
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2596 {mode} is a String, which can contain these character flags:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2597 'm' Remap keys. This is default. If {mode} is absent,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2598 keys are remapped.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2599 'n' Do not remap keys.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2600 't' Handle keys as if typed; otherwise they are handled as
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2601 if coming from a mapping. This matters for undo,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2602 opening folds, etc.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2603 'L' Lowlevel input. Only works for Unix or when using the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2604 GUI. Keys are used as if they were coming from the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2605 terminal. Other flags are not used. E980
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2606 When a CTRL-C interrupts and 't' is included it sets
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2607 the internal "got_int" flag.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2608 'i' Insert the string instead of appending (see above).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2609 'x' Execute commands until typeahead is empty. This is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2610 similar to using ":normal!". You can call feedkeys()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2611 several times without 'x' and then one time with 'x'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2612 (possibly with an empty {string}) to execute all the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2613 typeahead. Note that when Vim ends in Insert mode it
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2614 will behave as if <Esc> is typed, to avoid getting
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2615 stuck, waiting for a character to be typed before the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2616 script continues.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2617 Note that if you manage to call feedkeys() while
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2618 executing commands, thus calling it recursively, then
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2619 all typeahead will be consumed by the last call.
27156 67194006cad8 patch 8.2.4107: script context not restored after using <ScriptCmd> Bram Moolenaar <Bram@vim.org> parents: 27047 diff changeset	2620 'c' Remove any script context when executing, so that
67194006cad8 patch 8.2.4107: script context not restored after using <ScriptCmd> Bram Moolenaar <Bram@vim.org> parents: 27047 diff changeset	2621 legacy script syntax applies, "s:var" does not work,
28777 b96ceb97e896 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28757 diff changeset	2622 etc. Note that if the string being fed sets a script
28620 4d76b3e07c07 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28602 diff changeset	2623 context this still applies.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2624 '!' When used with 'x' will not end Insert mode. Can be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2625 used in a test when a timer is set to exit Insert mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2626 a little later. Useful for testing CursorHoldI.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2627
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2628 Return value is always 0.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2629
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2630 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2631 GetInput()->feedkeys()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2632
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2633 filereadable({file}) filereadable()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2634 The result is a Number, which is \|TRUE\| when a file with the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2635 name {file} exists, and can be read. If {file} doesn't exist,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2636 or is a directory, the result is \|FALSE\|. {file} is any
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2637 expression, which is used as a String.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2638 If you don't care about the file being readable you can use
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2639 \|glob()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2640 {file} is used as-is, you may want to expand wildcards first: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2641 echo filereadable('~/.vimrc')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2642 0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2643 echo filereadable(expand('~/.vimrc'))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2644 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2645
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2646 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2647 GetName()->filereadable()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2648 < file_readable()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2649 Obsolete name: file_readable().
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2650
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2651
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2652 filewritable({file}) filewritable()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2653 The result is a Number, which is 1 when a file with the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2654 name {file} exists, and can be written. If {file} doesn't
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2655 exist, or is not writable, the result is 0. If {file} is a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2656 directory, and we can write to it, the result is 2.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2657
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2658 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2659 GetName()->filewritable()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2660
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2661
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2662 filter({expr1}, {expr2}) filter()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2663 {expr1} must be a \|List\|, \|String\|, \|Blob\| or \|Dictionary\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2664 For each item in {expr1} evaluate {expr2} and when the result
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2665 is zero or false remove the item from the \|List\| or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2666 \|Dictionary\|. Similarly for each byte in a \|Blob\| and each
27036 3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26901 diff changeset	2667 character in a \|String\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2668
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2669 {expr2} must be a \|string\| or \|Funcref\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2670
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2671 If {expr2} is a \|string\|, inside {expr2} \|v:val\| has the value
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2672 of the current item. For a \|Dictionary\| \|v:key\| has the key
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2673 of the current item and for a \|List\| \|v:key\| has the index of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2674 the current item. For a \|Blob\| \|v:key\| has the index of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2675 current byte. For a \|String\| \|v:key\| has the index of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2676 current character.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2677 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2678 call filter(mylist, 'v:val !~ "OLD"')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2679 < Removes the items where "OLD" appears. >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2680 call filter(mydict, 'v:key >= 8')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2681 < Removes the items with a key below 8. >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2682 call filter(var, 0)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2683 < Removes all the items, thus clears the \|List\| or \|Dictionary\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2684
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2685 Note that {expr2} is the result of expression and is then
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2686 used as an expression again. Often it is good to use a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2687 \|literal-string\| to avoid having to double backslashes.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2688
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2689 If {expr2} is a \|Funcref\| it must take two arguments:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2690 1. the key or the index of the current item.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2691 2. the value of the current item.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2692 The function must return \|TRUE\| if the item should be kept.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2693 Example that keeps the odd items of a list: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2694 func Odd(idx, val)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2695 return a:idx % 2 == 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2696 endfunc
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2697 call filter(mylist, function('Odd'))
27036 3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26901 diff changeset	2698 < It is shorter when using a \|lambda\|. In \|Vim9\| syntax: >
3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26901 diff changeset	2699 call filter(myList, (idx, val) => idx * val <= 42)
3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26901 diff changeset	2700 < In legacy script syntax: >
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2701 call filter(myList, {idx, val -> idx * val <= 42})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2702 < If you do not use "val" you can leave it out: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2703 call filter(myList, {idx -> idx % 2 == 1})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2704 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2705 In \|Vim9\| script the result must be true, false, zero or one.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2706 Other values will result in a type error.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2707
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2708 For a \|List\| and a \|Dictionary\| the operation is done
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2709 in-place. If you want it to remain unmodified make a copy
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2710 first: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2711 :let l = filter(copy(mylist), 'v:val =~ "KEEP"')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2712
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2713 < Returns {expr1}, the \|List\| or \|Dictionary\| that was filtered,
26881 fb67cd7d30a7 patch 8.2.3969: value of MAXCOL not available in Vim script Bram Moolenaar <Bram@vim.org> parents: 26847 diff changeset	2714 or a new \|Blob\| or \|String\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2715 When an error is encountered while evaluating {expr2} no
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2716 further items in {expr1} are processed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2717 When {expr2} is a Funcref errors inside a function are ignored,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2718 unless it was defined with the "abort" flag.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2719
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2720 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2721 mylist->filter(expr2)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2722
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2723 finddir({name} [, {path} [, {count}]]) finddir()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2724 Find directory {name} in {path}. Supports both downwards and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2725 upwards recursive directory searches. See \|file-searching\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2726 for the syntax of {path}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2727
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2728 Returns the path of the first found match. When the found
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2729 directory is below the current directory a relative path is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2730 returned. Otherwise a full path is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2731 If {path} is omitted or empty then 'path' is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2732
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2733 If the optional {count} is given, find {count}'s occurrence of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2734 {name} in {path} instead of the first one.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2735 When {count} is negative return all the matches in a \|List\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2736
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	2737 Returns an empty string if the directory is not found.
f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	2738
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2739 This is quite similar to the ex-command `:find`.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2740
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2741 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2742 GetName()->finddir()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2743
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2744 findfile({name} [, {path} [, {count}]]) findfile()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2745 Just like \|finddir()\|, but find a file instead of a directory.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2746 Uses 'suffixesadd'.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2747 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2748 :echo findfile("tags.vim", ".;")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2749 < Searches from the directory of the current file upwards until
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2750 it finds the file "tags.vim".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2751
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2752 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2753 GetName()->findfile()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2754
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2755 flatten({list} [, {maxdepth}]) flatten()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2756 Flatten {list} up to {maxdepth} levels. Without {maxdepth}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2757 the result is a \|List\| without nesting, as if {maxdepth} is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2758 a very large number.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2759 The {list} is changed in place, use \|flattennew()\| if you do
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2760 not want that.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2761 In Vim9 script flatten() cannot be used, you must always use
27537 063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27497 diff changeset	2762 \|flattennew()\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2763 E900
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2764 {maxdepth} means how deep in nested lists changes are made.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2765 {list} is not modified when {maxdepth} is 0.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2766 {maxdepth} must be positive number.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2767
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2768 If there is an error the number zero is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2769
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2770 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2771 :echo flatten([1, [2, [3, 4]], 5])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2772 < [1, 2, 3, 4, 5] >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2773 :echo flatten([1, [2, [3, 4]], 5], 1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2774 < [1, 2, [3, 4], 5]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2775
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2776 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2777 mylist->flatten()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2778 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2779 flattennew({list} [, {maxdepth}]) flattennew()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2780 Like \|flatten()\| but first make a copy of {list}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2781
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2782
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2783 float2nr({expr}) float2nr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2784 Convert {expr} to a Number by omitting the part after the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2785 decimal point.
31028 5acd6f02ea35 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31004 diff changeset	2786 {expr} must evaluate to a \|Float\| or a \|Number\|.
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	2787 Returns 0 if {expr} is not a \|Float\| or a \|Number\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2788 When the value of {expr} is out of range for a \|Number\| the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2789 result is truncated to 0x7fffffff or -0x7fffffff (or when
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2790 64-bit Number support is enabled, 0x7fffffffffffffff or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2791 -0x7fffffffffffffff). NaN results in -0x80000000 (or when
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2792 64-bit Number support is enabled, -0x8000000000000000).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2793 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2794 echo float2nr(3.95)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2795 < 3 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2796 echo float2nr(-23.45)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2797 < -23 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2798 echo float2nr(1.0e100)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2799 < 2147483647 (or 9223372036854775807) >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2800 echo float2nr(-1.0e150)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2801 < -2147483647 (or -9223372036854775807) >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2802 echo float2nr(1.0e-100)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2803 < 0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2804
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2805 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2806 Compute()->float2nr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2807
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2808
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2809 floor({expr}) floor()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2810 Return the largest integral value less than or equal to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2811 {expr} as a \|Float\| (round down).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2812 {expr} must evaluate to a \|Float\| or a \|Number\|.
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	2813 Returns 0.0 if {expr} is not a \|Float\| or a \|Number\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2814 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2815 echo floor(1.856)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2816 < 1.0 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2817 echo floor(-5.456)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2818 < -6.0 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2819 echo floor(4.0)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2820 < 4.0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2821
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2822 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2823 Compute()->floor()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2824
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2825
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2826 fmod({expr1}, {expr2}) fmod()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2827 Return the remainder of {expr1} / {expr2}, even if the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2828 division is not representable. Returns {expr1} - i * {expr2}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2829 for some integer i such that if {expr2} is non-zero, the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2830 result has the same sign as {expr1} and magnitude less than
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2831 the magnitude of {expr2}. If {expr2} is zero, the value
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2832 returned is zero. The value returned is a \|Float\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2833 {expr1} and {expr2} must evaluate to a \|Float\| or a \|Number\|.
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	2834 Returns 0.0 if {expr1} or {expr2} is not a \|Float\| or a
f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	2835 \|Number\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2836 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2837 :echo fmod(12.33, 1.22)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2838 < 0.13 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2839 :echo fmod(-12.33, 1.22)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2840 < -0.13
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2841
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2842 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2843 Compute()->fmod(1.22)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2844
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2845
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2846 fnameescape({string}) fnameescape()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2847 Escape {string} for use as file name command argument. All
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2848 characters that have a special meaning, such as '%' and '\|'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2849 are escaped with a backslash.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2850 For most systems the characters escaped are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2851 " \t\n*?[{`$\\%#'\"\|!<". For systems where a backslash
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2852 appears in a filename, it depends on the value of 'isfname'.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2853 A leading '+' and '>' is also escaped (special after \|:edit\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2854 and \|:write\|). And a "-" by itself (special after \|:cd\|).
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	2855 Returns an empty string on error.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2856 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2857 :let fname = '+some str%nge\|name'
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	2858 :exe "edit " .. fnameescape(fname)
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2859 < results in executing: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2860 edit \+some\ str\%nge\\|name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2861 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2862 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2863 GetName()->fnameescape()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2864
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2865 fnamemodify({fname}, {mods}) fnamemodify()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2866 Modify file name {fname} according to {mods}. {mods} is a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2867 string of characters like it is used for file names on the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2868 command line. See \|filename-modifiers\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2869 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2870 :echo fnamemodify("main.c", ":p:h")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2871 < results in: >
29236 0eef32b4ebbc Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29194 diff changeset	2872 /home/user/vim/vim/src
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	2873 < If {mods} is empty or an unsupported modifier is used then
f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	2874 {fname} is returned.
29403 03e3b0034e31 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29314 diff changeset	2875 When {fname} is empty then with {mods} ":h" returns ".", so
03e3b0034e31 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29314 diff changeset	2876 that `:cd` can be used with it. This is different from
03e3b0034e31 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29314 diff changeset	2877 expand('%:h') without a buffer name, which returns an empty
03e3b0034e31 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29314 diff changeset	2878 string.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2879 Note: Environment variables don't work in {fname}, use
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2880 \|expand()\| first then.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2881
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2882 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2883 GetName()->fnamemodify(':p:h')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2884
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2885 foldclosed({lnum}) foldclosed()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2886 The result is a Number. If the line {lnum} is in a closed
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2887 fold, the result is the number of the first line in that fold.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2888 If the line {lnum} is not in a closed fold, -1 is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2889 {lnum} is used like with \|getline()\|. Thus "." is the current
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2890 line, "'m" mark m, etc.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2891
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2892 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2893 GetLnum()->foldclosed()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2894
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2895 foldclosedend({lnum}) foldclosedend()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2896 The result is a Number. If the line {lnum} is in a closed
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2897 fold, the result is the number of the last line in that fold.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2898 If the line {lnum} is not in a closed fold, -1 is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2899 {lnum} is used like with \|getline()\|. Thus "." is the current
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2900 line, "'m" mark m, etc.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2901
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2902 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2903 GetLnum()->foldclosedend()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2904
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2905 foldlevel({lnum}) foldlevel()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2906 The result is a Number, which is the foldlevel of line {lnum}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2907 in the current buffer. For nested folds the deepest level is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2908 returned. If there is no fold at line {lnum}, zero is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2909 returned. It doesn't matter if the folds are open or closed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2910 When used while updating folds (from 'foldexpr') -1 is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2911 returned for lines where folds are still to be updated and the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2912 foldlevel is unknown. As a special case the level of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2913 previous line is usually available.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2914 {lnum} is used like with \|getline()\|. Thus "." is the current
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2915 line, "'m" mark m, etc.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2916
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2917 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2918 GetLnum()->foldlevel()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2919 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2920 foldtext()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2921 foldtext() Returns a String, to be displayed for a closed fold. This is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2922 the default function used for the 'foldtext' option and should
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2923 only be called from evaluating 'foldtext'. It uses the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2924 \|v:foldstart\|, \|v:foldend\| and \|v:folddashes\| variables.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2925 The returned string looks like this: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2926 +-- 45 lines: abcdef
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2927 < The number of leading dashes depends on the foldlevel. The
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2928 "45" is the number of lines in the fold. "abcdef" is the text
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2929 in the first non-blank line of the fold. Leading white space,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2930 "//" or "/*" and the text from the 'foldmarker' and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2931 'commentstring' options is removed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2932 When used to draw the actual foldtext, the rest of the line
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2933 will be filled with the fold char from the 'fillchars'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2934 setting.
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	2935 Returns an empty string when there is no fold.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2936 {not available when compiled without the \|+folding\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2937
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2938 foldtextresult({lnum}) foldtextresult()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2939 Returns the text that is displayed for the closed fold at line
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2940 {lnum}. Evaluates 'foldtext' in the appropriate context.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2941 When there is no closed fold at {lnum} an empty string is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2942 returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2943 {lnum} is used like with \|getline()\|. Thus "." is the current
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2944 line, "'m" mark m, etc.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2945 Useful when exporting folded text, e.g., to HTML.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2946 {not available when compiled without the \|+folding\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2947
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2948
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2949 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2950 GetLnum()->foldtextresult()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2951 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2952 foreground()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2953 foreground() Move the Vim window to the foreground. Useful when sent from
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2954 a client to a Vim server. \|remote_send()\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2955 On Win32 systems this might not work, the OS does not always
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2956 allow a window to bring itself to the foreground. Use
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2957 \|remote_foreground()\| instead.
28379 6dd88e45d47d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28307 diff changeset	2958 {only in the Win32, Motif and GTK GUI versions and the
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2959 Win32 console version}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2960
30275 121d28008c14 patch 9.0.0473: fullcommand() only works for the current script version Bram Moolenaar <Bram@vim.org> parents: 30226 diff changeset	2961 fullcommand({name} [, {vim9}]) fullcommand()
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2962 Get the full command name from a short abbreviated command
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2963 name; see \|20.2\| for details on command abbreviations.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2964
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2965 The string argument {name} may start with a `:` and can
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2966 include a [range], these are skipped and not returned.
30275 121d28008c14 patch 9.0.0473: fullcommand() only works for the current script version Bram Moolenaar <Bram@vim.org> parents: 30226 diff changeset	2967 Returns an empty string if a command doesn't exist, if it's
121d28008c14 patch 9.0.0473: fullcommand() only works for the current script version Bram Moolenaar <Bram@vim.org> parents: 30226 diff changeset	2968 ambiguous (for user-defined commands) or cannot be shortened
121d28008c14 patch 9.0.0473: fullcommand() only works for the current script version Bram Moolenaar <Bram@vim.org> parents: 30226 diff changeset	2969 this way. \|vim9-no-shorten\|
121d28008c14 patch 9.0.0473: fullcommand() only works for the current script version Bram Moolenaar <Bram@vim.org> parents: 30226 diff changeset	2970
121d28008c14 patch 9.0.0473: fullcommand() only works for the current script version Bram Moolenaar <Bram@vim.org> parents: 30226 diff changeset	2971 Without the {vim9} argument uses the current script version.
121d28008c14 patch 9.0.0473: fullcommand() only works for the current script version Bram Moolenaar <Bram@vim.org> parents: 30226 diff changeset	2972 If {vim9} is present and FALSE then legacy script rules are
121d28008c14 patch 9.0.0473: fullcommand() only works for the current script version Bram Moolenaar <Bram@vim.org> parents: 30226 diff changeset	2973 used. When {vim9} is present and TRUE then Vim9 rules are
121d28008c14 patch 9.0.0473: fullcommand() only works for the current script version Bram Moolenaar <Bram@vim.org> parents: 30226 diff changeset	2974 used, e.g. "en" is not a short form of "endif".
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2975
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2976 For example `fullcommand('s')`, `fullcommand('sub')`,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2977 `fullcommand(':%substitute')` all return "substitute".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2978
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2979 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2980 GetName()->fullcommand()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2981 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2982 funcref()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2983 funcref({name} [, {arglist}] [, {dict}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2984 Just like \|function()\|, but the returned Funcref will lookup
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2985 the function by reference, not by name. This matters when the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2986 function {name} is redefined later.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2987
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2988 Unlike \|function()\|, {name} must be an existing user function.
27036 3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26901 diff changeset	2989 It only works for an autoloaded function if it has already
3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26901 diff changeset	2990 been loaded (to avoid mistakenly loading the autoload script
3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26901 diff changeset	2991 when only intending to use the function name, use \|function()\|
3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26901 diff changeset	2992 instead). {name} cannot be a builtin function.
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	2993 Returns 0 on error.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2994
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2995 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2996 GetFuncname()->funcref([arg])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2997 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2998 function() partial E700 E922 E923
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2999 function({name} [, {arglist}] [, {dict}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3000 Return a \|Funcref\| variable that refers to function {name}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3001 {name} can be the name of a user defined function or an
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3002 internal function.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3003
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3004 {name} can also be a Funcref or a partial. When it is a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3005 partial the dict stored in it will be used and the {dict}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3006 argument is not allowed. E.g.: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3007 let FuncWithArg = function(dict.Func, [arg])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3008 let Broken = function(dict.Func, [arg], dict)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3009 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3010 When using the Funcref the function will be found by {name},
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3011 also when it was redefined later. Use \|funcref()\| to keep the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3012 same function.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3013
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3014 When {arglist} or {dict} is present this creates a partial.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3015 That means the argument list and/or the dictionary is stored in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3016 the Funcref and will be used when the Funcref is called.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3017
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3018 The arguments are passed to the function in front of other
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3019 arguments, but after any argument from \|method\|. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3020 func Callback(arg1, arg2, name)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3021 ...
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3022 let Partial = function('Callback', ['one', 'two'])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3023 ...
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3024 call Partial('name')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3025 < Invokes the function as with: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3026 call Callback('one', 'two', 'name')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3027
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3028 < With a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3029 func Callback(one, two, three)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3030 ...
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3031 let Partial = function('Callback', ['two'])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3032 ...
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3033 eval 'one'->Partial('three')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3034 < Invokes the function as with: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3035 call Callback('one', 'two', 'three')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3036
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3037 < The function() call can be nested to add more arguments to the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3038 Funcref. The extra arguments are appended to the list of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3039 arguments. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3040 func Callback(arg1, arg2, name)
30085 ebed259f919f Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30083 diff changeset	3041 "...
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3042 let Func = function('Callback', ['one'])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3043 let Func2 = function(Func, ['two'])
30085 ebed259f919f Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30083 diff changeset	3044 "...
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3045 call Func2('name')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3046 < Invokes the function as with: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3047 call Callback('one', 'two', 'name')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3048
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3049 < The Dictionary is only useful when calling a "dict" function.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3050 In that case the {dict} is passed in as "self". Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3051 function Callback() dict
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	3052 echo "called for " .. self.name
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3053 endfunction
30085 ebed259f919f Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30083 diff changeset	3054 "...
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3055 let context = {"name": "example"}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3056 let Func = function('Callback', context)
30085 ebed259f919f Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30083 diff changeset	3057 "...
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3058 call Func() " will echo: called for example
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3059 < The use of function() is not needed when there are no extra
30085 ebed259f919f Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30083 diff changeset	3060 arguments, these two are equivalent, if Callback() is defined
ebed259f919f Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30083 diff changeset	3061 as context.Callback(): >
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3062 let Func = function('Callback', context)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3063 let Func = context.Callback
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3064
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3065 < The argument list and the Dictionary can be combined: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3066 function Callback(arg1, count) dict
30085 ebed259f919f Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30083 diff changeset	3067 "...
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3068 let context = {"name": "example"}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3069 let Func = function('Callback', ['one'], context)
30085 ebed259f919f Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30083 diff changeset	3070 "...
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3071 call Func(500)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3072 < Invokes the function as with: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3073 call context.Callback('one', 500)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3074 <
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	3075 Returns 0 on error.
f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	3076
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3077 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3078 GetFuncname()->function([arg])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3079
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3080
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3081 garbagecollect([{atexit}]) garbagecollect()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3082 Cleanup unused \|Lists\|, \|Dictionaries\|, \|Channels\| and \|Jobs\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3083 that have circular references.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3084
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3085 There is hardly ever a need to invoke this function, as it is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3086 automatically done when Vim runs out of memory or is waiting
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3087 for the user to press a key after 'updatetime'. Items without
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3088 circular references are always freed when they become unused.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3089 This is useful if you have deleted a very big \|List\| and/or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3090 \|Dictionary\| with circular references in a script that runs
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3091 for a long time.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3092
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3093 When the optional {atexit} argument is one, garbage
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3094 collection will also be done when exiting Vim, if it wasn't
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3095 done before. This is useful when checking for memory leaks.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3096
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3097 The garbage collection is not done immediately but only when
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3098 it's safe to perform. This is when waiting for the user to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3099 type a character. To force garbage collection immediately use
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3100 \|test_garbagecollect_now()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3101
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3102 get({list}, {idx} [, {default}]) get()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3103 Get item {idx} from \|List\| {list}. When this item is not
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3104 available return {default}. Return zero when {default} is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3105 omitted.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3106 Preferably used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3107 mylist->get(idx)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3108 get({blob}, {idx} [, {default}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3109 Get byte {idx} from \|Blob\| {blob}. When this byte is not
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3110 available return {default}. Return -1 when {default} is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3111 omitted.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3112 Preferably used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3113 myblob->get(idx)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3114 get({dict}, {key} [, {default}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3115 Get item with key {key} from \|Dictionary\| {dict}. When this
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3116 item is not available return {default}. Return zero when
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3117 {default} is omitted. Useful example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3118 let val = get(g:, 'var_name', 'default')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3119 < This gets the value of g:var_name if it exists, and uses
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3120 'default' when it does not exist.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3121 Preferably used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3122 mydict->get(key)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3123 get({func}, {what})
27321 3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27223 diff changeset	3124 Get item {what} from Funcref {func}. Possible values for
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3125 {what} are:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3126 "name" The function name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3127 "func" The function
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3128 "dict" The dictionary
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3129 "args" The list with arguments
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	3130 Returns zero on error.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3131 Preferably used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3132 myfunc->get(what)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3133 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3134 getbufinfo()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3135 getbufinfo([{buf}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3136 getbufinfo([{dict}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3137 Get information about buffers as a List of Dictionaries.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3138
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3139 Without an argument information about all the buffers is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3140 returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3141
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3142 When the argument is a \|Dictionary\| only the buffers matching
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3143 the specified criteria are returned. The following keys can
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3144 be specified in {dict}:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3145 buflisted include only listed buffers.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3146 bufloaded include only loaded buffers.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3147 bufmodified include only modified buffers.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3148
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3149 Otherwise, {buf} specifies a particular buffer to return
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3150 information for. For the use of {buf}, see \|bufname()\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3151 above. If the buffer is found the returned List has one item.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3152 Otherwise the result is an empty list.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3153
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3154 Each returned List item is a dictionary with the following
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3155 entries:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3156 bufnr Buffer number.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3157 changed TRUE if the buffer is modified.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3158 changedtick Number of changes made to the buffer.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3159 hidden TRUE if the buffer is hidden.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3160 lastused Timestamp in seconds, like
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3161 \|localtime()\|, when the buffer was
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3162 last used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3163 {only with the \|+viminfo\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3164 listed TRUE if the buffer is listed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3165 lnum Line number used for the buffer when
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3166 opened in the current window.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3167 Only valid if the buffer has been
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3168 displayed in the window in the past.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3169 If you want the line number of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3170 last known cursor position in a given
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3171 window, use \|line()\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3172 :echo line('.', {winid})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3173 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3174 linecount Number of lines in the buffer (only
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3175 valid when loaded)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3176 loaded TRUE if the buffer is loaded.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3177 name Full path to the file in the buffer.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3178 signs List of signs placed in the buffer.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3179 Each list item is a dictionary with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3180 the following fields:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3181 id sign identifier
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3182 lnum line number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3183 name sign name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3184 variables A reference to the dictionary with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3185 buffer-local variables.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3186 windows List of \|window-ID\|s that display this
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3187 buffer
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3188 popups List of popup \|window-ID\|s that
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3189 display this buffer
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3190
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3191 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3192 for buf in getbufinfo()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3193 echo buf.name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3194 endfor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3195 for buf in getbufinfo({'buflisted':1})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3196 if buf.changed
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3197 ....
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3198 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3199 endfor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3200 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3201 To get buffer-local options use: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3202 getbufvar({bufnr}, '&option_name')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3203 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3204 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3205 GetBufnr()->getbufinfo()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3206 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3207
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3208 getbufline()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3209 getbufline({buf}, {lnum} [, {end}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3210 Return a \|List\| with the lines starting from {lnum} to {end}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3211 (inclusive) in the buffer {buf}. If {end} is omitted, a
31164 7831da568864 patch 9.0.0916: getbufline() is inefficient for getting a single line Bram Moolenaar <Bram@vim.org> parents: 31139 diff changeset	3212 \|List\| with only the line {lnum} is returned. See
7831da568864 patch 9.0.0916: getbufline() is inefficient for getting a single line Bram Moolenaar <Bram@vim.org> parents: 31139 diff changeset	3213 `getbufoneline()` for only getting the line.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3214
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3215 For the use of {buf}, see \|bufname()\| above.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3216
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3217 For {lnum} and {end} "$" can be used for the last line of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3218 buffer. Otherwise a number must be used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3219
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3220 When {lnum} is smaller than 1 or bigger than the number of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3221 lines in the buffer, an empty \|List\| is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3222
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3223 When {end} is greater than the number of lines in the buffer,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3224 it is treated as {end} is set to the number of lines in the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3225 buffer. When {end} is before {lnum} an empty \|List\| is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3226 returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3227
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3228 This function works only for loaded buffers. For unloaded and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3229 non-existing buffers, an empty \|List\| is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3230
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3231 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3232 :let lines = getbufline(bufnr("myfile"), 1, "$")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3233
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3234 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3235 GetBufnr()->getbufline(lnum)
31164 7831da568864 patch 9.0.0916: getbufline() is inefficient for getting a single line Bram Moolenaar <Bram@vim.org> parents: 31139 diff changeset	3236 <
7831da568864 patch 9.0.0916: getbufline() is inefficient for getting a single line Bram Moolenaar <Bram@vim.org> parents: 31139 diff changeset	3237 getbufoneline()
7831da568864 patch 9.0.0916: getbufline() is inefficient for getting a single line Bram Moolenaar <Bram@vim.org> parents: 31139 diff changeset	3238 getbufoneline({buf}, {lnum})
7831da568864 patch 9.0.0916: getbufline() is inefficient for getting a single line Bram Moolenaar <Bram@vim.org> parents: 31139 diff changeset	3239 Just like `getbufline()` but only get one line and return it
7831da568864 patch 9.0.0916: getbufline() is inefficient for getting a single line Bram Moolenaar <Bram@vim.org> parents: 31139 diff changeset	3240 as a string.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3241
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3242 getbufvar({buf}, {varname} [, {def}]) getbufvar()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3243 The result is the value of option or local buffer variable
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3244 {varname} in buffer {buf}. Note that the name without "b:"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3245 must be used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3246 The {varname} argument is a string.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3247 When {varname} is empty returns a \|Dictionary\| with all the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3248 buffer-local variables.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3249 When {varname} is equal to "&" returns a \|Dictionary\| with all
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3250 the buffer-local options.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3251 Otherwise, when {varname} starts with "&" returns the value of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3252 a buffer-local option.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3253 This also works for a global or buffer-local option, but it
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3254 doesn't work for a global variable, window-local variable or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3255 window-local option.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3256 For the use of {buf}, see \|bufname()\| above.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3257 When the buffer or variable doesn't exist {def} or an empty
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3258 string is returned, there is no error message.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3259 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3260 :let bufmodified = getbufvar(1, "&mod")
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	3261 :echo "todo myvar = " .. getbufvar("todo", "myvar")
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3262
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3263 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3264 GetBufnr()->getbufvar(varname)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3265 <
31760 f348559ce426 patch 9.0.1212: cannot read back what setcellwidths() has done Bram Moolenaar <Bram@vim.org> parents: 31712 diff changeset	3266 getcellwidths() getcellwidths()
f348559ce426 patch 9.0.1212: cannot read back what setcellwidths() has done Bram Moolenaar <Bram@vim.org> parents: 31712 diff changeset	3267 Returns a \|List\| of cell widths of character ranges overridden
f348559ce426 patch 9.0.1212: cannot read back what setcellwidths() has done Bram Moolenaar <Bram@vim.org> parents: 31712 diff changeset	3268 by \|setcellwidths()\|. The format is equal to the argument of
f348559ce426 patch 9.0.1212: cannot read back what setcellwidths() has done Bram Moolenaar <Bram@vim.org> parents: 31712 diff changeset	3269 \|setcellwidths()\|. If no character ranges have their cell
f348559ce426 patch 9.0.1212: cannot read back what setcellwidths() has done Bram Moolenaar <Bram@vim.org> parents: 31712 diff changeset	3270 widths overridden, an empty List is returned.
f348559ce426 patch 9.0.1212: cannot read back what setcellwidths() has done Bram Moolenaar <Bram@vim.org> parents: 31712 diff changeset	3271
f348559ce426 patch 9.0.1212: cannot read back what setcellwidths() has done Bram Moolenaar <Bram@vim.org> parents: 31712 diff changeset	3272
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3273 getchangelist([{buf}]) getchangelist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3274 Returns the \|changelist\| for the buffer {buf}. For the use
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3275 of {buf}, see \|bufname()\| above. If buffer {buf} doesn't
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3276 exist, an empty list is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3277
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3278 The returned list contains two entries: a list with the change
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3279 locations and the current position in the list. Each
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3280 entry in the change list is a dictionary with the following
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3281 entries:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3282 col column number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3283 coladd column offset for 'virtualedit'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3284 lnum line number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3285 If buffer {buf} is the current buffer, then the current
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3286 position refers to the position in the list. For other
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3287 buffers, it is set to the length of the list.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3288
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3289 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3290 GetBufnr()->getchangelist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3291
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3292 getchar([expr]) getchar()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3293 Get a single character from the user or input stream.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3294 If [expr] is omitted, wait until a character is available.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3295 If [expr] is 0, only get a character when one is available.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3296 Return zero otherwise.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3297 If [expr] is 1, only check if a character is available, it is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3298 not consumed. Return zero if no character available.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3299 If you prefer always getting a string use \|getcharstr()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3300
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3301 Without [expr] and when [expr] is 0 a whole character or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3302 special key is returned. If it is a single character, the
28933 57c9377b9c62 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 28917 diff changeset	3303 result is a Number. Use \|nr2char()\| to convert it to a String.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3304 Otherwise a String is returned with the encoded character.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3305 For a special key it's a String with a sequence of bytes
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3306 starting with 0x80 (decimal: 128). This is the same value as
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3307 the String "\<Key>", e.g., "\<Left>". The returned value is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3308 also a String when a modifier (shift, control, alt) was used
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3309 that is not included in the character.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3310
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3311 When [expr] is 0 and Esc is typed, there will be a short delay
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3312 while Vim waits to see if this is the start of an escape
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3313 sequence.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3314
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3315 When [expr] is 1 only the first byte is returned. For a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3316 one-byte character it is the character itself as a number.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3317 Use nr2char() to convert it to a String.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3318
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3319 Use getcharmod() to obtain any additional modifiers.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3320
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3321 When the user clicks a mouse button, the mouse event will be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3322 returned. The position can then be found in \|v:mouse_col\|,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3323 \|v:mouse_lnum\|, \|v:mouse_winid\| and \|v:mouse_win\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3324 \|getmousepos()\| can also be used. Mouse move events will be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3325 ignored.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3326 This example positions the mouse as it would normally happen: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3327 let c = getchar()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3328 if c == "\<LeftMouse>" && v:mouse_win > 0
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	3329 exe v:mouse_win .. "wincmd w"
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3330 exe v:mouse_lnum
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	3331 exe "normal " .. v:mouse_col .. "\|"
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3332 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3333 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3334 When using bracketed paste only the first character is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3335 returned, the rest of the pasted text is dropped.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3336 \|xterm-bracketed-paste\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3337
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3338 There is no prompt, you will somehow have to make clear to the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3339 user that a character has to be typed. The screen is not
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3340 redrawn, e.g. when resizing the window. When using a popup
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3341 window it should work better with a \|popup-filter\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3342
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3343 There is no mapping for the character.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3344 Key codes are replaced, thus when the user presses the <Del>
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3345 key you get the code for the <Del> key, not the raw character
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3346 sequence. Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3347 getchar() == "\<Del>"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3348 getchar() == "\<S-Left>"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3349 < This example redefines "f" to ignore case: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3350 :nmap f :call FindChar()<CR>
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3351 :function FindChar()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3352 : let c = nr2char(getchar())
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3353 : while col('.') < col('$') - 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3354 : normal l
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3355 : if getline('.')[col('.') - 1] ==? c
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3356 : break
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3357 : endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3358 : endwhile
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3359 :endfunction
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3360 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3361 You may also receive synthetic characters, such as
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3362 \|<CursorHold>\|. Often you will want to ignore this and get
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3363 another character: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3364 :function GetKey()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3365 : let c = getchar()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3366 : while c == "\<CursorHold>"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3367 : let c = getchar()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3368 : endwhile
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3369 : return c
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3370 :endfunction
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3371
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3372 getcharmod() getcharmod()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3373 The result is a Number which is the state of the modifiers for
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3374 the last obtained character with getchar() or in another way.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3375 These values are added together:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3376 2 shift
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3377 4 control
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3378 8 alt (meta)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3379 16 meta (when it's different from ALT)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3380 32 mouse double click
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3381 64 mouse triple click
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3382 96 mouse quadruple click (== 32 + 64)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3383 128 command (Macintosh only)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3384 Only the modifiers that have not been included in the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3385 character itself are obtained. Thus Shift-a results in "A"
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	3386 without a modifier. Returns 0 if no modifiers are used.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3387
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3388 getcharpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3389 getcharpos({expr})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3390 Get the position for String {expr}. Same as \|getpos()\| but the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3391 column number in the returned List is a character index
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3392 instead of a byte index.
26881 fb67cd7d30a7 patch 8.2.3969: value of MAXCOL not available in Vim script Bram Moolenaar <Bram@vim.org> parents: 26847 diff changeset	3393 If \|getpos()\| returns a very large column number, equal to
fb67cd7d30a7 patch 8.2.3969: value of MAXCOL not available in Vim script Bram Moolenaar <Bram@vim.org> parents: 26847 diff changeset	3394 \|v:maxcol\|, then getcharpos() will return the character index
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3395 of the last character.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3396
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3397 Example:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3398 With the cursor on '세' in line 5 with text "여보세요": >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3399 getcharpos('.') returns [0, 5, 3, 0]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3400 getpos('.') returns [0, 5, 7, 0]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3401 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3402 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3403 GetMark()->getcharpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3404
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3405 getcharsearch() getcharsearch()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3406 Return the current character search information as a {dict}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3407 with the following entries:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3408
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3409 char character previously used for a character
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3410 search (\|t\|, \|f\|, \|T\|, or \|F\|); empty string
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3411 if no character search has been performed
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3412 forward direction of character search; 1 for forward,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3413 0 for backward
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3414 until type of character search; 1 for a \|t\| or \|T\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3415 character search, 0 for an \|f\| or \|F\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3416 character search
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3417
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3418 This can be useful to always have \|;\| and \|,\| search
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3419 forward/backward regardless of the direction of the previous
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3420 character search: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3421 :nnoremap <expr> ; getcharsearch().forward ? ';' : ','
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3422 :nnoremap <expr> , getcharsearch().forward ? ',' : ';'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3423 < Also see \|setcharsearch()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3424
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3425
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3426 getcharstr([expr]) getcharstr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3427 Get a single character from the user or input stream as a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3428 string.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3429 If [expr] is omitted, wait until a character is available.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3430 If [expr] is 0 or false, only get a character when one is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3431 available. Return an empty string otherwise.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3432 If [expr] is 1 or true, only check if a character is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3433 available, it is not consumed. Return an empty string
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3434 if no character is available.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3435 Otherwise this works like \|getchar()\|, except that a number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3436 result is converted to a string.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3437
28757 add09d468c0d patch 8.2.4903: cannot get the current cmdline completion type and position Bram Moolenaar <Bram@vim.org> parents: 28674 diff changeset	3438 getcmdcompltype() getcmdcompltype()
add09d468c0d patch 8.2.4903: cannot get the current cmdline completion type and position Bram Moolenaar <Bram@vim.org> parents: 28674 diff changeset	3439 Return the type of the current command-line completion.
add09d468c0d patch 8.2.4903: cannot get the current cmdline completion type and position Bram Moolenaar <Bram@vim.org> parents: 28674 diff changeset	3440 Only works when the command line is being edited, thus
add09d468c0d patch 8.2.4903: cannot get the current cmdline completion type and position Bram Moolenaar <Bram@vim.org> parents: 28674 diff changeset	3441 requires use of \|c_CTRL-\_e\| or \|c_CTRL-R_=\|.
28808 0f0fed554cdc Update runtime files, translations Bram Moolenaar <Bram@vim.org> parents: 28777 diff changeset	3442 See \|:command-completion\| for the return string.
29894 d8fc1effa724 patch 9.0.0285: it is not easy to change the command line from a plugin Bram Moolenaar <Bram@vim.org> parents: 29883 diff changeset	3443 Also see \|getcmdtype()\|, \|setcmdpos()\|, \|getcmdline()\| and
d8fc1effa724 patch 9.0.0285: it is not easy to change the command line from a plugin Bram Moolenaar <Bram@vim.org> parents: 29883 diff changeset	3444 \|setcmdline()\|.
28757 add09d468c0d patch 8.2.4903: cannot get the current cmdline completion type and position Bram Moolenaar <Bram@vim.org> parents: 28674 diff changeset	3445 Returns an empty string when completion is not defined.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3446
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3447 getcmdline() getcmdline()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3448 Return the current command-line. Only works when the command
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3449 line is being edited, thus requires use of \|c_CTRL-\_e\| or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3450 \|c_CTRL-R_=\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3451 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3452 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR>
29894 d8fc1effa724 patch 9.0.0285: it is not easy to change the command line from a plugin Bram Moolenaar <Bram@vim.org> parents: 29883 diff changeset	3453 < Also see \|getcmdtype()\|, \|getcmdpos()\|, \|setcmdpos()\| and
d8fc1effa724 patch 9.0.0285: it is not easy to change the command line from a plugin Bram Moolenaar <Bram@vim.org> parents: 29883 diff changeset	3454 \|setcmdline()\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3455 Returns an empty string when entering a password or using
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3456 \|inputsecret()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3457
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3458 getcmdpos() getcmdpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3459 Return the position of the cursor in the command line as a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3460 byte count. The first column is 1.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3461 Only works when editing the command line, thus requires use of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3462 \|c_CTRL-\_e\| or \|c_CTRL-R_=\| or an expression mapping.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3463 Returns 0 otherwise.
29894 d8fc1effa724 patch 9.0.0285: it is not easy to change the command line from a plugin Bram Moolenaar <Bram@vim.org> parents: 29883 diff changeset	3464 Also see \|getcmdtype()\|, \|setcmdpos()\|, \|getcmdline()\| and
d8fc1effa724 patch 9.0.0285: it is not easy to change the command line from a plugin Bram Moolenaar <Bram@vim.org> parents: 29883 diff changeset	3465 \|setcmdline()\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3466
28757 add09d468c0d patch 8.2.4903: cannot get the current cmdline completion type and position Bram Moolenaar <Bram@vim.org> parents: 28674 diff changeset	3467 getcmdscreenpos() getcmdscreenpos()
add09d468c0d patch 8.2.4903: cannot get the current cmdline completion type and position Bram Moolenaar <Bram@vim.org> parents: 28674 diff changeset	3468 Return the screen position of the cursor in the command line
add09d468c0d patch 8.2.4903: cannot get the current cmdline completion type and position Bram Moolenaar <Bram@vim.org> parents: 28674 diff changeset	3469 as a byte count. The first column is 1.
add09d468c0d patch 8.2.4903: cannot get the current cmdline completion type and position Bram Moolenaar <Bram@vim.org> parents: 28674 diff changeset	3470 Instead of \|getcmdpos()\|, it adds the prompt position.
add09d468c0d patch 8.2.4903: cannot get the current cmdline completion type and position Bram Moolenaar <Bram@vim.org> parents: 28674 diff changeset	3471 Only works when editing the command line, thus requires use of
add09d468c0d patch 8.2.4903: cannot get the current cmdline completion type and position Bram Moolenaar <Bram@vim.org> parents: 28674 diff changeset	3472 \|c_CTRL-\_e\| or \|c_CTRL-R_=\| or an expression mapping.
add09d468c0d patch 8.2.4903: cannot get the current cmdline completion type and position Bram Moolenaar <Bram@vim.org> parents: 28674 diff changeset	3473 Returns 0 otherwise.
29894 d8fc1effa724 patch 9.0.0285: it is not easy to change the command line from a plugin Bram Moolenaar <Bram@vim.org> parents: 29883 diff changeset	3474 Also see \|getcmdpos()\|, \|setcmdpos()\|, \|getcmdline()\| and
d8fc1effa724 patch 9.0.0285: it is not easy to change the command line from a plugin Bram Moolenaar <Bram@vim.org> parents: 29883 diff changeset	3475 \|setcmdline()\|.
28757 add09d468c0d patch 8.2.4903: cannot get the current cmdline completion type and position Bram Moolenaar <Bram@vim.org> parents: 28674 diff changeset	3476
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3477 getcmdtype() getcmdtype()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3478 Return the current command-line type. Possible return values
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3479 are:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3480 : normal Ex command
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3481 > debug mode command \|debug-mode\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3482 / forward search command
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3483 ? backward search command
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3484 @ \|input()\| command
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3485 - \|:insert\| or \|:append\| command
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3486 = \|i_CTRL-R_=\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3487 Only works when editing the command line, thus requires use of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3488 \|c_CTRL-\_e\| or \|c_CTRL-R_=\| or an expression mapping.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3489 Returns an empty string otherwise.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3490 Also see \|getcmdpos()\|, \|setcmdpos()\| and \|getcmdline()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3491
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3492 getcmdwintype() getcmdwintype()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3493 Return the current \|command-line-window\| type. Possible return
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3494 values are the same as \|getcmdtype()\|. Returns an empty string
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3495 when not in the command-line window.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3496
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3497 getcompletion({pat}, {type} [, {filtered}]) getcompletion()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3498 Return a list of command-line completion matches. The String
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3499 {type} argument specifies what for. The following completion
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3500 types are supported:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3501
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3502 arglist file names in argument list
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3503 augroup autocmd groups
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3504 buffer buffer names
28081 b737bfa876c5 patch 8.2.4565: no command line completion for :breakadd and :breakdel Bram Moolenaar <Bram@vim.org> parents: 28010 diff changeset	3505 behave \|:behave\| suboptions
b737bfa876c5 patch 8.2.4565: no command line completion for :breakadd and :breakdel Bram Moolenaar <Bram@vim.org> parents: 28010 diff changeset	3506 breakpoint \|:breakadd\| and \|:breakdel\| suboptions
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3507 color color schemes
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3508 command Ex command
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3509 cmdline \|cmdline-completion\| result
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3510 compiler compilers
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3511 cscope \|:cscope\| suboptions
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3512 diff_buffer \|:diffget\| and \|:diffput\| completion
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3513 dir directory names
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3514 environment environment variable names
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3515 event autocommand events
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3516 expression Vim expression
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3517 file file and directory names
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3518 file_in_path file and directory names in \|'path'\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3519 filetype filetype names \|'filetype'\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3520 function function name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3521 help help subjects
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3522 highlight highlight groups
28081 b737bfa876c5 patch 8.2.4565: no command line completion for :breakadd and :breakdel Bram Moolenaar <Bram@vim.org> parents: 28010 diff changeset	3523 history \|:history\| suboptions
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3524 locale locale names (as output of locale -a)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3525 mapclear buffer argument
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3526 mapping mapping name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3527 menu menus
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3528 messages \|:messages\| suboptions
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3529 option options
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3530 packadd optional package \|pack-add\| names
31811 c5ff7d053fa1 patch 9.0.1238: :runtime completion can be further improved Bram Moolenaar <Bram@vim.org> parents: 31798 diff changeset	3531 runtime \|:runtime\| completion
28183 2b595cee4c85 patch 8.2.4617: no completion for :scriptnames Bram Moolenaar <Bram@vim.org> parents: 28166 diff changeset	3532 scriptnames sourced script names \|:scriptnames\|
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3533 shellcmd Shell command
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3534 sign \|:sign\| suboptions
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3535 syntax syntax file names \|'syntax'\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3536 syntime \|:syntime\| suboptions
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3537 tag tags
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3538 tag_listfiles tags, file names
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3539 user user names
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3540 var user variables
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3541
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3542 If {pat} is an empty string, then all the matches are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3543 returned. Otherwise only items matching {pat} are returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3544 See \|wildcards\| for the use of special characters in {pat}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3545
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3546 If the optional {filtered} flag is set to 1, then 'wildignore'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3547 is applied to filter the results. Otherwise all the matches
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3548 are returned. The 'wildignorecase' option always applies.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3549
28166 130f4082a13d patch 8.2.4608: getcompletion() does not work when 'wildoptions' has "fuzzy" Bram Moolenaar <Bram@vim.org> parents: 28141 diff changeset	3550 If the 'wildoptions' option contains 'fuzzy', then fuzzy
130f4082a13d patch 8.2.4608: getcompletion() does not work when 'wildoptions' has "fuzzy" Bram Moolenaar <Bram@vim.org> parents: 28141 diff changeset	3551 matching is used to get the completion matches. Otherwise
28183 2b595cee4c85 patch 8.2.4617: no completion for :scriptnames Bram Moolenaar <Bram@vim.org> parents: 28166 diff changeset	3552 regular expression matching is used. Thus this function
2b595cee4c85 patch 8.2.4617: no completion for :scriptnames Bram Moolenaar <Bram@vim.org> parents: 28166 diff changeset	3553 follows the user preference, what happens on the command line.
2b595cee4c85 patch 8.2.4617: no completion for :scriptnames Bram Moolenaar <Bram@vim.org> parents: 28166 diff changeset	3554 If you do not want this you can make 'wildoptions' empty
2b595cee4c85 patch 8.2.4617: no completion for :scriptnames Bram Moolenaar <Bram@vim.org> parents: 28166 diff changeset	3555 before calling getcompletion() and restore it afterwards.
28166 130f4082a13d patch 8.2.4608: getcompletion() does not work when 'wildoptions' has "fuzzy" Bram Moolenaar <Bram@vim.org> parents: 28141 diff changeset	3556
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3557 If {type} is "cmdline", then the \|cmdline-completion\| result is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3558 returned. For example, to complete the possible values after
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3559 a ":call" command: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3560 echo getcompletion('call ', 'cmdline')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3561 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3562 If there are no matches, an empty list is returned. An
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3563 invalid value for {type} produces an error.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3564
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3565 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3566 GetPattern()->getcompletion('color')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3567 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3568 getcurpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3569 getcurpos([{winid}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3570 Get the position of the cursor. This is like getpos('.'), but
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3571 includes an extra "curswant" item in the list:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3572 [0, lnum, col, off, curswant] ~
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3573 The "curswant" number is the preferred column when moving the
26881 fb67cd7d30a7 patch 8.2.3969: value of MAXCOL not available in Vim script Bram Moolenaar <Bram@vim.org> parents: 26847 diff changeset	3574 cursor vertically. After \|$\| command it will be a very large
fb67cd7d30a7 patch 8.2.3969: value of MAXCOL not available in Vim script Bram Moolenaar <Bram@vim.org> parents: 26847 diff changeset	3575 number equal to \|v:maxcol\|. Also see \|getcursorcharpos()\| and
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3576 \|getpos()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3577 The first "bufnum" item is always zero. The byte position of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3578 the cursor is returned in 'col'. To get the character
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3579 position, use \|getcursorcharpos()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3580
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3581 The optional {winid} argument can specify the window. It can
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3582 be the window number or the \|window-ID\|. The last known
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3583 cursor position is returned, this may be invalid for the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3584 current value of the buffer if it is not the current window.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3585 If {winid} is invalid a list with zeroes is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3586
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3587 This can be used to save and restore the cursor position: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3588 let save_cursor = getcurpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3589 MoveTheCursorAround
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3590 call setpos('.', save_cursor)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3591 < Note that this only works within the window. See
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3592 \|winrestview()\| for restoring more state.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3593
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3594 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3595 GetWinid()->getcurpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3596 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3597 getcursorcharpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3598 getcursorcharpos([{winid}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3599 Same as \|getcurpos()\| but the column number in the returned
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3600 List is a character index instead of a byte index.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3601
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3602 Example:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3603 With the cursor on '보' in line 3 with text "여보세요": >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3604 getcursorcharpos() returns [0, 3, 2, 0, 3]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3605 getcurpos() returns [0, 3, 4, 0, 3]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3606 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3607 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3608 GetWinid()->getcursorcharpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3609
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3610 < getcwd()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3611 getcwd([{winnr} [, {tabnr}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3612 The result is a String, which is the name of the current
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3613 working directory. 'autochdir' is ignored.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3614
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3615 With {winnr} return the local current directory of this window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3616 in the current tab page. {winnr} can be the window number or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3617 the \|window-ID\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3618 If {winnr} is -1 return the name of the global working
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3619 directory. See also \|haslocaldir()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3620
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3621 With {winnr} and {tabnr} return the local current directory of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3622 the window in the specified tab page. If {winnr} is -1 return
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3623 the working directory of the tabpage.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3624 If {winnr} is zero use the current window, if {tabnr} is zero
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3625 use the current tabpage.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3626 Without any arguments, return the actual working directory of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3627 the current window.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3628 Return an empty string if the arguments are invalid.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3629
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3630 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3631 " Get the working directory of the current window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3632 :echo getcwd()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3633 :echo getcwd(0)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3634 :echo getcwd(0, 0)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3635 " Get the working directory of window 3 in tabpage 2
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3636 :echo getcwd(3, 2)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3637 " Get the global working directory
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3638 :echo getcwd(-1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3639 " Get the working directory of tabpage 3
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3640 :echo getcwd(-1, 3)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3641 " Get the working directory of current tabpage
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3642 :echo getcwd(-1, 0)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3643
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3644 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3645 GetWinnr()->getcwd()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3646
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3647 getenv({name}) getenv()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3648 Return the value of environment variable {name}. The {name}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3649 argument is a string, without a leading '$'. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3650 myHome = getenv('HOME')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3651
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3652 < When the variable does not exist \|v:null\| is returned. That
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3653 is different from a variable set to an empty string, although
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3654 some systems interpret the empty value as the variable being
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3655 deleted. See also \|expr-env\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3656
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3657 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3658 GetVarname()->getenv()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3659
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3660 getfontname([{name}]) getfontname()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3661 Without an argument returns the name of the normal font being
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3662 used. Like what is used for the Normal highlight group
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3663 \|hl-Normal\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3664 With an argument a check is done whether String {name} is a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3665 valid font name. If not then an empty string is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3666 Otherwise the actual font name is returned, or {name} if the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3667 GUI does not support obtaining the real name.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3668 Only works when the GUI is running, thus not in your vimrc or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3669 gvimrc file. Use the \|GUIEnter\| autocommand to use this
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3670 function just after the GUI has started.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3671 Note that the GTK GUI accepts any font name, thus checking for
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3672 a valid name does not work.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3673
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3674 getfperm({fname}) getfperm()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3675 The result is a String, which is the read, write, and execute
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3676 permissions of the given file {fname}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3677 If {fname} does not exist or its directory cannot be read, an
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3678 empty string is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3679 The result is of the form "rwxrwxrwx", where each group of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3680 "rwx" flags represent, in turn, the permissions of the owner
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3681 of the file, the group the file belongs to, and other users.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3682 If a user does not have a given permission the flag for this
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3683 is replaced with the string "-". Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3684 :echo getfperm("/etc/passwd")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3685 :echo getfperm(expand("~/.vimrc"))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3686 < This will hopefully (from a security point of view) display
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3687 the string "rw-r--r--" or even "rw-------".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3688
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3689 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3690 GetFilename()->getfperm()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3691 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3692 For setting permissions use \|setfperm()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3693
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3694 getfsize({fname}) getfsize()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3695 The result is a Number, which is the size in bytes of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3696 given file {fname}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3697 If {fname} is a directory, 0 is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3698 If the file {fname} can't be found, -1 is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3699 If the size of {fname} is too big to fit in a Number then -2
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3700 is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3701
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3702 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3703 GetFilename()->getfsize()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3704
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3705 getftime({fname}) getftime()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3706 The result is a Number, which is the last modification time of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3707 the given file {fname}. The value is measured as seconds
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3708 since 1st Jan 1970, and may be passed to strftime(). See also
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3709 \|localtime()\| and \|strftime()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3710 If the file {fname} can't be found -1 is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3711
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3712 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3713 GetFilename()->getftime()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3714
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3715 getftype({fname}) getftype()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3716 The result is a String, which is a description of the kind of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3717 file of the given file {fname}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3718 If {fname} does not exist an empty string is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3719 Here is a table over different kinds of files and their
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3720 results:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3721 Normal file "file"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3722 Directory "dir"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3723 Symbolic link "link"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3724 Block device "bdev"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3725 Character device "cdev"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3726 Socket "socket"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3727 FIFO "fifo"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3728 All other "other"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3729 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3730 getftype("/home")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3731 < Note that a type such as "link" will only be returned on
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3732 systems that support it. On some systems only "dir" and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3733 "file" are returned. On MS-Windows a symbolic link to a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3734 directory returns "dir" instead of "link".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3735
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3736 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3737 GetFilename()->getftype()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3738
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3739 getimstatus() getimstatus()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3740 The result is a Number, which is \|TRUE\| when the IME status is
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	3741 active and \|FALSE\| otherwise.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3742 See 'imstatusfunc'.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3743
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3744 getjumplist([{winnr} [, {tabnr}]]) getjumplist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3745 Returns the \|jumplist\| for the specified window.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3746
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3747 Without arguments use the current window.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3748 With {winnr} only use this window in the current tab page.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3749 {winnr} can also be a \|window-ID\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3750 With {winnr} and {tabnr} use the window in the specified tab
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	3751 page. If {winnr} or {tabnr} is invalid, an empty list is
f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	3752 returned.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3753
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3754 The returned list contains two entries: a list with the jump
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3755 locations and the last used jump position number in the list.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3756 Each entry in the jump location list is a dictionary with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3757 the following entries:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3758 bufnr buffer number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3759 col column number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3760 coladd column offset for 'virtualedit'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3761 filename filename if available
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3762 lnum line number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3763
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3764 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3765 GetWinnr()->getjumplist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3766
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3767 < getline()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3768 getline({lnum} [, {end}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3769 Without {end} the result is a String, which is line {lnum}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3770 from the current buffer. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3771 getline(1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3772 < When {lnum} is a String that doesn't start with a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3773 digit, \|line()\| is called to translate the String into a Number.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3774 To get the line under the cursor: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3775 getline(".")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3776 < When {lnum} is a number smaller than 1 or bigger than the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3777 number of lines in the buffer, an empty string is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3778
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3779 When {end} is given the result is a \|List\| where each item is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3780 a line from the current buffer in the range {lnum} to {end},
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3781 including line {end}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3782 {end} is used in the same way as {lnum}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3783 Non-existing lines are silently omitted.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3784 When {end} is before {lnum} an empty \|List\| is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3785 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3786 :let start = line('.')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3787 :let end = search("^$") - 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3788 :let lines = getline(start, end)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3789
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3790 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3791 ComputeLnum()->getline()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3792
31164 7831da568864 patch 9.0.0916: getbufline() is inefficient for getting a single line Bram Moolenaar <Bram@vim.org> parents: 31139 diff changeset	3793 < To get lines from another buffer see \|getbufline()\| and
7831da568864 patch 9.0.0916: getbufline() is inefficient for getting a single line Bram Moolenaar <Bram@vim.org> parents: 31139 diff changeset	3794 \|getbufoneline()\|
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3795
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3796 getloclist({nr} [, {what}]) getloclist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3797 Returns a \|List\| with all the entries in the location list for
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3798 window {nr}. {nr} can be the window number or the \|window-ID\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3799 When {nr} is zero the current window is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3800
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3801 For a location list window, the displayed location list is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3802 returned. For an invalid window number {nr}, an empty list is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3803 returned. Otherwise, same as \|getqflist()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3804
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3805 If the optional {what} dictionary argument is supplied, then
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3806 returns the items listed in {what} as a dictionary. Refer to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3807 \|getqflist()\| for the supported items in {what}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3808
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3809 In addition to the items supported by \|getqflist()\| in {what},
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3810 the following item is supported by \|getloclist()\|:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3811
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3812 filewinid id of the window used to display files
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3813 from the location list. This field is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3814 applicable only when called from a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3815 location list window. See
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3816 \|location-list-file-window\| for more
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3817 details.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3818
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3819 Returns a \|Dictionary\| with default values if there is no
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3820 location list for the window {nr}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3821 Returns an empty Dictionary if window {nr} does not exist.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3822
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3823 Examples (See also \|getqflist-examples\|): >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3824 :echo getloclist(3, {'all': 0})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3825 :echo getloclist(5, {'filewinid': 0})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3826
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3827
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3828 getmarklist([{buf}]) getmarklist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3829 Without the {buf} argument returns a \|List\| with information
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3830 about all the global marks. \|mark\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3831
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3832 If the optional {buf} argument is specified, returns the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3833 local marks defined in buffer {buf}. For the use of {buf},
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	3834 see \|bufname()\|. If {buf} is invalid, an empty list is
f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	3835 returned.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3836
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3837 Each item in the returned List is a \|Dict\| with the following:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3838 mark name of the mark prefixed by "'"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3839 pos a \|List\| with the position of the mark:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3840 [bufnum, lnum, col, off]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3841 Refer to \|getpos()\| for more information.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3842 file file name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3843
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3844 Refer to \|getpos()\| for getting information about a specific
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3845 mark.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3846
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3847 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3848 GetBufnr()->getmarklist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3849
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3850 getmatches([{win}]) getmatches()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3851 Returns a \|List\| with all matches previously defined for the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3852 current window by \|matchadd()\| and the \|:match\| commands.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3853 \|getmatches()\| is useful in combination with \|setmatches()\|,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3854 as \|setmatches()\| can restore a list of matches saved by
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3855 \|getmatches()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3856 If {win} is specified, use the window with this number or
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	3857 window ID instead of the current window. If {win} is invalid,
f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	3858 an empty list is returned.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3859 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3860 :echo getmatches()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3861 < [{'group': 'MyGroup1', 'pattern': 'TODO',
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3862 'priority': 10, 'id': 1}, {'group': 'MyGroup2',
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3863 'pattern': 'FIXME', 'priority': 10, 'id': 2}] >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3864 :let m = getmatches()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3865 :call clearmatches()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3866 :echo getmatches()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3867 < [] >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3868 :call setmatches(m)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3869 :echo getmatches()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3870 < [{'group': 'MyGroup1', 'pattern': 'TODO',
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3871 'priority': 10, 'id': 1}, {'group': 'MyGroup2',
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3872 'pattern': 'FIXME', 'priority': 10, 'id': 2}] >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3873 :unlet m
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3874 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3875 getmousepos() getmousepos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3876 Returns a \|Dictionary\| with the last known position of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3877 mouse. This can be used in a mapping for a mouse click or in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3878 a filter of a popup window. The items are:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3879 screenrow screen row
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3880 screencol screen column
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3881 winid Window ID of the click
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3882 winrow row inside "winid"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3883 wincol column inside "winid"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3884 line text line inside "winid"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3885 column text column inside "winid"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3886 All numbers are 1-based.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3887
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3888 If not over a window, e.g. when in the command line, then only
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3889 "screenrow" and "screencol" are valid, the others are zero.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3890
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3891 When on the status line below a window or the vertical
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3892 separator right of a window, the "line" and "column" values
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3893 are zero.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3894
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3895 When the position is after the text then "column" is the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3896 length of the text in bytes plus one.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3897
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3898 If the mouse is over a popup window then that window is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3899
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3900 When using \|getchar()\| the Vim variables \|v:mouse_lnum\|,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3901 \|v:mouse_col\| and \|v:mouse_winid\| also provide these values.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3902
31093 004aee2845d2 patch 9.0.0881: cannot get the currently showing mouse shape Bram Moolenaar <Bram@vim.org> parents: 31057 diff changeset	3903 getmouseshape() getmouseshape()
004aee2845d2 patch 9.0.0881: cannot get the currently showing mouse shape Bram Moolenaar <Bram@vim.org> parents: 31057 diff changeset	3904 Returns the name of the currently showing mouse pointer.
004aee2845d2 patch 9.0.0881: cannot get the currently showing mouse shape Bram Moolenaar <Bram@vim.org> parents: 31057 diff changeset	3905 When the \|+mouseshape\| feature is not supported or the shape
004aee2845d2 patch 9.0.0881: cannot get the currently showing mouse shape Bram Moolenaar <Bram@vim.org> parents: 31057 diff changeset	3906 is unknown an empty string is returned.
004aee2845d2 patch 9.0.0881: cannot get the currently showing mouse shape Bram Moolenaar <Bram@vim.org> parents: 31057 diff changeset	3907 This function is mainly intended for testing.
004aee2845d2 patch 9.0.0881: cannot get the currently showing mouse shape Bram Moolenaar <Bram@vim.org> parents: 31057 diff changeset	3908
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3909 getpid()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3910 getpid() Return a Number which is the process ID of the Vim process.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3911 On Unix and MS-Windows this is a unique number, until Vim
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3912 exits.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3913
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3914 getpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3915 getpos({expr}) Get the position for String {expr}. For possible values of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3916 {expr} see \|line()\|. For getting the cursor position see
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3917 \|getcurpos()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3918 The result is a \|List\| with four numbers:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3919 [bufnum, lnum, col, off]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3920 "bufnum" is zero, unless a mark like '0 or 'A is used, then it
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3921 is the buffer number of the mark.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3922 "lnum" and "col" are the position in the buffer. The first
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3923 column is 1.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3924 The "off" number is zero, unless 'virtualedit' is used. Then
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3925 it is the offset in screen columns from the start of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3926 character. E.g., a position within a <Tab> or after the last
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3927 character.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3928 Note that for '< and '> Visual mode matters: when it is "V"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3929 (visual line mode) the column of '< is zero and the column of
26881 fb67cd7d30a7 patch 8.2.3969: value of MAXCOL not available in Vim script Bram Moolenaar <Bram@vim.org> parents: 26847 diff changeset	3930 '> is a large number equal to \|v:maxcol\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3931 The column number in the returned List is the byte position
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3932 within the line. To get the character position in the line,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3933 use \|getcharpos()\|.
26881 fb67cd7d30a7 patch 8.2.3969: value of MAXCOL not available in Vim script Bram Moolenaar <Bram@vim.org> parents: 26847 diff changeset	3934 A very large column number equal to \|v:maxcol\| can be returned,
fb67cd7d30a7 patch 8.2.3969: value of MAXCOL not available in Vim script Bram Moolenaar <Bram@vim.org> parents: 26847 diff changeset	3935 in which case it means "after the end of the line".
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	3936 If {expr} is invalid, returns a list with all zeros.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3937 This can be used to save and restore the position of a mark: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3938 let save_a_mark = getpos("'a")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3939 ...
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3940 call setpos("'a", save_a_mark)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3941 < Also see \|getcharpos()\|, \|getcurpos()\| and \|setpos()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3942
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3943 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3944 GetMark()->getpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3945
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3946 getqflist([{what}]) getqflist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3947 Returns a \|List\| with all the current quickfix errors. Each
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3948 list item is a dictionary with these entries:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3949 bufnr number of buffer that has the file name, use
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3950 bufname() to get the name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3951 module module name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3952 lnum line number in the buffer (first line is 1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3953 end_lnum
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3954 end of line number if the item is multiline
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3955 col column number (first column is 1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3956 end_col end of column number if the item has range
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3957 vcol \|TRUE\|: "col" is visual column
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3958 \|FALSE\|: "col" is byte index
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3959 nr error number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3960 pattern search pattern used to locate the error
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3961 text description of the error
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3962 type type of the error, 'E', '1', etc.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3963 valid \|TRUE\|: recognized error message
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3964
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3965 When there is no error list or it's empty, an empty list is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3966 returned. Quickfix list entries with a non-existing buffer
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3967 number are returned with "bufnr" set to zero (Note: some
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3968 functions accept buffer number zero for the alternate buffer,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3969 you may need to explicitly check for zero).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3970
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3971 Useful application: Find pattern matches in multiple files and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3972 do something with them: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3973 :vimgrep /theword/jg *.c
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3974 :for d in getqflist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3975 : echo bufname(d.bufnr) ':' d.lnum '=' d.text
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3976 :endfor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3977 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3978 If the optional {what} dictionary argument is supplied, then
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3979 returns only the items listed in {what} as a dictionary. The
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3980 following string items are supported in {what}:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3981 changedtick get the total number of changes made
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3982 to the list \|quickfix-changedtick\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3983 context get the \|quickfix-context\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3984 efm errorformat to use when parsing "lines". If
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3985 not present, then the 'errorformat' option
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3986 value is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3987 id get information for the quickfix list with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3988 \|quickfix-ID\|; zero means the id for the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3989 current list or the list specified by "nr"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3990 idx get information for the quickfix entry at this
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3991 index in the list specified by 'id' or 'nr'.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3992 If set to zero, then uses the current entry.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3993 See \|quickfix-index\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3994 items quickfix list entries
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3995 lines parse a list of lines using 'efm' and return
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3996 the resulting entries. Only a \|List\| type is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3997 accepted. The current quickfix list is not
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3998 modified. See \|quickfix-parse\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3999 nr get information for this quickfix list; zero
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4000 means the current quickfix list and "$" means
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4001 the last quickfix list
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4002 qfbufnr number of the buffer displayed in the quickfix
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4003 window. Returns 0 if the quickfix buffer is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4004 not present. See \|quickfix-buffer\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4005 size number of entries in the quickfix list
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4006 title get the list title \|quickfix-title\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4007 winid get the quickfix \|window-ID\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4008 all all of the above quickfix properties
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4009 Non-string items in {what} are ignored. To get the value of a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4010 particular item, set it to zero.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4011 If "nr" is not present then the current quickfix list is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4012 If both "nr" and a non-zero "id" are specified, then the list
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4013 specified by "id" is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4014 To get the number of lists in the quickfix stack, set "nr" to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4015 "$" in {what}. The "nr" value in the returned dictionary
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4016 contains the quickfix stack size.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4017 When "lines" is specified, all the other items except "efm"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4018 are ignored. The returned dictionary contains the entry
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4019 "items" with the list of entries.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4020
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4021 The returned dictionary contains the following entries:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4022 changedtick total number of changes made to the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4023 list \|quickfix-changedtick\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4024 context quickfix list context. See \|quickfix-context\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4025 If not present, set to "".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4026 id quickfix list ID \|quickfix-ID\|. If not
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4027 present, set to 0.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4028 idx index of the quickfix entry in the list. If not
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4029 present, set to 0.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4030 items quickfix list entries. If not present, set to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4031 an empty list.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4032 nr quickfix list number. If not present, set to 0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4033 qfbufnr number of the buffer displayed in the quickfix
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4034 window. If not present, set to 0.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4035 size number of entries in the quickfix list. If not
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4036 present, set to 0.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4037 title quickfix list title text. If not present, set
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4038 to "".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4039 winid quickfix \|window-ID\|. If not present, set to 0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4040
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4041 Examples (See also \|getqflist-examples\|): >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4042 :echo getqflist({'all': 1})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4043 :echo getqflist({'nr': 2, 'title': 1})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4044 :echo getqflist({'lines' : ["F1:10:L10"]})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4045 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4046 getreg([{regname} [, 1 [, {list}]]]) getreg()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4047 The result is a String, which is the contents of register
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4048 {regname}. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4049 :let cliptext = getreg('*')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4050 < When register {regname} was not set the result is an empty
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4051 string.
27537 063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27497 diff changeset	4052 The {regname} argument must be a string. E1162
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4053
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4054 getreg('=') returns the last evaluated value of the expression
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4055 register. (For use in maps.)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4056 getreg('=', 1) returns the expression itself, so that it can
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4057 be restored with \|setreg()\|. For other registers the extra
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4058 argument is ignored, thus you can always give it.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4059
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4060 If {list} is present and \|TRUE\|, the result type is changed
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4061 to \|List\|. Each list item is one text line. Use it if you care
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4062 about zero bytes possibly present inside register: without
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4063 third argument both NLs and zero bytes are represented as NLs
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4064 (see \|NL-used-for-Nul\|).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4065 When the register was not set an empty list is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4066
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4067 If {regname} is "", the unnamed register '"' is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4068 If {regname} is not specified, \|v:register\| is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4069 In \|Vim9-script\| {regname} must be one character.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4070
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4071 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4072 GetRegname()->getreg()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4073
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4074 getreginfo([{regname}]) getreginfo()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4075 Returns detailed information about register {regname} as a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4076 Dictionary with the following entries:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4077 regcontents List of lines contained in register
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4078 {regname}, like
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4079 \|getreg\|({regname}, 1, 1).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4080 regtype the type of register {regname}, as in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4081 \|getregtype()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4082 isunnamed Boolean flag, v:true if this register
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4083 is currently pointed to by the unnamed
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4084 register.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4085 points_to for the unnamed register, gives the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4086 single letter name of the register
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4087 currently pointed to (see \|quotequote\|).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4088 For example, after deleting a line
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4089 with `dd`, this field will be "1",
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4090 which is the register that got the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4091 deleted text.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4092
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4093 The {regname} argument is a string. If {regname} is invalid
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4094 or not set, an empty Dictionary will be returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4095 If {regname} is "" or "@", the unnamed register '"' is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4096 If {regname} is not specified, \|v:register\| is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4097 The returned Dictionary can be passed to \|setreg()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4098 In \|Vim9-script\| {regname} must be one character.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4099
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4100 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4101 GetRegname()->getreginfo()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4102
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4103 getregtype([{regname}]) getregtype()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4104 The result is a String, which is type of register {regname}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4105 The value will be one of:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4106 "v" for \|characterwise\| text
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4107 "V" for \|linewise\| text
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4108 "<CTRL-V>{width}" for \|blockwise-visual\| text
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4109 "" for an empty or unknown register
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4110 <CTRL-V> is one character with value 0x16.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4111 The {regname} argument is a string. If {regname} is "", the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4112 unnamed register '"' is used. If {regname} is not specified,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4113 \|v:register\| is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4114 In \|Vim9-script\| {regname} must be one character.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4115
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4116 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4117 GetRegname()->getregtype()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4118
29861 8dca33bca038 patch 9.0.0269: getscriptinfo() does not include the version Bram Moolenaar <Bram@vim.org> parents: 29853 diff changeset	4119 getscriptinfo([{opts}) getscriptinfo()
29810 761631155a90 patch 9.0.0244: cannot easily get the list of sourced scripts Bram Moolenaar <Bram@vim.org> parents: 29779 diff changeset	4120 Returns a \|List\| with information about all the sourced Vim
29828 6b7020f3d856 patch 9.0.0253: a symlink to an autoload script results in two entries Bram Moolenaar <Bram@vim.org> parents: 29810 diff changeset	4121 scripts in the order they were sourced, like what
6b7020f3d856 patch 9.0.0253: a symlink to an autoload script results in two entries Bram Moolenaar <Bram@vim.org> parents: 29810 diff changeset	4122 `:scriptnames` shows.
29810 761631155a90 patch 9.0.0244: cannot easily get the list of sourced scripts Bram Moolenaar <Bram@vim.org> parents: 29779 diff changeset	4123
29930 cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4124 The optional Dict argument {opts} supports the following
cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4125 optional items:
cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4126 name Script name match pattern. If specified,
cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4127 and "sid" is not specified, information about
cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4128 scripts with name that match the pattern
cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4129 "name" are returned.
cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4130 sid Script ID \|<SID>\|. If specified, only
cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4131 information about the script with ID "sid" is
cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4132 returned and "name" is ignored.
cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4133
29810 761631155a90 patch 9.0.0244: cannot easily get the list of sourced scripts Bram Moolenaar <Bram@vim.org> parents: 29779 diff changeset	4134 Each item in the returned List is a \|Dict\| with the following
761631155a90 patch 9.0.0244: cannot easily get the list of sourced scripts Bram Moolenaar <Bram@vim.org> parents: 29779 diff changeset	4135 items:
29930 cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4136 autoload Set to TRUE for a script that was used with
29828 6b7020f3d856 patch 9.0.0253: a symlink to an autoload script results in two entries Bram Moolenaar <Bram@vim.org> parents: 29810 diff changeset	4137 `import autoload` but was not actually sourced
6b7020f3d856 patch 9.0.0253: a symlink to an autoload script results in two entries Bram Moolenaar <Bram@vim.org> parents: 29810 diff changeset	4138 yet (see \|import-autoload\|).
29930 cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4139 functions List of script-local function names defined in
cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4140 the script. Present only when a particular
cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4141 script is specified using the "sid" item in
cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4142 {opts}.
cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4143 name Vim script file name.
cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4144 sid Script ID \|<SID>\|.
cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4145 sourced Script ID of the actually sourced script that
29840 b15334beeaa4 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29828 diff changeset	4146 this script name links to, if any, otherwise
b15334beeaa4 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29828 diff changeset	4147 zero
29930 cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4148 variables A dictionary with the script-local variables.
31579 7d68a90cbf5c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31503 diff changeset	4149 Present only when a particular script is
29930 cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4150 specified using the "sid" item in {opts}.
cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4151 Note that this is a copy, the value of
cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4152 script-local variables cannot be changed using
cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4153 this dictionary.
cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4154 version Vimscript version (\|scriptversion\|)
cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4155
cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4156 Examples: >
cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4157 :echo getscriptinfo({'name': 'myscript'})
cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4158 :echo getscriptinfo({'sid': 15}).variables
cd573d7bc30d patch 9.0.0303: it is not easy to get information about a script Bram Moolenaar <Bram@vim.org> parents: 29894 diff changeset	4159 <
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4160 gettabinfo([{tabnr}]) gettabinfo()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4161 If {tabnr} is not specified, then information about all the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4162 tab pages is returned as a \|List\|. Each List item is a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4163 \|Dictionary\|. Otherwise, {tabnr} specifies the tab page
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4164 number and information about that one is returned. If the tab
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4165 page does not exist an empty List is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4166
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4167 Each List item is a \|Dictionary\| with the following entries:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4168 tabnr tab page number.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4169 variables a reference to the dictionary with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4170 tabpage-local variables
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4171 windows List of \|window-ID\|s in the tab page.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4172
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4173 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4174 GetTabnr()->gettabinfo()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4175
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4176 gettabvar({tabnr}, {varname} [, {def}]) gettabvar()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4177 Get the value of a tab-local variable {varname} in tab page
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4178 {tabnr}. \|t:var\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4179 Tabs are numbered starting with one.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4180 The {varname} argument is a string. When {varname} is empty a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4181 dictionary with all tab-local variables is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4182 Note that the name without "t:" must be used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4183 When the tab or variable doesn't exist {def} or an empty
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4184 string is returned, there is no error message.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4185
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4186 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4187 GetTabnr()->gettabvar(varname)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4188
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4189 gettabwinvar({tabnr}, {winnr}, {varname} [, {def}]) gettabwinvar()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4190 Get the value of window-local variable {varname} in window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4191 {winnr} in tab page {tabnr}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4192 The {varname} argument is a string. When {varname} is empty a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4193 dictionary with all window-local variables is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4194 When {varname} is equal to "&" get the values of all
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4195 window-local options in a \|Dictionary\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4196 Otherwise, when {varname} starts with "&" get the value of a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4197 window-local option.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4198 Note that {varname} must be the name without "w:".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4199 Tabs are numbered starting with one. For the current tabpage
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4200 use \|getwinvar()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4201 {winnr} can be the window number or the \|window-ID\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4202 When {winnr} is zero the current window is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4203 This also works for a global option, buffer-local option and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4204 window-local option, but it doesn't work for a global variable
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4205 or buffer-local variable.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4206 When the tab, window or variable doesn't exist {def} or an
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4207 empty string is returned, there is no error message.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4208 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4209 :let list_is_on = gettabwinvar(1, 2, '&list')
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	4210 :echo "myvar = " .. gettabwinvar(3, 1, 'myvar')
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4211 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4212 To obtain all window-local variables use: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4213 gettabwinvar({tabnr}, {winnr}, '&')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4214
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4215 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4216 GetTabnr()->gettabwinvar(winnr, varname)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4217
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4218 gettagstack([{winnr}]) gettagstack()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4219 The result is a Dict, which is the tag stack of window {winnr}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4220 {winnr} can be the window number or the \|window-ID\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4221 When {winnr} is not specified, the current window is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4222 When window {winnr} doesn't exist, an empty Dict is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4223
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4224 The returned dictionary contains the following entries:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4225 curidx Current index in the stack. When at
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4226 top of the stack, set to (length + 1).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4227 Index of bottom of the stack is 1.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4228 items List of items in the stack. Each item
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4229 is a dictionary containing the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4230 entries described below.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4231 length Number of entries in the stack.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4232
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4233 Each item in the stack is a dictionary with the following
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4234 entries:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4235 bufnr buffer number of the current jump
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4236 from cursor position before the tag jump.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4237 See \|getpos()\| for the format of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4238 returned list.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4239 matchnr current matching tag number. Used when
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4240 multiple matching tags are found for a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4241 name.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4242 tagname name of the tag
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4243
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4244 See \|tagstack\| for more information about the tag stack.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4245
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4246 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4247 GetWinnr()->gettagstack()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4248
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4249
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4250 gettext({text}) gettext()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4251 Translate String {text} if possible.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4252 This is mainly for use in the distributed Vim scripts. When
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4253 generating message translations the {text} is extracted by
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4254 xgettext, the translator can add the translated message in the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4255 .po file and Vim will lookup the translation when gettext() is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4256 called.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4257 For {text} double quoted strings are preferred, because
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4258 xgettext does not understand escaping in single quoted
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4259 strings.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4260
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4261
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4262 getwininfo([{winid}]) getwininfo()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4263 Returns information about windows as a \|List\| with Dictionaries.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4264
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4265 If {winid} is given Information about the window with that ID
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4266 is returned, as a \|List\| with one item. If the window does not
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4267 exist the result is an empty list.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4268
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4269 Without {winid} information about all the windows in all the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4270 tab pages is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4271
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4272 Each List item is a \|Dictionary\| with the following entries:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4273 botline last complete displayed buffer line
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4274 bufnr number of buffer in the window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4275 height window height (excluding winbar)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4276 loclist 1 if showing a location list
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4277 {only with the +quickfix feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4278 quickfix 1 if quickfix or location list window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4279 {only with the +quickfix feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4280 terminal 1 if a terminal window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4281 {only with the +terminal feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4282 tabnr tab page number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4283 topline first displayed buffer line
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4284 variables a reference to the dictionary with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4285 window-local variables
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4286 width window width
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4287 winbar 1 if the window has a toolbar, 0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4288 otherwise
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4289 wincol leftmost screen column of the window;
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4290 "col" from \|win_screenpos()\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4291 textoff number of columns occupied by any
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4292 'foldcolumn', 'signcolumn' and line
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4293 number in front of the text
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4294 winid \|window-ID\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4295 winnr window number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4296 winrow topmost screen line of the window;
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4297 "row" from \|win_screenpos()\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4298
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4299 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4300 GetWinnr()->getwininfo()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4301
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4302 getwinpos([{timeout}]) getwinpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4303 The result is a \|List\| with two numbers, the result of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4304 \|getwinposx()\| and \|getwinposy()\| combined:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4305 [x-pos, y-pos]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4306 {timeout} can be used to specify how long to wait in msec for
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4307 a response from the terminal. When omitted 100 msec is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4308 Use a longer time for a remote terminal.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4309 When using a value less than 10 and no response is received
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4310 within that time, a previously reported position is returned,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4311 if available. This can be used to poll for the position and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4312 do some work in the meantime: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4313 while 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4314 let res = getwinpos(1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4315 if res[0] >= 0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4316 break
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4317 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4318 " Do some work here
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4319 endwhile
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4320 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4321
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4322 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4323 GetTimeout()->getwinpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4324 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4325 getwinposx()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4326 getwinposx() The result is a Number, which is the X coordinate in pixels of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4327 the left hand side of the GUI Vim window. Also works for an
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4328 xterm (uses a timeout of 100 msec).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4329 The result will be -1 if the information is not available.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4330 The value can be used with `:winpos`.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4331
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4332 getwinposy()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4333 getwinposy() The result is a Number, which is the Y coordinate in pixels of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4334 the top of the GUI Vim window. Also works for an xterm (uses
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4335 a timeout of 100 msec).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4336 The result will be -1 if the information is not available.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4337 The value can be used with `:winpos`.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4338
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4339 getwinvar({winnr}, {varname} [, {def}]) getwinvar()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4340 Like \|gettabwinvar()\| for the current tabpage.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4341 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4342 :let list_is_on = getwinvar(2, '&list')
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	4343 :echo "myvar = " .. getwinvar(1, 'myvar')
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4344
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4345 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4346 GetWinnr()->getwinvar(varname)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4347 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4348 glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) glob()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4349 Expand the file wildcards in {expr}. See \|wildcards\| for the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4350 use of special characters.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4351
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4352 Unless the optional {nosuf} argument is given and is \|TRUE\|,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4353 the 'suffixes' and 'wildignore' options apply: Names matching
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4354 one of the patterns in 'wildignore' will be skipped and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4355 'suffixes' affect the ordering of matches.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4356 'wildignorecase' always applies.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4357
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4358 When {list} is present and it is \|TRUE\| the result is a \|List\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4359 with all matching files. The advantage of using a List is,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4360 you also get filenames containing newlines correctly.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4361 Otherwise the result is a String and when there are several
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4362 matches, they are separated by <NL> characters.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4363
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4364 If the expansion fails, the result is an empty String or List.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4365
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4366 You can also use \|readdir()\| if you need to do complicated
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4367 things, such as limiting the number of matches.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4368
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4369 A name for a non-existing file is not included. A symbolic
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4370 link is only included if it points to an existing file.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4371 However, when the {alllinks} argument is present and it is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4372 \|TRUE\| then all symbolic links are included.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4373
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4374 For most systems backticks can be used to get files names from
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4375 any external command. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4376 :let tagfiles = glob("`find . -name tags -print`")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4377 :let &tags = substitute(tagfiles, "\n", ",", "g")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4378 < The result of the program inside the backticks should be one
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4379 item per line. Spaces inside an item are allowed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4380
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4381 See \|expand()\| for expanding special Vim variables. See
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4382 \|system()\| for getting the raw output of an external command.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4383
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4384 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4385 GetExpr()->glob()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4386
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4387 glob2regpat({string}) glob2regpat()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4388 Convert a file pattern, as used by glob(), into a search
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4389 pattern. The result can be used to match with a string that
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4390 is a file name. E.g. >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4391 if filename =~ glob2regpat('Make*.mak')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4392 < This is equivalent to: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4393 if filename =~ '^Make.*\.mak$'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4394 < When {string} is an empty string the result is "^$", match an
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4395 empty string.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4396 Note that the result depends on the system. On MS-Windows
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4397 a backslash usually means a path separator.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4398
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4399 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4400 GetExpr()->glob2regpat()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4401 < globpath()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4402 globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4403 Perform glob() for String {expr} on all directories in {path}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4404 and concatenate the results. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4405 :echo globpath(&rtp, "syntax/c.vim")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4406 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4407 {path} is a comma-separated list of directory names. Each
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4408 directory name is prepended to {expr} and expanded like with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4409 \|glob()\|. A path separator is inserted when needed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4410 To add a comma inside a directory name escape it with a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4411 backslash. Note that on MS-Windows a directory may have a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4412 trailing backslash, remove it if you put a comma after it.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4413 If the expansion fails for one of the directories, there is no
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4414 error message.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4415
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4416 Unless the optional {nosuf} argument is given and is \|TRUE\|,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4417 the 'suffixes' and 'wildignore' options apply: Names matching
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4418 one of the patterns in 'wildignore' will be skipped and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4419 'suffixes' affect the ordering of matches.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4420
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4421 When {list} is present and it is \|TRUE\| the result is a \|List\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4422 with all matching files. The advantage of using a List is, you
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4423 also get filenames containing newlines correctly. Otherwise
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4424 the result is a String and when there are several matches,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4425 they are separated by <NL> characters. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4426 :echo globpath(&rtp, "syntax/c.vim", 0, 1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4427 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4428 {alllinks} is used as with \|glob()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4429
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4430 The "**" item can be used to search in a directory tree.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4431 For example, to find all "README.txt" files in the directories
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4432 in 'runtimepath' and below: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4433 :echo globpath(&rtp, "**/README.txt")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4434 < Upwards search and limiting the depth of "**" is not
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4435 supported, thus using 'path' will not always work properly.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4436
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4437 Can also be used as a \|method\|, the base is passed as the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4438 second argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4439 GetExpr()->globpath(&rtp)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4440 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4441 has()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4442 has({feature} [, {check}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4443 When {check} is omitted or is zero: The result is a Number,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4444 which is 1 if the feature {feature} is supported, zero
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4445 otherwise. The {feature} argument is a string, case is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4446 ignored. See \|feature-list\| below.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4447
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4448 When {check} is present and not zero: The result is a Number,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4449 which is 1 if the feature {feature} could ever be supported,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4450 zero otherwise. This is useful to check for a typo in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4451 {feature} and to detect dead code. Keep in mind that an older
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4452 Vim version will not know about a feature added later and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4453 features that have been abandoned will not be known by the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4454 current Vim version.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4455
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4456 Also see \|exists()\| and \|exists_compiled()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4457
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4458 Note that to skip code that has a syntax error when the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4459 feature is not available, Vim may skip the rest of the line
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4460 and miss a following `endif`. Therefore put the `endif` on a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4461 separate line: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4462 if has('feature')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4463 let x = this->breaks->without->the->feature
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4464 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4465 < If the `endif` would be moved to the second line as "\| endif" it
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4466 would not be found.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4467
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4468
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4469 has_key({dict}, {key}) has_key()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4470 The result is a Number, which is TRUE if \|Dictionary\| {dict}
29779 90a966f5c77a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29724 diff changeset	4471 has an entry with key {key}. FALSE otherwise.
90a966f5c77a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29724 diff changeset	4472 The {key} argument is a string. In \|Vim9\| script a number is
90a966f5c77a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29724 diff changeset	4473 also accepted (and converted to a string) but no other types.
90a966f5c77a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29724 diff changeset	4474 In legacy script the usual automatic conversion to string is
90a966f5c77a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29724 diff changeset	4475 done.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4476
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4477 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4478 mydict->has_key(key)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4479
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4480 haslocaldir([{winnr} [, {tabnr}]]) haslocaldir()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4481 The result is a Number:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4482 1 when the window has set a local directory via \|:lcd\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4483 2 when the tab-page has set a local directory via \|:tcd\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4484 0 otherwise.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4485
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4486 Without arguments use the current window.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4487 With {winnr} use this window in the current tab page.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4488 With {winnr} and {tabnr} use the window in the specified tab
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4489 page.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4490 {winnr} can be the window number or the \|window-ID\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4491 If {winnr} is -1 it is ignored and only the tabpage is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4492 Return 0 if the arguments are invalid.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4493 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4494 if haslocaldir() == 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4495 " window local directory case
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4496 elseif haslocaldir() == 2
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4497 " tab-local directory case
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4498 else
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4499 " global directory case
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4500 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4501
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4502 " current window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4503 :echo haslocaldir()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4504 :echo haslocaldir(0)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4505 :echo haslocaldir(0, 0)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4506 " window n in current tab page
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4507 :echo haslocaldir(n)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4508 :echo haslocaldir(n, 0)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4509 " window n in tab page m
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4510 :echo haslocaldir(n, m)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4511 " tab page m
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4512 :echo haslocaldir(-1, m)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4513 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4514 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4515 GetWinnr()->haslocaldir()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4516
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4517 hasmapto({what} [, {mode} [, {abbr}]]) hasmapto()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4518 The result is a Number, which is TRUE if there is a mapping
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4519 that contains {what} in somewhere in the rhs (what it is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4520 mapped to) and this mapping exists in one of the modes
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4521 indicated by {mode}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4522 The arguments {what} and {mode} are strings.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4523 When {abbr} is there and it is \|TRUE\| use abbreviations
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4524 instead of mappings. Don't forget to specify Insert and/or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4525 Command-line mode.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4526 Both the global mappings and the mappings local to the current
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4527 buffer are checked for a match.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4528 If no matching mapping is found FALSE is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4529 The following characters are recognized in {mode}:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4530 n Normal mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4531 v Visual and Select mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4532 x Visual mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4533 s Select mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4534 o Operator-pending mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4535 i Insert mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4536 l Language-Argument ("r", "f", "t", etc.)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4537 c Command-line mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4538 When {mode} is omitted, "nvo" is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4539
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4540 This function is useful to check if a mapping already exists
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4541 to a function in a Vim script. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4542 :if !hasmapto('\ABCdoit')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4543 : map <Leader>d \ABCdoit
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4544 :endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4545 < This installs the mapping to "\ABCdoit" only if there isn't
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4546 already a mapping to "\ABCdoit".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4547
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4548 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4549 GetRHS()->hasmapto()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4550
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4551 histadd({history}, {item}) histadd()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4552 Add the String {item} to the history {history} which can be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4553 one of: hist-names
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4554 "cmd" or ":" command line history
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4555 "search" or "/" search pattern history
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4556 "expr" or "=" typed expression history
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4557 "input" or "@" input line history
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4558 "debug" or ">" debug command history
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4559 empty the current or last used history
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4560 The {history} string does not need to be the whole name, one
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4561 character is sufficient.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4562 If {item} does already exist in the history, it will be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4563 shifted to become the newest entry.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4564 The result is a Number: TRUE if the operation was successful,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4565 otherwise FALSE is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4566
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4567 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4568 :call histadd("input", strftime("%Y %b %d"))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4569 :let date=input("Enter date: ")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4570 < This function is not available in the \|sandbox\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4571
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4572 Can also be used as a \|method\|, the base is passed as the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4573 second argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4574 GetHistory()->histadd('search')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4575
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4576 histdel({history} [, {item}]) histdel()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4577 Clear {history}, i.e. delete all its entries. See \|hist-names\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4578 for the possible values of {history}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4579
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4580 If the parameter {item} evaluates to a String, it is used as a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4581 regular expression. All entries matching that expression will
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4582 be removed from the history (if there are any).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4583 Upper/lowercase must match, unless "\c" is used \|/\c\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4584 If {item} evaluates to a Number, it will be interpreted as
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4585 an index, see \|:history-indexing\|. The respective entry will
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4586 be removed if it exists.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4587
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4588 The result is TRUE for a successful operation, otherwise FALSE
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4589 is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4590
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4591 Examples:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4592 Clear expression register history: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4593 :call histdel("expr")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4594 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4595 Remove all entries starting with "*" from the search history: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4596 :call histdel("/", '^\*')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4597 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4598 The following three are equivalent: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4599 :call histdel("search", histnr("search"))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4600 :call histdel("search", -1)
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	4601 :call histdel("search", '^' .. histget("search", -1) .. '$')
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4602 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4603 To delete the last search pattern and use the last-but-one for
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4604 the "n" command and 'hlsearch': >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4605 :call histdel("search", -1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4606 :let @/ = histget("search", -1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4607 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4608 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4609 GetHistory()->histdel()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4610
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4611 histget({history} [, {index}]) histget()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4612 The result is a String, the entry with Number {index} from
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4613 {history}. See \|hist-names\| for the possible values of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4614 {history}, and \|:history-indexing\| for {index}. If there is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4615 no such entry, an empty String is returned. When {index} is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4616 omitted, the most recent item from the history is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4617
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4618 Examples:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4619 Redo the second last search from history. >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	4620 :execute '/' .. histget("search", -2)
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4621
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4622 < Define an Ex command ":H {num}" that supports re-execution of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4623 the {num}th entry from the output of \|:history\|. >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4624 :command -nargs=1 H execute histget("cmd", 0+<args>)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4625 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4626 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4627 GetHistory()->histget()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4628
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4629 histnr({history}) histnr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4630 The result is the Number of the current entry in {history}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4631 See \|hist-names\| for the possible values of {history}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4632 If an error occurred, -1 is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4633
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4634 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4635 :let inp_index = histnr("expr")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4636
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4637 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4638 GetHistory()->histnr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4639 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4640 hlexists({name}) hlexists()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4641 The result is a Number, which is TRUE if a highlight group
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4642 called {name} exists. This is when the group has been
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4643 defined in some way. Not necessarily when highlighting has
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4644 been defined for it, it may also have been used for a syntax
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4645 item.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4646 highlight_exists()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4647 Obsolete name: highlight_exists().
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4648
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4649 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4650 GetName()->hlexists()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4651 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4652 hlget([{name} [, {resolve}]]) hlget()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4653 Returns a List of all the highlight group attributes. If the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4654 optional {name} is specified, then returns a List with only
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4655 the attributes of the specified highlight group. Returns an
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4656 empty List if the highlight group {name} is not present.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4657
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4658 If the optional {resolve} argument is set to v:true and the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4659 highlight group {name} is linked to another group, then the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4660 link is resolved recursively and the attributes of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4661 resolved highlight group are returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4662
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4663 Each entry in the returned List is a Dictionary with the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4664 following items:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4665 cleared boolean flag, set to v:true if the highlight
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4666 group attributes are cleared or not yet
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4667 specified. See \|highlight-clear\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4668 cterm cterm attributes. See \|highlight-cterm\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4669 ctermbg cterm background color.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4670 See \|highlight-ctermbg\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4671 ctermfg cterm foreground color.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4672 See \|highlight-ctermfg\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4673 ctermul cterm underline color. See \|highlight-ctermul\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4674 default boolean flag, set to v:true if the highlight
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4675 group link is a default link. See
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4676 \|highlight-default\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4677 font highlight group font. See \|highlight-font\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4678 gui gui attributes. See \|highlight-gui\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4679 guibg gui background color. See \|highlight-guibg\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4680 guifg gui foreground color. See \|highlight-guifg\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4681 guisp gui special color. See \|highlight-guisp\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4682 id highlight group ID.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4683 linksto linked highlight group name.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4684 See \|:highlight-link\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4685 name highlight group name. See \|group-name\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4686 start start terminal keycode. See \|highlight-start\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4687 stop stop terminal keycode. See \|highlight-stop\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4688 term term attributes. See \|highlight-term\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4689
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4690 The 'term', 'cterm' and 'gui' items in the above Dictionary
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4691 have a dictionary value with the following optional boolean
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4692 items: 'bold', 'standout', 'underline', 'undercurl', 'italic',
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4693 'reverse', 'inverse' and 'strikethrough'.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4694
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4695 Example(s): >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4696 :echo hlget()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4697 :echo hlget('ModeMsg')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4698 :echo hlget('Number', v:true)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4699 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4700 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4701 GetName()->hlget()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4702 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4703 hlset({list}) hlset()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4704 Creates or modifies the attributes of a List of highlight
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4705 groups. Each item in {list} is a dictionary containing the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4706 attributes of a highlight group. See \|hlget()\| for the list of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4707 supported items in this dictionary.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4708
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4709 In addition to the items described in \|hlget()\|, the following
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4710 additional items are supported in the dictionary:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4711
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4712 force boolean flag to force the creation of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4713 a link for an existing highlight group
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4714 with attributes.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4715
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4716 The highlight group is identified using the 'name' item and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4717 the 'id' item (if supplied) is ignored. If a highlight group
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4718 with a specified name doesn't exist, then it is created.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4719 Otherwise the attributes of an existing highlight group are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4720 modified.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4721
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4722 If an empty dictionary value is used for the 'term' or 'cterm'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4723 or 'gui' entries, then the corresponding attributes are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4724 cleared. If the 'cleared' item is set to v:true, then all the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4725 attributes of the highlight group are cleared.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4726
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4727 The 'linksto' item can be used to link a highlight group to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4728 another highlight group. See \|:highlight-link\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4729
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4730 Returns zero for success, -1 for failure.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4731
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4732 Example(s): >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4733 " add bold attribute to the Visual highlight group
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4734 :call hlset([#{name: 'Visual',
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4735 \ term: #{reverse: 1 , bold: 1}}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4736 :call hlset([#{name: 'Type', guifg: 'DarkGreen'}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4737 :let l = hlget()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4738 :call hlset(l)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4739 " clear the Search highlight group
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4740 :call hlset([#{name: 'Search', cleared: v:true}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4741 " clear the 'term' attributes for a highlight group
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4742 :call hlset([#{name: 'Title', term: {}}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4743 " create the MyHlg group linking it to DiffAdd
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4744 :call hlset([#{name: 'MyHlg', linksto: 'DiffAdd'}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4745 " remove the MyHlg group link
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4746 :call hlset([#{name: 'MyHlg', linksto: 'NONE'}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4747 " clear the attributes and a link
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4748 :call hlset([#{name: 'MyHlg', cleared: v:true,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4749 \ linksto: 'NONE'}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4750 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4751 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4752 GetAttrList()->hlset()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4753 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4754 hlID()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4755 hlID({name}) The result is a Number, which is the ID of the highlight group
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4756 with name {name}. When the highlight group doesn't exist,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4757 zero is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4758 This can be used to retrieve information about the highlight
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4759 group. For example, to get the background color of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4760 "Comment" group: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4761 :echo synIDattr(synIDtrans(hlID("Comment")), "bg")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4762 < highlightID()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4763 Obsolete name: highlightID().
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4764
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4765 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4766 GetName()->hlID()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4767
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4768 hostname() hostname()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4769 The result is a String, which is the name of the machine on
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4770 which Vim is currently running. Machine names greater than
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4771 256 characters long are truncated.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4772
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4773 iconv({string}, {from}, {to}) iconv()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4774 The result is a String, which is the text {string} converted
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4775 from encoding {from} to encoding {to}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4776 When the conversion completely fails an empty string is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4777 returned. When some characters could not be converted they
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4778 are replaced with "?".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4779 The encoding names are whatever the iconv() library function
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4780 can accept, see ":!man 3 iconv".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4781 Most conversions require Vim to be compiled with the \|+iconv\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4782 feature. Otherwise only UTF-8 to latin1 conversion and back
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4783 can be done.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4784 This can be used to display messages with special characters,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4785 no matter what 'encoding' is set to. Write the message in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4786 UTF-8 and use: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4787 echo iconv(utf8_str, "utf-8", &enc)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4788 < Note that Vim uses UTF-8 for all Unicode encodings, conversion
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4789 from/to UCS-2 is automatically changed to use UTF-8. You
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4790 cannot use UCS-2 in a string anyway, because of the NUL bytes.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4791
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4792 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4793 GetText()->iconv('latin1', 'utf-8')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4794 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4795 indent()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4796 indent({lnum}) The result is a Number, which is indent of line {lnum} in the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4797 current buffer. The indent is counted in spaces, the value
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4798 of 'tabstop' is relevant. {lnum} is used just like in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4799 \|getline()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4800 When {lnum} is invalid -1 is returned. In \|Vim9\| script an
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4801 error is given.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4802
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4803 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4804 GetLnum()->indent()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4805
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4806 index({object}, {expr} [, {start} [, {ic}]]) index()
29712 bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4807 Find {expr} in {object} and return its index. See
29724 66f9877b8aab patch 9.0.0202: code and help for indexof() is not ideal Bram Moolenaar <Bram@vim.org> parents: 29712 diff changeset	4808 \|indexof()\| for using a lambda to select the item.
29712 bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4809
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4810 If {object} is a \|List\| return the lowest index where the item
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4811 has a value equal to {expr}. There is no automatic
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4812 conversion, so the String "4" is different from the Number 4.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4813 And the number 4 is different from the Float 4.0. The value
29712 bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4814 of 'ignorecase' is not used here, case matters as indicated by
bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4815 the {ic} argument.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4816
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4817 If {object} is \|Blob\| return the lowest index where the byte
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4818 value is equal to {expr}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4819
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4820 If {start} is given then start looking at the item with index
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4821 {start} (may be negative for an item relative to the end).
29712 bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4822
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4823 When {ic} is given and it is \|TRUE\|, ignore case. Otherwise
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4824 case must match.
29712 bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4825
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4826 -1 is returned when {expr} is not found in {object}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4827 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4828 :let idx = index(words, "the")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4829 :if index(numbers, 123) >= 0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4830
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4831 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4832 GetObject()->index(what)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4833
29724 66f9877b8aab patch 9.0.0202: code and help for indexof() is not ideal Bram Moolenaar <Bram@vim.org> parents: 29712 diff changeset	4834 indexof({object}, {expr} [, {opts}]) indexof()
66f9877b8aab patch 9.0.0202: code and help for indexof() is not ideal Bram Moolenaar <Bram@vim.org> parents: 29712 diff changeset	4835 Returns the index of an item in {object} where {expr} is
66f9877b8aab patch 9.0.0202: code and help for indexof() is not ideal Bram Moolenaar <Bram@vim.org> parents: 29712 diff changeset	4836 v:true. {object} must be a \|List\| or a \|Blob\|.
66f9877b8aab patch 9.0.0202: code and help for indexof() is not ideal Bram Moolenaar <Bram@vim.org> parents: 29712 diff changeset	4837
29712 bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4838 If {object} is a \|List\|, evaluate {expr} for each item in the
29724 66f9877b8aab patch 9.0.0202: code and help for indexof() is not ideal Bram Moolenaar <Bram@vim.org> parents: 29712 diff changeset	4839 List until the expression is v:true and return the index of
66f9877b8aab patch 9.0.0202: code and help for indexof() is not ideal Bram Moolenaar <Bram@vim.org> parents: 29712 diff changeset	4840 this item.
29712 bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4841
bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4842 If {object} is a \|Blob\| evaluate {expr} for each byte in the
29724 66f9877b8aab patch 9.0.0202: code and help for indexof() is not ideal Bram Moolenaar <Bram@vim.org> parents: 29712 diff changeset	4843 Blob until the expression is v:true and return the index of
66f9877b8aab patch 9.0.0202: code and help for indexof() is not ideal Bram Moolenaar <Bram@vim.org> parents: 29712 diff changeset	4844 this byte.
29712 bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4845
bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4846 {expr} must be a \|string\| or \|Funcref\|.
bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4847
bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4848 If {expr} is a \|string\|: If {object} is a \|List\|, inside
bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4849 {expr} \|v:key\| has the index of the current List item and
bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4850 \|v:val\| has the value of the item. If {object} is a \|Blob\|,
bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4851 inside {expr} \|v:key\| has the index of the current byte and
bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4852 \|v:val\| has the byte value.
bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4853
bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4854 If {expr} is a \|Funcref\| it must take two arguments:
bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4855 1. the key or the index of the current item.
bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4856 2. the value of the current item.
bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4857 The function must return \|TRUE\| if the item is found and the
bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4858 search should stop.
bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4859
29724 66f9877b8aab patch 9.0.0202: code and help for indexof() is not ideal Bram Moolenaar <Bram@vim.org> parents: 29712 diff changeset	4860 The optional argument {opts} is a Dict and supports the
29712 bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4861 following items:
29724 66f9877b8aab patch 9.0.0202: code and help for indexof() is not ideal Bram Moolenaar <Bram@vim.org> parents: 29712 diff changeset	4862 startidx start evaluating {expr} at the item with this
66f9877b8aab patch 9.0.0202: code and help for indexof() is not ideal Bram Moolenaar <Bram@vim.org> parents: 29712 diff changeset	4863 index; may be negative for an item relative to
66f9877b8aab patch 9.0.0202: code and help for indexof() is not ideal Bram Moolenaar <Bram@vim.org> parents: 29712 diff changeset	4864 the end
29712 bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4865 Returns -1 when {expr} evaluates to v:false for all the items.
bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4866 Example: >
29724 66f9877b8aab patch 9.0.0202: code and help for indexof() is not ideal Bram Moolenaar <Bram@vim.org> parents: 29712 diff changeset	4867 :let l = [#{n: 10}, #{n: 20}, #{n: 30}]
66f9877b8aab patch 9.0.0202: code and help for indexof() is not ideal Bram Moolenaar <Bram@vim.org> parents: 29712 diff changeset	4868 :echo indexof(l, "v:val.n == 20")
66f9877b8aab patch 9.0.0202: code and help for indexof() is not ideal Bram Moolenaar <Bram@vim.org> parents: 29712 diff changeset	4869 :echo indexof(l, {i, v -> v.n == 30})
66f9877b8aab patch 9.0.0202: code and help for indexof() is not ideal Bram Moolenaar <Bram@vim.org> parents: 29712 diff changeset	4870 :echo indexof(l, "v:val.n == 20", #{startidx: 1})
29712 bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4871
bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4872 < Can also be used as a \|method\|: >
bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4873 mylist->indexof(expr)
bdb31515f78b patch 9.0.0196: finding value in list may require a for loop Bram Moolenaar <Bram@vim.org> parents: 29540 diff changeset	4874
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4875 input({prompt} [, {text} [, {completion}]]) input()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4876 The result is a String, which is whatever the user typed on
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4877 the command-line. The {prompt} argument is either a prompt
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4878 string, or a blank string (for no prompt). A '\n' can be used
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4879 in the prompt to start a new line.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4880 The highlighting set with \|:echohl\| is used for the prompt.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4881 The input is entered just like a command-line, with the same
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4882 editing commands and mappings. There is a separate history
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4883 for lines typed for input().
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4884 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4885 :if input("Coffee or beer? ") == "beer"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4886 : echo "Cheers!"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4887 :endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4888 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4889 If the optional {text} argument is present and not empty, this
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4890 is used for the default reply, as if the user typed this.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4891 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4892 :let color = input("Color? ", "white")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4893
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4894 < The optional {completion} argument specifies the type of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4895 completion supported for the input. Without it completion is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4896 not performed. The supported completion types are the same as
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4897 that can be supplied to a user-defined command using the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4898 "-complete=" argument. Refer to \|:command-completion\| for
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4899 more information. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4900 let fname = input("File: ", "", "file")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4901 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4902 NOTE: This function must not be used in a startup file, for
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4903 the versions that only run in GUI mode (e.g., the Win32 GUI).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4904 Note: When input() is called from within a mapping it will
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4905 consume remaining characters from that mapping, because a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4906 mapping is handled like the characters were typed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4907 Use \|inputsave()\| before input() and \|inputrestore()\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4908 after input() to avoid that. Another solution is to avoid
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4909 that further characters follow in the mapping, e.g., by using
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4910 \|:execute\| or \|:normal\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4911
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4912 Example with a mapping: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	4913 :nmap \x :call GetFoo()<CR>:exe "/" .. Foo<CR>
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4914 :function GetFoo()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4915 : call inputsave()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4916 : let g:Foo = input("enter search pattern: ")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4917 : call inputrestore()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4918 :endfunction
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4919
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4920 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4921 GetPrompt()->input()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4922
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4923 inputdialog({prompt} [, {text} [, {cancelreturn}]]) inputdialog()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4924 Like \|input()\|, but when the GUI is running and text dialogs
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4925 are supported, a dialog window pops up to input the text.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4926 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4927 :let n = inputdialog("value for shiftwidth", shiftwidth())
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4928 :if n != ""
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4929 : let &sw = n
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4930 :endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4931 < When the dialog is cancelled {cancelreturn} is returned. When
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4932 omitted an empty string is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4933 Hitting <Enter> works like pressing the OK button. Hitting
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4934 <Esc> works like pressing the Cancel button.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4935 NOTE: Command-line completion is not supported.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4936
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4937 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4938 GetPrompt()->inputdialog()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4939
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4940 inputlist({textlist}) inputlist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4941 {textlist} must be a \|List\| of strings. This \|List\| is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4942 displayed, one string per line. The user will be prompted to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4943 enter a number, which is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4944 The user can also select an item by clicking on it with the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4945 mouse, if the mouse is enabled in the command line ('mouse' is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4946 "a" or includes "c"). For the first string 0 is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4947 When clicking above the first item a negative number is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4948 returned. When clicking on the prompt one more than the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4949 length of {textlist} is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4950 Make sure {textlist} has less than 'lines' entries, otherwise
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4951 it won't work. It's a good idea to put the entry number at
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4952 the start of the string. And put a prompt in the first item.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4953 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4954 let color = inputlist(['Select color:', '1. red',
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4955 \ '2. green', '3. blue'])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4956
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4957 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4958 GetChoices()->inputlist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4959
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4960 inputrestore() inputrestore()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4961 Restore typeahead that was saved with a previous \|inputsave()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4962 Should be called the same number of times inputsave() is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4963 called. Calling it more often is harmless though.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4964 Returns TRUE when there is nothing to restore, FALSE otherwise.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4965
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4966 inputsave() inputsave()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4967 Preserve typeahead (also from mappings) and clear it, so that
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4968 a following prompt gets input from the user. Should be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4969 followed by a matching inputrestore() after the prompt. Can
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4970 be used several times, in which case there must be just as
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4971 many inputrestore() calls.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4972 Returns TRUE when out of memory, FALSE otherwise.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4973
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4974 inputsecret({prompt} [, {text}]) inputsecret()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4975 This function acts much like the \|input()\| function with but
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4976 two exceptions:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4977 a) the user's response will be displayed as a sequence of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4978 asterisks ("*") thereby keeping the entry secret, and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4979 b) the user's response will not be recorded on the input
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4980 \|history\| stack.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4981 The result is a String, which is whatever the user actually
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4982 typed on the command-line in response to the issued prompt.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4983 NOTE: Command-line completion is not supported.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4984
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4985 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4986 GetPrompt()->inputsecret()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4987
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4988 insert({object}, {item} [, {idx}]) insert()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4989 When {object} is a \|List\| or a \|Blob\| insert {item} at the start
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4990 of it.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4991
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4992 If {idx} is specified insert {item} before the item with index
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4993 {idx}. If {idx} is zero it goes before the first item, just
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4994 like omitting {idx}. A negative {idx} is also possible, see
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4995 \|list-index\|. -1 inserts just before the last item.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4996
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4997 Returns the resulting \|List\| or \|Blob\|. Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4998 :let mylist = insert([2, 3, 5], 1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4999 :call insert(mylist, 4, -1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5000 :call insert(mylist, 6, len(mylist))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5001 < The last example can be done simpler with \|add()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5002 Note that when {item} is a \|List\| it is inserted as a single
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5003 item. Use \|extend()\| to concatenate \|Lists\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5004
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5005 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5006 mylist->insert(item)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5007
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5008 interrupt() interrupt()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5009 Interrupt script execution. It works more or less like the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5010 user typing CTRL-C, most commands won't execute and control
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5011 returns to the user. This is useful to abort execution
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5012 from lower down, e.g. in an autocommand. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5013 :function s:check_typoname(file)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5014 : if fnamemodify(a:file, ':t') == '['
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5015 : echomsg 'Maybe typo'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5016 : call interrupt()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5017 : endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5018 :endfunction
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5019 :au BufWritePre * call s:check_typoname(expand('<amatch>'))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5020
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5021 invert({expr}) invert()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5022 Bitwise invert. The argument is converted to a number. A
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5023 List, Dict or Float argument causes an error. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5024 :let bits = invert(bits)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5025 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5026 :let bits = bits->invert()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5027
29290 dc4de65a7fb7 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29285 diff changeset	5028 isabsolutepath({path}) isabsolutepath()
28629 5ef46b938c6e patch 8.2.4838: checking for absolute path is not trivial Bram Moolenaar <Bram@vim.org> parents: 28620 diff changeset	5029 The result is a Number, which is \|TRUE\| when {path} is an
5ef46b938c6e patch 8.2.4838: checking for absolute path is not trivial Bram Moolenaar <Bram@vim.org> parents: 28620 diff changeset	5030 absolute path.
29290 dc4de65a7fb7 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29285 diff changeset	5031 On Unix, a path is considered absolute when it starts with '/'.
28629 5ef46b938c6e patch 8.2.4838: checking for absolute path is not trivial Bram Moolenaar <Bram@vim.org> parents: 28620 diff changeset	5032 On MS-Windows, it is considered absolute when it starts with an
5ef46b938c6e patch 8.2.4838: checking for absolute path is not trivial Bram Moolenaar <Bram@vim.org> parents: 28620 diff changeset	5033 optional drive prefix and is followed by a '\' or '/'. UNC paths
5ef46b938c6e patch 8.2.4838: checking for absolute path is not trivial Bram Moolenaar <Bram@vim.org> parents: 28620 diff changeset	5034 are always absolute.
5ef46b938c6e patch 8.2.4838: checking for absolute path is not trivial Bram Moolenaar <Bram@vim.org> parents: 28620 diff changeset	5035 Example: >
5ef46b938c6e patch 8.2.4838: checking for absolute path is not trivial Bram Moolenaar <Bram@vim.org> parents: 28620 diff changeset	5036 echo isabsolutepath('/usr/share/') " 1
5ef46b938c6e patch 8.2.4838: checking for absolute path is not trivial Bram Moolenaar <Bram@vim.org> parents: 28620 diff changeset	5037 echo isabsolutepath('./foobar') " 0
5ef46b938c6e patch 8.2.4838: checking for absolute path is not trivial Bram Moolenaar <Bram@vim.org> parents: 28620 diff changeset	5038 echo isabsolutepath('C:\Windows') " 1
5ef46b938c6e patch 8.2.4838: checking for absolute path is not trivial Bram Moolenaar <Bram@vim.org> parents: 28620 diff changeset	5039 echo isabsolutepath('foobar') " 0
5ef46b938c6e patch 8.2.4838: checking for absolute path is not trivial Bram Moolenaar <Bram@vim.org> parents: 28620 diff changeset	5040 echo isabsolutepath('\\remote\file') " 1
29290 dc4de65a7fb7 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29285 diff changeset	5041 <
28629 5ef46b938c6e patch 8.2.4838: checking for absolute path is not trivial Bram Moolenaar <Bram@vim.org> parents: 28620 diff changeset	5042 Can also be used as a \|method\|: >
5ef46b938c6e patch 8.2.4838: checking for absolute path is not trivial Bram Moolenaar <Bram@vim.org> parents: 28620 diff changeset	5043 GetName()->isabsolutepath()
5ef46b938c6e patch 8.2.4838: checking for absolute path is not trivial Bram Moolenaar <Bram@vim.org> parents: 28620 diff changeset	5044
5ef46b938c6e patch 8.2.4838: checking for absolute path is not trivial Bram Moolenaar <Bram@vim.org> parents: 28620 diff changeset	5045
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5046 isdirectory({directory}) isdirectory()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5047 The result is a Number, which is \|TRUE\| when a directory
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5048 with the name {directory} exists. If {directory} doesn't
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5049 exist, or isn't a directory, the result is \|FALSE\|. {directory}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5050 is any expression, which is used as a String.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5051
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5052 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5053 GetName()->isdirectory()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5054
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5055 isinf({expr}) isinf()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5056 Return 1 if {expr} is a positive infinity, or -1 a negative
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5057 infinity, otherwise 0. >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5058 :echo isinf(1.0 / 0.0)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5059 < 1 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5060 :echo isinf(-1.0 / 0.0)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5061 < -1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5062
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5063 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5064 Compute()->isinf()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5065
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5066 islocked({expr}) islocked() E786
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5067 The result is a Number, which is \|TRUE\| when {expr} is the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5068 name of a locked variable.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5069 The string argument {expr} must be the name of a variable,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5070 \|List\| item or \|Dictionary\| entry, not the variable itself!
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5071 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5072 :let alist = [0, ['a', 'b'], 2, 3]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5073 :lockvar 1 alist
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5074 :echo islocked('alist') " 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5075 :echo islocked('alist[1]') " 0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5076
27623 179c118424a6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27537 diff changeset	5077 < When {expr} is a variable that does not exist -1 is returned.
179c118424a6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27537 diff changeset	5078 If {expr} uses a range, list or dict index that is out of
179c118424a6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27537 diff changeset	5079 range or does not exist you get an error message. Use
179c118424a6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27537 diff changeset	5080 \|exists()\| to check for existence.
179c118424a6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27537 diff changeset	5081 In Vim9 script it does not work for local function variables.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5082
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5083 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5084 GetName()->islocked()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5085
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5086 isnan({expr}) isnan()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5087 Return \|TRUE\| if {expr} is a float with value NaN. >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5088 echo isnan(0.0 / 0.0)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5089 < 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5090
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5091 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5092 Compute()->isnan()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5093
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5094 items({dict}) items()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5095 Return a \|List\| with all the key-value pairs of {dict}. Each
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5096 \|List\| item is a list with two items: the key of a {dict}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5097 entry and the value of this entry. The \|List\| is in arbitrary
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5098 order. Also see \|keys()\| and \|values()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5099 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5100 for [key, value] in items(mydict)
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	5101 echo key .. ': ' .. value
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5102 endfor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5103
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5104 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5105 mydict->items()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5106
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5107 job_ functions are documented here: \|job-functions-details\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5108
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5109
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5110 join({list} [, {sep}]) join()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5111 Join the items in {list} together into one String.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5112 When {sep} is specified it is put in between the items. If
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5113 {sep} is omitted a single space is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5114 Note that {sep} is not added at the end. You might want to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5115 add it there too: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	5116 let lines = join(mylist, "\n") .. "\n"
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5117 < String items are used as-is. \|Lists\| and \|Dictionaries\| are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5118 converted into a string like with \|string()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5119 The opposite function is \|split()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5120
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5121 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5122 mylist->join()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5123
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5124 js_decode({string}) js_decode()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5125 This is similar to \|json_decode()\| with these differences:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5126 - Object key names do not have to be in quotes.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5127 - Strings can be in single quotes.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5128 - Empty items in an array (between two commas) are allowed and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5129 result in v:none items.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5130
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5131 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5132 ReadObject()->js_decode()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5133
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5134 js_encode({expr}) js_encode()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5135 This is similar to \|json_encode()\| with these differences:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5136 - Object key names are not in quotes.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5137 - v:none items in an array result in an empty item between
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5138 commas.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5139 For example, the Vim object:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5140 [1,v:none,{"one":1},v:none] ~
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5141 Will be encoded as:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5142 [1,,{one:1},,] ~
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5143 While json_encode() would produce:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5144 [1,null,{"one":1},null] ~
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5145 This encoding is valid for JavaScript. It is more efficient
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5146 than JSON, especially when using an array with optional items.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5147
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5148 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5149 GetObject()->js_encode()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5150
27036 3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26901 diff changeset	5151 json_decode({string}) json_decode() E491
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5152 This parses a JSON formatted string and returns the equivalent
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5153 in Vim values. See \|json_encode()\| for the relation between
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5154 JSON and Vim values.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5155 The decoding is permissive:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5156 - A trailing comma in an array and object is ignored, e.g.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5157 "[1, 2, ]" is the same as "[1, 2]".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5158 - Integer keys are accepted in objects, e.g. {1:2} is the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5159 same as {"1":2}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5160 - More floating point numbers are recognized, e.g. "1." for
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5161 "1.0", or "001.2" for "1.2". Special floating point values
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5162 "Infinity", "-Infinity" and "NaN" (capitalization ignored)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5163 are accepted.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5164 - Leading zeroes in integer numbers are ignored, e.g. "012"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5165 for "12" or "-012" for "-12".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5166 - Capitalization is ignored in literal names null, true or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5167 false, e.g. "NULL" for "null", "True" for "true".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5168 - Control characters U+0000 through U+001F which are not
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5169 escaped in strings are accepted, e.g. " " (tab
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5170 character in string) for "\t".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5171 - An empty JSON expression or made of only spaces is accepted
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5172 and results in v:none.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5173 - Backslash in an invalid 2-character sequence escape is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5174 ignored, e.g. "\a" is decoded as "a".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5175 - A correct surrogate pair in JSON strings should normally be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5176 a 12 character sequence such as "\uD834\uDD1E", but
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5177 json_decode() silently accepts truncated surrogate pairs
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5178 such as "\uD834" or "\uD834\u"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5179 E938
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5180 A duplicate key in an object, valid in rfc7159, is not
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5181 accepted by json_decode() as the result must be a valid Vim
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5182 type, e.g. this fails: {"a":"b", "a":"c"}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5183
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5184 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5185 ReadObject()->json_decode()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5186
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5187 json_encode({expr}) json_encode()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5188 Encode {expr} as JSON and return this as a string.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5189 The encoding is specified in:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5190 https://tools.ietf.org/html/rfc7159.html
27537 063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27497 diff changeset	5191 Vim values are converted as follows: E1161
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5192 \|Number\| decimal number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5193 \|Float\| floating point number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5194 Float nan "NaN"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5195 Float inf "Infinity"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5196 Float -inf "-Infinity"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5197 \|String\| in double quotes (possibly null)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5198 \|Funcref\| not possible, error
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5199 \|List\| as an array (possibly null); when
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5200 used recursively: []
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5201 \|Dict\| as an object (possibly null); when
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5202 used recursively: {}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5203 \|Blob\| as an array of the individual bytes
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5204 v:false "false"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5205 v:true "true"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5206 v:none "null"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5207 v:null "null"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5208 Note that NaN and Infinity are passed on as values. This is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5209 missing in the JSON standard, but several implementations do
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5210 allow it. If not then you will get an error.
28379 6dd88e45d47d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28307 diff changeset	5211 If a string contains an illegal character then the replacement
6dd88e45d47d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28307 diff changeset	5212 character 0xfffd is used.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5213
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5214 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5215 GetObject()->json_encode()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5216
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5217 keys({dict}) keys()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5218 Return a \|List\| with all the keys of {dict}. The \|List\| is in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5219 arbitrary order. Also see \|items()\| and \|values()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5220
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5221 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5222 mydict->keys()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5223
30226 b6b803ed4a53 patch 9.0.0449: there is no easy way to translate a key code into a string Bram Moolenaar <Bram@vim.org> parents: 30202 diff changeset	5224 keytrans({string}) keytrans()
b6b803ed4a53 patch 9.0.0449: there is no easy way to translate a key code into a string Bram Moolenaar <Bram@vim.org> parents: 30202 diff changeset	5225 Turn the internal byte representation of keys into a form that
b6b803ed4a53 patch 9.0.0449: there is no easy way to translate a key code into a string Bram Moolenaar <Bram@vim.org> parents: 30202 diff changeset	5226 can be used for \|:map\|. E.g. >
b6b803ed4a53 patch 9.0.0449: there is no easy way to translate a key code into a string Bram Moolenaar <Bram@vim.org> parents: 30202 diff changeset	5227 :let xx = "\<C-Home>"
b6b803ed4a53 patch 9.0.0449: there is no easy way to translate a key code into a string Bram Moolenaar <Bram@vim.org> parents: 30202 diff changeset	5228 :echo keytrans(xx)
b6b803ed4a53 patch 9.0.0449: there is no easy way to translate a key code into a string Bram Moolenaar <Bram@vim.org> parents: 30202 diff changeset	5229 < <C-Home>
b6b803ed4a53 patch 9.0.0449: there is no easy way to translate a key code into a string Bram Moolenaar <Bram@vim.org> parents: 30202 diff changeset	5230
b6b803ed4a53 patch 9.0.0449: there is no easy way to translate a key code into a string Bram Moolenaar <Bram@vim.org> parents: 30202 diff changeset	5231 Can also be used as a \|method\|: >
b6b803ed4a53 patch 9.0.0449: there is no easy way to translate a key code into a string Bram Moolenaar <Bram@vim.org> parents: 30202 diff changeset	5232 "\<C-Home>"->keytrans()
b6b803ed4a53 patch 9.0.0449: there is no easy way to translate a key code into a string Bram Moolenaar <Bram@vim.org> parents: 30202 diff changeset	5233
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5234 < len() E701
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5235 len({expr}) The result is a Number, which is the length of the argument.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5236 When {expr} is a String or a Number the length in bytes is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5237 used, as with \|strlen()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5238 When {expr} is a \|List\| the number of items in the \|List\| is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5239 returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5240 When {expr} is a \|Blob\| the number of bytes is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5241 When {expr} is a \|Dictionary\| the number of entries in the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5242 \|Dictionary\| is returned.
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	5243 Otherwise an error is given and returns zero.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5244
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5245 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5246 mylist->len()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5247
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5248 < libcall() E364 E368
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5249 libcall({libname}, {funcname}, {argument})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5250 Call function {funcname} in the run-time library {libname}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5251 with single argument {argument}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5252 This is useful to call functions in a library that you
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5253 especially made to be used with Vim. Since only one argument
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5254 is possible, calling standard library functions is rather
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5255 limited.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5256 The result is the String returned by the function. If the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5257 function returns NULL, this will appear as an empty string ""
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5258 to Vim.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5259 If the function returns a number, use libcallnr()!
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5260 If {argument} is a number, it is passed to the function as an
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5261 int; if {argument} is a string, it is passed as a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5262 null-terminated string.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5263 This function will fail in \|restricted-mode\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5264
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5265 libcall() allows you to write your own 'plug-in' extensions to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5266 Vim without having to recompile the program. It is NOT a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5267 means to call system functions! If you try to do so Vim will
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5268 very probably crash.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5269
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5270 For Win32, the functions you write must be placed in a DLL
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5271 and use the normal C calling convention (NOT Pascal which is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5272 used in Windows System DLLs). The function must take exactly
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5273 one parameter, either a character pointer or a long integer,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5274 and must return a character pointer or NULL. The character
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5275 pointer returned must point to memory that will remain valid
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5276 after the function has returned (e.g. in static data in the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5277 DLL). If it points to allocated memory, that memory will
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5278 leak away. Using a static buffer in the function should work,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5279 it's then freed when the DLL is unloaded.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5280
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5281 WARNING: If the function returns a non-valid pointer, Vim may
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5282 crash! This also happens if the function returns a number,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5283 because Vim thinks it's a pointer.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5284 For Win32 systems, {libname} should be the filename of the DLL
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5285 without the ".DLL" suffix. A full path is only required if
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5286 the DLL is not in the usual places.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5287 For Unix: When compiling your own plugins, remember that the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5288 object code must be compiled as position-independent ('PIC').
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5289 {only in Win32 and some Unix versions, when the \|+libcall\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5290 feature is present}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5291 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5292 :echo libcall("libc.so", "getenv", "HOME")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5293
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5294 < Can also be used as a \|method\|, the base is passed as the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5295 third argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5296 GetValue()->libcall("libc.so", "getenv")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5297 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5298 libcallnr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5299 libcallnr({libname}, {funcname}, {argument})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5300 Just like \|libcall()\|, but used for a function that returns an
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5301 int instead of a string.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5302 {only in Win32 on some Unix versions, when the \|+libcall\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5303 feature is present}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5304 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5305 :echo libcallnr("/usr/lib/libc.so", "getpid", "")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5306 :call libcallnr("libc.so", "printf", "Hello World!\n")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5307 :call libcallnr("libc.so", "sleep", 10)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5308 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5309 Can also be used as a \|method\|, the base is passed as the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5310 third argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5311 GetValue()->libcallnr("libc.so", "printf")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5312 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5313
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5314 line({expr} [, {winid}]) line()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5315 The result is a Number, which is the line number of the file
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5316 position given with {expr}. The {expr} argument is a string.
27537 063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27497 diff changeset	5317 The accepted positions are: E1209
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5318 . the cursor position
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5319 $ the last line in the current buffer
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5320 'x position of mark x (if the mark is not set, 0 is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5321 returned)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5322 w0 first line visible in current window (one if the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5323 display isn't updated, e.g. in silent Ex mode)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5324 w$ last line visible in current window (this is one
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5325 less than "w0" if no lines are visible)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5326 v In Visual mode: the start of the Visual area (the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5327 cursor is the end). When not in Visual mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5328 returns the cursor position. Differs from \|'<\| in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5329 that it's updated right away.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5330 Note that a mark in another file can be used. The line number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5331 then applies to another buffer.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5332 To get the column number use \|col()\|. To get both use
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5333 \|getpos()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5334 With the optional {winid} argument the values are obtained for
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5335 that window instead of the current window.
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	5336 Returns 0 for invalid values of {expr} and {winid}.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5337 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5338 line(".") line number of the cursor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5339 line(".", winid) idem, in window "winid"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5340 line("'t") line number of mark t
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	5341 line("'" .. marker) line number of mark marker
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5342 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5343 To jump to the last known position when opening a file see
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5344 \|last-position-jump\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5345
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5346 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5347 GetValue()->line()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5348
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5349 line2byte({lnum}) line2byte()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5350 Return the byte count from the start of the buffer for line
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5351 {lnum}. This includes the end-of-line character, depending on
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5352 the 'fileformat' option for the current buffer. The first
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5353 line returns 1. 'encoding' matters, 'fileencoding' is ignored.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5354 This can also be used to get the byte count for the line just
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5355 below the last line: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5356 line2byte(line("$") + 1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5357 < This is the buffer size plus one. If 'fileencoding' is empty
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5358 it is the file size plus one. {lnum} is used like with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5359 \|getline()\|. When {lnum} is invalid, or the \|+byte_offset\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5360 feature has been disabled at compile time, -1 is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5361 Also see \|byte2line()\|, \|go\| and \|:goto\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5362
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5363 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5364 GetLnum()->line2byte()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5365
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5366 lispindent({lnum}) lispindent()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5367 Get the amount of indent for line {lnum} according the lisp
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5368 indenting rules, as with 'lisp'.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5369 The indent is counted in spaces, the value of 'tabstop' is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5370 relevant. {lnum} is used just like in \|getline()\|.
28942 6cdf55afaae9 patch 8.2.4993: smart/C/lisp indenting is optional Bram Moolenaar <Bram@vim.org> parents: 28933 diff changeset	5371 When {lnum} is invalid -1 is returned. In \|Vim9\| script an
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5372 error is given.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5373
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5374 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5375 GetLnum()->lispindent()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5376
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5377 list2blob({list}) list2blob()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5378 Return a Blob concatenating all the number values in {list}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5379 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5380 list2blob([1, 2, 3, 4]) returns 0z01020304
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5381 list2blob([]) returns 0z
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5382 < Returns an empty Blob on error. If one of the numbers is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5383 negative or more than 255 error E1239 is given.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5384
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5385 \|blob2list()\| does the opposite.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5386
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5387 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5388 GetList()->list2blob()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5389
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5390 list2str({list} [, {utf8}]) list2str()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5391 Convert each number in {list} to a character string can
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5392 concatenate them all. Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5393 list2str([32]) returns " "
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5394 list2str([65, 66, 67]) returns "ABC"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5395 < The same can be done (slowly) with: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5396 join(map(list, {nr, val -> nr2char(val)}), '')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5397 < \|str2list()\| does the opposite.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5398
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5399 When {utf8} is omitted or zero, the current 'encoding' is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5400 When {utf8} is TRUE, always return UTF-8 characters.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5401 With UTF-8 composing characters work as expected: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5402 list2str([97, 769]) returns "á"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5403 <
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	5404 Returns an empty string on error.
2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	5405
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5406 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5407 GetList()->list2str()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5408
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5409 listener_add({callback} [, {buf}]) listener_add()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5410 Add a callback function that will be invoked when changes have
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5411 been made to buffer {buf}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5412 {buf} refers to a buffer name or number. For the accepted
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5413 values, see \|bufname()\|. When {buf} is omitted the current
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5414 buffer is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5415 Returns a unique ID that can be passed to \|listener_remove()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5416
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5417 The {callback} is invoked with five arguments:
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	5418 bufnr the buffer that was changed
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	5419 start first changed line number
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	5420 end first line number below the change
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	5421 added number of lines added, negative if lines were
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5422 deleted
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	5423 changes a List of items with details about the changes
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5424
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5425 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5426 func Listener(bufnr, start, end, added, changes)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5427 echo 'lines ' .. a:start .. ' until ' .. a:end .. ' changed'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5428 endfunc
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5429 call listener_add('Listener', bufnr)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5430
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	5431 < The List cannot be changed. Each item in "changes" is a
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5432 dictionary with these entries:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5433 lnum the first line number of the change
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5434 end the first line below the change
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5435 added number of lines added; negative if lines were
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5436 deleted
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5437 col first column in "lnum" that was affected by
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5438 the change; one if unknown or the whole line
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5439 was affected; this is a byte index, first
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5440 character has a value of one.
30875 3295247d97a5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30785 diff changeset	5441 When lines are inserted (not when a line is split, e.g. by
3295247d97a5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30785 diff changeset	5442 typing CR in Insert mode) the values are:
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5443 lnum line above which the new line is added
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5444 end equal to "lnum"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5445 added number of lines inserted
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5446 col 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5447 When lines are deleted the values are:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5448 lnum the first deleted line
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5449 end the line below the first deleted line, before
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5450 the deletion was done
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5451 added negative, number of lines deleted
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5452 col 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5453 When lines are changed:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5454 lnum the first changed line
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5455 end the line below the last changed line
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5456 added 0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5457 col first column with a change or 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5458
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5459 The entries are in the order the changes were made, thus the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5460 most recent change is at the end. The line numbers are valid
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5461 when the callback is invoked, but later changes may make them
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5462 invalid, thus keeping a copy for later might not work.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5463
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5464 The {callback} is invoked just before the screen is updated,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5465 when \|listener_flush()\| is called or when a change is being
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5466 made that changes the line count in a way it causes a line
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5467 number in the list of changes to become invalid.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5468
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5469 The {callback} is invoked with the text locked, see
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5470 \|textlock\|. If you do need to make changes to the buffer, use
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5471 a timer to do this later \|timer_start()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5472
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5473 The {callback} is not invoked when the buffer is first loaded.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5474 Use the \|BufReadPost\| autocmd event to handle the initial text
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5475 of a buffer.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5476 The {callback} is also not invoked when the buffer is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5477 unloaded, use the \|BufUnload\| autocmd event for that.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5478
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	5479 Returns zero if {callback} or {buf} is invalid.
2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	5480
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5481 Can also be used as a \|method\|, the base is passed as the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5482 second argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5483 GetBuffer()->listener_add(callback)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5484
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5485 listener_flush([{buf}]) listener_flush()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5486 Invoke listener callbacks for buffer {buf}. If there are no
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5487 pending changes then no callbacks are invoked.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5488
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5489 {buf} refers to a buffer name or number. For the accepted
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5490 values, see \|bufname()\|. When {buf} is omitted the current
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5491 buffer is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5492
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5493 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5494 GetBuffer()->listener_flush()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5495
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5496 listener_remove({id}) listener_remove()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5497 Remove a listener previously added with listener_add().
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5498 Returns FALSE when {id} could not be found, TRUE when {id} was
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5499 removed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5500
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5501 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5502 GetListenerId()->listener_remove()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5503
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5504 localtime() localtime()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5505 Return the current time, measured as seconds since 1st Jan
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5506 1970. See also \|strftime()\|, \|strptime()\| and \|getftime()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5507
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5508
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5509 log({expr}) log()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5510 Return the natural logarithm (base e) of {expr} as a \|Float\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5511 {expr} must evaluate to a \|Float\| or a \|Number\| in the range
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5512 (0, inf].
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	5513 Returns 0.0 if {expr} is not a \|Float\| or a \|Number\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5514 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5515 :echo log(10)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5516 < 2.302585 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5517 :echo log(exp(5))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5518 < 5.0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5519
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5520 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5521 Compute()->log()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5522
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5523
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5524 log10({expr}) log10()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5525 Return the logarithm of Float {expr} to base 10 as a \|Float\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5526 {expr} must evaluate to a \|Float\| or a \|Number\|.
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	5527 Returns 0.0 if {expr} is not a \|Float\| or a \|Number\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5528 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5529 :echo log10(1000)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5530 < 3.0 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5531 :echo log10(0.01)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5532 < -2.0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5533
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5534 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5535 Compute()->log10()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5536
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5537 luaeval({expr} [, {expr}]) luaeval()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5538 Evaluate Lua expression {expr} and return its result converted
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5539 to Vim data structures. Second {expr} may hold additional
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5540 argument accessible as _A inside first {expr}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5541 Strings are returned as they are.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5542 Boolean objects are converted to numbers.
30310 029c59bf78f1 patch 9.0.0491: no good reason to build without the float feature Bram Moolenaar <Bram@vim.org> parents: 30275 diff changeset	5543 Numbers are converted to \|Float\| values.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5544 Dictionaries and lists obtained by vim.eval() are returned
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5545 as-is.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5546 Other objects are returned as zero without any errors.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5547 See \|lua-luaeval\| for more details.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5548 Note that in a `:def` function local variables are not visible
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5549 to {expr}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5550
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5551 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5552 GetExpr()->luaeval()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5553
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5554 < {only available when compiled with the \|+lua\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5555
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5556 map({expr1}, {expr2}) map()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5557 {expr1} must be a \|List\|, \|String\|, \|Blob\| or \|Dictionary\|.
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	5558 When {expr1} is a \|List\| or \|Dictionary\|, replace each
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5559 item in {expr1} with the result of evaluating {expr2}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5560 For a \|Blob\| each byte is replaced.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5561 For a \|String\|, each character, including composing
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5562 characters, is replaced.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5563 If the item type changes you may want to use \|mapnew()\| to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5564 create a new List or Dictionary. This is required when using
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5565 Vim9 script.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5566
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5567 {expr2} must be a \|String\| or \|Funcref\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5568
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5569 If {expr2} is a \|String\|, inside {expr2} \|v:val\| has the value
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5570 of the current item. For a \|Dictionary\| \|v:key\| has the key
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5571 of the current item and for a \|List\| \|v:key\| has the index of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5572 the current item. For a \|Blob\| \|v:key\| has the index of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5573 current byte. For a \|String\| \|v:key\| has the index of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5574 current character.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5575 Example: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	5576 :call map(mylist, '"> " .. v:val .. " <"')
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5577 < This puts "> " before and " <" after each item in "mylist".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5578
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5579 Note that {expr2} is the result of an expression and is then
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5580 used as an expression again. Often it is good to use a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5581 \|literal-string\| to avoid having to double backslashes. You
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5582 still have to double ' quotes
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5583
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5584 If {expr2} is a \|Funcref\| it is called with two arguments:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5585 1. The key or the index of the current item.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5586 2. the value of the current item.
31200 a7801222c9c5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31164 diff changeset	5587 With a legacy script lambda you don't get an error if it only
a7801222c9c5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31164 diff changeset	5588 accepts one argument, but with a Vim9 lambda you get "E1106:
a7801222c9c5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31164 diff changeset	5589 One argument too many", the number of arguments must match.
a7801222c9c5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31164 diff changeset	5590
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5591 The function must return the new value of the item. Example
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5592 that changes each value by "key-value": >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5593 func KeyValue(key, val)
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	5594 return a:key .. '-' .. a:val
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5595 endfunc
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5596 call map(myDict, function('KeyValue'))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5597 < It is shorter when using a \|lambda\|: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	5598 call map(myDict, {key, val -> key .. '-' .. val})
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5599 < If you do not use "val" you can leave it out: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	5600 call map(myDict, {key -> 'item: ' .. key})
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5601 < If you do not use "key" you can use a short name: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	5602 call map(myDict, {_, val -> 'item: ' .. val})
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5603 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5604 The operation is done in-place for a \|List\| and \|Dictionary\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5605 If you want it to remain unmodified make a copy first: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	5606 :let tlist = map(copy(mylist), ' v:val .. "\t"')
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5607
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5608 < Returns {expr1}, the \|List\| or \|Dictionary\| that was filtered,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5609 or a new \|Blob\| or \|String\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5610 When an error is encountered while evaluating {expr2} no
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5611 further items in {expr1} are processed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5612 When {expr2} is a Funcref errors inside a function are ignored,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5613 unless it was defined with the "abort" flag.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5614
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5615 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5616 mylist->map(expr2)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5617
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5618
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5619 maparg({name} [, {mode} [, {abbr} [, {dict}]]]) maparg()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5620 When {dict} is omitted or zero: Return the rhs of mapping
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5621 {name} in mode {mode}. The returned String has special
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5622 characters translated like in the output of the ":map" command
28602 398c5b3211f9 patch 8.2.4825: can only get a list of mappings Bram Moolenaar <Bram@vim.org> parents: 28592 diff changeset	5623 listing. When {dict} is TRUE a dictionary is returned, see
398c5b3211f9 patch 8.2.4825: can only get a list of mappings Bram Moolenaar <Bram@vim.org> parents: 28592 diff changeset	5624 below. To get a list of all mappings see \|maplist()\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5625
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5626 When there is no mapping for {name}, an empty String is
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	5627 returned if {dict} is FALSE, otherwise returns an empty Dict.
2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	5628 When the mapping for {name} is empty, then "<Nop>" is
2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	5629 returned.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5630
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5631 The {name} can have special key names, like in the ":map"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5632 command.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5633
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5634 {mode} can be one of these strings:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5635 "n" Normal
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5636 "v" Visual (including Select)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5637 "o" Operator-pending
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5638 "i" Insert
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5639 "c" Cmd-line
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5640 "s" Select
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5641 "x" Visual
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5642 "l" langmap \|language-mapping\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5643 "t" Terminal-Job
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5644 "" Normal, Visual and Operator-pending
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5645 When {mode} is omitted, the modes for "" are used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5646
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5647 When {abbr} is there and it is \|TRUE\| use abbreviations
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5648 instead of mappings.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5649
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5650 When {dict} is there and it is \|TRUE\| return a dictionary
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5651 containing all the information of the mapping with the
28592 d3c966c0cdf7 patch 8.2.4820: not simple programmatic way to find a specific mapping Bram Moolenaar <Bram@vim.org> parents: 28517 diff changeset	5652 following items: mapping-dict
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5653 "lhs" The {lhs} of the mapping as it would be typed
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5654 "lhsraw" The {lhs} of the mapping as raw bytes
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5655 "lhsrawalt" The {lhs} of the mapping as raw bytes, alternate
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5656 form, only present when it differs from "lhsraw"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5657 "rhs" The {rhs} of the mapping as typed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5658 "silent" 1 for a \|:map-silent\| mapping, else 0.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5659 "noremap" 1 if the {rhs} of the mapping is not remappable.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5660 "script" 1 if mapping was defined with <script>.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5661 "expr" 1 for an expression mapping (\|:map-<expr>\|).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5662 "buffer" 1 for a buffer local mapping (\|:map-local\|).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5663 "mode" Modes for which the mapping is defined. In
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5664 addition to the modes mentioned above, these
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5665 characters will be used:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5666 " " Normal, Visual and Operator-pending
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5667 "!" Insert and Commandline mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5668 (\|mapmode-ic\|)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5669 "sid" The script local ID, used for <sid> mappings
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5670 (\|<SID>\|).
27223 ea2b4cb4515b patch 8.2.4140: maparg() does not indicate the type of script Bram Moolenaar <Bram@vim.org> parents: 27162 diff changeset	5671 "scriptversion" The version of the script. 999999 for
28933 57c9377b9c62 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 28917 diff changeset	5672 \|Vim9\| script.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5673 "lnum" The line number in "sid", zero if unknown.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5674 "nowait" Do not wait for other, longer mappings.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5675 (\|:map-<nowait>\|).
28808 0f0fed554cdc Update runtime files, translations Bram Moolenaar <Bram@vim.org> parents: 28777 diff changeset	5676 "abbr" True if this is an abbreviation \|abbreviations\|.
28817 1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5677 "mode_bits" Vim's internal binary representation of "mode".
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5678 \|mapset()\| ignores this; only "mode" is used.
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5679 See \|maplist()\| for usage examples. The values
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5680 are from src/vim.h and may change in the future.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5681
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5682 The dictionary can be used to restore a mapping with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5683 \|mapset()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5684
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5685 The mappings local to the current buffer are checked first,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5686 then the global mappings.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5687 This function can be used to map a key even when it's already
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5688 mapped, and have it do the original mapping too. Sketch: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	5689 exe 'nnoremap <Tab> ==' .. maparg('<Tab>', 'n')
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5690
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5691 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5692 GetKey()->maparg('n')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5693
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5694 mapcheck({name} [, {mode} [, {abbr}]]) mapcheck()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5695 Check if there is a mapping that matches with {name} in mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5696 {mode}. See \|maparg()\| for {mode} and special names in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5697 {name}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5698 When {abbr} is there and it is \|TRUE\| use abbreviations
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5699 instead of mappings.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5700 A match happens with a mapping that starts with {name} and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5701 with a mapping which is equal to the start of {name}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5702
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5703 matches mapping "a" "ab" "abc" ~
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5704 mapcheck("a") yes yes yes
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5705 mapcheck("abc") yes yes yes
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5706 mapcheck("ax") yes no no
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5707 mapcheck("b") no no no
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5708
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5709 The difference with maparg() is that mapcheck() finds a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5710 mapping that matches with {name}, while maparg() only finds a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5711 mapping for {name} exactly.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5712 When there is no mapping that starts with {name}, an empty
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5713 String is returned. If there is one, the RHS of that mapping
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5714 is returned. If there are several mappings that start with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5715 {name}, the RHS of one of them is returned. This will be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5716 "<Nop>" if the RHS is empty.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5717 The mappings local to the current buffer are checked first,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5718 then the global mappings.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5719 This function can be used to check if a mapping can be added
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5720 without being ambiguous. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5721 :if mapcheck("_vv") == ""
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5722 : map _vv :set guifont=7x13<CR>
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5723 :endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5724 < This avoids adding the "_vv" mapping when there already is a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5725 mapping for "_v" or for "_vvv".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5726
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5727 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5728 GetKey()->mapcheck('n')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5729
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5730
28602 398c5b3211f9 patch 8.2.4825: can only get a list of mappings Bram Moolenaar <Bram@vim.org> parents: 28592 diff changeset	5731 maplist([{abbr}]) maplist()
398c5b3211f9 patch 8.2.4825: can only get a list of mappings Bram Moolenaar <Bram@vim.org> parents: 28592 diff changeset	5732 Returns a \|List\| of all mappings. Each List item is a \|Dict\|,
398c5b3211f9 patch 8.2.4825: can only get a list of mappings Bram Moolenaar <Bram@vim.org> parents: 28592 diff changeset	5733 the same as what is returned by \|maparg()\|, see
398c5b3211f9 patch 8.2.4825: can only get a list of mappings Bram Moolenaar <Bram@vim.org> parents: 28592 diff changeset	5734 \|mapping-dict\|. When {abbr} is there and it is \|TRUE\| use
398c5b3211f9 patch 8.2.4825: can only get a list of mappings Bram Moolenaar <Bram@vim.org> parents: 28592 diff changeset	5735 abbreviations instead of mappings.
398c5b3211f9 patch 8.2.4825: can only get a list of mappings Bram Moolenaar <Bram@vim.org> parents: 28592 diff changeset	5736
398c5b3211f9 patch 8.2.4825: can only get a list of mappings Bram Moolenaar <Bram@vim.org> parents: 28592 diff changeset	5737 Example to show all mappings with 'MultiMatch' in rhs: >
398c5b3211f9 patch 8.2.4825: can only get a list of mappings Bram Moolenaar <Bram@vim.org> parents: 28592 diff changeset	5738 vim9script
398c5b3211f9 patch 8.2.4825: can only get a list of mappings Bram Moolenaar <Bram@vim.org> parents: 28592 diff changeset	5739 echo maplist()->filter(
398c5b3211f9 patch 8.2.4825: can only get a list of mappings Bram Moolenaar <Bram@vim.org> parents: 28592 diff changeset	5740 (_, m) => match(m.rhs, 'MultiMatch') >= 0)
28817 1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5741 < It can be tricky to find mappings for particular \|:map-modes\|.
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5742 \|mapping-dict\|'s "mode_bits" can simplify this. For example,
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5743 the mode_bits for Normal, Insert or Command-line modes are
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5744 0x19. To find all the mappings available in those modes you
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5745 can do: >
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5746 vim9script
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5747 var saved_maps = []
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5748 for m in maplist()
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5749 if and(m.mode_bits, 0x19) != 0
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5750 saved_maps->add(m)
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5751 endif
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5752 endfor
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5753 echo saved_maps->mapnew((_, m) => m.lhs)
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5754 < The values of the mode_bits are defined in Vim's src/vim.h
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5755 file and they can be discovered at runtime using
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5756 \|:map-commands\| and "maplist()". Example: >
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5757 vim9script
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5758 omap xyzzy <Nop>
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5759 var op_bit = maplist()->filter(
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5760 (_, m) => m.lhs == 'xyzzy')[0].mode_bits
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5761 ounmap xyzzy
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5762 echo printf("Operator-pending mode bit: 0x%x", op_bit)
28602 398c5b3211f9 patch 8.2.4825: can only get a list of mappings Bram Moolenaar <Bram@vim.org> parents: 28592 diff changeset	5763
398c5b3211f9 patch 8.2.4825: can only get a list of mappings Bram Moolenaar <Bram@vim.org> parents: 28592 diff changeset	5764
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5765 mapnew({expr1}, {expr2}) mapnew()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5766 Like \|map()\| but instead of replacing items in {expr1} a new
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5767 List or Dictionary is created and returned. {expr1} remains
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5768 unchanged. Items can still be changed by {expr2}, if you
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5769 don't want that use \|deepcopy()\| first.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5770
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5771
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5772 mapset({mode}, {abbr}, {dict}) mapset()
28674 38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5773 mapset({dict})
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5774 Restore a mapping from a dictionary, possibly returned by
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5775 \|maparg()\| or \|maplist()\|. A buffer mapping, when dict.buffer
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5776 is true, is set on the current buffer; it is up to the caller
28933 57c9377b9c62 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 28917 diff changeset	5777 to ensure that the intended buffer is the current buffer. This
28674 38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5778 feature allows copying mappings from one buffer to another.
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5779 The dict.mode value may restore a single mapping that covers
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5780 more than one mode, like with mode values of '!', ' ', 'nox',
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5781 or 'v'. E1276
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5782
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5783 In the first form, {mode} and {abbr} should be the same as
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5784 for the call to \|maparg()\|. E460
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5785 {mode} is used to define the mode in which the mapping is set,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5786 not the "mode" entry in {dict}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5787 Example for saving and restoring a mapping: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5788 let save_map = maparg('K', 'n', 0, 1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5789 nnoremap K somethingelse
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5790 ...
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5791 call mapset('n', 0, save_map)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5792 < Note that if you are going to replace a map in several modes,
28674 38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5793 e.g. with `:map!`, you need to save/restore the mapping for
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5794 all of them, when they might differ.
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5795
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5796 In the second form, with {dict} as the only argument, mode
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5797 and abbr are taken from the dict.
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5798 Example: >
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5799 vim9script
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5800 var save_maps = maplist()->filter(
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5801 (_, m) => m.lhs == 'K')
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5802 nnoremap K somethingelse
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5803 cnoremap K somethingelse2
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5804 # ...
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5805 unmap K
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5806 for d in save_maps
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5807 mapset(d)
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5808 endfor
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5809
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5810
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5811 match({expr}, {pat} [, {start} [, {count}]]) match()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5812 When {expr} is a \|List\| then this returns the index of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5813 first item where {pat} matches. Each item is used as a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5814 String, \|Lists\| and \|Dictionaries\| are used as echoed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5815
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5816 Otherwise, {expr} is used as a String. The result is a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5817 Number, which gives the index (byte offset) in {expr} where
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5818 {pat} matches.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5819
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5820 A match at the first character or \|List\| item returns zero.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5821 If there is no match -1 is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5822
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5823 For getting submatches see \|matchlist()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5824 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5825 :echo match("testing", "ing") " results in 4
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5826 :echo match([1, 'x'], '\a') " results in 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5827 < See \|string-match\| for how {pat} is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5828 strpbrk()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5829 Vim doesn't have a strpbrk() function. But you can do: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5830 :let sepidx = match(line, '[.,;: \t]')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5831 < strcasestr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5832 Vim doesn't have a strcasestr() function. But you can add
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5833 "\c" to the pattern to ignore case: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5834 :let idx = match(haystack, '\cneedle')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5835 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5836 If {start} is given, the search starts from byte index
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5837 {start} in a String or item {start} in a \|List\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5838 The result, however, is still the index counted from the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5839 first character/item. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5840 :echo match("testing", "ing", 2)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5841 < result is again "4". >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5842 :echo match("testing", "ing", 4)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5843 < result is again "4". >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5844 :echo match("testing", "t", 2)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5845 < result is "3".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5846 For a String, if {start} > 0 then it is like the string starts
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5847 {start} bytes later, thus "^" will match at {start}. Except
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5848 when {count} is given, then it's like matches before the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5849 {start} byte are ignored (this is a bit complicated to keep it
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5850 backwards compatible).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5851 For a String, if {start} < 0, it will be set to 0. For a list
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5852 the index is counted from the end.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5853 If {start} is out of range ({start} > strlen({expr}) for a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5854 String or {start} > len({expr}) for a \|List\|) -1 is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5855
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5856 When {count} is given use the {count}'th match. When a match
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5857 is found in a String the search for the next one starts one
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5858 character further. Thus this example results in 1: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5859 echo match("testing", "..", 0, 2)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5860 < In a \|List\| the search continues in the next item.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5861 Note that when {count} is added the way {start} works changes,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5862 see above.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5863
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5864 See \|pattern\| for the patterns that are accepted.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5865 The 'ignorecase' option is used to set the ignore-caseness of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5866 the pattern. 'smartcase' is NOT used. The matching is always
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5867 done like 'magic' is set and 'cpoptions' is empty.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5868 Note that a match at the start is preferred, thus when the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5869 pattern is using "*" (any number of matches) it tends to find
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5870 zero matches at the start instead of a number of matches
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5871 further down in the text.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5872
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5873 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5874 GetText()->match('word')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5875 GetList()->match('word')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5876 <
27036 3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26901 diff changeset	5877 matchadd() E290 E798 E799 E801 E957
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5878 matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5879 Defines a pattern to be highlighted in the current window (a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5880 "match"). It will be highlighted with {group}. Returns an
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5881 identification number (ID), which can be used to delete the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5882 match using \|matchdelete()\|. The ID is bound to the window.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5883 Matching is case sensitive and magic, unless case sensitivity
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5884 or magicness are explicitly overridden in {pattern}. The
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5885 'magic', 'smartcase' and 'ignorecase' options are not used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5886 The "Conceal" value is special, it causes the match to be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5887 concealed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5888
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5889 The optional {priority} argument assigns a priority to the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5890 match. A match with a high priority will have its
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5891 highlighting overrule that of a match with a lower priority.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5892 A priority is specified as an integer (negative numbers are no
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5893 exception). If the {priority} argument is not specified, the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5894 default priority is 10. The priority of 'hlsearch' is zero,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5895 hence all matches with a priority greater than zero will
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5896 overrule it. Syntax highlighting (see 'syntax') is a separate
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5897 mechanism, and regardless of the chosen priority a match will
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5898 always overrule syntax highlighting.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5899
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5900 The optional {id} argument allows the request for a specific
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5901 match ID. If a specified ID is already taken, an error
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5902 message will appear and the match will not be added. An ID
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5903 is specified as a positive integer (zero excluded). IDs 1, 2
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5904 and 3 are reserved for \|:match\|, \|:2match\| and \|:3match\|,
29533 34c1f4cd0c18 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29450 diff changeset	5905 respectively. 3 is reserved for use by the \|matchparen\|
34c1f4cd0c18 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29450 diff changeset	5906 plugin.
29450 67f31c24291b Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29403 diff changeset	5907 If the {id} argument is not specified or -1, \|matchadd()\|
30574 66de6909e102 patch 9.0.0622: matchaddpos() can get slow when adding many matches Bram Moolenaar <Bram@vim.org> parents: 30570 diff changeset	5908 automatically chooses a free ID, which is at least 1000.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5909
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5910 The optional {dict} argument allows for further custom
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5911 values. Currently this is used to specify a match specific
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5912 conceal character that will be shown for \|hl-Conceal\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5913 highlighted matches. The dict can have the following members:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5914
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5915 conceal Special character to show instead of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5916 match (only for \|hl-Conceal\| highlighted
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5917 matches, see \|:syn-cchar\|)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5918 window Instead of the current window use the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5919 window with this number or window ID.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5920
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5921 The number of matches is not limited, as it is the case with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5922 the \|:match\| commands.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5923
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	5924 Returns -1 on error.
2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	5925
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5926 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5927 :highlight MyGroup ctermbg=green guibg=green
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5928 :let m = matchadd("MyGroup", "TODO")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5929 < Deletion of the pattern: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5930 :call matchdelete(m)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5931
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5932 < A list of matches defined by \|matchadd()\| and \|:match\| are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5933 available from \|getmatches()\|. All matches can be deleted in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5934 one operation by \|clearmatches()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5935
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5936 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5937 GetGroup()->matchadd('TODO')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5938 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5939 matchaddpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5940 matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5941 Same as \|matchadd()\|, but requires a list of positions {pos}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5942 instead of a pattern. This command is faster than \|matchadd()\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5943 because it does not require to handle regular expressions and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5944 sets buffer line boundaries to redraw screen. It is supposed
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5945 to be used when fast match additions and deletions are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5946 required, for example to highlight matching parentheses.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5947
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5948 {pos} is a list of positions. Each position can be one of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5949 these:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5950 - A number. This whole line will be highlighted. The first
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5951 line has number 1.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5952 - A list with one number, e.g., [23]. The whole line with this
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5953 number will be highlighted.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5954 - A list with two numbers, e.g., [23, 11]. The first number is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5955 the line number, the second one is the column number (first
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5956 column is 1, the value must correspond to the byte index as
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5957 \|col()\| would return). The character at this position will
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5958 be highlighted.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5959 - A list with three numbers, e.g., [23, 11, 3]. As above, but
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5960 the third number gives the length of the highlight in bytes.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5961
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	5962 Returns -1 on error.
2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	5963
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5964 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5965 :highlight MyGroup ctermbg=green guibg=green
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5966 :let m = matchaddpos("MyGroup", [[23, 24], 34])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5967 < Deletion of the pattern: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5968 :call matchdelete(m)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5969
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5970 < Matches added by \|matchaddpos()\| are returned by
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5971 \|getmatches()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5972
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5973 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5974 GetGroup()->matchaddpos([23, 11])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5975
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5976 matcharg({nr}) matcharg()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5977 Selects the {nr} match item, as set with a \|:match\|,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5978 \|:2match\| or \|:3match\| command.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5979 Return a \|List\| with two elements:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5980 The name of the highlight group used
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5981 The pattern used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5982 When {nr} is not 1, 2 or 3 returns an empty \|List\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5983 When there is no match item set returns ['', ''].
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5984 This is useful to save and restore a \|:match\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5985 Highlighting matches using the \|:match\| commands are limited
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5986 to three matches. \|matchadd()\| does not have this limitation.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5987
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5988 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5989 GetMatch()->matcharg()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5990
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5991 matchdelete({id} [, {win}) matchdelete() E802 E803
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5992 Deletes a match with ID {id} previously defined by \|matchadd()\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5993 or one of the \|:match\| commands. Returns 0 if successful,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5994 otherwise -1. See example for \|matchadd()\|. All matches can
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5995 be deleted in one operation by \|clearmatches()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5996 If {win} is specified, use the window with this number or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5997 window ID instead of the current window.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5998
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5999 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6000 GetMatch()->matchdelete()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6001
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6002 matchend({expr}, {pat} [, {start} [, {count}]]) matchend()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6003 Same as \|match()\|, but return the index of first character
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6004 after the match. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6005 :echo matchend("testing", "ing")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6006 < results in "7".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6007 strspn() strcspn()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6008 Vim doesn't have a strspn() or strcspn() function, but you can
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6009 do it with matchend(): >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6010 :let span = matchend(line, '[a-zA-Z]')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6011 :let span = matchend(line, '[^a-zA-Z]')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6012 < Except that -1 is returned when there are no matches.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6013
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6014 The {start}, if given, has the same meaning as for \|match()\|. >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6015 :echo matchend("testing", "ing", 2)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6016 < results in "7". >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6017 :echo matchend("testing", "ing", 5)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6018 < result is "-1".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6019 When {expr} is a \|List\| the result is equal to \|match()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6020
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6021 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6022 GetText()->matchend('word')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6023
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6024
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6025 matchfuzzy({list}, {str} [, {dict}]) matchfuzzy()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6026 If {list} is a list of strings, then returns a \|List\| with all
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6027 the strings in {list} that fuzzy match {str}. The strings in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6028 the returned list are sorted based on the matching score.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6029
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6030 The optional {dict} argument always supports the following
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6031 items:
28831 b5c46d447518 patch 8.2.4939: matchfuzzypos() with "matchseq" does not have all positions Bram Moolenaar <Bram@vim.org> parents: 28817 diff changeset	6032 matchseq When this item is present return only matches
b5c46d447518 patch 8.2.4939: matchfuzzypos() with "matchseq" does not have all positions Bram Moolenaar <Bram@vim.org> parents: 28817 diff changeset	6033 that contain the characters in {str} in the
b5c46d447518 patch 8.2.4939: matchfuzzypos() with "matchseq" does not have all positions Bram Moolenaar <Bram@vim.org> parents: 28817 diff changeset	6034 given sequence.
29194 f92f658585e6 patch 8.2.5116: "limit" option of matchfuzzy() not always respected Bram Moolenaar <Bram@vim.org> parents: 29193 diff changeset	6035 limit Maximum number of matches in {list} to be
f92f658585e6 patch 8.2.5116: "limit" option of matchfuzzy() not always respected Bram Moolenaar <Bram@vim.org> parents: 29193 diff changeset	6036 returned. Zero means no limit.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6037
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6038 If {list} is a list of dictionaries, then the optional {dict}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6039 argument supports the following additional items:
28471 2ade724b3f45 patch 8.2.4760: using matchfuzzy() on a long list can take a while Bram Moolenaar <Bram@vim.org> parents: 28431 diff changeset	6040 key Key of the item which is fuzzy matched against
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6041 {str}. The value of this item should be a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6042 string.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6043 text_cb \|Funcref\| that will be called for every item
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6044 in {list} to get the text for fuzzy matching.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6045 This should accept a dictionary item as the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6046 argument and return the text for that item to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6047 use for fuzzy matching.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6048
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6049 {str} is treated as a literal string and regular expression
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6050 matching is NOT supported. The maximum supported {str} length
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6051 is 256.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6052
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6053 When {str} has multiple words each separated by white space,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6054 then the list of strings that have all the words is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6055
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6056 If there are no matching strings or there is an error, then an
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6057 empty list is returned. If length of {str} is greater than
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6058 256, then returns an empty list.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6059
28471 2ade724b3f45 patch 8.2.4760: using matchfuzzy() on a long list can take a while Bram Moolenaar <Bram@vim.org> parents: 28431 diff changeset	6060 When {limit} is given, matchfuzzy() will find up to this
2ade724b3f45 patch 8.2.4760: using matchfuzzy() on a long list can take a while Bram Moolenaar <Bram@vim.org> parents: 28431 diff changeset	6061 number of matches in {list} and return them in sorted order.
2ade724b3f45 patch 8.2.4760: using matchfuzzy() on a long list can take a while Bram Moolenaar <Bram@vim.org> parents: 28431 diff changeset	6062
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	6063 Refer to \|fuzzy-matching\| for more information about fuzzy
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6064 matching strings.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6065
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6066 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6067 :echo matchfuzzy(["clay", "crow"], "cay")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6068 < results in ["clay"]. >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6069 :echo getbufinfo()->map({_, v -> v.name})->matchfuzzy("ndl")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6070 < results in a list of buffer names fuzzy matching "ndl". >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6071 :echo getbufinfo()->matchfuzzy("ndl", {'key' : 'name'})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6072 < results in a list of buffer information dicts with buffer
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6073 names fuzzy matching "ndl". >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6074 :echo getbufinfo()->matchfuzzy("spl",
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6075 \ {'text_cb' : {v -> v.name}})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6076 < results in a list of buffer information dicts with buffer
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6077 names fuzzy matching "spl". >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6078 :echo v:oldfiles->matchfuzzy("test")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6079 < results in a list of file names fuzzy matching "test". >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6080 :let l = readfile("buffer.c")->matchfuzzy("str")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6081 < results in a list of lines in "buffer.c" fuzzy matching "str". >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6082 :echo ['one two', 'two one']->matchfuzzy('two one')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6083 < results in ['two one', 'one two']. >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6084 :echo ['one two', 'two one']->matchfuzzy('two one',
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6085 \ {'matchseq': 1})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6086 < results in ['two one'].
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6087
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6088 matchfuzzypos({list}, {str} [, {dict}]) matchfuzzypos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6089 Same as \|matchfuzzy()\|, but returns the list of matched
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6090 strings, the list of character positions where characters
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6091 in {str} matches and a list of matching scores. You can
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6092 use \|byteidx()\| to convert a character position to a byte
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6093 position.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6094
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6095 If {str} matches multiple times in a string, then only the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6096 positions for the best match is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6097
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6098 If there are no matching strings or there is an error, then a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6099 list with three empty list items is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6100
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6101 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6102 :echo matchfuzzypos(['testing'], 'tsg')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6103 < results in [['testing'], [[0, 2, 6]], [99]] >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6104 :echo matchfuzzypos(['clay', 'lacy'], 'la')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6105 < results in [['lacy', 'clay'], [[0, 1], [1, 2]], [153, 133]] >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6106 :echo [{'text': 'hello', 'id' : 10}]->matchfuzzypos('ll', {'key' : 'text'})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6107 < results in [[{'id': 10, 'text': 'hello'}], [[2, 3]], [127]]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6108
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6109 matchlist({expr}, {pat} [, {start} [, {count}]]) matchlist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6110 Same as \|match()\|, but return a \|List\|. The first item in the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6111 list is the matched string, same as what matchstr() would
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6112 return. Following items are submatches, like "\1", "\2", etc.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6113 in \|:substitute\|. When an optional submatch didn't match an
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6114 empty string is used. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6115 echo matchlist('acd', '$a$\?$b$\?$c$\?$.*$')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6116 < Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', '']
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6117 When there is no match an empty list is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6118
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6119 You can pass in a List, but that is not very useful.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6120
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6121 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6122 GetText()->matchlist('word')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6123
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6124 matchstr({expr}, {pat} [, {start} [, {count}]]) matchstr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6125 Same as \|match()\|, but return the matched string. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6126 :echo matchstr("testing", "ing")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6127 < results in "ing".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6128 When there is no match "" is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6129 The {start}, if given, has the same meaning as for \|match()\|. >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6130 :echo matchstr("testing", "ing", 2)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6131 < results in "ing". >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6132 :echo matchstr("testing", "ing", 5)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6133 < result is "".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6134 When {expr} is a \|List\| then the matching item is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6135 The type isn't changed, it's not necessarily a String.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6136
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6137 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6138 GetText()->matchstr('word')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6139
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6140 matchstrpos({expr}, {pat} [, {start} [, {count}]]) matchstrpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6141 Same as \|matchstr()\|, but return the matched string, the start
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6142 position and the end position of the match. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6143 :echo matchstrpos("testing", "ing")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6144 < results in ["ing", 4, 7].
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6145 When there is no match ["", -1, -1] is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6146 The {start}, if given, has the same meaning as for \|match()\|. >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6147 :echo matchstrpos("testing", "ing", 2)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6148 < results in ["ing", 4, 7]. >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6149 :echo matchstrpos("testing", "ing", 5)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6150 < result is ["", -1, -1].
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6151 When {expr} is a \|List\| then the matching item, the index
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6152 of first item where {pat} matches, the start position and the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6153 end position of the match are returned. >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6154 :echo matchstrpos([1, '__x'], '\a')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6155 < result is ["x", 1, 2, 3].
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6156 The type isn't changed, it's not necessarily a String.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6157
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6158 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6159 GetText()->matchstrpos('word')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6160 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6161
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6162 max()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6163 max({expr}) Return the maximum value of all items in {expr}. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6164 echo max([apples, pears, oranges])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6165
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6166 < {expr} can be a \|List\| or a \|Dictionary\|. For a Dictionary,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6167 it returns the maximum of all values in the Dictionary.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6168 If {expr} is neither a List nor a Dictionary, or one of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6169 items in {expr} cannot be used as a Number this results in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6170 an error. An empty \|List\| or \|Dictionary\| results in zero.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6171
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6172 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6173 mylist->max()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6174
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6175
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6176 menu_info({name} [, {mode}]) menu_info()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6177 Return information about the specified menu {name} in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6178 mode {mode}. The menu name should be specified without the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6179 shortcut character ('&'). If {name} is "", then the top-level
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6180 menu names are returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6181
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6182 {mode} can be one of these strings:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6183 "n" Normal
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6184 "v" Visual (including Select)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6185 "o" Operator-pending
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6186 "i" Insert
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6187 "c" Cmd-line
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6188 "s" Select
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6189 "x" Visual
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6190 "t" Terminal-Job
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6191 "" Normal, Visual and Operator-pending
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6192 "!" Insert and Cmd-line
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6193 When {mode} is omitted, the modes for "" are used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6194
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6195 Returns a \|Dictionary\| containing the following items:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6196 accel menu item accelerator text \|menu-text\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6197 display display name (name without '&')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6198 enabled v:true if this menu item is enabled
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6199 Refer to \|:menu-enable\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6200 icon name of the icon file (for toolbar)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6201 \|toolbar-icon\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6202 iconidx index of a built-in icon
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6203 modes modes for which the menu is defined. In
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6204 addition to the modes mentioned above, these
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6205 characters will be used:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6206 " " Normal, Visual and Operator-pending
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6207 name menu item name.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6208 noremenu v:true if the {rhs} of the menu item is not
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6209 remappable else v:false.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6210 priority menu order priority \|menu-priority\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6211 rhs right-hand-side of the menu item. The returned
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6212 string has special characters translated like
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6213 in the output of the ":menu" command listing.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6214 When the {rhs} of a menu item is empty, then
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6215 "<Nop>" is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6216 script v:true if script-local remapping of {rhs} is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6217 allowed else v:false. See \|:menu-script\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6218 shortcut shortcut key (character after '&' in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6219 the menu name) \|menu-shortcut\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6220 silent v:true if the menu item is created
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6221 with <silent> argument \|:menu-silent\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6222 submenus \|List\| containing the names of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6223 all the submenus. Present only if the menu
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6224 item has submenus.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6225
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6226 Returns an empty dictionary if the menu item is not found.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6227
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6228 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6229 :echo menu_info('Edit.Cut')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6230 :echo menu_info('File.Save', 'n')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6231
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6232 " Display the entire menu hierarchy in a buffer
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6233 func ShowMenu(name, pfx)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6234 let m = menu_info(a:name)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6235 call append(line('$'), a:pfx .. m.display)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6236 for child in m->get('submenus', [])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6237 call ShowMenu(a:name .. '.' .. escape(child, '.'),
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6238 \ a:pfx .. ' ')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6239 endfor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6240 endfunc
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6241 new
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6242 for topmenu in menu_info('').submenus
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6243 call ShowMenu(topmenu, '')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6244 endfor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6245 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6246 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6247 GetMenuName()->menu_info('v')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6248
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6249
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6250 < min()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6251 min({expr}) Return the minimum value of all items in {expr}. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6252 echo min([apples, pears, oranges])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6253
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6254 < {expr} can be a \|List\| or a \|Dictionary\|. For a Dictionary,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6255 it returns the minimum of all values in the Dictionary.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6256 If {expr} is neither a List nor a Dictionary, or one of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6257 items in {expr} cannot be used as a Number this results in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6258 an error. An empty \|List\| or \|Dictionary\| results in zero.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6259
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6260 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6261 mylist->min()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6262
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6263 < mkdir() E739
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6264 mkdir({name} [, {path} [, {prot}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6265 Create directory {name}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6266
30150 0fe61fa4e5d1 patch 9.0.0411: only created files can be cleaned up with one call Bram Moolenaar <Bram@vim.org> parents: 30085 diff changeset	6267 If {path} contains "p" then intermediate directories are
0fe61fa4e5d1 patch 9.0.0411: only created files can be cleaned up with one call Bram Moolenaar <Bram@vim.org> parents: 30085 diff changeset	6268 created as necessary. Otherwise it must be "".
0fe61fa4e5d1 patch 9.0.0411: only created files can be cleaned up with one call Bram Moolenaar <Bram@vim.org> parents: 30085 diff changeset	6269
0fe61fa4e5d1 patch 9.0.0411: only created files can be cleaned up with one call Bram Moolenaar <Bram@vim.org> parents: 30085 diff changeset	6270 If {path} contains "D" then {name} is deleted at the end of
0fe61fa4e5d1 patch 9.0.0411: only created files can be cleaned up with one call Bram Moolenaar <Bram@vim.org> parents: 30085 diff changeset	6271 the current function, as with: >
0fe61fa4e5d1 patch 9.0.0411: only created files can be cleaned up with one call Bram Moolenaar <Bram@vim.org> parents: 30085 diff changeset	6272 defer delete({name}, 'd')
0fe61fa4e5d1 patch 9.0.0411: only created files can be cleaned up with one call Bram Moolenaar <Bram@vim.org> parents: 30085 diff changeset	6273 <
0fe61fa4e5d1 patch 9.0.0411: only created files can be cleaned up with one call Bram Moolenaar <Bram@vim.org> parents: 30085 diff changeset	6274 If {path} contains "R" then {name} is deleted recursively at
0fe61fa4e5d1 patch 9.0.0411: only created files can be cleaned up with one call Bram Moolenaar <Bram@vim.org> parents: 30085 diff changeset	6275 the end of the current function, as with: >
0fe61fa4e5d1 patch 9.0.0411: only created files can be cleaned up with one call Bram Moolenaar <Bram@vim.org> parents: 30085 diff changeset	6276 defer delete({name}, 'rf')
0fe61fa4e5d1 patch 9.0.0411: only created files can be cleaned up with one call Bram Moolenaar <Bram@vim.org> parents: 30085 diff changeset	6277 < Note that when {name} has more than one part and "p" is used
0fe61fa4e5d1 patch 9.0.0411: only created files can be cleaned up with one call Bram Moolenaar <Bram@vim.org> parents: 30085 diff changeset	6278 some directories may already exist. Only the first one that
0fe61fa4e5d1 patch 9.0.0411: only created files can be cleaned up with one call Bram Moolenaar <Bram@vim.org> parents: 30085 diff changeset	6279 is created and what it contains is scheduled to be deleted.
0fe61fa4e5d1 patch 9.0.0411: only created files can be cleaned up with one call Bram Moolenaar <Bram@vim.org> parents: 30085 diff changeset	6280 E.g. when using: >
0fe61fa4e5d1 patch 9.0.0411: only created files can be cleaned up with one call Bram Moolenaar <Bram@vim.org> parents: 30085 diff changeset	6281 call mkdir('subdir/tmp/autoload', 'pR')
0fe61fa4e5d1 patch 9.0.0411: only created files can be cleaned up with one call Bram Moolenaar <Bram@vim.org> parents: 30085 diff changeset	6282 < and "subdir" already exists then "subdir/tmp" will be
0fe61fa4e5d1 patch 9.0.0411: only created files can be cleaned up with one call Bram Moolenaar <Bram@vim.org> parents: 30085 diff changeset	6283 scheduled for deletion, like with: >
0fe61fa4e5d1 patch 9.0.0411: only created files can be cleaned up with one call Bram Moolenaar <Bram@vim.org> parents: 30085 diff changeset	6284 defer delete('subdir/tmp', 'rf')
0fe61fa4e5d1 patch 9.0.0411: only created files can be cleaned up with one call Bram Moolenaar <Bram@vim.org> parents: 30085 diff changeset	6285 < Note that if scheduling the defer fails the directory is not
0fe61fa4e5d1 patch 9.0.0411: only created files can be cleaned up with one call Bram Moolenaar <Bram@vim.org> parents: 30085 diff changeset	6286 deleted. This should only happen when out of memory.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6287
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6288 If {prot} is given it is used to set the protection bits of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6289 the new directory. The default is 0o755 (rwxr-xr-x: r/w for
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6290 the user, readable for others). Use 0o700 to make it
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6291 unreadable for others. This is only used for the last part of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6292 {name}. Thus if you create /tmp/foo/bar then /tmp/foo will be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6293 created with 0o755.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6294 Example: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	6295 :call mkdir($HOME .. "/tmp/foo/bar", "p", 0o700)
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6296
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6297 < This function is not available in the \|sandbox\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6298
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6299 There is no error if the directory already exists and the "p"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6300 flag is passed (since patch 8.0.1708). However, without the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6301 "p" option the call will fail.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6302
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6303 The function result is a Number, which is TRUE if the call was
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6304 successful or FALSE if the directory creation failed or partly
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6305 failed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6306
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6307 Not available on all systems. To check use: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6308 :if exists("*mkdir")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6309
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6310 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6311 GetName()->mkdir()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6312 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6313 mode()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6314 mode([expr]) Return a string that indicates the current mode.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6315 If [expr] is supplied and it evaluates to a non-zero Number or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6316 a non-empty String (\|non-zero-arg\|), then the full mode is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6317 returned, otherwise only the first letter is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6318 Also see \|state()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6319
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6320 n Normal
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6321 no Operator-pending
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6322 nov Operator-pending (forced characterwise \|o_v\|)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6323 noV Operator-pending (forced linewise \|o_V\|)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6324 noCTRL-V Operator-pending (forced blockwise \|o_CTRL-V\|);
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6325 CTRL-V is one character
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6326 niI Normal using \|i_CTRL-O\| in \|Insert-mode\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6327 niR Normal using \|i_CTRL-O\| in \|Replace-mode\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6328 niV Normal using \|i_CTRL-O\| in \|Virtual-Replace-mode\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6329 nt Terminal-Normal (insert goes to Terminal-Job mode)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6330 v Visual by character
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6331 vs Visual by character using \|v_CTRL-O\| in Select mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6332 V Visual by line
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6333 Vs Visual by line using \|v_CTRL-O\| in Select mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6334 CTRL-V Visual blockwise
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6335 CTRL-Vs Visual blockwise using \|v_CTRL-O\| in Select mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6336 s Select by character
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6337 S Select by line
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6338 CTRL-S Select blockwise
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6339 i Insert
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6340 ic Insert mode completion \|compl-generic\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6341 ix Insert mode \|i_CTRL-X\| completion
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6342 R Replace \|R\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6343 Rc Replace mode completion \|compl-generic\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6344 Rx Replace mode \|i_CTRL-X\| completion
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6345 Rv Virtual Replace \|gR\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6346 Rvc Virtual Replace mode completion \|compl-generic\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6347 Rvx Virtual Replace mode \|i_CTRL-X\| completion
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6348 c Command-line editing
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6349 cv Vim Ex mode \|gQ\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6350 ce Normal Ex mode \|Q\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6351 r Hit-enter prompt
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6352 rm The -- more -- prompt
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6353 r? A \|:confirm\| query of some sort
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6354 ! Shell or external command is executing
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6355 t Terminal-Job mode: keys go to the job
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6356
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6357 This is useful in the 'statusline' option or when used
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6358 with \|remote_expr()\| In most other places it always returns
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6359 "c" or "n".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6360 Note that in the future more modes and more specific modes may
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6361 be added. It's better not to compare the whole string but only
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6362 the leading character(s).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6363 Also see \|visualmode()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6364
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6365 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6366 DoFull()->mode()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6367
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6368 mzeval({expr}) mzeval()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6369 Evaluate MzScheme expression {expr} and return its result
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6370 converted to Vim data structures.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6371 Numbers and strings are returned as they are.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6372 Pairs (including lists and improper lists) and vectors are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6373 returned as Vim \|Lists\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6374 Hash tables are represented as Vim \|Dictionary\| type with keys
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6375 converted to strings.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6376 All other types are converted to string with display function.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6377 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6378 :mz (define l (list 1 2 3))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6379 :mz (define h (make-hash)) (hash-set! h "list" l)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6380 :echo mzeval("l")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6381 :echo mzeval("h")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6382 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6383 Note that in a `:def` function local variables are not visible
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6384 to {expr}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6385
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6386 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6387 GetExpr()->mzeval()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6388 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6389 {only available when compiled with the \|+mzscheme\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6390
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6391 nextnonblank({lnum}) nextnonblank()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6392 Return the line number of the first line at or below {lnum}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6393 that is not blank. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6394 if getline(nextnonblank(1)) =~ "Java"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6395 < When {lnum} is invalid or there is no non-blank line at or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6396 below it, zero is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6397 {lnum} is used like with \|getline()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6398 See also \|prevnonblank()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6399
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6400 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6401 GetLnum()->nextnonblank()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6402
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6403 nr2char({expr} [, {utf8}]) nr2char()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6404 Return a string with a single character, which has the number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6405 value {expr}. Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6406 nr2char(64) returns "@"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6407 nr2char(32) returns " "
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6408 < When {utf8} is omitted or zero, the current 'encoding' is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6409 Example for "utf-8": >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6410 nr2char(300) returns I with bow character
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6411 < When {utf8} is TRUE, always return UTF-8 characters.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6412 Note that a NUL character in the file is specified with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6413 nr2char(10), because NULs are represented with newline
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6414 characters. nr2char(0) is a real NUL and terminates the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6415 string, thus results in an empty string.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6416 To turn a list of character numbers into a string: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6417 let list = [65, 66, 67]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6418 let str = join(map(list, {_, val -> nr2char(val)}), '')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6419 < Result: "ABC"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6420
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6421 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6422 GetNumber()->nr2char()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6423
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6424 or({expr}, {expr}) or()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6425 Bitwise OR on the two arguments. The arguments are converted
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6426 to a number. A List, Dict or Float argument causes an error.
29024 9f25e0ed831d patch 8.2.5034: there is no way to get the byte index from a virtual column Bram Moolenaar <Bram@vim.org> parents: 29016 diff changeset	6427 Also see `and()` and `xor()`.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6428 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6429 :let bits = or(bits, 0x80)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6430 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6431 :let bits = bits->or(0x80)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6432
29024 9f25e0ed831d patch 8.2.5034: there is no way to get the byte index from a virtual column Bram Moolenaar <Bram@vim.org> parents: 29016 diff changeset	6433 < Rationale: The reason this is a function and not using the "\|"
9f25e0ed831d patch 8.2.5034: there is no way to get the byte index from a virtual column Bram Moolenaar <Bram@vim.org> parents: 29016 diff changeset	6434 character like many languages, is that Vi has always used "\|"
9f25e0ed831d patch 8.2.5034: there is no way to get the byte index from a virtual column Bram Moolenaar <Bram@vim.org> parents: 29016 diff changeset	6435 to separate commands. In many places it would not be clear if
9f25e0ed831d patch 8.2.5034: there is no way to get the byte index from a virtual column Bram Moolenaar <Bram@vim.org> parents: 29016 diff changeset	6436 "\|" is an operator or a command separator.
9f25e0ed831d patch 8.2.5034: there is no way to get the byte index from a virtual column Bram Moolenaar <Bram@vim.org> parents: 29016 diff changeset	6437
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6438
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6439 pathshorten({path} [, {len}]) pathshorten()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6440 Shorten directory names in the path {path} and return the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6441 result. The tail, the file name, is kept as-is. The other
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6442 components in the path are reduced to {len} letters in length.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6443 If {len} is omitted or smaller than 1 then 1 is used (single
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6444 letters). Leading '~' and '.' characters are kept. Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6445 :echo pathshorten('~/.vim/autoload/myfile.vim')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6446 < ~/.v/a/myfile.vim ~
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6447 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6448 :echo pathshorten('~/.vim/autoload/myfile.vim', 2)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6449 < ~/.vi/au/myfile.vim ~
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6450 It doesn't matter if the path exists or not.
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	6451 Returns an empty string on error.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6452
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6453 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6454 GetDirectories()->pathshorten()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6455
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6456 perleval({expr}) perleval()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6457 Evaluate Perl expression {expr} in scalar context and return
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6458 its result converted to Vim data structures. If value can't be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6459 converted, it is returned as a string Perl representation.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6460 Note: If you want an array or hash, {expr} must return a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6461 reference to it.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6462 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6463 :echo perleval('[1 .. 4]')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6464 < [1, 2, 3, 4]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6465
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6466 Note that in a `:def` function local variables are not visible
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6467 to {expr}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6468
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6469 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6470 GetExpr()->perleval()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6471
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6472 < {only available when compiled with the \|+perl\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6473
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6474
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6475 popup_ functions are documented here: \|popup-functions\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6476
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6477
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6478 pow({x}, {y}) pow()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6479 Return the power of {x} to the exponent {y} as a \|Float\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6480 {x} and {y} must evaluate to a \|Float\| or a \|Number\|.
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	6481 Returns 0.0 if {x} or {y} is not a \|Float\| or a \|Number\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6482 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6483 :echo pow(3, 3)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6484 < 27.0 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6485 :echo pow(2, 16)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6486 < 65536.0 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6487 :echo pow(32, 0.20)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6488 < 2.0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6489
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6490 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6491 Compute()->pow(3)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6492
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6493 prevnonblank({lnum}) prevnonblank()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6494 Return the line number of the first line at or above {lnum}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6495 that is not blank. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6496 let ind = indent(prevnonblank(v:lnum - 1))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6497 < When {lnum} is invalid or there is no non-blank line at or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6498 above it, zero is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6499 {lnum} is used like with \|getline()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6500 Also see \|nextnonblank()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6501
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6502 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6503 GetLnum()->prevnonblank()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6504
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6505 printf({fmt}, {expr1} ...) printf()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6506 Return a String with {fmt}, where "%" items are replaced by
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6507 the formatted form of their respective arguments. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6508 printf("%4d: E%d %.30s", lnum, errno, msg)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6509 < May result in:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6510 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6511
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6512 When used as a \|method\| the base is passed as the second
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6513 argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6514 Compute()->printf("result: %d")
28379 6dd88e45d47d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28307 diff changeset	6515 <
6dd88e45d47d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28307 diff changeset	6516 You can use `call()` to pass the items as a list.
6dd88e45d47d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28307 diff changeset	6517
6dd88e45d47d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28307 diff changeset	6518 Often used items are:
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6519 %s string
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6520 %6S string right-aligned in 6 display cells
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6521 %6s string right-aligned in 6 bytes
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6522 %.9s string truncated to 9 bytes
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6523 %c single byte
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6524 %d decimal number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6525 %5d decimal number padded with spaces to 5 characters
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6526 %x hex number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6527 %04x hex number padded with zeros to at least 4 characters
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6528 %X hex number using upper case letters
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6529 %o octal number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6530 %08b binary number padded with zeros to at least 8 chars
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6531 %f floating point number as 12.23, inf, -inf or nan
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6532 %F floating point number as 12.23, INF, -INF or NAN
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6533 %e floating point number as 1.23e3, inf, -inf or nan
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6534 %E floating point number as 1.23E3, INF, -INF or NAN
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6535 %g floating point number, as %f or %e depending on value
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6536 %G floating point number, as %F or %E depending on value
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6537 %% the % character itself
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6538
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6539 Conversion specifications start with '%' and end with the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6540 conversion type. All other characters are copied unchanged to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6541 the result.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6542
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6543 The "%" starts a conversion specification. The following
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6544 arguments appear in sequence:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6545
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6546 % [flags] [field-width] [.precision] type
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6547
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6548 flags
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6549 Zero or more of the following flags:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6550
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6551 # The value should be converted to an "alternate
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6552 form". For c, d, and s conversions, this option
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6553 has no effect. For o conversions, the precision
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6554 of the number is increased to force the first
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6555 character of the output string to a zero (except
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6556 if a zero value is printed with an explicit
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6557 precision of zero).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6558 For b and B conversions, a non-zero result has
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6559 the string "0b" (or "0B" for B conversions)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6560 prepended to it.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6561 For x and X conversions, a non-zero result has
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6562 the string "0x" (or "0X" for X conversions)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6563 prepended to it.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6564
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6565 0 (zero) Zero padding. For all conversions the converted
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6566 value is padded on the left with zeros rather
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6567 than blanks. If a precision is given with a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6568 numeric conversion (d, b, B, o, x, and X), the 0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6569 flag is ignored.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6570
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6571 - A negative field width flag; the converted value
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6572 is to be left adjusted on the field boundary.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6573 The converted value is padded on the right with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6574 blanks, rather than on the left with blanks or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6575 zeros. A - overrides a 0 if both are given.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6576
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6577 ' ' (space) A blank should be left before a positive
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6578 number produced by a signed conversion (d).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6579
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6580 + A sign must always be placed before a number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6581 produced by a signed conversion. A + overrides
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6582 a space if both are used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6583
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6584 field-width
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6585 An optional decimal digit string specifying a minimum
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6586 field width. If the converted value has fewer bytes
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6587 than the field width, it will be padded with spaces on
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6588 the left (or right, if the left-adjustment flag has
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6589 been given) to fill out the field width. For the S
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6590 conversion the count is in cells.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6591
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6592 .precision
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6593 An optional precision, in the form of a period '.'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6594 followed by an optional digit string. If the digit
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6595 string is omitted, the precision is taken as zero.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6596 This gives the minimum number of digits to appear for
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6597 d, o, x, and X conversions, the maximum number of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6598 bytes to be printed from a string for s conversions,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6599 or the maximum number of cells to be printed from a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6600 string for S conversions.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6601 For floating point it is the number of digits after
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6602 the decimal point.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6603
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6604 type
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6605 A character that specifies the type of conversion to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6606 be applied, see below.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6607
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6608 A field width or precision, or both, may be indicated by an
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6609 asterisk '*' instead of a digit string. In this case, a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6610 Number argument supplies the field width or precision. A
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6611 negative field width is treated as a left adjustment flag
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6612 followed by a positive field width; a negative precision is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6613 treated as though it were missing. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6614 :echo printf("%d: %.*s", nr, width, line)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6615 < This limits the length of the text used from "line" to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6616 "width" bytes.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6617
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6618 The conversion specifiers and their meanings are:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6619
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6620 printf-d printf-b printf-B printf-o
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6621 printf-x printf-X
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6622 dbBoxX The Number argument is converted to signed decimal
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6623 (d), unsigned binary (b and B), unsigned octal (o), or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6624 unsigned hexadecimal (x and X) notation. The letters
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6625 "abcdef" are used for x conversions; the letters
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6626 "ABCDEF" are used for X conversions.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6627 The precision, if any, gives the minimum number of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6628 digits that must appear; if the converted value
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6629 requires fewer digits, it is padded on the left with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6630 zeros.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6631 In no case does a non-existent or small field width
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6632 cause truncation of a numeric field; if the result of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6633 a conversion is wider than the field width, the field
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6634 is expanded to contain the conversion result.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6635 The 'h' modifier indicates the argument is 16 bits.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6636 The 'l' modifier indicates the argument is 32 bits.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6637 The 'L' modifier indicates the argument is 64 bits.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6638 Generally, these modifiers are not useful. They are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6639 ignored when type is known from the argument.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6640
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6641 i alias for d
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6642 D alias for ld
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6643 U alias for lu
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6644 O alias for lo
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6645
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6646 printf-c
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6647 c The Number argument is converted to a byte, and the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6648 resulting character is written.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6649
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6650 printf-s
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6651 s The text of the String argument is used. If a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6652 precision is specified, no more bytes than the number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6653 specified are used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6654 If the argument is not a String type, it is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6655 automatically converted to text with the same format
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6656 as ":echo".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6657 printf-S
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6658 S The text of the String argument is used. If a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6659 precision is specified, no more display cells than the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6660 number specified are used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6661
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6662 printf-f E807
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6663 f F The Float argument is converted into a string of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6664 form 123.456. The precision specifies the number of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6665 digits after the decimal point. When the precision is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6666 zero the decimal point is omitted. When the precision
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6667 is not specified 6 is used. A really big number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6668 (out of range or dividing by zero) results in "inf"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6669 or "-inf" with %f (INF or -INF with %F).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6670 "0.0 / 0.0" results in "nan" with %f (NAN with %F).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6671 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6672 echo printf("%.2f", 12.115)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6673 < 12.12
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6674 Note that roundoff depends on the system libraries.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6675 Use \|round()\| when in doubt.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6676
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6677 printf-e printf-E
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6678 e E The Float argument is converted into a string of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6679 form 1.234e+03 or 1.234E+03 when using 'E'. The
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6680 precision specifies the number of digits after the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6681 decimal point, like with 'f'.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6682
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6683 printf-g printf-G
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6684 g G The Float argument is converted like with 'f' if the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6685 value is between 0.001 (inclusive) and 10000000.0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6686 (exclusive). Otherwise 'e' is used for 'g' and 'E'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6687 for 'G'. When no precision is specified superfluous
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6688 zeroes and '+' signs are removed, except for the zero
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6689 immediately after the decimal point. Thus 10000000.0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6690 results in 1.0e7.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6691
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6692 printf-%
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6693 % A '%' is written. No argument is converted. The
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6694 complete conversion specification is "%%".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6695
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6696 When a Number argument is expected a String argument is also
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6697 accepted and automatically converted.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6698 When a Float or String argument is expected a Number argument
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6699 is also accepted and automatically converted.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6700 Any other argument type results in an error message.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6701
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6702 E766 E767
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6703 The number of {exprN} arguments must exactly match the number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6704 of "%" items. If there are not sufficient or too many
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6705 arguments an error is given. Up to 18 arguments can be used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6706
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6707
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6708 prompt_getprompt({buf}) prompt_getprompt()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6709 Returns the effective prompt text for buffer {buf}. {buf} can
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6710 be a buffer name or number. See \|prompt-buffer\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6711
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6712 If the buffer doesn't exist or isn't a prompt buffer, an empty
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6713 string is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6714
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6715 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6716 GetBuffer()->prompt_getprompt()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6717
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6718 < {only available when compiled with the \|+channel\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6719
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6720
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6721 prompt_setcallback({buf}, {expr}) prompt_setcallback()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6722 Set prompt callback for buffer {buf} to {expr}. When {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6723 is an empty string the callback is removed. This has only
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6724 effect if {buf} has 'buftype' set to "prompt".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6725
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6726 The callback is invoked when pressing Enter. The current
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6727 buffer will always be the prompt buffer. A new line for a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6728 prompt is added before invoking the callback, thus the prompt
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6729 for which the callback was invoked will be in the last but one
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6730 line.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6731 If the callback wants to add text to the buffer, it must
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6732 insert it above the last line, since that is where the current
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6733 prompt is. This can also be done asynchronously.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6734 The callback is invoked with one argument, which is the text
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6735 that was entered at the prompt. This can be an empty string
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6736 if the user only typed Enter.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6737 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6738 call prompt_setcallback(bufnr(), function('s:TextEntered'))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6739 func s:TextEntered(text)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6740 if a:text == 'exit' \|\| a:text == 'quit'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6741 stopinsert
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6742 close
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6743 else
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	6744 call append(line('$') - 1, 'Entered: "' .. a:text .. '"')
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6745 " Reset 'modified' to allow the buffer to be closed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6746 set nomodified
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6747 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6748 endfunc
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6749
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6750 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6751 GetBuffer()->prompt_setcallback(callback)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6752
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6753 < {only available when compiled with the \|+channel\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6754
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6755 prompt_setinterrupt({buf}, {expr}) prompt_setinterrupt()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6756 Set a callback for buffer {buf} to {expr}. When {expr} is an
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6757 empty string the callback is removed. This has only effect if
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6758 {buf} has 'buftype' set to "prompt".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6759
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6760 This callback will be invoked when pressing CTRL-C in Insert
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6761 mode. Without setting a callback Vim will exit Insert mode,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6762 as in any buffer.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6763
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6764 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6765 GetBuffer()->prompt_setinterrupt(callback)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6766
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6767 < {only available when compiled with the \|+channel\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6768
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6769 prompt_setprompt({buf}, {text}) prompt_setprompt()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6770 Set prompt for buffer {buf} to {text}. You most likely want
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6771 {text} to end in a space.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6772 The result is only visible if {buf} has 'buftype' set to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6773 "prompt". Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6774 call prompt_setprompt(bufnr(), 'command: ')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6775 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6776 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6777 GetBuffer()->prompt_setprompt('command: ')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6778
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6779 < {only available when compiled with the \|+channel\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6780
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6781 prop_ functions are documented here: \|text-prop-functions\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6782
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6783 pum_getpos() pum_getpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6784 If the popup menu (see \|ins-completion-menu\|) is not visible,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6785 returns an empty \|Dictionary\|, otherwise, returns a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6786 \|Dictionary\| with the following keys:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6787 height nr of items visible
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6788 width screen cells
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6789 row top screen row (0 first row)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6790 col leftmost screen column (0 first col)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6791 size total nr of items
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6792 scrollbar \|TRUE\| if scrollbar is visible
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6793
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6794 The values are the same as in \|v:event\| during
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6795 \|CompleteChanged\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6796
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6797 pumvisible() pumvisible()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6798 Returns non-zero when the popup menu is visible, zero
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6799 otherwise. See \|ins-completion-menu\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6800 This can be used to avoid some things that would remove the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6801 popup menu.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6802
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6803 py3eval({expr}) py3eval()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6804 Evaluate Python expression {expr} and return its result
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6805 converted to Vim data structures.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6806 Numbers and strings are returned as they are (strings are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6807 copied though, Unicode strings are additionally converted to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6808 'encoding').
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6809 Lists are represented as Vim \|List\| type.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6810 Dictionaries are represented as Vim \|Dictionary\| type with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6811 keys converted to strings.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6812 Note that in a `:def` function local variables are not visible
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6813 to {expr}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6814
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6815 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6816 GetExpr()->py3eval()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6817
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6818 < {only available when compiled with the \|+python3\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6819
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6820 E858 E859
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6821 pyeval({expr}) pyeval()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6822 Evaluate Python expression {expr} and return its result
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6823 converted to Vim data structures.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6824 Numbers and strings are returned as they are (strings are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6825 copied though).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6826 Lists are represented as Vim \|List\| type.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6827 Dictionaries are represented as Vim \|Dictionary\| type,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6828 non-string keys result in error.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6829 Note that in a `:def` function local variables are not visible
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6830 to {expr}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6831
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6832 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6833 GetExpr()->pyeval()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6834
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6835 < {only available when compiled with the \|+python\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6836
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6837 pyxeval({expr}) pyxeval()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6838 Evaluate Python expression {expr} and return its result
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6839 converted to Vim data structures.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6840 Uses Python 2 or 3, see \|python_x\| and 'pyxversion'.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6841 See also: \|pyeval()\|, \|py3eval()\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6842
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6843 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6844 GetExpr()->pyxeval()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6845
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6846 < {only available when compiled with the \|+python\| or the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6847 \|+python3\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6848
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6849 rand([{expr}]) rand() random
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6850 Return a pseudo-random Number generated with an xoshiro128**
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6851 algorithm using seed {expr}. The returned number is 32 bits,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6852 also on 64 bits systems, for consistency.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6853 {expr} can be initialized by \|srand()\| and will be updated by
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6854 rand(). If {expr} is omitted, an internal seed value is used
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6855 and updated.
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	6856 Returns -1 if {expr} is invalid.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6857
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6858 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6859 :echo rand()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6860 :let seed = srand()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6861 :echo rand(seed)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6862 :echo rand(seed) % 16 " random number 0 - 15
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6863 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6864
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6865 E726 E727
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6866 range({expr} [, {max} [, {stride}]]) range()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6867 Returns a \|List\| with Numbers:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6868 - If only {expr} is specified: [0, 1, ..., {expr} - 1]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6869 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6870 - If {stride} is specified: [{expr}, {expr} + {stride}, ...,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6871 {max}] (increasing {expr} with {stride} each time, not
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6872 producing a value past {max}).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6873 When the maximum is one before the start the result is an
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6874 empty list. When the maximum is more than one before the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6875 start this is an error.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6876 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6877 range(4) " [0, 1, 2, 3]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6878 range(2, 4) " [2, 3, 4]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6879 range(2, 9, 3) " [2, 5, 8]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6880 range(2, -2, -1) " [2, 1, 0, -1, -2]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6881 range(0) " []
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6882 range(2, 0) " error!
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6883 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6884 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6885 GetExpr()->range()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6886 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6887
30922 ed6acfafa17e patch 9.0.0795: readblob() always reads the whole file Bram Moolenaar <Bram@vim.org> parents: 30875 diff changeset	6888 readblob({fname} [, {offset} [, {size}]]) readblob()
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6889 Read file {fname} in binary mode and return a \|Blob\|.
30922 ed6acfafa17e patch 9.0.0795: readblob() always reads the whole file Bram Moolenaar <Bram@vim.org> parents: 30875 diff changeset	6890 If {offset} is specified, read the file from the specified
ed6acfafa17e patch 9.0.0795: readblob() always reads the whole file Bram Moolenaar <Bram@vim.org> parents: 30875 diff changeset	6891 offset. If it is a negative value, it is used as an offset
ed6acfafa17e patch 9.0.0795: readblob() always reads the whole file Bram Moolenaar <Bram@vim.org> parents: 30875 diff changeset	6892 from the end of the file. E.g., to read the last 12 bytes: >
ed6acfafa17e patch 9.0.0795: readblob() always reads the whole file Bram Moolenaar <Bram@vim.org> parents: 30875 diff changeset	6893 readblob('file.bin', -12)
ed6acfafa17e patch 9.0.0795: readblob() always reads the whole file Bram Moolenaar <Bram@vim.org> parents: 30875 diff changeset	6894 < If {size} is specified, only the specified size will be read.
ed6acfafa17e patch 9.0.0795: readblob() always reads the whole file Bram Moolenaar <Bram@vim.org> parents: 30875 diff changeset	6895 E.g. to read the first 100 bytes of a file: >
ed6acfafa17e patch 9.0.0795: readblob() always reads the whole file Bram Moolenaar <Bram@vim.org> parents: 30875 diff changeset	6896 readblob('file.bin', 0, 100)
ed6acfafa17e patch 9.0.0795: readblob() always reads the whole file Bram Moolenaar <Bram@vim.org> parents: 30875 diff changeset	6897 < If {size} is -1 or omitted, the whole data starting from
ed6acfafa17e patch 9.0.0795: readblob() always reads the whole file Bram Moolenaar <Bram@vim.org> parents: 30875 diff changeset	6898 {offset} will be read.
30938 84f6f91ca02a patch 9.0.0803: readblob() cannot read from character device Bram Moolenaar <Bram@vim.org> parents: 30922 diff changeset	6899 This can be also used to read the data from a character device
84f6f91ca02a patch 9.0.0803: readblob() cannot read from character device Bram Moolenaar <Bram@vim.org> parents: 30922 diff changeset	6900 on Unix when {size} is explicitly set. Only if the device
84f6f91ca02a patch 9.0.0803: readblob() cannot read from character device Bram Moolenaar <Bram@vim.org> parents: 30922 diff changeset	6901 supports seeking {offset} can be used. Otherwise it should be
84f6f91ca02a patch 9.0.0803: readblob() cannot read from character device Bram Moolenaar <Bram@vim.org> parents: 30922 diff changeset	6902 zero. E.g. to read 10 bytes from a serial console: >
84f6f91ca02a patch 9.0.0803: readblob() cannot read from character device Bram Moolenaar <Bram@vim.org> parents: 30922 diff changeset	6903 readblob('/dev/ttyS0', 0, 10)
84f6f91ca02a patch 9.0.0803: readblob() cannot read from character device Bram Moolenaar <Bram@vim.org> parents: 30922 diff changeset	6904 < When the file can't be opened an error message is given and
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6905 the result is an empty \|Blob\|.
30952 61558a67630a patch 9.0.0810: readblob() returns empty when trying to read too much Bram Moolenaar <Bram@vim.org> parents: 30938 diff changeset	6906 When the offset is beyond the end of the file the result is an
61558a67630a patch 9.0.0810: readblob() returns empty when trying to read too much Bram Moolenaar <Bram@vim.org> parents: 30938 diff changeset	6907 empty blob.
61558a67630a patch 9.0.0810: readblob() returns empty when trying to read too much Bram Moolenaar <Bram@vim.org> parents: 30938 diff changeset	6908 When trying to read more bytes than are available the result
61558a67630a patch 9.0.0810: readblob() returns empty when trying to read too much Bram Moolenaar <Bram@vim.org> parents: 30938 diff changeset	6909 is truncated.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6910 Also see \|readfile()\| and \|writefile()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6911
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6912
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6913 readdir({directory} [, {expr} [, {dict}]]) readdir()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6914 Return a list with file and directory names in {directory}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6915 You can also use \|glob()\| if you don't need to do complicated
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6916 things, such as limiting the number of matches.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6917 The list will be sorted (case sensitive), see the {dict}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6918 argument below for changing the sort order.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6919
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6920 When {expr} is omitted all entries are included.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6921 When {expr} is given, it is evaluated to check what to do:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6922 If {expr} results in -1 then no further entries will
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6923 be handled.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6924 If {expr} results in 0 then this entry will not be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6925 added to the list.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6926 If {expr} results in 1 then this entry will be added
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6927 to the list.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6928 The entries "." and ".." are always excluded.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6929 Each time {expr} is evaluated \|v:val\| is set to the entry name.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6930 When {expr} is a function the name is passed as the argument.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6931 For example, to get a list of files ending in ".txt": >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6932 readdir(dirname, {n -> n =~ '.txt$'})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6933 < To skip hidden and backup files: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6934 readdir(dirname, {n -> n !~ '^\.\\|\~$'})
27321 3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27223 diff changeset	6935 < E857
3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27223 diff changeset	6936 The optional {dict} argument allows for further custom
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6937 values. Currently this is used to specify if and how sorting
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6938 should be performed. The dict can have the following members:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6939
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6940 sort How to sort the result returned from the system.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6941 Valid values are:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6942 "none" do not sort (fastest method)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6943 "case" sort case sensitive (byte value of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6944 each character, technically, using
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6945 strcmp()) (default)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6946 "icase" sort case insensitive (technically
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6947 using strcasecmp())
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6948 "collate" sort using the collation order
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6949 of the "POSIX" or "C" \|locale\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6950 (technically using strcoll())
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6951 Other values are silently ignored.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6952
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6953 For example, to get a list of all files in the current
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6954 directory without sorting the individual entries: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6955 readdir('.', '1', #{sort: 'none'})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6956 < If you want to get a directory tree: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6957 function! s:tree(dir)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6958 return {a:dir : map(readdir(a:dir),
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6959 \ {_, x -> isdirectory(x) ?
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	6960 \ {x : s:tree(a:dir .. '/' .. x)} : x})}
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6961 endfunction
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6962 echo s:tree(".")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6963 <
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	6964 Returns an empty List on error.
2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	6965
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6966 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6967 GetDirName()->readdir()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6968 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6969 readdirex({directory} [, {expr} [, {dict}]]) readdirex()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6970 Extended version of \|readdir()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6971 Return a list of Dictionaries with file and directory
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6972 information in {directory}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6973 This is useful if you want to get the attributes of file and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6974 directory at the same time as getting a list of a directory.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6975 This is much faster than calling \|readdir()\| then calling
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6976 \|getfperm()\|, \|getfsize()\|, \|getftime()\| and \|getftype()\| for
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6977 each file and directory especially on MS-Windows.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6978 The list will by default be sorted by name (case sensitive),
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6979 the sorting can be changed by using the optional {dict}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6980 argument, see \|readdir()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6981
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6982 The Dictionary for file and directory information has the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6983 following items:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6984 group Group name of the entry. (Only on Unix)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6985 name Name of the entry.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6986 perm Permissions of the entry. See \|getfperm()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6987 size Size of the entry. See \|getfsize()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6988 time Timestamp of the entry. See \|getftime()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6989 type Type of the entry.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6990 On Unix, almost same as \|getftype()\| except:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6991 Symlink to a dir "linkd"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6992 Other symlink "link"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6993 On MS-Windows:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6994 Normal file "file"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6995 Directory "dir"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6996 Junction "junction"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6997 Symlink to a dir "linkd"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6998 Other symlink "link"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6999 Other reparse point "reparse"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7000 user User name of the entry's owner. (Only on Unix)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7001 On Unix, if the entry is a symlink, the Dictionary includes
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7002 the information of the target (except the "type" item).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7003 On MS-Windows, it includes the information of the symlink
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7004 itself because of performance reasons.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7005
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7006 When {expr} is omitted all entries are included.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7007 When {expr} is given, it is evaluated to check what to do:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7008 If {expr} results in -1 then no further entries will
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7009 be handled.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7010 If {expr} results in 0 then this entry will not be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7011 added to the list.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7012 If {expr} results in 1 then this entry will be added
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7013 to the list.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7014 The entries "." and ".." are always excluded.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7015 Each time {expr} is evaluated \|v:val\| is set to a \|Dictionary\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7016 of the entry.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7017 When {expr} is a function the entry is passed as the argument.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7018 For example, to get a list of files ending in ".txt": >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7019 readdirex(dirname, {e -> e.name =~ '.txt$'})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7020 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7021 For example, to get a list of all files in the current
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7022 directory without sorting the individual entries: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7023 readdirex(dirname, '1', #{sort: 'none'})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7024 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7025 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7026 GetDirName()->readdirex()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7027 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7028
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7029 readfile()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7030 readfile({fname} [, {type} [, {max}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7031 Read file {fname} and return a \|List\|, each line of the file
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7032 as an item. Lines are broken at NL characters. Macintosh
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7033 files separated with CR will result in a single long line
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7034 (unless a NL appears somewhere).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7035 All NUL characters are replaced with a NL character.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7036 When {type} contains "b" binary mode is used:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7037 - When the last line ends in a NL an extra empty list item is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7038 added.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7039 - No CR characters are removed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7040 Otherwise:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7041 - CR characters that appear before a NL are removed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7042 - Whether the last line ends in a NL or not does not matter.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7043 - When 'encoding' is Unicode any UTF-8 byte order mark is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7044 removed from the text.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7045 When {max} is given this specifies the maximum number of lines
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7046 to be read. Useful if you only want to check the first ten
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7047 lines of a file: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7048 :for line in readfile(fname, '', 10)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7049 : if line =~ 'Date' \| echo line \| endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7050 :endfor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7051 < When {max} is negative -{max} lines from the end of the file
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7052 are returned, or as many as there are.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7053 When {max} is zero the result is an empty list.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7054 Note that without {max} the whole file is read into memory.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7055 Also note that there is no recognition of encoding. Read a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7056 file into a buffer if you need to.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7057 Deprecated (use \|readblob()\| instead): When {type} contains
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7058 "B" a \|Blob\| is returned with the binary data of the file
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7059 unmodified.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7060 When the file can't be opened an error message is given and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7061 the result is an empty list.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7062 Also see \|writefile()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7063
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7064 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7065 GetFileName()->readfile()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7066
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7067 reduce({object}, {func} [, {initial}]) reduce() E998
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7068 {func} is called for every item in {object}, which can be a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7069 \|String\|, \|List\| or a \|Blob\|. {func} is called with two
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7070 arguments: the result so far and current item. After
27459 5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	7071 processing all items the result is returned. E1132
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7072
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7073 {initial} is the initial result. When omitted, the first item
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7074 in {object} is used and {func} is first called for the second
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7075 item. If {initial} is not given and {object} is empty no
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7076 result can be computed, an E998 error is given.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7077
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7078 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7079 echo reduce([1, 3, 5], { acc, val -> acc + val })
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7080 echo reduce(['x', 'y'], { acc, val -> acc .. val }, 'a')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7081 echo reduce(0z1122, { acc, val -> 2 * acc + val })
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7082 echo reduce('xyz', { acc, val -> acc .. ',' .. val })
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7083 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7084 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7085 echo mylist->reduce({ acc, val -> acc + val }, 0)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7086
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7087
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7088 reg_executing() reg_executing()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7089 Returns the single letter name of the register being executed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7090 Returns an empty string when no register is being executed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7091 See \|@\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7092
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7093 reg_recording() reg_recording()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7094 Returns the single letter name of the register being recorded.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7095 Returns an empty string when not recording. See \|q\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7096
30634 f68f43043842 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30574 diff changeset	7097 reltime()
f68f43043842 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30574 diff changeset	7098 reltime({start})
f68f43043842 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30574 diff changeset	7099 reltime({start}, {end}) reltime()
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7100 Return an item that represents a time value. The item is a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7101 list with items that depend on the system. In Vim 9 script
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7102 list<any> can be used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7103 The item can be passed to \|reltimestr()\| to convert it to a
30634 f68f43043842 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30574 diff changeset	7104 string or \|reltimefloat()\| to convert to a Float. For
f68f43043842 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30574 diff changeset	7105 example, to see the time spent in function Work(): >
f68f43043842 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30574 diff changeset	7106 var startTime = reltime()
f68f43043842 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30574 diff changeset	7107 Work()
f68f43043842 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30574 diff changeset	7108 echo startTime->reltime()->reltimestr()
f68f43043842 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30574 diff changeset	7109 <
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	7110 Without an argument reltime() returns the current time (the
29314 f8116058ca76 release version 9.0 Bram Moolenaar <Bram@vim.org> parents: 29307 diff changeset	7111 representation is system-dependent, it can not be used as the
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	7112 wall-clock time, see \|localtime()\| for that).
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7113 With one argument is returns the time passed since the time
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7114 specified in the argument.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7115 With two arguments it returns the time passed between {start}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7116 and {end}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7117
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7118 The {start} and {end} arguments must be values returned by
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	7119 reltime(). If there is an error an empty List is returned in
2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	7120 legacy script, in Vim9 script an error is given.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7121
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7122 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7123 GetStart()->reltime()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7124 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7125 {only available when compiled with the \|+reltime\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7126
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7127 reltimefloat({time}) reltimefloat()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7128 Return a Float that represents the time value of {time}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7129 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7130 let start = reltime()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7131 call MyFunction()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7132 let seconds = reltimefloat(reltime(start))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7133 < See the note of reltimestr() about overhead.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7134 Also see \|profiling\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7135 If there is an error 0.0 is returned in legacy script, in Vim9
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7136 script an error is given.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7137
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7138 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7139 reltime(start)->reltimefloat()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7140
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7141 < {only available when compiled with the \|+reltime\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7142
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7143 reltimestr({time}) reltimestr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7144 Return a String that represents the time value of {time}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7145 This is the number of seconds, a dot and the number of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7146 microseconds. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7147 let start = reltime()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7148 call MyFunction()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7149 echo reltimestr(reltime(start))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7150 < Note that overhead for the commands will be added to the time.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7151 The accuracy depends on the system.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7152 Leading spaces are used to make the string align nicely. You
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7153 can use split() to remove it. >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7154 echo split(reltimestr(reltime(start)))[0]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7155 < Also see \|profiling\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7156 If there is an error an empty string is returned in legacy
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7157 script, in Vim9 script an error is given.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7158
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7159 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7160 reltime(start)->reltimestr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7161
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7162 < {only available when compiled with the \|+reltime\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7163
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7164 remote_expr() E449
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7165 remote_expr({server}, {string} [, {idvar} [, {timeout}]])
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	7166 Send the {string} to {server}. The {server} argument is a
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	7167 string, also see \|{server}\|.
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	7168
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	7169 The string is sent as an expression and the result is returned
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	7170 after evaluation. The result must be a String or a \|List\|. A
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	7171 \|List\| is turned into a String by joining the items with a
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	7172 line break in between (not at the end), like with join(expr,
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	7173 "\n").
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	7174
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7175 If {idvar} is present and not empty, it is taken as the name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7176 of a variable and a {serverid} for later use with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7177 \|remote_read()\| is stored there.
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	7178
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7179 If {timeout} is given the read times out after this many
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7180 seconds. Otherwise a timeout of 600 seconds is used.
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	7181
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7182 See also \|clientserver\| \|RemoteReply\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7183 This function is not available in the \|sandbox\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7184 {only available when compiled with the \|+clientserver\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7185 Note: Any errors will cause a local error message to be issued
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7186 and the result will be the empty string.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7187
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7188 Variables will be evaluated in the global namespace,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7189 independent of a function currently being active. Except
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7190 when in debug mode, then local function variables and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7191 arguments can be evaluated.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7192
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7193 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7194 :echo remote_expr("gvim", "2+2")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7195 :echo remote_expr("gvim1", "b:current_syntax")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7196 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7197 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7198 ServerName()->remote_expr(expr)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7199
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7200 remote_foreground({server}) remote_foreground()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7201 Move the Vim server with the name {server} to the foreground.
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	7202 The {server} argument is a string, also see \|{server}\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7203 This works like: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7204 remote_expr({server}, "foreground()")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7205 < Except that on Win32 systems the client does the work, to work
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7206 around the problem that the OS doesn't always allow the server
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7207 to bring itself to the foreground.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7208 Note: This does not restore the window if it was minimized,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7209 like foreground() does.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7210 This function is not available in the \|sandbox\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7211
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7212 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7213 ServerName()->remote_foreground()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7214
28379 6dd88e45d47d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28307 diff changeset	7215 < {only in the Win32, Motif and GTK GUI versions and the
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7216 Win32 console version}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7217
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7218
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7219 remote_peek({serverid} [, {retvar}]) remote_peek()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7220 Returns a positive number if there are available strings
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7221 from {serverid}. Copies any reply string into the variable
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7222 {retvar} if specified. {retvar} must be a string with the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7223 name of a variable.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7224 Returns zero if none are available.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7225 Returns -1 if something is wrong.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7226 See also \|clientserver\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7227 This function is not available in the \|sandbox\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7228 {only available when compiled with the \|+clientserver\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7229 Examples: >
30634 f68f43043842 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30574 diff changeset	7230 :let repl = ""
f68f43043842 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30574 diff changeset	7231 :echo "PEEK: " .. remote_peek(id, "repl") .. ": " .. repl
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7232
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7233 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7234 ServerId()->remote_peek()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7235
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7236 remote_read({serverid}, [{timeout}]) remote_read()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7237 Return the oldest available reply from {serverid} and consume
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7238 it. Unless a {timeout} in seconds is given, it blocks until a
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	7239 reply is available. Returns an empty string, if a reply is
2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	7240 not available or on error.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7241 See also \|clientserver\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7242 This function is not available in the \|sandbox\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7243 {only available when compiled with the \|+clientserver\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7244 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7245 :echo remote_read(id)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7246
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7247 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7248 ServerId()->remote_read()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7249 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7250 remote_send() E241
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7251 remote_send({server}, {string} [, {idvar}])
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	7252 Send the {string} to {server}. The {server} argument is a
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	7253 string, also see \|{server}\|.
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	7254
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	7255 The string is sent as input keys and the function returns
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	7256 immediately. At the Vim server the keys are not mapped
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	7257 \|:map\|.
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	7258
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7259 If {idvar} is present, it is taken as the name of a variable
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7260 and a {serverid} for later use with remote_read() is stored
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7261 there.
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	7262
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7263 See also \|clientserver\| \|RemoteReply\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7264 This function is not available in the \|sandbox\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7265 {only available when compiled with the \|+clientserver\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7266
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7267 Note: Any errors will be reported in the server and may mess
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7268 up the display.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7269 Examples: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	7270 :echo remote_send("gvim", ":DropAndReply " .. file, "serverid") ..
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7271 \ remote_read(serverid)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7272
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7273 :autocmd NONE RemoteReply *
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7274 \ echo remote_read(expand("<amatch>"))
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	7275 :echo remote_send("gvim", ":sleep 10 \| echo " ..
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7276 \ 'server2client(expand("<client>"), "HELLO")<CR>')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7277 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7278 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7279 ServerName()->remote_send(keys)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7280 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7281 remote_startserver() E941 E942
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7282 remote_startserver({name})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7283 Become the server {name}. This fails if already running as a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7284 server, when \|v:servername\| is not empty.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7285
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7286 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7287 ServerName()->remote_startserver()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7288
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7289 < {only available when compiled with the \|+clientserver\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7290
30634 f68f43043842 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30574 diff changeset	7291 remove({list}, {idx})
f68f43043842 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30574 diff changeset	7292 remove({list}, {idx}, {end}) remove()
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7293 Without {end}: Remove the item at {idx} from \|List\| {list} and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7294 return the item.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7295 With {end}: Remove items from {idx} to {end} (inclusive) and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7296 return a \|List\| with these items. When {idx} points to the same
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7297 item as {end} a list with one item is returned. When {end}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7298 points to an item before {idx} this is an error.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7299 See \|list-index\| for possible values of {idx} and {end}.
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	7300 Returns zero on error.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7301 Example: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	7302 :echo "last item: " .. remove(mylist, -1)
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7303 :call remove(mylist, 0, 9)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7304 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7305 Use \|delete()\| to remove a file.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7306
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7307 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7308 mylist->remove(idx)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7309
30634 f68f43043842 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30574 diff changeset	7310 remove({blob}, {idx})
f68f43043842 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 30574 diff changeset	7311 remove({blob}, {idx}, {end})
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7312 Without {end}: Remove the byte at {idx} from \|Blob\| {blob} and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7313 return the byte.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7314 With {end}: Remove bytes from {idx} to {end} (inclusive) and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7315 return a \|Blob\| with these bytes. When {idx} points to the same
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7316 byte as {end} a \|Blob\| with one byte is returned. When {end}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7317 points to a byte before {idx} this is an error.
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	7318 Returns zero on error.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7319 Example: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	7320 :echo "last byte: " .. remove(myblob, -1)
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7321 :call remove(mylist, 0, 9)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7322
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7323 remove({dict}, {key})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7324 Remove the entry from {dict} with key {key} and return it.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7325 Example: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	7326 :echo "removed " .. remove(dict, "one")
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7327 < If there is no {key} in {dict} this is an error.
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	7328 Returns zero on error.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7329
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7330 rename({from}, {to}) rename()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7331 Rename the file by the name {from} to the name {to}. This
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7332 should also work to move files across file systems. The
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7333 result is a Number, which is 0 if the file was renamed
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7334 successfully, and non-zero when the renaming failed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7335 NOTE: If {to} exists it is overwritten without warning.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7336 This function is not available in the \|sandbox\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7337
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7338 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7339 GetOldName()->rename(newname)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7340
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7341 repeat({expr}, {count}) repeat()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7342 Repeat {expr} {count} times and return the concatenated
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7343 result. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7344 :let separator = repeat('-', 80)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7345 < When {count} is zero or negative the result is empty.
30188 ba22d5536d3e patch 9.0.0430: cannot use repeat() with a blob Bram Moolenaar <Bram@vim.org> parents: 30150 diff changeset	7346 When {expr} is a \|List\| or a \|Blob\| the result is {expr}
ba22d5536d3e patch 9.0.0430: cannot use repeat() with a blob Bram Moolenaar <Bram@vim.org> parents: 30150 diff changeset	7347 concatenated {count} times. Example: >
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7348 :let longlist = repeat(['a', 'b'], 3)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7349 < Results in ['a', 'b', 'a', 'b', 'a', 'b'].
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7350
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7351 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7352 mylist->repeat(count)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7353
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7354 resolve({filename}) resolve() E655
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7355 On MS-Windows, when {filename} is a shortcut (a .lnk file),
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7356 returns the path the shortcut points to in a simplified form.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7357 When {filename} is a symbolic link or junction point, return
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7358 the full path to the target. If the target of junction is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7359 removed, return {filename}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7360 On Unix, repeat resolving symbolic links in all path
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7361 components of {filename} and return the simplified result.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7362 To cope with link cycles, resolving of symbolic links is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7363 stopped after 100 iterations.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7364 On other systems, return the simplified {filename}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7365 The simplification step is done as by \|simplify()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7366 resolve() keeps a leading path component specifying the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7367 current directory (provided the result is still a relative
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7368 path name) and also keeps a trailing path separator.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7369
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7370 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7371 GetName()->resolve()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7372
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7373 reverse({object}) reverse()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7374 Reverse the order of items in {object} in-place.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7375 {object} can be a \|List\| or a \|Blob\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7376 Returns {object}.
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	7377 Returns zero if {object} is not a List or a Blob.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7378 If you want an object to remain unmodified make a copy first: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7379 :let revlist = reverse(copy(mylist))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7380 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7381 mylist->reverse()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7382
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7383 round({expr}) round()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7384 Round off {expr} to the nearest integral value and return it
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7385 as a \|Float\|. If {expr} lies halfway between two integral
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7386 values, then use the larger one (away from zero).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7387 {expr} must evaluate to a \|Float\| or a \|Number\|.
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	7388 Returns 0.0 if {expr} is not a \|Float\| or a \|Number\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7389 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7390 echo round(0.456)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7391 < 0.0 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7392 echo round(4.5)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7393 < 5.0 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7394 echo round(-4.5)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7395 < -5.0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7396
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7397 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7398 Compute()->round()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7399
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7400 rubyeval({expr}) rubyeval()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7401 Evaluate Ruby expression {expr} and return its result
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7402 converted to Vim data structures.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7403 Numbers, floats and strings are returned as they are (strings
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7404 are copied though).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7405 Arrays are represented as Vim \|List\| type.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7406 Hashes are represented as Vim \|Dictionary\| type.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7407 Other objects are represented as strings resulted from their
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7408 "Object#to_s" method.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7409 Note that in a `:def` function local variables are not visible
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7410 to {expr}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7411
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7412 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7413 GetRubyExpr()->rubyeval()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7414
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7415 < {only available when compiled with the \|+ruby\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7416
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7417 screenattr({row}, {col}) screenattr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7418 Like \|screenchar()\|, but return the attribute. This is a rather
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7419 arbitrary number that can only be used to compare to the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7420 attribute at other positions.
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	7421 Returns -1 when row or col is out of range.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7422
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7423 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7424 GetRow()->screenattr(col)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7425
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7426 screenchar({row}, {col}) screenchar()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7427 The result is a Number, which is the character at position
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7428 [row, col] on the screen. This works for every possible
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7429 screen position, also status lines, window separators and the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7430 command line. The top left position is row one, column one
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7431 The character excludes composing characters. For double-byte
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7432 encodings it may only be the first byte.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7433 This is mainly to be used for testing.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7434 Returns -1 when row or col is out of range.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7435
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7436 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7437 GetRow()->screenchar(col)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7438
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7439 screenchars({row}, {col}) screenchars()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7440 The result is a \|List\| of Numbers. The first number is the same
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7441 as what \|screenchar()\| returns. Further numbers are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7442 composing characters on top of the base character.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7443 This is mainly to be used for testing.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7444 Returns an empty List when row or col is out of range.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7445
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7446 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7447 GetRow()->screenchars(col)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7448
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7449 screencol() screencol()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7450 The result is a Number, which is the current screen column of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7451 the cursor. The leftmost column has number 1.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7452 This function is mainly used for testing.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7453
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7454 Note: Always returns the current screen column, thus if used
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7455 in a command (e.g. ":echo screencol()") it will return the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7456 column inside the command line, which is 1 when the command is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7457 executed. To get the cursor position in the file use one of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7458 the following mappings: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	7459 nnoremap <expr> GG ":echom " .. screencol() .. "\n"
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7460 nnoremap <silent> GG :echom screencol()<CR>
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7461 nnoremap GG <Cmd>echom screencol()<CR>
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7462 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7463 screenpos({winid}, {lnum}, {col}) screenpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7464 The result is a Dict with the screen position of the text
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7465 character in window {winid} at buffer line {lnum} and column
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7466 {col}. {col} is a one-based byte index.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7467 The Dict has these members:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7468 row screen row
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7469 col first screen column
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7470 endcol last screen column
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7471 curscol cursor screen column
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7472 If the specified position is not visible, all values are zero.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7473 The "endcol" value differs from "col" when the character
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7474 occupies more than one screen cell. E.g. for a Tab "col" can
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7475 be 1 and "endcol" can be 8.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7476 The "curscol" value is where the cursor would be placed. For
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7477 a Tab it would be the same as "endcol", while for a double
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7478 width character it would be the same as "col".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7479 The \|conceal\| feature is ignored here, the column numbers are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7480 as if 'conceallevel' is zero. You can set the cursor to the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7481 right position and use \|screencol()\| to get the value with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7482 \|conceal\| taken into account.
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	7483 If the position is in a closed fold the screen position of the
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	7484 first character is returned, {col} is not used.
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	7485 Returns an empty Dict if {winid} is invalid.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7486
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7487 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7488 GetWinid()->screenpos(lnum, col)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7489
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7490 screenrow() screenrow()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7491 The result is a Number, which is the current screen row of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7492 cursor. The top line has number one.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7493 This function is mainly used for testing.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7494 Alternatively you can use \|winline()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7495
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7496 Note: Same restrictions as with \|screencol()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7497
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7498 screenstring({row}, {col}) screenstring()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7499 The result is a String that contains the base character and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7500 any composing characters at position [row, col] on the screen.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7501 This is like \|screenchars()\| but returning a String with the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7502 characters.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7503 This is mainly to be used for testing.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7504 Returns an empty String when row or col is out of range.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7505
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7506 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7507 GetRow()->screenstring(col)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7508 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7509 search()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7510 search({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7511 Search for regexp pattern {pattern}. The search starts at the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7512 cursor position (you can use \|cursor()\| to set it).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7513
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7514 When a match has been found its line number is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7515 If there is no match a 0 is returned and the cursor doesn't
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7516 move. No error message is given.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7517
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7518 {flags} is a String, which can contain these character flags:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7519 'b' search Backward instead of forward
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7520 'c' accept a match at the Cursor position
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7521 'e' move to the End of the match
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7522 'n' do Not move the cursor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7523 'p' return number of matching sub-Pattern (see below)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7524 's' Set the ' mark at the previous location of the cursor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7525 'w' Wrap around the end of the file
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7526 'W' don't Wrap around the end of the file
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7527 'z' start searching at the cursor column instead of zero
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7528 If neither 'w' or 'W' is given, the 'wrapscan' option applies.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7529
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7530 If the 's' flag is supplied, the ' mark is set, only if the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7531 cursor is moved. The 's' flag cannot be combined with the 'n'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7532 flag.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7533
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7534 'ignorecase', 'smartcase' and 'magic' are used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7535
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7536 When the 'z' flag is not given, forward searching always
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7537 starts in column zero and then matches before the cursor are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7538 skipped. When the 'c' flag is present in 'cpo' the next
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7539 search starts after the match. Without the 'c' flag the next
29840 b15334beeaa4 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29828 diff changeset	7540 search starts one column after the start of the match. This
b15334beeaa4 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29828 diff changeset	7541 matters for overlapping matches. See \|cpo-c\|. You can also
b15334beeaa4 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29828 diff changeset	7542 insert "\ze" to change where the match ends, see \|/\ze\|.
b15334beeaa4 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29828 diff changeset	7543
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7544 When searching backwards and the 'z' flag is given then the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7545 search starts in column zero, thus no match in the current
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7546 line will be found (unless wrapping around the end of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7547 file).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7548
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7549 When the {stopline} argument is given then the search stops
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7550 after searching this line. This is useful to restrict the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7551 search to a range of lines. Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7552 let match = search('(', 'b', line("w0"))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7553 let end = search('END', '', line("w$"))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7554 < When {stopline} is used and it is not zero this also implies
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7555 that the search does not wrap around the end of the file.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7556 A zero value is equal to not giving the argument.
29533 34c1f4cd0c18 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29450 diff changeset	7557 E1285 E1286 E1287 E1288 E1289
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7558 When the {timeout} argument is given the search stops when
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7559 more than this many milliseconds have passed. Thus when
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7560 {timeout} is 500 the search stops after half a second.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7561 The value must not be negative. A zero value is like not
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7562 giving the argument.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7563 {only available when compiled with the \|+reltime\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7564
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7565 If the {skip} expression is given it is evaluated with the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7566 cursor positioned on the start of a match. If it evaluates to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7567 non-zero this match is skipped. This can be used, for
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7568 example, to skip a match in a comment or a string.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7569 {skip} can be a string, which is evaluated as an expression, a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7570 function reference or a lambda.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7571 When {skip} is omitted or empty, every match is accepted.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7572 When evaluating {skip} causes an error the search is aborted
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7573 and -1 returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7574 search()-sub-match
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7575 With the 'p' flag the returned value is one more than the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7576 first sub-match in . One if none of them matched but the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7577 whole pattern did match.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7578 To get the column number too use \|searchpos()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7579
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7580 The cursor will be positioned at the match, unless the 'n'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7581 flag is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7582
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7583 Example (goes over all files in the argument list): >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7584 :let n = 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7585 :while n <= argc() " loop over all files in arglist
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	7586 : exe "argument " .. n
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7587 : " start at the last char in the file and wrap for the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7588 : " first search to find match at start of file
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7589 : normal G$
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7590 : let flags = "w"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7591 : while search("foo", flags) > 0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7592 : s/foo/bar/g
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7593 : let flags = "W"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7594 : endwhile
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7595 : update " write the file if modified
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7596 : let n = n + 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7597 :endwhile
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7598 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7599 Example for using some flags: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7600 :echo search('\<if\\|$else$\\|$endif$', 'ncpe')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7601 < This will search for the keywords "if", "else", and "endif"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7602 under or after the cursor. Because of the 'p' flag, it
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7603 returns 1, 2, or 3 depending on which keyword is found, or 0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7604 if the search fails. With the cursor on the first word of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7605 line:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7606 if (foo == 0) \| let foo = foo + 1 \| endif ~
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7607 the function returns 1. Without the 'c' flag, the function
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7608 finds the "endif" and returns 3. The same thing happens
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7609 without the 'e' flag if the cursor is on the "f" of "if".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7610 The 'n' flag tells the function not to move the cursor.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7611
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7612 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7613 GetPattern()->search()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7614
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7615 searchcount([{options}]) searchcount()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7616 Get or update the last search count, like what is displayed
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7617 without the "S" flag in 'shortmess'. This works even if
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7618 'shortmess' does contain the "S" flag.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7619
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7620 This returns a \|Dictionary\|. The dictionary is empty if the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7621 previous pattern was not set and "pattern" was not specified.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7622
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7623 key type meaning ~
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7624 current \|Number\| current position of match;
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7625 0 if the cursor position is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7626 before the first match
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7627 exact_match \|Boolean\| 1 if "current" is matched on
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7628 "pos", otherwise 0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7629 total \|Number\| total count of matches found
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7630 incomplete \|Number\| 0: search was fully completed
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7631 1: recomputing was timed out
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7632 2: max count exceeded
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7633
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7634 For {options} see further down.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7635
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7636 To get the last search count when \|n\| or \|N\| was pressed, call
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7637 this function with `recompute: 0` . This sometimes returns
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7638 wrong information because \|n\| and \|N\|'s maximum count is 99.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7639 If it exceeded 99 the result must be max count + 1 (100). If
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7640 you want to get correct information, specify `recompute: 1`: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7641
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7642 " result == maxcount + 1 (100) when many matches
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7643 let result = searchcount(#{recompute: 0})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7644
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7645 " Below returns correct result (recompute defaults
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7646 " to 1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7647 let result = searchcount()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7648 <
29450 67f31c24291b Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29403 diff changeset	7649 The function is useful to add the count to 'statusline': >
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7650 function! LastSearchCount() abort
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7651 let result = searchcount(#{recompute: 0})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7652 if empty(result)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7653 return ''
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7654 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7655 if result.incomplete ==# 1 " timed out
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7656 return printf(' /%s [?/??]', @/)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7657 elseif result.incomplete ==# 2 " max count exceeded
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7658 if result.total > result.maxcount &&
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7659 \ result.current > result.maxcount
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7660 return printf(' /%s [>%d/>%d]', @/,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7661 \ result.current, result.total)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7662 elseif result.total > result.maxcount
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7663 return printf(' /%s [%d/>%d]', @/,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7664 \ result.current, result.total)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7665 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7666 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7667 return printf(' /%s [%d/%d]', @/,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7668 \ result.current, result.total)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7669 endfunction
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	7670 let &statusline ..= '%{LastSearchCount()}'
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7671
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7672 " Or if you want to show the count only when
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7673 " 'hlsearch' was on
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	7674 " let &statusline ..=
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7675 " \ '%{v:hlsearch ? LastSearchCount() : ""}'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7676 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7677 You can also update the search count, which can be useful in a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7678 \|CursorMoved\| or \|CursorMovedI\| autocommand: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7679
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7680 autocmd CursorMoved,CursorMovedI *
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7681 \ let s:searchcount_timer = timer_start(
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7682 \ 200, function('s:update_searchcount'))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7683 function! s:update_searchcount(timer) abort
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7684 if a:timer ==# s:searchcount_timer
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7685 call searchcount(#{
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7686 \ recompute: 1, maxcount: 0, timeout: 100})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7687 redrawstatus
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7688 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7689 endfunction
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7690 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7691 This can also be used to count matched texts with specified
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7692 pattern in the current buffer using "pattern": >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7693
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7694 " Count '\<foo\>' in this buffer
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7695 " (Note that it also updates search count)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7696 let result = searchcount(#{pattern: '\<foo\>'})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7697
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7698 " To restore old search count by old pattern,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7699 " search again
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7700 call searchcount()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7701 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7702 {options} must be a \|Dictionary\|. It can contain:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7703 key type meaning ~
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7704 recompute \|Boolean\| if \|TRUE\|, recompute the count
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7705 like \|n\| or \|N\| was executed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7706 otherwise returns the last
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7707 computed result (when \|n\| or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7708 \|N\| was used when "S" is not
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7709 in 'shortmess', or this
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7710 function was called).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7711 (default: \|TRUE\|)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7712 pattern \|String\| recompute if this was given
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7713 and different with \|@/\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7714 this works as same as the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7715 below command is executed
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7716 before calling this function >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7717 let @/ = pattern
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7718 < (default: \|@/\|)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7719 timeout \|Number\| 0 or negative number is no
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7720 timeout. timeout milliseconds
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7721 for recomputing the result
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7722 (default: 0)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7723 maxcount \|Number\| 0 or negative number is no
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7724 limit. max count of matched
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7725 text while recomputing the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7726 result. if search exceeded
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7727 total count, "total" value
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7728 becomes `maxcount + 1`
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7729 (default: 99)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7730 pos \|List\| `[lnum, col, off]` value
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7731 when recomputing the result.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7732 this changes "current" result
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7733 value. see \|cursor()\|,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7734 \|getpos()\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7735 (default: cursor's position)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7736
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7737 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7738 GetSearchOpts()->searchcount()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7739 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7740 searchdecl({name} [, {global} [, {thisblock}]]) searchdecl()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7741 Search for the declaration of {name}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7742
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7743 With a non-zero {global} argument it works like \|gD\|, find
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7744 first match in the file. Otherwise it works like \|gd\|, find
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7745 first match in the function.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7746
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7747 With a non-zero {thisblock} argument matches in a {} block
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7748 that ends before the cursor position are ignored. Avoids
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7749 finding variable declarations only valid in another scope.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7750
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7751 Moves the cursor to the found match.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7752 Returns zero for success, non-zero for failure.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7753 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7754 if searchdecl('myvar') == 0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7755 echo getline('.')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7756 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7757 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7758 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7759 GetName()->searchdecl()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7760 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7761 searchpair()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7762 searchpair({start}, {middle}, {end} [, {flags} [, {skip}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7763 [, {stopline} [, {timeout}]]]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7764 Search for the match of a nested start-end pair. This can be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7765 used to find the "endif" that matches an "if", while other
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7766 if/endif pairs in between are ignored.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7767 The search starts at the cursor. The default is to search
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7768 forward, include 'b' in {flags} to search backward.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7769 If a match is found, the cursor is positioned at it and the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7770 line number is returned. If no match is found 0 or -1 is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7771 returned and the cursor doesn't move. No error message is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7772 given.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7773
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7774 {start}, {middle} and {end} are patterns, see \|pattern\|. They
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7775 must not contain pairs. Use of \%( \) is allowed. When
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7776 {middle} is not empty, it is found when searching from either
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7777 direction, but only when not in a nested start-end pair. A
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7778 typical use is: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7779 searchpair('\<if\>', '\<else\>', '\<endif\>')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7780 < By leaving {middle} empty the "else" is skipped.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7781
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7782 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7783 \|search()\|. Additionally:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7784 'r' Repeat until no more matches found; will find the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7785 outer pair. Implies the 'W' flag.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7786 'm' Return number of matches instead of line number with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7787 the match; will be > 1 when 'r' is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7788 Note: it's nearly always a good idea to use the 'W' flag, to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7789 avoid wrapping around the end of the file.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7790
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7791 When a match for {start}, {middle} or {end} is found, the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7792 {skip} expression is evaluated with the cursor positioned on
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7793 the start of the match. It should return non-zero if this
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7794 match is to be skipped. E.g., because it is inside a comment
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7795 or a string.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7796 When {skip} is omitted or empty, every match is accepted.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7797 When evaluating {skip} causes an error the search is aborted
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7798 and -1 returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7799 {skip} can be a string, a lambda, a funcref or a partial.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7800 Anything else makes the function fail.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7801 In a `:def` function when the {skip} argument is a string
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7802 constant it is compiled into instructions.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7803
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7804 For {stopline} and {timeout} see \|search()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7805
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7806 The value of 'ignorecase' is used. 'magic' is ignored, the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7807 patterns are used like it's on.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7808
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7809 The search starts exactly at the cursor. A match with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7810 {start}, {middle} or {end} at the next character, in the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7811 direction of searching, is the first one found. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7812 if 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7813 if 2
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7814 endif 2
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7815 endif 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7816 < When starting at the "if 2", with the cursor on the "i", and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7817 searching forwards, the "endif 2" is found. When starting on
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7818 the character just before the "if 2", the "endif 1" will be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7819 found. That's because the "if 2" will be found first, and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7820 then this is considered to be a nested if/endif from "if 2" to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7821 "endif 2".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7822 When searching backwards and {end} is more than one character,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7823 it may be useful to put "\zs" at the end of the pattern, so
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7824 that when the cursor is inside a match with the end it finds
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7825 the matching start.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7826
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7827 Example, to find the "endif" command in a Vim script: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7828
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7829 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W',
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7830 \ 'getline(".") =~ "^\\s*\""')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7831
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7832 < The cursor must be at or after the "if" for which a match is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7833 to be found. Note that single-quote strings are used to avoid
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7834 having to double the backslashes. The skip expression only
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7835 catches comments at the start of a line, not after a command.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7836 Also, a word "en" or "if" halfway a line is considered a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7837 match.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7838 Another example, to search for the matching "{" of a "}": >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7839
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7840 :echo searchpair('{', '', '}', 'bW')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7841
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7842 < This works when the cursor is at or before the "}" for which a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7843 match is to be found. To reject matches that syntax
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7844 highlighting recognized as strings: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7845
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7846 :echo searchpair('{', '', '}', 'bW',
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7847 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7848 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7849 searchpairpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7850 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7851 [, {stopline} [, {timeout}]]]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7852 Same as \|searchpair()\|, but returns a \|List\| with the line and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7853 column position of the match. The first element of the \|List\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7854 is the line number and the second element is the byte index of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7855 the column position of the match. If no match is found,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7856 returns [0, 0]. >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7857
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7858 :let [lnum,col] = searchpairpos('{', '', '}', 'n')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7859 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7860 See \|match-parens\| for a bigger and more useful example.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7861
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7862 searchpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7863 searchpos({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7864 Same as \|search()\|, but returns a \|List\| with the line and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7865 column position of the match. The first element of the \|List\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7866 is the line number and the second element is the byte index of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7867 the column position of the match. If no match is found,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7868 returns [0, 0].
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7869 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7870 :let [lnum, col] = searchpos('mypattern', 'n')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7871
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7872 < When the 'p' flag is given then there is an extra item with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7873 the sub-pattern match number \|search()-sub-match\|. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7874 :let [lnum, col, submatch] = searchpos('$\l$\\|$\u$', 'np')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7875 < In this example "submatch" is 2 when a lowercase letter is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7876 found \|/\l\|, 3 when an uppercase letter is found \|/\u\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7877
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7878 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7879 GetPattern()->searchpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7880
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7881 server2client({clientid}, {string}) server2client()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7882 Send a reply string to {clientid}. The most recent {clientid}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7883 that sent a string can be retrieved with expand("<client>").
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7884 {only available when compiled with the \|+clientserver\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7885 Returns zero for success, -1 for failure.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7886 Note:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7887 This id has to be stored before the next command can be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7888 received. I.e. before returning from the received command and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7889 before calling any commands that waits for input.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7890 See also \|clientserver\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7891 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7892 :echo server2client(expand("<client>"), "HELLO")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7893
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7894 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7895 GetClientId()->server2client(string)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7896 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7897 serverlist() serverlist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7898 Return a list of available server names, one per line.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7899 When there are no servers or the information is not available
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7900 an empty string is returned. See also \|clientserver\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7901 {only available when compiled with the \|+clientserver\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7902 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7903 :echo serverlist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7904 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7905 setbufline({buf}, {lnum}, {text}) setbufline()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7906 Set line {lnum} to {text} in buffer {buf}. This works like
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7907 \|setline()\| for the specified buffer.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7908
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7909 This function works only for loaded buffers. First call
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7910 \|bufload()\| if needed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7911
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7912 To insert lines use \|appendbufline()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7913 Any text properties in {lnum} are cleared.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7914
31004 eb145a4d6bf8 patch 9.0.0837: append() reports failure when not appending anything Bram Moolenaar <Bram@vim.org> parents: 30967 diff changeset	7915 {text} can be a string to set one line, or a List of strings
eb145a4d6bf8 patch 9.0.0837: append() reports failure when not appending anything Bram Moolenaar <Bram@vim.org> parents: 30967 diff changeset	7916 to set multiple lines. If the List extends below the last
eb145a4d6bf8 patch 9.0.0837: append() reports failure when not appending anything Bram Moolenaar <Bram@vim.org> parents: 30967 diff changeset	7917 line then those lines are added. If the List is empty then
eb145a4d6bf8 patch 9.0.0837: append() reports failure when not appending anything Bram Moolenaar <Bram@vim.org> parents: 30967 diff changeset	7918 nothing is changed and zero is returned.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7919
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7920 For the use of {buf}, see \|bufname()\| above.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7921
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7922 {lnum} is used like with \|setline()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7923 Use "$" to refer to the last line in buffer {buf}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7924 When {lnum} is just below the last line the {text} will be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7925 added below the last line.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7926
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7927 When {buf} is not a valid buffer, the buffer is not loaded or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7928 {lnum} is not valid then 1 is returned. In \|Vim9\| script an
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7929 error is given.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7930 On success 0 is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7931
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7932 Can also be used as a \|method\|, the base is passed as the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7933 third argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7934 GetText()->setbufline(buf, lnum)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7935
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7936 setbufvar({buf}, {varname}, {val}) setbufvar()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7937 Set option or local variable {varname} in buffer {buf} to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7938 {val}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7939 This also works for a global or local window option, but it
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7940 doesn't work for a global or local window variable.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7941 For a local window option the global value is unchanged.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7942 For the use of {buf}, see \|bufname()\| above.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7943 The {varname} argument is a string.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7944 Note that the variable name without "b:" must be used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7945 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7946 :call setbufvar(1, "&mod", 1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7947 :call setbufvar("todo", "myvar", "foobar")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7948 < This function is not available in the \|sandbox\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7949
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7950 Can also be used as a \|method\|, the base is passed as the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7951 third argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7952 GetValue()->setbufvar(buf, varname)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7953
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7954
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7955 setcellwidths({list}) setcellwidths()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7956 Specify overrides for cell widths of character ranges. This
31200 a7801222c9c5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31164 diff changeset	7957 tells Vim how wide characters are when displayed in the
a7801222c9c5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31164 diff changeset	7958 terminal, counted in screen cells. The values override
a7801222c9c5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31164 diff changeset	7959 'ambiwidth'. Example: >
a7801222c9c5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31164 diff changeset	7960 call setcellwidths([
a7801222c9c5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31164 diff changeset	7961 \ [0x111, 0x111, 1],
a7801222c9c5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31164 diff changeset	7962 \ [0x2194, 0x2199, 2],
a7801222c9c5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31164 diff changeset	7963 \ ])
a7801222c9c5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31164 diff changeset	7964
a7801222c9c5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31164 diff changeset	7965 < The {list} argument is a List of Lists with each three
a7801222c9c5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31164 diff changeset	7966 numbers: [{low}, {high}, {width}]. E1109 E1110
a7801222c9c5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31164 diff changeset	7967 {low} and {high} can be the same, in which case this refers to
a7801222c9c5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31164 diff changeset	7968 one character. Otherwise it is the range of characters from
a7801222c9c5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31164 diff changeset	7969 {low} to {high} (inclusive). E1111 E1114
31782 a19ef442c77a patch 9.0.1223: cannot use setcellwidths() below 0x100 Bram Moolenaar <Bram@vim.org> parents: 31760 diff changeset	7970 Only characters with value 0x80 and higher can be used.
31200 a7801222c9c5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31164 diff changeset	7971
a7801222c9c5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31164 diff changeset	7972 {width} must be either 1 or 2, indicating the character width
a7801222c9c5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31164 diff changeset	7973 in screen cells. E1112
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7974 An error is given if the argument is invalid, also when a
31200 a7801222c9c5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31164 diff changeset	7975 range overlaps with another. E1113
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7976
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7977 If the new value causes 'fillchars' or 'listchars' to become
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7978 invalid it is rejected and an error is given.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7979
31200 a7801222c9c5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31164 diff changeset	7980 To clear the overrides pass an empty {list}: >
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7981 setcellwidths([]);
31200 a7801222c9c5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31164 diff changeset	7982
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7983 < You can use the script $VIMRUNTIME/tools/emoji_list.vim to see
31200 a7801222c9c5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31164 diff changeset	7984 the effect for known emoji characters. Move the cursor
a7801222c9c5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31164 diff changeset	7985 through the text to check if the cell widths of your terminal
a7801222c9c5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31164 diff changeset	7986 match with what Vim knows about each emoji. If it doesn't
a7801222c9c5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31164 diff changeset	7987 look right you need to adjust the {list} argument.
a7801222c9c5 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31164 diff changeset	7988
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7989
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7990 setcharpos({expr}, {list}) setcharpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7991 Same as \|setpos()\| but uses the specified column number as the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7992 character index instead of the byte index in the line.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7993
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7994 Example:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7995 With the text "여보세요" in line 8: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7996 call setcharpos('.', [0, 8, 4, 0])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7997 < positions the cursor on the fourth character '요'. >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7998 call setpos('.', [0, 8, 4, 0])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7999 < positions the cursor on the second character '보'.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8000
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8001 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8002 GetPosition()->setcharpos('.')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8003
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8004 setcharsearch({dict}) setcharsearch()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8005 Set the current character search information to {dict},
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8006 which contains one or more of the following entries:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8007
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8008 char character which will be used for a subsequent
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8009 \|,\| or \|;\| command; an empty string clears the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8010 character search
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8011 forward direction of character search; 1 for forward,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8012 0 for backward
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8013 until type of character search; 1 for a \|t\| or \|T\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8014 character search, 0 for an \|f\| or \|F\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8015 character search
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8016
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8017 This can be useful to save/restore a user's character search
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8018 from a script: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8019 :let prevsearch = getcharsearch()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8020 :" Perform a command which clobbers user's search
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8021 :call setcharsearch(prevsearch)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8022 < Also see \|getcharsearch()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8023
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8024 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8025 SavedSearch()->setcharsearch()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8026
29894 d8fc1effa724 patch 9.0.0285: it is not easy to change the command line from a plugin Bram Moolenaar <Bram@vim.org> parents: 29883 diff changeset	8027 setcmdline({str} [, {pos}]) setcmdline()
d8fc1effa724 patch 9.0.0285: it is not easy to change the command line from a plugin Bram Moolenaar <Bram@vim.org> parents: 29883 diff changeset	8028 Set the command line to {str} and set the cursor position to
d8fc1effa724 patch 9.0.0285: it is not easy to change the command line from a plugin Bram Moolenaar <Bram@vim.org> parents: 29883 diff changeset	8029 {pos}.
d8fc1effa724 patch 9.0.0285: it is not easy to change the command line from a plugin Bram Moolenaar <Bram@vim.org> parents: 29883 diff changeset	8030 If {pos} is omitted, the cursor is positioned after the text.
d8fc1effa724 patch 9.0.0285: it is not easy to change the command line from a plugin Bram Moolenaar <Bram@vim.org> parents: 29883 diff changeset	8031 Returns 0 when successful, 1 when not editing the command
d8fc1effa724 patch 9.0.0285: it is not easy to change the command line from a plugin Bram Moolenaar <Bram@vim.org> parents: 29883 diff changeset	8032 line.
d8fc1effa724 patch 9.0.0285: it is not easy to change the command line from a plugin Bram Moolenaar <Bram@vim.org> parents: 29883 diff changeset	8033
d8fc1effa724 patch 9.0.0285: it is not easy to change the command line from a plugin Bram Moolenaar <Bram@vim.org> parents: 29883 diff changeset	8034 Can also be used as a \|method\|: >
d8fc1effa724 patch 9.0.0285: it is not easy to change the command line from a plugin Bram Moolenaar <Bram@vim.org> parents: 29883 diff changeset	8035 GetText()->setcmdline()
d8fc1effa724 patch 9.0.0285: it is not easy to change the command line from a plugin Bram Moolenaar <Bram@vim.org> parents: 29883 diff changeset	8036
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8037 setcmdpos({pos}) setcmdpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8038 Set the cursor position in the command line to byte position
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8039 {pos}. The first position is 1.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8040 Use \|getcmdpos()\| to obtain the current position.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8041 Only works while editing the command line, thus you must use
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8042 \|c_CTRL-\_e\|, \|c_CTRL-R_=\| or \|c_CTRL-R_CTRL-R\| with '='. For
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8043 \|c_CTRL-\_e\| and \|c_CTRL-R_CTRL-R\| with '=' the position is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8044 set after the command line is set to the expression. For
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8045 \|c_CTRL-R_=\| it is set after evaluating the expression but
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8046 before inserting the resulting text.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8047 When the number is too big the cursor is put at the end of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8048 line. A number smaller than one has undefined results.
29894 d8fc1effa724 patch 9.0.0285: it is not easy to change the command line from a plugin Bram Moolenaar <Bram@vim.org> parents: 29883 diff changeset	8049 Returns 0 when successful, 1 when not editing the command
d8fc1effa724 patch 9.0.0285: it is not easy to change the command line from a plugin Bram Moolenaar <Bram@vim.org> parents: 29883 diff changeset	8050 line.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8051
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8052 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8053 GetPos()->setcmdpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8054
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8055 setcursorcharpos({lnum}, {col} [, {off}]) setcursorcharpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8056 setcursorcharpos({list})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8057 Same as \|cursor()\| but uses the specified column number as the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8058 character index instead of the byte index in the line.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8059
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8060 Example:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8061 With the text "여보세요" in line 4: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8062 call setcursorcharpos(4, 3)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8063 < positions the cursor on the third character '세'. >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8064 call cursor(4, 3)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8065 < positions the cursor on the first character '여'.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8066
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8067 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8068 GetCursorPos()->setcursorcharpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8069
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8070
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8071 setenv({name}, {val}) setenv()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8072 Set environment variable {name} to {val}. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8073 call setenv('HOME', '/home/myhome')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8074
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8075 < When {val} is \|v:null\| the environment variable is deleted.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8076 See also \|expr-env\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8077
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8078 Can also be used as a \|method\|, the base is passed as the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8079 second argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8080 GetPath()->setenv('PATH')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8081
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8082 setfperm({fname}, {mode}) setfperm() chmod
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8083 Set the file permissions for {fname} to {mode}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8084 {mode} must be a string with 9 characters. It is of the form
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8085 "rwxrwxrwx", where each group of "rwx" flags represent, in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8086 turn, the permissions of the owner of the file, the group the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8087 file belongs to, and other users. A '-' character means the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8088 permission is off, any other character means on. Multi-byte
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8089 characters are not supported.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8090
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8091 For example "rw-r-----" means read-write for the user,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8092 readable by the group, not accessible by others. "xx-x-----"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8093 would do the same thing.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8094
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8095 Returns non-zero for success, zero for failure.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8096
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8097 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8098 GetFilename()->setfperm(mode)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8099 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8100 To read permissions see \|getfperm()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8101
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8102
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8103 setline({lnum}, {text}) setline()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8104 Set line {lnum} of the current buffer to {text}. To insert
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8105 lines use \|append()\|. To set lines in another buffer use
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8106 \|setbufline()\|. Any text properties in {lnum} are cleared.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8107
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8108 {lnum} is used like with \|getline()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8109 When {lnum} is just below the last line the {text} will be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8110 added below the last line.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8111 {text} can be any type or a List of any type, each item is
31004 eb145a4d6bf8 patch 9.0.0837: append() reports failure when not appending anything Bram Moolenaar <Bram@vim.org> parents: 30967 diff changeset	8112 converted to a String. When {text} is an empty List then
eb145a4d6bf8 patch 9.0.0837: append() reports failure when not appending anything Bram Moolenaar <Bram@vim.org> parents: 30967 diff changeset	8113 nothing is changed and FALSE is returned.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8114
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8115 If this succeeds, FALSE is returned. If this fails (most likely
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8116 because {lnum} is invalid) TRUE is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8117 In \|Vim9\| script an error is given if {lnum} is invalid.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8118
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8119 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8120 :call setline(5, strftime("%c"))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8121
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8122 < When {text} is a \|List\| then line {lnum} and following lines
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8123 will be set to the items in the list. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8124 :call setline(5, ['aaa', 'bbb', 'ccc'])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8125 < This is equivalent to: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8126 :for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8127 : call setline(n, l)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8128 :endfor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8129
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8130 < Note: The '[ and '] marks are not set.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8131
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8132 Can also be used as a \|method\|, the base is passed as the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8133 second argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8134 GetText()->setline(lnum)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8135
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8136 setloclist({nr}, {list} [, {action} [, {what}]]) setloclist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8137 Create or replace or add to the location list for window {nr}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8138 {nr} can be the window number or the \|window-ID\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8139 When {nr} is zero the current window is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8140
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8141 For a location list window, the displayed location list is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8142 modified. For an invalid window number {nr}, -1 is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8143 Otherwise, same as \|setqflist()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8144 Also see \|location-list\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8145
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8146 For {action} see \|setqflist-action\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8147
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8148 If the optional {what} dictionary argument is supplied, then
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8149 only the items listed in {what} are set. Refer to \|setqflist()\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8150 for the list of supported keys in {what}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8151
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8152 Can also be used as a \|method\|, the base is passed as the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8153 second argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8154 GetLoclist()->setloclist(winnr)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8155
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8156 setmatches({list} [, {win}]) setmatches()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8157 Restores a list of matches saved by \|getmatches()\| for the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8158 current window. Returns 0 if successful, otherwise -1. All
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8159 current matches are cleared before the list is restored. See
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8160 example for \|getmatches()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8161 If {win} is specified, use the window with this number or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8162 window ID instead of the current window.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8163
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8164 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8165 GetMatches()->setmatches()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8166 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8167 setpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8168 setpos({expr}, {list})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8169 Set the position for String {expr}. Possible values:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8170 . the cursor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8171 'x mark x
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8172
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8173 {list} must be a \|List\| with four or five numbers:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8174 [bufnum, lnum, col, off]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8175 [bufnum, lnum, col, off, curswant]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8176
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8177 "bufnum" is the buffer number. Zero can be used for the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8178 current buffer. When setting an uppercase mark "bufnum" is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8179 used for the mark position. For other marks it specifies the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8180 buffer to set the mark in. You can use the \|bufnr()\| function
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8181 to turn a file name into a buffer number.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8182 For setting the cursor and the ' mark "bufnum" is ignored,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8183 since these are associated with a window, not a buffer.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8184 Does not change the jumplist.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8185
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8186 "lnum" and "col" are the position in the buffer. The first
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8187 column is 1. Use a zero "lnum" to delete a mark. If "col" is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8188 smaller than 1 then 1 is used. To use the character count
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8189 instead of the byte count, use \|setcharpos()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8190
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8191 The "off" number is only used when 'virtualedit' is set. Then
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8192 it is the offset in screen columns from the start of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8193 character. E.g., a position within a <Tab> or after the last
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8194 character.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8195
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8196 The "curswant" number is only used when setting the cursor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8197 position. It sets the preferred column for when moving the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8198 cursor vertically. When the "curswant" number is missing the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8199 preferred column is not set. When it is present and setting a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8200 mark position it is not used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8201
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8202 Note that for '< and '> changing the line number may result in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8203 the marks to be effectively be swapped, so that '< is always
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8204 before '>.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8205
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8206 Returns 0 when the position could be set, -1 otherwise.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8207 An error message is given if {expr} is invalid.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8208
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8209 Also see \|setcharpos()\|, \|getpos()\| and \|getcurpos()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8210
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8211 This does not restore the preferred column for moving
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8212 vertically; if you set the cursor position with this, \|j\| and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8213 \|k\| motions will jump to previous columns! Use \|cursor()\| to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8214 also set the preferred column. Also see the "curswant" key in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8215 \|winrestview()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8216
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8217 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8218 GetPosition()->setpos('.')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8219
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8220 setqflist({list} [, {action} [, {what}]]) setqflist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8221 Create or replace or add to the quickfix list.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8222
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8223 If the optional {what} dictionary argument is supplied, then
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8224 only the items listed in {what} are set. The first {list}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8225 argument is ignored. See below for the supported items in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8226 {what}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8227 setqflist-what
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8228 When {what} is not present, the items in {list} are used. Each
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8229 item must be a dictionary. Non-dictionary items in {list} are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8230 ignored. Each dictionary item can contain the following
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8231 entries:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8232
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8233 bufnr buffer number; must be the number of a valid
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8234 buffer
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8235 filename name of a file; only used when "bufnr" is not
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8236 present or it is invalid.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8237 module name of a module; if given it will be used in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8238 quickfix error window instead of the filename.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8239 lnum line number in the file
27537 063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27497 diff changeset	8240 end_lnum end of lines, if the item spans multiple lines
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8241 pattern search pattern used to locate the error
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8242 col column number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8243 vcol when non-zero: "col" is visual column
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8244 when zero: "col" is byte index
27537 063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27497 diff changeset	8245 end_col end column, if the item spans multiple columns
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8246 nr error number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8247 text description of the error
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8248 type single-character error type, 'E', 'W', etc.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8249 valid recognized error message
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8250
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8251 The "col", "vcol", "nr", "type" and "text" entries are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8252 optional. Either "lnum" or "pattern" entry can be used to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8253 locate a matching error line.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8254 If the "filename" and "bufnr" entries are not present or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8255 neither the "lnum" or "pattern" entries are present, then the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8256 item will not be handled as an error line.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8257 If both "pattern" and "lnum" are present then "pattern" will
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8258 be used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8259 If the "valid" entry is not supplied, then the valid flag is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8260 set when "bufnr" is a valid buffer or "filename" exists.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8261 If you supply an empty {list}, the quickfix list will be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8262 cleared.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8263 Note that the list is not exactly the same as what
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8264 \|getqflist()\| returns.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8265
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8266 {action} values: setqflist-action E927
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8267 'a' The items from {list} are added to the existing
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8268 quickfix list. If there is no existing list, then a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8269 new list is created.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8270
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8271 'r' The items from the current quickfix list are replaced
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8272 with the items from {list}. This can also be used to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8273 clear the list: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8274 :call setqflist([], 'r')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8275 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8276 'f' All the quickfix lists in the quickfix stack are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8277 freed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8278
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8279 If {action} is not present or is set to ' ', then a new list
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8280 is created. The new quickfix list is added after the current
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8281 quickfix list in the stack and all the following lists are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8282 freed. To add a new quickfix list at the end of the stack,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8283 set "nr" in {what} to "$".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8284
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8285 The following items can be specified in dictionary {what}:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8286 context quickfix list context. See \|quickfix-context\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8287 efm errorformat to use when parsing text from
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8288 "lines". If this is not present, then the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8289 'errorformat' option value is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8290 See \|quickfix-parse\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8291 id quickfix list identifier \|quickfix-ID\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8292 idx index of the current entry in the quickfix
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8293 list specified by 'id' or 'nr'. If set to '$',
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8294 then the last entry in the list is set as the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8295 current entry. See \|quickfix-index\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8296 items list of quickfix entries. Same as the {list}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8297 argument.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8298 lines use 'errorformat' to parse a list of lines and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8299 add the resulting entries to the quickfix list
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8300 {nr} or {id}. Only a \|List\| value is supported.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8301 See \|quickfix-parse\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8302 nr list number in the quickfix stack; zero
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8303 means the current quickfix list and "$" means
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8304 the last quickfix list.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8305 quickfixtextfunc
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8306 function to get the text to display in the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8307 quickfix window. The value can be the name of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8308 a function or a funcref or a lambda. Refer to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8309 \|quickfix-window-function\| for an explanation
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8310 of how to write the function and an example.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8311 title quickfix list title text. See \|quickfix-title\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8312 Unsupported keys in {what} are ignored.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8313 If the "nr" item is not present, then the current quickfix list
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8314 is modified. When creating a new quickfix list, "nr" can be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8315 set to a value one greater than the quickfix stack size.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8316 When modifying a quickfix list, to guarantee that the correct
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8317 list is modified, "id" should be used instead of "nr" to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8318 specify the list.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8319
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8320 Examples (See also \|setqflist-examples\|): >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8321 :call setqflist([], 'r', {'title': 'My search'})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8322 :call setqflist([], 'r', {'nr': 2, 'title': 'Errors'})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8323 :call setqflist([], 'a', {'id':qfid, 'lines':["F1:10:L10"]})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8324 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8325 Returns zero for success, -1 for failure.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8326
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8327 This function can be used to create a quickfix list
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8328 independent of the 'errorformat' setting. Use a command like
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8329 `:cc 1` to jump to the first position.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8330
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8331 Can also be used as a \|method\|, the base is passed as the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8332 second argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8333 GetErrorlist()->setqflist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8334 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8335 setreg()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8336 setreg({regname}, {value} [, {options}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8337 Set the register {regname} to {value}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8338 If {regname} is "" or "@", the unnamed register '"' is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8339 The {regname} argument is a string. In \|Vim9-script\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8340 {regname} must be one character.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8341
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8342 {value} may be any value returned by \|getreg()\| or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8343 \|getreginfo()\|, including a \|List\| or \|Dict\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8344 If {options} contains "a" or {regname} is upper case,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8345 then the value is appended.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8346
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8347 {options} can also contain a register type specification:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8348 "c" or "v" \|characterwise\| mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8349 "l" or "V" \|linewise\| mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8350 "b" or "<CTRL-V>" \|blockwise-visual\| mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8351 If a number immediately follows "b" or "<CTRL-V>" then this is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8352 used as the width of the selection - if it is not specified
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8353 then the width of the block is set to the number of characters
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8354 in the longest line (counting a <Tab> as 1 character).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8355
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8356 If {options} contains no register settings, then the default
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8357 is to use character mode unless {value} ends in a <NL> for
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8358 string {value} and linewise mode for list {value}. Blockwise
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8359 mode is never selected automatically.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8360 Returns zero for success, non-zero for failure.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8361
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8362 E883
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8363 Note: you may not use \|List\| containing more than one item to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8364 set search and expression registers. Lists containing no
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8365 items act like empty strings.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8366
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8367 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8368 :call setreg(v:register, @*)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8369 :call setreg('*', @%, 'ac')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8370 :call setreg('a', "1\n2\n3", 'b5')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8371 :call setreg('"', { 'points_to': 'a'})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8372
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8373 < This example shows using the functions to save and restore a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8374 register: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8375 :let var_a = getreginfo()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8376 :call setreg('a', var_a)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8377 < or: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8378 :let var_a = getreg('a', 1, 1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8379 :let var_amode = getregtype('a')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8380 ....
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8381 :call setreg('a', var_a, var_amode)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8382 < Note: you may not reliably restore register value
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8383 without using the third argument to \|getreg()\| as without it
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8384 newlines are represented as newlines AND Nul bytes are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8385 represented as newlines as well, see \|NL-used-for-Nul\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8386
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8387 You can also change the type of a register by appending
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8388 nothing: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8389 :call setreg('a', '', 'al')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8390
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8391 < Can also be used as a \|method\|, the base is passed as the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8392 second argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8393 GetText()->setreg('a')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8394
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8395 settabvar({tabnr}, {varname}, {val}) settabvar()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8396 Set tab-local variable {varname} to {val} in tab page {tabnr}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8397 \|t:var\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8398 The {varname} argument is a string.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8399 Note that autocommands are blocked, side effects may not be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8400 triggered, e.g. when setting 'filetype'.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8401 Note that the variable name without "t:" must be used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8402 Tabs are numbered starting with one.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8403 This function is not available in the \|sandbox\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8404
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8405 Can also be used as a \|method\|, the base is passed as the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8406 third argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8407 GetValue()->settabvar(tab, name)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8408
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8409 settabwinvar({tabnr}, {winnr}, {varname}, {val}) settabwinvar()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8410 Set option or local variable {varname} in window {winnr} to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8411 {val}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8412 Tabs are numbered starting with one. For the current tabpage
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8413 use \|setwinvar()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8414 {winnr} can be the window number or the \|window-ID\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8415 When {winnr} is zero the current window is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8416 Note that autocommands are blocked, side effects may not be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8417 triggered, e.g. when setting 'filetype' or 'syntax'.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8418 This also works for a global or local buffer option, but it
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8419 doesn't work for a global or local buffer variable.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8420 For a local buffer option the global value is unchanged.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8421 Note that the variable name without "w:" must be used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8422 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8423 :call settabwinvar(1, 1, "&list", 0)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8424 :call settabwinvar(3, 2, "myvar", "foobar")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8425 < This function is not available in the \|sandbox\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8426
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8427 Can also be used as a \|method\|, the base is passed as the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8428 fourth argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8429 GetValue()->settabwinvar(tab, winnr, name)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8430
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8431 settagstack({nr}, {dict} [, {action}]) settagstack()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8432 Modify the tag stack of the window {nr} using {dict}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8433 {nr} can be the window number or the \|window-ID\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8434
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8435 For a list of supported items in {dict}, refer to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8436 \|gettagstack()\|. "curidx" takes effect before changing the tag
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8437 stack.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8438 E962
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8439 How the tag stack is modified depends on the {action}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8440 argument:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8441 - If {action} is not present or is set to 'r', then the tag
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8442 stack is replaced.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8443 - If {action} is set to 'a', then new entries from {dict} are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8444 pushed (added) onto the tag stack.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8445 - If {action} is set to 't', then all the entries from the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8446 current entry in the tag stack or "curidx" in {dict} are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8447 removed and then new entries are pushed to the stack.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8448
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8449 The current index is set to one after the length of the tag
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8450 stack after the modification.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8451
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8452 Returns zero for success, -1 for failure.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8453
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8454 Examples (for more examples see \|tagstack-examples\|):
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8455 Empty the tag stack of window 3: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8456 call settagstack(3, {'items' : []})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8457
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8458 < Save and restore the tag stack: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8459 let stack = gettagstack(1003)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8460 " do something else
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8461 call settagstack(1003, stack)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8462 unlet stack
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8463 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8464 Can also be used as a \|method\|, the base is passed as the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8465 second argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8466 GetStack()->settagstack(winnr)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8467
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8468 setwinvar({winnr}, {varname}, {val}) setwinvar()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8469 Like \|settabwinvar()\| for the current tab page.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8470 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8471 :call setwinvar(1, "&list", 0)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8472 :call setwinvar(2, "myvar", "foobar")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8473
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8474 < Can also be used as a \|method\|, the base is passed as the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8475 third argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8476 GetValue()->setwinvar(winnr, name)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8477
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8478 sha256({string}) sha256()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8479 Returns a String with 64 hex characters, which is the SHA256
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8480 checksum of {string}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8481
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8482 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8483 GetText()->sha256()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8484
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8485 < {only available when compiled with the \|+cryptv\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8486
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8487 shellescape({string} [, {special}]) shellescape()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8488 Escape {string} for use as a shell command argument.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8489 When the 'shell' contains powershell (MS-Windows) or pwsh
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	8490 (MS-Windows, Linux, and macOS) then it will enclose {string}
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8491 in single quotes and will double up all internal single
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8492 quotes.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8493 On MS-Windows, when 'shellslash' is not set, it will enclose
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8494 {string} in double quotes and double all double quotes within
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8495 {string}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8496 Otherwise it will enclose {string} in single quotes and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8497 replace all "'" with "'\''".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8498
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8499 When the {special} argument is present and it's a non-zero
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8500 Number or a non-empty String (\|non-zero-arg\|), then special
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8501 items such as "!", "%", "#" and "<cword>" will be preceded by
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8502 a backslash. This backslash will be removed again by the \|:!\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8503 command.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8504
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8505 The "!" character will be escaped (again with a \|non-zero-arg\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8506 {special}) when 'shell' contains "csh" in the tail. That is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8507 because for csh and tcsh "!" is used for history replacement
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8508 even when inside single quotes.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8509
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8510 With a \|non-zero-arg\| {special} the <NL> character is also
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8511 escaped. When 'shell' containing "csh" in the tail it's
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8512 escaped a second time.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8513
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8514 The "\" character will be escaped when 'shell' contains "fish"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8515 in the tail. That is because for fish "\" is used as an escape
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8516 character inside single quotes.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8517
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8518 Example of use with a \|:!\| command: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	8519 :exe '!dir ' .. shellescape(expand('<cfile>'), 1)
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8520 < This results in a directory listing for the file under the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8521 cursor. Example of use with \|system()\|: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	8522 :call system("chmod +w -- " .. shellescape(expand("%")))
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8523 < See also \|::S\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8524
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8525 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8526 GetCommand()->shellescape()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8527
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8528 shiftwidth([{col}]) shiftwidth()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8529 Returns the effective value of 'shiftwidth'. This is the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8530 'shiftwidth' value unless it is zero, in which case it is the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8531 'tabstop' value. This function was introduced with patch
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8532 7.3.694 in 2012, everybody should have it by now (however it
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8533 did not allow for the optional {col} argument until 8.1.542).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8534
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8535 When there is one argument {col} this is used as column number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8536 for which to return the 'shiftwidth' value. This matters for the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8537 'vartabstop' feature. If the 'vartabstop' setting is enabled and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8538 no {col} argument is given, column 1 will be assumed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8539
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8540 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8541 GetColumn()->shiftwidth()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8542
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8543 sign_ functions are documented here: \|sign-functions-details\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8544
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8545
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8546 simplify({filename}) simplify()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8547 Simplify the file name as much as possible without changing
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8548 the meaning. Shortcuts (on MS-Windows) or symbolic links (on
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8549 Unix) are not resolved. If the first path component in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8550 {filename} designates the current directory, this will be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8551 valid for the result as well. A trailing path separator is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8552 not removed either. On Unix "//path" is unchanged, but
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8553 "///path" is simplified to "/path" (this follows the Posix
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8554 standard).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8555 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8556 simplify("./dir/.././/file/") == "./file/"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8557 < Note: The combination "dir/.." is only removed if "dir" is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8558 a searchable directory or does not exist. On Unix, it is also
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8559 removed when "dir" is a symbolic link within the same
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8560 directory. In order to resolve all the involved symbolic
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8561 links before simplifying the path name, use \|resolve()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8562
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8563 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8564 GetName()->simplify()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8565
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8566 sin({expr}) sin()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8567 Return the sine of {expr}, measured in radians, as a \|Float\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8568 {expr} must evaluate to a \|Float\| or a \|Number\|.
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	8569 Returns 0.0 if {expr} is not a \|Float\| or a \|Number\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8570 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8571 :echo sin(100)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8572 < -0.506366 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8573 :echo sin(-4.01)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8574 < 0.763301
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8575
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8576 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8577 Compute()->sin()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8578
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8579
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8580 sinh({expr}) sinh()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8581 Return the hyperbolic sine of {expr} as a \|Float\| in the range
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8582 [-inf, inf].
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8583 {expr} must evaluate to a \|Float\| or a \|Number\|.
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	8584 Returns 0.0 if {expr} is not a \|Float\| or a \|Number\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8585 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8586 :echo sinh(0.5)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8587 < 0.521095 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8588 :echo sinh(-0.9)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8589 < -1.026517
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8590
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8591 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8592 Compute()->sinh()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8593
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8594
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8595 slice({expr}, {start} [, {end}]) slice()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8596 Similar to using a \|slice\| "expr[start : end]", but "end" is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8597 used exclusive. And for a string the indexes are used as
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8598 character indexes instead of byte indexes, like in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8599 \|vim9script\|. Also, composing characters are not counted.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8600 When {end} is omitted the slice continues to the last item.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8601 When {end} is -1 the last item is omitted.
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	8602 Returns an empty value if {start} or {end} are invalid.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8603
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8604 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8605 GetList()->slice(offset)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8606
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8607
27859 3cb1a109e987 patch 8.2.4455: accepting one and zero for second sort() argument is strange Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	8608 sort({list} [, {how} [, {dict}]]) sort() E702
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8609 Sort the items in {list} in-place. Returns {list}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8610
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8611 If you want a list to remain unmodified make a copy first: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8612 :let sortedlist = sort(copy(mylist))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8613
28933 57c9377b9c62 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 28917 diff changeset	8614 < When {how} is omitted or is a string, then sort() uses the
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8615 string representation of each item to sort on. Numbers sort
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8616 after Strings, \|Lists\| after Numbers. For sorting text in the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8617 current buffer use \|:sort\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8618
27859 3cb1a109e987 patch 8.2.4455: accepting one and zero for second sort() argument is strange Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	8619 When {how} is given and it is 'i' then case is ignored.
3cb1a109e987 patch 8.2.4455: accepting one and zero for second sort() argument is strange Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	8620 In legacy script, for backwards compatibility, the value one
3cb1a109e987 patch 8.2.4455: accepting one and zero for second sort() argument is strange Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	8621 can be used to ignore case. Zero means to not ignore case.
3cb1a109e987 patch 8.2.4455: accepting one and zero for second sort() argument is strange Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	8622
3cb1a109e987 patch 8.2.4455: accepting one and zero for second sort() argument is strange Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	8623 When {how} is given and it is 'l' then the current collation
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8624 locale is used for ordering. Implementation details: strcoll()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8625 is used to compare strings. See \|:language\| check or set the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8626 collation locale. \|v:collate\| can also be used to check the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8627 current locale. Sorting using the locale typically ignores
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8628 case. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8629 " ö is sorted similarly to o with English locale.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8630 :language collate en_US.UTF8
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8631 :echo sort(['n', 'o', 'O', 'ö', 'p', 'z'], 'l')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8632 < ['n', 'o', 'O', 'ö', 'p', 'z'] ~
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8633 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8634 " ö is sorted after z with Swedish locale.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8635 :language collate sv_SE.UTF8
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8636 :echo sort(['n', 'o', 'O', 'ö', 'p', 'z'], 'l')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8637 < ['n', 'o', 'O', 'p', 'z', 'ö'] ~
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8638 This does not work properly on Mac.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8639
27859 3cb1a109e987 patch 8.2.4455: accepting one and zero for second sort() argument is strange Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	8640 When {how} is given and it is 'n' then all items will be
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8641 sorted numerical (Implementation detail: this uses the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8642 strtod() function to parse numbers, Strings, Lists, Dicts and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8643 Funcrefs will be considered as being 0).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8644
27859 3cb1a109e987 patch 8.2.4455: accepting one and zero for second sort() argument is strange Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	8645 When {how} is given and it is 'N' then all items will be
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8646 sorted numerical. This is like 'n' but a string containing
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8647 digits will be used as the number they represent.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8648
27859 3cb1a109e987 patch 8.2.4455: accepting one and zero for second sort() argument is strange Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	8649 When {how} is given and it is 'f' then all items will be
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8650 sorted numerical. All values must be a Number or a Float.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8651
27859 3cb1a109e987 patch 8.2.4455: accepting one and zero for second sort() argument is strange Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	8652 When {how} is a \|Funcref\| or a function name, this function
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8653 is called to compare items. The function is invoked with two
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8654 items as argument and must return zero if they are equal, 1 or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8655 bigger if the first one sorts after the second one, -1 or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8656 smaller if the first one sorts before the second one.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8657
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8658 {dict} is for functions with the "dict" attribute. It will be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8659 used to set the local variable "self". \|Dictionary-function\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8660
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8661 The sort is stable, items which compare equal (as number or as
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8662 string) will keep their relative position. E.g., when sorting
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8663 on numbers, text strings will sort next to each other, in the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8664 same order as they were originally.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8665
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8666 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8667 mylist->sort()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8668
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8669 < Also see \|uniq()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8670
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8671 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8672 func MyCompare(i1, i2)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8673 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8674 endfunc
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8675 eval mylist->sort("MyCompare")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8676 < A shorter compare version for this specific simple case, which
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8677 ignores overflow: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8678 func MyCompare(i1, i2)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8679 return a:i1 - a:i2
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8680 endfunc
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8681 < For a simple expression you can use a lambda: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8682 eval mylist->sort({i1, i2 -> i1 - i2})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8683 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8684 sound_clear() sound_clear()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8685 Stop playing all sounds.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8686
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8687 On some Linux systems you may need the libcanberra-pulse
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8688 package, otherwise sound may not stop.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8689
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8690 {only available when compiled with the \|+sound\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8691
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8692 sound_playevent()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8693 sound_playevent({name} [, {callback}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8694 Play a sound identified by {name}. Which event names are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8695 supported depends on the system. Often the XDG sound names
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8696 are used. On Ubuntu they may be found in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8697 /usr/share/sounds/freedesktop/stereo. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8698 call sound_playevent('bell')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8699 < On MS-Windows, {name} can be SystemAsterisk, SystemDefault,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8700 SystemExclamation, SystemExit, SystemHand, SystemQuestion,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8701 SystemStart, SystemWelcome, etc.
30719 71137f73c94d patch 9.0.0694: no native sound support on Mac OS Bram Moolenaar <Bram@vim.org> parents: 30697 diff changeset	8702 On macOS, {name} refers to files located in
71137f73c94d patch 9.0.0694: no native sound support on Mac OS Bram Moolenaar <Bram@vim.org> parents: 30697 diff changeset	8703 /System/Library/Sounds (e.g. "Tink"). It will also work for
71137f73c94d patch 9.0.0694: no native sound support on Mac OS Bram Moolenaar <Bram@vim.org> parents: 30697 diff changeset	8704 custom installed sounds in folders like ~/Library/Sounds.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8705
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8706 When {callback} is specified it is invoked when the sound is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8707 finished. The first argument is the sound ID, the second
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8708 argument is the status:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8709 0 sound was played to the end
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8710 1 sound was interrupted
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8711 2 error occurred after sound started
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8712 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8713 func Callback(id, status)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8714 echomsg "sound " .. a:id .. " finished with " .. a:status
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8715 endfunc
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8716 call sound_playevent('bell', 'Callback')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8717
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8718 < MS-Windows: {callback} doesn't work for this function.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8719
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8720 Returns the sound ID, which can be passed to `sound_stop()`.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8721 Returns zero if the sound could not be played.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8722
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8723 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8724 GetSoundName()->sound_playevent()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8725
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8726 < {only available when compiled with the \|+sound\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8727
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8728 sound_playfile()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8729 sound_playfile({path} [, {callback}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8730 Like `sound_playevent()` but play sound file {path}. {path}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8731 must be a full path. On Ubuntu you may find files to play
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8732 with this command: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8733 :!find /usr/share/sounds -type f \| grep -v index.theme
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8734
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8735 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8736 GetSoundPath()->sound_playfile()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8737
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	8738 < {only available when compiled with the \|+sound\| feature}
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8739
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8740
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8741 sound_stop({id}) sound_stop()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8742 Stop playing sound {id}. {id} must be previously returned by
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8743 `sound_playevent()` or `sound_playfile()`.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8744
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8745 On some Linux systems you may need the libcanberra-pulse
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8746 package, otherwise sound may not stop.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8747
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8748 On MS-Windows, this does not work for event sound started by
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8749 `sound_playevent()`. To stop event sounds, use `sound_clear()`.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8750
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8751 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8752 soundid->sound_stop()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8753
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8754 < {only available when compiled with the \|+sound\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8755
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8756 soundfold()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8757 soundfold({word})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8758 Return the sound-folded equivalent of {word}. Uses the first
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8759 language in 'spelllang' for the current window that supports
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8760 soundfolding. 'spell' must be set. When no sound folding is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8761 possible the {word} is returned unmodified.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8762 This can be used for making spelling suggestions. Note that
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8763 the method can be quite slow.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8764
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8765 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8766 GetWord()->soundfold()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8767 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8768 spellbadword()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8769 spellbadword([{sentence}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8770 Without argument: The result is the badly spelled word under
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8771 or after the cursor. The cursor is moved to the start of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8772 bad word. When no bad word is found in the cursor line the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8773 result is an empty string and the cursor doesn't move.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8774
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8775 With argument: The result is the first word in {sentence} that
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8776 is badly spelled. If there are no spelling mistakes the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8777 result is an empty string.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8778
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8779 The return value is a list with two items:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8780 - The badly spelled word or an empty string.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8781 - The type of the spelling error:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8782 "bad" spelling mistake
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8783 "rare" rare word
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8784 "local" word only valid in another region
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8785 "caps" word should start with Capital
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8786 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8787 echo spellbadword("the quik brown fox")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8788 < ['quik', 'bad'] ~
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8789
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8790 The spelling information for the current window and the value
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8791 of 'spelllang' are used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8792
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8793 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8794 GetText()->spellbadword()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8795 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8796 spellsuggest()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8797 spellsuggest({word} [, {max} [, {capital}]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8798 Return a \|List\| with spelling suggestions to replace {word}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8799 When {max} is given up to this number of suggestions are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8800 returned. Otherwise up to 25 suggestions are returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8801
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8802 When the {capital} argument is given and it's non-zero only
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8803 suggestions with a leading capital will be given. Use this
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8804 after a match with 'spellcapcheck'.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8805
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8806 {word} can be a badly spelled word followed by other text.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8807 This allows for joining two words that were split. The
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8808 suggestions also include the following text, thus you can
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8809 replace a line.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8810
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8811 {word} may also be a good word. Similar words will then be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8812 returned. {word} itself is not included in the suggestions,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8813 although it may appear capitalized.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8814
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8815 The spelling information for the current window is used. The
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8816 values of 'spelllang' and 'spellsuggest' are used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8817
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8818 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8819 GetWord()->spellsuggest()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8820
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8821 split({string} [, {pattern} [, {keepempty}]]) split()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8822 Make a \|List\| out of {string}. When {pattern} is omitted or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8823 empty each white-separated sequence of characters becomes an
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8824 item.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8825 Otherwise the string is split where {pattern} matches,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8826 removing the matched characters. 'ignorecase' is not used
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8827 here, add \c to ignore case. \|/\c\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8828 When the first or last item is empty it is omitted, unless the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8829 {keepempty} argument is given and it's non-zero.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8830 Other empty items are kept when {pattern} matches at least one
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8831 character or when {keepempty} is non-zero.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8832 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8833 :let words = split(getline('.'), '\W\+')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8834 < To split a string in individual characters: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8835 :for c in split(mystring, '\zs')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8836 < If you want to keep the separator you can also use '\zs' at
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8837 the end of the pattern: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8838 :echo split('abc:def:ghi', ':\zs')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8839 < ['abc:', 'def:', 'ghi'] ~
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8840 Splitting a table where the first element can be empty: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8841 :let items = split(line, ':', 1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8842 < The opposite function is \|join()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8843
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8844 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8845 GetString()->split()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8846
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8847 sqrt({expr}) sqrt()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8848 Return the non-negative square root of Float {expr} as a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8849 \|Float\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8850 {expr} must evaluate to a \|Float\| or a \|Number\|. When {expr}
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	8851 is negative the result is NaN (Not a Number). Returns 0.0 if
2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	8852 {expr} is not a \|Float\| or a \|Number\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8853 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8854 :echo sqrt(100)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8855 < 10.0 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8856 :echo sqrt(-4.01)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8857 < nan
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8858 "nan" may be different, it depends on system libraries.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8859
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8860 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8861 Compute()->sqrt()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8862
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8863
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8864 srand([{expr}]) srand()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8865 Initialize seed used by \|rand()\|:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8866 - If {expr} is not given, seed values are initialized by
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8867 reading from /dev/urandom, if possible, or using time(NULL)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8868 a.k.a. epoch time otherwise; this only has second accuracy.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8869 - If {expr} is given it must be a Number. It is used to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8870 initialize the seed values. This is useful for testing or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8871 when a predictable sequence is intended.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8872
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8873 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8874 :let seed = srand()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8875 :let seed = srand(userinput)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8876 :echo rand(seed)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8877
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8878 state([{what}]) state()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8879 Return a string which contains characters indicating the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8880 current state. Mostly useful in callbacks that want to do
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8881 work that may not always be safe. Roughly this works like:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8882 - callback uses state() to check if work is safe to do.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8883 Yes: then do it right away.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8884 No: add to work queue and add a \|SafeState\| and/or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8885 \|SafeStateAgain\| autocommand (\|SafeState\| triggers at
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8886 toplevel, \|SafeStateAgain\| triggers after handling
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8887 messages and callbacks).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8888 - When SafeState or SafeStateAgain is triggered and executes
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8889 your autocommand, check with `state()` if the work can be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8890 done now, and if yes remove it from the queue and execute.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8891 Remove the autocommand if the queue is now empty.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8892 Also see \|mode()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8893
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8894 When {what} is given only characters in this string will be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8895 added. E.g, this checks if the screen has scrolled: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8896 if state('s') == ''
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8897 " screen has not scrolled
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8898 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8899 These characters indicate the state, generally indicating that
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8900 something is busy:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8901 m halfway a mapping, :normal command, feedkeys() or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8902 stuffed command
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8903 o operator pending, e.g. after \|d\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8904 a Insert mode autocomplete active
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8905 x executing an autocommand
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8906 w blocked on waiting, e.g. ch_evalexpr(), ch_read() and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8907 ch_readraw() when reading json
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8908 S not triggering SafeState or SafeStateAgain, e.g. after
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8909 \|f\| or a count
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8910 c callback invoked, including timer (repeats for
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8911 recursiveness up to "ccc")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8912 s screen has scrolled for messages
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8913
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8914 str2float({string} [, {quoted}]) str2float()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8915 Convert String {string} to a Float. This mostly works the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8916 same as when using a floating point number in an expression,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8917 see \|floating-point-format\|. But it's a bit more permissive.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8918 E.g., "1e40" is accepted, while in an expression you need to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8919 write "1.0e40". The hexadecimal form "0x123" is also
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8920 accepted, but not others, like binary or octal.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8921 When {quoted} is present and non-zero then embedded single
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8922 quotes before the dot are ignored, thus "1'000.0" is a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8923 thousand.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8924 Text after the number is silently ignored.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8925 The decimal point is always '.', no matter what the locale is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8926 set to. A comma ends the number: "12,345.67" is converted to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8927 12.0. You can strip out thousands separators with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8928 \|substitute()\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8929 let f = str2float(substitute(text, ',', '', 'g'))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8930 <
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	8931 Returns 0.0 if the conversion fails.
2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	8932
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8933 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8934 let f = text->substitute(',', '', 'g')->str2float()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8935
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8936 str2list({string} [, {utf8}]) str2list()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8937 Return a list containing the number values which represent
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8938 each character in String {string}. Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8939 str2list(" ") returns [32]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8940 str2list("ABC") returns [65, 66, 67]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8941 < \|list2str()\| does the opposite.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8942
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8943 When {utf8} is omitted or zero, the current 'encoding' is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8944 When {utf8} is TRUE, always treat the String as UTF-8
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8945 characters. With UTF-8 composing characters are handled
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8946 properly: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8947 str2list("á") returns [97, 769]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8948
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8949 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8950 GetString()->str2list()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8951
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8952
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8953 str2nr({string} [, {base} [, {quoted}]]) str2nr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8954 Convert string {string} to a number.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8955 {base} is the conversion base, it can be 2, 8, 10 or 16.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8956 When {quoted} is present and non-zero then embedded single
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8957 quotes are ignored, thus "1'000'000" is a million.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8958
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8959 When {base} is omitted base 10 is used. This also means that
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8960 a leading zero doesn't cause octal conversion to be used, as
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8961 with the default String to Number conversion. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8962 let nr = str2nr('0123')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8963 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8964 When {base} is 16 a leading "0x" or "0X" is ignored. With a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8965 different base the result will be zero. Similarly, when
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8966 {base} is 8 a leading "0", "0o" or "0O" is ignored, and when
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8967 {base} is 2 a leading "0b" or "0B" is ignored.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8968 Text after the number is silently ignored.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8969
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	8970 Returns 0 if {string} is empty or on error.
2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	8971
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8972 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8973 GetText()->str2nr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8974
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8975
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8976 strcharlen({string}) strcharlen()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8977 The result is a Number, which is the number of characters
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8978 in String {string}. Composing characters are ignored.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8979 \|strchars()\| can count the number of characters, counting
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8980 composing characters separately.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8981
29121 2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	8982 Returns 0 if {string} is empty or on error.
2a1f9b4a5ac9 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29087 diff changeset	8983
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8984 Also see \|strlen()\|, \|strdisplaywidth()\| and \|strwidth()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8985
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8986 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8987 GetText()->strcharlen()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8988
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8989
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8990 strcharpart({src}, {start} [, {len} [, {skipcc}]]) strcharpart()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8991 Like \|strpart()\| but using character index and length instead
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8992 of byte index and length.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8993 When {skipcc} is omitted or zero, composing characters are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8994 counted separately.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8995 When {skipcc} set to 1, Composing characters are ignored,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8996 similar to \|slice()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8997 When a character index is used where a character does not
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8998 exist it is omitted and counted as one character. For
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8999 example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9000 strcharpart('abc', -1, 2)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9001 < results in 'a'.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9002
29193 1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9003 Returns an empty string on error.
1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9004
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9005 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9006 GetText()->strcharpart(5)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9007
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9008
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9009 strchars({string} [, {skipcc}]) strchars()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9010 The result is a Number, which is the number of characters
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9011 in String {string}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9012 When {skipcc} is omitted or zero, composing characters are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9013 counted separately.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9014 When {skipcc} set to 1, Composing characters are ignored.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9015 \|strcharlen()\| always does this.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9016
29193 1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9017 Returns zero on error.
1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9018
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9019 Also see \|strlen()\|, \|strdisplaywidth()\| and \|strwidth()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9020
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9021 {skipcc} is only available after 7.4.755. For backward
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9022 compatibility, you can define a wrapper function: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9023 if has("patch-7.4.755")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9024 function s:strchars(str, skipcc)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9025 return strchars(a:str, a:skipcc)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9026 endfunction
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9027 else
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9028 function s:strchars(str, skipcc)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9029 if a:skipcc
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9030 return strlen(substitute(a:str, ".", "x", "g"))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9031 else
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9032 return strchars(a:str)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9033 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9034 endfunction
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9035 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9036 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9037 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9038 GetText()->strchars()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9039
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9040 strdisplaywidth({string} [, {col}]) strdisplaywidth()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9041 The result is a Number, which is the number of display cells
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9042 String {string} occupies on the screen when it starts at {col}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9043 (first column is zero). When {col} is omitted zero is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9044 Otherwise it is the screen column where to start. This
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9045 matters for Tab characters.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9046 The option settings of the current window are used. This
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9047 matters for anything that's displayed differently, such as
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9048 'tabstop' and 'display'.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9049 When {string} contains characters with East Asian Width Class
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9050 Ambiguous, this function's return value depends on 'ambiwidth'.
29193 1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9051 Returns zero on error.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9052 Also see \|strlen()\|, \|strwidth()\| and \|strchars()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9053
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9054 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9055 GetText()->strdisplaywidth()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9056
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9057 strftime({format} [, {time}]) strftime()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9058 The result is a String, which is a formatted date and time, as
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9059 specified by the {format} string. The given {time} is used,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9060 or the current time if no time is given. The accepted
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9061 {format} depends on your system, thus this is not portable!
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9062 See the manual page of the C function strftime() for the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9063 format. The maximum length of the result is 80 characters.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9064 See also \|localtime()\|, \|getftime()\| and \|strptime()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9065 The language can be changed with the \|:language\| command.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9066 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9067 :echo strftime("%c") Sun Apr 27 11:49:23 1997
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9068 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9069 :echo strftime("%y%m%d %T") 970427 11:53:55
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9070 :echo strftime("%H:%M") 11:55
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9071 :echo strftime("%c", getftime("file.c"))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9072 Show mod time of file.c.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9073 < Not available on all systems. To check use: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9074 :if exists("*strftime")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9075
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9076 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9077 GetFormat()->strftime()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9078
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9079 strgetchar({str}, {index}) strgetchar()
28933 57c9377b9c62 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 28917 diff changeset	9080 Get a Number corresponding to the character at {index} in
57c9377b9c62 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 28917 diff changeset	9081 {str}. This uses a zero-based character index, not a byte
57c9377b9c62 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 28917 diff changeset	9082 index. Composing characters are considered separate
57c9377b9c62 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 28917 diff changeset	9083 characters here. Use \|nr2char()\| to convert the Number to a
57c9377b9c62 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 28917 diff changeset	9084 String.
29193 1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9085 Returns -1 if {index} is invalid.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9086 Also see \|strcharpart()\| and \|strchars()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9087
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9088 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9089 GetText()->strgetchar(5)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9090
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9091 stridx({haystack}, {needle} [, {start}]) stridx()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9092 The result is a Number, which gives the byte index in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9093 {haystack} of the first occurrence of the String {needle}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9094 If {start} is specified, the search starts at index {start}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9095 This can be used to find a second match: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9096 :let colon1 = stridx(line, ":")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9097 :let colon2 = stridx(line, ":", colon1 + 1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9098 < The search is done case-sensitive.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9099 For pattern searches use \|match()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9100 -1 is returned if the {needle} does not occur in {haystack}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9101 See also \|strridx()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9102 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9103 :echo stridx("An Example", "Example") 3
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9104 :echo stridx("Starting point", "Start") 0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9105 :echo stridx("Starting point", "start") -1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9106 < strstr() strchr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9107 stridx() works similar to the C function strstr(). When used
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9108 with a single character it works similar to strchr().
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9109
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9110 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9111 GetHaystack()->stridx(needle)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9112 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9113 string()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9114 string({expr}) Return {expr} converted to a String. If {expr} is a Number,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9115 Float, String, Blob or a composition of them, then the result
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9116 can be parsed back with \|eval()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9117 {expr} type result ~
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9118 String 'string' (single quotes are doubled)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9119 Number 123
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9120 Float 123.123456 or 1.123456e8
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9121 Funcref function('name')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9122 Blob 0z00112233.44556677.8899
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9123 List [item, item]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9124 Dictionary {key: value, key: value}
31579 7d68a90cbf5c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31503 diff changeset	9125 Class class SomeName
7d68a90cbf5c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31503 diff changeset	9126 Object object of SomeName {lnum: 1, col: 3}
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9127
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9128 When a \|List\| or \|Dictionary\| has a recursive reference it is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9129 replaced by "[...]" or "{...}". Using eval() on the result
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9130 will then fail.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9131
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9132 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9133 mylist->string()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9134
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9135 < Also see \|strtrans()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9136
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9137
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9138 strlen({string}) strlen()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9139 The result is a Number, which is the length of the String
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9140 {string} in bytes.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9141 If the argument is a Number it is first converted to a String.
29193 1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9142 For other types an error is given and zero is returned.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9143 If you want to count the number of multibyte characters use
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9144 \|strchars()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9145 Also see \|len()\|, \|strdisplaywidth()\| and \|strwidth()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9146
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9147 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9148 GetString()->strlen()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9149
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9150 strpart({src}, {start} [, {len} [, {chars}]]) strpart()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9151 The result is a String, which is part of {src}, starting from
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9152 byte {start}, with the byte length {len}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9153 When {chars} is present and TRUE then {len} is the number of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9154 characters positions (composing characters are not counted
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9155 separately, thus "1" means one base character and any
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9156 following composing characters).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9157 To count {start} as characters instead of bytes use
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9158 \|strcharpart()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9159
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9160 When bytes are selected which do not exist, this doesn't
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9161 result in an error, the bytes are simply omitted.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9162 If {len} is missing, the copy continues from {start} till the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9163 end of the {src}. >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9164 strpart("abcdefg", 3, 2) == "de"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9165 strpart("abcdefg", -2, 4) == "ab"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9166 strpart("abcdefg", 5, 4) == "fg"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9167 strpart("abcdefg", 3) == "defg"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9168
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9169 < Note: To get the first character, {start} must be 0. For
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9170 example, to get the character under the cursor: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9171 strpart(getline("."), col(".") - 1, 1, v:true)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9172 <
29193 1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9173 Returns an empty string on error.
1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9174
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9175 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9176 GetText()->strpart(5)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9177
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9178 strptime({format}, {timestring}) strptime()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9179 The result is a Number, which is a unix timestamp representing
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9180 the date and time in {timestring}, which is expected to match
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9181 the format specified in {format}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9182
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9183 The accepted {format} depends on your system, thus this is not
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9184 portable! See the manual page of the C function strptime()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9185 for the format. Especially avoid "%c". The value of $TZ also
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9186 matters.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9187
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9188 If the {timestring} cannot be parsed with {format} zero is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9189 returned. If you do not know the format of {timestring} you
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9190 can try different {format} values until you get a non-zero
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9191 result.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9192
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9193 See also \|strftime()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9194 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9195 :echo strptime("%Y %b %d %X", "1997 Apr 27 11:49:23")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9196 < 862156163 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9197 :echo strftime("%c", strptime("%y%m%d %T", "970427 11:53:55"))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9198 < Sun Apr 27 11:53:55 1997 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9199 :echo strftime("%c", strptime("%Y%m%d%H%M%S", "19970427115355") + 3600)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9200 < Sun Apr 27 12:53:55 1997
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9201
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9202 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9203 GetFormat()->strptime(timestring)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9204 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9205 Not available on all systems. To check use: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9206 :if exists("*strptime")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9207
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9208 strridx({haystack}, {needle} [, {start}]) strridx()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9209 The result is a Number, which gives the byte index in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9210 {haystack} of the last occurrence of the String {needle}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9211 When {start} is specified, matches beyond this index are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9212 ignored. This can be used to find a match before a previous
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9213 match: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9214 :let lastcomma = strridx(line, ",")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9215 :let comma2 = strridx(line, ",", lastcomma - 1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9216 < The search is done case-sensitive.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9217 For pattern searches use \|match()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9218 -1 is returned if the {needle} does not occur in {haystack}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9219 If the {needle} is empty the length of {haystack} is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9220 See also \|stridx()\|. Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9221 :echo strridx("an angry armadillo", "an") 3
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9222 < strrchr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9223 When used with a single character it works similar to the C
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9224 function strrchr().
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9225
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9226 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9227 GetHaystack()->strridx(needle)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9228
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9229 strtrans({string}) strtrans()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9230 The result is a String, which is {string} with all unprintable
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9231 characters translated into printable characters \|'isprint'\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9232 Like they are shown in a window. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9233 echo strtrans(@a)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9234 < This displays a newline in register a as "^@" instead of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9235 starting a new line.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9236
29193 1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9237 Returns an empty string on error.
1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9238
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9239 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9240 GetString()->strtrans()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9241
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9242 strwidth({string}) strwidth()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9243 The result is a Number, which is the number of display cells
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9244 String {string} occupies. A Tab character is counted as one
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9245 cell, alternatively use \|strdisplaywidth()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9246 When {string} contains characters with East Asian Width Class
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9247 Ambiguous, this function's return value depends on 'ambiwidth'.
29193 1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9248 Returns zero on error.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9249 Also see \|strlen()\|, \|strdisplaywidth()\| and \|strchars()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9250
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9251 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9252 GetString()->strwidth()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9253
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9254 submatch({nr} [, {list}]) submatch() E935
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9255 Only for an expression in a \|:substitute\| command or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9256 substitute() function.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9257 Returns the {nr}'th submatch of the matched text. When {nr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9258 is 0 the whole matched text is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9259 Note that a NL in the string can stand for a line break of a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9260 multi-line match or a NUL character in the text.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9261 Also see \|sub-replace-expression\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9262
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9263 If {list} is present and non-zero then submatch() returns
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9264 a list of strings, similar to \|getline()\| with two arguments.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9265 NL characters in the text represent NUL characters in the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9266 text.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9267 Only returns more than one item for \|:substitute\|, inside
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9268 \|substitute()\| this list will always contain one or zero
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9269 items, since there are no real line breaks.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9270
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9271 When substitute() is used recursively only the submatches in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9272 the current (deepest) call can be obtained.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9273
29193 1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9274 Returns an empty string or list on error.
1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9275
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9276 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9277 :s/\d\+/\=submatch(0) + 1/
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9278 :echo substitute(text, '\d\+', '\=submatch(0) + 1', '')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9279 < This finds the first number in the line and adds one to it.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9280 A line break is included as a newline character.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9281
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9282 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9283 GetNr()->submatch()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9284
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9285 substitute({string}, {pat}, {sub}, {flags}) substitute()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9286 The result is a String, which is a copy of {string}, in which
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9287 the first match of {pat} is replaced with {sub}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9288 When {flags} is "g", all matches of {pat} in {string} are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9289 replaced. Otherwise {flags} should be "".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9290
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9291 This works like the ":substitute" command (without any flags).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9292 But the matching with {pat} is always done like the 'magic'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9293 option is set and 'cpoptions' is empty (to make scripts
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9294 portable). 'ignorecase' is still relevant, use \|/\c\| or \|/\C\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9295 if you want to ignore or match case and ignore 'ignorecase'.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9296 'smartcase' is not used. See \|string-match\| for how {pat} is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9297 used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9298
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9299 A "~" in {sub} is not replaced with the previous {sub}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9300 Note that some codes in {sub} have a special meaning
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9301 \|sub-replace-special\|. For example, to replace something with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9302 "\n" (two characters), use "\\\\n" or '\\n'.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9303
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9304 When {pat} does not match in {string}, {string} is returned
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9305 unmodified.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9306
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9307 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9308 :let &path = substitute(&path, ",\\=[^,]*$", "", "")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9309 < This removes the last component of the 'path' option. >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9310 :echo substitute("testing", ".*", "\\U\\0", "")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9311 < results in "TESTING".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9312
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9313 When {sub} starts with "\=", the remainder is interpreted as
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9314 an expression. See \|sub-replace-expression\|. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9315 :echo substitute(s, '%$\x\x$',
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	9316 \ '\=nr2char("0x" .. submatch(1))', 'g')
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9317
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9318 < When {sub} is a Funcref that function is called, with one
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9319 optional argument. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9320 :echo substitute(s, '%$\x\x$', SubNr, 'g')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9321 < The optional argument is a list which contains the whole
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9322 matched string and up to nine submatches, like what
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9323 \|submatch()\| returns. Example: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	9324 :echo substitute(s, '%$\x\x$', {m -> '0x' .. m[1]}, 'g')
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9325
29193 1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9326 < Returns an empty string on error.
1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9327
1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9328 Can also be used as a \|method\|: >
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9329 GetString()->substitute(pat, sub, flags)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9330
31347 56a2af8c0980 patch 9.0.1007: there is no way to get a list of swap file names Bram Moolenaar <Bram@vim.org> parents: 31200 diff changeset	9331 swapfilelist() swapfilelist()
56a2af8c0980 patch 9.0.1007: there is no way to get a list of swap file names Bram Moolenaar <Bram@vim.org> parents: 31200 diff changeset	9332 Returns a list of swap file names, like what "vim -r" shows.
56a2af8c0980 patch 9.0.1007: there is no way to get a list of swap file names Bram Moolenaar <Bram@vim.org> parents: 31200 diff changeset	9333 See the \|-r\| command argument. The 'directory' option is used
56a2af8c0980 patch 9.0.1007: there is no way to get a list of swap file names Bram Moolenaar <Bram@vim.org> parents: 31200 diff changeset	9334 for the directories to inspect. If you only want to get a
56a2af8c0980 patch 9.0.1007: there is no way to get a list of swap file names Bram Moolenaar <Bram@vim.org> parents: 31200 diff changeset	9335 list of swap files in the current directory then temporarily
56a2af8c0980 patch 9.0.1007: there is no way to get a list of swap file names Bram Moolenaar <Bram@vim.org> parents: 31200 diff changeset	9336 set 'directory' to a dot: >
56a2af8c0980 patch 9.0.1007: there is no way to get a list of swap file names Bram Moolenaar <Bram@vim.org> parents: 31200 diff changeset	9337 let save_dir = &directory
56a2af8c0980 patch 9.0.1007: there is no way to get a list of swap file names Bram Moolenaar <Bram@vim.org> parents: 31200 diff changeset	9338 let &directory = '.'
56a2af8c0980 patch 9.0.1007: there is no way to get a list of swap file names Bram Moolenaar <Bram@vim.org> parents: 31200 diff changeset	9339 let swapfiles = swapfilelist()
56a2af8c0980 patch 9.0.1007: there is no way to get a list of swap file names Bram Moolenaar <Bram@vim.org> parents: 31200 diff changeset	9340 let &directory = save_dir
56a2af8c0980 patch 9.0.1007: there is no way to get a list of swap file names Bram Moolenaar <Bram@vim.org> parents: 31200 diff changeset	9341
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9342 swapinfo({fname}) swapinfo()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9343 The result is a dictionary, which holds information about the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9344 swapfile {fname}. The available fields are:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9345 version Vim version
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9346 user user name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9347 host host name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9348 fname original file name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9349 pid PID of the Vim process that created the swap
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9350 file
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9351 mtime last modification time in seconds
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9352 inode Optional: INODE number of the file
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9353 dirty 1 if file was modified, 0 if not
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9354 Note that "user" and "host" are truncated to at most 39 bytes.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9355 In case of failure an "error" item is added with the reason:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9356 Cannot open file: file not found or in accessible
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9357 Cannot read file: cannot read first block
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9358 Not a swap file: does not contain correct block ID
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9359 Magic number mismatch: Info in first block is invalid
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9360
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9361 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9362 GetFilename()->swapinfo()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9363
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9364 swapname({buf}) swapname()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9365 The result is the swap file path of the buffer {expr}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9366 For the use of {buf}, see \|bufname()\| above.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9367 If buffer {buf} is the current buffer, the result is equal to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9368 \|:swapname\| (unless there is no swap file).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9369 If buffer {buf} has no swap file, returns an empty string.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9370
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9371 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9372 GetBufname()->swapname()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9373
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9374 synID({lnum}, {col}, {trans}) synID()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9375 The result is a Number, which is the syntax ID at the position
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9376 {lnum} and {col} in the current window.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9377 The syntax ID can be used with \|synIDattr()\| and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9378 \|synIDtrans()\| to obtain syntax information about text.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9379
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9380 {col} is 1 for the leftmost column, {lnum} is 1 for the first
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9381 line. 'synmaxcol' applies, in a longer line zero is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9382 Note that when the position is after the last character,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9383 that's where the cursor can be in Insert mode, synID() returns
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9384 zero. {lnum} is used like with \|getline()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9385
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9386 When {trans} is \|TRUE\|, transparent items are reduced to the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9387 item that they reveal. This is useful when wanting to know
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9388 the effective color. When {trans} is \|FALSE\|, the transparent
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9389 item is returned. This is useful when wanting to know which
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9390 syntax item is effective (e.g. inside parens).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9391 Warning: This function can be very slow. Best speed is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9392 obtained by going through the file in forward direction.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9393
29193 1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9394 Returns zero on error.
1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9395
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9396 Example (echoes the name of the syntax item under the cursor): >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9397 :echo synIDattr(synID(line("."), col("."), 1), "name")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9398 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9399
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9400 synIDattr({synID}, {what} [, {mode}]) synIDattr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9401 The result is a String, which is the {what} attribute of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9402 syntax ID {synID}. This can be used to obtain information
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9403 about a syntax item.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9404 {mode} can be "gui", "cterm" or "term", to get the attributes
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9405 for that mode. When {mode} is omitted, or an invalid value is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9406 used, the attributes for the currently active highlighting are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9407 used (GUI, cterm or term).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9408 Use synIDtrans() to follow linked highlight groups.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9409 {what} result
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9410 "name" the name of the syntax item
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9411 "fg" foreground color (GUI: color name used to set
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9412 the color, cterm: color number as a string,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9413 term: empty string)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9414 "bg" background color (as with "fg")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9415 "font" font name (only available in the GUI)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9416 \|highlight-font\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9417 "sp" special color for the GUI (as with "fg")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9418 \|highlight-guisp\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9419 "ul" underline color for cterm: number as a string
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9420 "fg#" like "fg", but for the GUI and the GUI is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9421 running the name in "#RRGGBB" form
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9422 "bg#" like "fg#" for "bg"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9423 "sp#" like "fg#" for "sp"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9424 "bold" "1" if bold
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9425 "italic" "1" if italic
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9426 "reverse" "1" if reverse
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9427 "inverse" "1" if inverse (= reverse)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9428 "standout" "1" if standout
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9429 "underline" "1" if underlined
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9430 "undercurl" "1" if undercurled
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9431 "strike" "1" if strikethrough
29540 9b8ab82e3b0b patch 9.0.0111: "nocombine" is missing from synIDattr() Bram Moolenaar <Bram@vim.org> parents: 29533 diff changeset	9432 "nocombine" "1" if nocombine
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9433
29193 1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9434 Returns an empty string on error.
1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9435
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9436 Example (echoes the color of the syntax item under the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9437 cursor): >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9438 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9439 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9440 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9441 :echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9442
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9443
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9444 synIDtrans({synID}) synIDtrans()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9445 The result is a Number, which is the translated syntax ID of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9446 {synID}. This is the syntax group ID of what is being used to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9447 highlight the character. Highlight links given with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9448 ":highlight link" are followed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9449
29193 1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9450 Returns zero on error.
1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9451
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9452 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9453 :echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9454
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9455 synconcealed({lnum}, {col}) synconcealed()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9456 The result is a \|List\| with currently three items:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9457 1. The first item in the list is 0 if the character at the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9458 position {lnum} and {col} is not part of a concealable
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9459 region, 1 if it is. {lnum} is used like with \|getline()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9460 2. The second item in the list is a string. If the first item
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9461 is 1, the second item contains the text which will be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9462 displayed in place of the concealed text, depending on the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9463 current setting of 'conceallevel' and 'listchars'.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9464 3. The third and final item in the list is a number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9465 representing the specific syntax region matched in the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9466 line. When the character is not concealed the value is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9467 zero. This allows detection of the beginning of a new
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9468 concealable region if there are two consecutive regions
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9469 with the same replacement character. For an example, if
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9470 the text is "123456" and both "23" and "45" are concealed
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9471 and replaced by the character "X", then:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9472 call returns ~
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9473 synconcealed(lnum, 1) [0, '', 0]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9474 synconcealed(lnum, 2) [1, 'X', 1]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9475 synconcealed(lnum, 3) [1, 'X', 1]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9476 synconcealed(lnum, 4) [1, 'X', 2]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9477 synconcealed(lnum, 5) [1, 'X', 2]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9478 synconcealed(lnum, 6) [0, '', 0]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9479
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9480
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9481 synstack({lnum}, {col}) synstack()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9482 Return a \|List\|, which is the stack of syntax items at the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9483 position {lnum} and {col} in the current window. {lnum} is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9484 used like with \|getline()\|. Each item in the List is an ID
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9485 like what \|synID()\| returns.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9486 The first item in the List is the outer region, following are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9487 items contained in that one. The last one is what \|synID()\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9488 returns, unless not the whole item is highlighted or it is a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9489 transparent item.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9490 This function is useful for debugging a syntax file.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9491 Example that shows the syntax stack under the cursor: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9492 for id in synstack(line("."), col("."))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9493 echo synIDattr(id, "name")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9494 endfor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9495 < When the position specified with {lnum} and {col} is invalid
29193 1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9496 an empty List is returned. The position just after the last
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9497 character in a line and the first column in an empty line are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9498 valid positions.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9499
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9500 system({expr} [, {input}]) system() E677
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9501 Get the output of the shell command {expr} as a \|String\|. See
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9502 \|systemlist()\| to get the output as a \|List\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9503
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9504 When {input} is given and is a \|String\| this string is written
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9505 to a file and passed as stdin to the command. The string is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9506 written as-is, you need to take care of using the correct line
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9507 separators yourself.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9508 If {input} is given and is a \|List\| it is written to the file
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9509 in a way \|writefile()\| does with {binary} set to "b" (i.e.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9510 with a newline between each list item with newlines inside
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9511 list items converted to NULs).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9512 When {input} is given and is a number that is a valid id for
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9513 an existing buffer then the content of the buffer is written
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9514 to the file line by line, each line terminated by a NL and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9515 NULs characters where the text has a NL.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9516
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9517 Pipes are not used, the 'shelltemp' option is not used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9518
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9519 When prepended by \|:silent\| the terminal will not be set to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9520 cooked mode. This is meant to be used for commands that do
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9521 not need the user to type. It avoids stray characters showing
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9522 up on the screen which require \|CTRL-L\| to remove. >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9523 :silent let f = system('ls *.vim')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9524 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9525 Note: Use \|shellescape()\| or \|::S\| with \|expand()\| or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9526 \|fnamemodify()\| to escape special characters in a command
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9527 argument. Newlines in {expr} may cause the command to fail.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9528 The characters in 'shellquote' and 'shellxquote' may also
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9529 cause trouble.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9530 This is not to be used for interactive commands.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9531
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9532 The result is a String. Example: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	9533 :let files = system('ls ' .. shellescape(expand('%:h')))
d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	9534 :let files = system('ls ' .. expand('%:h:S'))
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9535
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9536 < To make the result more system-independent, the shell output
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9537 is filtered to replace <CR> with <NL> for Macintosh, and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9538 <CR><NL> with <NL> for DOS-like systems.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9539 To avoid the string being truncated at a NUL, all NUL
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9540 characters are replaced with SOH (0x01).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9541
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9542 The command executed is constructed using several options:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9543 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9544 ({tmp} is an automatically generated file name).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9545 For Unix, braces are put around {expr} to allow for
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9546 concatenated commands.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9547
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9548 The command will be executed in "cooked" mode, so that a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9549 CTRL-C will interrupt the command (on Unix at least).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9550
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9551 The resulting error code can be found in \|v:shell_error\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9552 This function will fail in \|restricted-mode\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9553
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9554 Note that any wrong value in the options mentioned above may
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9555 make the function fail. It has also been reported to fail
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9556 when using a security agent application.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9557 Unlike ":!cmd" there is no automatic check for changed files.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9558 Use \|:checktime\| to force a check.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9559
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9560 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9561 :echo GetCmd()->system()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9562
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9563
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9564 systemlist({expr} [, {input}]) systemlist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9565 Same as \|system()\|, but returns a \|List\| with lines (parts of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9566 output separated by NL) with NULs transformed into NLs. Output
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9567 is the same as \|readfile()\| will output with {binary} argument
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9568 set to "b", except that there is no extra empty item when the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9569 result ends in a NL.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9570 Note that on MS-Windows you may get trailing CR characters.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9571
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9572 To see the difference between "echo hello" and "echo -n hello"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9573 use \|system()\| and \|split()\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9574 echo system('echo hello')->split('\n', 1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9575 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9576 Returns an empty string on error.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9577
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9578 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9579 :echo GetCmd()->systemlist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9580
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9581
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9582 tabpagebuflist([{arg}]) tabpagebuflist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9583 The result is a \|List\|, where each item is the number of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9584 buffer associated with each window in the current tab page.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9585 {arg} specifies the number of the tab page to be used. When
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9586 omitted the current tab page is used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9587 When {arg} is invalid the number zero is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9588 To get a list of all buffers in all tabs use this: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9589 let buflist = []
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9590 for i in range(tabpagenr('$'))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9591 call extend(buflist, tabpagebuflist(i + 1))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9592 endfor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9593 < Note that a buffer may appear in more than one window.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9594
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9595 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9596 GetTabpage()->tabpagebuflist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9597
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9598 tabpagenr([{arg}]) tabpagenr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9599 The result is a Number, which is the number of the current
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9600 tab page. The first tab page has number 1.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9601
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9602 The optional argument {arg} supports the following values:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9603 $ the number of the last tab page (the tab page
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9604 count).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9605 # the number of the last accessed tab page
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9606 (where \|g<Tab>\| goes to). if there is no
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9607 previous tab page 0 is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9608 The number can be used with the \|:tab\| command.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9609
29193 1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9610 Returns zero on error.
1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9611
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9612
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9613 tabpagewinnr({tabarg} [, {arg}]) tabpagewinnr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9614 Like \|winnr()\| but for tab page {tabarg}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9615 {tabarg} specifies the number of tab page to be used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9616 {arg} is used like with \|winnr()\|:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9617 - When omitted the current window number is returned. This is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9618 the window which will be used when going to this tab page.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9619 - When "$" the number of windows is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9620 - When "#" the previous window nr is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9621 Useful examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9622 tabpagewinnr(1) " current window of tab page 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9623 tabpagewinnr(4, '$') " number of windows in tab page 4
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9624 < When {tabarg} is invalid zero is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9625
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9626 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9627 GetTabpage()->tabpagewinnr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9628 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9629 tagfiles()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9630 tagfiles() Returns a \|List\| with the file names used to search for tags
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9631 for the current buffer. This is the 'tags' option expanded.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9632
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9633
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9634 taglist({expr} [, {filename}]) taglist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9635 Returns a \|List\| of tags matching the regular expression {expr}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9636
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9637 If {filename} is passed it is used to prioritize the results
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9638 in the same way that \|:tselect\| does. See \|tag-priority\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9639 {filename} should be the full path of the file.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9640
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9641 Each list item is a dictionary with at least the following
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9642 entries:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9643 name Name of the tag.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9644 filename Name of the file where the tag is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9645 defined. It is either relative to the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9646 current directory or a full path.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9647 cmd Ex command used to locate the tag in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9648 the file.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9649 kind Type of the tag. The value for this
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9650 entry depends on the language specific
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9651 kind values. Only available when
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9652 using a tags file generated by
28141 dce918af0c00 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28081 diff changeset	9653 Universal/Exuberant ctags or hdrtag.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9654 static A file specific tag. Refer to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9655 \|static-tag\| for more information.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9656 More entries may be present, depending on the content of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9657 tags file: access, implementation, inherits and signature.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9658 Refer to the ctags documentation for information about these
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9659 fields. For C code the fields "struct", "class" and "enum"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9660 may appear, they give the name of the entity the tag is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9661 contained in.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9662
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9663 The ex-command "cmd" can be either an ex search pattern, a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9664 line number or a line number followed by a byte number.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9665
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9666 If there are no matching tags, then an empty list is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9667
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9668 To get an exact tag match, the anchors '^' and '$' should be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9669 used in {expr}. This also make the function work faster.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9670 Refer to \|tag-regexp\| for more information about the tag
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9671 search regular expression pattern.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9672
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9673 Refer to \|'tags'\| for information about how the tags file is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9674 located by Vim. Refer to \|tags-file-format\| for the format of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9675 the tags file generated by the different ctags tools.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9676
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9677 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9678 GetTagpattern()->taglist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9679
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9680 tan({expr}) tan()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9681 Return the tangent of {expr}, measured in radians, as a \|Float\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9682 in the range [-inf, inf].
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9683 {expr} must evaluate to a \|Float\| or a \|Number\|.
29193 1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9684 Returns 0.0 if {expr} is not a \|Float\| or a \|Number\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9685 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9686 :echo tan(10)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9687 < 0.648361 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9688 :echo tan(-4.01)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9689 < -1.181502
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9690
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9691 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9692 Compute()->tan()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9693
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9694
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9695 tanh({expr}) tanh()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9696 Return the hyperbolic tangent of {expr} as a \|Float\| in the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9697 range [-1, 1].
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9698 {expr} must evaluate to a \|Float\| or a \|Number\|.
29193 1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9699 Returns 0.0 if {expr} is not a \|Float\| or a \|Number\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9700 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9701 :echo tanh(0.5)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9702 < 0.462117 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9703 :echo tanh(-1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9704 < -0.761594
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9705
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9706 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9707 Compute()->tanh()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9708
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9709
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9710 tempname() tempname() temp-file-name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9711 The result is a String, which is the name of a file that
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9712 doesn't exist. It can be used for a temporary file. The name
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9713 is different for at least 26 consecutive calls. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9714 :let tmpfile = tempname()
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	9715 :exe "redir > " .. tmpfile
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9716 < For Unix, the file will be in a private directory \|tempfile\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9717 For MS-Windows forward slashes are used when the 'shellslash'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9718 option is set, or when 'shellcmdflag' starts with '-' and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9719 'shell' does not contain powershell or pwsh.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9720
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9721
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9722 term_ functions are documented here: \|terminal-function-details\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9723
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9724
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9725 terminalprops() terminalprops()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9726 Returns a \|Dictionary\| with properties of the terminal that Vim
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9727 detected from the response to \|t_RV\| request. See
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9728 \|v:termresponse\| for the response itself. If \|v:termresponse\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9729 is empty most values here will be 'u' for unknown.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9730 cursor_style whether sending \|t_RS\| works **
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9731 cursor_blink_mode whether sending \|t_RC\| works **
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9732 underline_rgb whether \|t_8u\| works **
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9733 mouse mouse type supported
30958 122f883d7237 patch 9.0.0813: Kitty terminal is not recognized Bram Moolenaar <Bram@vim.org> parents: 30952 diff changeset	9734 kitty whether Kitty terminal was detected
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9735
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9736 ** value 'u' for unknown, 'y' for yes, 'n' for no
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9737
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9738 If the \|+termresponse\| feature is missing then the result is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9739 an empty dictionary.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9740
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9741 If "cursor_style" is 'y' then \|t_RS\| will be sent to request the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9742 current cursor style.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9743 If "cursor_blink_mode" is 'y' then \|t_RC\| will be sent to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9744 request the cursor blink status.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9745 "cursor_style" and "cursor_blink_mode" are also set if \|t_u7\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9746 is not empty, Vim will detect the working of sending \|t_RS\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9747 and \|t_RC\| on startup.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9748
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9749 When "underline_rgb" is not 'y', then \|t_8u\| will be made empty.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9750 This avoids sending it to xterm, which would clear the colors.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9751
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9752 For "mouse" the value 'u' is unknown
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9753
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9754 Also see:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9755 - 'ambiwidth' - detected by using \|t_u7\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9756 - \|v:termstyleresp\| and \|v:termblinkresp\| for the response to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9757 \|t_RS\| and \|t_RC\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9758
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9759
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9760 test_ functions are documented here: \|test-functions-details\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9761
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9762
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9763 timer_info()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9764 timer_info([{id}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9765 Return a list with information about timers.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9766 When {id} is given only information about this timer is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9767 returned. When timer {id} does not exist an empty list is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9768 returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9769 When {id} is omitted information about all timers is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9770
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9771 For each timer the information is stored in a \|Dictionary\| with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9772 these items:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9773 "id" the timer ID
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9774 "time" time the timer was started with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9775 "remaining" time until the timer fires
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9776 "repeat" number of times the timer will still fire;
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9777 -1 means forever
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9778 "callback" the callback
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9779 "paused" 1 if the timer is paused, 0 otherwise
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9780
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9781 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9782 GetTimer()->timer_info()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9783
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9784 < {only available when compiled with the \|+timers\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9785
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9786 timer_pause({timer}, {paused}) timer_pause()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9787 Pause or unpause a timer. A paused timer does not invoke its
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9788 callback when its time expires. Unpausing a timer may cause
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9789 the callback to be invoked almost immediately if enough time
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9790 has passed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9791
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9792 Pausing a timer is useful to avoid the callback to be called
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9793 for a short time.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9794
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9795 If {paused} evaluates to a non-zero Number or a non-empty
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9796 String, then the timer is paused, otherwise it is unpaused.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9797 See \|non-zero-arg\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9798
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9799 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9800 GetTimer()->timer_pause(1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9801
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9802 < {only available when compiled with the \|+timers\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9803
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9804 timer_start() timer timers
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9805 timer_start({time}, {callback} [, {options}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9806 Create a timer and return the timer ID.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9807
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9808 {time} is the waiting time in milliseconds. This is the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9809 minimum time before invoking the callback. When the system is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9810 busy or Vim is not waiting for input the time will be longer.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9811
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9812 {callback} is the function to call. It can be the name of a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9813 function or a \|Funcref\|. It is called with one argument, which
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9814 is the timer ID. The callback is only invoked when Vim is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9815 waiting for input.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9816 If you want to show a message look at \|popup_notification()\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9817 to avoid interfering with what the user is doing.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9818
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9819 {options} is a dictionary. Supported entries:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9820 "repeat" Number of times to repeat calling the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9821 callback. -1 means forever. When not present
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9822 the callback will be called once.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9823 If the timer causes an error three times in a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9824 row the repeat is cancelled. This avoids that
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9825 Vim becomes unusable because of all the error
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9826 messages.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9827
29193 1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9828 Returns -1 on error.
1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9829
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9830 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9831 func MyHandler(timer)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9832 echo 'Handler called'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9833 endfunc
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9834 let timer = timer_start(500, 'MyHandler',
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9835 \ {'repeat': 3})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9836 < This will invoke MyHandler() three times at 500 msec
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9837 intervals.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9838
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9839 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9840 GetMsec()->timer_start(callback)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9841
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9842 < Not available in the \|sandbox\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9843 {only available when compiled with the \|+timers\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9844
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9845 timer_stop({timer}) timer_stop()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9846 Stop a timer. The timer callback will no longer be invoked.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9847 {timer} is an ID returned by timer_start(), thus it must be a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9848 Number. If {timer} does not exist there is no error.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9849
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9850 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9851 GetTimer()->timer_stop()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9852
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9853 < {only available when compiled with the \|+timers\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9854
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9855 timer_stopall() timer_stopall()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9856 Stop all timers. The timer callbacks will no longer be
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9857 invoked. Useful if a timer is misbehaving. If there are no
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9858 timers there is no error.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9859
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9860 {only available when compiled with the \|+timers\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9861
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9862 tolower({expr}) tolower()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9863 The result is a copy of the String given, with all uppercase
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9864 characters turned into lowercase (just like applying \|gu\| to
29193 1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9865 the string). Returns an empty string on error.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9866
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9867 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9868 GetText()->tolower()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9869
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9870 toupper({expr}) toupper()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9871 The result is a copy of the String given, with all lowercase
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9872 characters turned into uppercase (just like applying \|gU\| to
29193 1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9873 the string). Returns an empty string on error.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9874
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9875 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9876 GetText()->toupper()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9877
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9878 tr({src}, {fromstr}, {tostr}) tr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9879 The result is a copy of the {src} string with all characters
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9880 which appear in {fromstr} replaced by the character in that
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9881 position in the {tostr} string. Thus the first character in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9882 {fromstr} is translated into the first character in {tostr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9883 and so on. Exactly like the unix "tr" command.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9884 This code also deals with multibyte characters properly.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9885
29193 1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9886 Returns an empty string on error.
1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9887
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9888 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9889 echo tr("hello there", "ht", "HT")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9890 < returns "Hello THere" >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9891 echo tr("<blob>", "<>", "{}")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9892 < returns "{blob}"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9893
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9894 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9895 GetText()->tr(from, to)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9896
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9897 trim({text} [, {mask} [, {dir}]]) trim()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9898 Return {text} as a String where any character in {mask} is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9899 removed from the beginning and/or end of {text}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9900
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9901 If {mask} is not given, {mask} is all characters up to 0x20,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9902 which includes Tab, space, NL and CR, plus the non-breaking
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9903 space character 0xa0.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9904
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9905 The optional {dir} argument specifies where to remove the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9906 characters:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9907 0 remove from the beginning and end of {text}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9908 1 remove only at the beginning of {text}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9909 2 remove only at the end of {text}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9910 When omitted both ends are trimmed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9911
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9912 This function deals with multibyte characters properly.
29193 1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9913 Returns an empty string on error.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9914
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9915 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9916 echo trim(" some text ")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9917 < returns "some text" >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	9918 echo trim(" \r\t\t\r RESERVE \t\n\x0B\xA0") .. "_TAIL"
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9919 < returns "RESERVE_TAIL" >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9920 echo trim("rm<Xrm<>X>rrm", "rm<>")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9921 < returns "Xrm<>X" (characters in the middle are not removed) >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9922 echo trim(" vim ", " ", 2)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9923 < returns " vim"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9924
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9925 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9926 GetText()->trim()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9927
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9928 trunc({expr}) trunc()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9929 Return the largest integral value with magnitude less than or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9930 equal to {expr} as a \|Float\| (truncate towards zero).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9931 {expr} must evaluate to a \|Float\| or a \|Number\|.
29193 1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	9932 Returns 0.0 if {expr} is not a \|Float\| or a \|Number\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9933 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9934 echo trunc(1.456)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9935 < 1.0 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9936 echo trunc(-5.456)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9937 < -5.0 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9938 echo trunc(4.0)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9939 < 4.0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9940
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9941 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9942 Compute()->trunc()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9943 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9944 type()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9945 type({expr}) The result is a Number representing the type of {expr}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9946 Instead of using the number directly, it is better to use the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9947 v:t_ variable that has the value:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9948 Number: 0 \|v:t_number\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9949 String: 1 \|v:t_string\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9950 Funcref: 2 \|v:t_func\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9951 List: 3 \|v:t_list\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9952 Dictionary: 4 \|v:t_dict\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9953 Float: 5 \|v:t_float\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9954 Boolean: 6 \|v:t_bool\| (v:false and v:true)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9955 None: 7 \|v:t_none\| (v:null and v:none)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9956 Job: 8 \|v:t_job\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9957 Channel: 9 \|v:t_channel\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9958 Blob: 10 \|v:t_blob\|
31712 2d68375d5ddf patch 9.0.1188: return value of type() for class and object unclear Bram Moolenaar <Bram@vim.org> parents: 31579 diff changeset	9959 Class 12 \|v:t_class\|
2d68375d5ddf patch 9.0.1188: return value of type() for class and object unclear Bram Moolenaar <Bram@vim.org> parents: 31579 diff changeset	9960 Object 13 \|v:t_object\|
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9961 For backward compatibility, this method can be used: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9962 :if type(myvar) == type(0)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9963 :if type(myvar) == type("")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9964 :if type(myvar) == type(function("tr"))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9965 :if type(myvar) == type([])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9966 :if type(myvar) == type({})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9967 :if type(myvar) == type(0.0)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9968 :if type(myvar) == type(v:false)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9969 :if type(myvar) == type(v:none)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9970 < To check if the v:t_ variables exist use this: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9971 :if exists('v:t_number')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9972
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9973 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9974 mylist->type()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9975
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9976
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9977 typename({expr}) typename()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9978 Return a string representation of the type of {expr}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9979 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9980 echo typename([1, 2, 3])
31760 f348559ce426 patch 9.0.1212: cannot read back what setcellwidths() has done Bram Moolenaar <Bram@vim.org> parents: 31712 diff changeset	9981 < list<number> ~
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9982
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9983
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9984 undofile({name}) undofile()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9985 Return the name of the undo file that would be used for a file
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9986 with name {name} when writing. This uses the 'undodir'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9987 option, finding directories that exist. It does not check if
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9988 the undo file exists.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9989 {name} is always expanded to the full path, since that is what
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9990 is used internally.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9991 If {name} is empty undofile() returns an empty string, since a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9992 buffer without a file name will not write an undo file.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9993 Useful in combination with \|:wundo\| and \|:rundo\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9994 When compiled without the \|+persistent_undo\| option this always
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9995 returns an empty string.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9996
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9997 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9998 GetFilename()->undofile()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9999
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10000 undotree() undotree()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10001 Return the current state of the undo tree in a dictionary with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10002 the following items:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10003 "seq_last" The highest undo sequence number used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10004 "seq_cur" The sequence number of the current position in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10005 the undo tree. This differs from "seq_last"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10006 when some changes were undone.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10007 "time_cur" Time last used for \|:earlier\| and related
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10008 commands. Use \|strftime()\| to convert to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10009 something readable.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10010 "save_last" Number of the last file write. Zero when no
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10011 write yet.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10012 "save_cur" Number of the current position in the undo
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10013 tree.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10014 "synced" Non-zero when the last undo block was synced.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10015 This happens when waiting from input from the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10016 user. See \|undo-blocks\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10017 "entries" A list of dictionaries with information about
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10018 undo blocks.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10019
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10020 The first item in the "entries" list is the oldest undo item.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10021 Each List item is a \|Dictionary\| with these items:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10022 "seq" Undo sequence number. Same as what appears in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10023 \|:undolist\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10024 "time" Timestamp when the change happened. Use
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10025 \|strftime()\| to convert to something readable.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10026 "newhead" Only appears in the item that is the last one
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10027 that was added. This marks the last change
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10028 and where further changes will be added.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10029 "curhead" Only appears in the item that is the last one
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10030 that was undone. This marks the current
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10031 position in the undo tree, the block that will
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10032 be used by a redo command. When nothing was
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10033 undone after the last change this item will
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10034 not appear anywhere.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10035 "save" Only appears on the last block before a file
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10036 write. The number is the write count. The
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10037 first write has number 1, the last one the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10038 "save_last" mentioned above.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10039 "alt" Alternate entry. This is again a List of undo
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10040 blocks. Each item may again have an "alt"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10041 item.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10042
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10043 uniq({list} [, {func} [, {dict}]]) uniq() E882
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10044 Remove second and succeeding copies of repeated adjacent
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10045 {list} items in-place. Returns {list}. If you want a list
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10046 to remain unmodified make a copy first: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10047 :let newlist = uniq(copy(mylist))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10048 < The default compare function uses the string representation of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10049 each item. For the use of {func} and {dict} see \|sort()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10050
29193 1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	10051 Returns zero if {list} is not a \|List\|.
1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	10052
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10053 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10054 mylist->uniq()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10055
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10056 values({dict}) values()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10057 Return a \|List\| with all the values of {dict}. The \|List\| is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10058 in arbitrary order. Also see \|items()\| and \|keys()\|.
29193 1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	10059 Returns zero if {dict} is not a \|Dict\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10060
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10061 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10062 mydict->values()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10063
28994 644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	10064 virtcol({expr} [, {list}]) virtcol()
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10065 The result is a Number, which is the screen column of the file
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10066 position given with {expr}. That is, the last screen position
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10067 occupied by the character at that position, when the screen
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10068 would be of unlimited width. When there is a <Tab> at the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10069 position, the returned Number will be the column at the end of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10070 the <Tab>. For example, for a <Tab> in column 1, with 'ts'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10071 set to 8, it returns 8. \|conceal\| is ignored.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10072 For the byte position use \|col()\|.
28994 644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	10073
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10074 For the use of {expr} see \|col()\|.
28994 644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	10075
644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	10076 When 'virtualedit' is used {expr} can be [lnum, col, off],
644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	10077 where "off" is the offset in screen columns from the start of
644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	10078 the character. E.g., a position within a <Tab> or after the
644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	10079 last character. When "off" is omitted zero is used. When
644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	10080 Virtual editing is active in the current mode, a position
644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	10081 beyond the end of the line can be returned. Also see
644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	10082 \|'virtualedit'\|
644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	10083
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10084 The accepted positions are:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10085 . the cursor position
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10086 $ the end of the cursor line (the result is the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10087 number of displayed characters in the cursor line
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10088 plus one)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10089 'x position of mark x (if the mark is not set, 0 is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10090 returned)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10091 v In Visual mode: the start of the Visual area (the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10092 cursor is the end). When not in Visual mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10093 returns the cursor position. Differs from \|'<\| in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10094 that it's updated right away.
28994 644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	10095
644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	10096 If {list} is present and non-zero then virtcol() returns a List
644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	10097 with the first and last screen position occupied by the
644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	10098 character.
644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	10099
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10100 Note that only marks in the current file can be used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10101 Examples: >
28994 644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	10102 " With text "foo^Lbar" and cursor on the "^L":
644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	10103
644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	10104 virtcol(".") " returns 5
644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	10105 virtcol(".", 1) " returns [4, 5]
644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	10106 virtcol("$") " returns 9
644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	10107
644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	10108 " With text " there", with 't at 'h':
644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	10109
644b0f0541de patch 8.2.5019: cannot get the first screen column of a character Bram Moolenaar <Bram@vim.org> parents: 28978 diff changeset	10110 virtcol("'t") " returns 6
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10111 < The first column is 1. 0 is returned for an error.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10112 A more advanced example that echoes the maximum length of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10113 all lines: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10114 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])"))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10115
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10116 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10117 GetPos()->virtcol()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10118
29024 9f25e0ed831d patch 8.2.5034: there is no way to get the byte index from a virtual column Bram Moolenaar <Bram@vim.org> parents: 29016 diff changeset	10119 virtcol2col({winid}, {lnum}, {col}) virtcol2col()
9f25e0ed831d patch 8.2.5034: there is no way to get the byte index from a virtual column Bram Moolenaar <Bram@vim.org> parents: 29016 diff changeset	10120 The result is a Number, which is the byte index of the
9f25e0ed831d patch 8.2.5034: there is no way to get the byte index from a virtual column Bram Moolenaar <Bram@vim.org> parents: 29016 diff changeset	10121 character in window {winid} at buffer line {lnum} and virtual
9f25e0ed831d patch 8.2.5034: there is no way to get the byte index from a virtual column Bram Moolenaar <Bram@vim.org> parents: 29016 diff changeset	10122 column {col}.
9f25e0ed831d patch 8.2.5034: there is no way to get the byte index from a virtual column Bram Moolenaar <Bram@vim.org> parents: 29016 diff changeset	10123
9f25e0ed831d patch 8.2.5034: there is no way to get the byte index from a virtual column Bram Moolenaar <Bram@vim.org> parents: 29016 diff changeset	10124 If {col} is greater than the last virtual column in line
9f25e0ed831d patch 8.2.5034: there is no way to get the byte index from a virtual column Bram Moolenaar <Bram@vim.org> parents: 29016 diff changeset	10125 {lnum}, then the byte index of the character at the last
9f25e0ed831d patch 8.2.5034: there is no way to get the byte index from a virtual column Bram Moolenaar <Bram@vim.org> parents: 29016 diff changeset	10126 virtual column is returned.
9f25e0ed831d patch 8.2.5034: there is no way to get the byte index from a virtual column Bram Moolenaar <Bram@vim.org> parents: 29016 diff changeset	10127
9f25e0ed831d patch 8.2.5034: there is no way to get the byte index from a virtual column Bram Moolenaar <Bram@vim.org> parents: 29016 diff changeset	10128 The {winid} argument can be the window number or the
9f25e0ed831d patch 8.2.5034: there is no way to get the byte index from a virtual column Bram Moolenaar <Bram@vim.org> parents: 29016 diff changeset	10129 \|window-ID\|. If this is zero, then the current window is used.
9f25e0ed831d patch 8.2.5034: there is no way to get the byte index from a virtual column Bram Moolenaar <Bram@vim.org> parents: 29016 diff changeset	10130
9f25e0ed831d patch 8.2.5034: there is no way to get the byte index from a virtual column Bram Moolenaar <Bram@vim.org> parents: 29016 diff changeset	10131 Returns -1 if the window {winid} doesn't exist or the buffer
9f25e0ed831d patch 8.2.5034: there is no way to get the byte index from a virtual column Bram Moolenaar <Bram@vim.org> parents: 29016 diff changeset	10132 line {lnum} or virtual column {col} is invalid.
9f25e0ed831d patch 8.2.5034: there is no way to get the byte index from a virtual column Bram Moolenaar <Bram@vim.org> parents: 29016 diff changeset	10133
9f25e0ed831d patch 8.2.5034: there is no way to get the byte index from a virtual column Bram Moolenaar <Bram@vim.org> parents: 29016 diff changeset	10134 See also \|screenpos()\|, \|virtcol()\| and \|col()\|.
9f25e0ed831d patch 8.2.5034: there is no way to get the byte index from a virtual column Bram Moolenaar <Bram@vim.org> parents: 29016 diff changeset	10135
9f25e0ed831d patch 8.2.5034: there is no way to get the byte index from a virtual column Bram Moolenaar <Bram@vim.org> parents: 29016 diff changeset	10136 Can also be used as a \|method\|: >
9f25e0ed831d patch 8.2.5034: there is no way to get the byte index from a virtual column Bram Moolenaar <Bram@vim.org> parents: 29016 diff changeset	10137 GetWinid()->virtcol2col(lnum, col)
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10138
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10139 visualmode([{expr}]) visualmode()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10140 The result is a String, which describes the last Visual mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10141 used in the current buffer. Initially it returns an empty
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10142 string, but once Visual mode has been used, it returns "v",
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10143 "V", or "<CTRL-V>" (a single CTRL-V character) for
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10144 character-wise, line-wise, or block-wise Visual mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10145 respectively.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10146 Example: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	10147 :exe "normal " .. visualmode()
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10148 < This enters the same Visual mode as before. It is also useful
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10149 in scripts if you wish to act differently depending on the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10150 Visual mode that was used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10151 If Visual mode is active, use \|mode()\| to get the Visual mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10152 (e.g., in a \|:vmap\|).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10153 If {expr} is supplied and it evaluates to a non-zero Number or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10154 a non-empty String, then the Visual mode will be cleared and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10155 the old value is returned. See \|non-zero-arg\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10156
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10157 wildmenumode() wildmenumode()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10158 Returns \|TRUE\| when the wildmenu is active and \|FALSE\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10159 otherwise. See 'wildmenu' and 'wildmode'.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10160 This can be used in mappings to handle the 'wildcharm' option
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10161 gracefully. (Makes only sense with \|mapmode-c\| mappings).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10162
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10163 For example to make <c-j> work like <down> in wildmode, use: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10164 :cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10165 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10166 (Note, this needs the 'wildcharm' option set appropriately).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10167
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10168 win_execute({id}, {command} [, {silent}]) win_execute()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10169 Like `execute()` but in the context of window {id}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10170 The window will temporarily be made the current window,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10171 without triggering autocommands or changing directory. When
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10172 executing {command} autocommands will be triggered, this may
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10173 have unexpected side effects. Use \|:noautocmd\| if needed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10174 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10175 call win_execute(winid, 'set syntax=python')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10176 < Doing the same with `setwinvar()` would not trigger
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10177 autocommands and not actually show syntax highlighting.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10178 E994
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10179 Not all commands are allowed in popup windows.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10180 When window {id} does not exist then no error is given and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10181 an empty string is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10182
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10183 Can also be used as a \|method\|, the base is passed as the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10184 second argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10185 GetCommand()->win_execute(winid)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10186
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10187 win_findbuf({bufnr}) win_findbuf()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10188 Returns a \|List\| with \|window-ID\|s for windows that contain
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10189 buffer {bufnr}. When there is none the list is empty.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10190
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10191 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10192 GetBufnr()->win_findbuf()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10193
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10194 win_getid([{win} [, {tab}]]) win_getid()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10195 Get the \|window-ID\| for the specified window.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10196 When {win} is missing use the current window.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10197 With {win} this is the window number. The top window has
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10198 number 1.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10199 Without {tab} use the current tab, otherwise the tab with
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10200 number {tab}. The first tab has number one.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10201 Return zero if the window cannot be found.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10202
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10203 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10204 GetWinnr()->win_getid()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10205
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10206
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10207 win_gettype([{nr}]) win_gettype()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10208 Return the type of the window:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10209 "autocmd" autocommand window. Temporary window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10210 used to execute autocommands.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10211 "command" command-line window \|cmdwin\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10212 (empty) normal window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10213 "loclist" \|location-list-window\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10214 "popup" popup window \|popup\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10215 "preview" preview window \|preview-window\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10216 "quickfix" \|quickfix-window\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10217 "unknown" window {nr} not found
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10218
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10219 When {nr} is omitted return the type of the current window.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10220 When {nr} is given return the type of this window by number or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10221 \|window-ID\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10222
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10223 Also see the 'buftype' option. When running a terminal in a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10224 popup window then 'buftype' is "terminal" and win_gettype()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10225 returns "popup".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10226
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10227 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10228 GetWinid()->win_gettype()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10229 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10230 win_gotoid({expr}) win_gotoid()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10231 Go to window with ID {expr}. This may also change the current
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10232 tabpage.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10233 Return TRUE if successful, FALSE if the window cannot be found.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10234
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10235 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10236 GetWinid()->win_gotoid()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10237
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10238 win_id2tabwin({expr}) win_id2tabwin()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10239 Return a list with the tab number and window number of window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10240 with ID {expr}: [tabnr, winnr].
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10241 Return [0, 0] if the window cannot be found.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10242
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10243 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10244 GetWinid()->win_id2tabwin()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10245
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10246 win_id2win({expr}) win_id2win()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10247 Return the window number of window with ID {expr}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10248 Return 0 if the window cannot be found in the current tabpage.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10249
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10250 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10251 GetWinid()->win_id2win()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10252
27047 b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10253 win_move_separator({nr}, {offset}) win_move_separator()
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10254 Move window {nr}'s vertical separator (i.e., the right border)
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10255 by {offset} columns, as if being dragged by the mouse. {nr}
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10256 can be a window number or \|window-ID\|. A positive {offset}
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10257 moves right and a negative {offset} moves left. Moving a
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10258 window's vertical separator will change the width of the
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10259 window and the width of other windows adjacent to the vertical
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10260 separator. The magnitude of movement may be smaller than
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10261 specified (e.g., as a consequence of maintaining
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10262 'winminwidth'). Returns TRUE if the window can be found and
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10263 FALSE otherwise.
29193 1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	10264 This will fail for the rightmost window and a full-width
1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29121 diff changeset	10265 window, since it has no separator on the right.
31028 5acd6f02ea35 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31004 diff changeset	10266 Only works for the current tab page. E1308
27047 b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10267
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10268 Can also be used as a \|method\|: >
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10269 GetWinnr()->win_move_separator(offset)
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10270
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10271 win_move_statusline({nr}, {offset}) win_move_statusline()
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10272 Move window {nr}'s status line (i.e., the bottom border) by
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10273 {offset} rows, as if being dragged by the mouse. {nr} can be a
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10274 window number or \|window-ID\|. A positive {offset} moves down
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10275 and a negative {offset} moves up. Moving a window's status
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10276 line will change the height of the window and the height of
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10277 other windows adjacent to the status line. The magnitude of
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10278 movement may be smaller than specified (e.g., as a consequence
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10279 of maintaining 'winminheight'). Returns TRUE if the window can
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10280 be found and FALSE otherwise.
31028 5acd6f02ea35 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 31004 diff changeset	10281 Only works for the current tab page.
27047 b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10282
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10283 Can also be used as a \|method\|: >
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10284 GetWinnr()->win_move_statusline(offset)
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	10285
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10286 win_screenpos({nr}) win_screenpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10287 Return the screen position of window {nr} as a list with two
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10288 numbers: [row, col]. The first window always has position
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10289 [1, 1], unless there is a tabline, then it is [2, 1].
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10290 {nr} can be the window number or the \|window-ID\|. Use zero
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10291 for the current window.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10292 Returns [0, 0] if the window cannot be found in the current
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10293 tabpage.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10294
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10295 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10296 GetWinid()->win_screenpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10297 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10298 win_splitmove({nr}, {target} [, {options}]) win_splitmove()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10299 Move the window {nr} to a new split of the window {target}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10300 This is similar to moving to {target}, creating a new window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10301 using \|:split\| but having the same contents as window {nr}, and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10302 then closing {nr}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10303
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10304 Both {nr} and {target} can be window numbers or \|window-ID\|s.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10305 Both must be in the current tab page.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10306
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10307 Returns zero for success, non-zero for failure.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10308
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10309 {options} is a \|Dictionary\| with the following optional entries:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10310 "vertical" When TRUE, the split is created vertically,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10311 like with \|:vsplit\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10312 "rightbelow" When TRUE, the split is made below or to the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10313 right (if vertical). When FALSE, it is done
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10314 above or to the left (if vertical). When not
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10315 present, the values of 'splitbelow' and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10316 'splitright' are used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10317
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10318 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10319 GetWinid()->win_splitmove(target)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10320 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10321
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10322 winbufnr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10323 winbufnr({nr}) The result is a Number, which is the number of the buffer
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10324 associated with window {nr}. {nr} can be the window number or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10325 the \|window-ID\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10326 When {nr} is zero, the number of the buffer in the current
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10327 window is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10328 When window {nr} doesn't exist, -1 is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10329 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10330 :echo "The file in the current window is " . bufname(winbufnr(0))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10331 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10332 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10333 FindWindow()->winbufnr()->bufname()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10334 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10335 wincol()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10336 wincol() The result is a Number, which is the virtual column of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10337 cursor in the window. This is counting screen cells from the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10338 left side of the window. The leftmost column is one.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10339
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10340 windowsversion()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10341 windowsversion()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10342 The result is a String. For MS-Windows it indicates the OS
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10343 version. E.g, Windows 10 is "10.0", Windows 8 is "6.2",
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10344 Windows XP is "5.1". For non-MS-Windows systems the result is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10345 an empty string.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10346
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10347 winheight({nr}) winheight()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10348 The result is a Number, which is the height of window {nr}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10349 {nr} can be the window number or the \|window-ID\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10350 When {nr} is zero, the height of the current window is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10351 returned. When window {nr} doesn't exist, -1 is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10352 An existing window always has a height of zero or more.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10353 This excludes any window toolbar line.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10354 Examples: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	10355 :echo "The current window has " .. winheight(0) .. " lines."
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10356
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10357 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10358 GetWinid()->winheight()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10359 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10360 winlayout([{tabnr}]) winlayout()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10361 The result is a nested List containing the layout of windows
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10362 in a tabpage.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10363
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10364 Without {tabnr} use the current tabpage, otherwise the tabpage
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10365 with number {tabnr}. If the tabpage {tabnr} is not found,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10366 returns an empty list.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10367
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10368 For a leaf window, it returns:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10369 ['leaf', {winid}]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10370 For horizontally split windows, which form a column, it
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10371 returns:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10372 ['col', [{nested list of windows}]]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10373 For vertically split windows, which form a row, it returns:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10374 ['row', [{nested list of windows}]]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10375
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10376 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10377 " Only one window in the tab page
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10378 :echo winlayout()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10379 ['leaf', 1000]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10380 " Two horizontally split windows
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10381 :echo winlayout()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10382 ['col', [['leaf', 1000], ['leaf', 1001]]]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10383 " The second tab page, with three horizontally split
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10384 " windows, with two vertically split windows in the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10385 " middle window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10386 :echo winlayout(2)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10387 ['col', [['leaf', 1002], ['row', [['leaf', 1003],
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10388 ['leaf', 1001]]], ['leaf', 1000]]]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10389 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10390 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10391 GetTabnr()->winlayout()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10392 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10393 winline()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10394 winline() The result is a Number, which is the screen line of the cursor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10395 in the window. This is counting screen lines from the top of
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10396 the window. The first line is one.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10397 If the cursor was moved the view on the file will be updated
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10398 first, this may cause a scroll.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10399
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10400 winnr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10401 winnr([{arg}]) The result is a Number, which is the number of the current
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10402 window. The top window has number 1.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10403 Returns zero for a popup window.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10404
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10405 The optional argument {arg} supports the following values:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10406 $ the number of the last window (the window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10407 count).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10408 # the number of the last accessed window (where
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10409 \|CTRL-W_p\| goes to). If there is no previous
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10410 window or it is in another tab page 0 is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10411 returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10412 {N}j the number of the Nth window below the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10413 current window (where \|CTRL-W_j\| goes to).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10414 {N}k the number of the Nth window above the current
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10415 window (where \|CTRL-W_k\| goes to).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10416 {N}h the number of the Nth window left of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10417 current window (where \|CTRL-W_h\| goes to).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10418 {N}l the number of the Nth window right of the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10419 current window (where \|CTRL-W_l\| goes to).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10420 The number can be used with \|CTRL-W_w\| and ":wincmd w"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10421 \|:wincmd\|.
29087 f3ec3c57e070 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	10422 When {arg} is invalid an error is given and zero is returned.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10423 Also see \|tabpagewinnr()\| and \|win_getid()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10424 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10425 let window_count = winnr('$')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10426 let prev_window = winnr('#')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10427 let wnum = winnr('3k')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10428
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10429 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10430 GetWinval()->winnr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10431 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10432 winrestcmd()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10433 winrestcmd() Returns a sequence of \|:resize\| commands that should restore
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10434 the current window sizes. Only works properly when no windows
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10435 are opened or closed and the current window and tab page is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10436 unchanged.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10437 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10438 :let cmd = winrestcmd()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10439 :call MessWithWindowSizes()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10440 :exe cmd
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10441 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10442 winrestview()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10443 winrestview({dict})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10444 Uses the \|Dictionary\| returned by \|winsaveview()\| to restore
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10445 the view of the current window.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10446 Note: The {dict} does not have to contain all values, that are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10447 returned by \|winsaveview()\|. If values are missing, those
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10448 settings won't be restored. So you can use: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10449 :call winrestview({'curswant': 4})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10450 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10451 This will only set the curswant value (the column the cursor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10452 wants to move on vertical movements) of the cursor to column 5
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10453 (yes, that is 5), while all other settings will remain the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10454 same. This is useful, if you set the cursor position manually.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10455
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10456 If you have changed the values the result is unpredictable.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10457 If the window size changed the result won't be the same.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10458
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10459 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10460 GetView()->winrestview()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10461 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10462 winsaveview()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10463 winsaveview() Returns a \|Dictionary\| that contains information to restore
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10464 the view of the current window. Use \|winrestview()\| to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10465 restore the view.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10466 This is useful if you have a mapping that jumps around in the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10467 buffer and you want to go back to the original view.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10468 This does not save fold information. Use the 'foldenable'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10469 option to temporarily switch off folding, so that folds are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10470 not opened when moving around. This may have side effects.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10471 The return value includes:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10472 lnum cursor line number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10473 col cursor column (Note: the first column
26881 fb67cd7d30a7 patch 8.2.3969: value of MAXCOL not available in Vim script Bram Moolenaar <Bram@vim.org> parents: 26847 diff changeset	10474 zero, as opposed to what \|getcurpos()\|
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10475 returns)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10476 coladd cursor column offset for 'virtualedit'
26881 fb67cd7d30a7 patch 8.2.3969: value of MAXCOL not available in Vim script Bram Moolenaar <Bram@vim.org> parents: 26847 diff changeset	10477 curswant column for vertical movement (Note:
fb67cd7d30a7 patch 8.2.3969: value of MAXCOL not available in Vim script Bram Moolenaar <Bram@vim.org> parents: 26847 diff changeset	10478 the first column is zero, as opposed
fb67cd7d30a7 patch 8.2.3969: value of MAXCOL not available in Vim script Bram Moolenaar <Bram@vim.org> parents: 26847 diff changeset	10479 to what \|getcurpos()\| returns). After
fb67cd7d30a7 patch 8.2.3969: value of MAXCOL not available in Vim script Bram Moolenaar <Bram@vim.org> parents: 26847 diff changeset	10480 \|$\| command it will be a very large
fb67cd7d30a7 patch 8.2.3969: value of MAXCOL not available in Vim script Bram Moolenaar <Bram@vim.org> parents: 26847 diff changeset	10481 number equal to \|v:maxcol\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10482 topline first line in the window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10483 topfill filler lines, only in diff mode
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10484 leftcol first column displayed; only used when
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10485 'wrap' is off
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10486 skipcol columns skipped
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10487 Note that no option values are saved.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10488
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10489
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10490 winwidth({nr}) winwidth()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10491 The result is a Number, which is the width of window {nr}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10492 {nr} can be the window number or the \|window-ID\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10493 When {nr} is zero, the width of the current window is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10494 returned. When window {nr} doesn't exist, -1 is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10495 An existing window always has a width of zero or more.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10496 Examples: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	10497 :echo "The current window has " .. winwidth(0) .. " columns."
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10498 :if winwidth(0) <= 50
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10499 : 50 wincmd \|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10500 :endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10501 < For getting the terminal or screen size, see the 'columns'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10502 option.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10503
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10504 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10505 GetWinid()->winwidth()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10506
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10507
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10508 wordcount() wordcount()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10509 The result is a dictionary of byte/chars/word statistics for
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10510 the current buffer. This is the same info as provided by
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10511 \|g_CTRL-G\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10512 The return value includes:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10513 bytes Number of bytes in the buffer
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10514 chars Number of chars in the buffer
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10515 words Number of words in the buffer
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10516 cursor_bytes Number of bytes before cursor position
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10517 (not in Visual mode)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10518 cursor_chars Number of chars before cursor position
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10519 (not in Visual mode)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10520 cursor_words Number of words before cursor position
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10521 (not in Visual mode)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10522 visual_bytes Number of bytes visually selected
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10523 (only in Visual mode)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10524 visual_chars Number of chars visually selected
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10525 (only in Visual mode)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10526 visual_words Number of words visually selected
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10527 (only in Visual mode)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10528
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10529
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10530 writefile()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10531 writefile({object}, {fname} [, {flags}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10532 When {object} is a \|List\| write it to file {fname}. Each list
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10533 item is separated with a NL. Each list item must be a String
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10534 or Number.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10535 All NL characters are replaced with a NUL character.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10536 Inserting CR characters needs to be done before passing {list}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10537 to writefile().
30083 a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10538
a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10539 When {object} is a \|Blob\| write the bytes to file {fname}
a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10540 unmodified, also when binary mode is not specified.
a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10541
a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10542 {flags} must be a String. These characters are recognized:
a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10543
a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10544 'b' Binary mode is used: There will not be a NL after the
a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10545 last list item. An empty item at the end does cause the
a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10546 last line in the file to end in a NL.
a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10547
a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10548 'a' Append mode is used, lines are appended to the file: >
a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10549 :call writefile(["foo"], "event.log", "a")
a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10550 :call writefile(["bar"], "event.log", "a")
a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10551 <
a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10552 'D' Delete the file when the current function ends. This
a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10553 works like: >
a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10554 :defer delete({fname})
a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10555 < Fails when not in a function. Also see \|:defer\|.
a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10556
a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10557 's' fsync() is called after writing the file. This flushes
a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10558 the file to disk, if possible. This takes more time but
a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10559 avoids losing the file if the system crashes.
a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10560
a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10561 'S' fsync() is not called, even when 'fsync' is set.
a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10562
a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10563 When {flags} does not contain "S" or "s" then fsync() is
a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10564 called if the 'fsync' option is set.
a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10565
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10566 An existing file is overwritten, if possible.
30083 a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10567
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10568 When the write fails -1 is returned, otherwise 0. There is an
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10569 error message if the file can't be created or when writing
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10570 fails.
30083 a542dfb1c1a2 patch 9.0.0379: cleaning up after writefile() is a hassle Bram Moolenaar <Bram@vim.org> parents: 29930 diff changeset	10571
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10572 Also see \|readfile()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10573 To copy a file byte for byte: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10574 :let fl = readfile("foo", "b")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10575 :call writefile(fl, "foocopy", "b")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10576
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10577 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10578 GetText()->writefile("thefile")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10579
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10580
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10581 xor({expr}, {expr}) xor()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10582 Bitwise XOR on the two arguments. The arguments are converted
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10583 to a number. A List, Dict or Float argument causes an error.
29024 9f25e0ed831d patch 8.2.5034: there is no way to get the byte index from a virtual column Bram Moolenaar <Bram@vim.org> parents: 29016 diff changeset	10584 Also see `and()` and `or()`.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10585 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10586 :let bits = xor(bits, 0x80)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10587 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10588 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10589 :let bits = bits->xor(0x80)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10590 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10591
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10592 ==============================================================================
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10593 3. Feature list feature-list
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10594
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10595 There are three types of features:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10596 1. Features that are only supported when they have been enabled when Vim
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10597 was compiled \|+feature-list\|. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10598 :if has("cindent")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10599 < gui_running
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10600 2. Features that are only supported when certain conditions have been met.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10601 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10602 :if has("gui_running")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10603 < has-patch
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10604 3. Beyond a certain version or at a certain version and including a specific
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10605 patch. The "patch-7.4.248" feature means that the Vim version is 7.5 or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10606 later, or it is version 7.4 and patch 248 was included. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10607 :if has("patch-7.4.248")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10608 < Note that it's possible for patch 248 to be omitted even though 249 is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10609 included. Only happens when cherry-picking patches.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10610 Note that this form only works for patch 7.4.237 and later, before that
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10611 you need to check for the patch and the v:version. Example (checking
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10612 version 6.2.148 or later): >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10613 :if v:version > 602 \|\| (v:version == 602 && has("patch148"))
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10614
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10615 Hint: To find out if Vim supports backslashes in a file name (MS-Windows),
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10616 use: `if exists('+shellslash')`
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10617
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10618
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10619 acl Compiled with \|ACL\| support.
29883 1342ee83ab97 patch 9.0.0280: the builtin termcap list depends on the version Bram Moolenaar <Bram@vim.org> parents: 29861 diff changeset	10620 all_builtin_terms Compiled with all builtin terminals enabled. (always
1342ee83ab97 patch 9.0.0280: the builtin termcap list depends on the version Bram Moolenaar <Bram@vim.org> parents: 29861 diff changeset	10621 true)
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10622 amiga Amiga version of Vim.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10623 arabic Compiled with Arabic support \|Arabic\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10624 arp Compiled with ARP support (Amiga).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10625 autocmd Compiled with autocommand support. (always true)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10626 autochdir Compiled with support for 'autochdir'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10627 autoservername Automatically enable \|clientserver\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10628 balloon_eval Compiled with \|balloon-eval\| support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10629 balloon_multiline GUI supports multiline balloons.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10630 beos BeOS version of Vim.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10631 browse Compiled with \|:browse\| support, and browse() will
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10632 work.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10633 browsefilter Compiled with support for \|browsefilter\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10634 bsd Compiled on an OS in the BSD family (excluding macOS).
29883 1342ee83ab97 patch 9.0.0280: the builtin termcap list depends on the version Bram Moolenaar <Bram@vim.org> parents: 29861 diff changeset	10635 builtin_terms Compiled with some builtin terminals. (always true)
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10636 byte_offset Compiled with support for 'o' in 'statusline'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10637 channel Compiled with support for \|channel\| and \|job\|
29285 729a7c00fabc Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29236 diff changeset	10638 cindent Compiled with 'cindent' support. (always true)
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10639 clientserver Compiled with remote invocation support \|clientserver\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10640 clipboard Compiled with 'clipboard' support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10641 clipboard_working Compiled with 'clipboard' support and it can be used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10642 cmdline_compl Compiled with \|cmdline-completion\| support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10643 cmdline_hist Compiled with \|cmdline-history\| support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10644 cmdline_info Compiled with 'showcmd' and 'ruler' support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10645 comments Compiled with \|'comments'\| support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10646 compatible Compiled to be very Vi compatible.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10647 conpty Platform where \|ConPTY\| can be used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10648 cryptv Compiled with encryption support \|encryption\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10649 cscope Compiled with \|cscope\| support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10650 cursorbind Compiled with \|'cursorbind'\| (always true)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10651 debug Compiled with "DEBUG" defined.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10652 dialog_con Compiled with console dialog support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10653 dialog_gui Compiled with GUI dialog support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10654 diff Compiled with \|vimdiff\| and 'diff' support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10655 digraphs Compiled with support for digraphs.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10656 directx Compiled with support for DirectX and 'renderoptions'.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10657 dnd Compiled with support for the "~ register \|quote_~\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10658 drop_file Compiled with \|drop_file\| support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10659 ebcdic Compiled on a machine with ebcdic character set.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10660 emacs_tags Compiled with support for Emacs tags.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10661 eval Compiled with expression evaluation support. Always
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10662 true, of course!
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10663 ex_extra \|+ex_extra\| (always true)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10664 extra_search Compiled with support for \|'incsearch'\| and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10665 \|'hlsearch'\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10666 farsi Support for Farsi was removed \|farsi\|.
29853 31c598083364 patch 9.0.0265: no good reason why the "gf" command isn't in the tiny version Bram Moolenaar <Bram@vim.org> parents: 29845 diff changeset	10667 file_in_path Compiled with support for \|gf\| and \|<cfile>\| (always
31c598083364 patch 9.0.0265: no good reason why the "gf" command isn't in the tiny version Bram Moolenaar <Bram@vim.org> parents: 29845 diff changeset	10668 true)
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10669 filterpipe When 'shelltemp' is off pipes are used for shell
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10670 read/write/filter commands
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10671 find_in_path Compiled with support for include file searches
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10672 \|+find_in_path\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10673 float Compiled with support for \|Float\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10674 fname_case Case in file names matters (for Amiga and MS-Windows
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10675 this is not present).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10676 folding Compiled with \|folding\| support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10677 footer Compiled with GUI footer support. \|gui-footer\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10678 fork Compiled to use fork()/exec() instead of system().
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10679 gettext Compiled with message translation \|multi-lang\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10680 gui Compiled with GUI enabled.
28379 6dd88e45d47d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28307 diff changeset	10681 gui_athena Compiled with Athena GUI (always false).
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10682 gui_gnome Compiled with Gnome support (gui_gtk is also defined).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10683 gui_gtk Compiled with GTK+ GUI (any version).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10684 gui_gtk2 Compiled with GTK+ 2 GUI (gui_gtk is also defined).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10685 gui_gtk3 Compiled with GTK+ 3 GUI (gui_gtk is also defined).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10686 gui_haiku Compiled with Haiku GUI.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10687 gui_mac Compiled with Macintosh GUI.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10688 gui_motif Compiled with Motif GUI.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10689 gui_photon Compiled with Photon GUI.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10690 gui_running Vim is running in the GUI, or it will start soon.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10691 gui_win32 Compiled with MS-Windows Win32 GUI.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10692 gui_win32s idem, and Win32s system being used (Windows 3.1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10693 haiku Haiku version of Vim.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10694 hangul_input Compiled with Hangul input support. \|hangul\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10695 hpux HP-UX version of Vim.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10696 iconv Can use iconv() for conversion.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10697 insert_expand Compiled with support for CTRL-X expansion commands in
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10698 Insert mode. (always true)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10699 job Compiled with support for \|channel\| and \|job\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10700 ipv6 Compiled with support for IPv6 networking in \|channel\|.
29285 729a7c00fabc Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29236 diff changeset	10701 jumplist Compiled with \|jumplist\| support. (always true)
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10702 keymap Compiled with 'keymap' support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10703 lambda Compiled with \|lambda\| support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10704 langmap Compiled with 'langmap' support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10705 libcall Compiled with \|libcall()\| support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10706 linebreak Compiled with 'linebreak', 'breakat', 'showbreak' and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10707 'breakindent' support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10708 linux Linux version of Vim.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10709 lispindent Compiled with support for lisp indenting.
29285 729a7c00fabc Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29236 diff changeset	10710 (always true)
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10711 listcmds Compiled with commands for the buffer list \|:files\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10712 and the argument list \|arglist\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10713 localmap Compiled with local mappings and abbr. \|:map-local\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10714 lua Compiled with Lua interface \|Lua\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10715 mac Any Macintosh version of Vim cf. osx
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10716 macunix Synonym for osxdarwin
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10717 menu Compiled with support for \|:menu\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10718 mksession Compiled with support for \|:mksession\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10719 modify_fname Compiled with file name modifiers. \|filename-modifiers\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10720 (always true)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10721 mouse Compiled with support for mouse.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10722 mouse_dec Compiled with support for Dec terminal mouse.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10723 mouse_gpm Compiled with support for gpm (Linux console mouse)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10724 mouse_gpm_enabled GPM mouse is working
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10725 mouse_netterm Compiled with support for netterm mouse.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10726 mouse_pterm Compiled with support for qnx pterm mouse.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10727 mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10728 mouse_sgr Compiled with support for sgr mouse.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10729 mouse_urxvt Compiled with support for urxvt mouse.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10730 mouse_xterm Compiled with support for xterm mouse.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10731 mouseshape Compiled with support for 'mouseshape'.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10732 multi_byte Compiled with support for 'encoding' (always true)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10733 multi_byte_encoding 'encoding' is set to a multibyte encoding.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10734 multi_byte_ime Compiled with support for IME input method.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10735 multi_lang Compiled with support for multiple languages.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10736 mzscheme Compiled with MzScheme interface \|mzscheme\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10737 nanotime Compiled with sub-second time stamp checks.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10738 netbeans_enabled Compiled with support for \|netbeans\| and connected.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10739 netbeans_intg Compiled with support for \|netbeans\|.
29285 729a7c00fabc Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29236 diff changeset	10740 num64 Compiled with 64-bit \|Number\| support. (always true)
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10741 ole Compiled with OLE automation support for Win32.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10742 osx Compiled for macOS cf. mac
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10743 osxdarwin Compiled for macOS, with \|mac-darwin-feature\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10744 packages Compiled with \|packages\| support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10745 path_extra Compiled with up/downwards search in 'path' and 'tags'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10746 perl Compiled with Perl interface.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10747 persistent_undo Compiled with support for persistent undo history.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10748 postscript Compiled with PostScript file printing.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10749 printer Compiled with \|:hardcopy\| support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10750 profile Compiled with \|:profile\| support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10751 python Python 2.x interface available. \|has-python\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10752 python_compiled Compiled with Python 2.x interface. \|has-python\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10753 python_dynamic Python 2.x interface is dynamically loaded. \|has-python\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10754 python3 Python 3.x interface available. \|has-python\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10755 python3_compiled Compiled with Python 3.x interface. \|has-python\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10756 python3_dynamic Python 3.x interface is dynamically loaded. \|has-python\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10757 pythonx Python 2.x and/or 3.x interface available. \|python_x\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10758 qnx QNX version of Vim.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10759 quickfix Compiled with \|quickfix\| support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10760 reltime Compiled with \|reltime()\| support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10761 rightleft Compiled with 'rightleft' support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10762 ruby Compiled with Ruby interface \|ruby\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10763 scrollbind Compiled with 'scrollbind' support. (always true)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10764 showcmd Compiled with 'showcmd' support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10765 signs Compiled with \|:sign\| support.
29285 729a7c00fabc Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29236 diff changeset	10766 smartindent Compiled with 'smartindent' support. (always true)
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10767 sodium Compiled with libsodium for better crypt support
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10768 sound Compiled with sound support, e.g. `sound_playevent()`
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10769 spell Compiled with spell checking support \|spell\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10770 startuptime Compiled with \|--startuptime\| support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10771 statusline Compiled with support for 'statusline', 'rulerformat'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10772 and special formats of 'titlestring' and 'iconstring'.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10773 sun SunOS version of Vim.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10774 sun_workshop Support for Sun \|workshop\| has been removed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10775 syntax Compiled with syntax highlighting support \|syntax\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10776 syntax_items There are active syntax highlighting items for the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10777 current buffer.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10778 system Compiled to use system() instead of fork()/exec().
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10779 tag_binary Compiled with binary searching in tags files
29285 729a7c00fabc Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29236 diff changeset	10780 \|tag-binary-search\|. (always true)
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10781 tag_old_static Support for old static tags was removed, see
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10782 \|tag-old-static\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10783 tcl Compiled with Tcl interface.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10784 termguicolors Compiled with true color in terminal support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10785 terminal Compiled with \|terminal\| support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10786 terminfo Compiled with terminfo instead of termcap.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10787 termresponse Compiled with support for \|t_RV\| and \|v:termresponse\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10788 textobjects Compiled with support for \|text-objects\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10789 textprop Compiled with support for \|text-properties\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10790 tgetent Compiled with tgetent support, able to use a termcap
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10791 or terminfo file.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10792 timers Compiled with \|timer_start()\| support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10793 title Compiled with window title support \|'title'\|.
29285 729a7c00fabc Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29236 diff changeset	10794 (always true)
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10795 toolbar Compiled with support for \|gui-toolbar\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10796 ttyin input is a terminal (tty)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10797 ttyout output is a terminal (tty)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10798 unix Unix version of Vim. +unix
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10799 unnamedplus Compiled with support for "unnamedplus" in 'clipboard'
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10800 user_commands User-defined commands. (always true)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10801 vartabs Compiled with variable tabstop support \|'vartabstop'\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10802 vcon Win32: Virtual console support is working, can use
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10803 'termguicolors'. Also see \|+vtp\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10804 vertsplit Compiled with vertically split windows \|:vsplit\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10805 (always true)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10806 vim_starting True while initial source'ing takes place. \|startup\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10807 vim_starting
26901 9805a7617981 patch 8.2.3979: Vim9: the feature is not mentioned in the right places Bram Moolenaar <Bram@vim.org> parents: 26881 diff changeset	10808 vim9script Compiled with \|Vim9\| script support
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10809 viminfo Compiled with viminfo support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10810 vimscript-1 Compiled Vim script version 1 support
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10811 vimscript-2 Compiled Vim script version 2 support
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10812 vimscript-3 Compiled Vim script version 3 support
29290 dc4de65a7fb7 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29285 diff changeset	10813 vimscript-4 Compiled Vim script version 4 support
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10814 virtualedit Compiled with 'virtualedit' option. (always true)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10815 visual Compiled with Visual mode. (always true)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10816 visualextra Compiled with extra Visual mode commands. (always
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10817 true) \|blockwise-operators\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10818 vms VMS version of Vim.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10819 vreplace Compiled with \|gR\| and \|gr\| commands. (always true)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10820 vtp Compiled for vcon support \|+vtp\| (check vcon to find
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10821 out if it works in the current console).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10822 wildignore Compiled with 'wildignore' option.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10823 wildmenu Compiled with 'wildmenu' option.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10824 win16 old version for MS-Windows 3.1 (always false)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10825 win32 Win32 version of Vim (MS-Windows 95 and later, 32 or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10826 64 bits)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10827 win32unix Win32 version of Vim, using Unix files (Cygwin)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10828 win64 Win64 version of Vim (MS-Windows 64 bit).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10829 win95 Win32 version for MS-Windows 95/98/ME (always false)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10830 winaltkeys Compiled with 'winaltkeys' option.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10831 windows Compiled with support for more than one window.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10832 (always true)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10833 writebackup Compiled with 'writebackup' default on.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10834 xfontset Compiled with X fontset support \|xfontset\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10835 xim Compiled with X input method support \|xim\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10836 xpm Compiled with pixmap support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10837 xpm_w32 Compiled with pixmap support for Win32. (Only for
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10838 backward compatibility. Use "xpm" instead.)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10839 xsmp Compiled with X session management support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10840 xsmp_interact Compiled with interactive X session management support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10841 xterm_clipboard Compiled with support for xterm clipboard.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10842 xterm_save Compiled with support for saving and restoring the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10843 xterm screen.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10844 x11 Compiled with X11 support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10845
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10846
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10847 ==============================================================================
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10848 4. Matching a pattern in a String string-match
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10849
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10850 This is common between several functions. A regexp pattern as explained at
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10851 \|pattern\| is normally used to find a match in the buffer lines. When a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10852 pattern is used to find a match in a String, almost everything works in the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10853 same way. The difference is that a String is handled like it is one line.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10854 When it contains a "\n" character, this is not seen as a line break for the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10855 pattern. It can be matched with a "\n" in the pattern, or with ".". Example:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10856 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10857 :let a = "aaaa\nxxxx"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10858 :echo matchstr(a, "..\n..")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10859 aa
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10860 xx
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10861 :echo matchstr(a, "a.x")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10862 a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10863 x
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10864
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10865 Don't forget that "^" will only match at the first character of the String and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10866 "$" at the last character of the string. They don't match after or before a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10867 "\n".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10868
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10869 vim:tw=78:ts=8:noet:ft=help:norl:

Mercurial > vim

annotate runtime/doc/builtin.txt @ 31811:c5ff7d053fa1 v9.0.1238