general.h

Go to the documentation of this file.

/*  _________________________________________________________________________
 *
 *  UTILIB: A utility library for developing portable C++ codes.
 *  Copyright (c) 2001, Sandia National Laboratories.
 *  This software is distributed under the GNU Lesser General Public License.
 *  For more information, see the README file in the top UTILIB directory.
 *  _________________________________________________________________________
 */

#ifndef __general_h
#define __general_h

#if defined(__cplusplus) && defined(ANSI_HDRS)
#include <cstring>
#include <cstdlib>
#include <cstdio>
#else
#include <string.h>
#include <stdlib.h>
#include <stdio.h>
#endif

#ifndef FALSE
#define FALSE   0
#endif
#ifndef TRUE
#define TRUE    1
#endif

#ifdef PPRINT_DO_COMMAND
#define DO_COMMAND_TAB  "\t"
#define DO_COMMAND_EOLN "\n"
#else
#define DO_COMMAND_TAB  " "
#define DO_COMMAND_EOLN ""
#endif

/*
      ACTION INDEX
        0 - Process flags
        1 - ERR
        2 - Used to make CFLAGS
        3 - Used to print out errors
        4 - Used to print out errors
        5 - Used to print out errors
        6 - Process required arguments
        7 - Exit the processing
 */


#define SIMPLE_FLAG_OPTN(string,var) \
  FLAG_OPTN(string, (var) = TRUE)

