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

Diff for /mandoc/mdoc.c between version 1.74 and 1.208

version 1.74, 2009/04/02 06:51:44 version 1.208, 2014/01/05 20:26:36
Line 1 
Line 1 
 /* $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>   * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
    * Copyright (c) 2010, 2012, 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
  *   *
  * Permission to use, copy, modify, and distribute this software for any   * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the   * purpose with or without fee is hereby granted, provided that the above
  * above copyright notice and this permission notice appear in all   * copyright notice and this permission notice appear in all copies.
  * copies.  
  *   *
  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL   * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED   * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE   * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL   * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR   * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR   * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  * PERFORMANCE OF THIS SOFTWARE.  
  */   */
   #ifdef HAVE_CONFIG_H
   #include "config.h"
   #endif
   
   #include <sys/types.h>
   
 #include <assert.h>  #include <assert.h>
 #include <ctype.h>  
 #include <stdarg.h>  #include <stdarg.h>
 #include <stdio.h>  #include <stdio.h>
 #include <stdlib.h>  #include <stdlib.h>
 #include <string.h>  #include <string.h>
   #include <time.h>
   
   #include "mdoc.h"
   #include "mandoc.h"
 #include "libmdoc.h"  #include "libmdoc.h"
   #include "libmandoc.h"
   
 enum    merr {  
         ENOCALL,  
         EBODYPROL,  
         EPROLBODY,  
         ESPACE,  
         ETEXTPROL,  
         ENOBLANK,  
         EMALLOC  
 };  
   
 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 47  const char *const __mdoc_macronames[MDOC_MAX] = {   
Line 45  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 65  const char *const __mdoc_macronames[MDOC_MAX] = {   
Line 63  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",           "Lb",           "Ap",          "Fr",           "Ud",           "Lb",           "Lp",
         "Lp",           "Lk",           "Mt",           "Brq",          "Lk",           "Mt",           "Brq",          "Bro",
         /* LINTED */          /* LINTED */
         "Bro",          "Brc",          "\%C",          "Es",          "Brc",          "%C",           "Es",           "En",
         /* LINTED */          /* LINTED */
         "En",           "Dx",           "\%Q"          "Dx",           "%Q",           "br",           "sp",
           /* LINTED */
           "%U",           "Ta"
         };          };
   
 const   char *const __mdoc_argnames[MDOC_ARG_MAX] = {  const   char *const __mdoc_argnames[MDOC_ARG_MAX] = {
Line 82  const char *const __mdoc_argnames[MDOC_ARG_MAX] = {   
Line 82  const char *const __mdoc_argnames[MDOC_ARG_MAX] = {   
         "ohang",                "inset",                "column",          "ohang",                "inset",                "column",
         "width",                "compact",              "std",          "width",                "compact",              "std",
         "filled",               "words",                "emphasis",          "filled",               "words",                "emphasis",
         "symbolic",             "nested"          "symbolic",             "nested",               "centered"
         };          };
   
 const   char * const *mdoc_macronames = __mdoc_macronames;  const   char * const *mdoc_macronames = __mdoc_macronames;
 const   char * const *mdoc_argnames = __mdoc_argnames;  const   char * const *mdoc_argnames = __mdoc_argnames;
   
   static  void              mdoc_node_free(struct mdoc_node *);
   static  void              mdoc_node_unlink(struct mdoc *,
                                   struct mdoc_node *);
 static  void              mdoc_free1(struct mdoc *);  static  void              mdoc_free1(struct mdoc *);
 static  int               mdoc_alloc1(struct mdoc *);  static  void              mdoc_alloc1(struct mdoc *);
 static  struct mdoc_node *node_alloc(struct mdoc *, int, int,  static  struct mdoc_node *node_alloc(struct mdoc *, int, int,
                                 int, enum mdoc_type);                                  enum mdoct, enum mdoc_type);
 static  int               node_append(struct mdoc *,  static  int               node_append(struct mdoc *,
                                 struct mdoc_node *);                                  struct mdoc_node *);
 static  int               parsetext(struct mdoc *, int, char *);  #if 0
 static  int               parsemacro(struct mdoc *, int, char *);  static  int               mdoc_preptext(struct mdoc *, int, char *, int);
 static  int               macrowarn(struct mdoc *, int, const char *);  #endif
 static  int               perr(struct mdoc *, int, int, enum merr);  static  int               mdoc_ptext(struct mdoc *, int, char *, int);
   static  int               mdoc_pmacro(struct mdoc *, int, char *, int);
   
 #define verr(m, t) perr((m), (m)->last->line, (m)->last->pos, (t))  
   
 /*  
  * Get the first (root) node of the parse tree.  
  */  
 const struct mdoc_node *  const struct mdoc_node *
 mdoc_node(const struct mdoc *m)  mdoc_node(const struct mdoc *mdoc)
 {  {
   
         return(MDOC_HALT & m->flags ? NULL : m->first);          assert( ! (MDOC_HALT & mdoc->flags));
           return(mdoc->first);
 }  }
   
   
 const struct mdoc_meta *  const struct mdoc_meta *
 mdoc_meta(const struct mdoc *m)  mdoc_meta(const struct mdoc *mdoc)
 {  {
   
         return(MDOC_HALT & m->flags ? NULL : &m->meta);          assert( ! (MDOC_HALT & mdoc->flags));
           return(&mdoc->meta);
 }  }
   
   
   /*
    * Frees volatile resources (parse tree, meta-data, fields).
    */
 static void  static void
 mdoc_free1(struct mdoc *mdoc)  mdoc_free1(struct mdoc *mdoc)
 {  {
   
         if (mdoc->first)          if (mdoc->first)
                 mdoc_node_freelist(mdoc->first);                  mdoc_node_delete(mdoc, mdoc->first);
         if (mdoc->meta.title)          if (mdoc->meta.title)
                 free(mdoc->meta.title);                  free(mdoc->meta.title);
         if (mdoc->meta.os)          if (mdoc->meta.os)
Line 136  mdoc_free1(struct mdoc *mdoc)
Line 140  mdoc_free1(struct mdoc *mdoc)
                 free(mdoc->meta.arch);                  free(mdoc->meta.arch);
         if (mdoc->meta.vol)          if (mdoc->meta.vol)
                 free(mdoc->meta.vol);                  free(mdoc->meta.vol);
           if (mdoc->meta.msec)
                   free(mdoc->meta.msec);
           if (mdoc->meta.date)
                   free(mdoc->meta.date);
 }  }
   
   
 static int  /*
    * Allocate all volatile resources (parse tree, meta-data, fields).
    */
   static void
 mdoc_alloc1(struct mdoc *mdoc)  mdoc_alloc1(struct mdoc *mdoc)
 {  {
   
         bzero(&mdoc->meta, sizeof(struct mdoc_meta));          memset(&mdoc->meta, 0, sizeof(struct mdoc_meta));
         mdoc->flags = 0;          mdoc->flags = 0;
         mdoc->lastnamed = mdoc->lastsec = 0;          mdoc->lastnamed = mdoc->lastsec = SEC_NONE;
         mdoc->last = calloc(1, sizeof(struct mdoc_node));          mdoc->last = mandoc_calloc(1, sizeof(struct mdoc_node));
         if (NULL == mdoc->last)  
                 return(0);  
   
         mdoc->first = mdoc->last;          mdoc->first = mdoc->last;
         mdoc->last->type = MDOC_ROOT;          mdoc->last->type = MDOC_ROOT;
           mdoc->last->tok = MDOC_MAX;
         mdoc->next = MDOC_NEXT_CHILD;          mdoc->next = MDOC_NEXT_CHILD;
         return(1);  
 }  }
   
   
 /*  /*
  * Free up all resources contributed by a parse:  the node tree,   * Free up volatile resources (see mdoc_free1()) then re-initialises the
  * meta-data and so on.  Then reallocate the root node for another   * data with mdoc_alloc1().  After invocation, parse data has been reset
  * parse.   * and the parser is ready for re-invocation on a new tree; however,
    * cross-parse non-volatile data is kept intact.
  */   */
 int  void
 mdoc_reset(struct mdoc *mdoc)  mdoc_reset(struct mdoc *mdoc)
 {  {
   
         mdoc_free1(mdoc);          mdoc_free1(mdoc);
         return(mdoc_alloc1(mdoc));          mdoc_alloc1(mdoc);
 }  }
   
   
 /*  /*
  * Completely free up all resources.   * Completely free up all volatile and non-volatile parse resources.
    * After invocation, the pointer is no longer usable.
  */   */
 void  void
 mdoc_free(struct mdoc *mdoc)  mdoc_free(struct mdoc *mdoc)
 {  {
   
         mdoc_free1(mdoc);          mdoc_free1(mdoc);
         if (mdoc->htab)  
                 mdoc_hash_free(mdoc->htab);  
         free(mdoc);          free(mdoc);
 }  }
   
   
   /*
    * Allocate volatile and non-volatile parse resources.
    */
 struct mdoc *  struct mdoc *
 mdoc_alloc(void *data, int pflags, const struct mdoc_cb *cb)  mdoc_alloc(struct roff *roff, struct mparse *parse,
           char *defos, int quick)
 {  {
         struct mdoc     *p;          struct mdoc     *p;
   
         if (NULL == (p = calloc(1, sizeof(struct mdoc))))          p = mandoc_calloc(1, sizeof(struct mdoc));
                 return(NULL);  
         if (cb)  
                 (void)memcpy(&p->cb, cb, sizeof(struct mdoc_cb));  
   
         p->data = data;          p->parse = parse;
         p->pflags = pflags;          p->defos = defos;
           p->quick = quick;
           p->roff = roff;
   
         if (NULL == (p->htab = mdoc_hash_alloc())) {          mdoc_hash_init();
                 free(p);          mdoc_alloc1(p);
                 return(NULL);          return(p);
         } else if (mdoc_alloc1(p))  
                 return(p);  
   
         free(p);  
         return(NULL);  
 }  }
   
   
 /*  /*
  * Climb back up the parse tree, validating open scopes.  Mostly calls   * Climb back up the parse tree, validating open scopes.  Mostly calls
  * through to macro_end in macro.c.   * through to macro_end() in macro.c.
  */   */
 int  int
 mdoc_endparse(struct mdoc *m)  mdoc_endparse(struct mdoc *mdoc)
 {  {
   
         if (MDOC_HALT & m->flags)          assert( ! (MDOC_HALT & mdoc->flags));
                 return(0);          if (mdoc_macroend(mdoc))
         else if (mdoc_macroend(m))  
                 return(1);                  return(1);
         m->flags |= MDOC_HALT;          mdoc->flags |= MDOC_HALT;
         return(0);          return(0);
 }  }
   
   
 /*  
  * Main parse routine.  Parses a single line -- really just hands off to  
  * the macro or text parser.  
  */  
 int  int
 mdoc_parseln(struct mdoc *m, int ln, char *buf)  mdoc_addeqn(struct mdoc *mdoc, const struct eqn *ep)
 {  {
           struct mdoc_node *n;
   
         /* If in error-mode, then we parse no more. */          assert( ! (MDOC_HALT & mdoc->flags));
   
         if (MDOC_HALT & m->flags)          /* No text before an initial macro. */
   
           if (SEC_NONE == mdoc->lastnamed) {
                   mdoc_pmsg(mdoc, ep->ln, ep->pos, MANDOCERR_NOTEXT);
                   return(1);
           }
   
           n = node_alloc(mdoc, ep->ln, ep->pos, MDOC_MAX, MDOC_EQN);
           n->eqn = ep;
   
           if ( ! node_append(mdoc, n))
                 return(0);                  return(0);
   
         return('.' == *buf ? parsemacro(m, ln, buf) :          mdoc->next = MDOC_NEXT_SIBLING;
                         parsetext(m, ln, buf));          return(1);
 }  }
   
   int
 void  mdoc_addspan(struct mdoc *mdoc, const struct tbl_span *sp)
 mdoc_vmsg(struct mdoc *mdoc, int ln, int pos, const char *fmt, ...)  
 {  {
         char              buf[256];          struct mdoc_node *n;
         va_list           ap;  
   
         if (NULL == mdoc->cb.mdoc_msg)          assert( ! (MDOC_HALT & mdoc->flags));
                 return;  
   
         va_start(ap, fmt);          /* No text before an initial macro. */
         (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);  
         va_end(ap);  
         (*mdoc->cb.mdoc_msg)(mdoc->data, ln, pos, buf);  
 }  
   
           if (SEC_NONE == mdoc->lastnamed) {
                   mdoc_pmsg(mdoc, sp->line, 0, MANDOCERR_NOTEXT);
                   return(1);
           }
   
 int          n = node_alloc(mdoc, sp->line, 0, MDOC_MAX, MDOC_TBL);
 mdoc_verr(struct mdoc *mdoc, int ln, int pos,          n->span = sp;
                 const char *fmt, ...)  
 {  
         char             buf[256];  
         va_list          ap;  
   
         if (NULL == mdoc->cb.mdoc_err)          if ( ! node_append(mdoc, n))
                 return(0);                  return(0);
   
         va_start(ap, fmt);          mdoc->next = MDOC_NEXT_SIBLING;
         (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);          return(1);
         va_end(ap);  
         return((*mdoc->cb.mdoc_err)(mdoc->data, ln, pos, buf));  
 }  }
   
   
   /*
    * Main parse routine.  Parses a single line -- really just hands off to
    * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()).
    */
 int  int
 mdoc_vwarn(struct mdoc *mdoc, int ln, int pos,  mdoc_parseln(struct mdoc *mdoc, int ln, char *buf, int offs)
                 enum mdoc_warn type, const char *fmt, ...)  
 {  {
         char             buf[256];  
         va_list          ap;  
   
         if (NULL == mdoc->cb.mdoc_warn)          assert( ! (MDOC_HALT & mdoc->flags));
                 return(0);  
   
         va_start(ap, fmt);          mdoc->flags |= MDOC_NEWLINE;
         (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);  
         va_end(ap);  
         return((*mdoc->cb.mdoc_warn)(mdoc->data, ln, pos, type, 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 (roff_getreg(mdoc->roff, "nS"))
                   mdoc->flags |= MDOC_SYNOPSIS;
           else
                   mdoc->flags &= ~MDOC_SYNOPSIS;
   
           return(roff_getcontrol(mdoc->roff, buf, &offs) ?
                           mdoc_pmacro(mdoc, ln, buf, offs) :
                           mdoc_ptext(mdoc, ln, buf, offs));
   }
   
 int  int
 mdoc_macro(struct mdoc *m, int tok,  mdoc_macro(MACRO_PROT_ARGS)
                 int ln, int pp, int *pos, char *buf)  
 {  {
           assert(tok < MDOC_MAX);
   
         /* FIXME - these should happen during validation. */          /* If we're in the body, deny prologue calls. */
   
         if (MDOC_PROLOGUE & mdoc_macros[tok].flags &&          if (MDOC_PROLOGUE & mdoc_macros[tok].flags &&
                         SEC_PROLOGUE != m->lastnamed)                          MDOC_PBODY & mdoc->flags) {
                 return(perr(m, ln, pp, EPROLBODY));                  mdoc_pmsg(mdoc, line, ppos, MANDOCERR_BADBODY);
                   return(1);
           }
   
           /* If we're in the prologue, deny "body" macros.  */
   
         if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) &&          if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) &&
                         SEC_PROLOGUE == m->lastnamed)                          ! (MDOC_PBODY & mdoc->flags)) {
                 return(perr(m, ln, pp, EBODYPROL));                  mdoc_pmsg(mdoc, line, ppos, MANDOCERR_BADPROLOG);
                   if (NULL == mdoc->meta.msec)
                           mdoc->meta.msec = mandoc_strdup("1");
                   if (NULL == mdoc->meta.title)
                           mdoc->meta.title = mandoc_strdup("UNKNOWN");
                   if (NULL == mdoc->meta.vol)
                           mdoc->meta.vol = mandoc_strdup("LOCAL");
                   if (NULL == mdoc->meta.os)
                           mdoc->meta.os = mandoc_strdup("LOCAL");
                   if (NULL == mdoc->meta.date)
                           mdoc->meta.date = mandoc_normdate
                                   (mdoc->parse, NULL, line, ppos);
                   mdoc->flags |= MDOC_PBODY;
           }
   
         if (1 != pp && ! (MDOC_CALLABLE & mdoc_macros[tok].flags))          return((*mdoc_macros[tok].fp)(mdoc, tok, line, ppos, pos, buf));
                 return(perr(m, ln, pp, ENOCALL));  
   
         return((*mdoc_macros[tok].fp)(m, tok, ln, pp, pos, buf));  
 }  }
   
   
 static int  static int
 perr(struct mdoc *m, int line, int pos, enum merr type)  
 {  
         char            *p;  
   
         p = NULL;  
         switch (type) {  
         case (ENOCALL):  
                 p = "not callable";  
                 break;  
         case (EPROLBODY):  
                 p = "macro disallowed in document body";  
                 break;  
         case (EBODYPROL):  
                 p = "macro disallowed in document prologue";  
                 break;  
         case (EMALLOC):  
                 p = "memory exhausted";  
                 break;  
         case (ETEXTPROL):  
                 p = "text disallowed in document prologue";  
                 break;  
         case (ENOBLANK):  
                 p = "blank lines disallowed in non-literal contexts";  
                 break;  
         case (ESPACE):  
                 p = "whitespace disallowed after delimiter";  
                 break;  
         }  
         assert(p);  
         return(mdoc_perr(m, line, pos, p));  
 }  
   
   
 static int  
 node_append(struct mdoc *mdoc, struct mdoc_node *p)  node_append(struct mdoc *mdoc, struct mdoc_node *p)
 {  {
   
Line 373  node_append(struct mdoc *mdoc, struct mdoc_node *p)
Line 366  node_append(struct mdoc *mdoc, struct mdoc_node *p)
                 /* NOTREACHED */                  /* NOTREACHED */
         }          }
   
           p->parent->nchild++;
   
           /*
            * Copy over the normalised-data pointer of our parent.  Not
            * everybody has one, but copying a null pointer is fine.
            */
   
           switch (p->type) {
           case (MDOC_BODY):
                   if (ENDBODY_NOT != p->end)
                           break;
                   /* FALLTHROUGH */
           case (MDOC_TAIL):
                   /* FALLTHROUGH */
           case (MDOC_HEAD):
                   p->norm = p->parent->norm;
                   break;
           default:
                   break;
           }
   
         if ( ! mdoc_valid_pre(mdoc, p))          if ( ! mdoc_valid_pre(mdoc, p))
                 return(0);                  return(0);
         if ( ! mdoc_action_pre(mdoc, p))  
                 return(0);  
   
         switch (p->type) {          switch (p->type) {
         case (MDOC_HEAD):          case (MDOC_HEAD):
Line 388  node_append(struct mdoc *mdoc, struct mdoc_node *p)
Line 400  node_append(struct mdoc *mdoc, struct mdoc_node *p)
                 p->parent->tail = p;                  p->parent->tail = p;
                 break;                  break;
         case (MDOC_BODY):          case (MDOC_BODY):
                   if (p->end)
                           break;
                 assert(MDOC_BLOCK == p->parent->type);                  assert(MDOC_BLOCK == p->parent->type);
                 p->parent->body = p;                  p->parent->body = p;
                 break;                  break;
Line 398  node_append(struct mdoc *mdoc, struct mdoc_node *p)
Line 412  node_append(struct mdoc *mdoc, struct mdoc_node *p)
         mdoc->last = p;          mdoc->last = p;
   
         switch (p->type) {          switch (p->type) {
           case (MDOC_TBL):
                   /* FALLTHROUGH */
         case (MDOC_TEXT):          case (MDOC_TEXT):
                 if ( ! mdoc_valid_post(mdoc))                  if ( ! mdoc_valid_post(mdoc))
                         return(0);                          return(0);
                 if ( ! mdoc_action_post(mdoc))  
                         return(0);  
                 break;                  break;
         default:          default:
                 break;                  break;
Line 413  node_append(struct mdoc *mdoc, struct mdoc_node *p)
Line 427  node_append(struct mdoc *mdoc, struct mdoc_node *p)
   
   
 static struct mdoc_node *  static struct mdoc_node *
 node_alloc(struct mdoc *mdoc, int line,  node_alloc(struct mdoc *mdoc, int line, int pos,
                 int pos, int tok, enum mdoc_type type)                  enum mdoct tok, enum mdoc_type type)
 {  {
         struct mdoc_node *p;          struct mdoc_node *p;
   
         if (NULL == (p = calloc(1, sizeof(struct mdoc_node)))) {          p = mandoc_calloc(1, sizeof(struct mdoc_node));
                 (void)verr(mdoc, EMALLOC);  
                 return(NULL);  
         }  
   
         p->sec = mdoc->lastsec;          p->sec = mdoc->lastsec;
         p->line = line;          p->line = line;
         p->pos = pos;          p->pos = pos;
           p->lastline = line;
         p->tok = tok;          p->tok = tok;
         if (MDOC_TEXT != (p->type = type))          p->type = type;
                 assert(p->tok >= 0);  
   
           /* Flag analysis. */
   
           if (MDOC_SYNOPSIS & mdoc->flags)
                   p->flags |= MDOC_SYNPRETTY;
           else
                   p->flags &= ~MDOC_SYNPRETTY;
           if (MDOC_NEWLINE & mdoc->flags)
                   p->flags |= MDOC_LINE;
           mdoc->flags &= ~MDOC_NEWLINE;
   
         return(p);          return(p);
 }  }
   
   
 int  int
 mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, int tok)  mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok)
 {  {
         struct mdoc_node *p;          struct mdoc_node *p;
   
         p = node_alloc(mdoc, line, pos, tok, MDOC_TAIL);          p = node_alloc(mdoc, line, pos, tok, MDOC_TAIL);
         if (NULL == p)          if ( ! node_append(mdoc, p))
                 return(0);                  return(0);
         return(node_append(mdoc, p));          mdoc->next = MDOC_NEXT_CHILD;
           return(1);
 }  }
   
   
 int  int
 mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, int tok)  mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok)
 {  {
         struct mdoc_node *p;          struct mdoc_node *p;
   
Line 455  mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, 
Line 476  mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, 
         assert(mdoc->last);          assert(mdoc->last);
   
         p = node_alloc(mdoc, line, pos, tok, MDOC_HEAD);          p = node_alloc(mdoc, line, pos, tok, MDOC_HEAD);
         if (NULL == p)          if ( ! node_append(mdoc, p))
                 return(0);                  return(0);
         return(node_append(mdoc, p));          mdoc->next = MDOC_NEXT_CHILD;
           return(1);
 }  }
   
   
 int  int
 mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, int tok)  mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok)
 {  {
         struct mdoc_node *p;          struct mdoc_node *p;
   
         p = node_alloc(mdoc, line, pos, tok, MDOC_BODY);          p = node_alloc(mdoc, line, pos, tok, MDOC_BODY);
         if (NULL == p)          if ( ! node_append(mdoc, p))
                 return(0);                  return(0);
         return(node_append(mdoc, p));          mdoc->next = MDOC_NEXT_CHILD;
           return(1);
 }  }
   
   
 int  int
   mdoc_endbody_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok,
                   struct mdoc_node *body, enum mdoc_endbody end)
   {
           struct mdoc_node *p;
   
           p = node_alloc(mdoc, line, pos, tok, MDOC_BODY);
           p->pending = body;
           p->norm = body->norm;
           p->end = end;
           if ( ! node_append(mdoc, p))
                   return(0);
           mdoc->next = MDOC_NEXT_SIBLING;
           return(1);
   }
   
   
   int
 mdoc_block_alloc(struct mdoc *mdoc, int line, int pos,  mdoc_block_alloc(struct mdoc *mdoc, int line, int pos,
                 int tok, struct mdoc_arg *args)                  enum mdoct tok, struct mdoc_arg *args)
 {  {
         struct mdoc_node *p;          struct mdoc_node *p;
   
         p = node_alloc(mdoc, line, pos, tok, MDOC_BLOCK);          p = node_alloc(mdoc, line, pos, tok, MDOC_BLOCK);
         if (NULL == p)          p->args = args;
                 return(0);          if (p->args)
         if ((p->args = args))  
                 (args->refcnt)++;                  (args->refcnt)++;
         return(node_append(mdoc, 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(mdoc, p))
                   return(0);
           mdoc->next = MDOC_NEXT_CHILD;
           return(1);
 }  }
   
   
 int  int
 mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos,  mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos,
                 int tok, struct mdoc_arg *args)                  enum mdoct tok, struct mdoc_arg *args)
 {  {
         struct mdoc_node *p;          struct mdoc_node *p;
   
         p = node_alloc(mdoc, line, pos, tok, MDOC_ELEM);          p = node_alloc(mdoc, line, pos, tok, MDOC_ELEM);
         if (NULL == p)          p->args = args;
                 return(0);          if (p->args)
         if ((p->args = args))  
                 (args->refcnt)++;                  (args->refcnt)++;
         return(node_append(mdoc, p));  
 }  
   
           switch (tok) {
           case (MDOC_An):
                   p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
                   break;
           default:
                   break;
           }
   
           if ( ! node_append(mdoc, p))
                   return(0);
           mdoc->next = MDOC_NEXT_CHILD;
           return(1);
   }
   
 int  int
 mdoc_word_alloc(struct mdoc *mdoc,  mdoc_word_alloc(struct mdoc *mdoc, int line, int pos, const char *p)
                 int line, int pos, const char *word)  
 {  {
         struct mdoc_node *p;          struct mdoc_node *n;
   
         p = node_alloc(mdoc, line, pos, -1, MDOC_TEXT);          n = node_alloc(mdoc, line, pos, MDOC_MAX, MDOC_TEXT);
         if (NULL == p)          n->string = roff_strdup(mdoc->roff, p);
   
           if ( ! node_append(mdoc, n))
                 return(0);                  return(0);
         if (NULL == (p->string = strdup(word))) {  
                 (void)verr(mdoc, EMALLOC);          mdoc->next = MDOC_NEXT_SIBLING;
                 return(0);          return(1);
         }  
         return(node_append(mdoc, p));  
 }  }
   
   
 void  void
   mdoc_word_append(struct mdoc *mdoc, const char *p)
   {
           struct mdoc_node        *n;
           char                    *addstr, *newstr;
   
           n = mdoc->last;
           addstr = roff_strdup(mdoc->roff, p);
           if (-1 == asprintf(&newstr, "%s %s", n->string, addstr)) {
                   perror(NULL);
                   exit((int)MANDOCLEVEL_SYSERR);
           }
           free(addstr);
           free(n->string);
           n->string = newstr;
           mdoc->next = MDOC_NEXT_SIBLING;
   }
   
   static void
 mdoc_node_free(struct mdoc_node *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)          if (p->args)
