Commit | Line | Data |
---|---|---|
f2cc4248 | 1 | /* Generate doc-string file for GNU Emacs from source files. |
acaf905b | 2 | Copyright (C) 1985-1986, 1992-1994, 1997, 1999-2012 |
a5b68355 | 3 | Free Software Foundation, Inc. |
f2cc4248 RS |
4 | |
5 | This file is part of GNU Emacs. | |
6 | ||
294981c7 | 7 | GNU Emacs is free software: you can redistribute it and/or modify |
93320c23 | 8 | it under the terms of the GNU General Public License as published by |
294981c7 GM |
9 | the Free Software Foundation, either version 3 of the License, or |
10 | (at your option) any later version. | |
93320c23 | 11 | |
f2cc4248 | 12 | GNU Emacs is distributed in the hope that it will be useful, |
93320c23 JA |
13 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | GNU General Public License for more details. | |
f2cc4248 | 16 | |
93320c23 | 17 | You should have received a copy of the GNU General Public License |
294981c7 GM |
18 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
19 | ||
f2cc4248 RS |
20 | |
21 | /* The arguments given to this program are all the C and Lisp source files | |
22 | of GNU Emacs. .elc and .el and .c files are allowed. | |
23 | A .o file can also be specified; the .c file it was made from is used. | |
24 | This helps the makefile pass the correct list of files. | |
08a39b83 | 25 | Option -d DIR means change to DIR before looking for files. |
f2cc4248 RS |
26 | |
27 | The results, which go to standard output or to a file | |
28 | specified with -a or -o (-a to append, -o to start from nothing), | |
29 | are entries containing function or variable names and their documentation. | |
30 | Each entry starts with a ^_ character. | |
31 | Then comes F for a function or V for a variable. | |
32 | Then comes the function or variable name, terminated with a newline. | |
33 | Then comes the documentation for that function or variable. | |
34 | */ | |
35 | ||
433d333d RS |
36 | #include <config.h> |
37 | ||
61b108cc | 38 | /* Defined to be emacs_main, sys_fopen, etc. in config.h. */ |
433d333d RS |
39 | #undef main |
40 | #undef fopen | |
41 | #undef chdir | |
34b4ece5 | 42 | |
f2cc4248 | 43 | #include <stdio.h> |
00b3c7ac | 44 | #include <stdlib.h> |
e3938952 RS |
45 | #ifdef MSDOS |
46 | #include <fcntl.h> | |
47 | #endif /* MSDOS */ | |
86b0513a | 48 | #ifdef WINDOWSNT |
86b0513a RS |
49 | #include <fcntl.h> |
50 | #include <direct.h> | |
51 | #endif /* WINDOWSNT */ | |
e3938952 | 52 | |
86b0513a | 53 | #ifdef DOS_NT |
e3938952 RS |
54 | #define READ_TEXT "rt" |
55 | #define READ_BINARY "rb" | |
86b0513a | 56 | #else /* not DOS_NT */ |
e3938952 RS |
57 | #define READ_TEXT "r" |
58 | #define READ_BINARY "r" | |
86b0513a | 59 | #endif /* not DOS_NT */ |
f2cc4248 | 60 | |
ef7c480d | 61 | #ifndef DIRECTORY_SEP |
ef7c480d | 62 | #define DIRECTORY_SEP '/' |
ef7c480d YM |
63 | #endif |
64 | ||
b09c5608 | 65 | #ifndef IS_DIRECTORY_SEP |
ef7c480d | 66 | #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP) |
b09c5608 EZ |
67 | #endif |
68 | ||
61b108cc | 69 | /* Use this to suppress gcc's `...may be used before initialized' warnings. */ |
8e48d7bc PE |
70 | #ifdef lint |
71 | # define IF_LINT(Code) Code | |
72 | #else | |
73 | # define IF_LINT(Code) /* empty */ | |
74 | #endif | |
75 | ||
b23b5a5b PE |
76 | static int scan_file (char *filename); |
77 | static int scan_lisp_file (const char *filename, const char *mode); | |
78 | static int scan_c_file (char *filename, const char *mode); | |
b23b5a5b PE |
79 | static void start_globals (void); |
80 | static void write_globals (void); | |
340ff9de | 81 | |
2d1985a2 KH |
82 | #ifdef MSDOS |
83 | /* s/msdos.h defines this as sys_chdir, but we're not linking with the | |
84 | file where that function is defined. */ | |
85 | #undef chdir | |
86 | #endif | |
87 | ||
a0613c61 | 88 | #include <unistd.h> |
a0613c61 | 89 | |
b5ff43cc | 90 | /* Stdio stream for output to the DOC file. */ |
f2cc4248 RS |
91 | FILE *outfile; |
92 | ||
b5ff43cc RS |
93 | /* Name this program was invoked with. */ |
94 | char *progname; | |
95 | ||
00b3c7ac TT |
96 | /* Nonzero if this invocation is generating globals.h. */ |
97 | int generate_globals; | |
98 | ||
fb2d3129 | 99 | /* Print error message. `s1' is printf control string, `s2' is arg for it. */ |
b5ff43cc RS |
100 | |
101 | /* VARARGS1 */ | |
b23b5a5b | 102 | static void |
988e88ab | 103 | error (const char *s1, const char *s2) |
b5ff43cc RS |
104 | { |
105 | fprintf (stderr, "%s: ", progname); | |
106 | fprintf (stderr, s1, s2); | |
107 | fprintf (stderr, "\n"); | |
108 | } | |
109 | ||
110 | /* Print error message and exit. */ | |
111 | ||
112 | /* VARARGS1 */ | |
845ca893 | 113 | static _Noreturn void |
988e88ab | 114 | fatal (const char *s1, const char *s2) |
b5ff43cc RS |
115 | { |
116 | error (s1, s2); | |
65396510 | 117 | exit (EXIT_FAILURE); |
b5ff43cc RS |
118 | } |
119 | ||
120 | /* Like malloc but get fatal error if memory is exhausted. */ | |
121 | ||
b23b5a5b | 122 | static void * |
873fbd0b | 123 | xmalloc (unsigned int size) |
b5ff43cc | 124 | { |
d5d66b7e | 125 | void *result = (void *) malloc (size); |
b5ff43cc RS |
126 | if (result == NULL) |
127 | fatal ("virtual memory exhausted", 0); | |
128 | return result; | |
129 | } | |
00b3c7ac TT |
130 | |
131 | /* Like realloc but get fatal error if memory is exhausted. */ | |
132 | ||
b23b5a5b | 133 | static void * |
00b3c7ac TT |
134 | xrealloc (void *arg, unsigned int size) |
135 | { | |
136 | void *result = (void *) realloc (arg, size); | |
137 | if (result == NULL) | |
138 | fatal ("virtual memory exhausted", 0); | |
139 | return result; | |
140 | } | |
141 | ||
b5ff43cc | 142 | \f |
340ff9de | 143 | int |
873fbd0b | 144 | main (int argc, char **argv) |
f2cc4248 RS |
145 | { |
146 | int i; | |
147 | int err_count = 0; | |
a27897c9 | 148 | int first_infile; |
f2cc4248 | 149 | |
b5ff43cc RS |
150 | progname = argv[0]; |
151 | ||
4e043ed3 RS |
152 | outfile = stdout; |
153 | ||
86b0513a | 154 | /* Don't put CRs in the DOC file. */ |
e3938952 | 155 | #ifdef MSDOS |
5281dea4 | 156 | _fmode = O_BINARY; |
4e043ed3 RS |
157 | #if 0 /* Suspicion is that this causes hanging. |
158 | So instead we require people to use -o on MSDOS. */ | |
e3938952 RS |
159 | (stdout)->_flag &= ~_IOTEXT; |
160 | _setmode (fileno (stdout), O_BINARY); | |
4e043ed3 RS |
161 | #endif |
162 | outfile = 0; | |
e3938952 | 163 | #endif /* MSDOS */ |
86b0513a RS |
164 | #ifdef WINDOWSNT |
165 | _fmode = O_BINARY; | |
166 | _setmode (fileno (stdout), O_BINARY); | |
167 | #endif /* WINDOWSNT */ | |
168 | ||
f2cc4248 RS |
169 | /* If first two args are -o FILE, output to FILE. */ |
170 | i = 1; | |
171 | if (argc > i + 1 && !strcmp (argv[i], "-o")) | |
172 | { | |
173 | outfile = fopen (argv[i + 1], "w"); | |
174 | i += 2; | |
175 | } | |
176 | if (argc > i + 1 && !strcmp (argv[i], "-a")) | |
177 | { | |
178 | outfile = fopen (argv[i + 1], "a"); | |
179 | i += 2; | |
180 | } | |
d2d92f7a JB |
181 | if (argc > i + 1 && !strcmp (argv[i], "-d")) |
182 | { | |
9055082e PE |
183 | if (chdir (argv[i + 1]) != 0) |
184 | { | |
185 | perror (argv[i + 1]); | |
186 | return EXIT_FAILURE; | |
187 | } | |
d2d92f7a JB |
188 | i += 2; |
189 | } | |
00b3c7ac TT |
190 | if (argc > i && !strcmp (argv[i], "-g")) |
191 | { | |
192 | generate_globals = 1; | |
193 | ++i; | |
194 | } | |
f2cc4248 | 195 | |
4e043ed3 RS |
196 | if (outfile == 0) |
197 | fatal ("No output file specified", ""); | |
198 | ||
00b3c7ac TT |
199 | if (generate_globals) |
200 | start_globals (); | |
201 | ||
a27897c9 | 202 | first_infile = i; |
f2cc4248 | 203 | for (; i < argc; i++) |
a27897c9 RS |
204 | { |
205 | int j; | |
206 | /* Don't process one file twice. */ | |
207 | for (j = first_infile; j < i; j++) | |
208 | if (! strcmp (argv[i], argv[j])) | |
209 | break; | |
210 | if (j == i) | |
211 | err_count += scan_file (argv[i]); | |
212 | } | |
00b3c7ac TT |
213 | |
214 | if (err_count == 0 && generate_globals) | |
215 | write_globals (); | |
216 | ||
08a39b83 | 217 | return (err_count > 0 ? EXIT_FAILURE : EXIT_SUCCESS); |
f2cc4248 RS |
218 | } |
219 | ||
d5d66b7e | 220 | /* Add a source file name boundary marker in the output file. */ |
b23b5a5b | 221 | static void |
873fbd0b | 222 | put_filename (char *filename) |
d5d66b7e | 223 | { |
b09c5608 EZ |
224 | char *tmp; |
225 | ||
226 | for (tmp = filename; *tmp; tmp++) | |
227 | { | |
61b108cc | 228 | if (IS_DIRECTORY_SEP (*tmp)) |
b09c5608 EZ |
229 | filename = tmp + 1; |
230 | } | |
d5d66b7e SM |
231 | |
232 | putc (037, outfile); | |
233 | putc ('S', outfile); | |
234 | fprintf (outfile, "%s\n", filename); | |
235 | } | |
236 | ||
a8a7afbe | 237 | /* Read file FILENAME and output its doc strings to outfile. */ |
f2cc4248 RS |
238 | /* Return 1 if file is not found, 0 if it is found. */ |
239 | ||
b23b5a5b | 240 | static int |
873fbd0b | 241 | scan_file (char *filename) |
f2cc4248 | 242 | { |
728a982d DN |
243 | |
244 | size_t len = strlen (filename); | |
d5d66b7e | 245 | |
00b3c7ac TT |
246 | if (!generate_globals) |
247 | put_filename (filename); | |
dc61cb9d | 248 | if (len > 4 && !strcmp (filename + len - 4, ".elc")) |
e3938952 | 249 | return scan_lisp_file (filename, READ_BINARY); |
dc61cb9d | 250 | else if (len > 3 && !strcmp (filename + len - 3, ".el")) |
e3938952 | 251 | return scan_lisp_file (filename, READ_TEXT); |
f2cc4248 | 252 | else |
e3938952 | 253 | return scan_c_file (filename, READ_TEXT); |
f2cc4248 | 254 | } |
00b3c7ac | 255 | |
b23b5a5b | 256 | static void |
00b3c7ac TT |
257 | start_globals (void) |
258 | { | |
259 | fprintf (outfile, "/* This file was auto-generated by make-docfile. */\n"); | |
260 | fprintf (outfile, "/* DO NOT EDIT. */\n"); | |
261 | fprintf (outfile, "struct emacs_globals {\n"); | |
262 | } | |
f2cc4248 | 263 | \f |
4df52042 | 264 | static char input_buffer[128]; |
f2cc4248 | 265 | |
52d8c529 MB |
266 | /* Some state during the execution of `read_c_string_or_comment'. */ |
267 | struct rcsoc_state | |
268 | { | |
fb2d3129 | 269 | /* A count of spaces and newlines that have been read, but not output. */ |
52d8c529 MB |
270 | unsigned pending_spaces, pending_newlines; |
271 | ||
272 | /* Where we're reading from. */ | |
273 | FILE *in_file; | |
274 | ||
275 | /* If non-zero, a buffer into which to copy characters. */ | |
276 | char *buf_ptr; | |
277 | /* If non-zero, a file into which to copy characters. */ | |
278 | FILE *out_file; | |
279 | ||
280 | /* A keyword we look for at the beginning of lines. If found, it is | |
281 | not copied, and SAW_KEYWORD is set to true. */ | |
988e88ab | 282 | const char *keyword; |
33972e80 | 283 | /* The current point we've reached in an occurrence of KEYWORD in |
52d8c529 | 284 | the input stream. */ |
988e88ab | 285 | const char *cur_keyword_ptr; |
33972e80 | 286 | /* Set to true if we saw an occurrence of KEYWORD. */ |
52d8c529 MB |
287 | int saw_keyword; |
288 | }; | |
289 | ||
290 | /* Output CH to the file or buffer in STATE. Any pending newlines or | |
291 | spaces are output first. */ | |
0c82822c | 292 | |
55d4c1b2 | 293 | static inline void |
873fbd0b | 294 | put_char (int ch, struct rcsoc_state *state) |
0c82822c MB |
295 | { |
296 | int out_ch; | |
297 | do | |
298 | { | |
52d8c529 | 299 | if (state->pending_newlines > 0) |
0c82822c | 300 | { |
52d8c529 | 301 | state->pending_newlines--; |
0c82822c MB |
302 | out_ch = '\n'; |
303 | } | |
52d8c529 | 304 | else if (state->pending_spaces > 0) |
0c82822c | 305 | { |
52d8c529 | 306 | state->pending_spaces--; |
0c82822c MB |
307 | out_ch = ' '; |
308 | } | |
309 | else | |
310 | out_ch = ch; | |
311 | ||
52d8c529 MB |
312 | if (state->out_file) |
313 | putc (out_ch, state->out_file); | |
314 | if (state->buf_ptr) | |
315 | *state->buf_ptr++ = out_ch; | |
0c82822c MB |
316 | } |
317 | while (out_ch != ch); | |
318 | } | |
319 | ||
52d8c529 MB |
320 | /* If in the middle of scanning a keyword, continue scanning with |
321 | character CH, otherwise output CH to the file or buffer in STATE. | |
322 | Any pending newlines or spaces are output first, as well as any | |
323 | previously scanned characters that were thought to be part of a | |
324 | keyword, but were in fact not. */ | |
325 | ||
326 | static void | |
873fbd0b | 327 | scan_keyword_or_put_char (int ch, struct rcsoc_state *state) |
52d8c529 MB |
328 | { |
329 | if (state->keyword | |
330 | && *state->cur_keyword_ptr == ch | |
331 | && (state->cur_keyword_ptr > state->keyword | |
332 | || state->pending_newlines > 0)) | |
333 | /* We might be looking at STATE->keyword at some point. | |
334 | Keep looking until we know for sure. */ | |
335 | { | |
336 | if (*++state->cur_keyword_ptr == '\0') | |
337 | /* Saw the whole keyword. Set SAW_KEYWORD flag to true. */ | |
338 | { | |
339 | state->saw_keyword = 1; | |
340 | ||
341 | /* Reset the scanning pointer. */ | |
342 | state->cur_keyword_ptr = state->keyword; | |
343 | ||
fb2d3129 | 344 | /* Canonicalize whitespace preceding a usage string. */ |
52d8c529 MB |
345 | state->pending_newlines = 2; |
346 | state->pending_spaces = 0; | |
347 | ||
348 | /* Skip any whitespace between the keyword and the | |
349 | usage string. */ | |
350 | do | |
351 | ch = getc (state->in_file); | |
352 | while (ch == ' ' || ch == '\n'); | |
353 | ||
56cf5162 SM |
354 | /* Output the open-paren we just read. */ |
355 | put_char (ch, state); | |
356 | ||
357 | /* Skip the function name and replace it with `fn'. */ | |
358 | do | |
359 | ch = getc (state->in_file); | |
360 | while (ch != ' ' && ch != ')'); | |
361 | put_char ('f', state); | |
362 | put_char ('n', state); | |
177c0ea7 | 363 | |
56cf5162 | 364 | /* Put back the last character. */ |
52d8c529 MB |
365 | ungetc (ch, state->in_file); |
366 | } | |
367 | } | |
368 | else | |
369 | { | |
370 | if (state->keyword && state->cur_keyword_ptr > state->keyword) | |
371 | /* We scanned the beginning of a potential usage | |
372 | keyword, but it was a false alarm. Output the | |
373 | part we scanned. */ | |
374 | { | |
988e88ab | 375 | const char *p; |
52d8c529 MB |
376 | |
377 | for (p = state->keyword; p < state->cur_keyword_ptr; p++) | |
378 | put_char (*p, state); | |
379 | ||
380 | state->cur_keyword_ptr = state->keyword; | |
381 | } | |
382 | ||
383 | put_char (ch, state); | |
384 | } | |
385 | } | |
386 | ||
387 | ||
74c55c82 GM |
388 | /* Skip a C string or C-style comment from INFILE, and return the |
389 | character that follows. COMMENT non-zero means skip a comment. If | |
390 | PRINTFLAG is positive, output string contents to outfile. If it is | |
391 | negative, store contents in buf. Convert escape sequences \n and | |
d097ad57 | 392 | \t to newline and tab; discard \ followed by newline. |
33972e80 | 393 | If SAW_USAGE is non-zero, then any occurrences of the string `usage:' |
d097ad57 MB |
394 | at the beginning of a line will be removed, and *SAW_USAGE set to |
395 | true if any were encountered. */ | |
f2cc4248 | 396 | |
b23b5a5b | 397 | static int |
873fbd0b | 398 | read_c_string_or_comment (FILE *infile, int printflag, int comment, int *saw_usage) |
f2cc4248 RS |
399 | { |
400 | register int c; | |
52d8c529 MB |
401 | struct rcsoc_state state; |
402 | ||
403 | state.in_file = infile; | |
4df52042 | 404 | state.buf_ptr = (printflag < 0 ? input_buffer : 0); |
52d8c529 MB |
405 | state.out_file = (printflag > 0 ? outfile : 0); |
406 | state.pending_spaces = 0; | |
407 | state.pending_newlines = 0; | |
408 | state.keyword = (saw_usage ? "usage:" : 0); | |
409 | state.cur_keyword_ptr = state.keyword; | |
410 | state.saw_keyword = 0; | |
411 | ||
412 | c = getc (infile); | |
74c55c82 | 413 | if (comment) |
52d8c529 MB |
414 | while (c == '\n' || c == '\r' || c == '\t' || c == ' ') |
415 | c = getc (infile); | |
d097ad57 | 416 | |
f2cc4248 RS |
417 | while (c != EOF) |
418 | { | |
74c55c82 | 419 | while (c != EOF && (comment ? c != '*' : c != '"')) |
f2cc4248 RS |
420 | { |
421 | if (c == '\\') | |
422 | { | |
423 | c = getc (infile); | |
433d333d | 424 | if (c == '\n' || c == '\r') |
f2cc4248 RS |
425 | { |
426 | c = getc (infile); | |
427 | continue; | |
428 | } | |
429 | if (c == 'n') | |
430 | c = '\n'; | |
431 | if (c == 't') | |
432 | c = '\t'; | |
433 | } | |
a00e9335 | 434 | |
0c82822c | 435 | if (c == ' ') |
52d8c529 | 436 | state.pending_spaces++; |
0c82822c MB |
437 | else if (c == '\n') |
438 | { | |
52d8c529 MB |
439 | state.pending_newlines++; |
440 | state.pending_spaces = 0; | |
0c82822c MB |
441 | } |
442 | else | |
52d8c529 | 443 | scan_keyword_or_put_char (c, &state); |
0c82822c | 444 | |
f2cc4248 RS |
445 | c = getc (infile); |
446 | } | |
74c55c82 | 447 | |
7dfd439c GM |
448 | if (c != EOF) |
449 | c = getc (infile); | |
f2cc4248 | 450 | |
74c55c82 GM |
451 | if (comment) |
452 | { | |
453 | if (c == '/') | |
454 | { | |
455 | c = getc (infile); | |
456 | break; | |
457 | } | |
a00e9335 | 458 | |
52d8c529 | 459 | scan_keyword_or_put_char ('*', &state); |
74c55c82 GM |
460 | } |
461 | else | |
462 | { | |
463 | if (c != '"') | |
464 | break; | |
a00e9335 | 465 | |
74c55c82 GM |
466 | /* If we had a "", concatenate the two strings. */ |
467 | c = getc (infile); | |
468 | } | |
469 | } | |
a00e9335 | 470 | |
f2cc4248 | 471 | if (printflag < 0) |
52d8c529 MB |
472 | *state.buf_ptr = 0; |
473 | ||
474 | if (saw_usage) | |
475 | *saw_usage = state.saw_keyword; | |
f2cc4248 RS |
476 | |
477 | return c; | |
478 | } | |
74c55c82 GM |
479 | |
480 | ||
f2cc4248 | 481 | \f |
069ad9ea | 482 | /* Write to file OUT the argument names of function FUNC, whose text is in BUF. |
f2cc4248 RS |
483 | MINARGS and MAXARGS are the minimum and maximum number of arguments. */ |
484 | ||
b23b5a5b | 485 | static void |
873fbd0b | 486 | write_c_args (FILE *out, char *func, char *buf, int minargs, int maxargs) |
f2cc4248 | 487 | { |
f125a9e8 | 488 | register char *p; |
30e4c427 | 489 | int in_ident = 0; |
8e48d7bc | 490 | char *ident_start IF_LINT (= NULL); |
728a982d | 491 | size_t ident_length = 0; |
f2cc4248 | 492 | |
56cf5162 | 493 | fprintf (out, "(fn"); |
069ad9ea RM |
494 | |
495 | if (*buf == '(') | |
496 | ++buf; | |
f2cc4248 | 497 | |
f125a9e8 | 498 | for (p = buf; *p; p++) |
f2cc4248 | 499 | { |
91a7f76d | 500 | char c = *p; |
30e4c427 | 501 | |
91a7f76d | 502 | /* Notice when a new identifier starts. */ |
30e4c427 JB |
503 | if ((('A' <= c && c <= 'Z') |
504 | || ('a' <= c && c <= 'z') | |
505 | || ('0' <= c && c <= '9') | |
506 | || c == '_') | |
507 | != in_ident) | |
f2cc4248 | 508 | { |
30e4c427 JB |
509 | if (!in_ident) |
510 | { | |
511 | in_ident = 1; | |
91a7f76d | 512 | ident_start = p; |
30e4c427 JB |
513 | } |
514 | else | |
91a7f76d AS |
515 | { |
516 | in_ident = 0; | |
517 | ident_length = p - ident_start; | |
518 | } | |
f2cc4248 | 519 | } |
30e4c427 | 520 | |
91a7f76d AS |
521 | /* Found the end of an argument, write out the last seen |
522 | identifier. */ | |
523 | if (c == ',' || c == ')') | |
3941a179 | 524 | { |
a94a477d JB |
525 | if (ident_length == 0) |
526 | { | |
527 | error ("empty arg list for `%s' should be (void), not ()", func); | |
528 | continue; | |
529 | } | |
530 | ||
91a7f76d AS |
531 | if (strncmp (ident_start, "void", ident_length) == 0) |
532 | continue; | |
533 | ||
534 | putc (' ', out); | |
535 | ||
536 | if (minargs == 0 && maxargs > 0) | |
537 | fprintf (out, "&optional "); | |
30e4c427 | 538 | |
91a7f76d AS |
539 | minargs--; |
540 | maxargs--; | |
541 | ||
542 | /* In C code, `default' is a reserved word, so we spell it | |
22bcf204 | 543 | `defalt'; demangle that here. */ |
554d39be | 544 | if (ident_length == 6 && strncmp (ident_start, "defalt", 6) == 0) |
91a7f76d AS |
545 | fprintf (out, "DEFAULT"); |
546 | else | |
547 | while (ident_length-- > 0) | |
548 | { | |
549 | c = *ident_start++; | |
550 | if (c >= 'a' && c <= 'z') | |
551 | /* Upcase the letter. */ | |
552 | c += 'A' - 'a'; | |
553 | else if (c == '_') | |
554 | /* Print underscore as hyphen. */ | |
555 | c = '-'; | |
556 | putc (c, out); | |
557 | } | |
558 | } | |
f2cc4248 | 559 | } |
91a7f76d AS |
560 | |
561 | putc (')', out); | |
f2cc4248 RS |
562 | } |
563 | \f | |
00b3c7ac TT |
564 | /* The types of globals. */ |
565 | enum global_type | |
566 | { | |
64df8c10 | 567 | EMACS_INTEGER, |
00b3c7ac TT |
568 | BOOLEAN, |
569 | LISP_OBJECT, | |
570 | INVALID | |
571 | }; | |
572 | ||
573 | /* A single global. */ | |
574 | struct global | |
575 | { | |
576 | enum global_type type; | |
577 | char *name; | |
578 | }; | |
579 | ||
580 | /* All the variable names we saw while scanning C sources in `-g' | |
581 | mode. */ | |
582 | int num_globals; | |
583 | int num_globals_allocated; | |
584 | struct global *globals; | |
585 | ||
586 | static void | |
587 | add_global (enum global_type type, char *name) | |
588 | { | |
589 | /* Ignore the one non-symbol that can occur. */ | |
590 | if (strcmp (name, "...")) | |
591 | { | |
592 | ++num_globals; | |
593 | ||
594 | if (num_globals_allocated == 0) | |
595 | { | |
596 | num_globals_allocated = 100; | |
597 | globals = xmalloc (num_globals_allocated * sizeof (struct global)); | |
598 | } | |
599 | else if (num_globals == num_globals_allocated) | |
600 | { | |
601 | num_globals_allocated *= 2; | |
602 | globals = xrealloc (globals, | |
603 | num_globals_allocated * sizeof (struct global)); | |
604 | } | |
605 | ||
606 | globals[num_globals - 1].type = type; | |
607 | globals[num_globals - 1].name = name; | |
608 | } | |
609 | } | |
610 | ||
611 | static int | |
612 | compare_globals (const void *a, const void *b) | |
613 | { | |
614 | const struct global *ga = a; | |
615 | const struct global *gb = b; | |
616 | return strcmp (ga->name, gb->name); | |
617 | } | |
618 | ||
b23b5a5b | 619 | static void |
00b3c7ac TT |
620 | write_globals (void) |
621 | { | |
622 | int i; | |
623 | qsort (globals, num_globals, sizeof (struct global), compare_globals); | |
624 | for (i = 0; i < num_globals; ++i) | |
625 | { | |
564ff1f2 | 626 | char const *type; |
00b3c7ac TT |
627 | |
628 | switch (globals[i].type) | |
629 | { | |
64df8c10 | 630 | case EMACS_INTEGER: |
00b3c7ac TT |
631 | type = "EMACS_INT"; |
632 | break; | |
633 | case BOOLEAN: | |
634 | type = "int"; | |
635 | break; | |
636 | case LISP_OBJECT: | |
637 | type = "Lisp_Object"; | |
638 | break; | |
639 | default: | |
640 | fatal ("not a recognized DEFVAR_", 0); | |
641 | } | |
642 | ||
643 | fprintf (outfile, " %s f_%s;\n", type, globals[i].name); | |
644 | fprintf (outfile, "#define %s globals.f_%s\n", | |
645 | globals[i].name, globals[i].name); | |
646 | while (i + 1 < num_globals | |
647 | && !strcmp (globals[i].name, globals[i + 1].name)) | |
648 | ++i; | |
649 | } | |
650 | ||
651 | fprintf (outfile, "};\n"); | |
652 | fprintf (outfile, "extern struct emacs_globals globals;\n"); | |
653 | } | |
654 | ||
655 | \f | |
f2cc4248 | 656 | /* Read through a c file. If a .o file is named, |
edfda783 | 657 | the corresponding .c or .m file is read instead. |
f2cc4248 RS |
658 | Looks for DEFUN constructs such as are defined in ../src/lisp.h. |
659 | Accepts any word starting DEF... so it finds DEFSIMPLE and DEFPRED. */ | |
660 | ||
b23b5a5b | 661 | static int |
988e88ab | 662 | scan_c_file (char *filename, const char *mode) |
f2cc4248 RS |
663 | { |
664 | FILE *infile; | |
665 | register int c; | |
666 | register int commas; | |
f2cc4248 | 667 | int minargs, maxargs; |
1feb8ae1 | 668 | int extension = filename[strlen (filename) - 1]; |
f2cc4248 | 669 | |
1feb8ae1 | 670 | if (extension == 'o') |
f2cc4248 RS |
671 | filename[strlen (filename) - 1] = 'c'; |
672 | ||
e3938952 | 673 | infile = fopen (filename, mode); |
f2cc4248 | 674 | |
edfda783 AR |
675 | if (infile == NULL && extension == 'o') |
676 | { | |
61b108cc | 677 | /* Try .m. */ |
edfda783 AR |
678 | filename[strlen (filename) - 1] = 'm'; |
679 | infile = fopen (filename, mode); | |
680 | if (infile == NULL) | |
61b108cc | 681 | filename[strlen (filename) - 1] = 'c'; /* Don't confuse people. */ |
edfda783 AR |
682 | } |
683 | ||
61b108cc | 684 | /* No error if non-ex input file. */ |
f2cc4248 RS |
685 | if (infile == NULL) |
686 | { | |
687 | perror (filename); | |
688 | return 0; | |
689 | } | |
690 | ||
fb2d3129 | 691 | /* Reset extension to be able to detect duplicate files. */ |
1feb8ae1 RS |
692 | filename[strlen (filename) - 1] = extension; |
693 | ||
f2cc4248 RS |
694 | c = '\n'; |
695 | while (!feof (infile)) | |
696 | { | |
a5979c0e | 697 | int doc_keyword = 0; |
8dfa32f6 PE |
698 | int defunflag = 0; |
699 | int defvarperbufferflag = 0; | |
700 | int defvarflag = 0; | |
701 | enum global_type type = INVALID; | |
a5979c0e | 702 | |
433d333d | 703 | if (c != '\n' && c != '\r') |
f2cc4248 RS |
704 | { |
705 | c = getc (infile); | |
706 | continue; | |
707 | } | |
708 | c = getc (infile); | |
709 | if (c == ' ') | |
710 | { | |
711 | while (c == ' ') | |
712 | c = getc (infile); | |
713 | if (c != 'D') | |
714 | continue; | |
715 | c = getc (infile); | |
716 | if (c != 'E') | |
717 | continue; | |
718 | c = getc (infile); | |
719 | if (c != 'F') | |
720 | continue; | |
721 | c = getc (infile); | |
722 | if (c != 'V') | |
723 | continue; | |
84128dee JB |
724 | c = getc (infile); |
725 | if (c != 'A') | |
726 | continue; | |
727 | c = getc (infile); | |
728 | if (c != 'R') | |
729 | continue; | |
730 | c = getc (infile); | |
731 | if (c != '_') | |
732 | continue; | |
733 | ||
f2cc4248 | 734 | defvarflag = 1; |
84128dee JB |
735 | |
736 | c = getc (infile); | |
737 | defvarperbufferflag = (c == 'P'); | |
00b3c7ac TT |
738 | if (generate_globals) |
739 | { | |
740 | if (c == 'I') | |
64df8c10 | 741 | type = EMACS_INTEGER; |
00b3c7ac TT |
742 | else if (c == 'L') |
743 | type = LISP_OBJECT; | |
744 | else if (c == 'B') | |
745 | type = BOOLEAN; | |
00b3c7ac | 746 | } |
84128dee | 747 | |
f2cc4248 | 748 | c = getc (infile); |
00b3c7ac TT |
749 | /* We need to distinguish between DEFVAR_BOOL and |
750 | DEFVAR_BUFFER_DEFAULTS. */ | |
751 | if (generate_globals && type == BOOLEAN && c != 'O') | |
752 | type = INVALID; | |
f2cc4248 RS |
753 | } |
754 | else if (c == 'D') | |
755 | { | |
756 | c = getc (infile); | |
757 | if (c != 'E') | |
758 | continue; | |
759 | c = getc (infile); | |
760 | if (c != 'F') | |
761 | continue; | |
762 | c = getc (infile); | |
763 | defunflag = c == 'U'; | |
f2cc4248 RS |
764 | } |
765 | else continue; | |
766 | ||
00b3c7ac TT |
767 | if (generate_globals && (!defvarflag || defvarperbufferflag |
768 | || type == INVALID)) | |
769 | continue; | |
770 | ||
f2cc4248 RS |
771 | while (c != '(') |
772 | { | |
773 | if (c < 0) | |
774 | goto eof; | |
775 | c = getc (infile); | |
776 | } | |
777 | ||
74c55c82 | 778 | /* Lisp variable or function name. */ |
f2cc4248 RS |
779 | c = getc (infile); |
780 | if (c != '"') | |
781 | continue; | |
d097ad57 | 782 | c = read_c_string_or_comment (infile, -1, 0, 0); |
74c55c82 | 783 | |
00b3c7ac TT |
784 | if (generate_globals) |
785 | { | |
786 | int i = 0; | |
787 | char *name; | |
788 | ||
789 | /* Skip "," and whitespace. */ | |
790 | do | |
791 | { | |
792 | c = getc (infile); | |
793 | } | |
794 | while (c == ',' || c == ' ' || c == '\t' || c == '\n' || c == '\r'); | |
795 | ||
796 | /* Read in the identifier. */ | |
797 | do | |
798 | { | |
4df52042 | 799 | input_buffer[i++] = c; |
00b3c7ac TT |
800 | c = getc (infile); |
801 | } | |
61b108cc SM |
802 | while (! (c == ',' || c == ' ' || c == '\t' |
803 | || c == '\n' || c == '\r')); | |
4df52042 | 804 | input_buffer[i] = '\0'; |
00b3c7ac TT |
805 | |
806 | name = xmalloc (i + 1); | |
4df52042 | 807 | memcpy (name, input_buffer, i + 1); |
00b3c7ac TT |
808 | add_global (type, name); |
809 | continue; | |
810 | } | |
811 | ||
a5979c0e MB |
812 | /* DEFVAR_LISP ("name", addr, "doc") |
813 | DEFVAR_LISP ("name", addr /\* doc *\/) | |
814 | DEFVAR_LISP ("name", addr, doc: /\* doc *\/) */ | |
f2cc4248 RS |
815 | |
816 | if (defunflag) | |
817 | commas = 5; | |
84128dee | 818 | else if (defvarperbufferflag) |
6ca1c3b4 | 819 | commas = 3; |
f2cc4248 RS |
820 | else if (defvarflag) |
821 | commas = 1; | |
61b108cc | 822 | else /* For DEFSIMPLE and DEFPRED. */ |
f2cc4248 RS |
823 | commas = 2; |
824 | ||
825 | while (commas) | |
826 | { | |
827 | if (c == ',') | |
828 | { | |
829 | commas--; | |
74c55c82 | 830 | |
f2cc4248 RS |
831 | if (defunflag && (commas == 1 || commas == 2)) |
832 | { | |
9055082e | 833 | int scanned = 0; |
f2cc4248 RS |
834 | do |
835 | c = getc (infile); | |
433d333d | 836 | while (c == ' ' || c == '\n' || c == '\r' || c == '\t'); |
f2cc4248 RS |
837 | if (c < 0) |
838 | goto eof; | |
839 | ungetc (c, infile); | |
61b108cc | 840 | if (commas == 2) /* Pick up minargs. */ |
9055082e | 841 | scanned = fscanf (infile, "%d", &minargs); |
61b108cc | 842 | else /* Pick up maxargs. */ |
f2cc4248 RS |
843 | if (c == 'M' || c == 'U') /* MANY || UNEVALLED */ |
844 | maxargs = -1; | |
845 | else | |
9055082e PE |
846 | scanned = fscanf (infile, "%d", &maxargs); |
847 | if (scanned < 0) | |
848 | goto eof; | |
f2cc4248 RS |
849 | } |
850 | } | |
74c55c82 GM |
851 | |
852 | if (c == EOF) | |
f2cc4248 RS |
853 | goto eof; |
854 | c = getc (infile); | |
855 | } | |
a5979c0e | 856 | |
433d333d | 857 | while (c == ' ' || c == '\n' || c == '\r' || c == '\t') |
f2cc4248 | 858 | c = getc (infile); |
a00e9335 | 859 | |
f2cc4248 | 860 | if (c == '"') |
d097ad57 | 861 | c = read_c_string_or_comment (infile, 0, 0, 0); |
a00e9335 | 862 | |
74c55c82 | 863 | while (c != EOF && c != ',' && c != '/') |
f2cc4248 | 864 | c = getc (infile); |
74c55c82 GM |
865 | if (c == ',') |
866 | { | |
a5979c0e MB |
867 | c = getc (infile); |
868 | while (c == ' ' || c == '\n' || c == '\r' || c == '\t') | |
869 | c = getc (infile); | |
870 | while ((c >= 'a' && c <= 'z') || (c >= 'Z' && c <= 'Z')) | |
871 | c = getc (infile); | |
872 | if (c == ':') | |
873 | { | |
874 | doc_keyword = 1; | |
875 | c = getc (infile); | |
876 | while (c == ' ' || c == '\n' || c == '\r' || c == '\t') | |
877 | c = getc (infile); | |
878 | } | |
74c55c82 | 879 | } |
f2cc4248 | 880 | |
74c55c82 GM |
881 | if (c == '"' |
882 | || (c == '/' | |
883 | && (c = getc (infile), | |
884 | ungetc (c, infile), | |
885 | c == '*'))) | |
f2cc4248 | 886 | { |
74c55c82 | 887 | int comment = c != '"'; |
d097ad57 | 888 | int saw_usage; |
a00e9335 | 889 | |
f2cc4248 RS |
890 | putc (037, outfile); |
891 | putc (defvarflag ? 'V' : 'F', outfile); | |
4df52042 | 892 | fprintf (outfile, "%s\n", input_buffer); |
74c55c82 GM |
893 | |
894 | if (comment) | |
61b108cc | 895 | getc (infile); /* Skip past `*'. */ |
d097ad57 | 896 | c = read_c_string_or_comment (infile, 1, comment, &saw_usage); |
772e2009 JB |
897 | |
898 | /* If this is a defun, find the arguments and print them. If | |
899 | this function takes MANY or UNEVALLED args, then the C source | |
900 | won't give the names of the arguments, so we shouldn't bother | |
74c55c82 GM |
901 | trying to find them. |
902 | ||
a5979c0e MB |
903 | Various doc-string styles: |
904 | 0: DEFUN (..., "DOC") (args) [!comment] | |
905 | 1: DEFUN (..., /\* DOC *\/ (args)) [comment && !doc_keyword] | |
906 | 2: DEFUN (..., doc: /\* DOC *\/) (args) [comment && doc_keyword] | |
907 | */ | |
d097ad57 | 908 | if (defunflag && maxargs != -1 && !saw_usage) |
f2cc4248 RS |
909 | { |
910 | char argbuf[1024], *p = argbuf; | |
74c55c82 | 911 | |
a5979c0e | 912 | if (!comment || doc_keyword) |
74c55c82 GM |
913 | while (c != ')') |
914 | { | |
915 | if (c < 0) | |
916 | goto eof; | |
917 | c = getc (infile); | |
918 | } | |
a00e9335 | 919 | |
f2cc4248 RS |
920 | /* Skip into arguments. */ |
921 | while (c != '(') | |
922 | { | |
923 | if (c < 0) | |
924 | goto eof; | |
925 | c = getc (infile); | |
926 | } | |
927 | /* Copy arguments into ARGBUF. */ | |
928 | *p++ = c; | |
929 | do | |
930 | *p++ = c = getc (infile); | |
931 | while (c != ')'); | |
932 | *p = '\0'; | |
933 | /* Output them. */ | |
934 | fprintf (outfile, "\n\n"); | |
4df52042 | 935 | write_c_args (outfile, input_buffer, argbuf, minargs, maxargs); |
f2cc4248 | 936 | } |
1e042160 SM |
937 | else if (defunflag && maxargs == -1 && !saw_usage) |
938 | /* The DOC should provide the usage form. */ | |
4df52042 PE |
939 | fprintf (stderr, "Missing `usage' for function `%s'.\n", |
940 | input_buffer); | |
f2cc4248 RS |
941 | } |
942 | } | |
943 | eof: | |
944 | fclose (infile); | |
945 | return 0; | |
946 | } | |
947 | \f | |
948 | /* Read a file of Lisp code, compiled or interpreted. | |
949 | Looks for | |
950 | (defun NAME ARGS DOCSTRING ...) | |
23d6b5a6 | 951 | (defmacro NAME ARGS DOCSTRING ...) |
34e778a6 | 952 | (defsubst NAME ARGS DOCSTRING ...) |
23d6b5a6 | 953 | (autoload (quote NAME) FILE DOCSTRING ...) |
f2cc4248 RS |
954 | (defvar NAME VALUE DOCSTRING) |
955 | (defconst NAME VALUE DOCSTRING) | |
23d6b5a6 JB |
956 | (fset (quote NAME) (make-byte-code ... DOCSTRING ...)) |
957 | (fset (quote NAME) #[... DOCSTRING ...]) | |
2d6e2619 | 958 | (defalias (quote NAME) #[... DOCSTRING ...]) |
3fe77f98 | 959 | (custom-declare-variable (quote NAME) VALUE DOCSTRING ...) |
f2cc4248 | 960 | starting in column zero. |
23d6b5a6 | 961 | (quote NAME) may appear as 'NAME as well. |
b5ff43cc RS |
962 | |
963 | We also look for #@LENGTH CONTENTS^_ at the beginning of the line. | |
964 | When we find that, we save it for the following defining-form, | |
965 | and we use that instead of reading a doc string within that defining-form. | |
966 | ||
a00e9335 | 967 | For defvar, defconst, and fset we skip to the docstring with a kludgy |
23d6b5a6 | 968 | formatting convention: all docstrings must appear on the same line as the |
a00e9335 | 969 | initial open-paren (the one in column zero) and must contain a backslash |
b0f08a24 | 970 | and a newline immediately after the initial double-quote. No newlines |
23d6b5a6 | 971 | must appear between the beginning of the form and the first double-quote. |
b0f08a24 DL |
972 | For defun, defmacro, and autoload, we know how to skip over the |
973 | arglist, but the doc string must still have a backslash and newline | |
a00e9335 | 974 | immediately after the double quote. |
b0f08a24 DL |
975 | The only source files that must follow this convention are preloaded |
976 | uncompiled ones like loaddefs.el and bindings.el; aside | |
23d6b5a6 JB |
977 | from that, it is always the .elc file that we look at, and they are no |
978 | problem because byte-compiler output follows this convention. | |
f2cc4248 RS |
979 | The NAME and DOCSTRING are output. |
980 | NAME is preceded by `F' for a function or `V' for a variable. | |
61b108cc | 981 | An entry is output only if DOCSTRING has \ newline just after the opening ". |
f2cc4248 RS |
982 | */ |
983 | ||
b23b5a5b | 984 | static void |
873fbd0b | 985 | skip_white (FILE *infile) |
23d6b5a6 JB |
986 | { |
987 | char c = ' '; | |
433d333d | 988 | while (c == ' ' || c == '\t' || c == '\n' || c == '\r') |
23d6b5a6 JB |
989 | c = getc (infile); |
990 | ungetc (c, infile); | |
991 | } | |
992 | ||
b23b5a5b | 993 | static void |
873fbd0b | 994 | read_lisp_symbol (FILE *infile, char *buffer) |
23d6b5a6 JB |
995 | { |
996 | char c; | |
997 | char *fillp = buffer; | |
998 | ||
999 | skip_white (infile); | |
1000 | while (1) | |
1001 | { | |
1002 | c = getc (infile); | |
1003 | if (c == '\\') | |
1004 | *(++fillp) = getc (infile); | |
433d333d | 1005 | else if (c == ' ' || c == '\t' || c == '\n' || c == '\r' || c == '(' || c == ')') |
23d6b5a6 JB |
1006 | { |
1007 | ungetc (c, infile); | |
1008 | *fillp = 0; | |
1009 | break; | |
1010 | } | |
1011 | else | |
1012 | *fillp++ = c; | |
1013 | } | |
1014 | ||
1015 | if (! buffer[0]) | |
1016 | fprintf (stderr, "## expected a symbol, got '%c'\n", c); | |
a00e9335 | 1017 | |
23d6b5a6 JB |
1018 | skip_white (infile); |
1019 | } | |
1020 | ||
61b108cc SM |
1021 | static int |
1022 | search_lisp_doc_at_eol (FILE *infile) | |
1023 | { | |
1024 | char c = 0, c1 = 0, c2 = 0; | |
1025 | ||
1026 | /* Skip until the end of line; remember two previous chars. */ | |
7cb70fd7 | 1027 | while (c != '\n' && c != '\r' && c != EOF) |
61b108cc SM |
1028 | { |
1029 | c2 = c1; | |
1030 | c1 = c; | |
1031 | c = getc (infile); | |
1032 | } | |
1033 | ||
1034 | /* If two previous characters were " and \, | |
1035 | this is a doc string. Otherwise, there is none. */ | |
1036 | if (c2 != '"' || c1 != '\\') | |
1037 | { | |
1038 | #ifdef DEBUG | |
1039 | fprintf (stderr, "## non-docstring in %s (%s)\n", | |
1040 | buffer, filename); | |
1041 | #endif | |
7cb70fd7 AS |
1042 | if (c != EOF) |
1043 | ungetc (c, infile); | |
61b108cc SM |
1044 | return 0; |
1045 | } | |
1046 | return 1; | |
1047 | } | |
1048 | ||
b23b5a5b | 1049 | static int |
988e88ab | 1050 | scan_lisp_file (const char *filename, const char *mode) |
f2cc4248 RS |
1051 | { |
1052 | FILE *infile; | |
1053 | register int c; | |
b5ff43cc | 1054 | char *saved_string = 0; |
f2cc4248 | 1055 | |
00b3c7ac TT |
1056 | if (generate_globals) |
1057 | fatal ("scanning lisp file when -g specified", 0); | |
1058 | ||
e3938952 | 1059 | infile = fopen (filename, mode); |
f2cc4248 RS |
1060 | if (infile == NULL) |
1061 | { | |
1062 | perror (filename); | |
61b108cc | 1063 | return 0; /* No error. */ |
f2cc4248 RS |
1064 | } |
1065 | ||
1066 | c = '\n'; | |
1067 | while (!feof (infile)) | |
1068 | { | |
b5ff43cc | 1069 | char buffer[BUFSIZ]; |
23d6b5a6 JB |
1070 | char type; |
1071 | ||
66f54605 | 1072 | /* If not at end of line, skip till we get to one. */ |
433d333d | 1073 | if (c != '\n' && c != '\r') |
f2cc4248 RS |
1074 | { |
1075 | c = getc (infile); | |
1076 | continue; | |
1077 | } | |
66f54605 | 1078 | /* Skip the line break. */ |
7e6972e9 | 1079 | while (c == '\n' || c == '\r') |
66f54605 | 1080 | c = getc (infile); |
b5ff43cc RS |
1081 | /* Detect a dynamic doc string and save it for the next expression. */ |
1082 | if (c == '#') | |
1083 | { | |
1084 | c = getc (infile); | |
1085 | if (c == '@') | |
1086 | { | |
8aec9916 JM |
1087 | size_t length = 0; |
1088 | size_t i; | |
b5ff43cc RS |
1089 | |
1090 | /* Read the length. */ | |
1091 | while ((c = getc (infile), | |
1092 | c >= '0' && c <= '9')) | |
1093 | { | |
1094 | length *= 10; | |
1095 | length += c - '0'; | |
1096 | } | |
1097 | ||
8aec9916 JM |
1098 | if (length <= 1) |
1099 | fatal ("invalid dynamic doc string length", ""); | |
1100 | ||
1101 | if (c != ' ') | |
1102 | fatal ("space not found after dynamic doc string length", ""); | |
1103 | ||
b5ff43cc RS |
1104 | /* The next character is a space that is counted in the length |
1105 | but not part of the doc string. | |
1106 | We already read it, so just ignore it. */ | |
1107 | length--; | |
1108 | ||
1109 | /* Read in the contents. */ | |
e0f59195 | 1110 | free (saved_string); |
938ebc4f | 1111 | saved_string = (char *) xmalloc (length); |
b5ff43cc RS |
1112 | for (i = 0; i < length; i++) |
1113 | saved_string[i] = getc (infile); | |
1114 | /* The last character is a ^_. | |
1115 | That is needed in the .elc file | |
1116 | but it is redundant in DOC. So get rid of it here. */ | |
1117 | saved_string[length - 1] = 0; | |
66f54605 | 1118 | /* Skip the line break. */ |
8aec9916 | 1119 | while (c == '\n' || c == '\r') |
66f54605 PR |
1120 | c = getc (infile); |
1121 | /* Skip the following line. */ | |
433d333d | 1122 | while (c != '\n' && c != '\r') |
b5ff43cc RS |
1123 | c = getc (infile); |
1124 | } | |
1125 | continue; | |
1126 | } | |
1127 | ||
f2cc4248 RS |
1128 | if (c != '(') |
1129 | continue; | |
a8a7afbe | 1130 | |
23d6b5a6 JB |
1131 | read_lisp_symbol (infile, buffer); |
1132 | ||
66f54605 | 1133 | if (! strcmp (buffer, "defun") |
34e778a6 AS |
1134 | || ! strcmp (buffer, "defmacro") |
1135 | || ! strcmp (buffer, "defsubst")) | |
f2cc4248 | 1136 | { |
23d6b5a6 JB |
1137 | type = 'F'; |
1138 | read_lisp_symbol (infile, buffer); | |
f2cc4248 | 1139 | |
61b108cc | 1140 | /* Skip the arguments: either "nil" or a list in parens. */ |
f2cc4248 | 1141 | |
23d6b5a6 JB |
1142 | c = getc (infile); |
1143 | if (c == 'n') /* nil */ | |
f2cc4248 | 1144 | { |
66f54605 PR |
1145 | if ((c = getc (infile)) != 'i' |
1146 | || (c = getc (infile)) != 'l') | |
23d6b5a6 JB |
1147 | { |
1148 | fprintf (stderr, "## unparsable arglist in %s (%s)\n", | |
1149 | buffer, filename); | |
1150 | continue; | |
1151 | } | |
f2cc4248 | 1152 | } |
23d6b5a6 | 1153 | else if (c != '(') |
f2cc4248 | 1154 | { |
23d6b5a6 JB |
1155 | fprintf (stderr, "## unparsable arglist in %s (%s)\n", |
1156 | buffer, filename); | |
1157 | continue; | |
f2cc4248 | 1158 | } |
23d6b5a6 JB |
1159 | else |
1160 | while (c != ')') | |
f2cc4248 | 1161 | c = getc (infile); |
23d6b5a6 JB |
1162 | skip_white (infile); |
1163 | ||
1164 | /* If the next three characters aren't `dquote bslash newline' | |
1165 | then we're not reading a docstring. | |
1166 | */ | |
66f54605 PR |
1167 | if ((c = getc (infile)) != '"' |
1168 | || (c = getc (infile)) != '\\' | |
1169 | || ((c = getc (infile)) != '\n' && c != '\r')) | |
f2cc4248 | 1170 | { |
23d6b5a6 JB |
1171 | #ifdef DEBUG |
1172 | fprintf (stderr, "## non-docstring in %s (%s)\n", | |
1173 | buffer, filename); | |
1174 | #endif | |
1175 | continue; | |
f2cc4248 | 1176 | } |
f2cc4248 | 1177 | } |
a8a7afbe | 1178 | |
420b63ad | 1179 | /* defcustom can only occur in uncompiled Lisp files. */ |
66f54605 | 1180 | else if (! strcmp (buffer, "defvar") |
420b63ad GM |
1181 | || ! strcmp (buffer, "defconst") |
1182 | || ! strcmp (buffer, "defcustom")) | |
f2cc4248 | 1183 | { |
23d6b5a6 JB |
1184 | type = 'V'; |
1185 | read_lisp_symbol (infile, buffer); | |
a8a7afbe | 1186 | |
b5ff43cc | 1187 | if (saved_string == 0) |
61b108cc SM |
1188 | if (!search_lisp_doc_at_eol (infile)) |
1189 | continue; | |
23d6b5a6 JB |
1190 | } |
1191 | ||
f6195dfb DN |
1192 | else if (! strcmp (buffer, "custom-declare-variable") |
1193 | || ! strcmp (buffer, "defvaralias") | |
1194 | ) | |
3fe77f98 | 1195 | { |
3fe77f98 RS |
1196 | type = 'V'; |
1197 | ||
1198 | c = getc (infile); | |
1199 | if (c == '\'') | |
1200 | read_lisp_symbol (infile, buffer); | |
1201 | else | |
1202 | { | |
1203 | if (c != '(') | |
1204 | { | |
1205 | fprintf (stderr, | |
1206 | "## unparsable name in custom-declare-variable in %s\n", | |
1207 | filename); | |
1208 | continue; | |
1209 | } | |
1210 | read_lisp_symbol (infile, buffer); | |
1211 | if (strcmp (buffer, "quote")) | |
1212 | { | |
1213 | fprintf (stderr, | |
1214 | "## unparsable name in custom-declare-variable in %s\n", | |
1215 | filename); | |
1216 | continue; | |
1217 | } | |
1218 | read_lisp_symbol (infile, buffer); | |
1219 | c = getc (infile); | |
1220 | if (c != ')') | |
1221 | { | |
1222 | fprintf (stderr, | |
1223 | "## unparsable quoted name in custom-declare-variable in %s\n", | |
1224 | filename); | |
1225 | continue; | |
1226 | } | |
1227 | } | |
1228 | ||
1229 | if (saved_string == 0) | |
61b108cc SM |
1230 | if (!search_lisp_doc_at_eol (infile)) |
1231 | continue; | |
3fe77f98 RS |
1232 | } |
1233 | ||
2d6e2619 | 1234 | else if (! strcmp (buffer, "fset") || ! strcmp (buffer, "defalias")) |
23d6b5a6 | 1235 | { |
23d6b5a6 | 1236 | type = 'F'; |
a8a7afbe | 1237 | |
23d6b5a6 JB |
1238 | c = getc (infile); |
1239 | if (c == '\'') | |
1240 | read_lisp_symbol (infile, buffer); | |
1241 | else | |
f2cc4248 | 1242 | { |
23d6b5a6 JB |
1243 | if (c != '(') |
1244 | { | |
1245 | fprintf (stderr, "## unparsable name in fset in %s\n", | |
1246 | filename); | |
1247 | continue; | |
1248 | } | |
1249 | read_lisp_symbol (infile, buffer); | |
1250 | if (strcmp (buffer, "quote")) | |
1251 | { | |
1252 | fprintf (stderr, "## unparsable name in fset in %s\n", | |
1253 | filename); | |
1254 | continue; | |
1255 | } | |
1256 | read_lisp_symbol (infile, buffer); | |
f2cc4248 | 1257 | c = getc (infile); |
23d6b5a6 JB |
1258 | if (c != ')') |
1259 | { | |
1260 | fprintf (stderr, | |
1261 | "## unparsable quoted name in fset in %s\n", | |
1262 | filename); | |
1263 | continue; | |
1264 | } | |
f2cc4248 | 1265 | } |
f2cc4248 | 1266 | |
b5ff43cc | 1267 | if (saved_string == 0) |
61b108cc SM |
1268 | if (!search_lisp_doc_at_eol (infile)) |
1269 | continue; | |
23d6b5a6 | 1270 | } |
f2cc4248 | 1271 | |
23d6b5a6 JB |
1272 | else if (! strcmp (buffer, "autoload")) |
1273 | { | |
1274 | type = 'F'; | |
1275 | c = getc (infile); | |
1276 | if (c == '\'') | |
1277 | read_lisp_symbol (infile, buffer); | |
1278 | else | |
f2cc4248 | 1279 | { |
23d6b5a6 | 1280 | if (c != '(') |
f2cc4248 | 1281 | { |
23d6b5a6 JB |
1282 | fprintf (stderr, "## unparsable name in autoload in %s\n", |
1283 | filename); | |
1284 | continue; | |
f2cc4248 | 1285 | } |
23d6b5a6 JB |
1286 | read_lisp_symbol (infile, buffer); |
1287 | if (strcmp (buffer, "quote")) | |
f2cc4248 | 1288 | { |
23d6b5a6 JB |
1289 | fprintf (stderr, "## unparsable name in autoload in %s\n", |
1290 | filename); | |
1291 | continue; | |
f2cc4248 | 1292 | } |
23d6b5a6 | 1293 | read_lisp_symbol (infile, buffer); |
f2cc4248 | 1294 | c = getc (infile); |
23d6b5a6 | 1295 | if (c != ')') |
f2cc4248 | 1296 | { |
23d6b5a6 JB |
1297 | fprintf (stderr, |
1298 | "## unparsable quoted name in autoload in %s\n", | |
1299 | filename); | |
1300 | continue; | |
f2cc4248 | 1301 | } |
23d6b5a6 JB |
1302 | } |
1303 | skip_white (infile); | |
1304 | if ((c = getc (infile)) != '\"') | |
1305 | { | |
1306 | fprintf (stderr, "## autoload of %s unparsable (%s)\n", | |
1307 | buffer, filename); | |
f2cc4248 RS |
1308 | continue; |
1309 | } | |
d097ad57 | 1310 | read_c_string_or_comment (infile, 0, 0, 0); |
23d6b5a6 | 1311 | |
b5ff43cc | 1312 | if (saved_string == 0) |
61b108cc SM |
1313 | if (!search_lisp_doc_at_eol (infile)) |
1314 | continue; | |
a8a7afbe | 1315 | } |
f2cc4248 | 1316 | |
23d6b5a6 | 1317 | #ifdef DEBUG |
66f54605 PR |
1318 | else if (! strcmp (buffer, "if") |
1319 | || ! strcmp (buffer, "byte-code")) | |
a706a3bc | 1320 | continue; |
23d6b5a6 | 1321 | #endif |
f2cc4248 | 1322 | |
23d6b5a6 JB |
1323 | else |
1324 | { | |
1325 | #ifdef DEBUG | |
bcfce2c7 | 1326 | fprintf (stderr, "## unrecognized top-level form, %s (%s)\n", |
23d6b5a6 JB |
1327 | buffer, filename); |
1328 | #endif | |
1329 | continue; | |
1330 | } | |
f2cc4248 | 1331 | |
61b108cc SM |
1332 | /* At this point, we should either use the previous dynamic doc string in |
1333 | saved_string or gobble a doc string from the input file. | |
1334 | In the latter case, the opening quote (and leading backslash-newline) | |
1335 | have already been read. */ | |
b5ff43cc | 1336 | |
f2cc4248 | 1337 | putc (037, outfile); |
23d6b5a6 JB |
1338 | putc (type, outfile); |
1339 | fprintf (outfile, "%s\n", buffer); | |
b5ff43cc RS |
1340 | if (saved_string) |
1341 | { | |
1342 | fputs (saved_string, outfile); | |
1343 | /* Don't use one dynamic doc string twice. */ | |
1344 | free (saved_string); | |
1345 | saved_string = 0; | |
1346 | } | |
1347 | else | |
d097ad57 | 1348 | read_c_string_or_comment (infile, 1, 0, 0); |
f2cc4248 RS |
1349 | } |
1350 | fclose (infile); | |
1351 | return 0; | |
1352 | } | |
ab5796a9 | 1353 | |
65396510 TTN |
1354 | |
1355 | /* make-docfile.c ends here */ |