X-Git-Url: http://git.madism.org/?p=apps%2Fmadmutt.git;a=blobdiff_plain;f=makedoc.c;h=279168bf23cafe5279d1878f1a82adf6a57c19a1;hp=52e15d879d6bd23e4e063b00a836c5deb493a8bc;hb=f0d5ecf432102dc3e6430ceb2a6c692ee856f4d4;hpb=b1b9961ff1c305dff57f547d28cb509bf007bad7 diff --git a/makedoc.c b/makedoc.c index 52e15d8..279168b 100644 --- a/makedoc.c +++ b/makedoc.c @@ -1,20 +1,14 @@ /* + * Copyright notice from original mutt: * Copyright (C) 1999-2000 Thomas Roessler - * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA. - */ + * + * Parts were written/modified by: + * Rocco Rutte + * + * This file is part of mutt-ng, see http://www.muttng.org/. + * It's licensed under the GNU General Public License, + * please see the file GPL in the top level source directory. + */ /** ** This program parses mutt's init.h and generates documentation in @@ -63,35 +57,36 @@ extern int optind; typedef struct { short seen; - char* name; - char* descr; + char *name; + char *descr; } var_t; static int outcount = 0; -static var_t* outbuf = NULL; +static var_t *outbuf = NULL; -static int var_cmp (const void* a, const void* b) { - return (strcmp (((var_t*) a)->name, ((var_t*) b)->name)); +static int var_cmp (const void *a, const void *b) +{ + return (strcmp (((var_t *) a)->name, ((var_t *) b)->name)); } -enum output_formats_t -{ +enum output_formats_t { F_CONF, F_MAN, F_SGML, F_NONE }; #define D_NL (1 << 0) #define D_EM (1 << 1) #define D_BF (1 << 2) -#define D_TAB (1 << 3) -#define D_NP (1 << 4) -#define D_INIT (1 << 5) -#define D_DL (1 << 6) -#define D_DT (1 << 7) - -enum -{ +#define D_TT (1 << 3) +#define D_TAB (1 << 4) +#define D_NP (1 << 5) +#define D_INIT (1 << 6) +#define D_DL (1 << 7) +#define D_DT (1 << 8) + +enum { SP_START_EM, SP_START_BF, + SP_START_TT, SP_END_FT, SP_NEWLINE, SP_NEWPAR, @@ -122,8 +117,8 @@ static void makedoc (FILE *, FILE *); static void pretty_default (char *, size_t, const char *, int); static int sgml_fputc (int); static int sgml_fputs (const char *); -static void add_var (const char*); -static int add_s (const char*); +static void add_var (const char *); +static int add_s (const char *); static int add_c (int); int main (int argc, char *argv[]) @@ -135,16 +130,22 @@ int main (int argc, char *argv[]) Progname++; else Progname = argv[0]; - - while ((c = getopt (argc, argv, "cmsd")) != EOF) - { - switch (c) - { - case 'c': OutputFormat = F_CONF; break; - case 'm': OutputFormat = F_MAN; break; - case 's': OutputFormat = F_SGML; break; - case 'd': Debug++; break; - default: + + while ((c = getopt (argc, argv, "cmsd")) != EOF) { + switch (c) { + case 'c': + OutputFormat = F_CONF; + break; + case 'm': + OutputFormat = F_MAN; + break; + case 's': + OutputFormat = F_SGML; + break; + case 'd': + Debug++; + break; + default: { fprintf (stderr, "%s: bad command line parameter.\n", Progname); exit (1); @@ -152,71 +153,74 @@ int main (int argc, char *argv[]) } } - if (optind != argc) - { - if ((f = fopen (argv[optind], "r")) == NULL) - { + if (optind != argc) { + if ((f = fopen (argv[optind], "r")) == NULL) { fprintf (stderr, "%s: Can't open %s (%s).\n", Progname, argv[optind], strerror (errno)); exit (1); } } - else + else f = stdin; - switch (OutputFormat) - { - case F_CONF: - case F_MAN: - case F_SGML: makedoc (f, stdout); break; - default: + switch (OutputFormat) { + case F_CONF: + case F_MAN: + case F_SGML: + makedoc (f, stdout); + break; + default: { - fprintf (stderr, "%s: No output format specified.\n", - Progname); + fprintf (stderr, "%s: No output format specified.\n", Progname); exit (1); } } - + if (f != stdin) fclose (f); - + exit (1); } -static void add_var (const char* name) { - outbuf = realloc (outbuf, (++outcount) * sizeof(var_t)); - outbuf[outcount-1].seen = 0; - outbuf[outcount-1].name = strdup (name); - outbuf[outcount-1].descr = NULL; +static void add_var (const char *name) +{ + outbuf = realloc (outbuf, (++outcount) * sizeof (var_t)); + outbuf[outcount - 1].seen = 0; + outbuf[outcount - 1].name = strdup (name); + outbuf[outcount - 1].descr = NULL; } -static int add (const char* s) { - size_t lnew = STRLEN(s), lold = STRLEN(outbuf[outcount-1].descr); +static int add_s (const char *s) +{ + size_t lnew = STRLEN (s), lold = STRLEN (outbuf[outcount - 1].descr); if (lnew == 0) return (0); - if (!outbuf[outcount-1].seen) { + if (!outbuf[outcount - 1].seen) { lold = 0; - outbuf[outcount-1].seen = 1; + outbuf[outcount - 1].seen = 1; } if (lold == 0) - outbuf[outcount-1].descr = strdup (s); + outbuf[outcount - 1].descr = strdup (s); else { - outbuf[outcount-1].descr = realloc (outbuf[outcount-1].descr, lold + lnew + 1); - memcpy (&(outbuf[outcount-1].descr[lold-1])+1, s, lnew); + outbuf[outcount - 1].descr = + realloc (outbuf[outcount - 1].descr, lold + lnew + 1); + memcpy (&(outbuf[outcount - 1].descr[lold - 1]) + 1, s, lnew); } - outbuf[outcount-1].descr[lold+lnew] = '\0'; + outbuf[outcount - 1].descr[lold + lnew] = '\0'; return (1); } -static int add_c (int c) { +static int add_c (int c) +{ char buf[2] = "\0\0"; + buf[0] = c; - return (add (buf)); + return (add_s (buf)); } -static void makedoc (FILE *in, FILE *out) +static void makedoc (FILE * in, FILE * out) { char buffer[BUFFSIZE]; char token[BUFFSIZE]; @@ -225,13 +229,11 @@ static void makedoc (FILE *in, FILE *out) int line = 0; int docstat = D_INIT; - while ((fgets (buffer, sizeof (buffer), in))) - { + while ((fgets (buffer, sizeof (buffer), in))) { line++; - if ((p = strchr (buffer, '\n')) == NULL) - { + if ((p = strchr (buffer, '\n')) == NULL) { fprintf (stderr, "%s: Line %d too long. Ask a wizard to enlarge\n" - "%s: my buffer size.\n", Progname, line, Progname); + "%s: my buffer size.\n", Progname, line, Progname); exit (1); } else @@ -240,23 +242,20 @@ static void makedoc (FILE *in, FILE *out) if (!(p = get_token (token, sizeof (token), buffer))) continue; - if (Debug) - { + if (Debug) { fprintf (stderr, "%s: line %d. first token: \"%s\".\n", Progname, line, token); } - + if (!strcmp (token, "/*++*/")) active = 1; - else if (!strcmp (token, "/*--*/")) - { + else if (!strcmp (token, "/*--*/")) { docstat = flush_doc (docstat); active = 0; } else if (active && (!strcmp (token, "/**") || !strcmp (token, "**"))) docstat = handle_docline (p, docstat); - else if (active && !strcmp (token, "{")) - { + else if (active && !strcmp (token, "{")) { docstat = flush_doc (docstat); handle_confline (p); } @@ -295,26 +294,21 @@ static char *get_token (char *d, size_t l, char *s) char *dd = d; if (Debug) - fprintf (stderr, "%s: get_token called for `%s'.\n", - Progname, s); - + fprintf (stderr, "%s: get_token called for `%s'.\n", Progname, s); + s = skip_ws (s); if (Debug > 1) - fprintf (stderr, "%s: argumet after skip_ws(): `%s'.\n", - Progname, s); + fprintf (stderr, "%s: argumet after skip_ws(): `%s'.\n", Progname, s); - if (!*s) - { + if (!*s) { if (Debug) fprintf (stderr, "%s: no more tokens on this line.\n", Progname); return NULL; } - if (strchr (single_char_tokens, *s)) - { - if (Debug) - { + if (strchr (single_char_tokens, *s)) { + if (Debug) { fprintf (stderr, "%s: found single character token `%c'.\n", Progname, *s); } @@ -323,38 +317,40 @@ static char *get_token (char *d, size_t l, char *s) return s; } - if (*s == '"') - { - if (Debug) - { + if (*s == '"') { + if (Debug) { fprintf (stderr, "%s: found quote character.\n", Progname); } - + s++; is_quoted = 1; } - for (t = s; *t && --l > 0; t++) - { + for (t = s; *t && --l > 0; t++) { if (*t == '\\' && !t[1]) break; - if (is_quoted && *t == '\\') - { - switch ((*d = *++t)) - { - case 'n': *d = '\n'; break; - case 't': *d = '\t'; break; - case 'r': *d = '\r'; break; - case 'a': *d = '\a'; break; + if (is_quoted && *t == '\\') { + switch ((*d = *++t)) { + case 'n': + *d = '\n'; + break; + case 't': + *d = '\t'; + break; + case 'r': + *d = '\r'; + break; + case 'a': + *d = '\a'; + break; } d++; continue; } - if (is_quoted && *t == '"') - { + if (is_quoted && *t == '"') { t++; break; } @@ -368,14 +364,12 @@ static char *get_token (char *d, size_t l, char *s) *d = '\0'; - if (Debug) - { + if (Debug) { fprintf (stderr, "%s: Got %stoken: `%s'.\n", Progname, is_quoted ? "quoted " : "", dd); - fprintf (stderr, "%s: Remainder: `%s'.\n", - Progname, t); + fprintf (stderr, "%s: Remainder: `%s'.\n", Progname, t); } - + return t; } @@ -392,8 +386,7 @@ static char *get_token (char *d, size_t l, char *s) * following string definitions! */ -enum -{ +enum { DT_NONE = 0, DT_BOOL, DT_NUM, @@ -407,36 +400,34 @@ enum DT_ADDR }; -struct -{ +struct { char *machine; char *human; -} -types[] = -{ - { "DT_NONE", "-none-" }, - { "DT_BOOL", "boolean" }, - { "DT_NUM", "number" }, - { "DT_STR", "string" }, - { "DT_PATH", "path" }, - { "DT_QUAD", "quadoption" }, - { "DT_SORT", "sort order" }, - { "DT_RX", "regular expression" }, - { "DT_MAGIC", "folder magic" }, - { "DT_SYN", NULL }, - { "DT_ADDR", "e-mail address" }, - { NULL, NULL } +} types[] = { + { + "DT_NONE", "-none-"}, { + "DT_BOOL", "boolean"}, { + "DT_NUM", "number"}, { + "DT_STR", "string"}, { + "DT_PATH", "path"}, { + "DT_QUAD", "quadoption"}, { + "DT_SORT", "sort order"}, { + "DT_RX", "regular expression"}, { + "DT_MAGIC", "folder magic"}, { + "DT_SYN", NULL}, { + "DT_ADDR", "e-mail address"}, { + NULL, NULL} }; - + static int buff2type (const char *s) { int type; - + for (type = DT_NONE; types[type].machine; type++) if (!strcmp (types[type].machine, s)) - return type; - + return type; + return DT_NONE; } @@ -450,68 +441,79 @@ static void handle_confline (char *s) char buff[BUFFSIZE]; char tmp[BUFFSIZE]; int type; - + char val[BUFFSIZE]; /* xxx - put this into an actual state machine? */ /* variable name */ - if (!(s = get_token (varname, sizeof (varname), s))) return; - + if (!(s = get_token (varname, sizeof (varname), s))) + return; + /* comma */ - if (!(s = get_token (buff, sizeof (buff), s))) return; - + if (!(s = get_token (buff, sizeof (buff), s))) + return; + /* type */ - if (!(s = get_token (buff, sizeof (buff), s))) return; + if (!(s = get_token (buff, sizeof (buff), s))) + return; type = buff2type (buff); /* possibly a "|" or comma */ - if (!(s = get_token (buff, sizeof (buff), s))) return; + if (!(s = get_token (buff, sizeof (buff), s))) + return; - if (!strcmp (buff, "|")) - { - if (Debug) fprintf (stderr, "%s: Expecting .\n", Progname); + if (!strcmp (buff, "|")) { + if (Debug) + fprintf (stderr, "%s: Expecting .\n", Progname); /* ignore subtype and comma */ - if (!(s = get_token (buff, sizeof (buff), s))) return; - if (!(s = get_token (buff, sizeof (buff), s))) return; + if (!(s = get_token (buff, sizeof (buff), s))) + return; + if (!(s = get_token (buff, sizeof (buff), s))) + return; } /* redraw, comma */ - - while (1) - { - if (!(s = get_token (buff, sizeof (buff), s))) return; + + while (1) { + if (!(s = get_token (buff, sizeof (buff), s))) + return; if (!strcmp (buff, ",")) break; } /* option name or UL &address */ - if (!(s = get_token (buff, sizeof (buff), s))) return; + if (!(s = get_token (buff, sizeof (buff), s))) + return; if (!strcmp (buff, "UL")) - if (!(s = get_token (buff, sizeof (buff), s))) return; + if (!(s = get_token (buff, sizeof (buff), s))) + return; /* comma */ - if (!(s = get_token (buff, sizeof (buff), s))) return; + if (!(s = get_token (buff, sizeof (buff), s))) + return; + + if (Debug) + fprintf (stderr, "%s: Expecting default value.\n", Progname); - if (Debug) fprintf (stderr, "%s: Expecting default value.\n", Progname); - /* or UL */ - if (!(s = get_token (buff, sizeof (buff), s))) return; - if (!strcmp (buff, "UL")) - { - if (Debug) fprintf (stderr, "%s: Skipping UL.\n", Progname); - if (!(s = get_token (buff, sizeof (buff), s))) return; + if (!(s = get_token (buff, sizeof (buff), s))) + return; + if (!strcmp (buff, "UL")) { + if (Debug) + fprintf (stderr, "%s: Skipping UL.\n", Progname); + if (!(s = get_token (buff, sizeof (buff), s))) + return; } memset (tmp, 0, sizeof (tmp)); - do - { + do { if (!strcmp (buff, "}")) break; - strncpy (tmp + STRLEN(tmp), buff, sizeof (tmp) - STRLEN(tmp)); + strncpy (tmp + STRLEN (tmp), buff, sizeof (tmp) - STRLEN (tmp)); } while ((s = get_token (buff, sizeof (buff), s))); @@ -525,17 +527,20 @@ static void pretty_default (char *t, size_t l, const char *s, int type) memset (t, 0, l); l--; - switch (type) - { - case DT_QUAD: - { - if (!strcasecmp (s, "M_YES")) strncpy (t, "yes", l); - else if (!strcasecmp (s, "M_NO")) strncpy (t, "no", l); - else if (!strcasecmp (s, "M_ASKYES")) strncpy (t, "ask-yes", l); - else if (!strcasecmp (s, "M_ASKNO")) strncpy (t, "ask-no", l); + switch (type) { + case DT_QUAD: + { + if (!strcasecmp (s, "M_YES")) + strncpy (t, "yes", l); + else if (!strcasecmp (s, "M_NO")) + strncpy (t, "no", l); + else if (!strcasecmp (s, "M_ASKYES")) + strncpy (t, "ask-yes", l); + else if (!strcasecmp (s, "M_ASKNO")) + strncpy (t, "ask-no", l); break; } - case DT_BOOL: + case DT_BOOL: { if (atoi (s)) strncpy (t, "yes", l); @@ -543,30 +548,32 @@ static void pretty_default (char *t, size_t l, const char *s, int type) strncpy (t, "no", l); break; } - case DT_SORT: + case DT_SORT: { /* heuristic! */ strncpy (t, s + 5, l); - for (; *t; t++) *t = tolower ((unsigned char) *t); + for (; *t; t++) + *t = tolower ((unsigned char) *t); break; } - case DT_MAGIC: + case DT_MAGIC: { /* heuristic! */ strncpy (t, s + 2, l); - for (; *t; t++) *t = tolower ((unsigned char) *t); + for (; *t; t++) + *t = tolower ((unsigned char) *t); break; } - case DT_STR: - case DT_RX: - case DT_ADDR: - case DT_PATH: + case DT_STR: + case DT_RX: + case DT_ADDR: + case DT_PATH: { if (!strcmp (s, "0")) break; /* fallthrough */ } - default: + default: { strncpy (t, s, l); break; @@ -576,33 +583,41 @@ static void pretty_default (char *t, size_t l, const char *s, int type) static void char_to_escape (char *dest, unsigned int c) { - switch (c) - { - case '\r': strcpy (dest, "\\r"); break; /* __STRCPY_CHECKED__ */ - case '\n': strcpy (dest, "\\n"); break; /* __STRCPY_CHECKED__ */ - case '\t': strcpy (dest, "\\t"); break; /* __STRCPY_CHECKED__ */ - case '\f': strcpy (dest, "\\f"); break; /* __STRCPY_CHECKED__ */ - default: sprintf (dest, "\\%03o", c); break; + switch (c) { + case '\r': + strcpy (dest, "\\r"); + break; /* __STRCPY_CHECKED__ */ + case '\n': + strcpy (dest, "\\n"); + break; /* __STRCPY_CHECKED__ */ + case '\t': + strcpy (dest, "\\t"); + break; /* __STRCPY_CHECKED__ */ + case '\f': + strcpy (dest, "\\f"); + break; /* __STRCPY_CHECKED__ */ + default: + sprintf (dest, "\\%03o", c); + break; } } static void conf_char_to_escape (unsigned int c) { char buff[16]; + char_to_escape (buff, c); - add (buff); + add_s (buff); } static void conf_print_strval (const char *v) { - for (; *v; v++) - { - if (*v < ' ' || *v & 0x80) - { + for (; *v; v++) { + if (*v < ' ' || *v & 0x80) { conf_char_to_escape ((unsigned int) *v); continue; } - if (*v == '"' || *v == '\\') + if (*v == '"' || *v == '\\') add_c ('\\'); add_c (*v); } @@ -610,19 +625,17 @@ static void conf_print_strval (const char *v) static void man_print_strval (const char *v) { - for (; *v; v++) - { - if (*v < ' ' || *v & 0x80) - { + for (; *v; v++) { + if (*v < ' ' || *v & 0x80) { add_c ('\\'); conf_char_to_escape ((unsigned int) *v); continue; } - + if (*v == '"') - add ("\\(rq"); + add_s ("\\(rq"); else if (*v == '\\') - add ("\\\\"); + add_s ("\\\\"); else add_c (*v); } @@ -631,10 +644,9 @@ static void man_print_strval (const char *v) static void sgml_print_strval (const char *v) { char buff[16]; - for (; *v; v++) - { - if (*v < ' ' || *v & 0x80) - { + + for (; *v; v++) { + if (*v < ' ' || *v & 0x80) { char_to_escape (buff, (unsigned int) *v); sgml_fputs (buff); continue; @@ -645,20 +657,31 @@ static void sgml_print_strval (const char *v) static int sgml_fputc (int c) { - switch (c) - { - case '<': return add ("<"); - case '>': return add (">"); - case '$': return add ("$"); - case '_': return add ("_"); - case '%': return add ("%"); - case '&': return add ("&"); - case '\\': return add ("\"); - case '"': return add ("&dquot;"); - case '[': return add ("["); - case ']': return add ("]"); - case '~': return add ("˜"); - default: return add_c (c); + switch (c) { + case '<': + return add_s ("<"); + case '>': + return add_s (">"); + case '$': + return add_s ("$"); + case '_': + return add_s ("_"); + case '%': + return add_s ("%"); + case '&': + return add_s ("&"); + case '\\': + return add_s ("\"); + case '"': + return add_s ("&dquot;"); + case '[': + return add_s ("["); + case ']': + return add_s ("]"); + case '~': + return add_s ("˜"); + default: + return add_c (c); } } @@ -667,109 +690,106 @@ static int sgml_fputs (const char *s) for (; *s; s++) if (sgml_fputc ((unsigned int) *s) == EOF) return EOF; - + return 0; } static void print_confline (const char *varname, int type, const char *val) { - if (type == DT_SYN) return; - - switch (OutputFormat) - { + if (type == DT_SYN) + return; + + switch (OutputFormat) { /* configuration file */ - case F_CONF: + case F_CONF: { - if (type == DT_STR || type == DT_RX || type == DT_ADDR || type == DT_PATH) - { - add ("\n# set "); - add (varname); - add ("\""); + if (type == DT_STR || type == DT_RX || type == DT_ADDR + || type == DT_PATH) { + add_s ("\n# set "); + add_s (varname); + add_s ("=\""); conf_print_strval (val); - add ("\""); + add_s ("\""); } - else if (type != DT_SYN) - { - add ("\n# set "); - add (varname); - add ("="); - add (val); + else if (type != DT_SYN) { + add_s ("\n# set "); + add_s (varname); + add_s ("="); + add_s (val); } - - add ("\n#\n# Name: "); - add (varname); - add ("\n# Type: "); - add (type2human (type)); - if (type == DT_STR || type == DT_RX || type == DT_ADDR || type == DT_PATH) - { - add ("\n# Default: \""); + + add_s ("\n#\n# Name: "); + add_s (varname); + add_s ("\n# Type: "); + add_s (type2human (type)); + if (type == DT_STR || type == DT_RX || type == DT_ADDR + || type == DT_PATH) { + add_s ("\n# Default: \""); conf_print_strval (val); - add ("\""); + add_s ("\""); } - else - { - add ("\n# Default: "); - add (val); + else { + add_s ("\n# Default: "); + add_s (val); } - add ("\n# "); + add_s ("\n# "); break; } /* manual page */ - case F_MAN: + case F_MAN: { - add ("\n.TP\n.B %s\n"); - add (varname); - add (".nf\n"); - add ("Type: %s\n"); - add (type2human (type)); - if (type == DT_STR || type == DT_RX || type == DT_ADDR || type == DT_PATH) - { - add ("Default: \\(lq"); + add_s (".TP\n.B "); + add_s (varname); + add_s ("\n.nf\n"); + add_s ("Type: "); + add_s (type2human (type)); + add_c ('\n'); + if (type == DT_STR || type == DT_RX || type == DT_ADDR + || type == DT_PATH) { + add_s ("Default: \\(lq"); man_print_strval (val); - add ("\\(rq\n"); + add_s ("\\(rq\n"); } else { - add ("Default: "); - add (val); + add_s ("Default: "); + add_s (val); add_c ('\n'); } - - add (".fi"); + add_s (".fi"); break; } - + /* SGML based manual */ - case F_SGML: + case F_SGML: { - add ("\n"); + add_s ("\n"); sgml_fputs (varname); - add ("