//--------------------------------------------------------------------
// $Id: GetOpt.hpp 4570 2004-07-05 21:57:23Z cjm $
//--------------------------------------------------------------------
//
//   Free GetOpt
//   Copyright 2000 by Christopher J. Madsen
//   See GetOpt.cpp for license information
//
//   Process command line arguments
//
//--------------------------------------------------------------------

#ifndef INCLUDED_GETOPT_HPP
#define INCLUDED_GETOPT_HPP

class GetOpt
{
 public:
  struct Option;
  enum Connection { nextArg, withEquals, adjacent     };
  enum Flag       { needArg = 0x01, repeatable = 0x02 };
  enum Found      { notFound, noArg, withArg          };
  enum Type       { optArg, optLong, optShort         };
  typedef bool (ArgFunc)(GetOpt* getopt, const Option* option,
                         const char* asEntered,
                         Connection connected, const char* argument,
                         int* usedChars);
  typedef void (ErrorFunc)(const char* option, const char* message);

  struct Option
  {
    char         shortName;
    const char*  longName;
    Found*       found;
    unsigned     flag;
    ArgFunc*     function;
    void*        data;
  }; // end GetOpt::Option

  bool           error;
  ErrorFunc*     errorOutput;
  const char*    optionStart;

 protected:
  const Option*  optionList;
  int            argc;
  int            argi, chari;
  const char**   argv;
  bool           normalOnly;
  const Option*  returningAll;
  char           shortOptionBuf[3];

 public:
  explicit GetOpt(const Option* aList);
  void  init(int theArgc, const char** theArgv);
  int   currentArg() const { return argi; };
  bool  nextOption(const Option*& option, const char*& asEntered);
  int   process(int theArgc, const char** theArgv);
  void  reportError(const char* option, const char* message);

  // Standard callback functions:
#ifndef GETOPT_NO_STDIO
  static void  printError(const char* option, const char* message);
#endif
  static bool  isFloat(GetOpt* getopt, const Option* option,
                       const char* asEntered,
                       Connection connected, const char* argument,
                       int* usedChars);
  static bool  isLong(GetOpt* getopt, const Option* option,
                      const char* asEntered,
                      Connection connected, const char* argument,
                      int* usedChars);
  static bool  isString(GetOpt* getopt, const Option* option,
                        const char* asEntered,
                        Connection connected, const char* argument,
                        int* usedChars);

 protected:
  void  checkReturnAll();
  const Option*  findShortOption(char option) const;
  const Option*  findLongOption(const char* option);
  bool  nextOption(const char*& option, Type& type, int& posArg);
}; // end GetOpt

#endif // INCLUDED_GETOPT_HPP