Mercurial > hg > octave-nkf
annotate scripts/help/type.m @ 9037:4cb9f994dcec
Documentation cleanup of var.texi, expr.texi, eval.texi
Spellcheck
Style check (particularly for two spaces after period)
| author | Rik <rdrider0-list@yahoo.com> |
|---|---|
| date | Sun, 22 Mar 2009 08:41:49 -0700 |
| parents | 5dd06f19e9be |
| children | f22bbc5d56e9 |
| rev | line source |
|---|---|
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
1 ## Copyright (C) 2009 S�ren Hauberg |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
2 ## |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
3 ## This program is free software; you can redistribute it and/or modify it |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
4 ## 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
|
5 ## 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
|
6 ## your option) any later version. |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
7 ## |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
8 ## This program is distributed in the hope that it will be useful, but |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
9 ## WITHOUT ANY WARRANTY; without even the implied warranty of |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
10 ## 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
|
11 ## General Public License for more details. |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
12 ## |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
13 ## You should have received a copy of the GNU General Public License |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
14 ## along with this program; see the file COPYING. If not, see |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
15 ## <http://www.gnu.org/licenses/>. |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
16 |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
17 ## -*- texinfo -*- |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
18 ## @deftypefn {Command} type options name @dots{} |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
19 ## Display the definition of each @var{name} that refers to a function. |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
20 ## |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
21 ## Normally also displays whether each @var{name} is user-defined or built-in; |
|
9037
4cb9f994dcec
Documentation cleanup of var.texi, expr.texi, eval.texi
Rik <rdrider0-list@yahoo.com>
parents:
8746
diff
changeset
|
22 ## the @code{-q} option suppresses this behavior. |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
23 ## |
|
9037
4cb9f994dcec
Documentation cleanup of var.texi, expr.texi, eval.texi
Rik <rdrider0-list@yahoo.com>
parents:
8746
diff
changeset
|
24 ## If an output argument is requested nothing is displayed. Instead, a cell |
|
4cb9f994dcec
Documentation cleanup of var.texi, expr.texi, eval.texi
Rik <rdrider0-list@yahoo.com>
parents:
8746
diff
changeset
|
25 ## array of strings is returned, where each element corresponds to the |
|
4cb9f994dcec
Documentation cleanup of var.texi, expr.texi, eval.texi
Rik <rdrider0-list@yahoo.com>
parents:
8746
diff
changeset
|
26 ## definition of each requested function. |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
27 ## @end deftypefn |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
28 |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
29 function retval = type (varargin) |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
30 ## Parse input |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
31 if (nargin == 0) |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
32 error ("type: not enough input arguments"); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
33 endif |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
34 |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
35 if (!iscellstr (varargin)) |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
36 error ("type: input arguments must be strings"); |
|
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 quiet = false; |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
40 idx = strcmpi (varargin, "-q") | strcmpi (varargin, "-quiet"); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
41 if (any (idx)) |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
42 quiet = true; |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
43 varargin (idx) = []; |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
44 endif |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
45 |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
46 if (nargout > 0) |
| 8582 | 47 retval = cell (size (varargin)); |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
48 endif |
| 8582 | 49 |
| 50 for n = 1:length (varargin) | |
| 51 name = varargin {n}; | |
| 52 | |
| 53 ## Find function and get its code | |
| 54 text = ""; | |
| 55 cmd = sprintf ("exist ('%s')", name); | |
| 56 e = evalin ("caller", cmd); | |
| 57 if (e == 1) | |
| 58 ## Variable | |
| 59 cmd = sprintf ("disp (%s);", name); | |
| 60 desc = evalin ("caller", cmd); | |
| 61 if (quiet) | |
| 62 text = desc; | |
| 63 else | |
| 64 text = sprintf ("%s is a variable\n%s", name, desc); | |
| 65 endif | |
| 66 elseif (e == 2) | |
| 67 ## m-file or ordinary file | |
| 68 file = which (name); | |
| 69 if (isempty (file)) | |
| 70 ## 'name' is an ordinary file, and not a function name. | |
| 71 ## FIXME: Should we just print it anyway? | |
| 72 error ("type: `%s' undefined\n", name); | |
| 73 endif | |
| 74 | |
| 75 ## Read the file | |
| 76 fid = fopen (file, "r"); | |
| 77 if (fid < 0) | |
| 78 error ("type: couldn't open `%s' for reading", file); | |
| 79 endif | |
| 80 contents = char (fread (fid).'); | |
| 81 fclose (fid); | |
| 82 | |
| 83 if (quiet) | |
| 84 text = contents; | |
| 85 else | |
| 86 text = sprintf ("%s is the user-defined function defined from: %s\n\n%s", | |
| 87 name, file, contents); | |
| 88 endif | |
| 89 elseif (e == 3) | |
| 90 text = sprintf ("%s is a dynamically-linked function", name); | |
| 91 elseif (e == 5) | |
| 92 text = sprintf ("%s is a built-in function", name); | |
| 93 elseif (any (strcmp (__operators__ (), name))) | |
| 94 text = sprintf ("%s is an operator", name); | |
| 95 elseif (any (strcmp (__keywords__ (), name))) | |
| 96 text = sprintf ("%s is a keyword", name); | |
| 97 else | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
98 error ("type: `%s' undefined\n", name); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
99 endif |
| 8582 | 100 |
| 101 ## Should we return the text or print if | |
| 102 if (nargout == 0) | |
| 103 disp (text); | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
104 else |
| 8582 | 105 retval {n} = text; |
| 106 endif | |
| 107 endfor | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
108 endfunction |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
109 |
| 8582 | 110 |