niftkCommandLineParser.h

Go to the documentation of this file.

/*=============================================================================

  NifTK: A software platform for medical image computing.

  Copyright (c) University College London (UCL). All rights reserved.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.

  See LICENSE.txt in the top level directory for details.

=============================================================================*/

#ifndef niftkCommandLineParser_h
#define niftkCommandLineParser_h

#include <NifTKConfigure.h>
#include "niftkCommonWin32ExportHeader.h"

#include <ostream>
#include <stdio.h>
#include <string>

namespace niftk
{


/* For use in flag argument of printhelp() */
#define HLP_BRIEF 0x0000
#define HLP_VERBOSE 0x0001


struct CommandLineArgumentDescription {
  int type;     
  const char *key;    
  const char *parm;   
  const char *helpmsg;    
};

/* type field takes the following arguments. */

#define OPT_TYPEMASK 0x00ff /* Mask type of opt. */



#define OPT_SWITCH   0x0000 
#define OPT_INT      0x0001 
#define OPT_FLOAT    0x0002 
#define OPT_STRING   0x0003 
#define OPT_VARIANT  0x0004 
#define OPT_MULT     0x0005 
#define OPT_DOUBLE   0x0006 
#define OPT_LONG     0x0007 
#define OPT_INTx2    0x0008 
#define OPT_INTx3    0x0009 
#define OPT_INTx4    0x000a 
#define OPT_FLOATx2  0x000b 
#define OPT_FLOATx3  0x000c 
#define OPT_FLOATx4  0x000d 
#define OPT_DOUBLEx2 0x000e 
#define OPT_DOUBLEx3 0x000f 
#define OPT_DOUBLEx4 0x0010 
#define OPT_DONE (~0)   




#define OPT_CHARBCK  0x0800 
#define OPT_UNIQUE   0x1000 
#define OPT_LONELY   0x2000 
#define OPT_REQ      0x4000 
#define OPT_NIN      0x8000 
#define OPT_MORETYPE 0x0011 


#define OPT_MORE (OPT_MORETYPE | OPT_LONELY)




union ad {
  long along;
  double afloat;
  char *astr;
  int *mult;
  int *pint;
  float *pfloat;
  double *pdouble;
};

struct ml {
  struct ml *next;
  struct CommandLineArgumentDescription *opt;
  int num;
  union ad data;
};

#define ML_END (~0)

class NIFTKCOMMON_WINEXPORT CommandLineParser {

public:

  CommandLineParser(int argc, char *argv[],
        struct CommandLineArgumentDescription *clArgList, bool flgVerbose);

  ~CommandLineParser();                  

  CommandLineParser(const CommandLineParser &source);

  void PrintUsage(void) {PrintHelp(m_OptionList->opt, HLP_VERBOSE);}

  int GetArgument(int, void *);

  int GetArgument(int, bool &value);
  int GetArgument(int, unsigned int &value);
  int GetArgument(int, int &value);
  int GetArgument(int, int *&value);
  int GetArgument(int, float &value);
  int GetArgument(int, float *&value);
  int GetArgument(int, double &value);
  int GetArgument(int, double *&value);
  int GetArgument(int, char *&value);
  int GetArgument(int, std::string &value);
  int GetArgument(int, long int &value);
  
private:

  int m_Argc;
  char **m_Argv;

  char *m_ProgramName;

  struct ml *m_OptionList;    

  int m_flgVerbose;

  void PrintHelp(struct CommandLineArgumentDescription *clArgList, int flag);

  struct ml *ParseArguments(int argc, char *argv[],
          struct CommandLineArgumentDescription *clArgList);

  void FreeArguments(struct ml *mlist);

  int MakeOption(char *str, struct CommandLineArgumentDescription *opt, int *delayed);
  void ParseStandardArguments(char *key, struct CommandLineArgumentDescription *optlist);
  void ReadParameter(char *argv[], int arg, int type, struct ml *ml);

  struct ml *allocmlist(struct CommandLineArgumentDescription *);
  struct ml *locateml(struct ml *, struct CommandLineArgumentDescription *);
  struct ml *createml(struct ml *, struct CommandLineArgumentDescription *);
  int incarg(int, int);
  void chknotopt(char *argv[], int arg);
  int *get_intx2(char *str);
  int *get_intx3(char *str);
  int *get_intx4(char *str);
  float *get_floatx2(char *str);
  float *get_floatx3(char *str);
  float *get_floatx4(char *str);
  double *get_doublex2(char *str);
  double *get_doublex3(char *str);
  double *get_doublex4(char *str);
  void errmsg(const char *s, ...);
  void DumpInfoMessage(struct ml *mlptr, const char *argDesc, std::string value);
  void dumpmlist(void);
  void dumpmlptr(struct ml *mlptr);
};
  
} // end namespace niftk

#endif