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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef CSV_COMMANDLINE_HXX
#define CSV_COMMANDLINE_HXX
#include <cosv/string.hxx>
namespace csv
{
/** Does the standards in handling command line parameters.
This class provides a default behaviour this way:
* Each option can have several forms
like: "-f" and "--file"
which are identified by having the same id.
The option id is used when calling ->do_HandleOption().
* For each recognized option together with its parameters
->do_HandleOption() is called.
* For the first unrecognized argument ->do_HandleFreeArgument() is
called.
After the first unrecognized argument, ->do_HandleFreeArgument()
is called for all remaining arguments.
@howtoderive
- Overwrite ->do_HandleOption() to act on all known options.
Overwrite ->do_HandleFreeArgument() to act on additional
arguments not connected to an option.
*/
class CommandLine
{
public:
// LIFECYCLE
virtual ~CommandLine() {}
// OPERATIONS
bool Interpret(
int argc,
char * argv[] );
// INQUIRY
const StringVector &
Arguments() const;
bool IsOk() const;
protected:
CommandLine();
void Add_Option(
intt i_id,
String i_text );
void Set_Error();
private:
// public for use by struct commandline.cxx-anonymous::FindOptionByText;
struct OptionDescription
{
intt nId;
String sText;
OptionDescription(
intt i_id,
String i_text );
}; private:
struct FindOptionByText;
typedef std::vector<OptionDescription> OptionList;
typedef std::vector<StringVector::const_iterator> StringCIteratorList;
typedef std::vector<intt> OptionIdList;
// Locals
void Get_Arguments(
int argc,
char * argv[] );
intt Find_Option(
const String & i_text ) const;
bool Store_Argument(
const String & i_arg );
void Find_OptionPoints();
void Handle_FreeArguments(
StringVector::const_iterator
i_begin,
StringVector::const_iterator
i_end );
// Helpers for options included via file
bool Try2Include_Options(
const String & i_optionsFile );
bool Include_Options(
const String & i_optionsFile );
bool Load_Options(
StreamStr & o_text,
const String & i_optionsFile );
/** Handles an option found in the command line.
Needs to be overwritten.
@return
The first argument within the range
i_next_argument .. i_comandLine_end that does not belong as a
parameter to the handled option.
*/
virtual StringVector::const_iterator
do_HandleOption(
intt i_id,
StringVector::const_iterator
i_paramsBegin,
StringVector::const_iterator
i_paramsEnd ) = 0;
/** Handles arguments on the command line that do not belong to
an option.
*/
virtual void do_HandleFreeArgument(
const String & i_argument ) = 0;
// DATA
OptionList aOptions;
/// Used during and after ->GetArguments()
StringVector aCommandLine;
StringCIteratorList aOptionPoints;
OptionIdList aOptionIds;
bool bIsOk;
};
inline const StringVector &
CommandLine::Arguments() const
{
return aCommandLine;
}
inline bool
CommandLine::IsOk() const
{
return bIsOk;
}
inline void
CommandLine::Set_Error()
{
bIsOk = false;
}
} // namespace csv
#endif
|
