vpParseArgv.h

/****************************************************************************
 *
 * Declarations for Tk-related things that are visible
 * outside of the Tk module itself.
 *
 * Copyright 1989-1992 Regents of the University of California.
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies.  The University of California
 * makes no representations about the suitability of this
 * software for any purpose.  It is provided "as is" without
 * express or implied warranty.
 *
 * This file has been modified to be used only for argv parsing without
 * reference to tk, tcl or X11. Base on tk.h from tk2.3
 *
 * Description:
 * Command line argument parsing.
 *
 * Authors:
 * Fabien Spindler (modification of the original version)
 *
 *****************************************************************************/

#ifndef vpParseArgv_h
#define vpParseArgv_h

#include <visp3/core/vpConfig.h>
#include <visp3/core/vpException.h>

class VISP_EXPORT vpParseArgv
{
public:
  typedef enum {
    ARGV_CONSTANT,      
    ARGV_CONSTANT_INT,  
    ARGV_CONSTANT_BOOL, 
    ARGV_INT,           
    ARGV_LONG,          
    ARGV_STRING,        
    ARGV_REST,
    ARGV_FLOAT,         
    ARGV_DOUBLE,        
    ARGV_FUNC,
    ARGV_GENFUNC,
    ARGV_HELP,          
    ARGV_END            
  } vpArgvType;

  typedef enum {
    ARGV_NO_DEFAULTS = 0x1,         
    ARGV_NO_LEFTOVERS = 0x2,        
    ARGV_NO_ABBREV = 0x4,           
    ARGV_DONT_SKIP_FIRST_ARG = 0x8, 
    ARGV_NO_PRINT = 0x10            
  } vpArgvFlags;

#ifndef DOXYGEN_SHOULD_SKIP_THIS

  typedef struct {
    const char *key;  
    vpArgvType type;  
    const char *src;  
    const char *dst;  
    const char *help; 
  } vpArgvInfo;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */

public:
  static vpArgvInfo defaultTable[2];
  static bool parse(int *argcPtr, const char **argv, vpArgvInfo *argTable, int flags);
  static int parse(int argc, const char **argv, const char *validOpts, const char **param);

private:
  static void printUsage(vpArgvInfo *argTable, int flags);
};

#endif