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 "opsysdll.h"

#include <basis/object_base.h>

// forward:
class filename;
class internal_cmd_line_array_of_parms;


class OPSYSTEM_CLASS_STYLE command_parameter
: public virtual object_base
{
public:
  enum parameter_types { VALUE, CHAR_FLAG, STRING_FLAG, BOGUS_ITEM };

  command_parameter(parameter_types type = BOGUS_ITEM);

  command_parameter(parameter_types type, const istring &text);

  command_parameter(const command_parameter &to_copy);

  ~command_parameter();

  IMPLEMENT_CLASS_NAME("command_parameter");

  command_parameter &operator =(const command_parameter &to_copy);

  inline parameter_types type() const { return _type; }
  inline void type(parameter_types new_type) { _type = new_type; }

  const istring &text() const;
  void text(const istring &new_text);

private:
  parameter_types _type;
  istring *_text;
};


class OPSYSTEM_CLASS_STYLE command_line
{
public:
  command_line(int argc, char *argv[]);

  command_line(const istring &to_parse);

  virtual ~command_line();

  IMPLEMENT_CLASS_NAME("command_line");

  filename program_name() const;

  static void separate_command_line(const istring &cmd_line, istring &app,
          istring &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 istring &option_string, int &index,
          bool case_sense = true) const;

  bool get_value(char option_character, istring &value,
          bool case_sense = true) const;

  bool get_value(const istring &option_string, istring &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.
  istring gather(int &index) const;

  istring text_form() const;

  static string_array get_command_line();

private:
  internal_cmd_line_array_of_parms *_implementation;  
  filename *_program_name;  

  void parse_string_array(const 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();
};

#endif

---