1 /*****************************************************************************\
3 * Name : command_line *
4 * Author : Chris Koeritz *
6 *******************************************************************************
7 * Copyright (c) 1992-$now By Author. This program is free software; you can *
8 * redistribute it and/or modify it under the terms of the GNU General Public *
9 * License as published by the Free Software Foundation; either version 2 of *
10 * the License or (at your option) any later version. This is online at: *
11 * http://www.fsf.org/copyleft/gpl.html *
12 * Please send any updates to: fred@gruntose.com *
13 \*****************************************************************************/
15 #include "command_line.h"
17 #include <basis/functions.h>
18 #include <basis/astring.h>
19 #include <basis/mutex.h>
20 #include <configuration/application_configuration.h>
21 #include <filesystem/directory.h>
22 #include <filesystem/filename.h>
23 #include <structures/static_memory_gremlin.h>
24 #include <structures/string_array.h>
25 #include <textual/parser_bits.h>
26 #include <loggers/program_wide_logger.h>
29 #define LOG(s) CLASS_EMERGENCY_LOG(program_wide_logger::get(), s)
31 using namespace basis;
32 using namespace configuration;
33 using namespace filesystem;
34 using namespace loggers;
35 using namespace structures;
36 using namespace textual;
38 namespace application {
42 command_parameter::command_parameter(parameter_types type)
43 : _type(type), _text(new astring) {}
45 command_parameter::command_parameter(parameter_types type, const astring &text)
46 : _type(type), _text(new astring(text)) {}
48 command_parameter::command_parameter(const command_parameter &to_copy)
49 : _type(VALUE), _text(new astring)
52 command_parameter::~command_parameter() { WHACK(_text); }
54 const astring &command_parameter::text() const { return *_text; }
56 void command_parameter::text(const astring &new_text) { *_text = new_text; }
58 command_parameter &command_parameter::operator =
59 (const command_parameter &to_copy)
61 if (this == &to_copy) return *this;
62 _type = to_copy._type;
63 *_text = *to_copy._text;
69 // option_prefixes: the list of valid prefixes for options on a command line.
70 // these are the characters that precede command line arguments. For Unix,
71 // the default is a dash (-), while for DOS most programs use forward-slash
72 // (/). Adding more characters is trivial; just add a character to the list
73 // before the sentinel of '\0'.
74 #if defined(_MSC_VER) || defined(__MINGW32__)
75 static char option_prefixes[] = { '-', '/', '\0' };
76 #elif defined(__UNIX__)
77 static char option_prefixes[] = { '-', '\0' };
79 #error "I don't know what kind of operating system this is."
82 bool it_is_a_prefix_char(char to_test)
84 for (int i = 0; option_prefixes[i]; i++)
85 if (to_test == option_prefixes[i]) return true;
91 class internal_cmd_line_array_of_parms : public array<command_parameter> {};
95 SAFE_STATIC_CONST(command_parameter, command_line::cmdline_blank_parm, )
96 // our default return for erroneous indices.
98 command_line::command_line(int argc, char *argv[])
99 : _implementation(new internal_cmd_line_array_of_parms),
100 _program_name(new filename(directory::absolute_path(argv[0])))
102 argv++; // skip command name in argv.
104 // loop over the rest of the fields and examine them.
105 string_array string_list; // accumulated below.
107 astring to_store = argv[0]; // retrieve the current string.
108 string_list += to_store; // put the string in our list.
109 argv++; // next string.
111 parse_string_array(string_list);
114 command_line::command_line(const astring &full_line)
115 : _implementation(new internal_cmd_line_array_of_parms),
116 _program_name(new filename)
119 string_array string_list;
120 bool in_quote = false;
121 //hmmm: this is not quote right yet.
122 // use the separate command line method, but get it to run iteratively
123 // so we can keep pulling them apart? maybe it already does!
124 // separate is better because it handles escaped quotes.
125 for (int i = 0; i < full_line.length(); i++) {
126 char to_examine = full_line.get(i);
127 if (to_examine == '"') {
128 // it's a quote character, so maybe we can start eating spaces.
131 continue; // eat the quote character but change modes.
133 // nope, we're closing a quote. we assume that the quotes are
134 // around the whole argument. that's the best win32 can do at least.
136 to_examine = ' '; // trick parser into logging the accumulated string.
137 // intentional fall-through to space case.
140 if (parser_bits::white_space(to_examine)) {
141 // if this is a white space, then we start a new string.
142 if (!in_quote && accumulator.t()) {
143 // only grab the accumulator if there are some contents.
144 string_list += accumulator;
146 } else if (in_quote) {
147 // we're stuffing the spaces into the string since we're quoted.
148 accumulator += to_examine;
151 // not white space, so save it in the accumulator.
152 accumulator += to_examine;
155 if (accumulator.t()) string_list += accumulator;
156 // that partial string wasn't snarfed during the loop.
157 // grab the program name off the list so the parsing occurs as expected.
158 *_program_name = directory::absolute_path(string_list[0]);
159 string_list.zap(0, 0);
160 parse_string_array(string_list);
163 command_line::~command_line()
165 WHACK(_program_name);
166 WHACK(_implementation);
169 int command_line::entries() const { return _implementation->length(); }
171 filename command_line::program_name() const { return *_program_name; }
173 const command_parameter &command_line::get(int field) const
175 bounds_return(field, 0, entries() - 1, cmdline_blank_parm());
176 return _implementation->get(field);
179 void command_line::separate_command_line(const astring &cmd_line,
180 astring &app, astring &parms)
182 char to_find = ' '; // the command separator.
183 if (cmd_line[0] == '\"') to_find = '\"';
184 // if the first character is a quote, then we are seeing a quoted phrase
185 // and need to look for its completing quote. otherwise, we'll just look
186 // for the next space.
188 int seek_posn = 1; // skip the first character. we have accounted for it.
189 // skim down the string, looking for the ending of the first phrase.
190 while (seek_posn < cmd_line.length()) {
191 // look for our parameter separator. this will signify the end of the
192 // first phrase / chunk. if we don't find it, then it should just mean
193 // there was only one item on the command line.
194 int indy = cmd_line.find(to_find, seek_posn);
195 if (negative(indy)) {
196 // yep, there wasn't a matching separator, so we think this is just
197 // one chunk--the app name.
201 // now that we know where our separator is, we need to find the right
202 // two parts (app and parms) based on the separator character in use.
203 if (to_find == '\"') {
204 // we are looking for a quote character to complete the app name.
205 if (cmd_line[indy - 1] == '\\') {
206 // we have a backslash escaping this quote! keep seeking.
207 seek_posn = indy + 1;
210 app = cmd_line.substring(0, indy);
211 parms = cmd_line.substring(indy + 2, cmd_line.end());
212 // skip the quote and the obligatory space character after it.
215 // simple space handling here; no escapes to worry about.
216 app = cmd_line.substring(0, indy - 1);
217 parms = cmd_line.substring(indy + 1, cmd_line.end());
224 bool command_line::zap(int field)
226 bounds_return(field, 0, entries() - 1, false);
227 _implementation->zap(field, field);
231 // makes a complaint about a failure and sets the hidden commands to have a
232 // bogus entry so they aren't queried again.
233 #define COMPLAIN_CMDS(s) \
234 listo_cmds += "unknown"; \
237 string_array command_line::get_command_line()
239 FUNCDEF("get_command_line");
240 string_array listo_cmds;
241 // the temporary string below can be given a flat formatting of the commands
242 // and it will be popped out into a list of arguments.
245 if (!_global_argc || !_global_argv) {
246 // our global parameters have not been set, so we must calculate them.
247 temporary = application_configuration::get_cmdline_from_proc();
249 // we have easy access to command line arguments supposedly, so use them.
250 for (int i = 0; i < _global_argc; i++) {
251 // add a string entry for each argument.
252 listo_cmds += _global_argv[i];
254 // we don't need a long string to be parsed; the list is ready.
257 #elif defined(__WIN32__)
258 // we have easy access to the original list of commands.
259 for (int i = 0; i < _global_argc; i++) {
260 // add a string entry for each argument.
261 listo_cmds += _global_argv[i];
265 COMPLAIN_CMDS("this OS doesn't support getting the command line.");
269 // now that we have our best guess at a flat representation of the command
270 // line arguments, we'll chop it up.
272 //hmmm: this algorithm doesn't support spaces in filenames currently.
273 //hmmm: for windows, we can parse the quotes that should be around cmd name.
274 //hmmm: but for unix, the ps command doesn't support spaces either. how to
275 // get around that to support programs with spaces in the name?
278 while (posn < temporary.length()) {
279 posn = temporary.find(' ', posn);
280 if (non_negative(posn)) {
281 // found another space to turn into a portion of the command line.
282 listo_cmds += temporary.substring(last_posn + 1, posn - 1);
283 // grab the piece of string between the point just beyond where we
284 // last saw a space and the position just before the space.
285 last_posn = posn; // save the last space position.
286 posn++; // push the pointer past the space.
288 // no more spaces in the string. grab what we can from the last bit
289 // of the string that we see.
290 if (last_posn < temporary.length() - 1) {
291 // there's something worthwhile grabbing after the last place we
293 listo_cmds += temporary.substring(last_posn + 1,
294 temporary.length() - 1);
296 break; // we're done finding spaces.
303 astring command_line::text_form() const
306 const astring EOL = parser_bits::platform_eol_to_chars();
307 for (int i = 0; i < entries(); i++) {
308 const command_parameter &curr = get(i);
309 to_return += a_sprintf("%d: ", i + 1);
310 switch (curr.type()) {
311 case command_parameter::CHAR_FLAG:
312 to_return += astring("<char flag> ") + curr.text() + EOL;
314 case command_parameter::STRING_FLAG:
315 to_return += astring("<string flag> ") + curr.text() + EOL;
317 case command_parameter::VALUE: // pass through to default.
319 to_return += astring("<value> ") + curr.text() + EOL;
326 bool command_line::find(char option_character, int &index,
327 bool case_sense) const
329 astring opt(option_character, 1); // convert to a string once here.
330 if (!case_sense) opt.to_lower(); // no case-sensitivity.
331 for (int i = index; i < entries(); i++) {
332 //hmmm: optimize this too.
333 if (get(i).type() == command_parameter::CHAR_FLAG) {
334 bool success = (!case_sense && get(i).text().iequals(opt))
335 || (case_sense && (get(i).text() == opt));
337 // the type is appropriate and the value is correct as well...
346 bool command_line::find(const astring &option_string, int &index,
347 bool case_sense) const
350 if (option_string.length() && (option_string[0] == '-') )
351 LOG(astring("found option string with dash! string is: ") + option_string);
353 for (int i = index; i < entries(); i++) {
354 if (get(i).type() == command_parameter::STRING_FLAG) {
355 bool success = (!case_sense && get(i).text().iequals(option_string))
356 || (case_sense && (get(i).text() == option_string));
358 // the type is appropriate and the value is correct as well...
367 bool command_line::get_value(char option_character, astring &value,
368 bool case_sense) const
371 int posn = 0; // where we find the flag.
372 if (!find(option_character, posn, case_sense)) return false;
374 // get the value after the flag, if there is such.
375 posn++; // this is where we think our flag's value lives.
376 if (posn >= entries()) return false;
378 // there's still an entry after where we found our flag; grab it.
379 command_parameter cp = get(posn);
380 if (cp.type() != command_parameter::VALUE) return false;
382 // finally; we've found an appropriate text value.
387 bool command_line::get_value(const astring &option_string, astring &value,
388 bool case_sense) const
390 FUNCDEF("get_value");
391 if (option_string.length() && (option_string[0] == '-') )
392 LOG(astring("found option string with dash! string is: ") + option_string);
395 int posn = 0; // where we find the flag.
396 if (!find(option_string, posn, case_sense)) return false;
398 // get the value after the flag, if there is such.
399 posn++; // this is where we think our flag's value lives.
400 if (posn >= entries()) return false;
402 // there's still an entry after where we found our flag; grab it.
403 command_parameter cp = get(posn);
404 if (cp.type() != command_parameter::VALUE) return false;
406 // finally; we've found an appropriate text value.
411 void command_line::parse_string_array(const string_array &to_parse)
413 bool still_looking_for_flags = true; // goes to false when only values left.
414 // loop over the fields and examine them.
415 for (int i = 0; i < to_parse.length(); i++) {
416 // retrieve a character from the current string.
418 char c = to_parse[i].get(index++);
419 // we check whether it's a prefix character, and if so, what kind.
420 if (still_looking_for_flags && it_is_a_prefix_char(c)) {
421 // at least one prefix is there, so treat this as a flag.
422 bool gnu_type_of_flag = false;
423 if (it_is_a_prefix_char(to_parse[i].get(index))) {
424 // there's a special GNU double flag beginner.
425 index++; // skip that extra one.
426 if ( (index >= to_parse[i].length())
427 || parser_bits::white_space(to_parse[i].get(index))) {
428 // special case of '--' (or '//' i suppose) with white space or
429 // nothing else afterwards; indicates that the rest of the items
430 // should just be values, not flags.
431 still_looking_for_flags = false;
432 continue; // we ate that item.
434 gnu_type_of_flag = true;
436 // everything after the prefixes is considered part of the flag; they're
437 // either individual flag characters (on a single prefix) or they're the
438 // full name for the flag (gnu style).
439 c = 1; // reset to a true bool value.
440 astring gnu_accumulator; // if processing a gnu flag, it arrives here.
442 if (!gnu_type_of_flag) {
443 // add as many flag parameters as possible.
444 c = to_parse[i].get(index++);
445 // c will be zero once we hit the end of the string.
447 command_parameter to_add(command_parameter::CHAR_FLAG, astring(c, 1));
448 *_implementation += to_add;
451 // the gnu flag name is added to here.
452 c = to_parse[i].get(index++); // zero at end of string.
454 gnu_accumulator += c; // one more character.
457 if (gnu_accumulator.t()) {
458 // we've accumulated a gnu flag, so store it.
459 command_parameter to_add(command_parameter::STRING_FLAG,
461 *_implementation += to_add;
464 // add a value type of command_parameter.
465 astring found = to_parse[i];
466 command_parameter to_add(command_parameter::VALUE, found);
467 *_implementation += to_add;
472 astring command_line::gather(int &index) const
475 for (int i = index; i < entries(); i++) {
476 if (get(i).type() == command_parameter::CHAR_FLAG) {
479 } else to_return += get(i).text();
481 index = entries() - 1;