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