Line 532  mdoc_node_free(struct mdoc_node *p)
Line 617  mdoc_node_free(struct mdoc_node *p)
 }  }
   
   
   static void
   mdoc_node_unlink(struct mdoc *mdoc, struct mdoc_node *n)
   {
   
           /* 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;
                   if (n->parent->last == n)
                           n->parent->last = n->prev ? n->prev : NULL;
           }
   
           /* Adjust parse point, if applicable. */
   
           if (mdoc && mdoc->last == n) {
                   if (n->prev) {
                           mdoc->last = n->prev;
                           mdoc->next = MDOC_NEXT_SIBLING;
                   } else {
                           mdoc->last = n->parent;
                           mdoc->next = MDOC_NEXT_CHILD;
                   }
           }
   
           if (mdoc && mdoc->first == n)
                   mdoc->first = NULL;
   }
   
   
 void  void
 mdoc_node_freelist(struct mdoc_node *p)  mdoc_node_delete(struct mdoc *mdoc, struct mdoc_node *p)
 {  {
   
         if (p->child)          while (p->child) {
                 mdoc_node_freelist(p->child);                  assert(p->nchild);
         if (p->next)                  mdoc_node_delete(mdoc, p->child);
                 mdoc_node_freelist(p->next);          }
           assert(0 == p->nchild);
   
           mdoc_node_unlink(mdoc, p);
         mdoc_node_free(p);          mdoc_node_free(p);
 }  }
   
   int
   mdoc_node_relink(struct mdoc *mdoc, struct mdoc_node *p)
   {
   
           mdoc_node_unlink(mdoc, p);
           return(node_append(mdoc, p));
   }
   
   #if 0
 /*  /*
  * Parse free-form text, that is, a line that does not begin with the   * Pre-treat a text line.
  * control character.   * Text lines can consist of equations, which must be handled apart from
    * the regular text.
    * Thus, use this function to step through a line checking if it has any
    * equations embedded in it.
    * This must handle multiple equations AND equations that do not end at
    * the end-of-line, i.e., will re-enter in the next roff parse.
  */   */
 static int  static int
 parsetext(struct mdoc *m, int line, char *buf)  mdoc_preptext(struct mdoc *mdoc, int line, char *buf, int offs)
 {  {
           char            *start, *end;
           char             delim;
   
         if (SEC_PROLOGUE == m->lastnamed)          while ('\0' != buf[offs]) {
                 return(perr(m, line, 0, ETEXTPROL));                  /* Mark starting position if eqn is set. */
                   start = NULL;
                   if ('\0' != (delim = roff_eqndelim(mdoc->roff)))
                           if (NULL != (start = strchr(buf + offs, delim)))
                                   *start++ = '\0';
   
         if (0 == buf[0] && ! (MDOC_LITERAL & m->flags))                  /* Parse text as normal. */
                 return(perr(m, line, 0, ENOBLANK));                  if ( ! mdoc_ptext(mdoc, line, buf, offs))
                           return(0);
   
         if ( ! mdoc_word_alloc(m, line, 0, buf))                  /* Continue only if an equation exists. */
                 return(0);                  if (NULL == start)
                           break;
   
         m->next = MDOC_NEXT_SIBLING;                  /* Read past the end of the equation. */
                   offs += start - (buf + offs);
                   assert(start == &buf[offs]);
                   if (NULL != (end = strchr(buf + offs, delim))) {
                           *end++ = '\0';
                           while (' ' == *end)
                                   end++;
                   }
   
                   /* Parse the equation itself. */
                   roff_openeqn(mdoc->roff, NULL, line, offs, buf);
   
                   /* Process a finished equation? */
                   if (roff_closeeqn(mdoc->roff))
                           if ( ! mdoc_addeqn(mdoc, roff_eqn(mdoc->roff)))
                                   return(0);
                   offs += (end - (buf + offs));
           }
   
         return(1);          return(1);
 }  }
   #endif
   
   /*
    * Parse free-form text, that is, a line that does not begin with the
    * control character.
    */
 static int  static int
 macrowarn(struct mdoc *m, int ln, const char *buf)  mdoc_ptext(struct mdoc *mdoc, int line, char *buf, int offs)
 {  {
         if ( ! (MDOC_IGN_MACRO & m->pflags))          char             *c, *ws, *end;
                 return(mdoc_perr(m, ln, 1,          struct mdoc_node *n;
                                 "unknown macro: %s%s",  
                                 buf, strlen(buf) > 3 ? "..." : ""));  
         return(mdoc_pwarn(m, ln, 1, WARN_SYNTAX,  
                                 "unknown macro: %s%s",  
                                 buf, strlen(buf) > 3 ? "..." : ""));  
 }  
   
           /* No text before an initial macro. */
   
           if (SEC_NONE == mdoc->lastnamed) {
                   mdoc_pmsg(mdoc, line, offs, MANDOCERR_NOTEXT);
                   return(1);
           }
   
           assert(mdoc->last);
           n = mdoc->last;
   
           /*
            * Divert directly to list processing if we're encountering a
            * columnar MDOC_BLOCK with or without a prior MDOC_BLOCK entry
            * (a MDOC_BODY means it's already open, in which case we should
            * process within its context in the normal way).
            */
   
           if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
                           LIST_column == n->norm->Bl.type) {
                   /* `Bl' is open without any children. */
                   mdoc->flags |= MDOC_FREECOL;
                   return(mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf));
           }
   
           if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
                           NULL != n->parent &&
                           MDOC_Bl == n->parent->tok &&
                           LIST_column == n->parent->norm->Bl.type) {
                   /* `Bl' has block-level `It' children. */
                   mdoc->flags |= MDOC_FREECOL;
                   return(mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf));
           }
   
           /*
            * Search for the beginning of unescaped trailing whitespace (ws)
            * and for the first character not to be output (end).
            */
   
           /* FIXME: replace with strcspn(). */
           ws = NULL;
           for (c = end = buf + offs; *c; c++) {
                   switch (*c) {
                   case ' ':
                           if (NULL == ws)
                                   ws = c;
                           continue;
                   case '\t':
                           /*
                            * Always warn about trailing tabs,
                            * even outside literal context,
                            * where they should be put on the next line.
                            */
                           if (NULL == ws)
                                   ws = c;
                           /*
                            * Strip trailing tabs in literal context only;
                            * outside, they affect the next line.
                            */
                           if (MDOC_LITERAL & mdoc->flags)
                                   continue;
                           break;
                   case '\\':
                           /* Skip the escaped character, too, if any. */
                           if (c[1])
                                   c++;
                           /* FALLTHROUGH */
                   default:
                           ws = NULL;
                           break;
                   }
                   end = c + 1;
           }
           *end = '\0';
   
           if (ws)
                   mdoc_pmsg(mdoc, line, (int)(ws-buf), MANDOCERR_EOLNSPACE);
   
           if ('\0' == buf[offs] && ! (MDOC_LITERAL & mdoc->flags)) {
                   mdoc_pmsg(mdoc, line, (int)(c-buf), MANDOCERR_NOBLANKLN);
   
                   /*
                    * Insert a `sp' in the case of a blank line.  Technically,
                    * blank lines aren't allowed, but enough manuals assume this
                    * behaviour that we want to work around it.
                    */
                   if ( ! mdoc_elem_alloc(mdoc, line, offs, MDOC_sp, NULL))
                           return(0);
   
                   mdoc->next = MDOC_NEXT_SIBLING;
   
                   return(mdoc_valid_post(mdoc));
           }
   
           if ( ! mdoc_word_alloc(mdoc, line, offs, buf+offs))
                   return(0);
   
           if (MDOC_LITERAL & mdoc->flags)
                   return(1);
   
           /*
            * End-of-sentence check.  If the last character is an unescaped
            * EOS character, then flag the node as being the end of a
            * sentence.  The front-end will know how to interpret this.
            */
   
           assert(buf < end);
   
           if (mandoc_eos(buf+offs, (size_t)(end-buf-offs)))
                   mdoc->last->flags |= MDOC_EOS;
   
           return(1);
   }
   
   
 /*  /*
  * Parse a macro line, that is, a line beginning with the control   * Parse a macro line, that is, a line beginning with the control
  * character.   * character.
  */   */
 int  static int
 parsemacro(struct mdoc *m, int ln, char *buf)  mdoc_pmacro(struct mdoc *mdoc, int ln, char *buf, int offs)
 {  {
         int               i, c;          enum mdoct        tok;
           int               i, sv;
         char              mac[5];          char              mac[5];
           struct mdoc_node *n;
   
         /* Comments and empties are quickly ignored. */          /* Empty post-control lines are ignored. */
   
         if (0 == buf[1])          if ('"' == buf[offs]) {
                   mdoc_pmsg(mdoc, ln, offs, MANDOCERR_BADCOMMENT);
                 return(1);                  return(1);
           } else if ('\0' == buf[offs])
                   return(1);
   
         if (' ' == buf[1]) {          sv = offs;
                 i = 2;  
                 while (buf[i] && ' ' == buf[i])  
                         i++;  
                 if (0 == buf[i])  
                         return(1);  
                 return(perr(m, ln, 1, ESPACE));  
         }  
   
         if (buf[1] && '\\' == buf[1])          /*
                 if (buf[2] && '\"' == buf[2])           * Copy the first word into a nil-terminated buffer.
                         return(1);           * Stop copying when a tab, space, or eoln is encountered.
            */
   
         /* Copy the first word into a nil-terminated buffer. */          i = 0;
           while (i < 4 && '\0' != buf[offs] &&
                           ' ' != buf[offs] && '\t' != buf[offs])
                   mac[i++] = buf[offs++];
   
         for (i = 1; i < 5; i++) {          mac[i] = '\0';
                 if (0 == (mac[i - 1] = buf[i]))  
                         break;          tok = (i > 1 || i < 4) ? mdoc_hash_find(mac) : MDOC_MAX;
                 else if (' ' == buf[i])  
                         break;          if (MDOC_MAX == tok) {
                   mandoc_vmsg(MANDOCERR_MACRO, mdoc->parse,
                                   ln, sv, "%s", buf + sv - 1);
                   return(1);
         }          }
   
         mac[i - 1] = 0;          /* Disregard the first trailing tab, if applicable. */
   
         if (i == 5 || i <= 2) {          if ('\t' == buf[offs])
                 if ( ! macrowarn(m, ln, mac))                  offs++;
   
           /* Jump to the next non-whitespace word. */
   
           while (buf[offs] && ' ' == buf[offs])
                   offs++;
   
           /*
            * 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[offs] && ' ' == buf[offs - 1])
                   mdoc_pmsg(mdoc, ln, offs - 1, MANDOCERR_EOLNSPACE);
   
           /*
            * If an initial macro or a list invocation, divert directly
            * into macro processing.
            */
   
           if (NULL == mdoc->last || MDOC_It == tok || MDOC_El == tok) {
                   if ( ! mdoc_macro(mdoc, tok, ln, sv, &offs, buf))
                         goto err;                          goto err;
                 return(1);                  return(1);
         }          }
   
         if (MDOC_MAX == (c = mdoc_hash_find(m->htab, mac))) {          n = mdoc->last;
                 if ( ! macrowarn(m, ln, mac))          assert(mdoc->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) {
                   mdoc->flags |= MDOC_FREECOL;
                   if ( ! mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf))
                         goto err;                          goto err;
                 return(1);                  return(1);
         }          }
   
         /* The macro is sane.  Jump to the next word. */          /*
            * 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.
            */
   
         while (buf[i] && ' ' == buf[i])          if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
                 i++;                          NULL != n->parent &&
                           MDOC_Bl == n->parent->tok &&
                           LIST_column == n->parent->norm->Bl.type) {
                   mdoc->flags |= MDOC_FREECOL;
                   if ( ! mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf))
                           goto err;
                   return(1);
           }
   
         /* Begin recursive parse sequence. */          /* Normal processing of a macro. */
   
         if ( ! mdoc_macro(m, c, ln, 1, &i, buf))          if ( ! mdoc_macro(mdoc, tok, ln, sv, &offs, buf))
                 goto err;                  goto err;
   
           /* In quick mode (for mandocdb), abort after the NAME section. */
   
           if (mdoc->quick && MDOC_Sh == tok &&
               SEC_NAME != mdoc->last->sec)
                   return(2);
   
         return(1);          return(1);
   
 err:    /* Error out. */  err:    /* Error out. */
   
         m->flags |= MDOC_HALT;          mdoc->flags |= MDOC_HALT;
         return(0);          return(0);
   }
   
   enum mdelim
   mdoc_isdelim(const char *p)
   {
   
           if ('\0' == p[0])
                   return(DELIM_NONE);
   
           if ('\0' == p[1])
                   switch (p[0]) {
                   case('('):
                           /* FALLTHROUGH */
                   case('['):
                           return(DELIM_OPEN);
                   case('|'):
                           return(DELIM_MIDDLE);
                   case('.'):
                           /* FALLTHROUGH */
                   case(','):
                           /* FALLTHROUGH */
                   case(';'):
                           /* FALLTHROUGH */
                   case(':'):
                           /* FALLTHROUGH */
                   case('?'):
                           /* FALLTHROUGH */
                   case('!'):
                           /* FALLTHROUGH */
                   case(')'):
                           /* FALLTHROUGH */
                   case(']'):
                           return(DELIM_CLOSE);
                   default:
                           return(DELIM_NONE);
                   }
   
           if ('\\' != p[0])
                   return(DELIM_NONE);
   
           if (0 == strcmp(p + 1, "."))
                   return(DELIM_CLOSE);
           if (0 == strcmp(p + 1, "fR|\\fP"))
                   return(DELIM_MIDDLE);
   
           return(DELIM_NONE);
 }  }
Legend:
Removed from v.1.74  
changed lines
  Added in v.1.208
CVSweb