Mercurial > octave
view scripts/miscellaneous/inputname.m @ 28789:28de41192f3c
Eliminate unneeded verification of nargin, nargout in m-files.
* FIRfilter.m, FIRfilter_aggregation.m, get.m, polynomial.m,
polynomial_superiorto.m, polynomial2.m, makeUniqueStrings.m, base64decode.m,
base64encode.m, cd.m, lin2mu.m, record.m, sound.m, soundsc.m, accumarray.m,
accumdim.m, bitcmp.m, bitset.m, cart2pol.m, celldisp.m, circshift.m,
cplxpair.m, cumtrapz.m, flip.m, idivide.m, interpft.m, logspace.m, pol2cart.m,
polyarea.m, postpad.m, prepad.m, rat.m, rot90.m, rotdim.m, shift.m, shiftdim.m,
sortrows.m, trapz.m, dsearch.m, dsearchn.m, getappdata.m, getpixelposition.m,
guidata.m, guihandles.m, isappdata.m, listfonts.m, uigetdir.m,
waitforbuttonpress.m, __makeinfo__.m, doc.m, get_first_help_sentence.m,
autumn.m, bone.m, brighten.m, cmpermute.m, cmunique.m, colorcube.m, contrast.m,
cool.m, copper.m, cubehelix.m, flag.m, gray.m, gray2ind.m, hot.m, hsv.m,
im2double.m, im2frame.m, imformats.m, jet.m, lines.m, ocean.m, pink.m, prism.m,
rainbow.m, rgbplot.m, spinmap.m, spring.m, summer.m, viridis.m, white.m,
winter.m, beep.m, importdata.m, is_valid_file_id.m, javachk.m, javaclasspath.m,
findstr.m, genvarname.m, strmatch.m, bandwidth.m, commutation_matrix.m, cond.m,
cross.m, isdefinite.m, ishermitian.m, issymmetric.m, krylov.m, linsolve.m,
logm.m, lscov.m, null.m, ordeig.m, orth.m, rank.m, rref.m, vecnorm.m,
bunzip2.m, citation.m, computer.m, copyfile.m, dir.m, dos.m, fileattrib.m,
gunzip.m, inputParser.m, inputname.m, ismac.m, ispc.m, isunix.m, license.m,
list_primes.m, methods.m, mkdir.m, movefile.m, nargchk.m, news.m,
orderfields.m, recycle.m, tar.m, unix.m, unpack.m, untar.m, unzip.m, ver.m,
version.m, what.m, zip.m, decic.m, fminbnd.m, fminunc.m, fsolve.m, fzero.m,
glpk.m, humps.m, lsqnonneg.m, optimget.m, pqpnonneg.m, sqp.m, pathdef.m,
camlookat.m, hidden.m, specular.m, plotmatrix.m, smooth3.m, sombrero.m,
stemleaf.m, __gnuplot_drawnow__.m, __opengl_info__.m, ancestor.m, cla.m,
close.m, closereq.m, copyobj.m, gca.m, gcf.m, ginput.m, graphics_toolkit.m,
groot.m, hgload.m, hgsave.m, isgraphics.m, ishold.m, linkaxes.m, meshgrid.m,
newplot.m, refresh.m, refreshdata.m, rotate.m, saveas.m, struct2hdl.m, conv.m,
mkpp.m, mpoles.m, padecoef.m, pchip.m, polyder.m, polyfit.m, polygcd.m,
polyint.m, polyout.m, polyval.m, ppder.m, ppint.m, getpref.m, ispref.m,
rmpref.m, profexport.m, profshow.m, powerset.m, arch_fit.m, arma_rnd.m,
blackman.m, detrend.m, diffpara.m, fftconv.m, fftfilt.m, filter2.m, freqz.m,
freqz_plot.m, hamming.m, hanning.m, sinetone.m, sinewave.m, spectral_adf.m,
spectral_xdf.m, stft.m, unwrap.m, gplot.m, ichol.m, ilu.m, spdiags.m, sprand.m,
sprandn.m, spstats.m, svds.m, treelayout.m, treeplot.m, betainc.m,
betaincinv.m, ellipke.m, gammainc.m, gammaincinv.m, legendre.m, pow2.m,
hankel.m, pascal.m, rosser.m, toeplitz.m, bounds.m, corr.m, cov.m, histc.m,
kendall.m, kurtosis.m, mad.m, mode.m, moment.m, prctile.m, quantile.m, range.m,
ranks.m, run_count.m, skewness.m, spearman.m, std.m, var.m, zscore.m,
dec2base.m, dec2bin.m, dec2hex.m, index.m, mat2str.m, native2unicode.m,
ostrsplit.m, strjoin.m, strjust.m, strtok.m, substr.m, unicode2native.m,
untabify.m, __debug_octave__.m, demo.m, example.m, fail.m, oruntests.m,
dump_demos.m, speed.m, test.m, date.m, datenum.m, datestr.m, datevec.m,
is_leap_year.m, now.m, weekday.m:
Eliminate unneeded verification of nargin, nargout in m-files now that
the interpreter checks these values.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 24 Sep 2020 14:44:58 -0700 |
parents | 4e10e25f0fc6 |
children | d8318c12d903 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2004-2020 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 {} {} inputname (@var{n}) ## @deftypefnx {} {} inputname (@var{n}, @var{ids_only}) ## Return the name of the @var{n}-th argument to the calling function. ## ## If the argument is not a simple variable name, return an empty string. ## Examples which will return @qcode{""} are numbers (@code{5.1}), ## expressions (@code{@var{y}/2}), and cell or structure indexing ## (@code{@var{c}@{1@}} or @code{@var{s}.@var{field}}). ## ## @code{inputname} is only useful within a function. When used at the command ## line or within a script it always returns an empty string. ## ## By default, return an empty string if the @var{n}-th argument is not a valid ## variable name. If the optional argument @var{ids_only} is false, return the ## text of the argument even if it is not a valid variable name. This is an ## Octave extension that allows the programmer to view exactly how the function ## was invoked even when the inputs are complex expressions. ## @seealso{nargin, narginchk} ## @end deftypefn ## FIXME: Actually, it probably *isn't* worth fixing, but there are small ## differences between Octave and Matlab. ## ## 1) When called from the top-level or a script, Matlab throws an error ## ## inputname (1) % at command prompt ## % Octave returns "", Matlab throws an error ## ## 2) cell or struct indexing causes all further names to be returned as "" ## ## c = {'a', 'b'} ## y = 1; z = 2; ## func (c, y, z) ## % inputname() would return 'c', 'y', 'z' for the inputs. ## func (c{1}, y, z) ## % inputname() would return '', '', '' for the inputs. ## ## 3) If inputname is not called from a function, Matlab walks up the stack ## until it finds some valid code and then works from there. This could ## be relevant for mex files or anonymous functions. ## ## f = @(x) inputname (x); ## a = 1:4; ## arrayfun (fn, a, 'uniformoutput', false) ## % output is {'fn', 'a', '', ''} function name = inputname (n, ids_only = true) if (nargin < 1) print_usage (); endif if (! isscalar (n) || ! isindex (n)) error ("inputname: N must be a scalar index"); endif try name = evalin ("caller", sprintf ("__varval__ ('.argn.'){%d}", n)); catch name = ""; return; end_try_catch ## For compatibility with Matlab, return empty string if argument name is ## not a valid identifier. if (ids_only && ! isvarname (name)) name = ""; elseif (ids_only) ## More complicated checking is required to verify name (bug #59103). ## NAME may be text, like "Inf", which is an acceptable variable name ## that passes isvarname(), but that does not mean it is an actual ## variable name, rather than a function or IEEE number. try v = evalin ("caller", sprintf ("evalin ('caller', '__varval__ (\"%s\")')", name)); catch name = ""; end_try_catch endif endfunction %!function name = __iname1__ (arg1, arg2, arg3) %! name = inputname (1); %!endfunction %!function name = __iname1_ID__ (arg1, arg2, arg3) %! name = inputname (1, false); %!endfunction %!function name = __iname2__ (arg1, arg2, arg3) %! name = inputname (2); %!endfunction %!function names = __iname3__ (arg1, arg2, arg3) %! names = cell (1, 3); %! for i = 1:3 %! names{i} = inputname (i); %! endfor %!endfunction %!test %! assert (__iname1__ ('xvar'), ""); %! xvar = 1; %! assert (__iname1__ (xvar), "xvar"); %!test %! xvar = 1; yvar = 2; %! assert (__iname2__ (xvar), ""); %! assert (__iname2__ (xvar, yvar), "yvar"); %!test %! xvar = 1; yvar = 2; %! assert (__iname3__ (xvar), {"xvar", "", ""}); %! assert (__iname3__ (xvar, yvar), {"xvar", "yvar", ""}); %! assert (__iname3__ (xvar, 3, yvar), {"xvar", "", "yvar"}); ## Test numbers, expressions, indexing operations %!test %! assert (__iname1__ (1.0), ""); %! x = 1; %! assert (__iname1__ (x / 2), ""); %! assert (__iname1__ (Inf), ""); %!test %! assert (__iname1_ID__ (1.0), "1.0"); %! x = 1; %! assert (__iname1_ID__ (x / 2), "x / 2"); %! assert (__iname1_ID__ (Inf), "Inf"); %!error inputname () %!error inputname (1,2,3) %!error <N must be a scalar> inputname (ones (2,2)) %!error <N must be a scalar index> inputname (-1)