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

Diff for /mandoc/mdoc.c between version 1.136 and 1.164

version 1.136, 2010/05/17 22:11:42 version 1.164, 2010/08/29 11:29:51
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>   * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
    * Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
  *   *
  * Permission to use, copy, modify, and distribute this software for any   * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above   * purpose with or without fee is hereby granted, provided that the above
Line 21 
Line 22 
 #include <sys/types.h>  #include <sys/types.h>
   
 #include <assert.h>  #include <assert.h>
 #include <ctype.h>  
 #include <stdarg.h>  #include <stdarg.h>
 #include <stdio.h>  #include <stdio.h>
 #include <stdlib.h>  #include <stdlib.h>
Line 69  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 98  static int    node_append(struct mdoc *, 
Line 98  static int    node_append(struct mdoc *, 
                                 struct mdoc_node *);                                  struct mdoc_node *);
 static  int               mdoc_ptext(struct mdoc *, int, char *, int);  static  int               mdoc_ptext(struct mdoc *, int, char *, int);
 static  int               mdoc_pmacro(struct mdoc *, int, char *, int);  static  int               mdoc_pmacro(struct mdoc *, int, char *, int);
 static  int               macrowarn(struct mdoc *, int,  
                                 const char *, int);  
   
   
 const struct mdoc_node *  const struct mdoc_node *
