vim: runtime/doc/builtin.txt annotate

annotate runtime/doc/builtin.txt @ 28956:3e6e6b4e74eb v8.2.5000

patch 8.2.5000: no patch for documentation updates Commit: https://github.com/vim/vim/commit/835ee980eedd1aa0fa2d731312ce38697a12a897 Author: Bram Moolenaar <Bram@vim.org> Date: Sun May 22 14:50:16 2022 +0100 patch 8.2.5000: no patch for documentation updates Problem: No patch for documentation updates. Solution: Update documentation files.

author	Bram Moolenaar <Bram@vim.org>
date	Sun, 22 May 2022 16:00:02 +0200
parents	6cdf55afaae9
children	3c3bdb8069f5

rev	line source
28956 3e6e6b4e74eb patch 8.2.5000: no patch for documentation updates Bram Moolenaar <Bram@vim.org> parents: 28942 diff changeset	1 builtin.txt For Vim version 8.2. Last change: 2022 May 21
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
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9 Note: Expression evaluation can be disabled at compile time. If this has been
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10 done, the builtin functions are not available. See \|+eval\| and
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	11 \|no-eval-feature\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	12
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	13 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	14 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	15 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	16 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	17
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 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	20
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	21 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	22
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	23 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	24
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	25 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	26 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	27 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	28 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	29 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	30 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	31 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	32 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	33 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	34 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	35 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	36 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	37 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	38 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	39 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	40 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	41 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	42 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	43 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	44 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	45 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	46 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	47 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	48 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	49 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	50 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	51 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	52 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	53 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	54 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	55 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	56 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	57 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	58 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	59 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	60 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	61 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	62 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	63 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	64 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	65 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	66 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	67 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	68 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	69 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	70 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	71 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	72 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	73 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	74 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	75 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	76 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	77 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	78 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	79 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	80 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	81 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	82 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	83 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	84 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	85 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	86 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	87 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	88 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	89 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	90 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	91 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	92 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	93 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	94 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	95 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	96 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	97 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	98 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	99 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	100 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	101 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	102 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	103 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	104 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	105 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	106 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	107 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	108 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	109 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	110 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	111 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	112 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	113 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	114 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	115 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	116 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	117 charclass({string}) Number character class of {string}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	118 charcol({expr}) Number column number of cursor or mark
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	119 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	120 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	121 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	122 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	123 clearmatches([{win}]) none clear all matches
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	124 col({expr}) Number column byte index of cursor or mark
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	125 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	126 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	127 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	128 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	129 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	130 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	131 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	132 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	133 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	134 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	135 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	136 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	137 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	138 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	139 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	140 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	141 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	142 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	143 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	144 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	145 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	146 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	147 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	148 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	149 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	150 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	151 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	152 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	153 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	154 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	155 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	156 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	157 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	158 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	159 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	160 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	161 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	162 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	163 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	164 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	165 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	166 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	167 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	168 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	169 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	170 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	171 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	172 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	173 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	174 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	175 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	176 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	177 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	178 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	179 {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	180 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	181 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	182 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	183 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	184 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	185 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	186 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	187 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	188 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	189 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	190 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	191 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	192 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	193 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	194 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	195 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	196 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	197 foreground() Number bring the Vim window 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	198 fullcommand({name}) String get full command from {name}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	199 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	200 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	201 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	202 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	203 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	204 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	205 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	206 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	207 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	208 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	209 List lines {lnum} to {end} 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	210 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	211 any variable {varname} 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	212 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	213 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	214 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	215 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	216 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	217 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	218 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	219 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	220 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	221 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	222 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	223 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	224 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	225 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	226 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	227 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	228 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	229 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	230 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	231 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	232 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	233 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	234 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	235 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	236 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	237 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	238 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	239 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	240 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	241 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	242 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	243 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	244 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	245 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	246 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	247 getmousepos() Dict last known mouse position
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	248 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	249 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	250 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	251 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	252 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	253 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	254 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	255 getregtype([{regname}]) String type 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	256 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	257 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	258 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	259 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	260 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	261 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	262 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	263 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	264 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	265 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	266 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	267 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	268 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	269 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	270 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	271 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	272 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	273 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	274 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	275 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	276 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	277 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	278 or \|:tcd\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	279 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	280 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	281 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	282 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	283 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	284 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	285 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	286 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	287 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	288 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	289 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	290 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	291 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	292 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	293 Number index in {object} where {expr} appears
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	294 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	295 String get input 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	296 inputdialog({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	297 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	298 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	299 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	300 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	301 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	302 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	303 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	304 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	305 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	306 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	307 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	308 (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	309 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	310 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	311 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	312 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	313 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	314 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	315 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	316 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	317 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	318 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	319 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	320 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	321 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	322 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	323 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	324 keys({dict}) List keys in {dict}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	325 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	326 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	327 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	328 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	329 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	330 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	331 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	332 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	333 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	334 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	335 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	336 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	337 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	338 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	339 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	340 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	341 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	342 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	343 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	344 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	345 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	346 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	347 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	348 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	349 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	350 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	351 Dictionary
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	352 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	353 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	354 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	355 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	356 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	357 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	358 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	359 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	360 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	361 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	362 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	363 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	364 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	365 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	366 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	367 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	368 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	369 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	370 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	371 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	372 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	373 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	374 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	375 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	376 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	377 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	378 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	379 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	380 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	381 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	382 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	383 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	384 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	385 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	386 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	387 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	388 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	389 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	390 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	391 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	392 popup_filter_yesno({id}, {key}) Number filter for a dialog popup window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	393 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	394 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	395 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	396 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	397 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	398 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	399 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	400 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	401 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	402 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	403 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	404 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	405 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	406 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	407 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	408 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	409 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	410 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	411 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	412 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	413 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	414 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	415 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	416 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	417 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	418 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	419 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	420 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	421 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	422 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	423 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	424 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	425 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	426 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	427 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	428 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	429 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	430 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	431 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	432 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	433 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	434 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	435 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	436 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	437 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	438 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	439 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	440 List items from {expr} to {max}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	441 readblob({fname}) Blob read a \|Blob\| from {fname}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	442 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	443 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	444 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	445 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	446 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	447 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	448 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	449 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	450 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	451 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	452 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	453 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	454 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	455 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	456 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	457 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	458 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	459 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	460 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	461 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	462 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	463 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	464 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	465 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	466 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	467 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	468 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	469 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	470 rename({from}, {to}) Number rename (move) file from {from} to {to}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	471 repeat({expr}, {count}) String repeat {expr} {count} times
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	472 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	473 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	474 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	475 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	476 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	477 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	478 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	479 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	480 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	481 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	482 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	483 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	484 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	485 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	486 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	487 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	488 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	489 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	490 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	491 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	492 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	493 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	494 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	495 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	496 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	497 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	498 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	499 {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	500 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	501 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	502 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	503 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	504 setcharsearch({dict}) Dict set character search from {dict}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	505 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	506 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	507 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	508 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	509 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	510 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	511 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	512 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	513 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	514 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	515 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	516 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	517 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	518 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	519 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	520 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	521 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	522 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	523 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	524 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	525 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	526 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	527 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	528 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	529 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	530 command argument
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	531 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	532 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	533 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	534 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	535 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	536 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	537 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	538 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	539 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	540 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	541 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	542 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	543 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	544 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	545 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	546 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	547 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	548 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	549 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	550 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	551 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	552 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	553 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	554 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	555 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	556 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	557 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	558 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	559 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	560 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	561 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	562 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	563 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	564 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	565 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	566 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	567 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	568 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	569 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	570 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	571 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	572 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	573 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	574 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	575 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	576 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	577 character {start}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	578 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	579 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	580 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	581 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	582 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	583 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	584 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	585 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	586 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	587 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	588 byte {start}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	589 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	590 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	591 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	592 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	593 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	594 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	595 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	596 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	597 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	598 String all {pat} in {expr} 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	599 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	600 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	601 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	602 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	603 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	604 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	605 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	606 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	607 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	608 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	609 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	610 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	611 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	612 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	613 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	614 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	615 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	616 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	617 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	618 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	619 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	620 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	621 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	622 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	623 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	624 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	625 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	626 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	627 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	628 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	629 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	630 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	631 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	632 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	633 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	634 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	635 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	636 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	637 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	638 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	639 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	640 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	641 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	642 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	643 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	644 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	645 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	646 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	647 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	648 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	649 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	650 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	651 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	652 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	653 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	654 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	655 test_ignore_error({expr}) none ignore a specific error
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	656 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	657 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	658 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	659 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	660 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	661 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	662 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	663 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	664 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	665 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	666 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	667 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	668 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	669 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	670 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	671 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	672 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	673 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	674 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	675 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	676 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	677 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	678 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	679 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	680 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	681 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	682 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	683 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	684 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	685 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	686 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	687 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	688 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	689 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	690 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	691 values({dict}) List values in {dict}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	692 virtcol({expr}) Number screen column of cursor or mark
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	693 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	694 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	695 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	696 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	697 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	698 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	699 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	700 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	701 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	702 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	703 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	704 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	705 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	706 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	707 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	708 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	709 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	710 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	711 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	712 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	713 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	714 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	715 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	716 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	717 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	718 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	719 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	720 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	721 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	722 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	723
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	724 ==============================================================================
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	725 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	726
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	727 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	728 specific functionality.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	729
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	730 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	731 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	732 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	733 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	734 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	735 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	736 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	737 < 1.456 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	738 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	739 < 5.456 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	740 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	741 < 4
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 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	744 Compute()->abs()
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 < {only available when compiled with the \|+float\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	747
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 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	750 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	751 \|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	752 {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	753 [-1, 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 acos(0)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	756 < 1.570796 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	757 :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	758 < 2.094395
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	759
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	760 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	761 Compute()->acos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	762
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	763 < {only available when compiled with the \|+float\| feature}
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 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	767 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	768 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	769 :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	770 :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	771 < 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	772 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	773 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	774 Use \|insert()\| to add an item at another position.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	775
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	776 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	777 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	778
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 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	781 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	782 to a number. A List, Dict or Float argument causes an error.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	783 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	784 :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	785 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	786 :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	787
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	788
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	789 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	790 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	791 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	792 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	793 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	794 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	795 {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	796 {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	797 Returns 1 for failure ({lnum} out of range 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	798 0 for success. In \|Vim9\| script an invalid argument or
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	799 negative number results in 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	800 :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	801 :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	802
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	803 < 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	804 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	805 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	806
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	807
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	808 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	809 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	810
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	811 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	812 \|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	813
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	814 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	815
26782 b7b82279426f patch 8.2.3919: Vim9: wrong argument for append() results in two errors Bram Moolenaar <Bram@vim.org> parents: 26777 diff changeset	816 {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	817 \|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	818 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	819 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	820
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	821 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	822 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	823
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	824 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	825 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	826 :let failed = appendbufline(13, 0, "# THE START")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	827 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	828 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	829 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	830 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	831
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 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	834 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	835 \|arglist\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	836 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	837 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	838 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	839 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	840 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	841 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	842
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	843 argidx()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	844 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	845 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	846
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	847 arglistid()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	848 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	849 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	850 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	851 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	852 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	853
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	854 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	855 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	856 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	857 page.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	858 {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	859
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	860 argv()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	861 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	862 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	863 \|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	864 :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	865 :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	866 : let f = escape(fnameescape(argv(i)), '.')
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	867 : 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	868 : 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	869 :endwhile
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	870 < 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	871 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	872
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	873 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	874 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	875
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	876 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	877 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	878 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	879 {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	880 [-1, 1].
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	881 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	882 :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	883 < 0.927295 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	884 :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	885 < -0.523599
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	886
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	887 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	888 Compute()->asin()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	889 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	890 {only available when compiled with the \|+float\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	891
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	892
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	893 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	894
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	895
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	896
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	897 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	898 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	899 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	900 {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	901 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	902 :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	903 < 1.560797 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	904 :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	905 < -1.326405
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	906
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	907 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	908 Compute()->atan()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	909 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	910 {only available when compiled with the \|+float\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	911
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	912
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	913 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	914 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	915 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	916 {expr1} and {expr2} 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	917 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	918 :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	919 < -0.785398 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	920 :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	921 < 2.356194
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	922
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	923 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	924 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	925 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	926 {only available when compiled with the \|+float\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	927
28917 c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	928
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	929 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	930 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	931
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	932 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	933 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	934 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	935 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	936 item is ignored.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	937 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	938 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	939 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	940 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	941 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	942 default group is used.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	943 nested set to v:true to add a nested autocmd.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	944 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	945 once set to v:true to add a autocmd which executes
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	946 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	947 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	948 \|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	949 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	950
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	951 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	952 Examples: >
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	953 " 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	954 let acmd = {}
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	955 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	956 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	957 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	958 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	959 call autocmd_add([acmd])
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	960
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	961 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	962 GetAutocmdList()->autocmd_add()
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	963 <
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	964 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	965 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	966
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	967 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	968 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	969 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	970 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	971 item is ignored.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	972 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	973 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	974 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	975 group are deleted.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	976 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	977 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	978 group is used.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	979 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	980 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	981 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	982 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	983 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	984 \|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	985 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	986
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	987 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	988 {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	989 is deleted.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	990
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	991 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	992 Examples: >
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	993 " :autocmd! BufLeave *.vim
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	994 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	995 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	996 " :autocmd! MyGroup1 BufLeave
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	997 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	998 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	999 " :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	1000 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	1001 \ pattern: '*.c'}
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1002 " :autocmd! MyGroup2 * *.c
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1003 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	1004 \ pattern: '*.c'}
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1005 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	1006 " :autocmd! MyGroup3
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1007 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	1008 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	1009 <
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1010 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	1011 GetAutocmdList()->autocmd_delete()
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1012
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1013 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	1014 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	1015 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	1016
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1017 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	1018 items:
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1019 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	1020 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	1021 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	1022 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	1023 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	1024 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	1025 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	1026 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	1027 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	1028 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	1029 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	1030 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	1031 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	1032 {opts}.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1033
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1034 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	1035 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	1036 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	1037 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	1038 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	1039 group Autocmd group name.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1040 nested Set to v:true for a nested autocmd. See
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1041 \|autocmd-nested\|.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1042 once Set to v:true, if the autocmd will be executed
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1043 only once. See \|autocmd-once\|.
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1044 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	1045 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	1046 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	1047 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	1048
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1049 Examples: >
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1050 " :autocmd MyGroup
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1051 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	1052 " :autocmd G BufUnload
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1053 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	1054 " :autocmd G * *.ts
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1055 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	1056 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	1057 " :autocmd Syntax
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1058 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	1059 " :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	1060 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	1061 \ pattern: '*.ts'}
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1062 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	1063 <
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1064 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	1065 Getopts()->autocmd_get()
c5862dfaf0bd patch 8.2.4981: it is not possible to manipulate autocommands Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	1066 <
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1067 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	1068 Return the current text in the balloon. Only for the string,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1069 not used for the List.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1070
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1071 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	1072 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	1073 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	1074 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	1075 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	1076 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	1077
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1078 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1079 func GetBalloonContent()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1080 " ... 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	1081 return ''
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1082 endfunc
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1083 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	1084
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1085 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	1086 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	1087 endfunc
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1088 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1089 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	1090 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1091 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	1092 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	1093 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	1094 balloon_show(). The 'balloonexpr' itself can return an
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1095 empty string or a placeholder.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1096
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1097 When showing a balloon is not possible nothing happens, no
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1098 error message.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1099 {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	1100 \|+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	1101
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1102 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	1103 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	1104 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	1105 to show debugger output.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1106 Returns a \|List\| with the split lines.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1107 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1108 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	1109
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1110 < {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	1111 feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1112
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1113 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	1114 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	1115 {blob}. Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1116 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	1117 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	1118 < 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	1119 opposite.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1120
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1121 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1122 GetBlob()->blob2list()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1123
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1124 browse()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1125 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	1126 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	1127 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	1128 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	1129 {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	1130 {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	1131 {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	1132 {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	1133 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	1134 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	1135
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1136 browsedir()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1137 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	1138 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	1139 "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	1140 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	1141 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	1142 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	1143 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	1144 {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	1145 {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	1146 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	1147 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	1148
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1149 bufadd({name}) bufadd()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1150 Add a buffer to the buffer list with String {name}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1151 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	1152 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	1153 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	1154 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	1155 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	1156 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	1157 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	1158 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	1159 call setbufline(bufnr, 1, ['some', 'text'])
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 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	1162
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1163 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	1164 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	1165 {buf} exists.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1166 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	1167 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	1168
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1169 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	1170 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	1171 - 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	1172 - 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	1173 - 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	1174 - 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	1175 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	1176 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	1177 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	1178 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	1179 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	1180 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	1181 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	1182 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	1183 file name.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1184
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1185 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1186 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	1187 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1188 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	1189
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1190 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	1191 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	1192 {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	1193 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	1194
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1195 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1196 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	1197
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1198 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	1199 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	1200 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	1201 the buffer will be empty. If the buffer was already loaded
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1202 then there is no change.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1203 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	1204 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	1205 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	1206
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1207 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1208 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	1209
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1210 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	1211 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	1212 {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	1213 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	1214
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1215 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1216 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	1217
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1218 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	1219 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	1220 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	1221 "[No Name]".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1222 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	1223 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	1224 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	1225 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	1226 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	1227 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	1228 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	1229 "" 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	1230 alternate buffer.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1231 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	1232 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	1233 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	1234 pattern.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1235 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	1236 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	1237 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	1238 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	1239 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	1240 :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	1241 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1242 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	1243
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1244 < 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	1245 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	1246 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	1247 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	1248 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	1249 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	1250 < buffer_name()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1251 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	1252
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1253 bufnr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1254 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	1255 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	1256 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	1257 above.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1258
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1259 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	1260 {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	1261 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	1262 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	1263 < 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	1264 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	1265
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1266 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	1267 :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	1268 < 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	1269 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	1270 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	1271 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	1272
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1273 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1274 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	1275 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1276 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	1277 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	1278 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	1279
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1280 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	1281 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	1282 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	1283 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	1284 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	1285
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	1286 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	1287 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1288 Only deals with 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	1289
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1290 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1291 FindBuffer()->bufwinid()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1292
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1293 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	1294 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	1295 \|window-ID\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1296 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	1297 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	1298
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	1299 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	1300
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1301 < 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	1302 \|:wincmd\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1303
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1304 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1305 FindBuffer()->bufwinnr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1306
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1307 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	1308 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	1309 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	1310 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	1311 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	1312 one.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1313 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	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 GetOffset()->byte2line()
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 < {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	1319 feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1320
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1321 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	1322 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	1323 {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	1324 zero.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1325 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	1326 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	1327 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	1328 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	1329 \|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	1330 separately.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1331 Example : >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1332 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	1333 < 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	1334 same: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1335 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	1336 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	1337 < 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	1338
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1339 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	1340 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	1341 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	1342
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1343 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1344 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	1345
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1346 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	1347 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	1348 as a separate character. Example: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	1349 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	1350 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	1351 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	1352 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	1353 < 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	1354 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	1355 one byte).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1356 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	1357 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	1358
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1359 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1360 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	1361
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1362 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	1363 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	1364 arguments.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1365 {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	1366 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	1367 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	1368 {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	1369 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	1370
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1371 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1372 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	1373
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1374 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	1375 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	1376 {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	1377 {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	1378 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1379 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	1380 < 2.0 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1381 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	1382 < -5.0 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1383 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	1384 < 4.0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1385
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1386 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1387 Compute()->ceil()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1388 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1389 {only available when compiled with the \|+float\| feature}
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
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1392 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	1393
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1394
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1395 changenr() changenr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1396 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	1397 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	1398 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	1399 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	1400 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	1401 one less than the number of the undone change.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1402
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1403 char2nr({string} [, {utf8}]) char2nr()
28933 57c9377b9c62 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 28917 diff changeset	1404 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	1405 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1406 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	1407 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	1408 < 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	1409 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	1410 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	1411 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	1412 < 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	1413 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	1414 \|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	1415 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	1416 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	1417 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	1418 < 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	1419
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1420 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1421 GetChar()->char2nr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1422
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1423
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1424 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	1425 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	1426 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	1427 0 blank
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1428 1 punctuation
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1429 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	1430 3 emoji
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1431 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	1432 The class is used in patterns and word motions.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1433
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1434
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1435 charcol({expr}) charcol()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1436 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	1437 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	1438
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1439 Example:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1440 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	1441 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	1442 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	1443
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1444 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1445 GetPos()->col()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1446 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1447 charidx()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1448 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	1449 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	1450 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	1451 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	1452 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	1453 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	1454 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	1455 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	1456 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	1457 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	1458 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	1459 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	1460 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	1461 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	1462 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	1463 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	1464 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	1465 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1466 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	1467 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	1468 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	1469 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1470 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1471 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	1472
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1473 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	1474 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	1475 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	1476 window:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1477 - 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	1478 (\|: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	1479 - 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	1480 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	1481 directory.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1482 - 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	1483 {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	1484 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	1485 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	1486 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	1487
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1488 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1489 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	1490 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	1491 " ... 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	1492 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	1493 endif
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 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1496 GetDir()->chdir()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1497 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1498 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	1499 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	1500 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	1501 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	1502 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	1503 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	1504 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	1505
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1506 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1507 GetLnum()->cindent()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1508
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1509 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	1510 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	1511 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	1512 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	1513 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	1514
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1515 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1516 GetWin()->clearmatches()
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 col()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1519 col({expr}) The result is a Number, which is the byte 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	1520 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	1521 . 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	1522 $ 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	1523 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	1524 '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	1525 returned)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1526 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	1527 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	1528 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	1529 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	1530 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	1531 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	1532 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	1533 out of range then col() returns zero.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1534 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	1535 \|getpos()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1536 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	1537 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	1538 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	1539 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1540 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	1541 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	1542 col("'t") column of mark t
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	1543 col("'" .. markname) column of mark markname
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1544 < 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	1545 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	1546 buffer.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1547 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	1548 column is one higher if the cursor is after 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	1549 line. This can be used to obtain the column 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	1550 :imap <F2> <C-O>:let save_ve = &ve<CR>
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1551 \<C-O>:set ve=all<CR>
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	1552 \<C-O>:echo col(".") .. "\n" <Bar>
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1553 \let &ve = save_ve<CR>
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1554
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1555 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1556 GetPos()->col()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1557 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1558
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1559 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	1560 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	1561 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	1562 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	1563 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	1564 {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	1565 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	1566 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	1567 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	1568 match.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1569 {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	1570 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	1571 "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	1572 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	1573 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	1574 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	1575 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	1576 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	1577 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1578 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	1579
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1580 func! ListMonths()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1581 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	1582 \ '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	1583 \ '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	1584 return ''
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1585 endfunc
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1586 < 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	1587 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	1588
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1589 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	1590 second argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1591 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	1592
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1593 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	1594 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	1595 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	1596 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	1597 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	1598 the list.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1599 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	1600 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	1601
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1602 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1603 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	1604
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1605 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	1606 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	1607 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	1608 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	1609 zero otherwise.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1610 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	1611 'completefunc' option.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1612
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1613
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1614 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	1615 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	1616 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	1617 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	1618 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	1619 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	1620 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	1621 See \|pumvisible()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1622 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	1623 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	1624 "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	1625 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	1626 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	1627 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	1628 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	1629 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	1630 <Down> keys)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1631 inserted Inserted string. [NOT IMPLEMENT YET]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1632
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1633 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	1634 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	1635 "" 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	1636 "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	1637 "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	1638 "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	1639 \|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	1640 "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	1641 "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	1642 "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	1643 "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	1644 "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	1645 "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	1646 "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	1647 "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	1648 "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	1649 "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	1650 "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	1651 "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	1652 "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	1653
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1654 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	1655 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	1656 {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	1657
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1658 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	1659 \|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	1660 \|CompleteChanged\| event.
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 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1663 " 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	1664 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	1665 " 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	1666 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	1667 " 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	1668 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	1669
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1670 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1671 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	1672 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1673 confirm()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1674 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	1675 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	1676 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	1677 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	1678 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	1679 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	1680
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1681 {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	1682 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	1683 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	1684 {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	1685 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	1686
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1687 {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	1688 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	1689 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	1690 < 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	1691 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	1692 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	1693 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	1694 < 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	1695 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	1696
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1697 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	1698 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	1699 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	1700 {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	1701
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1702 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	1703 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	1704 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	1705 "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	1706 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	1707 used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1708
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1709 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	1710 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	1711
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1712 An example: >
28246 e3d6184b89fa Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28183 diff changeset	1713 let choice = confirm("What do you want?",
28933 57c9377b9c62 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 28917 diff changeset	1714 \ "&Apples\n&Oranges\n&Bananas", 2)
28246 e3d6184b89fa Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28183 diff changeset	1715 if choice == 0
28933 57c9377b9c62 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 28917 diff changeset	1716 echo "make up your mind!"
28246 e3d6184b89fa Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28183 diff changeset	1717 elseif choice == 3
28933 57c9377b9c62 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 28917 diff changeset	1718 echo "tasteful"
28246 e3d6184b89fa Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28183 diff changeset	1719 else
28933 57c9377b9c62 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 28917 diff changeset	1720 echo "I prefer bananas myself."
28246 e3d6184b89fa Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28183 diff changeset	1721 endif
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1722 < 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	1723 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	1724 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	1725 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	1726 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	1727 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	1728
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1729 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	1730 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	1731 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1732 copy()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1733 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	1734 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	1735 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	1736 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	1737 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	1738 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	1739 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	1740 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	1741 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1742 mylist->copy()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1743
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1744 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	1745 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	1746 {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	1747 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1748 :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	1749 < 0.862319 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1750 :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	1751 < -0.646043
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 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1754 Compute()->cos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1755 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1756 {only available when compiled with the \|+float\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1757
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1758
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1759 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	1760 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	1761 [1, inf].
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1762 {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	1763 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1764 :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	1765 < 1.127626 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1766 :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	1767 < -1.127626
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1768
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1769 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1770 Compute()->cosh()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1771 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1772 {only available when compiled with the \|+float\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1773
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1774
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1775 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	1776 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	1777 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	1778
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1779 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	1780 {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	1781
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1782 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	1783
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1784 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	1785 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	1786 {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	1787
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1788 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1789 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	1790 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1791 cscope_connection()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1792 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	1793 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	1794 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	1795 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	1796 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	1797 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	1798
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1799 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	1800 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	1801
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1802 {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	1803 ----- ------------------------------
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1804 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	1805 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	1806 {dbpath}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1807 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	1808 {dbpath}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1809 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	1810 {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	1811 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	1812 {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	1813
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1814 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	1815
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1816 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	1817
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1818 # 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	1819 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	1820 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1821 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	1822 ---------- ---------- >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1823 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	1824 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	1825 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	1826 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	1827 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	1828 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	1829 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	1830 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	1831 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1832 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	1833 cursor({list})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1834 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	1835 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	1836
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1837 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	1838 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	1839 [{lnum}, {col}]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1840 [{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	1841 [{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	1842 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	1843 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	1844
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1845 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	1846 \|setcursorcharpos()\|.
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 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	1849 {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	1850 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	1851 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	1852 If {lnum} is zero, the cursor will stay in the current line.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1853 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	1854 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	1855 line.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1856 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	1857 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	1858 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	1859
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1860 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	1861 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	1862 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	1863 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	1864
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1865 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1866 GetCursorPos()->cursor()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1867
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1868 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	1869 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	1870 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	1871 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	1872 {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	1873
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1874 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1875 GetPid()->debugbreak()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1876
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1877 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	1878 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	1879 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	1880 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	1881 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	1882 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	1883 \|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	1884 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	1885 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	1886 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	1887
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1888 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	1889 \|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	1890 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	1891 \|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	1892 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	1893 E724
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1894 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	1895 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	1896 {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	1897 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	1898
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1899 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1900 GetObject()->deepcopy()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1901
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1902 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	1903 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	1904 name {fname}.
6dd88e45d47d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28307 diff changeset	1905
6dd88e45d47d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28307 diff changeset	1906 This also works when {fname} is a symbolic link. The symbolic
6dd88e45d47d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28307 diff changeset	1907 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	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 {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	1910 {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	1911
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1912 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	1913 {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	1914 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	1915 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	1916
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1917 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	1918 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	1919 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	1920
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1921 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	1922 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	1923 \|deletebufline()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1924
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1925 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1926 GetName()->delete()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1927
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1928 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	1929 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	1930 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	1931 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	1932
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1933 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	1934 \|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	1935
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1936 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	1937
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1938 {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	1939 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	1940 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	1941
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1942 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1943 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	1944 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1945 did_filetype()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1946 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	1947 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	1948 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	1949 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	1950 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	1951 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	1952 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	1953 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	1954 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	1955 file.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1956
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1957 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	1958 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	1959 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	1960 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	1961 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	1962 {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	1963 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	1964 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	1965
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1966 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1967 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	1968
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1969 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	1970 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	1971 {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	1972 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	1973 {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	1974 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	1975 {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	1976 line.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1977 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	1978 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	1979
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1980 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1981 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	1982 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1983
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1984 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	1985 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	1986 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	1987 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	1988 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	1989
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1990 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	1991 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	1992 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	1993
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1994 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	1995
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1996 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	1997 " 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	1998 :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	1999
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2000 " 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	2001 :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	2002 :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	2003 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2004 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2005 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	2006 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2007 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	2008 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	2009 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	2010
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2011
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2012 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	2013 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	2014 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	2015 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	2016
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2017 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	2018 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	2019 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	2020
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2021 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	2022
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2023 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2024 " 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	2025 :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	2026
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2027 " 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	2028 :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	2029 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2030 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2031 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	2032 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2033 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	2034 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	2035 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	2036
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2037
27537 063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27497 diff changeset	2038 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	2039 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	2040 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	2041 encoded character. E1215
063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27497 diff changeset	2042 Be careful, composing characters are NOT ignored. This
063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27497 diff changeset	2043 function is similar to \|:digraphs\| command, but useful to add
063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27497 diff changeset	2044 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	2045
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2046 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	2047 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	2048
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2049 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	2050 \|digraph_setlist()\|.
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 Example: >
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(' ', 'あ')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2054 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2055 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	2056 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	2057 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2058 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	2059 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	2060 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	2061
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 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	2064 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	2065 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	2066 where each list contains two strings with {chars} and
27537 063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27497 diff changeset	2067 {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	2068 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2069 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	2070 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2071 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	2072 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	2073 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	2074 endfor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2075 < 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	2076 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	2077
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2078 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	2079 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	2080 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2081 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	2082 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	2083 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	2084
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2085
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2086 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	2087 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	2088 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	2089 disable modifyOtherKeys: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2090 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	2091 < 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	2092 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	2093 < 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	2094
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2095
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2096 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	2097 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	2098 - 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	2099 items.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2100 - 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	2101 - 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	2102 - \|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	2103 - 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	2104 - 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	2105 - 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	2106
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2107 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	2108 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	2109
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2110 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2111 mylist->empty()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2112
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2113 environ() environ()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2114 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	2115 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	2116 :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	2117 < 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	2118 use this: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2119 :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	2120
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2121 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	2122 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	2123 backslash. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2124 :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	2125 < results in: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2126 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	2127 < 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	2128
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2129 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2130 GetText()->escape(' \')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2131 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2132 eval()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2133 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	2134 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	2135 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	2136 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	2137 functions.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2138
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2139 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2140 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	2141
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2142 eventhandler() eventhandler()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2143 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	2144 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	2145 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	2146 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	2147
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2148 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	2149 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	2150 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	2151 arguments.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2152 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	2153 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	2154 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	2155 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	2156 "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	2157 $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	2158 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	2159 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	2160 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	2161 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	2162 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	2163 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	2164 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	2165 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	2166 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	2167 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	2168 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	2169 1 exists
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2170 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	2171 -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	2172 \|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	2173
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2174 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2175 GetCommand()->executable()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2176
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2177 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	2178 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	2179 string.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2180 {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	2181 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	2182 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	2183 redir => var
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2184 {command}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2185 redir END
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2186 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2187 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	2188 "" 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	2189 "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	2190 "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	2191 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	2192 `: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	2193 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	2194 E930
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2195 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	2196
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2197 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	2198 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	2199
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2200 < 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	2201 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	2202
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2203 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	2204 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	2205
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2206 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2207 GetCommand()->execute()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2208
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2209 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	2210 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	2211 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	2212 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	2213 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	2214 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	2215 < 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	2216 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	2217
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2218 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2219 GetCommand()->exepath()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2220 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2221 exists()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2222 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	2223 zero otherwise.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2224
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2225 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	2226 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	2227 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	2228
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2229 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	2230 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	2231
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2232 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	2233 varname internal variable (see
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2234 dict.key \|internal-variables\|). Also works
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2235 list[i] for \|curly-braces-names\|, \|Dictionary\|
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2236 import.Func entries, \|List\| items, imported
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	2237 items, etc.
27459 5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2238 Does not work for local variables in a
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2239 compiled `:def` function.
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	2240 Also works for a function in \|Vim9\|
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	2241 script, since it can be used as a
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	2242 function reference.
27459 5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2243 Beware that evaluating an index may
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2244 cause an error message for an invalid
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2245 expression. E.g.: >
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2246 :let l = [1, 2, 3]
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2247 :echo exists("l[5]")
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2248 < 0 >
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2249 :echo exists("l[xx]")
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2250 < E121: Undefined variable: xx
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	2251 0
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2252 &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	2253 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	2254 +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	2255 $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	2256 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	2257 string)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2258 *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	2259 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	2260 \|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	2261 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	2262 Funcref.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2263 ?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	2264 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	2265 "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	2266 :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	2267 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	2268 Returns:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2269 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	2270 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	2271 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	2272 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	2273 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	2274 :2match The \|:2match\| command.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2275 :3match The \|:3match\| command.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2276 #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	2277 #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	2278 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	2279 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	2280 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	2281 character)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2282 #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	2283 #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	2284 event.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2285 #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	2286 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	2287 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	2288 ##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	2289 supported.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2290
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2291 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2292 exists("&shortname")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2293 exists("$HOSTNAME")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2294 exists("*strftime")
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	2295 exists("*s:MyFunc") " only for legacy script
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	2296 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	2297 exists("bufcount")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2298 exists(":Make")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2299 exists("#CursorHold")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2300 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	2301 exists("#filetypeindent")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2302 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	2303 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	2304 exists("##ColorScheme")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2305 < 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	2306 name.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2307 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	2308 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	2309 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	2310 Working example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2311 exists(":make")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2312 < 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	2313 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	2314
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2315 < 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	2316 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	2317 exists(bufcount)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2318 < 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	2319 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	2320
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2321 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2322 Varname()->exists()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2323 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2324
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2325 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	2326 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	2327 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	2328 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	2329 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	2330 ThatFunction('works')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2331 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2332 < 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	2333 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	2334
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2335 {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	2336 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	2337 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	2338
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2339
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2340 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	2341 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	2342 [0, inf].
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2343 {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	2344 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2345 :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	2346 < 7.389056 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2347 :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	2348 < 0.367879
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2349
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2350 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2351 Compute()->exp()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2352 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2353 {only available when compiled with the \|+float\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2354
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2355
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2356 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	2357 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	2358 {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	2359
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2360 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	2361 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	2362 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	2363 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	2364 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	2365
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2366 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	2367 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	2368 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	2369
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2370 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	2371 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	2372 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	2373
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2374 % 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	2375 # 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	2376 #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	2377 <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	2378 <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	2379 <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	2380 <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	2381 <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	2382 <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	2383 <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	2384 line number
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2385 <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	2386 a function
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2387 <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	2388 current script ID \|<SID>\|
28517 f73a9bdff3a3 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28471 diff changeset	2389 <script> sourced script file, or script file
f73a9bdff3a3 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28471 diff changeset	2390 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	2391 <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	2392 <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	2393 <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	2394 <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	2395 message \|server2client()\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2396 Modifiers:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2397 :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	2398 :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	2399 :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	2400 :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	2401 :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	2402
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2403 Example: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	2404 :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	2405 < 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	2406 '<', 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	2407 :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	2408 < Use this: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	2409 :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	2410 < 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	2411 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	2412 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	2413 "~/" 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	2414 :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	2415 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2416 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	2417 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	2418 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	2419
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2420 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	2421 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	2422 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	2423 '/' added.
28431 4fbdd4ce9edb patch 8.2.4740: when expand() fails there is no error message Bram Moolenaar <Bram@vim.org> parents: 28379 diff changeset	2424 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	2425 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	2426 expanded.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2427
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2428 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	2429 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	2430 '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	2431 {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	2432 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	2433 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	2434 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	2435 :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	2436 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2437 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	2438 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	2439 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	2440 \|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	2441 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	2442 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	2443 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	2444 "$FOOBAR".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2445
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2446 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	2447 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	2448
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2449 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2450 Getpattern()->expand()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2451
28307 425700af491b patch 8.2.4679: cannot have expandcmd() give an error message for mistakes Bram Moolenaar <Bram@vim.org> parents: 28283 diff changeset	2452 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	2453 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	2454 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	2455 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	2456 {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	2457 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	2458
425700af491b patch 8.2.4679: cannot have expandcmd() give an error message for mistakes Bram Moolenaar <Bram@vim.org> parents: 28283 diff changeset	2459 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	2460 argument:
425700af491b patch 8.2.4679: cannot have expandcmd() give an error message for mistakes Bram Moolenaar <Bram@vim.org> parents: 28283 diff changeset	2461 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	2462 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	2463 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	2464
28283 2fd2ce8a556c patch 8.2.4667: expandcmd() fails on an error Bram Moolenaar <Bram@vim.org> parents: 28246 diff changeset	2465 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	2466 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	2467
28283 2fd2ce8a556c patch 8.2.4667: expandcmd() fails on an error Bram Moolenaar <Bram@vim.org> parents: 28246 diff changeset	2468 Example: >
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2469 :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	2470 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	2471 :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	2472 <
28283 2fd2ce8a556c patch 8.2.4667: expandcmd() fails on an error Bram Moolenaar <Bram@vim.org> parents: 28246 diff changeset	2473 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	2474 GetCommand()->expandcmd()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2475 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2476 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	2477 {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	2478 \|Dictionaries\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2479
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2480 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	2481 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	2482 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	2483 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	2484 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	2485 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2486 :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	2487 :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	2488 < 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	2489 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	2490 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	2491 (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	2492 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	2493 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	2494 :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	2495 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2496 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	2497 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	2498 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	2499 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	2500 {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	2501 {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	2502 {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	2503 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	2504
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2505 {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	2506 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	2507 {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	2508 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	2509 fails.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2510 Returns {expr1}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2511
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2512 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2513 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	2514
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2515
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2516 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	2517 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	2518 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	2519 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	2520 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	2521
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2522
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2523 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	2524 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	2525 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	2526
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2527 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	2528 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	2529 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	2530 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	2531 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	2532
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2533 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	2534 {string}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2535
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2536 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	2537 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	2538 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	2539 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	2540 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	2541 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	2542
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2543 {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	2544 '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	2545 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	2546 '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	2547 '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	2548 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	2549 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	2550 '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	2551 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	2552 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	2553 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	2554 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	2555 '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	2556 '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	2557 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	2558 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	2559 (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	2560 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	2561 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	2562 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	2563 script continues.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2564 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	2565 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	2566 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	2567 '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	2568 legacy script syntax applies, "s:var" does not work,
28777 b96ceb97e896 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28757 diff changeset	2569 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	2570 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	2571 '!' 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	2572 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	2573 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	2574
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2575 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	2576
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2577 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2578 GetInput()->feedkeys()
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 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	2581 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	2582 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	2583 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	2584 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	2585 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	2586 \|glob()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2587 {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	2588 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	2589 0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2590 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	2591 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2592
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2593 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2594 GetName()->filereadable()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2595 < file_readable()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2596 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	2597
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2598
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2599 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	2600 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	2601 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	2602 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	2603 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	2604
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2605 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2606 GetName()->filewritable()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2607
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2608
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2609 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	2610 {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	2611 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	2612 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	2613 \|Dictionary\|. Similarly for each byte in a \|Blob\| and each
27036 3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26901 diff changeset	2614 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	2615
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2616 {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	2617
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2618 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	2619 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	2620 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	2621 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	2622 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	2623 current character.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2624 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2625 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	2626 < 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	2627 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	2628 < 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	2629 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	2630 < 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	2631
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2632 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	2633 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	2634 \|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	2635
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2636 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	2637 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	2638 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	2639 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	2640 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	2641 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	2642 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	2643 endfunc
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2644 call filter(mylist, function('Odd'))
27036 3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26901 diff changeset	2645 < It is shorter when using a \|lambda\|. In \|Vim9\| syntax: >
3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26901 diff changeset	2646 call filter(myList, (idx, val) => idx * val <= 42)
3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26901 diff changeset	2647 < 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	2648 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	2649 < 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	2650 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	2651 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2652 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	2653 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	2654
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2655 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	2656 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	2657 first: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2658 :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	2659
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2660 < 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	2661 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	2662 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	2663 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	2664 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	2665 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	2666
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2667 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2668 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	2669
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2670 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	2671 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	2672 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	2673 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	2674
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2675 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	2676 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	2677 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	2678 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	2679
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2680 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	2681 {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	2682 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	2683
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2684 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	2685 {only available when compiled with the \|+file_in_path\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2686 feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2687
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2688 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2689 GetName()->finddir()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2690
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2691 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	2692 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	2693 Uses 'suffixesadd'.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2694 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2695 :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	2696 < 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	2697 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	2698
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2699 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2700 GetName()->findfile()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2701
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2702 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	2703 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	2704 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	2705 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	2706 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	2707 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	2708 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	2709 \|flattennew()\|.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2710 E900
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2711 {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	2712 {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	2713 {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	2714
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2715 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	2716
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2717 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2718 :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	2719 < [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	2720 :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	2721 < [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	2722
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2723 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2724 mylist->flatten()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2725 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2726 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	2727 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	2728
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2729
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2730 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	2731 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	2732 decimal point.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2733 {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	2734 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	2735 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	2736 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	2737 -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	2738 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	2739 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2740 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	2741 < 3 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2742 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	2743 < -23 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2744 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	2745 < 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	2746 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	2747 < -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	2748 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	2749 < 0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2750
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2751 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2752 Compute()->float2nr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2753 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2754 {only available when compiled with the \|+float\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2755
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2756
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2757 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	2758 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	2759 {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	2760 {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	2761 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2762 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	2763 < 1.0 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2764 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	2765 < -6.0 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2766 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	2767 < 4.0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2768
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2769 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2770 Compute()->floor()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2771 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2772 {only available when compiled with the \|+float\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2773
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2774
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2775 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	2776 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	2777 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	2778 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	2779 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	2780 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	2781 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	2782 {expr1} and {expr2} 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	2783 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2784 :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	2785 < 0.13 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2786 :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	2787 < -0.13
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2788
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2789 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2790 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	2791 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2792 {only available when compiled with \|+float\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2793
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2794
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2795 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	2796 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	2797 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	2798 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	2799 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	2800 " \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	2801 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	2802 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	2803 and \|:write\|). And a "-" by itself (special after \|:cd\|).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2804 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2805 :let fname = '+some str%nge\|name'
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	2806 :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	2807 < 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	2808 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	2809 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2810 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2811 GetName()->fnameescape()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2812
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2813 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	2814 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	2815 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	2816 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	2817 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2818 :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	2819 < results in: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2820 /home/mool/vim/vim/src
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2821 < If {mods} is empty then {fname} is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2822 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	2823 \|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	2824
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2825 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2826 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	2827
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2828 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	2829 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	2830 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	2831 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	2832 {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	2833 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	2834
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2835 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2836 GetLnum()->foldclosed()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2837
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2838 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	2839 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	2840 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	2841 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	2842 {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	2843 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	2844
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2845 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2846 GetLnum()->foldclosedend()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2847
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2848 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	2849 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	2850 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	2851 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	2852 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	2853 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	2854 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	2855 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	2856 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	2857 {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	2858 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	2859
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2860 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2861 GetLnum()->foldlevel()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2862 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2863 foldtext()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2864 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	2865 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	2866 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	2867 \|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	2868 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	2869 +-- 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	2870 < 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	2871 "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	2872 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	2873 "//" 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	2874 '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	2875 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	2876 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	2877 setting.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2878 {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	2879
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2880 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	2881 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	2882 {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	2883 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	2884 returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2885 {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	2886 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	2887 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	2888 {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	2889
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2890
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2891 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2892 GetLnum()->foldtextresult()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2893 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2894 foreground()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2895 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	2896 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	2897 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	2898 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	2899 \|remote_foreground()\| instead.
28379 6dd88e45d47d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28307 diff changeset	2900 {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	2901 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	2902
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2903 fullcommand({name}) fullcommand()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2904 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	2905 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	2906
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2907 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	2908 include a [range], these are skipped and not returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2909 Returns an empty string if a command doesn't exist or if it's
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2910 ambiguous (for user-defined commands).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2911
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2912 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	2913 `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	2914
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2915 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2916 GetName()->fullcommand()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2917 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2918 funcref()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2919 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	2920 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	2921 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	2922 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	2923
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2924 Unlike \|function()\|, {name} must be an existing user function.
27036 3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26901 diff changeset	2925 It only works for an autoloaded function if it has already
3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26901 diff changeset	2926 been loaded (to avoid mistakenly loading the autoload script
3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26901 diff changeset	2927 when only intending to use the function name, use \|function()\|
3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26901 diff changeset	2928 instead). {name} cannot be a builtin function.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2929
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2930 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2931 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	2932 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2933 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	2934 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	2935 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	2936 {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	2937 internal function.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2938
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2939 {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	2940 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	2941 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	2942 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	2943 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	2944 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2945 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	2946 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	2947 same function.
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 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	2950 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	2951 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	2952
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2953 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	2954 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	2955 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	2956 ...
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2957 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	2958 ...
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2959 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	2960 < 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	2961 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	2962
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2963 < 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	2964 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	2965 ...
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2966 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	2967 ...
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2968 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	2969 < 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	2970 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	2971
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2972 < 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	2973 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	2974 arguments. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2975 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	2976 ...
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2977 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	2978 let Func2 = function(Func, ['two'])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2979 ...
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2980 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	2981 < 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	2982 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	2983
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2984 < 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	2985 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	2986 function Callback() dict
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	2987 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	2988 endfunction
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2989 ...
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2990 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	2991 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	2992 ...
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2993 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	2994 < The use of function() is not needed when there are no extra
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2995 arguments, these two are equivalent: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2996 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	2997 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	2998
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	2999 < 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	3000 function Callback(arg1, count) dict
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3001 ...
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3002 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	3003 let Func = function('Callback', ['one'], context)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3004 ...
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3005 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	3006 < 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	3007 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	3008 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3009 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3010 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	3011
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3012
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3013 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	3014 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	3015 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	3016
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3017 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	3018 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	3019 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	3020 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	3021 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	3022 \|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	3023 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	3024
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3025 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	3026 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	3027 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	3028
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3029 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	3030 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	3031 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	3032 \|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	3033
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3034 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	3035 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	3036 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	3037 omitted.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3038 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	3039 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	3040 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	3041 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	3042 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	3043 omitted.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3044 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	3045 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	3046 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	3047 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	3048 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	3049 {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	3050 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	3051 < 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	3052 '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	3053 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	3054 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	3055 get({func}, {what})
27321 3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27223 diff changeset	3056 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	3057 {what} are:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3058 "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	3059 "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	3060 "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	3061 "args" The list with arguments
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3062 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	3063 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	3064 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3065 getbufinfo()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3066 getbufinfo([{buf}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3067 getbufinfo([{dict}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3068 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	3069
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3070 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	3071 returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3072
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3073 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	3074 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	3075 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	3076 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	3077 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	3078 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	3079
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3080 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	3081 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	3082 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	3083 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	3084
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3085 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	3086 entries:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3087 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	3088 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	3089 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	3090 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	3091 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	3092 \|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	3093 last used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3094 {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	3095 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	3096 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	3097 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	3098 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	3099 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	3100 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	3101 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	3102 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	3103 :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	3104 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3105 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	3106 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	3107 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	3108 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	3109 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	3110 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	3111 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	3112 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	3113 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	3114 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	3115 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	3116 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	3117 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	3118 buffer
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3119 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	3120 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	3121
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3122 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3123 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	3124 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	3125 endfor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3126 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	3127 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	3128 ....
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3129 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3130 endfor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3131 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3132 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	3133 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	3134 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3135 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3136 GetBufnr()->getbufinfo()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3137 <
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 getbufline()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3140 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	3141 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	3142 (inclusive) in the buffer {buf}. If {end} is omitted, a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3143 \|List\| with only the line {lnum} is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3144
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3145 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	3146
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3147 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	3148 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	3149
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3150 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	3151 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	3152
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3153 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	3154 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	3155 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	3156 returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3157
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3158 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	3159 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	3160
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3161 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3162 :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	3163
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3164 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3165 GetBufnr()->getbufline(lnum)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3166
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3167 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	3168 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	3169 {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	3170 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	3171 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	3172 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	3173 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	3174 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	3175 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	3176 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	3177 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	3178 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	3179 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	3180 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	3181 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	3182 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	3183 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	3184 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3185 :let bufmodified = getbufvar(1, "&mod")
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	3186 :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	3187
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3188 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3189 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	3190 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3191 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	3192 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	3193 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	3194 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	3195
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3196 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	3197 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	3198 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	3199 entries:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3200 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	3201 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	3202 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	3203 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	3204 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	3205 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	3206
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3207 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3208 GetBufnr()->getchangelist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3209
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3210 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	3211 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	3212 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	3213 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	3214 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	3215 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	3216 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	3217 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	3218
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3219 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	3220 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	3221 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	3222 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	3223 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	3224 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	3225 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	3226 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	3227 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	3228
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3229 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	3230 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	3231 sequence.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3232
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3233 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	3234 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	3235 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	3236
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3237 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	3238
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3239 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	3240 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	3241 \|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	3242 \|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	3243 ignored.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3244 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	3245 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	3246 if c == "\<LeftMouse>" && v:mouse_win > 0
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	3247 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	3248 exe v:mouse_lnum
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	3249 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	3250 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3251 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3252 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	3253 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	3254 \|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	3255
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3256 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	3257 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	3258 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	3259 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	3260
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3261 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	3262 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	3263 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	3264 sequence. Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3265 getchar() == "\<Del>"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3266 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	3267 < 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	3268 :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	3269 :function FindChar()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3270 : 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	3271 : 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	3272 : normal l
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3273 : 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	3274 : break
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3275 : endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3276 : endwhile
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3277 :endfunction
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3278 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3279 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	3280 \|<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	3281 another character: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3282 :function GetKey()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3283 : 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	3284 : 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	3285 : 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	3286 : endwhile
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3287 : return c
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3288 :endfunction
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3289
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3290 getcharmod() getcharmod()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3291 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	3292 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	3293 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	3294 2 shift
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3295 4 control
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3296 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	3297 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	3298 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	3299 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	3300 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	3301 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	3302 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	3303 character itself are obtained. Thus Shift-a 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	3304 without a modifier.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3305
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3306 getcharpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3307 getcharpos({expr})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3308 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	3309 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	3310 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	3311 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	3312 \|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	3313 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	3314
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3315 Example:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3316 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	3317 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	3318 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	3319 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3320 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3321 GetMark()->getcharpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3322
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3323 getcharsearch() getcharsearch()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3324 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	3325 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	3326
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3327 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	3328 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	3329 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	3330 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	3331 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	3332 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	3333 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	3334 character search
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3335
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3336 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	3337 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	3338 character search: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3339 :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	3340 :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	3341 < 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	3342
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3343
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3344 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	3345 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	3346 string.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3347 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	3348 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	3349 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	3350 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	3351 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	3352 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	3353 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	3354 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	3355
28757 add09d468c0d patch 8.2.4903: cannot get the current cmdline completion type and position Bram Moolenaar <Bram@vim.org> parents: 28674 diff changeset	3356 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	3357 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	3358 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	3359 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	3360 See \|:command-completion\| for the return string.
28757 add09d468c0d patch 8.2.4903: cannot get the current cmdline completion type and position Bram Moolenaar <Bram@vim.org> parents: 28674 diff changeset	3361 Also see \|getcmdtype()\|, \|setcmdpos()\| and \|getcmdline()\|.
add09d468c0d patch 8.2.4903: cannot get the current cmdline completion type and position Bram Moolenaar <Bram@vim.org> parents: 28674 diff changeset	3362 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	3363
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3364 getcmdline() getcmdline()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3365 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	3366 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	3367 \|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	3368 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3369 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR>
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3370 < Also see \|getcmdtype()\|, \|getcmdpos()\| and \|setcmdpos()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3371 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	3372 \|inputsecret()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3373
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3374 getcmdpos() getcmdpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3375 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	3376 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	3377 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	3378 \|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	3379 Returns 0 otherwise.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3380 Also see \|getcmdtype()\|, \|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	3381
28757 add09d468c0d patch 8.2.4903: cannot get the current cmdline completion type and position Bram Moolenaar <Bram@vim.org> parents: 28674 diff changeset	3382 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	3383 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	3384 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	3385 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	3386 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	3387 \|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	3388 Returns 0 otherwise.
add09d468c0d patch 8.2.4903: cannot get the current cmdline completion type and position Bram Moolenaar <Bram@vim.org> parents: 28674 diff changeset	3389 Also see \|getcmdpos()\|, \|setcmdpos()\|.
add09d468c0d patch 8.2.4903: cannot get the current cmdline completion type and position Bram Moolenaar <Bram@vim.org> parents: 28674 diff changeset	3390
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3391 getcmdtype() getcmdtype()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3392 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	3393 are:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3394 : 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	3395 > 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	3396 / 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	3397 ? 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	3398 @ \|input()\| command
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3399 - \|: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	3400 = \|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	3401 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	3402 \|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	3403 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	3404 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	3405
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3406 getcmdwintype() getcmdwintype()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3407 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	3408 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	3409 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	3410
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3411 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	3412 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	3413 {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	3414 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	3415
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3416 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	3417 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	3418 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	3419 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	3420 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	3421 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	3422 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	3423 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	3424 compiler compilers
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3425 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	3426 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	3427 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	3428 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	3429 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	3430 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	3431 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	3432 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	3433 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	3434 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	3435 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	3436 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	3437 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	3438 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	3439 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	3440 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	3441 menu menus
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3442 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	3443 option options
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3444 packadd optional package \|pack-add\| names
28183 2b595cee4c85 patch 8.2.4617: no completion for :scriptnames Bram Moolenaar <Bram@vim.org> parents: 28166 diff changeset	3445 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	3446 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	3447 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	3448 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	3449 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	3450 tag tags
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3451 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	3452 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	3453 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	3454
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3455 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	3456 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	3457 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	3458
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3459 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	3460 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	3461 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	3462
28166 130f4082a13d patch 8.2.4608: getcompletion() does not work when 'wildoptions' has "fuzzy" Bram Moolenaar <Bram@vim.org> parents: 28141 diff changeset	3463 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	3464 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	3465 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	3466 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	3467 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	3468 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	3469
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3470 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	3471 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	3472 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	3473 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	3474 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3475 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	3476 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	3477
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3478 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3479 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	3480 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3481 getcurpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3482 getcurpos([{winid}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3483 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	3484 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	3485 [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	3486 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	3487 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	3488 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	3489 \|getpos()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3490 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	3491 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	3492 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	3493
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3494 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	3495 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	3496 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	3497 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	3498 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	3499
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3500 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	3501 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	3502 MoveTheCursorAround
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3503 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	3504 < 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	3505 \|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	3506
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3507 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3508 GetWinid()->getcurpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3509 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3510 getcursorcharpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3511 getcursorcharpos([{winid}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3512 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	3513 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	3514
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3515 Example:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3516 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	3517 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	3518 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	3519 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3520 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3521 GetWinid()->getcursorcharpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3522
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3523 < getcwd()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3524 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	3525 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	3526 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	3527
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3528 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	3529 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	3530 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	3531 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	3532 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	3533
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3534 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	3535 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	3536 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	3537 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	3538 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	3539 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	3540 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	3541 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	3542
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3543 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3544 " 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	3545 :echo getcwd()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3546 :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	3547 :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	3548 " 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	3549 :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	3550 " 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	3551 :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	3552 " 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	3553 :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	3554 " 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	3555 :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	3556
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3557 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3558 GetWinnr()->getcwd()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3559
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3560 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	3561 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	3562 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	3563 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	3564
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3565 < 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	3566 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	3567 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	3568 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	3569
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3570 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3571 GetVarname()->getenv()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3572
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3573 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	3574 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	3575 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	3576 \|hl-Normal\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3577 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	3578 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	3579 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	3580 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	3581 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	3582 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	3583 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	3584 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	3585 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	3586
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3587 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	3588 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	3589 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	3590 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	3591 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	3592 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	3593 "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	3594 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	3595 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	3596 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	3597 :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	3598 :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	3599 < 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	3600 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	3601
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3602 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3603 GetFilename()->getfperm()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3604 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3605 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	3606
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3607 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	3608 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	3609 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	3610 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	3611 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	3612 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	3613 is returned.
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 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3616 GetFilename()->getfsize()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3617
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3618 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	3619 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	3620 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	3621 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	3622 \|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	3623 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	3624
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3625 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3626 GetFilename()->getftime()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3627
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3628 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	3629 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	3630 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	3631 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	3632 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	3633 results:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3634 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	3635 Directory "dir"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3636 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	3637 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	3638 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	3639 Socket "socket"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3640 FIFO "fifo"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3641 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	3642 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3643 getftype("/home")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3644 < 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	3645 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	3646 "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	3647 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	3648
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3649 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3650 GetFilename()->getftype()
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 getimstatus() getimstatus()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3653 The result is a Number, which is \|TRUE\| when the IME status is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3654 active.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3655 See 'imstatusfunc'.
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 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	3658 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	3659
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3660 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	3661 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	3662 {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	3663 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	3664 page.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3665
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3666 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	3667 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	3668 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	3669 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	3670 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	3671 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	3672 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	3673 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	3674 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	3675
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3676 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3677 GetWinnr()->getjumplist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3678
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3679 < getline()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3680 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	3681 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	3682 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	3683 getline(1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3684 < 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	3685 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	3686 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	3687 getline(".")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3688 < 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	3689 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	3690
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3691 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	3692 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	3693 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	3694 {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	3695 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	3696 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	3697 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3698 :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	3699 :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	3700 :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	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 ComputeLnum()->getline()
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 < To get lines from another buffer see \|getbufline()\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3706
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3707 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	3708 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	3709 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	3710 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	3711
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3712 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	3713 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	3714 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	3715
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3716 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	3717 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	3718 \|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	3719
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3720 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	3721 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	3722
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3723 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	3724 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	3725 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	3726 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	3727 \|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	3728 details.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3729
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3730 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	3731 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	3732 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	3733
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3734 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	3735 :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	3736 :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	3737
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 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	3740 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	3741 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	3742
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3743 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	3744 local marks defined in 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	3745 see \|bufname()\|.
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 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	3748 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	3749 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	3750 [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	3751 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	3752 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	3753
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3754 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	3755 mark.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3756
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3757 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3758 GetBufnr()->getmarklist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3759
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3760 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	3761 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	3762 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	3763 \|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	3764 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	3765 \|getmatches()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3766 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	3767 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	3768 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3769 :echo getmatches()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3770 < [{'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	3771 '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	3772 '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	3773 :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	3774 :call clearmatches()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3775 :echo getmatches()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3776 < [] >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3777 :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	3778 :echo getmatches()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3779 < [{'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	3780 '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	3781 '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	3782 :unlet m
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3783 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3784 getmousepos() getmousepos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3785 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	3786 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	3787 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	3788 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	3789 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	3790 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	3791 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	3792 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	3793 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	3794 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	3795 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	3796
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3797 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	3798 "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	3799
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3800 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	3801 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	3802 are zero.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3803
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3804 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	3805 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	3806
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3807 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	3808
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3809 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	3810 \|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	3811
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3812 getpid()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3813 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	3814 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	3815 exits.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3816
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3817 getpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3818 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	3819 {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	3820 \|getcurpos()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3821 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	3822 [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	3823 "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	3824 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	3825 "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	3826 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	3827 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	3828 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	3829 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	3830 character.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3831 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	3832 (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	3833 '> 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	3834 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	3835 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	3836 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	3837 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	3838 in which case it means "after the end of 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	3839 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	3840 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	3841 ...
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3842 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	3843 < 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	3844
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3845 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3846 GetMark()->getpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3847
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3848 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	3849 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	3850 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	3851 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	3852 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	3853 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	3854 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	3855 end_lnum
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3856 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	3857 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	3858 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	3859 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	3860 \|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	3861 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	3862 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	3863 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	3864 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	3865 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	3866
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3867 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	3868 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	3869 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	3870 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	3871 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	3872
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3873 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	3874 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	3875 :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	3876 :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	3877 : 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	3878 :endfor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3879 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3880 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	3881 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	3882 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	3883 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	3884 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	3885 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	3886 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	3887 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	3888 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	3889 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	3890 \|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	3891 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	3892 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	3893 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	3894 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	3895 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	3896 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	3897 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	3898 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	3899 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	3900 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	3901 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	3902 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	3903 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	3904 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	3905 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	3906 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	3907 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	3908 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	3909 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	3910 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	3911 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	3912 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	3913 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	3914 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	3915 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	3916 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	3917 "$" 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	3918 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	3919 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	3920 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	3921 "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	3922
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3923 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	3924 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	3925 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	3926 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	3927 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	3928 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	3929 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	3930 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	3931 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	3932 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	3933 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	3934 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	3935 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	3936 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	3937 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	3938 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	3939 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	3940 to "".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3941 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	3942
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3943 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	3944 :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	3945 :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	3946 :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	3947 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3948 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	3949 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	3950 {regname}. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3951 :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	3952 < 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	3953 string.
27537 063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27497 diff changeset	3954 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	3955
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3956 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	3957 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	3958 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	3959 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	3960 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	3961
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3962 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	3963 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	3964 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	3965 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	3966 (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	3967 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	3968
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3969 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	3970 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	3971 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	3972
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3973 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3974 GetRegname()->getreg()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3975
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3976 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	3977 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	3978 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	3979 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	3980 {regname}, like
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3981 \|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	3982 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	3983 \|getregtype()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3984 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	3985 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	3986 register.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3987 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	3988 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	3989 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	3990 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	3991 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	3992 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	3993 deleted text.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3994
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	3995 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	3996 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	3997 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	3998 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	3999 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	4000 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	4001
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4002 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4003 GetRegname()->getreginfo()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4004
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4005 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	4006 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	4007 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	4008 "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	4009 "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	4010 "<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	4011 "" 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	4012 <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	4013 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	4014 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	4015 \|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	4016 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	4017
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4018 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4019 GetRegname()->getregtype()
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 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	4022 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	4023 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	4024 \|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	4025 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	4026 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	4027
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4028 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	4029 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	4030 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	4031 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	4032 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	4033
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4034 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4035 GetTabnr()->gettabinfo()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4036
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4037 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	4038 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	4039 {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	4040 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	4041 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	4042 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	4043 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	4044 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	4045 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	4046
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4047 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4048 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	4049
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4050 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	4051 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	4052 {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	4053 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	4054 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	4055 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	4056 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	4057 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	4058 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	4059 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	4060 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	4061 use \|getwinvar()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4062 {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	4063 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	4064 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	4065 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	4066 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	4067 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	4068 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	4069 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4070 :let list_is_on = gettabwinvar(1, 2, '&list')
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	4071 :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	4072 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4073 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	4074 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	4075
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4076 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4077 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	4078
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4079 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	4080 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	4081 {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	4082 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	4083 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	4084
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4085 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	4086 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	4087 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	4088 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	4089 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	4090 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	4091 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	4092 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	4093
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4094 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	4095 entries:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4096 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	4097 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	4098 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	4099 returned list.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4100 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	4101 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	4102 name.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4103 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	4104
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4105 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	4106
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4107 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4108 GetWinnr()->gettagstack()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4109
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4110
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4111 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	4112 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	4113 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	4114 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	4115 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	4116 .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	4117 called.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4118 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	4119 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	4120 strings.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4121
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4122
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4123 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	4124 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	4125
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4126 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	4127 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	4128 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	4129
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4130 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	4131 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	4132
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4133 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	4134 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	4135 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	4136 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	4137 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	4138 {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	4139 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	4140 {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	4141 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	4142 {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	4143 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	4144 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	4145 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	4146 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	4147 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	4148 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	4149 otherwise
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4150 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	4151 "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	4152 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	4153 '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	4154 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	4155 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	4156 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	4157 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	4158 "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	4159
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4160 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4161 GetWinnr()->getwininfo()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4162
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4163 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	4164 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	4165 \|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	4166 [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	4167 {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	4168 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	4169 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	4170 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	4171 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	4172 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	4173 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	4174 while 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4175 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	4176 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	4177 break
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4178 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4179 " 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	4180 endwhile
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4181 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4182
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4183 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4184 GetTimeout()->getwinpos()
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 getwinposx()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4187 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	4188 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	4189 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	4190 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	4191 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	4192
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4193 getwinposy()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4194 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	4195 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	4196 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	4197 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	4198 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	4199
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4200 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	4201 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	4202 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4203 :let list_is_on = getwinvar(2, '&list')
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	4204 :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	4205
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4206 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4207 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	4208 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4209 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	4210 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	4211 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	4212
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4213 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	4214 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	4215 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	4216 '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	4217 '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	4218
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4219 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	4220 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	4221 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	4222 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	4223 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	4224
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4225 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	4226
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4227 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	4228 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	4229
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4230 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	4231 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	4232 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	4233 \|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	4234
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4235 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	4236 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	4237 :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	4238 :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	4239 < 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	4240 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	4241
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4242 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	4243 \|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	4244
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4245 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4246 GetExpr()->glob()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4247
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4248 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	4249 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	4250 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	4251 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	4252 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	4253 < 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	4254 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	4255 < 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	4256 empty string.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4257 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	4258 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	4259
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4260 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4261 GetExpr()->glob2regpat()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4262 < globpath()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4263 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	4264 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	4265 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	4266 :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	4267 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4268 {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	4269 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	4270 \|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	4271 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	4272 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	4273 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	4274 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	4275 error message.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4276
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4277 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	4278 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	4279 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	4280 '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	4281
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4282 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	4283 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	4284 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	4285 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	4286 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	4287 :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	4288 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4289 {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	4290
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4291 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	4292 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	4293 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	4294 :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	4295 < 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	4296 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	4297
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4298 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	4299 second argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4300 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	4301 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4302 has()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4303 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	4304 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	4305 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	4306 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	4307 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	4308
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4309 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	4310 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	4311 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	4312 {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	4313 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	4314 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	4315 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	4316
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4317 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	4318
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4319 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	4320 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	4321 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	4322 separate line: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4323 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	4324 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	4325 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4326 < 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	4327 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	4328
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4329
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4330 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	4331 The result is a Number, which is TRUE if \|Dictionary\| {dict}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4332 has an entry with key {key}. FALSE otherwise. The {key}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4333 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	4334
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4335 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4336 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	4337
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4338 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	4339 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	4340 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	4341 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	4342 0 otherwise.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4343
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4344 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	4345 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	4346 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	4347 page.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4348 {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	4349 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	4350 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	4351 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4352 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	4353 " 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	4354 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	4355 " 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	4356 else
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4357 " 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	4358 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4359
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4360 " current window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4361 :echo haslocaldir()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4362 :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	4363 :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	4364 " 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	4365 :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	4366 :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	4367 " 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	4368 :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	4369 " 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	4370 :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	4371 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4372 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4373 GetWinnr()->haslocaldir()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4374
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4375 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	4376 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	4377 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	4378 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	4379 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	4380 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	4381 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	4382 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	4383 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	4384 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	4385 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	4386 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	4387 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	4388 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	4389 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	4390 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	4391 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	4392 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	4393 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	4394 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	4395 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	4396 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	4397
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4398 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	4399 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	4400 :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	4401 : 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	4402 :endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4403 < 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	4404 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	4405
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4406 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4407 GetRHS()->hasmapto()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4408
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4409 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	4410 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	4411 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	4412 "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	4413 "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	4414 "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	4415 "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	4416 "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	4417 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	4418 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	4419 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	4420 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	4421 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	4422 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	4423 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	4424
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4425 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4426 :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	4427 :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	4428 < 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	4429
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4430 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	4431 second argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4432 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	4433
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4434 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	4435 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	4436 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	4437
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4438 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	4439 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	4440 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	4441 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	4442 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	4443 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	4444 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	4445
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4446 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	4447 is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4448
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4449 Examples:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4450 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	4451 :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	4452 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4453 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	4454 :call histdel("/", '^\*')
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 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	4457 :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	4458 :call histdel("search", -1)
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	4459 :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	4460 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4461 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	4462 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	4463 :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	4464 :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	4465 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4466 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4467 GetHistory()->histdel()
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 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	4470 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	4471 {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	4472 {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	4473 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	4474 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	4475
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4476 Examples:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4477 Redo the second last search from history. >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	4478 :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	4479
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4480 < 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	4481 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	4482 :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	4483 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4484 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4485 GetHistory()->histget()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4486
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4487 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	4488 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	4489 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	4490 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	4491
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4492 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4493 :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	4494
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4495 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4496 GetHistory()->histnr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4497 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4498 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	4499 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	4500 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	4501 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	4502 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	4503 item.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4504 highlight_exists()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4505 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	4506
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4507 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4508 GetName()->hlexists()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4509 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4510 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	4511 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	4512 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	4513 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	4514 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	4515
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4516 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	4517 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	4518 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	4519 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	4520
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4521 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	4522 following items:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4523 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	4524 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	4525 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	4526 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	4527 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	4528 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	4529 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	4530 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	4531 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	4532 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	4533 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	4534 \|highlight-default\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4535 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	4536 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	4537 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	4538 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	4539 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	4540 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	4541 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	4542 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	4543 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	4544 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	4545 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	4546 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	4547
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4548 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	4549 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	4550 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	4551 '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	4552
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4553 Example(s): >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4554 :echo hlget()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4555 :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	4556 :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	4557 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4558 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4559 GetName()->hlget()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4560 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4561 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	4562 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	4563 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	4564 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	4565 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	4566
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4567 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	4568 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	4569
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4570 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	4571 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	4572 with attributes.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4573
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4574 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	4575 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	4576 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	4577 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	4578 modified.
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 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	4581 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	4582 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	4583 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	4584
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4585 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	4586 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	4587
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4588 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	4589
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4590 Example(s): >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4591 " 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	4592 :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	4593 \ 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	4594 :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	4595 :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	4596 :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	4597 " 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	4598 :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	4599 " 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	4600 :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	4601 " 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	4602 :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	4603 " 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	4604 :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	4605 " 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	4606 :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	4607 \ linksto: 'NONE'}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4608 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4609 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4610 GetAttrList()->hlset()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4611 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4612 hlID()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4613 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	4614 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	4615 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	4616 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	4617 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	4618 "Comment" group: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4619 :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	4620 < highlightID()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4621 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	4622
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4623 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4624 GetName()->hlID()
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 hostname() hostname()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4627 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	4628 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	4629 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	4630
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4631 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	4632 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	4633 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	4634 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	4635 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	4636 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	4637 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	4638 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	4639 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	4640 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	4641 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	4642 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	4643 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	4644 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	4645 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	4646 < 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	4647 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	4648 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	4649
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4650 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4651 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	4652 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4653 indent()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4654 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	4655 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	4656 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	4657 \|getline()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4658 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	4659 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	4660
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4661 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4662 GetLnum()->indent()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4663
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4664 index({object}, {expr} [, {start} [, {ic}]]) index()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4665 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	4666 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	4667 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	4668 And the number 4 is different from the Float 4.0. The value
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4669 of 'ignorecase' is not used here, case always matters.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4670
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4671 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	4672 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	4673
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4674 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	4675 {start} (may be negative for an item relative 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	4676 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	4677 case must match.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4678 -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	4679 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4680 :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	4681 :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	4682
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4683 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4684 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	4685
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4686 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	4687 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	4688 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	4689 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	4690 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	4691 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	4692 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	4693 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	4694 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	4695 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4696 :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	4697 : echo "Cheers!"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4698 :endif
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 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	4701 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	4702 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4703 :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	4704
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4705 < 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	4706 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	4707 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	4708 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	4709 "-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	4710 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	4711 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	4712 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4713 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	4714 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	4715 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	4716 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	4717 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	4718 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	4719 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	4720 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	4721 \|: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	4722
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4723 Example with a mapping: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	4724 :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	4725 :function GetFoo()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4726 : call inputsave()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4727 : 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	4728 : call inputrestore()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4729 :endfunction
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4730
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4731 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4732 GetPrompt()->input()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4733
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4734 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	4735 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	4736 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	4737 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4738 :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	4739 :if n != ""
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4740 : 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	4741 :endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4742 < 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	4743 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	4744 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	4745 <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	4746 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	4747
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4748 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4749 GetPrompt()->inputdialog()
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 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	4752 {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	4753 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	4754 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	4755 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	4756 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	4757 "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	4758 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	4759 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	4760 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	4761 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	4762 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	4763 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	4764 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4765 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	4766 \ '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	4767
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4768 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4769 GetChoices()->inputlist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4770
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4771 inputrestore() inputrestore()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4772 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	4773 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	4774 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	4775 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	4776
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4777 inputsave() inputsave()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4778 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	4779 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	4780 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	4781 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	4782 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	4783 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	4784
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4785 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	4786 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	4787 two exceptions:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4788 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	4789 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	4790 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	4791 \|history\| stack.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4792 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	4793 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	4794 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	4795
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4796 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4797 GetPrompt()->inputsecret()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4798
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4799 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	4800 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	4801 of it.
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 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	4804 {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	4805 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	4806 \|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	4807
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4808 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	4809 :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	4810 :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	4811 :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	4812 < 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	4813 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	4814 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	4815
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4816 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4817 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	4818
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4819 interrupt() interrupt()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4820 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	4821 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	4822 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	4823 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	4824 :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	4825 : 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	4826 : 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	4827 : call interrupt()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4828 : endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4829 :endfunction
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4830 :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	4831
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4832 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	4833 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	4834 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	4835 :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	4836 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4837 :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	4838
28629 5ef46b938c6e patch 8.2.4838: checking for absolute path is not trivial Bram Moolenaar <Bram@vim.org> parents: 28620 diff changeset	4839 isabsolutepath({directory}) isabsolutepath()
5ef46b938c6e patch 8.2.4838: checking for absolute path is not trivial Bram Moolenaar <Bram@vim.org> parents: 28620 diff changeset	4840 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	4841 absolute path.
5ef46b938c6e patch 8.2.4838: checking for absolute path is not trivial Bram Moolenaar <Bram@vim.org> parents: 28620 diff changeset	4842 < On Unix, a path is considered absolute when it starts with '/'.
5ef46b938c6e patch 8.2.4838: checking for absolute path is not trivial Bram Moolenaar <Bram@vim.org> parents: 28620 diff changeset	4843 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	4844 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	4845 are always absolute.
5ef46b938c6e patch 8.2.4838: checking for absolute path is not trivial Bram Moolenaar <Bram@vim.org> parents: 28620 diff changeset	4846 Example: >
5ef46b938c6e patch 8.2.4838: checking for absolute path is not trivial Bram Moolenaar <Bram@vim.org> parents: 28620 diff changeset	4847 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	4848 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	4849 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	4850 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	4851 echo isabsolutepath('\\remote\file') " 1
5ef46b938c6e patch 8.2.4838: checking for absolute path is not trivial Bram Moolenaar <Bram@vim.org> parents: 28620 diff changeset	4852
5ef46b938c6e patch 8.2.4838: checking for absolute path is not trivial Bram Moolenaar <Bram@vim.org> parents: 28620 diff changeset	4853 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	4854 GetName()->isabsolutepath()
5ef46b938c6e patch 8.2.4838: checking for absolute path is not trivial Bram Moolenaar <Bram@vim.org> parents: 28620 diff changeset	4855
5ef46b938c6e patch 8.2.4838: checking for absolute path is not trivial Bram Moolenaar <Bram@vim.org> parents: 28620 diff changeset	4856
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4857 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	4858 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	4859 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	4860 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	4861 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	4862
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4863 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4864 GetName()->isdirectory()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4865
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4866 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	4867 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	4868 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	4869 :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	4870 < 1 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4871 :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	4872 < -1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4873
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4874 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4875 Compute()->isinf()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4876 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4877 {only available when compiled with the \|+float\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4878
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4879 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	4880 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	4881 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	4882 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	4883 \|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	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 :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	4886 :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	4887 :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	4888 :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	4889
27623 179c118424a6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27537 diff changeset	4890 < 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	4891 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	4892 range or does not exist you get an error message. Use
179c118424a6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27537 diff changeset	4893 \|exists()\| to check for existence.
179c118424a6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27537 diff changeset	4894 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	4895
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4896 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4897 GetName()->islocked()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4898
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4899 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	4900 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	4901 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	4902 < 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4903
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4904 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4905 Compute()->isnan()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4906 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4907 {only available when compiled with the \|+float\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4908
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4909 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	4910 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	4911 \|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	4912 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	4913 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	4914 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4915 for [key, value] in items(mydict)
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	4916 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	4917 endfor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4918
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4919 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4920 mydict->items()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4921
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4922 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	4923
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4924
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4925 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	4926 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	4927 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	4928 {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	4929 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	4930 add it there too: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	4931 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	4932 < 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	4933 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	4934 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	4935
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4936 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4937 mylist->join()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4938
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4939 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	4940 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	4941 - 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	4942 - 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	4943 - 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	4944 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	4945
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4946 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4947 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	4948
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4949 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	4950 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	4951 - 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	4952 - 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	4953 commas.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4954 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	4955 [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	4956 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	4957 [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	4958 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	4959 [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	4960 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	4961 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	4962
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4963 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4964 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	4965
27036 3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26901 diff changeset	4966 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	4967 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	4968 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	4969 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	4970 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	4971 - 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	4972 "[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	4973 - 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	4974 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	4975 - 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	4976 "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	4977 "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	4978 are accepted.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4979 - 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	4980 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	4981 - 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	4982 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	4983 - 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	4984 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	4985 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	4986 - 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	4987 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	4988 - 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	4989 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	4990 - 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	4991 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	4992 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	4993 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	4994 E938
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4995 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	4996 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	4997 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	4998
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	4999 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5000 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	5001
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5002 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	5003 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	5004 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	5005 https://tools.ietf.org/html/rfc7159.html
27537 063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27497 diff changeset	5006 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	5007 \|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	5008 \|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	5009 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	5010 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	5011 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	5012 \|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	5013 \|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	5014 \|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	5015 used recursively: []
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5016 \|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	5017 used recursively: {}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5018 \|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	5019 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	5020 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	5021 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	5022 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	5023 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	5024 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	5025 allow it. If not then you will get an error.
28379 6dd88e45d47d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28307 diff changeset	5026 If a string contains an illegal character then the replacement
6dd88e45d47d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28307 diff changeset	5027 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	5028
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5029 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5030 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	5031
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5032 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	5033 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	5034 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	5035
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5036 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5037 mydict->keys()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5038
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5039 < len() E701
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5040 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	5041 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	5042 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	5043 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	5044 returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5045 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	5046 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	5047 \|Dictionary\| is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5048 Otherwise 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	5049
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5050 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5051 mylist->len()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5052
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5053 < 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	5054 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	5055 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	5056 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	5057 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	5058 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	5059 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	5060 limited.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5061 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	5062 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	5063 to Vim.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5064 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	5065 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	5066 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	5067 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	5068 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	5069
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5070 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	5071 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	5072 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	5073 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	5074
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5075 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	5076 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	5077 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	5078 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	5079 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	5080 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	5081 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	5082 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	5083 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	5084 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	5085
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5086 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	5087 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	5088 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	5089 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	5090 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	5091 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	5092 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	5093 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	5094 {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	5095 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	5096 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5097 :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	5098
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5099 < 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	5100 third argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5101 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	5102 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5103 libcallnr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5104 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	5105 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	5106 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	5107 {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	5108 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	5109 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5110 :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	5111 :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	5112 :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	5113 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5114 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	5115 third argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5116 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	5117 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5118
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5119 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	5120 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	5121 position given with {expr}. The {expr} argument is a string.
27537 063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27497 diff changeset	5122 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	5123 . 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	5124 $ 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	5125 '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	5126 returned)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5127 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	5128 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	5129 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	5130 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	5131 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	5132 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	5133 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	5134 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	5135 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	5136 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	5137 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	5138 \|getpos()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5139 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	5140 that window 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	5141 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5142 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	5143 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	5144 line("'t") line number of mark t
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	5145 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	5146 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5147 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	5148 \|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	5149
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5150 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5151 GetValue()->line()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5152
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5153 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	5154 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	5155 {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	5156 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	5157 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	5158 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	5159 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	5160 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	5161 < 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	5162 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	5163 \|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	5164 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	5165 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	5166
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5167 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5168 GetLnum()->line2byte()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5169
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5170 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	5171 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	5172 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	5173 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	5174 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	5175 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	5176 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	5177
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5178 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5179 GetLnum()->lispindent()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5180
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5181 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	5182 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	5183 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5184 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	5185 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	5186 < 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	5187 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	5188
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5189 \|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	5190
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5191 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5192 GetList()->list2blob()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5193
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5194 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	5195 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	5196 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	5197 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	5198 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	5199 < 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	5200 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	5201 < \|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	5202
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5203 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	5204 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	5205 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	5206 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	5207 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5208 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5209 GetList()->list2str()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5210
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5211 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	5212 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	5213 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	5214 {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	5215 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	5216 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	5217 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	5218
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5219 The {callback} is invoked with five arguments:
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	5220 bufnr the buffer that was changed
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	5221 start first changed line number
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	5222 end first line number below the change
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	5223 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	5224 deleted
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	5225 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	5226
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5227 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5228 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	5229 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	5230 endfunc
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5231 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	5232
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	5233 < 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	5234 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	5235 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	5236 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	5237 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	5238 deleted
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5239 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	5240 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	5241 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	5242 character has a value of one.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5243 When lines are inserted 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	5244 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	5245 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	5246 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	5247 col 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5248 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	5249 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	5250 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	5251 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	5252 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	5253 col 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5254 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	5255 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	5256 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	5257 added 0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5258 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	5259
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5260 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	5261 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	5262 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	5263 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	5264
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5265 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	5266 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	5267 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	5268 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	5269
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5270 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	5271 \|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	5272 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	5273
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5274 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	5275 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	5276 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	5277 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	5278 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	5279
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5280 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	5281 second argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5282 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	5283
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5284 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	5285 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	5286 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	5287
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5288 {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	5289 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	5290 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	5291
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5292 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5293 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	5294
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5295 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	5296 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	5297 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	5298 removed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5299
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5300 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5301 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	5302
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5303 localtime() localtime()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5304 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	5305 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	5306
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5307
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5308 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	5309 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	5310 {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	5311 (0, inf].
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5312 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5313 :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	5314 < 2.302585 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5315 :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	5316 < 5.0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5317
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5318 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5319 Compute()->log()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5320 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5321 {only available when compiled with the \|+float\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5322
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5323
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5324 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	5325 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	5326 {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	5327 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5328 :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	5329 < 3.0 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5330 :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	5331 < -2.0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5332
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5333 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5334 Compute()->log10()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5335 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5336 {only available when compiled with the \|+float\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5337
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5338 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	5339 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	5340 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	5341 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	5342 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	5343 Boolean objects are converted to numbers.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5344 Numbers are converted to \|Float\| values if vim was compiled
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5345 with \|+float\| and to numbers otherwise.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5346 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	5347 as-is.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5348 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	5349 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	5350 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	5351 to {expr}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5352
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5353 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5354 GetExpr()->luaeval()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5355
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5356 < {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	5357
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5358 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	5359 {expr1} must be a \|List\|, \|String\|, \|Blob\| or \|Dictionary\|.
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	5360 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	5361 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	5362 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	5363 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	5364 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	5365 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	5366 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	5367 Vim9 script.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5368
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5369 {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	5370
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5371 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	5372 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	5373 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	5374 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	5375 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	5376 current character.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5377 Example: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	5378 :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	5379 < 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	5380
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5381 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	5382 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	5383 \|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	5384 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	5385
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5386 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	5387 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	5388 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	5389 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	5390 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	5391 func KeyValue(key, val)
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	5392 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	5393 endfunc
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5394 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	5395 < It is shorter when using a \|lambda\|: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	5396 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	5397 < 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	5398 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	5399 < 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	5400 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	5401 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5402 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	5403 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	5404 :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	5405
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5406 < 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	5407 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	5408 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	5409 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	5410 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	5411 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	5412
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5413 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5414 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	5415
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 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	5418 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	5419 {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	5420 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	5421 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	5422 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	5423
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5424 When there is no mapping for {name}, 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	5425 returned. When the mapping for {name} is empty, then "<Nop>"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5426 is returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5427
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5428 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	5429 command.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5430
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5431 {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	5432 "n" Normal
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5433 "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	5434 "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	5435 "i" Insert
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5436 "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	5437 "s" Select
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5438 "x" Visual
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5439 "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	5440 "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	5441 "" 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	5442 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	5443
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5444 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	5445 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	5446
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5447 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	5448 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	5449 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	5450 "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	5451 "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	5452 "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	5453 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	5454 "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	5455 "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	5456 "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	5457 "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	5458 "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	5459 "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	5460 "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	5461 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	5462 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	5463 " " 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	5464 "!" 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	5465 (\|mapmode-ic\|)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5466 "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	5467 (\|<SID>\|).
27223 ea2b4cb4515b patch 8.2.4140: maparg() does not indicate the type of script Bram Moolenaar <Bram@vim.org> parents: 27162 diff changeset	5468 "scriptversion" The version of the script. 999999 for
28933 57c9377b9c62 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 28917 diff changeset	5469 \|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	5470 "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	5471 "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	5472 (\|:map-<nowait>\|).
28808 0f0fed554cdc Update runtime files, translations Bram Moolenaar <Bram@vim.org> parents: 28777 diff changeset	5473 "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	5474 "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	5475 \|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	5476 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	5477 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	5478
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5479 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	5480 \|mapset()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5481
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5482 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	5483 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	5484 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	5485 mapped, and have it do the original mapping too. Sketch: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	5486 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	5487
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5488 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5489 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	5490
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5491 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	5492 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	5493 {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	5494 {name}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5495 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	5496 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	5497 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	5498 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	5499
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5500 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	5501 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	5502 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	5503 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	5504 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	5505
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5506 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	5507 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	5508 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	5509 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	5510 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	5511 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	5512 {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	5513 "<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	5514 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	5515 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	5516 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	5517 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	5518 :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	5519 : 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	5520 :endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5521 < 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	5522 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	5523
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5524 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5525 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	5526
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5527
28602 398c5b3211f9 patch 8.2.4825: can only get a list of mappings Bram Moolenaar <Bram@vim.org> parents: 28592 diff changeset	5528 maplist([{abbr}]) maplist()
398c5b3211f9 patch 8.2.4825: can only get a list of mappings Bram Moolenaar <Bram@vim.org> parents: 28592 diff changeset	5529 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	5530 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	5531 \|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	5532 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	5533
398c5b3211f9 patch 8.2.4825: can only get a list of mappings Bram Moolenaar <Bram@vim.org> parents: 28592 diff changeset	5534 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	5535 vim9script
398c5b3211f9 patch 8.2.4825: can only get a list of mappings Bram Moolenaar <Bram@vim.org> parents: 28592 diff changeset	5536 echo maplist()->filter(
398c5b3211f9 patch 8.2.4825: can only get a list of mappings Bram Moolenaar <Bram@vim.org> parents: 28592 diff changeset	5537 (_, 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	5538 < 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	5539 \|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	5540 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	5541 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	5542 can do: >
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5543 vim9script
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5544 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	5545 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	5546 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	5547 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	5548 endif
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5549 endfor
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5550 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	5551 < 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	5552 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	5553 \|: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	5554 vim9script
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5555 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	5556 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	5557 (_, 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	5558 ounmap xyzzy
1ad71fcbf546 patch 8.2.4932: not easy to filter the output of maplist() Bram Moolenaar <Bram@vim.org> parents: 28808 diff changeset	5559 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	5560
398c5b3211f9 patch 8.2.4825: can only get a list of mappings Bram Moolenaar <Bram@vim.org> parents: 28592 diff changeset	5561
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5562 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	5563 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	5564 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	5565 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	5566 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	5567
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 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	5570 mapset({dict})
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5571 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	5572 \|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	5573 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	5574 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	5575 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	5576 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	5577 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	5578 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	5579
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5580 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	5581 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	5582 {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	5583 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	5584 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	5585 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	5586 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	5587 ...
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5588 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	5589 < 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	5590 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	5591 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	5592
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5593 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	5594 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	5595 Example: >
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5596 vim9script
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5597 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	5598 (_, 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	5599 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	5600 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	5601 # ...
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5602 unmap K
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5603 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	5604 mapset(d)
38f7a132bba3 patch 8.2.4861: it is not easy to restore saved mappings Bram Moolenaar <Bram@vim.org> parents: 28672 diff changeset	5605 endfor
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5606
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 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	5609 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	5610 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	5611 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	5612
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5613 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	5614 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	5615 {pat} matches.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5616
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5617 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	5618 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	5619
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5620 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	5621 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5622 :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	5623 :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	5624 < 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	5625 strpbrk()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5626 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	5627 :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	5628 < strcasestr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5629 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	5630 "\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	5631 :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	5632 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5633 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	5634 {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	5635 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	5636 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	5637 :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	5638 < 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	5639 :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	5640 < 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	5641 :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	5642 < 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	5643 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	5644 {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	5645 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	5646 {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	5647 backwards compatible).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5648 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	5649 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	5650 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	5651 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	5652
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5653 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	5654 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	5655 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	5656 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	5657 < 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	5658 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	5659 see above.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5660
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5661 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	5662 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	5663 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	5664 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	5665 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	5666 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	5667 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	5668 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	5669
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5670 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5671 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	5672 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	5673 <
27036 3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26901 diff changeset	5674 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	5675 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	5676 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	5677 "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	5678 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	5679 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	5680 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	5681 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	5682 '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	5683 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	5684 concealed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5685
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5686 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	5687 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	5688 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	5689 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	5690 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	5691 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	5692 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	5693 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	5694 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	5695 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	5696
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5697 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	5698 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	5699 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	5700 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	5701 and 3 are reserved for \|:match\|, \|:2match\| and \|:3match\|,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5702 respectively. If the {id} argument is not specified or -1,
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5703 \|matchadd()\| automatically chooses a free ID.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5704
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5705 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	5706 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	5707 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	5708 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	5709
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5710 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	5711 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	5712 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	5713 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	5714 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	5715
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5716 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	5717 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	5718
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5719 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5720 :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	5721 :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	5722 < 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	5723 :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	5724
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5725 < 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	5726 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	5727 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	5728
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5729 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5730 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	5731 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5732 matchaddpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5733 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	5734 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	5735 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	5736 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	5737 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	5738 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	5739 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	5740
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5741 {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	5742 these:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5743 - 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	5744 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	5745 - 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	5746 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	5747 - 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	5748 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	5749 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	5750 \|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	5751 be highlighted.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5752 - 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	5753 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	5754
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5755 The maximum number of positions in {pos} is 8.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5756
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5757 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5758 :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	5759 :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	5760 < 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	5761 :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	5762
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5763 < 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	5764 \|getmatches()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5765
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5766 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5767 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	5768
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5769 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	5770 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	5771 \|: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	5772 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	5773 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	5774 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	5775 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	5776 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	5777 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	5778 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	5779 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	5780
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5781 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5782 GetMatch()->matcharg()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5783
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5784 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	5785 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	5786 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	5787 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	5788 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	5789 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	5790 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	5791
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5792 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5793 GetMatch()->matchdelete()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5794
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5795 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	5796 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	5797 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	5798 :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	5799 < 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	5800 strspn() strcspn()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5801 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	5802 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	5803 :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	5804 :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	5805 < 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	5806
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5807 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	5808 :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	5809 < 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	5810 :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	5811 < 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	5812 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	5813
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5814 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5815 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	5816
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5817
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5818 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	5819 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	5820 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	5821 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	5822
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5823 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	5824 items:
28831 b5c46d447518 patch 8.2.4939: matchfuzzypos() with "matchseq" does not have all positions Bram Moolenaar <Bram@vim.org> parents: 28817 diff changeset	5825 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	5826 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	5827 given sequence.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5828
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5829 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	5830 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	5831 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	5832 {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	5833 string.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5834 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	5835 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	5836 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	5837 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	5838 use for fuzzy matching.
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	5839 limit Maximum number of matches in {list} to be
2ade724b3f45 patch 8.2.4760: using matchfuzzy() on a long list can take a while Bram Moolenaar <Bram@vim.org> parents: 28431 diff changeset	5840 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	5841
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5842 {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	5843 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	5844 is 256.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5845
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5846 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	5847 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	5848
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5849 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	5850 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	5851 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	5852
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	5853 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	5854 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	5855
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	5856 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	5857 matching strings.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5858
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5859 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5860 :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	5861 < 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	5862 :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	5863 < 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	5864 :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	5865 < 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	5866 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	5867 :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	5868 \ {'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	5869 < 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	5870 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	5871 :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	5872 < 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	5873 :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	5874 < 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	5875 :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	5876 < 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	5877 :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	5878 \ {'matchseq': 1})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5879 < 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	5880
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5881 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	5882 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	5883 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	5884 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	5885 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	5886 position.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5887
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5888 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	5889 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	5890
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5891 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	5892 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	5893
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5894 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5895 :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	5896 < 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	5897 :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	5898 < 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	5899 :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	5900 < 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	5901
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5902 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	5903 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	5904 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	5905 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	5906 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	5907 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	5908 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	5909 < 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	5910 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	5911
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5912 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	5913
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5914 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5915 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	5916
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5917 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	5918 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	5919 :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	5920 < 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	5921 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	5922 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	5923 :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	5924 < 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	5925 :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	5926 < result is "".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5927 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	5928 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	5929
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5930 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5931 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	5932
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5933 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	5934 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	5935 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	5936 :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	5937 < 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	5938 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	5939 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	5940 :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	5941 < 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	5942 :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	5943 < 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	5944 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	5945 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	5946 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	5947 :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	5948 < 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	5949 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	5950
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5951 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5952 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	5953 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5954
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5955 max()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5956 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	5957 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	5958
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5959 < {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	5960 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	5961 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	5962 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	5963 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	5964
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5965 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5966 mylist->max()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5967
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5968
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5969 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	5970 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	5971 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	5972 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	5973 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	5974
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5975 {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	5976 "n" Normal
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5977 "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	5978 "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	5979 "i" Insert
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5980 "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	5981 "s" Select
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5982 "x" Visual
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5983 "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	5984 "" 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	5985 "!" 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	5986 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	5987
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5988 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	5989 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	5990 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	5991 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	5992 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	5993 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	5994 \|toolbar-icon\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	5995 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	5996 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	5997 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	5998 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	5999 " " 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	6000 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	6001 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	6002 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	6003 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	6004 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	6005 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	6006 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	6007 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	6008 "<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	6009 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	6010 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	6011 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	6012 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	6013 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	6014 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	6015 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	6016 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	6017 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	6018
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6019 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	6020
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6021 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6022 :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	6023 :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	6024
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6025 " 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	6026 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	6027 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	6028 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	6029 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	6030 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	6031 \ a:pfx .. ' ')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6032 endfor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6033 endfunc
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6034 new
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6035 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	6036 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	6037 endfor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6038 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6039 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6040 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	6041
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6042
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6043 < min()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6044 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	6045 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	6046
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6047 < {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	6048 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	6049 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	6050 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	6051 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	6052
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6053 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6054 mylist->min()
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 < mkdir() E739
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6057 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	6058 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	6059
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6060 If {path} is "p" then intermediate directories are created as
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6061 necessary. Otherwise it must be "".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6062
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6063 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	6064 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	6065 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	6066 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	6067 {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	6068 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	6069 Example: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	6070 :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	6071
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6072 < 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	6073
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6074 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	6075 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	6076 "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	6077
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6078 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	6079 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	6080 failed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6081
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6082 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	6083 :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	6084
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6085 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6086 GetName()->mkdir()
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 mode()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6089 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	6090 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	6091 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	6092 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	6093 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	6094
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6095 n Normal
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6096 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	6097 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	6098 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	6099 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	6100 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	6101 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	6102 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	6103 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	6104 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	6105 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	6106 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	6107 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	6108 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	6109 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	6110 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	6111 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	6112 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	6113 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	6114 i Insert
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6115 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	6116 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	6117 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	6118 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	6119 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	6120 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	6121 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	6122 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	6123 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	6124 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	6125 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	6126 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	6127 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	6128 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	6129 ! 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	6130 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	6131
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6132 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	6133 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	6134 "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	6135 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	6136 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	6137 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	6138 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	6139
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6140 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6141 DoFull()->mode()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6142
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6143 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	6144 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	6145 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	6146 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	6147 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	6148 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	6149 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	6150 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	6151 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	6152 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6153 :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	6154 :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	6155 :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	6156 :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	6157 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6158 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	6159 to {expr}.
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 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6162 GetExpr()->mzeval()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6163 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6164 {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	6165
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6166 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	6167 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	6168 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	6169 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	6170 < 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	6171 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	6172 {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	6173 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	6174
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6175 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6176 GetLnum()->nextnonblank()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6177
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6178 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	6179 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	6180 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	6181 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	6182 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	6183 < 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	6184 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	6185 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	6186 < 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	6187 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	6188 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	6189 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	6190 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	6191 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	6192 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	6193 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	6194 < Result: "ABC"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6195
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6196 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6197 GetNumber()->nr2char()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6198
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6199 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	6200 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	6201 to a number. A List, Dict or Float argument causes an error.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6202 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6203 :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	6204 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6205 :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	6206
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6207
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6208 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	6209 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	6210 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	6211 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	6212 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	6213 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	6214 :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	6215 < ~/.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	6216 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6217 :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	6218 < ~/.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	6219 It doesn't matter if the path exists or not.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6220
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6221 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6222 GetDirectories()->pathshorten()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6223
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6224 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	6225 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	6226 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	6227 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	6228 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	6229 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	6230 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6231 :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	6232 < [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	6233
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6234 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	6235 to {expr}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6236
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6237 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6238 GetExpr()->perleval()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6239
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6240 < {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	6241
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6242
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6243 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	6244
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 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	6247 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	6248 {x} and {y} 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	6249 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6250 :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	6251 < 27.0 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6252 :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	6253 < 65536.0 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6254 :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	6255 < 2.0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6256
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6257 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6258 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	6259 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6260 {only available when compiled with the \|+float\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6261
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6262 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	6263 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	6264 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	6265 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	6266 < 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	6267 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	6268 {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	6269 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	6270
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6271 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6272 GetLnum()->prevnonblank()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6273
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6274 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	6275 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	6276 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	6277 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	6278 < 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	6279 " 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	6280
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6281 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	6282 argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6283 Compute()->printf("result: %d")
28379 6dd88e45d47d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28307 diff changeset	6284 <
6dd88e45d47d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28307 diff changeset	6285 You can use `call()` to pass the items as a list.
6dd88e45d47d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28307 diff changeset	6286
6dd88e45d47d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28307 diff changeset	6287 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	6288 %s string
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6289 %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	6290 %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	6291 %.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	6292 %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	6293 %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	6294 %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	6295 %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	6296 %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	6297 %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	6298 %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	6299 %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	6300 %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	6301 %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	6302 %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	6303 %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	6304 %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	6305 %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	6306 %% 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	6307
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6308 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	6309 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	6310 the result.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6311
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6312 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	6313 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	6314
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6315 % [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	6316
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6317 flags
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6318 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	6319
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6320 # 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	6321 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	6322 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	6323 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	6324 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	6325 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	6326 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	6327 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	6328 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	6329 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	6330 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	6331 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	6332 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	6333
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6334 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	6335 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	6336 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	6337 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	6338 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	6339
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6340 - 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	6341 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	6342 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	6343 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	6344 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	6345
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6346 ' ' (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	6347 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	6348
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6349 + 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	6350 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	6351 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	6352
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6353 field-width
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6354 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	6355 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	6356 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	6357 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	6358 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	6359 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	6360
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6361 .precision
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6362 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	6363 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	6364 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	6365 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	6366 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	6367 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	6368 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	6369 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	6370 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	6371 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	6372
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6373 type
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6374 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	6375 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	6376
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6377 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	6378 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	6379 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	6380 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	6381 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	6382 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	6383 :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	6384 < 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	6385 "width" bytes.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6386
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6387 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	6388
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6389 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	6390 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	6391 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	6392 (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	6393 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	6394 "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	6395 "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	6396 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	6397 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	6398 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	6399 zeros.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6400 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	6401 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	6402 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	6403 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	6404 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	6405 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	6406 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	6407 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	6408 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	6409
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6410 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	6411 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	6412 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	6413 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	6414
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6415 printf-c
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6416 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	6417 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	6418
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6419 printf-s
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6420 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	6421 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	6422 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	6423 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	6424 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	6425 as ":echo".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6426 printf-S
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6427 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	6428 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	6429 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	6430
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6431 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	6432 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	6433 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	6434 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	6435 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	6436 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	6437 (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	6438 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	6439 "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	6440 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6441 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	6442 < 12.12
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6443 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	6444 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	6445
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6446 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	6447 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	6448 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	6449 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	6450 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	6451
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6452 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	6453 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	6454 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	6455 (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	6456 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	6457 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	6458 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	6459 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	6460
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6461 printf-%
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6462 % 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	6463 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	6464
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6465 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	6466 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	6467 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	6468 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	6469 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	6470
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6471 E766 E767
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6472 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	6473 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	6474 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	6475
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 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	6478 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	6479 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	6480
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6481 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	6482 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	6483
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6484 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6485 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	6486
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6487 < {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	6488
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 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	6491 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	6492 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	6493 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	6494
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6495 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	6496 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	6497 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	6498 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	6499 line.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6500 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	6501 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	6502 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	6503 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	6504 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	6505 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	6506 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6507 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	6508 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	6509 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	6510 stopinsert
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6511 close
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6512 else
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	6513 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	6514 " 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	6515 set nomodified
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6516 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6517 endfunc
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6518
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6519 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6520 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	6521
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6522 < {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	6523
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6524 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	6525 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	6526 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	6527 {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	6528
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6529 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	6530 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	6531 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	6532
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6533 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6534 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	6535
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6536 < {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	6537
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6538 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	6539 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	6540 {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	6541 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	6542 "prompt". Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6543 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	6544 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6545 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6546 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	6547
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6548 < {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	6549
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6550 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	6551
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6552 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	6553 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	6554 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	6555 \|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	6556 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	6557 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	6558 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	6559 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	6560 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	6561 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	6562
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6563 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	6564 \|CompleteChanged\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6565
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6566 pumvisible() pumvisible()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6567 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	6568 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	6569 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	6570 popup menu.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6571
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6572 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	6573 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	6574 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	6575 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	6576 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	6577 'encoding').
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6578 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	6579 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	6580 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	6581 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	6582 to {expr}.
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 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6585 GetExpr()->py3eval()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6586
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6587 < {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	6588
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6589 E858 E859
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6590 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	6591 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	6592 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	6593 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	6594 copied though).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6595 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	6596 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	6597 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	6598 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	6599 to {expr}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6600
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6601 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6602 GetExpr()->pyeval()
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 < {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	6605
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6606 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	6607 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	6608 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	6609 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	6610 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	6611
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6612 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6613 GetExpr()->pyxeval()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6614
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6615 < {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	6616 \|+python3\| feature}
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 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	6619 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	6620 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	6621 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	6622 {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	6623 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	6624 and updated.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6625
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6626 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6627 :echo rand()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6628 :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	6629 :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	6630 :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	6631 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6632
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6633 E726 E727
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6634 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	6635 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	6636 - 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	6637 - 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	6638 - 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	6639 {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	6640 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	6641 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	6642 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	6643 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	6644 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6645 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	6646 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	6647 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	6648 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	6649 range(0) " []
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6650 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	6651 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6652 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6653 GetExpr()->range()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6654 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6655
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6656 readblob({fname}) readblob()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6657 Read file {fname} in binary mode and return a \|Blob\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6658 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	6659 the result is an empty \|Blob\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6660 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	6661
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6662
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6663 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	6664 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	6665 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	6666 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	6667 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	6668 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	6669
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6670 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	6671 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	6672 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	6673 be handled.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6674 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	6675 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	6676 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	6677 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	6678 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	6679 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	6680 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	6681 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	6682 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	6683 < 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	6684 readdir(dirname, {n -> n !~ '^\.\\|\~$'})
27321 3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27223 diff changeset	6685 < E857
3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27223 diff changeset	6686 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	6687 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	6688 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	6689
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6690 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	6691 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	6692 "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	6693 "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	6694 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	6695 strcmp()) (default)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6696 "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	6697 using strcasecmp())
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6698 "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	6699 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	6700 (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	6701 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	6702
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6703 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	6704 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	6705 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	6706 < 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	6707 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	6708 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	6709 \ {_, x -> isdirectory(x) ?
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	6710 \ {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	6711 endfunction
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6712 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	6713 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6714 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6715 GetDirName()->readdir()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6716 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6717 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	6718 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	6719 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	6720 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	6721 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	6722 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	6723 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	6724 \|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	6725 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	6726 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	6727 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	6728 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	6729
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6730 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	6731 following items:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6732 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	6733 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	6734 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	6735 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	6736 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	6737 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	6738 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	6739 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	6740 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	6741 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	6742 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	6743 Directory "dir"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6744 Junction "junction"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6745 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	6746 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	6747 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	6748 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	6749 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	6750 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	6751 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	6752 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	6753
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6754 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	6755 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	6756 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	6757 be handled.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6758 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	6759 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	6760 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	6761 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	6762 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	6763 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	6764 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	6765 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	6766 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	6767 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	6768 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6769 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	6770 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	6771 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	6772
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6773 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6774 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6775 GetDirName()->readdirex()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6776 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6777
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6778 readfile()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6779 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	6780 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	6781 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	6782 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	6783 (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	6784 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	6785 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	6786 - 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	6787 added.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6788 - 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	6789 Otherwise:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6790 - 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	6791 - 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	6792 - 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	6793 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	6794 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	6795 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	6796 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	6797 :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	6798 : 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	6799 :endfor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6800 < 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	6801 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	6802 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	6803 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	6804 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	6805 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	6806 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	6807 "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	6808 unmodified.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6809 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	6810 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	6811 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	6812
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6813 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6814 GetFileName()->readfile()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6815
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6816 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	6817 {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	6818 \|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	6819 arguments: the result so far and current item. After
27459 5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	6820 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	6821
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6822 {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	6823 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	6824 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	6825 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	6826
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6827 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6828 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	6829 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	6830 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	6831 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	6832 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6833 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6834 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	6835
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 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	6838 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	6839 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	6840 See \|@\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6841
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6842 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	6843 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	6844 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	6845
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6846 reltime([{start} [, {end}]]) reltime()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6847 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	6848 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	6849 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	6850 The item can be passed to \|reltimestr()\| to convert it to a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6851 string or \|reltimefloat()\| to convert to a Float.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6852
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6853 Without an argument reltime() returns the current time.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6854 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	6855 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	6856 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	6857 and {end}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6858
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6859 The {start} and {end} arguments must be values returned by
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6860 reltime(). If there is an error zero 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	6861 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	6862
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6863 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6864 GetStart()->reltime()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6865 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6866 {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	6867
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6868 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	6869 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	6870 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6871 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	6872 call MyFunction()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6873 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	6874 < 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	6875 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	6876 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	6877 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	6878
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6879 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6880 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	6881
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6882 < {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	6883
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6884 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	6885 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	6886 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	6887 microseconds. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6888 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	6889 call MyFunction()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6890 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	6891 < 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	6892 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	6893 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	6894 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	6895 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	6896 < 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	6897 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	6898 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	6899
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6900 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6901 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	6902
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6903 < {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	6904
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6905 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	6906 remote_expr({server}, {string} [, {idvar} [, {timeout}]])
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	6907 Send the {string} to {server}. The {server} argument is a
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	6908 string, also see \|{server}\|.
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	6909
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	6910 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	6911 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	6912 \|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	6913 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	6914 "\n").
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	6915
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6916 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	6917 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	6918 \|remote_read()\| is stored there.
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	6919
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6920 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	6921 seconds. Otherwise a timeout of 600 seconds is used.
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	6922
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6923 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	6924 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	6925 {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	6926 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	6927 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	6928
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6929 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	6930 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	6931 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	6932 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	6933
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6934 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6935 :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	6936 :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	6937 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6938 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6939 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	6940
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6941 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	6942 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	6943 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	6944 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	6945 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	6946 < 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	6947 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	6948 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	6949 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	6950 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	6951 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	6952
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6953 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6954 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	6955
28379 6dd88e45d47d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28307 diff changeset	6956 < {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	6957 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	6958
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6959
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6960 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	6961 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	6962 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	6963 {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	6964 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	6965 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	6966 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	6967 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	6968 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	6969 {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	6970 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6971 :let repl = ""
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	6972 :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	6973
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6974 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6975 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	6976
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6977 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	6978 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	6979 it. Unless a {timeout} in seconds is given, it blocks until a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6980 reply is available.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6981 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	6982 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	6983 {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	6984 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6985 :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	6986
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6987 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6988 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	6989 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6990 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	6991 remote_send({server}, {string} [, {idvar}])
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	6992 Send the {string} to {server}. The {server} argument is a
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	6993 string, also see \|{server}\|.
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	6994
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	6995 The string is sent as input keys and the function returns
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	6996 immediately. At the Vim server the keys are not mapped
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	6997 \|:map\|.
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	6998
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	6999 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	7000 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	7001 there.
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	7002
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7003 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	7004 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	7005 {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	7006
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7007 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	7008 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	7009 Examples: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	7010 :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	7011 \ 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	7012
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7013 :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	7014 \ echo remote_read(expand("<amatch>"))
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	7015 :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	7016 \ '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	7017 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7018 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7019 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	7020 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7021 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	7022 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	7023 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	7024 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	7025
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7026 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7027 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	7028
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7029 < {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	7030
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7031 remove({list}, {idx} [, {end}]) remove()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7032 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	7033 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	7034 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	7035 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	7036 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	7037 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	7038 See \|list-index\| for possible values of {idx} and {end}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7039 Example: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	7040 :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	7041 :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	7042 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7043 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	7044
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7045 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7046 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	7047
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7048 remove({blob}, {idx} [, {end}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7049 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	7050 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	7051 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	7052 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	7053 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	7054 points to a byte 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	7055 Example: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	7056 :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	7057 :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	7058
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7059 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	7060 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	7061 Example: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	7062 :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	7063 < If there is no {key} in {dict} 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	7064
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7065 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	7066 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	7067 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	7068 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	7069 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	7070 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	7071 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	7072
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7073 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7074 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	7075
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7076 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	7077 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	7078 result. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7079 :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	7080 < When {count} is zero or negative the result is empty.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7081 When {expr} is a \|List\| the result is {expr} concatenated
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7082 {count} times. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7083 :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	7084 < 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	7085
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7086 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7087 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	7088
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7089 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	7090 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	7091 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	7092 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	7093 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	7094 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	7095 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	7096 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	7097 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	7098 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	7099 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	7100 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	7101 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	7102 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	7103 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	7104
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7105 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7106 GetName()->resolve()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7107
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7108 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	7109 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	7110 {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	7111 Returns {object}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7112 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	7113 :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	7114 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7115 mylist->reverse()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7116
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7117 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	7118 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	7119 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	7120 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	7121 {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	7122 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7123 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	7124 < 0.0 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7125 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	7126 < 5.0 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7127 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	7128 < -5.0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7129
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7130 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7131 Compute()->round()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7132 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7133 {only available when compiled with the \|+float\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7134
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7135 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	7136 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	7137 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	7138 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	7139 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	7140 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	7141 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	7142 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	7143 "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	7144 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	7145 to {expr}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7146
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7147 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7148 GetRubyExpr()->rubyeval()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7149
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7150 < {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	7151
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7152 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	7153 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	7154 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	7155 attribute at other positions.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7156
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7157 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7158 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	7159
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7160 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	7161 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	7162 [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	7163 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	7164 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	7165 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	7166 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	7167 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	7168 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	7169
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7170 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7171 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	7172
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7173 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	7174 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	7175 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	7176 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	7177 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	7178 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	7179
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7180 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7181 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	7182
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7183 screencol() screencol()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7184 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	7185 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	7186 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	7187
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7188 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	7189 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	7190 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	7191 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	7192 the following mappings: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	7193 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	7194 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	7195 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	7196 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7197 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	7198 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	7199 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	7200 {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	7201 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	7202 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	7203 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	7204 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	7205 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	7206 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	7207 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	7208 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	7209 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	7210 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	7211 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	7212 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	7213 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	7214 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	7215 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	7216 \|conceal\| taken into account.
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	7217 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	7218 first character is returned, {col} is not used.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7219
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7220 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7221 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	7222
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7223 screenrow() screenrow()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7224 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	7225 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	7226 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	7227 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	7228
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7229 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	7230
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7231 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	7232 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	7233 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	7234 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	7235 characters.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7236 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	7237 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	7238
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7239 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7240 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	7241 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7242 search()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7243 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	7244 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	7245 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	7246
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7247 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	7248 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	7249 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	7250
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7251 {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	7252 '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	7253 '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	7254 '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	7255 '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	7256 '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	7257 '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	7258 '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	7259 '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	7260 '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	7261 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	7262
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7263 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	7264 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	7265 flag.
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 '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	7268
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7269 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	7270 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	7271 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	7272 search starts after the match. Without the 'c' flag the next
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7273 search starts one column further. This matters for
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7274 overlapping matches.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7275 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	7276 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	7277 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	7278 file).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7279
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7280 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	7281 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	7282 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	7283 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	7284 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	7285 < 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	7286 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	7287 A zero value is equal to not 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	7288
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7289 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	7290 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	7291 {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	7292 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	7293 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	7294 {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	7295
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7296 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	7297 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	7298 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	7299 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	7300 {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	7301 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	7302 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	7303 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	7304 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	7305 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	7306 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	7307 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	7308 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	7309 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	7310
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7311 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	7312 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	7313
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7314 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	7315 :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	7316 :while n <= argc() " loop over all files in arglist
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	7317 : 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	7318 : " 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	7319 : " 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	7320 : normal G$
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7321 : 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	7322 : 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	7323 : 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	7324 : 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	7325 : endwhile
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7326 : 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	7327 : 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	7328 :endwhile
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 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	7331 :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	7332 < 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	7333 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	7334 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	7335 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	7336 line:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7337 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	7338 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	7339 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	7340 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	7341 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	7342
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7343 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7344 GetPattern()->search()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7345
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7346 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	7347 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	7348 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	7349 '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	7350
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7351 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	7352 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	7353
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7354 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	7355 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	7356 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	7357 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	7358 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	7359 "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	7360 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	7361 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	7362 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	7363 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	7364
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7365 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	7366
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7367 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	7368 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	7369 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	7370 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	7371 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	7372
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7373 " 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	7374 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	7375
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7376 " 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	7377 " to 1)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7378 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	7379 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7380 The function is useful to add the count to \|statusline\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7381 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	7382 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	7383 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	7384 return ''
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7385 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7386 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	7387 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	7388 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	7389 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	7390 \ 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	7391 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	7392 \ 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	7393 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	7394 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	7395 \ 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	7396 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7397 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7398 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	7399 \ 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	7400 endfunction
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	7401 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	7402
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7403 " 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	7404 " 'hlsearch' was on
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	7405 " 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	7406 " \ '%{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	7407 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7408 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	7409 \|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	7410
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7411 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	7412 \ 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	7413 \ 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	7414 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	7415 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	7416 call searchcount(#{
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7417 \ 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	7418 redrawstatus
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7419 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7420 endfunction
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7421 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7422 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	7423 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	7424
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7425 " 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	7426 " (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	7427 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	7428
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7429 " 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	7430 " search again
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7431 call searchcount()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7432 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7433 {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	7434 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	7435 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	7436 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	7437 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	7438 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	7439 \|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	7440 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	7441 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	7442 (default: \|TRUE\|)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7443 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	7444 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	7445 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	7446 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	7447 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	7448 let @/ = pattern
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7449 < (default: \|@/\|)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7450 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	7451 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	7452 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	7453 (default: 0)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7454 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	7455 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	7456 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	7457 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	7458 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	7459 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	7460 (default: 99)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7461 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	7462 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	7463 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	7464 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	7465 \|getpos()\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7466 (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	7467
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7468 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7469 GetSearchOpts()->searchcount()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7470 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7471 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	7472 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	7473
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7474 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	7475 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	7476 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	7477
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7478 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	7479 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	7480 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	7481
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7482 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	7483 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	7484 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7485 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	7486 echo getline('.')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7487 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7488 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7489 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7490 GetName()->searchdecl()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7491 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7492 searchpair()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7493 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	7494 [, {stopline} [, {timeout}]]]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7495 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	7496 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	7497 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	7498 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	7499 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	7500 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	7501 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	7502 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	7503 given.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7504
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7505 {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	7506 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	7507 {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	7508 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	7509 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	7510 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	7511 < 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	7512
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7513 {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	7514 \|search()\|. Additionally:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7515 '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	7516 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	7517 '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	7518 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	7519 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	7520 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	7521
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7522 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	7523 {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	7524 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	7525 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	7526 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	7527 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	7528 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	7529 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	7530 {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	7531 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	7532 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	7533 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	7534
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7535 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	7536
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7537 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	7538 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	7539
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7540 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	7541 {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	7542 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	7543 if 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7544 if 2
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7545 endif 2
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7546 endif 1
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7547 < 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	7548 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	7549 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	7550 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	7551 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	7552 "endif 2".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7553 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	7554 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	7555 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	7556 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	7557
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7558 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	7559
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7560 :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	7561 \ 'getline(".") =~ "^\\s*\""')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7562
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7563 < 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	7564 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	7565 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	7566 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	7567 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	7568 match.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7569 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	7570
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7571 :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	7572
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7573 < 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	7574 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	7575 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	7576
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7577 :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	7578 \ '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	7579 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7580 searchpairpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7581 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	7582 [, {stopline} [, {timeout}]]]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7583 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	7584 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	7585 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	7586 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	7587 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	7588
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7589 :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	7590 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7591 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	7592
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7593 searchpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7594 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	7595 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	7596 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	7597 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	7598 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	7599 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	7600 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7601 :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	7602
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7603 < 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	7604 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	7605 :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	7606 < 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	7607 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	7608
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7609 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7610 GetPattern()->searchpos()
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 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	7613 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	7614 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	7615 {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	7616 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	7617 Note:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7618 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	7619 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	7620 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	7621 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	7622 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7623 :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	7624
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7625 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7626 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	7627 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7628 serverlist() serverlist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7629 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	7630 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	7631 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	7632 {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	7633 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7634 :echo serverlist()
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 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	7637 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	7638 \|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	7639
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7640 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	7641 \|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	7642
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7643 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	7644 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	7645
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7646 {text} can be a string to set one line, or a list of strings
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7647 to set multiple lines. If the list extends below the last
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7648 line then those lines are added.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7649
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7650 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	7651
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7652 {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	7653 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	7654 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	7655 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	7656
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7657 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	7658 {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	7659 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	7660 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	7661
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7662 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	7663 third argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7664 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	7665
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7666 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	7667 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	7668 {val}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7669 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	7670 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	7671 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	7672 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	7673 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	7674 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	7675 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7676 :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	7677 :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	7678 < 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	7679
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7680 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	7681 third argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7682 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	7683
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7684
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7685 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	7686 Specify overrides for cell widths of character ranges. This
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7687 tells Vim how wide characters are, counted in screen cells.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7688 This overrides 'ambiwidth'. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7689 setcellwidths([[0xad, 0xad, 1],
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7690 \ [0x2194, 0x2199, 2]])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7691
27459 5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27447 diff changeset	7692 < E1109 E1110 E1111 E1112 E1113 E1114
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7693 The {list} argument is a list of lists with each three
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7694 numbers. These three numbers are [low, high, width]. "low"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7695 and "high" can be the same, in which case this refers to one
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7696 character. Otherwise it is the range of characters from "low"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7697 to "high" (inclusive). "width" is either 1 or 2, indicating
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7698 the character width in screen cells.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7699 An error is given if the argument is invalid, also when a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7700 range overlaps with another.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7701 Only characters with value 0x100 and higher 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	7702
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7703 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	7704 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	7705
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7706 To clear the overrides pass 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	7707 setcellwidths([]);
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7708 < You can use the script $VIMRUNTIME/tools/emoji_list.vim to see
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7709 the effect for known emoji characters.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7710
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7711 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	7712 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	7713 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	7714
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7715 Example:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7716 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	7717 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	7718 < 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	7719 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	7720 < 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	7721
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7722 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7723 GetPosition()->setcharpos('.')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7724
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7725 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	7726 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	7727 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	7728
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7729 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	7730 \|,\| 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	7731 character search
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7732 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	7733 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	7734 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	7735 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	7736 character search
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7737
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7738 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	7739 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	7740 :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	7741 :" 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	7742 :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	7743 < 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	7744
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7745 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7746 SavedSearch()->setcharsearch()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7747
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7748 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	7749 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	7750 {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	7751 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	7752 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	7753 \|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	7754 \|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	7755 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	7756 \|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	7757 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	7758 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	7759 line. A number smaller than one has undefined results.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7760 Returns FALSE when successful, TRUE when not editing the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7761 command line.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7762
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7763 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7764 GetPos()->setcmdpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7765
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7766 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	7767 setcursorcharpos({list})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7768 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	7769 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	7770
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7771 Example:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7772 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	7773 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	7774 < 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	7775 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	7776 < 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	7777
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7778 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7779 GetCursorPos()->setcursorcharpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7780
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 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	7783 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	7784 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	7785
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7786 < 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	7787 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	7788
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7789 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	7790 second argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7791 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	7792
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7793 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	7794 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	7795 {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	7796 "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	7797 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	7798 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	7799 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	7800 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	7801
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7802 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	7803 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	7804 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	7805
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7806 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	7807
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7808 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7809 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	7810 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7811 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	7812
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7813
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7814 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	7815 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	7816 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	7817 \|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	7818
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7819 {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	7820 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	7821 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	7822 {text} can be any type or a List of any type, 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	7823 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	7824
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7825 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	7826 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	7827 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	7828
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7829 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7830 :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	7831
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7832 < 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	7833 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	7834 :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	7835 < 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	7836 :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	7837 : 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	7838 :endfor
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 < 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	7841
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7842 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	7843 second argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7844 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	7845
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7846 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	7847 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	7848 {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	7849 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	7850
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7851 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	7852 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	7853 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	7854 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	7855
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7856 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	7857
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7858 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	7859 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	7860 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	7861
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7862 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	7863 second argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7864 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	7865
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7866 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	7867 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	7868 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	7869 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	7870 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	7871 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	7872 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	7873
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7874 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7875 GetMatches()->setmatches()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7876 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7877 setpos()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7878 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	7879 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	7880 . the cursor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7881 '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	7882
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7883 {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	7884 [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	7885 [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	7886
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7887 "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	7888 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	7889 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	7890 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	7891 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	7892 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	7893 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	7894 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	7895
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7896 "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	7897 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	7898 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	7899 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	7900
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7901 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	7902 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	7903 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	7904 character.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7905
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7906 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	7907 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	7908 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	7909 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	7910 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	7911
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7912 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	7913 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	7914 before '>.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7915
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7916 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	7917 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	7918
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7919 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	7920
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7921 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	7922 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	7923 \|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	7924 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	7925 \|winrestview()\|.
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 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7928 GetPosition()->setpos('.')
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7929
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7930 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	7931 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	7932
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7933 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	7934 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	7935 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	7936 {what}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7937 setqflist-what
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7938 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	7939 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	7940 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	7941 entries:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7942
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7943 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	7944 buffer
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7945 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	7946 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	7947 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	7948 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	7949 lnum line number in the file
27537 063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27497 diff changeset	7950 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	7951 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	7952 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	7953 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	7954 when zero: "col" is byte index
27537 063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27497 diff changeset	7955 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	7956 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	7957 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	7958 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	7959 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	7960
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7961 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	7962 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	7963 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	7964 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	7965 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	7966 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	7967 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	7968 be used.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7969 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	7970 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	7971 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	7972 cleared.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7973 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	7974 \|getqflist()\| returns.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7975
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7976 {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	7977 '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	7978 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	7979 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	7980
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7981 '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	7982 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	7983 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	7984 :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	7985 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7986 '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	7987 freed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7988
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7989 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	7990 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	7991 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	7992 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	7993 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	7994
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	7995 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	7996 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	7997 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	7998 "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	7999 '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	8000 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	8001 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	8002 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	8003 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	8004 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	8005 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	8006 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	8007 argument.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8008 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	8009 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	8010 {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	8011 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	8012 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	8013 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	8014 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	8015 quickfixtextfunc
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8016 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	8017 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	8018 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	8019 \|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	8020 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	8021 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	8022 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	8023 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	8024 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	8025 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	8026 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	8027 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	8028 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	8029
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8030 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	8031 :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	8032 :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	8033 :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	8034 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8035 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	8036
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8037 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	8038 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	8039 `: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	8040
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8041 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	8042 second argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8043 GetErrorlist()->setqflist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8044 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8045 setreg()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8046 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	8047 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	8048 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	8049 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	8050 {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	8051
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8052 {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	8053 \|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	8054 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	8055 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	8056
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8057 {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	8058 "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	8059 "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	8060 "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	8061 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	8062 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	8063 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	8064 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	8065
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8066 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	8067 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	8068 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	8069 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	8070 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	8071
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8072 E883
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8073 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	8074 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	8075 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	8076
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8077 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8078 :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	8079 :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	8080 :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	8081 :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	8082
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8083 < 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	8084 register: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8085 :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	8086 :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	8087 < or: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8088 :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	8089 :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	8090 ....
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8091 :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	8092 < 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	8093 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	8094 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	8095 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	8096
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8097 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	8098 nothing: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8099 :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	8100
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8101 < 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	8102 second argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8103 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	8104
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8105 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	8106 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	8107 \|t:var\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8108 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	8109 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	8110 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	8111 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	8112 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	8113 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	8114
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8115 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	8116 third argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8117 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	8118
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8119 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	8120 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	8121 {val}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8122 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	8123 use \|setwinvar()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8124 {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	8125 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	8126 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	8127 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	8128 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	8129 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	8130 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	8131 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	8132 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8133 :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	8134 :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	8135 < 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	8136
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8137 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	8138 fourth argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8139 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	8140
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8141 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	8142 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	8143 {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	8144
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8145 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	8146 \|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	8147 stack.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8148 E962
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8149 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	8150 argument:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8151 - 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	8152 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	8153 - 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	8154 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	8155 - 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	8156 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	8157 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	8158
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8159 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	8160 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	8161
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8162 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	8163
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8164 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	8165 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	8166 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	8167
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8168 < 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	8169 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	8170 " 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	8171 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	8172 unlet stack
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8173 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8174 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	8175 second argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8176 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	8177
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8178 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	8179 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	8180 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8181 :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	8182 :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	8183
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8184 < 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	8185 third argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8186 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	8187
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8188 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	8189 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	8190 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	8191
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8192 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8193 GetText()->sha256()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8194
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8195 < {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	8196
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8197 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	8198 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	8199 When the 'shell' contains powershell (MS-Windows) or pwsh
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27623 diff changeset	8200 (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	8201 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	8202 quotes.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8203 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	8204 {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	8205 {string}.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8206 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	8207 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	8208
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8209 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	8210 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	8211 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	8212 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	8213 command.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8214
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8215 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	8216 {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	8217 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	8218 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	8219
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8220 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	8221 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	8222 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	8223
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8224 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	8225 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	8226 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	8227
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8228 Example of use with a \|:!\| command: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	8229 :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	8230 < 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	8231 cursor. Example of use with \|system()\|: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	8232 :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	8233 < 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	8234
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8235 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8236 GetCommand()->shellescape()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8237
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8238 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	8239 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	8240 '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	8241 '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	8242 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	8243 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	8244
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8245 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	8246 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	8247 '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	8248 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	8249
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8250 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8251 GetColumn()->shiftwidth()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8252
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8253 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	8254
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8255
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8256 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	8257 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	8258 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	8259 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	8260 {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	8261 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	8262 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	8263 "///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	8264 standard).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8265 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8266 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	8267 < 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	8268 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	8269 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	8270 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	8271 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	8272
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8273 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8274 GetName()->simplify()
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 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	8277 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	8278 {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	8279 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8280 :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	8281 < -0.506366 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8282 :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	8283 < 0.763301
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 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8286 Compute()->sin()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8287 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8288 {only available when compiled with the \|+float\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8289
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8290
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8291 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	8292 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	8293 [-inf, inf].
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8294 {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	8295 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8296 :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	8297 < 0.521095 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8298 :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	8299 < -1.026517
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8300
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8301 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8302 Compute()->sinh()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8303 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8304 {only available when compiled with the \|+float\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8305
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8306
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8307 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	8308 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	8309 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	8310 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	8311 \|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	8312 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	8313 When {end} is -1 the last item is omitted.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8314
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8315 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8316 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	8317
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8318
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	8319 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	8320 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	8321
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8322 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	8323 :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	8324
28933 57c9377b9c62 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 28917 diff changeset	8325 < 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	8326 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	8327 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	8328 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	8329
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	8330 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	8331 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	8332 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	8333
3cb1a109e987 patch 8.2.4455: accepting one and zero for second sort() argument is strange Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	8334 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	8335 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	8336 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	8337 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	8338 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	8339 case. Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8340 " ö 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	8341 :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	8342 :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	8343 < ['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	8344 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8345 " ö 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	8346 :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	8347 :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	8348 < ['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	8349 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	8350
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	8351 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	8352 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	8353 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	8354 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	8355
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	8356 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	8357 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	8358 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	8359
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	8360 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	8361 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	8362
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	8363 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	8364 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	8365 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	8366 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	8367 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	8368
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8369 {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	8370 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	8371
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8372 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	8373 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	8374 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	8375 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	8376
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8377 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8378 mylist->sort()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8379
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8380 < 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	8381
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8382 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8383 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	8384 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	8385 endfunc
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8386 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	8387 < 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	8388 ignores overflow: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8389 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	8390 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	8391 endfunc
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8392 < 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	8393 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	8394 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8395 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	8396 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	8397
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8398 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	8399 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	8400
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8401 {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	8402
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8403 sound_playevent()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8404 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	8405 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	8406 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	8407 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	8408 /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	8409 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	8410 < 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	8411 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	8412 SystemStart, SystemWelcome, etc.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8413
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8414 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	8415 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	8416 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	8417 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	8418 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	8419 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	8420 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8421 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	8422 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	8423 endfunc
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8424 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	8425
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8426 < 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	8427
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8428 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	8429 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	8430
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8431 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8432 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	8433
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8434 < {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	8435
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8436 sound_playfile()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8437 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	8438 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	8439 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	8440 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	8441 :!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	8442
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8443 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8444 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	8445
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	8446 < {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	8447
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 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	8450 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	8451 `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	8452
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8453 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	8454 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	8455
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8456 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	8457 `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	8458
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8459 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8460 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	8461
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8462 < {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	8463
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8464 soundfold()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8465 soundfold({word})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8466 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	8467 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	8468 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	8469 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	8470 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	8471 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	8472
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8473 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8474 GetWord()->soundfold()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8475 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8476 spellbadword()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8477 spellbadword([{sentence}])
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8478 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	8479 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	8480 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	8481 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	8482
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8483 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	8484 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	8485 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	8486
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8487 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	8488 - 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	8489 - 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	8490 "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	8491 "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	8492 "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	8493 "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	8494 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8495 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	8496 < ['quik', 'bad'] ~
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8497
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8498 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	8499 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	8500
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8501 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8502 GetText()->spellbadword()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8503 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8504 spellsuggest()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8505 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	8506 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	8507 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	8508 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	8509
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8510 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	8511 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	8512 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	8513
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8514 {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	8515 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	8516 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	8517 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	8518
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8519 {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	8520 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	8521 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	8522
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8523 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	8524 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	8525
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8526 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8527 GetWord()->spellsuggest()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8528
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8529 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	8530 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	8531 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	8532 item.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8533 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	8534 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	8535 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	8536 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	8537 {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	8538 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	8539 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	8540 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8541 :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	8542 < 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	8543 :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	8544 < 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	8545 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	8546 :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	8547 < ['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	8548 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	8549 :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	8550 < 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	8551
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8552 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8553 GetString()->split()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8554
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8555 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	8556 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	8557 \|Float\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8558 {expr} must evaluate to a \|Float\| or a \|Number\|. When {expr}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8559 is negative the result is NaN (Not a Number).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8560 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8561 :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	8562 < 10.0 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8563 :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	8564 < nan
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8565 "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	8566
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8567 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8568 Compute()->sqrt()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8569 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8570 {only available when compiled with the \|+float\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8571
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8572
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8573 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	8574 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	8575 - 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	8576 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	8577 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	8578 - 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	8579 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	8580 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	8581
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8582 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8583 :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	8584 :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	8585 :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	8586
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8587 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	8588 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	8589 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	8590 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	8591 - 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	8592 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	8593 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	8594 \|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	8595 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	8596 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	8597 - 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	8598 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	8599 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	8600 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	8601 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	8602
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8603 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	8604 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	8605 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	8606 " 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	8607 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8608 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	8609 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	8610 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	8611 stuffed command
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8612 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	8613 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	8614 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	8615 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	8616 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	8617 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	8618 \|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	8619 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	8620 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	8621 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	8622
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8623 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	8624 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	8625 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	8626 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	8627 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	8628 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	8629 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	8630 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	8631 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	8632 thousand.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8633 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	8634 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	8635 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	8636 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	8637 \|substitute()\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8638 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	8639 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8640 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8641 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	8642 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8643 {only available when compiled with the \|+float\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8644
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8645 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	8646 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	8647 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	8648 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	8649 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	8650 < \|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	8651
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8652 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	8653 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	8654 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	8655 properly: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8656 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	8657
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8658 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8659 GetString()->str2list()
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
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8662 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	8663 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	8664 {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	8665 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	8666 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	8667
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8668 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	8669 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	8670 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	8671 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	8672 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8673 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	8674 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	8675 {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	8676 {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	8677 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	8678
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8679 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8680 GetText()->str2nr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8681
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8682
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8683 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	8684 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	8685 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	8686 \|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	8687 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	8688
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8689 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	8690
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8691 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8692 GetText()->strcharlen()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8693
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8694
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8695 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	8696 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	8697 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	8698 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	8699 counted separately.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8700 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	8701 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	8702 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	8703 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	8704 example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8705 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	8706 < 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	8707
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8708 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8709 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	8710
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8711
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8712 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	8713 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	8714 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	8715 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	8716 counted separately.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8717 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	8718 \|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	8719
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8720 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	8721
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8722 {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	8723 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	8724 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	8725 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	8726 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	8727 endfunction
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8728 else
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8729 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	8730 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	8731 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	8732 else
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8733 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	8734 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8735 endfunction
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8736 endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8737 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8738 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8739 GetText()->strchars()
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 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	8742 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	8743 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	8744 (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	8745 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	8746 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	8747 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	8748 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	8749 '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	8750 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	8751 Ambiguous, this function's return value depends on 'ambiwidth'.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8752 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	8753
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8754 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8755 GetText()->strdisplaywidth()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8756
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8757 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	8758 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	8759 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	8760 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	8761 {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	8762 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	8763 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	8764 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	8765 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	8766 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8767 :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	8768 :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	8769 :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	8770 :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	8771 :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	8772 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	8773 < 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	8774 :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	8775
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8776 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8777 GetFormat()->strftime()
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 strgetchar({str}, {index}) strgetchar()
28933 57c9377b9c62 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 28917 diff changeset	8780 Get a Number corresponding to the character at {index} in
57c9377b9c62 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 28917 diff changeset	8781 {str}. This uses a zero-based character index, not a byte
57c9377b9c62 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 28917 diff changeset	8782 index. Composing characters are considered separate
57c9377b9c62 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 28917 diff changeset	8783 characters here. Use \|nr2char()\| to convert the Number to a
57c9377b9c62 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 28917 diff changeset	8784 String.
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8785 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	8786
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8787 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8788 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	8789
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8790 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	8791 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	8792 {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	8793 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	8794 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	8795 :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	8796 :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	8797 < 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	8798 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	8799 -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	8800 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	8801 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8802 :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	8803 :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	8804 :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	8805 < strstr() strchr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8806 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	8807 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	8808
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8809 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8810 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	8811 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8812 string()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8813 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	8814 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	8815 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	8816 {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	8817 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	8818 Number 123
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8819 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	8820 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	8821 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	8822 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	8823 Dictionary {key: value, key: value}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8824
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8825 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	8826 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	8827 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	8828
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8829 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8830 mylist->string()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8831
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8832 < 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	8833
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8834
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8835 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	8836 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	8837 {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	8838 If the argument is a Number it is first 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	8839 For other types 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	8840 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	8841 \|strchars()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8842 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	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()->strlen()
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 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	8848 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	8849 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	8850 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	8851 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	8852 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	8853 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	8854 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	8855 \|strcharpart()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8856
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8857 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	8858 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	8859 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	8860 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	8861 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	8862 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	8863 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	8864 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	8865
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8866 < 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	8867 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	8868 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	8869 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8870 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8871 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	8872
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8873 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	8874 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	8875 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	8876 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	8877
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8878 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	8879 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	8880 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	8881 matters.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8882
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8883 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	8884 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	8885 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	8886 result.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8887
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8888 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	8889 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8890 :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	8891 < 862156163 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8892 :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	8893 < 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	8894 :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	8895 < 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	8896
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8897 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8898 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	8899 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8900 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	8901 :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	8902
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8903 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	8904 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	8905 {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	8906 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	8907 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	8908 match: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8909 :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	8910 :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	8911 < 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	8912 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	8913 -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	8914 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	8915 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	8916 :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	8917 < strrchr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8918 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	8919 function strrchr().
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8920
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8921 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8922 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	8923
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8924 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	8925 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	8926 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	8927 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	8928 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	8929 < 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	8930 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	8931
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8932 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8933 GetString()->strtrans()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8934
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8935 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	8936 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	8937 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	8938 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	8939 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	8940 Ambiguous, this function's return value depends on 'ambiwidth'.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8941 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	8942
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8943 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8944 GetString()->strwidth()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8945
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8946 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	8947 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	8948 substitute() function.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8949 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	8950 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	8951 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	8952 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	8953 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	8954
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8955 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	8956 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	8957 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	8958 text.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8959 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	8960 \|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	8961 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	8962
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8963 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	8964 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	8965
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8966 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8967 :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	8968 :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	8969 < 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	8970 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	8971
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 GetNr()->submatch()
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 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	8976 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	8977 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	8978 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	8979 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	8980
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8981 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	8982 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	8983 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	8984 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	8985 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	8986 '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	8987 used.
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 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	8990 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	8991 \|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	8992 "\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	8993
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8994 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	8995 unmodified.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8996
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8997 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	8998 :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	8999 < 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	9000 :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	9001 < 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	9002
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9003 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	9004 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	9005 :echo substitute(s, '%$\x\x$',
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	9006 \ '\=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	9007
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9008 < 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	9009 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	9010 :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	9011 < 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	9012 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	9013 \|submatch()\| returns. Example: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	9014 :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	9015
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9016 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9017 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	9018
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9019 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	9020 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	9021 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	9022 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	9023 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	9024 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	9025 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	9026 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	9027 file
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9028 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	9029 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	9030 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	9031 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	9032 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	9033 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	9034 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	9035 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	9036 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	9037
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9038 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9039 GetFilename()->swapinfo()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9040
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9041 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	9042 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	9043 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	9044 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	9045 \|: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	9046 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	9047
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9048 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9049 GetBufname()->swapname()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9050
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9051 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	9052 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	9053 {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	9054 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	9055 \|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	9056
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9057 {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	9058 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	9059 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	9060 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	9061 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	9062
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9063 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	9064 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	9065 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	9066 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	9067 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	9068 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	9069 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	9070
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9071 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	9072 :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	9073 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9074
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9075 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	9076 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	9077 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	9078 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	9079 {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	9080 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	9081 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	9082 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	9083 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	9084 {what} result
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9085 "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	9086 "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	9087 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	9088 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	9089 "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	9090 "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	9091 \|highlight-font\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9092 "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	9093 \|highlight-guisp\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9094 "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	9095 "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	9096 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	9097 "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	9098 "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	9099 "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	9100 "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	9101 "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	9102 "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	9103 "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	9104 "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	9105 "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	9106 "strike" "1" if strikethrough
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9107
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9108 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	9109 cursor): >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9110 :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	9111 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9112 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9113 :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	9114
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9115
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9116 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	9117 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	9118 {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	9119 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	9120 ":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	9121
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9122 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9123 :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	9124
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9125 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	9126 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	9127 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	9128 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	9129 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	9130 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	9131 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	9132 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	9133 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	9134 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	9135 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	9136 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	9137 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	9138 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	9139 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	9140 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	9141 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	9142 call returns ~
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9143 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	9144 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	9145 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	9146 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	9147 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	9148 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	9149
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9150
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9151 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	9152 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	9153 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	9154 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	9155 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	9156 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	9157 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	9158 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	9159 transparent item.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9160 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	9161 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	9162 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	9163 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	9164 endfor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9165 < When the position specified with {lnum} and {col} is invalid
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9166 nothing is returned. The position just 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	9167 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	9168 valid positions.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9169
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9170 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	9171 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	9172 \|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	9173
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9174 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	9175 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	9176 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	9177 separators yourself.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9178 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	9179 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	9180 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	9181 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	9182 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	9183 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	9184 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	9185 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	9186
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9187 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	9188
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9189 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	9190 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	9191 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	9192 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	9193 :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	9194 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9195 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	9196 \|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	9197 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	9198 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	9199 cause trouble.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9200 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	9201
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9202 The result is a String. Example: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	9203 :let files = system('ls ' .. shellescape(expand('%:h')))
d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	9204 :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	9205
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9206 < 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	9207 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	9208 <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	9209 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	9210 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	9211
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9212 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	9213 '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	9214 ({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	9215 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	9216 concatenated commands.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9217
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9218 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	9219 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	9220
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9221 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	9222 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	9223
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9224 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	9225 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	9226 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	9227 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	9228 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	9229
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9230 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9231 :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	9232
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9233
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9234 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	9235 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	9236 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	9237 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	9238 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	9239 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	9240 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	9241
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9242 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	9243 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	9244 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	9245 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9246 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	9247
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9248 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9249 :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	9250
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9251
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9252 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	9253 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	9254 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	9255 {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	9256 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	9257 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	9258 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	9259 let buflist = []
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9260 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	9261 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	9262 endfor
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9263 < 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	9264
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9265 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9266 GetTabpage()->tabpagebuflist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9267
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9268 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	9269 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	9270 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	9271
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9272 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	9273 $ 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	9274 count).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9275 # 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	9276 (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	9277 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	9278 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	9279
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9280
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9281 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	9282 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	9283 {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	9284 {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	9285 - 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	9286 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	9287 - 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	9288 - 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	9289 Useful examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9290 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	9291 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	9292 < 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	9293
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9294 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9295 GetTabpage()->tabpagewinnr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9296 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9297 tagfiles()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9298 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	9299 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	9300
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9301
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9302 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	9303 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	9304
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9305 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	9306 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	9307 {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	9308
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9309 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	9310 entries:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9311 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	9312 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	9313 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	9314 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	9315 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	9316 the file.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9317 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	9318 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	9319 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	9320 using a tags file generated by
28141 dce918af0c00 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28081 diff changeset	9321 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	9322 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	9323 \|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	9324 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	9325 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	9326 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	9327 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	9328 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	9329 contained in.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9330
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9331 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	9332 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	9333
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9334 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	9335
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9336 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	9337 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	9338 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	9339 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	9340
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9341 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	9342 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	9343 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	9344
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9345 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9346 GetTagpattern()->taglist()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9347
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9348 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	9349 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	9350 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	9351 {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	9352 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9353 :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	9354 < 0.648361 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9355 :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	9356 < -1.181502
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9357
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9358 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9359 Compute()->tan()
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 {only available when compiled with the \|+float\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9362
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 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	9365 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	9366 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	9367 {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	9368 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9369 :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	9370 < 0.462117 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9371 :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	9372 < -0.761594
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 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9375 Compute()->tanh()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9376 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9377 {only available when compiled with the \|+float\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9378
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 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	9381 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	9382 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	9383 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	9384 :let tmpfile = tempname()
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	9385 :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	9386 < 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	9387 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	9388 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	9389 '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	9390
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9391
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9392 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	9393
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9394
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9395 terminalprops() terminalprops()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9396 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	9397 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	9398 \|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	9399 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	9400 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	9401 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	9402 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	9403 mouse mouse type supported
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9404
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9405 ** 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	9406
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9407 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	9408 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	9409
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9410 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	9411 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	9412 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	9413 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	9414 "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	9415 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	9416 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	9417
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9418 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	9419 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	9420
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9421 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	9422
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9423 Also see:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9424 - '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	9425 - \|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	9426 \|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	9427
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9428
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9429 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	9430
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9431
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9432 timer_info()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9433 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	9434 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	9435 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	9436 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	9437 returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9438 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	9439
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9440 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	9441 these items:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9442 "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	9443 "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	9444 "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	9445 "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	9446 -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	9447 "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	9448 "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	9449
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9450 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9451 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	9452
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9453 < {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	9454
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9455 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	9456 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	9457 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	9458 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	9459 has passed.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9460
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9461 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	9462 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	9463
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9464 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	9465 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	9466 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	9467
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9468 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9469 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	9470
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9471 < {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	9472
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9473 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	9474 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	9475 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	9476
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9477 {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	9478 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	9479 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	9480
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9481 {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	9482 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	9483 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	9484 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	9485 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	9486 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	9487
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9488 {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	9489 "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	9490 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	9491 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	9492 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	9493 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	9494 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	9495 messages.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9496
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9497 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9498 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	9499 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	9500 endfunc
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9501 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	9502 \ {'repeat': 3})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9503 < 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	9504 intervals.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9505
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9506 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9507 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	9508
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9509 < 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	9510 {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	9511
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9512 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	9513 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	9514 {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	9515 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	9516
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9517 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9518 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	9519
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9520 < {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	9521
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9522 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	9523 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	9524 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	9525 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	9526
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9527 {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	9528
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9529 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	9530 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	9531 characters turned into lowercase (just like applying \|gu\| to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9532 the string).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9533
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9534 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9535 GetText()->tolower()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9536
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9537 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	9538 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	9539 characters turned into uppercase (just like applying \|gU\| to
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9540 the string).
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 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9543 GetText()->toupper()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9544
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9545 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	9546 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	9547 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	9548 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	9549 {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	9550 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	9551 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	9552
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9553 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9554 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	9555 < 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	9556 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	9557 < returns "{blob}"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9558
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9559 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9560 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	9561
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9562 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	9563 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	9564 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	9565
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9566 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	9567 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	9568 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	9569
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9570 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	9571 characters:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9572 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	9573 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	9574 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	9575 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	9576
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9577 This function 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	9578
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9579 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9580 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	9581 < returns "some text" >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	9582 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	9583 < 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	9584 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	9585 < 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	9586 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	9587 < returns " vim"
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9588
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9589 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9590 GetText()->trim()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9591
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9592 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	9593 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	9594 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	9595 {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	9596 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9597 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	9598 < 1.0 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9599 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	9600 < -5.0 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9601 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	9602 < 4.0
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9603
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9604 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9605 Compute()->trunc()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9606 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9607 {only available when compiled with the \|+float\| feature}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9608
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9609 type()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9610 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	9611 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	9612 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	9613 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	9614 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	9615 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	9616 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	9617 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	9618 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	9619 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	9620 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	9621 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	9622 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	9623 Blob: 10 \|v:t_blob\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9624 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	9625 :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	9626 :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	9627 :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	9628 :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	9629 :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	9630 :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	9631 :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	9632 :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	9633 < 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	9634 :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	9635
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9636 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9637 mylist->type()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9638
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9639
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9640 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	9641 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	9642 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9643 echo typename([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	9644 list<number>
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9645
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9646
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9647 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	9648 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	9649 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	9650 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	9651 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	9652 {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	9653 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	9654 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	9655 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	9656 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	9657 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	9658 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	9659
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9660 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9661 GetFilename()->undofile()
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 undotree() undotree()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9664 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	9665 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	9666 "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	9667 "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	9668 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	9669 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	9670 "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	9671 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	9672 something readable.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9673 "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	9674 write yet.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9675 "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	9676 tree.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9677 "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	9678 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	9679 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	9680 "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	9681 undo blocks.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9682
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9683 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	9684 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	9685 "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	9686 \|:undolist\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9687 "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	9688 \|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	9689 "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	9690 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	9691 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	9692 "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	9693 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	9694 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	9695 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	9696 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	9697 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	9698 "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	9699 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	9700 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	9701 "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	9702 "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	9703 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	9704 item.
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 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	9707 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	9708 {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	9709 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	9710 :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	9711 < 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	9712 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	9713
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9714 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9715 mylist->uniq()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9716
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9717 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	9718 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	9719 in arbitrary order. Also see \|items()\| and \|keys()\|.
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 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9722 mydict->values()
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 virtcol({expr}) virtcol()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9725 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	9726 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	9727 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	9728 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	9729 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	9730 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	9731 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	9732 For the byte position use \|col()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9733 For the use of {expr} see \|col()\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9734 When 'virtualedit' is used {expr} can be [lnum, col, off], where
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9735 "off" 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	9736 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	9737 character. When "off" 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	9738 When Virtual editing is active in the current mode, a position
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9739 beyond the end of the line can be returned. \|'virtualedit'\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9740 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	9741 . 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	9742 $ 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	9743 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	9744 plus one)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9745 '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	9746 returned)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9747 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	9748 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	9749 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	9750 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	9751 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	9752 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9753 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9754 virtcol("$") with text "foo^Lbar", returns 9
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9755 virtcol("'t") with text " there", with 't at 'h', returns 6
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9756 < 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	9757 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	9758 all lines: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9759 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	9760
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9761 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9762 GetPos()->virtcol()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9763
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9764
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9765 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	9766 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	9767 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	9768 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	9769 "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	9770 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	9771 respectively.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9772 Example: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	9773 :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	9774 < 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	9775 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	9776 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	9777 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	9778 (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	9779 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	9780 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	9781 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	9782
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9783 wildmenumode() wildmenumode()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9784 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	9785 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	9786 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	9787 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	9788
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9789 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	9790 :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	9791 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9792 (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	9793
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9794 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	9795 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	9796 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	9797 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	9798 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	9799 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	9800 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9801 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	9802 < 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	9803 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	9804 E994
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9805 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	9806 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	9807 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	9808
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9809 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	9810 second argument: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9811 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	9812
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9813 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	9814 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	9815 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	9816
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9817 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9818 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	9819
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9820 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	9821 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	9822 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	9823 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	9824 number 1.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9825 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	9826 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	9827 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	9828
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9829 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9830 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	9831
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9832
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9833 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	9834 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	9835 "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	9836 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	9837 "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	9838 (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	9839 "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	9840 "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	9841 "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	9842 "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	9843 "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	9844
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9845 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	9846 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	9847 \|window-ID\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9848
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9849 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	9850 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	9851 returns "popup".
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 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9854 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	9855 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9856 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	9857 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	9858 tabpage.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9859 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	9860
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9861 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9862 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	9863
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9864 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	9865 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	9866 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	9867 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	9868
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9869 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9870 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	9871
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9872 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	9873 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	9874 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	9875
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9876 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9877 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	9878
27047 b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	9879 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	9880 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	9881 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	9882 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	9883 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	9884 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	9885 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	9886 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	9887 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	9888 '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	9889 FALSE otherwise.
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	9890
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	9891 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	9892 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	9893
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	9894 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	9895 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	9896 {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	9897 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	9898 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	9899 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	9900 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	9901 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	9902 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	9903 be found and FALSE otherwise.
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	9904
b94cdb5ef20e patch 8.2.4052: not easy to resize a window from a plugin Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	9905 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	9906 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	9907
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9908 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	9909 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	9910 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	9911 [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	9912 {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	9913 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	9914 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	9915 tabpage.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9916
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9917 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9918 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	9919 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9920 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	9921 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	9922 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	9923 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	9924 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	9925
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9926 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	9927 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	9928
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9929 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	9930
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9931 {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	9932 "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	9933 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	9934 "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	9935 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	9936 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	9937 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	9938 '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	9939
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9940 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9941 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	9942 <
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 winbufnr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9945 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	9946 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	9947 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	9948 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	9949 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	9950 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	9951 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9952 :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	9953 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9954 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9955 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	9956 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9957 wincol()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9958 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	9959 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	9960 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	9961
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9962 windowsversion()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9963 windowsversion()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9964 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	9965 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	9966 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	9967 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	9968
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9969 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	9970 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	9971 {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	9972 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	9973 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	9974 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	9975 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	9976 Examples: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	9977 :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	9978
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9979 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9980 GetWinid()->winheight()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9981 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9982 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	9983 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	9984 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	9985
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9986 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	9987 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	9988 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	9989
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9990 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	9991 ['leaf', {winid}]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9992 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	9993 returns:
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9994 ['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	9995 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	9996 ['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	9997
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9998 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	9999 " 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	10000 :echo winlayout()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10001 ['leaf', 1000]
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10002 " 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	10003 :echo winlayout()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10004 ['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	10005 " 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	10006 " 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	10007 " middle window
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10008 :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	10009 ['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	10010 ['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	10011 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10012 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10013 GetTabnr()->winlayout()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10014 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10015 winline()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10016 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	10017 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	10018 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	10019 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	10020 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	10021
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10022 winnr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10023 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	10024 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	10025 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	10026
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10027 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	10028 $ 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	10029 count).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10030 # 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	10031 \|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	10032 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	10033 returned.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10034 {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	10035 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	10036 {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	10037 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	10038 {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	10039 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	10040 {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	10041 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	10042 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	10043 \|:wincmd\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10044 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	10045 Examples: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10046 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	10047 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	10048 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	10049
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10050 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10051 GetWinval()->winnr()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10052 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10053 winrestcmd()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10054 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	10055 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	10056 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	10057 unchanged.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10058 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10059 :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	10060 :call MessWithWindowSizes()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10061 :exe cmd
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10062 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10063 winrestview()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10064 winrestview({dict})
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10065 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	10066 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	10067 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	10068 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	10069 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	10070 :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	10071 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10072 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	10073 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	10074 (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	10075 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	10076
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10077 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	10078 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	10079
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10080 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10081 GetView()->winrestview()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10082 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10083 winsaveview()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10084 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	10085 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	10086 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	10087 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	10088 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	10089 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	10090 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	10091 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	10092 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	10093 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	10094 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	10095 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	10096 returns)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10097 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	10098 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	10099 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	10100 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	10101 \|$\| 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	10102 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	10103 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	10104 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	10105 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	10106 '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	10107 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	10108 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	10109
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10110
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10111 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	10112 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	10113 {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	10114 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	10115 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	10116 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	10117 Examples: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27859 diff changeset	10118 :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	10119 :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	10120 : 50 wincmd \|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10121 :endif
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10122 < 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	10123 option.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10124
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10125 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10126 GetWinid()->winwidth()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10127
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10128
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10129 wordcount() wordcount()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10130 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	10131 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	10132 \|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	10133 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	10134 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	10135 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	10136 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	10137 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	10138 (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	10139 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	10140 (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	10141 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	10142 (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	10143 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	10144 (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	10145 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	10146 (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	10147 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	10148 (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	10149
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10150
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10151 writefile()
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10152 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	10153 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	10154 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	10155 or Number.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10156 When {flags} contains "b" then binary mode is used: There will
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10157 not be a NL after the last list item. An empty item at the
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10158 end does cause the last line in the file to end 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	10159
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10160 When {object} is a \|Blob\| write the bytes to file {fname}
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10161 unmodified.
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 When {flags} contains "a" then append mode is used, lines are
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10164 appended 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	10165 :call writefile(["foo"], "event.log", "a")
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10166 :call writefile(["bar"], "event.log", "a")
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 When {flags} contains "s" then fsync() is called after writing
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10169 the file. This flushes the file to disk, if possible. This
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10170 takes more time but avoids losing the file if the system
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10171 crashes.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10172 When {flags} does not contain "S" or "s" then fsync() is
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10173 called if the 'fsync' option is set.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10174 When {flags} contains "S" then fsync() is not called, even
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10175 when 'fsync' is set.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10176
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10177 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	10178 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	10179 to writefile().
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10180 An existing file is overwritten, if possible.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10181 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	10182 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	10183 fails.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10184 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	10185 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	10186 :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	10187 :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	10188
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10189 < Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10190 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	10191
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10192
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10193 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	10194 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	10195 to a number. A List, Dict or Float argument causes an error.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10196 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10197 :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	10198 <
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10199 Can also be used as a \|method\|: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10200 :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	10201 <
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 ==============================================================================
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10204 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	10205
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10206 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	10207 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	10208 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	10209 :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	10210 < gui_running
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10211 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	10212 Example: >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10213 :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	10214 < has-patch
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10215 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	10216 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	10217 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	10218 :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	10219 < 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	10220 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	10221 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	10222 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	10223 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	10224 :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	10225
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10226 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	10227 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	10228
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 acl Compiled with \|ACL\| support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10231 all_builtin_terms Compiled with all builtin terminals enabled.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10232 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	10233 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	10234 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	10235 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	10236 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	10237 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	10238 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	10239 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	10240 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	10241 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	10242 work.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10243 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	10244 bsd Compiled on an OS in the BSD family (excluding macOS).
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10245 builtin_terms Compiled with some builtin terminals.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10246 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	10247 channel 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	10248 cindent Compiled with 'cindent' support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10249 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	10250 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	10251 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	10252 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	10253 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	10254 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	10255 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	10256 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	10257 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	10258 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	10259 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	10260 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	10261 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	10262 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	10263 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	10264 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	10265 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	10266 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	10267 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	10268 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	10269 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	10270 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	10271 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	10272 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	10273 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	10274 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	10275 \|'hlsearch'\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10276 farsi Support for Farsi was removed \|farsi\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10277 file_in_path Compiled with support for \|gf\| and \|<cfile>\|
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10278 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	10279 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	10280 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	10281 \|+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	10282 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	10283 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	10284 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	10285 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	10286 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	10287 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	10288 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	10289 gui Compiled with GUI enabled.
28379 6dd88e45d47d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28307 diff changeset	10290 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	10291 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	10292 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	10293 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	10294 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	10295 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	10296 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	10297 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	10298 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	10299 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	10300 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	10301 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	10302 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	10303 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	10304 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	10305 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	10306 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	10307 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	10308 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	10309 ipv6 Compiled with support for IPv6 networking in \|channel\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10310 jumplist Compiled with \|jumplist\| support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10311 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	10312 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	10313 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	10314 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	10315 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	10316 'breakindent' support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10317 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	10318 lispindent Compiled with support for lisp indenting.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10319 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	10320 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	10321 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	10322 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	10323 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	10324 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	10325 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	10326 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	10327 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	10328 (always true)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10329 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	10330 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	10331 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	10332 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	10333 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	10334 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	10335 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	10336 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	10337 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	10338 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	10339 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	10340 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	10341 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	10342 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	10343 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	10344 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	10345 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	10346 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	10347 netbeans_intg Compiled with support for \|netbeans\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10348 num64 Compiled with 64-bit \|Number\| support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10349 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	10350 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	10351 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	10352 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	10353 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	10354 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	10355 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	10356 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	10357 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	10358 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	10359 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	10360 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	10361 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	10362 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	10363 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	10364 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	10365 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	10366 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	10367 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	10368 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	10369 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	10370 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	10371 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	10372 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	10373 signs Compiled with \|:sign\| support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10374 smartindent Compiled with 'smartindent' support.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10375 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	10376 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	10377 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	10378 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	10379 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	10380 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	10381 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	10382 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	10383 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	10384 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	10385 current buffer.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10386 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	10387 tag_binary Compiled with binary searching in tags files
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10388 \|tag-binary-search\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10389 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	10390 \|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	10391 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	10392 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	10393 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	10394 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	10395 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	10396 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	10397 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	10398 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	10399 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	10400 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	10401 title Compiled with window title support \|'title'\|.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10402 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	10403 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	10404 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	10405 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	10406 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	10407 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	10408 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	10409 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	10410 '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	10411 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	10412 (always true)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10413 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	10414 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	10415 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	10416 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	10417 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	10418 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	10419 vimscript-3 Compiled Vim script version 3 support
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10420 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	10421 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	10422 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	10423 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	10424 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	10425 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	10426 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	10427 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	10428 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	10429 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	10430 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	10431 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	10432 64 bits)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10433 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	10434 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	10435 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	10436 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	10437 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	10438 (always true)
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10439 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	10440 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	10441 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	10442 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	10443 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	10444 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	10445 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	10446 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	10447 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	10448 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	10449 xterm screen.
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10450 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	10451
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10452
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10453 ==============================================================================
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10454 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	10455
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10456 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	10457 \|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	10458 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	10459 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	10460 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	10461 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	10462 >
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10463 :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	10464 :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	10465 aa
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10466 xx
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10467 :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	10468 a
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10469 x
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10470
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10471 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	10472 "$" 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	10473 "\n".
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10474
629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: diff changeset	10475 vim:tw=78:ts=8:noet:ft=help:norl:

Mercurial > vim

annotate runtime/doc/builtin.txt @ 28956:3e6e6b4e74eb v8.2.5000