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