]>
code.delx.au - gnu-emacs/blob - lib-src/make-docfile.c
1 /* Generate doc-string file for GNU Emacs from source files.
3 Copyright (C) 1985-1986, 1992-1994, 1997, 1999-2015 Free Software
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
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.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
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.
26 Option -d DIR means change to DIR before looking for files.
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.
41 #include <stdlib.h> /* config.h unconditionally includes this anyway */
44 /* Defined to be sys_fopen in ms-w32.h, but only #ifdef emacs, so this
45 is really just insurance. */
48 #endif /* WINDOWSNT */
50 #include <binary-io.h>
53 /* Defined to be sys_chdir in ms-w32.h, but only #ifdef emacs, so this
54 is really just insurance.
56 Similarly, msdos defines this as sys_chdir, but we're not linking with the
57 file where that function is defined. */
59 #define IS_SLASH(c) ((c) == '/' || (c) == '\\' || (c) == ':')
60 #else /* not DOS_NT */
61 #define IS_SLASH(c) ((c) == '/')
62 #endif /* not DOS_NT */
64 static int scan_file (char *filename
);
65 static int scan_lisp_file (const char *filename
, const char *mode
);
66 static int scan_c_file (char *filename
, const char *mode
);
67 static int scan_c_stream (FILE *infile
);
68 static void start_globals (void);
69 static void write_globals (void);
73 /* Name this program was invoked with. */
76 /* Nonzero if this invocation is generating globals.h. */
79 /* Print error message. `s1' is printf control string, `s2' is arg for it. */
83 error (const char *s1
, const char *s2
)
85 fprintf (stderr
, "%s: ", progname
);
86 fprintf (stderr
, s1
, s2
);
87 fprintf (stderr
, "\n");
90 /* Print error message and exit. */
94 fatal (const char *s1
, const char *s2
)
100 /* Like malloc but get fatal error if memory is exhausted. */
103 xmalloc (unsigned int size
)
105 void *result
= (void *) malloc (size
);
107 fatal ("virtual memory exhausted", 0);
111 /* Like strdup, but get fatal error if memory is exhausted. */
116 char *result
= strdup (s
);
118 fatal ("virtual memory exhausted", 0);
122 /* Like realloc but get fatal error if memory is exhausted. */
125 xrealloc (void *arg
, unsigned int size
)
127 void *result
= (void *) realloc (arg
, size
);
129 fatal ("virtual memory exhausted", 0);
135 main (int argc
, char **argv
)
142 /* If first two args are -o FILE, output to FILE. */
144 if (argc
> i
+ 1 && !strcmp (argv
[i
], "-o"))
146 if (! freopen (argv
[i
+ 1], "w", stdout
))
148 perror (argv
[i
+ 1]);
153 if (argc
> i
+ 1 && !strcmp (argv
[i
], "-a"))
155 if (! freopen (argv
[i
+ 1], "a", stdout
))
157 perror (argv
[i
+ 1]);
162 if (argc
> i
+ 1 && !strcmp (argv
[i
], "-d"))
164 if (chdir (argv
[i
+ 1]) != 0)
166 perror (argv
[i
+ 1]);
171 if (argc
> i
&& !strcmp (argv
[i
], "-g"))
173 generate_globals
= 1;
177 set_binary_mode (fileno (stdout
), O_BINARY
);
179 if (generate_globals
)
183 scan_c_stream (stdin
);
186 int first_infile
= i
;
187 for (; i
< argc
; i
++)
190 /* Don't process one file twice. */
191 for (j
= first_infile
; j
< i
; j
++)
192 if (strcmp (argv
[i
], argv
[j
]) == 0)
195 err_count
+= scan_file (argv
[i
]);
199 if (err_count
== 0 && generate_globals
)
202 return (err_count
> 0 ? EXIT_FAILURE
: EXIT_SUCCESS
);
205 /* Add a source file name boundary marker in the output file. */
207 put_filename (char *filename
)
211 for (tmp
= filename
; *tmp
; tmp
++)
213 if (IS_DIRECTORY_SEP (*tmp
))
217 printf ("\037S%s\n", filename
);
220 /* Read file FILENAME and output its doc strings to stdout.
221 Return 1 if file is not found, 0 if it is found. */
224 scan_file (char *filename
)
227 size_t len
= strlen (filename
);
229 if (!generate_globals
)
230 put_filename (filename
);
231 if (len
> 4 && !strcmp (filename
+ len
- 4, ".elc"))
232 return scan_lisp_file (filename
, "rb");
233 else if (len
> 3 && !strcmp (filename
+ len
- 3, ".el"))
234 return scan_lisp_file (filename
, "r");
236 return scan_c_file (filename
, "r");
242 puts ("/* This file was auto-generated by make-docfile. */");
243 puts ("/* DO NOT EDIT. */");
244 puts ("struct emacs_globals {");
247 static char input_buffer
[128];
249 /* Some state during the execution of `read_c_string_or_comment'. */
252 /* A count of spaces and newlines that have been read, but not output. */
253 unsigned pending_spaces
, pending_newlines
;
255 /* Where we're reading from. */
258 /* If non-zero, a buffer into which to copy characters. */
260 /* If non-zero, a file into which to copy characters. */
263 /* A keyword we look for at the beginning of lines. If found, it is
264 not copied, and SAW_KEYWORD is set to true. */
266 /* The current point we've reached in an occurrence of KEYWORD in
268 const char *cur_keyword_ptr
;
269 /* Set to true if we saw an occurrence of KEYWORD. */
273 /* Output CH to the file or buffer in STATE. Any pending newlines or
274 spaces are output first. */
277 put_char (int ch
, struct rcsoc_state
*state
)
282 if (state
->pending_newlines
> 0)
284 state
->pending_newlines
--;
287 else if (state
->pending_spaces
> 0)
289 state
->pending_spaces
--;
296 putc (out_ch
, state
->out_file
);
298 *state
->buf_ptr
++ = out_ch
;
300 while (out_ch
!= ch
);
303 /* If in the middle of scanning a keyword, continue scanning with
304 character CH, otherwise output CH to the file or buffer in STATE.
305 Any pending newlines or spaces are output first, as well as any
306 previously scanned characters that were thought to be part of a
307 keyword, but were in fact not. */
310 scan_keyword_or_put_char (int ch
, struct rcsoc_state
*state
)
313 && *state
->cur_keyword_ptr
== ch
314 && (state
->cur_keyword_ptr
> state
->keyword
315 || state
->pending_newlines
> 0))
316 /* We might be looking at STATE->keyword at some point.
317 Keep looking until we know for sure. */
319 if (*++state
->cur_keyword_ptr
== '\0')
320 /* Saw the whole keyword. Set SAW_KEYWORD flag to true. */
322 state
->saw_keyword
= 1;
324 /* Reset the scanning pointer. */
325 state
->cur_keyword_ptr
= state
->keyword
;
327 /* Canonicalize whitespace preceding a usage string. */
328 state
->pending_newlines
= 2;
329 state
->pending_spaces
= 0;
331 /* Skip any whitespace between the keyword and the
334 ch
= getc (state
->in_file
);
335 while (ch
== ' ' || ch
== '\n');
337 /* Output the open-paren we just read. */
338 put_char (ch
, state
);
340 /* Skip the function name and replace it with `fn'. */
342 ch
= getc (state
->in_file
);
343 while (ch
!= ' ' && ch
!= ')');
344 put_char ('f', state
);
345 put_char ('n', state
);
347 /* Put back the last character. */
348 ungetc (ch
, state
->in_file
);
353 if (state
->keyword
&& state
->cur_keyword_ptr
> state
->keyword
)
354 /* We scanned the beginning of a potential usage
355 keyword, but it was a false alarm. Output the
360 for (p
= state
->keyword
; p
< state
->cur_keyword_ptr
; p
++)
361 put_char (*p
, state
);
363 state
->cur_keyword_ptr
= state
->keyword
;
366 put_char (ch
, state
);
371 /* Skip a C string or C-style comment from INFILE, and return the
372 character that follows. COMMENT non-zero means skip a comment. If
373 PRINTFLAG is positive, output string contents to stdout. If it is
374 negative, store contents in buf. Convert escape sequences \n and
375 \t to newline and tab; discard \ followed by newline.
376 If SAW_USAGE is non-zero, then any occurrences of the string `usage:'
377 at the beginning of a line will be removed, and *SAW_USAGE set to
378 true if any were encountered. */
381 read_c_string_or_comment (FILE *infile
, int printflag
, int comment
, int *saw_usage
)
384 struct rcsoc_state state
;
386 state
.in_file
= infile
;
387 state
.buf_ptr
= (printflag
< 0 ? input_buffer
: 0);
388 state
.out_file
= (printflag
> 0 ? stdout
: 0);
389 state
.pending_spaces
= 0;
390 state
.pending_newlines
= 0;
391 state
.keyword
= (saw_usage
? "usage:" : 0);
392 state
.cur_keyword_ptr
= state
.keyword
;
393 state
.saw_keyword
= 0;
397 while (c
== '\n' || c
== '\r' || c
== '\t' || c
== ' ')
402 while (c
!= EOF
&& (comment
? c
!= '*' : c
!= '"'))
407 if (c
== '\n' || c
== '\r')
419 state
.pending_spaces
++;
422 state
.pending_newlines
++;
423 state
.pending_spaces
= 0;
426 scan_keyword_or_put_char (c
, &state
);
442 scan_keyword_or_put_char ('*', &state
);
449 /* If we had a "", concatenate the two strings. */
458 *saw_usage
= state
.saw_keyword
;
465 /* Write to stdout the argument names of function FUNC, whose text is in BUF.
466 MINARGS and MAXARGS are the minimum and maximum number of arguments. */
469 write_c_args (char *func
, char *buf
, int minargs
, int maxargs
)
473 char *ident_start
IF_LINT (= NULL
);
474 size_t ident_length
= 0;
476 fputs ("(fn", stdout
);
481 for (p
= buf
; *p
; p
++)
485 /* Notice when a new identifier starts. */
486 if ((('A' <= c
&& c
<= 'Z')
487 || ('a' <= c
&& c
<= 'z')
488 || ('0' <= c
&& c
<= '9')
500 ident_length
= p
- ident_start
;
504 /* Found the end of an argument, write out the last seen
506 if (c
== ',' || c
== ')')
508 if (ident_length
== 0)
510 error ("empty arg list for `%s' should be (void), not ()", func
);
514 if (strncmp (ident_start
, "void", ident_length
) == 0)
519 if (minargs
== 0 && maxargs
> 0)
520 fputs ("&optional ", stdout
);
525 /* In C code, `default' is a reserved word, so we spell it
526 `defalt'; demangle that here. */
527 if (ident_length
== 6 && memcmp (ident_start
, "defalt", 6) == 0)
528 fputs ("DEFAULT", stdout
);
530 while (ident_length
-- > 0)
533 if (c
>= 'a' && c
<= 'z')
534 /* Upcase the letter. */
537 /* Print underscore as hyphen. */
547 /* The types of globals. These are sorted roughly in decreasing alignment
548 order to avoid allocation gaps, except that symbols and functions
560 /* A single global. */
563 enum global_type type
;
573 /* Bit values for FLAGS field from the above. Applied for DEFUNs only. */
574 enum { DEFUN_noreturn
= 1, DEFUN_const
= 2 };
576 /* All the variable names we saw while scanning C sources in `-g'
579 int num_globals_allocated
;
580 struct global
*globals
;
582 static struct global
*
583 add_global (enum global_type type
, char *name
, int value
, char const *svalue
)
585 /* Ignore the one non-symbol that can occur. */
586 if (strcmp (name
, "..."))
590 if (num_globals_allocated
== 0)
592 num_globals_allocated
= 100;
593 globals
= xmalloc (num_globals_allocated
* sizeof (struct global
));
595 else if (num_globals
== num_globals_allocated
)
597 num_globals_allocated
*= 2;
598 globals
= xrealloc (globals
,
599 num_globals_allocated
* sizeof (struct global
));
602 globals
[num_globals
- 1].type
= type
;
603 globals
[num_globals
- 1].name
= name
;
605 globals
[num_globals
- 1].v
.svalue
= svalue
;
607 globals
[num_globals
- 1].v
.value
= value
;
608 globals
[num_globals
- 1].flags
= 0;
609 return globals
+ num_globals
- 1;
615 compare_globals (const void *a
, const void *b
)
617 const struct global
*ga
= a
;
618 const struct global
*gb
= b
;
620 if (ga
->type
!= gb
->type
)
621 return ga
->type
- gb
->type
;
623 /* Consider "nil" to be the least, so that iQnil is zero. That
624 way, Qnil's internal representation is zero, which is a bit faster. */
625 if (ga
->type
== SYMBOL
)
627 bool a_nil
= strcmp (ga
->name
, "Qnil") == 0;
628 bool b_nil
= strcmp (gb
->name
, "Qnil") == 0;
630 return b_nil
- a_nil
;
633 return strcmp (ga
->name
, gb
->name
);
637 close_emacs_globals (int num_symbols
)
640 "extern struct emacs_globals globals;\n"
642 "#ifndef DEFINE_SYMBOLS\n"
645 "struct Lisp_Symbol alignas (GCALIGNMENT) lispsym[%d];\n"),
653 bool seen_defun
= false;
656 qsort (globals
, num_globals
, sizeof (struct global
), compare_globals
);
659 for (i
= 0; i
< num_globals
; i
++)
661 while (i
+ 1 < num_globals
662 && strcmp (globals
[i
].name
, globals
[i
+ 1].name
) == 0)
664 if (globals
[i
].type
== FUNCTION
665 && globals
[i
].v
.value
!= globals
[i
+ 1].v
.value
)
666 error ("function '%s' defined twice with differing signatures",
670 num_symbols
+= globals
[i
].type
== SYMBOL
;
671 globals
[j
++] = globals
[i
];
675 for (i
= 0; i
< num_globals
; ++i
)
677 char const *type
= 0;
679 switch (globals
[i
].type
)
688 type
= "Lisp_Object";
694 close_emacs_globals (num_symbols
);
700 fatal ("not a recognized DEFVAR_", 0);
705 printf (" %s f_%s;\n", type
, globals
[i
].name
);
706 printf ("#define %s globals.f_%s\n",
707 globals
[i
].name
, globals
[i
].name
);
709 else if (globals
[i
].type
== SYMBOL
)
710 printf (("DEFINE_LISP_SYMBOL_BEGIN (%s)\n"
712 "#define %s builtin_lisp_symbol (i%s)\n"
713 "DEFINE_LISP_SYMBOL_END (%s)\n\n"),
714 globals
[i
].name
, globals
[i
].name
, symnum
++,
715 globals
[i
].name
, globals
[i
].name
, globals
[i
].name
);
718 if (globals
[i
].flags
& DEFUN_noreturn
)
719 fputs ("_Noreturn ", stdout
);
721 printf ("EXFUN (%s, ", globals
[i
].name
);
722 if (globals
[i
].v
.value
== -1)
723 fputs ("MANY", stdout
);
724 else if (globals
[i
].v
.value
== -2)
725 fputs ("UNEVALLED", stdout
);
727 printf ("%d", globals
[i
].v
.value
);
730 if (globals
[i
].flags
& DEFUN_const
)
731 fputs (" ATTRIBUTE_CONST", stdout
);
732 else if (strcmp (globals
[i
].name
, "Fnext_read_file_uses_dialog_p")
735 /* It would be nice to have a cleaner way to deal with this
738 "#if ! (defined USE_GTK || defined USE_MOTIF \\\n"
739 " || defined HAVE_NS || defined HAVE_NTGUI)\n"
740 "\tATTRIBUTE_CONST\n"
750 close_emacs_globals (num_symbols
);
752 puts ("#ifdef DEFINE_SYMBOLS");
753 puts ("static char const *const defsym_name[] = {");
754 for (int i
= 0; i
< num_globals
; i
++)
756 if (globals
[i
].type
== SYMBOL
)
757 printf ("\t\"%s\",\n", globals
[i
].v
.svalue
);
758 while (i
+ 1 < num_globals
759 && strcmp (globals
[i
].name
, globals
[i
+ 1].name
) == 0)
767 /* Read through a c file. If a .o file is named,
768 the corresponding .c or .m file is read instead.
769 Looks for DEFUN constructs such as are defined in ../src/lisp.h.
770 Accepts any word starting DEF... so it finds DEFSIMPLE and DEFPRED. */
773 scan_c_file (char *filename
, const char *mode
)
776 int extension
= filename
[strlen (filename
) - 1];
778 if (extension
== 'o')
779 filename
[strlen (filename
) - 1] = 'c';
781 infile
= fopen (filename
, mode
);
783 if (infile
== NULL
&& extension
== 'o')
786 filename
[strlen (filename
) - 1] = 'm';
787 infile
= fopen (filename
, mode
);
789 filename
[strlen (filename
) - 1] = 'c'; /* Don't confuse people. */
792 /* No error if non-ex input file. */
799 /* Reset extension to be able to detect duplicate files. */
800 filename
[strlen (filename
) - 1] = extension
;
801 return scan_c_stream (infile
);
804 /* Return 1 if next input from INFILE is equal to P, -1 if EOF,
805 0 if input doesn't match. */
808 stream_match (FILE *infile
, const char *p
)
812 int c
= getc (infile
);
822 scan_c_stream (FILE *infile
)
824 int commas
, minargs
, maxargs
;
827 while (!feof (infile
))
831 int defvarperbufferflag
= 0;
833 enum global_type type
= INVALID
;
834 char *name
IF_LINT (= 0);
836 if (c
!= '\n' && c
!= '\r')
864 if (c
!= ' ' && c
!= '\t' && c
!= '(')
883 defvarperbufferflag
= (c
== 'P');
884 if (generate_globals
)
887 type
= EMACS_INTEGER
;
895 /* We need to distinguish between DEFVAR_BOOL and
896 DEFVAR_BUFFER_DEFAULTS. */
897 if (generate_globals
&& type
== BOOLEAN
&& c
!= 'O')
912 defunflag
= c
== 'U';
917 && (!defvarflag
|| defvarperbufferflag
|| type
== INVALID
)
918 && !defunflag
&& type
!= SYMBOL
)
930 /* Lisp variable or function name. */
934 c
= read_c_string_or_comment (infile
, -1, 0, 0);
937 if (generate_globals
)
940 char const *svalue
= 0;
942 /* Skip "," and whitespace. */
947 while (c
== ',' || c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r');
949 /* Read in the identifier. */
954 input_buffer
[i
++] = c
;
957 while (! (c
== ',' || c
== ' ' || c
== '\t'
958 || c
== '\n' || c
== '\r'));
959 input_buffer
[i
] = '\0';
961 name
= xmalloc (i
+ 1);
962 memcpy (name
, input_buffer
, i
+ 1);
968 while (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r');
971 c
= read_c_string_or_comment (infile
, -1, 0, 0);
972 svalue
= xstrdup (input_buffer
);
977 add_global (type
, name
, 0, svalue
);
985 /* DEFVAR_LISP ("name", addr, "doc")
986 DEFVAR_LISP ("name", addr /\* doc *\/)
987 DEFVAR_LISP ("name", addr, doc: /\* doc *\/) */
990 commas
= generate_globals
? 4 : 5;
991 else if (defvarperbufferflag
)
995 else /* For DEFSIMPLE and DEFPRED. */
1004 if (defunflag
&& (commas
== 1 || commas
== 2))
1009 while (c
== ' ' || c
== '\n' || c
== '\r' || c
== '\t');
1013 if (commas
== 2) /* Pick up minargs. */
1014 scanned
= fscanf (infile
, "%d", &minargs
);
1015 else /* Pick up maxargs. */
1016 if (c
== 'M' || c
== 'U') /* MANY || UNEVALLED */
1018 if (generate_globals
)
1019 maxargs
= (c
== 'M') ? -1 : -2;
1024 scanned
= fscanf (infile
, "%d", &maxargs
);
1035 if (generate_globals
)
1037 struct global
*g
= add_global (FUNCTION
, name
, maxargs
, 0);
1039 /* The following code tries to recognize function attributes
1040 specified after the docstring, e.g.:
1042 DEFUN ("foo", Ffoo, Sfoo, X, Y, Z,
1044 attributes: attribute1 attribute2 ...)
1045 (Lisp_Object arg...)
1047 Now only 'noreturn' and 'const' attributes are used. */
1049 /* Advance to the end of docstring. */
1053 int d
= getc (infile
);
1058 if (c
== '*' && d
== '/')
1060 c
= d
, d
= getc (infile
);
1064 /* Skip spaces, if any. */
1071 while (c
== ' ' || c
== '\n' || c
== '\r' || c
== '\t');
1072 /* Check for 'attributes:' token. */
1073 if (c
== 'a' && stream_match (infile
, "ttributes:"))
1075 char *p
= input_buffer
;
1076 /* Collect attributes up to ')'. */
1084 if (p
- input_buffer
> sizeof (input_buffer
))
1089 if (strstr (input_buffer
, "noreturn"))
1090 g
->flags
|= DEFUN_noreturn
;
1091 if (strstr (input_buffer
, "const"))
1092 g
->flags
|= DEFUN_const
;
1097 while (c
== ' ' || c
== '\n' || c
== '\r' || c
== '\t')
1101 c
= read_c_string_or_comment (infile
, 0, 0, 0);
1103 while (c
!= EOF
&& c
!= ',' && c
!= '/')
1108 while (c
== ' ' || c
== '\n' || c
== '\r' || c
== '\t')
1110 while ((c
>= 'a' && c
<= 'z') || (c
>= 'Z' && c
<= 'Z'))
1116 while (c
== ' ' || c
== '\n' || c
== '\r' || c
== '\t')
1123 && (c
= getc (infile
),
1127 int comment
= c
!= '"';
1130 printf ("\037%c%s\n", defvarflag
? 'V' : 'F', input_buffer
);
1133 getc (infile
); /* Skip past `*'. */
1134 c
= read_c_string_or_comment (infile
, 1, comment
, &saw_usage
);
1136 /* If this is a defun, find the arguments and print them. If
1137 this function takes MANY or UNEVALLED args, then the C source
1138 won't give the names of the arguments, so we shouldn't bother
1139 trying to find them.
1141 Various doc-string styles:
1142 0: DEFUN (..., "DOC") (args) [!comment]
1143 1: DEFUN (..., /\* DOC *\/ (args)) [comment && !doc_keyword]
1144 2: DEFUN (..., doc: /\* DOC *\/) (args) [comment && doc_keyword]
1146 if (defunflag
&& maxargs
!= -1 && !saw_usage
)
1148 char argbuf
[1024], *p
= argbuf
;
1150 if (!comment
|| doc_keyword
)
1158 /* Skip into arguments. */
1165 /* Copy arguments into ARGBUF. */
1168 *p
++ = c
= getc (infile
);
1172 fputs ("\n\n", stdout
);
1173 write_c_args (input_buffer
, argbuf
, minargs
, maxargs
);
1175 else if (defunflag
&& maxargs
== -1 && !saw_usage
)
1176 /* The DOC should provide the usage form. */
1177 fprintf (stderr
, "Missing `usage' for function `%s'.\n",
1186 /* Read a file of Lisp code, compiled or interpreted.
1188 (defun NAME ARGS DOCSTRING ...)
1189 (defmacro NAME ARGS DOCSTRING ...)
1190 (defsubst NAME ARGS DOCSTRING ...)
1191 (autoload (quote NAME) FILE DOCSTRING ...)
1192 (defvar NAME VALUE DOCSTRING)
1193 (defconst NAME VALUE DOCSTRING)
1194 (fset (quote NAME) (make-byte-code ... DOCSTRING ...))
1195 (fset (quote NAME) #[... DOCSTRING ...])
1196 (defalias (quote NAME) #[... DOCSTRING ...])
1197 (custom-declare-variable (quote NAME) VALUE DOCSTRING ...)
1198 starting in column zero.
1199 (quote NAME) may appear as 'NAME as well.
1201 We also look for #@LENGTH CONTENTS^_ at the beginning of the line.
1202 When we find that, we save it for the following defining-form,
1203 and we use that instead of reading a doc string within that defining-form.
1205 For defvar, defconst, and fset we skip to the docstring with a kludgy
1206 formatting convention: all docstrings must appear on the same line as the
1207 initial open-paren (the one in column zero) and must contain a backslash
1208 and a newline immediately after the initial double-quote. No newlines
1209 must appear between the beginning of the form and the first double-quote.
1210 For defun, defmacro, and autoload, we know how to skip over the
1211 arglist, but the doc string must still have a backslash and newline
1212 immediately after the double quote.
1213 The only source files that must follow this convention are preloaded
1214 uncompiled ones like loaddefs.el; aside from that, it is always the .elc
1215 file that we should look at, and they are no problem because byte-compiler
1216 output follows this convention.
1217 The NAME and DOCSTRING are output.
1218 NAME is preceded by `F' for a function or `V' for a variable.
1219 An entry is output only if DOCSTRING has \ newline just after the opening ".
1223 skip_white (FILE *infile
)
1226 while (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r')
1232 read_lisp_symbol (FILE *infile
, char *buffer
)
1235 char *fillp
= buffer
;
1237 skip_white (infile
);
1242 *(++fillp
) = getc (infile
);
1243 else if (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r' || c
== '(' || c
== ')')
1254 fprintf (stderr
, "## expected a symbol, got '%c'\n", c
);
1256 skip_white (infile
);
1260 search_lisp_doc_at_eol (FILE *infile
)
1262 int c
= 0, c1
= 0, c2
= 0;
1264 /* Skip until the end of line; remember two previous chars. */
1265 while (c
!= '\n' && c
!= '\r' && c
!= EOF
)
1272 /* If two previous characters were " and \,
1273 this is a doc string. Otherwise, there is none. */
1274 if (c2
!= '"' || c1
!= '\\')
1277 fprintf (stderr
, "## non-docstring found\n");
1286 #define DEF_ELISP_FILE(fn) { #fn, sizeof(#fn) - 1 }
1289 scan_lisp_file (const char *filename
, const char *mode
)
1293 char *saved_string
= 0;
1294 /* These are the only files that are loaded uncompiled, and must
1295 follow the conventions of the doc strings expected by this
1296 function. These conventions are automatically followed by the
1297 byte compiler when it produces the .elc files. */
1301 } const uncompiled
[] = {
1302 DEF_ELISP_FILE (loaddefs
.el
),
1303 DEF_ELISP_FILE (loadup
.el
),
1304 DEF_ELISP_FILE (charprop
.el
),
1305 DEF_ELISP_FILE (cp51932
.el
),
1306 DEF_ELISP_FILE (eucjp
-ms
.el
)
1309 size_t flen
= strlen (filename
);
1311 if (generate_globals
)
1312 fatal ("scanning lisp file when -g specified", 0);
1313 if (flen
> 3 && !strcmp (filename
+ flen
- 3, ".el"))
1315 for (i
= 0, match
= 0; i
< sizeof (uncompiled
) / sizeof (uncompiled
[0]);
1318 if (uncompiled
[i
].fl
<= flen
1319 && !strcmp (filename
+ flen
- uncompiled
[i
].fl
, uncompiled
[i
].fn
)
1320 && (flen
== uncompiled
[i
].fl
1321 || IS_SLASH (filename
[flen
- uncompiled
[i
].fl
- 1])))
1328 fatal ("uncompiled lisp file %s is not supported", filename
);
1331 infile
= fopen (filename
, mode
);
1335 return 0; /* No error. */
1339 while (!feof (infile
))
1341 char buffer
[BUFSIZ
];
1344 /* If not at end of line, skip till we get to one. */
1345 if (c
!= '\n' && c
!= '\r')
1350 /* Skip the line break. */
1351 while (c
== '\n' || c
== '\r')
1353 /* Detect a dynamic doc string and save it for the next expression. */
1362 /* Read the length. */
1363 while ((c
= getc (infile
),
1364 c
>= '0' && c
<= '9'))
1371 fatal ("invalid dynamic doc string length", "");
1374 fatal ("space not found after dynamic doc string length", "");
1376 /* The next character is a space that is counted in the length
1377 but not part of the doc string.
1378 We already read it, so just ignore it. */
1381 /* Read in the contents. */
1382 free (saved_string
);
1383 saved_string
= (char *) xmalloc (length
);
1384 for (i
= 0; i
< length
; i
++)
1385 saved_string
[i
] = getc (infile
);
1386 /* The last character is a ^_.
1387 That is needed in the .elc file
1388 but it is redundant in DOC. So get rid of it here. */
1389 saved_string
[length
- 1] = 0;
1390 /* Skip the line break. */
1391 while (c
== '\n' || c
== '\r')
1393 /* Skip the following line. */
1394 while (c
!= '\n' && c
!= '\r')
1403 read_lisp_symbol (infile
, buffer
);
1405 if (! strcmp (buffer
, "defun")
1406 || ! strcmp (buffer
, "defmacro")
1407 || ! strcmp (buffer
, "defsubst"))
1410 read_lisp_symbol (infile
, buffer
);
1412 /* Skip the arguments: either "nil" or a list in parens. */
1415 if (c
== 'n') /* nil */
1417 if ((c
= getc (infile
)) != 'i'
1418 || (c
= getc (infile
)) != 'l')
1420 fprintf (stderr
, "## unparsable arglist in %s (%s)\n",
1427 fprintf (stderr
, "## unparsable arglist in %s (%s)\n",
1434 skip_white (infile
);
1436 /* If the next three characters aren't `dquote bslash newline'
1437 then we're not reading a docstring.
1439 if ((c
= getc (infile
)) != '"'
1440 || (c
= getc (infile
)) != '\\'
1441 || ((c
= getc (infile
)) != '\n' && c
!= '\r'))
1444 fprintf (stderr
, "## non-docstring in %s (%s)\n",
1451 /* defcustom can only occur in uncompiled Lisp files. */
1452 else if (! strcmp (buffer
, "defvar")
1453 || ! strcmp (buffer
, "defconst")
1454 || ! strcmp (buffer
, "defcustom"))
1457 read_lisp_symbol (infile
, buffer
);
1459 if (saved_string
== 0)
1460 if (!search_lisp_doc_at_eol (infile
))
1464 else if (! strcmp (buffer
, "custom-declare-variable")
1465 || ! strcmp (buffer
, "defvaralias")
1472 read_lisp_symbol (infile
, buffer
);
1478 "## unparsable name in custom-declare-variable in %s\n",
1482 read_lisp_symbol (infile
, buffer
);
1483 if (strcmp (buffer
, "quote"))
1486 "## unparsable name in custom-declare-variable in %s\n",
1490 read_lisp_symbol (infile
, buffer
);
1495 "## unparsable quoted name in custom-declare-variable in %s\n",
1501 if (saved_string
== 0)
1502 if (!search_lisp_doc_at_eol (infile
))
1506 else if (! strcmp (buffer
, "fset") || ! strcmp (buffer
, "defalias"))
1512 read_lisp_symbol (infile
, buffer
);
1517 fprintf (stderr
, "## unparsable name in fset in %s\n",
1521 read_lisp_symbol (infile
, buffer
);
1522 if (strcmp (buffer
, "quote"))
1524 fprintf (stderr
, "## unparsable name in fset in %s\n",
1528 read_lisp_symbol (infile
, buffer
);
1533 "## unparsable quoted name in fset in %s\n",
1539 if (saved_string
== 0)
1540 if (!search_lisp_doc_at_eol (infile
))
1544 else if (! strcmp (buffer
, "autoload"))
1549 read_lisp_symbol (infile
, buffer
);
1554 fprintf (stderr
, "## unparsable name in autoload in %s\n",
1558 read_lisp_symbol (infile
, buffer
);
1559 if (strcmp (buffer
, "quote"))
1561 fprintf (stderr
, "## unparsable name in autoload in %s\n",
1565 read_lisp_symbol (infile
, buffer
);
1570 "## unparsable quoted name in autoload in %s\n",
1575 skip_white (infile
);
1576 if ((c
= getc (infile
)) != '\"')
1578 fprintf (stderr
, "## autoload of %s unparsable (%s)\n",
1582 read_c_string_or_comment (infile
, 0, 0, 0);
1584 if (saved_string
== 0)
1585 if (!search_lisp_doc_at_eol (infile
))
1590 else if (! strcmp (buffer
, "if")
1591 || ! strcmp (buffer
, "byte-code"))
1598 fprintf (stderr
, "## unrecognized top-level form, %s (%s)\n",
1604 /* At this point, we should either use the previous dynamic doc string in
1605 saved_string or gobble a doc string from the input file.
1606 In the latter case, the opening quote (and leading backslash-newline)
1607 have already been read. */
1609 printf ("\037%c%s\n", type
, buffer
);
1612 fputs (saved_string
, stdout
);
1613 /* Don't use one dynamic doc string twice. */
1614 free (saved_string
);
1618 read_c_string_or_comment (infile
, 1, 0, 0);
1625 /* make-docfile.c ends here */