include/futil.h

   1 /*
   2  * $Id$
   3  *
   4  *                This source code is part of
   5  *
   6  *                 G   R   O   M   A   C   S
   7  *
   8  *          GROningen MAchine for Chemical Simulations
   9  *
  10  *                        VERSION 3.0
  11  *
  12  * Copyright (c) 1991-2001
  13  * BIOSON Research Institute, Dept. of Biophysical Chemistry
  14  * University of Groningen, The Netherlands
  15  *
  16  * This program is free software; you can redistribute it and/or
  17  * modify it under the terms of the GNU General Public License
  18  * as published by the Free Software Foundation; either version 2
  19  * of the License, or (at your option) any later version.
  20  *
  21  * If you want to redistribute modifications, please consider that
  22  * scientific software is very special. Version control is crucial -
  23  * bugs must be traceable. We will be happy to consider code for
  24  * inclusion in the official distribution, but derived work must not
  25  * be called official GROMACS. Details are found in the README & COPYING
  26  * files - if they are missing, get the official version at www.gromacs.org.
  27  *
  28  * To help us fund GROMACS development, we humbly ask that you cite
  29  * the papers on the package - you can find them in the top README file.
  30  *
  31  * Do check out http://www.gromacs.org , or mail us at gromacs@gromacs.org .
  32  *
  33  * And Hey:
  34  * Giving Russians Opium May Alter Current Situation
  35  */
  36
  37 #ifndef _futil_h
  38 #define _futil_h
  39
  40 static char *SRCID_futil_h = "$Id$";
  41 #ifdef HAVE_CONFIG_H
  42 #include <config.h>
  43 #endif
  44
  45 #ifdef HAVE_IDENT
  46 #ident  "@(#) futil.h 1.1 11/23/92"
  47 #endif /* HAVE_IDENT */
  48 #include <stdio.h>
  49 #include "typedefs.h"
  50
  51 #ifdef CPLUSPLUS
  52 extern "C" {
  53 #endif
  54
  55 extern void no_buffers(void);
  56 /* Turn off buffering of files (which is default) for debugging purposes */
  57
  58 extern bool fexist(char *fname);
  59 /* Return TRUE when fname exists, FALSE otherwise */
  60
  61 extern bool eof(FILE *fp);
  62 /* Return TRUE on end-of-file, FALSE otherwise */
  63
  64 extern bool is_pipe(FILE *fp);
  65 /* Check whether the file (opened by ffopen) is a pipe */
  66
  67 extern char *backup_fn(char *file);
  68 /* Return a backup name for file (name with # before and after) */
  69
  70 extern FILE *ffopen(char *file,char *mode);
  71 /* Return a valid file pointer when succesfull, exits otherwise
  72  * If the file is in compressed format, open a pipe which uncompresses
  73  * the file! Therefore, files must be closed with ffclose (see below)
  74  */
  75
  76 extern void ffclose(FILE *fp);
  77 /* Close files or pipes */
  78
  79 #define fclose ffclose
  80
  81 extern void frewind(FILE *fp);
  82 /* Does not rewind pipes, but does so for normal files */
  83
  84 #define rewind frewind
  85
  86 bool is_pipe(FILE *fp);
  87
  88 extern FILE *uncompress(char *fn,char *mode);
  89 extern FILE *gunzip(char *fn,char *mode);
  90 /* Open a pipe to uncompress or unzip files. Must be closed with pclose */
  91
  92 extern char *libfn(char *file);
  93
  94 extern FILE *libopen(char *file);
  95 /* Open a library file for reading. This looks in the current directory
  96  * first, and then in the library directory. If the file is not found,
  97  * it terminates with a fatal_error
  98  */
  99
 100 extern char *low_libfn(char *file,bool bFatal);
 101
 102 extern FILE *low_libopen(char *file,bool bFatal);
 103 /* The same as the above, but does not terminate if (!bFatal) */
 104
 105 #ifdef CPLUSPLUS
 106 }
 107 #endif
 108
 109 #endif  /* _futil_h */