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

Diff for /mandoc/mdoc.c between version 1.8 and 1.178

version 1.8, 2008/12/29 12:19:41 version 1.178, 2011/02/06 22:02:58
Line 1 
Line 1 
 /* $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008 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   * 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.  
  */   */
   #ifdef HAVE_CONFIG_H
   #include "config.h"
   #endif
   
   #include <sys/types.h>
   
 #include <assert.h>  #include <assert.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 "mandoc.h"
   #include "libmdoc.h"
   #include "libmandoc.h"
   
 const   char *const __mdoc_macronames[MDOC_MAX] = {  const   char *const __mdoc_macronames[MDOC_MAX] = {
         "\\\"",         "Dd",           "Dt",           "Os",          "Ap",           "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 38  const char *const __mdoc_macronames[MDOC_MAX] = {   
Line 44  const char *const __mdoc_macronames[MDOC_MAX] = {   
         "Nm",           "Op",           "Ot",           "Pa",          "Nm",           "Op",           "Ot",           "Pa",
         "Rv",           "St",           "Va",           "Vt",          "Rv",           "St",           "Va",           "Vt",
         /* LINTED */          /* LINTED */
         "Xr",           "\%A",          "\%B",          "\%D",          "Xr",           "%A",           "%B",           "%D",
         /* LINTED */          /* LINTED */
         "\%I",          "\%J",          "\%N",          "\%O",          "%I",           "%J",           "%N",           "%O",
         /* LINTED */          /* LINTED */
         "\%P",          "\%R",          "\%T",          "\%V",          "%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 56  const char *const __mdoc_macronames[MDOC_MAX] = {   
Line 62  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",
           /* LINTED */
           "Brc",          "%C",           "Es",           "En",
           /* LINTED */
           "Dx",           "%Q",           "br",           "sp",
           /* LINTED */
           "%U",           "Ta"
         };          };
   
 const   char *const __mdoc_argnames[MDOC_ARG_MAX] = {  const   char *const __mdoc_argnames[MDOC_ARG_MAX] = {
Line 67  const char *const __mdoc_argnames[MDOC_ARG_MAX] = {   
Line 80  const char *const __mdoc_argnames[MDOC_ARG_MAX] = {   
         "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",  
         };          };
   
 const   struct mdoc_macro __mdoc_macros[MDOC_MAX] = {  
         { NULL, 0 }, /* \" */  
         { macro_prologue_ddate, 0 }, /* Dd */  
         { macro_prologue_dtitle, 0 }, /* Dt */  
         { macro_prologue_os, 0 }, /* Os */  
         { macro_scoped_implicit, 0 }, /* Sh */  
         { macro_scoped_implicit, 0 }, /* Ss */  
         { macro_text, 0 }, /* Pp */  
         { macro_scoped_line, 0 }, /* D1 */  
         { macro_scoped_line, 0 }, /* Dl */  
         { macro_scoped_explicit, MDOC_EXPLICIT }, /* Bd */  
         { macro_scoped_explicit, 0 }, /* Ed */  
         { macro_scoped_explicit, MDOC_EXPLICIT }, /* Bl */  
         { macro_scoped_explicit, 0 }, /* El */  
         { NULL, 0 }, /* It */  
         { macro_text, MDOC_CALLABLE }, /* Ad */  
         { NULL, 0 }, /* An */  
         { macro_text, MDOC_CALLABLE }, /* Ar */  
         { NULL, 0 }, /* Cd */  
         { macro_text, MDOC_CALLABLE }, /* Cm */  
         { macro_text, MDOC_CALLABLE }, /* Dv */  
         { macro_text, MDOC_CALLABLE }, /* Er */  
         { macro_text, MDOC_CALLABLE }, /* Ev */  
         { NULL, 0 }, /* Ex */  
         { macro_text, MDOC_CALLABLE }, /* Fa */  
         { NULL, 0 }, /* Fd */  
         { macro_text, MDOC_CALLABLE }, /* Fl */  
         { NULL, 0 }, /* Fn */  
         { macro_text, 0 }, /* Ft */  
         { macro_text, MDOC_CALLABLE }, /* Ic */  
         { NULL, 0 }, /* In */  
         { macro_text, MDOC_CALLABLE }, /* Li */  
         { NULL, 0 }, /* Nd */  
         { NULL, 0 }, /* Nm */  
         { NULL, 0 }, /* Op */  
         { NULL, 0 }, /* Ot */  
         { macro_text, MDOC_CALLABLE }, /* Pa */  
         { NULL, 0 }, /* Rv */  
         { NULL, 0 }, /* St */  
         { macro_text, MDOC_CALLABLE }, /* Va */  
         { macro_text, MDOC_CALLABLE }, /* Vt */  
         { NULL, 0 }, /* Xr */  
         { NULL, 0 }, /* %A */  
         { NULL, 0 }, /* %B */  
         { NULL, 0 }, /* %D */  
         { NULL, 0 }, /* %I */  
         { NULL, 0 }, /* %J */  
         { NULL, 0 }, /* %N */  
         { NULL, 0 }, /* %O */  
         { NULL, 0 }, /* %P */  
         { NULL, 0 }, /* %R */  
         { NULL, 0 }, /* %T */  
         { NULL, 0 }, /* %V */  
         { NULL, 0 }, /* Ac */  
         { NULL, 0 }, /* Ao */  
         { macro_scoped_pline, MDOC_CALLABLE }, /* Aq */  
         { NULL, 0 }, /* At */  
         { NULL, 0 }, /* Bc */  
         { NULL, 0 }, /* Bf */  
         { NULL, 0 }, /* Bo */  
         { macro_scoped_pline, MDOC_CALLABLE }, /* Bq */  
         { macro_constant_delimited, 0 }, /* Bsx */  
         { macro_constant_delimited, 0 }, /* Bx */  
         { NULL, 0 }, /* Db */  
         { NULL, 0 }, /* Dc */  
         { NULL, 0 }, /* Do */  
         { macro_scoped_pline, MDOC_CALLABLE }, /* Dq */  
         { NULL, 0 }, /* Ec */  
         { NULL, 0 }, /* Ef */  
         { macro_text, MDOC_CALLABLE }, /* Em */  
         { NULL, 0 }, /* Eo */  
         { macro_constant_delimited, 0 }, /* Fx */  
         { macro_text, 0 }, /* Ms */  
         { NULL, 0 }, /* No */  
         { NULL, 0 }, /* Ns */  
         { macro_constant_delimited, 0 }, /* Nx */  
         { macro_constant_delimited, 0 }, /* Ox */  
         { NULL, 0 }, /* Pc */  
         { NULL, 0 }, /* Pf */  
         { NULL, 0 }, /* Po */  
         { macro_scoped_pline, MDOC_CALLABLE }, /* Pq */  
         { NULL, 0 }, /* Qc */  
         { macro_scoped_pline, MDOC_CALLABLE }, /* Ql */  
         { NULL, 0 }, /* Qo */  
         { macro_scoped_pline, MDOC_CALLABLE }, /* Qq */  
         { NULL, 0 }, /* Re */  
         { NULL, 0 }, /* Rs */  
         { NULL, 0 }, /* Sc */  
         { NULL, 0 }, /* So */  
         { macro_scoped_pline, MDOC_CALLABLE }, /* Sq */  
         { NULL, 0 }, /* Sm */  
         { NULL, 0 }, /* Sx */  
         { NULL, 0 }, /* Sy */  
         { macro_text, MDOC_CALLABLE }, /* Tn */  
         { macro_constant_delimited, 0 }, /* Ux */  
         { NULL, 0 }, /* Xc */  
         { NULL, 0 }, /* Xo */  
         { NULL, 0 }, /* Fo */  
         { NULL, 0 }, /* Fc */  
         { NULL, 0 }, /* Oo */  
         { NULL, 0 }, /* Oc */  
         { NULL, 0 }, /* Bk */  
         { NULL, 0 }, /* Ek */  
         { NULL, 0 }, /* Bt */  
         { NULL, 0 }, /* Hf */  
         { NULL, 0 }, /* Fr */  
         { NULL, 0 }, /* Ud */  
 };  
   
 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;
 const   struct mdoc_macro * const mdoc_macros = __mdoc_macros;  
   
   static  void              mdoc_node_free(struct mdoc_node *);
 static  struct mdoc_arg  *argdup(size_t, const struct mdoc_arg *);  static  void              mdoc_node_unlink(struct mdoc *,
 static  void              argfree(size_t, struct mdoc_arg *);  
 static  void              argcpy(struct mdoc_arg *,  
                                 const struct mdoc_arg *);  
 static  char            **paramdup(size_t, const char **);  
 static  void              paramfree(size_t, char **);  
   
 static  void              mdoc_node_freelist(struct mdoc_node *);  
 static  void              mdoc_node_append(struct mdoc *, int,  
                                 struct mdoc_node *);                                  struct mdoc_node *);
 static  void              mdoc_elem_free(struct mdoc_elem *);  static  void              mdoc_free1(struct mdoc *);
 static  void              mdoc_text_free(struct mdoc_text *);  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);
   static  int               mdoc_span_alloc(struct mdoc *,
                                   const struct tbl_span *);
   
   
 const struct mdoc_node *  const struct mdoc_node *
 mdoc_result(struct mdoc *mdoc)  mdoc_node(const struct mdoc *m)
 {  {
   
         return(mdoc->first);          assert( ! (MDOC_HALT & m->flags));
           return(m->first);
 }  }
   
   
   const struct mdoc_meta *
   mdoc_meta(const struct mdoc *m)
   {
   
           assert( ! (MDOC_HALT & m->flags));
           return(&m->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);
           if (mdoc->meta.title)
                   free(mdoc->meta.title);
           if (mdoc->meta.os)
                   free(mdoc->meta.os);
           if (mdoc->meta.name)
                   free(mdoc->meta.name);
           if (mdoc->meta.arch)
                   free(mdoc->meta.arch);
           if (mdoc->meta.vol)
                   free(mdoc->meta.vol);
           if (mdoc->meta.msec)
                   free(mdoc->meta.msec);
   }
   
   
   /*
    * 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->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_reset(struct mdoc *mdoc)
   {
   
           mdoc_free1(mdoc);
           mdoc_alloc1(mdoc);
   }
   
   
   /*
    * 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_free(struct mdoc *mdoc)
 {  {
   
         if (mdoc->first)          mdoc_free1(mdoc);
                 mdoc_node_freelist(mdoc->first);  
         if (mdoc->htab)  
                 mdoc_tokhash_free(mdoc->htab);  
   
         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 regset *regs, void *data, mandocmsg msg)
 {  {
         struct mdoc     *p;          struct mdoc     *p;
   
         p = xcalloc(1, sizeof(struct mdoc));          p = mandoc_calloc(1, sizeof(struct mdoc));
   
           p->msg = msg;
         p->data = data;          p->data = data;
         (void)memcpy(&p->cb, cb, sizeof(struct mdoc_cb));          p->regs = regs;
   
         p->htab = mdoc_tokhash_alloc();          mdoc_hash_init();
           mdoc_alloc1(p);
         return(p);          return(p);
 }  }
   
   
   /*
    * Climb back up the parse tree, validating open scopes.  Mostly calls
    * through to macro_end() in macro.c.
    */
 int  int
 mdoc_parseln(struct mdoc *mdoc, char *buf)  mdoc_endparse(struct mdoc *m)
 {  {
         int               c, i;  
         char              tmp[5];  
   
         if ('.' != *buf) {          assert( ! (MDOC_HALT & m->flags));
                 mdoc_word_alloc(mdoc, 0, buf);          if (mdoc_macroend(m))
                 return(1);                  return(1);
         }          m->flags |= MDOC_HALT;
           return(0);
   }
   
         if (buf[1] && '\\' == buf[1])  int
                 if (buf[2] && '\"' == buf[2])  mdoc_addspan(struct mdoc *m, const struct tbl_span *sp)
                         return(1);  {
   
         i = 1;          assert( ! (MDOC_HALT & m->flags));
         while (buf[i] && ! isspace(buf[i]) && i < (int)sizeof(tmp))  
                 i++;  
   
         if (i == (int)sizeof(tmp))          /* No text before an initial macro. */
                 return(mdoc_err(mdoc, -1, 1, ERR_MACRO_NOTSUP));  
         else if (i <= 2)  
                 return(mdoc_err(mdoc, -1, 1, ERR_MACRO_NOTSUP));  
   
         i--;          if (SEC_NONE == m->lastnamed) {
                   /* FIXME: grab from span. */
                   mdoc_pmsg(m, 0, 0, MANDOCERR_NOTEXT);
                   return(1);
           }
   
         (void)memcpy(tmp, buf + 1, (size_t)i);          return(mdoc_span_alloc(m, sp));
         tmp[i++] = 0;  
   
         if (MDOC_MAX == (c = mdoc_find(mdoc, tmp)))  
                 return(mdoc_err(mdoc, c, 1, ERR_MACRO_NOTSUP));  
   
         while (buf[i] && isspace(buf[i]))  
                 i++;  
   
         return(mdoc_macro(mdoc, c, 1, &i, buf));  
 }  }
   
   
 void  /*
 mdoc_msg(struct mdoc *mdoc, int pos, const char *fmt, ...)   * Main parse routine.  Parses a single line -- really just hands off to
    * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()).
    */
   int
   mdoc_parseln(struct mdoc *m, int ln, char *buf, int offs)
 {  {
         va_list          ap;  
         char             buf[256];  
   
         if (NULL == mdoc->cb.mdoc_msg)          assert( ! (MDOC_HALT & m->flags));
                 return;  
   
         va_start(ap, fmt);          m->flags |= MDOC_NEWLINE;
         (void)vsnprintf(buf, sizeof(buf), fmt, ap);  
         va_end(ap);  
   
         (*mdoc->cb.mdoc_msg)(mdoc->data, pos, buf);          /*
 }           * 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]) ?
 int                          mdoc_pmacro(m, ln, buf, offs) :
 mdoc_err(struct mdoc *mdoc, int tok, int pos, enum mdoc_err type)                          mdoc_ptext(m, ln, buf, offs));
 {  
   
         if (NULL == mdoc->cb.mdoc_err)  
                 return(0);  
         return((*mdoc->cb.mdoc_err)(mdoc->data, tok, pos, type));  
 }  }
   
   
 int  int
 mdoc_warn(struct mdoc *mdoc, int tok, int pos, enum mdoc_warn type)  mdoc_vmsg(struct mdoc *mdoc, enum mandocerr t,
                   int ln, int pos, const char *fmt, ...)
 {  {
           char             buf[256];
           va_list          ap;
   
         if (NULL == mdoc->cb.mdoc_warn)          va_start(ap, fmt);
                 return(0);          vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
         return((*mdoc->cb.mdoc_warn)(mdoc->data, tok, pos, type));          va_end(ap);
   
           return((*mdoc->msg)(t, mdoc->data, ln, pos, buf));
 }  }
   
   
 int  int
 mdoc_macro(struct mdoc *mdoc, int tok, int ppos, int *pos, char *buf)  mdoc_macro(MACRO_PROT_ARGS)
 {  {
           assert(tok < MDOC_MAX);
   
         if (NULL == (mdoc_macros[tok].fp)) {          /* If we're in the body, deny prologue calls. */
                 (void)mdoc_err(mdoc, tok, ppos, ERR_MACRO_NOTSUP);  
                 return(0);  
         }  
   
         if (1 != ppos && ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) {          if (MDOC_PROLOGUE & mdoc_macros[tok].flags &&
                 (void)mdoc_err(mdoc, tok, ppos, ERR_MACRO_NOTCALL);                          MDOC_PBODY & m->flags) {
                 return(0);                  mdoc_pmsg(m, line, ppos, MANDOCERR_BADBODY);
                   return(1);
         }          }
   
         /*mdoc_msg(mdoc, ppos, "calling `%s'", mdoc_macronames[tok]);*/          /* If we're in the prologue, deny "body" macros.  */
   
         return((*mdoc_macros[tok].fp)(mdoc, tok, ppos, pos, buf));          if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) &&
                           ! (MDOC_PBODY & m->flags)) {
                   mdoc_pmsg(m, line, ppos, MANDOCERR_BADPROLOG);
                   if (NULL == m->meta.msec)
                           m->meta.msec = mandoc_strdup("1");
                   if (NULL == m->meta.title)
                           m->meta.title = mandoc_strdup("UNKNOWN");
                   if (NULL == m->meta.vol)
                           m->meta.vol = mandoc_strdup("LOCAL");
                   if (NULL == m->meta.os)
                           m->meta.os = mandoc_strdup("LOCAL");
                   if (0 == m->meta.date)
                           m->meta.date = time(NULL);
                   m->flags |= MDOC_PBODY;
           }
   
           return((*mdoc_macros[tok].fp)(m, tok, line, ppos, pos, buf));
 }  }
   
   
 static void  static int
 mdoc_node_append(struct mdoc *mdoc, int pos, struct mdoc_node *p)  node_append(struct mdoc *mdoc, struct mdoc_node *p)
 {  {
         const char       *nn, *on, *nt, *ot, *act;  
   
         switch (p->type) {          assert(mdoc->last);
         case (MDOC_TEXT):          assert(mdoc->first);
                 nn = p->data.text.string;          assert(MDOC_ROOT != p->type);
                 nt = "text";  
           switch (mdoc->next) {
           case (MDOC_NEXT_SIBLING):
                   mdoc->last->next = p;
                   p->prev = mdoc->last;
                   p->parent = mdoc->last->parent;
                 break;                  break;
         case (MDOC_BODY):          case (MDOC_NEXT_CHILD):
                 nn = mdoc_macronames[p->data.body.tok];                  mdoc->last->child = p;
                 nt = "body";                  p->parent = mdoc->last;
                 break;                  break;
         case (MDOC_ELEM):  
                 nn = mdoc_macronames[p->data.elem.tok];  
                 nt = "elem";  
                 break;  
         case (MDOC_HEAD):  
                 nn = mdoc_macronames[p->data.head.tok];  
                 nt = "head";  
                 break;  
         case (MDOC_BLOCK):  
                 nn = mdoc_macronames[p->data.block.tok];  
                 nt = "block";  
                 break;  
         default:          default:
                 abort();                  abort();
                 /* NOTREACHED */                  /* NOTREACHED */
         }          }
   
         if (NULL == mdoc->first) {          p->parent->nchild++;
                 assert(NULL == mdoc->last);  
                 mdoc->first = p;  
                 mdoc->last = p;  
                 mdoc_msg(mdoc, pos, "parse: root %s `%s'", nt, nn);  
                 return;  
         }  
   
         switch (mdoc->last->type) {          /*
         case (MDOC_TEXT):           * Copy over the normalised-data pointer of our parent.  Not
                 on = "<text>";           * everybody has one, but copying a null pointer is fine.
                 ot = "text";           */
                 break;  
           switch (p->type) {
         case (MDOC_BODY):          case (MDOC_BODY):
                 on = mdoc_macronames[mdoc->last->data.body.tok];                  /* FALLTHROUGH */
                 ot = "body";          case (MDOC_TAIL):
                 break;                  /* FALLTHROUGH */
         case (MDOC_ELEM):  
                 on = mdoc_macronames[mdoc->last->data.elem.tok];  
                 ot = "elem";  
                 break;  
         case (MDOC_HEAD):          case (MDOC_HEAD):
                 on = mdoc_macronames[mdoc->last->data.head.tok];                  p->norm = p->parent->norm;
                 ot = "head";  
                 break;                  break;
         case (MDOC_BLOCK):  
                 on = mdoc_macronames[mdoc->last->data.block.tok];  
                 ot = "block";  
                 break;  
         default:          default:
                 abort();                  break;
                 /* NOTREACHED */  
         }          }
   
           if ( ! mdoc_valid_pre(mdoc, p))
                   return(0);
   
         switch (p->type) {          switch (p->type) {
           case (MDOC_HEAD):
                   assert(MDOC_BLOCK == p->parent->type);
                   p->parent->head = p;
                   break;
           case (MDOC_TAIL):
                   assert(MDOC_BLOCK == p->parent->type);
                   p->parent->tail = p;
                   break;
         case (MDOC_BODY):          case (MDOC_BODY):
                 p->parent = mdoc->last->parent;                  if (p->end)
                 mdoc->last->next = p;                          break;
                 p->prev = mdoc->last;                  assert(MDOC_BLOCK == p->parent->type);
                 act = "sibling";                  p->parent->body = p;
                 break;                  break;
           default:
         case (MDOC_HEAD):  
                 assert(mdoc->last->type == MDOC_BLOCK);  
                 p->parent = mdoc->last;  
                 mdoc->last->child = p;  
                 act = "child";  
                 break;                  break;
           }
   
           mdoc->last = p;
   
           switch (p->type) {
           case (MDOC_TBL):
                   /* FALLTHROUGH */
           case (MDOC_TEXT):
                   if ( ! mdoc_valid_post(mdoc))
                           return(0);
                   break;
         default:          default:
                 switch (mdoc->last->type) {  
                 case (MDOC_BODY):  
                         /* FALLTHROUGH */  
                 case (MDOC_HEAD):  
                         p->parent = mdoc->last;  
                         mdoc->last->child = p;  
                         act = "child";  
                         break;  
                 default:  
                         p->parent = mdoc->last->parent;  
                         p->prev = mdoc->last;  
                         mdoc->last->next = p;  
                         act = "sibling";  
                         break;  
                 }  
                 break;                  break;
         }          }
   
         mdoc_msg(mdoc, pos, "parse: %s `%s' %s %s `%s'",          return(1);
                         nt, nn, act, ot, on);  
         mdoc->last = p;  
 }  }
   
   
 /* FIXME: deprecate paramsz, params. */  static struct mdoc_node *
 void  node_alloc(struct mdoc *m, int line, int pos,
 mdoc_head_alloc(struct mdoc *mdoc, int pos, int tok,                  enum mdoct tok, enum mdoc_type type)
                 size_t paramsz, const char **params)  
 {  {
         struct mdoc_node *p;          struct mdoc_node *p;
   
         assert(mdoc->first);          p = mandoc_calloc(1, sizeof(struct mdoc_node));
         assert(mdoc->last);          p->sec = m->lastsec;
         assert(mdoc->last->type == MDOC_BLOCK);          p->line = line;
         assert(mdoc->last->data.block.tok == tok);          p->pos = pos;
           p->tok = tok;
           p->type = type;
   
         p = xcalloc(1, sizeof(struct mdoc_node));          /* Flag analysis. */
         p->type = MDOC_HEAD;  
         p->data.head.tok = tok;  
         p->data.head.sz = paramsz;  
         p->data.head.args = paramdup(paramsz, params);  
   
         mdoc_node_append(mdoc, pos, p);          if (MDOC_SYNOPSIS & m->flags)
                   p->flags |= MDOC_SYNPRETTY;
           else
                   p->flags &= ~MDOC_SYNPRETTY;
           if (MDOC_NEWLINE & m->flags)
                   p->flags |= MDOC_LINE;
           m->flags &= ~MDOC_NEWLINE;
   
           return(p);
 }  }
   
   
 void  int
 mdoc_body_alloc(struct mdoc *mdoc, int pos, int tok)  mdoc_tail_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
 {  {
         struct mdoc_node *p;          struct mdoc_node *p;
   
         assert(mdoc->first);          p = node_alloc(m, line, pos, tok, MDOC_TAIL);
         assert(mdoc->last);          if ( ! node_append(m, p))
         assert((mdoc->last->type == MDOC_BLOCK) ||                  return(0);
                         (mdoc->last->type == MDOC_HEAD));          m->next = MDOC_NEXT_CHILD;
         if (mdoc->last->type == MDOC_BLOCK)          return(1);
                 assert(mdoc->last->data.block.tok == tok);  }
         else  
                 assert(mdoc->last->data.head.tok == tok);  
   
         p = xcalloc(1, sizeof(struct mdoc_node));  
   
         p->type = MDOC_BODY;  int
         p->data.body.tok = tok;  mdoc_head_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
   {
           struct mdoc_node *p;
   
         mdoc_node_append(mdoc, pos, p);          assert(m->first);
           assert(m->last);
   
           p = node_alloc(m, line, pos, tok, MDOC_HEAD);
           if ( ! node_append(m, p))
                   return(0);
           m->next = MDOC_NEXT_CHILD;
           return(1);
 }  }
   
   
 void  int
 mdoc_block_alloc(struct mdoc *mdoc, int pos, int tok,  mdoc_body_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
                 size_t argsz, const struct mdoc_arg *args)  
 {  {
         struct mdoc_node *p;          struct mdoc_node *p;
   
         p = xcalloc(1, sizeof(struct mdoc_node));          p = node_alloc(m, line, pos, tok, MDOC_BODY);
           if ( ! node_append(m, p))
                   return(0);
           m->next = MDOC_NEXT_CHILD;
           return(1);
   }
   
         p->type = MDOC_BLOCK;  
         p->data.block.tok = tok;  
         p->data.block.argc = argsz;  
         p->data.block.argv = argdup(argsz, args);  
   
         mdoc_node_append(mdoc, pos, p);  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);
 }  }
   
   
 void  int
 mdoc_elem_alloc(struct mdoc *mdoc, int pos, int tok,  mdoc_block_alloc(struct mdoc *m, int line, int pos,
                 size_t argsz, const struct mdoc_arg *args,                  enum mdoct tok, struct mdoc_arg *args)
                 size_t paramsz, const char **params)  
 {  {
         struct mdoc_node *p;          struct mdoc_node *p;
   
         p = xcalloc(1, sizeof(struct mdoc_node));          p = node_alloc(m, line, pos, tok, MDOC_BLOCK);
         p->type = MDOC_ELEM;          p->args = args;
         p->data.elem.tok = tok;          if (p->args)
         p->data.elem.sz = paramsz;                  (args->refcnt)++;
         p->data.elem.args = paramdup(paramsz, params);  
         p->data.elem.argc = argsz;  
         p->data.elem.argv = argdup(argsz, args);  
   
         mdoc_node_append(mdoc, pos, p);          switch (tok) {
           case (MDOC_Bd):
                   /* FALLTHROUGH */
           case (MDOC_Bf):
                   /* FALLTHROUGH */
           case (MDOC_Bl):
                   /* FALLTHROUGH */
           case (MDOC_Rs):
                   p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
                   break;
           default:
                   break;
           }
   
           if ( ! node_append(m, p))
                   return(0);
           m->next = MDOC_NEXT_CHILD;
           return(1);
 }  }
   
   
 void  int
 mdoc_word_alloc(struct mdoc *mdoc, int pos, const char *word)  mdoc_elem_alloc(struct mdoc *m, int line, int pos,
                   enum mdoct tok, struct mdoc_arg *args)
 {  {
         struct mdoc_node *p;          struct mdoc_node *p;
   
         p = xcalloc(1, sizeof(struct mdoc_node));          p = node_alloc(m, line, pos, tok, MDOC_ELEM);
         p->type = MDOC_TEXT;          p->args = args;
         p->data.text.string = xstrdup(word);          if (p->args)
                   (args->refcnt)++;
   
         mdoc_node_append(mdoc, pos, p);          switch (tok) {
           case (MDOC_An):
                   p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
                   break;
           default:
                   break;
           }
   
           if ( ! node_append(m, p))
                   return(0);
           m->next = MDOC_NEXT_CHILD;
           return(1);
 }  }
   
   static int
 static void  mdoc_span_alloc(struct mdoc *m, const struct tbl_span *sp)
 argfree(size_t sz, struct mdoc_arg *p)  
 {  {
         int              i, j;          struct mdoc_node *n;
   
         if (0 == sz)          n = node_alloc(m, sp->line, 0, MDOC_MAX, MDOC_TBL);
                 return;          n->span = sp;
   
         assert(p);          if ( ! node_append(m, n))
         /* LINTED */                  return(0);
         for (i = 0; i < (int)sz; i++)  
                 if (p[i].sz > 0) {          m->next = MDOC_NEXT_SIBLING;
                         assert(p[i].value);          return(1);
                         /* LINTED */  
                         for (j = 0; j < (int)p[i].sz; j++)  
                                 free(p[i].value[j]);  
                 }  
         free(p);  
 }  }
   
   
 static void  int
 mdoc_elem_free(struct mdoc_elem *p)  mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p)
 {  {
           struct mdoc_node *n;
           size_t            sv, len;
   
         paramfree(p->sz, p->args);          len = strlen(p);
         argfree(p->argc, p->argv);  
 }  
   
           n = node_alloc(m, line, pos, MDOC_MAX, MDOC_TEXT);
           n->string = mandoc_malloc(len + 1);
           sv = strlcpy(n->string, p, len + 1);
   
 static void          /* Prohibit truncation. */
 mdoc_block_free(struct mdoc_block *p)          assert(sv < len + 1);
 {  
   
         argfree(p->argc, p->argv);          if ( ! node_append(m, n))
                   return(0);
   
           m->next = MDOC_NEXT_SIBLING;
           return(1);
 }  }
   
   
 static void  static void
 mdoc_text_free(struct mdoc_text *p)  mdoc_node_free(struct mdoc_node *p)
 {  {
   
           if (MDOC_BLOCK == p->type || MDOC_ELEM == p->type)
                   free(p->norm);
         if (p->string)          if (p->string)
                 free(p->string);                  free(p->string);
           if (p->args)
                   mdoc_argv_free(p->args);
           free(p);
 }  }
   
   
 static void  static void
 mdoc_head_free(struct mdoc_head *p)  mdoc_node_unlink(struct mdoc *m, struct mdoc_node *n)
 {  {
   
         paramfree(p->sz, p->args);          /* Adjust siblings. */
 }  
   
           if (n->prev)
                   n->prev->next = n->next;
           if (n->next)
                   n->next->prev = n->prev;
   
 void          /* Adjust parent. */
 mdoc_node_free(struct mdoc_node *p)  
 {  
   
         switch (p->type) {          if (n->parent) {
         case (MDOC_TEXT):                  n->parent->nchild--;
                 mdoc_text_free(&p->data.text);                  if (n->parent->child == n)
                 break;                          n->parent->child = n->prev ? n->prev : n->next;
         case (MDOC_ELEM):                  if (n->parent->last == n)
                 mdoc_elem_free(&p->data.elem);                          n->parent->last = n->prev ? n->prev : NULL;
                 break;  
         case (MDOC_BLOCK):  
                 mdoc_block_free(&p->data.block);  
                 break;  
         case (MDOC_HEAD):  
                 mdoc_head_free(&p->data.head);  
                 break;  
         default:  
                 break;  
         }          }
   
         free(p);          /* Adjust parse point, if applicable. */
   
           if (m && m->last == n) {
                   if (n->prev) {
                           m->last = n->prev;
                           m->next = MDOC_NEXT_SIBLING;
                   } else {
                           m->last = n->parent;
                           m->next = MDOC_NEXT_CHILD;
                   }
           }
   
           if (m && m->first == n)
                   m->first = NULL;
 }  }
   
   
 static void  void
 mdoc_node_freelist(struct mdoc_node *p)  mdoc_node_delete(struct mdoc *m, struct mdoc_node *p)
 {  {
   
         if (p->child)          while (p->child) {
                 mdoc_node_freelist(p->child);                  assert(p->nchild);
         if (p->next)                  mdoc_node_delete(m, p->child);
                 mdoc_node_freelist(p->next);          }
           assert(0 == p->nchild);
   
           mdoc_node_unlink(m, p);
         mdoc_node_free(p);          mdoc_node_free(p);
 }  }
   
   
 int  /*
 mdoc_find(const struct mdoc *mdoc, const char *key)   * Parse free-form text, that is, a line that does not begin with the
    * control character.
    */
   static int
   mdoc_ptext(struct mdoc *m, int line, char *buf, int offs)
 {  {
           char             *c, *ws, *end;
           struct mdoc_node *n;
   
         return(mdoc_tokhash_find(mdoc->htab, key));          /* Ignore bogus comments. */
 }  
   
           if ('\\' == buf[offs] &&
                           '.' == buf[offs + 1] &&
                           '"' == buf[offs + 2]) {
                   mdoc_pmsg(m, line, offs, MANDOCERR_BADCOMMENT);
                   return(1);
           }
   
 static void          /* No text before an initial macro. */
 argcpy(struct mdoc_arg *dst, const struct mdoc_arg *src)  
 {  
         int              i;  
   
         dst->arg = src->arg;          if (SEC_NONE == m->lastnamed) {
         if (0 == (dst->sz = src->sz))                  mdoc_pmsg(m, line, offs, MANDOCERR_NOTEXT);
                 return;                  return(1);
         dst->value = xcalloc(dst->sz, sizeof(char *));          }
         for (i = 0; i < (int)dst->sz; i++)  
                 dst->value[i] = xstrdup(src->value[i]);  
 }  
   
           assert(m->last);
           n = m->last;
   
 static struct mdoc_arg *          /*
 argdup(size_t argsz, const struct mdoc_arg *args)           * Divert directly to list processing if we're encountering a
 {           * columnar MDOC_BLOCK with or without a prior MDOC_BLOCK entry
         struct mdoc_arg *pp;           * (a MDOC_BODY means it's already open, in which case we should
         int              i;           * process within its context in the normal way).
            */
   
         if (0 == argsz)          if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
                 return(NULL);                          LIST_column == n->norm->Bl.type) {
                   /* `Bl' is open without any children. */
                   m->flags |= MDOC_FREECOL;
                   return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf));
           }
   
         pp = xcalloc((size_t)argsz, sizeof(struct mdoc_arg));          if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
         for (i = 0; i < (int)argsz; i++)                          NULL != n->parent &&
                 argcpy(&pp[i], &args[i]);                          MDOC_Bl == n->parent->tok &&
                           LIST_column == n->parent->norm->Bl.type) {
                   /* `Bl' has block-level `It' children. */
                   m->flags |= MDOC_FREECOL;
                   return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf));
           }
   
         return(pp);          /*
 }           * 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';
   
 static void          if (ws)
 paramfree(size_t sz, char **p)                  mdoc_pmsg(m, line, (int)(ws-buf), MANDOCERR_EOLNSPACE);
 {  
         int              i;  
   
         if (0 == sz)          if ('\0' == buf[offs] && ! (MDOC_LITERAL & m->flags)) {
                 return;                  mdoc_pmsg(m, line, (int)(c-buf), MANDOCERR_NOBLANKLN);
   
         assert(p);                  /*
         /* LINTED */                   * Insert a `sp' in the case of a blank line.  Technically,
         for (i = 0; i < (int)sz; i++)                   * blank lines aren't allowed, but enough manuals assume this
                 free(p[i]);                   * behaviour that we want to work around it.
         free(p);                   */
                   if ( ! mdoc_elem_alloc(m, line, offs, MDOC_sp, NULL))
                           return(0);
   
                   m->next = MDOC_NEXT_SIBLING;
                   return(1);
           }
   
           if ( ! mdoc_word_alloc(m, line, offs, buf+offs))
                   return(0);
   
           if (MDOC_LITERAL & m->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), 0))
                   m->last->flags |= MDOC_EOS;
   
           return(1);
 }  }
   
   
 static char **  /*
 paramdup(size_t sz, const char **p)   * Parse a macro line, that is, a line beginning with the control
    * character.
    */
   static int
   mdoc_pmacro(struct mdoc *m, int ln, char *buf, int offs)
 {  {
         char            **pp;          enum mdoct        tok;
         int               i;          int               i, j, sv;
           char              mac[5];
           struct mdoc_node *n;
   
         if (0 == sz)          /* Empty lines are ignored. */
                 return(NULL);  
   
         pp = xcalloc(sz, sizeof(char *));          offs++;
         for (i = 0; i < (int)sz; i++)  
                 pp[i] = xstrdup(p[i]);  
   
         return(pp);          if ('\0' == buf[offs])
                   return(1);
   
           i = offs;
   
           /* Accept tabs/whitespace after the initial control char. */
   
           if (' ' == buf[i] || '\t' == buf[i]) {
                   i++;
                   while (buf[i] && (' ' == buf[i] || '\t' == buf[i]))
                           i++;
                   if ('\0' == buf[i])
                           return(1);
           }
   
           sv = i;
   
           /*
            * Copy the first word into a nil-terminated buffer.
            * Stop copying when a tab, space, or eoln is encountered.
            */
   
           j = 0;
           while (j < 4 && '\0' != buf[i] && ' ' != buf[i] && '\t' != buf[i])
                   mac[j++] = buf[i++];
           mac[j] = '\0';
   
           tok = (j > 1 || j < 4) ? mdoc_hash_find(mac) : MDOC_MAX;
           if (MDOC_MAX == tok) {
                   mdoc_vmsg(m, MANDOCERR_MACRO, ln, sv, "%s", buf + sv - 1);
                   return(1);
           }
   
           /* Disregard the first trailing tab, if applicable. */
   
           if ('\t' == buf[i])
                   i++;
   
           /* Jump to the next non-whitespace word. */
   
           while (buf[i] && ' ' == buf[i])
                   i++;
   
           /*
            * Trailing whitespace.  Note that tabs are allowed to be passed
            * into the parser as "text", so we only warn about spaces here.
            */
   
           if ('\0' == buf[i] && ' ' == buf[i - 1])
                   mdoc_pmsg(m, ln, i - 1, MANDOCERR_EOLNSPACE);
   
           /*
            * If an initial macro or a list invocation, divert directly
            * 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->norm->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->norm->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))
                   goto err;
   
           return(1);
   
   err:    /* Error out. */
   
           m->flags |= MDOC_HALT;
           return(0);
 }  }
   
   
Legend:
Removed from v.1.8  
changed lines
  Added in v.1.178
CVSweb