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

Diff for /mandoc/mdoc.c between version 1.125 and 1.143

version 1.125, 2010/05/08 07:30:19 version 1.143, 2010/05/31 15:50:48
Line 28 
Line 28 
 #include <string.h>  #include <string.h>
 #include <time.h>  #include <time.h>
   
   #include "mandoc.h"
 #include "libmdoc.h"  #include "libmdoc.h"
 #include "libmandoc.h"  #include "libmandoc.h"
   
 const   char *const __mdoc_merrnames[MERRMAX] = {  
         "trailing whitespace", /* ETAILWS */  
         "unexpected quoted parameter", /* EQUOTPARM */  
         "unterminated quoted parameter", /* EQUOTTERM */  
         "argument parameter suggested", /* EARGVAL */  
         "macro disallowed in prologue", /* EBODYPROL */  
         "macro disallowed in body", /* EPROLBODY */  
         "text disallowed in prologue", /* ETEXTPROL */  
         "blank line disallowed", /* ENOBLANK */  
         "text parameter too long", /* ETOOLONG */  
         "invalid escape sequence", /* EESCAPE */  
         "invalid character", /* EPRINT */  
         "document has no body", /* ENODAT */  
         "document has no prologue", /* ENOPROLOGUE */  
         "expected line arguments", /* ELINE */  
         "invalid AT&T argument", /* EATT */  
         "default name not yet set", /* ENAME */  
         "missing list type", /* ELISTTYPE */  
         "missing display type", /* EDISPTYPE */  
         "too many display types", /* EMULTIDISP */  
         "too many list types", /* EMULTILIST */  
         "NAME section must be first", /* ESECNAME */  
         "badly-formed NAME section", /* ENAMESECINC */  
         "argument repeated", /* EARGREP */  
         "expected boolean parameter", /* EBOOL */  
         "inconsistent column syntax", /* ECOLMIS */  
         "nested display invalid", /* ENESTDISP */  
         "width argument missing", /* EMISSWIDTH */  
         "invalid section for this manual section", /* EWRONGMSEC */  
         "section out of conventional order", /* ESECOOO */  
         "section repeated", /* ESECREP */  
         "invalid standard argument", /* EBADSTAND */  
         "multi-line arguments discouraged", /* ENOMULTILINE */  
         "multi-line arguments suggested", /* EMULTILINE */  
         "line arguments discouraged", /* ENOLINE */  
         "prologue macro out of conventional order", /* EPROLOOO */  
         "prologue macro repeated", /* EPROLREP */  
         "invalid manual section", /* EBADMSEC */  
         "invalid section", /* EBADSEC */  
         "invalid font mode", /* EFONT */  
         "invalid date syntax", /* EBADDATE */  
         "invalid number format", /* ENUMFMT */  
         "superfluous width argument", /* ENOWIDTH */  
         "system: utsname error", /* EUTSNAME */  
         "obsolete macro", /* EOBS */  
         "end-of-line scope violation", /* EIMPBRK */  
         "empty macro ignored", /* EIGNE */  
         "unclosed explicit scope", /* EOPEN */  
         "unterminated quoted phrase", /* EQUOTPHR */  
         "closure macro without prior context", /* ENOCTX */  
         "no description found for library", /* ELIB */  
         "bad child for parent context", /* EBADCHILD */  
         "list arguments preceding type", /* ENOTYPE */  
         "deprecated comment style", /* EBADCOMMENT */  
 };  
   
 const   char *const __mdoc_macronames[MDOC_MAX] = {  const   char *const __mdoc_macronames[MDOC_MAX] = {
         "Ap",           "Dd",           "Dt",           "Os",          "Ap",           "Dd",           "Dt",           "Os",
         "Sh",           "Ss",           "Pp",           "D1",          "Sh",           "Ss",           "Pp",           "D1",
Line 124  const char *const __mdoc_macronames[MDOC_MAX] = {   
Line 69  const char *const __mdoc_macronames[MDOC_MAX] = {   
         /* LINTED */          /* LINTED */
         "Dx",           "%Q",           "br",           "sp",          "Dx",           "%Q",           "br",           "sp",
         /* LINTED */          /* LINTED */
         "%U"          "%U",           "Ta"
         };          };
   
 const   char *const __mdoc_argnames[MDOC_ARG_MAX] = {  const   char *const __mdoc_argnames[MDOC_ARG_MAX] = {
Line 151  static struct mdoc_node *node_alloc(struct mdoc *, int
Line 96  static struct mdoc_node *node_alloc(struct mdoc *, int
                                 enum mdoct, enum mdoc_type);                                  enum mdoct, enum mdoc_type);
 static  int               node_append(struct mdoc *,  static  int               node_append(struct mdoc *,
                                 struct mdoc_node *);                                  struct mdoc_node *);
 static  int               mdoc_ptext(struct mdoc *, int, char *);  static  int               mdoc_ptext(struct mdoc *, int, char *, int);
 static  int               mdoc_pmacro(struct mdoc *, int, char *);  static  int               mdoc_pmacro(struct mdoc *, int, char *, int);
 static  int               macrowarn(struct mdoc *, int, const char *);  static  int               macrowarn(struct mdoc *, int,
                                   const char *, int);
   
   
 const struct mdoc_node *  const struct mdoc_node *
Line 191  mdoc_free1(struct mdoc *mdoc)
Line 137  mdoc_free1(struct mdoc *mdoc)
                 free(mdoc->meta.arch);                  free(mdoc->meta.arch);
         if (mdoc->meta.vol)          if (mdoc->meta.vol)
                 free(mdoc->meta.vol);                  free(mdoc->meta.vol);
           if (mdoc->meta.msec)
                   free(mdoc->meta.msec);
 }  }
   
   
Line 243  mdoc_free(struct mdoc *mdoc)
Line 191  mdoc_free(struct mdoc *mdoc)
  * Allocate volatile and non-volatile parse resources.   * Allocate volatile and non-volatile parse resources.
  */   */
 struct mdoc *  struct mdoc *
 mdoc_alloc(void *data, int pflags, const struct mdoc_cb *cb)  mdoc_alloc(void *data, int pflags, mandocmsg msg)
 {  {
         struct mdoc     *p;          struct mdoc     *p;
   
         p = mandoc_calloc(1, sizeof(struct mdoc));          p = mandoc_calloc(1, sizeof(struct mdoc));
   
         if (cb)          p->msg = msg;
                 memcpy(&p->cb, cb, sizeof(struct mdoc_cb));  
   
         p->data = data;          p->data = data;
         p->pflags = pflags;          p->pflags = pflags;
   
Line 283  mdoc_endparse(struct mdoc *m)
Line 229  mdoc_endparse(struct mdoc *m)
  * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()).   * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()).
  */   */
 int  int
 mdoc_parseln(struct mdoc *m, int ln, char *buf)  mdoc_parseln(struct mdoc *m, int ln, char *buf, int offs)
 {  {
   
         if (MDOC_HALT & m->flags)          if (MDOC_HALT & m->flags)
                 return(0);                  return(0);
   
         return('.' == *buf ? mdoc_pmacro(m, ln, buf) :          m->flags |= MDOC_NEWLINE;
                         mdoc_ptext(m, ln, buf));          return(('.' == buf[offs] || '\'' == buf[offs]) ?
                           mdoc_pmacro(m, ln, buf, offs) :
                           mdoc_ptext(m, ln, buf, offs));
 }  }
   
   
 int  int
 mdoc_verr(struct mdoc *mdoc, int ln, int pos,  mdoc_vmsg(struct mdoc *mdoc, enum mandocerr t,
                 const char *fmt, ...)                  int ln, int pos, const char *fmt, ...)
 {  {
         char             buf[256];          char             buf[256];
         va_list          ap;          va_list          ap;
   
         if (NULL == mdoc->cb.mdoc_err)  
                 return(0);  
   
         va_start(ap, fmt);          va_start(ap, fmt);
         (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);          vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
         va_end(ap);          va_end(ap);
   
         return((*mdoc->cb.mdoc_err)(mdoc->data, ln, pos, buf));          return((*mdoc->msg)(t, mdoc->data, ln, pos, buf));
 }  }
   
   
 int  int
 mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, const char *fmt, ...)  
 {  
         char             buf[256];  
         va_list          ap;  
   
         if (NULL == mdoc->cb.mdoc_warn)  
                 return(0);  
   
         va_start(ap, fmt);  
         (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);  
         va_end(ap);  
   
         return((*mdoc->cb.mdoc_warn)(mdoc->data, ln, pos, buf));  
 }  
   
   
 int  
 mdoc_err(struct mdoc *m, int line, int pos, int iserr, enum merr type)  
 {  
         const char      *p;  
   
         p = __mdoc_merrnames[(int)type];  
         assert(p);  
   
         if (iserr)  
                 return(mdoc_verr(m, line, pos, p));  
   
         return(mdoc_vwarn(m, line, pos, p));  
 }  
   
   
 int  
 mdoc_macro(struct mdoc *m, enum mdoct tok,  mdoc_macro(struct mdoc *m, enum mdoct tok,
                 int ln, int pp, int *pos, char *buf)                  int ln, int pp, int *pos, char *buf)
 {  {
Line 354  mdoc_macro(struct mdoc *m, enum mdoct tok, 
Line 267  mdoc_macro(struct mdoc *m, enum mdoct tok, 
   
         if (MDOC_PROLOGUE & mdoc_macros[tok].flags &&          if (MDOC_PROLOGUE & mdoc_macros[tok].flags &&
                         MDOC_PBODY & m->flags)                          MDOC_PBODY & m->flags)
                 return(mdoc_perr(m, ln, pp, EPROLBODY));                  return(mdoc_pmsg(m, ln, pp, MANDOCERR_BADBODY));
   
         /* If we're in the prologue, deny "body" macros.  */          /* If we're in the prologue, deny "body" macros.  */
   
         if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) &&          if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) &&
                         ! (MDOC_PBODY & m->flags)) {                          ! (MDOC_PBODY & m->flags)) {
                 if ( ! mdoc_pwarn(m, ln, pp, EBODYPROL))                  if ( ! mdoc_pmsg(m, ln, pp, MANDOCERR_BADPROLOG))
                         return(0);                          return(0);
                 if (NULL == m->meta.title)                  if (NULL == m->meta.title)
                         m->meta.title = mandoc_strdup("unknown");                          m->meta.title = mandoc_strdup("UNKNOWN");
                 if (NULL == m->meta.vol)                  if (NULL == m->meta.vol)
                         m->meta.vol = mandoc_strdup("local");                          m->meta.vol = mandoc_strdup("LOCAL");
                 if (NULL == m->meta.os)                  if (NULL == m->meta.os)
                         m->meta.os = mandoc_strdup("local");                          m->meta.os = mandoc_strdup("LOCAL");
                 if (0 == m->meta.date)                  if (0 == m->meta.date)
                         m->meta.date = time(NULL);                          m->meta.date = time(NULL);
                 m->flags |= MDOC_PBODY;                  m->flags |= MDOC_PBODY;
Line 453  node_alloc(struct mdoc *m, int line, int pos, 
Line 366  node_alloc(struct mdoc *m, int line, int pos, 
         p->pos = pos;          p->pos = pos;
         p->tok = tok;          p->tok = tok;
         p->type = type;          p->type = type;
           if (MDOC_NEWLINE & m->flags)
                   p->flags |= MDOC_LINE;
           m->flags &= ~MDOC_NEWLINE;
         return(p);          return(p);
 }  }
   
Line 625  mdoc_node_delete(struct mdoc *m, struct mdoc_node *p)
Line 540  mdoc_node_delete(struct mdoc *m, struct mdoc_node *p)
  * control character.   * control character.
  */   */
 static int  static int
 mdoc_ptext(struct mdoc *m, int line, char *buf)  mdoc_ptext(struct mdoc *m, int line, char *buf, int offs)
 {  {
         int              i;          char             *c, *ws, *end;
           struct mdoc_node *n;
   
         /* Ignore bogus comments. */          /* Ignore bogus comments. */
   
         if ('\\' == buf[0] && '.' == buf[1] && '\"' == buf[2])          if ('\\' == buf[offs] &&
                 return(mdoc_pwarn(m, line, 0, EBADCOMMENT));                          '.' == buf[offs + 1] &&
                           '"' == buf[offs + 2])
                   return(mdoc_pmsg(m, line, offs, MANDOCERR_BADCOMMENT));
   
         /* No text before an initial macro. */          /* No text before an initial macro. */
   
         if (SEC_NONE == m->lastnamed)          if (SEC_NONE == m->lastnamed)
                 return(mdoc_perr(m, line, 0, ETEXTPROL));                  return(mdoc_pmsg(m, line, offs, MANDOCERR_NOTEXT));
   
         /* Literal just gets pulled in as-is. */          assert(m->last);
           n = m->last;
         if (MDOC_LITERAL & m->flags)  
                 return(mdoc_word_alloc(m, line, 0, buf));  
   
         /* Check for a blank line, which may also consist of spaces. */          /*
            * Diver directly into list processing if we're encountering a
            * columnar MDOC_BLOCK with or without a prior MDOC_BLOCK entry
            * (if it's a MDOC_BODY that means it's open, in which case we
            * should process within its context).
            */
   
         for (i = 0; ' ' == buf[i]; i++)          if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
                 /* Skip to first non-space. */ ;                          LIST_column == n->data.list) {
                   m->flags |= MDOC_FREECOL;
                   return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf));
           }
   
         if ('\0' == buf[i]) {          if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
                 if ( ! mdoc_pwarn(m, line, 0, ENOBLANK))                          NULL != n->parent &&
                           MDOC_Bl == n->parent->tok &&
                           LIST_column == n->parent->data.list) {
                   m->flags |= MDOC_FREECOL;
                   return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf));
           }
   
           /*
            * Search for the beginning of unescaped trailing whitespace (ws)
            * and for the first character not to be output (end).
            */
   
           /* FIXME: replace with strcspn(). */
           ws = NULL;
           for (c = end = buf + offs; *c; c++) {
                   switch (*c) {
                   case '-':
                           if (mandoc_hyph(buf + offs, c))
                                   *c = ASCII_HYPH;
                           break;
                   case ' ':
                           if (NULL == ws)
                                   ws = c;
                           continue;
                   case '\t':
                           /*
                            * Always warn about trailing tabs,
                            * even outside literal context,
                            * where they should be put on the next line.
                            */
                           if (NULL == ws)
                                   ws = c;
                           /*
                            * Strip trailing tabs in literal context only;
                            * outside, they affect the next line.
                            */
                           if (MDOC_LITERAL & m->flags)
                                   continue;
                           break;
                   case '\\':
                           /* Skip the escaped character, too, if any. */
                           if (c[1])
                                   c++;
                           /* FALLTHROUGH */
                   default:
                           ws = NULL;
                           break;
                   }
                   end = c + 1;
           }
           *end = '\0';
   
           if (ws)
                   if ( ! mdoc_pmsg(m, line, (int)(ws-buf), MANDOCERR_EOLNSPACE))
                         return(0);                          return(0);
   
           if ('\0' == buf[offs] && ! (MDOC_LITERAL & m->flags)) {
                   if ( ! mdoc_pmsg(m, line, (int)(c-buf), MANDOCERR_NOBLANKLN))
                           return(0);
   
                 /*                  /*
                  * Insert a `Pp' in the case of a blank line.  Technically,                   * Insert a `Pp' in the case of a blank line.  Technically,
                  * blank lines aren't allowed, but enough manuals assume this                   * blank lines aren't allowed, but enough manuals assume this
                  * behaviour that we want to work around it.                   * behaviour that we want to work around it.
                  */                   */
                 if ( ! mdoc_elem_alloc(m, line, 0, MDOC_Pp, NULL))                  if ( ! mdoc_elem_alloc(m, line, offs, MDOC_Pp, NULL))
                         return(0);                          return(0);
   
                 m->next = MDOC_NEXT_SIBLING;                  m->next = MDOC_NEXT_SIBLING;
                 return(1);                  return(1);
         }          }
   
         /* Warn if the last un-escaped character is whitespace. */          if ( ! mdoc_word_alloc(m, line, offs, buf+offs))
                   return(0);
   
         i = (int)strlen(buf);          if (MDOC_LITERAL & m->flags)
         assert(i);                  return(1);
   
         if (' ' == buf[i - 1] || '\t' == buf[i - 1])          /*
                 if (1 == i || ('\\' != buf[i - 2]))           * End-of-sentence check.  If the last character is an unescaped
                         if ( ! mdoc_pwarn(m, line, i - 1, ETAILWS))           * EOS character, then flag the node as being the end of a
                                 return(0);           * sentence.  The front-end will know how to interpret this.
            */
   
         /* Allocate the whole word. */          assert(buf < end);
   
         return(mdoc_word_alloc(m, line, 0, buf));          if (mandoc_eos(buf+offs, (size_t)(end-buf-offs)))
                   m->last->flags |= MDOC_EOS;
   
           return(1);
 }  }
   
   
 static int  static int
 macrowarn(struct mdoc *m, int ln, const char *buf)  macrowarn(struct mdoc *m, int ln, const char *buf, int offs)
 {  {
         if ( ! (MDOC_IGN_MACRO & m->pflags))          int              rc;
                 return(mdoc_verr(m, ln, 0, "unknown macro: %s%s",  
                                 buf, strlen(buf) > 3 ? "..." : ""));          rc = mdoc_vmsg(m, MANDOCERR_MACRO, ln, offs,
         return(mdoc_vwarn(m, ln, 0, "unknown macro: %s%s",                          "unknown macro: %s%s",
                                 buf, strlen(buf) > 3 ? "..." : ""));                          buf, strlen(buf) > 3 ? "..." : "");
   
           /* FIXME: logic should be in driver. */
           return(MDOC_IGN_MACRO & m->pflags ? rc : 0);
 }  }
   
   