Line 191  mdoc_free(struct mdoc *mdoc)
Line 189  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, mandocmsg msg)  mdoc_alloc(struct regset *regs, void *data, mandocmsg msg)
 {  {
         struct mdoc     *p;          struct mdoc     *p;
   
Line 199  mdoc_alloc(void *data, int pflags, mandocmsg msg)
Line 197  mdoc_alloc(void *data, int pflags, mandocmsg msg)
   
         p->msg = msg;          p->msg = msg;
         p->data = data;          p->data = data;
         p->pflags = pflags;          p->regs = regs;
   
         mdoc_hash_init();          mdoc_hash_init();
         mdoc_alloc1(p);          mdoc_alloc1(p);
Line 236  mdoc_parseln(struct mdoc *m, int ln, char *buf, int of
Line 234  mdoc_parseln(struct mdoc *m, int ln, char *buf, int of
                 return(0);                  return(0);
   
         m->flags |= MDOC_NEWLINE;          m->flags |= MDOC_NEWLINE;
   
           /*
            * Let the roff nS register switch SYNOPSIS mode early,
            * such that the parser knows at all times
            * whether this mode is on or off.
            * Note that this mode is also switched by the Sh macro.
            */
           if (m->regs->regs[(int)REG_nS].set) {
                   if (m->regs->regs[(int)REG_nS].v.u)
                           m->flags |= MDOC_SYNOPSIS;
                   else
                           m->flags &= ~MDOC_SYNOPSIS;
           }
   
         return(('.' == buf[offs] || '\'' == buf[offs]) ?          return(('.' == buf[offs] || '\'' == buf[offs]) ?
                         mdoc_pmacro(m, ln, buf, offs) :                          mdoc_pmacro(m, ln, buf, offs) :
                         mdoc_ptext(m, ln, buf, offs));                          mdoc_ptext(m, ln, buf, offs));
Line 258  mdoc_vmsg(struct mdoc *mdoc, enum mandocerr t, 
Line 270  mdoc_vmsg(struct mdoc *mdoc, enum mandocerr t, 
   
   
 int  int
 mdoc_macro(struct mdoc *m, enum mdoct tok,  mdoc_macro(MACRO_PROT_ARGS)
                 int ln, int pp, int *pos, char *buf)  
 {  {
         assert(tok < MDOC_MAX);          assert(tok < MDOC_MAX);
   
Line 267  mdoc_macro(struct mdoc *m, enum mdoct tok, 
Line 278  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_pmsg(m, ln, pp, MANDOCERR_BADBODY));                  return(mdoc_pmsg(m, line, ppos, 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_pmsg(m, ln, pp, MANDOCERR_BADPROLOG))                  if ( ! mdoc_pmsg(m, line, ppos, 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;
         }          }
   
         return((*mdoc_macros[tok].fp)(m, tok, ln, pp, pos, buf));          return((*mdoc_macros[tok].fp)(m, tok, line, ppos, pos, buf));
 }  }
   
   
Line 330  node_append(struct mdoc *mdoc, struct mdoc_node *p)
Line 341  node_append(struct mdoc *mdoc, struct mdoc_node *p)
                 p->parent->tail = p;                  p->parent->tail = p;
                 break;                  break;
         case (MDOC_BODY):          case (MDOC_BODY):
                   if (p->end)
                           break;
                 assert(MDOC_BLOCK == p->parent->type);                  assert(MDOC_BLOCK == p->parent->type);
                 p->parent->body = p;                  p->parent->body = p;
                 break;                  break;
Line 366  node_alloc(struct mdoc *m, int line, int pos, 
Line 379  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;
   
           /* Flag analysis. */
   
           if (MDOC_SYNOPSIS & m->flags)
                   p->flags |= MDOC_SYNPRETTY;
           else
                   p->flags &= ~MDOC_SYNPRETTY;
         if (MDOC_NEWLINE & m->flags)          if (MDOC_NEWLINE & m->flags)
                 p->flags |= MDOC_LINE;                  p->flags |= MDOC_LINE;
         m->flags &= ~MDOC_NEWLINE;          m->flags &= ~MDOC_NEWLINE;
   
         return(p);          return(p);
 }  }
   
Line 416  mdoc_body_alloc(struct mdoc *m, int line, int pos, enu
Line 437  mdoc_body_alloc(struct mdoc *m, int line, int pos, enu
   
   
 int  int
   mdoc_endbody_alloc(struct mdoc *m, int line, int pos, enum mdoct tok,
                   struct mdoc_node *body, enum mdoc_endbody end)
   {
           struct mdoc_node *p;
   
           p = node_alloc(m, line, pos, tok, MDOC_BODY);
           p->pending = body;
           p->end = end;
           if ( ! node_append(m, p))
                   return(0);
           m->next = MDOC_NEXT_SIBLING;
           return(1);
   }
   
   
   int
 mdoc_block_alloc(struct mdoc *m, int line, int pos,  mdoc_block_alloc(struct mdoc *m, int line, int pos,
                 enum mdoct tok, struct mdoc_arg *args)                  enum mdoct tok, struct mdoc_arg *args)
 {  {
Line 472  mdoc_word_alloc(struct mdoc *m, int line, int pos, con
Line 509  mdoc_word_alloc(struct mdoc *m, int line, int pos, con
 }  }
   
   
 void  static void
 mdoc_node_free(struct mdoc_node *p)  mdoc_node_free(struct mdoc_node *p)
 {  {
   
           /*
            * XXX: if these end up being problematic in terms of memory
            * management and dereferencing freed blocks, then make them
            * into reference-counted double-pointers.
            */
   
           if (MDOC_Bd == p->tok && MDOC_BLOCK == p->type)
                   if (p->data.Bd)
                           free(p->data.Bd);
           if (MDOC_Bl == p->tok && MDOC_BLOCK == p->type)
                   if (p->data.Bl)
                           free(p->data.Bl);
           if (MDOC_Bf == p->tok && MDOC_HEAD == p->type)
                   if (p->data.Bf)
                           free(p->data.Bf);
   
         if (p->string)          if (p->string)
                 free(p->string);                  free(p->string);
         if (p->args)          if (p->args)
Line 542  mdoc_node_delete(struct mdoc *m, struct mdoc_node *p)
Line 595  mdoc_node_delete(struct mdoc *m, struct mdoc_node *p)
 static int  static int
 mdoc_ptext(struct mdoc *m, int line, char *buf, int offs)  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. */
   
Line 556  mdoc_ptext(struct mdoc *m, int line, char *buf, int of
Line 610  mdoc_ptext(struct mdoc *m, int line, char *buf, int of
         if (SEC_NONE == m->lastnamed)          if (SEC_NONE == m->lastnamed)
                 return(mdoc_pmsg(m, line, offs, MANDOCERR_NOTEXT));                  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, offs, buf + offs));  
   
         /* Check for a blank line, which may also consist of spaces. */          /*
            * Divert directly to list processing if we're encountering a
            * columnar MDOC_BLOCK with or without a prior MDOC_BLOCK entry
            * (a MDOC_BODY means it's already open, in which case we should
            * process within its context in the normal way).
            */
   
         for (i = offs; ' ' == buf[i]; i++)          if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
                 /* Skip to first non-space. */ ;                          LIST_column == n->data.Bl->type) {
                   /* `Bl' is open without any children. */
                   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_pmsg(m, line, offs, MANDOCERR_NOBLANKLN))                          NULL != n->parent &&
                           MDOC_Bl == n->parent->tok &&
                           LIST_column == n->parent->data.Bl->type) {
                   /* `Bl' has block-level `It' children. */
                   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;
                           ws = NULL;
                           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
Line 582  mdoc_ptext(struct mdoc *m, int line, char *buf, int of
Line 702  mdoc_ptext(struct mdoc *m, int line, char *buf, int of
                 return(1);                  return(1);
         }          }
   
         /*          if ( ! mdoc_word_alloc(m, line, offs, buf+offs))
          * Warn if the last un-escaped character is whitespace. Then  
          * strip away the remaining spaces (tabs stay!).  
          */  
   
         i = (int)strlen(buf);  
         assert(i);  
   
         if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {  
                 if (i > 1 && '\\' != buf[i - 2])  
                         if ( ! mdoc_pmsg(m, line, i - 1, MANDOCERR_EOLNSPACE))  
                                 return(0);  
   
                 for (--i; i && ' ' == buf[i]; i--)  
                         /* Spin back to non-space. */ ;  
   
                 /* Jump ahead of escaped whitespace. */  
                 i += '\\' == buf[i] ? 2 : 1;  
   
                 buf[i] = '\0';  
         }  
   
         /* Allocate the whole word. */  
   
         if ( ! mdoc_word_alloc(m, line, offs, buf + offs))  
                 return(0);                  return(0);
   
           if (MDOC_LITERAL & m->flags)
                   return(1);
   
         /*          /*
          * End-of-sentence check.  If the last character is an unescaped           * End-of-sentence check.  If the last character is an unescaped
          * EOS character, then flag the node as being the end of a           * EOS character, then flag the node as being the end of a
          * sentence.  The front-end will know how to interpret this.           * sentence.  The front-end will know how to interpret this.
          */           */
   
         assert(i);          assert(buf < end);
         if (mandoc_eos(buf, (size_t)i))  
           if (mandoc_eos(buf+offs, (size_t)(end-buf-offs), 0))
                 m->last->flags |= MDOC_EOS;                  m->last->flags |= MDOC_EOS;
   
         return(1);          return(1);
 }  }
   
   
 static int  
 macrowarn(struct mdoc *m, int ln, const char *buf, int offs)  
 {  
         int              rc;  
   
         rc = mdoc_vmsg(m, MANDOCERR_MACRO, ln, offs,  
                         "unknown macro: %s%s",  
                         buf, strlen(buf) > 3 ? "..." : "");  
   
         /* FIXME: logic should be in driver. */  
         return(MDOC_IGN_MACRO & m->pflags ? rc : 0);  
 }  
   
   
 /*  /*
  * Parse a macro line, that is, a line beginning with the control   * Parse a macro line, that is, a line beginning with the control
  * character.   * character.
  */   */
 int  static int
 mdoc_pmacro(struct mdoc *m, int ln, char *buf, int offs)  mdoc_pmacro(struct mdoc *m, int ln, char *buf, int offs)
 {  {
         enum mdoct      tok;          enum mdoct        tok;
         int             i, j, sv;          int               i, j, sv;
         char            mac[5];          char              mac[5];
           struct mdoc_node *n;
   
         /* Empty lines are ignored. */          /* Empty lines are ignored. */
   
Line 657  mdoc_pmacro(struct mdoc *m, int ln, char *buf, int off
Line 744  mdoc_pmacro(struct mdoc *m, int ln, char *buf, int off
   
         i = offs;          i = offs;
   
         /* Accept whitespace after the initial control char. */          /* Accept tabs/whitespace after the initial control char. */
   
         if (' ' == buf[i]) {          if (' ' == buf[i] || '\t' == buf[i]) {
                 i++;                  i++;
                 while (buf[i] && ' ' == buf[i])                  while (buf[i] && (' ' == buf[i] || '\t' == buf[i]))
                         i++;                          i++;
                 if ('\0' == buf[i])                  if ('\0' == buf[i])
                         return(1);                          return(1);
Line 669  mdoc_pmacro(struct mdoc *m, int ln, char *buf, int off
Line 756  mdoc_pmacro(struct mdoc *m, int ln, char *buf, int off
   
         sv = i;          sv = i;
   
         /* Copy the first word into a nil-terminated buffer. */          /*
            * Copy the first word into a nil-terminated buffer.
            * Stop copying when a tab, space, backslash, or eoln is encountered.
            */
   
         for (j = 0; j < 4; j++, i++) {          j = 0;
                 if ('\0' == (mac[j] = buf[i]))          while (j < 4 && '\0' != buf[i] &&
                         break;                          ' ' != buf[i] &&
                 else if (' ' == buf[i])                          '\t' != buf[i] &&
                         break;                          '\\' != buf[i])
                   mac[j++] = buf[i++];
                 /* Check for invalid characters. */  
   
                 if (isgraph((u_char)buf[i]))  
                         continue;  
                 if ( ! mdoc_pmsg(m, ln, i, MANDOCERR_BADCHAR))  
                         return(0);  
                 i--;  
         }  
   
         mac[j] = '\0';          mac[j] = '\0';
   
         if (j == 4 || j < 2) {          tok = (j > 1 || j < 4) ? mdoc_hash_find(mac) : MDOC_MAX;
                 if ( ! macrowarn(m, ln, mac, sv))          if (MDOC_MAX == tok) {
                         goto err;                  mdoc_vmsg(m, MANDOCERR_MACRO, ln, sv,
                       "unknown macro: %s%s",
                       buf, strlen(buf) > 3 ? "..." : "");
                 return(1);                  return(1);
         }  
   
         if (MDOC_MAX == (tok = mdoc_hash_find(mac))) {  
                 if ( ! macrowarn(m, ln, mac, sv))  
                         goto err;  
                 return(1);  
         }          }
   
         /* The macro is sane.  Jump to the next word. */          /* Disregard the first trailing tab, if applicable. */
   
           if ('\t' == buf[i])
                   i++;
   
           /* Jump to the next non-whitespace word. */
   
         while (buf[i] && ' ' == buf[i])          while (buf[i] && ' ' == buf[i])
                 i++;                  i++;
   
Line 714  mdoc_pmacro(struct mdoc *m, int ln, char *buf, int off
Line 796  mdoc_pmacro(struct mdoc *m, int ln, char *buf, int off
                 if ( ! mdoc_pmsg(m, ln, i - 1, MANDOCERR_EOLNSPACE))                  if ( ! mdoc_pmsg(m, ln, i - 1, MANDOCERR_EOLNSPACE))
                         goto err;                          goto err;
   
         /*          /*
          * Begin recursive parse sequence.  Since we're at the start of           * If an initial macro or a list invocation, divert directly
          * the line, we don't need to do callable/parseable checks.           * into macro processing.
          */           */
   
           if (NULL == m->last || MDOC_It == tok || MDOC_El == tok) {
                   if ( ! mdoc_macro(m, tok, ln, sv, &i, buf))
                           goto err;
                   return(1);
           }
   
           n = m->last;
           assert(m->last);
   
           /*
            * If the first macro of a `Bl -column', open an `It' block
            * context around the parsed macro.
            */
   
           if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
                           LIST_column == n->data.Bl->type) {
                   m->flags |= MDOC_FREECOL;
                   if ( ! mdoc_macro(m, MDOC_It, ln, sv, &sv, buf))
                           goto err;
                   return(1);
           }
   
           /*
            * If we're following a block-level `It' within a `Bl -column'
            * context (perhaps opened in the above block or in ptext()),
            * then open an `It' block context around the parsed macro.
            */
   
           if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
                           NULL != n->parent &&
                           MDOC_Bl == n->parent->tok &&
                           LIST_column == n->parent->data.Bl->type) {
                   m->flags |= MDOC_FREECOL;
                   if ( ! mdoc_macro(m, MDOC_It, ln, sv, &sv, buf))
                           goto err;
                   return(1);
           }
   
           /* Normal processing of a macro. */
   
         if ( ! mdoc_macro(m, tok, ln, sv, &i, buf))          if ( ! mdoc_macro(m, tok, ln, sv, &i, buf))
                 goto err;                  goto err;
   
Legend:
Removed from v.1.136  
changed lines
  Added in v.1.164
CVSweb