src/gromacs/fileio/futil.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014, 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.
  10  *
  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.
  15  *
  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.
  20  *
  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.
  25  *
  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.
  33  *
  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.
  36  */
  37
  38 #ifndef GMX_FILEIO_FUTIL_H
  39 #define GMX_FILEIO_FUTIL_H
  40
  41 #include <stdio.h>
  42 #include "../legacyheaders/typedefs.h"
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47 #if 0
  48 }
  49 #endif
  50
  51 /* Native windows uses backslash path separators.
  52  * Cygwin and everybody else in the world use slash.
  53  */
  54 #include "../utility/gmx_header_config.h"
  55 #ifdef GMX_NATIVE_WINDOWS
  56 #define DIR_SEPARATOR '\\'
  57 #else
  58 #define DIR_SEPARATOR '/'
  59 #endif
  60
  61 /* Now get the maximum path size. */
  62 #ifdef PATH_MAX
  63 #  define GMX_PATH_MAX PATH_MAX
  64 #elif defined MAX_PATH
  65 #  define GMX_PATH_MAX MAX_PATH
  66 #else
  67 #  define GMX_PATH_MAX 4096
  68 #endif
  69
  70 typedef gmx_int64_t    gmx_off_t;
  71
  72 void no_buffers(void);
  73 /* Turn off buffering of files (which is default) for debugging purposes */
  74
  75 gmx_bool gmx_fexist(const char *fname);
  76 /* Return TRUE when fname exists, FALSE otherwise */
  77
  78 gmx_bool gmx_fexist_master(const char *fname, t_commrec *cr);
  79 /* Return TRUE when fname exists, FALSE otherwise, bcast from master to others */
  80
  81 gmx_bool gmx_eof(FILE *fp);
  82 /* Return TRUE on end-of-file, FALSE otherwise */
  83
  84 gmx_bool is_pipe(FILE *fp);
  85 /* Check whether the file (opened by gmx_ffopen) is a pipe */
  86
  87 /*  Make a backup of file if necessary.
  88     Return false if there was a problem.
  89  */
  90 gmx_bool make_backup(const char * file);
  91
  92 FILE *gmx_ffopen(const char *file, const char *mode);
  93 /* Return a valid file pointer when successful, exits otherwise
  94  * If the file is in compressed format, open a pipe which uncompresses
  95  * the file! Therefore, files must be closed with gmx_ffclose (see below)
  96  */
  97
  98 int gmx_ffclose(FILE *fp);
  99 /* Close files or pipes */
 100
 101
 102 void frewind(FILE *fp);
 103 /* Does not rewind pipes, but does so for normal files */
 104
 105 #define rewind frewind
 106
 107
 108 int gmx_fseek(FILE *stream, gmx_off_t offset, int whence);
 109 /* OS-independent fseek. 64-bit when available */
 110
 111 gmx_off_t gmx_ftell(FILE *stream);
 112 /* OS-independent fseek. 64-bit when available. */
 113
 114
 115 gmx_bool is_pipe(FILE *fp);
 116
 117 char *gmxlibfn(const char *file);
 118 /* allocates and returns a string with the full file name for a library file */
 119
 120 FILE *libopen(const char *file);
 121 /* Open a library file for reading. This looks in the current directory
 122  * first, and then in the library directory. If the file is not found,
 123  * it terminates with a fatal_error
 124  */
 125
 126 /* Opaque data type to list directories */
 127 typedef struct gmx_directory *
 128     gmx_directory_t;
 129
 130 /* Open a directory for reading. The first argument should be a pointer
 131  * to a declared gmx_directory_t variable. Returns 0 on success.
 132  */
 133 int
 134 gmx_directory_open(gmx_directory_t *p_gmxdir, const char *dirname);
 135
 136
 137 /* Given an initialized gmx_directory_t, if there are more files in
 138  * the directory this routine returns 0 and write the next name
 139  * into the USER-PROVIDED buffer name. The last argument is the max
 140  * number of characters that will be written. Just as strncpy, the
 141  * string will NOT be terminated it it is longer than maxlength_name.
 142  */
 143 int
 144 gmx_directory_nextfile(gmx_directory_t gmxdir, char *name, int maxlength_name);
 145
 146 /* Release all data for a directory structure */
 147 int
 148 gmx_directory_close(gmx_directory_t gmxdir);
 149
 150
 151 char *low_gmxlibfn(const char *file, gmx_bool bAddCWD, gmx_bool bFatal);
 152
 153 FILE *low_libopen(const char *file, gmx_bool bFatal);
 154 /* The same as the above, but does not terminate if (!bFatal) */
 155
 156 /* Create unique name for temp file (wrapper around mkstemp).
 157  * Buf should be at least 7 bytes long
 158  */
 159 void gmx_tmpnam(char *buf);
 160
 161 /* truncte the file to the specified length */
 162 int gmx_truncatefile(char *path, gmx_off_t length);
 163
 164 /* rename/move the file (atomically, if the OS makes that available) oldname
 165    to newname */
 166 int gmx_file_rename(const char *oldname, const char *newname);
 167
 168 /* copy the file (data only) oldname to newname. if copy_if_empty==FALSE,
 169    the file won't be copied if it's empty.*/
 170 int gmx_file_copy(const char *oldname, const char *newname, gmx_bool copy_if_empty);
 171
 172 /* do an fsync() on an open file pointer.
 173    Only use this during checkpointing! */
 174 int gmx_fsync(FILE *fp);
 175
 176 void gmx_chdir(const char *directory);
 177 void gmx_getcwd(char *buffer, size_t size);
 178
 179 #ifdef __cplusplus
 180 }
 181 #endif
 182
 183 #endif  /* GMX_FILEIO_FUTIL_H */