2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
5 * Copyright (c) 2001-2004, The GROMACS development team.
6 * Copyright (c) 2013,2014,2015, 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.
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.
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.
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.
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.
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.
38 #ifndef GMX_FILEIO_FILENM_H
39 #define GMX_FILEIO_FILENM_H
41 #include "gromacs/legacyheaders/types/commrec_fwd.h"
42 #include "gromacs/utility/basedefinitions.h"
48 /* this enum should correspond to the array deffile in gmxlib/filenm.c */
51 efTRX, efTRO, efTRN, efTRR, efCOMPRESSED, efXTC, efTNG,
53 efSTX, efSTO, efGRO, efG96, efPDB, efBRK, efENT, efESP, efPQR,
59 efTEX, efRTP, efATP, efHDB,
61 efMAP, efEPS, efMAT, efM2P,
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 */
85 #define ffALLOW_MISSING 1<<6
86 #define ffRW (ffREAD | ffWRITE)
87 #define ffOPTRD (ffREAD | ffOPT)
88 #define ffOPTWR (ffWRITE| ffOPT)
89 #define ffOPTRW (ffRW | ffOPT)
90 #define ffLIBRD (ffREAD | ffLIB)
91 #define ffLIBOPTRD (ffOPTRD | ffLIB)
92 #define ffRDMULT (ffREAD | ffMULT)
93 #define ffOPTRDMULT (ffRDMULT | ffOPT)
94 #define ffWRMULT (ffWRITE | ffMULT)
95 #define ffOPTWRMULT (ffWRMULT | ffOPT)
97 const char *ftp2ext(int ftp);
98 /* Return extension for filetype */
100 const char *ftp2ext_generic(int ftp);
101 /* Return extension for filetype, and a generic name for generic types
104 const char *ftp2ext_with_dot(int ftp);
105 /* Return extension for filetype with a leading dot */
107 int ftp2generic_count(int ftp);
108 /* Return the number of filetypes for a generic filetype */
110 const int *ftp2generic_list(int ftp);
111 /* Return the list of filetypes for a generic filetype */
113 const char *ftp2desc(int ftp);
114 /* Return description for file type */
116 const char *ftp2defnm(int ftp);
117 /* Return default file name for file type */
119 const char *ftp2defopt(int ftp);
120 /* Return default option name for file type */
122 const char *ftp2ftype(int ftp);
123 /* Return Binary or ASCII depending on file type */
125 const char *opt2fn(const char *opt, int nfile, const t_filenm fnm[]);
126 /* Return the filename belonging to cmd-line option opt, or NULL when
129 const char *opt2fn_master(const char *opt, int nfile,
130 const t_filenm fnm[], t_commrec *cr);
131 /* Return the filename belonging to cmd-line option opt, or NULL when
132 * no such option or not running on master */
135 int opt2fns(char **fns[], const char *opt, int nfile,
136 const t_filenm fnm[]);
137 /* Return the filenames belonging to cmd-line option opt, or NULL when
140 #define opt2FILE(opt, nfile, fnm, mode) gmx_ffopen(opt2fn(opt, nfile, fnm), mode)
141 /* Return a file pointer from the filename (see above) */
143 int fn2ftp(const char *fn);
144 /* Return the filetype corrsponding to filename */
146 const char *ftp2fn(int ftp, int nfile, const t_filenm fnm[]);
147 /* Return the first file name with type ftp, or NULL when none found. */
149 int ftp2fns(char **fns[], int ftp, int nfile, const t_filenm fnm[]);
150 /* Return the number of files for the first option with type ftp
151 and the files in **fns[] (will be allocated), or NULL when none found. */
153 #define ftp2FILE(ftp, nfile, fnm, mode) gmx_ffopen(ftp2fn(ftp, nfile, fnm), mode)
154 /* Return a file pointer from the filename (see above) */
156 gmx_bool ftp2bSet(int ftp, int nfile, const t_filenm fnm[]);
157 /* Return TRUE when this file type has been found on the cmd-line */
159 gmx_bool opt2bSet(const char *opt, int nfile, const t_filenm fnm[]);
160 /* Return TRUE when this option has been found on the cmd-line */
162 const char *opt2fn_null(const char *opt, int nfile, const t_filenm fnm[]);
163 /* Return the filenm belonging top cmd-line option opt, or NULL when
165 * Also return NULL when opt is optional and option is not set.
168 const char *ftp2fn_null(int ftp, int nfile, const t_filenm fnm[]);
169 /* Return the first file name with type ftp, or NULL when none found.
170 * Also return NULL when ftp is optional and option is not set.
173 gmx_bool is_optional(const t_filenm *fnm);
174 /* Return whether or not this filenm is optional */
176 gmx_bool is_output(const t_filenm *fnm);
177 /* Return whether or not this filenm is output */
179 gmx_bool is_set(const t_filenm *fnm);
180 /* Return whether or not this filenm is set */
182 /* When we do checkpointing, this routine is called to check for previous
183 * output files and append a '.partNNNN' suffix before the (output) file extensions.
185 int add_suffix_to_output_names(t_filenm *fnm, int nfile, const char *suffix);
187 /* duplicate the filename list (to make a private copy for each thread,
189 t_filenm *dup_tfn(int nf, const t_filenm tfn[]);
191 /* Free memory allocated for file names by parse_file_args(). */
192 void done_filenms(int nf, t_filenm fnm[]);
198 #endif /* GMX_FILEIO_FILENM_H */