vim: runtime/doc/if_lua.txt comparison

comparison runtime/doc/if_lua.txt @ 16076:a2f0e93a5857 v8.1.1043

patch 8.1.1043: Lua interface does not support Blob commit https://github.com/vim/vim/commit/b78286903300477bb8578a47b8170b4551e290c8 Author: Bram Moolenaar <Bram@vim.org> Date: Sat Mar 23 13:57:02 2019 +0100 patch 8.1.1043: Lua interface does not support Blob Problem: Lua interface does not support Blob. Solution: Add support to Blob. (Ozaki Kiichi, closes https://github.com/vim/vim/issues/4151)

author	Bram Moolenaar <Bram@vim.org>
date	Sat, 23 Mar 2019 14:00:06 +0100
parents	4a588e3afd4a
children	0e473e9e70c2

comparison

equal deleted inserted replaced

-:5ca428f99af9
+:a2f0e93a5857
 1. Commands			|lua-commands|
 2. The vim module		|lua-vim|
 3. List userdata		|lua-list|
 4. Dict userdata		|lua-dict|
-5. Funcref userdata		|lua-funcref|
+5. Blob userdata		|lua-blob|
-6. Buffer userdata		|lua-buffer|
+6. Funcref userdata		|lua-funcref|
-7. Window userdata		|lua-window|
+7. Buffer userdata		|lua-buffer|
-8. The luaeval function		|lua-luaeval|
+8. Window userdata		|lua-window|
-9. Dynamic loading		|lua-dynamic|
+9. luaeval() Vim function	|lua-luaeval|
+10. Dynamic loading		|lua-dynamic|
 {Vi does not have any of these commands}
 The Lua interface is available only when Vim was compiled with the
 |+lua| feature.
 				    :lua t = {math.pi, false, say = 'hi'}
 				    :echo luaeval('vim.dict(t)')
 				    :" {'1': 3.141593, '2': v:false,
 				    :" 'say': 'hi'}
 <
+	vim.blob([arg])		Returns an empty blob or, if "arg" is a Lua
+				string, returns a blob b such that b is
+				equivalent to "arg" as a byte string.
+				Examples: >
+				    :lua s = "12ab\x00\x80\xfe\xff"
+				    :echo luaeval('vim.blob(s)')
+				    :" 0z31326162.0080FEFF
+<
 	vim.funcref({name})	Returns a Funcref to function {name} (see
 				|Funcref|). It is equivalent to Vim's
 				function().
 	vim.buffer([arg])	If "arg" is a number, returns buffer with
 	:lua d.self = nil -- remove entry
 	:echo d
 <
 ==============================================================================
-5. Funcref userdata					*lua-funcref*
+5. Blob userdata					*lua-blob*
+Blob userdata represent vim blobs. A blob "b" has the following properties:
+Properties
+----------
+	o "#b" is the length of blob "b", equivalent to "len(b)" in Vim.
+	o "b[k]" returns the k-th item in "b"; "b" is zero-indexed, as in Vim.
+	    To modify the k-th item, simply do "b[k] = number"; in particular,
+	    "b[#b] = number" can append a byte to tail.
+Methods
+-------
+	o "b:add(bytes)" appends "bytes" to the end of "b".
+Examples:
+>
+	:let b = 0z001122
+	:lua b = vim.eval('b') -- same 'b'
+	:lua print(b, b[0], #b)
+	:lua b[1] = 32
+	:lua b[#b] = 0x33 -- append a byte to tail
+	:lua b:add("\x80\x81\xfe\xff")
+	:echo b
+<
+==============================================================================
+6. Funcref userdata					*lua-funcref*
 Funcref userdata represent funcref variables in Vim. Funcrefs that were
 defined with a "dict" attribute need to be obtained as a dictionary key
 in order to have "self" properly assigned to the dictionary (see examples
 below.) A funcref "f" has the following properties:
 	:lua l = d.len -- assign d as 'self'
 	:lua print(l())
 <
 ==============================================================================
-6. Buffer userdata					*lua-buffer*
+7. Buffer userdata					*lua-buffer*
 Buffer userdata represent vim buffers. A buffer userdata "b" has the following
 properties and methods:
 Properties
 	EOF
 	endfunction
 <
 ==============================================================================
-7. Window userdata					*lua-window*
+8. Window userdata					*lua-window*
 Window objects represent vim windows. A window userdata "w" has the following
 properties and methods:
 Properties
 	:lua n,w = 0,vim.window(true) while w~=nil do n,w = n + 1,w:next() end
 	:lua print("There are " .. n .. " windows")
 <
 ==============================================================================
-8. The luaeval function					*lua-luaeval* *lua-eval*
+9. luaeval() Vim function				*lua-luaeval* *lua-eval*
 The (dual) equivalent of "vim.eval" for passing Lua values to Vim is
 "luaeval". "luaeval" takes an expression string and an optional argument and
 returns the result of the expression. It is semantically equivalent in Lua to:
 >
 	    local chunk = assert(loadstring(chunkheader .. expstr, "luaeval"))
 	    return chunk(arg) -- return typval
 	end
 <
 Note that "_A" receives the argument to "luaeval". Lua numbers, strings, and
-list, dict, and funcref userdata are converted to their Vim respective types,
+list, dict, blob, and funcref userdata are converted to their Vim respective
-while Lua booleans are converted to numbers. An error is thrown if conversion
+types, while Lua booleans are converted to numbers. An error is thrown if
-of any of the remaining Lua types, including userdata other than lists, dicts,
+conversion of any of the remaining Lua types, including userdata other than
-and funcrefs, is attempted.
+lists, dicts, blobs, and funcrefs, is attempted.
 Examples: >
 	:echo luaeval('math.pi')
 	:lua a = vim.list():add('newlist')
 	:  endfunction
 	:echo Rand(1,10)
 ==============================================================================
-9. Dynamic loading				    *lua-dynamic*
+10. Dynamic loading				    *lua-dynamic*
 On MS-Windows and Unix the Lua library can be loaded dynamically.  The
 |:version| output then includes |+lua/dyn|.
 This means that Vim will search for the Lua DLL or shared library file only

Mercurial > vim

comparison runtime/doc/if_lua.txt @ 16076:a2f0e93a5857 v8.1.1043