########################################################################
##
## Copyright (C) 2009-2021 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or .
##
## 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
## .
##
########################################################################
## -*- texinfo -*-
## @deftypefn {} {} which name @dots{}
## Display the type of each @var{name}.
##
## If @var{name} is defined from a function file, the full name of the file is
## also displayed.
## @seealso{help, lookfor}
## @end deftypefn
function varargout = which_own (varargin)
if (nargin == 0 || ! iscellstr (varargin))
print_usage_own ();
endif
if (strcmp (varargin (end), "-all"))
##For loop so the removal of a path due to the search of one file doesn't
##affect the rest of the files
for i = 1:nargin-1
paths = char ([]);
do
m = __which__ (varargin{i});
if (isempty (m.file))
break;
endif
which_aux (m, 1, nargout);
rmpath (m.file (1: (strfind (m.file, "/") (end))));
paths = [paths ":" m.file(1:strfind(m.file, "/") (end))];
until (0)
addpath (paths);
endfor
else
m = __which__ (varargin{:});
which_aux (m, nargin, nargout);
endif
endfunction
##Auxillary which function
function varargout = which_aux (m, n_in, n_out)
## Check whether each name is a variable, variables take precedence over
## functions in name resolution.
for i = 1:n_in
m(i).is_variable = evalin ("caller",
['exist ("' undo_string_escapes(m(i).name) '", "var")'], "");
if (m(i).is_variable)
m(i).file = "variable";
endif
endfor
if (n_out == 0)
for i = 1:n_in
if (m(i).is_variable)
printf ("'%s' is a variable\n", m(i).name);
elseif (isempty (m(i).file))
if (! isempty (m(i).type))
printf ("'%s' is a %s\n",
m(i).name, m(i).type);
endif
else
if (isempty (m(i).type))
n_in
m(i)
if (isfolder (m(i).file))
printf ("'%s' is the directory %s\n",
m(i).name, m(i).file);
else
printf ("'%s' is the file %s\n",
m(i).name, m(i).file);
endif
else
printf ("'%s' is a %s from the file %s\n",
m(i).name, m(i).type, m(i).file);
endif
endif
endfor
else
n_out
varargout = {m.file};
## Return type, instead of "", for built-in classes (bug #50541).
## FIXME: remove code if __which__ is updated to return path for classes
idx = find (cellfun ("isempty", varargout));
if (idx)
varargout(idx) = m(idx).type;
endif
endif
endfunction
%!test
%! str = which ("ls");
%! assert (str(end-17:end), fullfile ("miscellaneous", "ls.m"));
%!test
%! str = which ("fftw");
%! assert (str(end-7:end), "fftw.oct");
%!test
%! str = which ("inputParser");
%! assert (str, "built-in function");
%!test
%! x = 3;
%! str = which ("x");
%! assert (str, "variable");
%!assert (which ("__NO_SUCH_NAME__"), "")
%!test
%! str = which ("fftw");
%! assert (str(end-7:end), "fftw.oct");
%! fftw = 12;
%! str = which ("fftw");
%! assert (str, "variable");
%! clear fftw;
%! str = which ("fftw");
%! assert (str(end-7:end), "fftw.oct");
%!error which ()
%!error which (1)