mutt_*mktemp--
[apps/madmutt.git] / makedoc.c
index e660dfd..e2cfc67 100644 (file)
--- a/makedoc.c
+++ b/makedoc.c
  **
  **/
 
-#if HAVE_CONFIG_H
-# include "config.h"
-#endif
-
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#include <ctype.h>
-
-#include <errno.h>
-
-#ifdef HAVE_UNISTD_H
-# include <unistd.h>
-#endif
+#include <lib-lib/lib-lib.h>
 
 #ifdef HAVE_GETOPT_H
 # include <getopt.h>
@@ -82,12 +69,15 @@ enum output_formats_t {
 #define D_INIT          (1 << 6)
 #define D_DL            (1 << 7)
 #define D_DT            (1 << 8)
+#define D_DD            (1 << 9)
+#define D_PA            (1 << 10)
 
 enum {
   SP_START_EM,
   SP_START_BF,
   SP_START_TT,
   SP_END_FT,
+  SP_END_PAR,
   SP_NEWLINE,
   SP_NEWPAR,
   SP_STR,
@@ -96,13 +86,14 @@ enum {
   SP_START_DL,
   SP_DT,
   SP_DD,
+  SP_END_DD,
   SP_END_DL,
+  SP_END_SECT,
   SP_REFER
 };
 
 enum output_formats_t OutputFormat = F_NONE;
 char *Progname;
-short Debug = 0;
 
 static char *get_token (char *, size_t, char *);
 static char *skip_ws (char *);
@@ -114,9 +105,9 @@ static int print_it (int, char *, int);
 static void print_confline (const char *, int, const char *);
 static void handle_confline (char *);
 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 int sgml_id_fputs (const char *);
 static void add_var (const char *);
 static int add_s (const char *);
 static int add_c (int);
@@ -142,9 +133,6 @@ int main (int argc, char *argv[])
     case 's':
       OutputFormat = F_SGML;
       break;
-    case 'd':
-      Debug++;
-      break;
     default:
       {
         fprintf (stderr, "%s: bad command line parameter.\n", Progname);
@@ -177,7 +165,7 @@ int main (int argc, char *argv[])
   }
 
   if (f != stdin)
-    fclose (f);
+    m_fclose(&f);
 
   exit (1);
 }
@@ -186,7 +174,7 @@ 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].name = strdup(name);
   outbuf[outcount - 1].descr = NULL;
 }
 
@@ -202,7 +190,7 @@ static int add_s (const char *s)
   }
 
   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);
@@ -242,11 +230,6 @@ static void makedoc (FILE * in, FILE * out)
     if (!(p = get_token (token, sizeof (token), buffer)))
       continue;
 
-    if (Debug) {
-      fprintf (stderr, "%s: line %d.  first token: \"%s\".\n",
-               Progname, line, token);
-    }
-
     if (!strcmp (token, "/*++*/"))
       active = 1;
     else if (!strcmp (token, "/*--*/")) {
@@ -293,35 +276,19 @@ static char *get_token (char *d, size_t l, char *s)
   short is_quoted = 0;
   char *dd = d;
 
-  if (Debug)
-    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);
-
   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) {
-      fprintf (stderr, "%s: found single character token `%c'.\n",
-               Progname, *s);
-    }
     d[0] = *s++;
     d[1] = 0;
     return s;
   }
 
   if (*s == '"') {
-    if (Debug) {
-      fprintf (stderr, "%s: found quote character.\n", Progname);
-    }
-
     s++;
     is_quoted = 1;
   }
@@ -364,12 +331,6 @@ static char *get_token (char *d, size_t l, char *s)
 
   *d = '\0';
 
-  if (Debug) {
-    fprintf (stderr, "%s: Got %stoken: `%s'.\n",
-             Progname, is_quoted ? "quoted " : "", dd);
-    fprintf (stderr, "%s: Remainder: `%s'.\n", Progname, t);
-  }
-
   return t;
 }
 
@@ -397,7 +358,8 @@ enum {
   DT_RX,
   DT_MAGIC,
   DT_SYN,
-  DT_ADDR
+  DT_ADDR,
+  DT_SYS
 };
 
 struct {
@@ -416,6 +378,7 @@ struct {
   "DT_MAGIC", "folder magic"}, {
   "DT_SYN", NULL}, {
   "DT_ADDR", "e-mail address"}, {
+  "DT_SYS", "system property"}, {
   NULL, NULL}
 };
 
