Mercurial > octave-nkf

annotate scripts/gethelp.cc @ 10553:f88e3d5d88e2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
avoid GCC warnings
author John W. Eaton <jwe@octave.org>
date Fri, 23 Apr 2010 15:57:32 -0400
parents bc59bc6282a0
children 1dfbcc9eee92
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6528
diff changeset
1 /*
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6528
diff changeset
2
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 8521
diff changeset
3 Copyright (C) 1999, 2000, 2003, 2007, 2008, 2009 John W. Eaton
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6528
diff changeset
4
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6528
diff changeset
5 This file is part of Octave.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6528
diff changeset
6
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6528
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6528
diff changeset
8 under the terms of the GNU General Public License as published by the
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6528
diff changeset
9 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6528
diff changeset
10 option) any later version.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6528
diff changeset
11
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6528
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6528
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6528
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6528
diff changeset
15 for more details.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6528
diff changeset
16
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6528
diff changeset
17 You should have received a copy of the GNU General Public License
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6528
diff changeset
18 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6528
diff changeset
19 <http://www.gnu.org/licenses/>.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6528
diff changeset
20
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6528
diff changeset
21 */
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6528
diff changeset
22
4279
64c444ac1fee [project @ 2003-01-04 01:10:25 by jwe]
jwe
parents: 3576
diff changeset
23 #if defined (__DECCXX)
64c444ac1fee [project @ 2003-01-04 01:10:25 by jwe]
jwe
parents: 3576
diff changeset
24 #define __USE_STD_IOSTREAM
64c444ac1fee [project @ 2003-01-04 01:10:25 by jwe]
jwe
parents: 3576
diff changeset
25 #endif
64c444ac1fee [project @ 2003-01-04 01:10:25 by jwe]
jwe
parents: 3576
diff changeset
26
8521
93cf10950334 tmpdir=tmpnam;
Rafael Laboissiere <rafael@debian.org>
parents: 8019
diff changeset
27 #include <cstdio>
93cf10950334 tmpdir=tmpnam;
Rafael Laboissiere <rafael@debian.org>
parents: 8019
diff changeset
28
93cf10950334 tmpdir=tmpnam;
Rafael Laboissiere <rafael@debian.org>
parents: 8019
diff changeset
29 #include <iostream>
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
30 #include <string>
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
31
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
32 static bool
3575
7576a76f6d7b [project @ 2000-02-04 11:02:49 by jwe]
jwe
parents: 3427
diff changeset
33 looks_like_octave_copyright (const std::string& s)
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
34 {
6528
b3e973d63c1c [project @ 2007-04-16 17:13:08 by jwe]
jwe
parents: 4279
diff changeset
35 // Perhaps someday we will want to do more here, so leave this as a
b3e973d63c1c [project @ 2007-04-16 17:13:08 by jwe]
jwe
parents: 4279
diff changeset
36 // separate function.
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
37
6528
b3e973d63c1c [project @ 2007-04-16 17:13:08 by jwe]
jwe
parents: 4279
diff changeset
38 return (s.substr (0, 9) == "Copyright");
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
39 }
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
40
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
41 // Eat whitespace and comments from FFILE, returning the text of the
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
42 // first block of comments that doesn't look like a copyright notice,
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
43
3575
7576a76f6d7b [project @ 2000-02-04 11:02:49 by jwe]
jwe
parents: 3427
diff changeset
44 static std::string
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
45 extract_help_text (void)
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
46 {
3575
7576a76f6d7b [project @ 2000-02-04 11:02:49 by jwe]
jwe
parents: 3427
diff changeset
47 std::string help_txt;
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
48
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
49 bool first_comments_seen = false;
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
50 bool begin_comment = false;
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
51 bool have_help_text = false;
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
52 bool in_comment = false;
3427
e098ebb77023 [project @ 2000-01-13 09:25:53 by jwe]
jwe
parents: 3295
diff changeset
53 bool discard_space = true;
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
54 int c;
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
55
3575
7576a76f6d7b [project @ 2000-02-04 11:02:49 by jwe]
jwe
parents: 3427
diff changeset
56 while ((c = std::cin.get ()) != EOF)
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
57 {
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
58 if (begin_comment)
10163
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
59 {
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
60 if (c == '%' || c == '#')
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
61 continue;
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
62 else if (discard_space && c == ' ')
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
63 {
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
64 discard_space = false;
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
65 continue;
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
66 }
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
67 else
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
68 begin_comment = false;
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
69 }
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
70
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
71 if (in_comment)
10163
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
72 {
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
73 if (! have_help_text)
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
74 {
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
75 first_comments_seen = true;
10553
f88e3d5d88e2 avoid GCC warnings
John W. Eaton <jwe@octave.org>
parents: 10165
diff changeset
76 help_txt += static_cast<char> (c);
10163
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
77 }
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
78
10163
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
79 if (c == '\n')
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
80 {
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
81 in_comment = false;
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
82 discard_space = true;
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
83
10163
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
84 if ((c = std::cin.get ()) != EOF)
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
85 {
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
86 if (c == '\n')
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
87 break;
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
88 }
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
89 else
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
90 break;
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
91 }
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
92 }
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
93 else
10163
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
94 {
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
95 switch (c)
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
96 {
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
97 case ' ':
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
98 case '\t':
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
99 if (first_comments_seen)
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
100 have_help_text = true;
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
101 break;
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
102
10163
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
103 case '\n':
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
104 if (first_comments_seen)
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
105 have_help_text = true;
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
106 continue;
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
107
10163
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
108 case '%':
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
109 case '#':
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
110 begin_comment = true;
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
111 in_comment = true;
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
112 break;
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
113
10163
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
114 default:
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
115 goto done;
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
116 }
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
117 }
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
118 }
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
119
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
120 done:
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
121
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
122 if (! help_txt.empty ())
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
123 {
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
124 if (looks_like_octave_copyright (help_txt))
10163
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
125 help_txt.resize (0);
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
126
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
127 if (help_txt.empty ())
10163
a822560a3ce3 scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
128 help_txt = extract_help_text ();
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
129 }
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
130
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
131 return help_txt;
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
132 }
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
133
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
134 int
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
135 main (int argc, char **argv)
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
136 {
3575
7576a76f6d7b [project @ 2000-02-04 11:02:49 by jwe]
jwe
parents: 3427
diff changeset
137 std::string name;
9014
71fca0fc2436 save source file names for functions as comments in .texi files
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
138 std::string file_name;
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
139
9014
71fca0fc2436 save source file names for functions as comments in .texi files
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
140 if (argc != 3)
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
141 {
9014
71fca0fc2436 save source file names for functions as comments in .texi files
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
142 std::cerr << "usage: gethelp name file-name\n";
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
143 return 1;
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
144 }
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
145 else
9014
71fca0fc2436 save source file names for functions as comments in .texi files
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
146 {
71fca0fc2436 save source file names for functions as comments in .texi files
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
147 name = argv[1];
71fca0fc2436 save source file names for functions as comments in .texi files
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
148 file_name = argv[2];
71fca0fc2436 save source file names for functions as comments in .texi files
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
149 }
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
150
3575
7576a76f6d7b [project @ 2000-02-04 11:02:49 by jwe]
jwe
parents: 3427
diff changeset
151 std::string help_text = extract_help_text ();
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
152
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
153 if (! help_text.empty ())
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
154 {
9014
71fca0fc2436 save source file names for functions as comments in .texi files
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
155 std::cout << "" << name << "\n"
10165
bc59bc6282a0 scripts/gethelp.cc: finish previous untabification
John W. Eaton <jwe@octave.org>
parents: 10163
diff changeset
156 << "@c " << file_name << "\n"
bc59bc6282a0 scripts/gethelp.cc: finish previous untabification
John W. Eaton <jwe@octave.org>
parents: 10163
diff changeset
157 << help_text;
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
158
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
159 if (help_text[help_text.length () - 1] != '\n')
10165
bc59bc6282a0 scripts/gethelp.cc: finish previous untabification
John W. Eaton <jwe@octave.org>
parents: 10163
diff changeset
160 std::cout << "\n";
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
161 }
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
162
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
163 return 0;
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
164 }