octave: scripts/help/which.m annotate

annotate scripts/help/which.m @ 23295:c1362a71fb0e

which.m: Return a non-empty string for built-in classes and command line fcns (bug #50541); * which.m: Check return cellstr for empty values. Replace empty values with the "type" field. * symtab.cc: Update BIST tests for new behavior of which.

author	Rik <rik@octave.org>
date	Thu, 16 Mar 2017 12:30:13 -0700
parents	092078913d54
children	194eb4bd202b

rev	line source
23219 3ac9f9ecfae5 maint: Update copyright dates. John W. Eaton <jwe@octave.org> parents: 22430 diff changeset	1 ## Copyright (C) 2009-2017 John W. Eaton
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	2 ##
11104 2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10549 diff changeset	3 ## This file is part of Octave.
2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10549 diff changeset	4 ##
2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10549 diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	6 ## under the terms of the GNU General Public License as published by
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22430 diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22430 diff changeset	8 ## (at your option) any later version.
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	9 ##
11104 2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10549 diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22430 diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22430 diff changeset	13 ## GNU General Public License for more details.
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	14 ##
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	15 ## You should have received a copy of the GNU General Public License
11104 2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10549 diff changeset	16 ## along with Octave; see the file COPYING. If not, see
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	17 ## <http://www.gnu.org/licenses/>.
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	18
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	19 ## -- texinfo --
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20158 diff changeset	20 ## @deftypefn {} {} which name @dots{}
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	21 ## Display the type of each @var{name}.
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	22 ##
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	23 ## If @var{name} is defined from a function file, the full name of the file is
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	24 ## also displayed.
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	25 ## @seealso{help, lookfor}
11547 e1851653d59c Eliminate @deffn macros. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	26 ## @end deftypefn
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	27
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	28 function varargout = which (varargin)
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	29
20922 49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20852 diff changeset	30 if (nargin == 0 \|\| ! iscellstr (varargin))
49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20852 diff changeset	31 print_usage ();
49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20852 diff changeset	32 endif
49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20852 diff changeset	33
49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20852 diff changeset	34 m = __which__ (varargin{:});
49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20852 diff changeset	35
49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20852 diff changeset	36 ## Check whether each name is a variable, variables take precedence over
49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20852 diff changeset	37 ## functions in name resolution.
49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20852 diff changeset	38 for i = 1:nargin
49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20852 diff changeset	39 m(i).is_variable = evalin ("caller",
22430 18b863e3b1e2 Properly display help for operators (bug #48975). Rik <rik@octave.org> parents: 22323 diff changeset	40 ['exist ("' undo_string_escapes(m(i).name) '", "var")'], false);
20922 49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20852 diff changeset	41 if (m(i).is_variable)
49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20852 diff changeset	42 m(i).file = "variable";
49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20852 diff changeset	43 endif
49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20852 diff changeset	44 endfor
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	45
20922 49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20852 diff changeset	46 if (nargout == 0)
18451 2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	47 for i = 1:nargin
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	48 if (m(i).is_variable)
21634 96518f623c91 Backed out changeset dcf8922b724b Mike Miller <mtmiller@octave.org> parents: 21633 diff changeset	49 printf ("'%s' is a variable\n", m(i).name);
20922 49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20852 diff changeset	50 elseif (isempty (m(i).file))
49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20852 diff changeset	51 if (! isempty (m(i).type))
21634 96518f623c91 Backed out changeset dcf8922b724b Mike Miller <mtmiller@octave.org> parents: 21633 diff changeset	52 printf ("'%s' is a %s\n",
20922 49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20852 diff changeset	53 m(i).name, m(i).type);
49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20852 diff changeset	54 endif
49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20852 diff changeset	55 else
49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20852 diff changeset	56 if (isempty (m(i).type))
23046 168a18a57fc2 which.m: change output to distinguish between files and directories. Rik <rik@octave.org> parents: 22755 diff changeset	57 if (isdir (m(i).file))
168a18a57fc2 which.m: change output to distinguish between files and directories. Rik <rik@octave.org> parents: 22755 diff changeset	58 printf ("'%s' is the directory %s\n",
168a18a57fc2 which.m: change output to distinguish between files and directories. Rik <rik@octave.org> parents: 22755 diff changeset	59 m(i).name, m(i).file);
168a18a57fc2 which.m: change output to distinguish between files and directories. Rik <rik@octave.org> parents: 22755 diff changeset	60 else
168a18a57fc2 which.m: change output to distinguish between files and directories. Rik <rik@octave.org> parents: 22755 diff changeset	61 printf ("'%s' is the file %s\n",
168a18a57fc2 which.m: change output to distinguish between files and directories. Rik <rik@octave.org> parents: 22755 diff changeset	62 m(i).name, m(i).file);
168a18a57fc2 which.m: change output to distinguish between files and directories. Rik <rik@octave.org> parents: 22755 diff changeset	63 endif
20922 49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20852 diff changeset	64 else
21634 96518f623c91 Backed out changeset dcf8922b724b Mike Miller <mtmiller@octave.org> parents: 21633 diff changeset	65 printf ("'%s' is a %s from the file %s\n",
20922 49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20852 diff changeset	66 m(i).name, m(i).type, m(i).file);
49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20852 diff changeset	67 endif
18451 2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	68 endif
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	69 endfor
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	70 else
20922 49081851fddc Eliminate duplicate input arg checking in which.m and __which__. Rik <rik@octave.org> parents: 20852 diff changeset	71 varargout = {m.file};
23295 c1362a71fb0e which.m: Return a non-empty string for built-in classes and command line fcns (bug #50541); Rik <rik@octave.org> parents: 23220 diff changeset	72 ## Return type, instead of "", for built-in classes (bug #50541).
c1362a71fb0e which.m: Return a non-empty string for built-in classes and command line fcns (bug #50541); Rik <rik@octave.org> parents: 23220 diff changeset	73 ## FIXME: remove code if __which__ is updated to return path for classes
c1362a71fb0e which.m: Return a non-empty string for built-in classes and command line fcns (bug #50541); Rik <rik@octave.org> parents: 23220 diff changeset	74 idx = find (cellfun ("isempty", varargout));
c1362a71fb0e which.m: Return a non-empty string for built-in classes and command line fcns (bug #50541); Rik <rik@octave.org> parents: 23220 diff changeset	75 if (idx)
c1362a71fb0e which.m: Return a non-empty string for built-in classes and command line fcns (bug #50541); Rik <rik@octave.org> parents: 23220 diff changeset	76 varargout(idx) = m(idx).type;
c1362a71fb0e which.m: Return a non-empty string for built-in classes and command line fcns (bug #50541); Rik <rik@octave.org> parents: 23220 diff changeset	77 endif
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	78 endif
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	79
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	80 endfunction
12843 3035c2e130de codesprint: Tests for which.m Rik <octave@nomad.inbox5.com> parents: 11547 diff changeset	81
3035c2e130de codesprint: Tests for which.m Rik <octave@nomad.inbox5.com> parents: 11547 diff changeset	82
3035c2e130de codesprint: Tests for which.m Rik <octave@nomad.inbox5.com> parents: 11547 diff changeset	83 %!test
3035c2e130de codesprint: Tests for which.m Rik <octave@nomad.inbox5.com> parents: 11547 diff changeset	84 %! str = which ("ls");
23295 c1362a71fb0e which.m: Return a non-empty string for built-in classes and command line fcns (bug #50541); Rik <rik@octave.org> parents: 23220 diff changeset	85 %! assert (str(end-17:end), fullfile ("miscellaneous", "ls.m"));
12843 3035c2e130de codesprint: Tests for which.m Rik <octave@nomad.inbox5.com> parents: 11547 diff changeset	86 %!test
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14868 diff changeset	87 %! str = which ("amd");
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14868 diff changeset	88 %! assert (str(end-6:end), "amd.oct");
23295 c1362a71fb0e which.m: Return a non-empty string for built-in classes and command line fcns (bug #50541); Rik <rik@octave.org> parents: 23220 diff changeset	89 %!test
c1362a71fb0e which.m: Return a non-empty string for built-in classes and command line fcns (bug #50541); Rik <rik@octave.org> parents: 23220 diff changeset	90 %! str = which ("inputParser");
c1362a71fb0e which.m: Return a non-empty string for built-in classes and command line fcns (bug #50541); Rik <rik@octave.org> parents: 23220 diff changeset	91 %! assert (str, "built-in function");
18451 2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	92 %!test
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	93 %! x = 3;
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	94 %! str = which ("x");
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	95 %! assert (str, "variable");
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	96
23295 c1362a71fb0e which.m: Return a non-empty string for built-in classes and command line fcns (bug #50541); Rik <rik@octave.org> parents: 23220 diff changeset	97 %!assert (which ("__NO_SUCH_NAME__"), "")
c1362a71fb0e which.m: Return a non-empty string for built-in classes and command line fcns (bug #50541); Rik <rik@octave.org> parents: 23220 diff changeset	98
18451 2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	99 %!test
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	100 %! str = which ("amd");
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	101 %! assert (str(end-6:end), "amd.oct");
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	102 %! amd = 12;
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	103 %! str = which ("amd");
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	104 %! assert (str, "variable");
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	105 %! clear amd;
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	106 %! str = which ("amd");
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	107 %! assert (str(end-6:end), "amd.oct");
23295 c1362a71fb0e which.m: Return a non-empty string for built-in classes and command line fcns (bug #50541); Rik <rik@octave.org> parents: 23220 diff changeset	108
c1362a71fb0e which.m: Return a non-empty string for built-in classes and command line fcns (bug #50541); Rik <rik@octave.org> parents: 23220 diff changeset	109 %!error which ()
c1362a71fb0e which.m: Return a non-empty string for built-in classes and command line fcns (bug #50541); Rik <rik@octave.org> parents: 23220 diff changeset	110 %!error which (1)
c1362a71fb0e which.m: Return a non-empty string for built-in classes and command line fcns (bug #50541); Rik <rik@octave.org> parents: 23220 diff changeset	111

Mercurial > octave

annotate scripts/help/which.m @ 23295:c1362a71fb0e