|
1
|
1 // help.cc -*- C++ -*- |
|
|
2 /* |
|
|
3 |
|
1009
|
4 Copyright (C) 1992, 1993, 1994, 1995 John W. Eaton |
|
1
|
5 |
|
|
6 This file is part of Octave. |
|
|
7 |
|
|
8 Octave is free software; you can redistribute it and/or modify it |
|
|
9 under the terms of the GNU General Public License as published by the |
|
|
10 Free Software Foundation; either version 2, or (at your option) any |
|
|
11 later version. |
|
|
12 |
|
|
13 Octave is distributed in the hope that it will be useful, but WITHOUT |
|
|
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
|
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
|
16 for more details. |
|
|
17 |
|
|
18 You should have received a copy of the GNU General Public License |
|
|
19 along with Octave; see the file COPYING. If not, write to the Free |
|
|
20 Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. |
|
|
21 |
|
|
22 */ |
|
|
23 |
|
240
|
24 #ifdef HAVE_CONFIG_H |
|
|
25 #include "config.h" |
|
1
|
26 #endif |
|
|
27 |
|
529
|
28 #include <signal.h> |
|
|
29 #include <stdlib.h> |
|
1
|
30 #include <iostream.h> |
|
529
|
31 #include <strstream.h> |
|
240
|
32 |
|
581
|
33 #include "tree-expr.h" |
|
|
34 #include "tree-const.h" |
|
529
|
35 #include "sighandlers.h" |
|
|
36 #include "user-prefs.h" |
|
|
37 #include "tree-expr.h" |
|
|
38 #include "variables.h" |
|
|
39 #include "oct-obj.h" |
|
|
40 #include "symtab.h" |
|
|
41 #include "octave.h" |
|
|
42 #include "dirfns.h" |
|
|
43 #include "pager.h" |
|
|
44 #include "error.h" |
|
242
|
45 #include "utils.h" |
|
1
|
46 #include "help.h" |
|
529
|
47 #include "defun.h" |
|
|
48 |
|
|
49 extern "C" |
|
|
50 { |
|
|
51 #include "info/info.h" |
|
|
52 #include "info/dribble.h" |
|
|
53 #include "info/terminal.h" |
|
|
54 |
|
|
55 extern int initialize_info_session (); |
|
|
56 extern int index_entry_exists (); |
|
|
57 extern int do_info_index_search (); |
|
|
58 extern void finish_info_session (); |
|
|
59 extern char *replace_in_documentation (); |
|
|
60 |
|
|
61 // XXX FIXME XXX |
|
|
62 #undef __FUNCTION_DEF |
|
|
63 #include <readline/tilde.h> |
|
679
|
64 |
|
|
65 #define boolean kpathsea_boolean |
|
|
66 #define false kpathsea_false |
|
|
67 #define true kpathsea_true |
|
|
68 #include <kpathsea/pathsearch.h> |
|
529
|
69 } |
|
1
|
70 |
|
|
71 static help_list operators[] = |
|
|
72 { |
|
|
73 { "!", |
|
|
74 "Logical not operator. See also `~'.\n", }, |
|
|
75 |
|
|
76 { "!=", |
|
|
77 "Logical not equals operator. See also `~' and `<>'.\n", }, |
|
|
78 |
|
|
79 { "\"", |
|
|
80 "String delimiter.\n", }, |
|
|
81 |
|
|
82 { "#", |
|
928
|
83 "Begin comment character. See also `%'.", }, |
|
1
|
84 |
|
|
85 { "%", |
|
928
|
86 "Begin comment charcter. See also `#'.", }, |
|
1
|
87 |
|
|
88 { "&", |
|
928
|
89 "Logical and operator. See also `&&'.", }, |
|
1
|
90 |
|
|
91 { "&&", |
|
928
|
92 "Logical and operator. See also `&'.", }, |
|
1
|
93 |
|
|
94 { "'", |
|
|
95 "Matrix transpose operator. For complex matrices, computes the\n\ |
|
|
96 complex conjugate (Hermitian) transpose. See also `.''\n\ |
|
|
97 \n\ |
|
|
98 The single quote character may also be used to delimit strings, but\n\ |
|
|
99 it is better to use the double quote character, since that is never\n\ |
|
928
|
100 ambiguous", }, |
|
1
|
101 |
|
|
102 { "(", |
|
928
|
103 "Array index or function argument delimiter.", }, |
|
1
|
104 |
|
|
105 { ")", |
|
928
|
106 "Array index or function argument delimiter.", }, |
|
1
|
107 |
|
|
108 { "*", |
|
928
|
109 "Multiplication operator. See also `.*'", }, |
|
1
|
110 |
|
|
111 { "**", |
|
928
|
112 "Power operator. See also `^', `.**', and `.^'", }, |
|
1
|
113 |
|
|
114 { "+", |
|
928
|
115 "Addition operator.", }, |
|
1
|
116 |
|
|
117 { "++", |
|
928
|
118 "Increment operator. As in C, may be applied as a prefix or postfix operator.", }, |
|
1
|
119 |
|
|
120 { ",", |
|
928
|
121 "Array index, function argument, or command separator.", }, |
|
1
|
122 |
|
|
123 { "-", |
|
928
|
124 "Subtraction or unary negation operator.", }, |
|
1
|
125 |
|
|
126 { "--", |
|
928
|
127 "Decrement operator. As in C, may be applied as a prefix or postfix operator.", }, |
|
1
|
128 |
|
|
129 { ".'", |
|
|
130 "Matrix transpose operator. For complex matrices, computes the\n\ |
|
928
|
131 transpose, *not* the complex conjugate transpose. See also `''.", }, |
|
1
|
132 |
|
|
133 { ".*", |
|
928
|
134 "Element by element multiplication operator. See also `*'.", }, |
|
1
|
135 |
|
|
136 { ".**", |
|
928
|
137 "Element by element power operator. See also `**', `^', and `.^'.", }, |
|
1
|
138 |
|
|
139 { "./", |
|
928
|
140 "Element by element division operator. See also `/' and `\\'.", }, |
|
1
|
141 |
|
|
142 { ".^", |
|
928
|
143 "Element by element power operator. See also `**', `^', and `.^'.", }, |
|
1
|
144 |
|
|
145 { "/", |
|
928
|
146 "Right division. See also `\\' and `./'.", }, |
|
1
|
147 |
|
|
148 { ":", |
|
928
|
149 "Select entire rows or columns of matrices.", }, |
|
1
|
150 |
|
|
151 { ";", |
|
928
|
152 "Array row or command separator. See also `,'.", }, |
|
1
|
153 |
|
|
154 { "<", |
|
928
|
155 "Less than operator.", }, |
|
1
|
156 |
|
|
157 { "<=", |
|
928
|
158 "Less than or equals operator.", }, |
|
1
|
159 |
|
|
160 { "<>", |
|
928
|
161 "Logical not equals operator. See also `!=' and `~='.", }, |
|
1
|
162 |
|
|
163 { "=", |
|
928
|
164 "Assignment operator.", }, |
|
1
|
165 |
|
|
166 { "==", |
|
928
|
167 "Equality test operator.", }, |
|
1
|
168 |
|
|
169 { ">", |
|
928
|
170 "Greater than operator.", }, |
|
1
|
171 |
|
|
172 { ">=", |
|
928
|
173 "Greater than or equals operator.", }, |
|
1
|
174 |
|
|
175 { "[", |
|
928
|
176 "Return list delimiter. See also `]'.", }, |
|
1
|
177 |
|
|
178 { "\\", |
|
928
|
179 "Left division operator. See also `/' and `./'.", }, |
|
1
|
180 |
|
|
181 { "]", |
|
928
|
182 "Return list delimiter. See also `['.", }, |
|
1
|
183 |
|
|
184 { "^", |
|
928
|
185 "Power operator. See also `**', `.^', and `.**.'", }, |
|
1
|
186 |
|
|
187 { "|", |
|
928
|
188 "Logical or operator. See also `||'.", }, |
|
1
|
189 |
|
|
190 { "||", |
|
928
|
191 "Logical or operator. See also `|'.", }, |
|
1
|
192 |
|
|
193 { "~", |
|
928
|
194 "Logical not operator. See also `!' and `~'.", }, |
|
1
|
195 |
|
|
196 { "~=", |
|
928
|
197 "Logical not equals operator. See also `<>' and `!='.", }, |
|
1
|
198 |
|
529
|
199 { 0, 0, }, |
|
1
|
200 }; |
|
|
201 |
|
|
202 static help_list keywords[] = |
|
|
203 { |
|
928
|
204 { "all_va_args", |
|
|
205 "Pass all unnamed arguments to another function call.", }, |
|
|
206 |
|
1
|
207 { "break", |
|
928
|
208 "Exit the innermost enclosing while or for loop.", }, |
|
1
|
209 |
|
|
210 { "continue", |
|
928
|
211 "Jump to the end of the innermost enclosing while or for loop.", }, |
|
1
|
212 |
|
|
213 { "else", |
|
928
|
214 "Alternate action for an if block.", }, |
|
1
|
215 |
|
|
216 { "elseif", |
|
928
|
217 "Alternate conditional test for an if block.", }, |
|
1
|
218 |
|
|
219 { "end", |
|
928
|
220 "Mark the end of any for, if, while, or function block.", }, |
|
|
221 |
|
|
222 { "end_unwind_protect", |
|
|
223 "Mark the end of an unwind_protect block.", }, |
|
1
|
224 |
|
|
225 { "endfor", |
|
928
|
226 "Mark the end of a for loop.", }, |
|
1
|
227 |
|
|
228 { "endfunction", |
|
928
|
229 "Mark the end of a function.", }, |
|
1
|
230 |
|
|
231 { "endif", |
|
928
|
232 "Mark the end of an if block.", }, |
|
1
|
233 |
|
|
234 { "endwhile", |
|
928
|
235 "Mark the end of a while loop.", }, |
|
1
|
236 |
|
|
237 { "for", |
|
928
|
238 "Begin a for loop.", }, |
|
1
|
239 |
|
|
240 { "function", |
|
928
|
241 "Begin a function body.", }, |
|
1
|
242 |
|
|
243 { "global", |
|
928
|
244 "Declare variables to have global scope.", }, |
|
1
|
245 |
|
|
246 { "gplot", |
|
928
|
247 "Produce 2-D plots using gnuplot-like command syntax.", }, |
|
1
|
248 |
|
|
249 { "gsplot", |
|
928
|
250 "Produce 3-D plots using gnuplot-like command syntax.", }, |
|
1
|
251 |
|
|
252 { "if", |
|
928
|
253 "Begin an if block.", }, |
|
1
|
254 |
|
|
255 { "return", |
|
928
|
256 "Return from a function.", }, |
|
|
257 |
|
|
258 { "unwind_protect", |
|
|
259 "Begin an unwind_protect block.", }, |
|
|
260 |
|
|
261 { "unwind_protect_cleanup", |
|
|
262 "Begin the cleanup section of an unwind_protect block.", }, |
|
1
|
263 |
|
|
264 { "while", |
|
928
|
265 "Begin a while loop.", }, |
|
1
|
266 |
|
529
|
267 { 0, 0, }, |
|
1
|
268 }; |
|
|
269 |
|
581
|
270 // Return a copy of the operator or keyword names. |
|
|
271 |
|
1
|
272 char ** |
|
|
273 names (help_list *lst, int& count) |
|
|
274 { |
|
|
275 count = 0; |
|
|
276 help_list *ptr = lst; |
|
529
|
277 while (ptr->name) |
|
1
|
278 { |
|
|
279 count++; |
|
|
280 ptr++; |
|
|
281 } |
|
|
282 |
|
|
283 if (count == 0) |
|
529
|
284 return 0; |
|
1
|
285 |
|
|
286 char **name_list = new char * [count+1]; |
|
|
287 |
|
|
288 ptr = lst; |
|
|
289 int i = 0; |
|
529
|
290 while (ptr->name) |
|
1
|
291 { |
|
242
|
292 name_list[i++] = strsave (ptr->name); |
|
1
|
293 ptr++; |
|
|
294 } |
|
|
295 |
|
529
|
296 name_list[i] = 0; |
|
1
|
297 return name_list; |
|
|
298 } |
|
|
299 |
|
|
300 help_list * |
|
|
301 operator_help (void) |
|
|
302 { |
|
|
303 return operators; |
|
|
304 } |
|
|
305 |
|
|
306 help_list * |
|
|
307 keyword_help (void) |
|
|
308 { |
|
|
309 return keywords; |
|
|
310 } |
|
|
311 |
|
1115
|
312 #define VERBOSE_HELP_MESSAGE \ |
|
|
313 "\n\ |
|
|
314 Additional help for builtin functions, operators, and variables\n\ |
|
|
315 is available in the on-line version of the manual.\n\ |
|
|
316 \n\ |
|
|
317 Use the command `help -i <topic>' to search the manual index.\n" |
|
|
318 |
|
|
319 static void |
|
|
320 additional_help_message (ostrstream& output_buf, int force = 0) |
|
542
|
321 { |
|
1115
|
322 if (! (user_pref.suppress_verbose_help_message || force)) |
|
|
323 output_buf << VERBOSE_HELP_MESSAGE; |
|
542
|
324 } |
|
|
325 |
|
|
326 void |
|
|
327 print_usage (const char *string, int just_usage) |
|
|
328 { |
|
|
329 ostrstream output_buf; |
|
|
330 |
|
|
331 symbol_record *sym_rec = global_sym_tab->lookup (string, 0, 0); |
|
|
332 if (sym_rec) |
|
|
333 { |
|
|
334 char *h = sym_rec->help (); |
|
|
335 if (h && *h) |
|
|
336 { |
|
|
337 output_buf << "\n*** " << string << ":\n\n" |
|
|
338 << h << "\n"; |
|
|
339 |
|
1115
|
340 additional_help_message (output_buf, !just_usage); |
|
542
|
341 output_buf << ends; |
|
|
342 maybe_page_output (output_buf); |
|
|
343 } |
|
|
344 } |
|
1023
|
345 else |
|
|
346 warning ("no usage message found for `%s'", string); |
|
542
|
347 } |
|
|
348 |
|
529
|
349 static void |
|
542
|
350 display_names_from_help_list (ostrstream& output_buf, help_list *list, |
|
|
351 const char *desc) |
|
529
|
352 { |
|
|
353 int count = 0; |
|
|
354 char **symbols = names (list, count); |
|
|
355 output_buf << "\n*** " << desc << ":\n\n"; |
|
|
356 if (symbols && count > 0) |
|
|
357 list_in_columns (output_buf, symbols); |
|
|
358 delete [] symbols; |
|
|
359 } |
|
|
360 |
|
742
|
361 static char * |
|
|
362 print_symbol_type (ostrstream& output_buf, symbol_record *sym_rec, |
|
|
363 char *name, int print) |
|
|
364 { |
|
|
365 char *retval = 0; |
|
|
366 |
|
|
367 if (sym_rec->is_user_function ()) |
|
|
368 { |
|
|
369 tree_fvc *defn = sym_rec->def (); |
|
|
370 char *fn = defn->fcn_file_name (); |
|
|
371 if (fn) |
|
|
372 { |
|
|
373 char *ff = fcn_file_in_path (fn); |
|
|
374 ff = ff ? ff : fn; |
|
|
375 |
|
|
376 if (print) |
|
|
377 output_buf << name |
|
|
378 << " is the function defined from:\n" |
|
|
379 << ff << "\n"; |
|
|
380 else |
|
|
381 retval = ff; |
|
|
382 } |
|
|
383 else |
|
|
384 { |
|
|
385 if (print) |
|
|
386 output_buf << name << " is a user-defined function\n"; |
|
|
387 else |
|
|
388 retval = "user-defined function"; |
|
|
389 } |
|
|
390 } |
|
|
391 else if (sym_rec->is_text_function ()) |
|
|
392 { |
|
|
393 if (print) |
|
|
394 output_buf << name << " is a builtin text-function\n"; |
|
|
395 else |
|
|
396 retval = "builtin text-function"; |
|
|
397 } |
|
|
398 else if (sym_rec->is_builtin_function ()) |
|
|
399 { |
|
|
400 if (print) |
|
|
401 output_buf << name << " is a builtin function\n"; |
|
|
402 else |
|
|
403 retval = "builtin function"; |
|
|
404 } |
|
|
405 else if (sym_rec->is_user_variable ()) |
|
|
406 { |
|
|
407 if (print) |
|
|
408 output_buf << name << " is a user-defined variable\n"; |
|
|
409 else |
|
|
410 retval = "user-defined variable"; |
|
|
411 } |
|
|
412 else if (sym_rec->is_builtin_variable ()) |
|
|
413 { |
|
|
414 if (print) |
|
|
415 output_buf << name << " is a builtin variable\n"; |
|
|
416 else |
|
|
417 retval = "builtin variable"; |
|
|
418 } |
|
|
419 else |
|
|
420 { |
|
|
421 if (print) |
|
|
422 output_buf << "which: `" << name |
|
|
423 << "' has unknown type\n"; |
|
|
424 else |
|
|
425 retval = "unknown type"; |
|
|
426 } |
|
|
427 |
|
|
428 return retval; |
|
|
429 } |
|
|
430 |
|
529
|
431 static void |
|
542
|
432 display_symtab_names (ostrstream& output_buf, char **names, |
|
|
433 int count, const char *desc) |
|
|
434 { |
|
|
435 output_buf << "\n*** " << desc << ":\n\n"; |
|
|
436 if (names && count > 0) |
|
|
437 list_in_columns (output_buf, names); |
|
|
438 } |
|
|
439 |
|
|
440 static void |
|
529
|
441 simple_help (void) |
|
|
442 { |
|
|
443 ostrstream output_buf; |
|
|
444 |
|
542
|
445 display_names_from_help_list (output_buf, operator_help (), |
|
|
446 "operators"); |
|
529
|
447 |
|
542
|
448 display_names_from_help_list (output_buf, keyword_help (), |
|
|
449 "reserved words"); |
|
529
|
450 |
|
542
|
451 #ifdef LIST_SYMBOLS |
|
|
452 #undef LIST_SYMBOLS |
|
|
453 #endif |
|
|
454 #define LIST_SYMBOLS(type, msg) \ |
|
|
455 do \ |
|
|
456 { \ |
|
|
457 int count; \ |
|
867
|
458 char **names = global_sym_tab->list (count, 0, 0, 1, type); \ |
|
542
|
459 display_symtab_names (output_buf, names, count, msg); \ |
|
|
460 char **ptr = names; \ |
|
|
461 while (*ptr) \ |
|
|
462 delete [] *ptr++; \ |
|
|
463 delete [] names; \ |
|
|
464 } \ |
|
|
465 while (0) |
|
529
|
466 |
|
542
|
467 // XXX FIXME XXX -- is this distinction needed? |
|
|
468 LIST_SYMBOLS (symbol_def::TEXT_FUNCTION, |
|
|
469 "text functions (these names are also reserved)"); |
|
529
|
470 |
|
542
|
471 LIST_SYMBOLS (symbol_def::MAPPER_FUNCTION, "mapper functions"); |
|
|
472 |
|
|
473 LIST_SYMBOLS (symbol_def::BUILTIN_FUNCTION, "general functions"); |
|
|
474 |
|
|
475 LIST_SYMBOLS (symbol_def::BUILTIN_VARIABLE, "builtin variables"); |
|
|
476 |
|
529
|
477 // Also need to list variables and currently compiled functions from |
|
|
478 // the symbol table, if there are any. |
|
|
479 |
|
|
480 // Also need to search octave_path for script files. |
|
|
481 |
|
679
|
482 char *path_elt = kpse_path_element (user_pref.loadpath); |
|
529
|
483 |
|
679
|
484 while (path_elt) |
|
529
|
485 { |
|
679
|
486 str_llist_type *elt_dirs = kpse_element_dirs (path_elt); |
|
|
487 |
|
|
488 str_llist_elt_type *dir; |
|
|
489 for (dir = *elt_dirs; dir; dir = STR_LLIST_NEXT (*dir)) |
|
529
|
490 { |
|
679
|
491 char *elt_dir = STR_LLIST (*dir); |
|
|
492 |
|
|
493 if (elt_dir) |
|
|
494 { |
|
|
495 int count; |
|
|
496 char **names = get_fcn_file_names (count, elt_dir, 0); |
|
|
497 |
|
|
498 output_buf << "\n*** function files in " |
|
|
499 << make_absolute (elt_dir, the_current_working_directory) |
|
|
500 << ":\n\n"; |
|
|
501 |
|
|
502 if (names && count > 0) |
|
|
503 list_in_columns (output_buf, names); |
|
|
504 |
|
|
505 delete [] names; |
|
|
506 } |
|
529
|
507 } |
|
679
|
508 path_elt = kpse_path_element (0); |
|
529
|
509 } |
|
|
510 |
|
|
511 additional_help_message (output_buf); |
|
|
512 output_buf << ends; |
|
|
513 maybe_page_output (output_buf); |
|
|
514 } |
|
|
515 |
|
|
516 static int |
|
|
517 try_info (const char *string, int force = 0) |
|
|
518 { |
|
|
519 int status = 0; |
|
|
520 |
|
|
521 char *directory_name = strsave (user_pref.info_file); |
|
|
522 char *temp = filename_non_directory (directory_name); |
|
|
523 |
|
|
524 if (temp != directory_name) |
|
|
525 { |
|
|
526 *temp = 0; |
|
|
527 info_add_path (directory_name, INFOPATH_PREPEND); |
|
|
528 } |
|
|
529 |
|
|
530 delete [] directory_name; |
|
|
531 |
|
|
532 NODE *initial_node = info_get_node (user_pref.info_file, 0); |
|
|
533 |
|
|
534 if (! initial_node) |
|
|
535 { |
|
|
536 warning ("can't find info file!\n"); |
|
|
537 status = -1; |
|
|
538 } |
|
|
539 else |
|
|
540 { |
|
|
541 status = initialize_info_session (initial_node, 0); |
|
|
542 |
|
|
543 if (status == 0 && (force || index_entry_exists (windows, string))) |
|
|
544 { |
|
|
545 terminal_clear_screen (); |
|
|
546 |
|
|
547 terminal_prep_terminal (); |
|
|
548 |
|
|
549 display_update_display (windows); |
|
|
550 |
|
|
551 info_last_executed_command = 0; |
|
|
552 |
|
|
553 if (! force) |
|
|
554 do_info_index_search (windows, 0, string); |
|
|
555 |
|
|
556 char *format = replace_in_documentation |
|
|
557 ("Type \"\\[quit]\" to quit, \"\\[get-help-window]\" for help."); |
|
|
558 |
|
|
559 window_message_in_echo_area (format); |
|
|
560 |
|
|
561 info_read_and_dispatch (); |
|
|
562 |
|
|
563 terminal_goto_xy (0, screenheight - 1); |
|
|
564 |
|
|
565 terminal_clear_to_eol (); |
|
|
566 |
|
|
567 terminal_unprep_terminal (); |
|
|
568 |
|
|
569 status = 1; |
|
|
570 } |
|
|
571 |
|
|
572 finish_info_session (initial_node, 0); |
|
|
573 } |
|
|
574 |
|
|
575 return status; |
|
|
576 } |
|
|
577 |
|
542
|
578 int |
|
|
579 help_from_list (ostrstream& output_buf, const help_list *list, |
|
|
580 const char *string, int usage) |
|
|
581 { |
|
|
582 char *name; |
|
|
583 while ((name = list->name) != 0) |
|
|
584 { |
|
|
585 if (strcmp (name, string) == 0) |
|
|
586 { |
|
|
587 if (usage) |
|
|
588 output_buf << "\nusage: "; |
|
|
589 else |
|
|
590 { |
|
|
591 output_buf << "\n*** " << string << ":\n\n"; |
|
|
592 } |
|
|
593 |
|
|
594 output_buf << list->help << "\n"; |
|
|
595 |
|
|
596 return 1; |
|
|
597 } |
|
|
598 list++; |
|
|
599 } |
|
|
600 return 0; |
|
|
601 } |
|
|
602 |
|
529
|
603 DEFUN_TEXT ("help", Fhelp, Shelp, -1, 1, |
|
|
604 "help [-i] [topic ...]\n\ |
|
|
605 \n\ |
|
|
606 print cryptic yet witty messages") |
|
|
607 { |
|
|
608 Octave_object retval; |
|
|
609 |
|
|
610 DEFINE_ARGV("help"); |
|
|
611 |
|
|
612 if (argc == 1) |
|
|
613 { |
|
|
614 simple_help (); |
|
|
615 } |
|
|
616 else |
|
|
617 { |
|
|
618 if (argv[1] && strcmp (argv[1], "-i") == 0) |
|
|
619 { |
|
|
620 argc--; |
|
|
621 argv++; |
|
|
622 |
|
|
623 if (argc == 1) |
|
|
624 { |
|
|
625 volatile sig_handler *old_sigint_handler; |
|
654
|
626 old_sigint_handler = signal (SIGINT, SIG_IGN); |
|
529
|
627 |
|
|
628 try_info (0, 1); |
|
|
629 |
|
|
630 signal (SIGINT, old_sigint_handler); |
|
|
631 } |
|
|
632 else |
|
|
633 { |
|
|
634 while (--argc > 0) |
|
|
635 { |
|
|
636 argv++; |
|
|
637 |
|
|
638 if (! *argv || ! **argv) |
|
|
639 continue; |
|
|
640 |
|
|
641 volatile sig_handler *old_sigint_handler; |
|
|
642 old_sigint_handler = signal (SIGINT, SIG_IGN); |
|
|
643 |
|
|
644 if (! try_info (*argv)) |
|
|
645 { |
|
|
646 message ("help", |
|
|
647 "sorry, `%s' is not indexed in the manual", |
|
|
648 *argv); |
|
|
649 sleep (2); |
|
|
650 } |
|
|
651 |
|
|
652 signal (SIGINT, old_sigint_handler); |
|
|
653 } |
|
|
654 } |
|
|
655 } |
|
|
656 else |
|
|
657 { |
|
|
658 ostrstream output_buf; |
|
|
659 |
|
|
660 help_list *op_help_list = operator_help (); |
|
|
661 help_list *kw_help_list = keyword_help (); |
|
|
662 |
|
|
663 while (--argc > 0) |
|
|
664 { |
|
|
665 argv++; |
|
|
666 |
|
|
667 if (! *argv || ! **argv) |
|
|
668 continue; |
|
|
669 |
|
|
670 if (help_from_list (output_buf, op_help_list, *argv, 0)) |
|
|
671 continue; |
|
|
672 |
|
|
673 if (help_from_list (output_buf, kw_help_list, *argv, 0)) |
|
|
674 continue; |
|
|
675 |
|
962
|
676 symbol_record *sym_rec = lookup_by_name (*argv, 0); |
|
581
|
677 |
|
991
|
678 if (sym_rec && sym_rec->is_defined ()) |
|
529
|
679 { |
|
|
680 char *h = sym_rec->help (); |
|
|
681 if (h && *h) |
|
|
682 { |
|
742
|
683 print_symbol_type (output_buf, sym_rec, *argv, 1); |
|
|
684 output_buf << "\n" << h << "\n"; |
|
529
|
685 continue; |
|
|
686 } |
|
|
687 } |
|
|
688 |
|
993
|
689 char *path = fcn_file_in_path (*argv); |
|
|
690 char *h = get_help_from_file (path); |
|
991
|
691 if (h && *h) |
|
|
692 { |
|
993
|
693 output_buf << *argv << " is the file:\n" |
|
|
694 << path << "\n\n" << h << "\n"; |
|
991
|
695 delete [] h; |
|
993
|
696 delete [] path; |
|
991
|
697 continue; |
|
|
698 } |
|
993
|
699 delete [] path; |
|
991
|
700 |
|
529
|
701 output_buf << "\nhelp: sorry, `" << *argv |
|
581
|
702 << "' is not documented\n"; |
|
529
|
703 } |
|
|
704 |
|
|
705 additional_help_message (output_buf); |
|
|
706 output_buf << ends; |
|
|
707 maybe_page_output (output_buf); |
|
|
708 } |
|
|
709 } |
|
|
710 |
|
|
711 DELETE_ARGV; |
|
|
712 |
|
|
713 return retval; |
|
|
714 } |
|
|
715 |
|
581
|
716 DEFUN_TEXT ("type", Ftype, Stype, -1, 1, |
|
|
717 "type NAME ...]\n\ |
|
|
718 \n\ |
|
|
719 display the definition of each NAME that refers to a function") |
|
|
720 { |
|
|
721 Octave_object retval; |
|
|
722 |
|
|
723 DEFINE_ARGV("type"); |
|
|
724 |
|
|
725 if (argc > 1) |
|
|
726 { |
|
|
727 // XXX FIXME XXX -- we should really use getopt () |
|
|
728 int quiet = 0; |
|
|
729 if (argv[1] && strcmp (argv[1], "-q") == 0) |
|
|
730 { |
|
|
731 quiet = 1; |
|
|
732 argc--; |
|
|
733 argv++; |
|
|
734 } |
|
|
735 |
|
|
736 ostrstream output_buf; |
|
|
737 |
|
|
738 while (--argc > 0) |
|
|
739 { |
|
|
740 argv++; |
|
|
741 |
|
|
742 if (! *argv || ! **argv) |
|
|
743 continue; |
|
|
744 |
|
962
|
745 symbol_record *sym_rec = lookup_by_name (*argv, 0); |
|
581
|
746 |
|
|
747 if (sym_rec) |
|
|
748 { |
|
|
749 if (sym_rec->is_user_function ()) |
|
|
750 { |
|
|
751 tree_fvc *defn = sym_rec->def (); |
|
|
752 |
|
|
753 if (nargout == 0 && ! quiet) |
|
|
754 output_buf << *argv << " is a user-defined function\n"; |
|
|
755 |
|
|
756 defn->print_code (output_buf); |
|
|
757 } |
|
|
758 |
|
|
759 // XXX FIXME XXX -- this code should be shared with Fwhich |
|
|
760 |
|
|
761 else if (sym_rec->is_text_function ()) |
|
|
762 output_buf << *argv << " is a builtin text-function\n"; |
|
|
763 else if (sym_rec->is_builtin_function ()) |
|
|
764 output_buf << *argv << " is a builtin function\n"; |
|
|
765 else if (sym_rec->is_user_variable ()) |
|
625
|
766 { |
|
|
767 tree_fvc *defn = sym_rec->def (); |
|
|
768 |
|
|
769 if (nargout == 0 && ! quiet) |
|
|
770 output_buf << *argv << " is a user-defined variable\n"; |
|
|
771 |
|
|
772 defn->print_code (output_buf); |
|
|
773 |
|
|
774 if (nargout == 0) |
|
|
775 output_buf << "\n"; |
|
|
776 } |
|
581
|
777 else if (sym_rec->is_builtin_variable ()) |
|
625
|
778 { |
|
|
779 tree_fvc *defn = sym_rec->def (); |
|
|
780 |
|
|
781 if (nargout == 0 && ! quiet) |
|
|
782 output_buf << *argv << " is a builtin variable\n"; |
|
|
783 |
|
|
784 defn->print_code (output_buf); |
|
|
785 |
|
|
786 if (nargout == 0) |
|
|
787 output_buf << "\n"; |
|
|
788 } |
|
581
|
789 else |
|
|
790 output_buf << "type: `" << *argv << "' has unknown type!\n"; |
|
|
791 } |
|
|
792 else |
|
|
793 output_buf << "type: `" << *argv << "' undefined\n"; |
|
|
794 } |
|
|
795 |
|
|
796 output_buf << ends; |
|
|
797 |
|
|
798 if (nargout == 0) |
|
|
799 maybe_page_output (output_buf); |
|
|
800 else |
|
|
801 { |
|
|
802 char *s = output_buf.str (); |
|
|
803 retval = s; |
|
|
804 delete s; |
|
|
805 } |
|
|
806 } |
|
|
807 else |
|
|
808 print_usage ("type"); |
|
|
809 |
|
|
810 DELETE_ARGV; |
|
|
811 |
|
|
812 return retval; |
|
|
813 } |
|
|
814 |
|
|
815 DEFUN_TEXT ("which", Fwhich, Swhich, -1, 1, |
|
|
816 "which NAME ...]\n\ |
|
|
817 \n\ |
|
|
818 display the type of each NAME. If NAME is defined from an function\n\ |
|
|
819 file, print the full name of the file.") |
|
|
820 { |
|
|
821 Octave_object retval; |
|
|
822 |
|
|
823 DEFINE_ARGV("which"); |
|
|
824 |
|
|
825 if (argc > 1) |
|
|
826 { |
|
|
827 if (nargout > 0) |
|
|
828 retval.resize (argc-1, Matrix ()); |
|
|
829 |
|
|
830 ostrstream output_buf; |
|
|
831 |
|
|
832 for (int i = 0; i < argc-1; i++) |
|
|
833 { |
|
|
834 argv++; |
|
|
835 |
|
|
836 if (! *argv || ! **argv) |
|
|
837 continue; |
|
|
838 |
|
962
|
839 symbol_record *sym_rec = lookup_by_name (*argv, 0); |
|
581
|
840 |
|
|
841 if (sym_rec) |
|
|
842 { |
|
742
|
843 int print = (nargout == 0); |
|
|
844 char *tmp = print_symbol_type (output_buf, sym_rec, |
|
|
845 *argv, print); |
|
|
846 if (! print) |
|
|
847 retval(i) = tmp; |
|
581
|
848 } |
|
|
849 else |
|
|
850 { |
|
|
851 if (nargout == 0) |
|
|
852 output_buf << "which: `" << *argv << "' is undefined\n"; |
|
|
853 else |
|
|
854 retval(i) = "undefined"; |
|
|
855 } |
|
|
856 } |
|
|
857 output_buf << ends; |
|
|
858 maybe_page_output (output_buf); |
|
|
859 } |
|
|
860 else |
|
|
861 print_usage ("which"); |
|
|
862 |
|
|
863 DELETE_ARGV; |
|
|
864 |
|
|
865 return retval; |
|
|
866 } |
|
|
867 |
|
1
|
868 /* |
|
|
869 ;;; Local Variables: *** |
|
|
870 ;;; mode: C++ *** |
|
|
871 ;;; page-delimiter: "^/\\*" *** |
|
|
872 ;;; End: *** |
|
|
873 */ |
