2 * Copyright (C) 1999-2000 Thomas Roessler <roessler@does-not-exist.org>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
20 ** This program parses mutt's init.h and generates documentation in
21 ** three different formats:
23 ** -> a commented muttrc configuration file
24 ** -> nroff, suitable for inclusion in a manual page
25 ** -> linuxdoc-sgml, suitable for inclusion in the
51 extern char *sys_errlist[];
54 #define strerror(x) ((x) > 0 && (x) < sys_nerr) ? sys_errlist[(x)] : 0
55 #endif /* !HAVE_STRERROR */
63 F_CONF, F_MAN, F_SGML, F_NONE
69 #define D_TAB (1 << 3)
71 #define D_INIT (1 << 5)
92 enum output_formats_t OutputFormat = F_NONE;
96 static char *get_token (char *, size_t, char *);
97 static char *skip_ws (char *);
98 static const char *type2human (int);
99 static int buff2type (const char *);
100 static int flush_doc (int, FILE *);
101 static int handle_docline (char *, FILE *, int);
102 static int print_it (int, char *, FILE *, int);
103 static void print_confline (const char *, int, const char *, FILE *);
104 static void handle_confline (char *, FILE *);
105 static void makedoc (FILE *, FILE *);
106 static void pretty_default (char *, size_t, const char *, int);
107 static int sgml_fputc (int, FILE *);
108 static int sgml_fputs (const char *, FILE *);
110 int main (int argc, char *argv[])
115 if ((Progname = strrchr (argv[0], '/')))
120 while ((c = getopt (argc, argv, "cmsd")) != EOF)
124 case 'c': OutputFormat = F_CONF; break;
125 case 'm': OutputFormat = F_MAN; break;
126 case 's': OutputFormat = F_SGML; break;
127 case 'd': Debug++; break;
130 fprintf (stderr, "%s: bad command line parameter.\n", Progname);
138 if ((f = fopen (argv[optind], "r")) == NULL)
140 fprintf (stderr, "%s: Can't open %s (%s).\n",
141 Progname, argv[optind], strerror (errno));
148 switch (OutputFormat)
152 case F_SGML: makedoc (f, stdout); break;
155 fprintf (stderr, "%s: No output format specified.\n",
168 static void makedoc (FILE *in, FILE *out)
170 char buffer[BUFFSIZE];
171 char token[BUFFSIZE];
175 int docstat = D_INIT;
177 while ((fgets (buffer, sizeof (buffer), in)))
180 if ((p = strchr (buffer, '\n')) == NULL)
182 fprintf (stderr, "%s: Line %d too long. Ask a wizard to enlarge\n"
183 "%s: my buffer size.\n", Progname, line, Progname);
189 if (!(p = get_token (token, sizeof (token), buffer)))
194 fprintf (stderr, "%s: line %d. first token: \"%s\".\n",
195 Progname, line, token);
198 if (!strcmp (token, "/*++*/"))
200 else if (!strcmp (token, "/*--*/"))
202 docstat = flush_doc (docstat, out);
205 else if (active && (!strcmp (token, "/**") || !strcmp (token, "**")))
206 docstat = handle_docline (p, out, docstat);
207 else if (active && !strcmp (token, "{"))
209 docstat = flush_doc (docstat, out);
210 handle_confline (p, out);
213 flush_doc (docstat, out);
217 /* skip whitespace */
219 static char *skip_ws (char *s)
221 while (*s && isspace ((unsigned char) *s))
227 /* isolate a token */
229 static char single_char_tokens[] = "[]{},;|";
231 static char *get_token (char *d, size_t l, char *s)
238 fprintf (stderr, "%s: get_token called for `%s'.\n",
244 fprintf (stderr, "%s: argumet after skip_ws(): `%s'.\n",
250 fprintf (stderr, "%s: no more tokens on this line.\n", Progname);
254 if (strchr (single_char_tokens, *s))
258 fprintf (stderr, "%s: found single character token `%c'.\n",
270 fprintf (stderr, "%s: found quote character.\n", Progname);
277 for (t = s; *t && --l > 0; t++)
279 if (*t == '\\' && !t[1])
282 if (is_quoted && *t == '\\')
286 case 'n': *d = '\n'; break;
287 case 't': *d = '\t'; break;
288 case 'r': *d = '\r'; break;
289 case 'a': *d = '\a'; break;
296 if (is_quoted && *t == '"')
301 else if (!is_quoted && strchr (single_char_tokens, *t))
303 else if (!is_quoted && isspace ((unsigned char) *t))
313 fprintf (stderr, "%s: Got %stoken: `%s'.\n",
314 Progname, is_quoted ? "quoted " : "", dd);
315 fprintf (stderr, "%s: Remainder: `%s'.\n",
324 ** Configuration line parser
326 ** The following code parses a line from init.h which declares
327 ** a configuration variable.
331 /* note: the following enum must be in the same order as the
332 * following string definitions!
357 { "DT_NONE", "-none-" },
358 { "DT_BOOL", "boolean" },
359 { "DT_NUM", "number" },
360 { "DT_STR", "string" },
361 { "DT_PATH", "path" },
362 { "DT_QUAD", "quadoption" },
363 { "DT_SORT", "sort order" },
364 { "DT_RX", "regular expression" },
365 { "DT_MAGIC", "folder magic" },
367 { "DT_ADDR", "e-mail address" },
372 static int buff2type (const char *s)
376 for (type = DT_NONE; types[type].machine; type++)
377 if (!strcmp (types[type].machine, s))
383 static const char *type2human (int type)
385 return types[type].human;
387 static void handle_confline (char *s, FILE *out)
389 char varname[BUFFSIZE];
396 /* xxx - put this into an actual state machine? */
399 if (!(s = get_token (varname, sizeof (varname), s))) return;
402 if (!(s = get_token (buff, sizeof (buff), s))) return;
405 if (!(s = get_token (buff, sizeof (buff), s))) return;
407 type = buff2type (buff);
409 /* possibly a "|" or comma */
410 if (!(s = get_token (buff, sizeof (buff), s))) return;
412 if (!strcmp (buff, "|"))
414 if (Debug) fprintf (stderr, "%s: Expecting <subtype> <comma>.\n", Progname);
415 /* ignore subtype and comma */
416 if (!(s = get_token (buff, sizeof (buff), s))) return;
417 if (!(s = get_token (buff, sizeof (buff), s))) return;
424 if (!(s = get_token (buff, sizeof (buff), s))) return;
425 if (!strcmp (buff, ","))
429 /* option name or UL &address */
430 if (!(s = get_token (buff, sizeof (buff), s))) return;
431 if (!strcmp (buff, "UL"))
432 if (!(s = get_token (buff, sizeof (buff), s))) return;
435 if (!(s = get_token (buff, sizeof (buff), s))) return;
437 if (Debug) fprintf (stderr, "%s: Expecting default value.\n", Progname);
439 /* <default value> or UL <default value> */
440 if (!(s = get_token (buff, sizeof (buff), s))) return;
441 if (!strcmp (buff, "UL"))
443 if (Debug) fprintf (stderr, "%s: Skipping UL.\n", Progname);
444 if (!(s = get_token (buff, sizeof (buff), s))) return;
447 memset (tmp, 0, sizeof (tmp));
451 if (!strcmp (buff, "}"))
454 strncpy (tmp + strlen (tmp), buff, sizeof (tmp) - strlen (tmp));
456 while ((s = get_token (buff, sizeof (buff), s)));
458 pretty_default (val, sizeof (val), tmp, type);
459 print_confline (varname, type, val, out);
462 static void pretty_default (char *t, size_t l, const char *s, int type)
471 if (!strcasecmp (s, "M_YES")) strncpy (t, "yes", l);
472 else if (!strcasecmp (s, "M_NO")) strncpy (t, "no", l);
473 else if (!strcasecmp (s, "M_ASKYES")) strncpy (t, "ask-yes", l);
474 else if (!strcasecmp (s, "M_ASKNO")) strncpy (t, "ask-no", l);
480 strncpy (t, "yes", l);
482 strncpy (t, "no", l);
488 strncpy (t, s + 5, l);
489 for (; *t; t++) *t = tolower ((unsigned char) *t);
495 strncpy (t, s + 2, l);
496 for (; *t; t++) *t = tolower ((unsigned char) *t);
504 if (!strcmp (s, "0"))
516 static void char_to_escape (char *dest, unsigned int c)
520 case '\r': strcpy (dest, "\\r"); break; /* __STRCPY_CHECKED__ */
521 case '\n': strcpy (dest, "\\n"); break; /* __STRCPY_CHECKED__ */
522 case '\t': strcpy (dest, "\\t"); break; /* __STRCPY_CHECKED__ */
523 case '\f': strcpy (dest, "\\f"); break; /* __STRCPY_CHECKED__ */
524 default: sprintf (dest, "\\%03o", c); break;
527 static void conf_char_to_escape (unsigned int c , FILE *out)
530 char_to_escape (buff, c);
534 static void conf_print_strval (const char *v, FILE *out)
538 if (*v < ' ' || *v & 0x80)
540 conf_char_to_escape ((unsigned int) *v, out);
544 if (*v == '"' || *v == '\\')
550 static void man_print_strval (const char *v, FILE *out)
554 if (*v < ' ' || *v & 0x80)
557 conf_char_to_escape ((unsigned int) *v, out);
562 fputs ("\\(rq", out);
570 static void sgml_print_strval (const char *v, FILE *out)
575 if (*v < ' ' || *v & 0x80)
577 char_to_escape (buff, (unsigned int) *v);
578 sgml_fputs (buff, out);
581 sgml_fputc ((unsigned int) *v, out);
585 static int sgml_fputc (int c, FILE *out)
589 case '<': return fputs ("<", out);
590 case '>': return fputs (">", out);
591 case '$': return fputs ("$", out);
592 case '_': return fputs ("_", out);
593 case '%': return fputs ("%", out);
594 case '&': return fputs ("&", out);
595 case '\\': return fputs ("\", out);
596 case '"': return fputs ("&dquot;", out);
597 case '[': return fputs ("[", out);
598 case ']': return fputs ("]", out);
599 case '~': return fputs ("˜", out);
600 default: return fputc (c, out);
604 static int sgml_fputs (const char *s, FILE *out)
607 if (sgml_fputc ((unsigned int) *s, out) == EOF)
613 static void print_confline (const char *varname, int type, const char *val, FILE *out)
615 if (type == DT_SYN) return;
617 switch (OutputFormat)
619 /* configuration file */
622 if (type == DT_STR || type == DT_RX || type == DT_ADDR || type == DT_PATH)
624 fprintf (out, "\n# set %s=\"", varname);
625 conf_print_strval (val, out);
628 else if (type != DT_SYN)
629 fprintf (out, "\n# set %s=%s", varname, val);
631 fprintf (out, "\n#\n# Name: %s", varname);
632 fprintf (out, "\n# Type: %s", type2human (type));
633 if (type == DT_STR || type == DT_RX || type == DT_ADDR || type == DT_PATH)
635 fputs ("\n# Default: \"", out);
636 conf_print_strval (val, out);
640 fprintf (out, "\n# Default: %s", val);
649 fprintf (out, "\n.TP\n.B %s\n", varname);
650 fputs (".nf\n", out);
651 fprintf (out, "Type: %s\n", type2human (type));
652 if (type == DT_STR || type == DT_RX || type == DT_ADDR || type == DT_PATH)
654 fputs ("Default: \\(lq", out);
655 man_print_strval (val, out);
656 fputs ("\\(rq\n", out);
659 fprintf (out, "Default: %s\n", val);
666 /* SGML based manual */
669 fputs ("\n<sect2>", out); sgml_fputs (varname, out);
670 fprintf (out, "<label id=\"%s\">", varname);
671 fprintf (out, "\n<p>\nType: %s<newline>", type2human (type));
673 if (type == DT_STR || type == DT_RX || type == DT_ADDR || type == DT_PATH)
675 fputs ("\nDefault: &dquot;", out);
676 sgml_print_strval (val, out);
677 fputs ("&dquot;\n", out);
680 fprintf (out, "\nDefault: %s\n", val);
690 ** Documentation line parser
692 ** The following code parses specially formatted documentation
693 ** comments in init.h.
695 ** The format is very remotely inspired by nroff. Most important, it's
696 ** easy to parse and convert, and it was easy to generate from the SGML
697 ** source of mutt's original manual.
699 ** - \fI switches to italics
700 ** - \fB switches to boldface
701 ** - \fP switches to normal display
702 ** - .dl on a line starts a definition list (name taken taken from HTML).
703 ** - .dt starts a term in a definition list.
704 ** - .dd starts a definition in a definition list.
705 ** - .de on a line finishes a definition list.
706 ** - .ts on a line starts a "tscreen" environment (name taken from SGML).
707 ** - .te on a line finishes this environment.
708 ** - .pp on a line starts a paragraph.
709 ** - \$word will be converted to a reference to word, where appropriate.
710 ** Note that \$$word is possible as well.
711 ** - '. ' in the beginning of a line expands to two space characters.
712 ** This is used to protect indentations in tables.
715 /* close eventually-open environments. */
717 static int fd_recurse = 0;
719 static int flush_doc (int docstat, FILE *out)
721 if (docstat & D_INIT)
726 fprintf (stderr, "%s: Internal error, recursion in flush_doc()!\n", Progname);
730 if (docstat & (D_TAB))
731 docstat = print_it (SP_END_TAB, NULL, out, docstat);
733 if (docstat & (D_DL))
734 docstat = print_it (SP_END_DL, NULL, out, docstat);
736 if (docstat & (D_EM | D_BF))
737 docstat = print_it (SP_END_FT, NULL, out, docstat);
739 docstat = print_it (SP_NEWLINE, NULL, out, 0);
745 /* print something. */
747 static int print_it (int special, char *str, FILE *out, int docstat)
749 int onl = docstat & (D_NL|D_NP);
751 docstat &= ~(D_NL|D_NP|D_INIT);
753 switch (OutputFormat)
755 /* configuration file */
760 static int Continuation = 0;
762 case SP_END_FT: docstat &= ~(D_EM|D_BF); break;
763 case SP_START_BF: docstat |= D_BF; break;
764 case SP_START_EM: docstat |= D_EM; break;
839 for (i = strlen (str) ; i < 8 ; i++)
858 docstat &= ~(D_EM|D_BF);
896 fputs (".IP\n", out);
903 fputs ("\n.IP\n.DS\n.sp\n.ft CR\n.nf\n", out);
904 docstat |= D_TAB | D_NL;
909 fputs ("\n.fi\n.ec\n.ft P\n.sp\n", out);
916 fputs ("\n.RS", out);
922 fputs ("\n.IP ", out);
932 fputs ("\n.RE", out);
943 fputs ("\\(rq", out);
944 else if (*str == '\\')
946 else if (!strncmp (str, "``", 2))
948 fputs ("\\(lq", out);
951 else if (!strncmp (str, "''", 2))
953 fputs ("\\(rq", out);
966 /* SGML based manual */
973 if (docstat & D_EM) fputs ("</em>", out);
974 if (docstat & D_BF) fputs ("</bf>", out);
975 docstat &= ~(D_EM|D_BF);
1013 fputs ("<p>\n", out);
1020 fputs ("\n<tscreen><verb>\n", out);
1021 docstat |= D_TAB | D_NL;
1026 fputs ("\n</verb></tscreen>", out);
1033 fputs ("\n<descrip>\n", out);
1039 fputs ("<tag>", out);
1044 fputs ("</tag>", out);
1049 fputs ("</descrip>\n", out);
1055 if (docstat & D_TAB)
1058 sgml_fputs (str, out);
1064 /* make gcc happy (unreached) */
1072 void print_ref (FILE *out, int output_dollar, const char *ref)
1074 switch (OutputFormat)
1084 fprintf (out, "<ref id=\"%s\" name=\"", ref);
1086 fputs ("$", out);
1087 sgml_fputs (ref, out);
1096 static int commit_buff (char *buff, char **d, FILE *out, int docstat)
1101 docstat = print_it (SP_STR, buff, out, docstat);
1108 static int handle_docline (char *l, FILE *out, int docstat)
1110 char buff[BUFFSIZE];
1115 fprintf (stderr, "%s: handle_docline `%s'\n", Progname, l);
1117 if (!strncmp (l, ".pp", 3))
1118 return print_it (SP_NEWPAR, NULL, out, docstat);
1119 else if (!strncmp (l, ".ts", 3))
1120 return print_it (SP_START_TAB, NULL, out, docstat);
1121 else if (!strncmp (l, ".te", 3))
1122 return print_it (SP_END_TAB, NULL, out, docstat);
1123 else if (!strncmp (l, ".dl", 3))
1124 return print_it (SP_START_DL, NULL, out, docstat);
1125 else if (!strncmp (l, ".de", 3))
1126 return print_it (SP_END_DL, NULL, out, docstat);
1127 else if (!strncmp (l, ". ", 2))
1130 for (s = l, d = buff; *s; s++)
1132 if (!strncmp (s, "\\(as", 4))
1137 else if (!strncmp (s, "\\(rs", 4))
1142 else if (!strncmp (s, "\\fI", 3))
1144 docstat = commit_buff (buff, &d, out, docstat);
1145 docstat = print_it (SP_START_EM, NULL, out, docstat);
1148 else if (!strncmp (s, "\\fB", 3))
1150 docstat = commit_buff (buff, &d, out, docstat);
1151 docstat = print_it (SP_START_BF, NULL, out, docstat);
1154 else if (!strncmp (s, "\\fP", 3))
1156 docstat = commit_buff (buff, &d, out, docstat);
1157 docstat = print_it (SP_END_FT, NULL, out, docstat);
1160 else if (!strncmp (s, ".dt", 3))
1162 docstat = commit_buff (buff, &d, out, docstat);
1163 docstat = print_it (SP_DT, NULL, out, docstat);
1166 else if (!strncmp (s, ".dd", 3))
1168 docstat = commit_buff (buff, &d, out, docstat);
1169 docstat = print_it (SP_DD, NULL, out, docstat);
1174 int output_dollar = 0;
1191 while (isalnum ((unsigned char) *s) || *s == '-' || *s == '_')
1194 docstat = commit_buff (buff, &d, out, docstat);
1197 print_ref (out, output_dollar, ref);
1206 docstat = commit_buff (buff, &d, out, docstat);
1207 return print_it (SP_NEWLINE, NULL, out, docstat);