annotate scripts/miscellaneous/delete.m @ 14378:dbc99d17f0ad

fact.m: Spelling and punctuation fixes
author Jordi Gutiérrez Hermoso <jordigh@octave.org>
date Thu, 16 Feb 2012 21:44:53 -0500
parents 72c96de7a403
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 13819
diff changeset
1 ## Copyright (C) 2004-2012 John W. Eaton
4691
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
2 ##
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
4 ##
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6405
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6405
diff changeset
8 ## your option) any later version.
4691
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
9 ##
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
14 ##
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6405
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6405
diff changeset
17 ## <http://www.gnu.org/licenses/>.
4691
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
18
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
9316
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
20 ## @deftypefn {Function File} {} delete (@var{file})
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
21 ## @deftypefnx {Function File} {} delete (@var{handle})
8188
946035db5605 delete.m: Permit a vector of handles to be deleted.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
22 ## Delete the named file or graphics handle.
9316
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
23 ##
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
24 ## Deleting graphics objects is the proper way to remove
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
25 ## features from a plot without clearing the entire figure.
13819
9a8763bcf575 delete.m: Update seealso link. Add input validation tests.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
26 ## @seealso{clf, cla, unlink}
4691
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
27 ## @end deftypefn
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
28
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
29 ## Author: jwe
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
30
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
31 function delete (arg)
4691
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
32
13819
9a8763bcf575 delete.m: Update seealso link. Add input validation tests.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
33 if (nargin != 1)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5307
diff changeset
34 print_usage ();
4691
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
35 endif
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
36
13819
9a8763bcf575 delete.m: Update seealso link. Add input validation tests.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
37 if (ischar (arg))
9a8763bcf575 delete.m: Update seealso link. Add input validation tests.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
38 files = glob (arg);
9a8763bcf575 delete.m: Update seealso link. Add input validation tests.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
39 if (isempty (files))
9a8763bcf575 delete.m: Update seealso link. Add input validation tests.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
40 warning ("delete: no such file: %s", arg);
9a8763bcf575 delete.m: Update seealso link. Add input validation tests.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
41 endif
9a8763bcf575 delete.m: Update seealso link. Add input validation tests.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
42 for i = 1:length (files)
9a8763bcf575 delete.m: Update seealso link. Add input validation tests.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
43 file = files{i};
9a8763bcf575 delete.m: Update seealso link. Add input validation tests.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
44 [err, msg] = unlink (file);
9a8763bcf575 delete.m: Update seealso link. Add input validation tests.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
45 if (err)
9a8763bcf575 delete.m: Update seealso link. Add input validation tests.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
46 warning ("delete: %s: %s", file, msg);
9a8763bcf575 delete.m: Update seealso link. Add input validation tests.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
47 endif
9a8763bcf575 delete.m: Update seealso link. Add input validation tests.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
48 endfor
9a8763bcf575 delete.m: Update seealso link. Add input validation tests.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
49 elseif (all (ishandle (arg(:))))
9a8763bcf575 delete.m: Update seealso link. Add input validation tests.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
50 ## Delete a graphics object.
9a8763bcf575 delete.m: Update seealso link. Add input validation tests.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
51 __go_delete__ (arg);
9a8763bcf575 delete.m: Update seealso link. Add input validation tests.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
52 else
9a8763bcf575 delete.m: Update seealso link. Add input validation tests.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
53 error ("delete: first argument must be a filename or graphics handle");
9a8763bcf575 delete.m: Update seealso link. Add input validation tests.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
54 endif
9a8763bcf575 delete.m: Update seealso link. Add input validation tests.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
55
4691
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
56 endfunction
13819
9a8763bcf575 delete.m: Update seealso link. Add input validation tests.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
57
9a8763bcf575 delete.m: Update seealso link. Add input validation tests.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
58
9a8763bcf575 delete.m: Update seealso link. Add input validation tests.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
59 %% Test input validation
9a8763bcf575 delete.m: Update seealso link. Add input validation tests.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
60 %!error delete ()
9a8763bcf575 delete.m: Update seealso link. Add input validation tests.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
61 %!error delete (1, 2)
9a8763bcf575 delete.m: Update seealso link. Add input validation tests.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
62 %!error <first argument must be a filename> delete (struct ())
9a8763bcf575 delete.m: Update seealso link. Add input validation tests.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
63