|
1
|
1 /* |
|
|
2 |
|
2847
|
3 Copyright (C) 1996, 1997 John W. Eaton |
|
1
|
4 |
|
|
5 This file is part of Octave. |
|
|
6 |
|
|
7 Octave is free software; you can redistribute it and/or modify it |
|
|
8 under the terms of the GNU General Public License as published by the |
|
|
9 Free Software Foundation; either version 2, or (at your option) any |
|
|
10 later version. |
|
|
11 |
|
|
12 Octave is distributed in the hope that it will be useful, but WITHOUT |
|
|
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
|
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
|
15 for more details. |
|
|
16 |
|
|
17 You should have received a copy of the GNU General Public License |
|
|
18 along with Octave; see the file COPYING. If not, write to the Free |
|
5307
|
19 Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
|
|
20 02110-1301, USA. |
|
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" |
|
2926
|
46 #include "oct-env.h" |
|
1755
|
47 #include "str-vec.h" |
|
|
48 |
|
2492
|
49 #include <defaults.h> |
|
1352
|
50 #include "defun.h" |
|
|
51 #include "dirfns.h" |
|
|
52 #include "error.h" |
|
2202
|
53 #include "gripes.h" |
|
1352
|
54 #include "help.h" |
|
2177
|
55 #include "input.h" |
|
5832
|
56 #include "load-path.h" |
|
1755
|
57 #include "oct-obj.h" |
|
2976
|
58 #include "ov-usr-fcn.h" |
|
1352
|
59 #include "pager.h" |
|
3018
|
60 #include "parse.h" |
|
1466
|
61 #include "pathsearch.h" |
|
3295
|
62 #include "procstream.h" |
|
529
|
63 #include "sighandlers.h" |
|
|
64 #include "symtab.h" |
|
2694
|
65 #include "syswait.h" |
|
1755
|
66 #include "toplev.h" |
|
242
|
67 #include "utils.h" |
|
1352
|
68 #include "variables.h" |
|
3301
|
69 #include "version.h" |
|
5447
|
70 #include "quit.h" |
|
529
|
71 |
|
2202
|
72 // Name of the info file specified on command line. |
|
|
73 // (--info-file file) |
|
3523
|
74 std::string Vinfo_file; |
|
2202
|
75 |
|
|
76 // Name of the info reader we'd like to use. |
|
|
77 // (--info-program program) |
|
5794
|
78 std::string Vinfo_program; |
|
2202
|
79 |
|
3686
|
80 // Name of the makeinfo program to run. |
|
5794
|
81 static std::string Vmakeinfo_program = "makeinfo"; |
|
3686
|
82 |
|
2189
|
83 // If TRUE, don't print additional help message in help and usage |
|
|
84 // functions. |
|
5794
|
85 static bool Vsuppress_verbose_help_message = false; |
|
2189
|
86 |
|
5775
|
87 // FIXME -- maybe this should use string instead of char*. |
|
3016
|
88 |
|
|
89 struct help_list |
|
|
90 { |
|
|
91 const char *name; |
|
|
92 const char *help; |
|
|
93 }; |
|
|
94 |
|
1
|
95 static help_list operators[] = |
|
|
96 { |
|
|
97 { "!", |
|
|
98 "Logical not operator. See also `~'.\n", }, |
|
|
99 |
|
|
100 { "!=", |
|
|
101 "Logical not equals operator. See also `~' and `<>'.\n", }, |
|
|
102 |
|
|
103 { "\"", |
|
|
104 "String delimiter.\n", }, |
|
|
105 |
|
|
106 { "#", |
|
928
|
107 "Begin comment character. See also `%'.", }, |
|
1
|
108 |
|
|
109 { "%", |
|
928
|
110 "Begin comment charcter. See also `#'.", }, |
|
1
|
111 |
|
|
112 { "&", |
|
928
|
113 "Logical and operator. See also `&&'.", }, |
|
1
|
114 |
|
|
115 { "&&", |
|
928
|
116 "Logical and operator. See also `&'.", }, |
|
1
|
117 |
|
|
118 { "'", |
|
|
119 "Matrix transpose operator. For complex matrices, computes the\n\ |
|
|
120 complex conjugate (Hermitian) transpose. See also `.''\n\ |
|
|
121 \n\ |
|
|
122 The single quote character may also be used to delimit strings, but\n\ |
|
|
123 it is better to use the double quote character, since that is never\n\ |
|
928
|
124 ambiguous", }, |
|
1
|
125 |
|
|
126 { "(", |
|
928
|
127 "Array index or function argument delimiter.", }, |
|
1
|
128 |
|
|
129 { ")", |
|
928
|
130 "Array index or function argument delimiter.", }, |
|
1
|
131 |
|
|
132 { "*", |
|
928
|
133 "Multiplication operator. See also `.*'", }, |
|
1
|
134 |
|
|
135 { "**", |
|
928
|
136 "Power operator. See also `^', `.**', and `.^'", }, |
|
1
|
137 |
|
|
138 { "+", |
|
928
|
139 "Addition operator.", }, |
|
1
|
140 |
|
|
141 { "++", |
|
5339
|
142 "Increment operator. As in C, may be applied as a prefix or postfix\n\ |
|
|
143 operator.", }, |
|
1
|
144 |
|
|
145 { ",", |
|
928
|
146 "Array index, function argument, or command separator.", }, |
|
1
|
147 |
|
|
148 { "-", |
|
928
|
149 "Subtraction or unary negation operator.", }, |
|
1
|
150 |
|
|
151 { "--", |
|
5339
|
152 "Decrement operator. As in C, may be applied as a prefix or postfix\n\ |
|
|
153 operator.", }, |
|
1
|
154 |
|
|
155 { ".'", |
|
|
156 "Matrix transpose operator. For complex matrices, computes the\n\ |
|
928
|
157 transpose, *not* the complex conjugate transpose. See also `''.", }, |
|
1
|
158 |
|
|
159 { ".*", |
|
928
|
160 "Element by element multiplication operator. See also `*'.", }, |
|
1
|
161 |
|
|
162 { ".**", |
|
928
|
163 "Element by element power operator. See also `**', `^', and `.^'.", }, |
|
1
|
164 |
|
|
165 { "./", |
|
928
|
166 "Element by element division operator. See also `/' and `\\'.", }, |
|
1
|
167 |
|
|
168 { ".^", |
|
928
|
169 "Element by element power operator. See also `**', `^', and `.^'.", }, |
|
1
|
170 |
|
|
171 { "/", |
|
928
|
172 "Right division. See also `\\' and `./'.", }, |
|
1
|
173 |
|
|
174 { ":", |
|
928
|
175 "Select entire rows or columns of matrices.", }, |
|
1
|
176 |
|
|
177 { ";", |
|
928
|
178 "Array row or command separator. See also `,'.", }, |
|
1
|
179 |
|
|
180 { "<", |
|
928
|
181 "Less than operator.", }, |
|
1
|
182 |
|
|
183 { "<=", |
|
928
|
184 "Less than or equals operator.", }, |
|
1
|
185 |
|
|
186 { "<>", |
|
928
|
187 "Logical not equals operator. See also `!=' and `~='.", }, |
|
1
|
188 |
|
|
189 { "=", |
|
928
|
190 "Assignment operator.", }, |
|
1
|
191 |
|
|
192 { "==", |
|
928
|
193 "Equality test operator.", }, |
|
1
|
194 |
|
|
195 { ">", |
|
928
|
196 "Greater than operator.", }, |
|
1
|
197 |
|
|
198 { ">=", |
|
928
|
199 "Greater than or equals operator.", }, |
|
1
|
200 |
|
|
201 { "[", |
|
928
|
202 "Return list delimiter. See also `]'.", }, |
|
1
|
203 |
|
|
204 { "\\", |
|
928
|
205 "Left division operator. See also `/' and `./'.", }, |
|
1
|
206 |
|
|
207 { "]", |
|
928
|
208 "Return list delimiter. See also `['.", }, |
|
1
|
209 |
|
|
210 { "^", |
|
928
|
211 "Power operator. See also `**', `.^', and `.**.'", }, |
|
1
|
212 |
|
|
213 { "|", |
|
928
|
214 "Logical or operator. See also `||'.", }, |
|
1
|
215 |
|
|
216 { "||", |
|
928
|
217 "Logical or operator. See also `|'.", }, |
|
1
|
218 |
|
|
219 { "~", |
|
928
|
220 "Logical not operator. See also `!' and `~'.", }, |
|
1
|
221 |
|
|
222 { "~=", |
|
928
|
223 "Logical not equals operator. See also `<>' and `!='.", }, |
|
1
|
224 |
|
529
|
225 { 0, 0, }, |
|
1
|
226 }; |
|
|
227 |
|
|
228 static help_list keywords[] = |
|
|
229 { |
|
|
230 { "break", |
|
5818
|
231 "-*- texinfo -*-\n\ |
|
|
232 @deffn Keyword break\n\ |
|
|
233 Exit the innermost enclosing do, while or for loop.\n\ |
|
|
234 @seealso{do, while, for, continue}\n\ |
|
|
235 @end deffn", }, |
|
5040
|
236 |
|
|
237 { "case", |
|
5818
|
238 "-*- texinfo -*-\n\ |
|
|
239 @deffn Keyword case @{@var{value}@}\n\ |
|
|
240 A case statement in an switch. Octave cases are exclusive and do not\n\ |
|
5040
|
241 fall-through as do C-language cases. A switch statement must have at least\n\ |
|
5818
|
242 one case. See @code{switch} for an example.\n\ |
|
|
243 @seealso{switch}\n\ |
|
|
244 @end deffn", }, |
|
1
|
245 |
|
1489
|
246 { "catch", |
|
5818
|
247 "-*- texinfo -*-\n\ |
|
|
248 @deffn Keyword catch\n\ |
|
|
249 Begin the cleanup part of a try-catch block.\n\ |
|
|
250 @seealso{try}\n\ |
|
|
251 @end deffn", }, |
|
1489
|
252 |
|
1
|
253 { "continue", |
|
5818
|
254 "-*- texinfo -*-\n\ |
|
|
255 @deffn Keyword continue\n\ |
|
|
256 Jump to the end of the innermost enclosing do, while or for loop.\n\ |
|
|
257 @seealso{do, while, for, break}\n\ |
|
|
258 @end deffn", }, |
|
5040
|
259 |
|
|
260 { "do", |
|
5818
|
261 "-*- texinfo -*-\n\ |
|
|
262 @deffn Keyword do\n\ |
|
|
263 Begin a do-until loop. This differs from a do-while loop in that the\n\ |
|
|
264 body of the loop is executed at least once.\n\ |
|
|
265 @seealso{while}\n\ |
|
|
266 @end deffn", }, |
|
1
|
267 |
|
|
268 { "else", |
|
5818
|
269 "-*- texinfo -*-\n\ |
|
|
270 @deffn Keyword else\n\ |
|
|
271 Alternate action for an if block. See @code{if} for an example.\n\ |
|
|
272 @seealso{if}\n\ |
|
|
273 @end deffn", }, |
|
1
|
274 |
|
|
275 { "elseif", |
|
5818
|
276 "-*- texinfo -*-\n\ |
|
|
277 @deffn Keyword elseif (@var{condition})\n\ |
|
|
278 Alternate conditional test for an if block. See @code{if} for an example.\n\ |
|
|
279 @seealso{if}\n\ |
|
|
280 @end deffn", }, |
|
1
|
281 |
|
|
282 { "end", |
|
5818
|
283 "-*- texinfo -*-\n\ |
|
|
284 @deffn Keyword end\n\ |
|
|
285 Mark the end of any @code{for}, @code{if}, @code{do}, @code{while}, or @code{function} block.\n\ |
|
|
286 @seealso{for, if, do, while, function}\n\ |
|
|
287 @end deffn", }, |
|
928
|
288 |
|
1489
|
289 { "end_try_catch", |
|
5818
|
290 "-*- texinfo -*-\n\ |
|
|
291 @deffn Keyword end_try_catch\n\ |
|
|
292 Mark the end of an @code{try-catch} block.\n\ |
|
|
293 @seealso{try, catch}\n\ |
|
|
294 @end deffn", }, |
|
1489
|
295 |
|
928
|
296 { "end_unwind_protect", |
|
5818
|
297 "-*- texinfo -*-\n\ |
|
|
298 @deffn Keyword end_unwind_protect\n\ |
|
|
299 Mark the end of an unwind_protect block.\n\ |
|
|
300 @seealso{unwind_protect}\n\ |
|
|
301 @end deffn", }, |
|
1
|
302 |
|
|
303 { "endfor", |
|
5818
|
304 "-*- texinfo -*-\n\ |
|
|
305 @deffn Keyword endfor\n\ |
|
|
306 Mark the end of a for loop. See @code{for} for an example.\n\ |
|
|
307 @seealso{for}\n\ |
|
|
308 @end deffn", }, |
|
1
|
309 |
|
|
310 { "endfunction", |
|
5818
|
311 "-*- texinfo -*-\n\ |
|
|
312 @deffn Keyword endfunction\n\ |
|
|
313 Mark the end of a function.\n\ |
|
|
314 @seealso{function}\n\ |
|
|
315 @end deffn", }, |
|
1
|
316 |
|
|
317 { "endif", |
|
5818
|
318 "-*- texinfo -*-\n\ |
|
|
319 @deffn Keyword endif\n\ |
|
|
320 Mark the end of an if block. See @code{if} for an example.\n\ |
|
|
321 @seealso{if}\n\ |
|
|
322 @end deffn", }, |
|
1
|
323 |
|
5122
|
324 { "endswitch", |
|
5818
|
325 "-*- texinfo -*-\n\ |
|
|
326 @deffn Keyword endswitch\n\ |
|
|
327 Mark the end of a switch block. See @code{switch} for an example.\n\ |
|
|
328 @seealso{switch}\n\ |
|
|
329 @end deffn", }, |
|
5122
|
330 |
|
1
|
331 { "endwhile", |
|
5818
|
332 "-*- texinfo -*-\n\ |
|
|
333 @deffn Keyword endwhile\n\ |
|
|
334 Mark the end of a while loop. See @code{while} for an example.\n\ |
|
|
335 @seealso{do, while}\n\ |
|
|
336 @end deffn", }, |
|
1
|
337 |
|
|
338 { "for", |
|
5818
|
339 "-*- texinfo -*-\n\ |
|
|
340 @deffn Keyword for @var{i} = @var{range}\n\ |
|
|
341 Begin a for loop.\n\ |
|
|
342 @example\n\ |
|
|
343 for i = 1:10\n\ |
|
|
344 i\n\ |
|
|
345 endfor\n\ |
|
|
346 @end example\n\ |
|
|
347 @seealso{do, while}\n\ |
|
|
348 @end deffn", }, |
|
1
|
349 |
|
|
350 { "function", |
|
5818
|
351 "-*- texinfo -*-\n\ |
|
|
352 @deffn Keyword function @var{outputs} = function (@var{input}, ...)\n\ |
|
|
353 @deffnx Keyword function {} function (@var{input}, ...)\n\ |
|
|
354 @deffnx Keyword function @var{outputs} = function\n\ |
|
|
355 Begin a function body with @var{outputs} as results and @var{inputs} as\n\ |
|
|
356 parameters.\n\ |
|
|
357 @seealso{return}\n\ |
|
|
358 @end deffn", }, |
|
1
|
359 |
|
|
360 { "global", |
|
5818
|
361 "-*- texinfo -*-\n\ |
|
|
362 @deffn Keyword global\n\ |
|
|
363 Declare variables to have global scope.\n\ |
|
|
364 @example\n\ |
|
|
365 global @var{x};\n\ |
|
|
366 if isempty (@var{x})\n\ |
|
|
367 x = 1;\n\ |
|
|
368 endif\n\ |
|
|
369 @end example\n\ |
|
|
370 @seealso{persistent}\n\ |
|
|
371 @end deffn", }, |
|
1
|
372 |
|
|
373 { "if", |
|
5393
|
374 "-*- texinfo -*-\n\ |
|
|
375 @deffn Keyword if (@var{cond}) @dots{} endif\n\ |
|
|
376 @deffnx Keyword if (@var{cond}) @dots{} else @dots{} endif\n\ |
|
|
377 @deffnx Keyword if (@var{cond}) @dots{} elseif (@var{cond}) @dots{} endif\n\ |
|
|
378 @deffnx Keyword if (@var{cond}) @dots{} elseif (@var{cond}) @dots{} else @dots{} endif\n\ |
|
|
379 Begin an if block.\n\ |
|
5818
|
380 @example\n\ |
|
|
381 x = 1;\n\ |
|
|
382 if (x == 1)\n\ |
|
|
383 disp (\"one\");\n\ |
|
|
384 elseif (x == 2)\n\ |
|
|
385 disp (\"two\");\n\ |
|
|
386 else\n\ |
|
|
387 disp (\"not one or two\");\n\ |
|
|
388 endif\n\ |
|
|
389 @end example\n\ |
|
5646
|
390 @seealso{switch}\n\ |
|
|
391 @end deffn", }, |
|
1
|
392 |
|
5040
|
393 { "otherwise", |
|
5818
|
394 "-*- texinfo -*-\n\ |
|
|
395 @deffn Keyword otherwise\n\ |
|
|
396 The default statement in a switch block (similar to else in an if block).\n\ |
|
|
397 @seealso{switch}\n\ |
|
|
398 @end deffn", }, |
|
5040
|
399 |
|
4686
|
400 { "persistent", |
|
5818
|
401 "-*- texinfo -*-\n\ |
|
|
402 @deffn Keyword persistent @var{var}\n\ |
|
|
403 Declare variables as persistent. A variable that has been declared\n\ |
|
5623
|
404 persistent within a function will retain its contents in memory between\n\ |
|
|
405 subsequent calls to the same function. The difference between persistent\n\ |
|
5818
|
406 variables and global variables is that persistent variables are local in \n\ |
|
|
407 scope to a particular function and are not visible elsewhere.\n\ |
|
|
408 @seealso{global}\n\ |
|
|
409 @end deffn", }, |
|
4686
|
410 |
|
5040
|
411 { "replot", |
|
5818
|
412 "-*- texinfo -*-\n\ |
|
|
413 @deffn Keyword replot\n\ |
|
|
414 Replot a graphic.\n\ |
|
|
415 @seealso{plot}\n\ |
|
|
416 @end deffn", }, |
|
5040
|
417 |
|
1
|
418 { "return", |
|
5818
|
419 "-*- texinfo -*-\n\ |
|
|
420 @deffn Keyword return\n\ |
|
|
421 Return from a function.\n\ |
|
|
422 @seealso{function}\n\ |
|
|
423 @end deffn", }, |
|
928
|
424 |
|
5040
|
425 { "static", |
|
5818
|
426 "-*- texinfo -*-\n\ |
|
|
427 @deffn Keyword static\n\ |
|
|
428 This function has been deprecated in favor of persistent.\n\ |
|
|
429 @seealso{persistent}\n\ |
|
|
430 @end deffn", }, |
|
5040
|
431 |
|
|
432 { "switch", |
|
5818
|
433 "-*- texinfo -*-\n\ |
|
|
434 @deffn Keyword switch @var{statement}\n\ |
|
|
435 Begin a switch block.\n\ |
|
|
436 @example\n\ |
|
|
437 yesno = \"yes\"\n\ |
|
|
438 \n\ |
|
|
439 switch yesno\n\ |
|
5832
|
440 case @{\"Yes\" \"yes\" \"YES\" \"y\" \"Y\"@}\n\ |
|
5818
|
441 value = 1;\n\ |
|
5832
|
442 case @{\"No\" \"no\" \"NO\" \"n\" \"N\"@}\n\ |
|
5818
|
443 value = 0;\n\ |
|
|
444 otherwise\n\ |
|
|
445 error (\"invalid value\");\n\ |
|
|
446 endswitch\n\ |
|
|
447 @end example\n\ |
|
|
448 @seealso{if, case, otherwise}\n\ |
|
|
449 @end deffn", }, |
|
5040
|
450 |
|
1489
|
451 { "try", |
|
5818
|
452 "-*- texinfo -*-\n\ |
|
|
453 @deffn Keyword try\n\ |
|
|
454 Begin a try-catch block.\n\ |
|
6138
|
455 \n\ |
|
|
456 If an error occurs within a try block, then the catch code will be run and\n\ |
|
|
457 execution will proceed after the catch block (though it is often\n\ |
|
|
458 recommended to use the lasterr function to re-throw the error after cleanup\n\ |
|
|
459 is completed).\n\ |
|
|
460 @seealso{catch,unwind_protect}\n\ |
|
5818
|
461 @end deffn", }, |
|
1489
|
462 |
|
5040
|
463 { "until", |
|
5818
|
464 "-*- texinfo -*-\n\ |
|
|
465 @deffn Keyword until\n\ |
|
|
466 End a do-until loop.\n\ |
|
|
467 @seealso{do}\n\ |
|
|
468 @end deffn", }, |
|
5040
|
469 |
|
928
|
470 { "unwind_protect", |
|
5818
|
471 "-*- texinfo -*-\n\ |
|
|
472 @deffn Keyword unwind_protect\n\ |
|
|
473 Begin an unwind_protect block.\n\ |
|
6138
|
474 \n\ |
|
|
475 If an error occurs within the first part of an unwind_protect block\n\ |
|
|
476 the commands within the unwind_protect_cleanup block are executed before\n\ |
|
|
477 the error is thrown. If an error is not thrown, then the\n\ |
|
|
478 unwind_protect_cleanup block is still executed (in other words, the\n\ |
|
|
479 unwind_protect_cleanup will be run with or without an error in the\n\ |
|
|
480 unwind_protect block).\n\ |
|
|
481 @seealso{unwind_protect_cleanup,try}\n\ |
|
5818
|
482 @end deffn", }, |
|
928
|
483 |
|
|
484 { "unwind_protect_cleanup", |
|
5818
|
485 "-*- texinfo -*-\n\ |
|
|
486 @deffn Keyword unwind_protect_cleanup\n\ |
|
|
487 Begin the cleanup section of an unwind_protect block.\n\ |
|
|
488 @seealso{unwind_protect}\n\ |
|
|
489 @end deffn", }, |
|
1
|
490 |
|
5040
|
491 { "varargin", |
|
5818
|
492 "-*- texinfo -*-\n\ |
|
|
493 @deffn Keyword varargin\n\ |
|
|
494 Pass an arbitrary number of arguments into a function.\n\ |
|
|
495 @seealso{varargout, nargin, nargout}\n\ |
|
|
496 @end deffn", }, |
|
5040
|
497 |
|
|
498 { "varargout", |
|
5818
|
499 "-*- texinfo -*-\n\ |
|
|
500 @deffn Keyword varargout\n\ |
|
|
501 Pass an arbitrary number of arguments out of a function.\n\ |
|
|
502 @seealso{varargin, nargin, nargout}\n\ |
|
|
503 @end deffn", }, |
|
5040
|
504 |
|
1
|
505 { "while", |
|
5818
|
506 "-*- texinfo -*-\n\ |
|
|
507 @deffn Keyword while\n\ |
|
|
508 Begin a while loop.\n\ |
|
|
509 @seealso{do}\n\ |
|
|
510 @end deffn", }, |
|
1
|
511 |
|
529
|
512 { 0, 0, }, |
|
1
|
513 }; |
|
|
514 |
|
581
|
515 // Return a copy of the operator or keyword names. |
|
|
516 |
|
3016
|
517 static string_vector |
|
3355
|
518 names (help_list *lst) |
|
1
|
519 { |
|
1755
|
520 string_vector retval; |
|
|
521 |
|
3355
|
522 int count = 0; |
|
1
|
523 help_list *ptr = lst; |
|
529
|
524 while (ptr->name) |
|
1
|
525 { |
|
|
526 count++; |
|
|
527 ptr++; |
|
|
528 } |
|
|
529 |
|
1755
|
530 if (count > 0) |
|
|
531 { |
|
|
532 retval.resize (count); |
|
1
|
533 |
|
1755
|
534 ptr = lst; |
|
|
535 for (int i = 0; i < count; i++) |
|
|
536 { |
|
|
537 retval[i] = ptr->name; |
|
|
538 ptr++; |
|
|
539 } |
|
1
|
540 } |
|
|
541 |
|
1755
|
542 return retval; |
|
1
|
543 } |
|
|
544 |
|
3014
|
545 static help_list * |
|
1
|
546 operator_help (void) |
|
|
547 { |
|
|
548 return operators; |
|
|
549 } |
|
|
550 |
|
3016
|
551 static help_list * |
|
1
|
552 keyword_help (void) |
|
|
553 { |
|
|
554 return keywords; |
|
|
555 } |
|
|
556 |
|
5775
|
557 // It's not likely that this does the right thing now. FIXME |
|
3016
|
558 |
|
|
559 string_vector |
|
|
560 make_name_list (void) |
|
|
561 { |
|
3355
|
562 string_vector key = names (keyword_help ()); |
|
|
563 int key_len = key.length (); |
|
3016
|
564 |
|
4009
|
565 string_vector fbi = fbi_sym_tab->name_list (); |
|
|
566 int fbi_len = fbi.length (); |
|
|
567 |
|
3355
|
568 string_vector glb = global_sym_tab->name_list (); |
|
|
569 int glb_len = glb.length (); |
|
3016
|
570 |
|
3355
|
571 string_vector top = top_level_sym_tab->name_list (); |
|
|
572 int top_len = top.length (); |
|
3016
|
573 |
|
3355
|
574 string_vector lcl; |
|
3016
|
575 if (top_level_sym_tab != curr_sym_tab) |
|
3355
|
576 lcl = curr_sym_tab->name_list (); |
|
|
577 int lcl_len = lcl.length (); |
|
3016
|
578 |
|
5832
|
579 string_vector ffl = load_path::fcn_names (); |
|
3016
|
580 int ffl_len = ffl.length (); |
|
|
581 |
|
5592
|
582 string_vector afl = autoloaded_functions (); |
|
|
583 int afl_len = afl.length (); |
|
|
584 |
|
|
585 int total_len = key_len + fbi_len + glb_len + top_len + lcl_len + ffl_len + afl_len; |
|
3016
|
586 |
|
|
587 string_vector list (total_len); |
|
|
588 |
|
|
589 // Put all the symbols in one big list. |
|
|
590 |
|
|
591 int j = 0; |
|
|
592 int i = 0; |
|
|
593 for (i = 0; i < key_len; i++) |
|
|
594 list[j++] = key[i]; |
|
|
595 |
|
4009
|
596 for (i = 0; i < fbi_len; i++) |
|
|
597 list[j++] = fbi[i]; |
|
|
598 |
|
3016
|
599 for (i = 0; i < glb_len; i++) |
|
|
600 list[j++] = glb[i]; |
|
|
601 |
|
|
602 for (i = 0; i < top_len; i++) |
|
|
603 list[j++] = top[i]; |
|
|
604 |
|
|
605 for (i = 0; i < lcl_len; i++) |
|
|
606 list[j++] = lcl[i]; |
|
|
607 |
|
|
608 for (i = 0; i < ffl_len; i++) |
|
|
609 list[j++] = ffl[i]; |
|
|
610 |
|
5592
|
611 for (i = 0; i < afl_len; i++) |
|
|
612 list[j++] = afl[i]; |
|
|
613 |
|
3016
|
614 return list; |
|
|
615 } |
|
|
616 |
|
3014
|
617 void |
|
3523
|
618 additional_help_message (std::ostream& os) |
|
2470
|
619 { |
|
|
620 if (! Vsuppress_verbose_help_message) |
|
5641
|
621 os << "\ |
|
5794
|
622 Additional help for built-in functions and operators is\n\ |
|
|
623 available in the on-line version of the manual. Use the command\n\ |
|
5672
|
624 `doc <topic>' to search the manual index.\n\ |
|
3295
|
625 \n\ |
|
3160
|
626 Help and information about Octave is also available on the WWW\n\ |
|
5041
|
627 at http://www.octave.org and via the help@octave.org\n\ |
|
3917
|
628 mailing list.\n"; |
|
3160
|
629 } |
|
|
630 |
|
5775
|
631 // FIXME -- this needs a major overhaul to cope with new |
|
2976
|
632 // symbol table stuff. |
|
|
633 |
|
529
|
634 static void |
|
3523
|
635 display_names_from_help_list (std::ostream& os, help_list *list, |
|
542
|
636 const char *desc) |
|
529
|
637 { |
|
3355
|
638 string_vector symbols = names (list); |
|
3259
|
639 |
|
1808
|
640 if (! symbols.empty ()) |
|
|
641 { |
|
2095
|
642 os << "\n*** " << desc << ":\n\n"; |
|
3259
|
643 |
|
|
644 symbols.qsort (); |
|
|
645 |
|
2095
|
646 symbols.list_in_columns (os); |
|
1808
|
647 } |
|
529
|
648 } |
|
|
649 |
|
|
650 static void |
|
3523
|
651 display_symtab_names (std::ostream& os, const string_vector& names, |
|
|
652 const std::string& desc) |
|
542
|
653 { |
|
1808
|
654 if (! names.empty ()) |
|
|
655 { |
|
2095
|
656 os << "\n*** " << desc << ":\n\n"; |
|
|
657 names.list_in_columns (os); |
|
1808
|
658 } |
|
542
|
659 } |
|
|
660 |
|
|
661 #ifdef LIST_SYMBOLS |
|
|
662 #undef LIST_SYMBOLS |
|
|
663 #endif |
|
|
664 #define LIST_SYMBOLS(type, msg) \ |
|
|
665 do \ |
|
|
666 { \ |
|
3259
|
667 string_vector names \ |
|
4009
|
668 = fbi_sym_tab->name_list (string_vector (), true, type); \ |
|
3355
|
669 display_symtab_names (octave_stdout, names, msg); \ |
|
542
|
670 } \ |
|
|
671 while (0) |
|
529
|
672 |
|
3014
|
673 static void |
|
|
674 simple_help (void) |
|
|
675 { |
|
3160
|
676 octave_stdout << "Help is available for the topics listed below.\n"; |
|
|
677 |
|
|
678 additional_help_message (octave_stdout); |
|
|
679 |
|
3014
|
680 display_names_from_help_list (octave_stdout, operator_help (), |
|
|
681 "operators"); |
|
|
682 |
|
|
683 display_names_from_help_list (octave_stdout, keyword_help (), |
|
|
684 "reserved words"); |
|
|
685 |
|
5775
|
686 // FIXME -- is this distinction needed? |
|
1358
|
687 |
|
4208
|
688 LIST_SYMBOLS (symbol_record::COMMAND, "commands"); |
|
529
|
689 |
|
3010
|
690 LIST_SYMBOLS (symbol_record::MAPPER_FUNCTION, "mapper functions"); |
|
542
|
691 |
|
3010
|
692 LIST_SYMBOLS (symbol_record::BUILTIN_FUNCTION, "general functions"); |
|
542
|
693 |
|
1358
|
694 // Also need to list variables and currently compiled functions from |
|
|
695 // the symbol table, if there are any. |
|
529
|
696 |
|
1358
|
697 // Also need to search octave_path for script files. |
|
529
|
698 |
|
5832
|
699 load_path::display (octave_stdout); |
|
5592
|
700 |
|
|
701 string_vector autoloaded = autoloaded_functions (); |
|
|
702 |
|
|
703 if (! autoloaded.empty ()) |
|
|
704 { |
|
|
705 octave_stdout << "\n*** autoloaded functions:\n\n"; |
|
|
706 |
|
|
707 autoloaded.qsort (); |
|
|
708 |
|
|
709 autoloaded.list_in_columns (octave_stdout); |
|
|
710 } |
|
529
|
711 } |
|
|
712 |
|
|
713 static int |
|
3523
|
714 try_info (const std::string& nm) |
|
529
|
715 { |
|
5672
|
716 int retval = -1; |
|
1295
|
717 |
|
5672
|
718 warning ("please use `doc' instead of `help -i'"); |
|
529
|
719 |
|
5672
|
720 octave_value_list args; |
|
|
721 args(0) = nm; |
|
|
722 octave_value_list result = feval ("doc", args, 1); |
|
4051
|
723 |
|
5672
|
724 if (result.length () > 0) |
|
|
725 retval = result(0).int_value (); |
|
529
|
726 |
|
5672
|
727 return retval; |
|
529
|
728 } |
|
1140
|
729 |
|
|
730 static void |
|
1755
|
731 help_from_info (const string_vector& argv, int idx, int argc) |
|
1140
|
732 { |
|
1755
|
733 if (idx == argc) |
|
3523
|
734 try_info (std::string ()); |
|
1140
|
735 else |
|
|
736 { |
|
1755
|
737 for (int i = idx; i < argc; i++) |
|
1140
|
738 { |
|
1755
|
739 int status = try_info (argv[i]); |
|
1140
|
740 |
|
5672
|
741 if (status == 127) |
|
|
742 break; |
|
|
743 else if (status != 0) |
|
|
744 message ("help", "`%s' is not indexed in the manual", |
|
|
745 argv[i].c_str ()); |
|
1140
|
746 } |
|
|
747 } |
|
2470
|
748 } |
|
3014
|
749 |
|
|
750 static bool |
|
3523
|
751 looks_like_texinfo (const std::string& msg, size_t& p1) |
|
3295
|
752 { |
|
|
753 p1 = msg.find ('\n'); |
|
|
754 |
|
3523
|
755 std::string t = msg.substr (0, p1); |
|
3295
|
756 |
|
|
757 if (p1 == NPOS) |
|
|
758 p1 = 0; |
|
|
759 |
|
|
760 size_t p2 = t.find ("-*- texinfo -*-"); |
|
|
761 |
|
|
762 return (p2 != NPOS); |
|
|
763 } |
|
|
764 |
|
3330
|
765 void |
|
3523
|
766 display_help_text (std::ostream& os, const std::string& msg) |
|
3295
|
767 { |
|
|
768 // Look for "-*- texinfo -*-" in first line of help message. If it |
|
|
769 // is present, use makeinfo to format the rest of the message before |
|
|
770 // sending it to the output stream. Otherwise, just print the |
|
|
771 // message. |
|
|
772 |
|
|
773 size_t pos; |
|
|
774 |
|
|
775 if (looks_like_texinfo (msg, pos)) |
|
|
776 { |
|
5594
|
777 os.flush (); |
|
|
778 |
|
3523
|
779 std::string tmp_file_name = file_ops::tempnam ("", ""); |
|
3295
|
780 |
|
|
781 int cols = command_editor::terminal_cols (); |
|
|
782 |
|
|
783 if (cols > 16) |
|
|
784 cols--; |
|
|
785 |
|
|
786 if (cols > 64) |
|
|
787 cols -= 7; |
|
|
788 |
|
|
789 if (cols > 80) |
|
|
790 cols = 72; |
|
|
791 |
|
5765
|
792 std::ostringstream buf; |
|
4051
|
793 |
|
6099
|
794 // Use double quotes to quote the sed patterns for Windows. |
|
|
795 |
|
|
796 buf << "sed -e \"s/^[#%][#%]* *//\" -e \"s/^ *@/@/\" | " |
|
5794
|
797 << "\"" << Vmakeinfo_program << "\"" |
|
3303
|
798 << " -D \"VERSION " << OCTAVE_VERSION << "\"" |
|
|
799 << " -D \"OCTAVEHOME " << OCTAVE_PREFIX << "\"" |
|
3584
|
800 << " -D \"TARGETHOSTTYPE " << OCTAVE_CANONICAL_HOST_TYPE << "\"" |
|
3301
|
801 << " --fill-column " << cols |
|
|
802 << " --no-warn" |
|
|
803 << " --no-validate" |
|
|
804 << " --no-headers" |
|
|
805 << " --force" |
|
5765
|
806 << " --output \"" << tmp_file_name << "\""; |
|
3295
|
807 |
|
5765
|
808 oprocstream filter (buf.str ()); |
|
3295
|
809 |
|
3686
|
810 if (filter && filter.is_open ()) |
|
3295
|
811 { |
|
3405
|
812 filter << "@macro seealso {args}\n" |
|
5644
|
813 << "@sp 1\n" |
|
3408
|
814 << "@noindent\n" |
|
3405
|
815 << "See also: \\args\\.\n" |
|
|
816 << "@end macro\n"; |
|
|
817 |
|
3769
|
818 filter << msg.substr (pos+1) << std::endl; |
|
3295
|
819 |
|
3686
|
820 int status = filter.close (); |
|
3295
|
821 |
|
3523
|
822 std::ifstream tmp_file (tmp_file_name.c_str ()); |
|
3295
|
823 |
|
3686
|
824 if (WIFEXITED (status) && WEXITSTATUS (status) == 0) |
|
|
825 { |
|
|
826 int c; |
|
|
827 while ((c = tmp_file.get ()) != EOF) |
|
|
828 os << (char) c; |
|
3295
|
829 |
|
3686
|
830 tmp_file.close (); |
|
|
831 } |
|
|
832 else |
|
|
833 { |
|
|
834 warning ("help: Texinfo formatting filter exited abnormally"); |
|
|
835 warning ("help: raw Texinfo source of help text follows..."); |
|
5594
|
836 warning ("help:\n\n%s\n\n", msg.c_str ()); |
|
3686
|
837 } |
|
3295
|
838 |
|
|
839 file_ops::unlink (tmp_file_name); |
|
|
840 } |
|
|
841 else |
|
|
842 os << msg; |
|
|
843 } |
|
|
844 else |
|
|
845 os << msg; |
|
|
846 } |
|
|
847 |
|
5800
|
848 void |
|
|
849 display_usage_text (std::ostream& os, const std::string& msg) |
|
|
850 { |
|
|
851 std::string filtered_msg = msg; |
|
|
852 |
|
|
853 size_t pos; |
|
|
854 |
|
|
855 if (looks_like_texinfo (msg, pos)) |
|
|
856 { |
|
|
857 std::ostringstream buf; |
|
|
858 |
|
|
859 buf << "-*- texinfo -*-\n"; |
|
|
860 |
|
|
861 bool found_def = false; |
|
|
862 |
|
|
863 size_t msg_len = msg.length (); |
|
|
864 |
|
|
865 while (pos < msg_len) |
|
|
866 { |
|
|
867 size_t new_pos = msg.find_first_of ('\n', pos); |
|
|
868 |
|
|
869 if (new_pos == NPOS) |
|
|
870 new_pos = msg_len-1; |
|
|
871 |
|
|
872 std::string line = msg.substr (pos, new_pos-pos+1); |
|
|
873 |
|
|
874 if (line.substr (0, 4) == "@def" |
|
|
875 || line.substr (0, 8) == "@end def") |
|
|
876 { |
|
|
877 found_def = true; |
|
|
878 buf << line; |
|
|
879 } |
|
|
880 |
|
|
881 pos = new_pos + 1; |
|
|
882 } |
|
|
883 |
|
|
884 if (found_def) |
|
|
885 filtered_msg = buf.str (); |
|
|
886 } |
|
|
887 |
|
|
888 display_help_text (os, filtered_msg); |
|
|
889 } |
|
|
890 |
|
3295
|
891 static bool |
|
6243
|
892 raw_help_from_list (const help_list *list, const std::string& nm, |
|
|
893 std::string& h, bool& symbol_found) |
|
542
|
894 { |
|
5399
|
895 bool retval = false; |
|
|
896 |
|
2804
|
897 const char *name; |
|
3014
|
898 |
|
542
|
899 while ((name = list->name) != 0) |
|
|
900 { |
|
1755
|
901 if (strcmp (name, nm.c_str ()) == 0) |
|
542
|
902 { |
|
5399
|
903 symbol_found = true; |
|
|
904 |
|
6243
|
905 h = list->help; |
|
5399
|
906 |
|
|
907 if (h.length () > 0) |
|
6243
|
908 retval = true; |
|
5399
|
909 |
|
|
910 break; |
|
542
|
911 } |
|
|
912 list++; |
|
|
913 } |
|
3014
|
914 |
|
5399
|
915 return retval;; |
|
|
916 } |
|
|
917 |
|
6243
|
918 static bool |
|
|
919 help_from_list (std::ostream& os, const help_list *list, |
|
|
920 const std::string& nm, int usage, bool& symbol_found) |
|
|
921 { |
|
|
922 bool retval = false; |
|
|
923 |
|
|
924 std::string h; |
|
|
925 |
|
|
926 if (raw_help_from_list (list, nm, h, symbol_found)) |
|
|
927 { |
|
|
928 if (h.length () > 0) |
|
|
929 { |
|
|
930 if (usage) |
|
|
931 os << "\nusage: "; |
|
|
932 else |
|
|
933 os << "\n*** " << nm << ":\n\n"; |
|
|
934 |
|
|
935 display_help_text (os, h); |
|
|
936 |
|
|
937 os << "\n"; |
|
|
938 |
|
|
939 retval = true; |
|
|
940 } |
|
|
941 } |
|
|
942 |
|
|
943 return retval; |
|
|
944 } |
|
|
945 |
|
5399
|
946 std::string |
|
|
947 extract_help_from_dispatch (const std::string& nm) |
|
|
948 { |
|
|
949 std::string retval; |
|
|
950 |
|
|
951 symbol_record *builtin = fbi_sym_tab->lookup ("builtin:" + nm, 0); |
|
|
952 |
|
|
953 if (builtin) |
|
|
954 { |
|
|
955 // Check that builtin is up to date. |
|
|
956 |
|
|
957 // Don't try to fight octave's function name handling |
|
|
958 // mechanism. Instead, move dispatch record out of the way, |
|
|
959 // and restore the builtin to its original name. |
|
|
960 symbol_record *dispatch = fbi_sym_tab->lookup (nm, 0); |
|
|
961 |
|
|
962 if (dispatch) |
|
|
963 { |
|
|
964 dispatch->unprotect (); |
|
|
965 |
|
|
966 fbi_sym_tab->rename (nm, "dispatch:" + nm); |
|
|
967 fbi_sym_tab->rename ("builtin:" + nm, nm); |
|
|
968 |
|
|
969 // Check for updates to builtin function; ignore errors |
|
|
970 // that appear (they interfere with renaming), and remove |
|
5775
|
971 // the updated name from the current symbol table. FIXME -- |
|
|
972 // check that updating a function updates it in all |
|
|
973 // contexts. It may be that it is updated only in the |
|
5399
|
974 // current symbol table, and not the caller. I believe this |
|
|
975 // won't be a problem because the caller will go through the |
|
|
976 // same logic and end up with the newer version. |
|
|
977 |
|
|
978 octave_function *f = is_valid_function (nm); |
|
|
979 |
|
|
980 if (f) |
|
|
981 retval = builtin->help (); |
|
|
982 |
|
|
983 curr_sym_tab->clear_function (nm); |
|
|
984 |
|
|
985 // Move the builtin function out of the way and restore the |
|
5775
|
986 // dispatch fuction. FIXME what if builtin wants to |
|
5399
|
987 // protect itself? |
|
|
988 |
|
|
989 fbi_sym_tab->rename (nm, "builtin:" + nm); |
|
|
990 fbi_sym_tab->rename ("dispatch:" + nm, nm); |
|
|
991 |
|
|
992 dispatch->protect (); |
|
|
993 } |
|
|
994 else |
|
|
995 error ("failed to find dispatch record for `builtin:%s'", nm.c_str ()); |
|
|
996 } |
|
|
997 |
|
|
998 return retval; |
|
542
|
999 } |
|
|
1000 |
|
3355
|
1001 static bool |
|
6243
|
1002 raw_help_from_symbol_table (const std::string& nm, std::string& h, |
|
|
1003 std::string& w, bool& symbol_found) |
|
3355
|
1004 { |
|
|
1005 bool retval = false; |
|
|
1006 |
|
|
1007 symbol_record *sym_rec = lookup_by_name (nm, 0); |
|
|
1008 |
|
|
1009 if (sym_rec && sym_rec->is_defined ()) |
|
|
1010 { |
|
5399
|
1011 symbol_found = true; |
|
|
1012 |
|
6243
|
1013 h = sym_rec->help (); |
|
|
1014 |
|
|
1015 if (h.length () > 0) |
|
|
1016 { |
|
|
1017 w = sym_rec->which (); |
|
|
1018 |
|
|
1019 retval = true; |
|
|
1020 } |
|
|
1021 } |
|
3355
|
1022 |
|
6243
|
1023 return retval; |
|
|
1024 } |
|
|
1025 |
|
|
1026 static bool |
|
|
1027 help_from_symbol_table (std::ostream& os, const std::string& nm, |
|
|
1028 bool& symbol_found) |
|
|
1029 { |
|
|
1030 bool retval = false; |
|
|
1031 |
|
|
1032 std::string h; |
|
|
1033 std::string w; |
|
|
1034 |
|
|
1035 if (raw_help_from_symbol_table (nm, h, w, symbol_found)) |
|
|
1036 { |
|
3355
|
1037 if (h.length () > 0) |
|
|
1038 { |
|
5399
|
1039 h = extract_help_from_dispatch (nm) + h; |
|
6243
|
1040 |
|
3355
|
1041 display_help_text (os, h); |
|
6243
|
1042 |
|
|
1043 if (w.length () > 0 && ! Vsuppress_verbose_help_message) |
|
|
1044 os << w << "\n"; |
|
|
1045 |
|
3355
|
1046 os << "\n"; |
|
6243
|
1047 |
|
3355
|
1048 retval = true; |
|
|
1049 } |
|
|
1050 } |
|
|
1051 |
|
|
1052 return retval; |
|
|
1053 } |
|
|
1054 |
|
|
1055 static bool |
|
6243
|
1056 raw_help_from_file (const std::string& nm, std::string& h, |
|
|
1057 std::string& file, bool& symbol_found) |
|
|
1058 { |
|
|
1059 bool retval = false; |
|
|
1060 |
|
|
1061 h = get_help_from_file (nm, symbol_found, file); |
|
|
1062 |
|
|
1063 if (h.length () > 0) |
|
|
1064 retval = true; |
|
|
1065 |
|
|
1066 return retval; |
|
|
1067 } |
|
|
1068 |
|
|
1069 static bool |
|
5399
|
1070 help_from_file (std::ostream& os, const std::string& nm, bool& symbol_found) |
|
3355
|
1071 { |
|
|
1072 bool retval = false; |
|
|
1073 |
|
6243
|
1074 std::string h; |
|
5931
|
1075 std::string file; |
|
|
1076 |
|
6243
|
1077 if (raw_help_from_file (nm, h, file, symbol_found)) |
|
5484
|
1078 { |
|
6243
|
1079 if (h.length () > 0) |
|
|
1080 { |
|
|
1081 os << nm << " is the file " << file << "\n\n"; |
|
|
1082 |
|
|
1083 display_help_text (os, h); |
|
|
1084 |
|
|
1085 os << "\n"; |
|
|
1086 |
|
|
1087 retval = true; |
|
|
1088 } |
|
3355
|
1089 } |
|
|
1090 |
|
|
1091 return retval; |
|
|
1092 } |
|
|
1093 |
|
6243
|
1094 std::string |
|
|
1095 raw_help (const std::string& nm, bool &symbol_found) |
|
|
1096 { |
|
|
1097 std::string h; |
|
|
1098 std::string w; |
|
|
1099 std::string f; |
|
|
1100 |
|
|
1101 (raw_help_from_list (operator_help (), nm, h, symbol_found) |
|
|
1102 || raw_help_from_list (keyword_help (), nm, h, symbol_found) |
|
|
1103 || raw_help_from_symbol_table (nm, h, w, symbol_found) |
|
|
1104 || raw_help_from_file (nm, h, f, symbol_found)); |
|
|
1105 |
|
|
1106 return h; |
|
|
1107 } |
|
|
1108 |
|
1140
|
1109 static void |
|
1755
|
1110 builtin_help (int argc, const string_vector& argv) |
|
1140
|
1111 { |
|
|
1112 help_list *op_help_list = operator_help (); |
|
|
1113 help_list *kw_help_list = keyword_help (); |
|
|
1114 |
|
1755
|
1115 for (int i = 1; i < argc; i++) |
|
1140
|
1116 { |
|
5399
|
1117 bool symbol_found = false; |
|
|
1118 |
|
|
1119 if (help_from_list (octave_stdout, op_help_list, argv[i], 0, |
|
|
1120 symbol_found)) |
|
1140
|
1121 continue; |
|
|
1122 |
|
5399
|
1123 if (help_from_list (octave_stdout, kw_help_list, argv[i], 0, |
|
|
1124 symbol_found)) |
|
1140
|
1125 continue; |
|
|
1126 |
|
5399
|
1127 if (help_from_symbol_table (octave_stdout, argv[i], symbol_found)) |
|
|
1128 continue; |
|
|
1129 |
|
|
1130 if (help_from_file (octave_stdout, argv[i], symbol_found)) |
|
3355
|
1131 continue; |
|
1755
|
1132 |
|
5399
|
1133 if (symbol_found) |
|
|
1134 octave_stdout << "\nhelp: `" << argv[i] |
|
|
1135 << "' is not documented\n"; |
|
|
1136 else |
|
|
1137 octave_stdout << "\nhelp: `" << argv[i] |
|
|
1138 << "' not found\n"; |
|
1140
|
1139 } |
|
|
1140 |
|
2095
|
1141 additional_help_message (octave_stdout); |
|
1140
|
1142 } |
|
|
1143 |
|
4208
|
1144 DEFCMD (help, args, , |
|
3332
|
1145 "-*- texinfo -*-\n\ |
|
|
1146 @deffn {Command} help\n\ |
|
|
1147 Octave's @code{help} command can be used to print brief usage-style\n\ |
|
|
1148 messages, or to display information directly from an on-line version of\n\ |
|
|
1149 the printed manual, using the GNU Info browser. If invoked without any\n\ |
|
5794
|
1150 arguments, @code{help} prints a list of all the available operators\n\ |
|
|
1151 and functions. If the first argument is @code{-i}, the @code{help}\n\ |
|
|
1152 command searches the index of the on-line version of this manual for\n\ |
|
|
1153 the given topics.\n\ |
|
3168
|
1154 \n\ |
|
3332
|
1155 For example, the command @kbd{help help} prints a short message\n\ |
|
|
1156 describing the @code{help} command, and @kbd{help -i help} starts the\n\ |
|
|
1157 GNU Info browser at this node in the on-line version of the manual.\n\ |
|
|
1158 \n\ |
|
|
1159 Once the GNU Info browser is running, help for using it is available\n\ |
|
|
1160 using the command @kbd{C-h}.\n\ |
|
5672
|
1161 @seealso{doc, which, lookfor}\n\ |
|
3333
|
1162 @end deffn") |
|
529
|
1163 { |
|
2086
|
1164 octave_value_list retval; |
|
529
|
1165 |
|
1755
|
1166 int argc = args.length () + 1; |
|
|
1167 |
|
1968
|
1168 string_vector argv = args.make_argv ("help"); |
|
1755
|
1169 |
|
|
1170 if (error_state) |
|
|
1171 return retval; |
|
529
|
1172 |
|
|
1173 if (argc == 1) |
|
3014
|
1174 simple_help (); |
|
529
|
1175 else |
|
|
1176 { |
|
1755
|
1177 if (argv[1] == "-i") |
|
3014
|
1178 help_from_info (argv, 2, argc); |
|
529
|
1179 else |
|
3014
|
1180 builtin_help (argc, argv); |
|
529
|
1181 } |
|
|
1182 |
|
|
1183 return retval; |
|
|
1184 } |
|
|
1185 |
|
3355
|
1186 static void |
|
3523
|
1187 do_type (std::ostream& os, const std::string& name, bool pr_type_info, |
|
3355
|
1188 bool quiet, bool pr_orig_txt) |
|
|
1189 { |
|
|
1190 symbol_record *sym_rec = lookup_by_name (name, 0); |
|
|
1191 |
|
|
1192 if (sym_rec && sym_rec->is_defined ()) |
|
3356
|
1193 sym_rec->type (os, pr_type_info, quiet, pr_orig_txt); |
|
3355
|
1194 else |
|
|
1195 { |
|
3523
|
1196 std::string ff = fcn_file_in_path (name); |
|
3355
|
1197 |
|
|
1198 if (! ff.empty ()) |
|
|
1199 { |
|
3538
|
1200 std::ifstream fs (ff.c_str (), std::ios::in); |
|
3355
|
1201 |
|
|
1202 if (fs) |
|
|
1203 { |
|
|
1204 if (pr_type_info && ! quiet) |
|
|
1205 os << name << " is the script file: " << ff << "\n\n"; |
|
|
1206 |
|
|
1207 char ch; |
|
|
1208 |
|
|
1209 while (fs.get (ch)) |
|
|
1210 os << ch; |
|
|
1211 } |
|
|
1212 else |
|
|
1213 os << "unable to open `" << ff << "' for reading!\n"; |
|
|
1214 } |
|
|
1215 else |
|
|
1216 error ("type: `%s' undefined", name.c_str ()); |
|
|
1217 } |
|
|
1218 } |
|
|
1219 |
|
4208
|
1220 DEFCMD (type, args, nargout, |
|
3361
|
1221 "-*- texinfo -*-\n\ |
|
|
1222 \n\ |
|
|
1223 @deffn {Command} type options name @dots{}\n\ |
|
|
1224 Display the definition of each @var{name} that refers to a function.\n\ |
|
|
1225 \n\ |
|
|
1226 Normally also displays if each @var{name} is user-defined or builtin;\n\ |
|
|
1227 the @code{-q} option suppresses this behaviour.\n\ |
|
581
|
1228 \n\ |
|
3361
|
1229 Currently, Octave can only display functions that can be compiled\n\ |
|
|
1230 cleanly, because it uses its internal representation of the function to\n\ |
|
|
1231 recreate the program text.\n\ |
|
|
1232 \n\ |
|
|
1233 Comments are not displayed because Octave's parser currently discards\n\ |
|
|
1234 them as it converts the text of a function file to its internal\n\ |
|
|
1235 representation. This problem may be fixed in a future release.\n\ |
|
|
1236 @end deffn") |
|
581
|
1237 { |
|
3584
|
1238 octave_value retval; |
|
1588
|
1239 |
|
1755
|
1240 int argc = args.length () + 1; |
|
|
1241 |
|
1968
|
1242 string_vector argv = args.make_argv ("type"); |
|
1755
|
1243 |
|
3355
|
1244 if (! error_state) |
|
581
|
1245 { |
|
3355
|
1246 if (argc > 1) |
|
|
1247 { |
|
5775
|
1248 // FIXME -- we should really use getopt () |
|
2532
|
1249 |
|
3355
|
1250 bool quiet = false; |
|
|
1251 bool pr_orig_txt = true; |
|
2532
|
1252 |
|
3355
|
1253 int idx; |
|
581
|
1254 |
|
3355
|
1255 for (idx = 1; idx < argc; idx++) |
|
1281
|
1256 { |
|
3355
|
1257 if (argv[idx] == "-q" || argv[idx] == "-quiet") |
|
|
1258 quiet = true; |
|
|
1259 else if (argv[idx] == "-t" || argv[idx] == "-transformed") |
|
|
1260 pr_orig_txt = false; |
|
|
1261 else |
|
|
1262 break; |
|
1281
|
1263 } |
|
|
1264 |
|
3355
|
1265 if (idx < argc) |
|
|
1266 { |
|
5765
|
1267 std::ostringstream output_buf; |
|
581
|
1268 |
|
3355
|
1269 for (int i = idx; i < argc; i++) |
|
581
|
1270 { |
|
3523
|
1271 std::string id = argv[i]; |
|
2534
|
1272 |
|
3355
|
1273 if (nargout == 0) |
|
|
1274 do_type (octave_stdout, id, true, quiet, pr_orig_txt); |
|
|
1275 else |
|
|
1276 do_type (output_buf, id, false, quiet, pr_orig_txt); |
|
581
|
1277 |
|
3355
|
1278 if (error_state) |
|
|
1279 goto abort; |
|
581
|
1280 } |
|
|
1281 |
|
3584
|
1282 if (nargout != 0) |
|
5765
|
1283 retval = output_buf.str (); |
|
581
|
1284 } |
|
|
1285 else |
|
5823
|
1286 print_usage (); |
|
3355
|
1287 } |
|
|
1288 else |
|
5823
|
1289 print_usage (); |
|
3355
|
1290 } |
|
3141
|
1291 |
|
3355
|
1292 abort: |
|
581
|
1293 |
|
|
1294 return retval; |
|
|
1295 } |
|
|
1296 |
|
3536
|
1297 static std::string |
|
3523
|
1298 do_which (const std::string& name) |
|
3355
|
1299 { |
|
3523
|
1300 std::string retval; |
|
3355
|
1301 |
|
|
1302 symbol_record *sym_rec = lookup_by_name (name, 0); |
|
|
1303 |
|
|
1304 if (sym_rec && sym_rec->is_defined ()) |
|
|
1305 retval = sym_rec->which (); |
|
|
1306 else |
|
|
1307 { |
|
3523
|
1308 std::string path = fcn_file_in_path (name); |
|
3355
|
1309 |
|
|
1310 if (! path.empty ()) |
|
|
1311 retval = path; |
|
|
1312 else |
|
|
1313 retval = "undefined"; |
|
|
1314 } |
|
|
1315 |
|
|
1316 return retval; |
|
|
1317 } |
|
|
1318 |
|
|
1319 static void |
|
3523
|
1320 do_which (std::ostream& os, const std::string& name) |
|
3355
|
1321 { |
|
|
1322 symbol_record *sym_rec = lookup_by_name (name, 0); |
|
|
1323 |
|
|
1324 if (sym_rec && sym_rec->is_defined ()) |
|
|
1325 sym_rec->which (os); |
|
|
1326 else |
|
|
1327 { |
|
3523
|
1328 std::string path = fcn_file_in_path (name); |
|
3355
|
1329 |
|
|
1330 if (! path.empty ()) |
|
|
1331 os << "which: `" << name << "' is the script file\n" |
|
|
1332 << path << "\n"; |
|
|
1333 else |
|
|
1334 os << "which: `" << name << "' is undefined\n"; |
|
|
1335 } |
|
|
1336 } |
|
|
1337 |
|
4208
|
1338 DEFCMD (which, args, nargout, |
|
3361
|
1339 "-*- texinfo -*-\n\ |
|
|
1340 @deffn {Command} which name @dots{}\n\ |
|
|
1341 Display the type of each @var{name}. If @var{name} is defined from a\n\ |
|
|
1342 function file, the full name of the file is also displayed.\n\ |
|
5667
|
1343 @seealso{help, lookfor}\n\ |
|
3361
|
1344 @end deffn") |
|
581
|
1345 { |
|
2086
|
1346 octave_value_list retval; |
|
581
|
1347 |
|
1968
|
1348 string_vector argv = args.make_argv ("which"); |
|
1755
|
1349 |
|
3355
|
1350 if (! error_state) |
|
|
1351 { |
|
|
1352 int argc = argv.length (); |
|
581
|
1353 |
|
|
1354 if (nargout > 0) |
|
|
1355 retval.resize (argc-1, Matrix ()); |
|
|
1356 |
|
3355
|
1357 if (argc > 1) |
|
581
|
1358 { |
|
3355
|
1359 for (int i = 1; i < argc; i++) |
|
581
|
1360 { |
|
3523
|
1361 std::string id = argv[i]; |
|
3141
|
1362 |
|
3355
|
1363 if (nargout == 0) |
|
|
1364 do_which (octave_stdout, id); |
|
581
|
1365 else |
|
3355
|
1366 retval(i-1) = do_which (id); |
|
581
|
1367 } |
|
|
1368 } |
|
3355
|
1369 else |
|
5823
|
1370 print_usage (); |
|
581
|
1371 } |
|
|
1372 |
|
|
1373 return retval; |
|
|
1374 } |
|
|
1375 |
|
5775
|
1376 // FIXME |
|
5447
|
1377 // This function attempts to find the first sentence of a help string, though |
|
|
1378 // given that the user can create the help in an arbitrary format, your |
|
|
1379 // success might vary.. it works much better with help string formated in |
|
|
1380 // texinfo. Using regex might make this function much simpler. |
|
|
1381 |
|
|
1382 std::string |
|
|
1383 first_help_sentence (const std::string& h, bool short_sentence = true) |
|
|
1384 { |
|
5738
|
1385 std::string retval; |
|
|
1386 |
|
5447
|
1387 size_t pos = 0; |
|
|
1388 |
|
|
1389 if (looks_like_texinfo (h, pos)) |
|
5592
|
1390 { |
|
|
1391 // Get the parsed help string. |
|
5447
|
1392 pos = 0; |
|
5765
|
1393 std::ostringstream os; |
|
5447
|
1394 display_help_text (os, h); |
|
|
1395 std::string h2 = os.str (); |
|
|
1396 |
|
|
1397 while (1) |
|
|
1398 { |
|
|
1399 // Skip leading whitespace and get new line |
|
|
1400 pos = h2.find_first_not_of ("\n\t ", pos); |
|
|
1401 |
|
|
1402 if (pos == NPOS) |
|
|
1403 break; |
|
|
1404 |
|
|
1405 size_t new_pos = h2.find_first_of ('\n', pos); |
|
|
1406 std::string line = h2.substr (pos, new_pos-pos); |
|
|
1407 |
|
|
1408 // Skip lines starting in "-" |
|
|
1409 if (line.find_first_of ('-') == 0) |
|
|
1410 { |
|
|
1411 pos = new_pos + 1; |
|
|
1412 continue; |
|
|
1413 } |
|
|
1414 |
|
|
1415 break; |
|
|
1416 } |
|
|
1417 |
|
|
1418 if (pos == NPOS) |
|
5738
|
1419 return retval; |
|
5447
|
1420 |
|
|
1421 // At start of real text. Get first line with the sentence |
|
|
1422 size_t new_pos = h2.find_first_of ('\n', pos); |
|
|
1423 std::string line = h2.substr (pos, new_pos-pos); |
|
|
1424 size_t dot_pos; |
|
|
1425 |
|
|
1426 while ((dot_pos = line.find_first_of ('.')) == NPOS) |
|
|
1427 { |
|
|
1428 // Trim trailing blanks on line |
|
|
1429 line.substr (0, line.find_last_not_of ("\n\t ") + 1); |
|
|
1430 |
|
|
1431 // Append next line |
|
|
1432 size_t tmp_pos = h2.find_first_not_of ("\n\t ", new_pos + 1); |
|
|
1433 if (tmp_pos == NPOS || h2.substr (tmp_pos, 1) == "\n") |
|
|
1434 break; |
|
|
1435 |
|
|
1436 new_pos = h2.find_first_of ('\n', tmp_pos); |
|
|
1437 std::string next = h2.substr (tmp_pos, new_pos-tmp_pos); |
|
|
1438 |
|
|
1439 if (short_sentence) |
|
|
1440 { |
|
|
1441 if ((tmp_pos = next.find_first_of ('.')) != NPOS) |
|
|
1442 { |
|
|
1443 line = line + " " + next; |
|
|
1444 dot_pos = line.find_first_of ('.'); |
|
|
1445 } |
|
|
1446 break; |
|
|
1447 } |
|
|
1448 else |
|
|
1449 line = line + " " + next; |
|
|
1450 } |
|
|
1451 |
|
|
1452 if (dot_pos == NPOS) |
|
5738
|
1453 retval = line; |
|
5447
|
1454 else |
|
5738
|
1455 retval = line.substr (0, dot_pos + 1); |
|
5447
|
1456 } |
|
|
1457 else |
|
|
1458 { |
|
|
1459 std::string _upper = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"; |
|
|
1460 std::string _lower = "abcdefghijklmnopqrstuvwxyz"; |
|
|
1461 std::string _alpha = _upper + _lower + "_"; |
|
|
1462 std::string _alphanum = _alpha + "1234567890"; |
|
|
1463 pos = 0; |
|
|
1464 |
|
|
1465 while (1) |
|
|
1466 { |
|
|
1467 // Skip leading whitespace and get new line |
|
|
1468 pos = h.find_first_not_of ("\n\t ", pos); |
|
|
1469 |
|
|
1470 if (pos == NPOS) |
|
|
1471 break; |
|
|
1472 |
|
|
1473 size_t new_pos = h.find_first_of ('\n', pos); |
|
|
1474 std::string line = h.substr (pos, new_pos-pos); |
|
|
1475 |
|
|
1476 // Make a lower case copy to simplify some tests |
|
|
1477 std::string lower = line; |
|
5768
|
1478 std::transform (lower.begin (), lower.end (), lower.begin (), tolower); |
|
5447
|
1479 |
|
|
1480 // Skip lines starting in "-" or "Usage" |
|
|
1481 if (lower.find_first_of ('-') == 0 |
|
|
1482 || lower.substr (0, 5) == "usage") |
|
|
1483 { |
|
5592
|
1484 pos = (new_pos == NPOS ? NPOS : new_pos + 1); |
|
5447
|
1485 continue; |
|
|
1486 } |
|
|
1487 |
|
|
1488 size_t line_pos = 0; |
|
|
1489 size_t tmp_pos = 0; |
|
|
1490 |
|
|
1491 // chop " blah : " |
|
|
1492 tmp_pos = line.find_first_not_of ("\t ", line.find_first_not_of |
|
|
1493 (_alphanum, line_pos)); |
|
|
1494 if (tmp_pos != NPOS && line.substr (tmp_pos, 1) == ":") |
|
|
1495 line_pos = line.find_first_not_of ("\t ", tmp_pos + 1); |
|
|
1496 |
|
|
1497 if (line_pos == NPOS) |
|
|
1498 { |
|
5592
|
1499 pos = (new_pos == NPOS ? NPOS : new_pos + 1); |
|
5447
|
1500 continue; |
|
|
1501 } |
|
|
1502 |
|
|
1503 // chop " function " |
|
|
1504 if (lower.substr (line_pos, 8) == "function") |
|
|
1505 line_pos = line.find_first_not_of ("\t ", line_pos + 8); |
|
|
1506 |
|
|
1507 if (line_pos == NPOS) |
|
|
1508 { |
|
5592
|
1509 pos = (new_pos == NPOS ? NPOS : new_pos + 1); |
|
5447
|
1510 continue; |
|
|
1511 } |
|
|
1512 |
|
|
1513 // chop " [a,b] = " |
|
|
1514 if (line.substr (line_pos, 1) == "[") |
|
|
1515 { |
|
|
1516 tmp_pos = line.find_first_not_of |
|
|
1517 ("\t ", line.find_first_of ("]", line_pos) + 1); |
|
|
1518 |
|
|
1519 if (tmp_pos != NPOS && line.substr (tmp_pos, 1) == "=") |
|
|
1520 line_pos = line.find_first_not_of ("\t ",tmp_pos + 1); |
|
|
1521 } |
|
|
1522 |
|
|
1523 if (line_pos == NPOS) |
|
|
1524 { |
|
5592
|
1525 pos = (new_pos == NPOS ? NPOS : new_pos + 1); |
|
5447
|
1526 continue; |
|
|
1527 } |
|
|
1528 |
|
|
1529 // chop " a = " |
|
|
1530 if (line.find_first_not_of (_alpha, line_pos) != line_pos) |
|
|
1531 { |
|
|
1532 tmp_pos = line.find_first_not_of ("\t ", line.find_first_not_of |
|
|
1533 (_alphanum, line_pos)); |
|
|
1534 if (tmp_pos != NPOS && line.substr (tmp_pos, 1) == "=") |
|
|
1535 line_pos = line.find_first_not_of ("\t ", tmp_pos + 1); |
|
|
1536 } |
|
|
1537 |
|
|
1538 if (line_pos == NPOS) |
|
|
1539 { |
|
|
1540 pos = new_pos + 1; |
|
|
1541 continue; |
|
|
1542 } |
|
|
1543 |
|
|
1544 // chop " f(x) " |
|
|
1545 if (line.find_first_not_of (_alpha, line_pos) != line_pos) |
|
|
1546 { |
|
|
1547 tmp_pos = line.find_first_not_of ("\t ", line.find_first_not_of |
|
|
1548 (_alphanum, line_pos)); |
|
|
1549 if (tmp_pos != NPOS && line.substr (tmp_pos, 1) == "(") |
|
|
1550 line_pos = line.find_first_not_of ("\t ", line.find_first_of |
|
|
1551 (")", tmp_pos) + 1); |
|
|
1552 } |
|
|
1553 |
|
|
1554 if (line_pos == NPOS) |
|
|
1555 { |
|
5592
|
1556 pos = (new_pos == NPOS ? NPOS : new_pos + 1); |
|
5447
|
1557 continue; |
|
|
1558 } |
|
|
1559 |
|
|
1560 // chop " ; " |
|
|
1561 if (line.substr (line_pos, 1) == ":" |
|
|
1562 || line.substr (line_pos, 1) == ";") |
|
|
1563 line_pos = line.find_first_not_of ("\t ", line_pos + 1); |
|
|
1564 |
|
|
1565 if (line_pos == NPOS) |
|
|
1566 { |
|
5592
|
1567 pos = (new_pos == NPOS ? NPOS : new_pos + 1); |
|
5447
|
1568 continue; |
|
|
1569 } |
|
|
1570 |
|
|
1571 // chop " BLAH " |
|
|
1572 if (line.length () > line_pos + 2 |
|
|
1573 && line.find_first_of (_upper, line_pos) == line_pos |
|
|
1574 && line.find_first_of (_upper, line_pos+1) == line_pos + 1) |
|
|
1575 line_pos = line.find_first_not_of ("\t ", line.find_first_not_of |
|
|
1576 (_upper + "0123456789_", line_pos)); |
|
|
1577 |
|
|
1578 if (line_pos == NPOS) |
|
|
1579 { |
|
5592
|
1580 pos = (new_pos == NPOS ? NPOS : new_pos + 1); |
|
5447
|
1581 continue; |
|
|
1582 } |
|
|
1583 |
|
|
1584 // chop " blah --- " |
|
|
1585 tmp_pos = line.find_first_not_of ("\t ", line.find_first_not_of |
|
|
1586 (_alphanum, line_pos)); |
|
|
1587 if (tmp_pos != NPOS && line.substr (tmp_pos, 1) == "-") |
|
|
1588 { |
|
|
1589 tmp_pos = line.find_first_not_of ("-", tmp_pos); |
|
|
1590 if (line.substr (tmp_pos, 1) == " " |
|
|
1591 || line.substr (tmp_pos, 1) == "\t") |
|
|
1592 line_pos = line.find_first_not_of ("\t ", tmp_pos); |
|
|
1593 } |
|
|
1594 |
|
|
1595 if (line_pos == NPOS) |
|
|
1596 { |
|
5592
|
1597 pos = (new_pos == NPOS ? NPOS : new_pos + 1); |
|
5447
|
1598 continue; |
|
|
1599 } |
|
|
1600 |
|
|
1601 // chop " blah <TAB> " |
|
|
1602 if (line.find_first_not_of (_alpha, line_pos) != line_pos) |
|
|
1603 { |
|
|
1604 tmp_pos = line.find_first_not_of (" ", line.find_first_not_of |
|
|
1605 (_alphanum, line_pos)); |
|
|
1606 if (tmp_pos != NPOS && line.substr (tmp_pos, 1) == "\t") |
|
|
1607 line_pos = line.find_first_not_of ("\t ", line.find_first_of |
|
|
1608 (")", tmp_pos) + 1); |
|
|
1609 } |
|
|
1610 |
|
|
1611 if (line_pos == NPOS) |
|
|
1612 { |
|
5592
|
1613 pos = (new_pos == NPOS ? NPOS : new_pos + 1); |
|
5447
|
1614 continue; |
|
|
1615 } |
|
|
1616 |
|
|
1617 // chop " blah " |
|
|
1618 if (line.find_first_not_of (_alpha, line_pos) != line_pos) |
|
|
1619 { |
|
|
1620 tmp_pos = line.find_first_not_of (_alphanum, line_pos); |
|
|
1621 |
|
|
1622 if (tmp_pos != NPOS |
|
|
1623 && (line.substr (tmp_pos, 2) == "\t\t" |
|
|
1624 || line.substr (tmp_pos, 2) == "\t " |
|
|
1625 || line.substr (tmp_pos, 2) == " \t" |
|
|
1626 || line.substr (tmp_pos, 2) == " ")) |
|
|
1627 line_pos = line.find_first_not_of ("\t ", tmp_pos); |
|
|
1628 } |
|
|
1629 |
|
|
1630 if (line_pos == NPOS) |
|
|
1631 { |
|
5592
|
1632 pos = (new_pos == NPOS ? NPOS : new_pos + 1); |
|
5447
|
1633 continue; |
|
|
1634 } |
|
|
1635 |
|
|
1636 // skip blah \n or \n blah |
|
|
1637 // skip blank line |
|
|
1638 // skip "# !/usr/bin/octave" |
|
|
1639 if ((line.substr (line_pos , 2) == "or" |
|
|
1640 && line.find_first_not_of ("\n\t ", line_pos + 2) == NPOS) |
|
|
1641 || line.find_first_not_of ("\n\t ", line_pos) == NPOS |
|
|
1642 || line.substr (line_pos, 2) == "!/") |
|
|
1643 { |
|
5592
|
1644 pos = (new_pos == NPOS ? NPOS : new_pos + 1); |
|
5447
|
1645 continue; |
|
|
1646 } |
|
|
1647 |
|
|
1648 // Got the start of first sentence, break. |
|
|
1649 pos = pos + line_pos; |
|
|
1650 break; |
|
|
1651 } |
|
|
1652 |
|
|
1653 if (pos == NPOS) |
|
5738
|
1654 return retval; |
|
5447
|
1655 |
|
|
1656 // At start of real text. Get first line with the sentence |
|
|
1657 size_t new_pos = h.find_first_of ('\n', pos); |
|
|
1658 std::string line = h.substr (pos, new_pos-pos); |
|
|
1659 size_t dot_pos; |
|
|
1660 |
|
|
1661 while ((dot_pos = line.find_first_of ('.')) == NPOS) |
|
|
1662 { |
|
|
1663 // Trim trailing blanks on line |
|
|
1664 line = line.substr (0, line.find_last_not_of ("\n\t ") + 1); |
|
|
1665 |
|
|
1666 // Append next line |
|
|
1667 size_t tmp_pos = h.find_first_not_of ("\t ", new_pos + 1); |
|
|
1668 if (tmp_pos == NPOS || h.substr (tmp_pos, 1) == "\n") |
|
|
1669 break; |
|
|
1670 |
|
|
1671 new_pos = h.find_first_of ('\n', tmp_pos); |
|
|
1672 std::string next = h.substr (tmp_pos, new_pos-tmp_pos); |
|
|
1673 |
|
|
1674 if (short_sentence) |
|
|
1675 { |
|
|
1676 // Only add the next line if it terminates the sentence, then break |
|
|
1677 if ((tmp_pos = next.find_first_of ('.')) != NPOS) |
|
|
1678 { |
|
|
1679 line = line + " " + next; |
|
|
1680 dot_pos = line.find_first_of ('.'); |
|
|
1681 } |
|
|
1682 break; |
|
|
1683 } |
|
|
1684 else |
|
|
1685 line = line + " " + next; |
|
|
1686 } |
|
|
1687 |
|
|
1688 if (dot_pos == NPOS) |
|
5738
|
1689 retval = line; |
|
5447
|
1690 else |
|
5738
|
1691 retval = line.substr (0, dot_pos + 1); |
|
5447
|
1692 } |
|
5738
|
1693 |
|
|
1694 return retval; |
|
5447
|
1695 } |
|
|
1696 |
|
|
1697 static void |
|
|
1698 print_lookfor (const std::string& name, const std::string& line) |
|
|
1699 { |
|
|
1700 const size_t deflen = 20; |
|
|
1701 |
|
|
1702 size_t max_width = command_editor::terminal_cols () - deflen; |
|
|
1703 if (max_width < deflen) |
|
|
1704 max_width = deflen; |
|
|
1705 |
|
|
1706 size_t name_len = name.length (); |
|
|
1707 |
|
|
1708 size_t width = max_width; |
|
|
1709 if (name_len > deflen) |
|
|
1710 { |
|
|
1711 width = command_editor::terminal_cols () - name_len; |
|
|
1712 if (width < deflen) |
|
|
1713 width = deflen; |
|
|
1714 } |
|
|
1715 |
|
|
1716 size_t pad_len = deflen > name_len ? deflen - name_len + 1 : 1; |
|
|
1717 octave_stdout << name << std::string (pad_len, ' '); |
|
|
1718 |
|
|
1719 size_t pos = 0; |
|
|
1720 |
|
|
1721 while (1) |
|
|
1722 { |
|
|
1723 size_t new_pos = line.find_first_of ("\n\t ", pos); |
|
|
1724 size_t end_pos = new_pos; |
|
|
1725 |
|
|
1726 if (line.length () - pos < width) |
|
|
1727 new_pos = end_pos = NPOS; |
|
|
1728 else |
|
|
1729 while (new_pos != NPOS && new_pos - pos < width) |
|
|
1730 { |
|
|
1731 end_pos = new_pos; |
|
|
1732 new_pos = line.find_first_of ("\n\t ", new_pos + 1); |
|
|
1733 } |
|
|
1734 |
|
|
1735 octave_stdout << line.substr (pos, end_pos-pos) << std::endl; |
|
|
1736 |
|
|
1737 if (end_pos == NPOS) |
|
|
1738 break; |
|
|
1739 |
|
|
1740 pos = end_pos + 1; |
|
|
1741 width = max_width; |
|
|
1742 octave_stdout << std::string (deflen + 1, ' '); |
|
|
1743 } |
|
|
1744 } |
|
|
1745 |
|
|
1746 DEFCMD (lookfor, args, nargout, |
|
|
1747 "-*- texinfo -*-\n\ |
|
|
1748 @deffn {Command} lookfor @var{str}\n\ |
|
|
1749 @deffnx {Command} lookfor -all @var{str}\n\ |
|
|
1750 @deffnx {Function} {[@var{fun}, @var{helpstring}] = } lookfor (@var{str})\n\ |
|
|
1751 @deffnx {Function} {[@var{fun}, @var{helpstring}] = } lookfor ('-all', @var{str})\n\ |
|
5814
|
1752 Search for the string @var{str} in all of the functions found in the\n\ |
|
|
1753 function search path. By default @code{lookfor} searchs for @var{str}\n\ |
|
|
1754 in the first sentence of the help string of each function found. The entire\n\ |
|
|
1755 help string of each function found in the path can be search if\n\ |
|
5447
|
1756 the '-all' argument is supplied. All searches are case insensitive.\n\ |
|
|
1757 \n\ |
|
|
1758 Called with no output arguments, @code{lookfor} prints the list of matching\n\ |
|
|
1759 functions to the terminal. Otherwise the output arguments @var{fun} and\n\ |
|
|
1760 @var{helpstring} define the matching functions and the first sentence of\n\ |
|
|
1761 each of their help strings.\n\ |
|
|
1762 \n\ |
|
|
1763 Note that the ability of @code{lookfor} to correctly identify the first\n\ |
|
|
1764 sentence of the help of the functions is dependent on the format of the\n\ |
|
|
1765 functions help. All of the functions in octave itself will correctly\n\ |
|
|
1766 find the first sentence, but the same can not be guaranteed for other\n\ |
|
|
1767 functions. Therefore the use of the '-all' argument might be necessary\n\ |
|
|
1768 to find related functions that are not part of octave.\n\ |
|
5667
|
1769 @seealso{help, which}\n\ |
|
5642
|
1770 @end deffn") |
|
5447
|
1771 { |
|
|
1772 octave_value_list retval; |
|
|
1773 int nargin = args.length (); |
|
|
1774 bool first_sentence_only = true; |
|
|
1775 |
|
|
1776 if (nargin != 1 && nargin != 2) |
|
|
1777 { |
|
|
1778 usage ("lookfor"); |
|
|
1779 return retval; |
|
|
1780 } |
|
|
1781 |
|
|
1782 string_vector ret[2]; |
|
|
1783 |
|
|
1784 std::string txt; |
|
|
1785 |
|
|
1786 if (args(0).is_string ()) |
|
|
1787 { |
|
|
1788 txt = args(0).string_value (); |
|
|
1789 |
|
|
1790 if (nargin == 2) |
|
|
1791 { |
|
|
1792 if (args(1).is_string ()) |
|
|
1793 { |
|
|
1794 std::string tmp = args(1).string_value (); |
|
|
1795 |
|
|
1796 if (txt.substr(0,1) == "-") |
|
|
1797 { |
|
|
1798 txt = tmp; |
|
|
1799 tmp = args(0).string_value (); |
|
|
1800 } |
|
|
1801 |
|
|
1802 if (tmp == "-all") |
|
|
1803 first_sentence_only = false; |
|
|
1804 else |
|
|
1805 error ("lookfor: unrecognized option argument"); |
|
|
1806 } |
|
|
1807 else |
|
|
1808 error ("lookfor: arguments must be a string"); |
|
|
1809 } |
|
|
1810 } |
|
|
1811 else |
|
|
1812 error ("lookfor: argument must be a string"); |
|
|
1813 |
|
|
1814 if (!error_state) |
|
|
1815 { |
|
|
1816 // All tests in lower case |
|
5768
|
1817 std::transform (txt.begin (), txt.end (), txt.begin (), tolower); |
|
5447
|
1818 |
|
|
1819 help_list *ptr = keyword_help (); |
|
|
1820 while (ptr->name) |
|
|
1821 { |
|
|
1822 std::string name = ptr->name; |
|
|
1823 std::string h = ptr->help; |
|
|
1824 |
|
5592
|
1825 if (name.find (txt) != NPOS) |
|
5447
|
1826 { |
|
|
1827 if (nargout) |
|
|
1828 { |
|
|
1829 ret[0].append (name); |
|
|
1830 ret[1].append (first_help_sentence (h)); |
|
|
1831 } |
|
|
1832 else |
|
|
1833 print_lookfor (name, first_help_sentence (h)); |
|
|
1834 } |
|
5592
|
1835 else |
|
|
1836 { |
|
|
1837 std::string s; |
|
|
1838 |
|
|
1839 if (first_sentence_only) |
|
|
1840 s = first_help_sentence (h); |
|
|
1841 else |
|
|
1842 s = h; |
|
|
1843 |
|
5768
|
1844 std::transform (s.begin (), s.end (), s.begin (), tolower); |
|
5592
|
1845 |
|
|
1846 if (s.length () > 0 && s.find (txt) != NPOS) |
|
|
1847 { |
|
|
1848 if (nargout) |
|
|
1849 { |
|
|
1850 ret[0].append (name); |
|
|
1851 ret[1].append (first_help_sentence (h)); |
|
|
1852 } |
|
|
1853 else |
|
|
1854 print_lookfor (name, first_help_sentence (h)); |
|
|
1855 } |
|
|
1856 } |
|
5447
|
1857 |
|
|
1858 OCTAVE_QUIT; |
|
|
1859 |
|
|
1860 ptr++; |
|
|
1861 } |
|
|
1862 |
|
|
1863 ptr = operator_help (); |
|
|
1864 while (ptr->name) |
|
|
1865 { |
|
|
1866 std::string name = ptr->name; |
|
|
1867 std::string h = ptr->help; |
|
|
1868 |
|
5592
|
1869 if (name.find (txt) != NPOS) |
|
5447
|
1870 { |
|
|
1871 if (nargout) |
|
|
1872 { |
|
|
1873 ret[0].append (name); |
|
|
1874 ret[1].append (first_help_sentence (h)); |
|
|
1875 } |
|
|
1876 else |
|
|
1877 print_lookfor (name, first_help_sentence (h)); |
|
|
1878 } |
|
5592
|
1879 else |
|
|
1880 { |
|
|
1881 std::string s; |
|
|
1882 if (first_sentence_only) |
|
|
1883 s = first_help_sentence (h); |
|
|
1884 else |
|
|
1885 s = h; |
|
|
1886 |
|
5768
|
1887 std::transform (s.begin (), s.end (), s.begin (), tolower); |
|
5592
|
1888 |
|
|
1889 if (s.length () > 0 && s.find (txt) != NPOS) |
|
|
1890 { |
|
|
1891 if (nargout) |
|
|
1892 { |
|
|
1893 ret[0].append (name); |
|
|
1894 ret[1].append (first_help_sentence (h)); |
|
|
1895 } |
|
|
1896 else |
|
|
1897 print_lookfor (name, first_help_sentence (h)); |
|
|
1898 } |
|
|
1899 } |
|
5447
|
1900 |
|
|
1901 OCTAVE_QUIT; |
|
|
1902 |
|
|
1903 ptr++; |
|
|
1904 } |
|
|
1905 |
|
|
1906 // Check the symbol record table |
|
|
1907 string_vector names |
|
|
1908 = fbi_sym_tab->name_list (string_vector (), true); |
|
|
1909 |
|
|
1910 for (octave_idx_type i = 0; i < names.length (); i++) |
|
|
1911 { |
|
|
1912 std::string name = names (i); |
|
|
1913 |
|
|
1914 OCTAVE_QUIT; |
|
|
1915 |
|
|
1916 symbol_record *sr = lookup_by_name (name, 0); |
|
5738
|
1917 if (sr && sr->is_defined () |
|
|
1918 && sr->type_name () != "overloaded function") |
|
5447
|
1919 { |
|
|
1920 std::string h = sr->help (); |
|
|
1921 |
|
5592
|
1922 if (name.find (txt) != NPOS) |
|
5447
|
1923 { |
|
|
1924 if (nargout) |
|
|
1925 { |
|
|
1926 ret[0].append (name); |
|
|
1927 ret[1].append (first_help_sentence (h)); |
|
|
1928 } |
|
|
1929 else |
|
|
1930 print_lookfor (name, first_help_sentence (h)); |
|
|
1931 } |
|
5592
|
1932 else |
|
|
1933 { |
|
|
1934 std::string s; |
|
|
1935 |
|
|
1936 if (first_sentence_only) |
|
|
1937 s = first_help_sentence (h); |
|
|
1938 else |
|
|
1939 s = h; |
|
|
1940 |
|
5768
|
1941 std::transform (s.begin (), s.end (), s.begin (), tolower); |
|
5592
|
1942 |
|
|
1943 if (s.length () > 0 && s.find (txt) != NPOS) |
|
|
1944 { |
|
|
1945 if (nargout) |
|
|
1946 { |
|
|
1947 ret[0].append (name); |
|
|
1948 ret[1].append (first_help_sentence (h)); |
|
|
1949 } |
|
|
1950 else |
|
|
1951 print_lookfor (name, first_help_sentence (h)); |
|
|
1952 } |
|
|
1953 } |
|
5447
|
1954 } |
|
|
1955 } |
|
|
1956 |
|
5832
|
1957 string_vector dirs = load_path::dirs (); |
|
5447
|
1958 |
|
|
1959 int len = dirs.length (); |
|
|
1960 |
|
|
1961 for (int i = 0; i < len; i++) |
|
|
1962 { |
|
5832
|
1963 names = load_path::files (dirs[i]); |
|
5447
|
1964 |
|
|
1965 if (! names.empty ()) |
|
|
1966 { |
|
|
1967 for (int j = 0; j < names.length (); j++) |
|
|
1968 { |
|
|
1969 std::string name = names (j); |
|
|
1970 |
|
|
1971 OCTAVE_QUIT; |
|
|
1972 |
|
|
1973 // Strip extension |
|
|
1974 size_t l = name.length (); |
|
|
1975 if (l > 4 && name.substr (l-4) == ".oct") |
|
|
1976 name = name.substr (0, l - 4); |
|
|
1977 else if (l > 2 && name.substr (l-2) == ".m") |
|
|
1978 name = name.substr (0, l - 2); |
|
|
1979 else |
|
|
1980 continue; |
|
|
1981 |
|
|
1982 // Check if already in symbol table |
|
|
1983 symbol_record *sr = fbi_sym_tab->lookup (name); |
|
|
1984 |
|
|
1985 if (!sr) |
|
|
1986 { |
|
|
1987 // Check if this version is first in the path |
|
|
1988 |
|
5832
|
1989 std::string file_name = load_path::find_fcn (name); |
|
|
1990 |
|
|
1991 std::string dir = dirs[i] + file_ops::dir_sep_str; |
|
|
1992 |
|
|
1993 if (file_name == dir + name + ".oct" |
|
|
1994 || file_name == dir + name + ".m") |
|
5447
|
1995 { |
|
5484
|
1996 bool symbol_found; |
|
|
1997 |
|
5592
|
1998 std::string h; |
|
5832
|
1999 if (file_name == dir + name + ".oct") |
|
5592
|
2000 { |
|
|
2001 // oct-file. Must load to get help |
|
|
2002 sr = lookup_by_name (name, false); |
|
5447
|
2003 |
|
5592
|
2004 if (sr && sr->is_defined ()) |
|
|
2005 h = sr->help (); |
|
|
2006 } |
|
5447
|
2007 else |
|
5592
|
2008 h = get_help_from_file (file_name, symbol_found); |
|
5447
|
2009 |
|
5592
|
2010 if (name.find (txt) != NPOS) |
|
5447
|
2011 { |
|
|
2012 if (nargout) |
|
|
2013 { |
|
|
2014 ret[0].append (name); |
|
|
2015 ret[1].append (first_help_sentence (h)); |
|
|
2016 } |
|
|
2017 else |
|
|
2018 print_lookfor (name, first_help_sentence (h)); |
|
|
2019 } |
|
5592
|
2020 else |
|
|
2021 { |
|
|
2022 std::string s; |
|
|
2023 if (first_sentence_only) |
|
|
2024 s = first_help_sentence (h); |
|
|
2025 else |
|
|
2026 s = h; |
|
|
2027 |
|
5768
|
2028 std::transform (s.begin (), s.end (), s.begin (), tolower); |
|
5592
|
2029 |
|
|
2030 if (s.length () > 0 && s.find (txt) != NPOS) |
|
|
2031 { |
|
|
2032 if (nargout) |
|
|
2033 { |
|
|
2034 ret[0].append (name); |
|
|
2035 ret[1].append (first_help_sentence (h)); |
|
|
2036 } |
|
|
2037 else |
|
|
2038 print_lookfor (name, first_help_sentence (h)); |
|
|
2039 } |
|
|
2040 } |
|
|
2041 } |
|
|
2042 } |
|
|
2043 |
|
|
2044 // Check if this function has autoloaded functions attached to it |
|
5832
|
2045 std::string file_name = load_path::find_fcn (name); |
|
|
2046 |
|
5592
|
2047 string_vector autoload_fcns = reverse_lookup_autoload (file_name); |
|
|
2048 |
|
|
2049 if (! autoload_fcns.empty ()) |
|
|
2050 { |
|
|
2051 for (int k = 0; k < autoload_fcns.length (); k++) |
|
|
2052 { |
|
|
2053 std::string aname = autoload_fcns (k); |
|
|
2054 |
|
|
2055 // Check if already in symbol table |
|
|
2056 sr = fbi_sym_tab->lookup (aname); |
|
|
2057 |
|
|
2058 if (!sr) |
|
|
2059 { |
|
|
2060 // Must load to get help |
|
5738
|
2061 sr = lookup_by_name (aname, false); |
|
5592
|
2062 |
|
|
2063 std::string h; |
|
|
2064 if (sr && sr->is_defined ()) |
|
|
2065 h = sr->help (); |
|
|
2066 |
|
|
2067 if (aname.find (txt) != NPOS) |
|
|
2068 { |
|
|
2069 if (nargout) |
|
|
2070 { |
|
|
2071 ret[0].append (aname); |
|
|
2072 ret[1].append (first_help_sentence (h)); |
|
|
2073 } |
|
|
2074 else |
|
|
2075 print_lookfor (aname, first_help_sentence (h)); |
|
|
2076 } |
|
|
2077 else |
|
|
2078 { |
|
|
2079 std::string s; |
|
|
2080 if (first_sentence_only) |
|
|
2081 s = first_help_sentence (h); |
|
|
2082 else |
|
|
2083 s = h; |
|
|
2084 |
|
5768
|
2085 std::transform (s.begin (), s.end (), s.begin (), |
|
5592
|
2086 tolower); |
|
|
2087 |
|
|
2088 if (s.length () > 0 && s.find (txt) != NPOS) |
|
|
2089 { |
|
|
2090 if (nargout) |
|
|
2091 { |
|
|
2092 ret[0].append (aname); |
|
|
2093 ret[1].append (first_help_sentence (h)); |
|
|
2094 } |
|
|
2095 else |
|
|
2096 print_lookfor (aname, first_help_sentence (h)); |
|
|
2097 } |
|
|
2098 } |
|
|
2099 } |
|
5447
|
2100 } |
|
|
2101 } |
|
|
2102 } |
|
|
2103 } |
|
|
2104 } |
|
|
2105 |
|
|
2106 if (nargout != 0) |
|
|
2107 { |
|
|
2108 retval (1) = ret[1]; |
|
|
2109 retval (0) = ret[0]; |
|
|
2110 } |
|
|
2111 } |
|
|
2112 else |
|
|
2113 { |
|
|
2114 error ("lookfor: argument must be a string"); |
|
|
2115 } |
|
|
2116 |
|
|
2117 return retval; |
|
|
2118 } |
|
|
2119 |
|
5794
|
2120 DEFUN (info_file, args, nargout, |
|
|
2121 "-*- texinfo -*-\n\ |
|
|
2122 @deftypefn {Built-in Function} {@var{val} =} info_file ()\n\ |
|
|
2123 @deftypefnx {Built-in Function} {@var{old_val} =} info_file (@var{new_val})\n\ |
|
|
2124 Query or set the internal variable that specifies the name of the\n\ |
|
|
2125 Octave info file. The default value is\n\ |
|
|
2126 @code{\"@var{octave-home}/info/octave.info\"}, in\n\ |
|
|
2127 which @var{octave-home} is the directory where all of Octave is installed.\n\ |
|
|
2128 @seealso{info_program, doc, help, makeinfo_program}\n\ |
|
|
2129 @end deftypefn") |
|
2202
|
2130 { |
|
5794
|
2131 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (info_file); |
|
2202
|
2132 } |
|
|
2133 |
|
5794
|
2134 DEFUN (info_program, args, nargout, |
|
|
2135 "-*- texinfo -*-\n\ |
|
|
2136 @deftypefn {Built-in Function} {@var{val} =} info_program ()\n\ |
|
|
2137 @deftypefnx {Built-in Function} {@var{old_val} =} info_program (@var{new_val})\n\ |
|
|
2138 Query or set the internal variable that specifies the name of the\n\ |
|
|
2139 info program to run. The default initial value is\n\ |
|
3686
|
2140 @code{\"@var{octave-home}/libexec/octave/@var{version}/exec/@var{arch}/info\"}\n\ |
|
|
2141 in which @var{octave-home} is the directory where all of Octave is\n\ |
|
|
2142 installed, @var{version} is the Octave version number, and @var{arch}\n\ |
|
|
2143 is the system type (for example, @code{i686-pc-linux-gnu}). The\n\ |
|
|
2144 default initial value may be overridden by the environment variable\n\ |
|
|
2145 @code{OCTAVE_INFO_PROGRAM}, or the command line argument\n\ |
|
5794
|
2146 @code{--info-program NAME}.\n\ |
|
|
2147 @seealso{info_file, doc, help, makeinfo_program}\n\ |
|
|
2148 @end deftypefn") |
|
|
2149 { |
|
|
2150 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (info_program); |
|
|
2151 } |
|
3686
|
2152 |
|
5794
|
2153 DEFUN (makeinfo_program, args, nargout, |
|
|
2154 "-*- texinfo -*-\n\ |
|
|
2155 @deftypefn {Built-in Function} {@var{val} =} makeinfo_program ()\n\ |
|
|
2156 @deftypefnx {Built-in Function} {@var{old_val} =} makeinfo_program (@var{new_val})\n\ |
|
|
2157 Query or set the internal variable that specifies the name of the\n\ |
|
|
2158 makeinfo program that Octave runs to format help text containing\n\ |
|
|
2159 Texinfo markup commands. The default initial value is @code{\"makeinfo\"}.\n\ |
|
|
2160 @seealso{info_file, info_program, doc, help}\n\ |
|
|
2161 @end deftypefn") |
|
|
2162 { |
|
|
2163 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (makeinfo_program); |
|
|
2164 } |
|
2202
|
2165 |
|
5794
|
2166 DEFUN (suppress_verbose_help_message, args, nargout, |
|
|
2167 "-*- texinfo -*-\n\ |
|
|
2168 @deftypefn {Built-in Function} {@var{val} =} suppress_verbose_help_message ()\n\ |
|
|
2169 @deftypefnx {Built-in Function} {@var{old_val} =} suppress_verbose_help_message (@var{new_val})\n\ |
|
|
2170 Query or set the internal vaiable that controls whether Octave\n\ |
|
|
2171 will add additional help information to the end of the output from\n\ |
|
3332
|
2172 the @code{help} command and usage messages for built-in commands.\n\ |
|
5794
|
2173 @end deftypefn") |
|
|
2174 { |
|
|
2175 return SET_INTERNAL_VARIABLE (suppress_verbose_help_message); |
|
2189
|
2176 } |
|
|
2177 |
|
1
|
2178 /* |
|
|
2179 ;;; Local Variables: *** |
|
|
2180 ;;; mode: C++ *** |
|
|
2181 ;;; End: *** |
|
|
2182 */ |