Line 697  macrowarn(struct mdoc *m, int ln, const char *buf)
Line 686  macrowarn(struct mdoc *m, int ln, const char *buf)
  * character.   * character.
  */   */
 int  int
 mdoc_pmacro(struct mdoc *m, int ln, char *buf)  mdoc_pmacro(struct mdoc *m, int ln, char *buf, int offs)
 {  {
         enum mdoct      tok;          enum mdoct      tok;
         int             i, j;          int             i, j, sv;
         char            mac[5];          char            mac[5];
   
         /* Empty lines are ignored. */          /* Empty lines are ignored. */
   
         if ('\0' == buf[1])          offs++;
   
           if ('\0' == buf[offs])
                 return(1);                  return(1);
   
         i = 1;          i = offs;
   
         /* Accept whitespace after the initial control char. */          /* Accept whitespace after the initial control char. */
   
Line 720  mdoc_pmacro(struct mdoc *m, int ln, char *buf)
Line 711  mdoc_pmacro(struct mdoc *m, int ln, char *buf)
                         return(1);                          return(1);
         }          }
   
           sv = i;
   
         /* Copy the first word into a nil-terminated buffer. */          /* Copy the first word into a nil-terminated buffer. */
   
         for (j = 0; j < 4; j++, i++) {          for (j = 0; j < 4; j++, i++) {
Line 732  mdoc_pmacro(struct mdoc *m, int ln, char *buf)
Line 725  mdoc_pmacro(struct mdoc *m, int ln, char *buf)
   
                 if (isgraph((u_char)buf[i]))                  if (isgraph((u_char)buf[i]))
                         continue;                          continue;
                 return(mdoc_perr(m, ln, i, EPRINT));                  if ( ! mdoc_pmsg(m, ln, i, MANDOCERR_BADCHAR))
                           return(0);
                   i--;
         }          }
   
         mac[j] = 0;          mac[j] = '\0';
   
         if (j == 4 || j < 2) {          if (j == 4 || j < 2) {
                 if ( ! macrowarn(m, ln, mac))                  if ( ! macrowarn(m, ln, mac, sv))
                         goto err;                          goto err;
                 return(1);                  return(1);
         }          }
   
         if (MDOC_MAX == (tok = mdoc_hash_find(mac))) {          if (MDOC_MAX == (tok = mdoc_hash_find(mac))) {
                 if ( ! macrowarn(m, ln, mac))                  if ( ! macrowarn(m, ln, mac, sv))
                         goto err;                          goto err;
                 return(1);                  return(1);
         }          }
Line 760  mdoc_pmacro(struct mdoc *m, int ln, char *buf)
Line 755  mdoc_pmacro(struct mdoc *m, int ln, char *buf)
          */           */
   
         if ('\0' == buf[i] && ' ' == buf[i - 1])          if ('\0' == buf[i] && ' ' == buf[i - 1])
                 if ( ! mdoc_pwarn(m, ln, i - 1, ETAILWS))                  if ( ! mdoc_pmsg(m, ln, i - 1, MANDOCERR_EOLNSPACE))
                         goto err;                          goto err;
   
         /*          /*
          * Begin recursive parse sequence.  Since we're at the start of           * Begin recursive parse sequence.  Since we're at the start of
          * the line, we don't need to do callable/parseable checks.           * the line, we don't need to do callable/parseable checks.
          */           */
         if ( ! mdoc_macro(m, tok, ln, 1, &i, buf))          if ( ! mdoc_macro(m, tok, ln, sv, &i, buf))
                 goto err;                  goto err;
   
         return(1);          return(1);
Legend:
Removed from v.1.125  
changed lines
  Added in v.1.143
CVSweb