Mercurial > octave
view scripts/strings/validatestring.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) 2008-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/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {@var{validstr} =} validatestring (@var{str}, @var{strarray}) ## @deftypefnx {} {@var{validstr} =} validatestring (@var{str}, @var{strarray}, @var{funcname}) ## @deftypefnx {} {@var{validstr} =} validatestring (@var{str}, @var{strarray}, @var{funcname}, @var{varname}) ## @deftypefnx {} {@var{validstr} =} validatestring (@dots{}, @var{position}) ## Verify that @var{str} is an element, or substring of an element, in ## @var{strarray}. ## ## When @var{str} is a character string to be tested, and @var{strarray} is a ## cell array of strings of valid values, then @var{validstr} will be the ## validated form of @var{str} where validation is defined as @var{str} being ## a member or substring of @var{validstr}. This is useful for both verifying ## and expanding short options, such as @qcode{"r"}, to their longer forms, ## such as @qcode{"red"}. If @var{str} is a substring of @var{validstr}, ## and there are multiple matches, the shortest match will be returned if ## all matches are substrings of each other. Otherwise, an error will be ## raised because the expansion of @var{str} is ambiguous. All comparisons ## are case insensitive. ## ## The additional inputs @var{funcname}, @var{varname}, and @var{position} ## are optional and will make any generated validation error message more ## specific. ## ## Examples: ## @c Set example in small font to prevent overfull line ## ## @smallexample ## @group ## validatestring ("r", @{"red", "green", "blue"@}) ## @result{} "red" ## ## validatestring ("b", @{"red", "green", "blue", "black"@}) ## @result{} error: validatestring: multiple unique matches were found for 'b': ## blue, black ## @end group ## @end smallexample ## ## @seealso{strcmp, strcmpi, validateattributes, inputParser} ## @end deftypefn function str = validatestring (str, strarray, varargin) if (nargin < 2 || nargin > 5) print_usage (); endif ## Process input arguments position = 0; if (! isempty (varargin) && isnumeric (varargin{end})) position = fix (varargin{end}); varargin(end) = []; if (position < 1) error ("validatestring: POSITION must be >= 1"); endif endif funcname = varname = ""; char_idx = cellfun ("isclass", varargin, "char"); n_chararg = sum (char_idx); if (n_chararg > 2) error ("validatestring: invalid number of character inputs (> 3)"); elseif (n_chararg == 2) [funcname, varname] = deal (varargin{char_idx}); elseif (n_chararg == 1) funcname = varargin{char_idx}; endif ## Validate the inputs if (! (ischar (str) && isrow (str))) error ("validatestring: STR must be a single character string"); elseif (! iscellstr (strarray)) error ("validatestring: STRARRAY must be a cellstr"); elseif (! isempty (funcname) && ! isrow (funcname)) error ("validatestring: FUNCNAME must be a single character string"); elseif (! isempty (varname) && ! isrow (varname)) error ("validatestring: VARNAME must be a single character string"); endif ## Make static part of error string that uses funcname, varname, and position if (isempty (funcname)) funcname = "validatestring"; endif errstr = [funcname ": '" str "' "]; if (! isempty (varname)) if (position > 0) errstr = sprintf ("%s(variable %s, argument #%i) ", ... errstr, varname, position); else errstr = sprintf ("%s(variable %s) ", errstr, varname); endif else if (position > 0) errstr = sprintf ("%s(argument #%i) ", errstr, position); endif endif matches = strncmpi (str, strarray(:), numel (str)); nmatches = sum (matches); if (nmatches == 0) error ("%sdoes not match any of\n%s", errstr, sprintf ("'%s', ", strarray{:})(1:end-2)); elseif (nmatches == 1) str = strarray{matches}; else ## Are the matches substrings of each other? ## If true, choose the shortest. If not, raise an error. match_idx = find (matches); match_len = cellfun ("length", strarray(match_idx)); [min_len, min_idx] = min (match_len); short_str = strarray{match_idx(min_idx)}; submatch = strncmpi (short_str, strarray(match_idx), min_len); if (all (submatch)) str = short_str; else error ("%smatches multiple possible values:\n%s", errstr, sprintf ("'%s', ", strarray{match_idx})(1:end-2)); endif endif endfunction %!shared strarray %! strarray = {"octave" "Oct" "octopus" "octaves"}; %!assert (validatestring ("octave", strarray), "octave") %!assert (validatestring ("oct", strarray), "Oct") %!assert (validatestring ("octa", strarray), "octave") %! strarray = {"abc1" "def" "abc2"}; %!assert (validatestring ("d", strarray), "def") %!error <'xyz' does not match any> validatestring ("xyz", strarray) %!error <DUMMY_TEST: 'xyz' does not match any> %! validatestring ("xyz", strarray, "DUMMY_TEST") %!error <DUMMY_TEST: 'xyz' \(variable DUMMY_VAR\) does not match> %! validatestring ("xyz", strarray, "DUMMY_TEST", "DUMMY_VAR") %!error <DUMMY_TEST: 'xyz' \(variable DUMMY_VAR, argument #5\) does> %! validatestring ("xyz", strarray, "DUMMY_TEST", "DUMMY_VAR", 5) %!error <'abc' matches multiple possible values:> validatestring ("abc", strarray) ## Test input validation %!error <Invalid call> validatestring ("xyz") %!error <Invalid call> validatestring ("xyz", {"xyz"}, "3", "4", 5, 6) %!error <POSITION must be .= 1> validatestring ("xyz", {"xyz"}, "3", "4", -5) %!error <invalid number of character inputs> %! validatestring ("xyz", {"xyz"}, "3", "4", "5") %!error <STR must be a single character string> %! validatestring (1, {"xyz"}, "3", "4", 5) %!error <STR must be a single character string> %! validatestring (['xyz';'def'], {"xyz"}, "3", "4", 5) %!error <STRARRAY must be a cellstr> validatestring ("xyz", "xyz", "3", "4", 5) %!error <FUNCNAME must be a single character string> %! validatestring ("xyz", {"xyz"}, ["3";"3"], "4", 5) %!error <VARNAME must be a single character string> %! validatestring ("xyz", {"xyz"}, "3", ["4";"4"], 5)