include/filenm.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 _filenm_h
  37 #define _filenm_h
  38
  39 #ifdef HAVE_CONFIG_H
  40 #include <config.h>
  41 #endif
  42
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 #include "futil.h"
  49
  50 void set_default_file_name(const char *name);
  51 /* Set the default file name for all file types to name */
  52
  53 extern const char *ftp2ext(int ftp);
  54 /* Return extension for filetype */
  55
  56 extern const char *ftp2ext_generic(int ftp);
  57 /* Return extension for filetype, and a generic name for generic types
  58    (e.g. trx)*/
  59
  60 extern const char *ftp2desc(int ftp);
  61 /* Return description for file type */
  62
  63 extern const char *ftp2defnm(int ftp);
  64 /* Return default file name for file type */
  65
  66 extern const char *ftp2ftype(int ftp);
  67 /* Return Binary or ASCII depending on file type */
  68
  69 extern void pr_def(FILE *fp,int ftp);
  70 /* Print definitions for filename ftp */
  71
  72 extern void pr_defs(FILE *fp);
  73 /* Print definitions for all filename */
  74
  75 extern void pr_fns(FILE *fp,int nf,const t_filenm tfn[]);
  76 /* Print nf file names and types */
  77
  78 extern void pr_fopts(FILE *fp,int nf,const t_filenm tfn[], int shell);
  79 /* prints file options in tcsh 'complete' format */
  80
  81 extern void parse_file_args(int *argc,char *argv[],int nf,t_filenm fnm[],
  82                             bool bKeep, bool bReadNode);
  83 /* Parse command line for file names. When bKeep is set args are
  84  * not removed from argv. */
  85
  86 extern const char *opt2fn(const char *opt,int nfile, const t_filenm fnm[]);
  87 /* Return the filename belonging to cmd-line option opt, or NULL when
  88  * no such option. */
  89
  90 extern const char *opt2fn_master(const char *opt, int nfile,
  91                                 const t_filenm fnm[], t_commrec *cr);
  92 /* Return the filename belonging to cmd-line option opt, or NULL when
  93  * no such option or not running on master */
  94
  95
  96 extern int opt2fns(char **fns[], const char *opt,int nfile,
  97                    const t_filenm fnm[]);
  98 /* Return the filenames belonging to cmd-line option opt, or NULL when
  99  * no such option. */
 100
 101 #define opt2FILE(opt,nfile,fnm,mode) ffopen(opt2fn(opt,nfile,fnm),mode)
 102 /* Return a file pointer from the filename (see above) */
 103
 104 extern int fn2ftp(const char *fn);
 105 /* Return the filetype corrsponding to filename */
 106
 107 extern const char *ftp2fn(int ftp,int nfile,const t_filenm fnm[]);
 108 /* Return the first file name with type ftp, or NULL when none found. */
 109
 110 extern int ftp2fns(char **fns[], int ftp,int nfile,const t_filenm fnm[]);
 111 /* Return the number of files for the first option with type ftp
 112    and the files in **fns[] (will be allocated), or NULL when none found. */
 113
 114 #if 0
 115 /* This function is not thread-safe and used nowhere: */
 116 extern char *ftp2filter(int ftp);
 117 /* Return a file extension filter for file type */
 118 #endif
 119
 120 #define ftp2FILE(ftp,nfile,fnm,mode) ffopen(ftp2fn(ftp,nfile,fnm),mode)
 121 /* Return a file pointer from the filename (see above) */
 122
 123 extern bool ftp2bSet(int ftp,int nfile,const t_filenm fnm[]);
 124 /* Return TRUE when this file type has been found on the cmd-line */
 125
 126 extern bool opt2bSet(const char *opt,int nfile,const t_filenm fnm[]);
 127 /* Return TRUE when this option has been found on the cmd-line */
 128
 129 extern const char *opt2fn_null(const char *opt,int nfile,const t_filenm fnm[]);
 130 /* Return the filenm belonging top cmd-line option opt, or NULL when
 131  * no such option.
 132  * Also return NULL when opt is optional and option is not set.
 133  */
 134
 135 extern const char *ftp2fn_null(int ftp,int nfile,const t_filenm fnm[]);
 136 /* Return the first file name with type ftp, or NULL when none found.
 137  * Also return NULL when ftp is optional and option is not set.
 138  */
 139
 140 extern bool is_optional(const t_filenm *fnm);
 141 /* Return whether or not this filenm is optional */
 142
 143 extern bool is_output(const t_filenm *fnm);
 144 /* Return whether or not this filenm is output */
 145
 146 extern bool is_set(const t_filenm *fnm);
 147 /* Return whether or not this filenm is set */
 148
 149 /* When we do checkpointing, this routine is called to check for previous
 150  * output files and append a 'partNNNN' suffix before the (output) file extensions.
 151  */
 152 int add_suffix_to_output_names(t_filenm *fnm, int nfile, const char *suffix);
 153
 154 /* duplicate the filename list (to make a private copy for each thread,
 155    for example) */
 156 t_filenm *dup_tfn(int nf, const t_filenm tfn[]);
 157
 158 #ifdef __cplusplus
 159 }
 160 #endif
 161
 162 #endif  /* _filenm_h */