vim: runtime/doc/if_lua.txt annotate

annotate runtime/doc/if_lua.txt @ 16553:0e473e9e70c2 v8.1.1280

patch 8.1.1280: remarks about functionality not in Vi clutters the help commit https://github.com/vim/vim/commit/25c9c680ec4dfbb51f4ef21c3460a48d3c67ffc8 Author: Bram Moolenaar <Bram@vim.org> Date: Sun May 5 18:13:34 2019 +0200 patch 8.1.1280: remarks about functionality not in Vi clutters the help Problem: Remarks about functionality not in Vi clutters the help. Solution: Move all info about what is new in Vim or already existed in Vi to vi_diff.txt. Remove {not in Vi} remarks. (closes #4268) Add "noet" to the help files modeline. Also include many other help file improvements.

author	Bram Moolenaar <Bram@vim.org>
date	Sun, 05 May 2019 18:15:06 +0200
parents	a2f0e93a5857
children	2704c4e3e20a

rev	line source
16553 0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help Bram Moolenaar <Bram@vim.org> parents: 16076 diff changeset	1 if_lua.txt For Vim version 8.1. Last change: 2019 May 05
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\|
16076 a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	13 5. Blob userdata \|lua-blob\|
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	14 6. Funcref userdata \|lua-funcref\|
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	15 7. Buffer userdata \|lua-buffer\|
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	16 8. Window userdata \|lua-window\|
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	17 9. luaeval() Vim function \|lua-luaeval\|
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	18 10. Dynamic loading \|lua-dynamic\|
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	19
16553 0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help Bram Moolenaar <Bram@vim.org> parents: 16076 diff changeset	20 {only available when Vim was compiled with the \|+lua\| feature}
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	21
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	22 ==============================================================================
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	23 1. Commands lua-commands
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 :lua
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	26 :[range]lua {chunk}
16553 0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help Bram Moolenaar <Bram@vim.org> parents: 16076 diff changeset	27 Execute Lua chunk {chunk}.
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	28
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	29 Examples:
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 :lua print("Hello, Vim!")
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	32 :lua local curbuf = vim.buffer() curbuf[7] = "line #7"
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	33 <
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	34
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	35 :[range]lua << {endmarker}
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	36 {script}
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	37 {endmarker}
16553 0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help Bram Moolenaar <Bram@vim.org> parents: 16076 diff changeset	38 Execute Lua script {script}.
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	39 Note: This command doesn't work when the Lua
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	40 feature wasn't compiled in. To avoid errors, see
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	41 \|script-here\|.
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	42
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	43 {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	44 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	45 for the \|:append\| and \|:insert\| commands.
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	46 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	47 in Vim scripts.
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	48
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	49 Example:
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 function! CurrentLineInfo()
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	52 lua << EOF
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	53 local linenr = vim.window().line
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	54 local curline = vim.buffer()[linenr]
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	55 print(string.format("Current line [%d] has %d chars",
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	56 linenr, #curline))
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	57 EOF
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	58 endfunction
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	59 <
10153 715d6c5707b8 commit https://github.com/vim/vim/commit/abd468ed0fbcba391e7833feeaa7de3ced841455 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	60 To see what version of Lua you have: >
715d6c5707b8 commit https://github.com/vim/vim/commit/abd468ed0fbcba391e7833feeaa7de3ced841455 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	61 :lua print(_VERSION)
715d6c5707b8 commit https://github.com/vim/vim/commit/abd468ed0fbcba391e7833feeaa7de3ced841455 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	62
715d6c5707b8 commit https://github.com/vim/vim/commit/abd468ed0fbcba391e7833feeaa7de3ced841455 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	63 If you use LuaJIT you can also use this: >
715d6c5707b8 commit https://github.com/vim/vim/commit/abd468ed0fbcba391e7833feeaa7de3ced841455 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	64 :lua print(jit.version)
715d6c5707b8 commit https://github.com/vim/vim/commit/abd468ed0fbcba391e7833feeaa7de3ced841455 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	65 <
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	66
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	67 :luado
3465 161d01cbb165 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3450 diff changeset	68 :[range]luado {body} Execute Lua function "function (line, linenr) {body}
161d01cbb165 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3450 diff changeset	69 end" for each line in the [range], with the function
161d01cbb165 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3450 diff changeset	70 argument being set to the text of each line in turn,
161d01cbb165 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3450 diff changeset	71 without a trailing <EOL>, and the current line number.
161d01cbb165 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3450 diff changeset	72 If the value returned by the function is a string it
161d01cbb165 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3450 diff changeset	73 becomes the text of the line in the current turn. The
161d01cbb165 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3450 diff changeset	74 default for [range] is the whole file: "1,$".
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	75
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	76 Examples:
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	77 >
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	78 :luado return string.format("%s\t%d", line:reverse(), #line)
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	79
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	80 :lua require"lpeg"
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	81 :lua -- balanced parenthesis grammar:
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	82 :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	83 :luado if bp:match(line) then return "-->\t" .. line end
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	84 <
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	85
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	86 :luafile
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	87 :[range]luafile {file}
16553 0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help Bram Moolenaar <Bram@vim.org> parents: 16076 diff changeset	88 Execute Lua script in {file}.
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	89 The whole argument is used as a single file name.
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	90
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	91 Examples:
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 :luafile script.lua
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	94 :luafile %
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	95 <
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	96
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	97 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	98 :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	99 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	100 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	101 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	102 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	103
2337 a0f87fc19d1d Better conceal in help. (partly by Dominique Pelle) Bram Moolenaar <bram@vim.org> parents: 2320 diff changeset	104 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	105 and manage buffers (\|lua-buffer\|) and windows (\|lua-window\|). However,
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	106 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	107 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	108
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 ==============================================================================
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	111 2. The vim module lua-vim
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	112
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	113 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	114 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	115 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	116 Vim evaluation and command execution, and others.
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	117
4911 78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	118 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	119 table with numeric keys 1, ..., n (a
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	120 "sequence"), returns a list l such that l[i] =
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	121 arg[i] for i = 1, ..., n (see \|List\|).
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	122 Non-numeric keys are not used to initialize
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	123 the list. See also \|lua-eval\| for conversion
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	124 rules. Example: >
14298 4a588e3afd4a Update runtime files, add Danish translations. Christian Brabandt <cb@256bit.org> parents: 14239 diff changeset	125 :lua t = {math.pi, false, say = 'hi'}
4a588e3afd4a Update runtime files, add Danish translations. Christian Brabandt <cb@256bit.org> parents: 14239 diff changeset	126 :echo luaeval('vim.list(t)')
4a588e3afd4a Update runtime files, add Danish translations. Christian Brabandt <cb@256bit.org> parents: 14239 diff changeset	127 :" [3.141593, v:false], 'say' is ignored
4911 78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	128 <
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	129 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	130 Lua table, returns a dict d such that d[k] =
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	131 arg[k] for all string keys k in "arg" (see
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	132 \|Dictionary\|). Number keys are converted to
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	133 strings. Keys that are not strings are not
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	134 used to initialize the dictionary. See also
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	135 \|lua-eval\| for conversion rules. Example: >
14298 4a588e3afd4a Update runtime files, add Danish translations. Christian Brabandt <cb@256bit.org> parents: 14239 diff changeset	136 :lua t = {math.pi, false, say = 'hi'}
4a588e3afd4a Update runtime files, add Danish translations. Christian Brabandt <cb@256bit.org> parents: 14239 diff changeset	137 :echo luaeval('vim.dict(t)')
4a588e3afd4a Update runtime files, add Danish translations. Christian Brabandt <cb@256bit.org> parents: 14239 diff changeset	138 :" {'1': 3.141593, '2': v:false,
4a588e3afd4a Update runtime files, add Danish translations. Christian Brabandt <cb@256bit.org> parents: 14239 diff changeset	139 :" 'say': 'hi'}
4911 78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	140 <
16076 a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	141 vim.blob([arg]) Returns an empty blob or, if "arg" is a Lua
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	142 string, returns a blob b such that b is
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	143 equivalent to "arg" as a byte string.
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	144 Examples: >
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	145 :lua s = "12ab\x00\x80\xfe\xff"
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	146 :echo luaeval('vim.blob(s)')
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	147 :" 0z31326162.0080FEFF
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	148 <
4911 78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	149 vim.funcref({name}) Returns a Funcref to function {name} (see
14298 4a588e3afd4a Update runtime files, add Danish translations. Christian Brabandt <cb@256bit.org> parents: 14239 diff changeset	150 \|Funcref\|). It is equivalent to Vim's
4a588e3afd4a Update runtime files, add Danish translations. Christian Brabandt <cb@256bit.org> parents: 14239 diff changeset	151 function().
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	152
2373 f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	153 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	154 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	155 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	156 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	157 (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	158 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	159 '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	160 list or else the current buffer.
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	161
2373 f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	162 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	163 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	164 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	165 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	166 current window.
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	167
3450 b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	168 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	169 Lua's "type" function, but returns "list",
4911 78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	170 "dict", "funcref", "buffer", or "window" if
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	171 {arg} is a list, dictionary, funcref, buffer,
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	172 or window, respectively. Examples: >
3450 b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	173 :lua l = vim.list()
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	174 :lua print(type(l), vim.type(l))
14239 7457bf2db968 patch 8.1.0136: Lua tests don't cover new features Christian Brabandt <cb@256bit.org> parents: 13963 diff changeset	175 :" list
3450 b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	176 <
2373 f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	177 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	178 Examples: >
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	179 :lua vim.command"set tw=60"
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	180 :lua vim.command"normal ddp"
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	181 <
2373 f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	182 vim.eval({expr}) Evaluates expression {expr} (see \|expression\|),
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	183 converts the result to Lua, and returns it.
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	184 Vim strings and numbers are directly converted
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	185 to Lua strings and numbers respectively. Vim
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	186 lists and dictionaries are converted to Lua
3450 b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	187 userdata (see \|lua-list\| and \|lua-dict\|).
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	188 Examples: >
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	189 :lua tw = vim.eval"&tw"
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	190 :lua print(vim.eval"{'a': 'one'}".a)
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	191 <
2373 f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	192 vim.line() Returns the current line (without the trailing
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	193 <EOL>), a Lua string.
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	194
2373 f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	195 vim.beep() Beeps.
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	196
2373 f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	197 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	198 returns it. Note that the buffer is not set as
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	199 current.
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	200
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	201
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	202 ==============================================================================
3450 b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	203 3. List userdata lua-list
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	204
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	205 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	206 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	207 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	208 properties and methods:
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	209
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	210 Properties
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	211 ----------
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	212 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	213 in Vim.
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	214 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	215 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	216 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	217 o "l()" returns an iterator for "l".
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	218
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	219 Methods
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	220 -------
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	221 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	222 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	223 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	224
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	225 Examples:
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 :let l = [1, 'item']
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	228 :lua l = vim.eval('l') -- same 'l'
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	229 :lua l:add(vim.list())
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	230 :lua l[0] = math.pi
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	231 :echo l[0] " 3.141593
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	232 :lua l[0] = nil -- remove first item
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	233 :lua l:insert(true, 1)
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	234 :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	235 :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	236 <
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	237
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	238 ==============================================================================
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	239 4. Dict userdata lua-dict
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	240
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	241 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	242 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	243 "d" has the following properties:
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 Properties
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	246 ----------
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	247 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	248 in Vim.
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	249 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	250 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	251 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	252 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	253 Vim.
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 Examples:
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	256 >
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	257 :let d = {'n':10}
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	258 :lua d = vim.eval('d') -- same 'd'
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	259 :lua print(d, d.n, #d)
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	260 :let d.self = d
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	261 :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	262 :lua d.x = math.pi
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	263 :lua d.self = nil -- remove entry
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	264 :echo d
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	265 <
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	266
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	267 ==============================================================================
16076 a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	268 5. Blob userdata lua-blob
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	269
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	270 Blob userdata represent vim blobs. A blob "b" has the following properties:
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	271
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	272 Properties
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	273 ----------
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	274 o "#b" is the length of blob "b", equivalent to "len(b)" in Vim.
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	275 o "b[k]" returns the k-th item in "b"; "b" is zero-indexed, as in Vim.
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	276 To modify the k-th item, simply do "b[k] = number"; in particular,
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	277 "b[#b] = number" can append a byte to tail.
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	278
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	279 Methods
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	280 -------
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	281 o "b:add(bytes)" appends "bytes" to the end of "b".
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	282
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	283 Examples:
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	284 >
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	285 :let b = 0z001122
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	286 :lua b = vim.eval('b') -- same 'b'
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	287 :lua print(b, b[0], #b)
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	288 :lua b[1] = 32
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	289 :lua b[#b] = 0x33 -- append a byte to tail
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	290 :lua b:add("\x80\x81\xfe\xff")
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	291 :echo b
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	292 <
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	293
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	294 ==============================================================================
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	295 6. Funcref userdata lua-funcref
4911 78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	296
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	297 Funcref userdata represent funcref variables in Vim. Funcrefs that were
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	298 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	299 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	300 below.) A funcref "f" has the following properties:
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	301
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	302 Properties
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	303 ----------
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	304 o "#f" is the name of the function referenced by "f"
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	305 o "f(...)" calls the function referenced by "f" (with arguments)
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	306
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	307 Examples:
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	308 >
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	309 :function I(x)
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	310 : return a:x
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	311 : endfunction
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	312 :let R = function('I')
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	313 :lua i1 = vim.funcref('I')
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	314 :lua i2 = vim.eval('R')
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	315 :lua print(#i1, #i2) -- both 'I'
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	316 :lua print(i1, i2, #i2(i1) == #i1(i2))
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	317 :function Mylen() dict
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	318 : return len(self.data)
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	319 : endfunction
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	320 :let mydict = {'data': [0, 1, 2, 3]}
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	321 :lua d = vim.eval('mydict'); d.len = vim.funcref('Mylen')
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	322 :echo mydict.len()
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	323 :lua l = d.len -- assign d as 'self'
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	324 :lua print(l())
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	325 <
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	326
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	327 ==============================================================================
16076 a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	328 7. Buffer userdata lua-buffer
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	329
2373 f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	330 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	331 properties and methods:
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	332
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	333 Properties
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	334 ----------
2373 f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	335 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	336 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	337 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	338 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	339 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	340 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	341 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	342 (read-only).
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	343
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	344 Methods
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	345 -------
2373 f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	346 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	347 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	348 "#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	349 the buffer.
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	350 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	351 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	352 list.
f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	353 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	354 a "real" (not freed from memory) Vim buffer.
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	355
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	356 Examples:
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	357 >
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	358 :lua b = vim.buffer() -- current buffer
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	359 :lua print(b.name, b.number)
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	360 :lua b[1] = "first line"
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	361 :lua b:insert("FIRST!", 0)
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	362 :lua b[1] = nil -- delete top line
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	363 :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	364 :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	365 :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	366
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	367 function! ListBuffers()
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	368 lua << EOF
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	369 local b = vim.buffer(true) -- first buffer in list
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	370 while b ~= nil do
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	371 print(b.number, b.name, #b)
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	372 b = b:next()
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	373 end
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	374 vim.beep()
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	375 EOF
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	376 endfunction
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	377 <
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	378
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	379 ==============================================================================
16076 a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	380 8. Window userdata lua-window
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	381
2373 f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	382 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	383 properties and methods:
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	384
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	385 Properties
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	386 ----------
2373 f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	387 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	388 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	389 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	390 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	391 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	392 o "w.height" represents the height of window "w".
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	393
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	394 Methods
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	395 -------
2373 f149bb1cf5be Make it possible to load Lua dynamically on Unix. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	396 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	397 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	398 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	399 a "real" (not freed from memory) Vim window.
2320 966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	400
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	401 Examples:
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	402 >
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	403 :lua w = vim.window() -- current window
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	404 :lua print(w.buffer.name, w.line, w.col)
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	405 :lua w.width = w.width + math.random(10)
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	406 :lua w.height = 2 * math.random() * w.height
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	407 :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	408 :lua print("There are " .. n .. " windows")
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	409 <
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	410
966a5609669e Added Lua interfae. (Luis Carvalho) Bram Moolenaar <bram@vim.org> parents: diff changeset	411 ==============================================================================
16076 a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	412 9. luaeval() Vim function lua-luaeval lua-eval
3450 b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	413
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	414 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	415 "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	416 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	417 >
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	418 local chunkheader = "local _A = select(1, ...) return "
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	419 function luaeval (expstr, arg)
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	420 local chunk = assert(loadstring(chunkheader .. expstr, "luaeval"))
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	421 return chunk(arg) -- return typval
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	422 end
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	423 <
4911 78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	424 Note that "_A" receives the argument to "luaeval". Lua numbers, strings, and
16076 a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	425 list, dict, blob, and funcref userdata are converted to their Vim respective
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	426 types, while Lua booleans are converted to numbers. An error is thrown if
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	427 conversion of any of the remaining Lua types, including userdata other than
a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	428 lists, dicts, blobs, and funcrefs, is attempted.
4911 78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	429
78c318784090 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3682 diff changeset	430 Examples: >
3450 b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	431
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	432 :echo luaeval('math.pi')
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	433 :lua a = vim.list():add('newlist')
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	434 :let a = luaeval('a')
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	435 :echo a[0] " 'newlist'
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	436 :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	437 : 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	438 : endfunction
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	439 :echo Rand(1,10)
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	440
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	441
b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	442 ==============================================================================
16076 a2f0e93a5857 patch 8.1.1043: Lua interface does not support Blob Bram Moolenaar <Bram@vim.org> parents: 14298 diff changeset	443 10. Dynamic loading lua-dynamic
7196 42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	444
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	445 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	446 \|:version\| output then includes \|+lua/dyn\|.
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	447
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	448 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	449 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	450 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	451
8673 ed7251c3e2d3 commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07 Christian Brabandt <cb@256bit.org> parents: 7196 diff changeset	452
ed7251c3e2d3 commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07 Christian Brabandt <cb@256bit.org> parents: 7196 diff changeset	453 MS-Windows ~
7196 42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	454
8673 ed7251c3e2d3 commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07 Christian Brabandt <cb@256bit.org> parents: 7196 diff changeset	455 To use the Lua interface the Lua DLL must be in your search path. In a
ed7251c3e2d3 commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07 Christian Brabandt <cb@256bit.org> parents: 7196 diff changeset	456 console window type "path" to see what directories are used. The 'luadll'
ed7251c3e2d3 commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07 Christian Brabandt <cb@256bit.org> parents: 7196 diff changeset	457 option can be also used to specify the Lua DLL. The version of the DLL must
ed7251c3e2d3 commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07 Christian Brabandt <cb@256bit.org> parents: 7196 diff changeset	458 match the Lua version Vim was compiled with.
ed7251c3e2d3 commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07 Christian Brabandt <cb@256bit.org> parents: 7196 diff changeset	459
ed7251c3e2d3 commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07 Christian Brabandt <cb@256bit.org> parents: 7196 diff changeset	460
ed7251c3e2d3 commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07 Christian Brabandt <cb@256bit.org> parents: 7196 diff changeset	461 Unix ~
ed7251c3e2d3 commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07 Christian Brabandt <cb@256bit.org> parents: 7196 diff changeset	462
ed7251c3e2d3 commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07 Christian Brabandt <cb@256bit.org> parents: 7196 diff changeset	463 The 'luadll' option can be used to specify the Lua shared library file instead
ed7251c3e2d3 commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07 Christian Brabandt <cb@256bit.org> parents: 7196 diff changeset	464 of DYNAMIC_LUA_DLL file what was specified at compile time. The version of
ed7251c3e2d3 commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07 Christian Brabandt <cb@256bit.org> parents: 7196 diff changeset	465 the shared library must match the Lua version Vim was compiled with.
7196 42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	466
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	467
42717d048817 commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920 Christian Brabandt <cb@256bit.org> parents: 5340 diff changeset	468 ==============================================================================
3450 b067b8b81be9 updated for version 7.3.490 Bram Moolenaar <bram@vim.org> parents: 2572 diff changeset	469 vim:tw=78:ts=8:noet:ft=help:norl:

Mercurial > vim

annotate runtime/doc/if_lua.txt @ 16553:0e473e9e70c2 v8.1.1280