[BACK]Return to pod2mdoc.c CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / pod2mdoc

Diff for /pod2mdoc/pod2mdoc.c between version 1.12 and 1.32

version 1.12, 2014/04/01 11:58:32 version 1.32, 2014/07/18 05:09:32
Line 27 
Line 27 
 #include <unistd.h>  #include <unistd.h>
   
 /*  /*
  * In what section can we find Perl manuals?   * In what section can we find Perl module manuals?
    * Sometimes (Mac OS X) it's 3pm, sometimes (OpenBSD, etc.) 3p.
    * XXX IF YOU CHANGE THIS, CHANGE POD2MDOC.1 AS WELL.
  */   */
 #define PERL_SECTION    "3p"  #define PERL_SECTION    "3p"
   
Line 50  enum sect {
Line 52  enum sect {
         SECT_SYNOPSIS, /* SYNOPSIS section */          SECT_SYNOPSIS, /* SYNOPSIS section */
 };  };
   
   enum    outstate {
           OUST_NL = 0,    /* just started a new output line */
           OUST_TXT,       /* text line output in progress */
           OUST_MAC        /* macro line output in progress */
   };
   
 struct  state {  struct  state {
           const char      *fname; /* file being parsed */
         int              parsing; /* after =cut of before command */          int              parsing; /* after =cut of before command */
         int              paused; /* in =begin and before =end */          int              paused; /* in =begin and before =end */
         int              haspar; /* in paragraph: do we need Pp? */  
         enum sect        sect; /* which section are we in? */          enum sect        sect; /* which section are we in? */
         const char      *fname; /* file being parsed */  
 #define LIST_STACKSZ     128  #define LIST_STACKSZ     128
         enum list        lstack[LIST_STACKSZ]; /* open lists */          enum list        lstack[LIST_STACKSZ]; /* open lists */
         size_t           lpos; /* where in list stack */          size_t           lpos; /* where in list stack */
           int              haspar; /* in paragraph: do we need Pp? */
           enum outstate    oust; /* state of the mdoc output stream */
           int              wantws; /* let mdoc(7) output whitespace here */
           char            *outbuf; /* text buffered for output */
           size_t           outbufsz; /* allocated size of outbuf */
           size_t           outbuflen; /* current length of outbuf */
 };  };
   
 enum    fmt {  enum    fmt {
Line 121  static const char fmts[FMT__MAX] = {
Line 134  static const char fmts[FMT__MAX] = {
   
 static  int     last;  static  int     last;
   
   
   static void
   outbuf_grow(struct state *st, size_t by)
   {
   
           st->outbufsz += (by / 128 + 1) * 128;
           st->outbuf = realloc(st->outbuf, st->outbufsz);
           if (NULL == st->outbuf) {
                   perror(NULL);
                   exit(EXIT_FAILURE);
           }
   }
   
   static void
   outbuf_addchar(struct state *st)
   {
   
           if (st->outbuflen + 2 >= st->outbufsz)
                   outbuf_grow(st, 1);
           st->outbuf[st->outbuflen++] = last;
           if ('\\' == last)
                   st->outbuf[st->outbuflen++] = 'e';
           st->outbuf[st->outbuflen] = '\0';
           st->wantws = 0;
   }
   
   static void
   outbuf_addstr(struct state *st, const char *str)
   {
           size_t   slen;
   
           slen = strlen(str);
           if (st->outbuflen + slen >= st->outbufsz)
                   outbuf_grow(st, slen);
           memcpy(st->outbuf + st->outbuflen, str, slen+1);
           last = str[slen - 1];
           st->wantws = 0;
   }
   
   static void
   outbuf_flush(struct state *st)
   {
   
           if (0 == st->outbuflen)
                   return;
   
           fputs(st->outbuf, stdout);
           *st->outbuf = '\0';
           st->outbuflen = 0;
   
           if (OUST_NL == st->oust)
                   st->oust = OUST_TXT;
   }
   
   static void
   mdoc_newln(struct state *st)
   {
   
           if (OUST_NL == st->oust)
                   return;
   
           putchar('\n');
           last = '\n';
           st->oust = OUST_NL;
           st->wantws = 1;
   }
   
 /*  /*
  * Given buf[*start] is at the start of an escape name, read til the end   * Given buf[*start] is at the start of an escape name, read til the end
  * of the escape ('>') then try to do something with it.   * of the escape ('>') then try to do something with it.
  * Sets start to be one after the '>'.   * Sets start to be one after the '>'.
    *
    * This function does not care about output modes,
    * it merely appends text to the output buffer,
    * which can then be used in any mode.
  */   */
 static void  static void
 formatescape(const char *buf, size_t *start, size_t end)  formatescape(struct state *st, const char *buf, size_t *start, size_t end)
 {  {
         char             esc[16]; /* no more needed */          char             esc[16]; /* no more needed */
         size_t           i, max;          size_t           i, max;
Line 155  formatescape(const char *buf, size_t *start, size_t en
Line 239  formatescape(const char *buf, size_t *start, size_t en
          * Just let the rest of them go.           * Just let the rest of them go.
          */           */
         if (0 == strcmp(esc, "lt"))          if (0 == strcmp(esc, "lt"))
                 printf("\\(la");                  outbuf_addstr(st, "\\(la");
         else if (0 == strcmp(esc, "gt"))          else if (0 == strcmp(esc, "gt"))
                 printf("\\(ra");                  outbuf_addstr(st, "\\(ra");
         else if (0 == strcmp(esc, "vb"))          else if (0 == strcmp(esc, "vb"))
                 printf("\\(ba");                  outbuf_addstr(st, "\\(ba");
         else if (0 == strcmp(esc, "sol"))          else if (0 == strcmp(esc, "sol"))
                 printf("\\(sl");                  outbuf_addstr(st, "\\(sl");
         else  
                 return;  
   
         last = 'a';  
 }  }
   
 /*  /*
  * Run some heuristics to intuit a link format.   * Run some heuristics to intuit a link format.
  * I recognise L<foo::bar> as a Perl manpage, printing it in section 3p;   * I set "start" to be the end of the sequence (last right-carrot) so
  * or a general UNIX foo(5) manpage.  
  * If I recognise one, I set "start" to be the end of the sequence so  
  * that the caller can safely just continue processing.   * that the caller can safely just continue processing.
  * Otherwise, I don't touch "start".   * If this is just an empty tag, I'll return 0.
    *
    * Always operates in OUST_MAC mode.
    * Mode handling is done by the caller.
  */   */
 static int  static int
 trylink(const char *buf, size_t *start, size_t end, size_t dsz)  trylink(const char *buf, size_t *start, size_t end, size_t dsz)
 {  {
         size_t          sv, nstart, nend, i, j;          size_t           linkstart, realend, linkend,
         int             hasdouble;                           i, j, textsz, stack;
   
         /*          /*
          * Scan to the start of the terminus.           * Scan to the start of the terminus.
          * This function is more or less replicated in the formatcode()           * This function is more or less replicated in the formatcode()
          * for null or index formatting codes.           * for null or index formatting codes.
            * However, we're slightly different because we might have
            * nested escapes we need to ignore.
          */           */
         hasdouble = 0;          stack = 0;
         for (sv = nstart = *start; nstart < end; nstart++) {          for (linkstart = realend = *start; realend < end; realend++) {
                 /* Do we have a double-colon? */                  if ('<' == buf[realend])
                 if (':' == buf[nstart] &&                          stack++;
                         nstart > sv &&                  if ('>' != buf[realend])
                         ':' == buf[nstart - 1])  
                         hasdouble = 1;  
                 if ('>' != buf[nstart])  
                         continue;                          continue;
                 else if (dsz == 1)                  else if (stack-- > 0)
                           continue;
                   if (dsz == 1)
                         break;                          break;
                 assert(nstart > 0);                  assert(realend > 0);
                 if (' ' != buf[nstart - 1])                  if (' ' != buf[realend - 1])
                         continue;                          continue;
                 i = nstart;                  for (i = realend, j = 0; i < end && j < dsz; j++)
                 for (j = 0; i < end && j < dsz; j++)  
                         if ('>' != buf[i++])                          if ('>' != buf[i++])
                                 break;                                  break;
                 if (dsz == j)                  if (dsz == j)
                         break;                          break;
         }          }
   
         /* We don't care about stubs. */          /* Ignore stubs. */
         if (nstart == end || nstart == *start)          if (realend == end || realend == *start)
                 return(0);                  return(0);
   
         /* Set nend to the end of content. */          /* Set linkend to the end of content. */
         nend = nstart;          linkend = dsz > 1 ? realend - 1 : realend;
         if (dsz > 1)  
                 nend--;  
   
         /*          /* Re-scan to see if we have a title or section. */
          * Provide for some common invocations of the link primitive.          for (textsz = *start; textsz < linkend; textsz++)
          * First, allow us to link to other Perl manuals.                  if ('|' == buf[textsz] || '/' == buf[textsz])
          */                          break;
         if (hasdouble)  
           if (textsz < linkend && '|' == buf[textsz]) {
                   /* With title: set start, then end at section. */
                   linkstart = textsz + 1;
                   textsz = textsz - *start;
                   for (i = linkstart; i < linkend; i++)
                           if ('/' == buf[i])
                                   break;
                   if (i < linkend)
                           linkend = i;
           } else if (textsz < linkend && '/' == buf[textsz]) {
                   /* With section: set end at section. */
                   linkend = textsz;
                   textsz = 0;
           } else
                   /* No title, no section. */
                   textsz = 0;
   
           *start = realend;
           j = linkend - linkstart;
   
           /* Do we have only subsection material? */
           if (0 == j && '/' == buf[linkend]) {
                   linkstart = linkend + 1;
                   linkend = dsz > 1 ? realend - 1 : realend;
                   if (0 == (j = linkend - linkstart))
                           return(0);
                   printf("Sx %.*s", (int)j, &buf[linkstart]);
                   return(1);
           } else if (0 == j)
                   return(0);
   
           /* See if we qualify as being a link or not. */
           if ((j > 4 && 0 == memcmp("http:", &buf[linkstart], j)) ||
                   (j > 5 && 0 == memcmp("https:", &buf[linkstart], j)) ||
                   (j > 3 && 0 == memcmp("ftp:", &buf[linkstart], j)) ||
                   (j > 4 && 0 == memcmp("sftp:", &buf[linkstart], j)) ||
                   (j > 3 && 0 == memcmp("smb:", &buf[linkstart], j)) ||
                   (j > 3 && 0 == memcmp("afs:", &buf[linkstart], j))) {
                   /* Gross. */
                   printf("Lk %.*s", (int)((dsz > 1 ? realend - 1 :
                           realend) - linkstart), &buf[linkstart]);
                   return(1);
           }
   
           /* See if we qualify as a mailto. */
           if (j > 6 && 0 == memcmp("mailto:", &buf[linkstart], j)) {
                   printf("Mt %.*s", (int)j, &buf[linkstart]);
                   return(1);
           }
   
           /* See if we're a foo(5), foo(5x), or foo(5xx) manpage. */
           if ((j > 3 && ')' == buf[linkend - 1]) &&
                   ('(' == buf[linkend - 3])) {
                   printf("Xr %.*s %c", (int)(j - 3),
                           &buf[linkstart], buf[linkend - 2]);
                   return(1);
           } else if ((j > 4 && ')' == buf[linkend - 1]) &&
                   ('(' == buf[linkend - 4])) {
                   printf("Xr %.*s %.*s", (int)(j - 4),
                           &buf[linkstart], 2, &buf[linkend - 3]);
                   return(1);
           } else if ((j > 5 && ')' == buf[linkend - 1]) &&
                   ('(' == buf[linkend - 5])) {
                   printf("Xr %.*s %.*s", (int)(j - 5),
                           &buf[linkstart], 3, &buf[linkend - 4]);
                   return(1);
           }
   
           /* Last try: do we have a double-colon? */
           for (i = linkstart + 1; i < linkend; i++)
                   if (':' == buf[i] && ':' == buf[i - 1])
                           break;
   
           if (i < linkend)
                 printf("Xr %.*s " PERL_SECTION,                  printf("Xr %.*s " PERL_SECTION,
                         (int)(nend - sv), &buf[sv]);                          (int)j, &buf[linkstart]);
         else if (nend - sv > 3 && isalnum(buf[sv]) &&  
                         ')' == buf[nend - 1] &&  
                         isdigit((int)buf[nend - 2]) &&  
                         '(' == buf[nend - 3])  
                 printf("Xr %.*s %c",  
                         (int)(nend - 3 - sv),  
                         &buf[sv], buf[nend - 2]);  
         else          else
                 return(0);                  printf("Xr %.*s 1", (int)j, &buf[linkstart]);
   
         *start = nstart;  
         return(1);          return(1);
 }  }
   
 /*  /*
    * Doclifting: if we're a bold "-xx" and we're in the SYNOPSIS section,
    * then it's likely that we're a flag.
    * Our flag might be followed by an argument, so make sure that we're
    * accounting for that, too.
    * If we don't have a flag at all, however, then assume we're an "Ar".
    *
    * Always operates in OUST_MAC mode.
    * Mode handlinf is done by the caller.
    */
   static void
   dosynopsisfl(const char *buf, size_t *start, size_t end)
   {
           size_t   i;
   again:
           assert(*start + 1 < end);
           assert('-' == buf[*start]);
   
           if ( ! isalnum((int)buf[*start + 1]) &&
                   '?' != buf[*start + 1] &&
                   '-' != buf[*start + 1]) {
                   (*start)--;
                   fputs("Ar ", stdout);
                   return;
           }
   
           (*start)++;
           for (i = *start; i < end; i++)
                   if (isalnum((int)buf[i]))
                           continue;
                   else if ('?' == buf[i])
                           continue;
                   else if ('-' == buf[i])
                           continue;
                   else if ('_' == buf[i])
                           continue;
                   else
                           break;
   
           assert(i < end);
   
           if ( ! (' ' == buf[i] || '>' == buf[i])) {
                   printf("Ar ");
                   return;
           }
   
           printf("Fl ");
           if (end - *start > 1 &&
                   isupper((int)buf[*start]) &&
                   islower((int)buf[*start + 1]) &&
                   (end - *start == 2 ||
                    ' ' == buf[*start + 2]))
                   printf("\\&");
           printf("%.*s ", (int)(i - *start), &buf[*start]);
           *start = i;
   
           if (' ' == buf[i]) {
                   while (i < end && ' ' == buf[i])
                           i++;
                   assert(i < end);
                   if ('-' == buf[i]) {
                           *start = i;
                           goto again;
                   }
                   printf("Ar ");
                   *start = i;
           }
   }
   
   /*
  * We're at the character in front of a format code, which is structured   * We're at the character in front of a format code, which is structured
  * like X<...> and can contain nested format codes.   * like X<...> and can contain nested format codes.
  * This consumes the whole format code, and any nested format codes, til   * This consumes the whole format code, and any nested format codes, til
  * the end of matched production.   * the end of matched production.
  * If "reentrant", then we're being called after a macro has already  
  * been printed to the current line.  
  * If "nomacro", then we don't print any macros, just contained data   * If "nomacro", then we don't print any macros, just contained data
  * (e.g., following "Sh" or "Nm").   * (e.g., following "Sh" or "Nm").
  * Return whether we've printed a macro or not--in other words, whether   * "pos" is only significant in SYNOPSIS, and should be 0 when invoked
  * this should trigger a subsequent newline (this should be ignored when   * as the first format code on a line (for decoration as an "Nm"),
  * reentrant).   * non-zero otherwise.
    *
    * Output mode handling is most complicated here.
    * We may enter in any mode.
    * We usually exit in OUST_MAC mode, except when
    * entering without OUST_MAC and the code is invalid.
  */   */
 static int  static void
 formatcode(struct state *st, const char *buf,  formatcode(struct state *st, const char *buf, size_t *start,
         size_t *start, size_t end, int reentrant, int nomacro)          size_t end, int nomacro, int pos)
 {  {
         enum fmt         fmt;          enum fmt         fmt;
         size_t           i, j, dsz;          size_t           i, j, dsz;
Line 264  formatcode(struct state *st, const char *buf, 
Line 481  formatcode(struct state *st, const char *buf, 
   
         /*          /*
          * First, look up the format code.           * First, look up the format code.
          * If it's not valid, then exit immediately.           * If it's not valid, treat it as a NOOP.
          */           */
         for (fmt = 0; fmt < FMT__MAX; fmt++)          for (fmt = 0; fmt < FMT__MAX; fmt++)
                 if (buf[*start] == fmts[fmt])                  if (buf[*start] == fmts[fmt])
                         break;                          break;
   
         if (FMT__MAX == fmt) {  
                 putchar(last = buf[(*start)++]);  
                 if ('\\' == last)  
                         putchar('e');  
                 return(0);  
         }  
   
         /*          /*
          * Determine whether we're overriding our delimiter.           * Determine whether we're overriding our delimiter.
          * According to POD, if we have more than one '<' followed by a           * According to POD, if we have more than one '<' followed by a
Line 301  formatcode(struct state *st, const char *buf, 
Line 511  formatcode(struct state *st, const char *buf, 
          * processing for real macros.           * processing for real macros.
          */           */
         if (FMT_ESCAPE == fmt) {          if (FMT_ESCAPE == fmt) {
                 formatescape(buf, start, end);                  formatescape(st, buf, start, end);
                 return(0);                  return;
         } else if (FMT_NULL == fmt || FMT_INDEX == fmt) {          } else if (FMT_NULL == fmt || FMT_INDEX == fmt) {
                 /*                  /*
                  * Just consume til the end delimiter, accounting for                   * Just consume til the end delimiter, accounting for
Line 325  formatcode(struct state *st, const char *buf, 
Line 535  formatcode(struct state *st, const char *buf, 
                         (*start) += dsz;                          (*start) += dsz;
                         break;                          break;
                 }                  }
                 return(0);                  if (*start < end) {
                           assert('>' == buf[*start]);
                           (*start)++;
                   }
                   if (isspace(last))
                           while (*start < end && isspace((int)buf[*start]))
                                   (*start)++;
                   return;
         }          }
   
         /*          /*
          * Check whether we're supposed to print macro stuff (this is           * Check whether we're supposed to print macro stuff (this is
          * suppressed in, e.g., "Nm" and "Sh" macros).           * suppressed in, e.g., "Nm" and "Sh" macros).
          */           */
         if ( ! nomacro) {          if (FMT__MAX != fmt && !nomacro) {
   
                 /*                  /*
                  * Print out the macro describing this format code.                   * We may already have wantws if there was whitespace
                  * If we're not "reentrant" (not yet on a macro line)                   * before the code ("text B<text"), but initial
                  * then print a newline, if necessary, and the macro                   * whitespace inside our scope ("textB< text")
                  * indicator.                   * allows to break at this point as well.
                  * Otherwise, offset us with a space.  
                  */                   */
                 if ( ! reentrant) {  
                         if (last != '\n')                  st->wantws |= ' ' == buf[*start];
   
                   /*
                    * If we are on a text line and there is no
                    * whitespace before our content, we have to make
                    * the previous word a prefix to the macro line.
                    * In the following, mdoc_newln() must not be used
                    * lest we clobber out output state.
                    */
   
                   if (OUST_MAC != st->oust && !st->wantws) {
                           if (OUST_NL != st->oust)
                                 putchar('\n');                                  putchar('\n');
                           printf(".Pf ");
                   }
   
                   outbuf_flush(st);
   
                   /* Whitespace is easier to suppress on macro lines. */
   
                   if (OUST_MAC == st->oust && !st->wantws)
                           printf(" Ns ");
   
                   /* Unless we are on a macro line, start one. */
   
                   if (OUST_MAC != st->oust && st->wantws) {
                           if (OUST_NL != st->oust)
                                   putchar('\n');
                         putchar('.');                          putchar('.');
                 } else                  } else
                         putchar(' ');                          putchar(' ');
   
                 /*                  /*
                  * If we don't have whitespace before us (and none after                   * Print the macro corresponding to this format code,
                  * the opening delimiter), then suppress macro                   * and update the output state afterwards.
                  * whitespace with Pf.  
                  */                   */
                 if (' ' != last && '\n' != last && ' ' != buf[*start])  
                         printf("Pf ");  
   
                 switch (fmt) {                  switch (fmt) {
                 case (FMT_ITALIC):                  case (FMT_ITALIC):
                         printf("Em ");                          printf("Em ");
                         break;                          break;
                 case (FMT_BOLD):                  case (FMT_BOLD):
                         /*                          if (SECT_SYNOPSIS == st->sect) {
                          * Doclifting: if we're a bold "-xx" and we're                                  if (1 == dsz && '-' == buf[*start])
                          * in the SYNOPSIS section, then it's likely                                          dosynopsisfl(buf, start, end);
                          * that we're a flag.                                  else if (0 == pos)
                          * Be really strict: only do this when the dash                                          printf("Nm ");
                          * is followed by alnums til the end marker,                                  else
                          * which mustn't be a custom.                                          printf("Ar ");
                          */                                  break;
                         if (SECT_SYNOPSIS == st->sect &&  
                                 end - *start > 1 &&  
                                 '-' == buf[*start] &&  
                                 (isalnum((int)buf[*start + 1]) ||  
                                  '?' == buf[*start + 1])) {  
                                 for (i = *start + 1; i < end; i++)  
                                         if ( ! isalnum((int)buf[i]))  
                                                 break;  
                                 if (i < end && '>' == buf[i]) {  
                                         (*start)++;  
                                         printf("Fl ");  
                                         break;  
                                 }  
                         }                          }
                         printf("Sy ");                          if (0 == strncmp(buf + *start, "NULL", 4) &&
                               ('=' == buf[*start + 4] ||
                                '>' == buf[*start + 4]))
                                   printf("Dv ");
                           else
                                   printf("Sy ");
                         break;                          break;
                 case (FMT_CODE):                  case (FMT_CODE):
                         printf("Qo Li ");                          printf("Qo Li ");
                         break;                          break;
                 case (FMT_LINK):                  case (FMT_LINK):
                           /* Try to link; use "No" if it's empty. */
                         if ( ! trylink(buf, start, end, dsz))                          if ( ! trylink(buf, start, end, dsz))
                                 printf("No ");                                  printf("No ");
                         break;                          break;
Line 400  formatcode(struct state *st, const char *buf, 
Line 633  formatcode(struct state *st, const char *buf, 
                 default:                  default:
                         abort();                          abort();
                 }                  }
         }                  st->oust = OUST_MAC;
                   st->wantws = 1;
           } else
                   outbuf_flush(st);
   
         /*          /*
          * Process until we reach the end marker (e.g., '>') or until we           * Process until we reach the end marker (e.g., '>') or until we
Line 430  formatcode(struct state *st, const char *buf, 
Line 666  formatcode(struct state *st, const char *buf, 
                         }                          }
                 }                  }
                 if (*start + 1 < end && '<' == buf[*start + 1]) {                  if (*start + 1 < end && '<' == buf[*start + 1]) {
                         formatcode(st, buf, start, end, 1, nomacro);                          formatcode(st, buf, start, end, nomacro, 1);
                         continue;                          continue;
                 }                  }
   
                 /*                  /* Suppress newlines and multiple spaces. */
                  * Make sure that any macro-like words (or  
                  * really any word starting with a capital  
                  * letter) is assumed to be a macro that must be  
                  * escaped.  
                  * This matches "Xx " and "XxEOLN".  
                  */  
                 if ((' ' == last || '\n' == last) &&  
                                 end - *start > 1 &&  
                                 isupper((int)buf[*start]) &&  
                                 islower((int)buf[*start + 1]) &&  
                                 (end - *start == 2 ||  
                                  ' ' == buf[*start + 2]))  
                         printf("\\&");  
   
                 /* Suppress newline. */                  last = buf[(*start)++];
                 if ('\n' == buf[*start])                  if (' ' == last || '\n' == last) {
                         putchar(last = ' ');                          putchar(' ');
                 else                          while (*start < end && ' ' == buf[*start])
                         putchar(last = buf[*start]);                                  (*start)++;
                           continue;
                   }
   
                   if (OUST_MAC == st->oust) {
                           if ( ! st->wantws) {
                                   printf(" Ns ");
                                   st->wantws = 1;
                           }
   
                           /*
                            * Escape macro-like words.
                            * This matches "Xx " and "XxEOLN".
                            */
   
                           if (end - *start > 0 &&
                               isupper((unsigned char)last) &&
                               islower((unsigned char)buf[*start]) &&
                               (end - *start == 1 ||
                                ' ' == buf[*start + 1] ||
                                '>' == buf[*start + 1]))
                                   printf("\\&");
                   }
   
                   putchar(last);
   
                 /* Protect against character escapes. */                  /* Protect against character escapes. */
   
                 if ('\\' == last)                  if ('\\' == last)
                         putchar('e');                          putchar('e');
   
                 (*start)++;  
   
                 if (' ' == last)  
                         while (*start < end && ' ' == buf[*start])  
                                 (*start)++;  
         }          }
   
         if ( ! nomacro && FMT_CODE == fmt)          if ( ! nomacro && FMT_CODE == fmt)
                 printf(" Qc ");                  printf(" Qc ");
   
         /*          if (FMT__MAX != fmt)
          * We're now subsequent the format code.                  st->wantws = ' ' == last;
          * If there isn't a space (or newline) here, and we haven't just  
          * printed a space, then suppress space.  
          */  
         if ( ! nomacro && ' ' != last)  
                 if (' ' != buf[*start] && '\n' != buf[*start])  
                         printf(" Ns ");  
   
         return(1);  
 }  }
   
 /*  /*
  * Calls formatcode() til the end of a paragraph.   * Calls formatcode() til the end of a paragraph.
    * Goes to OUST_MAC mode and stays there when returning,
    * such that the caller can add arguments to the macro line
    * before closing it out.
  */   */
 static void  static void
 formatcodeln(struct state *st, const char *buf,  formatcodeln(struct state *st, const char *linemac,
         size_t *start, size_t end, int nomacro)          const char *buf, size_t *start, size_t end, int nomacro)
 {  {
   
           assert(OUST_NL == st->oust);
           assert(st->wantws);
           printf(".%s ", linemac);
           st->oust = OUST_MAC;
   
         last = ' ';          last = ' ';
         while (*start < end)  {          while (*start < end)  {
                 if (*start + 1 < end && '<' == buf[*start + 1]) {                  if (*start + 1 < end && '<' == buf[*start + 1]) {
                         formatcode(st, buf, start, end, 1, nomacro);                          formatcode(st, buf, start, end, nomacro, 1);
                         continue;                          continue;
                 }                  }
   
                   if (OUST_MAC == st->oust) {
                           if ( ! st->wantws &&
                               ' ' != buf[*start] &&
                               '\n' != buf[*start])
                                   printf(" Ns ");
                           st->wantws = 1;
                   }
   
                 /*                  /*
                  * Since we're already on a macro line, we want to make                   * Since we're already on a macro line, we want to make
                  * sure that we don't inadvertently invoke a macro.                   * sure that we don't inadvertently invoke a macro.
Line 548  listguess(const char *buf, size_t start, size_t end)
Line 799  listguess(const char *buf, size_t start, size_t end)
  * A command paragraph, as noted in the perlpod manual, just indicates   * A command paragraph, as noted in the perlpod manual, just indicates
  * that we should do something, optionally with some text to print as   * that we should do something, optionally with some text to print as
  * well.   * well.
    * From the perspective of external callers,
    * always stays in OUST_NL/wantws mode,
    * but its children do use OUST_MAC.
  */   */
 static void  static void
 command(struct state *st, const char *buf, size_t start, size_t end)  command(struct state *st, const char *buf, size_t start, size_t end)
Line 591  command(struct state *st, const char *buf, size_t star
Line 845  command(struct state *st, const char *buf, size_t star
                  * The behaviour of head= follows from a quick glance at                   * The behaviour of head= follows from a quick glance at
                  * how pod2man handles it.                   * how pod2man handles it.
                  */                   */
                 printf(".Sh ");  
                 st->sect = SECT_NONE;                  st->sect = SECT_NONE;
                 if (end - start == 4) {                  if (end - start == 4) {
                         if (0 == memcmp(&buf[start], "NAME", 4))                          if (0 == memcmp(&buf[start], "NAME", 4))
Line 600  command(struct state *st, const char *buf, size_t star
Line 853  command(struct state *st, const char *buf, size_t star
                         if (0 == memcmp(&buf[start], "SYNOPSIS", 8))                          if (0 == memcmp(&buf[start], "SYNOPSIS", 8))
                                 st->sect = SECT_SYNOPSIS;                                  st->sect = SECT_SYNOPSIS;
                 }                  }
                 formatcodeln(st, buf, &start, end, 1);                  formatcodeln(st, "Sh", buf, &start, end, 1);
                 putchar('\n');                  mdoc_newln(st);
                 st->haspar = 1;                  st->haspar = 1;
                 break;                  break;
         case (CMD_HEAD2):          case (CMD_HEAD2):
                 printf(".Ss ");                  formatcodeln(st, "Ss", buf, &start, end, 1);
                 formatcodeln(st, buf, &start, end, 1);                  mdoc_newln(st);
                 putchar('\n');  
                 st->haspar = 1;                  st->haspar = 1;
                 break;                  break;
         case (CMD_HEAD3):          case (CMD_HEAD3):
                 puts(".Pp");                  puts(".Pp");
                 printf(".Em ");                  formatcodeln(st, "Em", buf, &start, end, 0);
                 formatcodeln(st, buf, &start, end, 0);                  mdoc_newln(st);
                 putchar('\n');  
                 puts(".Pp");                  puts(".Pp");
                 st->haspar = 1;                  st->haspar = 1;
                 break;                  break;
         case (CMD_HEAD4):          case (CMD_HEAD4):
                 puts(".Pp");                  puts(".Pp");
                 printf(".No ");                  formatcodeln(st, "No", buf, &start, end, 0);
                 formatcodeln(st, buf, &start, end, 0);                  mdoc_newln(st);
                 putchar('\n');  
                 puts(".Pp");                  puts(".Pp");
                 st->haspar = 1;                  st->haspar = 1;
                 break;                  break;
Line 674  command(struct state *st, const char *buf, size_t star
Line 924  command(struct state *st, const char *buf, size_t star
                 }                  }
                 switch (st->lstack[st->lpos - 1]) {                  switch (st->lstack[st->lpos - 1]) {
                 case (LIST_TAG):                  case (LIST_TAG):
                         printf(".It ");                          formatcodeln(st, "It", buf, &start, end, 0);
                         formatcodeln(st, buf, &start, end, 0);                          mdoc_newln(st);
                         putchar('\n');  
                         break;                          break;
                 case (LIST_ENUM):                  case (LIST_ENUM):
                         /* FALLTHROUGH */                          /* FALLTHROUGH */
Line 728  command(struct state *st, const char *buf, size_t star
Line 977  command(struct state *st, const char *buf, size_t star
   
 /*  /*
  * Just pump out the line in a verbatim block.   * Just pump out the line in a verbatim block.
    * From the perspective of external callers,
    * always stays in OUST_NL/wantws mode.
  */   */
 static void  static void
 verbatim(struct state *st, const char *buf, size_t start, size_t end)  verbatim(struct state *st, const char *buf, size_t start, size_t end)
 {  {
         int              last;          size_t           i;
   
         if ( ! st->parsing || st->paused)          if ( ! st->parsing || st->paused)
                 return;                  return;
   again:
           /*
            * If we're in the SYNOPSIS, see if we're an #include block.
            * If we are, then print the "In" macro and re-loop.
            * This handles any number of inclusions, but only when they
            * come before the remaining parts...
            */
           if (SECT_SYNOPSIS == st->sect) {
                   i = start;
                   for (i = start; i < end && ' ' == buf[i]; i++)
                           /* Spin. */ ;
                   if (i == end)
                           return;
                   /* We're an include block! */
                   if (end - i > 10 &&
                           0 == memcmp(&buf[i], "#include <", 10)) {
                           start = i + 10;
                           while (start < end && ' ' == buf[start])
                                   start++;
                           fputs(".In ", stdout);
                           /* Stop til the '>' marker or we hit eoln. */
                           while (start < end &&
                                   '>' != buf[start] && '\n' != buf[start])
                                   putchar(buf[start++]);
                           putchar('\n');
                           if (start < end && '>' == buf[start])
                                   start++;
                           if (start < end && '\n' == buf[start])
                                   start++;
                           if (start < end)
                                   goto again;
                           return;
                   }
           }
   
           if (start == end)
                   return;
         puts(".Bd -literal");          puts(".Bd -literal");
         for (last = ' '; start < end; start++) {          for (last = ' '; start < end; start++) {
                 /*                  /*
Line 750  verbatim(struct state *st, const char *buf, size_t sta
Line 1037  verbatim(struct state *st, const char *buf, size_t sta
                 if ('\\' == buf[start])                  if ('\\' == buf[start])
                         printf("e");                          printf("e");
         }          }
         putchar('\n');          putchar(last = '\n');
         puts(".Ed");          puts(".Ed");
 }  }
   
 /*  /*
    * See dosynopsisop().
    */
   static int
   hasmatch(const char *buf, size_t start, size_t end)
   {
           size_t   stack;
   
           for (stack = 0; start < end; start++)
                   if (buf[start] == '[')
                           stack++;
                   else if (buf[start] == ']' && 0 == stack)
                           return(1);
                   else if (buf[start] == ']')
                           stack--;
           return(0);
   }
   
   /*
    * If we're in the SYNOPSIS section and we've encounter braces in an
    * ordinary paragraph, then try to see whether we're an [-option].
    * Do this, if we're an opening bracket, by first seeing if we have a
    * matching end via hasmatch().
    * If we're an ending bracket, see if we have a stack already.
    */
   static int
   dosynopsisop(struct state *st, const char *buf,
           size_t *start, size_t end, size_t *opstack)
   {
   
           assert('[' == buf[*start] || ']' == buf[*start]);
   
           if ('[' == buf[*start] && hasmatch(buf, *start + 1, end)) {
                   mdoc_newln(st);
                   puts(".Oo");
                   (*opstack)++;
           } else if ('[' == buf[*start])
                   return(0);
   
           if (']' == buf[*start] && *opstack > 0) {
                   mdoc_newln(st);
                   puts(".Oc");
                   (*opstack)--;
           } else if (']' == buf[*start])
                   return(0);
   
           (*start)++;
           last = '\n';
           while (' ' == buf[*start])
                   (*start)++;
           return(1);
   }
   
   /*
    * Format multiple "Nm" manpage names in the NAME section.
    * From the perspective of external callers,
    * always stays in OUST_NL/wantws mode,
    * but its children do use OUST_MAC.
    */
   static void
   donamenm(struct state *st, const char *buf, size_t *start, size_t end)
   {
           size_t   word;
   
           assert(OUST_NL == st->oust);
           assert(st->wantws);
   
           while (*start < end && ' ' == buf[*start])
                   (*start)++;
   
           if (end == *start) {
                   puts(".Nm unknown");
                   return;
           }
   
           while (*start < end) {
                   for (word = *start; word < end; word++)
                           if (',' == buf[word])
                                   break;
                   formatcodeln(st, "Nm", buf, start, word, 1);
                   if (*start == end) {
                           mdoc_newln(st);
                           break;
                   }
                   assert(',' == buf[*start]);
                   printf(" ,");
                   mdoc_newln(st);
                   (*start)++;
                   while (*start < end && ' ' == buf[*start])
                           (*start)++;
           }
   }
   
   /*
  * Ordinary paragraph.   * Ordinary paragraph.
  * Well, this is really the hardest--POD seems to assume that, for   * Well, this is really the hardest--POD seems to assume that, for
  * example, a leading space implies a newline, and so on.   * example, a leading space implies a newline, and so on.
  * Lots of other snakes in the grass: escaping a newline followed by a   * Lots of other snakes in the grass: escaping a newline followed by a
  * period (accidental mdoc(7) control), double-newlines after macro   * period (accidental mdoc(7) control), double-newlines after macro
  * passages, etc.   * passages, etc.
    *
    * Uses formatcode() to go to OUST_MAC mode
    * and outbuf_flush() to go to OUST_TXT mode.
    * Main text mode wantws handling is in this function.
    * Must make sure to go back to OUST_NL/wantws mode before returning.
  */   */
 static void  static void
 ordinary(struct state *st, const char *buf, size_t start, size_t end)  ordinary(struct state *st, const char *buf, size_t start, size_t end)
 {  {
         size_t          i, j;          size_t          i, j, opstack;
           int             seq;
   
         if ( ! st->parsing || st->paused)          if ( ! st->parsing || st->paused)
                 return;                  return;
Line 777  ordinary(struct state *st, const char *buf, size_t sta
Line 1163  ordinary(struct state *st, const char *buf, size_t sta
          * To wit, print out a "Nm" and "Nd" in that format.           * To wit, print out a "Nm" and "Nd" in that format.
          */           */
         if (SECT_NAME == st->sect) {          if (SECT_NAME == st->sect) {
                 for (i = end - 1; i > start; i--)                  for (i = end - 2; i > start; i--)
                         if ('-' == buf[i])                          if ('-' == buf[i] && ' ' == buf[i + 1])
                                 break;                                  break;
                 if ('-' == buf[i]) {                  if ('-' == buf[i]) {
                         j = i;                          j = i;
Line 786  ordinary(struct state *st, const char *buf, size_t sta
Line 1172  ordinary(struct state *st, const char *buf, size_t sta
                         for ( ; i > start; i--)                          for ( ; i > start; i--)
                                 if ('-' != buf[i])                                  if ('-' != buf[i])
                                         break;                                          break;
                         printf(".Nm ");                          donamenm(st, buf, &start, i + 1);
                         formatcodeln(st, buf, &start, i + 1, 1);  
                         putchar('\n');  
                         start = j + 1;                          start = j + 1;
                         printf(".Nd ");                          while (start < end && ' ' == buf[start])
                         formatcodeln(st, buf, &start, end, 1);                                  start++;
                         putchar('\n');                          formatcodeln(st, "Nd", buf, &start, end, 1);
                           mdoc_newln(st);
                         return;                          return;
                 }                  }
         }          }
Line 802  ordinary(struct state *st, const char *buf, size_t sta
Line 1187  ordinary(struct state *st, const char *buf, size_t sta
   
         st->haspar = 0;          st->haspar = 0;
         last = '\n';          last = '\n';
           opstack = 0;
   
         while (start < end) {          for (seq = 0; start < end; seq++) {
                 /*                  /*
                  * Loop til we get either to a newline or escape.                   * Loop til we get either to a newline or escape.
                  * Escape initial control characters.                   * Escape initial control characters.
Line 814  ordinary(struct state *st, const char *buf, size_t sta
Line 1200  ordinary(struct state *st, const char *buf, size_t sta
                         else if ('\n' == buf[start])                          else if ('\n' == buf[start])
                                 break;                                  break;
                         else if ('\n' == last && '.' == buf[start])                          else if ('\n' == last && '.' == buf[start])
                                 printf("\\&");                                  outbuf_addstr(st, "\\&");
                         else if ('\n' == last && '\'' == buf[start])                          else if ('\n' == last && '\'' == buf[start])
                                 printf("\\&");                                  outbuf_addstr(st, "\\&");
 #if notyet  
                         /*                          /*
                          * If we're in the SYNOPSIS, have square                           * If we're in the SYNOPSIS, have square
                          * brackets indicate that we're opening and                           * brackets indicate that we're opening and
                          * closing an optional context.                           * closing an optional context.
                          */                           */
                         if (SECT_SYNOPSIS == st->sect) {  
                                 if ('[' == buf[start] ||  
                                         ']' == buf[start]) {  
                                         if (last != '\n')  
                                                 putchar('\n');  
                                         if ('[' == buf[start])  
                                                 printf(".Oo\n");  
                                         else  
                                                 printf(".Oc\n");  
                                         start++;  
                                         continue;  
                                 }  
                         }  
 #endif  
                         putchar(last = buf[start++]);  
                         if ('\\' == last)  
                                 putchar('e');  
                 }  
   
                 if (start < end - 1 && '<' == buf[start + 1]) {                          if (SECT_SYNOPSIS == st->sect &&
                                   ('[' == buf[start] ||
                                    ']' == buf[start]) &&
                                   dosynopsisop(st, buf,
                                       &start, end, &opstack))
                                   continue;
   
                         /*                          /*
                          * We've encountered a format code.                           * On whitespace, flush the output buffer
                          * This is going to trigger a macro no matter                           * and allow breaking to a macro line.
                          * what, so print a newline now.                           * Otherwise, buffer text and clear wantws.
                          * Then print the (possibly nested) macros and  
                          * following that, a newline.  
                          * Consume all whitespace so we don't  
                          * accidentally start an implicit literal line.  
                          */                           */
                         if (formatcode(st, buf, &start, end, 0, 0)) {  
                                 putchar(last = '\n');                          last = buf[start++];
                           if (' ' == last) {
                                   outbuf_flush(st);
                                   putchar(' ');
                                   st->wantws = 1;
                           } else
                                   outbuf_addchar(st);
                   }
   
                   if (start < end - 1 && '<' == buf[start + 1]) {
                           formatcode(st, buf, &start, end, 0, seq);
                           if (OUST_MAC == st->oust) {
                                   /*
                                    * Let mdoc(7) handle trailing punctuation.
                                    * XXX Some punctuation characters
                                    *     are not handled yet.
                                    */
                                   if ((start == end - 1 ||
                                           (start < end - 1 &&
                                            (' ' == buf[start + 1] ||
                                             '\n' == buf[start + 1]))) &&
                                           ('.' == buf[start] ||
                                            ',' == buf[start])) {
                                           putchar(' ');
                                           putchar(buf[start++]);
                                   }
   
                                   if (st->wantws ||
                                       ' ' == buf[start] ||
                                       '\n' == buf[start])
                                           mdoc_newln(st);
   
                                   /*
                                    * Consume all whitespace
                                    * so we don't accidentally start
                                    * an implicit literal line.
                                    */
   
                                 while (start < end && ' ' == buf[start])                                  while (start < end && ' ' == buf[start])
                                         start++;                                          start++;
   
                                   /*
                                    * Some text is following.
                                    * Implement requested spacing.
                                    */
   
                                   if ( ! st->wantws && start < end &&
                                       '<' != buf[start + 1]) {
                                           printf(" Ns ");
                                           st->wantws = 1;
                                   }
                         }                          }
                 } else if (start < end && '\n' == buf[start]) {                  } else if (start < end && '\n' == buf[start]) {
                         /*                          outbuf_flush(st);
                          * Print the newline only if we haven't already                          mdoc_newln(st);
                          * printed a newline.  
                          */  
                         if (last != '\n')  
                                 putchar(last = buf[start]);  
                         if (++start >= end)                          if (++start >= end)
                                 continue;                                  continue;
                         /*                          /*
Line 874  ordinary(struct state *st, const char *buf, size_t sta
Line 1287  ordinary(struct state *st, const char *buf, size_t sta
                          * have a macro subsequent it, which may be                           * have a macro subsequent it, which may be
                          * possible if we have an escape next.                           * possible if we have an escape next.
                          */                           */
                         if (' ' == buf[start] || '\t' == buf[start]) {                          if (' ' == buf[start] || '\t' == buf[start])
                                 puts(".br");                                  puts(".br");
                                 last = '\n';  
                         }  
                         for ( ; start < end; start++)                          for ( ; start < end; start++)
                                 if (' ' != buf[start] && '\t' != buf[start])                                  if (' ' != buf[start] && '\t' != buf[start])
                                         break;                                          break;
                 }                  }
         }          }
           outbuf_flush(st);
         if (last != '\n')          mdoc_newln(st);
                 putchar('\n');  
 }  }
   
 /*  /*
Line 897  static void
Line 1307  static void
 dopar(struct state *st, const char *buf, size_t start, size_t end)  dopar(struct state *st, const char *buf, size_t start, size_t end)
 {  {
   
           assert(OUST_NL == st->oust);
           assert(st->wantws);
   
         if (end == start)          if (end == start)
                 return;                  return;
         if (' ' == buf[start] || '\t' == buf[start])          if (' ' == buf[start] || '\t' == buf[start])
Line 915  static void
Line 1328  static void
 dofile(const struct args *args, const char *fname,  dofile(const struct args *args, const char *fname,
         const struct tm *tm, const char *buf, size_t sz)          const struct tm *tm, const char *buf, size_t sz)
 {  {
         size_t           sup, end, i, cur = 0;  
         struct state     st;  
         const char      *section, *date;  
         char             datebuf[64];          char             datebuf[64];
           struct state     st;
           const char      *fbase, *fext, *section, *date;
         char            *title, *cp;          char            *title, *cp;
           size_t           sup, end, i, cur = 0;
   
         if (0 == sz)          if (0 == sz)
                 return;                  return;
   
         /* Title is last path component of the filename. */          /*
            * Parsing the filename is almost always required,
            * except when both the title and the section
            * are provided on the command line.
            */
   
         if (NULL != args->title)          if (NULL == args->title || NULL == args->section) {
                 title = strdup(args->title);                  fbase = strrchr(fname, '/');
         else if (NULL != (cp = strrchr(fname, '/')))                  if (NULL == fbase)
                 title = strdup(cp + 1);                          fbase = fname;
         else                  else
                 title = strdup(fname);                          fbase++;
                   fext = strrchr(fbase, '.');
           } else
                   fext = NULL;
   
           /*
            * The title will be converted to uppercase,
            * so it needs to be copied.
            */
   
           title = (NULL != args->title) ? strdup(args->title) :
                   (NULL != fext) ? strndup(fbase, fext - fbase) :
                   strdup(fbase);
   
         if (NULL == title) {          if (NULL == title) {
                 perror(NULL);                  perror(NULL);
                 exit(EXIT_FAILURE);                  exit(EXIT_FAILURE);
Line 940  dofile(const struct args *args, const char *fname, 
Line 1369  dofile(const struct args *args, const char *fname, 
   
         /* Section is 1 unless suffix is "pm". */          /* Section is 1 unless suffix is "pm". */
   
         if (NULL == (section = args->section)) {          section = (NULL != args->section) ? args->section :
                 section = "1";              (NULL == fext || strcmp(fext + 1, "pm")) ? "1" :
                 if (NULL != (cp = strrchr(title, '.'))) {              PERL_SECTION;
                         *cp++ = '\0';  
                         if (0 == strcmp(cp, "pm"))  
                                 section = PERL_SECTION;  
                 }  
         }  
   
         /* Date.  Or the given "tm" if not supplied. */          /* Date.  Or the given "tm" if not supplied. */
   
Line 968  dofile(const struct args *args, const char *fname, 
Line 1392  dofile(const struct args *args, const char *fname, 
         free(title);          free(title);
   
         memset(&st, 0, sizeof(struct state));          memset(&st, 0, sizeof(struct state));
           st.oust = OUST_NL;
           st.wantws = 1;
   
         assert(sz > 0);          assert(sz > 0);
   
         /* Main loop over file contents. */          /* Main loop over file contents. */
Line 1010  readfile(const struct args *args, const char *fname)
Line 1437  readfile(const struct args *args, const char *fname)
         time_t           ttm;          time_t           ttm;
         struct stat      st;          struct stat      st;
   
         assert(NULL != fname);  
   
         fd = 0 != strcmp("-", fname) ?          fd = 0 != strcmp("-", fname) ?
                 open(fname, O_RDONLY, 0) : STDIN_FILENO;                  open(fname, O_RDONLY, 0) : STDIN_FILENO;
   
Line 1117  main(int argc, char *argv[])
Line 1542  main(int argc, char *argv[])
   
         /* Accept only a single input file. */          /* Accept only a single input file. */
   
         if (argc > 2)          if (argc > 1)
                 return(EXIT_FAILURE);                  goto usage;
         else if (1 == argc)          else if (1 == argc)
                 fname = *argv;                  fname = *argv;
   
Line 1127  main(int argc, char *argv[])
Line 1552  main(int argc, char *argv[])
   
 usage:  usage:
         fprintf(stderr, "usage: %s [-d date] "          fprintf(stderr, "usage: %s [-d date] "
                 "[-n title] [-s section]\n", name);              "[-n title] [-s section] [file]\n", name);
   
         return(EXIT_FAILURE);          return(EXIT_FAILURE);
 }  }
Legend:
Removed from v.1.12  
changed lines
  Added in v.1.32
CVSweb