File: getopt.cpp

package info (click to toggle)
mpich 4.3.2-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 101,184 kB
  • sloc: ansic: 1,040,629; cpp: 82,270; javascript: 40,763; perl: 27,933; python: 16,041; sh: 14,676; xml: 14,418; f90: 12,916; makefile: 9,270; fortran: 8,046; java: 4,635; asm: 324; ruby: 103; awk: 27; lisp: 19; php: 8; sed: 4
file content (698 lines) | stat: -rw-r--r-- 18,403 bytes parent folder | download | duplicates (4)
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
/*
* Copyright (c) 2013-2016 Intel Corporation.  All rights reserved.
*
* This software is available to you under the BSD license below:
*
*     Redistribution and use in source and binary forms, with or
*     without modification, are permitted provided that the following
*     conditions are met:
*
*      - Redistributions of source code must retain the above
*        copyright notice, this list of conditions and the following
*        disclaimer.
*
*      - Redistributions in binary form must reproduce the above
*        copyright notice, this list of conditions and the following
*        disclaimer in the documentation and/or other materials
*        provided with the distribution.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AWV
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/

#include <assert.h>
#include <string.h>
#include <stdlib.h>
#include <stdio.h>

#include "getopt.h"

#ifndef min
#  define min(x,y) (x)<(y) ? (x) : (y)
#endif // min

char* optarg = 0;
int   optind = 1;
int   opterr = 1;
int   optopt = '?';
static int nextchar = 0;

typedef struct _getopt_param {
	const char* optstring;	// effective option string, without prefixes
	bool posix;		// POSIX compatible mode (stop at first not detected parameter)
	bool process_all;	// process all elements
	bool no_report;		// don't report about errors...
	char missing_arg;	// character for return for missing option argument
				//   by default - '?', but may be ':'
} getopt_param;


// this function detects for parameters of processing
static getopt_param scan_param(const char* optstring)
{
	assert(optstring);
	getopt_param param = { optstring, false, false, false, '?' };
	size_t len = strlen(optstring);

	if (!opterr)
		param.no_report = true;

	for (size_t i = 0; i < len; i++) {
		// if option string begins with symbols '-+:' then this is special symbols...
		switch(optstring[i])
		{
		case '-':
			param.process_all = true;
			break;
		case '+':
			param.posix = true;
			break;
		case ':':
			param.missing_arg = ':';
			param.no_report = true; // i don't know why, but if optstrings starts with
			break;                  // ':' - original Linux function doesn't report about errors...
		default: // ok, no more special symbols... save efective format string & return
			param.optstring = optstring + i;
			return param;
		}
	}
	assert(0); // no more symbols? not good :(
	return param;
}

// this function detects different between 2 strings:
// return values:
//   -1 - strings differ
//   0  - strings same
//   >0 - str is substring of opt
static int string_diff(const char* opt, const char* str, int len)
{
	assert(opt);
	assert(str);
	assert(len);
	assert(len <= (int)strlen(str));

	int olen = strlen(opt);

	if (olen < len)
		return -1;

	for (int i = 0;; i++) {
		if(!opt[i] && i == len)
			return 0; // option == str
		else if(opt[i] && i >= len)
			return olen - i; // str is part of option
		else if(opt[i] != str[i])
			return -1; // option is shorter str... in str specified option name longer that option
	}
}

typedef enum _opt_type
{
	opt_not_found		= 0,
	opt_err_no_arg		= 1,
	opt_err_ambiguous	= 2,
	opt_single		= 3,
	opt_inplace_arg		= 4,
	opt_has_arg		= 5
} opt_type;


// check for short option... should be like "-opt_name"
static bool is_short_option(const char* str)
{
	return (str[0] == '-' && str[1] && str[1] != '-');
}

// check for long option... should be like "--opt_name"
static bool is_long_option(const char* str)
{
	return (str[0] == '-' && str[1] == '-'  && str[2]);
}

static bool is_option(const char* str)
{
	return (is_short_option(str) || is_long_option(str));
}

static bool is_finish(const char* str)
{ // if string == "--" - then this is terminator (no more process)
	return (str[0] == '-' && str[1] == '-' && !str[2]);
}

static int short_option_begin(const char* /*str*/)
{ // currently this is fake because supported only '-' as attribute of short option
	return 1;
}

static int long_option_begin(const char* /*str*/)
{ // currently this is fake because supported only '--' as attribute of long option
	return 2;
}

static int option_begin(const char* str)
{
	if (is_short_option(str))
		return short_option_begin(str);
	else if (is_long_option(str))
		return long_option_begin(str);
	assert(0);
	return 0;
}

