ArArgumentParser.h

/*
MobileRobots Advanced Robotics Interface for Applications (ARIA)
Copyright (C) 2004, 2005 ActivMedia Robotics LLC
Copyright (C) 2006, 2007 MobileRobots Inc.

     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 program is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.

     You should have received a copy of the GNU General Public License
     along with this program; if not, write to the Free Software
     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

If you wish to redistribute ARIA under different terms, contact 
MobileRobots for information about a commercial version of ARIA at 
robots@mobilerobots.com or 
MobileRobots Inc, 19 Columbia Drive, Amherst, NH 03031; 800-639-9481
*/

#ifndef ARARGUMENTPARSER_H
#define ARARGUMENTPARSER_H

#include "ariaTypedefs.h"
#include "ArArgumentBuilder.h"


class ArArgumentParser
{
public:
  AREXPORT ArArgumentParser(int *argc, char **argv);
  AREXPORT ArArgumentParser(ArArgumentBuilder *builder);
  AREXPORT ~ArArgumentParser();
  AREXPORT bool checkArgument(const char *argument);
  AREXPORT char *checkParameterArgument(char *argument, 
                    bool returnFirst = false);
  AREXPORT bool checkParameterArgumentString(char *argument, 
                         const char **dest, 
                         bool *wasReallySet = NULL,
                         bool returnFirst = false);
  AREXPORT bool checkParameterArgumentInteger(char *argument, int *dest,
                          bool *wasReallySet = NULL, 
                          bool returnFirst = false);
  AREXPORT bool checkParameterArgumentBool(char *argument, bool *dest,
                       bool *wasReallySet = NULL,
                       bool returnFirst = false);
  AREXPORT bool checkParameterArgumentFloat(char *argument, float *dest, 
                bool *wasReallySet = NULL, bool returnFirst = false);
  AREXPORT void addDefaultArgument(const char *argument, int position = -1);
  AREXPORT void loadDefaultArguments(int positon = 1);
  AREXPORT bool checkHelpAndWarnUnparsed(unsigned int numArgsOkay = 0);
  AREXPORT size_t getArgc(void) const;
  AREXPORT char** getArgv(void) const;
  AREXPORT const char* getArg(size_t whichArg) const;
  AREXPORT void log(void) const;
  AREXPORT void removeArg(size_t which);
  AREXPORT static void addDefaultArgumentFile(const char *file);
  AREXPORT static void addDefaultArgumentEnv(const char *env);
  AREXPORT static void logDefaultArgumentLocations(void);
#ifndef SWIG

  AREXPORT bool checkArgumentVar(char *argument, ...);
  AREXPORT char *checkParameterArgumentVar(char *argument, ...);
  AREXPORT bool checkParameterArgumentStringVar(bool *wasReallySet, 
                        const char **dest, 
                        char *argument, ...);
  AREXPORT bool checkParameterArgumentBoolVar(bool *wasReallySet, bool *dest,
                          char *argument, ...);
  AREXPORT bool checkParameterArgumentIntegerVar(bool *wasReallySet, int *dest,
                         char *argument, ...);
#endif
protected:
  static std::list<std::string> ourDefaultArgumentLocs;
  static std::list<bool> ourDefaultArgumentLocIsFile;
  bool myOwnBuilder;
  ArArgumentBuilder *myBuilder;
  bool myUsingBuilder;
  char **myArgv;
  int *myArgc;
  char myEmptyArg[1];
};


#endif // ARARGUMENTPARSER_H

---