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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
|
<!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="https://github.com/lunarmodules/Penlight">GitHub Project</a></li>
<li><a href="../index.html">Documentation</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
</ul>
<h2>Libraries</h2>
<ul class="nowrap">
<li><a href="../libraries/pl.html">pl</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><a href="../libraries/pl.pretty.html">pl.pretty</a></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><strong>pl.types</strong></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="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>
<li><a href="../classes/pl.Set.html">pl.Set</a></li>
</ul>
<h2>Manual</h2>
<ul class="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="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/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.types</code></h1>
<p>Dealing with Detailed Type Information</p>
<p>
</p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#is_callable">is_callable (obj)</a></td>
<td class="summary">is the object either a function or a callable object?.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#is_type">is_type (obj, tp)</a></td>
<td class="summary">is the object of the specified type?.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#type">type (obj)</a></td>
<td class="summary">a string representation of a type.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#is_integer">is_integer (x)</a></td>
<td class="summary">is this number an integer?</td>
</tr>
<tr>
<td class="name" nowrap><a href="#is_empty">is_empty (o, ignore_spaces)</a></td>
<td class="summary">Check if the object is "empty".</td>
</tr>
<tr>
<td class="name" nowrap><a href="#is_indexable">is_indexable (val)</a></td>
<td class="summary">is an object 'array-like'?</td>
</tr>
<tr>
<td class="name" nowrap><a href="#is_iterable">is_iterable (val)</a></td>
<td class="summary">can an object be iterated over with <a href="https://www.lua.org/manual/5.1/manual.html#pdf-pairs">pairs</a>?</td>
</tr>
<tr>
<td class="name" nowrap><a href="#is_writeable">is_writeable (val)</a></td>
<td class="summary">can an object accept new key/pair values?</td>
</tr>
<tr>
<td class="name" nowrap><a href="#to_bool">to_bool (o[, true_strs[, check_objs]])</a></td>
<td class="summary">Convert to a boolean value.</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "is_callable"></a>
<strong>is_callable (obj)</strong>
</dt>
<dd>
is the object either a function or a callable object?.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">obj</span>
Object to check.
</li>
</ul>
</dd>
<dt>
<a name = "is_type"></a>
<strong>is_type (obj, tp)</strong>
</dt>
<dd>
is the object of the specified type?.
If the type is a string, then use type, otherwise compare with metatable.</p>
<p> NOTE: this function is imported from <a href="../libraries/pl.utils.html#is_type">utils.is_type</a>.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">obj</span>
An object to check
</li>
<li><span class="parameter">tp</span>
The expected type
</li>
</ul>
<h3>See also:</h3>
<ul>
<a href="../libraries/pl.utils.html#is_type">utils.is_type</a>
</ul>
</dd>
<dt>
<a name = "type"></a>
<strong>type (obj)</strong>
</dt>
<dd>
a string representation of a type.
For tables and userdata with metatables, we assume that the metatable has a <code>_name</code>
field. If the field is not present it will return 'unknown table' or
'unknown userdata'.
Lua file objects return the type 'file'.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">obj</span>
an object
</li>
</ul>
<h3>Returns:</h3>
<ol>
a string like 'number', 'table', 'file' or 'List'
</ol>
</dd>
<dt>
<a name = "is_integer"></a>
<strong>is_integer (x)</strong>
</dt>
<dd>
is this number an integer?
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">x</span>
a number
</li>
</ul>
<h3>Returns:</h3>
<ol>
boolean
</ol>
<h3>Raises:</h3>
error if x is not a number
</dd>
<dt>
<a name = "is_empty"></a>
<strong>is_empty (o, ignore_spaces)</strong>
</dt>
<dd>
<p>Check if the object is "empty".
An object is considered empty if it is:</p>
<ul>
<li><code>nil</code></li>
<li>a table with out any items (key-value pairs or indexes)</li>
<li>a string with no content ("")</li>
<li>not a nil/table/string</li>
</ul>
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">o</span>
The object to check if it is empty.
</li>
<li><span class="parameter">ignore_spaces</span>
If the object is a string and this is true the string is
considered empty if it only contains spaces.
</li>
</ul>
<h3>Returns:</h3>
<ol>
<code>true</code> if the object is empty, otherwise a falsy value.
</ol>
</dd>
<dt>
<a name = "is_indexable"></a>
<strong>is_indexable (val)</strong>
</dt>
<dd>
is an object 'array-like'?
An object is array like if:</p>
<ul>
<li>it is a table, or</li>
<li>it has a metatable with <code>__len</code> and <code>__index</code> methods</li>
</ul>
<p> NOTE: since <code>__len</code> is 5.2+, on 5.1 is usually returns <code>false</code> for userdata
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">val</span>
any value.
</li>
</ul>
<h3>Returns:</h3>
<ol>
<code>true</code> if the object is array-like, otherwise a falsy value.
</ol>
</dd>
<dt>
<a name = "is_iterable"></a>
<strong>is_iterable (val)</strong>
</dt>
<dd>
can an object be iterated over with <a href="https://www.lua.org/manual/5.1/manual.html#pdf-pairs">pairs</a>?
An object is iterable if:</p>
<ul>
<li>it is a table, or</li>
<li>it has a metatable with a <code>__pairs</code> meta method</li>
</ul>
<p> NOTE: since <code>__pairs</code> is 5.2+, on 5.1 is usually returns <code>false</code> for userdata
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">val</span>
any value.
</li>
</ul>
<h3>Returns:</h3>
<ol>
<code>true</code> if the object is iterable, otherwise a falsy value.
</ol>
</dd>
<dt>
<a name = "is_writeable"></a>
<strong>is_writeable (val)</strong>
</dt>
<dd>
<p>can an object accept new key/pair values?
An object is iterable if:</p>
<ul>
<li>it is a table, or</li>
<li>it has a metatable with a <code>__newindex</code> meta method</li>
</ul>
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">val</span>
any value.
</li>
</ul>
<h3>Returns:</h3>
<ol>
<code>true</code> if the object is writeable, otherwise a falsy value.
</ol>
</dd>
<dt>
<a name = "to_bool"></a>
<strong>to_bool (o[, true_strs[, check_objs]])</strong>
</dt>
<dd>
<p>Convert to a boolean value.
True values are:</p>
<ul>
<li>boolean: true.</li>
<li>string: 'yes', 'y', 'true', 't', '1' or additional strings specified by <code>true_strs</code>.</li>
<li>number: Any non-zero value.</li>
<li>table: Is not empty and <code>check_objs</code> is true.</li>
<li>everything else: Is not <code>nil</code> and <code>check_objs</code> is true.</li>
</ul>
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">o</span>
The object to evaluate.
</li>
<li><span class="parameter">true_strs</span>
optional Additional strings that when matched should evaluate to true. Comparison is case insensitive.
This should be a List of strings. E.g. "ja" to support German.
(<em>optional</em>)
</li>
<li><span class="parameter">check_objs</span>
True if objects should be evaluated.
(<em>optional</em>)
</li>
</ul>
<h3>Returns:</h3>
<ol>
true if the input evaluates to true, otherwise false.
</ol>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
|