vim: runtime/doc/eval.txt comparison

comparison runtime/doc/eval.txt @ 15512:f0f06837a699

Update runtime files. commit https://github.com/vim/vim/commit/d09091d4955c5f41de69928f2db85611ed54ed23 Author: Bram Moolenaar <Bram@vim.org> Date: Thu Jan 17 16:07:22 2019 +0100 Update runtime files.

author	Bram Moolenaar <Bram@vim.org>
date	Thu, 17 Jan 2019 16:15:08 +0100
parents	e1de20a47fa9
children	4af72c724093

comparison

equal deleted inserted replaced

-:f41122780189
+:f0f06837a699
-*eval.txt*	For Vim version 8.1.  Last change: 2019 Jan 15
+*eval.txt*	For Vim version 8.1.  Last change: 2019 Jan 17
 		  VIM REFERENCE MANUAL	  by Bram Moolenaar
 <	64 ~
 To avoid a leading zero to cause octal conversion, or for using a different
 base, use |str2nr()|.
-							*TRUE* *FALSE*
+						*TRUE* *FALSE* *Boolean*
 For boolean operators Numbers are used.  Zero is FALSE, non-zero is TRUE.
 You can also use |v:false| and |v:true|.  When TRUE is returned from a
 function it is the Number one, FALSE is the number zero.
 Note that in the command: >
 Note that " " and "0" are also non-empty strings, thus considered to be TRUE.
 A List, Dictionary or Float is not a Number or String, thus evaluate to FALSE.
 		*E745* *E728* *E703* *E729* *E730* *E731* *E908* *E910* *E913*
 		*E974* *E975* *E976*
-List, Dictionary, Funcref, Job, Channel and Blob types are not automatically
+|List|, |Dictionary|, |Funcref|, |Job|, |Channel| and |Blob| types are not
-converted.
+automatically converted.
 							*E805* *E806* *E808*
 When mixing Number and Float the Number is converted to Float.  Otherwise
 there is no automatic conversion of Float.  You can use str2float() for String
 to Float, printf() for Float to String and float2nr() for Float to Number.
 Part of a blob ~
 A part of the Blob can be obtained by specifying the first and last index,
 separated by a colon in square brackets: >
 	:let myblob = 0z00112233
+	:let shortblob = myblob[1:2]	" get 0z1122
 	:let shortblob = myblob[2:-1]	" get 0z2233
 Omitting the first index is similar to zero.  Omitting the last index is
 similar to -1. >
 	:let endblob = myblob[2:]	" from item 2 to the end: 0z2233
 	:let shortblob = myblob[2:2]	" Blob with one byte: 0z22
 	:let otherblob = myblob[:]	" make a copy of the Blob
-If the first index is beyond the last byte of the Blob or the second byte is
+If the first index is beyond the last byte of the Blob or the second index is
 before the first byte, the result is an empty list.  There is no error
 message.
 If the second index is equal to or greater than the length of the list the
 length minus one is used: >
 When the index is just one beyond the end of the Blob, it is appended. Any
 higher index is an error.
 To change a sequence of bytes the [:] notation can be used: >
 	let blob[1:3] = 0z445566
-The length of the replaced bytes much be exactly the same as the value
+The length of the replaced bytes must be exactly the same as the value
 provided. *E972*
 To change part of a blob you can specify the first and last byte to be
-modified.  The value must at least have the number of bytes in the range: >
+modified.  The value must have the same number of bytes in the range: >
-	:let blob[3:5] = [3, 4, 5]
+	:let blob[3:5] = 0z334455
 You can also use the functions |add()|, |remove()| and |insert()|.
 Blob identity ~
 	:echo blob == blob3
 <	1 >
 	:echo blob is blob3
 <	0
-Making a copy of a list is done with the |copy()| function.  Using [:] also
+Making a copy of a Blob is done with the |copy()| function.  Using [:] also
 works, as explained above.
 1.6 More about variables ~
 							*more-variables*
 	expr5 is expr5		same |List| instance
 	expr5 isnot expr5	different |List| instance
 |expr5|	expr6
