1 /* Give this program DOCSTR.mm.nn as standard input
2 and it outputs to standard output
3 a file of texinfo input containing the doc strings.
5 This version sorts the output by function name.
8 /* Synched up with: FSF 19.28. */
14 #include <stdlib.h> /* for qsort() and malloc() */
16 static void *xmalloc (size_t);
23 typedef struct LINE LINE;
27 LINE *next; /* ptr to next or NULL */
28 char *line; /* text of the line */
31 typedef struct docstr DOCSTR;
33 struct docstr /* Allocated thing for an entry. */
35 DOCSTR *next; /* next in the chain */
36 char *name; /* name of the function or var */
37 LINE *first; /* first line of doc text. */
38 char type; /* 'F' for function, 'V' for variable */
42 /* Print error message. `s1' is printf control string, `s2' is arg for it. */
45 error (char *s1, char *s2)
47 fprintf (stderr, "sorted-doc: ");
48 fprintf (stderr, s1, s2);
49 fprintf (stderr, "\n");
52 /* Print error message and exit. */
55 fatal (char *s1, char *s2)
61 /* Like malloc but get fatal error if memory is exhausted. */
66 void *result = malloc (size);
68 fatal ("%s", "virtual memory exhausted");
75 char *buf = (char *) xmalloc (strlen (str) + 1);
80 /* Comparison function for qsort to call. */
83 cmpdoc (DOCSTR **a, DOCSTR **b)
85 register int val = strcmp ((*a)->name, (*b)->name);
87 return (*a)->type - (*b)->type;
93 WAITING, BEG_NAME, NAME_GET, BEG_DESC, DESC_GET
96 const char *states[] =
98 "WAITING", "BEG_NAME", "NAME_GET", "BEG_DESC", "DESC_GET"
102 main (int argc, char *argv[])
104 register DOCSTR *dp = NULL; /* allocated DOCSTR */
105 register LINE *lp = NULL; /* allocated line */
106 register char *bp = 0; /* ptr inside line buffer */
107 /* int notfirst = 0; / * set after read something */
108 register enum state state = WAITING; /* state at start */
109 int cnt = 0; /* number of DOCSTRs read */
111 DOCSTR *docs = 0; /* chain of allocated DOCSTRS */
112 char buf[512]; /* line buffer */
114 while (1) /* process one char at a time */
116 /* this char from the DOCSTR file */
117 register int ch = getchar ();
121 if (state == WAITING)
126 else if (state == BEG_NAME)
129 if (dp == NULL) /* first dp allocated */
131 docs = dp = (DOCSTR*) xmalloc (sizeof (DOCSTR));
133 else /* all the rest */
135 dp->next = (DOCSTR*) xmalloc (sizeof (DOCSTR));
142 /* Record whether function or variable. */
146 else if (state == BEG_DESC)
148 if (lp == NULL) /* first line for dp */
150 dp->first = lp = (LINE*)xmalloc (sizeof (LINE));
152 else /* continuing lines */
154 lp->next = (LINE*)xmalloc (sizeof (LINE));
164 if (state == NAME_GET || state == DESC_GET)
166 if (ch != MARKER && ch != '\n' && ch != EOF)
170 else /* saving and changing state */
175 if (state == NAME_GET)
181 state = (ch == MARKER) ? BEG_NAME : BEG_DESC;
183 } /* NAME_GET || DESC_GET */
190 register int i; /* counter */
192 /* build array of ptrs to DOCSTRs */
194 array = (DOCSTR**)xmalloc (cnt * sizeof (*array));
195 for (dp = docs, i = 0; dp != NULL ; dp = dp->next)
198 /* sort the array by name; within each name, by type */
200 qsort ((char*)array, cnt, sizeof (DOCSTR*),
201 (int (*)(const void *, const void *)) cmpdoc);
203 /* write the output header */
205 printf ("\\input texinfo @c -*-texinfo-*-\n");
206 printf ("@setfilename ../info/summary\n");
207 printf ("@settitle Command Summary for GNU Emacs\n");
208 printf ("@unnumbered Command Summary for GNU Emacs\n");
209 printf ("@table @asis\n");
212 printf ("@global@let@ITEM=@item\n");
213 printf ("@def@item{@filbreak@vskip5pt@ITEM}\n");
214 printf ("@font@tensy cmsy10 scaled @magstephalf\n");
215 printf ("@font@teni cmmi10 scaled @magstephalf\n");
216 printf ("@def\\{{@tensy@char110}}\n"); /* this backslash goes with cmr10 */
217 printf ("@def|{{@tensy@char106}}\n");
218 printf ("@def@{{{@tensy@char102}}\n");
219 printf ("@def@}{{@tensy@char103}}\n");
220 printf ("@def<{{@teni@char62}}\n");
221 printf ("@def>{{@teni@char60}}\n");
222 printf ("@chardef@@64\n");
223 printf ("@catcode43=12\n");
224 printf ("@tableindent-0.2in\n");
225 printf ("@end iftex\n");
227 /* print each function from the array */
229 for (i = 0; i < cnt; i++)
231 printf ("\n@item %s @code{%s}\n@display\n",
232 array[i]->type == 'F' ? "Function" : "Variable",
235 for (lp = array[i]->first; lp != NULL ; lp = lp->next)
237 for (bp = lp->line; *bp; bp++)
239 /* the characters "@{}" need special treatment */
240 if (*bp == '@' || *bp == '{' || *bp == '}')
248 printf("@end display\n");
249 if ( i%200 == 0 && i != 0 ) printf("@end table\n\n@table @asis\n");
252 printf ("@end table\n");