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
 *
 * Modifications by Peter Neelin (November 27, 1992)
 * Modifications by Fabien Spindler (June 20, 2006)
 */

 
#ifndef VP_PARSE_ARGV_H
#define VP_PARSE_ARGV_H
 
#include <visp3/core/vpConfig.h>
#include <visp3/core/vpException.h>
 
BEGIN_VISP_NAMESPACE

  name with more than one character.
 
  \code
  #include <stdio.h>
  #include <visp3/core/vpMath.h>
  #include <visp3/io/vpParseArgv.h>
 
  // Usage : [-bool] [-int <integer value>] [-long <long value>]
  //         [-float <float value>] [-double <double value>] [-string <string value>] [-h]
  int main(int argc, const char ** argv)
  {
    // Variables to set by command line parsing
    bool   b_val = false;
    int    i_val = 10;
    long   l_val = 123456;
    float  f_val = 0.1f;
    double d_val = M_PI;
    char   *s_val;
 
    // Parse the command line to set the variables
    vpParseArgv::vpArgvInfo argTable[] =
    {
      {"-bool", vpParseArgv::ARGV_CONSTANT_BOOL, 0, (char *) &b_val,
      "Flag enabled."},
      {"-int", vpParseArgv::ARGV_INT, (char*) nullptr, (char *) &i_val,
      "An integer value."},
      {"-long", vpParseArgv::ARGV_LONG, (char*) nullptr, (char *) &l_val,
      "An integer value."},
      {"-float", vpParseArgv::ARGV_FLOAT, (char*) nullptr, (char *) &f_val,
      "A float value."},
      {"-double", vpParseArgv::ARGV_DOUBLE, (char*) nullptr, (char *) &d_val,
      "A double value."},
      {"-string", vpParseArgv::ARGV_STRING, (char*) nullptr, (char *) &s_val,
      "A string value."},
      {"-h", vpParseArgv::ARGV_HELP, (char*) nullptr, (char *) nullptr,
      "Print the help."},
      {(char*) nullptr, vpParseArgv::ARGV_END, (char*) nullptr, (char*) nullptr, (char*) nullptr} } ;
 
    // Read the command line options
    if(vpParseArgv::parse(&argc, argv, argTable,
                          vpParseArgv::ARGV_NO_LEFTOVERS |
                          vpParseArgv::ARGV_NO_ABBREV |
                          vpParseArgv::ARGV_NO_DEFAULTS)) {
      return (false);
    }
 
    // b_val, i_val, l_val, f_val, d_val, s_val may have new values
  }
  \endcode
 
  The code below shows an other way to parse command line arguments using
  vpParseArgv class. Here command line options are only one character long.
  \code
  #include <stdio.h>
  #include <stdlib.h>
  #include <visp3/core/vpMath.h>
  #include <visp3/io/vpParseArgv.h>
 
  // List of allowed command line options
  #define GETOPTARGS "bi:l:f:d:h" // double point mean here that the preceding option request an argument
 
  // Usage : [-b] [-i <integer value>] [-l <long value>]
  //         [-f <float value>] [-d <double value>] [-s <string value>] [-h]
  int main(int argc, const char ** argv)
  {
    // Variables to set by command line parsing
    bool   b_val = false;
    int    i_val = 10;
    long   l_val = 123456;
    float  f_val = 0.1f;
    double d_val = M_PI;
    std::string s_val;
 
    // Parse the command line to set the variables
    const char *optarg;
    int c;
    while ((c = vpParseArgv::parse(argc, argv, GETOPTARGS, &optarg)) > 1) {
 
      switch (c) {
      case 'b': b_val = true; break;
      case 'i': i_val = atoi(optarg); break;
      case 'l': l_val = atol(optarg); break;
      case 'f': f_val = static_cast<float>(atof(optarg)); break;
      case 'd': d_val = atof(optarg); break;
      case 's': s_val = std::string(optarg); break;
      case 'h': printf("Usage: ...\n"); return EXIT_SUCCESS; break;
 
      default:
        printf("Usage: ...\n"); return EXIT_SUCCESS; break;
      }
    }
    if ((c == 1) || (c == -1)) {
      // standalone param or error
      printf("Usage: ...\n");
      return EXIT_FAILURE;
    }
 
    // b_val, i_val, l_val, f_val, d_val, s_val may have new values
  }
  \endcode
 
*/
 
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);
};
 
END_VISP_NAMESPACE
 
#endif