1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
|
<!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.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>Modules</h2>
<ul>
<li><a href="../modules/pl.html">pl</a></li>
<li><a href="../modules/pl.Date.html">pl.Date</a></li>
<li><a href="../modules/pl.List.html">pl.List</a></li>
<li><a href="../modules/pl.Map.html">pl.Map</a></li>
<li><a href="../modules/pl.MultiMap.html">pl.MultiMap</a></li>
<li><a href="../modules/pl.OrderedMap.html">pl.OrderedMap</a></li>
<li><a href="../modules/pl.Set.html">pl.Set</a></li>
<li><a href="../modules/pl.app.html">pl.app</a></li>
<li><a href="../modules/pl.array2d.html">pl.array2d</a></li>
<li><a href="../modules/pl.class.html">pl.class</a></li>
<li><a href="../modules/pl.comprehension.html">pl.comprehension</a></li>
<li><a href="../modules/pl.config.html">pl.config</a></li>
<li><a href="../modules/pl.data.html">pl.data</a></li>
<li><a href="../modules/pl.dir.html">pl.dir</a></li>
<li><a href="../modules/pl.file.html">pl.file</a></li>
<li><a href="../modules/pl.func.html">pl.func</a></li>
<li><a href="../modules/pl.input.html">pl.input</a></li>
<li><a href="../modules/pl.lapp.html">pl.lapp</a></li>
<li><a href="../modules/pl.lexer.html">pl.lexer</a></li>
<li><a href="../modules/pl.luabalanced.html">pl.luabalanced</a></li>
<li><a href="../modules/pl.operator.html">pl.operator</a></li>
<li><a href="../modules/pl.path.html">pl.path</a></li>
<li><a href="../modules/pl.permute.html">pl.permute</a></li>
<li><strong>pl.pretty</strong></li>
<li><a href="../modules/pl.seq.html">pl.seq</a></li>
<li><a href="../modules/pl.sip.html">pl.sip</a></li>
<li><a href="../modules/pl.strict.html">pl.strict</a></li>
<li><a href="../modules/pl.stringio.html">pl.stringio</a></li>
<li><a href="../modules/pl.stringx.html">pl.stringx</a></li>
<li><a href="../modules/pl.tablex.html">pl.tablex</a></li>
<li><a href="../modules/pl.template.html">pl.template</a></li>
<li><a href="../modules/pl.test.html">pl.test</a></li>
<li><a href="../modules/pl.text.html">pl.text</a></li>
<li><a href="../modules/pl.utils.html">pl.utils</a></li>
<li><a href="../modules/pl.xml.html">pl.xml</a></li>
</ul>
<h2>Topics</h2>
<ul>
<li><a href="../topics/01-introduction.md.html">01-introduction.md</a></li>
<li><a href="../topics/02-arrays.md.html">02-arrays.md</a></li>
<li><a href="../topics/03-strings.md.html">03-strings.md</a></li>
<li><a href="../topics/04-paths.md.html">04-paths.md</a></li>
<li><a href="../topics/05-dates.md.html">05-dates.md</a></li>
<li><a href="../topics/06-data.md.html">06-data.md</a></li>
<li><a href="../topics/07-functional.md.html">07-functional.md</a></li>
<li><a href="../topics/08-additional.md.html">08-additional.md</a></li>
<li><a href="../topics/09-discussion.md.html">09-discussion.md</a></li>
</ul>
<h2>Examples</h2>
<ul>
<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="../modules/pl.utils.html#">pl.utils</a> , <a href="../modules/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><code><em>s</em></code>: <p> {string} string of the form ‘{…}’, with perhaps some whitespace</p>
<pre><code> before or after the curly braces.
</code></pre>
</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><code><em>s</em></code>: Lua code</li>
<li><code><em>env</em></code>: optional environment</li>
<li><code><em>paranoid</em></code>: 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><code><em>tbl</em></code>: {table} Table to serialize to a string.</li>
<li><code><em>space</em></code>: <p> {string} (optional) The indent to use.</p>
<pre><code> Defaults to two spaces; make it the empty string for no indentation
</code></pre>
</li>
<li><code><em>not_clever</em></code>: <p> {bool} (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><code><em>t</em></code>: {table} The table to write to a file or stdout.</li>
<li><code><em>...</em></code>: <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><code><em>num</em></code>: a number</li>
<li><code><em>kind</em></code>: one of ‘M’ (memory in KiB etc), ‘N’ (postfixes are ‘K’,‘M’ and ‘B’)
and ’T' (use commas as thousands separator)</li>
<li><code><em>prec</em></code>: 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.2</a></i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
|
