pintos-os.org Git - pspp/blob - 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 struct file_handle;
  25
  26 /* Prepares to atomically replace a (potentially) existing file by a new file,
  27    by creating a temporary file with the given PERMISSIONS bits.
  28
  29    Special files are an exception: they are not atomically
  30    replaced but simply opened for writing.
  31
  32    If successful, returns a ticket that can be used to commit or abort the file
  33    replacement.  If neither action is taken, program termination via signal
  34    will abort.  Depending on the function, stores a file descriptor in *FD or a
  35    stream in *FP for the newly opened file.  The descriptor or stream is opened
  36    for writing a binary file if BINARY is true, otherwise a text file (this
  37    disctinction only matters on Windows).
  38
  39    On error, returns NULL and stores NULL in *FP or -1 in *FD.
  40
  41    The caller is responsible for closing *FP or *FD. */
  42
  43 struct replace_file *replace_file_start (const struct file_handle *fh,
  44                                          bool binary, mode_t permissions,
  45                                          FILE **fp);
  46 struct replace_file *replace_file_start_fd (const struct file_handle *fh,
  47                                             bool binary,
  48                                             mode_t permissions, int *fd);
  49
  50 /* Commits or aborts the replacement of a (potentially) existing
  51    file by a new file, using the ticket returned by
  52    replace_file_start.  Returns success. */
  53 bool replace_file_commit (struct replace_file *);
  54 bool replace_file_abort (struct replace_file *);
  55
  56 #endif /* make-file.h */