@@ -439,7 +402,6 @@ static void handle_confline (char *s)
 {
   char varname[BUFFSIZE];
   char buff[BUFFSIZE];
-  char tmp[BUFFSIZE];
   int type;
 
   char val[BUFFSIZE];
@@ -465,8 +427,6 @@ static void handle_confline (char *s)
     return;
 
   if (!strcmp (buff, "|")) {
-    if (Debug)
-      fprintf (stderr, "%s: Expecting <subtype> <comma>.\n", Progname);
     /* ignore subtype and comma */
     if (!(s = get_token (buff, sizeof (buff), s)))
       return;
@@ -494,93 +454,28 @@ static void handle_confline (char *s)
   if (!(s = get_token (buff, sizeof (buff), s)))
     return;
 
-  if (Debug)
-    fprintf (stderr, "%s: Expecting default value.\n", Progname);
-
   /* <default value> or UL <default value> */
   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));
+  memset(val, 0, sizeof(val));
 
   do {
     if (!strcmp (buff, "}"))
       break;
 
-    strncpy (tmp + STRLEN (tmp), buff, sizeof (tmp) - STRLEN (tmp));
+    m_strcat(val, sizeof(val), buff);
   }
   while ((s = get_token (buff, sizeof (buff), s)));
 
-  pretty_default (val, sizeof (val), tmp, type);
   add_var (varname);
   print_confline (varname, type, val);
 }
 
-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);
-      break;
-    }
-  case DT_BOOL:
-    {
-      if (atoi (s))
-        strncpy (t, "yes", l);
-      else
-        strncpy (t, "no", l);
-      break;
-    }
-  case DT_SORT:
-    {
-      /* heuristic! */
-      strncpy (t, s + 5, l);
-      for (; *t; t++)
-        *t = tolower ((unsigned char) *t);
-      break;
-    }
-  case DT_MAGIC:
-    {
-      /* heuristic! */
-      strncpy (t, s + 2, l);
-      for (; *t; t++)
-        *t = tolower ((unsigned char) *t);
-      break;
-    }
-  case DT_STR:
-  case DT_RX:
-  case DT_ADDR:
-  case DT_PATH:
-    {
-      if (!strcmp (s, "0"))
-        break;
-      /* fallthrough */
-    }
-  default:
-    {
-      strncpy (t, s, l);
-      break;
-    }
-  }
-}
-
 static void char_to_escape (char *dest, unsigned int c)
 {
   switch (c) {
@@ -662,24 +557,28 @@ static int sgml_fputc (int c)
     return add_s ("&lt;");
   case '>':
     return add_s ("&gt;");
+#if 0
   case '$':
     return add_s ("&dollar;");
   case '_':
     return add_s ("&lowbar;");
   case '%':
     return add_s ("&percnt;");
+#endif
   case '&':
     return add_s ("&amp;");
+#if 0
   case '\\':
     return add_s ("&bsol;");
   case '"':
-    return add_s ("&dquot;");
+    return add_s ("&quot;");
   case '[':
     return add_s ("&lsqb;");
   case ']':
     return add_s ("&rsqb;");
   case '~':
     return add_s ("&tilde;");
+#endif
   default:
     return add_c (c);
   }
@@ -694,6 +593,21 @@ static int sgml_fputs (const char *s)
   return 0;
 }
 
