3 * This source code is part of
7 * GROningen MAchine for Chemical Simulations
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.
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.
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.
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.
30 * For more info, check our website at http://www.gromacs.org
33 * Gromacs Runs On Most of All Computer Systems
50 void set_default_file_name(const char *name
);
51 /* Set the default file name for all file types to name */
53 extern const char *ftp2ext(int ftp
);
54 /* Return extension for filetype */
56 extern const char *ftp2ext_generic(int ftp
);
57 /* Return extension for filetype, and a generic name for generic types (e.g. trx)*/
59 extern const char *ftp2desc(int ftp
);
60 /* Return description for file type */
62 extern const char *ftp2defnm(int ftp
);
63 /* Return default file name for file type */
65 extern const char *ftp2ftype(int ftp
);
66 /* Return Binary or ASCII depending on file type */
68 extern void pr_def(FILE *fp
,int ftp
);
69 /* Print definitions for filename ftp */
71 extern void pr_defs(FILE *fp
);
72 /* Print definitions for all filename */
74 extern void pr_fns(FILE *fp
,int nf
,t_filenm tfn
[]);
75 /* Print nf file names and types */
77 extern void pr_fopts(FILE *fp
,int nf
,t_filenm tfn
[], int shell
);
78 /* prints file options in tcsh 'complete' format */
80 extern void parse_file_args(int *argc
,char *argv
[],int nf
,t_filenm fnm
[],
81 bool bKeep
, bool bReadNode
);
82 /* Parse command line for file names. When bKeep is set args are
83 * not removed from argv. */
85 extern char *opt2fn(const char *opt
,int nfile
,t_filenm fnm
[]);
86 /* Return the filename belonging to cmd-line option opt, or NULL when
89 extern char *opt2fn_master(const char *opt
,int nfile
,t_filenm fnm
[],t_commrec
*cr
);
90 /* Return the filename belonging to cmd-line option opt, or NULL when
91 * no such option or not running on master */
94 extern int opt2fns(char **fns
[], const char *opt
,int nfile
,t_filenm fnm
[]);
95 /* Return the filenames belonging to cmd-line option opt, or NULL when
98 #define opt2FILE(opt,nfile,fnm,mode) ffopen(opt2fn(opt,nfile,fnm),mode)
99 /* Return a file pointer from the filename (see above) */
101 extern int fn2ftp(const char *fn
);
102 /* Return the filetype corrsponding to filename */
104 extern char *ftp2fn(int ftp
,int nfile
,t_filenm fnm
[]);
105 /* Return the first file name with type ftp, or NULL when none found. */
107 extern int ftp2fns(char **fns
[], int ftp
,int nfile
,t_filenm fnm
[]);
108 /* Return the number of files for the first option with type ftp
109 and the files in **fns[] (will be allocated), or NULL when none found. */
111 extern char *ftp2filter(int ftp
);
112 /* Return a file extension filter for file type */
114 #define ftp2FILE(ftp,nfile,fnm,mode) ffopen(ftp2fn(ftp,nfile,fnm),mode)
115 /* Return a file pointer from the filename (see above) */
117 extern bool ftp2bSet(int ftp
,int nfile
,t_filenm fnm
[]);
118 /* Return TRUE when this file type has been found on the cmd-line */
120 extern bool opt2bSet(const char *opt
,int nfile
,t_filenm fnm
[]);
121 /* Return TRUE when this option has been found on the cmd-line */
123 extern char *opt2fn_null(const char *opt
,int nfile
,t_filenm fnm
[]);
124 /* Return the filenm belonging top cmd-line option opt, or NULL when
126 * Also return NULL when opt is optional and option is not set.
129 extern char *ftp2fn_null(int ftp
,int nfile
,t_filenm fnm
[]);
130 /* Return the first file name with type ftp, or NULL when none found.
131 * Also return NULL when ftp is optional and option is not set.
134 extern bool is_optional(t_filenm
*fnm
);
135 /* Return whether or not this filenm is optional */
137 extern bool is_output(t_filenm
*fnm
);
138 /* Return whether or not this filenm is output */
140 extern bool is_set(t_filenm
*fnm
);
141 /* Return whether or not this filenm is set */
143 /* When we do checkpointing, this routine is called to check for previous
144 * output files and append a 'partNNNN' suffix before the (output) file extensions.
147 add_suffix_to_output_names(t_filenm
*fnm
, int nfile
, char *suffix
);
153 #endif /* _filenm_h */