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