Mercurial > octave
view scripts/miscellaneous/inputname.m @ 27919:1891570abac8
update Octave Project Developers copyright for the new year
In files that have the "Octave Project Developers" copyright notice,
update for 2020.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Mon, 06 Jan 2020 22:29:51 -0500 |
parents | b442ec6dda5c |
children | bd51beb6205e |
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.html/>. ## ## ## 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. As ## an example, a reference to a field in a structure such as @code{s.field} is ## not a simple name and will return @qcode{""}. ## ## @code{inputname} is only useful within a function. When used at the command ## line 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. ## @seealso{nargin, nthargout} ## @end deftypefn function name = inputname (n, ids_only = true) if (nargin < 1 || nargin > 2) print_usage (); endif name = ""; try name = evalin ("caller", sprintf ("__varval__ ('.argn.'){%d}", fix (n))); catch 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 = ""; endif endfunction ## Warning: heap big magic in the following tests!!! ## The test function builds a private context for each test, with only the ## specified values shared between them. It does this using the following ## template: ## ## function [<shared>] = testfn (<shared>) ## <test> ## endfunction ## ## To test inputname, I need a function context invoked with known parameter ## names. So define a couple of shared parameters, et voila!, the test is ## trivial. %!shared hello, worldly %!assert (inputname (1), "hello") %!assert (inputname (2), "worldly") %!assert (inputname (3), "") ## Clear parameter list so that testfn is created with zero inputs/outputs %!shared %!assert (inputname (-1), "") %!assert (inputname (1), "") %!function r = __foo1__ (x, y) %! r = inputname (2); %!endfunction %!assert (__foo1__ (pi, e), "e") %!assert (feval (@__foo1__, pi, e), "e") %!function r = __foo2__ (x, y) %! r = inputname (2, false); %!endfunction %!assert (__foo2__ (pi+1, 2+2), "2 + 2") %!assert (feval (@__foo2__, pi, pi/2), "pi / 2") %!error inputname () %!error inputname (1,2,3)