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