Mercurial > octave-nkf
annotate src/help.cc @ 8863:34a821854961
pkg.m (generate_lookfor_cache): generate a DOC file for each directory
| author | Jason Riedy <jason@acm.org> |
|---|---|
| date | Wed, 25 Feb 2009 00:41:40 -0500 |
| parents | 31f864877246 |
| children | eb63fbe60fab |
| rev | line source |
|---|---|
| 1 | 1 /* |
| 2 | |
| 7017 | 3 Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, |
| 4 2002, 2003, 2004, 2005, 2006, 2007 John W. Eaton | |
| 1 | 5 |
| 6 This file is part of Octave. | |
| 7 | |
| 8 Octave is free software; you can redistribute it and/or modify it | |
| 9 under the terms of the GNU General Public License as published by the | |
| 7016 | 10 Free Software Foundation; either version 3 of the License, or (at your |
| 11 option) any later version. | |
| 1 | 12 |
| 13 Octave is distributed in the hope that it will be useful, but WITHOUT | |
| 14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 16 for more details. | |
| 17 | |
| 18 You should have received a copy of the GNU General Public License | |
| 7016 | 19 along with Octave; see the file COPYING. If not, see |
| 20 <http://www.gnu.org/licenses/>. | |
| 1 | 21 |
| 22 */ | |
| 23 | |
| 240 | 24 #ifdef HAVE_CONFIG_H |
| 1192 | 25 #include <config.h> |
| 1 | 26 #endif |
| 27 | |
| 1343 | 28 #include <cstdlib> |
| 29 #include <cstring> | |
| 30 | |
| 5769 | 31 #include <algorithm> |
| 3503 | 32 #include <iostream> |
| 33 #include <fstream> | |
| 5765 | 34 #include <sstream> |
| 1755 | 35 #include <string> |
| 36 | |
| 1350 | 37 #ifdef HAVE_UNISTD_H |
| 2442 | 38 #ifdef HAVE_SYS_TYPES_H |
| 1295 | 39 #include <sys/types.h> |
| 2442 | 40 #endif |
| 1295 | 41 #include <unistd.h> |
| 42 #endif | |
| 1343 | 43 |
| 3295 | 44 #include "cmd-edit.h" |
| 45 #include "file-ops.h" | |
| 6253 | 46 #include "file-stat.h" |
| 2926 | 47 #include "oct-env.h" |
| 1755 | 48 #include "str-vec.h" |
| 49 | |
| 2492 | 50 #include <defaults.h> |
| 1352 | 51 #include "defun.h" |
| 52 #include "dirfns.h" | |
| 53 #include "error.h" | |
| 2202 | 54 #include "gripes.h" |
| 1352 | 55 #include "help.h" |
| 2177 | 56 #include "input.h" |
| 5832 | 57 #include "load-path.h" |
| 1755 | 58 #include "oct-obj.h" |
| 2976 | 59 #include "ov-usr-fcn.h" |
| 1352 | 60 #include "pager.h" |
| 3018 | 61 #include "parse.h" |
| 1466 | 62 #include "pathsearch.h" |
| 3295 | 63 #include "procstream.h" |
| 7336 | 64 #include "pt-pr-code.h" |
| 529 | 65 #include "sighandlers.h" |
| 66 #include "symtab.h" | |
| 2694 | 67 #include "syswait.h" |
| 1755 | 68 #include "toplev.h" |
|
8672
2a49c32d4322
allow help to work with files containing only comments
John W. Eaton <jwe@octave.org>
parents:
8631
diff
changeset
|
69 #include "unwind-prot.h" |
| 242 | 70 #include "utils.h" |
| 1352 | 71 #include "variables.h" |
| 3301 | 72 #include "version.h" |
| 5447 | 73 #include "quit.h" |
| 529 | 74 |
| 8861 | 75 // Name of the doc cache file specified on the command line. |
| 76 // (--doc-cache-file file) | |
| 77 std::string Vdoc_cache_file; | |
| 78 | |
| 2202 | 79 // Name of the info file specified on command line. |
| 80 // (--info-file file) | |
| 3523 | 81 std::string Vinfo_file; |
| 2202 | 82 |
| 83 // Name of the info reader we'd like to use. | |
| 84 // (--info-program program) | |
| 5794 | 85 std::string Vinfo_program; |
| 2202 | 86 |
| 3686 | 87 // Name of the makeinfo program to run. |
| 5794 | 88 static std::string Vmakeinfo_program = "makeinfo"; |
| 3686 | 89 |
| 2189 | 90 // If TRUE, don't print additional help message in help and usage |
| 91 // functions. | |
| 5794 | 92 static bool Vsuppress_verbose_help_message = false; |
| 2189 | 93 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
94 #include <map> |
| 3016 | 95 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
96 typedef std::map<std::string, std::string> map_type; |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
97 typedef map_type::value_type pair_type; |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
98 typedef map_type::const_iterator map_iter; |
| 3016 | 99 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
100 template<typename T, std::size_t z> |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
101 std::size_t |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
102 size (T const (&)[z]) |
| 1 | 103 { |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
104 return z; |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
105 } |
| 1 | 106 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
107 // FIXME -- The descriptions could easily be in texinfo -- should they? |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
108 const static pair_type operators[] = |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
109 { |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
110 pair_type ("!", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
111 "Logical not operator. See also `~'.\n"), |
| 1 | 112 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
113 pair_type ("!=", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
114 "Logical not equals operator. See also `~='.\n"), |
| 1 | 115 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
116 pair_type ("\"", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
117 "String delimiter.\n"), |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
118 |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
119 pair_type ("#", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
120 "Begin comment character. See also `%'."), |
| 1 | 121 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
122 pair_type ("%", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
123 "Begin comment charcter. See also `#'."), |
| 1 | 124 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
125 pair_type ("&", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
126 "Element by element logical and operator. See also `&&'."), |
| 1 | 127 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
128 pair_type ("&&", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
129 "Logical and operator (with short-circuit evaluation). See also `&'."), |
| 1 | 130 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
131 pair_type ("'", |
| 1 | 132 "Matrix transpose operator. For complex matrices, computes the\n\ |
| 133 complex conjugate (Hermitian) transpose. See also `.''\n\ | |
| 134 \n\ | |
| 135 The single quote character may also be used to delimit strings, but\n\ | |
| 136 it is better to use the double quote character, since that is never\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
137 ambiguous"), |
| 1 | 138 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
139 pair_type ("(", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
140 "Array index or function argument delimiter."), |
| 1 | 141 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
142 pair_type (")", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
143 "Array index or function argument delimiter."), |
| 1 | 144 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
145 pair_type ("*", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
146 "Multiplication operator. See also `.*'"), |
| 1 | 147 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
148 pair_type ("**", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
149 "Power operator. See also `^', `.**', and `.^'"), |
| 1 | 150 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
151 pair_type ("+", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
152 "Addition operator."), |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
153 |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
154 pair_type ("++", |
| 5339 | 155 "Increment operator. As in C, may be applied as a prefix or postfix\n\ |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
156 operator."), |
| 1 | 157 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
158 pair_type (",", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
159 "Array index, function argument, or command separator."), |
| 1 | 160 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
161 pair_type ("-", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
162 "Subtraction or unary negation operator."), |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
163 |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
164 pair_type ("--", |
| 5339 | 165 "Decrement operator. As in C, may be applied as a prefix or postfix\n\ |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
166 operator."), |
| 1 | 167 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
168 pair_type (".'", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
169 "Matrix transpose operator. For complex matrices, computes the\n\ |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
170 transpose, *not* the complex conjugate transpose. See also `''."), |
| 1 | 171 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
172 pair_type (".*", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
173 "Element by element multiplication operator. See also `*'."), |
| 1 | 174 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
175 pair_type (".**", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
176 "Element by element power operator. See also `**', `^', and `.^'."), |
| 1 | 177 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
178 pair_type ("./", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
179 "Element by element division operator. See also `/' and `\\'."), |
| 1 | 180 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
181 pair_type (".^", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
182 "Element by element power operator. See also `**', `^', and `.^'."), |
| 1 | 183 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
184 pair_type ("/", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
185 "Right division. See also `\\' and `./'."), |
| 1 | 186 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
187 pair_type (":", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
188 "Select entire rows or columns of matrices."), |
| 1 | 189 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
190 pair_type (";", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
191 "Array row or command separator. See also `,'."), |
| 1 | 192 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
193 pair_type ("<", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
194 "Less than operator."), |
| 1 | 195 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
196 pair_type ("<=", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
197 "Less than or equals operator."), |
| 1 | 198 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
199 pair_type ("=", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
200 "Assignment operator."), |
| 1 | 201 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
202 pair_type ("==", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
203 "Equality test operator."), |
| 1 | 204 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
205 pair_type (">", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
206 "Greater than operator."), |
| 1 | 207 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
208 pair_type (">=", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
209 "Greater than or equals operator."), |
| 1 | 210 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
211 pair_type ("[", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
212 "Return list delimiter. See also `]'."), |
| 1 | 213 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
214 pair_type ("\\", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
215 "Left division operator. See also `/' and `./'."), |
| 1 | 216 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
217 pair_type ("]", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
218 "Return list delimiter. See also `['."), |
| 1 | 219 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
220 pair_type ("^", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
221 "Power operator. See also `**', `.^', and `.**.'"), |
| 1 | 222 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
223 pair_type ("|", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
224 "Element by element logical or operator. See also `||'."), |
| 1 | 225 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
226 pair_type ("||", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
227 "Logical or operator (with short-circuit evaluation). See also `|'."), |
| 1 | 228 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
229 pair_type ("~", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
230 "Logical not operator. See also `!' and `~'."), |
| 1 | 231 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
232 pair_type ("~=", |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
233 "Logical not equals operator. See also `!='."), |
| 1 | 234 }; |
| 235 | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
236 const static pair_type keywords[] = |
| 1 | 237 { |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
238 pair_type ("break", |
| 5818 | 239 "-*- texinfo -*-\n\ |
| 240 @deffn Keyword break\n\ | |
| 241 Exit the innermost enclosing do, while or for loop.\n\ | |
| 242 @seealso{do, while, for, continue}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
243 @end deffn"), |
| 5040 | 244 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
245 pair_type ("case", |
| 5818 | 246 "-*- texinfo -*-\n\ |
| 247 @deffn Keyword case @{@var{value}@}\n\ | |
| 248 A case statement in an switch. Octave cases are exclusive and do not\n\ | |
| 5040 | 249 fall-through as do C-language cases. A switch statement must have at least\n\ |
| 5818 | 250 one case. See @code{switch} for an example.\n\ |
| 251 @seealso{switch}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
252 @end deffn"), |
| 1 | 253 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
254 pair_type ("catch", |
| 5818 | 255 "-*- texinfo -*-\n\ |
| 256 @deffn Keyword catch\n\ | |
| 257 Begin the cleanup part of a try-catch block.\n\ | |
| 258 @seealso{try}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
259 @end deffn"), |
| 1489 | 260 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
261 pair_type ("continue", |
| 5818 | 262 "-*- texinfo -*-\n\ |
| 263 @deffn Keyword continue\n\ | |
| 264 Jump to the end of the innermost enclosing do, while or for loop.\n\ | |
| 265 @seealso{do, while, for, break}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
266 @end deffn"), |
| 5040 | 267 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
268 pair_type ("do", |
| 5818 | 269 "-*- texinfo -*-\n\ |
| 270 @deffn Keyword do\n\ | |
| 271 Begin a do-until loop. This differs from a do-while loop in that the\n\ | |
| 272 body of the loop is executed at least once.\n\ | |
| 273 @seealso{while}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
274 @end deffn"), |
| 1 | 275 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
276 pair_type ("else", |
| 5818 | 277 "-*- texinfo -*-\n\ |
| 278 @deffn Keyword else\n\ | |
| 279 Alternate action for an if block. See @code{if} for an example.\n\ | |
| 280 @seealso{if}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
281 @end deffn"), |
| 1 | 282 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
283 pair_type ("elseif", |
| 5818 | 284 "-*- texinfo -*-\n\ |
| 285 @deffn Keyword elseif (@var{condition})\n\ | |
| 286 Alternate conditional test for an if block. See @code{if} for an example.\n\ | |
| 287 @seealso{if}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
288 @end deffn"), |
| 1 | 289 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
290 pair_type ("end", |
| 5818 | 291 "-*- texinfo -*-\n\ |
| 292 @deffn Keyword end\n\ | |
| 293 Mark the end of any @code{for}, @code{if}, @code{do}, @code{while}, or @code{function} block.\n\ | |
| 294 @seealso{for, if, do, while, function}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
295 @end deffn"), |
| 928 | 296 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
297 pair_type ("end_try_catch", |
| 5818 | 298 "-*- texinfo -*-\n\ |
| 299 @deffn Keyword end_try_catch\n\ | |
| 300 Mark the end of an @code{try-catch} block.\n\ | |
| 301 @seealso{try, catch}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
302 @end deffn"), |
| 1489 | 303 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
304 pair_type ("end_unwind_protect", |
| 5818 | 305 "-*- texinfo -*-\n\ |
| 306 @deffn Keyword end_unwind_protect\n\ | |
| 307 Mark the end of an unwind_protect block.\n\ | |
| 308 @seealso{unwind_protect}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
309 @end deffn"), |
| 1 | 310 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
311 pair_type ("endfor", |
| 5818 | 312 "-*- texinfo -*-\n\ |
| 313 @deffn Keyword endfor\n\ | |
| 314 Mark the end of a for loop. See @code{for} for an example.\n\ | |
| 315 @seealso{for}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
316 @end deffn"), |
| 1 | 317 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
318 pair_type ("endfunction", |
| 5818 | 319 "-*- texinfo -*-\n\ |
| 320 @deffn Keyword endfunction\n\ | |
| 321 Mark the end of a function.\n\ | |
| 322 @seealso{function}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
323 @end deffn"), |
| 1 | 324 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
325 pair_type ("endif", |
| 5818 | 326 "-*- texinfo -*-\n\ |
| 327 @deffn Keyword endif\n\ | |
| 328 Mark the end of an if block. See @code{if} for an example.\n\ | |
| 329 @seealso{if}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
330 @end deffn"), |
| 1 | 331 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
332 pair_type ("endswitch", |
| 5818 | 333 "-*- texinfo -*-\n\ |
| 334 @deffn Keyword endswitch\n\ | |
| 335 Mark the end of a switch block. See @code{switch} for an example.\n\ | |
| 336 @seealso{switch}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
337 @end deffn"), |
| 5122 | 338 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
339 pair_type ("endwhile", |
| 5818 | 340 "-*- texinfo -*-\n\ |
| 341 @deffn Keyword endwhile\n\ | |
| 342 Mark the end of a while loop. See @code{while} for an example.\n\ | |
| 343 @seealso{do, while}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
344 @end deffn"), |
| 1 | 345 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
346 pair_type ("for", |
| 5818 | 347 "-*- texinfo -*-\n\ |
| 348 @deffn Keyword for @var{i} = @var{range}\n\ | |
| 349 Begin a for loop.\n\ | |
| 350 @example\n\ | |
| 351 for i = 1:10\n\ | |
| 352 i\n\ | |
| 353 endfor\n\ | |
| 354 @end example\n\ | |
| 355 @seealso{do, while}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
356 @end deffn"), |
| 1 | 357 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
358 pair_type ("function", |
| 5818 | 359 "-*- texinfo -*-\n\ |
| 360 @deffn Keyword function @var{outputs} = function (@var{input}, ...)\n\ | |
| 361 @deffnx Keyword function {} function (@var{input}, ...)\n\ | |
| 362 @deffnx Keyword function @var{outputs} = function\n\ | |
| 363 Begin a function body with @var{outputs} as results and @var{inputs} as\n\ | |
| 364 parameters.\n\ | |
| 365 @seealso{return}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
366 @end deffn"), |
| 1 | 367 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
368 pair_type ("global", |
| 5818 | 369 "-*- texinfo -*-\n\ |
| 370 @deffn Keyword global\n\ | |
| 371 Declare variables to have global scope.\n\ | |
| 372 @example\n\ | |
| 373 global @var{x};\n\ | |
| 374 if isempty (@var{x})\n\ | |
| 375 x = 1;\n\ | |
| 376 endif\n\ | |
| 377 @end example\n\ | |
| 378 @seealso{persistent}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
379 @end deffn"), |
| 1 | 380 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
381 pair_type ("if", |
| 5393 | 382 "-*- texinfo -*-\n\ |
| 383 @deffn Keyword if (@var{cond}) @dots{} endif\n\ | |
| 384 @deffnx Keyword if (@var{cond}) @dots{} else @dots{} endif\n\ | |
| 385 @deffnx Keyword if (@var{cond}) @dots{} elseif (@var{cond}) @dots{} endif\n\ | |
| 386 @deffnx Keyword if (@var{cond}) @dots{} elseif (@var{cond}) @dots{} else @dots{} endif\n\ | |
| 387 Begin an if block.\n\ | |
| 5818 | 388 @example\n\ |
| 389 x = 1;\n\ | |
| 390 if (x == 1)\n\ | |
| 391 disp (\"one\");\n\ | |
| 392 elseif (x == 2)\n\ | |
| 393 disp (\"two\");\n\ | |
| 394 else\n\ | |
| 395 disp (\"not one or two\");\n\ | |
| 396 endif\n\ | |
| 397 @end example\n\ | |
| 5646 | 398 @seealso{switch}\n\ |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
399 @end deffn"), |
| 1 | 400 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
401 pair_type ("otherwise", |
| 5818 | 402 "-*- texinfo -*-\n\ |
| 403 @deffn Keyword otherwise\n\ | |
| 404 The default statement in a switch block (similar to else in an if block).\n\ | |
| 405 @seealso{switch}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
406 @end deffn"), |
| 5040 | 407 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
408 pair_type ("persistent", |
| 5818 | 409 "-*- texinfo -*-\n\ |
| 410 @deffn Keyword persistent @var{var}\n\ | |
| 411 Declare variables as persistent. A variable that has been declared\n\ | |
| 5623 | 412 persistent within a function will retain its contents in memory between\n\ |
| 413 subsequent calls to the same function. The difference between persistent\n\ | |
| 5818 | 414 variables and global variables is that persistent variables are local in \n\ |
| 415 scope to a particular function and are not visible elsewhere.\n\ | |
| 416 @seealso{global}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
417 @end deffn"), |
| 4686 | 418 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
419 pair_type ("replot", |
| 5818 | 420 "-*- texinfo -*-\n\ |
| 421 @deffn Keyword replot\n\ | |
| 422 Replot a graphic.\n\ | |
| 423 @seealso{plot}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
424 @end deffn"), |
| 5040 | 425 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
426 pair_type ("return", |
| 5818 | 427 "-*- texinfo -*-\n\ |
| 428 @deffn Keyword return\n\ | |
| 429 Return from a function.\n\ | |
| 430 @seealso{function}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
431 @end deffn"), |
| 928 | 432 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
433 pair_type ("static", |
| 5818 | 434 "-*- texinfo -*-\n\ |
| 435 @deffn Keyword static\n\ | |
| 436 This function has been deprecated in favor of persistent.\n\ | |
| 437 @seealso{persistent}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
438 @end deffn"), |
| 5040 | 439 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
440 pair_type ("switch", |
| 5818 | 441 "-*- texinfo -*-\n\ |
| 442 @deffn Keyword switch @var{statement}\n\ | |
| 443 Begin a switch block.\n\ | |
| 444 @example\n\ | |
| 445 yesno = \"yes\"\n\ | |
| 446 \n\ | |
| 447 switch yesno\n\ | |
| 5832 | 448 case @{\"Yes\" \"yes\" \"YES\" \"y\" \"Y\"@}\n\ |
| 5818 | 449 value = 1;\n\ |
| 5832 | 450 case @{\"No\" \"no\" \"NO\" \"n\" \"N\"@}\n\ |
| 5818 | 451 value = 0;\n\ |
| 452 otherwise\n\ | |
| 453 error (\"invalid value\");\n\ | |
| 454 endswitch\n\ | |
| 455 @end example\n\ | |
| 456 @seealso{if, case, otherwise}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
457 @end deffn"), |
| 5040 | 458 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
459 pair_type ("try", |
| 5818 | 460 "-*- texinfo -*-\n\ |
| 461 @deffn Keyword try\n\ | |
| 462 Begin a try-catch block.\n\ | |
| 6138 | 463 \n\ |
| 464 If an error occurs within a try block, then the catch code will be run and\n\ | |
| 465 execution will proceed after the catch block (though it is often\n\ | |
| 466 recommended to use the lasterr function to re-throw the error after cleanup\n\ | |
| 467 is completed).\n\ | |
| 468 @seealso{catch,unwind_protect}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
469 @end deffn"), |
| 1489 | 470 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
471 pair_type ("until", |
| 5818 | 472 "-*- texinfo -*-\n\ |
| 473 @deffn Keyword until\n\ | |
| 474 End a do-until loop.\n\ | |
| 475 @seealso{do}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
476 @end deffn"), |
| 5040 | 477 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
478 pair_type ("unwind_protect", |
| 5818 | 479 "-*- texinfo -*-\n\ |
| 480 @deffn Keyword unwind_protect\n\ | |
| 481 Begin an unwind_protect block.\n\ | |
| 6138 | 482 \n\ |
| 483 If an error occurs within the first part of an unwind_protect block\n\ | |
| 484 the commands within the unwind_protect_cleanup block are executed before\n\ | |
| 485 the error is thrown. If an error is not thrown, then the\n\ | |
| 486 unwind_protect_cleanup block is still executed (in other words, the\n\ | |
| 487 unwind_protect_cleanup will be run with or without an error in the\n\ | |
| 488 unwind_protect block).\n\ | |
| 489 @seealso{unwind_protect_cleanup,try}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
490 @end deffn"), |
| 928 | 491 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
492 pair_type ("unwind_protect_cleanup", |
| 5818 | 493 "-*- texinfo -*-\n\ |
| 494 @deffn Keyword unwind_protect_cleanup\n\ | |
| 495 Begin the cleanup section of an unwind_protect block.\n\ | |
| 496 @seealso{unwind_protect}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
497 @end deffn"), |
| 1 | 498 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
499 pair_type ("varargin", |
| 5818 | 500 "-*- texinfo -*-\n\ |
| 501 @deffn Keyword varargin\n\ | |
| 502 Pass an arbitrary number of arguments into a function.\n\ | |
| 503 @seealso{varargout, nargin, nargout}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
504 @end deffn"), |
| 5040 | 505 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
506 pair_type ("varargout", |
| 5818 | 507 "-*- texinfo -*-\n\ |
| 508 @deffn Keyword varargout\n\ | |
| 509 Pass an arbitrary number of arguments out of a function.\n\ | |
| 510 @seealso{varargin, nargin, nargout}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
511 @end deffn"), |
| 5040 | 512 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
513 pair_type ("while", |
| 5818 | 514 "-*- texinfo -*-\n\ |
| 515 @deffn Keyword while\n\ | |
| 516 Begin a while loop.\n\ | |
| 517 @seealso{do}\n\ | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
518 @end deffn"), |
| 1 | 519 }; |
| 520 | |
| 581 | 521 // Return a copy of the operator or keyword names. |
| 3016 | 522 static string_vector |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
523 names (const map_type& lst) |
| 1 | 524 { |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
525 string_vector retval (lst.size ()); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
526 int j = 0; |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
527 for (map_iter iter = lst.begin (); iter != lst.end (); iter ++) |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
528 retval [j++] = iter->first; |
| 1755 | 529 return retval; |
| 1 | 530 } |
| 531 | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
532 const static map_type operators_map (operators, operators + size (operators)); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
533 const static map_type keywords_map (keywords, keywords + size (keywords)); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
534 const static string_vector keyword_names = names (keywords_map); |
| 1 | 535 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
536 // FIXME -- It's not likely that this does the right thing now. |
| 3016 | 537 |
| 538 string_vector | |
| 539 make_name_list (void) | |
| 540 { | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
541 const int key_len = keyword_names.length (); |
| 3016 | 542 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
543 const string_vector bif = symbol_table::built_in_function_names (); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
544 const int bif_len = bif.length (); |
| 4009 | 545 |
|
7752
40c428ea3408
initial implementation of dbup and dbdown
John W. Eaton <jwe@octave.org>
parents:
7438
diff
changeset
|
546 // FIXME -- is this really necessary here? |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
547 const string_vector glb = symbol_table::global_variable_names (); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
548 const int glb_len = glb.length (); |
| 3016 | 549 |
|
7752
40c428ea3408
initial implementation of dbup and dbdown
John W. Eaton <jwe@octave.org>
parents:
7438
diff
changeset
|
550 // FIXME -- is this really necessary here? |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
551 const string_vector top = symbol_table::top_level_variable_names (); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
552 const int top_len = top.length (); |
| 3016 | 553 |
| 3355 | 554 string_vector lcl; |
| 7336 | 555 if (! symbol_table::at_top_level ()) |
| 556 lcl = symbol_table::variable_names (); | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
557 const int lcl_len = lcl.length (); |
| 3016 | 558 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
559 const string_vector ffl = load_path::fcn_names (); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
560 const int ffl_len = ffl.length (); |
| 3016 | 561 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
562 const string_vector afl = autoloaded_functions (); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
563 const int afl_len = afl.length (); |
| 5592 | 564 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
565 const int total_len = key_len + bif_len + glb_len + top_len + lcl_len |
| 7336 | 566 + ffl_len + afl_len; |
| 3016 | 567 |
| 568 string_vector list (total_len); | |
| 569 | |
| 570 // Put all the symbols in one big list. | |
| 571 | |
| 572 int j = 0; | |
| 573 int i = 0; | |
| 574 for (i = 0; i < key_len; i++) | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
575 list[j++] = keyword_names[i]; |
| 3016 | 576 |
| 7336 | 577 for (i = 0; i < bif_len; i++) |
| 578 list[j++] = bif[i]; | |
| 4009 | 579 |
| 3016 | 580 for (i = 0; i < glb_len; i++) |
| 581 list[j++] = glb[i]; | |
| 582 | |
| 583 for (i = 0; i < top_len; i++) | |
| 584 list[j++] = top[i]; | |
| 585 | |
| 586 for (i = 0; i < lcl_len; i++) | |
| 587 list[j++] = lcl[i]; | |
| 588 | |
| 589 for (i = 0; i < ffl_len; i++) | |
| 590 list[j++] = ffl[i]; | |
| 591 | |
| 5592 | 592 for (i = 0; i < afl_len; i++) |
| 593 list[j++] = afl[i]; | |
| 594 | |
| 3016 | 595 return list; |
| 596 } | |
| 597 | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
598 static bool |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
599 looks_like_html (const std::string& msg) |
| 3014 | 600 { |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
601 const size_t p1 = msg.find ('\n'); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
602 std::string t = msg.substr (0, p1); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
603 const size_t p2 = t.find ("<html"); // FIXME: this comparison should be case-insensitive |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
604 |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
605 return (p2 != std::string::npos); |
| 2470 | 606 } |
| 3014 | 607 |
| 608 static bool | |
| 3523 | 609 looks_like_texinfo (const std::string& msg, size_t& p1) |
| 3295 | 610 { |
| 611 p1 = msg.find ('\n'); | |
| 612 | |
| 3523 | 613 std::string t = msg.substr (0, p1); |
| 3295 | 614 |
| 8021 | 615 if (p1 == std::string::npos) |
| 3295 | 616 p1 = 0; |
| 617 | |
| 618 size_t p2 = t.find ("-*- texinfo -*-"); | |
| 619 | |
| 8021 | 620 return (p2 != std::string::npos); |
| 3295 | 621 } |
| 622 | |
| 3355 | 623 static bool |
| 6243 | 624 raw_help_from_symbol_table (const std::string& nm, std::string& h, |
| 625 std::string& w, bool& symbol_found) | |
| 3355 | 626 { |
| 627 bool retval = false; | |
| 628 | |
| 7336 | 629 octave_value val = symbol_table::find_function (nm); |
| 3355 | 630 |
| 7336 | 631 if (val.is_defined ()) |
| 3355 | 632 { |
| 7336 | 633 octave_function *fcn = val.function_value (); |
| 634 | |
| 635 if (fcn) | |
| 636 { | |
| 637 symbol_found = true; | |
| 5399 | 638 |
| 7336 | 639 h = fcn->doc_string (); |
| 640 | |
|
8631
52956d669506
Display sensible error message when the help text of an undocumented function is requested
Soren Hauberg <hauberg@gmail.com>
parents:
8630
diff
changeset
|
641 retval = true; |
|
52956d669506
Display sensible error message when the help text of an undocumented function is requested
Soren Hauberg <hauberg@gmail.com>
parents:
8630
diff
changeset
|
642 |
|
52956d669506
Display sensible error message when the help text of an undocumented function is requested
Soren Hauberg <hauberg@gmail.com>
parents:
8630
diff
changeset
|
643 w = fcn->fcn_file_name (); |
| 6243 | 644 |
|
8631
52956d669506
Display sensible error message when the help text of an undocumented function is requested
Soren Hauberg <hauberg@gmail.com>
parents:
8630
diff
changeset
|
645 if (w.empty ()) |
|
52956d669506
Display sensible error message when the help text of an undocumented function is requested
Soren Hauberg <hauberg@gmail.com>
parents:
8630
diff
changeset
|
646 w = fcn->is_user_function () |
|
52956d669506
Display sensible error message when the help text of an undocumented function is requested
Soren Hauberg <hauberg@gmail.com>
parents:
8630
diff
changeset
|
647 ? "command-line function" : "built-in function"; |
| 6243 | 648 } |
| 649 } | |
| 3355 | 650 |
| 6243 | 651 return retval; |
| 652 } | |
| 653 | |
| 654 static bool | |
| 655 raw_help_from_file (const std::string& nm, std::string& h, | |
| 656 std::string& file, bool& symbol_found) | |
| 657 { | |
| 658 bool retval = false; | |
| 659 | |
|
8672
2a49c32d4322
allow help to work with files containing only comments
John W. Eaton <jwe@octave.org>
parents:
8631
diff
changeset
|
660 // FIXME -- this is a bit of a kluge... |
|
2a49c32d4322
allow help to work with files containing only comments
John W. Eaton <jwe@octave.org>
parents:
8631
diff
changeset
|
661 unwind_protect_bool (reading_script_file); |
|
2a49c32d4322
allow help to work with files containing only comments
John W. Eaton <jwe@octave.org>
parents:
8631
diff
changeset
|
662 reading_script_file = true; |
|
2a49c32d4322
allow help to work with files containing only comments
John W. Eaton <jwe@octave.org>
parents:
8631
diff
changeset
|
663 |
| 6243 | 664 h = get_help_from_file (nm, symbol_found, file); |
| 665 | |
|
8672
2a49c32d4322
allow help to work with files containing only comments
John W. Eaton <jwe@octave.org>
parents:
8631
diff
changeset
|
666 unwind_protect::run (); |
|
2a49c32d4322
allow help to work with files containing only comments
John W. Eaton <jwe@octave.org>
parents:
8631
diff
changeset
|
667 |
| 6243 | 668 if (h.length () > 0) |
| 669 retval = true; | |
| 670 | |
| 671 return retval; | |
| 672 } | |
| 673 | |
| 674 static bool | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
675 raw_help_from_map (const std::string& nm, std::string& h, |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
676 const map_type& map, bool& symbol_found) |
| 3355 | 677 { |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
678 map_iter idx = map.find (nm); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
679 symbol_found = (idx != map.end ()); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
680 h = (symbol_found) ? idx->second : ""; |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
681 return symbol_found; |
| 3355 | 682 } |
| 683 | |
| 6243 | 684 std::string |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
685 raw_help (const std::string& nm, bool& symbol_found) |
| 6243 | 686 { |
| 687 std::string h; | |
| 688 std::string w; | |
| 689 std::string f; | |
| 690 | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
691 (raw_help_from_symbol_table (nm, h, w, symbol_found) |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
692 || raw_help_from_file (nm, h, f, symbol_found) |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
693 || raw_help_from_map (nm, h, operators_map, symbol_found) |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
694 || raw_help_from_map (nm, h, keywords_map, symbol_found)); |
| 6243 | 695 |
| 696 return h; | |
| 697 } | |
| 698 | |
| 1140 | 699 static void |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
700 do_get_help_text (const std::string name, std::string& text, |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
701 std::string& format) |
| 1140 | 702 { |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
703 bool symbol_found = false; |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
704 text = raw_help (name, symbol_found); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
705 |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
706 format = "Not found"; |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
707 if (symbol_found) |
| 1140 | 708 { |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
709 size_t idx = -1; |
|
8631
52956d669506
Display sensible error message when the help text of an undocumented function is requested
Soren Hauberg <hauberg@gmail.com>
parents:
8630
diff
changeset
|
710 if (text.empty ()) |
|
52956d669506
Display sensible error message when the help text of an undocumented function is requested
Soren Hauberg <hauberg@gmail.com>
parents:
8630
diff
changeset
|
711 { |
|
52956d669506
Display sensible error message when the help text of an undocumented function is requested
Soren Hauberg <hauberg@gmail.com>
parents:
8630
diff
changeset
|
712 format = "Not documented"; |
|
52956d669506
Display sensible error message when the help text of an undocumented function is requested
Soren Hauberg <hauberg@gmail.com>
parents:
8630
diff
changeset
|
713 } |
|
52956d669506
Display sensible error message when the help text of an undocumented function is requested
Soren Hauberg <hauberg@gmail.com>
parents:
8630
diff
changeset
|
714 else if (looks_like_texinfo (text, idx)) |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
715 { |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
716 format = "texinfo"; |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
717 text.erase (0, idx); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
718 } |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
719 else if (looks_like_html (text)) |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
720 { |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
721 format = "html"; |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
722 } |
| 5399 | 723 else |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
724 { |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
725 format = "plain text"; |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
726 } |
| 1140 | 727 } |
| 728 } | |
| 729 | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
730 DEFUN (get_help_text, args, , "-*- texinfo -*-\n\ |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
731 @deftypefn {Loadable Function} {[@var{text}, @var{format}] =} get_help_text (@var{name})\n\ |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
732 Returns the help text of a given function.\n\ |
| 3168 | 733 \n\ |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
734 This function returns the raw help text @var{text} and an indication of\n\ |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
735 its format for the function @var{name}. The format indication @var{format}\n\ |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
736 is a string that can be either @t{\"texinfo\"}, @t{\"html\"}, or\n\ |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
737 @t{\"plain text\"}.\n\ |
| 3332 | 738 \n\ |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
739 To convert the help text to other formats, use the @code{makeinfo} function.\n\ |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
740 \n\ |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
741 @seealso{makeinfo}\n\ |
|
8812
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
742 @end deftypefn") |
| 529 | 743 { |
| 2086 | 744 octave_value_list retval; |
| 529 | 745 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
746 if (args.length () == 1) |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
747 { |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
748 const std::string name = args (0).string_value (); |
| 1755 | 749 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
750 if (! error_state) |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
751 { |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
752 std::string text; |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
753 std::string format; |
| 529 | 754 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
755 do_get_help_text (name, text, format); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
756 |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
757 retval(1) = format; |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
758 retval(0) = text; |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
759 } |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
760 else |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
761 error ("get_help_text: invalid input"); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
762 } |
| 529 | 763 else |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
764 print_usage (); |
| 529 | 765 |
| 766 return retval; | |
| 767 } | |
| 768 | |
|
8812
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
769 // Return a cell array of strings containing the names of all |
|
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
770 // operators. |
|
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
771 |
|
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
772 DEFUN (__operators__, , , |
|
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
773 "-*- texinfo -*-\n\ |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
774 @deftypefn {Function File} __operators__ ()\n\ |
|
8812
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
775 Undocumented internal function.\n\ |
|
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
776 @end deftypefn") |
| 3355 | 777 { |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
778 return octave_value (Cell (names (operators_map))); |
| 3355 | 779 } |
| 780 | |
|
8812
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
781 // Return a cell array of strings containing the names of all |
|
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
782 // keywords. |
|
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
783 |
|
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
784 DEFUN (__keywords__, , , |
|
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
785 "-*- texinfo -*-\n\ |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
786 @deftypefn {Function File} __keywords__ ()\n\ |
|
8812
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
787 Undocumented internal function.\n\ |
|
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
788 @end deftypefn") |
| 581 | 789 { |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
790 return octave_value (Cell (names (keywords_map))); |
| 581 | 791 } |
| 792 | |
|
8812
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
793 // Return a cell array of strings containing the names of all builtin |
|
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
794 // functions. |
|
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
795 |
|
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
796 DEFUN (__builtins__, , , |
|
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
797 "-*- texinfo -*-\n\ |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
798 @deftypefn {Function File} __builtins__ ()\n\ |
|
8812
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
799 Undocumented internal function.\n\ |
|
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
800 @end deftypefn") |
| 3355 | 801 { |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
802 const string_vector bif = symbol_table::built_in_function_names (); |
| 3355 | 803 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
804 return octave_value (Cell (bif)); |
| 3355 | 805 } |
| 806 | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
807 static std::string |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
808 do_which (const std::string& name, std::string& type) |
| 3355 | 809 { |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
810 std::string file; |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
811 |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
812 type = std::string (); |
| 3355 | 813 |
| 7336 | 814 octave_value val = symbol_table::find_function (name); |
| 815 | |
| 816 if (val.is_defined ()) | |
| 3355 | 817 { |
| 7336 | 818 octave_function *fcn = val.function_value (); |
| 819 | |
| 820 if (fcn) | |
| 821 { | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
822 file = fcn->fcn_file_name (); |
| 3355 | 823 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
824 if (file.empty ()) |
| 7336 | 825 { |
| 826 if (fcn->is_user_function ()) | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
827 type = "command-line function"; |
| 7336 | 828 else |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
829 type = "built-in function"; |
| 7336 | 830 } |
| 831 else | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
832 type = val.is_user_script () |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
833 ? std::string ("script") : std::string ("function"); |
| 7336 | 834 } |
| 835 } | |
|
8672
2a49c32d4322
allow help to work with files containing only comments
John W. Eaton <jwe@octave.org>
parents:
8631
diff
changeset
|
836 else |
|
2a49c32d4322
allow help to work with files containing only comments
John W. Eaton <jwe@octave.org>
parents:
8631
diff
changeset
|
837 { |
|
2a49c32d4322
allow help to work with files containing only comments
John W. Eaton <jwe@octave.org>
parents:
8631
diff
changeset
|
838 // We might find a file that contains only a doc string. |
|
2a49c32d4322
allow help to work with files containing only comments
John W. Eaton <jwe@octave.org>
parents:
8631
diff
changeset
|
839 |
|
2a49c32d4322
allow help to work with files containing only comments
John W. Eaton <jwe@octave.org>
parents:
8631
diff
changeset
|
840 file = load_path::find_fcn_file (name); |
|
2a49c32d4322
allow help to work with files containing only comments
John W. Eaton <jwe@octave.org>
parents:
8631
diff
changeset
|
841 } |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
842 |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
843 return file; |
| 3355 | 844 } |
| 845 | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
846 std::string |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
847 do_which (const std::string& name) |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
848 { |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
849 std::string retval; |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
850 |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
851 std::string type; |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
852 |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
853 retval = do_which (name, type); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
854 |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
855 return retval; |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
856 } |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
857 |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
858 DEFUN (__which__, args, , |
| 3361 | 859 "-*- texinfo -*-\n\ |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
860 @deftypefn {Built-in Function} {} __which__ (@var{name}, @dots{})\n\ |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
861 Undocumented internal function.\n\ |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
862 @end deftypefn") |
| 581 | 863 { |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
864 octave_value retval; |
| 581 | 865 |
| 1968 | 866 string_vector argv = args.make_argv ("which"); |
| 1755 | 867 |
| 3355 | 868 if (! error_state) |
| 869 { | |
| 870 int argc = argv.length (); | |
| 581 | 871 |
| 3355 | 872 if (argc > 1) |
| 581 | 873 { |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
874 Octave_map m (dim_vector (1, argc-1)); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
875 |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
876 Cell names (1, argc-1); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
877 Cell files (1, argc-1); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
878 Cell types (1, argc-1); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
879 |
| 3355 | 880 for (int i = 1; i < argc; i++) |
| 581 | 881 { |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
882 std::string name = argv[i]; |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
883 |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
884 std::string type; |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
885 |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
886 std::string file = do_which (name, type); |
| 3141 | 887 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
888 names(i-1) = name; |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
889 files(i-1) = file; |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
890 types(i-1) = type; |
| 581 | 891 } |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
892 |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
893 m.assign ("name", names); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
894 m.assign ("file", files); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
895 m.assign ("type", types); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
896 |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
897 retval = m; |
| 581 | 898 } |
| 3355 | 899 else |
| 5823 | 900 print_usage (); |
| 581 | 901 } |
| 902 | |
| 903 return retval; | |
| 904 } | |
| 905 | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
906 // FIXME -- Are we sure this function always does the right thing? |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
907 inline bool |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
908 file_is_in_dir (const std::string filename, const std::string dir) |
| 5447 | 909 { |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
910 if (filename.find (dir) == 0) |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
911 { |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
912 const int dir_len = dir.size (); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
913 const int filename_len = filename.size (); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
914 const int max_allowed_seps = file_ops::is_dir_sep (dir [dir_len-1]) ? 0 : 1; |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
915 |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
916 int num_seps = 0; |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
917 for (int i = dir_len; i < filename_len; i++) |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
918 if (file_ops::is_dir_sep (filename [i])) |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
919 num_seps ++; |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
920 |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
921 return (num_seps <= max_allowed_seps); |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
922 } |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
923 else |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
924 return false; |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
925 } |
| 5447 | 926 |
|
8812
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
927 // Return a cell array of strings containing the names of all |
|
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
928 // functions available in DIRECTORY. If no directory is given, search |
|
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
929 // the current path. |
|
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
930 |
|
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
931 DEFUN (__list_functions__, args, , |
|
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
932 "-*- texinfo -*-\n\ |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
933 @deftypefn {Function File} {@var{retval} =} __list_functions__ ()\n\ |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
934 @deftypefnx{Function File} {@var{retval} =} __list_functions__ (@var{directory})\n\ |
|
8812
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
935 Undocumented internal function.\n\ |
|
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
8672
diff
changeset
|
936 @end deftypefn") |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
937 { |
|
8863
34a821854961
pkg.m (generate_lookfor_cache): generate a DOC file for each directory
Jason Riedy <jason@acm.org>
parents:
8861
diff
changeset
|
938 octave_value retval; |
| 5447 | 939 |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
940 // Get list of functions |
|
8863
34a821854961
pkg.m (generate_lookfor_cache): generate a DOC file for each directory
Jason Riedy <jason@acm.org>
parents:
8861
diff
changeset
|
941 string_vector ffl = load_path::fcn_names (); |
|
34a821854961
pkg.m (generate_lookfor_cache): generate a DOC file for each directory
Jason Riedy <jason@acm.org>
parents:
8861
diff
changeset
|
942 string_vector afl = autoloaded_functions (); |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
943 |
|
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
944 if (args.length () == 0) |
|
8863
34a821854961
pkg.m (generate_lookfor_cache): generate a DOC file for each directory
Jason Riedy <jason@acm.org>
parents:
8861
diff
changeset
|
945 retval = Cell (ffl.append (afl)); |
| 5447 | 946 else |
| 947 { | |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
948 std::string dir = args (0).string_value (); |
|
8863
34a821854961
pkg.m (generate_lookfor_cache): generate a DOC file for each directory
Jason Riedy <jason@acm.org>
parents:
8861
diff
changeset
|
949 |
|
34a821854961
pkg.m (generate_lookfor_cache): generate a DOC file for each directory
Jason Riedy <jason@acm.org>
parents:
8861
diff
changeset
|
950 if (! error_state) |
|
34a821854961
pkg.m (generate_lookfor_cache): generate a DOC file for each directory
Jason Riedy <jason@acm.org>
parents:
8861
diff
changeset
|
951 { |
|
34a821854961
pkg.m (generate_lookfor_cache): generate a DOC file for each directory
Jason Riedy <jason@acm.org>
parents:
8861
diff
changeset
|
952 string_vector fl = load_path::files (dir); |
|
34a821854961
pkg.m (generate_lookfor_cache): generate a DOC file for each directory
Jason Riedy <jason@acm.org>
parents:
8861
diff
changeset
|
953 |
|
34a821854961
pkg.m (generate_lookfor_cache): generate a DOC file for each directory
Jason Riedy <jason@acm.org>
parents:
8861
diff
changeset
|
954 if (! error_state) |
|
34a821854961
pkg.m (generate_lookfor_cache): generate a DOC file for each directory
Jason Riedy <jason@acm.org>
parents:
8861
diff
changeset
|
955 retval = Cell (fl); |
|
34a821854961
pkg.m (generate_lookfor_cache): generate a DOC file for each directory
Jason Riedy <jason@acm.org>
parents:
8861
diff
changeset
|
956 } |
| 5447 | 957 else |
|
8863
34a821854961
pkg.m (generate_lookfor_cache): generate a DOC file for each directory
Jason Riedy <jason@acm.org>
parents:
8861
diff
changeset
|
958 error ("__list_functions__: input must be a string"); |
|
8575
f134925a1cfa
m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
8503
diff
changeset
|
959 } |
| 5447 | 960 |
| 961 return retval; | |
| 962 } | |
| 963 | |
| 8861 | 964 DEFUN (doc_cache_file, args, nargout, |
| 965 "-*- texinfo -*-\n\ | |
| 966 @deftypefn {Built-in Function} {@var{val} =} doc_cache_file ()\n\ | |
| 967 @deftypefnx {Built-in Function} {@var{old_val} =} doc_cache_file (@var{new_val})\n\ | |
| 968 Query or set the internal variable that specifies the name of the\n\ | |
| 969 Octave DOC file. The default value is @code{\"@var{octetcdir}/DOC\"}.\n\ | |
| 970 @seealso{info_program, doc, help, makeinfo_program}\n\ | |
| 971 @end deftypefn") | |
| 972 { | |
| 973 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (doc_cache_file); | |
| 974 } | |
| 975 | |
| 5794 | 976 DEFUN (info_file, args, nargout, |
| 977 "-*- texinfo -*-\n\ | |
| 978 @deftypefn {Built-in Function} {@var{val} =} info_file ()\n\ | |
| 979 @deftypefnx {Built-in Function} {@var{old_val} =} info_file (@var{new_val})\n\ | |
| 980 Query or set the internal variable that specifies the name of the\n\ | |
| 981 Octave info file. The default value is\n\ | |
| 982 @code{\"@var{octave-home}/info/octave.info\"}, in\n\ | |
| 983 which @var{octave-home} is the directory where all of Octave is installed.\n\ | |
| 984 @seealso{info_program, doc, help, makeinfo_program}\n\ | |
| 985 @end deftypefn") | |
| 2202 | 986 { |
| 5794 | 987 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (info_file); |
| 2202 | 988 } |
| 989 | |
| 5794 | 990 DEFUN (info_program, args, nargout, |
| 991 "-*- texinfo -*-\n\ | |
| 992 @deftypefn {Built-in Function} {@var{val} =} info_program ()\n\ | |
| 993 @deftypefnx {Built-in Function} {@var{old_val} =} info_program (@var{new_val})\n\ | |
| 994 Query or set the internal variable that specifies the name of the\n\ | |
| 7096 | 995 info program to run. The default value is\n\ |
| 3686 | 996 @code{\"@var{octave-home}/libexec/octave/@var{version}/exec/@var{arch}/info\"}\n\ |
| 997 in which @var{octave-home} is the directory where all of Octave is\n\ | |
| 998 installed, @var{version} is the Octave version number, and @var{arch}\n\ | |
| 999 is the system type (for example, @code{i686-pc-linux-gnu}). The\n\ | |
| 1000 default initial value may be overridden by the environment variable\n\ | |
| 1001 @code{OCTAVE_INFO_PROGRAM}, or the command line argument\n\ | |
| 5794 | 1002 @code{--info-program NAME}.\n\ |
| 1003 @seealso{info_file, doc, help, makeinfo_program}\n\ | |
| 1004 @end deftypefn") | |
| 1005 { | |
| 1006 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (info_program); | |
| 1007 } | |
| 3686 | 1008 |
| 5794 | 1009 DEFUN (makeinfo_program, args, nargout, |
| 1010 "-*- texinfo -*-\n\ | |
| 1011 @deftypefn {Built-in Function} {@var{val} =} makeinfo_program ()\n\ | |
| 1012 @deftypefnx {Built-in Function} {@var{old_val} =} makeinfo_program (@var{new_val})\n\ | |
| 1013 Query or set the internal variable that specifies the name of the\n\ | |
| 1014 makeinfo program that Octave runs to format help text containing\n\ | |
| 1015 Texinfo markup commands. The default initial value is @code{\"makeinfo\"}.\n\ | |
| 1016 @seealso{info_file, info_program, doc, help}\n\ | |
| 1017 @end deftypefn") | |
| 1018 { | |
| 1019 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (makeinfo_program); | |
| 1020 } | |
| 2202 | 1021 |
| 5794 | 1022 DEFUN (suppress_verbose_help_message, args, nargout, |
| 1023 "-*- texinfo -*-\n\ | |
| 1024 @deftypefn {Built-in Function} {@var{val} =} suppress_verbose_help_message ()\n\ | |
| 1025 @deftypefnx {Built-in Function} {@var{old_val} =} suppress_verbose_help_message (@var{new_val})\n\ | |
| 7001 | 1026 Query or set the internal variable that controls whether Octave\n\ |
| 5794 | 1027 will add additional help information to the end of the output from\n\ |
| 3332 | 1028 the @code{help} command and usage messages for built-in commands.\n\ |
| 5794 | 1029 @end deftypefn") |
| 1030 { | |
| 1031 return SET_INTERNAL_VARIABLE (suppress_verbose_help_message); | |
| 2189 | 1032 } |
| 1033 | |
| 1 | 1034 /* |
| 1035 ;;; Local Variables: *** | |
| 1036 ;;; mode: C++ *** | |
| 1037 ;;; End: *** | |
| 1038 */ |