|
1
|
1 // help.h -*- 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 |
|
1315
|
20 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
|
1
|
21 |
|
|
22 */ |
|
|
23 |
|
383
|
24 #if !defined (octave_help_h) |
|
|
25 #define octave_help_h 1 |
|
1
|
26 |
|
542
|
27 class ostrstream; |
|
|
28 |
|
1755
|
29 #include <string> |
|
|
30 |
|
|
31 class string_vector; |
|
|
32 |
|
|
33 // XXX FIXME XXX -- should probably use string, not char*. |
|
|
34 |
|
|
35 struct help_list |
|
1
|
36 { |
|
|
37 char *name; |
|
|
38 char *help; |
|
|
39 }; |
|
|
40 |
|
1755
|
41 extern string_vector names (help_list *l, int& count); |
|
1
|
42 extern help_list *operator_help (void); |
|
|
43 extern help_list *keyword_help (void); |
|
|
44 |
|
1755
|
45 extern void print_usage (const string& nm, int just_usage = 0); |
|
|
46 |
|
542
|
47 extern int help_from_list (ostrstream& output_buf, |
|
1755
|
48 const help_list *list, const string& nm, |
|
542
|
49 int usage); |
|
|
50 |
|
1
|
51 #endif |
|
|
52 |
|
|
53 /* |
|
|
54 ;;; Local Variables: *** |
|
|
55 ;;; mode: C++ *** |
|
|
56 ;;; page-delimiter: "^/\\*" *** |
|
|
57 ;;; End: *** |
|
|
58 */ |
