vim: runtime/doc/if_lua.txt annotate

annotate runtime/doc/if_lua.txt @ 8581:fd454847836d v7.4.1580

commit https://github.com/vim/vim/commit/7a5c46a9df7ef01a4f6a620861c35400d5ad28d9 Author: Bram Moolenaar <Bram@vim.org> Date: Wed Mar 16 20:41:21 2016 +0100 patch 7.4.1580 Problem: Crash when using function reference. (Luchr) Solution: Set initial refcount. (Ken Takata, closes https://github.com/vim/vim/issues/690)

author	Christian Brabandt <cb@256bit.org>
date	Wed, 16 Mar 2016 20:45:05 +0100
parents	42717d048817
children	ed7251c3e2d3

rev	line source
7196 42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	1 if_lua.txt For Vim version 7.4. Last change: 2015 Oct 16
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	2
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	3
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	4 VIM REFERENCE MANUAL by Luis Carvalho
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	5
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	6
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	7 The Lua Interface to Vim lua Lua
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	8
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	9 1. Commands \|lua-commands\|
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	10 2. The vim module \|lua-vim\|
3450 b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	11 3. List userdata \|lua-list\|
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	12 4. Dict userdata \|lua-dict\|
4911 78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	13 5. Funcref userdata \|lua-funcref\|
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	14 6. Buffer userdata \|lua-buffer\|
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	15 7. Window userdata \|lua-window\|
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	16 8. The luaeval function \|lua-luaeval\|
7196 42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	17 9. Dynamic loading \|lua-dynamic\|
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	18
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	19 {Vi does not have any of these commands}
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	20
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	21 The Lua interface is available only when Vim was compiled with the
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	22 \|+lua\| feature.
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	23
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	24 ==============================================================================
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	25 1. Commands lua-commands
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	26
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	27 :lua
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	28 :[range]lua {chunk}
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	29 Execute Lua chunk {chunk}. {not in Vi}
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	30
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	31 Examples:
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	32 >
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	33 :lua print("Hello, Vim!")
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	34 :lua local curbuf = vim.buffer() curbuf[7] = "line #7"
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	35 <
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	36
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	37 :[range]lua << {endmarker}
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	38 {script}
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	39 {endmarker}
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	40 Execute Lua script {script}. {not in Vi}
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	41 Note: This command doesn't work when the Lua
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	42 feature wasn't compiled in. To avoid errors, see
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	43 \|script-here\|.
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	44
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	45 {endmarker} must NOT be preceded by any white space. If {endmarker} is
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	46 omitted from after the "<<", a dot '.' must be used after {script}, like
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	47 for the \|:append\| and \|:insert\| commands.
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	48 This form of the \|:lua\| command is mainly useful for including Lua code
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	49 in Vim scripts.
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	50
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	51 Example:
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	52 >
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	53 function! CurrentLineInfo()
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	54 lua << EOF
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	55 local linenr = vim.window().line
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	56 local curline = vim.buffer()[linenr]
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	57 print(string.format("Current line [%d] has %d chars",
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	58 linenr, #curline))
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	59 EOF
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	60 endfunction
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	61 <
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	62
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	63 :luado
3465 161d01cbb165 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3450 diff changeset	64 :[range]luado {body} Execute Lua function "function (line, linenr) {body}
161d01cbb165 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3450 diff changeset	65 end" for each line in the [range], with the function
161d01cbb165 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3450 diff changeset	66 argument being set to the text of each line in turn,
161d01cbb165 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3450 diff changeset	67 without a trailing <EOL>, and the current line number.
161d01cbb165 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3450 diff changeset	68 If the value returned by the function is a string it
161d01cbb165 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3450 diff changeset	69 becomes the text of the line in the current turn. The
161d01cbb165 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3450 diff changeset	70 default for [range] is the whole file: "1,$".
161d01cbb165 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3450 diff changeset	71 {not in Vi}
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	72
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	73 Examples:
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	74 >
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	75 :luado return string.format("%s\t%d", line:reverse(), #line)
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	76
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	77 :lua require"lpeg"
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	78 :lua -- balanced parenthesis grammar:
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	79 :lua bp = lpeg.P{ "(" * ((1 - lpeg.S"()") + lpeg.V(1))^0 * ")" }
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	80 :luado if bp:match(line) then return "-->\t" .. line end
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	81 <
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	82
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	83 :luafile
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	84 :[range]luafile {file}
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	85 Execute Lua script in {file}. {not in Vi}
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	86 The whole argument is used as a single file name.
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	87
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	88 Examples:
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	89 >
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	90 :luafile script.lua
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	91 :luafile %
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	92 <
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	93
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	94 All these commands execute a Lua chunk from either the command line (:lua and
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	95 :luado) or a file (:luafile) with the given line [range]. Similarly to the Lua
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	96 interpreter, each chunk has its own scope and so only global variables are
3450 b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	97 shared between command calls. All Lua default libraries are available. In
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	98 addition, Lua "print" function has its output redirected to the Vim message
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	99 area, with arguments separated by a white space instead of a tab.
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	100
2337 a0f87fc19d1d Better conceal in help. (partly by Dominique Pelle) Bram Moolenaar <bram@vim.org> parents: 2320 diff changeset	101 Lua uses the "vim" module (see \|lua-vim\|) to issue commands to Vim
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	102 and manage buffers (\|lua-buffer\|) and windows (\|lua-window\|). However,
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	103 procedures that alter buffer content, open new buffers, and change cursor
2337 a0f87fc19d1d Better conceal in help. (partly by Dominique Pelle) Bram Moolenaar <bram@vim.org> parents: 2320 diff changeset	104 position are restricted when the command is executed in the \|sandbox\|.
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	105
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	106
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	107 ==============================================================================
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	108 2. The vim module lua-vim
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	109
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	110 Lua interfaces Vim through the "vim" module. The first and last line of the
2373 f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	111 input range are stored in "vim.firstline" and "vim.lastline" respectively. The
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	112 module also includes routines for buffer, window, and current line queries,
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	113 Vim evaluation and command execution, and others.
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	114
4911 78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	115 vim.list([arg]) Returns an empty list or, if "arg" is a Lua
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	116 table with numeric keys 1, ..., n (a
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	117 "sequence"), returns a list l such that l[i] =
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	118 arg[i] for i = 1, ..., n (see \|List\|).
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	119 Non-numeric keys are not used to initialize
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	120 the list. See also \|lua-eval\| for conversion
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	121 rules. Example: >
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	122 :lua t = {math.pi, false, say = 'hi'}
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	123 :echo luaeval('vim.list(t)')
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	124 :" [3.141593, 0], 'say' is ignored
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	125 <
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	126 vim.dict([arg]) Returns an empty dictionary or, if "arg" is a
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	127 Lua table, returns a dict d such that d[k] =
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	128 arg[k] for all string keys k in "arg" (see
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	129 \|Dictionary\|). Number keys are converted to
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	130 strings. Keys that are not strings are not
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	131 used to initialize the dictionary. See also
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	132 \|lua-eval\| for conversion rules. Example: >
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	133 :lua t = {math.pi, false, say = 'hi'}
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	134 :echo luaeval('vim.dict(t)')
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	135 :" {'say': 'hi'}, numeric keys ignored
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	136 <
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	137 vim.funcref({name}) Returns a Funcref to function {name} (see
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	138 \|Funcref\|). It is equivalent to Vim's
5340 22da5ab9aaa1 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 5294 diff changeset	139 "function". NOT IMPLEMENTED YET
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	140
2373 f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	141 vim.buffer([arg]) If "arg" is a number, returns buffer with
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	142 number "arg" in the buffer list or, if "arg"
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	143 is a string, returns buffer whose full or short
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	144 name is "arg". In both cases, returns 'nil'
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	145 (nil value, not string) if the buffer is not
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	146 found. Otherwise, if "toboolean(arg)" is
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	147 'true' returns the first buffer in the buffer
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	148 list or else the current buffer.
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	149
2373 f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	150 vim.window([arg]) If "arg" is a number, returns window with
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	151 number "arg" or 'nil' (nil value, not string)
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	152 if not found. Otherwise, if "toboolean(arg)"
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	153 is 'true' returns the first window or else the
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	154 current window.
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	155
3450 b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	156 vim.type({arg}) Returns the type of {arg}. It is equivalent to
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	157 Lua's "type" function, but returns "list",
4911 78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	158 "dict", "funcref", "buffer", or "window" if
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	159 {arg} is a list, dictionary, funcref, buffer,
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	160 or window, respectively. Examples: >
3450 b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	161 :lua l = vim.list()
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	162 :lua print(type(l), vim.type(l))
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	163 :" userdata list
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	164 <
2373 f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	165 vim.command({cmd}) Executes the vim (ex-mode) command {cmd}.
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	166 Examples: >
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	167 :lua vim.command"set tw=60"
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	168 :lua vim.command"normal ddp"
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	169 <
2373 f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	170 vim.eval({expr}) Evaluates expression {expr} (see \|expression\|),
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	171 converts the result to Lua, and returns it.
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	172 Vim strings and numbers are directly converted
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	173 to Lua strings and numbers respectively. Vim
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	174 lists and dictionaries are converted to Lua
3450 b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	175 userdata (see \|lua-list\| and \|lua-dict\|).
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	176 Examples: >
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	177 :lua tw = vim.eval"&tw"
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	178 :lua print(vim.eval"{'a': 'one'}".a)
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	179 <
2373 f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	180 vim.line() Returns the current line (without the trailing
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	181 <EOL>), a Lua string.
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	182
2373 f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	183 vim.beep() Beeps.
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	184
2373 f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	185 vim.open({fname}) Opens a new buffer for file {fname} and
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	186 returns it. Note that the buffer is not set as
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	187 current.
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	188
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	189
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	190 ==============================================================================
3450 b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	191 3. List userdata lua-list
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	192
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	193 List userdata represent vim lists, and the interface tries to follow closely
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	194 Vim's syntax for lists. Since lists are objects, changes in list references in
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	195 Lua are reflected in Vim and vice-versa. A list "l" has the following
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	196 properties and methods:
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	197
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	198 Properties
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	199 ----------
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	200 o "#l" is the number of items in list "l", equivalent to "len(l)"
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	201 in Vim.
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	202 o "l[k]" returns the k-th item in "l"; "l" is zero-indexed, as in Vim.
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	203 To modify the k-th item, simply do "l[k] = newitem"; in
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	204 particular, "l[k] = nil" removes the k-th item from "l".
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	205 o "l()" returns an iterator for "l".
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	206
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	207 Methods
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	208 -------
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	209 o "l:add(item)" appends "item" to the end of "l".
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	210 o "l:insert(item[, pos])" inserts "item" at (optional)
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	211 position "pos" in the list. The default value for "pos" is 0.
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	212
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	213 Examples:
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	214 >
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	215 :let l = [1, 'item']
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	216 :lua l = vim.eval('l') -- same 'l'
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	217 :lua l:add(vim.list())
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	218 :lua l[0] = math.pi
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	219 :echo l[0] " 3.141593
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	220 :lua l[0] = nil -- remove first item
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	221 :lua l:insert(true, 1)
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	222 :lua print(l, #l, l[0], l[1], l[-1])
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	223 :lua for item in l() do print(item) end
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	224 <
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	225
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	226 ==============================================================================
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	227 4. Dict userdata lua-dict
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	228
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	229 Similarly to list userdata, dict userdata represent vim dictionaries; since
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	230 dictionaries are also objects, references are kept between Lua and Vim. A dict
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	231 "d" has the following properties:
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	232
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	233 Properties
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	234 ----------
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	235 o "#d" is the number of items in dict "d", equivalent to "len(d)"
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	236 in Vim.
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	237 o "d.key" or "d['key']" returns the value at entry "key" in "d".
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	238 To modify the entry at this key, simply do "d.key = newvalue"; in
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	239 particular, "d.key = nil" removes the entry from "d".
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	240 o "d()" returns an iterator for "d" and is equivalent to "items(d)" in
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	241 Vim.
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	242
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	243 Examples:
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	244 >
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	245 :let d = {'n':10}
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	246 :lua d = vim.eval('d') -- same 'd'
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	247 :lua print(d, d.n, #d)
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	248 :let d.self = d
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	249 :lua for k, v in d() do print(d, k, v) end
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	250 :lua d.x = math.pi
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	251 :lua d.self = nil -- remove entry
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	252 :echo d
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	253 <
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	254
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	255 ==============================================================================
4911 78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	256 5. Funcref userdata lua-funcref
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	257
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	258 Funcref userdata represent funcref variables in Vim. Funcrefs that were
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	259 defined with a "dict" attribute need to be obtained as a dictionary key
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	260 in order to have "self" properly assigned to the dictionary (see examples
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	261 below.) A funcref "f" has the following properties:
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	262
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	263 Properties
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	264 ----------
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	265 o "#f" is the name of the function referenced by "f"
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	266 o "f(...)" calls the function referenced by "f" (with arguments)
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	267
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	268 Examples:
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	269 >
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	270 :function I(x)
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	271 : return a:x
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	272 : endfunction
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	273 :let R = function('I')
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	274 :lua i1 = vim.funcref('I')
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	275 :lua i2 = vim.eval('R')
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	276 :lua print(#i1, #i2) -- both 'I'
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	277 :lua print(i1, i2, #i2(i1) == #i1(i2))
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	278 :function Mylen() dict
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	279 : return len(self.data)
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	280 : endfunction
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	281 :let mydict = {'data': [0, 1, 2, 3]}
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	282 :lua d = vim.eval('mydict'); d.len = vim.funcref('Mylen')
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	283 :echo mydict.len()
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	284 :lua l = d.len -- assign d as 'self'
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	285 :lua print(l())
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	286 <
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	287
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	288 ==============================================================================
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	289 6. Buffer userdata lua-buffer
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	290
2373 f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	291 Buffer userdata represent vim buffers. A buffer userdata "b" has the following
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	292 properties and methods:
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	293
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	294 Properties
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	295 ----------
2373 f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	296 o "b()" sets "b" as the current buffer.
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	297 o "#b" is the number of lines in buffer "b".
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	298 o "b[k]" represents line number k: "b[k] = newline" replaces line k
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	299 with string "newline" and "b[k] = nil" deletes line k.
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	300 o "b.name" contains the short name of buffer "b" (read-only).
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	301 o "b.fname" contains the full name of buffer "b" (read-only).
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	302 o "b.number" contains the position of buffer "b" in the buffer list
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	303 (read-only).
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	304
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	305 Methods
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	306 -------
2373 f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	307 o "b:insert(newline[, pos])" inserts string "newline" at (optional)
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	308 position "pos" in the buffer. The default value for "pos" is
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	309 "#b + 1". If "pos == 0" then "newline" becomes the first line in
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	310 the buffer.
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	311 o "b:next()" returns the buffer next to "b" in the buffer list.
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	312 o "b:previous()" returns the buffer previous to "b" in the buffer
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	313 list.
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	314 o "b:isvalid()" returns 'true' (boolean) if buffer "b" corresponds to
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	315 a "real" (not freed from memory) Vim buffer.
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	316
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	317 Examples:
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	318 >
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	319 :lua b = vim.buffer() -- current buffer
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	320 :lua print(b.name, b.number)
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	321 :lua b[1] = "first line"
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	322 :lua b:insert("FIRST!", 0)
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	323 :lua b[1] = nil -- delete top line
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	324 :lua for i=1,3 do b:insert(math.random()) end
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	325 :3,4lua for i=vim.lastline,vim.firstline,-1 do b[i] = nil end
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	326 :lua vim.open"myfile"() -- open buffer and set it as current
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	327
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	328 function! ListBuffers()
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	329 lua << EOF
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	330 local b = vim.buffer(true) -- first buffer in list
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	331 while b ~= nil do
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	332 print(b.number, b.name, #b)
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	333 b = b:next()
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	334 end
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	335 vim.beep()
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	336 EOF
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	337 endfunction
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	338 <
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	339
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	340 ==============================================================================
4911 78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	341 7. Window userdata lua-window
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	342
2373 f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	343 Window objects represent vim windows. A window userdata "w" has the following
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	344 properties and methods:
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	345
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	346 Properties
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	347 ----------
2373 f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	348 o "w()" sets "w" as the current window.
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	349 o "w.buffer" contains the buffer of window "w" (read-only).
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	350 o "w.line" represents the cursor line position in window "w".
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	351 o "w.col" represents the cursor column position in window "w".
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	352 o "w.width" represents the width of window "w".
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	353 o "w.height" represents the height of window "w".
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	354
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	355 Methods
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	356 -------
2373 f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	357 o "w:next()" returns the window next to "w".
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	358 o "w:previous()" returns the window previous to "w".
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	359 o "w:isvalid()" returns 'true' (boolean) if window "w" corresponds to
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	360 a "real" (not freed from memory) Vim window.
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	361
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	362 Examples:
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	363 >
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	364 :lua w = vim.window() -- current window
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	365 :lua print(w.buffer.name, w.line, w.col)
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	366 :lua w.width = w.width + math.random(10)
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	367 :lua w.height = 2 * math.random() * w.height
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	368 :lua n,w = 0,vim.window(true) while w~=nil do n,w = n + 1,w:next() end
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	369 :lua print("There are " .. n .. " windows")
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	370 <
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	371
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	372 ==============================================================================
4911 78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	373 8. The luaeval function lua-luaeval lua-eval
3450 b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	374
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	375 The (dual) equivalent of "vim.eval" for passing Lua values to Vim is
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	376 "luaeval". "luaeval" takes an expression string and an optional argument and
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	377 returns the result of the expression. It is semantically equivalent in Lua to:
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	378 >
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	379 local chunkheader = "local _A = select(1, ...) return "
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	380 function luaeval (expstr, arg)
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	381 local chunk = assert(loadstring(chunkheader .. expstr, "luaeval"))
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	382 return chunk(arg) -- return typval
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	383 end
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	384 <
4911 78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	385 Note that "_A" receives the argument to "luaeval". Lua numbers, strings, and
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	386 list, dict, and funcref userdata are converted to their Vim respective types,
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	387 while Lua booleans are converted to numbers. An error is thrown if conversion
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	388 of any of the remaining Lua types, including userdata other than lists, dicts,
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	389 and funcrefs, is attempted.
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	390
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	391 Examples: >
3450 b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	392
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	393 :echo luaeval('math.pi')
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	394 :lua a = vim.list():add('newlist')
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	395 :let a = luaeval('a')
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	396 :echo a[0] " 'newlist'
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	397 :function Rand(x,y) " random uniform between x and y
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	398 : return luaeval('(_A.y-_A.x)*math.random()+_A.x', {'x':a:x,'y':a:y})
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	399 : endfunction
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	400 :echo Rand(1,10)
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	401
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	402
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	403 ==============================================================================
7196 42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	404 9. Dynamic loading lua-dynamic
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	405
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	406 On MS-Windows and Unix the Lua library can be loaded dynamically. The
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	407 \|:version\| output then includes \|+lua/dyn\|.
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	408
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	409 This means that Vim will search for the Lua DLL or shared library file only
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	410 when needed. When you don't use the Lua interface you don't need it, thus
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	411 you can use Vim without this file.
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	412
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	413 On MS-Windows to use the Lua interface the Lua DLL must be in your search path.
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	414 In a console window type "path" to see what directories are used. The version
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	415 of the DLL must match the Lua version Vim was compiled with.
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	416
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	417 On Unix the 'luadll' option can be used to specify the Lua shared library file
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	418 instead of DYNAMIC_LUA_DLL file what was specified at compile time. The
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	419 version of the shared library must match the Lua version Vim was compiled with.
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	420
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	421
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	422 ==============================================================================
3450 b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	423 vim:tw=78:ts=8:noet:ft=help:norl:

Mercurial > vim

annotate runtime/doc/if_lua.txt @ 8581:fd454847836d v7.4.1580