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
|
<!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="#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="#Partioning_Strings">Partioning Strings </a></li>
<li><a href="#Miscelaneous">Miscelaneous </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.1/manual.html#5.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></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 spaces?</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 whitespace 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 whitespace 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 whitespace on both left and right of s.</td>
</tr>
</table>
<h2><a href="#Partioning_Strings">Partioning 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 occurance 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 occurance 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="#Miscelaneous">Miscelaneous </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">inital 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>
</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.1/manual.html#5.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.1/manual.html#5.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.1/manual.html#5.4">string</a></span>
a string
</li>
</ul>
</dd>
<dt>
<a name = "isspace"></a>
<strong>isspace (s)</strong>
</dt>
<dd>
does s only contain spaces?
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">s</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.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.1/manual.html#5.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.1/manual.html#5.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.1/manual.html#5.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.1/manual.html#5.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.1/manual.html#5.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.join(<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.1/manual.html#5.4">string</a></span>
the string.
</li>
<li><span class="parameter">keep_ends</span>
<span class="types"><span class="type">bool</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.1/manual.html#5.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.1/manual.html#5.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">int</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.split(<span class="string">'one two'</span>)) == <span class="number">2</span></pre></li>
<li><pre class="example">stringx.split(<span class="string">'one,two,three'</span>, <span class="string">','</span>) == List{<span class="string">'one'</span>,<span class="string">'two'</span>,<span class="string">'three'</span>}</pre></li>
<li><pre class="example">stringx.split(<span class="string">'one,two,three'</span>, <span class="string">','</span>, <span class="number">2</span>) == List{<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.1/manual.html#5.4">string</a></span>
the string
</li>
<li><span class="parameter">tabsize</span>
<span class="types"><span class="type">int</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.expandtabs(<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.expandtabs(<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.1/manual.html#5.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.1/manual.html#5.4">string</a></span>
substring
</li>
<li><span class="parameter">first</span>
<span class="types"><span class="type">int</span></span>
first index
(<em>optional</em>)
</li>
<li><span class="parameter">last</span>
<span class="types"><span class="type">int</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.1/manual.html#5.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.1/manual.html#5.4">string</a></span>
substring
</li>
<li><span class="parameter">first</span>
<span class="types"><span class="type">int</span></span>
first index
(<em>optional</em>)
</li>
<li><span class="parameter">last</span>
<span class="types"><span class="type">int</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.1/manual.html#5.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.1/manual.html#5.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.1/manual.html#5.4">string</a></span>
the substitution
</li>
<li><span class="parameter">n</span>
<span class="types"><span class="type">int</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.1/manual.html#5.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.1/manual.html#5.4">string</a></span>
substring
</li>
<li><span class="parameter">allow_overlap</span>
<span class="types"><span class="type">bool</span></span>
allow matches to overlap
(<em>optional</em>)
</li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example"><span class="global">assert</span>(stringx.count(<span class="string">'banana'</span>, <span class="string">'ana'</span>) == <span class="number">1</span>)
<span class="global">assert</span>(stringx.count(<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.1/manual.html#5.4">string</a></span>
the string
</li>
<li><span class="parameter">w</span>
<span class="types"><span class="type">int</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.1/manual.html#5.4">string</a></span>
padding character
(<em>default</em> ' ')
</li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">stringx.ljust(<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.1/manual.html#5.4">string</a></span>
the string
</li>
<li><span class="parameter">w</span>
<span class="types"><span class="type">int</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.1/manual.html#5.4">string</a></span>
padding character
(<em>default</em> ' ')
</li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">stringx.rjust(<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.1/manual.html#5.4">string</a></span>
the string
</li>
<li><span class="parameter">w</span>
<span class="types"><span class="type">int</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.1/manual.html#5.4">string</a></span>
padding character
(<em>default</em> ' ')
</li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">stringx.center(<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 whitespace 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.1/manual.html#5.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.1/manual.html#5.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 whitespace 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.1/manual.html#5.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.1/manual.html#5.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 whitespace 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.1/manual.html#5.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.1/manual.html#5.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>
</dl>
<h2 class="section-header "><a name="Partioning_Strings"></a>Partioning 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.1/manual.html#5.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.1/manual.html#5.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:splitv(<span class="string">'='</span>)</pre>
</ul>
</dd>
<dt>
<a name = "partition"></a>
<strong>partition (s, ch)</strong>
</dt>
<dd>
partition the string using first occurance 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.1/manual.html#5.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.1/manual.html#5.4">string</a></span>
delimiter
</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.partition(<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.partition(<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 occurance 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.1/manual.html#5.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.1/manual.html#5.4">string</a></span>
delimiter
</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.rpartition(<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.rpartition(<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.1/manual.html#5.4">string</a></span>
the string
</li>
<li><span class="parameter">idx</span>
<span class="types"><span class="type">int</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="Miscelaneous"></a>Miscelaneous </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.1/manual.html#5.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.lines(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>
inital 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.1/manual.html#5.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.title(<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.1/manual.html#5.4">string</a></span>
the string
</li>
<li><span class="parameter">w</span>
<span class="types"><span class="type">int</span></span>
the maxinum size allowed
</li>
<li><span class="parameter">tail</span>
<span class="types"><span class="type">bool</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>):shorten(<span class="number">8</span>) == <span class="string">'12345...'</span></pre></li>
<li><pre class="example">(<span class="string">'1234567890'</span>):shorten(<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>):shorten(<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>
</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>
<i style="float:right;">Last updated 2020-09-24 12:27:36 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
|
