update packages

[CreaPhase.git] / octave_packages / m / testfun / example.m

diff --git a/octave_packages/m/testfun/example.m b/octave_packages/m/testfun/example.m
new file mode 100644 (file)
index 0000000..15f5256
--- /dev/null
+++ b/octave_packages/m/testfun/example.m
@@ -0,0 +1,104 @@
+## Copyright (C) 2000-2012 Paul Kienzle
+##
+## This file is part of Octave.
+##
+## Octave is free software; you can redistribute it and/or modify it
+## under the terms of the GNU General Public License as published by
+## the Free Software Foundation; either version 3 of the License, or (at
+## your option) any later version.
+##
+## Octave is distributed in the hope that it will be useful, but
+## WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+## General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with Octave; see the file COPYING.  If not, see
+## <http://www.gnu.org/licenses/>.
+
+## -*- texinfo -*-
+## @deftypefn  {Command} {} example @var{name}
+## @deftypefnx {Command} {} example @var{name} @var{n}
+## @deftypefnx {Function File} {} example ('@var{name}')
+## @deftypefnx {Function File} {} example ('@var{name}', @var{n})
+## @deftypefnx {Function File} {[@var{s}, @var{idx}] =} example (@dots{})
+##
+## Display the code for example @var{n} associated with the function
+## '@var{name}', but do not run it.  If @var{n} is not specified, all examples
+## are displayed.
+##
+## When called with output arguments, the examples are returned in the form of
+## a string @var{s}, with @var{idx} indicating the ending position of the
+## various examples.
+##
+## See @code{demo} for a complete explanation.
+## @seealso{demo, test}
+## @end deftypefn
+
+function [code_r, idx_r] = example (name, n)
+
+  if (nargin < 1 || nargin > 2)
+    print_usage ();
+  endif
+
+  if (nargin < 2)
+    n = 0;
+  elseif (ischar (n))
+    n = str2double (n);
+  endif
+
+  [code, idx] = test (name, "grabdemo");
+  if (nargout > 0)
+    if (n > 0)
+      if (n <= length (idx))
+        code_r = code(idx(n):idx(n+1)-1);
+        idx_r = [1, length(code_r)+1];
+      else
+        code_r = "";
+        idx_r = [];
+      endif
+    else
+      code_r = code;
+      idx_r = idx;
+    endif
+  else
+    if (n > 0)
+      doidx = n;
+    else
+      doidx = 1:length(idx)-1;
+    endif
+    if (isempty (idx))
+      warning ("no example available for %s", name);
+      return;
+    elseif (n >= length(idx))
+      warning ("only %d examples available for %s", length(idx)-1, name);
+      return;
+    endif
+
+    for i = 1:length (doidx)
+      block = code(idx(doidx(i)):idx(doidx(i)+1)-1);
+      printf ("%s example %d:%s\n\n", name, doidx(i), block);
+    endfor
+  endif
+
+endfunction
+
+
+%!## warning: don't modify the demos without modifying the tests!
+%!demo
+%! example ('example');
+%!demo
+%! t=0:0.01:2*pi; x = sin(t);
+%! plot (t,x)
+
+%!assert (example('example',1), "\n example ('example');");
+%!test
+%! [code, idx] = example ('example');
+%! assert (code, ...
+%!         "\n example ('example');\n t=0:0.01:2*pi; x = sin(t);\n plot (t,x)")
+%! assert (idx, [1, 23, 63]);
+
+%% Test input validation
+%!error example
+%!error example ('example', 3, 5)
+