1 /* Give this program DOC-mm.nn.oo as standard input and it outputs to
2 standard output a file of texinfo input containing the doc strings.
4 Copyright (C) 1989, 1992, 1994, 1996, 1999, 2000, 2001, 2002, 2003,
5 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
7 This file is part of GNU Emacs.
9 GNU Emacs is free software: you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version.
14 GNU Emacs is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
23 /* This version sorts the output by function name. */
32 #include <fcntl.h> /* for O_BINARY */
33 #include <io.h> /* for setmode */
35 #ifndef HAVE_STDLIB_H /* config.h includes stdlib. */
36 #ifndef WINDOWSNT /* src/s/ms-w32.h includes stdlib.h */
37 extern char *malloc ();
46 typedef struct line LINE
;
50 LINE
*next
; /* ptr to next or NULL */
51 char *line
; /* text of the line */
54 typedef struct docstr DOCSTR
;
56 struct docstr
/* Allocated thing for an entry. */
58 DOCSTR
*next
; /* next in the chain */
59 char *name
; /* name of the function or var */
60 LINE
*first
; /* first line of doc text. */
61 char type
; /* 'F' for function, 'V' for variable */
65 /* Print error message. `s1' is printf control string, `s2' is arg for it. */
68 error (const char *s1
, const char *s2
)
70 fprintf (stderr
, "sorted-doc: ");
71 fprintf (stderr
, s1
, s2
);
72 fprintf (stderr
, "\n");
75 /* Print error message and exit. */
78 fatal (const char *s1
, const char *s2
)
84 /* Like malloc but get fatal error if memory is exhausted. */
89 char *result
= malloc ((unsigned)size
);
91 fatal ("%s", "virtual memory exhausted");
98 char *buf
= xmalloc (strlen (str
) + 1);
99 (void) strcpy (buf
, str
);
103 /* Comparison function for qsort to call. */
106 cmpdoc (const void *va
, const void *vb
)
108 DOCSTR
*const *a
= va
;
109 DOCSTR
*const *b
= vb
;
110 register int val
= strcmp ((*a
)->name
, (*b
)->name
);
112 return (*a
)->type
- (*b
)->type
;
117 WAITING
, BEG_NAME
, NAME_GET
, BEG_DESC
, DESC_GET
120 const char *states
[] =
122 "WAITING", "BEG_NAME", "NAME_GET", "BEG_DESC", "DESC_GET"
128 register DOCSTR
*dp
= NULL
; /* allocated DOCSTR */
129 register LINE
*lp
= NULL
; /* allocated line */
130 register char *bp
; /* ptr inside line buffer */
131 register enum state state
= WAITING
; /* state at start */
132 int cnt
= 0; /* number of DOCSTRs read */
134 DOCSTR
*docs
= NULL
; /* chain of allocated DOCSTRS */
135 char buf
[512]; /* line buffer */
138 /* DOC is a binary file. */
139 if (!isatty (fileno (stdin
)))
140 setmode (fileno (stdin
), O_BINARY
);
145 while (1) /* process one char at a time */
147 /* this char from the DOCSTR file */
148 register int ch
= getchar ();
152 if (state
== WAITING
)
157 else if (state
== BEG_NAME
)
160 if (dp
== NULL
) /* first dp allocated */
162 docs
= dp
= (DOCSTR
*) xmalloc (sizeof (DOCSTR
));
164 else /* all the rest */
166 dp
->next
= (DOCSTR
*) xmalloc (sizeof (DOCSTR
));
173 /* Record whether function or variable. */
177 else if (state
== BEG_DESC
)
179 if (lp
== NULL
) /* first line for dp */
181 dp
->first
= lp
= (LINE
*)xmalloc (sizeof (LINE
));
183 else /* continuing lines */
185 lp
->next
= (LINE
*)xmalloc (sizeof (LINE
));
195 if (state
== NAME_GET
|| state
== DESC_GET
)
197 if (ch
!= MARKER
&& ch
!= '\n' && ch
!= EOF
)
201 else /* saving and changing state */
206 if (state
== NAME_GET
)
212 state
= (ch
== MARKER
) ? BEG_NAME
: BEG_DESC
;
214 } /* NAME_GET || DESC_GET */
221 register int i
; /* counter */
223 /* build array of ptrs to DOCSTRs */
225 array
= (DOCSTR
**)xmalloc (cnt
* sizeof (*array
));
226 for (dp
= docs
, i
= 0; dp
!= NULL
; dp
= dp
->next
)
229 /* sort the array by name; within each name, by type */
231 qsort ((char*)array
, cnt
, sizeof (DOCSTR
*), cmpdoc
);
233 /* write the output header */
235 printf ("\\input texinfo @c -*-texinfo-*-\n");
236 printf ("@setfilename ../info/summary\n");
237 printf ("@settitle Command Summary for GNU Emacs\n");
238 printf ("@finalout\n");
239 printf ("@unnumbered Command Summary for GNU Emacs\n");
240 printf ("@table @asis\n");
243 printf ("@global@let@ITEM@item\n");
244 printf ("@def@item{@filbreak@vskip5pt@ITEM}\n");
245 printf ("@font@tensy cmsy10 scaled @magstephalf\n");
246 printf ("@font@teni cmmi10 scaled @magstephalf\n");
247 printf ("@def\\{{@tensy@char110}}\n"); /* this backslash goes with cmr10 */
248 printf ("@def|{{@tensy@char106}}\n");
249 printf ("@def@{{{@tensy@char102}}\n");
250 printf ("@def@}{{@tensy@char103}}\n");
251 printf ("@def<{{@teni@char62}}\n");
252 printf ("@def>{{@teni@char60}}\n");
253 printf ("@chardef@@64\n");
254 printf ("@catcode43=12\n");
255 printf ("@tableindent-0.2in\n");
256 printf ("@end iftex\n");
258 /* print each function from the array */
260 for (i
= 0; i
< cnt
; i
++)
262 printf ("\n@item %s @code{%s}\n@display\n",
263 array
[i
]->type
== 'F' ? "Function" : "Variable",
266 for (lp
= array
[i
]->first
; lp
!= NULL
; lp
= lp
->next
)
268 for (bp
= lp
->line
; *bp
; bp
++)
270 /* the characters "@{}" need special treatment */
271 if (*bp
== '@' || *bp
== '{' || *bp
== '}')
279 printf("@end display\n");
280 /* Try to avoid a save size overflow in the TeX output
282 if (i
%100 == 0 && i
> 0 && i
!= cnt
)
283 printf("\n@end table\n@table @asis\n");
286 printf ("@end table\n");
293 /* arch-tag: ce28f204-1e70-4b34-8210-3d54a5662071
294 (do not change this comment) */
296 /* sorted-doc.c ends here */