src/gromacs/commandline/pargs.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 #ifndef GMX_COMMANDLINE_PARGS_H
  38 #define GMX_COMMANDLINE_PARGS_H
  39
  40 #include "../legacyheaders/types/simple.h"
  41
  42 #ifdef __cplusplus
  43 extern "C"
  44 {
  45 #endif
  46
  47 /* This structure is used for parsing arguments off the comand line */
  48 enum
  49 {
  50     etINT, etGMX_LARGE_INT, etREAL, etTIME, etSTR,    etBOOL, etRVEC,   etENUM, etNR
  51 };
  52
  53 typedef struct
  54 {
  55     const char *option;
  56     gmx_bool    bSet;
  57     int         type;
  58     union
  59     {
  60         void            *v; /* This is a nasty workaround, to be able to use initialized */
  61         int             *i; /* arrays */
  62         gmx_large_int_t *is;
  63         real            *r;
  64         const char     **c; /* Must be pointer to string (when type == etSTR)         */
  65         /* or null terminated list of enums (when type == etENUM) */
  66         gmx_bool        *b;
  67         rvec            *rv;
  68     }           u;
  69     const char *desc;
  70 } t_pargs;
  71
  72 void get_pargs(int *argc, char *argv[], int nparg, t_pargs pa[],
  73                gmx_bool bKeepArgs);
  74 /* Read a number of arguments from the command line.
  75  * For etINT, etREAL and etCHAR an extra argument is read (when present)
  76  * for etBOOL the gmx_boolean option is changed to the negate value
  77  * If !bKeepArgs, the command line arguments are removed from the command line
  78  */
  79
  80 gmx_bool is_hidden(t_pargs *pa);
  81 /* Return TRUE when the option is a secret one */
  82
  83 int nenum(const char *const enumc[]);
  84 /* returns ordinal number of selected enum from args
  85  * depends on enumc[0] pointing to one of the other elements
  86  * array must be terminated by a NULL pointer
  87  */
  88
  89 int opt2parg_int(const char *option, int nparg, t_pargs pa[]);
  90
  91 gmx_bool opt2parg_gmx_bool(const char *option, int nparg, t_pargs pa[]);
  92
  93 real opt2parg_real(const char *option, int nparg, t_pargs pa[]);
  94
  95 const char *opt2parg_str(const char *option, int nparg, t_pargs pa[]);
  96
  97 const char *opt2parg_enum(const char *option, int nparg, t_pargs pa[]);
  98
  99 gmx_bool opt2parg_bSet(const char *option, int nparg, t_pargs pa[]);
 100
 101 #ifdef __cplusplus
 102 }
 103 #endif
 104
 105 #endif