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

Diff for /mandoc/mdoc.c between version 1.50 and 1.229

version 1.50, 2009/03/02 17:14:46 version 1.229, 2014/11/19 03:08:17
Line 1 
Line 1 
 /* $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>   * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
    * Copyright (c) 2010, 2012, 2013, 2014 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   * purpose with or without fee is hereby granted, provided that the above
  * above copyright notice and this permission notice appear in all   * copyright notice and this permission notice appear in all copies.
  * copies.  
  *   *
  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL   * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED   * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE   * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL   * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR   * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR   * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  * PERFORMANCE OF THIS SOFTWARE.  
  */   */
   #include "config.h"
   
   #include <sys/types.h>
   
 #include <assert.h>  #include <assert.h>
 #include <ctype.h>  #include <ctype.h>
 #include <err.h>  
 #include <stdarg.h>  #include <stdarg.h>
 #include <stdlib.h>  
 #include <stdio.h>  #include <stdio.h>
   #include <stdlib.h>
 #include <string.h>  #include <string.h>
   #include <time.h>
   
 #include "private.h"  #include "mdoc.h"
   #include "mandoc.h"
   #include "mandoc_aux.h"
   #include "libmdoc.h"
   #include "libmandoc.h"
   
 /*  const   char *const __mdoc_macronames[MDOC_MAX + 1] = {
  * Main caller in the libmdoc library.  This begins the parsing routine,          "Ap",           "Dd",           "Dt",           "Os",
  * handles allocation of data, and so forth.  Most of the "work" is done  
  * in macro.c and validate.c.  
  */  
   
 static  struct mdoc_arg  *argdup(size_t, const struct mdoc_arg *);  
 static  void              argfree(size_t, struct mdoc_arg *);  
 static  void              argcpy(struct mdoc_arg *,  
                                 const struct mdoc_arg *);  
   
 static  struct mdoc_node *mdoc_node_alloc(const struct mdoc *);  
 static  int               mdoc_node_append(struct mdoc *,  
                                 struct mdoc_node *);  
 static  void              mdoc_elem_free(struct mdoc_elem *);  
 static  void              mdoc_text_free(struct mdoc_text *);  
   
   
 const   char *const __mdoc_macronames[MDOC_MAX] = {  
         "\\\"",         "Dd",           "Dt",           "Os",  
         "Sh",           "Ss",           "Pp",           "D1",          "Sh",           "Ss",           "Pp",           "D1",
         "Dl",           "Bd",           "Ed",           "Bl",          "Dl",           "Bd",           "Ed",           "Bl",
         "El",           "It",           "Ad",           "An",          "El",           "It",           "Ad",           "An",
Line 55  const char *const __mdoc_macronames[MDOC_MAX] = {   
Line 44  const char *const __mdoc_macronames[MDOC_MAX] = {   
         "Ic",           "In",           "Li",           "Nd",          "Ic",           "In",           "Li",           "Nd",
         "Nm",           "Op",           "Ot",           "Pa",          "Nm",           "Op",           "Ot",           "Pa",
         "Rv",           "St",           "Va",           "Vt",          "Rv",           "St",           "Va",           "Vt",
         /* LINTED */          "Xr",           "%A",           "%B",           "%D",
         "Xr",           "\%A",          "\%B",          "\%D",          "%I",           "%J",           "%N",           "%O",
         /* LINTED */          "%P",           "%R",           "%T",           "%V",
         "\%I",          "\%J",          "\%N",          "\%O",  
         /* LINTED */  
         "\%P",          "\%R",          "\%T",          "\%V",  
         "Ac",           "Ao",           "Aq",           "At",          "Ac",           "Ao",           "Aq",           "At",
         "Bc",           "Bf",           "Bo",           "Bq",          "Bc",           "Bf",           "Bo",           "Bq",
         "Bsx",          "Bx",           "Db",           "Dc",          "Bsx",          "Bx",           "Db",           "Dc",
Line 74  const char *const __mdoc_macronames[MDOC_MAX] = {   
Line 60  const char *const __mdoc_macronames[MDOC_MAX] = {   
         "Tn",           "Ux",           "Xc",           "Xo",          "Tn",           "Ux",           "Xc",           "Xo",
         "Fo",           "Fc",           "Oo",           "Oc",          "Fo",           "Fc",           "Oo",           "Oc",
         "Bk",           "Ek",           "Bt",           "Hf",          "Bk",           "Ek",           "Bt",           "Hf",
         "Fr",           "Ud",          "Fr",           "Ud",           "Lb",           "Lp",
           "Lk",           "Mt",           "Brq",          "Bro",
           "Brc",          "%C",           "Es",           "En",
           "Dx",           "%Q",           "br",           "sp",
           "%U",           "Ta",           "ll",           "text",
         };          };
   
 const   char *const __mdoc_argnames[MDOC_ARG_MAX] = {  const   char *const __mdoc_argnames[MDOC_ARG_MAX] = {
         "split",                "nosplit",              "ragged",          "split",                "nosplit",              "ragged",
         "unfilled",             "literal",              "file",          "unfilled",             "literal",              "file",
         "offset",               "bullet",               "dash",          "offset",               "bullet",               "dash",
         "hyphen",               "item",                 "enum",          "hyphen",               "item",                 "enum",
         "tag",                  "diag",                 "hang",          "tag",                  "diag",                 "hang",
         "ohang",                "inset",                "column",          "ohang",                "inset",                "column",
         "width",                "compact",              "std",          "width",                "compact",              "std",
         "p1003.1-88",           "p1003.1-90",           "p1003.1-96",          "filled",               "words",                "emphasis",
         "p1003.1-2001",         "p1003.1-2004",         "p1003.1",          "symbolic",             "nested",               "centered"
         "p1003.1b",             "p1003.1b-93",          "p1003.1c-95",  
         "p1003.1g-2000",        "p1003.2-92",           "p1387.2-95",  
         "p1003.2",              "p1387.2",              "isoC-90",  
         "isoC-amd1",            "isoC-tcor1",           "isoC-tcor2",  
         "isoC-99",              "ansiC",                "ansiC-89",  
         "ansiC-99",             "ieee754",              "iso8802-3",  
         "xpg3",                 "xpg4",                 "xpg4.2",  
         "xpg4.3",               "xbd5",                 "xcu5",  
         "xsh5",                 "xns5",                 "xns5.2d2.0",  
         "xcurses4.2",           "susv2",                "susv3",  
         "svid4",                "filled",               "words",  
         "emphasis",             "symbolic",  
         };          };
   
 const   char * const *mdoc_macronames = __mdoc_macronames;  const   char * const *mdoc_macronames = __mdoc_macronames;
 const   char * const *mdoc_argnames = __mdoc_argnames;  const   char * const *mdoc_argnames = __mdoc_argnames;
   
   static  void              mdoc_node_free(struct mdoc_node *);
   static  void              mdoc_node_unlink(struct mdoc *,
                                   struct mdoc_node *);
   static  void              mdoc_free1(struct mdoc *);
   static  void              mdoc_alloc1(struct mdoc *);
   static  struct mdoc_node *node_alloc(struct mdoc *, int, int,
                                   enum mdoct, enum mdoc_type);
   static  int               node_append(struct mdoc *,
                                   struct mdoc_node *);
   static  int               mdoc_ptext(struct mdoc *, int, char *, int);
   static  int               mdoc_pmacro(struct mdoc *, int, char *, int);
   
   
 const struct mdoc_node *  const struct mdoc_node *
 mdoc_node(const struct mdoc *mdoc)  mdoc_node(const struct mdoc *mdoc)
 {  {
Line 112  mdoc_node(const struct mdoc *mdoc)
Line 102  mdoc_node(const struct mdoc *mdoc)
         return(mdoc->first);          return(mdoc->first);
 }  }
   
   
 const struct mdoc_meta *  const struct mdoc_meta *
 mdoc_meta(const struct mdoc *mdoc)  mdoc_meta(const struct mdoc *mdoc)
 {  {
Line 120  mdoc_meta(const struct mdoc *mdoc)
Line 109  mdoc_meta(const struct mdoc *mdoc)
         return(&mdoc->meta);          return(&mdoc->meta);
 }  }
   
   /*
    * Frees volatile resources (parse tree, meta-data, fields).
    */
   static void
   mdoc_free1(struct mdoc *mdoc)
   {
   
           if (mdoc->first)
                   mdoc_node_delete(mdoc, mdoc->first);
           free(mdoc->meta.msec);
           free(mdoc->meta.vol);
           free(mdoc->meta.arch);
           free(mdoc->meta.date);
           free(mdoc->meta.title);
           free(mdoc->meta.os);
           free(mdoc->meta.name);
   }
   
   /*
    * Allocate all volatile resources (parse tree, meta-data, fields).
    */
   static void
   mdoc_alloc1(struct mdoc *mdoc)
   {
   
           memset(&mdoc->meta, 0, sizeof(struct mdoc_meta));
           mdoc->flags = 0;
           mdoc->lastnamed = mdoc->lastsec = SEC_NONE;
           mdoc->last = mandoc_calloc(1, sizeof(struct mdoc_node));
           mdoc->first = mdoc->last;
           mdoc->last->type = MDOC_ROOT;
           mdoc->last->tok = MDOC_MAX;
           mdoc->next = MDOC_NEXT_CHILD;
   }
   
   /*
    * Free up volatile resources (see mdoc_free1()) then re-initialises the
    * data with mdoc_alloc1().  After invocation, parse data has been reset
    * and the parser is ready for re-invocation on a new tree; however,
    * cross-parse non-volatile data is kept intact.
    */
 void  void
 mdoc_free(struct mdoc *mdoc)  mdoc_reset(struct mdoc *mdoc)
 {  {
   
         if (mdoc->first)          mdoc_free1(mdoc);
                 mdoc_node_freelist(mdoc->first);          mdoc_alloc1(mdoc);
         if (mdoc->htab)  }
                 mdoc_tokhash_free(mdoc->htab);  
         if (mdoc->meta.title)  
                 free(mdoc->meta.title);  
         if (mdoc->meta.os)  
                 free(mdoc->meta.os);  
         if (mdoc->meta.name)  
                 free(mdoc->meta.name);  
   
   /*
    * Completely free up all volatile and non-volatile parse resources.
    * After invocation, the pointer is no longer usable.
    */
   void
   mdoc_free(struct mdoc *mdoc)
   {
   
           mdoc_free1(mdoc);
         free(mdoc);          free(mdoc);
 }  }
   
   /*
    * Allocate volatile and non-volatile parse resources.
    */
 struct mdoc *  struct mdoc *
 mdoc_alloc(void *data, const struct mdoc_cb *cb)  mdoc_alloc(struct roff *roff, struct mparse *parse,
           const char *defos, int quick)
 {  {
         struct mdoc     *p;          struct mdoc     *p;
   
         p = xcalloc(1, sizeof(struct mdoc));          p = mandoc_calloc(1, sizeof(struct mdoc));
   
         p->data = data;          p->parse = parse;
         if (cb)          p->defos = defos;
                 (void)memcpy(&p->cb, cb, sizeof(struct mdoc_cb));          p->quick = quick;
           p->roff = roff;
   
         p->last = xcalloc(1, sizeof(struct mdoc_node));          mdoc_hash_init();
         p->last->type = MDOC_ROOT;          mdoc_alloc1(p);
         p->first = p->last;  
   
         p->next = MDOC_NEXT_CHILD;  
         p->htab = mdoc_tokhash_alloc();  
   
         return(p);          return(p);
 }  }
   
   
 int  int
 mdoc_endparse(struct mdoc *mdoc)  mdoc_endparse(struct mdoc *mdoc)
 {  {
   
         if (MDOC_HALT & mdoc->flags)          return(mdoc_macroend(mdoc));
                 return(0);  
         if (NULL == mdoc->first)  
                 return(1);  
   
         assert(mdoc->last);  
         if ( ! macro_end(mdoc)) {  
                 mdoc->flags |= MDOC_HALT;  
                 return(0);  
         }  
         return(1);  
 }  }
   
   
 /*  
  * Main line-parsing routine.  If the line is a macro-line (started with  
  * a '.' control character), then pass along to the parser, which parses  
  * subsequent macros until the end of line.  If normal text, simply  
  * append the entire line to the chain.  
  */  
 int  int
 mdoc_parseln(struct mdoc *mdoc, int line, char *buf)  mdoc_addeqn(struct mdoc *mdoc, const struct eqn *ep)
 {  {
         int               c, i;          struct mdoc_node *n;
         char              tmp[5];  
   
         if (MDOC_HALT & mdoc->flags)          n = node_alloc(mdoc, ep->ln, ep->pos, MDOC_MAX, MDOC_EQN);
                 return(0);          n->eqn = ep;
           if (ep->ln > mdoc->last->line)
                   n->flags |= MDOC_LINE;
   
         mdoc->linetok = 0;          if ( ! node_append(mdoc, n))
   
         if ('.' != *buf) {  
                 /*  
                  * Free-form text.  Not allowed in the prologue.  
                  */  
                 if (SEC_PROLOGUE == mdoc->lastnamed)  
                         return(mdoc_perr(mdoc, line, 0,  
                                         "no text in prologue"));  
   
                 if ( ! mdoc_word_alloc(mdoc, line, 0, buf))  
                         return(0);  
                 mdoc->next = MDOC_NEXT_SIBLING;  
                 return(1);  
         }  
   
         /*  
          * Control-character detected.  Begin the parsing sequence.  
          */  
   
         if (buf[1] && '\\' == buf[1])  
                 if (buf[2] && '\"' == buf[2])  
                         return(1);  
   
         i = 1;  
         while (buf[i] && ! isspace((int)buf[i]) && i < (int)sizeof(tmp))  
                 i++;  
   
         if (i == (int)sizeof(tmp)) {  
                 mdoc->flags |= MDOC_HALT;  
                 return(mdoc_perr(mdoc, line, 1, "unknown macro"));  
         } else if (i <= 2) {  
                 mdoc->flags |= MDOC_HALT;  
                 return(mdoc_perr(mdoc, line, 1, "unknown macro"));  
         }  
   
         i--;  
   
         (void)memcpy(tmp, buf + 1, (size_t)i);  
         tmp[i++] = 0;  
   
         if (MDOC_MAX == (c = mdoc_find(mdoc, tmp))) {  
                 mdoc->flags |= MDOC_HALT;  
                 return(mdoc_perr(mdoc, line, 1, "unknown macro"));  
         }  
   
         while (buf[i] && isspace((int)buf[i]))  
                 i++;  
   
         if ( ! mdoc_macro(mdoc, c, line, 1, &i, buf)) {  
                 mdoc->flags |= MDOC_HALT;  
                 return(0);                  return(0);
         }  
   
           mdoc->next = MDOC_NEXT_SIBLING;
         return(1);          return(1);
 }  }
   
   
 void  
 mdoc_vmsg(struct mdoc *mdoc, int ln, int pos, const char *fmt, ...)  
 {  
         char              buf[256];  
         va_list           ap;  
   
         if (NULL == mdoc->cb.mdoc_msg)  
                 return;  
   
         va_start(ap, fmt);  
         (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);  
         va_end(ap);  
         (*mdoc->cb.mdoc_msg)(mdoc->data, ln, pos, buf);  
 }  
   
   
 int  int
 mdoc_verr(struct mdoc *mdoc, int ln, int pos,  mdoc_addspan(struct mdoc *mdoc, const struct tbl_span *sp)
                 const char *fmt, ...)  
 {  {
         char             buf[256];          struct mdoc_node *n;
         va_list          ap;  
   
         if (NULL == mdoc->cb.mdoc_err)          n = node_alloc(mdoc, sp->line, 0, MDOC_MAX, MDOC_TBL);
           n->span = sp;
   
           if ( ! node_append(mdoc, n))
                 return(0);                  return(0);
   
         va_start(ap, fmt);          mdoc->next = MDOC_NEXT_SIBLING;
         (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);          return(1);
         va_end(ap);  
         return((*mdoc->cb.mdoc_err)(mdoc->data, ln, pos, buf));  
 }  }
   
   /*
    * Main parse routine.  Parses a single line -- really just hands off to
    * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()).
    */
 int  int
 mdoc_vwarn(struct mdoc *mdoc, int ln, int pos,  mdoc_parseln(struct mdoc *mdoc, int ln, char *buf, int offs)
                 enum mdoc_warn type, const char *fmt, ...)  
 {  {
         char             buf[256];  
         va_list          ap;  
   
         if (NULL == mdoc->cb.mdoc_warn)          if (mdoc->last->type != MDOC_EQN || ln > mdoc->last->line)
                 return(0);                  mdoc->flags |= MDOC_NEWLINE;
   
         va_start(ap, fmt);          /*
         (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);           * Let the roff nS register switch SYNOPSIS mode early,
         va_end(ap);           * such that the parser knows at all times
         return((*mdoc->cb.mdoc_warn)(mdoc->data, ln, pos, type, buf));           * whether this mode is on or off.
            * Note that this mode is also switched by the Sh macro.
            */
           if (roff_getreg(mdoc->roff, "nS"))
                   mdoc->flags |= MDOC_SYNOPSIS;
           else
                   mdoc->flags &= ~MDOC_SYNOPSIS;
   
           return(roff_getcontrol(mdoc->roff, buf, &offs) ?
               mdoc_pmacro(mdoc, ln, buf, offs) :
               mdoc_ptext(mdoc, ln, buf, offs));
 }  }
   
   
 int  int
 mdoc_macro(struct mdoc *mdoc, int tok,  mdoc_macro(MACRO_PROT_ARGS)
                 int ln, int ppos, int *pos, char *buf)  
 {  {
           assert(tok < MDOC_MAX);
   
         assert(mdoc_macros[tok].fp);          if (mdoc->flags & MDOC_PBODY) {
                   if (tok == MDOC_Dt) {
                           mandoc_vmsg(MANDOCERR_DT_LATE,
                               mdoc->parse, line, ppos,
                               "Dt %s", buf + *pos);
                           return(1);
                   }
           } else if ( ! (mdoc_macros[tok].flags & MDOC_PROLOGUE)) {
                   if (mdoc->meta.title == NULL) {
                           mandoc_vmsg(MANDOCERR_DT_NOTITLE,
                               mdoc->parse, line, ppos, "%s %s",
                               mdoc_macronames[tok], buf + *pos);
                           mdoc->meta.title = mandoc_strdup("UNTITLED");
                   }
                   if (NULL == mdoc->meta.vol)
                           mdoc->meta.vol = mandoc_strdup("LOCAL");
                   mdoc->flags |= MDOC_PBODY;
           }
   
         if (MDOC_PROLOGUE & mdoc_macros[tok].flags &&          return((*mdoc_macros[tok].fp)(mdoc, tok, line, ppos, pos, buf));
                         SEC_PROLOGUE != mdoc->lastnamed)  
                 return(mdoc_perr(mdoc, ln, ppos, "macro disallowed in document body"));  
         if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) &&  
                         SEC_PROLOGUE == mdoc->lastnamed)  
                 return(mdoc_perr(mdoc, ln, ppos, "macro disallowed in document prologue"));  
         if (1 != ppos && ! (MDOC_CALLABLE & mdoc_macros[tok].flags))  
                 return(mdoc_perr(mdoc, ln, ppos, "macro not callable"));  
         return((*mdoc_macros[tok].fp)(mdoc, tok, ln, ppos, pos, buf));  
 }  }
   
   
 static int  static int
 mdoc_node_append(struct mdoc *mdoc, struct mdoc_node *p)  node_append(struct mdoc *mdoc, struct mdoc_node *p)
 {  {
         const char       *nn, *nt, *on, *ot, *act;  
   
         assert(mdoc->last);          assert(mdoc->last);
         assert(mdoc->first);          assert(mdoc->first);
         assert(MDOC_ROOT != p->type);          assert(MDOC_ROOT != p->type);
   
         /* See if we exceed the suggest line-max. */  
   
         switch (p->type) {  
         case (MDOC_TEXT):  
                 /* FALLTHROUGH */  
         case (MDOC_ELEM):  
                 /* FALLTHROUGH */  
         case (MDOC_BLOCK):  
                 mdoc->linetok++;  
                 break;  
         default:  
                 break;  
         }  
   
         /* This sort-of works (re-opening of text macros...). */  
         if (mdoc->linetok > MDOC_LINEARG_SOFTMAX)  
                 if ( ! mdoc_nwarn(mdoc, p, WARN_COMPAT,  
                                         "suggested %d tokens per line exceeded (has %d)",  
                                         MDOC_LINEARG_SOFTMAX, mdoc->linetok))  
                         return(0);  
   
         if (MDOC_TEXT == mdoc->last->type)  
                 on = "<text>";  
         else if (MDOC_ROOT == mdoc->last->type)  
                 on = "<root>";  
         else  
                 on = mdoc_macronames[mdoc->last->tok];  
   
         if (MDOC_TEXT == p->type)  
                 nn = "<text>";  
         else if (MDOC_ROOT == p->type)  
                 nn = "<root>";  
         else  
                 nn = mdoc_macronames[p->tok];  
   
         ot = mdoc_type2a(mdoc->last->type);  
         nt = mdoc_type2a(p->type);  
   
         switch (mdoc->next) {          switch (mdoc->next) {
         case (MDOC_NEXT_SIBLING):          case MDOC_NEXT_SIBLING:
                 mdoc->last->next = p;                  mdoc->last->next = p;
                 p->prev = mdoc->last;                  p->prev = mdoc->last;
                 p->parent = mdoc->last->parent;                  p->parent = mdoc->last->parent;
                 act = "sibling";  
                 break;                  break;
         case (MDOC_NEXT_CHILD):          case MDOC_NEXT_CHILD:
                 mdoc->last->child = p;                  mdoc->last->child = p;
                 p->parent = mdoc->last;                  p->parent = mdoc->last;
                 act = "child";  
                 break;                  break;
         default:          default:
                 abort();                  abort();
                 /* NOTREACHED */                  /* NOTREACHED */
         }          }
   
           p->parent->nchild++;
   
           /*
            * Copy over the normalised-data pointer of our parent.  Not
            * everybody has one, but copying a null pointer is fine.
            */
   
           switch (p->type) {
           case MDOC_BODY:
                   if (ENDBODY_NOT != p->end)
                           break;
                   /* FALLTHROUGH */
           case MDOC_TAIL:
                   /* FALLTHROUGH */
           case MDOC_HEAD:
                   p->norm = p->parent->norm;
                   break;
           default:
                   break;
           }
   
         if ( ! mdoc_valid_pre(mdoc, p))          if ( ! mdoc_valid_pre(mdoc, p))
                 return(0);                  return(0);
   
         switch (p->type) {          switch (p->type) {
         case (MDOC_HEAD):          case MDOC_HEAD:
                 assert(MDOC_BLOCK == p->parent->type);                  assert(MDOC_BLOCK == p->parent->type);
                 p->parent->data.block.head = p;                  p->parent->head = p;
                 break;                  break;
         case (MDOC_TAIL):          case MDOC_TAIL:
                 assert(MDOC_BLOCK == p->parent->type);                  assert(MDOC_BLOCK == p->parent->type);
                 p->parent->data.block.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->data.block.body = p;                  p->parent->body = p;
                 break;                  break;
         default:          default:
                 break;                  break;
         }          }
   
         mdoc->last = p;          mdoc->last = p;
         mdoc_msg(mdoc, "parse: %s `%s' %s of %s `%s'",  
                         nt, nn, act, ot, on);          switch (p->type) {
           case MDOC_TBL:
                   /* FALLTHROUGH */
           case MDOC_TEXT:
                   if ( ! mdoc_valid_post(mdoc))
                           return(0);
                   break;
           default:
                   break;
           }
   
         return(1);          return(1);
 }  }
   
   
 static struct mdoc_node *  static struct mdoc_node *
 mdoc_node_alloc(const struct mdoc *mdoc)  node_alloc(struct mdoc *mdoc, int line, int pos,
                   enum mdoct tok, enum mdoc_type type)
 {  {
         struct mdoc_node *p;          struct mdoc_node *p;
   
         p = xcalloc(1, sizeof(struct mdoc_node));          p = mandoc_calloc(1, sizeof(struct mdoc_node));
         p->sec = mdoc->lastsec;          p->sec = mdoc->lastsec;
           p->line = line;
           p->pos = pos;
           p->lastline = line;
           p->tok = tok;
           p->type = type;
   
           /* Flag analysis. */
   
           if (MDOC_SYNOPSIS & mdoc->flags)
                   p->flags |= MDOC_SYNPRETTY;
           else
                   p->flags &= ~MDOC_SYNPRETTY;
           if (MDOC_NEWLINE & mdoc->flags)
                   p->flags |= MDOC_LINE;
           mdoc->flags &= ~MDOC_NEWLINE;
   
         return(p);          return(p);
 }  }
   
   
 int  int
 mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, int tok)  mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok)
 {  {
         struct mdoc_node *p;          struct mdoc_node *p;
   
         assert(mdoc->first);          p = node_alloc(mdoc, line, pos, tok, MDOC_TAIL);
         assert(mdoc->last);          if ( ! node_append(mdoc, p))
                   return(0);
         p = mdoc_node_alloc(mdoc);          mdoc->next = MDOC_NEXT_CHILD;
           return(1);
         p->line = line;  
         p->pos = pos;  
         p->type = MDOC_TAIL;  
         p->tok = tok;  
   
         return(mdoc_node_append(mdoc, p));  
 }  }
   
   
 int  int
 mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, int tok)  mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok)
 {  {
         struct mdoc_node *p;          struct mdoc_node *p;
   
         assert(mdoc->first);          assert(mdoc->first);
         assert(mdoc->last);          assert(mdoc->last);
   
         p = mdoc_node_alloc(mdoc);          p = node_alloc(mdoc, line, pos, tok, MDOC_HEAD);
           if ( ! node_append(mdoc, p))
         p->line = line;                  return(0);
         p->pos = pos;          mdoc->next = MDOC_NEXT_CHILD;
         p->type = MDOC_HEAD;          return(1);
         p->tok = tok;  
   
         return(mdoc_node_append(mdoc, p));  
 }  }
   
   
 int  int
 mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, int tok)  mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok)
 {  {
         struct mdoc_node *p;          struct mdoc_node *p;
   
         assert(mdoc->first);          p = node_alloc(mdoc, line, pos, tok, MDOC_BODY);
         assert(mdoc->last);          if ( ! node_append(mdoc, p))
                   return(0);
         p = mdoc_node_alloc(mdoc);          mdoc->next = MDOC_NEXT_CHILD;
           return(1);
         p->line = line;  
         p->pos = pos;  
         p->type = MDOC_BODY;  
         p->tok = tok;  
   
         return(mdoc_node_append(mdoc, p));  
 }  }
   
   
 int  int
 mdoc_root_alloc(struct mdoc *mdoc)  mdoc_endbody_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok,
                   struct mdoc_node *body, enum mdoc_endbody end)
 {  {
         struct mdoc_node *p;          struct mdoc_node *p;
   
         p = mdoc_node_alloc(mdoc);          p = node_alloc(mdoc, line, pos, tok, MDOC_BODY);
           p->pending = body;
         p->type = MDOC_ROOT;          p->norm = body->norm;
           p->end = end;
         return(mdoc_node_append(mdoc, p));          if ( ! node_append(mdoc, p))
                   return(0);
           mdoc->next = MDOC_NEXT_SIBLING;
           return(1);
 }  }
   
   
 int  int
 mdoc_block_alloc(struct mdoc *mdoc, int line, int pos,  mdoc_block_alloc(struct mdoc *mdoc, int line, int pos,
                 int tok, size_t argsz, const struct mdoc_arg *args)                  enum mdoct tok, struct mdoc_arg *args)
 {  {
         struct mdoc_node *p;          struct mdoc_node *p;
   
         p = mdoc_node_alloc(mdoc);          p = node_alloc(mdoc, line, pos, tok, MDOC_BLOCK);
           p->args = args;
           if (p->args)
                   (args->refcnt)++;
   
         p->pos = pos;          switch (tok) {
         p->line = line;          case MDOC_Bd:
         p->type = MDOC_BLOCK;                  /* FALLTHROUGH */
         p->tok = tok;          case MDOC_Bf:
         p->data.block.argc = argsz;                  /* FALLTHROUGH */
         p->data.block.argv = argdup(argsz, args);          case MDOC_Bl:
                   /* FALLTHROUGH */
           case MDOC_En:
                   /* FALLTHROUGH */
           case MDOC_Rs:
                   p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
                   break;
           default:
                   break;
           }
   
         return(mdoc_node_append(mdoc, p));          if ( ! node_append(mdoc, p))
                   return(0);
           mdoc->next = MDOC_NEXT_CHILD;
           return(1);
 }  }
   
   
 int  int
 mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos,  mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos,
                 int tok, size_t argsz, const struct mdoc_arg *args)                  enum mdoct tok, struct mdoc_arg *args)
 {  {
         struct mdoc_node *p;          struct mdoc_node *p;
   
         p = mdoc_node_alloc(mdoc);          p = node_alloc(mdoc, line, pos, tok, MDOC_ELEM);
           p->args = args;
           if (p->args)
                   (args->refcnt)++;
   
         p->line = line;          switch (tok) {
         p->pos = pos;          case MDOC_An:
         p->type = MDOC_ELEM;                  p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
         p->tok = tok;                  break;
         p->data.elem.argc = argsz;          default:
         p->data.elem.argv = argdup(argsz, args);                  break;
           }
   
         return(mdoc_node_append(mdoc, p));          if ( ! node_append(mdoc, p))
                   return(0);
           mdoc->next = MDOC_NEXT_CHILD;
           return(1);
 }  }
   
   
 int  int
 mdoc_word_alloc(struct mdoc *mdoc,  mdoc_word_alloc(struct mdoc *mdoc, int line, int pos, const char *p)
                 int line, int pos, const char *word)  
 {  {
         struct mdoc_node *p;          struct mdoc_node *n;
   
         p = mdoc_node_alloc(mdoc);          n = node_alloc(mdoc, line, pos, MDOC_MAX, MDOC_TEXT);
           n->string = roff_strdup(mdoc->roff, p);
   
         p->line = line;          if ( ! node_append(mdoc, n))
         p->pos = pos;                  return(0);
         p->type = MDOC_TEXT;  
         p->data.text.string = xstrdup(word);  
   
         return(mdoc_node_append(mdoc, p));          mdoc->next = MDOC_NEXT_SIBLING;
           return(1);
 }  }
   
   void
   mdoc_word_append(struct mdoc *mdoc, const char *p)
   {
           struct mdoc_node        *n;
           char                    *addstr, *newstr;
   
           n = mdoc->last;
           addstr = roff_strdup(mdoc->roff, p);
           mandoc_asprintf(&newstr, "%s %s", n->string, addstr);
           free(addstr);
           free(n->string);
           n->string = newstr;
           mdoc->next = MDOC_NEXT_SIBLING;
   }
   
 static void  static void
 argfree(size_t sz, struct mdoc_arg *p)  mdoc_node_free(struct mdoc_node *p)
 {  {
         int              i, j;  
   
         if (0 == sz)          if (MDOC_BLOCK == p->type || MDOC_ELEM == p->type)
                 return;                  free(p->norm);
           if (p->string)
         assert(p);                  free(p->string);
         /* LINTED */          if (p->args)
         for (i = 0; i < (int)sz; i++)                  mdoc_argv_free(p->args);
                 if (p[i].sz > 0) {  
                         assert(p[i].value);  
                         /* LINTED */  
                         for (j = 0; j < (int)p[i].sz; j++)  
                                 free(p[i].value[j]);  
                         free(p[i].value);  
                 }  
         free(p);          free(p);
 }  }
   
   
 static void  static void
 mdoc_elem_free(struct mdoc_elem *p)  mdoc_node_unlink(struct mdoc *mdoc, struct mdoc_node *n)
 {  {
   
         argfree(p->argc, p->argv);          /* Adjust siblings. */
 }  
   
           if (n->prev)
                   n->prev->next = n->next;
           if (n->next)
                   n->next->prev = n->prev;
   
 static void          /* Adjust parent. */
 mdoc_block_free(struct mdoc_block *p)  
 {  
   
         argfree(p->argc, p->argv);          if (n->parent) {
                   n->parent->nchild--;
                   if (n->parent->child == n)
                           n->parent->child = n->prev ? n->prev : n->next;
                   if (n->parent->last == n)
                           n->parent->last = n->prev ? n->prev : NULL;
           }
   
           /* Adjust parse point, if applicable. */
   
           if (mdoc && mdoc->last == n) {
                   if (n->prev) {
                           mdoc->last = n->prev;
                           mdoc->next = MDOC_NEXT_SIBLING;
                   } else {
                           mdoc->last = n->parent;
                           mdoc->next = MDOC_NEXT_CHILD;
                   }
           }
   
           if (mdoc && mdoc->first == n)
                   mdoc->first = NULL;
 }  }
   
   void
   mdoc_node_delete(struct mdoc *mdoc, struct mdoc_node *p)
   {
   
 static void          while (p->child) {
 mdoc_text_free(struct mdoc_text *p)                  assert(p->nchild);
                   mdoc_node_delete(mdoc, p->child);
           }
           assert(0 == p->nchild);
   
           mdoc_node_unlink(mdoc, p);
           mdoc_node_free(p);
   }
   
   int
   mdoc_node_relink(struct mdoc *mdoc, struct mdoc_node *p)
 {  {
   
         if (p->string)          mdoc_node_unlink(mdoc, p);
                 free(p->string);          return(node_append(mdoc, p));
 }  }
   
   /*
    * Parse free-form text, that is, a line that does not begin with the
    * control character.
    */
   static int
   mdoc_ptext(struct mdoc *mdoc, int line, char *buf, int offs)
   {
           char             *c, *ws, *end;
           struct mdoc_node *n;
   
 void          assert(mdoc->last);
 mdoc_node_free(struct mdoc_node *p)          n = mdoc->last;
   
           /*
            * 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).
            */
   
           if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
               LIST_column == n->norm->Bl.type) {
                   /* `Bl' is open without any children. */
                   mdoc->flags |= MDOC_FREECOL;
                   return(mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf));
           }
   
           if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
               NULL != n->parent &&
               MDOC_Bl == n->parent->tok &&
               LIST_column == n->parent->norm->Bl.type) {
                   /* `Bl' has block-level `It' children. */
                   mdoc->flags |= MDOC_FREECOL;
                   return(mdoc_macro(mdoc, 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 (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 & mdoc->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)
                   mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse,
                       line, (int)(ws-buf), NULL);
   
           if ('\0' == buf[offs] && ! (MDOC_LITERAL & mdoc->flags)) {
                   mandoc_msg(MANDOCERR_FI_BLANK, mdoc->parse,
                       line, (int)(c - buf), NULL);
   
                   /*
                    * Insert a `sp' in the case of a blank line.  Technically,
                    * blank lines aren't allowed, but enough manuals assume this
                    * behaviour that we want to work around it.
                    */
                   if ( ! mdoc_elem_alloc(mdoc, line, offs, MDOC_sp, NULL))
                           return(0);
   
                   mdoc->next = MDOC_NEXT_SIBLING;
   
                   return(mdoc_valid_post(mdoc));
           }
   
           if ( ! mdoc_word_alloc(mdoc, line, offs, buf+offs))
                   return(0);
   
           if (MDOC_LITERAL & mdoc->flags)
                   return(1);
   
           /*
            * End-of-sentence check.  If the last character is an unescaped
            * EOS character, then flag the node as being the end of a
            * sentence.  The front-end will know how to interpret this.
            */
   
           assert(buf < end);
   
           if (mandoc_eos(buf+offs, (size_t)(end-buf-offs)))
                   mdoc->last->flags |= MDOC_EOS;
   
           return(1);
   }
   
   /*
    * Parse a macro line, that is, a line beginning with the control
    * character.
    */
   static int
   mdoc_pmacro(struct mdoc *mdoc, int ln, char *buf, int offs)
 {  {
           struct mdoc_node *n;
           const char       *cp;
           enum mdoct        tok;
           int               i, sv;
           char              mac[5];
   
         switch (p->type) {          sv = offs;
         case (MDOC_TEXT):  
                 mdoc_text_free(&p->data.text);          /*
            * Copy the first word into a nil-terminated buffer.
            * Stop when a space, tab, escape, or eoln is encountered.
            */
   
           i = 0;
           while (i < 4 && strchr(" \t\\", buf[offs]) == NULL)
                   mac[i++] = buf[offs++];
   
           mac[i] = '\0';
   
           tok = (i > 1 && i < 4) ? mdoc_hash_find(mac) : MDOC_MAX;
   
           if (tok == MDOC_MAX) {
                   mandoc_msg(MANDOCERR_MACRO, mdoc->parse,
                       ln, sv, buf + sv - 1);
                   return(1);
           }
   
           /* Skip a leading escape sequence or tab. */
   
           switch (buf[offs]) {
           case '\\':
                   cp = buf + offs + 1;
                   mandoc_escape(&cp, NULL, NULL);
                   offs = cp - buf;
                 break;                  break;
         case (MDOC_ELEM):          case '\t':
                 mdoc_elem_free(&p->data.elem);                  offs++;
                 break;                  break;
         case (MDOC_BLOCK):  
                 mdoc_block_free(&p->data.block);  
                 break;  
         default:          default:
                 break;                  break;
         }          }
   
         free(p);          /* Jump to the next non-whitespace word. */
 }  
   
           while (buf[offs] && ' ' == buf[offs])
                   offs++;
   
 void          /*
 mdoc_node_freelist(struct mdoc_node *p)           * Trailing whitespace.  Note that tabs are allowed to be passed
 {           * into the parser as "text", so we only warn about spaces here.
            */
   
         if (p->child)          if ('\0' == buf[offs] && ' ' == buf[offs - 1])
                 mdoc_node_freelist(p->child);                  mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse,
         if (p->next)                      ln, offs - 1, NULL);
                 mdoc_node_freelist(p->next);  
   
         mdoc_node_free(p);          /*
 }           * If an initial macro or a list invocation, divert directly
            * into macro processing.
            */
   
           if (NULL == mdoc->last || MDOC_It == tok || MDOC_El == tok)
                   return(mdoc_macro(mdoc, tok, ln, sv, &offs, buf));
   
 int          n = mdoc->last;
 mdoc_find(const struct mdoc *mdoc, const char *key)          assert(mdoc->last);
 {  
   
         return(mdoc_tokhash_find(mdoc->htab, key));          /*
 }           * 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->norm->Bl.type) {
                   mdoc->flags |= MDOC_FREECOL;
                   return(mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf));
           }
   
 static void          /*
 argcpy(struct mdoc_arg *dst, const struct mdoc_arg *src)           * If we're following a block-level `It' within a `Bl -column'
 {           * context (perhaps opened in the above block or in ptext()),
         int              i;           * then open an `It' block context around the parsed macro.
            */
   
         dst->line = src->line;          if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
         dst->pos = src->pos;              NULL != n->parent &&
         dst->arg = src->arg;              MDOC_Bl == n->parent->tok &&
         if (0 == (dst->sz = src->sz))              LIST_column == n->parent->norm->Bl.type) {
                 return;                  mdoc->flags |= MDOC_FREECOL;
         dst->value = xcalloc(dst->sz, sizeof(char *));                  return(mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf));
         for (i = 0; i < (int)dst->sz; i++)          }
                 dst->value[i] = xstrdup(src->value[i]);  
 }  
   
           /* Normal processing of a macro. */
   
 static struct mdoc_arg *          if ( ! mdoc_macro(mdoc, tok, ln, sv, &offs, buf))
 argdup(size_t argsz, const struct mdoc_arg *args)                  return(0);
 {  
         struct mdoc_arg *pp;  
         int              i;  
   
         if (0 == argsz)          /* In quick mode (for mandocdb), abort after the NAME section. */
                 return(NULL);  
   
         pp = xcalloc((size_t)argsz, sizeof(struct mdoc_arg));          if (mdoc->quick && MDOC_Sh == tok &&
         for (i = 0; i < (int)argsz; i++)              SEC_NAME != mdoc->last->sec)
                 argcpy(&pp[i], &args[i]);                  return(2);
   
         return(pp);          return(1);
 }  }
   
   enum mdelim
 /* FIXME: deprecate. */  mdoc_isdelim(const char *p)
 char *  
 mdoc_node2a(struct mdoc_node *node)  
 {  {
         static char      buf[64];  
   
         assert(node);          if ('\0' == p[0])
                   return(DELIM_NONE);
   
         buf[0] = 0;          if ('\0' == p[1])
         (void)xstrlcat(buf, mdoc_type2a(node->type), 64);                  switch (p[0]) {
         if (MDOC_ROOT == node->type)                  case '(':
                 return(buf);                          /* FALLTHROUGH */
         (void)xstrlcat(buf, " `", 64);                  case '[':
         if (MDOC_TEXT == node->type)                          return(DELIM_OPEN);
                 (void)xstrlcat(buf, node->data.text.string, 64);                  case '|':
         else                          return(DELIM_MIDDLE);
                 (void)xstrlcat(buf, mdoc_macronames[node->tok], 64);                  case '.':
         (void)xstrlcat(buf, "'", 64);                          /* FALLTHROUGH */
                   case ',':
                           /* FALLTHROUGH */
                   case ';':
                           /* FALLTHROUGH */
                   case ':':
                           /* FALLTHROUGH */
                   case '?':
                           /* FALLTHROUGH */
                   case '!':
                           /* FALLTHROUGH */
                   case ')':
                           /* FALLTHROUGH */
                   case ']':
                           return(DELIM_CLOSE);
                   default:
                           return(DELIM_NONE);
                   }
   
         return(buf);          if ('\\' != p[0])
                   return(DELIM_NONE);
   
           if (0 == strcmp(p + 1, "."))
                   return(DELIM_CLOSE);
           if (0 == strcmp(p + 1, "fR|\\fP"))
                   return(DELIM_MIDDLE);
   
           return(DELIM_NONE);
 }  }
   
   void
   mdoc_deroff(char **dest, const struct mdoc_node *n)
   {
           char    *cp;
           size_t   sz;
   
           if (MDOC_TEXT != n->type) {
                   for (n = n->child; n; n = n->next)
                           mdoc_deroff(dest, n);
                   return;
           }
   
           /* Skip leading whitespace. */
   
           for (cp = n->string; '\0' != *cp; cp++)
                   if (0 == isspace((unsigned char)*cp))
                           break;
   
           /* Skip trailing whitespace. */
   
           for (sz = strlen(cp); sz; sz--)
                   if (0 == isspace((unsigned char)cp[sz-1]))
                           break;
   
           /* Skip empty strings. */
   
           if (0 == sz)
                   return;
   
           if (NULL == *dest) {
                   *dest = mandoc_strndup(cp, sz);
                   return;
           }
   
           mandoc_asprintf(&cp, "%s %*s", *dest, (int)sz, cp);
           free(*dest);
           *dest = cp;
   }
Legend:
Removed from v.1.50  
changed lines
  Added in v.1.229
CVSweb