<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Penlight Documentation</title>
<link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->
<div id="main">
<!-- Menu -->
<div id="navigation">
<br/>
<h1>Penlight</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
</ul>
<h2>Libraries</h2>
<ul class="$(kind=='Topics' and '' or 'nowrap'">
<li><a href="../libraries/pl.html">pl</a></li>
<li><a href="../libraries/pl.Set.html">pl.Set</a></li>
<li><a href="../libraries/pl.app.html">pl.app</a></li>
<li><a href="../libraries/pl.array2d.html">pl.array2d</a></li>
<li><a href="../libraries/pl.class.html">pl.class</a></li>
<li><a href="../libraries/pl.compat.html">pl.compat</a></li>
<li><a href="../libraries/pl.comprehension.html">pl.comprehension</a></li>
<li><a href="../libraries/pl.config.html">pl.config</a></li>
<li><a href="../libraries/pl.data.html">pl.data</a></li>
<li><a href="../libraries/pl.dir.html">pl.dir</a></li>
<li><a href="../libraries/pl.file.html">pl.file</a></li>
<li><a href="../libraries/pl.func.html">pl.func</a></li>
<li><a href="../libraries/pl.import_into.html">pl.import_into</a></li>
<li><a href="../libraries/pl.input.html">pl.input</a></li>
<li><a href="../libraries/pl.lapp.html">pl.lapp</a></li>
<li><a href="../libraries/pl.lexer.html">pl.lexer</a></li>
<li><a href="../libraries/pl.luabalanced.html">pl.luabalanced</a></li>
<li><a href="../libraries/pl.operator.html">pl.operator</a></li>
<li><a href="../libraries/pl.path.html">pl.path</a></li>
<li><a href="../libraries/pl.permute.html">pl.permute</a></li>
<li><strong>pl.pretty</strong></li>
<li><a href="../libraries/pl.seq.html">pl.seq</a></li>
<li><a href="../libraries/pl.sip.html">pl.sip</a></li>
<li><a href="../libraries/pl.strict.html">pl.strict</a></li>
<li><a href="../libraries/pl.stringio.html">pl.stringio</a></li>
<li><a href="../libraries/pl.stringx.html">pl.stringx</a></li>
<li><a href="../libraries/pl.tablex.html">pl.tablex</a></li>
<li><a href="../libraries/pl.template.html">pl.template</a></li>
<li><a href="../libraries/pl.test.html">pl.test</a></li>
<li><a href="../libraries/pl.text.html">pl.text</a></li>
<li><a href="../libraries/pl.types.html">pl.types</a></li>
<li><a href="../libraries/pl.url.html">pl.url</a></li>
<li><a href="../libraries/pl.utils.html">pl.utils</a></li>
<li><a href="../libraries/pl.xml.html">pl.xml</a></li>
</ul>
<h2>Classes</h2>
<ul class="$(kind=='Topics' and '' or 'nowrap'">
<li><a href="../classes/pl.Date.html">pl.Date</a></li>
<li><a href="../classes/pl.List.html">pl.List</a></li>
<li><a href="../classes/pl.Map.html">pl.Map</a></li>
<li><a href="../classes/pl.MultiMap.html">pl.MultiMap</a></li>
<li><a href="../classes/pl.OrderedMap.html">pl.OrderedMap</a></li>
</ul>
<h2>Manual</h2>
<ul class="$(kind=='Topics' and '' or 'nowrap'">
<li><a href="../manual/01-introduction.md.html">Introduction</a></li>
<li><a href="../manual/02-arrays.md.html">Tables and Arrays</a></li>
<li><a href="../manual/03-strings.md.html">Strings. Higher-level operations on strings.</a></li>
<li><a href="../manual/04-paths.md.html">Paths and Directories</a></li>
<li><a href="../manual/05-dates.md.html">Date and Time</a></li>
<li><a href="../manual/06-data.md.html">Data</a></li>
<li><a href="../manual/07-functional.md.html">Functional Programming</a></li>
<li><a href="../manual/08-additional.md.html">Additional Libraries</a></li>
<li><a href="../manual/09-discussion.md.html">Technical Choices</a></li>
</ul>
<h2>Examples</h2>
<ul class="$(kind=='Topics' and '' or 'nowrap'">
<li><a href="../examples/seesubst.lua.html">seesubst.lua</a></li>
<li><a href="../examples/sipscan.lua.html">sipscan.lua</a></li>
<li><a href="../examples/symbols.lua.html">symbols.lua</a></li>
<li><a href="../examples/test-cmp.lua.html">test-cmp.lua</a></li>
<li><a href="../examples/test-data.lua.html">test-data.lua</a></li>
<li><a href="../examples/test-listcallbacks.lua.html">test-listcallbacks.lua</a></li>
<li><a href="../examples/test-pretty.lua.html">test-pretty.lua</a></li>
<li><a href="../examples/test-symbols.lua.html">test-symbols.lua</a></li>
<li><a href="../examples/testapp.lua.html">testapp.lua</a></li>
<li><a href="../examples/testclone.lua.html">testclone.lua</a></li>
<li><a href="../examples/testconfig.lua.html">testconfig.lua</a></li>
<li><a href="../examples/testglobal.lua.html">testglobal.lua</a></li>
<li><a href="../examples/testinputfields.lua.html">testinputfields.lua</a></li>
<li><a href="../examples/testinputfields2.lua.html">testinputfields2.lua</a></li>
<li><a href="../examples/testxml.lua.html">testxml.lua</a></li>
<li><a href="../examples/which.lua.html">which.lua</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>pl.pretty</code></h1>
<p>Pretty-printing Lua tables.</p>
<p> Also provides a sandboxed Lua table reader and
a function to present large numbers in human-friendly format.</p>
<p> Dependencies: <a href="../libraries/pl.utils.html#">pl.utils</a>, <a href="../libraries/pl.lexer.html#">pl.lexer</a></p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#read">read (s)</a></td>
<td class="summary">read a string representation of a Lua table.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#load">load (s, env, paranoid)</a></td>
<td class="summary">read a Lua chunk.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#write">write (tbl, space, not_clever)</a></td>
<td class="summary">Create a string representation of a Lua table.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#dump">dump (t, ...)</a></td>
<td class="summary">Dump a Lua table out to a file or stdout.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#number">number (num, kind, prec)</a></td>
<td class="summary">format large numbers nicely for human consumption.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "read"></a>
<strong>read (s)</strong>
</dt>
<dd>
read a string representation of a Lua table.
Uses load(), but tries to be cautious about loading arbitrary code!
It is expecting a string of the form '{...}', with perhaps some whitespace
before or after the curly braces. A comment may occur beforehand.
An empty environment is used, and
any occurance of the keyword 'function' will be considered a problem.
in the given environment - the return value may be <code>nil</code>.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
string of the form '{...}', with perhaps some whitespace
before or after the curly braces.
</li>
</ul>
<h3>Returns:</h3>
<ol>
a table
</ol>
</dd>
<dt>
<a name = "load"></a>
<strong>load (s, env, paranoid)</strong>
</dt>
<dd>
read a Lua chunk.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
Lua code
</li>
<li><span class="parameter">env</span>
optional environment
</li>
<li><span class="parameter">paranoid</span>
<span class="types"><span class="type">bool</span></span>
prevent any looping constructs and disable string methods
</li>
</ul>
<h3>Returns:</h3>
<ol>
the environment
</ol>
</dd>
<dt>
<a name = "write"></a>
<strong>write (tbl, space, not_clever)</strong>
</dt>
<dd>
Create a string representation of a Lua table.
This function never fails, but may complain by returning an
extra value. Normally puts out one item per line, using
the provided indent; set the second parameter to '' if
you want output on one line.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">tbl</span>
<span class="types"><span class="type">tab</span></span>
Table to serialize to a string.
</li>
<li><span class="parameter">space</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
<p> (optional) The indent to use.</p>
<pre><code>Defaults to two spaces; make it the empty string for no indentation
</code></pre>
</li>
<li><span class="parameter">not_clever</span>
<span class="types"><span class="type">bool</span></span>
<p> (optional) Use for plain output, e.g {['key']=1}.</p>
<pre><code>Defaults to false.
</code></pre>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<li>
a string</li>
<li>
a possible error message</li>
</ol>
</dd>
<dt>
<a name = "dump"></a>
<strong>dump (t, ...)</strong>
</dt>
<dd>
Dump a Lua table out to a file or stdout.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">t</span>
{table} The table to write to a file or stdout.
</li>
<li><span class="parameter">...</span>
<p> {string} (optional) File name to write too. Defaults to writing</p>
<pre><code>to stdout.
</code></pre>
</li>
</ul>
</dd>
<dt>
<a name = "number"></a>
<strong>number (num, kind, prec)</strong>
</dt>
<dd>
format large numbers nicely for human consumption.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">num</span>
a number
</li>
<li><span class="parameter">kind</span>
one of 'M' (memory in KiB etc), 'N' (postfixes are 'K','M' and 'B')
and 'T' (use commas as thousands separator)
</li>
<li><span class="parameter">prec</span>
number of digits to use for 'M' and 'N' (default 1)
</li>
</ul>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
<i style="float:right;">Last updated 2015-03-21 18:49:03 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
