annotate scripts/deprecated/octave_tmp_file_name.m @ 20279:db30302bedc3

Added tag rc-4-0-0-3 for changeset 065f933ef083
author John W. Eaton <jwe@octave.org>
date Fri, 10 Apr 2015 14:41:21 -0400
parents 4197fc428c7d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19898
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19842
diff changeset
1 ## Copyright (C) 2014-2015 John W. Eaton
19460
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
2 ##
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
3 ## This file is part of Octave.
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
4 ##
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
8 ## your option) any later version.
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
9 ##
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
13 ## General Public License for more details.
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
14 ##
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
18
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
19 ## -*- texinfo -*-
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
20 ## @deftypefn {Built-in Function} {@var{fname} =} octave_tmp_file_name ()
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
21 ## @deftypefnx {Built-in Function} {@var{fname} =} octave_tmp_file_name (@var{dir})
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
22 ## @deftypefnx {Built-in Function} {@var{fname} =} octave_tmp_file_name (@var{dir}, @var{prefix})
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
23 ##
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
24 ## @code{octave_tmp_file_name} is deprecated and will be removed in Octave
19842
ebd27d8c63fd update default branch to release as 4.0
John W. Eaton <jwe@octave.org>
parents: 19794
diff changeset
25 ## version 4.4. Use @code{tempname} for equivalent functionality.
19460
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
26 ##
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
27 ## Return a unique temporary file name as a string.
19794
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19460
diff changeset
28 ##
19460
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
29 ## If @var{prefix} is omitted, a value of @qcode{"oct-"} is used.
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
30 ## If @var{dir} is also omitted, the default directory for temporary files
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
31 ## (@code{P_tmpdir} is used. If @var{dir} is provided, it must exist,
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
32 ## otherwise the default directory for temporary files is used.
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
33 ## @seealso{tempname, tmpnam, mkstemp, tempdir, P_tmpdir, tmpfile}
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
34 ## @end deftypefn
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
35
19842
ebd27d8c63fd update default branch to release as 4.0
John W. Eaton <jwe@octave.org>
parents: 19794
diff changeset
36 ## Deprecated in version 4.0
19460
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
37
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
38 function filename = octave_tmp_file_name (varargin)
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
39
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
40 persistent warned = false;
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
41 if (! warned)
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
42 warned = true;
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
43 warning ("Octave:deprecated-function",
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
44 "octave_tmp_file_name is obsolete and will be removed from a future version of Octave, please use tempname instead");
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
45 endif
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
46
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
47 filename = tmpnam (varargin{:});
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
48
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
49 endfunction
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
50
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
51
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
52 %!assert (1)
e5a1e7951908 Deprecate octave_tmp_file_name.
Rik <rik@octave.org>
parents:
diff changeset
53