// looking for nearest option or terminate sequence ('--') in argv from optind index
// if no option found - return -1, else - index of found option
static int look_for_option(int argc, char* const argv[], int optind)
{
	assert(argv);
	for (int i = optind; i < argc; i++)
		if (is_option(argv[i]) || is_finish(argv[i]))
			return i;
	return -1;
}

// this function tries to detect short option entry in string
static opt_type check_for_short_option(const char* optstring, const char* str)
{
	assert(optstring);
	assert(str);

	size_t olen = strlen(optstring);
	size_t slen = strlen(str);

	if (!olen || !slen)
		return opt_not_found;

	char sym = str[0];
	for (size_t i = 0; i < olen; i++) { // loop for all options in optstring
		if (optstring[i] != ':' && optstring[i] == sym) {
			// ok, we found option...
			// let's check is it valid?
			if (optstring[i + 1] != ':') {
				// single option... just return...
				return opt_single;
			}
			else if (optstring[i + 1] == ':' && optstring[i + 2] != ':') {
				// mandatory argument
				if (str[1]) // value of arg is in same argv
					return opt_inplace_arg;
				else // else next arg is value of option
					return opt_has_arg;
			}
			else {
				// if(optstring[i+1] == ':' && optstring[i+2] == ':')
				// optional argument
				if (str[1]) // value of arg is in same argv
					return opt_inplace_arg;
				else // else optional argument is absent
					return opt_single;
			}
		}
	}

	return opt_not_found;
}

// this function tries to detect long option entry in string
static opt_type check_for_long_option(const struct option *longopts, int *longindex,
	const char* str, const char*& arg)
{
	assert(longindex);
	assert(str);

	arg = 0;

	if (!longopts)
		return opt_not_found;

	// looking for '=' in string...
	int i;
	for (i = 0; str[i] && str[i] != '='; i++);
	assert(str[i] == '=' || !str[i]);

	int len = i; // len used for detecting length of option name in string

	if (str[i] == '=' && str[i + 1]) // ok, symbol '=' detected...
		arg = str + i + 1; // set potential option name substring length

	// detecting the nearest option name to string
	int index = 1;
	const char* opt = longopts->name;

	if (!opt)
		return opt_not_found;

	int diff = string_diff(opt, str, len);
	int selected = diff >= 0 ? 0 : -1;
	bool ambiguous = false;

	while (longopts[index].name) {
		opt = longopts[index].name;

		int _diff = string_diff(opt, str, len);
		if (!_diff) {
			diff = 0;
			selected = index;
			break;
		}

		if (_diff > 0 && diff > 0)
			ambiguous = true; // detected 2 or more options which are confirms string

		else if (_diff > 0 && (_diff < diff || diff < 0)) {
			diff = _diff;
			selected = index;
		}
		index++;
	}

	if (ambiguous && diff > 0) // if detected multiple confirms and no exact match - return error
		return opt_err_ambiguous;

	if (selected >= 0) {
		if (longopts[selected].has_arg == no_argument && arg) {
			return opt_err_no_arg; // argument is not required but specified
		}
		else if (longopts[selected].has_arg == no_argument /*&& !arg*/) {
			*longindex = index;
			return opt_single; // option without argument
		}
		else if (longopts[selected].has_arg == required_argument && arg) {
			*longindex = index;
			return opt_inplace_arg;
		}
		else if (longopts[selected].has_arg == required_argument) {
			*longindex = index;
			return opt_has_arg;
		}
		else if (longopts[selected].has_arg == optional_argument && arg) {
			*longindex = index;
			return opt_inplace_arg;
		}
		else if (longopts[selected].has_arg == optional_argument) {
			*longindex = index;
			return opt_single; // option without argument
		}
	}
	return opt_not_found;
}

// here stored all numbers of elements which should be placed at end of argv list
static int* swap_list = 0;
static int  swap_num = 0;

static void clear_swap()
{
	if (swap_list)
		free(swap_list);
	swap_list = 0;
	swap_num = 0;
}

// adding index to list
static void add_to_swap(int idx, int num = 1)
{
	assert(!swap_list && !swap_num || swap_list && swap_num);
	assert(num);

	if (!swap_num)
		swap_list = (int*)malloc(sizeof(*swap_list) * num);
	else
		swap_list = (int*)realloc(swap_list, sizeof(*swap_list) * (swap_num + num));
	assert(swap_list);

	for (int i = 0; i < num; i++)
		swap_list[swap_num + i] = idx + i;
	swap_num += num;
}

