src/gromacs/fileio/filenm.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,2014, 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
  38 #ifndef GMX_FILEIO_FILENM_H
  39 #define GMX_FILEIO_FILENM_H
  40
  41 #include "../legacyheaders/types/commrec_fwd.h"
  42 #include "../utility/basedefinitions.h"
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 /* this enum should correspond to the array deffile in gmxlib/filenm.c */
  49 enum {
  50     efMDP,
  51     efTRX, efTRO, efTRN, efTRR, efCOMPRESSED, efXTC, efTNG,
  52     efEDR,
  53     efSTX, efSTO, efGRO, efG96, efPDB, efBRK, efENT, efESP, efPQR,
  54     efCPT,
  55     efLOG, efXVG, efOUT,
  56     efNDX,
  57     efTOP, efITP,
  58     efTPS, efTPR,
  59     efTEX, efRTP, efATP, efHDB,
  60     efDAT, efDLG,
  61     efMAP, efEPS, efMAT, efM2P,
  62     efMTX,
  63     efEDI,
  64     efCUB,
  65     efXPM,
  66     efRND,
  67     efNR
  68 };
  69
  70 typedef struct {
  71     int           ftp;    /* File type (see enum above)         */
  72     const char   *opt;    /* Command line option                        */
  73     const char   *fn;     /* File name (as set in source code)  */
  74     unsigned long flag;   /* Flag for all kinds of info (see defs)*/
  75     int           nfiles; /* number of files                    */
  76     char        **fns;    /* File names                         */
  77 } t_filenm;
  78
  79 #define ffSET   1<<0
  80 #define ffREAD  1<<1
  81 #define ffWRITE 1<<2
  82 #define ffOPT   1<<3
  83 #define ffLIB   1<<4
  84 #define ffMULT  1<<5
  85 #define ffRW    (ffREAD | ffWRITE)
  86 #define ffOPTRD (ffREAD | ffOPT)
  87 #define ffOPTWR (ffWRITE| ffOPT)
  88 #define ffOPTRW (ffRW   | ffOPT)
  89 #define ffLIBRD (ffREAD | ffLIB)
  90 #define ffLIBOPTRD (ffOPTRD | ffLIB)
  91 #define ffRDMULT   (ffREAD  | ffMULT)
  92 #define ffOPTRDMULT   (ffRDMULT | ffOPT)
  93 #define ffWRMULT   (ffWRITE  | ffMULT)
  94 #define ffOPTWRMULT   (ffWRMULT | ffOPT)
  95
  96 const char *ftp2ext(int ftp);
  97 /* Return extension for filetype */
  98
  99 const char *ftp2ext_generic(int ftp);
 100 /* Return extension for filetype, and a generic name for generic types
 101    (e.g. trx)*/
 102
 103 const char *ftp2ext_with_dot(int ftp);
 104 /* Return extension for filetype with a leading dot */
 105
 106 int ftp2generic_count(int ftp);
 107 /* Return the number of filetypes for a generic filetype */
 108
 109 const int *ftp2generic_list(int ftp);
 110 /* Return the list of filetypes for a generic filetype */
 111
 112 const char *ftp2desc(int ftp);
 113 /* Return description for file type */
 114
 115 const char *ftp2defnm(int ftp);
 116 /* Return default file name for file type */
 117
 118 const char *ftp2defopt(int ftp);
 119 /* Return default option name for file type */
 120
 121 const char *ftp2ftype(int ftp);
 122 /* Return Binary or ASCII depending on file type */
 123
 124 const char *opt2fn(const char *opt, int nfile, const t_filenm fnm[]);
 125 /* Return the filename belonging to cmd-line option opt, or NULL when
 126  * no such option. */
 127
 128 const char *opt2fn_master(const char *opt, int nfile,
 129                           const t_filenm fnm[], t_commrec *cr);
 130 /* Return the filename belonging to cmd-line option opt, or NULL when
 131  * no such option or not running on master */
 132
 133
 134 int opt2fns(char **fns[], const char *opt, int nfile,
 135             const t_filenm fnm[]);
 136 /* Return the filenames belonging to cmd-line option opt, or NULL when
 137  * no such option. */
 138
 139 #define opt2FILE(opt, nfile, fnm, mode) gmx_ffopen(opt2fn(opt, nfile, fnm), mode)
 140 /* Return a file pointer from the filename (see above) */
 141
 142 int fn2ftp(const char *fn);
 143 /* Return the filetype corrsponding to filename */
 144
 145 const char *ftp2fn(int ftp, int nfile, const t_filenm fnm[]);
 146 /* Return the first file name with type ftp, or NULL when none found. */
 147
 148 int ftp2fns(char **fns[], int ftp, int nfile, const t_filenm fnm[]);
 149 /* Return the number of files for the first option with type ftp
 150    and the files in **fns[] (will be allocated), or NULL when none found. */
 151
 152 #define ftp2FILE(ftp, nfile, fnm, mode) gmx_ffopen(ftp2fn(ftp, nfile, fnm), mode)
 153 /* Return a file pointer from the filename (see above) */
 154
 155 gmx_bool ftp2bSet(int ftp, int nfile, const t_filenm fnm[]);
 156 /* Return TRUE when this file type has been found on the cmd-line */
 157
 158 gmx_bool opt2bSet(const char *opt, int nfile, const t_filenm fnm[]);
 159 /* Return TRUE when this option has been found on the cmd-line */
 160
 161 const char *opt2fn_null(const char *opt, int nfile, const t_filenm fnm[]);
 162 /* Return the filenm belonging top cmd-line option opt, or NULL when
 163  * no such option.
 164  * Also return NULL when opt is optional and option is not set.
 165  */
 166
 167 const char *ftp2fn_null(int ftp, int nfile, const t_filenm fnm[]);
 168 /* Return the first file name with type ftp, or NULL when none found.
 169  * Also return NULL when ftp is optional and option is not set.
 170  */
 171
 172 gmx_bool is_optional(const t_filenm *fnm);
 173 /* Return whether or not this filenm is optional */
 174
 175 gmx_bool is_output(const t_filenm *fnm);
 176 /* Return whether or not this filenm is output */
 177
 178 gmx_bool is_set(const t_filenm *fnm);
 179 /* Return whether or not this filenm is set */
 180
 181 /* When we do checkpointing, this routine is called to check for previous
 182  * output files and append a '.partNNNN' suffix before the (output) file extensions.
 183  */
 184 int add_suffix_to_output_names(t_filenm *fnm, int nfile, const char *suffix);
 185
 186 /* duplicate the filename list (to make a private copy for each thread,
 187    for example) */
 188 t_filenm *dup_tfn(int nf, const t_filenm tfn[]);
 189
 190 /* Free memory allocated for file names by parse_file_args(). */
 191 void done_filenms(int nf, t_filenm fnm[]);
 192
 193 #ifdef __cplusplus
 194 }
 195 #endif
 196
 197 #endif  /* GMX_FILEIO_FILENM_H */