src/gromacs/legacyheaders/readinp.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  *                        VERSION 3.2.0
  10  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  11  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  12  * Copyright (c) 2001-2004, The GROMACS development team,
  13  * check out http://www.gromacs.org for more information.
  14
  15  * This program is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU General Public License
  17  * as published by the Free Software Foundation; either version 2
  18  * of the License, or (at your option) any later version.
  19  *
  20  * If you want to redistribute modifications, please consider that
  21  * scientific software is very special. Version control is crucial -
  22  * bugs must be traceable. We will be happy to consider code for
  23  * inclusion in the official distribution, but derived work must not
  24  * be called official GROMACS. Details are found in the README & COPYING
  25  * files - if they are missing, get the official version at www.gromacs.org.
  26  *
  27  * To help us fund GROMACS development, we humbly ask that you cite
  28  * the papers on the package - you can find them in the top README file.
  29  *
  30  * For more info, check our website at http://www.gromacs.org
  31  *
  32  * And Hey:
  33  * Gromacs Runs On Most of All Computer Systems
  34  */
  35
  36 #ifndef _readinp_h
  37 #define _readinp_h
  38
  39 #include "typedefs.h"
  40 #include "warninp.h"
  41
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 typedef struct {
  48     int      count;     /* sort order for output  */
  49     gmx_bool bObsolete; /* whether it is an obsolete param value */
  50     gmx_bool bSet;      /* whether it it has been read out */
  51     char    *name;      /* name of the parameter */
  52     char    *value;     /* parameter value string */
  53     int      inp_count; /* number of einps read. Only valid for the first item
  54                                                  in the inpfile list. */
  55 } t_inpfile;
  56 /* entry in input files (like .mdp files).
  57    Initally read in with read_inpfile, then filled in with missing values
  58    through get_eint, get_ereal, etc. */
  59
  60
  61
  62 t_inpfile *read_inpfile(const char *fn, int *ninp,
  63                         warninp_t wi);
  64 /* Create & populate a t_inpfile struct from values in file fn.
  65    fn = the file name
  66    ninp = the number of read parameters
  67    cppopts = the cpp-style options for #include paths and #defines */
  68
  69 void write_inpfile(const char *fn, int ninp, t_inpfile inp[],
  70                    gmx_bool bHaltOnUnknown,
  71                    warninp_t wi);
  72
  73 void replace_inp_entry(int ninp, t_inpfile *inp,
  74                        const char *old_entry, const char *new_entry);
  75
  76 int get_eint(int *ninp, t_inpfile **inp, const char *name, int def,
  77              warninp_t wi);
  78
  79 gmx_large_int_t get_egmx_large_int(int *ninp, t_inpfile **inp,
  80                                    const char *name, gmx_large_int_t def,
  81                                    warninp_t);
  82
  83 double get_ereal(int *ninp, t_inpfile **inp, const char *name, double def,
  84                  warninp_t wi);
  85
  86 const char *get_estr(int *ninp, t_inpfile **inp, const char *name, const char *def);
  87
  88 int get_eeenum(int *ninp, t_inpfile **inp, const char *name, const char **defs,
  89                warninp_t wi);
  90 /* defs must be NULL terminated */
  91
  92 int get_eenum(int *ninp, t_inpfile **inp, const char *name, const char **defs);
  93 /* defs must be NULL terminated */
  94
  95 /* Here are some dirty macros to extract data from the inp structures.
  96  * Most macros assume the variables ninp, inp and wi are present.
  97  * Elements are removed from the list after reading.
  98  */
  99 #define REM_TYPE(name)       replace_inp_entry(ninp, inp, name, NULL)
 100 #define REPL_TYPE(old, new)   replace_inp_entry(ninp, inp, old, new)
 101 #define STYPE(name, var, def)  if ((tmp = get_estr(&ninp, &inp, name, def)) != NULL) strcpy(var, tmp)
 102 #define STYPENC(name, def) get_estr(&ninp, &inp, name, def)
 103 #define ITYPE(name, var, def)  var    = get_eint(&ninp, &inp, name, def, wi)
 104 #define STEPTYPE(name, var, def)  var = get_egmx_large_int(&ninp, &inp, name, def, wi)
 105 #define RTYPE(name, var, def)  var    = get_ereal(&ninp, &inp, name, def, wi)
 106 #define ETYPE(name, var, defs) var    = get_eenum(&ninp, &inp, name, defs)
 107 #define EETYPE(name, var, defs) var   = get_eeenum(&ninp, &inp, name, defs, wi)
 108 #define CCTYPE(s) STYPENC("\n; " s, NULL)
 109 #define CTYPE(s)  STYPENC("; " s, NULL)
 110 /* This last one prints a comment line where you can add some explanation */
 111
 112 /* This structure is used for parsing arguments off the comand line */
 113 enum {
 114     etINT, etGMX_LARGE_INT, etREAL, etTIME, etSTR,    etBOOL, etRVEC,   etENUM, etNR
 115 };
 116
 117 /* name to print in help info for command line arguments (defined in enum above) */
 118 const char *get_arg_desc(int type);
 119
 120 typedef struct {
 121     const char *option;
 122     gmx_bool    bSet;
 123     int         type;
 124     union {
 125         void            *v; /* This is a nasty workaround, to be able to use initialized */
 126         int             *i; /* arrays */
 127         gmx_large_int_t *is;
 128         real            *r;
 129         const char     **c; /* Must be pointer to string (when type == etSTR)         */
 130         /* or null terminated list of enums (when type == etENUM) */
 131         gmx_bool        *b;
 132         rvec            *rv;
 133     } u;
 134     const char *desc;
 135 } t_pargs;
 136
 137 void get_pargs(int *argc, char *argv[], int nparg, t_pargs pa[],
 138                gmx_bool bKeepArgs);
 139 /* Read a number of arguments from the command line.
 140  * For etINT, etREAL and etCHAR an extra argument is read (when present)
 141  * for etBOOL the gmx_boolean option is changed to the negate value
 142  * If !bKeepArgs, the command line arguments are removed from the command line
 143  */
 144
 145 gmx_bool is_hidden(t_pargs *pa);
 146 /* Return TRUE when the option is a secret one */
 147
 148 char *pa_val(t_pargs *pa, char *buf, int sz);
 149 /* Return the value of pa in the provided buffer buf, of size sz.
 150  * The return value is also a pointer to buf.
 151  */
 152
 153 int opt2parg_int(const char *option, int nparg, t_pargs pa[]);
 154
 155 gmx_bool opt2parg_gmx_bool(const char *option, int nparg, t_pargs pa[]);
 156
 157 real opt2parg_real(const char *option, int nparg, t_pargs pa[]);
 158
 159 const char *opt2parg_str(const char *option, int nparg, t_pargs pa[]);
 160
 161 const char *opt2parg_enum(const char *option, int nparg, t_pargs pa[]);
 162
 163 gmx_bool opt2parg_bSet(const char *option, int nparg, t_pargs pa[]);
 164
 165 void print_pargs(FILE *fp, int npargs, t_pargs pa[], gmx_bool bLeadingSpace);
 166
 167 char *pargs_print_line(t_pargs *pa, gmx_bool bLeadingSpace);
 168
 169 void pr_enums(FILE *fp, int npargs, t_pargs pa[], int shell);
 170
 171 #ifdef __cplusplus
 172 }
 173 #endif
 174
 175 #endif