Browse Source

Details in the manual

pull/33/head
Roberto Ierusalimschy 12 months ago
parent
commit
011850a8f8
  1. 34
      manual/manual.of

34
manual/manual.of

@ -2563,8 +2563,8 @@ See also @Lid{luaL_checklstring}, @Lid{luaL_checkstring},
and @Lid{luaL_tolstring} in the auxiliary library.) and @Lid{luaL_tolstring} in the auxiliary library.)
In general, In general,
Lua's garbage collection can free or move internal memory Lua's garbage collection can free or move memory
and then invalidate pointers to internal strings. and then invalidate pointers to strings handled by a Lua state.
To allow a safe use of these pointers, To allow a safe use of these pointers,
the API guarantees that any pointer to a string in a stack index the API guarantees that any pointer to a string in a stack index
is valid while the string value at that index is not removed from the stack. is valid while the string value at that index is not removed from the stack.
@ -3158,8 +3158,6 @@ The index must be the last index previously marked to be closed
A @idx{__close} metamethod cannot yield A @idx{__close} metamethod cannot yield
when called through this function. when called through this function.
(This function was introduced in @N{release 5.4.3}.)
} }
@APIEntry{int lua_closethread (lua_State *L, lua_State *from);| @APIEntry{int lua_closethread (lua_State *L, lua_State *from);|
@ -3179,8 +3177,6 @@ The parameter @id{from} represents the coroutine that is resetting @id{L}.
If there is no such coroutine, If there is no such coroutine,
this parameter can be @id{NULL}. this parameter can be @id{NULL}.
(This function was introduced in @N{release 5.4.6}.)
} }
@APIEntry{int lua_compare (lua_State *L, int index1, int index2, int op);| @APIEntry{int lua_compare (lua_State *L, int index1, int index2, int op);|
@ -4227,14 +4223,6 @@ and then pops the top element.
} }
@APIEntry{int lua_resetthread (lua_State *L);|
@apii{0,?,-}
This function is deprecated;
it is equivalent to @Lid{lua_closethread} with
@id{from} being @id{NULL}.
}
@APIEntry{int lua_resume (lua_State *L, lua_State *from, int nargs, @APIEntry{int lua_resume (lua_State *L, lua_State *from, int nargs,
int *nresults);| int *nresults);|
@ -4516,8 +4504,6 @@ indicates whether the operation succeeded.
@apii{0,0,m} @apii{0,0,m}
Converts the Lua value at the given index to a @N{C string}. Converts the Lua value at the given index to a @N{C string}.
If @id{len} is not @id{NULL},
it sets @T{*len} with the string length.
The Lua value must be a string or a number; The Lua value must be a string or a number;
otherwise, the function returns @id{NULL}. otherwise, the function returns @id{NULL}.
If the value is a number, If the value is a number,
@ -4526,12 +4512,16 @@ then @id{lua_tolstring} also
(This change confuses @Lid{lua_next} (This change confuses @Lid{lua_next}
when @id{lua_tolstring} is applied to keys during a table traversal.) when @id{lua_tolstring} is applied to keys during a table traversal.)
@id{lua_tolstring} returns a pointer If @id{len} is not @id{NULL},
to a string inside the Lua state @see{constchar}. the function sets @T{*len} with the string length.
This string always has a zero (@Char{\0}) The returned @N{C string} always has a zero (@Char{\0})
after its last character (as @N{in C}), after its last character,
but can contain other zeros in its body. but can contain other zeros in its body.
The pointer returned by @id{lua_tolstring}
may be invalidated by the garbage collector if the
corresponding Lua value is removed from the stack @see{constchar}.
} }
@APIEntry{lua_Number lua_tonumber (lua_State *L, int index);| @APIEntry{lua_Number lua_tonumber (lua_State *L, int index);|
@ -9063,7 +9053,6 @@ The options are:
@item{@T{--}| stop handling options;} @item{@T{--}| stop handling options;}
@item{@T{-}| execute @id{stdin} as a file and stop handling options.} @item{@T{-}| execute @id{stdin} as a file and stop handling options.}
} }
(The form @T{-l @rep{g=mod}} was introduced in @N{release 5.4.4}.)
After handling its options, @id{lua} runs the given @emph{script}. After handling its options, @id{lua} runs the given @emph{script}.
When called without arguments, When called without arguments,
@ -9251,6 +9240,9 @@ declare a local variable with the same name in the loop body.
@itemize{ @itemize{
@item{ @item{
The function @id{lua_resetthread} is deprecated;
it is equivalent to @Lid{lua_closethread} with
@id{from} being @id{NULL}.
} }
} }

Loading…
Cancel
Save