src/gromacs/utility/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,2015, 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 /*! \file
  38  * \brief
  39  * Low-level wrappers for OS-specific file handling with some \Gromacs
  40  * customizations.
  41  *
  42  * \inpublicapi
  43  * \ingroup module_utility
  44  */
  45 #ifndef GMX_UTILITY_FUTIL_H
  46 #define GMX_UTILITY_FUTIL_H
  47
  48 #include <limits.h>
  49 #include <stdio.h>
  50
  51 #include "gromacs/utility/basedefinitions.h"
  52
  53 #ifdef __cplusplus
  54 extern "C" {
  55 #endif
  56 #if 0
  57 }
  58 #endif
  59
  60 #include "gromacs/utility/gmx_header_config.h"
  61 /*! \def DIR_SEPARATOR
  62  * \brief
  63  * Directory separator on this OS.
  64  *
  65  * Native Windows uses backslash path separators (but accepts also slashes).
  66  * Cygwin and most other systems use slash.
  67  *
  68  * \todo
  69  * Get rid of this (Redmine #950), or at least remove this from an installed
  70  * header.  It is not necessary for constructing paths on the systems that it
  71  * currently supports, and is not reliable in parsing input paths either, since
  72  * Windows needs to accept both instead of only DIR_SEPARATOR.
  73  */
  74 #ifdef GMX_NATIVE_WINDOWS
  75 #define DIR_SEPARATOR '\\'
  76 #else
  77 #define DIR_SEPARATOR '/'
  78 #endif
  79
  80 /*! \def GMX_PATH_MAX
  81  * \brief
  82  * Maximum path length, if the OS provides one, otherwise a fixed constant.
  83  */
  84 #ifdef PATH_MAX
  85 #  define GMX_PATH_MAX PATH_MAX
  86 #elif defined MAX_PATH
  87 #  define GMX_PATH_MAX MAX_PATH
  88 #else
  89 #  define GMX_PATH_MAX 4096
  90 #endif
  91
  92 /** \Gromacs definition to use instead of `off_t`. */
  93 typedef gmx_int64_t    gmx_off_t;
  94
  95 /*! \brief
  96  * Turn off buffering for output files (which is default) for debugging
  97  * purposes.
  98  *
  99  * This only has effect on files opened with gmx_ffopen().
 100  */
 101 void gmx_disable_file_buffering(void);
 102
 103 /*! \brief
 104  * Enables backups with the specified number of maximum backups.
 105  *
 106  * If \p count == 0, disables backups.  If not called, this is the default.
 107  * If \p count == -1, reads the count from an environment variable.
 108  *
 109  * This is not currently thread-safe, as it is only called during
 110  * initialization code.
 111  */
 112 void gmx_set_max_backup_count(int count);
 113
 114 /*! \brief
 115  * Check whether a path exists.
 116  *
 117  * \returns `TRUE` when \p fname exists.
 118  *
 119  * Note that this returns `TRUE` even if \p fname is a directory instead of a
 120  * file.
 121  */
 122 gmx_bool gmx_fexist(const char *fname);
 123
 124 /*! \brief
 125  * Makes a backup of file if the file exists.
 126  */
 127 void make_backup(const char *file);
 128
 129 /*! \brief
 130  * Opens a file, with \Gromacs-specific additions.
 131  *
 132  * If the file is in compressed format, opens a pipe which uncompresses the
 133  * file on the fly.  For this to work, gmx_ffclose() and frewind() should
 134  * always be used for files opened with gmx_ffopen() instead of fclose() and
 135  * rewind().  For compressed files, the \p file parameter should be passed
 136  * without the compressed extension; if that file is not found, then a few
 137  * compression extensions are tried.
 138  * Creates a backup if a file opened for writing already exists before
 139  * overwriting it.
 140  * A fatal error results if the file cannot be opened, for whatever reason.
 141  */
 142 FILE *gmx_ffopen(const char *file, const char *mode);
 143
 144 /** Closes a file opened with gmx_ffopen(). */
 145 int gmx_ffclose(FILE *fp);
 146
 147 /*! \brief
 148  * Wraps rewind() for files opened with gmx_ffopen().
 149  *
 150  * A fatal error results if this function is called for a pipe (a compressed
 151  * input file).
 152  */
 153 void frewind(FILE *fp);
 154
 155 /** OS-independent 64-bit fseek(). */
 156 int gmx_fseek(FILE *stream, gmx_off_t offset, int whence);
 157
 158 /** OS-independent 64-bit ftell(). */
 159 gmx_off_t gmx_ftell(FILE *stream);
 160
 161 /** OS-independent truncate(). */
 162 int gmx_truncate(const char *filename, gmx_off_t length);
 163
 164 /*! \brief
 165  * Finds full path for a library file.
 166  *
 167  * Searches first in the current directory, and then in the configured library
 168  * directories.
 169  * Fatal error results if the file is not found in any location.
 170  * The caller is responsible of freeing the returned string.
 171  */
 172 char *gmxlibfn(const char *file);
 173
 174 /*! \brief
 175  * Opens a library file for reading.
 176  *
 177  * Works as gmxlibfn(), except that it opens the file and returns a file
 178  * handle.
 179  */
 180 FILE *libopen(const char *file);
 181
 182 /*! \brief
 183  * More flexible gmxlibfn().
 184  *
 185  * Works as gmxlibfn(), but provides control whether the current working
 186  * directory is searched or not, and whether a missing file is a fatal error or
 187  * not.
 188  */
 189 char *low_gmxlibfn(const char *file, gmx_bool bAddCWD, gmx_bool bFatal);
 190
 191 /*! \brief
 192  * Alternative for libopen() that optionally does not exit.
 193  *
 194  * Works as libopen(), but provides control whether a missing file is a fatal
 195  * error or not.
 196  */
 197 FILE *low_libopen(const char *file, gmx_bool bFatal);
 198
 199
 200 /*! \brief
 201  * Creates unique name for temp file (wrapper around mkstemp).
 202  *
 203  * \p buf should be at least 7 bytes long
 204  */
 205 void gmx_tmpnam(char *buf);
 206
 207 /*! \brief
 208  * OS-independent rename().
 209  *
 210  * Renames/moves a file atomically, if the OS makes that available.
 211  */
 212 int gmx_file_rename(const char *oldname, const char *newname);
 213
 214 /*! \brief
 215  * Copies a file (data only) oldname to newname.
 216  *
 217  * If \p copy_if_empty is `FALSE`, the file won't be copied if it's empty.
 218  */
 219 int gmx_file_copy(const char *oldname, const char *newname, gmx_bool copy_if_empty);
 220
 221 /*! \brief
 222  * OS-independent fsync().
 223  *
 224  * Only use this during checkpointing!
 225  */
 226 int gmx_fsync(FILE *fp);
 227
 228 /*! \brief
 229  * OS-independent chdir().
 230  *
 231  * Exits with a fatal error if changing the directory fails.
 232  */
 233 void gmx_chdir(const char *directory);
 234 /*! \brief
 235  * OS-independent getcwd().
 236  *
 237  * Exits with a fatal error if the call fails.
 238  */
 239 void gmx_getcwd(char *buffer, size_t size);
 240
 241 #ifdef __cplusplus
 242 }
 243
 244 namespace gmx
 245 {
 246
 247 class DataFileFinder;
 248
 249 /*! \brief
 250  * Gets a finder for locating data files from share/top/.
 251  *
 252  * \returns Finder set with setLibraryFileFinder(), or a default finder.
 253  *
 254  * If setLibraryFileFinder() has not been called (or a `NULL` finder has been
 255  * set), a default finder is returned.
 256  * The default finder searches data files from the directory identified by the
 257  * global program context; it does not respect GMXLIB environment variable.
 258  * Calling initForCommandLine() sets a finder that respects GMXLIB.
 259  *
 260  * Does not throw.
 261  *
 262  * See setLibraryFileFinder() for thread safety.
 263  *
 264  * \ingroup module_utility
 265  */
 266 const DataFileFinder &getLibraryFileFinder();
 267 /*! \brief
 268  * Sets a finder for location data files from share/top/.
 269  *
 270  * \param[in] finder  finder to set
 271  *     (can be NULL to restore the default finder).
 272  *
 273  * The library does not take ownership of \p finder.
 274  * The provided object must remain valid until the global instance is changed
 275  * by another call to setLibraryFileFinder().
 276  *
 277  * The global instance is used by gmxlibfn() and libopen().
 278  *
 279  * This method is not thread-safe.  See setProgramContext(); the same
 280  * constraints apply here as well.
 281  *
 282  * Does not throw.
 283  */
 284 void setLibraryFileFinder(const DataFileFinder *finder);
 285
 286 } // namespace gmx
 287 #endif
 288
 289 #endif