// swap values in array
// this function moves elements enumrated in swap_list to end of
// argv vector...
// arguments:
//   argc   - size of argv vector (used mostly for control of length,
//            to be sure that we are inside of vector)
//   argv   - vector to process
//   optind - bound of process... argv vector is processed in range 0..optind
static void swap_values(int argc, char** argv, int optind)
{
	assert(optind >= swap_num);
	assert(optind <= argc);

	int i; // index for original array
	int j; // index for temp array
	int k; // index for swap array

	int vals = min(argc, optind);

	char** tmp = (char**)malloc(vals * sizeof(*tmp));
	assert(tmp);

	for (i = j = k = 0; i < vals && j < vals; i++) {
		// copying all elements which NOT enumerated in swap_list array to temp array
		if(k >= swap_num || i != swap_list[k]) {
			tmp[j++] = argv[i];
		}
		else {// if index of element is in swap_list array - then just skip this element
		      // NOTE: swap_list array is SORTED, that is why we can to not run
		      //       throgh whole swap_list array in every iteration
			assert(k < swap_num);
			k++;
		}
	}

	// ok, now copy rest of array (skipped elements) to temp array
	for (k = 0; j < vals && k < swap_num; k++, j++) {
		assert(swap_list[k] < optind);
		assert(swap_list[k] < argc);
		tmp[j] = argv[swap_list[k]];
	}

	// and now save tmp array to argv
	for (i = 0; i < vals; i++)
		argv[i] = tmp[i];

	free(tmp);

	::optind -= swap_num;

	clear_swap();
}

// this function is called when we need to detect next option entry in argv
// return value:
//   true  - next option entry found, retval not used
//   false - no more options, retval - reason (-1 no more options, 1 - argument processed as default
//                                             option with code 1)
static bool detect_next_option(int argc, char* const argv[], const getopt_param& param, int& retval)
{
	if (!is_option(argv[optind])) {
		// if optind points to non-option - then check it...
		if (is_finish(argv[optind])) {
			// is it terminate sequence ('--')?
			optind++;
			if(!param.posix && !param.process_all)
				swap_values(argc, (char**)argv, optind);
			retval = -1;
			return false;
		}
		else if (param.process_all) {// processing all elements
			optarg = (char*)argv[optind];
			optind++;
			retval = 1;
			return false;
		}
		else if (param.posix) {
			retval = -1;
			return false;
		}
		else {
			int next_ind = look_for_option(argc, argv, optind);
			assert(next_ind != optind); // should not be same
			if (next_ind > 0) {
				add_to_swap(optind, next_ind - optind); // marking elements for swap
						    /* NOTE: in swap_list stored indexes of elements which are not
						    detected as options and not detected as arguments
						    (if argv[x] is detected as option - stsrts with '-',
						    it doesn't added to this list). later, when no more
						    element may be detected, these stored elements are moved
						    to end of argv vector */
				optind = next_ind;
			}
			else {// no more options found
				swap_values(argc, (char**)argv, optind);
				retval = -1;
				return false;
			}
		}

		if (is_finish(argv[optind])) {
			optind++;
			if (!param.posix && !param.process_all)
				swap_values(argc, (char**)argv, optind);
			retval = -1;
			return false;
		}
	}
	return true;
}

// this function is called when we are sure that option is short...
static int get_short_option(int argc, char* const argv[], const getopt_param& param)
{
	assert(argc);
	assert(argv);
	assert(nextchar);
	assert(optind < argc);

	const char* str = argv[optind] + nextchar;

	switch(check_for_short_option(param.optstring, str))
	{
	case opt_not_found:
		optopt = str[0];
		nextchar++;
		if (!argv[optind][nextchar]) {
			nextchar = 0;
			optind++;
		}
		if(!param.no_report)
			printf("%s: invalid option -- %c\n", argv[0], optopt);
		return '?';
	case opt_err_no_arg:
		// somethibg wrong... check_for_short_option can't
		// detect absent external parameter...
		assert(0);
		break;
	case opt_single:
		nextchar++;
		if (!argv[optind][nextchar]) {
			nextchar = 0;
			optind++;
		}
		return str[0];
	case opt_inplace_arg:
		optarg = (char*)str + 1;
		optind++;
		nextchar = 0;
		return str[0];
	case opt_has_arg:
		if(optind + 1 >= argc) {
			// error: option hasn't argument
			optopt = str[0];
			optind++;
			nextchar = 0;
			if(!param.no_report)
				printf("%s: option requires an argument -- %c\n", argv[0], optopt);
			return param.missing_arg;
		}
		else {
			optarg = (char*)argv[optind + 1];
			optind += 2;
			nextchar = 0;
			return str[0];
		}
	}

	// should not go here...
	assert(0);
	return -1;
}

