octave-nkf: scripts/help/which.m annotate

annotate scripts/help/which.m @ 18519:2bd78ab75b23

which: Properly identify workspace variables (bug #37320) * which.m: Check whether each name is a variable, for compatibility with Matlab and consistency with exist(). Add %!tests for new behavior.

author	Mike Miller <mtmiller@ieee.org>
date	Sat, 08 Feb 2014 14:39:33 -0500
parents	d63878346099
children	4197fc428c7d

rev	line source
17744 d63878346099 maint: Update copyright notices for release. John W. Eaton <jwe@octave.org> parents: 15467 diff changeset	1 ## Copyright (C) 2009-2013 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
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	8 ## your option) any later version.
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
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	13 ## General Public License for more details.
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 --
11547 e1851653d59c Eliminate @deffn macros. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	20 ## @deftypefn {Command} {} which name @dots{}
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	21 ## Display the type of each @var{name}. If @var{name} is defined from a
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	22 ## function file, the full name of the file is also displayed.
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	23 ## @seealso{help, lookfor}
11547 e1851653d59c Eliminate @deffn macros. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	24 ## @end deftypefn
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	25
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	26 function varargout = which (varargin)
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 if (nargin > 0 && iscellstr (varargin))
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	29 m = __which__ (varargin{:});
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	30
18519 2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	31 ## Check whether each name is a variable, variables take precedence over
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	32 ## functions in name resolution.
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	33 for i = 1:nargin
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	34 m(i).is_variable = evalin ("caller",
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	35 ["exist (\"" m(i).name "\", \"var\")"], false);
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	36 if (m(i).is_variable)
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	37 m(i).file = "variable";
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	38 endif
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	39 endfor
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	40
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	41 if (nargout == 0)
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	42 for i = 1:nargin
18519 2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	43 if (m(i).is_variable)
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	44 printf ("'%s' is a variable\n", m(i).name);
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	45 elseif (isempty (m(i).file))
10549 95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 8761 diff changeset	46 if (! isempty (m(i).type))
15466 d174210ce1ec use ' instead of ` in error messages, warnings and most comments John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	47 printf ("'%s' is a %s\n",
10549 95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 8761 diff changeset	48 m(i).name, m(i).type);
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 8761 diff changeset	49 endif
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 8761 diff changeset	50 else
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 8761 diff changeset	51 if (isempty (m(i).type))
15466 d174210ce1ec use ' instead of ` in error messages, warnings and most comments John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	52 printf ("'%s' is the file %s\n",
10549 95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 8761 diff changeset	53 m(i).name, m(i).file);
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 8761 diff changeset	54 else
15466 d174210ce1ec use ' instead of ` in error messages, warnings and most comments John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	55 printf ("'%s' is a %s from the file %s\n",
10549 95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 8761 diff changeset	56 m(i).name, m(i).type, m(i).file);
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 8761 diff changeset	57 endif
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 8761 diff changeset	58 endif
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	59 endfor
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	60 else
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	61 varargout = {m.file};
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	62 endif
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	63 else
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	64 print_usage ();
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	65 endif
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	66
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	67 endfunction
12843 3035c2e130de codesprint: Tests for which.m Rik <octave@nomad.inbox5.com> parents: 11547 diff changeset	68
3035c2e130de codesprint: Tests for which.m Rik <octave@nomad.inbox5.com> parents: 11547 diff changeset	69
3035c2e130de codesprint: Tests for which.m Rik <octave@nomad.inbox5.com> parents: 11547 diff changeset	70 %!test
3035c2e130de codesprint: Tests for which.m Rik <octave@nomad.inbox5.com> parents: 11547 diff changeset	71 %! str = which ("ls");
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	72 %! assert (str(end-17:end), strcat ("miscellaneous", filesep (), "ls.m"));
12843 3035c2e130de codesprint: Tests for which.m Rik <octave@nomad.inbox5.com> parents: 11547 diff changeset	73 %!test
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14868 diff changeset	74 %! str = which ("amd");
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14868 diff changeset	75 %! assert (str(end-6:end), "amd.oct");
12843 3035c2e130de codesprint: Tests for which.m Rik <octave@nomad.inbox5.com> parents: 11547 diff changeset	76
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	77 %!assert (which ("_NO_SUCH_NAME_"), "")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	78
18519 2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	79 %!test
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	80 %! x = 3;
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	81 %! str = which ("x");
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	82 %! assert (str, "variable");
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	83
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	84 %!test
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	85 %! str = which ("amd");
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	86 %! assert (str(end-6:end), "amd.oct");
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	87 %! amd = 12;
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	88 %! str = which ("amd");
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	89 %! assert (str, "variable");
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	90 %! clear amd;
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	91 %! str = which ("amd");
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	92 %! assert (str(end-6:end), "amd.oct");

Mercurial > hg > octave-nkf

annotate scripts/help/which.m @ 18519:2bd78ab75b23