Added the '=' to the plot subcommand's documentation.
[pspp-builds.git] / src / data / make-file.h
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2004 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 MKFILE_H
18 #define MKFILE_H
19
20
21 /* Creates a temporary file and stores its name in *FILE_NAME and
22    a file descriptor for it in *FD.  Returns success.  Caller is
23    responsible for freeing *FILE_NAME. */
24 int make_temp_file (int *fd, char **file_name);
25
26
27 /* Creates a temporary file and stores its name in *FILE_NAME and
28    a file stream for it in *FP.  Returns success.  Caller is
29    responsible for freeing *FILE_NAME. */
30 int make_unique_file_stream (FILE **fp, char **file_name) ;
31
32
33 /* Prepares to atomically replace a (potentially) existing file
34    by a new file, by creating a temporary file with the given
35    PERMISSIONS bits in the same directory as *FILE_NAME.
36
37    Special files are an exception: they are not atomically
38    replaced but simply opened for writing.
39
40    If successful, stores the temporary file's name in *TMP_NAME
41    and a stream for it opened according to MODE (which should be
42    "w" or "wb") in *FP.  Returns a ticket that can be used to
43    commit or abort the file replacement.  If neither action has
44    yet been taken, program termination via signal will cause
45    *TMP_FILE to be unlinked.
46
47    The caller is responsible for closing *FP, but *TMP_NAME is
48    owned by the callee. */
49 struct replace_file *replace_file_start (const char *file_name,
50                                          const char *mode, mode_t permissions,
51                                          FILE **fp, char **tmp_name);
52
53 /* Commits or aborts the replacement of a (potentially) existing
54    file by a new file, using the ticket returned by
55    replace_file_start.  Returns success. */
56 bool replace_file_commit (struct replace_file *);
57 bool replace_file_abort (struct replace_file *);
58
59 #endif /* make-file.h */