static int get_long_option(int argc, char* const argv[], const getopt_param& param,
	const option* longopts, int* longindex)
{
	assert(argc);
	assert(argv);
	assert(!nextchar);
	assert(optind < argc);

	optopt = 0;
	*longindex = 0;

	const char* element = argv[optind]; // saving current argument for error message

	switch(check_for_long_option(longopts, longindex,
		argv[optind] + option_begin(argv[optind]),
		(const char*&)optarg))
	{
	case opt_not_found:
		if (!param.no_report)
			printf("%s: unrecognized option `%s'\n", argv[0], element);
		optind++;
		return '?';
	case opt_err_no_arg:
		if (!param.no_report)
			printf("%s: option `%s' doesn't allow an argument\n", argv[0], element);
		optind++;
		return '?';
	case opt_has_arg:
		if (optind + 1 >= argc) {
			optind++;
			if (!param.no_report)
				printf("%s: option `%s' requires an argument\n", argv[0], element);
			*longindex = 0;
			return param.missing_arg;
		}
		optarg = (char*)(argv[optind + 1]);
		optind++;
		// here should NOT be break because here is same return method
	case opt_single:
	case opt_inplace_arg:
		optind++;
		if (longopts[*longindex].flag) {
			*longopts[*longindex].flag = longopts[*longindex].val;
			return 0;
		}
		else {
			return longopts[*longindex].val;
		}
	case opt_err_ambiguous:
		optind++;
		if (!param.no_report)
			printf("%s: option `%s' is ambiguous\n", argv[0], element);
		return '?';
	}

	assert(0); // should not be here...
	return -1;
}

static int get_long_short_option(int argc, char* const argv[], const getopt_param& param,
	const option* longopts, int* longindex)
{
	assert(argc);
	assert(argv);
	assert(!nextchar);
	assert(optind < argc);

	optopt = 0;
	*longindex = 0;

	const char* element = argv[optind]; // saving current argument for error message

	opt_type ltype = check_for_long_option(longopts, longindex,
		argv[optind] + option_begin(argv[optind]),
		(const char*&)optarg);
	opt_type stype = check_for_short_option(param.optstring,
		argv[optind] + option_begin(argv[optind]));

	if (ltype == opt_not_found && stype == opt_not_found) {
		if(!param.no_report)
			printf("%s: unrecognized option `%s'\n", argv[0], element);
		optind++;
		return '?';
	}
	else if (ltype != opt_not_found) {
		return get_long_option(argc, argv, param, longopts, longindex);
	}
	else {//if(stype != opt_not_found)
		nextchar = short_option_begin(argv[optind]);
		return get_short_option(argc, argv, param);
	}
}

int getopt(int argc, char* const argv[], const char *optstring)
{
	if (!argc || !argv || !optstring)
		return -1;

	getopt_param param = scan_param(optstring);

	if (optind >= argc) {
		if (!param.posix && !param.process_all)
			swap_values(argc, (char**)argv, optind);
		return -1;
	}

	optarg = 0;

	if (!nextchar) {// we are in begin of argument... no previous iterations on this arg
		int retval;
		if (!detect_next_option(argc, argv, param, retval))
			return retval;
		nextchar = short_option_begin(argv[optind]);
	}

	return get_short_option(argc, argv, param);
}

int getopt_long(int argc, char * const argv[],
	const char *optstring,
	const struct option *longopts, int *longindex)
{
	if (!argc || !argv)
		return -1;

	getopt_param param = scan_param(optstring ? optstring : "");

	if (optind >= argc) {
		if (!param.posix && !param.process_all)
			swap_values(argc, (char**)argv, optind);
		return -1;
	}

	optarg = 0;

	if (!nextchar) {// we are in begin of argument... no previous iterations on this arg
		int retval;
		if (!detect_next_option(argc, argv, param, retval))
			return retval;

		const char* str = argv[optind];
		if (is_long_option(str)) {
			int _longindex;
			if(!longindex) // if no longindex specified - create own temp...
				longindex = &_longindex;
			return get_long_option(argc, argv, param, longopts, longindex);
		}
		else if(is_short_option(str)) {
			nextchar = short_option_begin(str);
		}
	}

	return get_short_option(argc, argv, param);
}

int getopt_long_only(int argc, char * const argv[],
	const char *optstring,
	const struct option *longopts, int *longindex)
{
	if (!argc || !argv)
		return -1;

	getopt_param param = scan_param(optstring ? optstring : "");

	if (optind >= argc) {
		if (!param.posix && !param.process_all)
			swap_values(argc, (char**)argv, optind);
		return -1;
	}

	optarg = 0;

	if (!nextchar) {// we are in begin of argument... no previous iterations on this arg
		int retval;
		if (!detect_next_option(argc, argv, param, retval))
			return retval;

		const char* str = argv[optind];
		if (is_long_option(str)) {
			int _longindex;
			if (!longindex) // if no longindex specified - create own temp...
				longindex = &_longindex;
			return get_long_option(argc, argv, param, longopts, longindex);
		}
		else if (is_short_option(str)) {
			return get_long_short_option(argc, argv, param, longopts, longindex);
		}
	}

	return get_short_option(argc, argv, param);
}