forked from dusty-nv/jetson-utils
-
Notifications
You must be signed in to change notification settings - Fork 0
/
commandLine.h
111 lines (95 loc) · 3.71 KB
/
commandLine.h
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
/*
* Copyright (c) 2017, NVIDIA CORPORATION. All rights reserved.
*
* 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, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* 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 AND 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.
*/
#ifndef __COMMAND_LINE_H_
#define __COMMAND_LINE_H_
#include <stdlib.h>
/**
* Command line parser class.
* @ingroup util
*/
class commandLine
{
public:
/**
* Constructor, takes the command line from `main()`
*/
commandLine( const int argc, char** argv );
/**
* Checks to see whether the specified flag was included on the
* command line. For example, if argv contained `--foo`, then
* `GetFlag("foo")` would return `true`
*
* @returns `true`, if the flag with argName was found
* `false`, if the flag with argName was not found
*/
bool GetFlag( const char* argName ) const;
/**
* Get float argument. For example if argv contained `--foo=3.14159`,
* then `GetInt("foo")` would return `3.14159f`
*
* @returns `defaultValue` if the argument couldn't be found. (`0.0` by default).
* Otherwise, returns the value of the argument.
*/
float GetFloat( const char* argName, float defaultValue=0.0f ) const;
/**
* Get integer argument. For example if argv contained `--foo=100`,
* then `GetInt("foo")` would return `100`
*
* @returns `defaultValue` if the argument couldn't be found (`0` by default).
* Otherwise, returns the value of the argument.
*/
int GetInt( const char* argName, int defaultValue=0 ) const;
/**
* Get string argument. For example if argv contained `--foo=bar`,
* then `GetString("foo")` would return `"bar"`
*
* @returns `defaultValue` if the argument couldn't be found (`NULL` by default).
* Otherwise, returns a pointer to the argument value string
* from the `argv` array.
*/
const char* GetString( const char* argName, const char* defaultValue=NULL ) const;
/**
* Get positional string argument. Positional arguments aren't named, but rather
* referenced by their index in the list. For example if the command line contained
* `my-program --foo=bar /path/to/my_file.txt`, then `GetString(0)` would return
* `"/path/to/my_file.txt"
*
* @returns `defaultValue` if the argument couldn't be found (`NULL` by default).
* Otherwise, returns a pointer to the argument value string
* from the `argv` array.
*/
const char* GetPosition( unsigned int position, const char* defaultValue=NULL ) const;
/**
* Get the number of positional arguments in the command line.
* Positional arguments are those that don't have a name.
*/
unsigned int GetPositionArgs() const;
/**
* The argument count that the object was created with from main()
*/
int argc;
/**
* The argument strings that the object was created with from main()
*/
char** argv;
};
#endif