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

Diff for /mandoc/mdoc.c between version 1.6 and 1.128

version 1.6, 2008/12/28 21:25:09 version 1.128, 2010/05/12 16:01:01
Line 1 
Line 1 
 /* $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>   * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *   *
  * 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 <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 "libmdoc.h"
   #include "libmandoc.h"
   
   const   char *const __mdoc_merrnames[MERRMAX] = {
           "trailing whitespace", /* ETAILWS */
           "unexpected quoted parameter", /* EQUOTPARM */
           "unterminated quoted parameter", /* EQUOTTERM */
           "argument parameter suggested", /* EARGVAL */
           "macro disallowed in prologue", /* EBODYPROL */
           "macro disallowed in body", /* EPROLBODY */
           "text disallowed in prologue", /* ETEXTPROL */
           "blank line disallowed", /* ENOBLANK */
           "text parameter too long", /* ETOOLONG */
           "invalid escape sequence", /* EESCAPE */
           "invalid character", /* EPRINT */
           "document has no body", /* ENODAT */
           "document has no prologue", /* ENOPROLOGUE */
           "expected line arguments", /* ELINE */
           "invalid AT&T argument", /* EATT */
           "default name not yet set", /* ENAME */
           "missing list type", /* ELISTTYPE */
           "missing display type", /* EDISPTYPE */
           "too many display types", /* EMULTIDISP */
           "too many list types", /* EMULTILIST */
           "NAME section must be first", /* ESECNAME */
           "badly-formed NAME section", /* ENAMESECINC */
           "argument repeated", /* EARGREP */
           "expected boolean parameter", /* EBOOL */
           "inconsistent column syntax", /* ECOLMIS */
           "nested display invalid", /* ENESTDISP */
           "width argument missing", /* EMISSWIDTH */
           "invalid section for this manual section", /* EWRONGMSEC */
           "section out of conventional order", /* ESECOOO */
           "section repeated", /* ESECREP */
           "invalid standard argument", /* EBADSTAND */
           "multi-line arguments discouraged", /* ENOMULTILINE */
           "multi-line arguments suggested", /* EMULTILINE */
           "line arguments discouraged", /* ENOLINE */
           "prologue macro out of conventional order", /* EPROLOOO */
           "prologue macro repeated", /* EPROLREP */
           "invalid manual section", /* EBADMSEC */
           "invalid section", /* EBADSEC */
           "invalid font mode", /* EFONT */
           "invalid date syntax", /* EBADDATE */
           "invalid number format", /* ENUMFMT */
           "superfluous width argument", /* ENOWIDTH */
           "system: utsname error", /* EUTSNAME */
           "obsolete macro", /* EOBS */
           "end-of-line scope violation", /* EIMPBRK */
           "empty macro ignored", /* EIGNE */
           "unclosed explicit scope", /* EOPEN */
           "unterminated quoted phrase", /* EQUOTPHR */
           "closure macro without prior context", /* ENOCTX */
           "no description found for library", /* ELIB */
           "bad child for parent context", /* EBADCHILD */
           "list arguments preceding type", /* ENOTYPE */
           "deprecated comment style", /* EBADCOMMENT */
   };
   
 const   char *const __mdoc_macronames[MDOC_MAX] = {  const   char *const __mdoc_macronames[MDOC_MAX] = {
         "\\\"",         "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 99  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 117  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"
         };          };
   
 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 135  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 */  
         { NULL, 0 }, /* Aq */  
         { NULL, 0 }, /* At */  
         { NULL, 0 }, /* Bc */  
         { NULL, 0 }, /* Bf */  
         { NULL, 0 }, /* Bo */  
         { NULL, 0 }, /* Bq */  
         { NULL, 0 }, /* Bsx */  
         { NULL, 0 }, /* Bx */  
         { NULL, 0 }, /* Db */  
         { NULL, 0 }, /* Dc */  
         { NULL, 0 }, /* Do */  
         { NULL, 0 }, /* Dq */  
         { NULL, 0 }, /* Ec */  
         { NULL, 0 }, /* Ef */  
         { macro_text, MDOC_CALLABLE }, /* Em */  
         { NULL, 0 }, /* Eo */  
         { NULL, 0 }, /* Fx */  
         { macro_text, 0 }, /* Ms */  
         { NULL, 0 }, /* No */  
         { NULL, 0 }, /* Ns */  
         { NULL, 0 }, /* Nx */  
         { NULL, 0 }, /* Ox */  
         { NULL, 0 }, /* Pc */  
         { NULL, 0 }, /* Pf */  
         { NULL, 0 }, /* Po */  
         { NULL, 0 }, /* Pq */  
         { NULL, 0 }, /* Qc */  
         { NULL, 0 }, /* Ql */  
         { NULL, 0 }, /* Qo */  
         { macro_scoped_pline, MDOC_CALLABLE }, /* Qq */  
         { NULL, 0 }, /* Re */  
         { NULL, 0 }, /* Rs */  
         { NULL, 0 }, /* Sc */  
         { NULL, 0 }, /* So */  
         { NULL, 0 }, /* Sq */  
         { NULL, 0 }, /* Sm */  
         { NULL, 0 }, /* Sx */  
         { NULL, 0 }, /* Sy */  
         { macro_text, MDOC_CALLABLE }, /* Tn */  
         { NULL, 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 *);
   static  int               mdoc_pmacro(struct mdoc *, int, char *);
   static  int               macrowarn(struct mdoc *, int, const char *);
   
   
 const struct mdoc_node *  const struct mdoc_node *
 mdoc_result(struct mdoc *mdoc)  mdoc_node(const struct mdoc *m)
 {  {
   
         return(mdoc->first);          return(MDOC_HALT & m->flags ? NULL : m->first);
 }  }
   
   
   const struct mdoc_meta *
   mdoc_meta(const struct mdoc *m)
   {
   
           return(MDOC_HALT & m->flags ? NULL : &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);
   }
   
   
   /*
    * 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(void *data, int pflags, const struct mdoc_cb *cb)
 {  {
         struct mdoc     *p;          struct mdoc     *p;
   
         p = xcalloc(1, sizeof(struct mdoc));          p = mandoc_calloc(1, sizeof(struct mdoc));
   
           if (cb)
                   memcpy(&p->cb, cb, sizeof(struct mdoc_cb));
   
         p->data = data;          p->data = data;
         (void)memcpy(&p->cb, cb, sizeof(struct mdoc_cb));          p->pflags = pflags;
   
         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) {          if (MDOC_HALT & m->flags)
                 mdoc_word_alloc(mdoc, 0, buf);                  return(0);
           else if (mdoc_macroend(m))
                 return(1);                  return(1);
         }          m->flags |= MDOC_HALT;
           return(0);
   }
   
         if (buf[1] && '\\' == buf[1])  
                 if (buf[2] && '\"' == buf[2])  
                         return(1);  
   
         i = 1;  /*
         while (buf[i] && ! isspace(buf[i]) && i < (int)sizeof(tmp))   * Main parse routine.  Parses a single line -- really just hands off to
                 i++;   * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()).
    */
   int
   mdoc_parseln(struct mdoc *m, int ln, char *buf)
   {
   
         if (i == (int)sizeof(tmp))          if (MDOC_HALT & m->flags)
                 return(mdoc_err(mdoc, -1, 1, ERR_MACRO_NOTSUP));                  return(0);
         else if (i <= 2)  
                 return(mdoc_err(mdoc, -1, 1, ERR_MACRO_NOTSUP));  
   
         i--;          return('.' == *buf ? mdoc_pmacro(m, ln, buf) :
                           mdoc_ptext(m, ln, buf));
         (void)memcpy(tmp, buf + 1, (size_t)i);  
         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  int
 mdoc_msg(struct mdoc *mdoc, int pos, const char *fmt, ...)  mdoc_verr(struct mdoc *mdoc, int ln, int pos,
                   const char *fmt, ...)
 {  {
         va_list          ap;  
         char             buf[256];          char             buf[256];
           va_list          ap;
   
         if (NULL == mdoc->cb.mdoc_msg)          if (NULL == mdoc->cb.mdoc_err)
                 return;                  return(0);
   
         va_start(ap, fmt);          va_start(ap, fmt);
         (void)vsnprintf(buf, sizeof(buf), fmt, ap);          (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
         va_end(ap);          va_end(ap);
   
         (*mdoc->cb.mdoc_msg)(mdoc->data, pos, buf);          return((*mdoc->cb.mdoc_err)(mdoc->data, ln, pos, buf));
 }  }
   
   
 int  int
 mdoc_err(struct mdoc *mdoc, int tok, int pos, enum mdoc_err type)  mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, const char *fmt, ...)
 {  {
           char             buf[256];
           va_list          ap;
   
         if (NULL == mdoc->cb.mdoc_err)          if (NULL == mdoc->cb.mdoc_warn)
                 return(0);                  return(0);
         return((*mdoc->cb.mdoc_err)(mdoc->data, tok, pos, type));  
           va_start(ap, fmt);
           (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
           va_end(ap);
   
           return((*mdoc->cb.mdoc_warn)(mdoc->data, ln, pos, buf));
 }  }
   
   
 int  int
 mdoc_warn(struct mdoc *mdoc, int tok, int pos, enum mdoc_warn type)  mdoc_err(struct mdoc *m, int line, int pos, int iserr, enum merr type)
 {  {
           const char      *p;
   
         if (NULL == mdoc->cb.mdoc_warn)          p = __mdoc_merrnames[(int)type];
                 return(0);          assert(p);
         return((*mdoc->cb.mdoc_warn)(mdoc->data, tok, pos, type));  
           if (iserr)
                   return(mdoc_verr(m, line, pos, p));
   
           return(mdoc_vwarn(m, line, pos, p));
 }  }
   
   
 int  int
 mdoc_macro(struct mdoc *mdoc, int tok, int ppos, int *pos, char *buf)  mdoc_macro(struct mdoc *m, enum mdoct tok,
                   int ln, int pp, int *pos, char *buf)
 {  {
           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);                  return(mdoc_perr(m, ln, pp, EPROLBODY));
         }  
   
         /*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)) {
                   if ( ! mdoc_pwarn(m, ln, pp, EBODYPROL))
                           return(0);
                   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, ln, pp, 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) {          if ( ! mdoc_valid_pre(mdoc, p))
         case (MDOC_TEXT):                  return(0);
                 on = "<text>";          if ( ! mdoc_action_pre(mdoc, p))
                 ot = "text";                  return(0);
                 break;  
         case (MDOC_BODY):          switch (p->type) {
                 on = mdoc_macronames[mdoc->last->data.body.tok];  
                 ot = "body";  
                 break;  
         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];                  assert(MDOC_BLOCK == p->parent->type);
                 ot = "head";                  p->parent->head = p;
                 break;                  break;
         case (MDOC_BLOCK):          case (MDOC_TAIL):
                 on = mdoc_macronames[mdoc->last->data.block.tok];                  assert(MDOC_BLOCK == p->parent->type);
                 ot = "block";                  p->parent->tail = p;
                 break;                  break;
           case (MDOC_BODY):
                   assert(MDOC_BLOCK == p->parent->type);
                   p->parent->body = p;
                   break;
         default:          default:
                 abort();                  break;
                 /* NOTREACHED */  
         }          }
   
           mdoc->last = p;
   
         switch (p->type) {          switch (p->type) {
         case (MDOC_BODY):          case (MDOC_TEXT):
                 p->parent = mdoc->last->parent;                  if ( ! mdoc_valid_post(mdoc))
                 mdoc->last->next = p;                          return(0);
                 p->prev = mdoc->last;                  if ( ! mdoc_action_post(mdoc))
                 act = "sibling";                          return(0);
                 break;                  break;
   
         case (MDOC_HEAD):  
                 assert(mdoc->last->type == MDOC_BLOCK);  
                 p->parent = mdoc->last;  
                 mdoc->last->child = p;  
                 act = "child";  
                 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));          return(p);
         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);  
 }  }
   
   
 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;  
         p->data.body.tok = tok;  
   
         mdoc_node_append(mdoc, pos, p);  
 }  }
   
   
 void  int
 mdoc_block_alloc(struct mdoc *mdoc, int pos, int tok,  mdoc_head_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));          assert(m->first);
           assert(m->last);
   
         p->type = MDOC_BLOCK;          p = node_alloc(m, line, pos, tok, MDOC_HEAD);
         p->data.block.tok = tok;          if ( ! node_append(m, p))
         p->data.block.argc = argsz;                  return(0);
         p->data.block.argv = argdup(argsz, args);          m->next = MDOC_NEXT_CHILD;
           return(1);
         mdoc_node_append(mdoc, pos, p);  
 }  }
   
   
 void  int
 mdoc_elem_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,  
                 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_BODY);
         p->type = MDOC_ELEM;          if ( ! node_append(m, p))
         p->data.elem.tok = tok;                  return(0);
         p->data.elem.sz = paramsz;          m->next = MDOC_NEXT_CHILD;
         p->data.elem.args = paramdup(paramsz, params);          return(1);
         p->data.elem.argc = argsz;  
         p->data.elem.argv = argdup(argsz, args);  
   
         mdoc_node_append(mdoc, pos, p);  
 }  }
   
   
 void  int
 mdoc_word_alloc(struct mdoc *mdoc, int pos, const char *word)  mdoc_block_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_BLOCK);
         p->type = MDOC_TEXT;          p->args = args;
         p->data.text.string = xstrdup(word);          if (p->args)
                   (args->refcnt)++;
         mdoc_node_append(mdoc, pos, p);          if ( ! node_append(m, p))
                   return(0);
           m->next = MDOC_NEXT_CHILD;
           return(1);
 }  }
   
   
 static void  int
 argfree(size_t sz, struct mdoc_arg *p)  mdoc_elem_alloc(struct mdoc *m, int line, int pos,
                   enum mdoct tok, struct mdoc_arg *args)
 {  {
         int              i, j;          struct mdoc_node *p;
   
         if (0 == sz)          p = node_alloc(m, line, pos, tok, MDOC_ELEM);
                 return;          p->args = args;
           if (p->args)
         assert(p);                  (args->refcnt)++;
         /* LINTED */          if ( ! node_append(m, p))
         for (i = 0; i < (int)sz; i++)                  return(0);
                 if (p[i].sz > 0) {          m->next = MDOC_NEXT_CHILD;
                         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  void
 mdoc_text_free(struct mdoc_text *p)  mdoc_node_free(struct mdoc_node *p)
 {  {
   
         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;
   
           /* Adjust parent. */
   
           if (n->parent) {
                   n->parent->nchild--;
                   if (n->parent->child == n)
                           n->parent->child = n->prev ? n->prev : n->next;
           }
   
           /* 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;
 }  }
   
   
 void  void
 mdoc_node_free(struct mdoc_node *p)  mdoc_node_delete(struct mdoc *m, struct mdoc_node *p)
 {  {
   
         switch (p->type) {          while (p->child) {
         case (MDOC_TEXT):                  assert(p->nchild);
                 mdoc_text_free(&p->data.text);                  mdoc_node_delete(m, p->child);
           }
           assert(0 == p->nchild);
   
           mdoc_node_unlink(m, p);
           mdoc_node_free(p);
   }
   
   
   /*
    * 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              i;
   
           /* Ignore bogus comments. */
   
           if ('\\' == buf[0] && '.' == buf[1] && '\"' == buf[2])
                   return(mdoc_pwarn(m, line, 0, EBADCOMMENT));
   
           /* No text before an initial macro. */
   
           if (SEC_NONE == m->lastnamed)
                   return(mdoc_perr(m, line, 0, ETEXTPROL));
   
           /* Literal just gets pulled in as-is. */
   
           if (MDOC_LITERAL & m->flags)
                   return(mdoc_word_alloc(m, line, 0, buf));
   
           /* Check for a blank line, which may also consist of spaces. */
   
           for (i = 0; ' ' == buf[i]; i++)
                   /* Skip to first non-space. */ ;
   
           if ('\0' == buf[i]) {
                   if ( ! mdoc_pwarn(m, line, 0, ENOBLANK))
                           return(0);
   
                   /*
                    * Insert a `Pp' 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(m, line, 0, MDOC_Pp, NULL))
                           return(0);
   
                   m->next = MDOC_NEXT_SIBLING;
                   return(1);
           }
   
           /*
            * Warn if the last un-escaped character is whitespace. Then
            * strip away the remaining spaces (tabs stay!).
            */
   
           i = (int)strlen(buf);
           assert(i);
   
           if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {
                   if (i > 1 && '\\' != buf[i - 2])
                           if ( ! mdoc_pwarn(m, line, i - 1, ETAILWS))
                                   return(0);
   
                   for (--i; i && ' ' == buf[i]; i--)
                           /* Spin back to non-space. */ ;
   
                   /* Jump ahead of escaped whitespace. */
                   i += '\\' == buf[i] ? 2 : 1;
   
                   buf[i] = '\0';
           }
   
           /* Allocate the whole word. */
   
           if ( ! mdoc_word_alloc(m, line, 0, buf))
                   return(0);
   
           /*
            * 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(i);
   
           switch (buf[i - 1]) {
           case ('.'):
                   if (i > 1 && '\\' == buf[i - 2])
                           break;
                   /* FALLTHROUGH */
           case ('!'):
                   /* FALLTHROUGH */
           case ('?'):
                   m->last->flags |= MDOC_EOS;
                 break;                  break;
         case (MDOC_ELEM):  
                 mdoc_elem_free(&p->data.elem);  
                 break;  
         case (MDOC_BLOCK):  
                 mdoc_block_free(&p->data.block);  
                 break;  
         case (MDOC_HEAD):  
                 mdoc_head_free(&p->data.head);  
                 break;  
         default:          default:
                 break;                  break;
   
         }          }
   
         free(p);          return(1);
 }  }
   
   
 static void  static int
 mdoc_node_freelist(struct mdoc_node *p)  macrowarn(struct mdoc *m, int ln, const char *buf)
 {  {
           if ( ! (MDOC_IGN_MACRO & m->pflags))
         if (p->child)                  return(mdoc_verr(m, ln, 0, "unknown macro: %s%s",
                 mdoc_node_freelist(p->child);                                  buf, strlen(buf) > 3 ? "..." : ""));
         if (p->next)          return(mdoc_vwarn(m, ln, 0, "unknown macro: %s%s",
                 mdoc_node_freelist(p->next);                                  buf, strlen(buf) > 3 ? "..." : ""));
   
         mdoc_node_free(p);  
 }  }
   
   
   /*
    * Parse a macro line, that is, a line beginning with the control
    * character.
    */
 int  int
 mdoc_find(const struct mdoc *mdoc, const char *key)  mdoc_pmacro(struct mdoc *m, int ln, char *buf)
 {  {
           enum mdoct      tok;
           int             i, j;
           char            mac[5];
   
         return(mdoc_tokhash_find(mdoc->htab, key));          /* Empty lines are ignored. */
 }  
   
           if ('\0' == buf[1])
                   return(1);
   
 static void          i = 1;
 argcpy(struct mdoc_arg *dst, const struct mdoc_arg *src)  
 {  
         int              i;  
   
         dst->arg = src->arg;          /* Accept whitespace after the initial control char. */
         if (0 == (dst->sz = src->sz))  
                 return;  
         dst->value = xcalloc(dst->sz, sizeof(char *));  
         for (i = 0; i < (int)dst->sz; i++)  
                 dst->value[i] = xstrdup(src->value[i]);  
 }  
   
           if (' ' == buf[i]) {
                   i++;
                   while (buf[i] && ' ' == buf[i])
                           i++;
                   if ('\0' == buf[i])
                           return(1);
           }
   
 static struct mdoc_arg *          /* Copy the first word into a nil-terminated buffer. */
 argdup(size_t argsz, const struct mdoc_arg *args)  
 {  
         struct mdoc_arg *pp;  
         int              i;  
   
         if (0 == argsz)          for (j = 0; j < 4; j++, i++) {
                 return(NULL);                  if ('\0' == (mac[j] = buf[i]))
                           break;
                   else if (' ' == buf[i])
                           break;
   
         pp = xcalloc((size_t)argsz, sizeof(struct mdoc_arg));                  /* Check for invalid characters. */
         for (i = 0; i < (int)argsz; i++)  
                 argcpy(&pp[i], &args[i]);  
   
         return(pp);                  if (isgraph((u_char)buf[i]))
 }                          continue;
                   return(mdoc_perr(m, ln, i, EPRINT));
           }
   
           mac[j] = 0;
   
 static void          if (j == 4 || j < 2) {
 paramfree(size_t sz, char **p)                  if ( ! macrowarn(m, ln, mac))
 {                          goto err;
         int              i;                  return(1);
           }
   
           if (MDOC_MAX == (tok = mdoc_hash_find(mac))) {
                   if ( ! macrowarn(m, ln, mac))
                           goto err;
                   return(1);
           }
   
         if (0 == sz)          /* The macro is sane.  Jump to the next word. */
                 return;  
   
         assert(p);          while (buf[i] && ' ' == buf[i])
         /* LINTED */                  i++;
         for (i = 0; i < (int)sz; i++)  
                 free(p[i]);  
         free(p);  
 }  
   
           /*
            * Trailing whitespace.  Note that tabs are allowed to be passed
            * into the parser as "text", so we only warn about spaces here.
            */
   
 static char **          if ('\0' == buf[i] && ' ' == buf[i - 1])
 paramdup(size_t sz, const char **p)                  if ( ! mdoc_pwarn(m, ln, i - 1, ETAILWS))
 {                          goto err;
         char            **pp;  
         int               i;  
   
         if (0 == sz)          /*
                 return(NULL);           * Begin recursive parse sequence.  Since we're at the start of
            * the line, we don't need to do callable/parseable checks.
            */
           if ( ! mdoc_macro(m, tok, ln, 1, &i, buf))
                   goto err;
   
         pp = xcalloc(sz, sizeof(char *));          return(1);
         for (i = 0; i < (int)sz; i++)  
                 pp[i] = xstrdup(p[i]);  
   
         return(pp);  err:    /* Error out. */
   
           m->flags |= MDOC_HALT;
           return(0);
 }  }
   
   
Legend:
Removed from v.1.6  
changed lines
  Added in v.1.128
CVSweb