octave_packages/m/general/isdir.m

   1 ## Copyright (C) 2004-2012 Alois Schloegl
   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} {} isdir (@var{f})
  21 ## Return true if @var{f} is a directory.
  22 ## @seealso{is_absolute_filename, is_rooted_relative_filename}
  23 ## @end deftypefn
  24
  25 function retval = isdir (f)
  26   if (nargin != 1)
  27     print_usage ("isdir");
  28   endif
  29
  30   ## Exist returns an integer but isdir should return a logical.
  31   retval = (exist (f, "dir") == 7);
  32
  33 endfunction
  34
  35 %!error isdir ();
  36 %!error isdir (1, 2);
  37
  38 %!assert (isdir (pwd ()));
  39 %!assert (! isdir ("this is highly unlikely to be a directory name"));