Mercurial > octave
view scripts/testfun/fail.m @ 30875:5d3faba0342e
doc: Ensure documentation lists output argument when it exists for all m-files.
For new users of Octave it is best to show explicit calling forms
in the documentation and to show a return argument when it exists.
* bp-table.cc, shift.m, accumarray.m, accumdim.m, bincoeff.m, bitcmp.m,
bitget.m, bitset.m, blkdiag.m, celldisp.m, cplxpair.m, dblquad.m, flip.m,
fliplr.m, flipud.m, idivide.m, int2str.m, interpft.m, logspace.m, num2str.m,
polyarea.m, postpad.m, prepad.m, randi.m, repmat.m, rng.m, rot90.m, rotdim.m,
structfun.m, triplequad.m, uibuttongroup.m, uicontrol.m, uipanel.m,
uipushtool.m, uitoggletool.m, uitoolbar.m, waitforbuttonpress.m, help.m,
__additional_help_message__.m, hsv.m, im2double.m, im2frame.m, javachk.m,
usejava.m, argnames.m, char.m, formula.m, inline.m, __vectorize__.m, findstr.m,
flipdim.m, strmatch.m, vectorize.m, commutation_matrix.m, cond.m, cross.m,
duplication_matrix.m, expm.m, orth.m, rank.m, rref.m, trace.m, vech.m, cast.m,
compare_versions.m, delete.m, dir.m, fileattrib.m, grabcode.m, gunzip.m,
inputname.m, license.m, list_primes.m, ls.m, mexext.m, movefile.m,
namelengthmax.m, nargoutchk.m, nthargout.m, substruct.m, swapbytes.m, ver.m,
verLessThan.m, what.m, fminunc.m, fsolve.m, fzero.m, optimget.m, __fdjac__.m,
matlabroot.m, savepath.m, campos.m, camroll.m, camtarget.m, camup.m, camva.m,
camzoom.m, clabel.m, diffuse.m, legend.m, orient.m, rticks.m, specular.m,
thetaticks.m, xlim.m, xtickangle.m, xticklabels.m, xticks.m, ylim.m,
ytickangle.m, yticklabels.m, yticks.m, zlim.m, ztickangle.m, zticklabels.m,
zticks.m, ellipsoid.m, isocolors.m, isonormals.m, stairs.m, surfnorm.m,
__actual_axis_position__.m, __pltopt__.m, close.m, graphics_toolkit.m, pan.m,
print.m, printd.m, __ghostscript__.m, __gnuplot_print__.m, __opengl_print__.m,
rotate3d.m, subplot.m, zoom.m, compan.m, conv.m, poly.m, polyaffine.m,
polyder.m, polyint.m, polyout.m, polyreduce.m, polyvalm.m, roots.m, prefdir.m,
prefsfile.m, profexplore.m, profexport.m, profshow.m, powerset.m, unique.m,
arch_rnd.m, arma_rnd.m, autoreg_matrix.m, bartlett.m, blackman.m, detrend.m,
durbinlevinson.m, fftconv.m, fftfilt.m, fftshift.m, fractdiff.m, hamming.m,
hanning.m, hurst.m, ifftshift.m, rectangle_lw.m, rectangle_sw.m, triangle_lw.m,
sinc.m, sinetone.m, sinewave.m, spectral_adf.m, spectral_xdf.m, spencer.m,
ilu.m, __sprand__.m, sprand.m, sprandn.m, sprandsym.m, treelayout.m, beta.m,
betainc.m, betaincinv.m, betaln.m, cosint.m, expint.m, factorial.m, gammainc.m,
gammaincinv.m, lcm.m, nthroot.m, perms.m, reallog.m, realpow.m, realsqrt.m,
sinint.m, hadamard.m, hankel.m, hilb.m, invhilb.m, magic.m, pascal.m, rosser.m,
toeplitz.m, vander.m, wilkinson.m, center.m, corr.m, cov.m, discrete_cdf.m,
discrete_inv.m, discrete_pdf.m, discrete_rnd.m, empirical_cdf.m,
empirical_inv.m, empirical_pdf.m, empirical_rnd.m, kendall.m, kurtosis.m,
mad.m, mean.m, meansq.m, median.m, mode.m, moment.m, range.m, ranks.m,
run_count.m, skewness.m, spearman.m, statistics.m, std.m, base2dec.m,
bin2dec.m, blanks.m, cstrcat.m, deblank.m, dec2base.m, dec2bin.m, dec2hex.m,
hex2dec.m, index.m, regexptranslate.m, rindex.m, strcat.m, strjust.m,
strtrim.m, strtrunc.m, substr.m, untabify.m, __have_feature__.m,
__prog_output_assert__.m, __run_test_suite__.m, example.m, fail.m, asctime.m,
calendar.m, ctime.m, date.m, etime.m:
Add return arguments to @deftypefn macros where they were missing. Rename
variables in functions (particularly generic "retval") to match documentation.
Rename some return variables for (hopefully) better clarity (e.g., 'ax' to 'hax'
to indicate it is a graphics handle to an axes object).
author | Rik <rik@octave.org> |
---|---|
date | Wed, 30 Mar 2022 20:40:27 -0700 |
parents | 796f54d4ddbf |
children | 597f3ee61a48 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2005-2022 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## 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 ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## ## Original version by Paul Kienzle distributed as free software in the ## public domain. ## -*- texinfo -*- ## @deftypefn {} {@var{status} =} fail (@var{code}) ## @deftypefnx {} {@var{status} =} fail (@var{code}, @var{pattern}) ## @deftypefnx {} {@var{status} =} fail (@var{code}, "warning") ## @deftypefnx {} {@var{status} =} fail (@var{code}, "warning", @var{pattern}) ## ## Return true if @var{code} fails with an error message matching ## @var{pattern}, otherwise produce an error. ## ## @var{code} must be in the form of a string that is passed to the Octave ## interpreter via the @code{evalin} function, i.e., a (quoted) string constant ## or a string variable. ## ## Note that if @var{code} runs successfully, rather than failing, the error ## printed is: ## ## @example ## expected error <.> but got none ## @end example ## ## If called with two arguments, the return value will be true only if ## @var{code} fails with an error message containing @var{pattern} ## (case sensitive). If the code fails with a different error than the one ## specified in @var{pattern} then the message produced is: ## ## @example ## @group ## expected <@var{pattern}> ## but got <text of actual error> ## @end group ## @end example ## ## The angle brackets are not part of the output. ## ## When called with the @qcode{"warning"} option @code{fail} will produce an ## error if executing the code produces no warning. ## @seealso{assert, error} ## @end deftypefn function status = fail (code, pattern, warning_pattern) if (nargin < 1) print_usage (); endif ## Parse input arguments test_warning = false; if (nargin == 1) pattern = ""; elseif (nargin == 2 && ! strcmp (pattern, "warning")) ## Normal error test elseif (nargin >= 2 && strcmp (pattern, "warning")) test_warning = true; if (nargin == 2) pattern = ""; else pattern = warning_pattern; endif else print_usage (); endif ## Match any nonempty message if (isempty (pattern)) pattern = "."; endif ## Allow assert (fail ()) if (nargout) status = true; endif if (test_warning) ## Perform the warning test. ## Clear old warnings. lastwarn (""); ## Make sure warnings are turned on. wstate = warning ("query", "quiet"); warning ("on", "quiet"); try evalin ("caller", [code ";"]); ## Retrieve new warnings. warn = lastwarn (); warning (wstate.state, "quiet"); if (isempty (warn)) msg = sprintf ("expected warning <%s> but got none", pattern); else if (! isempty (regexp (warn, pattern, "once"))) return; endif msg = sprintf ("expected warning <%s>\nbut got <%s>", pattern, warn); endif catch warning (wstate.state, "quiet"); err = lasterr (); msg = sprintf ("expected warning <%s>\nbut got error <%s>", pattern, err); end_try_catch else ## Perform the error test. try evalin ("caller", [code ";"]); msg = sprintf ("expected error <%s> but got none", pattern); catch err = lasterr (); if (! isempty (regexp (err, pattern, "once"))) return; endif msg = sprintf ("expected error <%s>\nbut got <%s>", pattern, err); end_try_catch endif ## If we get here, then code didn't fail or error didn't match. error (msg); endfunction %!fail ("[1,2]*[2,3]", "nonconformant") %!fail ("fail ('[1,2]*[2;3]', 'nonconformant')", "expected error <nonconformant> but got none") %!fail ("fail ('[1,2]*[2,3]', 'usage:')", "expected error <usage:>\nbut got.*nonconformant") %!fail ("warning ('test warning')", "warning", "test warning") %!fail ("warning ('next test')", 'warning', 'next test') ## Test that fail() itself will generate an error %!error <expected error> fail ("1") %!error <'__a__' undefined> fail ("__a__*[2;3]", "nonconformant") %!error <expected error .usage:> fail ("__a__*[2,3]", "usage:") %!error <warning failure> fail ("warning ('warning failure')", "warning", "success") ## Test input validation %!error <Invalid call> fail () %!error fail (1, "nowarning", "foo")