-	expr6 +	 expr6 ..	number addition or list concatenation
+	expr6 +	 expr6 ..	number addition, list or blob concatenation
 	expr6 -	 expr6 ..	number subtraction
 	expr6 .	 expr6 ..	string concatenation
 |expr6|	expr7
 	expr7 *	 expr7 ..	number multiplication
 If expr8 is a |Blob| this results in a new |Blob| with the bytes in the
 indexes expr1a and expr1b, inclusive.  Examples: >
 	:let b = 0zDEADBEEF
 	:let bs = b[1:2]		" 0zADBE
-	:let bs = b[]			" copy ov 0zDEADBEEF
+	:let bs = b[:]			" copy of 0zDEADBEEF
 Using expr8[expr1] or expr8[expr1a : expr1b] on a |Funcref| results in an
 error.
 Watch out for confusion between a namespace and a variable followed by a colon
 					*v:mouse_col* *mouse_col-variable*
 v:mouse_col	Column number for a mouse click obtained with |getchar()|.
 		This is the screen column number, like with |virtcol()|.  The
 		value is zero when there was no mouse button click.
-					*v:none* *none-variable*
+					*v:none* *none-variable* *None*
 v:none		An empty String. Used to put an empty item in JSON.  See
 		|json_encode()|.
 		When used as a number this evaluates to zero.
 		When used as a string this evaluates to "v:none". >
 			echo v:none
 		another Vim open the file and jump to the right place.  For
 		example, when jumping to a tag the value is ":tag tagname\r".
 		For ":edit +cmd file" the value is ":cmd\r".
 				*v:t_TYPE* *v:t_bool* *t_bool-variable*
-v:t_bool	Value of Boolean type.  Read-only.  See: |type()|
+v:t_bool	Value of |Boolean| type.  Read-only.  See: |type()|
 					*v:t_channel* *t_channel-variable*
-v:t_channel	Value of Channel type.  Read-only.  See: |type()|
+v:t_channel	Value of |Channel| type.  Read-only.  See: |type()|
 					*v:t_dict* *t_dict-variable*
-v:t_dict	Value of Dictionary type.  Read-only.  See: |type()|
+v:t_dict	Value of |Dictionary| type.  Read-only.  See: |type()|
 					*v:t_float* *t_float-variable*
-v:t_float	Value of Float type.  Read-only.  See: |type()|
+v:t_float	Value of |Float| type.  Read-only.  See: |type()|
 					*v:t_func* *t_func-variable*
-v:t_func	Value of Funcref type.  Read-only.  See: |type()|
+v:t_func	Value of |Funcref| type.  Read-only.  See: |type()|
 					*v:t_job* *t_job-variable*
-v:t_job		Value of Job type.  Read-only.  See: |type()|
+v:t_job		Value of |Job| type.  Read-only.  See: |type()|
 					*v:t_list* *t_list-variable*
-v:t_list	Value of List type.  Read-only.  See: |type()|
+v:t_list	Value of |List| type.  Read-only.  See: |type()|
 					*v:t_none* *t_none-variable*
-v:t_none	Value of None type.  Read-only.  See: |type()|
+v:t_none	Value of |None| type.  Read-only.  See: |type()|
 					*v:t_number* *t_number-variable*
-v:t_number	Value of Number type.  Read-only.  See: |type()|
+v:t_number	Value of |Number| type.  Read-only.  See: |type()|
 					*v:t_string* *t_string-variable*
-v:t_string	Value of String type.  Read-only.  See: |type()|
+v:t_string	Value of |String| type.  Read-only.  See: |type()|
 					*v:t_blob* *t_blob-variable*
