Jmaa/pretty
1
0
Fork 0
Code Actions
79b036e51e
pretty/library.lua

1356 lines
54 KiB
Lua
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

-- pretty.library
-- Provides an API for accessing documentation for the Lua standard library, and
-- the LuaJIT extension libraries.
-- FIXME: This is a large module to load from `function.lua` when `pretty` is
-- loaded. Could probably loaded lazily.
-- FIXME: Currently this module imports a bunch of packages, even though it may
-- never need to use them. Could probably load those lazily.
--------------------------------------------------------------------------------
local function_library = {}
local function library_function ( func_def )
if not func_def.func then return false end
local is_func_builtin = not debug or not debug.getinfo or (debug.getinfo(func_def.func, 'S').what == 'C')
if not is_func_builtin then return false end
function_library[func_def.func] = func_def
end
--------------------------------------------------------------------------------
-- Basic Functions
library_function {
func = assert,
name = 'assert',
para = 'v [, message]',
docs = 'Issues an error when the value of its argument v is false (i.e., nil or false); otherwise, returns all its arguments. message is an error message; when absent, it defaults to "assertion failed!"'
}
library_function {
func = collectgarbage,
name = 'collectgarbage',
para = '[opt [, arg]]',
docs = [[
This function is a generic interface to the garbage collector. It performs different functions according to its first argument, opt:
"collect": performs a full garbage-collection cycle. This is the default option.
"stop": stops the garbage collector.
"restart": restarts the garbage collector.
"count": returns the total memory in use by Lua (in Kbytes).
"step": performs a garbage-collection step. The step "size" is controlled by arg (larger values mean more steps) in a non-specified way. If you want to control the step size you must experimentally tune the value of arg. Returns true if the step finished a collection cycle.
"setpause": sets arg as the new value for the pause of the collector (see §2.10). Returns the previous value for pause.
"setstepmul": sets arg as the new value for the step multiplier of the collector (see §2.10). Returns the previous value for step.]]
}
library_function {
func = dofile,
name = 'dofile',
para = '[filename]',
docs = 'Opens the named file and executes its contents as a Lua chunk. When called without arguments, dofile executes the contents of the standard input (stdin). Returns all values returned by the chunk. In case of errors, dofile propagates the error to its caller (that is, dofile does not run in protected mode).'
}
library_function {
func = error,
name = 'error',
para = 'message [, level]',
docs = [[
Terminates the last protected function called and returns message as the error message. Function error never returns.
Usually, error adds some information about the error position at the beginning of the message. The level argument specifies how to get the error position. With level 1 (the default), the error position is where the error function was called. Level 2 points the error to where the function that called error was called; and so on. Passing a level 0 avoids the addition of error position information to the message.]]
}
library_function {
func = getfenv,
name = 'getfenv',
para = '[F]',
docs = 'Returns the current environment in use by the function. f can be a Lua function or a number that specifies the function at that stack level: Level 1 is the function calling getfenv. If the given function is not a Lua function, or if f is 0, getfenv returns the global environment. The default for f is 1.'
}
library_function {
func = getmetatable,
name = 'getmetatable',
para = 'object',
docs = 'If object does not have a metatable, returns nil. Otherwise, if the object\'s metatable has a "__metatable" field, returns the associated value. Otherwise, returns the metatable of the given object.'
}
library_function {
func = ipairs,
name = 'ipairs',
para = 't',
docs = [[
Returns three values: an iterator function, the table t, and 0, so that the construction
for i,v in ipairs(t) do body end
will iterate over the pairs (1,t[1]), (2,t[2]), ..., up to the first integer key absent from the table.]]
}
library_function {
func = load,
name = 'load',
para = 'func [, chunkname]',
docs = [[
Loads a chunk using function func to get its pieces. Each call to func must return a string that concatenates with previous results. A return of an empty string, nil, or no value signals the end of the chunk.
If there are no errors, returns the compiled chunk as a function; otherwise, returns nil plus the error message. The environment of the returned function is the global environment.
chunkname is used as the chunk name for error messages and debug information. When absent, it defaults to "=(load)".]]
}
library_function {
func = loadfile,
name = 'loadfile',
para = '[filename]',
docs = [[Similar to load, but gets the chunk from file filename or from the standard input, if no file name is given.]]
}
library_function {
func = loadstring,
name = 'loadstring',
para = 'string [, chunkname]',
docs = [[
Similar to load, but gets the chunk from the given string.
To load and run a given string, use the idiom
assert(loadstring(s))()
When absent, chunkname defaults to the given string.]]
}
library_function {
func = next,
name = 'next',
para = 'table [, index]',
docs = [[
Allows a program to traverse all fields of a table. Its first argument is a table and its second argument is an index in this table. next returns the next index of the table and its associated value. When called with nil as its second argument, next returns an initial index and its associated value. When called with the last index, or with nil in an empty table, next returns nil. If the second argument is absent, then it is interpreted as nil. In particular, you can use next(t) to check whether a table is empty.
The order in which the indices are enumerated is not specified, even for numeric indices. (To traverse a table in numeric order, use a numerical for or the ipairs function.)
The behavior of next is undefined if, during the traversal, you assign any value to a non-existent field in the table. You may however modify existing fields. In particular, you may clear existing fields.]]
}
library_function {
func = pairs,
name = 'pairs',
para = 't',
docs = [[
Returns three values: the next function, the table t, and nil, so that the construction
for k,v in pairs(t) do body end
will iterate over all key–value pairs of table t.
See function next for the caveats of modifying the table during its traversal.]]
}
library_function {
func = pcall,
name = 'pcall',
para = 'f, arg1, ...',
docs = [[Calls function f with the given arguments in protected mode. This means that any error inside f is not propagated; instead, pcall catches the error and returns a status code. Its first result is the status code (a boolean), which is true if the call succeeds without errors. In such case, pcall also returns all results from the call, after this first result. In case of any error, pcall returns false plus the error message.]]
}
library_function {
func = print,
name = 'print',
para = '...',
docs = [[Receives any number of arguments, and prints their values to stdout, using the tostring function to convert them to strings. print is not intended for formatted output, but only as a quick way to show a value, typically for debugging. For formatted output, use string.format.]]
}
library_function {
func = rawequal,
name = 'rawequal',
para = 'v1, v2',
docs = [[Checks whether v1 is equal to v2, without invoking any metamethod. Returns a boolean.]]
}
library_function {
func = rawget,
name = 'rawget',
para = 'table, index',
docs = [[Gets the real value of table[index], without invoking any metamethod. table must be a table; index may be any value.]]
}
library_function {
func = rawset,
name = 'rawset',
para = 'table, index, value',
docs = [[
Sets the real value of table[index] to value, without invoking any metamethod. table must be a table, index any value different from nil, and value any Lua value.
This function returns table.]]
}
library_function {
func = select,
name = 'select',
para = 'index, ...',
docs = [[
If index is a number, returns all arguments after argument number index. Otherwise, index must be the string "#", and select returns the total number of extra arguments it received.]]
}
library_function {
func = setfenv,
name = 'setfenv',
para = 'f, table',
docs = [[
Sets the environment to be used by the given function. f can be a Lua function or a number that specifies the function at that stack level: Level 1 is the function calling setfenv. setfenv returns the given function.
As a special case, when f is 0 setfenv changes the environment of the running thread. In this case, setfenv returns no values.]]
}
library_function {
func = setmetatable,
name = 'setmetatable',
para = 'table, metatable',
docs = [[
Sets the metatable for the given table. (You cannot change the metatable of other types from Lua, only from C.) If metatable is nil, removes the metatable of the given table. If the original metatable has a "__metatable" field, raises an error.
This function returns table.]]
}
library_function {
func = tonumber,
name = 'tonumber',
para = 'e [, base]',
docs = [[
Tries to convert its argument to a number. If the argument is already a number or a string convertible to a number, then tonumber returns this number; otherwise, it returns nil.
An optional argument specifies the base to interpret the numeral. The base may be any integer between 2 and 36, inclusive. In bases above 10, the letter 'A' (in either upper or lower case) represents 10, 'B' represents 11, and so forth, with 'Z' representing 35. In base 10 (the default), the number can have a decimal part, as well as an optional exponent part (see §2.1). In other bases, only unsigned integers are accepted.]]
}
library_function {
func = tostring,
name = 'tostring',
para = 'e',
docs = [[
Receives an argument of any type and converts it to a string in a reasonable format. For complete control of how numbers are converted, use string.format.
If the metatable of e has a "__tostring" field, then tostring calls the corresponding value with e as argument, and uses the result of the call as its result.]]
}
library_function {
func = type,
name = 'type',
para = 'v',
docs = [[
Returns the type of its only argument, coded as a string. The possible results of this function are "nil" (a string, not the value nil), "number", "string", "boolean", "table", "function", "thread", "userdata" and "cdata" (luajit only).]]
}
library_function {
func = unpack,
name = 'unpack',
para = 'list [, i [, j]]',
docs = [[
Returns the elements from the given table. This function is equivalent to
return list[i], list[i+1], ..., list[j]
except that the above code can be written only for a fixed number of elements. By default, i is 1 and j is the length of the list, as defined by the length operator (see §2.5.5).]]
}
library_function {
func = xpcall,
name = 'xpcall',
para = 'f, err',
docs = [[
This function is similar to pcall, except that you can set a new error handler.
xpcall calls function f in protected mode, using err as the error handler. Any error inside f is not propagated; instead, xpcall catches the error, calls the err function with the original error object, and returns a status code. Its first result is the status code (a boolean), which is true if the call succeeds without errors. In this case, xpcall also returns all results from the call, after this first result. In case of any error, xpcall returns false plus the result from err.]]
}
library_function {
func = newproxy,
name = 'newproxy',
para = '',
docs = [[
Undocumented. (And depricated in PUC Lua 5.2)
For info, see: http://stackoverflow.com/questions/23592388/create-new-empty-userdata-from-pure-lua
]]
}
--------------------------------------------------------------------------------
-- Coroutine Manipulation (coroutine)
if coroutine then
library_function {
func = coroutine.create,
name = 'coroutine.create',
para = 'f',
docs = [[
Creates a new coroutine, with body f. f must be a Lua function. Returns this new coroutine, an object with type "thread".]]
}
library_function {
func = coroutine.resume,
name = 'coroutine.resume',
para = 'co [, val1, ...]',
docs = [[
Starts or continues the execution of coroutine co. The first time you resume a coroutine, it starts running its body. The values val1, ... are passed as the arguments to the body function. If the coroutine has yielded, resume restarts it; the values val1, ... are passed as the results from the yield.
If the coroutine runs without any errors, resume returns true plus any values passed to yield (if the coroutine yields) or any values returned by the body function (if the coroutine terminates). If there is any error, resume returns false plus the error message.]]
}
library_function {
func = coroutine.running,
name = 'coroutine.running',
para = '',
docs = [[Returns the running coroutine, or nil when called by the main thread.]]
}
library_function {
func = coroutine.status,
name = 'coroutine.status',
para = 'co',
docs = [[Returns the status of coroutine co, as a string: "running", if the coroutine is running (that is, it called status); "suspended", if the coroutine is suspended in a call to yield, or if it has not started running yet; "normal" if the coroutine is active but not running (that is, it has resumed another coroutine); and "dead" if the coroutine has finished its body function, or if it has stopped with an error.]]
}
library_function {
func = coroutine.wrap,
name = 'coroutine.wrap',
para = 'f',
docs = [[Creates a new coroutine, with body f. f must be a Lua function. Returns a function that resumes the coroutine each time it is called. Any arguments passed to the function behave as the extra arguments to resume. Returns the same values returned by resume, except the first boolean. In case of error, propagates the error.]]
}
library_function {
func = coroutine.yield,
name = 'coroutine.yield',
para = '...',
docs = [[Suspends the execution of the calling coroutine. The coroutine cannot be running a C function, a metamethod, or an iterator. Any arguments to yield are passed as extra results to resume.]]
}
end
--------------------------------------------------------------------------------
-- Modules (package + others)
library_function {
func = module,
name = 'module',
para = 'name [, ...]',
docs = [[
Creates a module. If there is a table in package.loaded[name], this table is the module. Otherwise, if there is a global table t with the given name, this table is the module. Otherwise creates a new table t and sets it as the value of the global name and the value of package.loaded[name]. This function also initializes t._NAME with the given name, t._M with the module (t itself), and t._PACKAGE with the package name (the full module name minus last component; see below). Finally, module sets t as the new environment of the current function and the new value of package.loaded[name], so that require returns t.
If name is a compound name (that is, one with components separated by dots), module creates (or reuses, if they already exist) tables for each component. For instance, if name is a.b.c, then module stores the module table in field c of field b of global a.
This function can receive optional options after the module name, where each option is a function to be applied over the module.
]]
}
library_function {
func = require,
name = 'require',
para = 'modname',
docs = [[
Loads the given module. The function starts by looking into the package.loaded table to determine whether modname is already loaded. If it is, then require returns the value stored at package.loaded[modname]. Otherwise, it tries to find a loader for the module.
To find a loader, require is guided by the package.loaders array. By changing this array, we can change how require looks for a module. The following explanation is based on the default configuration for package.loaders.
First require queries package.preload[modname]. If it has a value, this value (which should be a function) is the loader. Otherwise require searches for a Lua loader using the path stored in package.path. If that also fails, it searches for a C loader using the path stored in package.cpath. If that also fails, it tries an all-in-one loader (see package.loaders).
Once a loader is found, require calls the loader with a single argument, modname. If the loader returns any value, require assigns the returned value to package.loaded[modname]. If the loader returns no value and has not assigned any value to package.loaded[modname], then require assigns true to this entry. In any case, require returns the final value of package.loaded[modname].
If there is any error loading or running the module, or if it cannot find any loader for the module, then require signals an error.
]]
}
if package then
library_function {
func = package.loadlib,
name = 'package.loadlib',
para = 'libname, funcname',
docs = [[
Dynamically links the host program with the C library libname. Inside this library, looks for a function funcname and returns this function as a C function. (So, funcname must follow the protocol (see lua_CFunction)).
This is a low-level function. It completely bypasses the package and module system. Unlike require, it does not perform any path searching and does not automatically adds extensions. libname must be the complete file name of the C library, including if necessary a path and extension. funcname must be the exact name exported by the C library (which may depend on the C compiler and linker used).
This function is not supported by ANSI C. As such, it is only available on some platforms (Windows, Linux, Mac OS X, Solaris, BSD, plus other Unix systems that support the dlfcn standard).
]]
}
library_function {
func = package.seeall,
name = 'package.seeall',
para = 'module',
docs = [[
Sets a metatable for module with its __index field referring to the global environment, so that this module inherits values from the global environment. To be used as an option to function module.
]]
}
end
--------------------------------------------------------------------------------
-- String Manipulation (string)
if string then
library_function {
func = string.byte,
name = 'string.byte',
para = 's [, i [, j]]',
docs = [[
Returns the internal numerical codes of the characters s[i], s[i+1], ..., s[j]. The default value for i is 1; the default value for j is i.
Note that numerical codes are not necessarily portable across platforms.]]
}
library_function {
func = string.char,
name = 'string.char',
para = '...',
docs = [[
Receives zero or more integers. Returns a string with length equal to the number of arguments, in which each character has the internal numerical code equal to its corresponding argument.
Note that numerical codes are not necessarily portable across platforms.
]]
}
library_function {
func = string.dump,
name = 'string.dump',
para = 'function',
docs = [[
Returns a string containing a binary representation of the given function, so that a later loadstring on this string returns a copy of the function. function must be a Lua function without upvalues.
]]
}
library_function {
func = string.find,
name = 'string.find',
para = 's, pattern [, init [, plain]]',
docs = [[
Looks for the first match of pattern in the string s. If it finds a match, then find returns the indices of s where this occurrence starts and ends; otherwise, it returns nil. A third, optional numerical argument init specifies where to start the search; its default value is 1 and can be negative. A value of true as a fourth, optional argument plain turns off the pattern matching facilities, so the function does a plain "find substring" operation, with no characters in pattern being considered "magic". Note that if plain is given, then init must be given as well.
If the pattern has captures, then in a successful match the captured values are also returned, after the two indices.
]]
}
library_function {
func = string.format,
name = 'string.format',
para = 'formatstring, ...',
docs = [[
Returns a formatted version of its variable number of arguments following the description given in its first argument (which must be a string). The format string follows the same rules as the printf family of standard C functions. The only differences are that the options/modifiers *, l, L, n, p, and h are not supported and that there is an extra option, q. The q option formats a string in a form suitable to be safely read back by the Lua interpreter: the string is written between double quotes, and all double quotes, newlines, embedded zeros, and backslashes in the string are correctly escaped when written. For instance, the call
string.format('%q', 'a string with "quotes" and \n new line')
will produce the string:
"a string with \"quotes\" and \
new line"
The options c, d, E, e, f, g, G, i, o, u, X, and x all expect a number as argument, whereas q and s expect a string.
This function does not accept string values containing embedded zeros, except as arguments to the q option.
]]
}
library_function {
func = string.gmatch,
name = 'string.gmatch',
para = 's, pattern',
docs = [[
Returns an iterator function that, each time it is called, returns the next captures from pattern over string s. If pattern specifies no captures, then the whole match is produced in each call.
As an example, the following loop
s = "hello world from Lua"
for w in string.gmatch(s, "%a+") do
print(w)
end
will iterate over all the words from string s, printing one per line. The next example collects all pairs key=value from the given string into a table:
t = {}
s = "from=world, to=Lua"
for k, v in string.gmatch(s, "(%w+)=(%w+)") do
t[k] = v
end
For this function, a '^' at the start of a pattern does not work as an anchor, as this would prevent the iteration.
]]
}
library_function {
func = string.gsub,
name = 'string.gsub',
para = 's, pattern, repl, [, n]',
docs = [[
Returns a copy of s in which all (or the first n, if given) occurrences of the pattern have been replaced by a replacement string specified by repl, which can be a string, a table, or a function. gsub also returns, as its second value, the total number of matches that occurred.
If repl is a string, then its value is used for replacement. The character % works as an escape character: any sequence in repl of the form %n, with n between 1 and 9, stands for the value of the n-th captured substring (see below). The sequence %0 stands for the whole match. The sequence %% stands for a single %.
If repl is a table, then the table is queried for every match, using the first capture as the key; if the pattern specifies no captures, then the whole match is used as the key.
If repl is a function, then this function is called every time a match occurs, with all captured substrings passed as arguments, in order; if the pattern specifies no captures, then the whole match is passed as a sole argument.
If the value returned by the table query or by the function call is a string or a number, then it is used as the replacement string; otherwise, if it is false or nil, then there is no replacement (that is, the original match is kept in the string).
]]
}
library_function {
func = string.len,
name = 'string.len',
para = 's',
docs = [[
Receives a string and returns its length. The empty string "" has length 0. Embedded zeros are counted, so "a\000bc\000" has length 5.
]]
}
library_function {
func = string.lower,
name = 'string.lower',
para = 's',
docs = [[
Receives a string and returns a copy of this string with all uppercase letters changed to lowercase. All other characters are left unchanged. The definition of what an uppercase letter is depends on the current locale.
]]
}
library_function {
func = string.match,
name = 'string.match',
para = 's, pattern [, init]',
docs = [[
Looks for the first match of pattern in the string s. If it finds one, then match returns the captures from the pattern; otherwise it returns nil. If pattern specifies no captures, then the whole match is returned. A third, optional numerical argument init specifies where to start the search; its default value is 1 and can be negative.
]]
}
library_function {
func = string.rep,
name = 'string.rep',
para = 's, n',
docs = [[
Returns a string that is the concatenation of n copies of the string s.
]]
}
library_function {
func = string.reverse,
name = 'string.reverse',
para = 's',
docs = [[
Returns a string that is the string s reversed.
]]
}
library_function {
func = string.sub,
name = 'string.sub',
para = 's, i [, j]',
docs = [[
Returns the substring of s that starts at i and continues until j; i and j can be negative. If j is absent, then it is assumed to be equal to -1 (which is the same as the string length). In particular, the call string.sub(s,1,j) returns a prefix of s with length j, and string.sub(s, -i) returns a suffix of s with length i.
]]
}
library_function {
func = string.upper,
name = 'string.upper',
para = 's',
docs = [[
Receives a string and returns a copy of this string with all lowercase letters changed to uppercase. All other characters are left unchanged. The definition of what a lowercase letter is depends on the current locale.
]]
}
end
--------------------------------------------------------------------------------
-- Table Manipulation (table)
if table then
library_function {
func = table.concat,
name = 'table.concat',
para = 'table [, sep [, i, [, j]]]',
docs = [[
Given an array where all elements are strings or numbers, returns table[i]..sep..table[i+1] ... sep..table[j]. The default value for sep is the empty string, the default for i is 1, and the default for j is the length of the table. If i is greater than j, returns the empty string.
]]
}
library_function {
func = table.insert,
name = 'table.insert',
para = 'table, [pos,] value',
docs = [[
Inserts element value at position pos in table, shifting up other elements to open space, if necessary. The default value for pos is n+1, where n is the length of the table (see §2.5.5), so that a call table.insert(t,x) inserts x at the end of table t.
]]
}
library_function {
func = table.maxn,
name = 'table.maxn',
para = 'table',
docs = [[
Returns the largest positive numerical index of the given table, or zero if the table has no positive numerical indices. (To do its job this function does a linear traversal of the whole table.)
]]
}
library_function {
func = table.remove,
name = 'table.remove',
para = 'table [, pos]',
docs = [[
Removes from table the element at position pos, shifting down other elements to close the space, if necessary. Returns the value of the removed element. The default value for pos is n, where n is the length of the table, so that a call table.remove(t) removes the last element of table t.
]]
}
library_function {
func = table.sort,
name = 'table.sort',
para = 'table [, comp]',
docs = [[
Sorts table elements in a given order, in-place, from table[1] to table[n], where n is the length of the table. If comp is given, then it must be a function that receives two table elements, and returns true when the first is less than the second (so that not comp(a[i+1],a[i]) will be true after the sort). If comp is not given, then the standard Lua operator < is used instead.
The sort algorithm is not stable; that is, elements considered equal by the given order may have their relative positions changed by the sort.
]]
}
end
--------------------------------------------------------------------------------
-- Mathematical Functions (math)
if math then
library_function {
func = math.abs,
name = 'math.abs',
para = 'x',
docs = 'Returns the absolute value of x.'
}
library_function {
func = math.acos,
name = 'math.acos',
para = 'x',
docs = 'Returns the arc cosine of x (in radians).'
}
library_function {
func = math.asin,
name = 'math.asin',
para = 'x',
docs = 'Returns the arc sine of x (in radians).'
}
library_function {
func = math.atan,
name = 'math.atan',
para = 'x',
docs = 'Returns the arc tangent of x (in radians).'
}
library_function {
func = math.atan2,
name = 'math.atan2',
para = 'y, x',
docs = 'Returns the arc tangent of y/x (in radians), but uses the signs of both parameters to find the quadrant of the result. (It also handles correctly the case of x being zero.)'
}
library_function {
func = math.ceil,
name = 'math.ceil',
para = 'x',
docs = 'Returns the smallest integer larger than or equal to x.'
}
library_function {
func = math.cos,
name = 'math.cos',
para = 'x',
docs = 'Returns the cosine of x (assumed to be in radians).'
}
library_function {
func = math.cosh,
name = 'math.cosh',
para = 'x',
docs = 'Returns the hyperbolic cosine of x.'
}
library_function {
func = math.deg,
name = 'math.deg',
para = 'x',
docs = 'Returns the angle x (given in radians) in degrees.'
}
library_function {
func = math.exp,
name = 'math.exp',
para = 'x',
docs = 'Returns the value e^x. (Euler\'s number raised to the power of x.)'
}
library_function {
func = math.floor,
name = 'math.floor',
para = 'x',
docs = 'Returns the largest integer smaller than or equal to x.'
}
library_function {
func = math.fmod,
name = 'math.fmod',
para = 'x, y',
docs = 'Returns the remainder of the division of x by y that rounds the quotient towards zero.'
}
library_function {
func = math.frexp,
name = 'math.frexp',
para = 'x',
docs = 'Returns m and e such that x = m*2^e, e is an integer and the absolute value of m is in the range [0.5, 1) (or zero when x is zero).'
}
library_function {
func = math.ldexp,
name = 'math.ldexp',
para = 'm, e',
docs = 'Returns m*2^e (e should be an integer).'
}
library_function {
func = math.log,
name = 'math.log',
para = 'x',
docs = 'Returns the natural logarithm of x.'
}
library_function {
func = math.log10,
name = 'math.log10',
para = 'x',
docs = 'Returns the base-10 logarithm of x.'
}
library_function {
func = math.max,
name = 'math.max',
para = 'x, ...',
docs = 'Returns the maximum value among its arguments.'
}
library_function {
func = math.min,
name = 'math.min',
para = 'x, ...',
docs = 'Returns the minimum value among its arguments.'
}
library_function {
func = math.modf,
name = 'math.modf',
para = 'x',
docs = 'Returns two numbers, the integral part of x and the fractional part of x.'
}
library_function {
func = math.pow,
name = 'math.pow',
para = 'x, y',
docs = 'Returns x raised to the power of y. (You can also use the expression x^y to compute this value.)'
}
library_function {
func = math.rad,
name = 'math.rad',
para = 'x',
docs = 'Returns the angle x (given in degrees) in radians.'
}
library_function {
func = math.random,
name = 'math.random',
para = '[m [, n]',
docs = 'When called without arguments, returns a uniform pseudo-random real number in the range [0,1). When called with an integer number m, math.random returns a uniform pseudo-random integer in the range [1, m]. When called with two integer numbers m and n, math.random returns a uniform pseudo-random integer in the range [m, n].'
}
library_function {
func = math.randomseed,
name = 'math.randomseed',
para = 'x',
docs = 'Sets x as the "seed" for the pseudo-random generator: equal seeds produce equal sequences of numbers.'
}
library_function {
func = math.sin,
name = 'math.sin',
para = 'x',
docs = 'Returns the sine of x (assumed to be in radians).'
}
library_function {
func = math.sinh,
name = 'math.sinh',
para = 'x',
docs = 'Returns the hyperbolic sine of x.'
}
library_function {
func = math.sqrt,
name = 'math.sqrt',
para = 'x',
docs = 'Returns the square root of x. (You can also use the expression x^0.5 to compute this value.)'
}
library_function {
func = math.tan,
name = 'math.tan',
para = 'x',
docs = 'Returns the tangent of x (assumed to be in radians).'
}
library_function {
func = math.tanh,
name = 'math.tanh',
para = 'x',
docs = 'Returns the hyperbolic tangent of x. '
}
end
--------------------------------------------------------------------------------
-- Input and Output Facilities (io)
if io then
library_function {
func = io.close,
name = 'io.close',
para = '[file]',
docs = [[
Equivalent to file:close(). Without a file, closes the default output file.
]]
}
library_function {
func = io.flush,
name = 'io.flush',
para = '',
docs = [[
Equivalent to file:flush over the default output file.
]]
}
library_function {
func = io.input,
name = 'io.input',
para = '[file]',
docs = [[
When called with a file name, it opens the named file (in text mode), and sets its handle as the default input file. When called with a file handle, it simply sets this file handle as the default input file. When called without parameters, it returns the current default input file.
In case of errors this function raises the error, instead of returning an error code.
]]
}
library_function {
func = io.lines,
name = 'io.lines',
para = '[filename]',
docs = [[
Opens the given file name in read mode and returns an iterator function that, each time it is called, returns a new line from the file. Therefore, the construction
for line in io.lines(filename) do body end
will iterate over all lines of the file. When the iterator function detects the end of file, it returns nil (to finish the loop) and automatically closes the file.
The call io.lines() (with no file name) is equivalent to io.input():lines(); that is, it iterates over the lines of the default input file. In this case it does not close the file when the loop ends.
]]
}
library_function {
func = io.open,
name = 'io.open',
para = 'filename [, mode]',
docs = [[
This function opens a file, in the mode specified in the string mode. It returns a new file handle, or, in case of errors, nil plus an error message.
The mode string can be any of the following:
"r": read mode (the default);
"w": write mode;
"a": append mode;
"r+": update mode, all previous data is preserved;
"w+": update mode, all previous data is erased;
"a+": append update mode, previous data is preserved, writing is only allowed at the end of file.
The mode string can also have a 'b' at the end, which is needed in some systems to open the file in binary mode. This string is exactly what is used in the standard C function fopen.
]]
}
library_function {
func = io.output,
name = 'io.output',
para = '[file]',
docs = [[
Similar to io.input, but operates over the default output file.
]]
}
library_function {
func = io.popen,
name = 'io.popen',
para = 'prog [, mode]',
docs = [[
Starts program prog in a separated process and returns a file handle that you can use to read data from this program (if mode is "r", the default) or to write data to this program (if mode is "w").
This function is system dependent and is not available on all platforms.
]]
}
library_function {
func = io.read,
name = 'io.read',
para = '...',
docs = [[
Equivalent to io.input():read.
]]
}
library_function {
func = io.tmpfile,
name = 'io.tmpfile',
para = '',
docs = [[
Returns a handle for a temporary file. This file is opened in update mode and it is automatically removed when the program ends.
]]
}
library_function {
func = io.type,
name = 'io.type',
para = 'obj',
docs = [[
Checks whether obj is a valid file handle. Returns the string "file" if obj is an open file handle, "closed file" if obj is a closed file handle, or nil if obj is not a file handle.
]]
}
library_function {
func = io.write,
name = 'io.write',
para = '...',
docs = [[
Equivalent to io.output():write.
]]
}
end
if io and io.tmpfile then
-- NOTE: Yes, we need to open a file. These aren't the same functions as
-- their counterparts in io.
local file = io.tmpfile()
library_function {
func = file.close,
name = 'file:close',
para = '',
docs = [[
Closes file. Note that files are automatically closed when their handles are garbage collected, but that takes an unpredictable amount of time to happen.
]]
}
library_function {
func = file.flush,
name = 'file:flush',
para = '',
docs = [[
Saves any written data to file.
]]
}
library_function {
func = file.lines,
name = 'file:lines',
para = '',
docs = [[
Returns an iterator function that, each time it is called, returns a new line from the file. Therefore, the construction
for line in file:lines() do body end
will iterate over all lines of the file. (Unlike io.lines, this function does not close the file when the loop ends.)
]]
}
library_function {
func = file.read,
name = 'file:read',
para = '...',
docs = [[
Reads the file file, according to the given formats, which specify what to read. For each format, the function returns a string (or a number) with the characters read, or nil if it cannot read data with the specified format. When called without formats, it uses a default format that reads the entire next line (see below).
The available formats are
"*n": reads a number; this is the only format that returns a number instead of a string.
"*a": reads the whole file, starting at the current position. On end of file, it returns the empty string.
"*l": reads the next line (skipping the end of line), returning nil on end of file. This is the default format.
number: reads a string with up to this number of characters, returning nil on end of file. If number is zero, it reads nothing and returns an empty string, or nil on end of file.
]]
}
library_function {
func = file.seek,
name = 'file:seek',
para = '[whence] [, offset]',
docs = [[
Sets and gets the file position, measured from the beginning of the file, to the position given by offset plus a base specified by the string whence, as follows:
"set": base is position 0 (beginning of the file);
"cur": base is current position;
"end": base is end of file;
In case of success, function seek returns the final file position, measured in bytes from the beginning of the file. If this function fails, it returns nil, plus a string describing the error.
The default value for whence is "cur", and for offset is 0. Therefore, the call file:seek() returns the current file position, without changing it; the call file:seek("set") sets the position to the beginning of the file (and returns 0); and the call file:seek("end") sets the position to the end of the file, and returns its size.
]]
}
library_function {
func = file.setvbuf,
name = 'file:setvbuf',
para = 'mode [, size]',
docs = [[
Sets the buffering mode for an output file. There are three available modes:
"no": no buffering; the result of any output operation appears immediately.
"full": full buffering; output operation is performed only when the buffer is full (or when you explicitly flush the file (see io.flush)).
"line": line buffering; output is buffered until a newline is output or there is any input from some special files (such as a terminal device).
For the last two cases, size specifies the size of the buffer, in bytes. The default is an appropriate size.
]]
}
library_function {
func = file.write,
name = 'file:write',
para = '...',
docs = [[
Writes the value of each of its arguments to the file. The arguments must be strings or numbers. To write other values, use tostring or string.format before write.
]]
}
file:close()
end
--------------------------------------------------------------------------------
-- Operating System Facilities (os)
if os then
library_function {
func = os.clock,
name = 'os.clock',
para = '',
docs = [[
Returns an approximation of the amount in seconds of CPU time used by the program.
]]
}
library_function {
func = os.date,
name = 'os.date',
para = '[format [, time]]',
docs = [[
Returns a string or a table containing date and time, formatted according to the given string format.
If the time argument is present, this is the time to be formatted (see the os.time function for a description of this value). Otherwise, date formats the current time.
If format starts with '!', then the date is formatted in Coordinated Universal Time. After this optional character, if format is the string "*t", then date returns a table with the following fields: year (four digits), month (1--12), day (1--31), hour (0--23), min (0--59), sec (0--61), wday (weekday, Sunday is 1), yday (day of the year), and isdst (daylight saving flag, a boolean).
If format is not "*t", then date returns the date as a string, formatted according to the same rules as the C function strftime.
When called without arguments, date returns a reasonable date and time representation that depends on the host system and on the current locale (that is, os.date() is equivalent to os.date("%c")).
]]
}
library_function {
func = os.difftime,
name = 'os.difftime',
para = 't2, t1',
docs = [[
Returns the number of seconds from time t1 to time t2. In POSIX, Windows, and some other systems, this value is exactly t2-t1.
]]
}
library_function {
func = os.execute,
name = 'os.execute',
para = '[command]',
docs = [[
This function is equivalent to the C function system. It passes command to be executed by an operating system shell. It returns a status code, which is system-dependent. If command is absent, then it returns nonzero if a shell is available and zero otherwise.
]]
}
library_function {
func = os.exit,
name = 'os.exit',
para = '[code]',
docs = [[
Calls the C function exit, with an optional code, to terminate the host program. The default value for code is the success code.
]]
}
library_function {
func = os.getenv,
name = 'os.getenv',
para = 'varname',
docs = [[
Returns the value of the process environment variable varname, or nil if the variable is not defined.
]]
}
library_function {
func = os.remove,
name = 'os.remove',
para = 'filename',
docs = [[
Deletes the file or directory with the given name. Directories must be empty to be removed. If this function fails, it returns nil, plus a string describing the error.
]]
}
library_function {
func = os.rename,
name = 'os.rename',
para = 'oldname, newname',
docs = [[
Renames file or directory named oldname to newname. If this function fails, it returns nil, plus a string describing the error.
]]
}
library_function {
func = os.setlocale,
name = 'os.setlocale',
para = 'locale [, category]',
docs = [[
Sets the current locale of the program. locale is a string specifying a locale; category is an optional string describing which category to change: "all", "collate", "ctype", "monetary", "numeric", or "time"; the default category is "all". The function returns the name of the new locale, or nil if the request cannot be honored.
If locale is the empty string, the current locale is set to an implementation-defined native locale. If locale is the string "C", the current locale is set to the standard C locale.
When called with nil as the first argument, this function only returns the name of the current locale for the given category
]]
}
library_function {
func = os.time,
name = 'os.time',
para = '[table]',
docs = [[
Returns the current time when called without arguments, or a time representing the date and time specified by the given table. This table must have fields year, month, and day, and may have fields hour, min, sec, and isdst (for a description of these fields, see the os.date function).
The returned value is a number, whose meaning depends on your system. In POSIX, Windows, and some other systems, this number counts the number of seconds since some given start time (the "epoch"). In other systems, the meaning is not specified, and the number returned by time can be used only as an argument to date and difftime.
]]
}
library_function {
func = os.tmpname,
name = 'os.tmpname',
para = '',
docs = [[
Returns a string with a file name that can be used for a temporary file. The file must be explicitly opened before its use and explicitly removed when no longer needed.
On some systems (POSIX), this function also creates a file with that name, to avoid security risks. (Someone else might create the file with wrong permissions in the time between getting the name and creating the file.) You still have to open the file to use it and to remove it (even if you do not use it).
When possible, you may prefer to use io.tmpfile, which automatically removes the file when the program ends.
]]
}
end
--------------------------------------------------------------------------------
-- The Debug Library (debug)
if debug then
library_function {
func = debug.debug,
name = 'debug.debug',
para = '',
docs = [[
Enters an interactive mode with the user, running each string that the user enters. Using simple commands and other debug facilities, the user can inspect global and local variables, change their values, evaluate expressions, and so on. A line containing only the word cont finishes this function, so that the caller continues its execution.
Note that commands for debug.debug are not lexically nested within any function, and so have no direct access to local variables.
]]
}
library_function {
func = debug.getfenv,
name = 'debug.getfenv',
para = 'o',
docs = [[
Returns the environment of object o.
]]
}
library_function {
func = debug.gethook,
name = 'debug.gethook',
para = '[thread]',
docs = [[
Returns the current hook settings of the thread, as three values: the current hook function, the current hook mask, and the current hook count (as set by the debug.sethook function).
]]
}
library_function {
func = debug.getinfo,
name = 'debug.getinfo',
para = '[thread,] function [, what]',
docs = [[
Returns a table with information about a function. You can give the function directly, or you can give a number as the value of function, which means the function running at level function of the call stack of the given thread: level 0 is the current function (getinfo itself); level 1 is the function that called getinfo; and so on. If function is a number larger than the number of active functions, then getinfo returns nil.
The returned table can contain all the fields returned by lua_getinfo, with the string what describing which fields to fill in. The default for what is to get all information available, except the table of valid lines. If present, the option 'f' adds a field named func with the function itself. If present, the option 'L' adds a field named activelines with the table of valid lines.
For instance, the expression debug.getinfo(1,"n").name returns a table with a name for the current function, if a reasonable name can be found, and the expression debug.getinfo(print) returns a table with all available information about the print function.
]]
}
library_function {
func = debug.getlocal,
name = 'debug.getlocal',
para = '[thread,] local, local',
docs = [[
This function returns the name and the value of the local variable with index local of the function at level level of the stack. (The first parameter or local variable has index 1, and so on, until the last active local variable.) The function returns nil if there is no local variable with the given index, and raises an error when called with a level out of range. (You can call debug.getinfo to check whether the level is valid.)
Variable names starting with '(' (open parentheses) represent internal variables (loop control variables, temporaries, and C function locals).
]]
}
library_function {
func = debug.getmetatable,
name = 'debug.getmetatable',
para = 'object',
docs = [[
Returns the metatable of the given object or nil if it does not have a metatable.
]]
}
library_function {
func = debug.getregistry,
name = 'debug.getregistry',
para = '',
docs = [[
Returns the registry table (see §3.5).
]]
}
library_function {
func = debug.getupvalue,
name = 'debug.getupvalue',
para = 'func, up',
docs = [[
This function returns the name and the value of the upvalue with index up of the function func. The function returns nil if there is no upvalue with the given index.
]]
}
library_function {
func = debug.setfenv,
name = 'debug.setfenv',
para = 'object, table',
docs = [[
Sets the environment of the given object to the given table. Returns object.
]]
}
library_function {
func = debug.sethook,
name = 'debug.sethook',
para = '[thread,] hook, mask [, count]',
docs = [[
Sets the given function as a hook. The string mask and the number count describe when the hook will be called. The string mask may have the following characters, with the given meaning:
"c": the hook is called every time Lua calls a function;
"r": the hook is called every time Lua returns from a function;
"l": the hook is called every time Lua enters a new line of code.
With a count different from zero, the hook is called after every count instructions.
When called without arguments, debug.sethook turns off the hook.
When the hook is called, its first parameter is a string describing the event that has triggered its call: "call", "return" (or "tail return", when simulating a return from a tail call), "line", and "count". For line events, the hook also gets the new line number as its second parameter. Inside a hook, you can call getinfo with level 2 to get more information about the running function (level 0 is the getinfo function, and level 1 is the hook function), unless the event is "tail return". In this case, Lua is only simulating the return, and a call to getinfo will return invalid data.
]]
}
library_function {
func = debug.setlocal,
name = 'debug.setlocal',
para = '[thread,] level, local, value',
docs = [[
This function assigns the value value to the local variable with index local of the function at level level of the stack. The function returns nil if there is no local variable with the given index, and raises an error when called with a level out of range. (You can call getinfo to check whether the level is valid.) Otherwise, it returns the name of the local variable.
]]
}
library_function {
func = debug.setmetatable,
name = 'debug.setmetatable',
para = 'object, table',
docs = [[
Sets the metatable for the given object to the given table (which can be nil).
]]
}
library_function {
func = debug.setupvalue,
name = 'debug.setupvalue',
para = 'func, up, value',
docs = [[
This function assigns the value value to the upvalue with index up of the function func. The function returns nil if there is no upvalue with the given index. Otherwise, it returns the name of the upvalue.
]]
}
library_function {
func = debug.traceback,
name = 'debug.traceback',
para = '[thread,] [message [, level]]',
docs = [[
Returns a string with a traceback of the call stack. An optional message string is appended at the beginning of the traceback. An optional level number tells at which level to start the traceback (default is 1, the function calling traceback).
]]
}
end
--------------------------------------------------------------------------------
-- JIT
if jit then
library_function {
func = jit.on,
name = 'jit.on',
para = '[func|true [, true|false]]',
docs = [[
Enables jit compilation, depending upon the given arguments:
- None: Enable entirely
- (func): For the given function
- (true): For the calling function
- (func|true, true): The function and all sub-functions (recursivly).
- (func|true, false): Not the function but all sub-functions (recursivly).
Does not trigger immidiate compilation.
]]
}
library_function {
func = jit.off,
name = 'jit.off',
para = '[func|true [, true|false]]',
docs = [[
Disables jit compilation, depending upon the given arguments:
- None: Disable Entirely
- (func): For the given function
- (true): For the calling function
- (func|true, true): The function and all sub-functions (recursivly).
- (func|true, false): Not the function but all sub-functions (recursivly).
Also flushes the cache of the affected compiled code.
]]
}
library_function {
func = jit.flush,
name = 'jit.flush',
para = '[func|true|trace [, true|false]]',
docs = [[
Flushes cache of compiled code, depending upon the given arguments:
- None: Flush entire cache.
- (func): For the given function
- (true): For the calling function
- (func|true, true): The function and all sub-functions (recursivly).
- (func|true, false): Not the function but all sub-functions (recursivly).
- (trace): Flushes the root trace, specified by its number, and all of its side traces from the cache. The code for the trace will be retained as long as there are any other traces which link to it.
]]
}
library_function {
func = jit.status,
name = 'jit.status',
para = '',
docs = [[
Returns the current status of the JIT compiler.
The first result is either true or false if the JIT compiler is turned on or off.
The remaining results are strings for CPU-specific features and enabled optimizations.
]]
}
library_function {
func = jit.opt and jit.opt.start,
name = 'jit.opt.start',
para = '...',
docs = [[
This sub-module provides the backend for the -O command line option.
You can also use it programmatically, e.g.:
jit.opt.start(2) -- same as -O2
jit.opt.start("-dce")
jit.opt.start("hotloop=10", "hotexit=2")
Unlike in LuaJIT 1.x, the module is built-in and optimization is turned on by default! It's no longer necessary to run require("jit.opt").start(), which was one of the ways to enable optimization.
]]
}
library_function {
func = jit.attach,
name = 'jit.attach',
para = '...',
docs = [[
Undocumented.
For info, see: http://wiki.luajit.org/JIT-Compiler-API
]]
}
for func_name, func in pairs(jit.util or {}) do
library_function {
func = func,
name = 'jit.util.'..func_name,
para = '...',
docs = [[
Undocumented, in flux and thus unstable!
Part of the sub-module for introspection of bytecode, traces, IR and machine code.
For info, see: http://luajit.org/ext_jit.html#jit_util
]]
}
end
end
--------------------------------------------------------------------------------
-- FFI
-- TODO: Add FFI documentation
-- Documentation is here: http://luajit.org/ext_ffi_api.html
--------------------------------------------------------------------------------
return function_library
View Git Blame Copy Permalink