File: CSCommandLineParser.h

package info (click to toggle)
unar 1.1-2
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 6,664 kB
  • sloc: ansic: 52,939; objc: 39,563; cpp: 4,074; makefile: 99; perl: 10
file content (98 lines) | stat: -rw-r--r-- 4,515 bytes parent folder | download
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
#import <Foundation/Foundation.h>

@interface CSCommandLineParser:NSObject
{
	NSMutableDictionary *options;
	NSMutableArray *optionordering;
	NSMutableArray *alwaysrequiredoptions;

	NSArray *remainingargumentarray;

	NSString *programname,*usageheader,*usagefooter;
}

-(id)init;
-(void)dealloc;

-(void)setProgramName:(NSString *)name;
-(void)setUsageHeader:(NSString *)header;
-(void)setUsageFooter:(NSString *)footer;

-(void)addStringOption:(NSString *)option
description:(NSString *)description;
-(void)addStringOption:(NSString *)option defaultValue:(NSString *)defaultvalue
description:(NSString *)description;
-(void)addStringOption:(NSString *)option
description:(NSString *)description argumentDescription:(NSString *)argdescription;
-(void)addStringOption:(NSString *)option defaultValue:(NSString *)defaultvalue
description:(NSString *)description argumentDescription:(NSString *)argdescription;
-(void)addMultipleChoiceOption:(NSString *)option allowedValues:(NSArray *)allowedvalues
description:(NSString *)description;
-(void)addMultipleChoiceOption:(NSString *)option allowedValues:(NSArray *)allowedvalues defaultValue:(NSString *)defaultvalue
description:(NSString *)description;
-(void)addMultipleChoiceOption:(NSString *)option allowedValues:(NSArray *)allowedvalues
description:(NSString *)description argumentDescription:(NSString *)argdescription;
-(void)addMultipleChoiceOption:(NSString *)option allowedValues:(NSArray *)allowedvalues defaultValue:(NSString *)defaultvalue
description:(NSString *)description argumentDescription:(NSString *)argdescription;

-(void)addIntegerOption:(NSString *)option
description:(NSString *)description;
-(void)addIntegerOption:(NSString *)option
description:(NSString *)description argumentDescription:(NSString *)argdescription;
-(void)addIntegerOption:(NSString *)option defaultValue:(int)defaultvalue
description:(NSString *)description;
-(void)addIntegerOption:(NSString *)option defaultValue:(int)defaultvalue
description:(NSString *)description argumentDescription:(NSString *)argdescription;

-(void)addFloatingPointOption:(NSString *)option
description:(NSString *)description;
-(void)addFloatingPointOption:(NSString *)option
description:(NSString *)description argumentDescription:(NSString *)argdescription;
-(void)addFloatingPointOption:(NSString *)option defaultValue:(double)defaultvalue
description:(NSString *)description;
-(void)addFloatingPointOption:(NSString *)option defaultValue:(double)defaultvalue
description:(NSString *)description argumentDescription:(NSString *)argdescription;

-(void)addSwitchOption:(NSString *)option description:(NSString *)description;

-(void)addHelpOption;
-(void)addHelpOptionNamed:(NSString *)helpoption description:(NSString *)description;

-(void)addAlias:(NSString *)alias forOption:(NSString *)option;

-(void)addRequiredOption:(NSString *)requiredoption;
-(void)addRequiredOptionsArray:(NSArray *)requiredoptions;
-(void)addRequiredOption:(NSString *)requiredoption forOption:(NSString *)option;
-(void)addRequiredOptionsArray:(NSArray *)requiredoptions forOption:(NSString *)option;

-(BOOL)parseCommandLineWithArgc:(int)argc argv:(const char **)argv;
-(BOOL)parseArgumentArray:(NSArray *)arguments;

-(void)_parseArguments:(NSArray *)arguments remainingArguments:(NSMutableArray *)remainingarguments
errors:(NSMutableArray *)errors;
-(void)_parseOptionWithDictionary:(NSMutableDictionary *)dict type:(NSString *)type
name:(NSString *)option value:(NSString *)value errors:(NSMutableArray *)errors;
-(void)_setDefaultValues;
-(void)_parseRemainingArguments:(NSArray *)remainingarguments errors:(NSMutableArray *)errors;
-(void)_enforceRequirementsWithErrors:(NSMutableArray *)errors;
-(void)_requireOptionsInArray:(NSArray *)requiredoptions when:(NSString *)when errors:(NSMutableArray *)errors;
-(BOOL)_isOptionDefined:(NSString *)option;
-(NSString *)_describeOption:(NSString *)name;
-(NSString *)_describeOptionAndArgument:(NSString *)name;
-(void)_reportErrors:(NSArray *)errors;

-(void)printUsage;

-(NSString *)stringValueForOption:(NSString *)option;
-(NSArray *)stringArrayValueForOption:(NSString *)option;
-(int)intValueForOption:(NSString *)option;
-(float)floatValueForOption:(NSString *)option;
-(double)doubleValueForOption:(NSString *)option;
-(BOOL)boolValueForOption:(NSString *)option;

-(NSArray *)remainingArguments; // TODO: figure out something better than this.

-(void)_assertOptionNameIsUnique:(NSString *)option;
-(void)_raiseUnknownOption:(NSString *)option;

@end