1 /* Generate doc-string file for GNU Emacs from source files.
2 Copyright (C) 1985, 1986, 1992, 1993, 1994 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
20 /* The arguments given to this program are all the C and Lisp source files
21 of GNU Emacs. .elc and .el and .c files are allowed.
22 A .o file can also be specified; the .c file it was made from is used.
23 This helps the makefile pass the correct list of files.
25 The results, which go to standard output or to a file
26 specified with -a or -o (-a to append, -o to start from nothing),
27 are entries containing function or variable names and their documentation.
28 Each entry starts with a ^_ character.
29 Then comes F for a function or V for a variable.
30 Then comes the function or variable name, terminated with a newline.
31 Then comes the documentation for that function or variable.
34 #define NO_SHORTNAMES /* Tell config not to load remap.h */
35 #include <../src/config.h>
45 #endif /* WINDOWSNT */
48 #define READ_TEXT "rt"
49 #define READ_BINARY "rb"
50 #else /* not DOS_NT */
52 #define READ_BINARY "r"
53 #endif /* not DOS_NT */
56 int scan_lisp_file ();
60 /* s/msdos.h defines this as sys_chdir, but we're not linking with the
61 file where that function is defined. */
65 /* Stdio stream for output to the DOC file. */
68 /* Name this program was invoked with. */
71 /* Print error message. `s1' is printf control string, `s2' is arg for it. */
78 fprintf (stderr
, "%s: ", progname
);
79 fprintf (stderr
, s1
, s2
);
80 fprintf (stderr
, "\n");
83 /* Print error message and exit. */
94 /* Like malloc but get fatal error if memory is exhausted. */
100 long *result
= (long *) malloc (size
);
102 fatal ("virtual memory exhausted", 0);
119 /* Don't put CRs in the DOC file. */
122 #if 0 /* Suspicion is that this causes hanging.
123 So instead we require people to use -o on MSDOS. */
124 (stdout
)->_flag
&= ~_IOTEXT
;
125 _setmode (fileno (stdout
), O_BINARY
);
131 _setmode (fileno (stdout
), O_BINARY
);
132 #endif /* WINDOWSNT */
134 /* If first two args are -o FILE, output to FILE. */
136 if (argc
> i
+ 1 && !strcmp (argv
[i
], "-o"))
138 outfile
= fopen (argv
[i
+ 1], "w");
141 if (argc
> i
+ 1 && !strcmp (argv
[i
], "-a"))
143 outfile
= fopen (argv
[i
+ 1], "a");
146 if (argc
> i
+ 1 && !strcmp (argv
[i
], "-d"))
153 fatal ("No output file specified", "");
156 for (; i
< argc
; i
++)
159 /* Don't process one file twice. */
160 for (j
= first_infile
; j
< i
; j
++)
161 if (! strcmp (argv
[i
], argv
[j
]))
164 err_count
+= scan_file (argv
[i
]);
167 exit (err_count
> 0);
169 return err_count
> 0;
172 /* Read file FILENAME and output its doc strings to outfile. */
173 /* Return 1 if file is not found, 0 if it is found. */
179 int len
= strlen (filename
);
180 if (len
> 4 && !strcmp (filename
+ len
- 4, ".elc"))
181 return scan_lisp_file (filename
, READ_BINARY
);
182 else if (len
> 3 && !strcmp (filename
+ len
- 3, ".el"))
183 return scan_lisp_file (filename
, READ_TEXT
);
185 return scan_c_file (filename
, READ_TEXT
);
190 /* Skip a C string from INFILE,
191 and return the character that follows the closing ".
192 If printflag is positive, output string contents to outfile.
193 If it is negative, store contents in buf.
194 Convert escape sequences \n and \t to newline and tab;
195 discard \ followed by newline. */
198 read_c_string (infile
, printflag
)
208 while (c
!= '"' && c
!= EOF
)
225 else if (printflag
< 0)
232 /* If we had a "", concatenate the two strings. */
242 /* Write to file OUT the argument names of function FUNC, whose text is in BUF.
243 MINARGS and MAXARGS are the minimum and maximum number of arguments. */
246 write_c_args (out
, func
, buf
, minargs
, maxargs
)
249 int minargs
, maxargs
;
256 fprintf (out
, "(%s", func
);
261 for (p
= buf
; *p
; p
++)
266 /* Notice when we start printing a new identifier. */
267 if ((('A' <= c
&& c
<= 'Z')
268 || ('a' <= c
&& c
<= 'z')
269 || ('0' <= c
&& c
<= '9')
281 if (minargs
== 0 && maxargs
> 0)
282 fprintf (out
, "&optional ");
292 /* Print the C argument list as it would appear in lisp:
293 print underscores as hyphens, and print commas as spaces.
294 Collapse adjacent spaces into one. */
295 if (c
== '_') c
= '-';
296 if (c
== ',') c
= ' ';
298 /* In C code, `default' is a reserved word, so we spell it
299 `defalt'; unmangle that here. */
301 && strncmp (p
, "defalt", 6) == 0
302 && ! (('A' <= p
[6] && p
[6] <= 'Z')
303 || ('a' <= p
[6] && p
[6] <= 'z')
304 || ('0' <= p
[6] && p
[6] <= '9')
307 fprintf (out
, "DEFAULT");
312 else if (c
!= ' ' || ! just_spaced
)
314 if (c
>= 'a' && c
<= 'z')
315 /* Upcase the letter. */
320 just_spaced
= (c
== ' ');
325 /* Read through a c file. If a .o file is named,
326 the corresponding .c file is read instead.
327 Looks for DEFUN constructs such as are defined in ../src/lisp.h.
328 Accepts any word starting DEF... so it finds DEFSIMPLE and DEFPRED. */
331 scan_c_file (filename
, mode
)
332 char *filename
, *mode
;
337 register int defunflag
;
338 register int defvarperbufferflag
;
339 register int defvarflag
;
340 int minargs
, maxargs
;
341 int extension
= filename
[strlen (filename
) - 1];
343 if (extension
== 'o')
344 filename
[strlen (filename
) - 1] = 'c';
346 infile
= fopen (filename
, mode
);
348 /* No error if non-ex input file */
355 /* Reset extension to be able to detect duplicate files. */
356 filename
[strlen (filename
) - 1] = extension
;
359 while (!feof (infile
))
396 defvarperbufferflag
= (c
== 'P');
409 defunflag
= c
== 'U';
424 c
= read_c_string (infile
, -1);
428 else if (defvarperbufferflag
)
432 else /* For DEFSIMPLE and DEFPRED */
440 if (defunflag
&& (commas
== 1 || commas
== 2))
444 while (c
== ' ' || c
== '\n' || c
== '\t');
448 if (commas
== 2) /* pick up minargs */
449 fscanf (infile
, "%d", &minargs
);
450 else /* pick up maxargs */
451 if (c
== 'M' || c
== 'U') /* MANY || UNEVALLED */
454 fscanf (infile
, "%d", &maxargs
);
461 while (c
== ' ' || c
== '\n' || c
== '\t')
464 c
= read_c_string (infile
, 0);
468 while (c
== ' ' || c
== '\n' || c
== '\t')
474 putc (defvarflag
? 'V' : 'F', outfile
);
475 fprintf (outfile
, "%s\n", buf
);
476 c
= read_c_string (infile
, 1);
478 /* If this is a defun, find the arguments and print them. If
479 this function takes MANY or UNEVALLED args, then the C source
480 won't give the names of the arguments, so we shouldn't bother
481 trying to find them. */
482 if (defunflag
&& maxargs
!= -1)
484 char argbuf
[1024], *p
= argbuf
;
491 /* Skip into arguments. */
498 /* Copy arguments into ARGBUF. */
501 *p
++ = c
= getc (infile
);
505 fprintf (outfile
, "\n\n");
506 write_c_args (outfile
, buf
, argbuf
, minargs
, maxargs
);
515 /* Read a file of Lisp code, compiled or interpreted.
517 (defun NAME ARGS DOCSTRING ...)
518 (defmacro NAME ARGS DOCSTRING ...)
519 (autoload (quote NAME) FILE DOCSTRING ...)
520 (defvar NAME VALUE DOCSTRING)
521 (defconst NAME VALUE DOCSTRING)
522 (fset (quote NAME) (make-byte-code ... DOCSTRING ...))
523 (fset (quote NAME) #[... DOCSTRING ...])
524 (defalias (quote NAME) #[... DOCSTRING ...])
525 starting in column zero.
526 (quote NAME) may appear as 'NAME as well.
528 We also look for #@LENGTH CONTENTS^_ at the beginning of the line.
529 When we find that, we save it for the following defining-form,
530 and we use that instead of reading a doc string within that defining-form.
532 For defun, defmacro, and autoload, we know how to skip over the arglist.
533 For defvar, defconst, and fset we skip to the docstring with a kludgy
534 formatting convention: all docstrings must appear on the same line as the
535 initial open-paren (the one in column zero) and must contain a backslash
536 and a double-quote immediately after the initial double-quote. No newlines
537 must appear between the beginning of the form and the first double-quote.
538 The only source file that must follow this convention is loaddefs.el; aside
539 from that, it is always the .elc file that we look at, and they are no
540 problem because byte-compiler output follows this convention.
541 The NAME and DOCSTRING are output.
542 NAME is preceded by `F' for a function or `V' for a variable.
543 An entry is output only if DOCSTRING has \ newline just after the opening "
551 while (c
== ' ' || c
== '\t' || c
== '\n')
557 read_lisp_symbol (infile
, buffer
)
562 char *fillp
= buffer
;
569 *(++fillp
) = getc (infile
);
570 else if (c
== ' ' || c
== '\t' || c
== '\n' || c
== '(' || c
== ')')
581 fprintf (stderr
, "## expected a symbol, got '%c'\n", c
);
587 scan_lisp_file (filename
, mode
)
588 char *filename
, *mode
;
592 char *saved_string
= 0;
594 infile
= fopen (filename
, mode
);
598 return 0; /* No error */
602 while (!feof (infile
))
613 /* Detect a dynamic doc string and save it for the next expression. */
622 /* Read the length. */
623 while ((c
= getc (infile
),
624 c
>= '0' && c
<= '9'))
630 /* The next character is a space that is counted in the length
631 but not part of the doc string.
632 We already read it, so just ignore it. */
635 /* Read in the contents. */
636 if (saved_string
!= 0)
638 saved_string
= (char *) malloc (length
);
639 for (i
= 0; i
< length
; i
++)
640 saved_string
[i
] = getc (infile
);
641 /* The last character is a ^_.
642 That is needed in the .elc file
643 but it is redundant in DOC. So get rid of it here. */
644 saved_string
[length
- 1] = 0;
645 /* Skip the newline. */
656 read_lisp_symbol (infile
, buffer
);
658 if (! strcmp (buffer
, "defun") ||
659 ! strcmp (buffer
, "defmacro"))
662 read_lisp_symbol (infile
, buffer
);
664 /* Skip the arguments: either "nil" or a list in parens */
667 if (c
== 'n') /* nil */
669 if ((c
= getc (infile
)) != 'i' ||
670 (c
= getc (infile
)) != 'l')
672 fprintf (stderr
, "## unparsable arglist in %s (%s)\n",
679 fprintf (stderr
, "## unparsable arglist in %s (%s)\n",
688 /* If the next three characters aren't `dquote bslash newline'
689 then we're not reading a docstring.
691 if ((c
= getc (infile
)) != '"' ||
692 (c
= getc (infile
)) != '\\' ||
693 (c
= getc (infile
)) != '\n')
696 fprintf (stderr
, "## non-docstring in %s (%s)\n",
703 else if (! strcmp (buffer
, "defvar") ||
704 ! strcmp (buffer
, "defconst"))
708 read_lisp_symbol (infile
, buffer
);
710 if (saved_string
== 0)
713 /* Skip until the first newline; remember the two previous chars. */
714 while (c
!= '\n' && c
>= 0)
721 /* If two previous characters were " and \,
722 this is a doc string. Otherwise, there is none. */
723 if (c2
!= '"' || c1
!= '\\')
726 fprintf (stderr
, "## non-docstring in %s (%s)\n",
734 else if (! strcmp (buffer
, "fset") || ! strcmp (buffer
, "defalias"))
741 read_lisp_symbol (infile
, buffer
);
746 fprintf (stderr
, "## unparsable name in fset in %s\n",
750 read_lisp_symbol (infile
, buffer
);
751 if (strcmp (buffer
, "quote"))
753 fprintf (stderr
, "## unparsable name in fset in %s\n",
757 read_lisp_symbol (infile
, buffer
);
762 "## unparsable quoted name in fset in %s\n",
768 if (saved_string
== 0)
770 /* Skip until the first newline; remember the two previous chars. */
771 while (c
!= '\n' && c
>= 0)
778 /* If two previous characters were " and \,
779 this is a doc string. Otherwise, there is none. */
780 if (c2
!= '"' || c1
!= '\\')
783 fprintf (stderr
, "## non-docstring in %s (%s)\n",
791 else if (! strcmp (buffer
, "autoload"))
796 read_lisp_symbol (infile
, buffer
);
801 fprintf (stderr
, "## unparsable name in autoload in %s\n",
805 read_lisp_symbol (infile
, buffer
);
806 if (strcmp (buffer
, "quote"))
808 fprintf (stderr
, "## unparsable name in autoload in %s\n",
812 read_lisp_symbol (infile
, buffer
);
817 "## unparsable quoted name in autoload in %s\n",
823 if ((c
= getc (infile
)) != '\"')
825 fprintf (stderr
, "## autoload of %s unparsable (%s)\n",
829 read_c_string (infile
, 0);
832 if (saved_string
== 0)
834 /* If the next three characters aren't `dquote bslash newline'
835 then we're not reading a docstring. */
836 if ((c
= getc (infile
)) != '"' ||
837 (c
= getc (infile
)) != '\\' ||
838 (c
= getc (infile
)) != '\n')
841 fprintf (stderr
, "## non-docstring in %s (%s)\n",
850 else if (! strcmp (buffer
, "if") ||
851 ! strcmp (buffer
, "byte-code"))
858 fprintf (stderr
, "## unrecognised top-level form, %s (%s)\n",
864 /* At this point, we should either use the previous
865 dynamic doc string in saved_string
866 or gobble a doc string from the input file.
868 In the latter case, the opening quote (and leading
869 backslash-newline) have already been read. */
872 putc (type
, outfile
);
873 fprintf (outfile
, "%s\n", buffer
);
876 fputs (saved_string
, outfile
);
877 /* Don't use one dynamic doc string twice. */
882 read_c_string (infile
, 1);