|
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 |
|
1315
|
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
|
1
|
20 |
|
|
21 */ |
|
|
22 |
|
240
|
23 #ifdef HAVE_CONFIG_H |
|
1192
|
24 #include <config.h> |
|
1
|
25 #endif |
|
|
26 |
|
1343
|
27 #include <csignal> |
|
|
28 #include <cstdlib> |
|
|
29 #include <cstring> |
|
|
30 |
|
1755
|
31 #include <string> |
|
|
32 |
|
1350
|
33 #include <iostream.h> |
|
2534
|
34 #include <fstream.h> |
|
1350
|
35 #include <strstream.h> |
|
|
36 |
|
|
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 |
|
2926
|
44 #include "oct-env.h" |
|
1755
|
45 #include "str-vec.h" |
|
|
46 |
|
2492
|
47 #include <defaults.h> |
|
1352
|
48 #include "defun.h" |
|
|
49 #include "dirfns.h" |
|
|
50 #include "error.h" |
|
2233
|
51 #include "fn-cache.h" |
|
2202
|
52 #include "gripes.h" |
|
1352
|
53 #include "help.h" |
|
2177
|
54 #include "input.h" |
|
1755
|
55 #include "oct-obj.h" |
|
2976
|
56 #include "ov-usr-fcn.h" |
|
1352
|
57 #include "pager.h" |
|
1466
|
58 #include "pathsearch.h" |
|
2124
|
59 #include "pt-pr-code.h" |
|
529
|
60 #include "sighandlers.h" |
|
|
61 #include "symtab.h" |
|
2694
|
62 #include "syswait.h" |
|
1755
|
63 #include "toplev.h" |
|
1588
|
64 #include "unwind-prot.h" |
|
242
|
65 #include "utils.h" |
|
1352
|
66 #include "variables.h" |
|
529
|
67 |
|
2202
|
68 // Name of the info file specified on command line. |
|
|
69 // (--info-file file) |
|
|
70 string Vinfo_file; |
|
|
71 |
|
|
72 // Name of the info reader we'd like to use. |
|
|
73 // (--info-program program) |
|
|
74 string Vinfo_prog; |
|
|
75 |
|
2189
|
76 // If TRUE, don't print additional help message in help and usage |
|
|
77 // functions. |
|
|
78 static bool Vsuppress_verbose_help_message; |
|
|
79 |
|
1
|
80 static help_list operators[] = |
|
|
81 { |
|
|
82 { "!", |
|
|
83 "Logical not operator. See also `~'.\n", }, |
|
|
84 |
|
|
85 { "!=", |
|
|
86 "Logical not equals operator. See also `~' and `<>'.\n", }, |
|
|
87 |
|
|
88 { "\"", |
|
|
89 "String delimiter.\n", }, |
|
|
90 |
|
|
91 { "#", |
|
928
|
92 "Begin comment character. See also `%'.", }, |
|
1
|
93 |
|
|
94 { "%", |
|
928
|
95 "Begin comment charcter. See also `#'.", }, |
|
1
|
96 |
|
|
97 { "&", |
|
928
|
98 "Logical and operator. See also `&&'.", }, |
|
1
|
99 |
|
|
100 { "&&", |
|
928
|
101 "Logical and operator. See also `&'.", }, |
|
1
|
102 |
|
|
103 { "'", |
|
|
104 "Matrix transpose operator. For complex matrices, computes the\n\ |
|
|
105 complex conjugate (Hermitian) transpose. See also `.''\n\ |
|
|
106 \n\ |
|
|
107 The single quote character may also be used to delimit strings, but\n\ |
|
|
108 it is better to use the double quote character, since that is never\n\ |
|
928
|
109 ambiguous", }, |
|
1
|
110 |
|
|
111 { "(", |
|
928
|
112 "Array index or function argument delimiter.", }, |
|
1
|
113 |
|
|
114 { ")", |
|
928
|
115 "Array index or function argument delimiter.", }, |
|
1
|
116 |
|
|
117 { "*", |
|
928
|
118 "Multiplication operator. See also `.*'", }, |
|
1
|
119 |
|
|
120 { "**", |
|
928
|
121 "Power operator. See also `^', `.**', and `.^'", }, |
|
1
|
122 |
|
|
123 { "+", |
|
928
|
124 "Addition operator.", }, |
|
1
|
125 |
|
|
126 { "++", |
|
928
|
127 "Increment operator. As in C, may be applied as a prefix or postfix operator.", }, |
|
1
|
128 |
|
|
129 { ",", |
|
928
|
130 "Array index, function argument, or command separator.", }, |
|
1
|
131 |
|
|
132 { "-", |
|
928
|
133 "Subtraction or unary negation operator.", }, |
|
1
|
134 |
|
|
135 { "--", |
|
928
|
136 "Decrement operator. As in C, may be applied as a prefix or postfix operator.", }, |
|
1
|
137 |
|
|
138 { ".'", |
|
|
139 "Matrix transpose operator. For complex matrices, computes the\n\ |
|
928
|
140 transpose, *not* the complex conjugate transpose. See also `''.", }, |
|
1
|
141 |
|
|
142 { ".*", |
|
928
|
143 "Element by element multiplication operator. See also `*'.", }, |
|
1
|
144 |
|
|
145 { ".**", |
|
928
|
146 "Element by element power operator. See also `**', `^', and `.^'.", }, |
|
1
|
147 |
|
|
148 { "./", |
|
928
|
149 "Element by element division operator. See also `/' and `\\'.", }, |
|
1
|
150 |
|
|
151 { ".^", |
|
928
|
152 "Element by element power operator. See also `**', `^', and `.^'.", }, |
|
1
|
153 |
|
|
154 { "/", |
|
928
|
155 "Right division. See also `\\' and `./'.", }, |
|
1
|
156 |
|
|
157 { ":", |
|
928
|
158 "Select entire rows or columns of matrices.", }, |
|
1
|
159 |
|
|
160 { ";", |
|
928
|
161 "Array row or command separator. See also `,'.", }, |
|
1
|
162 |
|
|
163 { "<", |
|
928
|
164 "Less than operator.", }, |
|
1
|
165 |
|
|
166 { "<=", |
|
928
|
167 "Less than or equals operator.", }, |
|
1
|
168 |
|
|
169 { "<>", |
|
928
|
170 "Logical not equals operator. See also `!=' and `~='.", }, |
|
1
|
171 |
|
|
172 { "=", |
|
928
|
173 "Assignment operator.", }, |
|
1
|
174 |
|
|
175 { "==", |
|
928
|
176 "Equality test operator.", }, |
|
1
|
177 |
|
|
178 { ">", |
|
928
|
179 "Greater than operator.", }, |
|
1
|
180 |
|
|
181 { ">=", |
|
928
|
182 "Greater than or equals operator.", }, |
|
1
|
183 |
|
|
184 { "[", |
|
928
|
185 "Return list delimiter. See also `]'.", }, |
|
1
|
186 |
|
|
187 { "\\", |
|
928
|
188 "Left division operator. See also `/' and `./'.", }, |
|
1
|
189 |
|
|
190 { "]", |
|
928
|
191 "Return list delimiter. See also `['.", }, |
|
1
|
192 |
|
|
193 { "^", |
|
928
|
194 "Power operator. See also `**', `.^', and `.**.'", }, |
|
1
|
195 |
|
|
196 { "|", |
|
928
|
197 "Logical or operator. See also `||'.", }, |
|
1
|
198 |
|
|
199 { "||", |
|
928
|
200 "Logical or operator. See also `|'.", }, |
|
1
|
201 |
|
|
202 { "~", |
|
928
|
203 "Logical not operator. See also `!' and `~'.", }, |
|
1
|
204 |
|
|
205 { "~=", |
|
928
|
206 "Logical not equals operator. See also `<>' and `!='.", }, |
|
1
|
207 |
|
529
|
208 { 0, 0, }, |
|
1
|
209 }; |
|
|
210 |
|
|
211 static help_list keywords[] = |
|
|
212 { |
|
928
|
213 { "all_va_args", |
|
|
214 "Pass all unnamed arguments to another function call.", }, |
|
|
215 |
|
1
|
216 { "break", |
|
928
|
217 "Exit the innermost enclosing while or for loop.", }, |
|
1
|
218 |
|
1489
|
219 { "catch", |
|
|
220 "begin the cleanup part of a try-catch block", }, |
|
|
221 |
|
1
|
222 { "continue", |
|
928
|
223 "Jump to the end of the innermost enclosing while or for loop.", }, |
|
1
|
224 |
|
|
225 { "else", |
|
928
|
226 "Alternate action for an if block.", }, |
|
1
|
227 |
|
|
228 { "elseif", |
|
928
|
229 "Alternate conditional test for an if block.", }, |
|
1
|
230 |
|
|
231 { "end", |
|
928
|
232 "Mark the end of any for, if, while, or function block.", }, |
|
|
233 |
|
1489
|
234 { "end_try_catch", |
|
|
235 "Mark the end of an try-catch block.", }, |
|
|
236 |
|
928
|
237 { "end_unwind_protect", |
|
|
238 "Mark the end of an unwind_protect block.", }, |
|
1
|
239 |
|
|
240 { "endfor", |
|
928
|
241 "Mark the end of a for loop.", }, |
|
1
|
242 |
|
|
243 { "endfunction", |
|
928
|
244 "Mark the end of a function.", }, |
|
1
|
245 |
|
|
246 { "endif", |
|
928
|
247 "Mark the end of an if block.", }, |
|
1
|
248 |
|
|
249 { "endwhile", |
|
928
|
250 "Mark the end of a while loop.", }, |
|
1
|
251 |
|
|
252 { "for", |
|
928
|
253 "Begin a for loop.", }, |
|
1
|
254 |
|
|
255 { "function", |
|
928
|
256 "Begin a function body.", }, |
|
1
|
257 |
|
|
258 { "global", |
|
928
|
259 "Declare variables to have global scope.", }, |
|
1
|
260 |
|
|
261 { "gplot", |
|
928
|
262 "Produce 2-D plots using gnuplot-like command syntax.", }, |
|
1
|
263 |
|
|
264 { "gsplot", |
|
928
|
265 "Produce 3-D plots using gnuplot-like command syntax.", }, |
|
1
|
266 |
|
|
267 { "if", |
|
928
|
268 "Begin an if block.", }, |
|
1
|
269 |
|
|
270 { "return", |
|
928
|
271 "Return from a function.", }, |
|
|
272 |
|
1489
|
273 { "try", |
|
|
274 "Begin a try-catch block.", }, |
|
|
275 |
|
928
|
276 { "unwind_protect", |
|
|
277 "Begin an unwind_protect block.", }, |
|
|
278 |
|
|
279 { "unwind_protect_cleanup", |
|
|
280 "Begin the cleanup section of an unwind_protect block.", }, |
|
1
|
281 |
|
|
282 { "while", |
|
928
|
283 "Begin a while loop.", }, |
|
1
|
284 |
|
529
|
285 { 0, 0, }, |
|
1
|
286 }; |
|
|
287 |
|
581
|
288 // Return a copy of the operator or keyword names. |
|
|
289 |
|
1755
|
290 string_vector |
|
1
|
291 names (help_list *lst, int& count) |
|
|
292 { |
|
1755
|
293 string_vector retval; |
|
|
294 |
|
1
|
295 count = 0; |
|
|
296 help_list *ptr = lst; |
|
529
|
297 while (ptr->name) |
|
1
|
298 { |
|
|
299 count++; |
|
|
300 ptr++; |
|
|
301 } |
|
|
302 |
|
1755
|
303 if (count > 0) |
|
|
304 { |
|
|
305 retval.resize (count); |
|
1
|
306 |
|
1755
|
307 ptr = lst; |
|
|
308 for (int i = 0; i < count; i++) |
|
|
309 { |
|
|
310 retval[i] = ptr->name; |
|
|
311 ptr++; |
|
|
312 } |
|
1
|
313 } |
|
|
314 |
|
1755
|
315 return retval; |
|
1
|
316 } |
|
|
317 |
|
|
318 help_list * |
|
|
319 operator_help (void) |
|
|
320 { |
|
|
321 return operators; |
|
|
322 } |
|
|
323 |
|
|
324 help_list * |
|
|
325 keyword_help (void) |
|
|
326 { |
|
|
327 return keywords; |
|
|
328 } |
|
|
329 |
|
2470
|
330 #if defined (USE_GNU_INFO) |
|
|
331 static void |
|
|
332 additional_help_message (ostream& os) |
|
|
333 { |
|
|
334 if (! Vsuppress_verbose_help_message) |
|
|
335 os << "\n\ |
|
1115
|
336 Additional help for builtin functions, operators, and variables\n\ |
|
|
337 is available in the on-line version of the manual.\n\ |
|
|
338 \n\ |
|
2470
|
339 Use the command `help -i <topic>' to search the manual index.\n"; |
|
|
340 } |
|
|
341 #else |
|
1115
|
342 static void |
|
2470
|
343 additional_help_message (ostream&) |
|
542
|
344 { |
|
2470
|
345 } |
|
1140
|
346 #endif |
|
542
|
347 |
|
|
348 void |
|
1755
|
349 print_usage (const string& nm, int just_usage) |
|
542
|
350 { |
|
2856
|
351 symbol_record *sym_rec = global_sym_tab->lookup (nm); |
|
542
|
352 if (sym_rec) |
|
|
353 { |
|
1755
|
354 string h = sym_rec->help (); |
|
|
355 |
|
|
356 if (h.length () > 0) |
|
542
|
357 { |
|
2095
|
358 octave_stdout << "\n*** " << nm << ":\n\n" |
|
542
|
359 << h << "\n"; |
|
|
360 |
|
1117
|
361 if (! just_usage) |
|
2095
|
362 additional_help_message (octave_stdout); |
|
542
|
363 } |
|
|
364 } |
|
1023
|
365 else |
|
1755
|
366 warning ("no usage message found for `%s'", nm.c_str ()); |
|
542
|
367 } |
|
|
368 |
|
2976
|
369 // XXX FIXME XXX -- this needs a major overhaul to cope with new |
|
|
370 // symbol table stuff. |
|
|
371 |
|
529
|
372 static void |
|
2095
|
373 display_names_from_help_list (ostream& os, help_list *list, |
|
542
|
374 const char *desc) |
|
529
|
375 { |
|
|
376 int count = 0; |
|
1755
|
377 string_vector symbols = names (list, count); |
|
1808
|
378 if (! symbols.empty ()) |
|
|
379 { |
|
2095
|
380 os << "\n*** " << desc << ":\n\n"; |
|
|
381 symbols.list_in_columns (os); |
|
1808
|
382 } |
|
529
|
383 } |
|
|
384 |
|
1755
|
385 static string |
|
2095
|
386 print_symbol_type (ostream& os, symbol_record *sym_rec, |
|
1755
|
387 const string& name, int print) |
|
742
|
388 { |
|
1755
|
389 string retval; |
|
742
|
390 |
|
|
391 if (sym_rec->is_user_function ()) |
|
|
392 { |
|
2976
|
393 octave_value tmp = sym_rec->def (); |
|
1755
|
394 |
|
2976
|
395 octave_function *defn = tmp.function_value (); |
|
|
396 |
|
|
397 string fn = defn ? defn->fcn_file_name () : string (); |
|
1755
|
398 |
|
|
399 if (! fn.empty ()) |
|
742
|
400 { |
|
1755
|
401 string ff = fcn_file_in_path (fn); |
|
|
402 |
|
|
403 ff = ff.length () > 0 ? ff : fn; |
|
742
|
404 |
|
|
405 if (print) |
|
2095
|
406 os << name |
|
|
407 << " is the function defined from:\n" |
|
|
408 << ff << "\n"; |
|
742
|
409 else |
|
|
410 retval = ff; |
|
|
411 } |
|
|
412 else |
|
|
413 { |
|
|
414 if (print) |
|
2095
|
415 os << name << " is a user-defined function\n"; |
|
742
|
416 else |
|
|
417 retval = "user-defined function"; |
|
|
418 } |
|
|
419 } |
|
|
420 else if (sym_rec->is_text_function ()) |
|
|
421 { |
|
|
422 if (print) |
|
2095
|
423 os << name << " is a builtin text-function\n"; |
|
742
|
424 else |
|
|
425 retval = "builtin text-function"; |
|
|
426 } |
|
|
427 else if (sym_rec->is_builtin_function ()) |
|
|
428 { |
|
|
429 if (print) |
|
2095
|
430 os << name << " is a builtin function\n"; |
|
742
|
431 else |
|
|
432 retval = "builtin function"; |
|
|
433 } |
|
|
434 else if (sym_rec->is_user_variable ()) |
|
|
435 { |
|
|
436 if (print) |
|
2095
|
437 os << name << " is a user-defined variable\n"; |
|
742
|
438 else |
|
|
439 retval = "user-defined variable"; |
|
|
440 } |
|
|
441 else if (sym_rec->is_builtin_variable ()) |
|
|
442 { |
|
|
443 if (print) |
|
2095
|
444 os << name << " is a builtin variable\n"; |
|
742
|
445 else |
|
|
446 retval = "builtin variable"; |
|
|
447 } |
|
|
448 else |
|
|
449 { |
|
|
450 if (print) |
|
2095
|
451 os << "which: `" << name << "' has unknown type\n"; |
|
742
|
452 else |
|
|
453 retval = "unknown type"; |
|
|
454 } |
|
|
455 |
|
|
456 return retval; |
|
|
457 } |
|
|
458 |
|
529
|
459 static void |
|
2095
|
460 display_symtab_names (ostream& os, const string_vector& names, |
|
1755
|
461 int /* count */, const string& desc) |
|
542
|
462 { |
|
1808
|
463 if (! names.empty ()) |
|
|
464 { |
|
2095
|
465 os << "\n*** " << desc << ":\n\n"; |
|
|
466 names.list_in_columns (os); |
|
1808
|
467 } |
|
542
|
468 } |
|
|
469 |
|
|
470 static void |
|
529
|
471 simple_help (void) |
|
|
472 { |
|
2095
|
473 display_names_from_help_list (octave_stdout, operator_help (), |
|
542
|
474 "operators"); |
|
529
|
475 |
|
2095
|
476 display_names_from_help_list (octave_stdout, keyword_help (), |
|
542
|
477 "reserved words"); |
|
529
|
478 |
|
542
|
479 #ifdef LIST_SYMBOLS |
|
|
480 #undef LIST_SYMBOLS |
|
|
481 #endif |
|
|
482 #define LIST_SYMBOLS(type, msg) \ |
|
|
483 do \ |
|
|
484 { \ |
|
|
485 int count; \ |
|
3013
|
486 string_vector names = global_sym_tab->name_list (count, 0, 0, 1, type); \ |
|
2095
|
487 display_symtab_names (octave_stdout, names, count, msg); \ |
|
542
|
488 } \ |
|
|
489 while (0) |
|
529
|
490 |
|
1358
|
491 // XXX FIXME XXX -- is this distinction needed? |
|
|
492 |
|
3010
|
493 LIST_SYMBOLS (symbol_record::TEXT_FUNCTION, |
|
542
|
494 "text functions (these names are also reserved)"); |
|
529
|
495 |
|
3010
|
496 LIST_SYMBOLS (symbol_record::MAPPER_FUNCTION, "mapper functions"); |
|
542
|
497 |
|
3010
|
498 LIST_SYMBOLS (symbol_record::BUILTIN_FUNCTION, "general functions"); |
|
542
|
499 |
|
3010
|
500 LIST_SYMBOLS (symbol_record::BUILTIN_VARIABLE, "builtin variables"); |
|
542
|
501 |
|
1358
|
502 // Also need to list variables and currently compiled functions from |
|
|
503 // the symbol table, if there are any. |
|
529
|
504 |
|
1358
|
505 // Also need to search octave_path for script files. |
|
529
|
506 |
|
2202
|
507 dir_path p (Vload_path); |
|
529
|
508 |
|
1787
|
509 string_vector dirs = p.all_directories (); |
|
679
|
510 |
|
1787
|
511 int len = dirs.length (); |
|
679
|
512 |
|
1787
|
513 for (int i = 0; i < len; i++) |
|
|
514 { |
|
2233
|
515 string_vector names = octave_fcn_file_name_cache::list (dirs[i]); |
|
679
|
516 |
|
1787
|
517 if (! names.empty ()) |
|
|
518 { |
|
2926
|
519 string dir |
|
|
520 = octave_env::make_absolute (dirs[i], octave_env::getcwd ()); |
|
|
521 |
|
|
522 octave_stdout << "\n*** function files in " << dir << ":\n\n"; |
|
679
|
523 |
|
2095
|
524 names.list_in_columns (octave_stdout); |
|
529
|
525 } |
|
|
526 } |
|
|
527 |
|
2095
|
528 additional_help_message (octave_stdout); |
|
529
|
529 } |
|
|
530 |
|
2470
|
531 #if defined (USE_GNU_INFO) |
|
529
|
532 static int |
|
1755
|
533 try_info (const string& nm) |
|
529
|
534 { |
|
|
535 int status = 0; |
|
|
536 |
|
1295
|
537 static char *cmd_str = 0; |
|
|
538 |
|
|
539 delete [] cmd_str; |
|
|
540 cmd_str = 0; |
|
|
541 |
|
|
542 ostrstream cmd_buf; |
|
|
543 |
|
2202
|
544 cmd_buf << Vinfo_prog << " --file " << Vinfo_file; |
|
1295
|
545 |
|
2202
|
546 string directory_name = Vinfo_file; |
|
1755
|
547 size_t pos = directory_name.rfind ('/'); |
|
|
548 |
|
|
549 if (pos != NPOS) |
|
529
|
550 { |
|
1755
|
551 directory_name.resize (pos + 1); |
|
1295
|
552 cmd_buf << " --directory " << directory_name; |
|
529
|
553 } |
|
|
554 |
|
1755
|
555 if (nm.length () > 0) |
|
|
556 cmd_buf << " --index-search " << nm; |
|
529
|
557 |
|
1295
|
558 cmd_buf << ends; |
|
529
|
559 |
|
1295
|
560 cmd_str = cmd_buf.str (); |
|
529
|
561 |
|
2705
|
562 volatile octave_interrupt_handler old_interrupt_handler |
|
2554
|
563 = octave_ignore_interrupts (); |
|
529
|
564 |
|
1295
|
565 status = system (cmd_str); |
|
529
|
566 |
|
2554
|
567 octave_set_interrupt_handler (old_interrupt_handler); |
|
529
|
568 |
|
2694
|
569 if (WIFEXITED (status)) |
|
|
570 status = WEXITSTATUS (status); |
|
1295
|
571 else |
|
|
572 status = 127; |
|
529
|
573 |
|
|
574 return status; |
|
|
575 } |
|
1140
|
576 |
|
|
577 static void |
|
1755
|
578 help_from_info (const string_vector& argv, int idx, int argc) |
|
1140
|
579 { |
|
1755
|
580 if (idx == argc) |
|
|
581 try_info (string ()); |
|
1140
|
582 else |
|
|
583 { |
|
1755
|
584 for (int i = idx; i < argc; i++) |
|
1140
|
585 { |
|
1755
|
586 int status = try_info (argv[i]); |
|
1140
|
587 |
|
1295
|
588 if (status) |
|
1140
|
589 { |
|
1295
|
590 if (status < 0) |
|
|
591 { |
|
|
592 message ("help", |
|
|
593 "sorry, `%s' is not indexed in the manual", |
|
1755
|
594 argv[i].c_str ()); |
|
1295
|
595 sleep (2); |
|
|
596 } |
|
|
597 else |
|
|
598 { |
|
|
599 error ("help: unable to find info!"); |
|
|
600 break; |
|
|
601 } |
|
1140
|
602 } |
|
|
603 } |
|
|
604 } |
|
2470
|
605 } |
|
1140
|
606 #else |
|
2470
|
607 static void |
|
|
608 help_from_info (const string_vector&, int, int) |
|
|
609 { |
|
1140
|
610 message (0, "sorry, help -i is not available in this version of Octave"); |
|
2470
|
611 } |
|
1140
|
612 #endif |
|
529
|
613 |
|
542
|
614 int |
|
2095
|
615 help_from_list (ostream& os, const help_list *list, |
|
1755
|
616 const string& nm, int usage) |
|
542
|
617 { |
|
2804
|
618 const char *name; |
|
542
|
619 while ((name = list->name) != 0) |
|
|
620 { |
|
1755
|
621 if (strcmp (name, nm.c_str ()) == 0) |
|
542
|
622 { |
|
|
623 if (usage) |
|
2095
|
624 os << "\nusage: "; |
|
542
|
625 else |
|
|
626 { |
|
2095
|
627 os << "\n*** " << nm << ":\n\n"; |
|
542
|
628 } |
|
|
629 |
|
2095
|
630 os << list->help << "\n"; |
|
542
|
631 |
|
|
632 return 1; |
|
|
633 } |
|
|
634 list++; |
|
|
635 } |
|
|
636 return 0; |
|
|
637 } |
|
|
638 |
|
1140
|
639 static void |
|
1755
|
640 builtin_help (int argc, const string_vector& argv) |
|
1140
|
641 { |
|
|
642 help_list *op_help_list = operator_help (); |
|
|
643 help_list *kw_help_list = keyword_help (); |
|
|
644 |
|
1755
|
645 for (int i = 1; i < argc; i++) |
|
1140
|
646 { |
|
2095
|
647 if (help_from_list (octave_stdout, op_help_list, argv[i], 0)) |
|
1140
|
648 continue; |
|
|
649 |
|
2095
|
650 if (help_from_list (octave_stdout, kw_help_list, argv[i], 0)) |
|
1140
|
651 continue; |
|
|
652 |
|
1755
|
653 symbol_record *sym_rec = lookup_by_name (argv[i], 0); |
|
1140
|
654 |
|
|
655 if (sym_rec && sym_rec->is_defined ()) |
|
|
656 { |
|
1755
|
657 string h = sym_rec->help (); |
|
|
658 |
|
|
659 if (h.length () > 0) |
|
1140
|
660 { |
|
2095
|
661 print_symbol_type (octave_stdout, sym_rec, argv[i], 1); |
|
|
662 octave_stdout << "\n" << h << "\n"; |
|
1140
|
663 continue; |
|
|
664 } |
|
|
665 } |
|
|
666 |
|
1755
|
667 string path = fcn_file_in_path (argv[i]); |
|
|
668 |
|
|
669 string h = get_help_from_file (path); |
|
|
670 |
|
|
671 if (! h.empty ()) |
|
1140
|
672 { |
|
2095
|
673 octave_stdout << argv[i] << " is the file:\n" |
|
1140
|
674 << path << "\n\n" << h << "\n"; |
|
1755
|
675 |
|
1140
|
676 continue; |
|
|
677 } |
|
|
678 |
|
2095
|
679 octave_stdout << "\nhelp: sorry, `" << argv[i] |
|
|
680 << "' is not documented\n"; |
|
1140
|
681 } |
|
|
682 |
|
2095
|
683 additional_help_message (octave_stdout); |
|
1140
|
684 } |
|
|
685 |
|
2470
|
686 #if defined (USE_GNU_INFO) |
|
1957
|
687 DEFUN_TEXT (help, args, , |
|
529
|
688 "help [-i] [topic ...]\n\ |
|
|
689 \n\ |
|
|
690 print cryptic yet witty messages") |
|
1140
|
691 #else |
|
1957
|
692 DEFUN_TEXT (help, args, , |
|
1140
|
693 "help [topic ...]\n\ |
|
|
694 \n\ |
|
|
695 print cryptic yet witty messages") |
|
|
696 #endif |
|
529
|
697 { |
|
2086
|
698 octave_value_list retval; |
|
529
|
699 |
|
1755
|
700 int argc = args.length () + 1; |
|
|
701 |
|
1968
|
702 string_vector argv = args.make_argv ("help"); |
|
1755
|
703 |
|
|
704 if (error_state) |
|
|
705 return retval; |
|
529
|
706 |
|
|
707 if (argc == 1) |
|
|
708 { |
|
|
709 simple_help (); |
|
|
710 } |
|
|
711 else |
|
|
712 { |
|
1755
|
713 if (argv[1] == "-i") |
|
529
|
714 { |
|
1755
|
715 help_from_info (argv, 2, argc); |
|
529
|
716 } |
|
|
717 else |
|
|
718 { |
|
1140
|
719 builtin_help (argc, argv); |
|
529
|
720 } |
|
|
721 } |
|
|
722 |
|
|
723 return retval; |
|
|
724 } |
|
|
725 |
|
1957
|
726 DEFUN_TEXT (type, args, nargout, |
|
2962
|
727 "type NAME\n\ |
|
581
|
728 \n\ |
|
|
729 display the definition of each NAME that refers to a function") |
|
|
730 { |
|
2086
|
731 octave_value_list retval; |
|
581
|
732 |
|
2985
|
733 unwind_protect::begin_frame ("Ftype"); |
|
1588
|
734 |
|
1755
|
735 int argc = args.length () + 1; |
|
|
736 |
|
1968
|
737 string_vector argv = args.make_argv ("type"); |
|
1755
|
738 |
|
|
739 if (error_state) |
|
|
740 return retval; |
|
581
|
741 |
|
|
742 if (argc > 1) |
|
|
743 { |
|
1358
|
744 // XXX FIXME XXX -- we should really use getopt () |
|
|
745 |
|
2532
|
746 bool quiet = false; |
|
|
747 bool pr_orig_txt = true; |
|
|
748 |
|
|
749 int idx; |
|
|
750 |
|
|
751 for (idx = 1; idx < argc; idx++) |
|
581
|
752 { |
|
2532
|
753 if (argv[idx] == "-q" || argv[idx] == "-quiet") |
|
|
754 quiet = true; |
|
|
755 else if (argv[idx] == "-t" || argv[idx] == "-transformed") |
|
|
756 pr_orig_txt = false; |
|
|
757 else |
|
|
758 break; |
|
|
759 } |
|
|
760 |
|
|
761 if (idx == argc) |
|
|
762 { |
|
|
763 print_usage ("type"); |
|
|
764 return retval; |
|
581
|
765 } |
|
|
766 |
|
|
767 ostrstream output_buf; |
|
|
768 |
|
1755
|
769 for (int i = idx; i < argc; i++) |
|
581
|
770 { |
|
1755
|
771 string id = argv[i]; |
|
|
772 string elts; |
|
581
|
773 |
|
1755
|
774 if (id[id.length () - 1] != '.') |
|
1281
|
775 { |
|
1755
|
776 size_t pos = id.find ('.'); |
|
|
777 |
|
|
778 if (pos != NPOS) |
|
1288
|
779 { |
|
1889
|
780 elts = id.substr (pos+1); |
|
1755
|
781 id = id.substr (0, pos); |
|
1288
|
782 } |
|
1281
|
783 } |
|
|
784 |
|
|
785 symbol_record *sym_rec = lookup_by_name (id, 0); |
|
581
|
786 |
|
|
787 if (sym_rec) |
|
|
788 { |
|
|
789 if (sym_rec->is_user_function ()) |
|
|
790 { |
|
2976
|
791 octave_value tmp = sym_rec->def (); |
|
|
792 |
|
|
793 octave_function *defn = tmp.function_value (); |
|
2962
|
794 |
|
2976
|
795 string fn = defn ? defn->fcn_file_name () : string (); |
|
581
|
796 |
|
2976
|
797 string ff = fn.empty () ? string () : fcn_file_in_path (fn); |
|
2534
|
798 |
|
|
799 if (pr_orig_txt && ! ff.empty ()) |
|
|
800 { |
|
|
801 ifstream fs (ff.c_str (), ios::in); |
|
|
802 |
|
|
803 if (fs) |
|
|
804 { |
|
|
805 if (nargout == 0 && ! quiet) |
|
|
806 output_buf << argv[i] |
|
|
807 << " is the function defined from:\n" |
|
|
808 << ff << "\n\n"; |
|
|
809 |
|
|
810 char ch; |
|
581
|
811 |
|
2534
|
812 while (fs.get (ch)) |
|
|
813 output_buf << ch; |
|
|
814 } |
|
|
815 else |
|
|
816 output_buf << "unable to open `" << ff |
|
|
817 << "' for reading!\n"; |
|
|
818 } |
|
|
819 else |
|
|
820 { |
|
|
821 if (nargout == 0 && ! quiet) |
|
|
822 output_buf << argv[i] |
|
|
823 << " is a user-defined function:\n\n"; |
|
2124
|
824 |
|
2534
|
825 tree_print_code tpc (output_buf, "", pr_orig_txt); |
|
|
826 |
|
2962
|
827 defn->accept (tpc); |
|
2534
|
828 } |
|
581
|
829 } |
|
|
830 |
|
1358
|
831 // XXX FIXME XXX -- this code should be shared with |
|
|
832 // Fwhich. |
|
581
|
833 |
|
|
834 else if (sym_rec->is_text_function ()) |
|
1755
|
835 output_buf << argv[i] << " is a builtin text-function\n"; |
|
581
|
836 else if (sym_rec->is_builtin_function ()) |
|
1755
|
837 output_buf << argv[i] << " is a builtin function\n"; |
|
1281
|
838 else if (sym_rec->is_user_variable () |
|
|
839 || sym_rec->is_builtin_variable ()) |
|
625
|
840 { |
|
2976
|
841 octave_value defn = sym_rec->def (); |
|
625
|
842 |
|
2976
|
843 assert (defn.is_constant ()); |
|
1281
|
844 |
|
|
845 int var_ok = 1; |
|
2875
|
846 |
|
|
847 // XXX FIXME XXX -- need to handle structure |
|
|
848 // references correctly. |
|
|
849 |
|
2976
|
850 if (defn.is_map ()) |
|
|
851 error ("type: operations on structs not implemented"); |
|
1288
|
852 |
|
2875
|
853 if (! error_state) |
|
1281
|
854 { |
|
2875
|
855 if (nargout == 0 && ! quiet) |
|
1288
|
856 { |
|
2875
|
857 if (var_ok) |
|
|
858 { |
|
|
859 output_buf << argv[i]; |
|
|
860 if (sym_rec->is_user_variable ()) |
|
|
861 output_buf << " is a user-defined variable\n"; |
|
|
862 else |
|
|
863 output_buf << " is a built-in variable\n"; |
|
|
864 } |
|
1288
|
865 else |
|
2875
|
866 { |
|
|
867 if (! elts.empty ()) |
|
|
868 output_buf << "type: structure `" << id |
|
|
869 << "' has no member `" << elts |
|
|
870 << "'\n"; |
|
|
871 else |
|
|
872 output_buf << "type: `" << id |
|
|
873 << "' has unknown type!\n"; |
|
|
874 } |
|
1288
|
875 } |
|
1281
|
876 } |
|
625
|
877 } |
|
581
|
878 else |
|
1755
|
879 output_buf << "type: `" << argv[i] << "' has unknown type!\n"; |
|
581
|
880 } |
|
|
881 else |
|
1755
|
882 output_buf << "type: `" << argv[i] << "' undefined\n"; |
|
581
|
883 } |
|
|
884 |
|
|
885 output_buf << ends; |
|
|
886 |
|
2095
|
887 char *s = output_buf.str (); |
|
|
888 |
|
581
|
889 if (nargout == 0) |
|
2095
|
890 octave_stdout << s; |
|
581
|
891 else |
|
2095
|
892 retval = s; |
|
|
893 |
|
|
894 delete [] s; |
|
581
|
895 } |
|
|
896 else |
|
|
897 print_usage ("type"); |
|
|
898 |
|
|
899 return retval; |
|
|
900 } |
|
|
901 |
|
1957
|
902 DEFUN_TEXT (which, args, nargout, |
|
1565
|
903 "which NAME ...\n\ |
|
581
|
904 \n\ |
|
|
905 display the type of each NAME. If NAME is defined from an function\n\ |
|
|
906 file, print the full name of the file.") |
|
|
907 { |
|
2086
|
908 octave_value_list retval; |
|
581
|
909 |
|
1755
|
910 int argc = args.length () + 1; |
|
|
911 |
|
1968
|
912 string_vector argv = args.make_argv ("which"); |
|
1755
|
913 |
|
|
914 if (error_state) |
|
|
915 return retval; |
|
581
|
916 |
|
|
917 if (argc > 1) |
|
|
918 { |
|
|
919 if (nargout > 0) |
|
|
920 retval.resize (argc-1, Matrix ()); |
|
|
921 |
|
1755
|
922 for (int i = 1; i < argc; i++) |
|
581
|
923 { |
|
1755
|
924 symbol_record *sym_rec = lookup_by_name (argv[i], 0); |
|
581
|
925 |
|
|
926 if (sym_rec) |
|
|
927 { |
|
742
|
928 int print = (nargout == 0); |
|
2095
|
929 string tmp = print_symbol_type (octave_stdout, sym_rec, |
|
1755
|
930 argv[i], print); |
|
742
|
931 if (! print) |
|
|
932 retval(i) = tmp; |
|
581
|
933 } |
|
|
934 else |
|
|
935 { |
|
|
936 if (nargout == 0) |
|
2095
|
937 octave_stdout << "which: `" << argv[i] << "' is undefined\n"; |
|
581
|
938 else |
|
|
939 retval(i) = "undefined"; |
|
|
940 } |
|
|
941 } |
|
|
942 } |
|
|
943 else |
|
|
944 print_usage ("which"); |
|
|
945 |
|
|
946 return retval; |
|
|
947 } |
|
|
948 |
|
2189
|
949 static int |
|
|
950 suppress_verbose_help_message (void) |
|
|
951 { |
|
|
952 Vsuppress_verbose_help_message |
|
|
953 = check_preference ("suppress_verbose_help_message"); |
|
|
954 |
|
|
955 return 0; |
|
|
956 } |
|
|
957 |
|
2202
|
958 static int |
|
|
959 info_file (void) |
|
|
960 { |
|
|
961 int status = 0; |
|
|
962 |
|
|
963 string s = builtin_string_variable ("INFO_FILE"); |
|
|
964 |
|
|
965 if (s.empty ()) |
|
|
966 { |
|
|
967 gripe_invalid_value_specified ("INFO_FILE"); |
|
|
968 status = -1; |
|
|
969 } |
|
|
970 else |
|
|
971 Vinfo_file = s; |
|
|
972 |
|
|
973 return status; |
|
|
974 } |
|
|
975 |
|
|
976 static int |
|
|
977 info_prog (void) |
|
|
978 { |
|
|
979 int status = 0; |
|
|
980 |
|
|
981 string s = builtin_string_variable ("INFO_PROGRAM"); |
|
|
982 |
|
|
983 if (s.empty ()) |
|
|
984 { |
|
|
985 gripe_invalid_value_specified ("INFO_PROGRAM"); |
|
|
986 status = -1; |
|
|
987 } |
|
|
988 else |
|
|
989 Vinfo_prog = s; |
|
|
990 |
|
|
991 return status; |
|
|
992 } |
|
|
993 |
|
2189
|
994 void |
|
|
995 symbols_of_help (void) |
|
|
996 { |
|
2202
|
997 DEFVAR (INFO_FILE, Vinfo_file, 0, info_file, |
|
|
998 "name of the Octave info file"); |
|
|
999 |
|
|
1000 DEFVAR (INFO_PROGRAM, Vinfo_prog, 0, info_prog, |
|
|
1001 "name of the Octave info reader"); |
|
|
1002 |
|
2189
|
1003 DEFVAR (suppress_verbose_help_message, 0.0, 0, suppress_verbose_help_message, |
|
|
1004 "suppress printing of message pointing to additional help in the\n\ |
|
|
1005 help and usage functions"); |
|
|
1006 } |
|
|
1007 |
|
1
|
1008 /* |
|
|
1009 ;;; Local Variables: *** |
|
|
1010 ;;; mode: C++ *** |
|
|
1011 ;;; End: *** |
|
|
1012 */ |
