-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathsimple_parseopt.html
More file actions
1324 lines (1081 loc) · 69.2 KB
/
simple_parseopt.html
File metadata and controls
1324 lines (1081 loc) · 69.2 KB
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
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- This file is generated by Nim. -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- Favicon -->
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
<!-- Google fonts -->
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
<!-- CSS -->
<title>simple_parseopt</title>
<style type="text/css" >
/*
Stylesheet for use with Docutils/rst2html.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
Modified from Chad Skeeters' rst2html-style
https://bitbucket.org/cskeeters/rst2html-style/
Modified by Boyd Greenfield and narimiran
*/
html {
font-size: 100%;
-webkit-text-size-adjust: 100%;
-ms-text-size-adjust: 100%; }
body {
font-family: "Lato", "Helvetica Neue", "HelveticaNeue", Helvetica, Arial, sans-serif;
font-weight: 400;
font-size: 1.125em;
line-height: 1.5;
color: #222;
background-color: #FCFCFC; }
/* Skeleton grid */
.container {
position: relative;
width: 100%;
max-width: 1050px;
margin: 0 auto;
padding: 0;
box-sizing: border-box; }
.column,
.columns {
width: 100%;
float: left;
box-sizing: border-box;
margin-left: 1%;
}
.column:first-child,
.columns:first-child {
margin-left: 0; }
.three.columns {
width: 19%; }
.nine.columns {
width: 80.0%; }
.twelve.columns {
width: 100%;
margin-left: 0; }
@media screen and (max-width: 860px) {
.three.columns {
display: none;
}
.nine.columns {
width: 98.0%;
}
body {
font-size: 1em;
line-height: 1.35;
}
}
cite {
font-style: italic !important; }
/* Nim search input */
div#searchInputDiv {
margin-bottom: 1em;
}
input#searchInput {
width: 80%;
}
/*
* Some custom formatting for input forms.
* This also fixes input form colors on Firefox with a dark system theme on Linux.
*/
input {
-moz-appearance: none;
color: #333;
background-color: #f8f8f8;
border: 1px solid #aaa;
font-family: "Lato", "Helvetica Neue", "HelveticaNeue", Helvetica, Arial, sans-serif;
font-size: 0.9em;
padding: 6px;
}
input:focus {
border: 1px solid #1fa0eb;
box-shadow: 0 0 2px #1fa0eb;
}
/* Docgen styles */
/* Links */
a {
color: #07b;
text-decoration: none;
}
a span.Identifier {
text-decoration: underline;
text-decoration-color: #aab;
}
a.reference-toplevel {
font-weight: bold;
}
a.toc-backref {
text-decoration: none;
color: #222; }
a.link-seesrc {
color: #607c9f;
font-size: 0.9em;
font-style: italic; }
a:hover,
a:focus {
color: #607c9f;
text-decoration: underline; }
a:hover span.Identifier {
color: #607c9f;
}
sub,
sup {
position: relative;
font-size: 75%;
line-height: 0;
vertical-align: baseline; }
sup {
top: -0.5em; }
sub {
bottom: -0.25em; }
img {
width: auto;
height: auto;
max-width: 100%;
vertical-align: middle;
border: 0;
-ms-interpolation-mode: bicubic; }
@media print {
* {
color: black !important;
text-shadow: none !important;
background: transparent !important;
box-shadow: none !important; }
a,
a:visited {
text-decoration: underline; }
a[href]:after {
content: " (" attr(href) ")"; }
abbr[title]:after {
content: " (" attr(title) ")"; }
.ir a:after,
a[href^="javascript:"]:after,
a[href^="#"]:after {
content: ""; }
pre,
blockquote {
border: 1px solid #999;
page-break-inside: avoid; }
thead {
display: table-header-group; }
tr,
img {
page-break-inside: avoid; }
img {
max-width: 100% !important; }
@page {
margin: 0.5cm; }
h1 {
page-break-before: always; }
h1.title {
page-break-before: avoid; }
p,
h2,
h3 {
orphans: 3;
widows: 3; }
h2,
h3 {
page-break-after: avoid; }
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
small {
font-size: 85%; }
strong {
font-weight: 600;
font-size: 0.95em;
color: #3c3c3c;
}
em {
font-style: italic; }
h1 {
font-size: 1.8em;
font-weight: 400;
padding-bottom: .25em;
border-bottom: 1px solid #aaa;
margin-top: 2.5em;
margin-bottom: 1em;
line-height: 1.2em; }
h1.title {
padding-bottom: 1em;
border-bottom: 0px;
font-size: 2.5em;
text-align: center;
font-weight: 900;
margin-top: 0.75em;
margin-bottom: 0em;
}
h2 {
font-size: 1.3em;
margin-top: 2em; }
h2.subtitle {
text-align: center; }
h3 {
font-size: 1.125em;
font-style: italic;
margin-top: 1.5em; }
h4 {
font-size: 1.125em;
margin-top: 1em; }
h5 {
font-size: 1.125em;
margin-top: 0.75em; }
h6 {
font-size: 1.1em; }
ul,
ol {
padding: 0;
margin-top: 0.5em;
margin-left: 0.75em; }
ul ul,
ul ol,
ol ol,
ol ul {
margin-bottom: 0;
margin-left: 1.25em; }
li {
list-style-type: circle;
}
ul.simple-boot li {
list-style-type: none;
margin-left: 0em;
margin-bottom: 0.5em;
}
ol.simple > li, ul.simple > li {
margin-bottom: 0.25em;
margin-left: 0.4em }
ul.simple.simple-toc > li {
margin-top: 1em;
}
ul.simple-toc {
list-style: none;
font-size: 0.9em;
margin-left: -0.3em;
margin-top: 1em; }
ul.simple-toc > li {
list-style-type: none;
}
ul.simple-toc-section {
list-style-type: circle;
margin-left: 1em;
color: #6c9aae; }
ol.arabic {
list-style: decimal; }
ol.loweralpha {
list-style: lower-alpha; }
ol.upperalpha {
list-style: upper-alpha; }
ol.lowerroman {
list-style: lower-roman; }
ol.upperroman {
list-style: upper-roman; }
ul.auto-toc {
list-style-type: none; }
dl {
margin-bottom: 1.5em; }
dt {
margin-bottom: -0.5em;
margin-left: 0.0em; }
dd {
margin-left: 2.0em;
margin-bottom: 3.0em;
margin-top: 0.5em; }
hr {
margin: 2em 0;
border: 0;
border-top: 1px solid #aaa; }
blockquote {
font-size: 0.9em;
font-style: italic;
padding-left: 0.5em;
margin-left: 0;
border-left: 5px solid #bbc;
}
.pre {
font-family: "Source Code Pro", Monaco, Menlo, Consolas, "Courier New", monospace;
font-weight: 500;
font-size: 0.85em;
background-color: #f0f3ff;
padding-left: 3px;
padding-right: 3px;
border-radius: 4px;
}
pre {
font-family: "Source Code Pro", Monaco, Menlo, Consolas, "Courier New", monospace;
color: #222;
font-weight: 500;
display: inline-block;
box-sizing: border-box;
min-width: 100%;
padding: 0.5em;
margin-top: 0.5em;
margin-bottom: 0.5em;
font-size: 0.85em;
white-space: pre !important;
overflow-y: hidden;
overflow-x: visible;
background-color: ghostwhite;
border: 1px solid #dde;
-webkit-border-radius: 6px;
-moz-border-radius: 6px;
border-radius: 6px; }
.pre-scrollable {
max-height: 340px;
overflow-y: scroll; }
/* Nim line-numbered tables */
.line-nums-table {
width: 100%;
table-layout: fixed; }
table.line-nums-table {
border-radius: 4px;
border: 1px solid #cccccc;
background-color: ghostwhite;
border-collapse: separate;
margin-top: 15px;
margin-bottom: 25px; }
.line-nums-table tbody {
border: none; }
.line-nums-table td pre {
border: none;
background-color: transparent; }
.line-nums-table td.blob-line-nums {
width: 28px; }
.line-nums-table td.blob-line-nums pre {
color: #b0b0b0;
-webkit-filter: opacity(75%);
text-align: right;
border-color: transparent;
background-color: transparent;
padding-left: 0px;
margin-left: 0px;
padding-right: 0px;
margin-right: 0px; }
table {
max-width: 100%;
background-color: transparent;
margin-top: 0.5em;
margin-bottom: 1.5em;
border-collapse: collapse;
border-color: #ccc;
border-spacing: 0;
font-size: 0.9em;
}
table th, table td {
padding: 0px 0.5em 0px;
}
table th {
background-color: #e8e8e8;
font-weight: bold; }
table th.docinfo-name {
background-color: transparent;
}
table tr:hover {
background-color: ghostwhite; }
/* rst2html default used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
border: 0; }
table.borderless td, table.borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding: 0 0.5em 0 0 !important; }
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 !important; }
.last, .with-subtitle {
margin-bottom: 0 !important; }
.hidden {
display: none; }
blockquote.epigraph {
margin: 2em 5em; }
dl.docutils dd {
margin-bottom: 0.5em; }
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
overflow: hidden; }
div.figure {
margin-left: 2em;
margin-right: 2em; }
div.footer, div.header {
clear: both;
text-align: center;
color: #666;
font-size: smaller; }
div.footer {
padding-top: 5em;
}
div.line-block {
display: block;
margin-top: 1em;
margin-bottom: 1em; }
div.line-block div.line-block {
margin-top: 0;
margin-bottom: 0;
margin-left: 1.5em; }
div.topic {
margin: 2em; }
div.search_results {
background-color: antiquewhite;
margin: 3em;
padding: 1em;
border: 1px solid #4d4d4d;
}
div#global-links ul {
margin-left: 0;
list-style-type: none;
}
div#global-links > simple-boot {
margin-left: 3em;
}
hr.docutils {
width: 75%; }
img.align-left, .figure.align-left, object.align-left {
clear: left;
float: left;
margin-right: 1em; }
img.align-right, .figure.align-right, object.align-right {
clear: right;
float: right;
margin-left: 1em; }
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto; }
.align-left {
text-align: left; }
.align-center {
clear: both;
text-align: center; }
.align-right {
text-align: right; }
/* reset inner alignment in figures */
div.align-right {
text-align: inherit; }
p.attribution {
text-align: right;
margin-left: 50%; }
p.caption {
font-style: italic; }
p.credits {
font-style: italic;
font-size: smaller; }
p.label {
white-space: nowrap; }
p.rubric {
font-weight: bold;
font-size: larger;
color: maroon;
text-align: center; }
p.topic-title {
font-weight: bold; }
pre.address {
margin-bottom: 0;
margin-top: 0;
font: inherit; }
pre.literal-block, pre.doctest-block, pre.math, pre.code {
margin-left: 2em;
margin-right: 2em; }
pre.code .ln {
color: grey; }
/* line numbers */
pre.code, code {
background-color: #eeeeee; }
pre.code .comment, code .comment {
color: #5c6576; }
pre.code .keyword, code .keyword {
color: #3B0D06;
font-weight: bold; }
pre.code .literal.string, code .literal.string {
color: #0c5404; }
pre.code .name.builtin, code .name.builtin {
color: #352b84; }
pre.code .deleted, code .deleted {
background-color: #DEB0A1; }
pre.code .inserted, code .inserted {
background-color: #A3D289; }
span.classifier {
font-style: oblique; }
span.classifier-delimiter {
font-weight: bold; }
span.option {
white-space: nowrap; }
span.problematic {
color: #b30000; }
span.section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size: 80%; }
span.DecNumber {
color: #252dbe; }
span.BinNumber {
color: #252dbe; }
span.HexNumber {
color: #252dbe; }
span.OctNumber {
color: #252dbe; }
span.FloatNumber {
color: #252dbe; }
span.Identifier {
color: #222; }
span.Keyword {
font-weight: 600;
color: #5e8f60; }
span.StringLit {
color: #a4255b; }
span.LongStringLit {
color: #a4255b; }
span.CharLit {
color: #a4255b; }
span.EscapeSequence {
color: black; }
span.Operator {
color: black; }
span.Punctuation {
color: black; }
span.Comment, span.LongComment {
font-style: italic;
font-weight: 400;
color: #484a86; }
span.RegularExpression {
color: darkviolet; }
span.TagStart {
color: darkviolet; }
span.TagEnd {
color: darkviolet; }
span.Key {
color: #252dbe; }
span.Value {
color: #252dbe; }
span.RawData {
color: #a4255b; }
span.Assembler {
color: #252dbe; }
span.Preprocessor {
color: #252dbe; }
span.Directive {
color: #252dbe; }
span.Command, span.Rule, span.Hyperlink, span.Label, span.Reference,
span.Other {
color: black; }
/* Pop type, const, proc, and iterator defs in nim def blocks */
dt pre > span.Identifier, dt pre > span.Operator {
color: #155da4;
font-weight: 700; }
dt pre > span.Keyword ~ span.Identifier, dt pre > span.Identifier ~ span.Identifier,
dt pre > span.Operator ~ span.Identifier, dt pre > span.Other ~ span.Identifier {
color: inherit;
font-weight: inherit; }
/* Nim sprite for the footer (taken from main page favicon) */
.nim-sprite {
display: inline-block;
height: 16px;
width: 16px;
background-position: 0 0;
background-size: 16px 16px;
-webkit-filter: opacity(50%);
background-repeat: no-repeat;
background-image: url("data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA==");
margin-bottom: -5px; }
span.pragmadots {
/* Position: relative frees us up to make the dots
look really nice without fucking up the layout and
causing bulging in the parent container */
position: relative;
/* 1px down looks slightly nicer */
top: 1px;
padding: 2px;
background-color: #e8e8e8;
border-radius: 4px;
margin: 0 2px;
cursor: pointer;
font-size: 0.8em;
}
span.pragmadots:hover {
background-color: #DBDBDB;
}
span.pragmawrap {
display: none;
}
span.attachedType {
display: none;
visibility: hidden;
}
</style>
<script type="text/javascript" src="dochack.js"></script>
<script type="text/javascript">
function main() {
var pragmaDots = document.getElementsByClassName("pragmadots");
for (var i = 0; i < pragmaDots.length; i++) {
pragmaDots[i].onclick = function(event) {
// Hide tease
event.target.parentNode.style.display = "none";
// Show actual
event.target.parentNode.nextElementSibling.style.display = "inline";
}
}
}
</script>
</head>
<body onload="main()">
<div class="document" id="documentId">
<div class="container">
<h1 class="title">simple_parseopt</h1>
<div class="row">
<div class="three columns">
<div id="global-links">
<ul class="simple">
</ul>
</div>
<div id="searchInputDiv">
Search: <input type="text" id="searchInput"
onkeyup="search()" />
</div>
<div>
Group by:
<select onchange="groupBy(this.value)">
<option value="section">Section</option>
<option value="type">Type</option>
</select>
</div>
<ul class="simple simple-toc" id="toc-list">
<ul class="simple"><li><a class="reference" id="basic-use_toc" href="#basic-use">Basic Use</a></li>
<li><a class="reference" id="default-commandminusline-syntax_toc" href="#default-commandminusline-syntax">Default command-line syntax</a></li>
<li><a class="reference" id="extra-parameter-infocolon-pragmas_toc" href="#extra-parameter-infocolon-pragmas">Extra Parameter Info: Pragmas</a></li>
<li><a class="reference" id="settings_toc" href="#settings">Settings</a></li>
</ul><li>
<a class="reference reference-toplevel" href="#12" id="62">Procs</a>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#no_dash"
title="no_dash()"><wbr />no_<wbr />dash<span class="attachedType"></span></a></li>
<li><a class="reference" href="#no_slash"
title="no_slash()"><wbr />no_<wbr />slash<span class="attachedType"></span></a></li>
<li><a class="reference" href="#dash_dash_parameters"
title="dash_dash_parameters()"><wbr />dash_<wbr />dash_<wbr />parameters<span class="attachedType"></span></a></li>
<li><a class="reference" href="#dash_dash_separator"
title="dash_dash_separator()"><wbr />dash_<wbr />dash_<wbr />separator<span class="attachedType"></span></a></li>
<li><a class="reference" href="#value_after_colon"
title="value_after_colon()"><wbr />value_<wbr />after_<wbr />colon<span class="attachedType"></span></a></li>
<li><a class="reference" href="#value_after_equals"
title="value_after_equals()"><wbr />value_<wbr />after_<wbr />equals<span class="attachedType"></span></a></li>
<li><a class="reference" href="#allow_repetition"
title="allow_repetition()"><wbr />allow_<wbr />repetition<span class="attachedType"></span></a></li>
<li><a class="reference" href="#allow_errors"
title="allow_errors()"><wbr />allow_<wbr />errors<span class="attachedType"></span></a></li>
<li><a class="reference" href="#no_implicit_bare"
title="no_implicit_bare()"><wbr />no_<wbr />implicit_<wbr />bare<span class="attachedType"></span></a></li>
<li><a class="reference" href="#can_name_bare"
title="can_name_bare()"><wbr />can_<wbr />name_<wbr />bare<span class="attachedType"></span></a></li>
<li><a class="reference" href="#manual_help"
title="manual_help()"><wbr />manual_<wbr />help<span class="attachedType"></span></a></li>
<li><a class="reference" href="#command_name%2Cstring"
title="command_name(name: string)"><wbr />command_<wbr />name<span class="attachedType"></span></a></li>
<li><a class="reference" href="#help_text%2Cstring%2Cstring"
title="help_text(text, footer = "")"><wbr />help_<wbr />text<span class="attachedType"></span></a></li>
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#17" id="67">Macros</a>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#config.m%2Cuntyped"
title="config(body: untyped): untyped"><wbr />config<span class="attachedType"></span></a></li>
<li><a class="reference" href="#get_options_and_supplied.m%2Cuntyped"
title="get_options_and_supplied(body: untyped): untyped"><wbr />get_<wbr />options_<wbr />and_<wbr />supplied<span class="attachedType"></span></a></li>
<li><a class="reference" href="#get_options.m%2Cuntyped"
title="get_options(body: untyped): untyped"><wbr />get_<wbr />options<span class="attachedType"></span></a></li>
</ul>
</li>
</ul>
</div>
<div class="nine columns" id="content">
<div id="tocRoot"></div>
<p class="module-desc">Nim module which provides clean, zero-effort command line parsing.
<h2><a class="toc-backref" id="basic-use" href="#basic-use">Basic Use</a></h2><p>This module gives you two ways to parse the command line: <tt class="docutils literal"><span class="pre">get_options</span></tt> and <tt class="docutils literal"><span class="pre">get_options_and_supplied</span></tt></p>
<p><strong>get_options</strong></p>
<p>At its simplest, declare a block like this:</p>
<p><pre class="listing"><span class="Comment"># foo.nim</span>
<span class="Keyword">let</span> <span class="Identifier">options</span> <span class="Operator">=</span> <span class="Identifier">get_options</span><span class="Punctuation">:</span>
<span class="Identifier">name</span> <span class="Operator">=</span> <span class="StringLit">"Default Name"</span>
<span class="Identifier">active</span> <span class="Operator">=</span> <span class="Identifier">false</span>
<span class="Identifier">letter_one</span> <span class="Operator">=</span> <span class="CharLit">'a'</span>
<span class="Identifier">age</span> <span class="Operator">=</span> <span class="DecNumber">1</span>
<span class="Identifier">hello</span><span class="Punctuation">:</span><span class="Identifier">string</span>
<span class="Identifier">big</span><span class="Punctuation">:</span><span class="Identifier">float64</span> <span class="Operator">=</span> <span class="FloatNumber">1.1</span>
<span class="Identifier">small</span><span class="Punctuation">:</span><span class="Identifier">float</span> <span class="Operator">=</span> <span class="FloatNumber">2.2</span>
<span class="Identifier">flat</span><span class="Punctuation">:</span><span class="Identifier">uint</span> <span class="Operator">=</span> <span class="DecNumber">2</span>
<span class="Identifier">arguments</span><span class="Punctuation">:</span><span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span>
<span class="Identifier">echo</span> <span class="Identifier">options</span><span class="Operator">.</span><span class="Identifier">name</span> <span class="Operator">&</span> <span class="StringLit">" is "</span> <span class="Operator">&</span> <span class="Identifier">options</span><span class="Operator">.</span><span class="Identifier">age</span><span class="Operator">.</span><span class="Identifier">repr</span> <span class="Operator">&</span> <span class="StringLit">" years old!"</span>
</pre></p>
<p>Notice it follows the same syntax as a <tt class="docutils literal"><span class="pre">var</span></tt> block.</p>
<p>In the example <tt class="docutils literal"><span class="pre">foo.nim</span></tt> above, the variable <tt class="docutils literal"><span class="pre">options</span></tt> will be set to an <tt class="docutils literal"><span class="pre">object</span></tt> with fields as described in the <tt class="docutils literal"><span class="pre">get_options</span></tt> block. Each field will also be set up as a command-line parameter for the user running the program to use; bools will toggle, while other fields will take a value argument.</p>
<p><pre class="listing">
foo -name "J. Random" -active -big 1011121.121498 -letter-one z
</pre></p>
<p>This will set the <tt class="docutils literal"><span class="pre">name</span></tt> <tt class="docutils literal"><span class="pre">string</span></tt> to <tt class="docutils literal"><span class="pre">"J. Random"</span></tt>, toggle the <tt class="docutils literal"><span class="pre">active</span></tt> <tt class="docutils literal"><span class="pre">bool</span></tt> to <tt class="docutils literal"><span class="pre">true</span></tt>, set the <tt class="docutils literal"><span class="pre">big</span></tt> <tt class="docutils literal"><span class="pre">float64</span></tt> to <tt class="docutils literal"><span class="pre">1011121.121498</span></tt>, and set <tt class="docutils literal"><span class="pre">letter_one</span></tt> to <tt class="docutils literal"><span class="pre">z</span></tt> (notice the underscore in the field becomes a hyphen at the command line).</p>
<p>You may use any basic type: <tt class="docutils literal"><span class="pre">bool</span></tt>, <tt class="docutils literal"><span class="pre">string</span></tt>, <tt class="docutils literal"><span class="pre">int</span></tt>, <tt class="docutils literal"><span class="pre">float</span></tt>, <tt class="docutils literal"><span class="pre">uint</span></tt>, <tt class="docutils literal"><span class="pre">char</span></tt>, and the sized variants thereof, as well as <tt class="docutils literal"><span class="pre">seq`s of those types: `seq[string]</span></tt>, <tt class="docutils literal"><span class="pre">seq[int]</span></tt>, <tt class="docutils literal"><span class="pre">seq[float]</span></tt>, etc. (You may not use <tt class="docutils literal"><span class="pre">seq[bool]</span></tt>)</p>
<p>The last <tt class="docutils literal"><span class="pre">seq[string]</span></tt> will automatically be used to store any arguments set without a parameter name (you can disable this behaviour with <tt class="docutils literal"><span class="pre">no_implicit_bare()</span></tt>)</p>
<p><em>Details</em></p>
<p>The code above will translate into the equivalent of:</p>
<p><pre class="listing"><span class="Keyword">type</span> <span class="Identifier">Options</span> <span class="Operator">=</span> <span class="Keyword">object</span>
<span class="Identifier">name</span><span class="Punctuation">:</span><span class="Identifier">string</span>
<span class="Identifier">active</span><span class="Punctuation">:</span><span class="Identifier">bool</span>
<span class="Identifier">letter_one</span><span class="Punctuation">:</span><span class="Identifier">char</span>
<span class="Identifier">age</span><span class="Punctuation">:</span><span class="Identifier">int</span>
<span class="Identifier">hello</span><span class="Punctuation">:</span><span class="Identifier">string</span>
<span class="Identifier">big</span><span class="Punctuation">:</span><span class="Identifier">float64</span>
<span class="Identifier">small</span><span class="Punctuation">:</span><span class="Identifier">float</span>
<span class="Identifier">flat</span><span class="Punctuation">:</span><span class="Identifier">uint</span>
<span class="Identifier">arguments</span><span class="Punctuation">:</span><span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span>
<span class="Identifier">options</span> <span class="Operator">=</span> <span class="Identifier">Options</span><span class="Punctuation">(</span><span class="Identifier">name</span><span class="Punctuation">:</span> <span class="StringLit">"Default Name"</span><span class="Punctuation">,</span> <span class="Identifier">active</span><span class="Punctuation">:</span> <span class="Identifier">false</span><span class="Punctuation">,</span> <span class="Identifier">letter_one</span><span class="Punctuation">:</span> <span class="CharLit">'a'</span><span class="Punctuation">,</span> <span class="Identifier">age</span><span class="Punctuation">:</span> <span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="Identifier">big</span><span class="Punctuation">:</span> <span class="FloatNumber">1.1</span><span class="Punctuation">,</span> <span class="Identifier">small</span><span class="Punctuation">:</span> <span class="FloatNumber">2.2</span><span class="Punctuation">,</span> <span class="Identifier">flat</span><span class="Punctuation">:</span> <span class="DecNumber">2</span><span class="Punctuation">)</span>
<span class="Identifier">parse_command_line_into</span><span class="Punctuation">(</span><span class="Identifier">options</span><span class="Punctuation">)</span>
</pre></p>
<p>Where <tt class="docutils literal"><span class="pre">parse_command_line_into</span></tt> is some hypothetical procedure which parses the user-supplied command line and sets fields in <tt class="docutils literal"><span class="pre">options</span></tt> appropriately.</p>
<p><strong>get_options_and_supplied</strong></p>
<p>Using a <tt class="docutils literal"><span class="pre">get_options_and_supplied</span></tt> block will behave just like <tt class="docutils literal"><span class="pre">get_options</span></tt>, except it will return a tuple of two objects. The first is as detailed above. The second object will have identical field names, but all its fields will be of type <tt class="docutils literal"><span class="pre">bool</span></tt>.</p>
<p>Any field which the user has supplied on the command line will have its <tt class="docutils literal"><span class="pre">bool</span></tt> in the second object set to <tt class="docutils literal"><span class="pre">true</span></tt>.</p>
<p><pre class="listing"><span class="Comment"># foo.nim</span>
<span class="Keyword">let</span> <span class="Punctuation">(</span><span class="Identifier">options</span><span class="Punctuation">,</span> <span class="Identifier">supplied</span><span class="Punctuation">)</span> <span class="Operator">=</span> <span class="Identifier">get_options_and_supplied</span><span class="Punctuation">:</span>
<span class="Identifier">name</span> <span class="Operator">=</span> <span class="StringLit">"Default Name"</span>
<span class="Identifier">active</span> <span class="Operator">=</span> <span class="Identifier">false</span>
<span class="Identifier">letter</span> <span class="Operator">=</span> <span class="CharLit">'a'</span>
<span class="Identifier">age</span> <span class="Operator">=</span> <span class="DecNumber">1</span>
<span class="Identifier">big</span><span class="Punctuation">:</span><span class="Identifier">float64</span> <span class="Operator">=</span> <span class="FloatNumber">1.1</span>
<span class="Identifier">small</span><span class="Punctuation">:</span><span class="Identifier">float</span> <span class="Operator">=</span> <span class="FloatNumber">2.2</span>
<span class="Identifier">flat</span><span class="Punctuation">:</span><span class="Identifier">uint</span> <span class="Operator">=</span> <span class="DecNumber">2</span>
<span class="Identifier">hello</span><span class="Punctuation">:</span><span class="Identifier">string</span>
<span class="Keyword">if</span> <span class="Identifier">supplied</span><span class="Operator">.</span><span class="Identifier">name</span> <span class="Keyword">and</span> <span class="Identifier">supplied</span><span class="Operator">.</span><span class="Identifier">age</span><span class="Punctuation">:</span>
<span class="Identifier">echo</span> <span class="Identifier">options</span><span class="Operator">.</span><span class="Identifier">name</span> <span class="Operator">&</span> <span class="StringLit">" is "</span> <span class="Operator">&</span> <span class="Identifier">options</span><span class="Operator">.</span><span class="Identifier">age</span><span class="Operator">.</span><span class="Identifier">repr</span> <span class="Operator">&</span> <span class="StringLit">" years old!"</span>
</pre></p>
<h2><a class="toc-backref" id="default-commandminusline-syntax" href="#default-commandminusline-syntax">Default command-line syntax</a></h2><p>By default, each named parameter may be set on the command line by the user prefixing it with a <tt class="docutils literal"><span class="pre">-</span></tt> or a <tt class="docutils literal"><span class="pre">/</span></tt>. For <tt class="docutils literal"><span class="pre">bool</span></tt> fields, this will toggle the field. For other fields, the next argument on the command line is used to set the field.</p>
<p>All of these will work:</p>
<p><pre class="listing">
foo -name "Joe Random" -active
foo /active /flat 100
foo /hello Greetings! -big 100 /small 20
</pre></p>
<h2><a class="toc-backref" id="extra-parameter-infocolon-pragmas" href="#extra-parameter-infocolon-pragmas">Extra Parameter Info: Pragmas</a></h2><p>You may also add pragmas to the end of any line to modify parameter behaviour. Each pragma has a more verbose alias, if you prefer that style of code.</p>
<ul class="simple"><li><tt class="docutils literal"><span class="pre">{. info("text") .}</span></tt> <em>or</em> <tt class="docutils literal"><span class="pre">{. description("text") .}</span></tt><blockquote><p>Description of the parameter which will be shown in help text.</p></blockquote>
</li>
</ul>
<ul class="simple"><li><tt class="docutils literal"><span class="pre">{. aka("a", "b", ...) .}</span></tt> <em>or</em> <tt class="docutils literal"><span class="pre">{. alias("a", "b", ...) .}</span></tt><blockquote><p>Aliases for the parameter - user may use these as parameters; they will write to the field.</p></blockquote>
</li>
</ul>
<ul class="simple"><li><tt class="docutils literal"><span class="pre">{. bare .}</span></tt> <em>or</em> <tt class="docutils literal"><span class="pre">{. positional .}</span></tt><blockquote><p>Accepts a bare, positional argument (an argument which has not been prefixed with a parameter name). User will not be able to refer to the argument with its parameter name.</p></blockquote>
</li>
</ul>
<ul class="simple"><li><tt class="docutils literal"><span class="pre">{. need .}</span></tt> <em>or</em> <tt class="docutils literal"><span class="pre">.{ required .}</span></tt><blockquote><p>Parameter must be supplied by user or an error is shown.</p></blockquote>
</li>
</ul>
<ul class="simple"><li><tt class="docutils literal"><span class="pre">{. len(i) .}</span></tt> <em>or</em> <tt class="docutils literal"><span class="pre">.{ count(i) .}</span></tt><blockquote><p><p>Place on a <tt class="docutils literal"><span class="pre">seq</span></tt> field to require that many values be supplied to it. For example:</p>
<p><tt class="docutils literal"><span class="pre">position:seq[float] {. len(3) .} # x y z</span></tt></p>
<p>Note that this does not set a limit on the total length of the <tt class="docutils literal"><span class="pre">seq</span></tt>, only on how many values the user must specify. Using <tt class="docutils literal"><span class="pre">len</span></tt> in conjunction with the <tt class="docutils literal"><span class="pre">allow_repetition</span></tt> setting, you can accept multiple batches of values (see <tt class="docutils literal"><span class="pre">normalize.nim</span></tt> example)</p>
</p></blockquote>
</li>
</ul>
<h2><a class="toc-backref" id="settings" href="#settings">Settings</a></h2><p>You may tailor the parser with the following calls:</p>
<ul class="simple"><li><strong>no_dash()</strong><blockquote><p>Disable parameter being identified by prefixing with <tt class="docutils literal"><span class="pre">-</span></tt></p></blockquote>
</li>
</ul>
<ul class="simple"><li><strong>no_slash()</strong><blockquote><p>Disable parameter being identified by prefixing with <tt class="docutils literal"><span class="pre">/</span></tt></p></blockquote>
</li>
</ul>
<ul class="simple"><li><strong>dash_dash_parameters()</strong><blockquote><p>Require that parameters which have more than one character in their name be prefixed with <tt class="docutils literal"><span class="pre">--</span></tt> instead of <tt class="docutils literal"><span class="pre">-</span></tt>. Single-character parameters may then be entered grouped together under one <tt class="docutils literal"><span class="pre">-</span></tt></p></blockquote>
</li>
<li><strong>dash_dash_separator()</strong><blockquote><p><tt class="docutils literal"><span class="pre">--</span></tt> on its own in the command line will disable parameter names on every argument after it; they will all be treated as bare</p></blockquote>
</li>
<li><strong>value_after_colon()</strong><blockquote><p><p>Allow the user to specify parameter & value together, separated by a <tt class="docutils literal"><span class="pre">:</span></tt></p>
<p>e.g. <tt class="docutils literal"><span class="pre">-param:value</span></tt></p>
<p>Note this will not play nicely with quoted string values.</p>
</p></blockquote>
</li>
<li><strong>value_after_equals()</strong><blockquote><p><p>Allow the user to specify parameter & value together, separated by a <tt class="docutils literal"><span class="pre">=</span></tt></p>
<p>e.g. <tt class="docutils literal"><span class="pre">-param=value</span></tt></p>
<p>Note this will not play nicely with quoted string values.</p>
</p></blockquote>
</li>
<li><strong>allow_repetition()</strong><blockquote><p>Allow the user to specify the same parameter more than once without reporting an error.</p></blockquote>
</li>
<li><strong>allow_errors()</strong><blockquote><p>Allow program execution to continue after erroneous input.</p></blockquote>
</li>
<li><strong>no_implicit_bare()</strong><blockquote><p>Do not automatically use the last <tt class="docutils literal"><span class="pre">seq[string]</span></tt> parameter to gather any bare parameters the user enters (they become erroneous instead)</p></blockquote>
</li>
<li><strong>can_name_bare()</strong><blockquote><p>Allows user to set bare parameters by name.</p></blockquote>