annotate scripts/miscellaneous/recycle.m @ 19631:db92e7e28e1f

strip trailing whitespace from most source files * NEWS, doc/interpreter/contributors.in, doc/interpreter/func.txi, doc/interpreter/genpropdoc.m, doc/interpreter/octave_logo.eps, doc/interpreter/plot.txi, doc/interpreter/stmt.txi, examples/data/Makefile.am, libinterp/corefcn/data.cc, libinterp/corefcn/debug.cc, libinterp/corefcn/error.cc, libinterp/corefcn/file-io.cc, libinterp/corefcn/gl-render.cc, libinterp/corefcn/graphics.cc, libinterp/corefcn/graphics.in.h, libinterp/corefcn/load-path.cc, libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc, libinterp/corefcn/strfind.cc, libinterp/corefcn/toplev.cc, libinterp/corefcn/toplev.h, libinterp/corefcn/urlwrite.cc, libinterp/corefcn/variables.cc, libinterp/octave-value/ov-classdef.cc, libinterp/octave-value/ov-classdef.h, libinterp/octave.cc, libinterp/parse-tree/lex.h, libinterp/parse-tree/oct-parse.in.yy, libinterp/parse-tree/pt-classdef.h, liboctave/system/file-ops.cc, liboctave/system/oct-env.cc, m4/acinclude.m4, scripts/deprecated/finite.m, scripts/deprecated/fmod.m, scripts/deprecated/fnmatch.m, scripts/deprecated/luinc.m, scripts/deprecated/octave_tmp_file_name.m, scripts/deprecated/syl.m, scripts/deprecated/usage.m, scripts/general/inputParser.m, scripts/general/interp1.m, scripts/general/interp2.m, scripts/general/interp3.m, scripts/general/isequal.m, scripts/general/private/__isequal__.m, scripts/geometry/voronoi.m, scripts/image/image.m, scripts/image/imshow.m, scripts/image/ind2rgb.m, scripts/linear-algebra/bandwidth.m, scripts/linear-algebra/isbanded.m, scripts/miscellaneous/bzip2.m, scripts/miscellaneous/cast.m, scripts/miscellaneous/copyfile.m, scripts/miscellaneous/delete.m, scripts/miscellaneous/fullfile.m, scripts/miscellaneous/getappdata.m, scripts/miscellaneous/gunzip.m, scripts/miscellaneous/isappdata.m, scripts/miscellaneous/ls.m, scripts/miscellaneous/mex.m, scripts/miscellaneous/movefile.m, scripts/miscellaneous/orderfields.m, scripts/miscellaneous/recycle.m, scripts/miscellaneous/rmappdata.m, scripts/miscellaneous/setfield.m, scripts/miscellaneous/symvar.m, scripts/miscellaneous/tar.m, scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m, scripts/miscellaneous/ver.m, scripts/miscellaneous/what.m, scripts/miscellaneous/xor.m, scripts/miscellaneous/zip.m, scripts/optimization/fminbnd.m, scripts/optimization/sqp.m, scripts/path/private/getsavepath.m, scripts/path/savepath.m, scripts/pkg/pkg.m, scripts/pkg/private/installed_packages.m, scripts/plot/draw/plotyy.m, scripts/plot/draw/polar.m, scripts/plot/draw/private/__quiver__.m, scripts/plot/draw/private/__scatter__.m, scripts/plot/draw/private/__stem__.m, scripts/plot/draw/surface.m, scripts/plot/draw/surfnorm.m, scripts/plot/util/copyobj.m, scripts/plot/util/hgload.m, scripts/plot/util/hgsave.m, scripts/plot/util/isprop.m, scripts/plot/util/linkprop.m, scripts/plot/util/private/__go_draw_axes__.m, scripts/set/setdiff.m, scripts/set/union.m, scripts/signal/periodogram.m, scripts/sparse/eigs.m, scripts/sparse/ilu.m, scripts/sparse/qmr.m, scripts/sparse/sprand.m, scripts/sparse/sprandn.m, scripts/specfun/beta.m, scripts/specfun/ellipke.m, scripts/specfun/isprime.m, scripts/statistics/base/lscov.m, scripts/testfun/__run_test_suite__.m, scripts/testfun/test.m: Strip trailing whitespace.
author John W. Eaton <jwe@octave.org>
date Tue, 20 Jan 2015 10:29:54 -0500
parents cbce5d1bcaf9
children 4197fc428c7d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17744
d63878346099 maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents: 15776
diff changeset
1 ## Copyright (C) 2012-2013 John W. Eaton
13840
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
2 ##
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
3 ## This file is part of Octave.
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
4 ##
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
8 ## your option) any later version.
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
9 ##
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
13 ## General Public License for more details.
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
14 ##
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
18
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
19 ## -*- texinfo -*-
15776
169a47c5e254 recycle.m: Fix docstring.
Rik <rik@octave.org>
parents: 15467
diff changeset
20 ## @deftypefn {Function File} {@var{current_state} =} recycle ()
169a47c5e254 recycle.m: Fix docstring.
Rik <rik@octave.org>
parents: 15467
diff changeset
21 ## @deftypefnx {Function File} {@var{old_state} =} recycle (@var{new_state})
13918
043aead8ed89 Remove recycle from list of unimplemented functions
Rik <octave@nomad.inbox5.com>
parents: 13840
diff changeset
22 ## Query or set the preference for recycling deleted files.
13840
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
23 ##
19225
6cf253a39fde recycle.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
24 ## When recycling is enabled, commands which would permanently erase files
6cf253a39fde recycle.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
25 ## instead move them to a temporary location (such as the directory labeled
6cf253a39fde recycle.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
26 ## Trash).
6cf253a39fde recycle.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
27 ##
19439
cbce5d1bcaf9 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 19225
diff changeset
28 ## Programming Note: This function is provided for @sc{matlab} compatibility,
cbce5d1bcaf9 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 19225
diff changeset
29 ## but recycling is not implemented in Octave. To help avoid accidental data
cbce5d1bcaf9 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 19225
diff changeset
30 ## loss an error will be raised if an attempt is made to enable file
cbce5d1bcaf9 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 19225
diff changeset
31 ## recycling.
19225
6cf253a39fde recycle.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
32 ## @seealso{delete, rmdir}
13840
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
33 ## @end deftypefn
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
34
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
35 ## Author: jwe
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
36
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
37 function retval = recycle (state)
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
38
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
39 persistent current_state = "off";
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
40
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
41 if (nargin > 1)
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
42 print_usage ();
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
43 endif
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
44
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
45 if (nargin == 0 || nargout > 0)
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
46 retval = current_state;
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
47 endif
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
48
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
49 if (nargin == 1)
19225
6cf253a39fde recycle.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
50 if (! ischar (state))
6cf253a39fde recycle.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
51 error ("recycle: STATE must be a character string");
6cf253a39fde recycle.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
52 endif
19631
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19439
diff changeset
53
19225
6cf253a39fde recycle.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
54 if (strcmpi (state, "on"))
6cf253a39fde recycle.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
55 error ("recycle: recycling files is not implemented");
6cf253a39fde recycle.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
56 elseif (strcmpi (state, "off"))
6cf253a39fde recycle.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
57 current_state = "off";
13840
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
58 else
19225
6cf253a39fde recycle.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
59 error ("recycle: invalid value of STATE = '%s'", state);
13840
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
60 endif
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
61 endif
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
62
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
63 endfunction
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
64
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
65
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
66 %!test
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
67 %! recycle ("off");
69afe121f07e provide parial implementation of the recycle function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
68 %! assert (recycle ("off"), "off");
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
69
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
70 %!error recycle ("on", "and I mean it")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
71 %!error <STATE must be a character string> recycle (1)
19225
6cf253a39fde recycle.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
72 %!error <recycling files is not implemented> recycle ("on")
6cf253a39fde recycle.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
73 %!error <invalid value of STATE = 'foobar'> recycle ("foobar")
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
74