octave_packages/m/io/is_valid_file_id.m

   1 ## Copyright (C) 2010-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} {} is_valid_file_id (@var{fid})
  21 ## Return true if @var{fid} refers to an open file.
  22 ## @seealso{fopen}
  23 ## @end deftypefn
  24
  25 function retval = is_valid_file_id (fid)
  26
  27   retval = false;
  28
  29   if (nargin == 1)
  30     try
  31       if (isscalar (fid))
  32         [file, mode, arch] = fopen (fid);
  33         retval = ! isempty (file);
  34       endif
  35     end_try_catch
  36   else
  37     print_usage ();
  38   endif
  39
  40 endfunction
  41
  42 %!assert (is_valid_file_id (stdout))
  43 %!assert (! is_valid_file_id ([1,2;3,4]))
  44 %!assert (! is_valid_file_id ("not_a_file_id"))
  45 %!assert (! is_valid_file_id (-1))
  46 %!assert (! is_valid_file_id (pi))