command_line.h

Go to the documentation of this file.

#ifndef COMMAND_LINE_CLASS
#define COMMAND_LINE_CLASS
 
/*****************************************************************************\
*                                                                             *
* Name   : command_line                                                       *
* Author : Chris Koeritz                                                      *
*                                                                             *
*******************************************************************************
* Copyright (c) 1992-$now By Author.  This program is free software; you can  *
* redistribute it and/or modify it under the terms of the GNU General Public  *
* License as published by the Free Software Foundation; either version 2 of   *
* the License or (at your option) any later version.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/
 
#include <basis/contracts.h>
#include <filesystem/filename.h>
 
namespace application {
 
 
// forward declarations.
class internal_cmd_line_array_of_parms;
 
class command_parameter : public virtual basis::root_object
{
public:
  enum parameter_types { VALUE, CHAR_FLAG, STRING_FLAG, BOGUS_ITEM };
 
  command_parameter(parameter_types type = BOGUS_ITEM);
 
  command_parameter(parameter_types type, const basis::astring &text);
 
  command_parameter(const command_parameter &to_copy);
 
  ~command_parameter();
 
  DEFINE_CLASS_NAME("command_parameter");
 
  command_parameter &operator =(const command_parameter &to_copy);
 
  parameter_types type() const { return _type; }
  void type(parameter_types new_type) { _type = new_type; }
 
  const basis::astring &text() const;
  void text(const basis::astring &new_text);
 
private:
  parameter_types _type;
  basis::astring *_text;
};
 
 
class command_line
{
public:
  command_line(int argc, char *argv[]);
 
  command_line(const basis::astring &to_parse);
 
  virtual ~command_line();
 
  DEFINE_CLASS_NAME("command_line");
 
  filesystem::filename program_name() const;
 
  static void separate_command_line(const basis::astring &cmd_line, basis::astring &app,
          basis::astring &parms);
 
  int entries() const;
 
  const command_parameter &get(int field) const;
 
  bool zap(int field);
 
  // note: in the following, if "case_sense" is true, then the searches are
  //       case-sensitive.  otherwise, case of the flags is not a concern.
  //       the returned values always retain the original case.
 
  bool find(char option_character, int &index, bool case_sense = true) const;
 
  bool find(const basis::astring &option_string, int &index,
          bool case_sense = true) const;
 
  bool get_value(char option_character, basis::astring &value,
          bool case_sense = true) const;
 
  bool get_value(const basis::astring &option_string, basis::astring &value,
          bool case_sense = true) const;
 
//is this useful?  it's kind of like what we need for special flags (like
//  -fgob.h, where gob.h is a value parameter) but needs to terminate
//differently for that to work.
  basis::astring gather(int &index) const;
 
  basis::astring text_form() const;
 
  static structures::string_array get_command_line();
 
private:
  internal_cmd_line_array_of_parms *_implementation;  
  filesystem::filename *_program_name;  
 
  void parse_string_array(const structures::string_array &to_parse);
 
  // forbidden:
  command_line(const command_line &to_copy);
  command_line &operator =(const command_line &to_copy);
 
  static const command_parameter &cmdline_blank_parm();
};
 
 
// this declares a program-wide command-line argument storage area.
 
extern int _global_argc;
extern char **_global_argv;
#define DEFINE_ARGC_AND_ARGV int _global_argc = 0; char **_global_argv = NULL_POINTER
 
#define SET_ARGC_ARGV(argc, argv) { \
  application::_global_argc = argc; \
  application::_global_argv = argv; \
}
 
} //namespace.
 
#endif