#define FLAG_OPTN(string,stmt) \
  if (__ACTION__ == 0) { \
    if (strcmp(_OPTION_, "-" #string) == 0) { \
      {stmt;} \
      continue; \
    } \
  } \
  else if (__ACTION__ == 1 || __ACTION__ == 4) { \
    (void) fputs(DO_COMMAND_TAB,stderr);  \
    (void) fputs("[-" #string "]",stderr); \
    (void) fputs(DO_COMMAND_EOLN, stderr); \
  }

#define CFLAG_OPTN(char,stmt) \
  if (__ACTION__ == 0 && _OPTION_[1] == (#char)[0]) { \
    __ACTION__ = 2; \
    _OPTION_ += 1; \
  }  \
  if (__ACTION__ == 2 && _OPTION_[0] == (#char)[0]) { \
    {stmt;} \
    continue; \
  } else if (__ACTION__ == 1) { \
    (void) fputs(DO_COMMAND_TAB,stderr); \
    (void) fputs("[-" #char , stderr); \
    __ACTION__ = 3; \
  } else if (__ACTION__ == 3) { \
    (void) fputs(#char, stderr); \
  } else if (__ACTION__ == 5) { \
    __ACTION__ = 4; \
  }
  
#define SIMPLE_CFLAG_OPTN(char,var) \
  CFLAG_OPTN(char, (var) = 1)

#define DATA_OPTN(string,desc,stmt) \
  if (__ACTION__ == 0 \
      && strncmp(_OPTION_, "-" #string, sizeof("-" #string) - 1) == 0) { \
    if (_OPTION_[sizeof("-" #string)-1] == '\0') { \
      __i__ += 1; \
      if (__i__ >= argc) __ACTION__ = 1; \
      _OPTION_ = argv[__i__]; \
    } \
    else _OPTION_ += sizeof("-" #string); \
    if (__ACTION__ != 1) {stmt;} \
    continue; \
  } else if (__ACTION__ == 1 || __ACTION__ == 4) { \
    (void) fputs(DO_COMMAND_TAB,stderr); \
    (void) fputs("[-" #string #desc "]",stderr); \
    (void) fputs(DO_COMMAND_EOLN, stderr); \
  }

#define DATA_OPTN2(string,desc,stmt1,stmt2) \
  if (__ACTION__ == 0 \
      && strncmp(_OPTION_, "-" #string, sizeof("-" #string) - 1) == 0) { \
    if (_OPTION_[sizeof("-" #string)-1] == '\0') { \
      __i__ += 1; \
      if (__i__ >= argc) __ACTION__ = 1; \
      _OPTION_ = argv[__i__]; \
    } \
    else _OPTION_ += sizeof("-" #string); \
    if (__ACTION__ != 1) { \
        stmt1; \
        __i__ += 1; \
        if (__i__ >= argc) \
           __ACTION__ = 1; \
        else { \
           _OPTION_ = argv[__i__]; \
           stmt2; \
           } \
        } \
    continue; \
  } else if (__ACTION__ == 1 || __ACTION__ == 4) { \
    (void) fputs(DO_COMMAND_TAB,stderr); \
    (void) fputs("[-" #string #desc "]",stderr); \
    (void) fputs(DO_COMMAND_EOLN, stderr); \
  }

#define NON_SWITCH(desc,stmt) \
  if (__ACTION__ == 6) { \
     while (__i__ < argc) { \
       _OPTION_ = argv[__i__]; \
       stmt; \
       __i__++; \
       } \
  } \
  else if (__ACTION__ == 1 || __ACTION__ == 4) { \
    (void) fputs(DO_COMMAND_TAB,stderr); \
    (void) fputs("[" #desc "...]",stderr); \
    (void) fputs(DO_COMMAND_EOLN, stderr); \
  }

#define FREE_ARGS_CONT() \
  if (__ACTION__ == 6) { \
     int i; \
     char* tmp = argv[0];\
     for (i=1; i<__i__; i++) \
       argv++; \
     argv[0] = tmp;\
     argc -= __i__-1; \
     __ACTION__ = 7; \
  } \
  else if (__ACTION__ == 1 || __ACTION__ == 4) \
    (void) fputs(DO_COMMAND_EOLN, stderr);

#define FREE_ARGS() \
  if (__ACTION__ == 6) { \
     int i; \
     for (i=1; i<__i__; i++) \
       argv++; \
     argc -= __i__-1; \
     __ACTION__ = 7; \
  } \
  else if (__ACTION__ == 1 || __ACTION__ == 4) { \
    (void) fputs(DO_COMMAND_TAB,stderr); \
    (void) fputs("[argv1 argv2 ...]",stderr); \
    (void) fputs(DO_COMMAND_EOLN, stderr); \
  }

#define REQ_ARG(desc,stmt) \
  if (__ACTION__ == 6) { \
    if (__i__ >= argc) { \
       __ACTION__ = 1; \
       continue; \
    } \
    stmt; \
    __i__ += 1; \
    if (__i__ < argc) \
       _OPTION_ = argv[__i__]; \
  } \
  else if (__ACTION__ == 1 || __ACTION__ == 4) { \
    (void) fputs(DO_COMMAND_TAB, stderr); \
    (void) fputs("<" #desc ">",stderr); \
    (void) fputs(DO_COMMAND_EOLN, stderr); \
  }

#define OPT_ARG(desc,stmt) \
  if ((__ACTION__ == 6) && (__i__ < argc)) { \
    stmt; \
    __i__ += 1; \
    if (__i__ < argc) \
       _OPTION_ = argv[__i__]; \
  } \
  else if (__ACTION__ == 1 || __ACTION__ == 4) { \
    (void) fputs(DO_COMMAND_TAB,stderr); \
    (void) fputs("[<" #desc ">]",stderr); \
    (void) fputs(DO_COMMAND_EOLN, stderr); \
  }

#define ANY_OPTION(desc,stmt) \
  if (__ACTION__ == 0) { \
    stmt; \
    continue; \
  } \
  else if (__ACTION__ == 1 || __ACTION__ == 4) { \
    (void) fputs(DO_COMMAND_TAB,stderr); \
    (void) fputs("" #desc "",stderr); \
    (void) fputs(DO_COMMAND_EOLN, stderr); \
  }

#define COMMAND_LINE_ERROR { __ACTION__ = 1; continue;}

#define DO_STANDARD_COMMAND_LINE(stmts) \
  { \
    int __i__; \
    int __ACTION__; \
    char *_OPTION_ = NULL; \
    __i__ = 0; \
    __ACTION__ = 0; \
    while (1) { \
      if (__ACTION__ == 2) { \
        _OPTION_ += 1; \
        if (_OPTION_[0] == '\0') __ACTION__ = 0; \
      } \
      if ((__ACTION__ == 0) || (__ACTION__ == 6)) { \
        __i__ += 1; \
        if (__i__ >= argc) \
           __ACTION__ = 6; \
        else \
           _OPTION_ = argv[__i__]; \
      } \
      if (__ACTION__ == 0 && _OPTION_[0] != '-') \
         __ACTION__ = 6; \
      if (__ACTION__ == 1) (void) fprintf(stderr, "Usage: %s%s", argv[0],DO_COMMAND_EOLN); \
      stmts; \
      if (__ACTION__ == 6) {\
        if (__i__ < argc) { \
          __ACTION__ = 1; \
          continue; \
        } \
        else \
          break; \
      } \
      if (__ACTION__ == 7) \
         break; \
      if (__ACTION__ == 1 || __ACTION__ == 4) { \
        fprintf(stderr,"\n"); \
        exit(__ACTION__); \
      } \
      if (__ACTION__ == 3) { \
        (void) fputs("]",stderr); \
        (void) fputs(DO_COMMAND_EOLN, stderr); \
        __ACTION__ = 5; \
      } else { \
         __ACTION__ = 1; \
      } \
    } \
  }

#endif