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

annotate scripts/help/type.m @ 14138:72c96de7a403 stable

maint: update copyright notices for 2012

author	John W. Eaton <jwe@octave.org>
date	Mon, 02 Jan 2012 14:25:41 -0500
parents	b584c07cd818
children	f3d52523cde1 d174210ce1ec

rev	line source
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 12838 diff changeset	1 ## Copyright (C) 2009-2012 S�ren Hauberg
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: 10793 diff changeset	3 ## This file is part of Octave.
2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10793 diff changeset	4 ##
2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10793 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: 10793 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: 10793 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 --
9724 f22bbc5d56e9 Fix various incorrect usages of TeXinfo deffn and deftypefn macros Rik <rdrider0-list@yahoo.com> parents: 9037 diff changeset	20 ## @deftypefn {Command} {} type @var{name} @dots{}
f22bbc5d56e9 Fix various incorrect usages of TeXinfo deffn and deftypefn macros Rik <rdrider0-list@yahoo.com> parents: 9037 diff changeset	21 ## @deftypefnx {Command} {} type -q @var{name} @dots{}
9752 51c21837686f Period spellcheck of Octave documentation to check and fix newly added DOCSTRINGS Rik <rdrider0-list@yahoo.com> parents: 9724 diff changeset	22 ## @deftypefnx {Function File} {dfns =} type ("@var{name}", @dots{})
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	23 ## Display the definition of each @var{name} that refers to a function.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	24 ##
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	25 ## Normally also displays whether each @var{name} is user-defined or built-in;
10793 be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 9752 diff changeset	26 ## the @option{-q} option suppresses this behavior.
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	27 ##
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	28 ## If an output argument is requested nothing is displayed. Instead, a cell
c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	29 ## array of strings is returned, where each element corresponds to the
9037 4cb9f994dcec Documentation cleanup of var.texi, expr.texi, eval.texi Rik <rdrider0-list@yahoo.com> parents: 8746 diff changeset	30 ## definition of each requested function.
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	31 ## @end deftypefn
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	32
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	33 function retval = type (varargin)
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	34 ## Parse input
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	35 if (nargin == 0)
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	36 error ("type: not enough input arguments");
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	37 endif
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	38
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	39 if (!iscellstr (varargin))
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	40 error ("type: input arguments must be strings");
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	41 endif
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	42
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	43 quiet = false;
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	44 idx = strcmpi (varargin, "-q") \| strcmpi (varargin, "-quiet");
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	45 if (any (idx))
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	46 quiet = true;
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	47 varargin (idx) = [];
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	48 endif
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	49
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	50 if (nargout > 0)
8582 92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	51 retval = cell (size (varargin));
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	52 endif
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	53
8582 92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	54 for n = 1:length (varargin)
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	55 name = varargin {n};
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	56
8582 92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	57 ## Find function and get its code
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	58 text = "";
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	59 cmd = sprintf ("exist ('%s')", name);
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	60 e = evalin ("caller", cmd);
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	61 if (e == 1)
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	62 ## Variable
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	63 cmd = sprintf ("disp (%s);", name);
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	64 desc = evalin ("caller", cmd);
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	65 if (quiet)
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	66 text = desc;
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	67 else
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	68 text = sprintf ("%s is a variable\n%s", name, desc);
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	69 endif
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	70 elseif (e == 2)
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	71 ## m-file or ordinary file
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	72 file = which (name);
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	73 if (isempty (file))
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	74 ## 'name' is an ordinary file, and not a function name.
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	75 ## FIXME: Should we just print it anyway?
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	76 error ("type: `%s' undefined\n", name);
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	77 endif
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	78
8582 92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	79 ## Read the file
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	80 fid = fopen (file, "r");
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	81 if (fid < 0)
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	82 error ("type: couldn't open `%s' for reading", file);
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	83 endif
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	84 contents = char (fread (fid).');
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	85 fclose (fid);
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	86
8582 92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	87 if (quiet)
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	88 text = contents;
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	89 else
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	90 text = sprintf ("%s is the user-defined function defined from: %s\n\n%s",
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	91 name, file, contents);
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	92 endif
8582 92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	93 elseif (e == 3)
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	94 text = sprintf ("%s is a dynamically-linked function", name);
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	95 elseif (e == 5)
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	96 text = sprintf ("%s is a built-in function", name);
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	97 elseif (any (strcmp (__operators__ (), name)))
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	98 text = sprintf ("%s is an operator", name);
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	99 elseif (any (strcmp (__keywords__ (), name)))
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	100 text = sprintf ("%s is a keyword", name);
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	101 else
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	102 error ("type: `%s' undefined\n", name);
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	103 endif
8582 92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	104
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	105 ## Should we return the text or print if
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	106 if (nargout == 0)
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	107 disp (text);
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	108 else
8582 92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	109 retval {n} = text;
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	110 endif
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	111 endfor
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	112 endfunction
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	113
12838 b584c07cd818 codesprint: Add tests for type() Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	114 %!test
b584c07cd818 codesprint: Add tests for type() Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	115 %! var = 1;
b584c07cd818 codesprint: Add tests for type() Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	116 %! typestr = type ("var");
b584c07cd818 codesprint: Add tests for type() Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	117 %! typestr = typestr{1}(1:17);
b584c07cd818 codesprint: Add tests for type() Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	118 %! assert (typestr, "var is a variable");
8582 92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	119
12838 b584c07cd818 codesprint: Add tests for type() Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	120 %!assert (type ('dot'){1}, "dot is a dynamically-linked function")
b584c07cd818 codesprint: Add tests for type() Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	121 %!assert (type ('cat'){1}, "cat is a built-in function")
b584c07cd818 codesprint: Add tests for type() Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	122 %!assert (type ('+'){1}, "+ is an operator")
b584c07cd818 codesprint: Add tests for type() Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	123 %!assert (type ('end'){1}, "end is a keyword")
b584c07cd818 codesprint: Add tests for type() Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	124 %!error (type ('NO_NAME'))

Mercurial > hg > octave-nkf

annotate scripts/help/type.m @ 14138:72c96de7a403 stable