repo/luan: website/src/manual.html.luan comparison

comparison website/src/manual.html.luan @ 470:5627eb637eb4

documentation

author	Franklin Schmidt <fschmidt@gmail.com>
date	Sat, 09 May 2015 23:54:22 -0600
parents	85467f95ab13
children	f4aca5a5346a

comparison

equal deleted inserted replaced

-:85467f95ab13
+:5627eb637eb4
 <div margin-bottom="1em">
 	<a href="#libs">Standard Libraries</a>
 	<ul>
 		<li><a href="#default_lib">Default Environment</a></li>
+		<li><a href="#luan_lib">Basic Functions</a></li>
 	</ul>
 </div>
 <hr/>
 <h3 margin-top="1em"><a name="default_lib">Default Environment</a></h3>
 <p>
 These are provided by default as local variables for any Luan code as described in <a href="#env">Environments</a>.
 <h4 margin-top="1em"><a name="_ENV"><tt>_ENV</tt></a></h4>
 <p>
 This is a table that holds the global variables of a module as described in <a href="#env">Environments</a>.
+<h4 margin-top="1em"><a name="require"><tt>java ()</tt></a></h4>
-<h2>6.1 &ndash; <a name="6.1">Basic Functions</a></h2>
+<p>
-<p>
+This function enables Java in the current chunk if that chunk has permission to use Java.  If the chunk doesn't have permission to use Java, then an error is thrown.
-The basic library provides core functions to Lua.
-If you do not include this library in your application,
-you should check carefully whether you need to provide
+<h4 margin-top="1em"><a name="require"><tt>require (mod_uri)</tt></a></h4>
-implementations for some of its facilities.
+<p>
+Example use:
-<p>
-<hr><h3><a name="pdf-assert"><code>assert (v [, message])</code></a></h3>
+<p><tt><pre>
+	local Table = require "luan:Table"
+</pre></tt></p>
-<p>
-Calls <a href="#pdf-error"><code>error</code></a> if
+<p>
-the value of its argument <code>v</code> is false (i.e., <b>nil</b> or <b>false</b>);
+Could be defined as:
-otherwise, returns all its arguments.
-In case of error,
+<p><tt><pre>
-<code>message</code> is the error object;
+	local function require(mod_name)
-when absent, it defaults to "<code>assertion failed!</code>"
+		return Package.load(mod_name) or Luan.error("module '"..mod_name.."' not found")
+	end
+</pre></tt></p>
-<p>
+<h3 margin-top="1em"><a name="luan_lib">Basic Functions</a></h3>
-<hr><h3><a name="pdf-collectgarbage"><code>collectgarbage ([opt [, arg]])</code></a></h3>
+<p>
+Include this library by:
-<p>
-This function is a generic interface to the garbage collector.
+<p><tt><pre>
-It performs different functions according to its first argument, <code>opt</code>:
+	local Luan = require "luan:Luan"
+</pre></tt></p>
-<ul>
+The basic library provides basic functions to Luan that don't depend on other libaries.
-<li><b>"<code>collect</code>": </b>
-performs a full garbage-collection cycle.
-This is the default option.
+<h4 margin-top="1em"><a name="Luan.assert"><tt>Luan.assert (v [, message])</tt></a></h4>
-</li>
+<p>
-<li><b>"<code>stop</code>": </b>
+Could be defined as:
-stops automatic execution of the garbage collector.
-The collector will run only when explicitly invoked,
+<p><tt><pre>
-until a call to restart it.
+	function Luan.assert(v,message)
-</li>
+		return v or Luan.error(message or "assertion failed!")
+	end
-<li><b>"<code>restart</code>": </b>
+</pre></tt></p>
-restarts automatic execution of the garbage collector.
-</li>
+<h4 margin-top="1em"><a name="Luan.assert_binary"><tt>Luan.assert_binary (v)</tt></a></h4>
-<li><b>"<code>count</code>": </b>
-returns the total memory in use by Lua in Kbytes.
+<p>
-The value has a fractional part,
+Could be defined as:
-so that it multiplied by 1024
-gives the exact number of bytes in use by Lua
+<p><tt><pre>
-(except for overflows).
+	function Luan.assert_binary(v)
-</li>
+		local v_type = Luan.type(v)
+		return v_type == "binary" and v or Luan.error("bad argument #1 (binary expected, got "..v_type..")")
-<li><b>"<code>step</code>": </b>
+	end
-performs a garbage-collection step.
+</pre></tt></p>
-The step "size" is controlled by <code>arg</code>.
-With a zero value,
-the collector will perform one basic (indivisible) step.
+<h4 margin-top="1em"><a name="Luan.assert_boolean"><tt>Luan.assert_boolean (v)</tt></a></h4>
-For non-zero values,
-the collector will perform as if that amount of memory
+<p>
-(in KBytes) had been allocated by Lua.
+Like <a href="#Luan.assert_binary"><tt>assert_binary</tt></a> but for type <tt>boolean</tt>.
-Returns <b>true</b> if the step finished a collection cycle.
-</li>
+<h4 margin-top="1em"><a name="Luan.assert_integer"><tt>Luan.assert_integer (v)</tt></a></h4>
-<li><b>"<code>setpause</code>": </b>
-sets <code>arg</code> as the new value for the <em>pause</em> of
+<p>
-the collector (see <a href="#2.5">&sect;2.5</a>).
+Asserts that <tt>v</tt> can be converted to Java type <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html">Integer</a> and returns an Integer.
-Returns the previous value for <em>pause</em>.
-</li>
+<h4 margin-top="1em"><a name="Luan.assert_long"><tt>Luan.assert_long (v)</tt></a></h4>
-<li><b>"<code>setstepmul</code>": </b>
-sets <code>arg</code> as the new value for the <em>step multiplier</em> of
+<p>
-the collector (see <a href="#2.5">&sect;2.5</a>).
+Asserts that <tt>v</tt> can be converted to Java type <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html">Long</a> and returns a Long.
-Returns the previous value for <em>step</em>.
-</li>
+<h4 margin-top="1em"><a name="Luan.assert_number"><tt>Luan.assert_number (v)</tt></a></h4>
-<li><b>"<code>isrunning</code>": </b>
-returns a boolean that tells whether the collector is running
+<p>
-(i.e., not stopped).
+Like <a href="#Luan.assert_binary"><tt>assert_binary</tt></a> but for type <tt>number</tt>.
-</li>
-</ul>
+<h4 margin-top="1em"><a name="Luan.assert_string"><tt>Luan.assert_string (v)</tt></a></h4>
+<p>
+Like <a href="#Luan.assert_binary"><tt>assert_binary</tt></a> but for type <tt>string</tt>.
-<p>
-<hr><h3><a name="pdf-dofile"><code>dofile ([filename])</code></a></h3>
-Opens the named file and executes its contents as a Lua chunk.
+<h4 margin-top="1em"><a name="Luan.assert_table"><tt>Luan.assert_table (v)</tt></a></h4>
-When called without arguments,
-<code>dofile</code> executes the contents of the standard input (<code>stdin</code>).
+<p>
-Returns all values returned by the chunk.
+Like <a href="#Luan.assert_binary"><tt>assert_binary</tt></a> but for type <tt>table</tt>.
-In case of errors, <code>dofile</code> propagates the error
-to its caller (that is, <code>dofile</code> does not run in protected mode).
+<h4 margin-top="1em"><a name="Luan.do_file"><tt>Luan.do_file ([uri])</tt></a></h4>
+<p>
+Could be defined as:
-<p>
-<hr><h3><a name="pdf-error"><code>error (message [, level])</code></a></h3>
+<p><tt><pre>
-Terminates the last protected function called
+	function Luan.do_file(uri)
-and returns <code>message</code> as the error object.
+		return load_file(uri)()
-Function <code>error</code> never returns.
+	end
+</pre></tt></p>
-<p>
-Usually, <code>error</code> adds some information about the error position
-at the beginning of the message, if the message is a string.
+<h4 margin-top="1em"><a name="Luan.error"><tt>Luan.error (message)</tt></a></h4>
-The <code>level</code> argument specifies how to get the error position.
-With level&nbsp;1 (the default), the error position is where the
+<p>
-<code>error</code> function was called.
+Throws an error containing the message.  This uses Java exceptions internally and the implementation is likely to change.  So this documentation is likely to change.
-Level&nbsp;2 points the error to where the function
-that called <code>error</code> was called; and so on.
-Passing a level&nbsp;0 avoids the addition of error position information
+<h4 margin-top="1em"><a name="Luan.get_metatable"><tt>Luan.get_metatable (table)</tt></a></h4>
-to the message.
+<p>
+If <tt>table</tt> does not have a metatable, returns <b>nil</b>.
-<p>
-<hr><h3><a name="pdf-_G"><code>_G</code></a></h3>
-A global variable (not a function) that
-holds the global environment (see <a href="#2.2">&sect;2.2</a>).
-Lua itself does not use this variable;
-changing its value does not affect any environment,
-nor vice versa.
-<p>
-<hr><h3><a name="pdf-getmetatable"><code>getmetatable (object)</code></a></h3>
-<p>
-If <code>object</code> does not have a metatable, returns <b>nil</b>.
 Otherwise,
-if the object's metatable has a <code>"__metatable"</code> field,
+if the table's metatable has a <tt>"__metatable"</tt> field,
 returns the associated value.
-Otherwise, returns the metatable of the given object.
+Otherwise, returns the metatable of the given table.
 <p>

Mercurial Hosting > luan

comparison website/src/manual.html.luan @ 470:5627eb637eb4