+/* reduce CDATA to ID */
+static int sgml_id_fputs (const char *s) {
+ char id;
+
+ for (; *s; s++) {
+   if (*s == '_')
+     id = '-';
+   else
+     id = *s;
+   if (sgml_fputc ((unsigned int) id) == EOF)
+     return EOF;
+ }
+ return 0;
+}
+
 static void print_confline (const char *varname, int type, const char *val)
 {
   if (type == DT_SYN)
@@ -703,11 +617,18 @@ static void print_confline (const char *varname, int type, const char *val)
     /* configuration file */
   case F_CONF:
     {
+      if (type == DT_SYS) {
+        add_s ("\n# set ?");
+        add_s (varname);
+        add_s (" prints ");
+        add_s (val);
+        break;
+      }
       if (type == DT_STR || type == DT_RX || type == DT_ADDR
           || type == DT_PATH) {
         add_s ("\n# set ");
         add_s (varname);
-        add_s ("\"");
+        add_s ("=\"");
         conf_print_strval (val);
         add_s ("\"");
       }
@@ -753,7 +674,7 @@ static void print_confline (const char *varname, int type, const char *val)
         add_s ("\\(rq\n");
       }
       else {
-        add_s ("Default: ");
+        add_s (type == DT_SYS ? "Value: " : "Default: ");
         add_s (val);
         add_c ('\n');
       }
@@ -765,26 +686,26 @@ static void print_confline (const char *varname, int type, const char *val)
     /* SGML based manual */
   case F_SGML:
     {
-      add_s ("\n<sect2>");
+      add_s ("\n<madmutt-doc:vardef name=\"");
       sgml_fputs (varname);
-      add_s ("<label id=\"");
-      add_s (varname);
-      add_s ("\">");
-      add_s ("\n<p>\nType: <tt>");
+      add_s ("\">\n<para>Type: <literal>");
       add_s (type2human (type));
-      add_s ("</tt>\n\n");
+      add_s ("</literal></para>\n");
 
       if (type == DT_STR || type == DT_RX || type == DT_ADDR
           || type == DT_PATH) {
-        add_s ("<p>\nDefault: <tt>&dquot;");
+        add_s ("<para>\nDefault: <literal>&quot;");
         sgml_print_strval (val);
-        add_s ("&dquot;</tt>");
+        add_s ("&quot;</literal>");
       }
       else {
-        add_s ("<p>\nDefault: <tt>");
+        add_s ("<para>\n"); 
+        add_s (type == DT_SYS ? "Value: " : "Default: ");
+        add_s ("<literal>");
         add_s (val);
-        add_s ("</tt>");
+        add_s ("</literal>");
       }
+      add_s ("</para>\n");
       break;
     }
     /* make gcc happy */
@@ -805,6 +726,7 @@ static void print_confline (const char *varname, int type, const char *val)
  **
  ** - \fI switches to italics
  ** - \fB switches to boldface
+ ** - \fT switches to typewriter for SGML
  ** - \fP switches to normal display
  ** - .dl on a line starts a definition list (name taken taken from HTML).
  ** - .dt starts a term in a definition list.
@@ -834,6 +756,9 @@ static int flush_doc (int docstat)
     exit (1);
   }
 
+  if (docstat & (D_PA))
+    docstat = print_it (SP_END_PAR, NULL, docstat);
+
   if (docstat & (D_TAB))
     docstat = print_it (SP_END_TAB, NULL, docstat);
 
@@ -843,6 +768,8 @@ static int flush_doc (int docstat)
   if (docstat & (D_EM | D_BF | D_TT))
     docstat = print_it (SP_END_FT, NULL, docstat);
 
+  docstat = print_it (SP_END_SECT, NULL, docstat);
+
   docstat = print_it (SP_NEWLINE, NULL, 0);
 
   fd_recurse--;
@@ -964,26 +891,27 @@ static int print_it (int special, char *str, int docstat)
       case SP_END_FT:
         {
           add_s ("\\fP");
-          docstat &= ~(D_EM | D_BF);
+          docstat &= ~(D_EM | D_BF | D_TT);
           break;
         }
       case SP_START_BF:
         {
           add_s ("\\fB");
           docstat |= D_BF;
-          docstat &= ~D_EM;
+          docstat &= ~(D_EM | D_TT);
           break;
         }
       case SP_START_EM:
         {
           add_s ("\\fI");
           docstat |= D_EM;
-          docstat &= ~D_BF;
+          docstat &= ~(D_BF | D_TT);
           break;
         }
       case SP_START_TT:
         {
           docstat |= D_TT;
+          docstat &= ~(D_BF | D_EM);
           break;
         }
       case SP_NEWLINE:
@@ -1078,31 +1006,31 @@ static int print_it (int special, char *str, int docstat)
       case SP_END_FT:
         {
           if (docstat & D_EM)
-            add_s ("</em>");
+            add_s ("</emphasis>");
           if (docstat & D_BF)
-            add_s ("</bf>");
+            add_s ("</emphasis>");
           if (docstat & D_TT)
-            add_s ("</tt>");
+            add_s ("</literal>");
           docstat &= ~(D_EM | D_BF | D_TT);
           break;
         }
       case SP_START_BF:
         {
-          add_s ("<bf>");
+          add_s ("<emphasis role=\"bold\">");
           docstat |= D_BF;
           docstat &= ~(D_EM | D_TT);
           break;
         }
       case SP_START_EM:
         {
-          add_s ("<em>");
+          add_s ("<emphasis>");
           docstat |= D_EM;
           docstat &= ~(D_BF | D_TT);
           break;
         }
       case SP_START_TT:
         {
-          add_s ("<tt>");
+          add_s ("<literal>");
           docstat |= D_TT;
           docstat &= ~(D_EM | D_BF);
           break;
@@ -1126,44 +1054,65 @@ static int print_it (int special, char *str, int docstat)
 
           if (!(onl & D_NL))
             add_s ("\n");
-          add_s ("\n<p>\n");
+          if (docstat & D_PA)
+            add_s ("</para>\n");
+          add_s ("<para>\n");
 
           docstat |= D_NP;
+          docstat |= D_PA;
           break;
         }
       case SP_START_TAB:
         {
-          add_s ("\n<tscreen><verb>\n");
+          add_s ("\n<screen>\n");
           docstat |= D_TAB | D_NL;
           break;
         }
       case SP_END_TAB:
         {
-          add_s ("\n</verb></tscreen>");
+          add_s ("\n</screen>");
           docstat &= ~D_TAB;
           docstat |= D_NL;
           break;
         }
       case SP_START_DL:
         {
-          add_s ("\n<descrip>\n");
+          add_s ("\n<variablelist>\n");
           docstat |= D_DL;
           break;
         }
       case SP_DT:
         {
-          add_s ("<tag>");
+          add_s ("<varlistentry><term>");
           break;
         }
       case SP_DD:
         {
-          add_s ("</tag>");
+          add_s ("</term>\n<listitem><para>\n");
+          docstat |= D_DD;
           break;
         }
       case SP_END_DL:
         {
-          add_s ("</descrip>\n");
-          docstat &= ~D_DL;
+          add_s ("</para></listitem></varlistentry></variablelist>\n");
+          docstat &= ~(D_DL|D_DD);
+          break;
+        }
+      case SP_END_PAR:
+        {
+          add_s ("</para>\n");
+          docstat &= ~D_PA;
+          break;
+        }
+      case SP_END_DD:
+        {
+          add_s ("</para></listitem></varlistentry>\n");
+          docstat &= ~D_DD;
+          break;
+        }
+      case SP_END_SECT:
+        {
+          add_s ("</madmutt-doc:vardef>\n");
           break;
         }
       case SP_STR:
@@ -1196,13 +1145,13 @@ void print_ref (int output_dollar, const char *ref)
     break;
 
   case F_SGML:
-    add_s ("<ref id=\"");
-    add_s (ref);
-    add_s ("\" name=\"");
+    add_s ("<link linkend=\"");
+    sgml_id_fputs (ref);
+    add_s ("\">\n");
     if (output_dollar)
-      add_s ("&dollar;");
+      add_s ("$");
     sgml_fputs (ref);
-    add_s ("\">");
+    add_s ("</link>");
     break;
 
   default:
@@ -1228,9 +1177,6 @@ static int handle_docline (char *l, int docstat)
 
   l = skip_ws (l);
 
-  if (Debug)
-    fprintf (stderr, "%s: handle_docline `%s'\n", Progname, l);
-
   if (!strncmp (l, ".pp", 3))
     return print_it (SP_NEWPAR, NULL, docstat);
   else if (!strncmp (l, ".ts", 3))
@@ -1274,6 +1220,10 @@ static int handle_docline (char *l, int docstat)
       s += 2;
     }
     else if (!strncmp (s, ".dt", 3)) {
+      if (docstat & D_DD) {
+        docstat = commit_buff (buff, &d, docstat);
+        docstat = print_it (SP_END_DD, NULL, docstat);
+      }
       docstat = commit_buff (buff, &d, docstat);
       docstat = print_it (SP_DT, NULL, docstat);
       s += 3;