-v:t_blob	Value of Blob type.  Read-only.  See: |type()|
+v:t_blob	Value of |Blob| type.  Read-only.  See: |type()|
 				*v:termresponse* *termresponse-variable*
 v:termresponse	The escape sequence returned by the terminal for the |t_RV|
 		termcap entry.  It is set when Vim receives an escape sequence
 		that starts with ESC [ or CSI and ends in a 'c', with only
 		there is nothing more to read (channel was closed).
 		See |channel-more|.
 		{only available when compiled with the |+channel| feature}
 ch_readblob({handle} [, {options}])			*ch_readblob()*
-		Like ch_read() but reads binary data and returns a Blob.
+		Like ch_read() but reads binary data and returns a |Blob|.
 		See |channel-more|.
 		{only available when compiled with the |+channel| feature}
 ch_readraw({handle} [, {options}])			*ch_readraw()*
 		Like ch_read() but for a JS and JSON channel does not decode
 		{handle} can be a Channel or a Job that has a Channel.
 		{only available when compiled with the |+channel| feature}
 ch_sendraw({handle}, {expr} [, {options}])		*ch_sendraw()*
-		Send string or Blob {expr} over {handle}.
+		Send |String| or |Blob| {expr} over {handle}.
 		Works like |ch_sendexpr()|, but does not encode the request or
 		decode the response.  The caller is responsible for the
 		correct contents.  Also does not add a newline for a channel
 		in NL mode, the caller must do that.  The NL in the response
 		is removed.
 		- A |String| is empty when its length is zero.
 		- A |Number| and |Float| are empty when their value is zero.
 		- |v:false|, |v:none| and |v:null| are empty, |v:true| is not.
 		- A |Job| is empty when it failed to start.
 		- A |Channel| is empty when it is closed.
-		- A Blob is empty when its length is zero.
+		- A |Blob| is empty when its length is zero.
 		For a long |List| this is much faster than comparing the
 		length with zero.
 escape({string}, {chars})				*escape()*
 		in Vim values.  See |json_encode()| for the relation between
 		JSON and Vim values.
 		The decoding is permissive:
 		- A trailing comma in an array and object is ignored, e.g.
 		  "[1, 2, ]" is the same as "[1, 2]".
+		- Integer keys are accepted in objects, e.g. {1:2} is the
+		  same as {'1':2}.
 		- More floating point numbers are recognized, e.g. "1." for
 		  "1.0", or "001.2" for "1.2". Special floating point values
 		  "Infinity", "-Infinity" and "NaN" (capitalization ignored)
 		  are accepted.
 		- Leading zeroes in integer numbers are ignored, e.g. "012"
 json_encode({expr})					*json_encode()*
 		Encode {expr} as JSON and return this as a string.
 		The encoding is specified in:
 		https://tools.ietf.org/html/rfc7159.html
 		Vim values are converted as follows:
-		   Number		decimal number
+		   |Number|		decimal number
-		   Float		floating point number
+		   |Float|		floating point number
 		   Float nan		"NaN"
 		   Float inf		"Infinity"
 		   Float -inf		"-Infinity"
-		   String		in double quotes (possibly null)
+		   |String|		in double quotes (possibly null)
-		   Funcref		not possible, error
+		   |Funcref|		not possible, error
-		   List			as an array (possibly null); when
+		   |List|		as an array (possibly null); when
 					used recursively: []
-		   Dict			as an object (possibly null); when
+		   |Dict|		as an object (possibly null); when
 					used recursively: {}
-		   Blob			as an array of the individual bytes
+		   |Blob|		as an array of the individual bytes
 		   v:false		"false"
 		   v:true		"true"
 		   v:none		"null"
 		   v:null		"null"
 		Note that NaN and Infinity are passed on as values.  This is
 len({expr})	The result is a Number, which is the length of the argument.
 		When {expr} is a String or a Number the length in bytes is
 		used, as with |strlen()|.
 		When {expr} is a |List| the number of items in the |List| is
 		returned.
+		When {expr} is a |Blob| the number of bytes is returned.
 		When {expr} is a |Dictionary| the number of entries in the
 		|Dictionary| is returned.
 		Otherwise an error is given.
 						*libcall()* *E364* *E368*
 smartindent		Compiled with 'smartindent' support.
 spell			Compiled with spell checking support |spell|.
 startuptime		Compiled with |--startuptime| support.
 statusline		Compiled with support for 'statusline', 'rulerformat'
 			and special formats of 'titlestring' and 'iconstring'.
-sun_workshop		Compiled with support for Sun |workshop|.
+sun_workshop		Support for Sun |workshop| has been removed.
 syntax			Compiled with syntax highlighting support |syntax|.
 syntax_items		There are active syntax highlighting items for the
 			current buffer.
 system			Compiled to use system() instead of fork()/exec().
 tag_binary		Compiled with binary searching in tags files

Mercurial > vim

comparison runtime/doc/eval.txt @ 15512:f0f06837a699