octave_packages/m/miscellaneous/tempdir.m

   1 ## Copyright (C) 2003-2012 John W. Eaton
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn {Function File} {@var{dir} =} tempdir ()
  21 ## Return the name of the system's directory for temporary files.
  22 ## @end deftypefn
  23
  24 function dirname = tempdir ()
  25
  26   dirname = getenv ("TMPDIR");
  27   if (isempty (dirname))
  28     dirname = P_tmpdir;
  29   endif
  30
  31   if (! strcmp (dirname(end), filesep))
  32     dirname = cstrcat (dirname, filesep);
  33   endif
  34
  35   if (! isdir (dirname))
  36     warning ("tempdir: `%s' does not exist or is not a directory", dirname);
  37   endif
  38
  39 endfunction
  40
  41
  42 %!assert (ischar (tempdir ()))
  43
  44 %!test
  45 %! old_wstate = warning ("query");
  46 %! warning ("off");
  47 %! old_tmpdir = getenv ("TMPDIR");
  48 %! unwind_protect
  49 %!   setenv ("TMPDIR", "__MY_TMP_DIR__");
  50 %!   assert (tempdir (), ["__MY_TMP_DIR__" filesep()]);
  51 %! unwind_protect_cleanup
  52 %!   setenv ("TMPDIR", old_tmpdir);
  53 %!   warning (old_wstate);
  54 %! end_unwind_protect
  55