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
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
|
<!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="#String_Predicates">String Predicates </a></li>
<li><a href="#Strings_and_Lists">Strings and Lists </a></li>
<li><a href="#Finding_and_Replacing">Finding and Replacing </a></li>
<li><a href="#Stripping_and_Justifying">Stripping and Justifying </a></li>
<li><a href="#Partitioning_Strings">Partitioning Strings </a></li>
<li><a href="#Text_handling">Text handling </a></li>
<li><a href="#Template">Template </a></li>
<li><a href="#Miscellaneous">Miscellaneous </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><strong>pl.stringx</strong></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="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.stringx</code></h1>
<p>Python-style extended string library.</p>
<p> see 3.6.1 of the Python reference.
If you want to make these available as string methods, then say
<code>stringx.import()</code> to bring them into the standard <a href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a> table.</p>
<p> See <a href="../manual/03-strings.md.html#">the Guide</a></p>
<p> Dependencies: <a href="../libraries/pl.utils.html#">pl.utils</a>, <a href="../libraries/pl.types.html#">pl.types</a></p>
<h2><a href="#String_Predicates">String Predicates </a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#isalpha">isalpha (s)</a></td>
<td class="summary">does s only contain alphabetic characters?</td>
</tr>
<tr>
<td class="name" nowrap><a href="#isdigit">isdigit (s)</a></td>
<td class="summary">does s only contain digits?</td>
</tr>
<tr>
<td class="name" nowrap><a href="#isalnum">isalnum (s)</a></td>
<td class="summary">does s only contain alphanumeric characters?</td>
</tr>
<tr>
<td class="name" nowrap><a href="#isspace">isspace (s)</a></td>
<td class="summary">does s only contain whitespace?</td>
</tr>
<tr>
<td class="name" nowrap><a href="#islower">islower (s)</a></td>
<td class="summary">does s only contain lower case characters?</td>
</tr>
<tr>
<td class="name" nowrap><a href="#isupper">isupper (s)</a></td>
<td class="summary">does s only contain upper case characters?</td>
</tr>
<tr>
<td class="name" nowrap><a href="#startswith">startswith (s, prefix)</a></td>
<td class="summary">does s start with prefix or one of prefixes?</td>
</tr>
<tr>
<td class="name" nowrap><a href="#endswith">endswith (s, suffix)</a></td>
<td class="summary">does s end with suffix or one of suffixes?</td>
</tr>
</table>
<h2><a href="#Strings_and_Lists">Strings and Lists </a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#join">join (s, seq)</a></td>
<td class="summary">concatenate the strings using this string as a delimiter.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#splitlines">splitlines (s[, keep_ends])</a></td>
<td class="summary">Split a string into a list of lines.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#split">split (s[, re[, n]])</a></td>
<td class="summary">split a string into a list of strings using a delimiter.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#expandtabs">expandtabs (s, tabsize)</a></td>
<td class="summary">replace all tabs in s with tabsize spaces.</td>
</tr>
</table>
<h2><a href="#Finding_and_Replacing">Finding and Replacing </a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#lfind">lfind (s, sub[, first[, last]])</a></td>
<td class="summary">find index of first instance of sub in s from the left.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#rfind">rfind (s, sub[, first[, last]])</a></td>
<td class="summary">find index of first instance of sub in s from the right.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#replace">replace (s, old, new[, n])</a></td>
<td class="summary">replace up to n instances of old by new in the string s.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#count">count (s, sub[, allow_overlap])</a></td>
<td class="summary">count all instances of substring in string.</td>
</tr>
</table>
<h2><a href="#Stripping_and_Justifying">Stripping and Justifying </a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#ljust">ljust (s, w[, ch=' '])</a></td>
<td class="summary">left-justify s with width w.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#rjust">rjust (s, w[, ch=' '])</a></td>
<td class="summary">right-justify s with width w.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#center">center (s, w[, ch=' '])</a></td>
<td class="summary">center-justify s with width w.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#lstrip">lstrip (s[, chrs='%s'])</a></td>
<td class="summary">trim any characters on the left of s.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#rstrip">rstrip (s[, chrs='%s'])</a></td>
<td class="summary">trim any characters on the right of s.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#strip">strip (s[, chrs='%s'])</a></td>
<td class="summary">trim any characters on both left and right of s.</td>
</tr>
</table>
<h2><a href="#Partitioning_Strings">Partitioning Strings </a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#splitv">splitv (s[, re='%s'])</a></td>
<td class="summary">split a string using a pattern.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#partition">partition (s, ch)</a></td>
<td class="summary">partition the string using first occurrence of a delimiter</td>
</tr>
<tr>
<td class="name" nowrap><a href="#rpartition">rpartition (s, ch)</a></td>
<td class="summary">partition the string p using last occurrence of a delimiter</td>
</tr>
<tr>
<td class="name" nowrap><a href="#at">at (s, idx)</a></td>
<td class="summary">return the 'character' at the index.</td>
</tr>
</table>
<h2><a href="#Text_handling">Text handling </a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#indent">indent (s, n[, ch=' '])</a></td>
<td class="summary">indent a multiline string.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#dedent">dedent (s)</a></td>
<td class="summary">dedent a multiline string by removing any initial indent.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#wrap">wrap (s[, width=70[, breaklong=false]])</a></td>
<td class="summary">format a paragraph into lines so that they fit into a line width.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#fill">fill (s[, width=70[, breaklong=false]])</a></td>
<td class="summary">format a paragraph so that it fits into a line width.</td>
</tr>
</table>
<h2><a href="#Template">Template </a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#Template">Template (tmpl)</a></td>
<td class="summary">Creates a new Template class.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Template:substitute">Template:substitute (tbl)</a></td>
<td class="summary">substitute values into a template, throwing an error.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Template:safe_substitute">Template:safe_substitute (tbl)</a></td>
<td class="summary">substitute values into a template.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Template:indent_substitute">Template:indent_substitute (tbl)</a></td>
<td class="summary">substitute values into a template, preserving indentation.</td>
</tr>
</table>
<h2><a href="#Miscellaneous">Miscellaneous </a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#lines">lines (s)</a></td>
<td class="summary">return an iterator over all lines in a string</td>
</tr>
<tr>
<td class="name" nowrap><a href="#title">title (s)</a></td>
<td class="summary">initial word letters uppercase ('title case').</td>
</tr>
<tr>
<td class="name" nowrap><a href="#shorten">shorten (s, w, tail)</a></td>
<td class="summary">Return a shortened version of a string.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#quote_string">quote_string (s)</a></td>
<td class="summary">Quote the given string and preserve any control or escape characters, such that reloading the string in Lua returns the same result.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#format_operator">format_operator ()</a></td>
<td class="summary">Python-style formatting operator.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#import">import ()</a></td>
<td class="summary">import the stringx functions into the global string (meta)table</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="String_Predicates"></a>String Predicates </h2>
<dl class="function">
<dt>
<a name = "isalpha"></a>
<strong>isalpha (s)</strong>
</dt>
<dd>
does s only contain alphabetic characters?
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
a string
</li>
</ul>
</dd>
<dt>
<a name = "isdigit"></a>
<strong>isdigit (s)</strong>
</dt>
<dd>
does s only contain digits?
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
a string
</li>
</ul>
</dd>
<dt>
<a name = "isalnum"></a>
<strong>isalnum (s)</strong>
</dt>
<dd>
does s only contain alphanumeric characters?
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
a string
</li>
</ul>
</dd>
<dt>
<a name = "isspace"></a>
<strong>isspace (s)</strong>
</dt>
<dd>
does s only contain whitespace?
Matches on pattern '%s' so matches space, newline, tabs, etc.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
a string
</li>
</ul>
</dd>
<dt>
<a name = "islower"></a>
<strong>islower (s)</strong>
</dt>
<dd>
does s only contain lower case characters?
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
a string
</li>
</ul>
</dd>
<dt>
<a name = "isupper"></a>
<strong>isupper (s)</strong>
</dt>
<dd>
does s only contain upper case characters?
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
a string
</li>
</ul>
</dd>
<dt>
<a name = "startswith"></a>
<strong>startswith (s, prefix)</strong>
</dt>
<dd>
does s start with prefix or one of prefixes?
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
a string
</li>
<li><span class="parameter">prefix</span>
a string or an array of strings
</li>
</ul>
</dd>
<dt>
<a name = "endswith"></a>
<strong>endswith (s, suffix)</strong>
</dt>
<dd>
does s end with suffix or one of suffixes?
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
a string
</li>
<li><span class="parameter">suffix</span>
a string or an array of strings
</li>
</ul>
</dd>
</dl>
<h2 class="section-header "><a name="Strings_and_Lists"></a>Strings and Lists </h2>
<dl class="function">
<dt>
<a name = "join"></a>
<strong>join (s, seq)</strong>
</dt>
<dd>
concatenate the strings using this string as a delimiter.
Note that the arguments are reversed from <code>string.concat</code>.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the string
</li>
<li><span class="parameter">seq</span>
a table of strings or numbers
</li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">stringx.<span class="function-name">join</span>(<span class="string">' '</span>, {<span class="number">1</span>,<span class="number">2</span>,<span class="number">3</span>}) == <span class="string">'1 2 3'</span></pre>
</ul>
</dd>
<dt>
<a name = "splitlines"></a>
<strong>splitlines (s[, keep_ends])</strong>
</dt>
<dd>
Split a string into a list of lines.
<code>"\r"</code>, <code>"\n"</code>, and <code>"\r\n"</code> are considered line ends.
They are not included in the lines unless <code>keepends</code> is passed.
Terminal line end does not produce an extra line.
Splitting an empty string results in an empty list.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the string.
</li>
<li><span class="parameter">keep_ends</span>
<span class="types"><span class="type">boolean</span></span>
include line ends.
(<em>optional</em>)
</li>
</ul>
<h3>Returns:</h3>
<ol>
List of lines
</ol>
</dd>
<dt>
<a name = "split"></a>
<strong>split (s[, re[, n]])</strong>
</dt>
<dd>
split a string into a list of strings using a delimiter.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the string
</li>
<li><span class="parameter">re</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
a delimiter (defaults to whitespace)
(<em>optional</em>)
</li>
<li><span class="parameter">n</span>
<span class="types"><span class="type">integer</span></span>
maximum number of results
(<em>optional</em>)
</li>
</ul>
<h3>Returns:</h3>
<ol>
List
</ol>
<h3>Usage:</h3>
<ul>
<li><pre class="example">#(stringx.<span class="function-name">split</span>(<span class="string">'one two'</span>)) == <span class="number">2</span></pre></li>
<li><pre class="example">stringx.<span class="function-name">split</span>(<span class="string">'one,two,three'</span>, <span class="string">','</span>) == <span class="function-name">List</span>{<span class="string">'one'</span>,<span class="string">'two'</span>,<span class="string">'three'</span>}</pre></li>
<li><pre class="example">stringx.<span class="function-name">split</span>(<span class="string">'one,two,three'</span>, <span class="string">','</span>, <span class="number">2</span>) == <span class="function-name">List</span>{<span class="string">'one'</span>,<span class="string">'two,three'</span>}</pre></li>
</ul>
</dd>
<dt>
<a name = "expandtabs"></a>
<strong>expandtabs (s, tabsize)</strong>
</dt>
<dd>
replace all tabs in s with tabsize spaces. If not specified, tabsize defaults to 8.
Tab stops will be honored.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the string
</li>
<li><span class="parameter">tabsize</span>
<span class="types"><span class="type">integer</span></span>
[opt=8] number of spaces to expand each tab
</li>
</ul>
<h3>Returns:</h3>
<ol>
expanded string
</ol>
<h3>Usage:</h3>
<ul>
<li><pre class="example">stringx.<span class="function-name">expandtabs</span>(<span class="string">'\tone,two,three'</span>, <span class="number">4</span>) == <span class="string">' one,two,three'</span></pre></li>
<li><pre class="example">stringx.<span class="function-name">expandtabs</span>(<span class="string">' \tone,two,three'</span>, <span class="number">4</span>) == <span class="string">' one,two,three'</span></pre></li>
</ul>
</dd>
</dl>
<h2 class="section-header "><a name="Finding_and_Replacing"></a>Finding and Replacing </h2>
<dl class="function">
<dt>
<a name = "lfind"></a>
<strong>lfind (s, sub[, first[, last]])</strong>
</dt>
<dd>
find index of first instance of sub in s from the left.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the string
</li>
<li><span class="parameter">sub</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
substring
</li>
<li><span class="parameter">first</span>
<span class="types"><span class="type">integer</span></span>
first index
(<em>optional</em>)
</li>
<li><span class="parameter">last</span>
<span class="types"><span class="type">integer</span></span>
last index
(<em>optional</em>)
</li>
</ul>
<h3>Returns:</h3>
<ol>
start index, or nil if not found
</ol>
</dd>
<dt>
<a name = "rfind"></a>
<strong>rfind (s, sub[, first[, last]])</strong>
</dt>
<dd>
find index of first instance of sub in s from the right.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the string
</li>
<li><span class="parameter">sub</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
substring
</li>
<li><span class="parameter">first</span>
<span class="types"><span class="type">integer</span></span>
first index
(<em>optional</em>)
</li>
<li><span class="parameter">last</span>
<span class="types"><span class="type">integer</span></span>
last index
(<em>optional</em>)
</li>
</ul>
<h3>Returns:</h3>
<ol>
start index, or nil if not found
</ol>
</dd>
<dt>
<a name = "replace"></a>
<strong>replace (s, old, new[, n])</strong>
</dt>
<dd>
replace up to n instances of old by new in the string s.
If n is not present, replace all instances.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the string
</li>
<li><span class="parameter">old</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the target substring
</li>
<li><span class="parameter">new</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the substitution
</li>
<li><span class="parameter">n</span>
<span class="types"><span class="type">integer</span></span>
optional maximum number of substitutions
(<em>optional</em>)
</li>
</ul>
<h3>Returns:</h3>
<ol>
result string
</ol>
</dd>
<dt>
<a name = "count"></a>
<strong>count (s, sub[, allow_overlap])</strong>
</dt>
<dd>
count all instances of substring in string.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the string
</li>
<li><span class="parameter">sub</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
substring
</li>
<li><span class="parameter">allow_overlap</span>
<span class="types"><span class="type">boolean</span></span>
allow matches to overlap
(<em>optional</em>)
</li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example"><span class="global">assert</span>(stringx.<span class="function-name">count</span>(<span class="string">'banana'</span>, <span class="string">'ana'</span>) == <span class="number">1</span>)
<span class="global">assert</span>(stringx.<span class="function-name">count</span>(<span class="string">'banana'</span>, <span class="string">'ana'</span>, <span class="keyword">true</span>) == <span class="number">2</span>)</pre>
</ul>
</dd>
</dl>
<h2 class="section-header "><a name="Stripping_and_Justifying"></a>Stripping and Justifying </h2>
<dl class="function">
<dt>
<a name = "ljust"></a>
<strong>ljust (s, w[, ch=' '])</strong>
</dt>
<dd>
left-justify s with width w.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the string
</li>
<li><span class="parameter">w</span>
<span class="types"><span class="type">integer</span></span>
width of justification
</li>
<li><span class="parameter">ch</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
padding character
(<em>default</em> ' ')
</li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">stringx.<span class="function-name">ljust</span>(<span class="string">'hello'</span>, <span class="number">10</span>, <span class="string">'*'</span>) == <span class="string">'*****hello'</span></pre>
</ul>
</dd>
<dt>
<a name = "rjust"></a>
<strong>rjust (s, w[, ch=' '])</strong>
</dt>
<dd>
right-justify s with width w.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the string
</li>
<li><span class="parameter">w</span>
<span class="types"><span class="type">integer</span></span>
width of justification
</li>
<li><span class="parameter">ch</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
padding character
(<em>default</em> ' ')
</li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">stringx.<span class="function-name">rjust</span>(<span class="string">'hello'</span>, <span class="number">10</span>, <span class="string">'*'</span>) == <span class="string">'hello*****'</span></pre>
</ul>
</dd>
<dt>
<a name = "center"></a>
<strong>center (s, w[, ch=' '])</strong>
</dt>
<dd>
center-justify s with width w.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the string
</li>
<li><span class="parameter">w</span>
<span class="types"><span class="type">integer</span></span>
width of justification
</li>
<li><span class="parameter">ch</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
padding character
(<em>default</em> ' ')
</li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">stringx.<span class="function-name">center</span>(<span class="string">'hello'</span>, <span class="number">10</span>, <span class="string">'*'</span>) == <span class="string">'**hello***'</span></pre>
</ul>
</dd>
<dt>
<a name = "lstrip"></a>
<strong>lstrip (s[, chrs='%s'])</strong>
</dt>
<dd>
trim any characters on the left of s.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the string
</li>
<li><span class="parameter">chrs</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
default any whitespace character,
but can be a string of characters to be trimmed
(<em>default</em> '%s')
</li>
</ul>
</dd>
<dt>
<a name = "rstrip"></a>
<strong>rstrip (s[, chrs='%s'])</strong>
</dt>
<dd>
trim any characters on the right of s.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the string
</li>
<li><span class="parameter">chrs</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
default any whitespace character,
but can be a string of characters to be trimmed
(<em>default</em> '%s')
</li>
</ul>
</dd>
<dt>
<a name = "strip"></a>
<strong>strip (s[, chrs='%s'])</strong>
</dt>
<dd>
trim any characters on both left and right of s.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the string
</li>
<li><span class="parameter">chrs</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
default any whitespace character,
but can be a string of characters to be trimmed
(<em>default</em> '%s')
</li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">stringx.<span class="function-name">strip</span>(<span class="string">' --== Hello ==-- '</span>, <span class="string">"- ="</span>) <span class="comment">--> 'Hello'</span></pre>
</ul>
</dd>
</dl>
<h2 class="section-header "><a name="Partitioning_Strings"></a>Partitioning Strings </h2>
<dl class="function">
<dt>
<a name = "splitv"></a>
<strong>splitv (s[, re='%s'])</strong>
</dt>
<dd>
split a string using a pattern. Note that at least one value will be returned!
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the string
</li>
<li><span class="parameter">re</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
a Lua string pattern (defaults to whitespace)
(<em>default</em> '%s')
</li>
</ul>
<h3>Returns:</h3>
<ol>
the parts of the string
</ol>
<h3>See also:</h3>
<ul>
<a href="../libraries/pl.utils.html#splitv">utils.splitv</a>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">a,b = line:<span class="function-name">splitv</span>(<span class="string">'='</span>)</pre>
</ul>
</dd>
<dt>
<a name = "partition"></a>
<strong>partition (s, ch)</strong>
</dt>
<dd>
partition the string using first occurrence of a delimiter
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the string
</li>
<li><span class="parameter">ch</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
delimiter (match as plain string, no patterns)
</li>
</ul>
<h3>Returns:</h3>
<ol>
<li>
part before ch</li>
<li>
ch</li>
<li>
part after ch</li>
</ol>
<h3>Usage:</h3>
<ul>
<li><pre class="example">{stringx.<span class="function-name">partition</span>(<span class="string">'a,b,c'</span>, <span class="string">','</span>))} == {<span class="string">'a'</span>, <span class="string">','</span>, <span class="string">'b,c'</span>}</pre></li>
<li><pre class="example">{stringx.<span class="function-name">partition</span>(<span class="string">'abc'</span>, <span class="string">'x'</span>))} == {<span class="string">'abc'</span>, <span class="string">''</span>, <span class="string">''</span>}</pre></li>
</ul>
</dd>
<dt>
<a name = "rpartition"></a>
<strong>rpartition (s, ch)</strong>
</dt>
<dd>
partition the string p using last occurrence of a delimiter
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the string
</li>
<li><span class="parameter">ch</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
delimiter (match as plain string, no patterns)
</li>
</ul>
<h3>Returns:</h3>
<ol>
<li>
part before ch</li>
<li>
ch</li>
<li>
part after ch</li>
</ol>
<h3>Usage:</h3>
<ul>
<li><pre class="example">{stringx.<span class="function-name">rpartition</span>(<span class="string">'a,b,c'</span>, <span class="string">','</span>))} == {<span class="string">'a,b'</span>, <span class="string">','</span>, <span class="string">'c'</span>}</pre></li>
<li><pre class="example">{stringx.<span class="function-name">rpartition</span>(<span class="string">'abc'</span>, <span class="string">'x'</span>))} == {<span class="string">''</span>, <span class="string">''</span>, <span class="string">'abc'</span>}</pre></li>
</ul>
</dd>
<dt>
<a name = "at"></a>
<strong>at (s, idx)</strong>
</dt>
<dd>
return the 'character' at the index.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the string
</li>
<li><span class="parameter">idx</span>
<span class="types"><span class="type">integer</span></span>
an index (can be negative)
</li>
</ul>
<h3>Returns:</h3>
<ol>
a substring of length 1 if successful, empty string otherwise.
</ol>
</dd>
</dl>
<h2 class="section-header "><a name="Text_handling"></a>Text handling </h2>
<dl class="function">
<dt>
<a name = "indent"></a>
<strong>indent (s, n[, ch=' '])</strong>
</dt>
<dd>
indent a multiline string.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the (multiline) string
</li>
<li><span class="parameter">n</span>
<span class="types"><span class="type">integer</span></span>
the size of the indent
</li>
<li><span class="parameter">ch</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the character to use when indenting
(<em>default</em> ' ')
</li>
</ul>
<h3>Returns:</h3>
<ol>
indented string
</ol>
</dd>
<dt>
<a name = "dedent"></a>
<strong>dedent (s)</strong>
</dt>
<dd>
dedent a multiline string by removing any initial indent.
useful when working with [[..]] strings.
Empty lines are ignored.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the (multiline) string
</li>
</ul>
<h3>Returns:</h3>
<ol>
a string with initial indent zero.
</ol>
<h3>Usage:</h3>
<ul>
<pre class="example"><span class="keyword">local</span> s = <span class="function-name">dedent</span> <span class="string">[[
One
Two
Three
]]</span>
<span class="global">assert</span>(s == <span class="string">[[
One
Two
Three
]]</span>)</pre>
</ul>
</dd>
<dt>
<a name = "wrap"></a>
<strong>wrap (s[, width=70[, breaklong=false]])</strong>
</dt>
<dd>
format a paragraph into lines so that they fit into a line width.
It will not break long words by default, so lines can be over the length
to that extent.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the string to format
</li>
<li><span class="parameter">width</span>
<span class="types"><span class="type">integer</span></span>
the margin width
(<em>default</em> 70)
</li>
<li><span class="parameter">breaklong</span>
<span class="types"><span class="type">boolean</span></span>
if truthy, words longer than the width given will be forced split.
(<em>default</em> false)
</li>
</ul>
<h3>Returns:</h3>
<ol>
a list of lines (List object), use <a href="../libraries/pl.stringx.html#fill">fill</a> to return a string instead of a <a href="../classes/pl.List.html">List</a>.
</ol>
<h3>See also:</h3>
<ul>
<li><a href="../classes/pl.List.html#">pl.List</a></li>
<li><a href="../libraries/pl.stringx.html#fill">fill</a></li>
</ul>
</dd>
<dt>
<a name = "fill"></a>
<strong>fill (s[, width=70[, breaklong=false]])</strong>
</dt>
<dd>
format a paragraph so that it fits into a line width.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the string to format
</li>
<li><span class="parameter">width</span>
<span class="types"><span class="type">integer</span></span>
the margin width
(<em>default</em> 70)
</li>
<li><span class="parameter">breaklong</span>
<span class="types"><span class="type">boolean</span></span>
if truthy, words longer than the width given will be forced split.
(<em>default</em> false)
</li>
</ul>
<h3>Returns:</h3>
<ol>
a string, use <a href="../libraries/pl.stringx.html#wrap">wrap</a> to return a list of lines instead of a string.
</ol>
<h3>See also:</h3>
<ul>
<a href="../libraries/pl.stringx.html#wrap">wrap</a>
</ul>
</dd>
</dl>
<h2 class="section-header "><a name="Template"></a>Template </h2>
<dl class="function">
<dt>
<a name = "Template"></a>
<strong>Template (tmpl)</strong>
</dt>
<dd>
Creates a new Template class.
This is a shortcut to <code>Template.new(tmpl)</code>.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">tmpl</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the template string
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../libraries/pl.stringx.html#Template">Template</a></span>
</ol>
</dd>
<dt>
<a name = "Template:substitute"></a>
<strong>Template:substitute (tbl)</strong>
</dt>
<dd>
substitute values into a template, throwing an error.
This will throw an error if no name is found.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">tbl</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.6">table</a></span>
a table of name-value pairs.
</li>
</ul>
<h3>Returns:</h3>
<ol>
string with place holders substituted
</ol>
</dd>
<dt>
<a name = "Template:safe_substitute"></a>
<strong>Template:safe_substitute (tbl)</strong>
</dt>
<dd>
substitute values into a template.
This version just passes unknown names through.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">tbl</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.6">table</a></span>
a table of name-value pairs.
</li>
</ul>
<h3>Returns:</h3>
<ol>
string with place holders substituted
</ol>
</dd>
<dt>
<a name = "Template:indent_substitute"></a>
<strong>Template:indent_substitute (tbl)</strong>
</dt>
<dd>
substitute values into a template, preserving indentation. <br>
If the value is a multiline string <em>or</em> a template, it will insert
the lines at the correct indentation. <br>
Furthermore, if a template, then that template will be substituted
using the same table.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">tbl</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.6">table</a></span>
a table of name-value pairs.
</li>
</ul>
<h3>Returns:</h3>
<ol>
string with place holders substituted
</ol>
</dd>
</dl>
<h2 class="section-header "><a name="Miscellaneous"></a>Miscellaneous </h2>
<dl class="function">
<dt>
<a name = "lines"></a>
<strong>lines (s)</strong>
</dt>
<dd>
return an iterator over all lines in a string
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the string
</li>
</ul>
<h3>Returns:</h3>
<ol>
an iterator
</ol>
<h3>Usage:</h3>
<ul>
<pre class="example"><span class="keyword">local</span> line_no = <span class="number">1</span>
<span class="keyword">for</span> line <span class="keyword">in</span> stringx.<span class="function-name">lines</span>(some_text) <span class="keyword">do</span>
<span class="global">print</span>(line_no, line)
line_no = line_no + <span class="number">1</span>
<span class="keyword">end</span></pre>
</ul>
</dd>
<dt>
<a name = "title"></a>
<strong>title (s)</strong>
</dt>
<dd>
initial word letters uppercase ('title case').
Here 'words' mean chunks of non-space characters.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the string
</li>
</ul>
<h3>Returns:</h3>
<ol>
a string with each word's first letter uppercase
</ol>
<h3>Usage:</h3>
<ul>
<pre class="example">stringx.<span class="function-name">title</span>(<span class="string">"hello world"</span>) == <span class="string">"Hello World"</span>)</pre>
</ul>
</dd>
<dt>
<a name = "shorten"></a>
<strong>shorten (s, w, tail)</strong>
</dt>
<dd>
Return a shortened version of a string.
Fits string within w characters. Removed characters are marked with ellipsis.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
the string
</li>
<li><span class="parameter">w</span>
<span class="types"><span class="type">integer</span></span>
the maximum size allowed
</li>
<li><span class="parameter">tail</span>
<span class="types"><span class="type">boolean</span></span>
true if we want to show the end of the string (head otherwise)
</li>
</ul>
<h3>Usage:</h3>
<ul>
<li><pre class="example">(<span class="string">'1234567890'</span>):<span class="function-name">shorten</span>(<span class="number">8</span>) == <span class="string">'12345...'</span></pre></li>
<li><pre class="example">(<span class="string">'1234567890'</span>):<span class="function-name">shorten</span>(<span class="number">8</span>, <span class="keyword">true</span>) == <span class="string">'...67890'</span></pre></li>
<li><pre class="example">(<span class="string">'1234567890'</span>):<span class="function-name">shorten</span>(<span class="number">20</span>) == <span class="string">'1234567890'</span></pre></li>
</ul>
</dd>
<dt>
<a name = "quote_string"></a>
<strong>quote_string (s)</strong>
</dt>
<dd>
Quote the given string and preserve any control or escape characters, such that reloading the string in Lua returns the same result.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
The string to be quoted.
</li>
</ul>
<h3>Returns:</h3>
<ol>
The quoted string.
</ol>
</dd>
<dt>
<a name = "format_operator"></a>
<strong>format_operator ()</strong>
</dt>
<dd>
Python-style formatting operator.
Calling <code>text.format_operator()</code> overloads the % operator for strings to give
Python/Ruby style formatted output.
This is extended to also do template-like substitution for map-like data.</p>
<p> Note this goes further than the original, and will allow these cases:</p>
<ol>
<li>a single value</li>
<li>a list of values</li>
<li>a map of var=value pairs</li>
<li>a function, as in gsub</li>
</ol>
<p> For the second two cases, it uses $-variable substitution.</p>
<p> When called, this function will monkey-patch the global <a href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a> metatable by
adding a <code>__mod</code> method.</p>
<p> See <a href="http://lua-users.org/wiki/StringInterpolation">the lua-users wiki</a>
<h3>Usage:</h3>
<ul>
<pre class="example"><span class="global">require</span> <span class="string">'pl.text'</span>.<span class="function-name">format_operator</span>()
<span class="keyword">local</span> out1 = <span class="string">'%s = %5.3f'</span> % {<span class="string">'PI'</span>,<span class="global">math</span>.pi} <span class="comment">--> 'PI = 3.142'
</span><span class="keyword">local</span> out2 = <span class="string">'$name = $value'</span> % {name=<span class="string">'dog'</span>,value=<span class="string">'Pluto'</span>} <span class="comment">--> 'dog = Pluto'</span></pre>
</ul>
</dd>
<dt>
<a name = "import"></a>
<strong>import ()</strong>
</dt>
<dd>
import the stringx functions into the global string (meta)table
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
|
