fbuf: New data structure for buffered file I/O.

[pspp] / src / data / make-file.h

diff --git a/src/data/make-file.h b/src/data/make-file.h
index a2bcc76eb11bdda3ec0917844f0c9b11c1175ced..d908db336681c9b4179c126abe601f7b1c34f126 100644 (file)
--- a/src/data/make-file.h
+++ b/src/data/make-file.h
@@ -23,25 +23,29 @@
 
 struct file_handle;
 
-/* Prepares to atomically replace a (potentially) existing file
-   by a new file., by creating a temporary file with the given
-   PERMISSIONS bits.
+/* Prepares to atomically replace a (potentially) existing file by a new file,
+   by creating a temporary file with the given PERMISSIONS bits.
 
    Special files are an exception: they are not atomically
    replaced but simply opened for writing.
 
-   If successful, stores a stream for it opened according to MODE (which should be
-   "w" or "wb") in *FP.  Returns a ticket that can be used to
-   commit or abort the file replacement.  If neither action has
-   yet been taken, program termination via signal will cause
-   all resources to be released.  The return value must not be
-   explicitly freed.
+   If successful, returns a ticket that can be used to commit or abort the file
+   replacement.  If neither action is taken, program termination via signal
+   will abort.  Depending on the function, stores a file descriptor in *FD or a
+   stream in *FP for the newly opened file.  The descriptor or stream is opened
+   for writing a binary file if BINARY is true, otherwise a text file (this
+   disctinction only matters on Windows).
 
-   The caller is responsible for closing *FP */
+   On error, returns NULL and stores NULL in *FP or -1 in *FD.
+
+   The caller is responsible for closing *FP or *FD. */
 
 struct replace_file *replace_file_start (const struct file_handle *fh,
-                                         const char *mode, mode_t permissions,
+                                         bool binary, mode_t permissions,
                                          FILE **fp);
+struct replace_file *replace_file_start_fd (const struct file_handle *fh,
+                                            bool binary,
+                                            mode_t permissions, int *fd);
 
 /* Commits or aborts the replacement of a (potentially) existing
    file by a new file, using the ticket returned by