vim: runtime/doc/eval.txt comparison

comparison runtime/doc/eval.txt @ 17857:4935244c1128 v8.1.1925

patch 8.1.1925: more functions can be used as methods Commit: https://github.com/vim/vim/commit/4c313b13fb7bfa694ec6d2a13175e8650c007b2a Author: Bram Moolenaar <Bram@vim.org> Date: Sat Aug 24 22:58:31 2019 +0200 patch 8.1.1925: more functions can be used as methods Problem: More functions can be used as methods. Solution: Make various functions usable as a method.

author	Bram Moolenaar <Bram@vim.org>
date	Sat, 24 Aug 2019 23:00:04 +0200
parents	285f7a700185
children	cc953757ed2a

comparison

equal deleted inserted replaced

-:786c5c8ba565
+:4935244c1128
 getbufinfo([{expr}])		List	information about buffers
 getbufline({expr}, {lnum} [, {end}])
 				List	lines {lnum} to {end} of buffer {expr}
 getbufvar({expr}, {varname} [, {def}])
 				any	variable {varname} in buffer {expr}
-getchangelist({expr})		List	list of change list items
+getchangelist([{expr}])		List	list of change list items
 getchar([expr])			Number	get one character from the user
 getcharmod()			Number	modifiers for the last typed character
 getcharsearch()			Dict	last character search
 getcmdline()			String	return the current command-line
 getcmdpos()			Number	return cursor position in command-line
 		non-existing buffers, an empty |List| is returned.
 		Example: >
 			:let lines = getbufline(bufnr("myfile"), 1, "$")
+<		Can also be used as a |method|: >
+			GetBufnr()->getbufline(lnum)
 getbufvar({expr}, {varname} [, {def}])				*getbufvar()*
 		The result is the value of option or local buffer variable
 		{varname} in buffer {expr}.  Note that the name without "b:"
 		must be used.
 		When {varname} is empty returns a dictionary with all the
 		When the buffer or variable doesn't exist {def} or an empty
 		string is returned, there is no error message.
 		Examples: >
 			:let bufmodified = getbufvar(1, "&mod")
 			:echo "todo myvar = " . getbufvar("todo", "myvar")
-<
-getchangelist({expr})					*getchangelist()*
+<		Can also be used as a |method|: >
+			GetBufnr()->getbufvar(varname)
+<
+getchangelist([{expr}])					*getchangelist()*
 		Returns the |changelist| for the buffer {expr}. For the use
 		of {expr}, see |bufname()| above. If buffer {expr} doesn't
 		exist, an empty list is returned.
 		The returned list contains two entries: a list with the change
 			coladd		column offset for 'virtualedit'
 			lnum		line number
 		If buffer {expr} is the current buffer, then the current
 		position refers to the position in the list. For other
 		buffers, it is set to the length of the list.
+		Can also be used as a |method|: >
+			GetBufnr()->getchangelist()
 getchar([expr])						*getchar()*
 		Get a single character from the user or input stream.
 		If [expr] is omitted, wait until a character is available.
 		If [expr] is 0, only get a character when one is available.
 		are returned. The 'wildignorecase' option always applies.
 		If there are no matches, an empty list is returned.  An
 		invalid value for {type} produces an error.
+		Can also be used as a |method|: >
+			GetPattern()->getcompletion('color')
+<
 							*getcurpos()*
 getcurpos()	Get the position of the cursor.  This is like getpos('.'), but
 		includes an extra item in the list:
 		    [bufnum, lnum, col, off, curswant] ~
 		The "curswant" number is the preferred column when moving the
 			:echo getcwd(-1)
 			" Get the working directory of tabpage 3
 			:echo getcwd(-1, 3)
 			" Get the working directory of current tabpage
 			:echo getcwd(-1, 0)
+<		Can also be used as a |method|: >
+			GetWinnr()->getcwd()
 <
 getenv({name})						*getenv()*
 		Return the value of environment variable {name}.
 		When the variable does not exist |v:null| is returned.  That
 		is different from a variable set to an empty string, although
 		some systems interpret the empty value as the variable being
 		deleted.  See also |expr-env|.
+		Can also be used as a |method|: >
+			GetVarname()->getenv()
 getfontname([{name}])					*getfontname()*
 		Without an argument returns the name of the normal font being
 		used.  Like what is used for the Normal highlight group
 		|hl-Normal|.
 			:echo getfperm("/etc/passwd")
 			:echo getfperm(expand("~/.vimrc"))
 <		This will hopefully (from a security point of view) display
 		the string "rw-r--r--" or even "rw-------".
+		Can also be used as a |method|: >
+			GetFilename()->getfperm()
+<
 		For setting permissions use |setfperm()|.
 getfsize({fname})					*getfsize()*
 		The result is a Number, which is the size in bytes of the
 		given file {fname}.
 		If {fname} is a directory, 0 is returned.
 		If the file {fname} can't be found, -1 is returned.
 		If the size of {fname} is too big to fit in a Number then -2
 		is returned.
+		Can also be used as a |method|: >
+			GetFilename()->getfsize()
 getftime({fname})					*getftime()*
 		The result is a Number, which is the last modification time of
 		the given file {fname}.  The value is measured as seconds
 		since 1st Jan 1970, and may be passed to strftime().  See also
 		|localtime()| and |strftime()|.
 		If the file {fname} can't be found -1 is returned.
