+2020-07-04 Bruno Haible <bruno@clisp.org>
+
+ clean-temp: Improve comments.
+ * lib/clean-temp.h (open_temp, fopen_temp, close_temp, fclose_temp,
+ fwriteerror_temp, close_stream_temp): Clarify intended use.
+ * lib/clean-temp.c: Likewise.
+
2020-07-04 Bruno Haible <bruno@clisp.org>
clean-temp: Make multithread-safe, part 2.
}
/* Open a temporary file in a temporary directory.
- Registers the resulting file descriptor to be closed. */
+ FILE_NAME must already have been passed to register_temp_file.
+ Registers the resulting file descriptor to be closed.
+ DELETE_ON_CLOSE indicates whether the file can be deleted when the resulting
+ file descriptor or stream is closed. */
int
open_temp (const char *file_name, int flags, mode_t mode, bool delete_on_close)
{
}
/* Open a temporary file in a temporary directory.
- Registers the resulting file descriptor to be closed. */
+ FILE_NAME must already have been passed to register_temp_file.
+ Registers the resulting file descriptor to be closed.
+ DELETE_ON_CLOSE indicates whether the file can be deleted when the resulting
+ file descriptor or stream is closed. */
FILE *
fopen_temp (const char *file_name, const char *mode, bool delete_on_close)
{
}
/* Close a temporary file in a temporary directory.
+ FD must have been returned by open_temp.
Unregisters the previously registered file descriptor. */
int
close_temp (int fd)
}
/* Close a temporary file in a temporary directory.
+ FP must have been returned by fopen_temp, or by fdopen on a file descriptor
+ returned by open_temp.
Unregisters the previously registered file descriptor. */
int
fclose_temp (FILE *fp)
#if GNULIB_FWRITEERROR
/* Like fwriteerror.
+ FP must have been returned by fopen_temp, or by fdopen on a file descriptor
+ returned by open_temp.
Unregisters the previously registered file descriptor. */
int
fwriteerror_temp (FILE *fp)
#if GNULIB_CLOSE_STREAM
/* Like close_stream.
+ FP must have been returned by fopen_temp, or by fdopen on a file descriptor
+ returned by open_temp.
Unregisters the previously registered file descriptor. */
int
close_stream_temp (FILE *fp)
extern int cleanup_temp_dir (struct temp_dir *dir);
/* Open a temporary file in a temporary directory.
+ FILE_NAME must already have been passed to register_temp_file.
Registers the resulting file descriptor to be closed.
DELETE_ON_CLOSE indicates whether the file can be deleted when the resulting
file descriptor or stream is closed. */
bool delete_on_close);
/* Close a temporary file in a temporary directory.
+ FD must have been returned by open_temp.
Unregisters the previously registered file descriptor. */
extern int close_temp (int fd);
+
+/* Close a temporary file in a temporary directory.
+ FP must have been returned by fopen_temp, or by fdopen on a file descriptor
+ returned by open_temp.
+ Unregisters the previously registered file descriptor. */
extern int fclose_temp (FILE *fp);
/* Like fwriteerror.
+ FP must have been returned by fopen_temp, or by fdopen on a file descriptor
+ returned by open_temp.
Unregisters the previously registered file descriptor. */
extern int fwriteerror_temp (FILE *fp);
/* Like close_stream.
+ FP must have been returned by fopen_temp, or by fdopen on a file descriptor
+ returned by open_temp.
Unregisters the previously registered file descriptor. */
extern int close_stream_temp (FILE *fp);