Mercurial > hg > octave-nkf > gnulib-hg

annotate lib/tempname.h @ 8623:27cfd50b8f6c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix missing escape.
author Bruno Haible <bruno@clisp.org>
date Tue, 03 Apr 2007 22:45:13 +0000
parents 483757159eb6
children bbbbbf4cd1c5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7575
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
1 /* Create a temporary file or directory.
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
2
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
3 Copyright (C) 2006 Free Software Foundation, Inc.
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
4
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
5 This program is free software; you can redistribute it and/or modify
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
6 it under the terms of the GNU General Public License as published by
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
7 the Free Software Foundation; either version 2, or (at your option)
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
8 any later version.
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
9
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
10 This program is distributed in the hope that it will be useful,
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
13 GNU General Public License for more details.
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
14
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
15 You should have received a copy of the GNU General Public License
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
16 along with this program; if not, write to the Free Software Foundation,
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
17 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
18
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
19 /* header written by Eric Blake */
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
20
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
21 /* In gnulib, always prefer large files. GT_FILE maps to
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
22 __GT_BIGFILE, not __GT_FILE, for a reason. */
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
23 #define GT_FILE 1
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
24 #define GT_DIR 2
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
25 #define GT_NOCREATE 3
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
26
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
27 /* Generate a temporary file name based on TMPL. TMPL must match the
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
28 rules for mk[s]temp (i.e. end in "XXXXXX"). The name constructed
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
29 does not exist at the time of the call to gen_tempname. TMPL is
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
30 overwritten with the result.
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
31
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
32 KIND may be one of:
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
33 GT_NOCREATE: simply verify that the name does not exist
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
34 at the time of the call.
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
35 GT_FILE: create a large file using open(O_CREAT|O_EXCL)
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
36 and return a read-write fd. The file is mode 0600.
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
37 GT_DIR: create a directory, which will be mode 0700.
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
38
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
39 We use a clever algorithm to get hard-to-predict names. */
483757159eb6 * MODULES.html.sh: Document tempname.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
40 extern int gen_tempname (char *tmpl, int kind);