octave_packages/m/miscellaneous/delete.m

   1 ## Copyright (C) 2004-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} {} delete (@var{file})
  21 ## @deftypefnx {Function File} {} delete (@var{handle})
  22 ## Delete the named file or graphics handle.
  23 ##
  24 ## Deleting graphics objects is the proper way to remove
  25 ## features from a plot without clearing the entire figure.
  26 ## @seealso{clf, cla, unlink}
  27 ## @end deftypefn
  28
  29 ## Author: jwe
  30
  31 function delete (arg)
  32
  33   if (nargin != 1)
  34     print_usage ();
  35   endif
  36
  37   if (ischar (arg))
  38     files = glob (arg);
  39     if (isempty (files))
  40       warning ("delete: no such file: %s", arg);
  41     endif
  42     for i = 1:length (files)
  43       file = files{i};
  44       [err, msg] = unlink (file);
  45       if (err)
  46         warning ("delete: %s: %s", file, msg);
  47       endif
  48     endfor
  49   elseif (all (ishandle (arg(:))))
  50     ## Delete a graphics object.
  51     __go_delete__ (arg);
  52   else
  53     error ("delete: first argument must be a filename or graphics handle");
  54   endif
  55
  56 endfunction
  57
  58
  59 %% Test input validation
  60 %!error delete ()
  61 %!error delete (1, 2)
  62 %!error <first argument must be a filename> delete (struct ())
  63