COptionParser.h

Go to the documentation of this file.

// Begin CVS Header
//   $Source: /Volumes/Home/Users/shoops/cvs/copasi_dev/copasi/commandline/COptionParser.h,v $
//   $Revision: 1.26 $
//   $Name:  $
//   $Author: shoops $
//   $Date: 2012/06/01 17:25:01 $
// End CVS Header

// Copyright (C) 2012 by Pedro Mendes, Virginia Tech Intellectual
// Properties, Inc., University of Heidelberg, and The University
// of Manchester.
// All rights reserved.

/*
 * This file was automaticly generated by clo++ version 0.6.4 (REL-0_6_4)
 * http://pmade.org/pjones/software/clo++/
 *
 * Template enhancements by Stefan Hoops mailto:shoops@vt.edu
 */

/**
 * This is the main header file (COptionParser.h).
 * You can control the name of this header file using the
 * cxx_header_file variable.
 */

// you can control the include guard
// name with the cxx_header_def variable
#ifndef COPASI_COptionParser
#define COPASI_COptionParser

// standard includes
#include <stdexcept>
#include <string>
#include <vector>

/// the namespace can be controlled using the cxx_namespace variable
namespace copasi
{
/**
 * a list of autothrow ids for the autoexcept exception class
 * so that you know which option caused the exception.
 */
enum autothrow
{
  autothrow_help
};

enum SBMLSchema_enum
{
  SBMLSchema_L1V1,
  SBMLSchema_L1V2,
  SBMLSchema_L2V1,
  SBMLSchema_L2V2,
  SBMLSchema_L2V3,
  SBMLSchema_L2V4,
  SBMLSchema_L3V1
};

/**
 * the following struct is used to hold the values of
 * the options. It has a constructor that sets all the option
 * values to their default value.
 */
struct options
{
  options(void) :
      License(false),
      MaxTime(0),
      NoLogo(false),
      SBMLSchema(SBMLSchema_L2V4),
      Validate(false),
      Verbose(false)
  {}
  std::string     ConfigDir;
  std::string     ConfigFile;
  std::string     CopasiDir;
  std::string     ExportBerkeleyMadonna;
  std::string     ExportC;
  std::string     ExportSBML;
  std::string     ExportXPPAUT;
  std::string     Home;
  std::string     ImportSBML;
  bool     License;
  int     MaxTime;
  bool     NoLogo;
  SBMLSchema_enum     SBMLSchema;
  std::string     Save;
  std::string     Tmp;
  bool     Validate;
  bool     Verbose;
#ifdef COPASI_SEDML
  std::string     ImportSEDML;
#endif
}; // end options struct

/**
 * the following struct is used to record the location
 * on the command line where the option was found.
 */
struct option_locations
{
  typedef int size_type;
  size_type ConfigDir;
  size_type ConfigFile;
  size_type CopasiDir;
  size_type ExportBerkeleyMadonna;
  size_type ExportC;
  size_type ExportSBML;
  size_type ExportXPPAUT;
  size_type Home;
  size_type ImportSBML;
  size_type License;
  size_type MaxTime;
  size_type NoLogo;
  size_type SBMLSchema;
  size_type Save;
  size_type Tmp;
  size_type Validate;
  size_type Verbose;
#ifdef COPASI_SEDML
  size_type ImportSEDML;
#endif
}; // end option location struct

/**
 * if there are any errors while parsing the command
 * line, the following class will be thrown.
 */
class option_error : public std::runtime_error
{
public:
  option_error(const std::string &what_arg)
      : runtime_error(what_arg) {}

  const char* get_help_comment(void) const;
};

/**
 * if any option that is a autothrow option is present
 * on the command line, this exception class will be
 * thrown when that option is parsed.
 */
class autoexcept : public option_error
{
public:
  // constructor
  autoexcept(autothrow id, const std::string &message)
      : option_error(message), autothrow_(id) {}

  /**
   * get the autothrow enum member for the autothrow
   * option that caused the exception.
   */
  autothrow get_autothrow_id(void) const
  {return autothrow_;}
private:
  autothrow autothrow_;
};

/**
 * the COptionParser class is the main command
 * line parsing class. You can control the name of it
 * using the cxx_class variable.
 */
class COptionParser
{
public:
  /// default constructor
  COptionParser(void);

  /// parse the command line
  void parse(int argc, char *argv[], bool call_finalize = true);

  /// parse a file
  void parse(const char * fileName);

  /// finalize all parsing (eg. check for mandatory options)
  void finalize(void);

  /// get a list of nonoptions from the command line
  const std::vector<std::string>& get_non_options(void) const
  {return non_options_;}

  /// get the main options
  const options& get_options(void) const
  {return options_;}

  /// get the main option locations
  const option_locations& get_locations(void) const
  {return locations_;}
private:
  options options_;
  option_locations locations_;

  enum options_enum
  {
    option_ConfigDir,
    option_ConfigFile,
    option_CopasiDir,
    option_Home,
    option_Tmp,
    option_Verbose,
    option_NoLogo,
    option_License,
    option_Validate,
    option_Save,
    option_ImportSBML,
    option_ExportSBML,
    option_SBMLSchema,
    option_ExportBerkeleyMadonna,
    option_ExportC,
    option_ExportXPPAUT,
    option_MaxTime

#ifdef COPASI_SEDML
   , option_ImportSEDML
#endif
  } openum_;

  enum parser_state {state_option, state_value, state_consume } state_;
  std::vector<std::string> non_options_;

  enum opsource
  {
    source_cl,
    source_cf
  };
  void parse_element(const char *element, int position, opsource source);
  void parse_short_option(char option, int position, opsource source);
  void parse_long_option(const char *option, int position, opsource source);
  void parse_value(const char *value);
}; // end copasi::COptionParser class
} // end copasi namespace
#endif // COPASI_COptionParser