forked from kohler/masstree-beta
-
Notifications
You must be signed in to change notification settings - Fork 0
/
clp.c
2362 lines (2108 loc) · 67.3 KB
/
clp.c
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
/* Masstree
* Eddie Kohler, Yandong Mao, Robert Morris
* Copyright (c) 2012-2013 President and Fellows of Harvard College
* Copyright (c) 2012-2013 Massachusetts Institute of Technology
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, subject to the conditions
* listed in the Masstree LICENSE file. These conditions include: you must
* preserve this copyright notice, and you cannot mention the copyright
* holders in advertising related to the Software without their permission.
* The Software is provided WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED. This
* notice is a summary of the Masstree LICENSE file; the license in that file
* is legally binding.
*/
/* clp.c - Complete source code for CLP.
* This file is part of CLP, the command line parser package.
*
* Copyright (c) 1997-2011 Eddie Kohler, ekohler@gmail.com
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, subject to the conditions
* listed in the Click LICENSE file, which is available in full at
* http://www.pdos.lcs.mit.edu/click/license.html. The conditions include: you
* must preserve this copyright notice, and you cannot mention the copyright
* holders in advertising related to the Software without their permission.
* The Software is provided WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED. This
* notice is a summary of the Click LICENSE file; the license in that file is
* legally binding. */
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif
#include "clp.h"
#include <stdlib.h>
#include <string.h>
#include <stdio.h>
#include <assert.h>
#include <stdarg.h>
#include <ctype.h>
/* By default, assume we have strtoul. */
#if !defined(HAVE_STRTOUL) && !defined(HAVE_CONFIG_H)
# define HAVE_STRTOUL 1
#endif
#ifdef __cplusplus
extern "C" {
#endif
/** @file clp.h
* @brief Functions for parsing command line options.
*
* The CLP functions are used to parse command line arugments into options.
* It automatically handles value parsing, error messages, long options with
* minimum prefix matching, short options, and negated options.
*
* The CLP model works like this.
*
* <ol>
* <li>The user declares an array of Clp_Option structures that define the
* options their program accepts.</li>
* <li>The user creates a Clp_Parser object using Clp_NewParser(), passing in
* the command line arguments to parse and the Clp_Option structures.</li>
* <li>A loop repeatedly calls Clp_Next() to parse the arguments.</li>
* </ol>
*
* Unlike many command line parsing libraries, CLP steps through all arguments
* one at a time, rather than slurping up all options at once. This makes it
* meaningful to give an option more than once.
*
* Here's an example.
*
* @code
* #define ANIMAL_OPT 1
* #define VEGETABLE_OPT 2
* #define MINERALS_OPT 3
* #define USAGE_OPT 4
*
* static const Clp_Option options[] = {
* { "animal", 'a', ANIMAL_OPT, Clp_ValString, 0 },
* { "vegetable", 'v', VEGETABLE_OPT, Clp_ValString, Clp_Negate | Clp_Optional },
* { "minerals", 'm', MINERALS_OPT, Clp_ValInt, 0 },
* { "usage", 0, USAGE_OPT, 0, 0 }
* };
*
* int main(int argc, char *argv[]) {
* Clp_Parser *clp = Clp_NewParser(argc, argv,
* sizeof(options) / sizeof(options[0]), options);
* int opt;
* while ((opt = Clp_Next(clp)) != Clp_Done)
* switch (opt) {
* case ANIMAL_OPT:
* fprintf(stderr, "animal is %s\n", clp->val.s);
* break;
* case VEGETABLE_OPT:
* if (clp->negated)
* fprintf(stderr, "no vegetables!\n");
* else if (clp->have_val)
* fprintf(stderr, "vegetable is %s\n", clp->val.s);
* else
* fprintf(stderr, "vegetables OK\n");
* break;
* case MINERALS_OPT:
* fprintf(stderr, "%d minerals\n", clp->val.i);
* break;
* case USAGE_OPT:
* fprintf(stderr, "Usage: 20q [--animal=ANIMAL] [--vegetable[=VEGETABLE]] [--minerals=N]\n");
* break;
* case Clp_NotOption:
* fprintf(stderr, "non-option %s\n", clp->vstr);
* break;
* }
* }
* }
* @endcode
*
* Here are a couple of executions.
*
* <pre>
* % ./20q --animal=cat
* animal is cat
* % ./20q --animal=cat -a dog -afish --animal bird --an=snake
* animal is cat
* animal is dog
* animal is fish
* animal is bird
* animal is snake
* % ./20q --no-vegetables
* no vegetables!
* % ./20q -v
* vegetables OK
* % ./20q -vkale
* vegetable is kale
* % ./20q -m10
* 10 minerals
* % ./20q -m foo
* '-m' expects an integer, not 'foo'
* </pre>
*/
/* Option types for Clp_SetOptionChar */
#define Clp_DoubledLong (Clp_LongImplicit * 2)
#define Clp_InitialValType 8
#define MAX_AMBIGUOUS_VALUES 4
typedef struct {
int val_type;
Clp_ValParseFunc func;
int flags;
void *user_data;
} Clp_ValType;
typedef struct {
unsigned ilong : 1;
unsigned ishort : 1;
unsigned imandatory : 1;
unsigned ioptional : 1;
unsigned ipos : 1;
unsigned ineg : 1;
unsigned iprefmatch : 1;
unsigned lmmpos_short : 1;
unsigned lmmneg_short : 1;
unsigned char ilongoff;
int lmmpos;
int lmmneg;
} Clp_InternOption;
#define Clp_OptionCharsSize 5
typedef struct {
int c;
int type;
} Clp_Oclass;
#define Clp_OclassSize 10
typedef struct Clp_Internal {
const Clp_Option *opt;
Clp_InternOption *iopt;
int nopt;
unsigned opt_generation;
Clp_ValType *valtype;
int nvaltype;
const char * const *argv;
int argc;
Clp_Oclass oclass[Clp_OclassSize];
int noclass;
int long1pos;
int long1neg;
int utf8;
char option_chars[Clp_OptionCharsSize];
const char *xtext;
const char *program_name;
void (*error_handler)(Clp_Parser *, const char *);
int option_processing;
int current_option;
unsigned char is_short;
unsigned char whole_negated; /* true if negated by an option character */
unsigned char could_be_short;
unsigned char current_short;
unsigned char negated_by_no;
int ambiguous;
int ambiguous_values[MAX_AMBIGUOUS_VALUES];
} Clp_Internal;
struct Clp_ParserState {
const char * const *argv;
int argc;
char option_chars[Clp_OptionCharsSize];
const char *xtext;
int option_processing;
unsigned opt_generation;
int current_option;
unsigned char is_short;
unsigned char whole_negated;
unsigned char current_short;
unsigned char negated_by_no;
};
typedef struct Clp_StringList {
Clp_Option *items;
Clp_InternOption *iopt;
int nitems;
int allow_int;
int nitems_invalid_report;
} Clp_StringList;
static int parse_string(Clp_Parser *, const char *, int, void *);
static int parse_int(Clp_Parser *, const char *, int, void *);
static int parse_bool(Clp_Parser *, const char *, int, void *);
static int parse_double(Clp_Parser *, const char *, int, void *);
static int parse_string_list(Clp_Parser *, const char *, int, void *);
static int ambiguity_error(Clp_Parser *, int, int *, const Clp_Option *,
const Clp_InternOption *, const char *, const char *,
...);
/*******
* utf8
**/
#define U_REPLACEMENT 0xFFFD
static char *
encode_utf8(char *s, int n, int c)
{
if (c < 0 || c >= 0x110000 || (c >= 0xD800 && c <= 0xDFFF))
c = U_REPLACEMENT;
if (c <= 0x7F && n >= 1)
*s++ = c;
else if (c <= 0x7FF && n >= 2) {
*s++ = 0xC0 | (c >> 6);
goto char1;
} else if (c <= 0xFFFF && n >= 3) {
*s++ = 0xE0 | (c >> 12);
goto char2;
} else if (n >= 4) {
*s++ = 0xF0 | (c >> 18);
*s++ = 0x80 | ((c >> 12) & 0x3F);
char2:
*s++ = 0x80 | ((c >> 6) & 0x3F);
char1:
*s++ = 0x80 | (c & 0x3F);
}
return s;
}
static int
decode_utf8(const char *s, const char **cp)
{
int c;
if ((unsigned char) *s <= 0x7F) /* 1 byte: 0x000000-0x00007F */
c = *s++;
else if ((unsigned char) *s <= 0xC1) /* bad/overlong encoding */
goto replacement;
else if ((unsigned char) *s <= 0xDF) { /* 2 bytes: 0x000080-0x0007FF */
if ((s[1] & 0xC0) != 0x80) /* bad encoding */
goto replacement;
c = (*s++ & 0x1F) << 6;
goto char1;
} else if ((unsigned char) *s <= 0xEF) { /* 3 bytes: 0x000800-0x00FFFF */
if ((s[1] & 0xC0) != 0x80 /* bad encoding */
|| (s[2] & 0xC0) != 0x80 /* bad encoding */
|| ((unsigned char) *s == 0xE0 /* overlong encoding */
&& (s[1] & 0xE0) == 0x80)
|| ((unsigned char) *s == 0xED /* encoded surrogate */
&& (s[1] & 0xE0) == 0xA0))
goto replacement;
c = (*s++ & 0x0F) << 12;
goto char2;
} else if ((unsigned char) *s <= 0xF4) { /* 4 bytes: 0x010000-0x10FFFF */
if ((s[1] & 0xC0) != 0x80 /* bad encoding */
|| (s[2] & 0xC0) != 0x80 /* bad encoding */
|| (s[3] & 0xC0) != 0x80 /* bad encoding */
|| ((unsigned char) *s == 0xF0 /* overlong encoding */
&& (s[1] & 0xF0) == 0x80)
|| ((unsigned char) *s == 0xF4 /* encoded value > 0x10FFFF */
&& (unsigned char) s[1] >= 0x90))
goto replacement;
c = (*s++ & 0x07) << 18;
c += (*s++ & 0x3F) << 12;
char2:
c += (*s++ & 0x3F) << 6;
char1:
c += (*s++ & 0x3F);
} else {
replacement:
c = U_REPLACEMENT;
for (s++; (*s & 0xC0) == 0x80; s++)
/* nothing */;
}
if (cp)
*cp = s;
return c;
}
static int
utf8_charlen(const char *s)
{
const char *sout;
(void) decode_utf8(s, &sout);
return sout - s;
}
static int
clp_utf8_charlen(const Clp_Internal *cli, const char *s)
{
return (cli->utf8 ? utf8_charlen(s) : 1);
}
/*******
* Clp_NewParser, etc.
**/
static int
min_different_chars(const char *s, const char *t)
/* Returns the minimum number of bytes required to distinguish
s from t.
If s is shorter than t, returns strlen(s). */
{
const char *sfirst = s;
while (*s && *t && *s == *t)
s++, t++;
if (!*s)
return s - sfirst;
else
return s - sfirst + 1;
}
static int
long_as_short(const Clp_Internal *cli, const Clp_Option *o,
Clp_InternOption *io, int failure)
{
if ((cli->long1pos || cli->long1neg) && io->ilong) {
const char *name = o->long_name + io->ilongoff;
if (cli->utf8) {
int c = decode_utf8(name, &name);
if (!*name && c && c != U_REPLACEMENT)
return c;
} else if (name[0] && !name[1])
return (unsigned char) name[0];
}
return failure;
}
static void
compare_options(Clp_Parser *clp, const Clp_Option *o1, Clp_InternOption *io1,
const Clp_Option *o2, Clp_InternOption *io2)
{
Clp_Internal *cli = clp->internal;
int short1, shortx1;
/* ignore meaningless combinations */
if ((!io1->ishort && !io1->ilong) || (!io2->ishort && !io2->ilong)
|| !((io1->ipos && io2->ipos) || (io1->ineg && io2->ineg))
|| o1->option_id == o2->option_id)
return;
/* look for duplication of short options */
short1 = (io1->ishort ? o1->short_name : -1);
shortx1 = long_as_short(cli, o1, io1, -2);
if (short1 >= 0 || shortx1 >= 0) {
int short2 = (io2->ishort ? o2->short_name : -3);
int shortx2 = long_as_short(cli, o2, io2, -4);
if (short1 == short2)
Clp_OptionError(clp, "CLP internal error: more than 1 option has short name %<%c%>", short1);
else if ((short1 == shortx2 || shortx1 == short2 || shortx1 == shortx2)
&& ((io1->ipos && io2->ipos && cli->long1pos)
|| (io1->ineg && io2->ineg && cli->long1neg)))
Clp_OptionError(clp, "CLP internal error: 1-char long name conflicts with short name %<%c%>", (short1 == shortx2 ? shortx2 : shortx1));
}
/* analyze longest minimum match */
if (io1->ilong) {
const char *name1 = o1->long_name + io1->ilongoff;
/* long name's first character matches short name */
if (io2->ishort && !io1->iprefmatch) {
int name1char = (cli->utf8 ? decode_utf8(name1, 0) : (unsigned char) *name1);
if (name1char == o2->short_name) {
if (io1->ipos && io2->ipos)
io1->lmmpos_short = 1;
if (io1->ineg && io2->ineg)
io1->lmmneg_short = 1;
}
}
/* match long name to long name */
if (io2->ilong) {
const char *name2 = o2->long_name + io2->ilongoff;
if (strcmp(name1, name2) == 0)
Clp_OptionError(clp, "CLP internal error: duplicate long name %<%s%>", name1);
if (io1->ipos && io2->ipos && !strncmp(name1, name2, io1->lmmpos)
&& (!io1->iprefmatch || strncmp(name1, name2, strlen(name1))))
io1->lmmpos = min_different_chars(name1, name2);
if (io1->ineg && io2->ineg && !strncmp(name1, name2, io1->lmmneg)
&& (!io1->iprefmatch || strncmp(name1, name2, strlen(name1))))
io1->lmmneg = min_different_chars(name1, name2);
}
}
}
/** @param argc number of arguments
* @param argv argument array
* @param nopt number of option definitions
* @param opt option definition array
* @return the parser
*
* The new Clp_Parser that will parse the arguments in @a argv according to
* the option definitions in @a opt.
*
* The Clp_Parser is created with the following characteristics:
*
* <ul>
* <li>The "-" character introduces short options (<tt>Clp_SetOptionChar(clp,
* '-', Clp_Short)</tt>).</li>
* <li>Clp_ProgramName is set from the first argument in @a argv, if any. The
* first argument returned by Clp_Next() will be the second argument in @a
* argv. Note that this behavior differs from Clp_SetArguments.</li>
* <li>UTF-8 support is on iff the <tt>LANG</tt> environment variable contains
* one of the substrings "UTF-8", "UTF8", or "utf8". Override this with
* Clp_SetUTF8().</li>
* <li>The Clp_ValString, Clp_ValStringNotOption, Clp_ValInt, Clp_ValUnsigned,
* Clp_ValBool, and Clp_ValDouble types are installed.</li>
* <li>Errors are reported to standard error.</li>
* </ul>
*
* You may also create a Clp_Parser with no arguments or options
* (<tt>Clp_NewParser(0, 0, 0, 0)</tt>) and set the arguments and options
* later.
*
* Returns NULL if there isn't enough memory to construct the parser.
*
* @note The CLP library will not modify the contents of @a argv or @a opt.
* The calling program must not modify @a opt. It may modify @a argv in
* limited cases.
*/
Clp_Parser *
Clp_NewParser(int argc, const char * const *argv, int nopt, const Clp_Option *opt)
{
Clp_Parser *clp = (Clp_Parser *)malloc(sizeof(Clp_Parser));
Clp_Internal *cli = (Clp_Internal *)malloc(sizeof(Clp_Internal));
Clp_InternOption *iopt = (Clp_InternOption *)malloc(sizeof(Clp_InternOption) * nopt);
if (cli)
cli->valtype = (Clp_ValType *)malloc(sizeof(Clp_ValType) * Clp_InitialValType);
if (!clp || !cli || !iopt || !cli->valtype)
goto failed;
clp->option = 0;
clp->negated = 0;
clp->have_val = 0;
clp->vstr = 0;
clp->user_data = 0;
clp->internal = cli;
cli->opt = opt;
cli->nopt = nopt;
cli->iopt = iopt;
cli->opt_generation = 0;
cli->error_handler = 0;
/* Assign program name (now so we can call Clp_OptionError) */
if (argc > 0) {
const char *slash = strrchr(argv[0], '/');
cli->program_name = slash ? slash + 1 : argv[0];
} else
cli->program_name = 0;
/* Assign arguments, skipping program name */
Clp_SetArguments(clp, argc - 1, argv + 1);
/* Initialize UTF-8 status and option classes */
{
char *s = getenv("LANG");
cli->utf8 = (s && (strstr(s, "UTF-8") != 0 || strstr(s, "UTF8") != 0
|| strstr(s, "utf8") != 0));
}
cli->oclass[0].c = '-';
cli->oclass[0].type = Clp_Short;
cli->noclass = 1;
cli->long1pos = cli->long1neg = 0;
/* Add default type parsers */
cli->nvaltype = 0;
Clp_AddType(clp, Clp_ValString, 0, parse_string, 0);
Clp_AddType(clp, Clp_ValStringNotOption, Clp_DisallowOptions, parse_string, 0);
Clp_AddType(clp, Clp_ValInt, 0, parse_int, 0);
Clp_AddType(clp, Clp_ValUnsigned, 0, parse_int, (void *)cli);
Clp_AddType(clp, Clp_ValBool, 0, parse_bool, 0);
Clp_AddType(clp, Clp_ValDouble, 0, parse_double, 0);
/* Set options */
Clp_SetOptions(clp, nopt, opt);
return clp;
failed:
if (cli && cli->valtype)
free(cli->valtype);
if (cli)
free(cli);
if (clp)
free(clp);
if (iopt)
free(iopt);
return 0;
}
/** @param clp the parser
*
* All memory associated with @a clp is freed. */
void
Clp_DeleteParser(Clp_Parser *clp)
{
int i;
Clp_Internal *cli;
if (!clp)
return;
cli = clp->internal;
/* get rid of any string list types */
for (i = 0; i < cli->nvaltype; i++)
if (cli->valtype[i].func == parse_string_list) {
Clp_StringList *clsl = (Clp_StringList *)cli->valtype[i].user_data;
free(clsl->items);
free(clsl->iopt);
free(clsl);
}
free(cli->valtype);
free(cli->iopt);
free(cli);
free(clp);
}
/** @param clp the parser
* @param errh error handler function
* @return previous error handler function
*
* The error handler function is called when CLP encounters an error while
* parsing the command line. It is called with the arguments "<tt>(*errh)(@a
* clp, s)</tt>", where <tt>s</tt> is a description of the error terminated by
* a newline. The <tt>s</tt> descriptions produced by CLP itself are prefixed
* by the program name, if any. */
Clp_ErrorHandler
Clp_SetErrorHandler(Clp_Parser *clp, void (*errh)(Clp_Parser *, const char *))
{
Clp_Internal *cli = clp->internal;
Clp_ErrorHandler old = cli->error_handler;
cli->error_handler = errh;
return old;
}
/** @param clp the parser
* @param utf8 does the parser support UTF-8?
* @return previous UTF-8 mode
*
* In UTF-8 mode, all input strings (arguments and long names for options) are
* assumed to be encoded via UTF-8, and all character names
* (Clp_SetOptionChar() and short names for options) may cover the whole
* Unicode range. Out of UTF-8 mode, all input strings are treated as binary,
* and all character names must be unsigned char values.
*
* Furthermore, error messages in UTF-8 mode may contain Unicode quote
* characters. */
int
Clp_SetUTF8(Clp_Parser *clp, int utf8)
{
Clp_Internal *cli = clp->internal;
int i, j, old_utf8 = cli->utf8;
cli->utf8 = utf8;
for (i = 0; i < cli->nopt; ++i) {
cli->iopt[i].lmmpos = cli->iopt[i].lmmneg = 1;
cli->iopt[i].lmmpos_short = cli->iopt[i].lmmneg_short = 0;
for (j = 0; j < cli->nopt; ++j)
compare_options(clp, &cli->opt[i], &cli->iopt[i],
&cli->opt[j], &cli->iopt[j]);
}
return old_utf8;
}
/** @param clp the parser
* @param c character
* @return option character treatment
*
* Returns an integer specifying how CLP treats arguments that begin
* with character @a c. See Clp_SetOptionChar for possibilities.
*/
int
Clp_OptionChar(Clp_Parser *clp, int c)
{
Clp_Internal *cli = clp->internal;
int i, oclass = 0;
if (cli->noclass > 0 && cli->oclass[0].c == 0)
oclass = cli->oclass[0].type;
for (i = 0; i < cli->noclass; ++i)
if (cli->oclass[i].c == c)
oclass = cli->oclass[i].type;
return oclass;
}
/** @param clp the parser
* @param c character
* @param type option character treatment
* @return previous option character treatment, or -1 on error
*
* @a type specifies how CLP treats arguments that begin with character @a c.
* Possibilities are:
*
* <dl>
* <dt>Clp_NotOption (or 0)</dt>
* <dd>The argument cannot be an option.</dd>
* <dt>Clp_Long</dt>
* <dd>The argument is a long option.</dd>
* <dt>Clp_Short</dt>
* <dd>The argument is a set of short options.</dd>
* <dt>Clp_Short|Clp_Long</dt>
* <dd>The argument is either a long option or, if no matching long option is
* found, a set of short options.</dd>
* <dt>Clp_LongNegated</dt>
* <dd>The argument is a negated long option. For example, after
* Clp_SetOptionChar(@a clp, '^', Clp_LongNegated), the argument "^foo" is
* equivalent to "--no-foo".</dd>
* <dt>Clp_ShortNegated</dt>
* <dd>The argument is a set of negated short options.</dd>
* <dt>Clp_ShortNegated|Clp_LongNegated</dt>
* <dd>The argument is either a negated long option or, if no matching long
* option is found, a set of negated short options.</dd>
* <dt>Clp_LongImplicit</dt>
* <dd>The argument may be a long option, where the character @a c is actually
* part of the long option name. For example, after Clp_SetOptionChar(@a clp,
* 'f', Clp_LongImplicit), the argument "foo" may be equivalent to
* "--foo".</dd>
* </dl>
*
* In UTF-8 mode, @a c may be any Unicode character. Otherwise, @a c must be
* an unsigned char value. The special character 0 assigns @a type to @em
* every character.
*
* It is an error if @a c is out of range, @a type is illegal, or there are
* too many character definitions stored in @a clp already. The function
* returns -1 on error.
*
* A double hyphen "--" always introduces a long option. This behavior cannot
* currently be changed with Clp_SetOptionChar().
*/
int
Clp_SetOptionChar(Clp_Parser *clp, int c, int type)
{
int i, j, long1pos, long1neg;
int old = Clp_OptionChar(clp, c);
Clp_Internal *cli = clp->internal;
if (type != Clp_NotOption && type != Clp_Short && type != Clp_Long
&& type != Clp_ShortNegated && type != Clp_LongNegated
&& type != Clp_LongImplicit && type != (Clp_Short | Clp_Long)
&& type != (Clp_ShortNegated | Clp_LongNegated))
return -1;
if (c < 0 || c >= (cli->utf8 ? 0x110000 : 256))
return -1;
if (c == 0)
cli->noclass = 0;
for (i = 0; i < cli->noclass; ++i)
if (cli->oclass[i].c == c)
break;
if (i == Clp_OclassSize)
return -1;
cli->oclass[i].c = c;
cli->oclass[i].type = type;
if (cli->noclass == i)
cli->noclass = i + 1;
long1pos = long1neg = 0;
for (i = 0; i < cli->noclass; ++i) {
if ((cli->oclass[i].type & Clp_Short)
&& (cli->oclass[i].type & Clp_Long))
long1pos = 1;
if ((cli->oclass[i].type & Clp_ShortNegated)
&& (cli->oclass[i].type & Clp_LongNegated))
long1neg = 1;
}
if (long1pos != cli->long1pos || long1neg != cli->long1neg) {
/* Must recheck option set */
cli->long1pos = long1pos;
cli->long1neg = long1neg;
for (i = 0; i < cli->nopt; ++i) {
cli->iopt[i].lmmpos = cli->iopt[i].lmmneg = 1;
cli->iopt[i].lmmpos_short = cli->iopt[i].lmmneg_short = 0;
for (j = 0; j < cli->nopt; ++j)
compare_options(clp, &cli->opt[i], &cli->iopt[i],
&cli->opt[j], &cli->iopt[j]);
}
}
return old;
}
/** @param clp the parser
* @param nopt number of option definitions
* @param opt option definition array
* @return 0 on success, -1 on failure
*
* Installs the option definitions in @a opt. Future option parsing will
* use @a opt to search for options.
*
* Also checks @a opt's option definitions for validity. "CLP internal
* errors" are reported via Clp_OptionError() if:
*
* <ul>
* <li>An option has a negative ID.</li>
* <li>Two different short options have the same name.</li>
* <li>Two different long options have the same name.</li>
* <li>A short and a long option are ambiguous, in that some option character
* might introduce either a short or a long option (e.g., Clp_SetOptionChar(@a
* clp, '-', Clp_Long|Clp_Short)), and a short name equals a long name.</li>
* </ul>
*
* If necessary memory cannot be allocated, this function returns -1 without
* modifying the parser.
*
* @note The CLP library will not modify the contents of @a argv or @a opt.
* The calling program must not modify @a opt either until another call to
* Clp_SetOptions() or the parser is destroyed.
*/
int
Clp_SetOptions(Clp_Parser *clp, int nopt, const Clp_Option *opt)
{
Clp_Internal *cli = clp->internal;
Clp_InternOption *iopt;
int i, j;
static unsigned opt_generation = 0;
if (nopt > cli->nopt) {
iopt = (Clp_InternOption *)malloc(sizeof(Clp_InternOption) * nopt);
if (!iopt)
return -1;
free(cli->iopt);
cli->iopt = iopt;
}
cli->opt = opt;
cli->nopt = nopt;
cli->opt_generation = ++opt_generation;
iopt = cli->iopt;
cli->current_option = -1;
/* Massage the options to make them usable */
for (i = 0; i < nopt; i++) {
/* Ignore negative option_ids, which are internal to CLP */
if (opt[i].option_id < 0) {
Clp_OptionError(clp, "CLP internal error: option %d has negative option_id", i);
iopt[i].ilong = iopt[i].ishort = iopt[i].ipos = iopt[i].ineg = 0;
continue;
}
/* Set flags based on input flags */
iopt[i].ilong = (opt[i].long_name != 0 && opt[i].long_name[0] != 0);
iopt[i].ishort = (opt[i].short_name > 0
&& opt[i].short_name < (cli->utf8 ? 0x110000 : 256));
iopt[i].ipos = 1;
iopt[i].ineg = (opt[i].flags & Clp_Negate) != 0;
iopt[i].imandatory = (opt[i].flags & Clp_Mandatory) != 0;
iopt[i].ioptional = (opt[i].flags & Clp_Optional) != 0;
iopt[i].iprefmatch = (opt[i].flags & Clp_PreferredMatch) != 0;
iopt[i].ilongoff = 0;
/* Enforce invariants */
if (opt[i].val_type <= 0)
iopt[i].imandatory = iopt[i].ioptional = 0;
if (opt[i].val_type > 0 && !iopt[i].ioptional)
iopt[i].imandatory = 1;
/* Options that start with 'no-' should be changed to OnlyNegated */
if (iopt[i].ilong && strncmp(opt[i].long_name, "no-", 3) == 0) {
iopt[i].ipos = 0;
iopt[i].ineg = 1;
iopt[i].ilongoff = 3;
if (strncmp(opt[i].long_name + 3, "no-", 3) == 0)
Clp_OptionError(clp, "CLP internal error: option %d begins with \"no-no-\"", i);
} else if (opt[i].flags & Clp_OnlyNegated) {
iopt[i].ipos = 0;
iopt[i].ineg = 1;
}
}
/* Check option set */
for (i = 0; i < nopt; ++i) {
iopt[i].lmmpos = iopt[i].lmmneg = 1;
iopt[i].lmmpos_short = iopt[i].lmmneg_short = 0;
for (j = 0; j < nopt; ++j)
compare_options(clp, &opt[i], &iopt[i], &opt[j], &iopt[j]);
}
return 0;
}
/** @param clp the parser
* @param argc number of arguments
* @param argv argument array
*
* Installs the arguments in @a argv for parsing. Future option parsing will
* analyze @a argv.
*
* Unlike Clp_NewParser(), this function does not treat @a argv[0] specially.
* The first subsequent call to Clp_Next() will analyze @a argv[0].
*
* This function also sets option processing to on, as by
* Clp_SetOptionProcessing(@a clp, 1).
*
* @note The CLP library will not modify the contents of @a argv. The calling
* program should not generally modify the element of @a argv that CLP is
* currently analyzing.
*/
void
Clp_SetArguments(Clp_Parser *clp, int argc, const char * const *argv)
{
Clp_Internal *cli = clp->internal;
cli->argc = argc + 1;
cli->argv = argv - 1;
cli->is_short = 0;
cli->whole_negated = 0;
cli->option_processing = 1;
cli->current_option = -1;
}
/** @param clp the parser
* @param on whether to search for options
* @return previous option processing setting
*
* When option processing is off, every call to Clp_Next() returns
* Clp_NotOption. By default the option <tt>"--"</tt> turns off option
* processing and is otherwise ignored.
*/
int
Clp_SetOptionProcessing(Clp_Parser *clp, int on)
{
Clp_Internal *cli = clp->internal;
int old = cli->option_processing;
cli->option_processing = on;
return old;
}
/*******
* functions for Clp_Option lists
**/
/* the ever-glorious argcmp */
static int
argcmp(const char *ref, const char *arg, int min_match, int fewer_dashes)
/* Returns 0 if ref and arg don't match.
Returns -1 if ref and arg match, but fewer than min_match characters.
Returns len if ref and arg match min_match or more characters;
len is the number of characters that matched in arg.
Allows arg to contain fewer dashes than ref iff fewer_dashes != 0.
Examples:
argcmp("x", "y", 1, 0) --> 0 / just plain wrong
argcmp("a", "ax", 1, 0) --> 0 / ...even though min_match == 1
and the 1st chars match
argcmp("box", "bo", 3, 0) --> -1 / ambiguous
argcmp("cat", "c=3", 1, 0) --> 1 / handles = arguments
*/
{
const char *refstart = ref;
const char *argstart = arg;
assert(min_match > 0);
compare:
while (*ref && *arg && *arg != '=' && *ref == *arg)
ref++, arg++;
/* Allow arg to contain fewer dashes than ref */
if (fewer_dashes && *ref == '-' && ref[1] && ref[1] == *arg) {
ref++;
goto compare;
}
if (*arg && *arg != '=')
return 0;
else if (ref - refstart < min_match)
return -1;
else
return arg - argstart;
}
static int
find_prefix_opt(Clp_Parser *clp, const char *arg,
int nopt, const Clp_Option *opt,
const Clp_InternOption *iopt,
int *ambiguous, int *ambiguous_values)
/* Looks for an unambiguous match of 'arg' against one of the long
options in 'opt'. Returns positive if it finds one; otherwise, returns
-1 and possibly changes 'ambiguous' and 'ambiguous_values' to keep
track of at most MAX_AMBIGUOUS_VALUES possibilities. */
{
int i, fewer_dashes = 0, first_ambiguous = *ambiguous;
int negated = clp && clp->negated;
int first_charlen = (clp ? clp_utf8_charlen(clp->internal, arg) : 1);
retry:
for (i = 0; i < nopt; i++) {
int len, lmm;
if (!iopt[i].ilong || (negated ? !iopt[i].ineg : !iopt[i].ipos))
continue;
lmm = (negated ? iopt[i].lmmneg : iopt[i].lmmpos);
if (clp && clp->internal->could_be_short
&& (negated ? iopt[i].lmmneg_short : iopt[i].lmmpos_short))
lmm = (first_charlen >= lmm ? first_charlen + 1 : lmm);
len = argcmp(opt[i].long_name + iopt[i].ilongoff, arg, lmm, fewer_dashes);
if (len > 0)
return i;
else if (len < 0) {
if (*ambiguous < MAX_AMBIGUOUS_VALUES)
ambiguous_values[*ambiguous] = i;
(*ambiguous)++;
}
}
/* If there were no partial matches, try again with fewer_dashes true */
if (*ambiguous == first_ambiguous && !fewer_dashes) {
fewer_dashes = 1;
goto retry;
}
return -1;
}
/*****
* Argument parsing
**/
static int
val_type_binsearch(Clp_Internal *cli, int val_type)
{
unsigned l = 0, r = cli->nvaltype;
while (l < r) {
unsigned m = l + (r - l) / 2;
if (cli->valtype[m].val_type == val_type)
return m;
else if (cli->valtype[m].val_type < val_type)
l = m + 1;
else
r = m;
}