+		Can also be used as a |method|: >
+			GetFilename()->getftime()
 getftype({fname})					*getftype()*
 		The result is a String, which is a description of the kind of
 		file of the given file {fname}.
 		If {fname} does not exist an empty string is returned.
 <		Note that a type such as "link" will only be returned on
 		systems that support it.  On some systems only "dir" and
 		"file" are returned.  On MS-Windows a symbolic link to a
 		directory returns "dir" instead of "link".
+		Can also be used as a |method|: >
+			GetFilename()->getftype()
 getjumplist([{winnr} [, {tabnr}]])			*getjumplist()*
 		Returns the |jumplist| for the specified window.
 		Without arguments use the current window.
 		With {winnr} only use this window in the current tab page.
 			col		column number
 			coladd		column offset for 'virtualedit'
 			filename	filename if available
 			lnum		line number
-							*getline()*
+		Can also be used as a |method|: >
+			GetWinnr()->getjumplist()
+<							*getline()*
 getline({lnum} [, {end}])
 		Without {end} the result is a String, which is line {lnum}
 		from the current buffer.  Example: >
 			getline(1)
 <		When {lnum} is a String that doesn't start with a
 		When {end} is before {lnum} an empty |List| is returned.
 		Example: >
 			:let start = line('.')
 			:let end = search("^$") - 1
 			:let lines = getline(start, end)
+<		Can also be used as a |method|: >
+			ComputeLnum()->getline()
 <		To get lines from another buffer see |getbufline()|
 getloclist({nr} [, {what}])				*getloclist()*
 		Returns a list with all the entries in the location list for
 		This can be used to save and restore the position of a mark: >
 			let save_a_mark = getpos("'a")
 			...
 			call setpos("'a", save_a_mark)
 <		Also see |getcurpos()| and |setpos()|.
+		Can also be used as a |method|: >
+			GetMark()->getpos()
 getqflist([{what}])					*getqflist()*
 		Returns a list with all the current quickfix errors.  Each
 		list item is a dictionary with these entries:
 		(see |NL-used-for-Nul|).
 		When the register was not set an empty list is returned.
 		If {regname} is not specified, |v:register| is used.
+		Can also be used as a |method|: >
+			GetRegname()->getreg()
 getregtype([{regname}])					*getregtype()*
 		The result is a String, which is type of register {regname}.
 		The value will be one of:
 		    "v"			for |characterwise| text
 		    "<CTRL-V>{width}"	for |blockwise-visual| text
 		    ""			for an empty or unknown register
 		<CTRL-V> is one character with value 0x16.
 		If {regname} is not specified, |v:register| is used.
+		Can also be used as a |method|: >
+			GetRegname()->getregtype()
 gettabinfo([{arg}])					*gettabinfo()*
 		If {arg} is not specified, then information about all the tab
 		pages is returned as a List. Each List item is a Dictionary.
 		Otherwise, {arg} specifies the tab page number and information
 		about that one is returned.  If the tab page does not exist an
 		Each List item is a Dictionary with the following entries:
 			tabnr		tab page number.
 			variables	a reference to the dictionary with
 					tabpage-local variables
 			windows		List of |window-ID|s in the tab page.
+		Can also be used as a |method|: >
+			GetTabnr()->gettabinfo()
 gettabvar({tabnr}, {varname} [, {def}])				*gettabvar()*
 		Get the value of a tab-local variable {varname} in tab page
 		{tabnr}. |t:var|
 		Tabs are numbered starting with one.
 		When {varname} is empty a dictionary with all tab-local
 		variables is returned.
 		Note that the name without "t:" must be used.
 		When the tab or variable doesn't exist {def} or an empty
 		string is returned, there is no error message.
+		Can also be used as a |method|: >
+			GetTabnr()->gettabvar(varname)
 gettabwinvar({tabnr}, {winnr}, {varname} [, {def}])		*gettabwinvar()*
 		Get the value of window-local variable {varname} in window
 		{winnr} in tab page {tabnr}.
 		When {varname} is empty a dictionary with all window-local
 			:let list_is_on = gettabwinvar(1, 2, '&list')
 			:echo "myvar = " . gettabwinvar(3, 1, 'myvar')
 <
 		To obtain all window-local variables use: >
 			gettabwinvar({tabnr}, {winnr}, '&')
+<		Can also be used as a |method|: >
+			GetTabnr()->gettabvar(winnr, varname)
 gettagstack([{nr}])					*gettagstack()*
 		The result is a Dict, which is the tag stack of window {nr}.
 		{nr} can be the window number or the |window-ID|.
 		When {nr} is not specified, the current window is used.
 		readable by the group, not accessible by others.  "xx-x-----"
 		would do the same thing.
 		Returns non-zero for success, zero for failure.
+		Can also be used as a |method|: >
+			GetFilename()->setfperm(mode)
+<
 		To read permissions see |getfperm()|.
 setline({lnum}, {text})					*setline()*
 		Set line {lnum} of the current buffer to {text}.  To insert

Mercurial > vim

comparison runtime/doc/eval.txt @ 17857:4935244c1128 v8.1.1925