Mercurial > hg > octave-nkf
annotate scripts/help/type.m @ 15466:d174210ce1ec stable
use ' instead of ` in error messages, warnings and most comments
* intro.txi, io.txi, munge-texi.cc, octave.texi, cmd-edit.cc,
data-conv.cc, file-ops.cc, glob-match.h, kpse.cc, oct-env.cc,
oct-locbuf.h, oct-md5.cc, oct-rand.cc, general/interp2.m, doc.m,
get_first_help_sentence.m, help.m, print_usage.m,
__additional_help_message__.m, type.m, unimplemented.m, which.m,
cast.m, dir.m, license.m, mkoctfile.m, recycle.m, tempdir.m,
optimset.m, pkg/pkg.m, closereq.m, colstyle.m, __fltk_print__.m,
__gnuplot_print__.m, __go_draw_figure__.m, __pie__.m, __pltopt__.m,
__print_parse_opts__.m, uigetdir.m, uigetfile.m, uiputfile.m, stft.m,
mean.m, anova.m, cor_test.m, t_test_regression.m, __magick_read__.cc,
dlmread.cc, schur.cc, data.cc, debug.cc, defun-dld.h, defun.cc,
defun.h, dynamic-ld.cc, error.cc, error.h, gl-render.cc, graphics.cc,
gripes.cc, input.cc, lex.ll, load-path.cc, load-save.cc, ls-hdf5.cc,
ls-mat-ascii.cc, ls-mat4.cc, ls-mat5.cc, ls-oct-ascii.cc,
ls-oct-binary.cc, oct-hist.cc, oct-parse.yy, oct-stream.cc,
oct-stream.h, octave.cc, ov-base-diag.cc, ov-base.cc, ov-class.cc,
ov-colon.h, ov-struct.cc, ov-typeinfo.cc, ov.cc, pager.cc,
pr-output.cc, pt-binop.cc, pt-eval.cc, pt-id.cc, pt-idx.cc,
pt-misc.cc, pt-unop.cc, symtab.cc, symtab.h, toplev.cc, txt-eng-ft.cc,
utils.cc, variables.cc, test_eval-catch.m, test_try.m:
Use ' instead of ` in error messages, warnings, and most comments.
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Mon, 01 Oct 2012 17:18:49 -0400 |
| parents | 72c96de7a403 |
| children | 049e8bbff782 |
| 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 | 3 ## This file is part of Octave. |
| 4 ## | |
| 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 | 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 | 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 | 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 | 54 for n = 1:length (varargin) |
| 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 | 57 ## Find function and get its code |
| 58 text = ""; | |
| 59 cmd = sprintf ("exist ('%s')", name); | |
| 60 e = evalin ("caller", cmd); | |
| 61 if (e == 1) | |
| 62 ## Variable | |
| 63 cmd = sprintf ("disp (%s);", name); | |
| 64 desc = evalin ("caller", cmd); | |
| 65 if (quiet) | |
| 66 text = desc; | |
| 67 else | |
| 68 text = sprintf ("%s is a variable\n%s", name, desc); | |
| 69 endif | |
| 70 elseif (e == 2) | |
| 71 ## m-file or ordinary file | |
| 72 file = which (name); | |
| 73 if (isempty (file)) | |
| 74 ## 'name' is an ordinary file, and not a function name. | |
| 75 ## FIXME: Should we just print it anyway? | |
|
15466
d174210ce1ec
use ' instead of ` in error messages, warnings and most comments
John W. Eaton <jwe@octave.org>
parents:
14138
diff
changeset
|
76 error ("type: '%s' undefined\n", name); |
| 8582 | 77 endif |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
78 |
| 8582 | 79 ## Read the file |
| 80 fid = fopen (file, "r"); | |
| 81 if (fid < 0) | |
|
15466
d174210ce1ec
use ' instead of ` in error messages, warnings and most comments
John W. Eaton <jwe@octave.org>
parents:
14138
diff
changeset
|
82 error ("type: couldn't open '%s' for reading", file); |
| 8582 | 83 endif |
| 84 contents = char (fread (fid).'); | |
| 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 | 87 if (quiet) |
| 88 text = contents; | |
| 89 else | |
| 90 text = sprintf ("%s is the user-defined function defined from: %s\n\n%s", | |
| 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 | 93 elseif (e == 3) |
| 94 text = sprintf ("%s is a dynamically-linked function", name); | |
| 95 elseif (e == 5) | |
| 96 text = sprintf ("%s is a built-in function", name); | |
| 97 elseif (any (strcmp (__operators__ (), name))) | |
| 98 text = sprintf ("%s is an operator", name); | |
| 99 elseif (any (strcmp (__keywords__ (), name))) | |
| 100 text = sprintf ("%s is a keyword", name); | |
| 101 else | |
|
15466
d174210ce1ec
use ' instead of ` in error messages, warnings and most comments
John W. Eaton <jwe@octave.org>
parents:
14138
diff
changeset
|
102 error ("type: '%s' undefined\n", name); |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
103 endif |
| 8582 | 104 |
| 105 ## Should we return the text or print if | |
| 106 if (nargout == 0) | |
| 107 disp (text); | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff
changeset
|
108 else |
| 8582 | 109 retval {n} = text; |
| 110 endif | |
| 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 | 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')) |