src/data/make-file.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2004, 2010 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation, either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  16
  17 #ifndef MAKE_FILE_H
  18 #define MAKE_FILE_H
  19
  20 #include <stdbool.h>
  21 #include <stdio.h>
  22 #include <sys/types.h>
  23
  24 /* Creates a temporary file and stores its name in *FILE_NAME and
  25    a file descriptor for it in *FD.  Returns success.  Caller is
  26    responsible for freeing *FILE_NAME. */
  27 int make_temp_file (int *fd, char **file_name);
  28
  29
  30 /* Creates a temporary file and stores its name in *FILE_NAME and
  31    a file stream for it in *FP.  Returns success.  Caller is
  32    responsible for freeing *FILE_NAME. */
  33 int make_unique_file_stream (FILE **fp, char **file_name) ;
  34
  35
  36 /* Prepares to atomically replace a (potentially) existing file
  37    by a new file, by creating a temporary file with the given
  38    PERMISSIONS bits in the same directory as *FILE_NAME.
  39
  40    Special files are an exception: they are not atomically
  41    replaced but simply opened for writing.
  42
  43    If successful, stores the temporary file's name in *TMP_NAME
  44    and a stream for it opened according to MODE (which should be
  45    "w" or "wb") in *FP.  Returns a ticket that can be used to
  46    commit or abort the file replacement.  If neither action has
  47    yet been taken, program termination via signal will cause
  48    *TMP_FILE to be unlinked.
  49
  50    The caller is responsible for closing *FP, but *TMP_NAME is
  51    owned by the callee. */
  52 struct replace_file *replace_file_start (const char *file_name,
  53                                          const char *mode, mode_t permissions,
  54                                          FILE **fp, char **tmp_name);
  55
  56 /* Commits or aborts the replacement of a (potentially) existing
  57    file by a new file, using the ticket returned by
  58    replace_file_start.  Returns success. */
  59 bool replace_file_commit (struct replace_file *);
  60 bool replace_file_abort (struct replace_file *);
  61
  62 #endif /* make-file.h */