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

Diff for /mandoc/mdoc.c between version 1.88 and 1.250

version 1.88, 2009/07/06 13:04:52 version 1.250, 2015/04/19 14:57:38
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>   * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
    * Copyright (c) 2010, 2012-2015 Ingo Schwarze <schwarze@openbsd.org>
  *   *
  * Permission to use, copy, modify, and distribute this software for any   * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above   * purpose with or without fee is hereby granted, provided that the above
  * copyright notice and this permission notice appear in all copies.   * copyright notice and this permission notice appear in all copies.
  *   *
  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES   * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF   * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR   * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES   * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN   * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.   * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */   */
   #include "config.h"
   
   #include <sys/types.h>
   
 #include <assert.h>  #include <assert.h>
 #include <ctype.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 "mandoc_aux.h"
   #include "mandoc.h"
   #include "roff.h"
   #include "mdoc.h"
   #include "libmandoc.h"
   #include "roff_int.h"
 #include "libmdoc.h"  #include "libmdoc.h"
   
 const   char *const __mdoc_macronames[MDOC_MAX] = {  const   char *const __mdoc_macronames[MDOC_MAX + 1] = {
           "text",
         "Ap",           "Dd",           "Dt",           "Os",          "Ap",           "Dd",           "Dt",           "Os",
         "Sh",           "Ss",           "Pp",           "D1",          "Sh",           "Ss",           "Pp",           "D1",
         "Dl",           "Bd",           "Ed",           "Bl",          "Dl",           "Bd",           "Ed",           "Bl",
Line 34  const char *const __mdoc_macronames[MDOC_MAX] = {   
Line 47  const char *const __mdoc_macronames[MDOC_MAX] = {   
         "Ic",           "In",           "Li",           "Nd",          "Ic",           "In",           "Li",           "Nd",
         "Nm",           "Op",           "Ot",           "Pa",          "Nm",           "Op",           "Ot",           "Pa",
         "Rv",           "St",           "Va",           "Vt",          "Rv",           "St",           "Va",           "Vt",
         /* LINTED */          "Xr",           "%A",           "%B",           "%D",
         "Xr",           "\%A",          "\%B",          "\%D",          "%I",           "%J",           "%N",           "%O",
         /* LINTED */          "%P",           "%R",           "%T",           "%V",
         "\%I",          "\%J",          "\%N",          "\%O",  
         /* LINTED */  
         "\%P",          "\%R",          "\%T",          "\%V",  
         "Ac",           "Ao",           "Aq",           "At",          "Ac",           "Ao",           "Aq",           "At",
         "Bc",           "Bf",           "Bo",           "Bq",          "Bc",           "Bf",           "Bo",           "Bq",
         "Bsx",          "Bx",           "Db",           "Dc",          "Bsx",          "Bx",           "Db",           "Dc",
Line 55  const char *const __mdoc_macronames[MDOC_MAX] = {   
Line 65  const char *const __mdoc_macronames[MDOC_MAX] = {   
         "Bk",           "Ek",           "Bt",           "Hf",          "Bk",           "Ek",           "Bt",           "Hf",
         "Fr",           "Ud",           "Lb",           "Lp",          "Fr",           "Ud",           "Lb",           "Lp",
         "Lk",           "Mt",           "Brq",          "Bro",          "Lk",           "Mt",           "Brq",          "Bro",
         /* LINTED */          "Brc",          "%C",           "Es",           "En",
         "Brc",          "\%C",          "Es",           "En",          "Dx",           "%Q",           "br",           "sp",
         /* LINTED */          "%U",           "Ta",           "ll",
         "Dx",           "\%Q"  };
         };  
   
 const   char *const __mdoc_argnames[MDOC_ARG_MAX] = {  const   char *const __mdoc_argnames[MDOC_ARG_MAX] = {
         "split",                "nosplit",              "ragged",          "split",                "nosplit",              "ragged",
         "unfilled",             "literal",              "file",          "unfilled",             "literal",              "file",
         "offset",               "bullet",               "dash",          "offset",               "bullet",               "dash",
         "hyphen",               "item",                 "enum",          "hyphen",               "item",                 "enum",
         "tag",                  "diag",                 "hang",          "tag",                  "diag",                 "hang",
         "ohang",                "inset",                "column",          "ohang",                "inset",                "column",
         "width",                "compact",              "std",          "width",                "compact",              "std",
         "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 + 1;
 const   char * const *mdoc_argnames = __mdoc_argnames;  const   char * const *mdoc_argnames = __mdoc_argnames;
   
 static  void              mdoc_free1(struct mdoc *);  static  int               mdoc_ptext(struct roff_man *, int, char *, int);
 static  int               mdoc_alloc1(struct mdoc *);  static  int               mdoc_pmacro(struct roff_man *, int, char *, int);
 static  struct mdoc_node *node_alloc(struct mdoc *, int, int,  
                                 int, enum mdoc_type);  
 static  int               node_append(struct mdoc *,  
                                 struct mdoc_node *);  
 static  int               parsetext(struct mdoc *, int, char *);  
 static  int               parsemacro(struct mdoc *, int, char *);  
 static  int               macrowarn(struct mdoc *, int, const char *);  
   
   
 const struct mdoc_node *  void
 mdoc_node(const struct mdoc *m)  mdoc_endparse(struct roff_man *mdoc)
 {  {
   
         return(MDOC_HALT & m->flags ? NULL : m->first);          mdoc_macroend(mdoc);
 }  }
   
   
 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).   * Main parse routine.  Parses a single line -- really just hands off to
    * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()).
  */   */
 static void  int
 mdoc_free1(struct mdoc *mdoc)  mdoc_parseln(struct roff_man *mdoc, int ln, char *buf, int offs)
 {  {
   
         if (mdoc->first)          if (mdoc->last->type != ROFFT_EQN || ln > mdoc->last->line)
                 mdoc_node_freelist(mdoc->first);                  mdoc->flags |= MDOC_NEWLINE;
         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);  
 }  
   
           /*
            * 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) ?
  * Allocate all volatile resources (parse tree, meta-data, fields).              mdoc_pmacro(mdoc, ln, buf, offs) :
  */              mdoc_ptext(mdoc, ln, buf, offs));
 static int  
 mdoc_alloc1(struct mdoc *mdoc)  
 {  
   
         bzero(&mdoc->meta, sizeof(struct mdoc_meta));  
         mdoc->flags = 0;  
         mdoc->lastnamed = mdoc->lastsec = SEC_NONE;  
         mdoc->last = calloc(1, sizeof(struct mdoc_node));  
         if (NULL == mdoc->last)  
                 return(0);  
   
         mdoc->first = mdoc->last;  
         mdoc->last->type = MDOC_ROOT;  
         mdoc->next = MDOC_NEXT_CHILD;  
         return(1);  
 }  }
   
   void
 /*  mdoc_macro(MACRO_PROT_ARGS)
  * 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.  
  */  
 int  
 mdoc_reset(struct mdoc *mdoc)  
 {  {
           assert(tok > TOKEN_NONE && tok < MDOC_MAX);
   
         mdoc_free1(mdoc);          if (mdoc->flags & MDOC_PBODY) {
         return(mdoc_alloc1(mdoc));                  if (tok == MDOC_Dt) {
                           mandoc_vmsg(MANDOCERR_DT_LATE,
                               mdoc->parse, line, ppos,
                               "Dt %s", buf + *pos);
                           return;
                   }
           } else if ( ! (mdoc_macros[tok].flags & MDOC_PROLOGUE)) {
                   if (mdoc->meta.title == NULL) {
                           mandoc_vmsg(MANDOCERR_DT_NOTITLE,
                               mdoc->parse, line, ppos, "%s %s",
                               mdoc_macronames[tok], buf + *pos);
                           mdoc->meta.title = mandoc_strdup("UNTITLED");
                   }
                   if (NULL == mdoc->meta.vol)
                           mdoc->meta.vol = mandoc_strdup("LOCAL");
                   mdoc->flags |= MDOC_PBODY;
           }
           (*mdoc_macros[tok].fp)(mdoc, tok, line, ppos, pos, buf);
 }  }
   
   
 /*  
  * 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_tail_alloc(struct roff_man *mdoc, int line, int pos, int tok)
 {  {
           struct roff_node *p;
   
         mdoc_free1(mdoc);          p = roff_node_alloc(mdoc, line, pos, ROFFT_TAIL, tok);
         if (mdoc->htab)          roff_node_append(mdoc, p);
                 mdoc_hash_free(mdoc->htab);          mdoc->next = ROFF_NEXT_CHILD;
         free(mdoc);  
 }  }
   
   struct roff_node *
 /*  mdoc_endbody_alloc(struct roff_man *mdoc, int line, int pos, int tok,
  * Allocate volatile and non-volatile parse resources.                  struct roff_node *body, enum mdoc_endbody end)
  */  
 struct mdoc *  
 mdoc_alloc(void *data, int pflags, const struct mdoc_cb *cb)  
 {  {
         struct mdoc     *p;          struct roff_node *p;
   
         if (NULL == (p = calloc(1, sizeof(struct mdoc))))          body->flags |= MDOC_ENDED;
                 return(NULL);          body->parent->flags |= MDOC_ENDED;
         if (cb)          p = roff_node_alloc(mdoc, line, pos, ROFFT_BODY, tok);
                 (void)memcpy(&p->cb, cb, sizeof(struct mdoc_cb));          p->body = body;
           p->norm = body->norm;
         p->data = data;          p->end = end;
         p->pflags = pflags;          roff_node_append(mdoc, p);
           mdoc->next = ROFF_NEXT_SIBLING;
         if (NULL == (p->htab = mdoc_hash_alloc())) {          return(p);
                 free(p);  
                 return(NULL);  
         } else if (mdoc_alloc1(p))  
                 return(p);  
   
         free(p);  
         return(NULL);  
 }  }
   
   struct roff_node *
 /*  mdoc_block_alloc(struct roff_man *mdoc, int line, int pos,
  * Climb back up the parse tree, validating open scopes.  Mostly calls          int tok, struct mdoc_arg *args)
  * through to macro_end() in macro.c.  
  */  
 int  
 mdoc_endparse(struct mdoc *m)  
 {  {
           struct roff_node *p;
   
         if (MDOC_HALT & m->flags)          p = roff_node_alloc(mdoc, line, pos, ROFFT_BLOCK, tok);
                 return(0);          p->args = args;
         else if (mdoc_macroend(m))          if (p->args)
                 return(1);                  (args->refcnt)++;
         m->flags |= MDOC_HALT;  
         return(0);          switch (tok) {
           case MDOC_Bd:
                   /* FALLTHROUGH */
           case MDOC_Bf:
                   /* FALLTHROUGH */
           case MDOC_Bl:
                   /* FALLTHROUGH */
           case MDOC_En:
                   /* FALLTHROUGH */
           case MDOC_Rs:
                   p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
                   break;
           default:
                   break;
           }
           roff_node_append(mdoc, p);
           mdoc->next = ROFF_NEXT_CHILD;
           return(p);
 }  }
   
   void
 /*  mdoc_elem_alloc(struct roff_man *mdoc, int line, int pos,
  * Main parse routine.  Parses a single line -- really just hands off to          int tok, struct mdoc_arg *args)
  * the macro (parsemacro()) or text parser (parsetext()).  
  */  
 int  
 mdoc_parseln(struct mdoc *m, int ln, char *buf)  
 {  {
           struct roff_node *p;
   
         if (MDOC_HALT & m->flags)          p = roff_node_alloc(mdoc, line, pos, ROFFT_ELEM, tok);
                 return(0);          p->args = args;
           if (p->args)
                   (args->refcnt)++;
   
         return('.' == *buf ? parsemacro(m, ln, buf) :          switch (tok) {
                         parsetext(m, ln, buf));          case MDOC_An:
                   p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
                   break;
           default:
                   break;
           }
           roff_node_append(mdoc, p);
           mdoc->next = ROFF_NEXT_CHILD;
 }  }
   
   void
 int  mdoc_node_relink(struct roff_man *mdoc, struct roff_node *p)
 mdoc_verr(struct mdoc *mdoc, int ln, int pos,  
                 const char *fmt, ...)  
 {  {
         char             buf[256];  
         va_list          ap;  
   
         if (NULL == mdoc->cb.mdoc_err)          roff_node_unlink(mdoc, p);
                 return(0);          roff_node_append(mdoc, p);
   
         va_start(ap, fmt);  
         (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);  
         va_end(ap);  
   
         return((*mdoc->cb.mdoc_err)(mdoc->data, ln, pos, buf));  
 }  }
   
   /*
 int   * Parse free-form text, that is, a line that does not begin with the
 mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, const char *fmt, ...)   * control character.
    */
   static int
   mdoc_ptext(struct roff_man *mdoc, int line, char *buf, int offs)
 {  {
         char             buf[256];          struct roff_node *n;
         va_list          ap;          char             *c, *ws, *end;
   
         if (NULL == mdoc->cb.mdoc_warn)          assert(mdoc->last);
                 return(0);          n = mdoc->last;
   
         va_start(ap, fmt);          /*
         (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);           * Divert directly to list processing if we're encountering a
         va_end(ap);           * columnar ROFFT_BLOCK with or without a prior ROFFT_BLOCK entry
            * (a ROFFT_BODY means it's already open, in which case we should
            * process within its context in the normal way).
            */
   
         return((*mdoc->cb.mdoc_warn)(mdoc->data, ln, pos, buf));          if (n->tok == MDOC_Bl && n->type == ROFFT_BODY &&
 }              n->end == ENDBODY_NOT && n->norm->Bl.type == LIST_column) {
                   /* `Bl' is open without any children. */
                   mdoc->flags |= MDOC_FREECOL;
                   mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf);
                   return(1);
           }
   
           if (n->tok == MDOC_It && n->type == ROFFT_BLOCK &&
               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;
                   mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf);
                   return(1);
           }
   
 int          /*
 mdoc_err(struct mdoc *m, int line, int pos, int iserr, enum merr type)           * Search for the beginning of unescaped trailing whitespace (ws)
 {           * and for the first character not to be output (end).
         char             *p;           */
   
         p = NULL;  
   
         switch (type) {          /* FIXME: replace with strcspn(). */
         case (ENOCALL):          ws = NULL;
                 p = "not callable";          for (c = end = buf + offs; *c; c++) {
                 break;                  switch (*c) {
         case (EPROLBODY):                  case ' ':
                 p = "macro disallowed in document body";                          if (NULL == ws)
                 break;                                  ws = c;
         case (EBODYPROL):                          continue;
                 p = "macro disallowed in document prologue";                  case '\t':
                 break;                          /*
         case (EMALLOC):                           * Always warn about trailing tabs,
                 p = "memory exhausted";                           * even outside literal context,
                 break;                           * where they should be put on the next line.
         case (ETEXTPROL):                           */
                 p = "text disallowed in document prologue";                          if (NULL == ws)
                 break;                                  ws = c;
         case (ENOBLANK):                          /*
                 p = "blank lines disallowed in non-literal contexts";                           * Strip trailing tabs in literal context only;
                 break;                           * outside, they affect the next line.
         case (ESPACE):                           */
                 p = "whitespace disallowed after delimiter";                          if (MDOC_LITERAL & mdoc->flags)
                 break;                                  continue;
         case (ETOOLONG):                          break;
                 p = "text argument too long";                  case '\\':
                 break;                          /* Skip the escaped character, too, if any. */
         case (EESCAPE):                          if (c[1])
                 p = "invalid escape sequence";                                  c++;
                 break;                          /* FALLTHROUGH */
         case (EPRINT):                  default:
                 p = "invalid character";                          ws = NULL;
                 break;                          break;
         case (ENESTDISP):                  }
                 p = "displays may not be nested";                  end = c + 1;
                 break;  
         case (EBOOL):  
                 p = "expected boolean value";  
                 break;  
         case (EARGREP):  
                 p = "argument repeated";  
                 break;  
         case (EMULTIDISP):  
                 p = "multiple display types specified";  
                 break;  
         case (EMULTILIST):  
                 p = "multiple list types specified";  
                 break;  
         case (ELISTTYPE):  
                 p = "missing list type";  
                 break;  
         case (EDISPTYPE):  
                 p = "missing display type";  
                 break;  
         case (ESECNAME):  
                 p = "the NAME section must come first";  
                 break;  
         case (ELINE):  
                 p = "expected line arguments";  
                 break;  
         case (ENOPROLOGUE):  
                 p = "document has no prologue";  
                 break;  
         case (ENODAT):  
                 p = "document has no data";  
                 break;  
         case (ECOLMIS):  
                 p = "column syntax style mismatch";  
                 break;  
         case (EATT):  
                 p = "expected valid AT&T symbol";  
                 break;  
         case (ENAME):  
                 p = "default name not yet set";  
                 break;  
         case (ENOWIDTH):  
                 p = "superfluous width argument";  
                 break;  
         case (EMISSWIDTH):  
                 p = "missing width argument";  
                 break;  
         case (EWRONGMSEC):  
                 p = "document section in wrong manual section";  
                 break;  
         case (ESECOOO):  
                 p = "document section out of conventional order";  
                 break;  
         case (ESECREP):  
                 p = "document section repeated";  
                 break;  
         case (EBADSTAND):  
                 p = "unknown standard";  
                 break;  
         case (ENAMESECINC):  
                 p = "NAME section contents incomplete/badly-ordered";  
                 break;  
         case (ENOMULTILINE):  
                 p = "suggested no multi-line arguments";  
                 break;  
         case (EMULTILINE):  
                 p = "suggested multi-line arguments";  
                 break;  
         case (ENOLINE):  
                 p = "suggested no line arguments";  
                 break;  
         case (EPROLOOO):  
                 p = "prologue macros out-of-order";  
                 break;  
         case (EPROLREP):  
                 p = "prologue macros repeated";  
                 break;  
         case (EARGVAL):  
                 p = "argument value suggested";  
                 break;  
         case (EFONT):  
                 p = "invalid font mode";  
                 break;  
         case (EBADMSEC):  
                 p = "inappropriate manual section";  
                 break;  
         case (EBADSEC):  
                 p = "inappropriate document section";  
                 break;  
         case (EQUOTTERM):  
                 p = "unterminated quoted parameter";  
                 break;  
         case (EQUOTPARM):  
                 p = "unexpected quoted parameter";  
                 break;  
         case (EARGVPARM):  
                 p = "argument-like parameter";  
                 break;  
         case (ECOLEMPTY):  
                 p = "last list column is empty";  
                 break;  
         case (ETAILWS):  
                 p = "trailing whitespace";  
                 break;  
         case (ENUMFMT):  
                 p = "bad number format";  
                 break;  
         case (EUTSNAME):  
                 p = "utsname";  
                 break;  
         case (EBADDATE):  
                 p = "malformed date syntax";  
                 break;  
         case (EOPEN):  
                 p = "explicit scope still open on exit";  
                 break;  
         case (EQUOT):  
                 p = "unterminated quotation";  
                 break;  
         case (ENOCTX):  
                 p = "closure has no prior context";  
                 break;  
         case (ENOPARMS):  
                 p = "unexpect line arguments";  
                 break;  
         case (EIGNE):  
                 p = "ignoring empty element";  
                 break;  
         case (EIMPBRK):  
                 p = "crufty end-of-line scope violation";  
                 break;  
         case (EMACPARM):  
                 p = "macro-like parameter";  
                 break;  
         case (EOBS):  
                 p = "macro marked obsolete";  
                 break;  
         }          }
           *end = '\0';
   
         assert(p);          if (ws)
                   mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse,
                       line, (int)(ws-buf), NULL);
   
         if (iserr)          if (buf[offs] == '\0' && ! (mdoc->flags & MDOC_LITERAL)) {
                 return(mdoc_verr(m, line, pos, p));                  mandoc_msg(MANDOCERR_FI_BLANK, mdoc->parse,
                       line, (int)(c - buf), NULL);
   
         return(mdoc_vwarn(m, line, pos, p));                  /*
 }                   * 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.
                    */
                   roff_elem_alloc(mdoc, line, offs, MDOC_sp);
                   mdoc->next = ROFF_NEXT_SIBLING;
                   mdoc_valid_post(mdoc);
                   return(1);
           }
   
           roff_word_alloc(mdoc, line, offs, buf+offs);
   
 int          if (mdoc->flags & MDOC_LITERAL)
 mdoc_macro(struct mdoc *m, int tok,                  return(1);
                 int ln, int pp, int *pos, char *buf)  
 {  
   
         if (MDOC_PROLOGUE & mdoc_macros[tok].flags &&          /*
                         MDOC_PBODY & m->flags)           * End-of-sentence check.  If the last character is an unescaped
                 return(mdoc_perr(m, ln, pp, EPROLBODY));           * EOS character, then flag the node as being the end of a
         if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) &&           * sentence.  The front-end will know how to interpret this.
                         ! (MDOC_PBODY & m->flags))           */
                 return(mdoc_perr(m, ln, pp, EBODYPROL));  
   
         if (1 != pp && ! (MDOC_CALLABLE & mdoc_macros[tok].flags))          assert(buf < end);
                 return(mdoc_perr(m, ln, pp, ENOCALL));  
   
         return((*mdoc_macros[tok].fp)(m, tok, ln, pp, pos, buf));          if (mandoc_eos(buf+offs, (size_t)(end-buf-offs)))
                   mdoc->last->flags |= MDOC_EOS;
           return(1);
 }  }
   
   /*
    * Parse a macro line, that is, a line beginning with the control
    * character.
    */
 static int  static int
 node_append(struct mdoc *mdoc, struct mdoc_node *p)  mdoc_pmacro(struct roff_man *mdoc, int ln, char *buf, int offs)
 {  {
           struct roff_node *n;
           const char       *cp;
           int               tok;
           int               i, sv;
           char              mac[5];
   
         assert(mdoc->last);          sv = offs;
         assert(mdoc->first);  
         assert(MDOC_ROOT != p->type);  
   
         switch (mdoc->next) {          /*
         case (MDOC_NEXT_SIBLING):           * Copy the first word into a nil-terminated buffer.
                 mdoc->last->next = p;           * Stop when a space, tab, escape, or eoln is encountered.
                 p->prev = mdoc->last;           */
                 p->parent = mdoc->last->parent;  
                 break;  
         case (MDOC_NEXT_CHILD):  
                 mdoc->last->child = p;  
                 p->parent = mdoc->last;  
                 break;  
         default:  
                 abort();  
                 /* NOTREACHED */  
         }  
   
         p->parent->nchild++;          i = 0;
           while (i < 4 && strchr(" \t\\", buf[offs]) == NULL)
                   mac[i++] = buf[offs++];
   
         if ( ! mdoc_valid_pre(mdoc, p))          mac[i] = '\0';
                 return(0);  
         if ( ! mdoc_action_pre(mdoc, p))  
                 return(0);  
   
         switch (p->type) {          tok = (i > 1 && i < 4) ? mdoc_hash_find(mac) : TOKEN_NONE;
         case (MDOC_HEAD):  
                 assert(MDOC_BLOCK == p->parent->type);          if (tok == TOKEN_NONE) {
                 p->parent->head = p;                  mandoc_msg(MANDOCERR_MACRO, mdoc->parse,
                 break;                      ln, sv, buf + sv - 1);
         case (MDOC_TAIL):                  return(1);
                 assert(MDOC_BLOCK == p->parent->type);  
                 p->parent->tail = p;  
                 break;  
         case (MDOC_BODY):  
                 assert(MDOC_BLOCK == p->parent->type);  
                 p->parent->body = p;  
                 break;  
         default:  
                 break;  
         }          }
   
         mdoc->last = p;          /* Skip a leading escape sequence or tab. */
   
         switch (p->type) {          switch (buf[offs]) {
         case (MDOC_TEXT):          case '\\':
                 if ( ! mdoc_valid_post(mdoc))                  cp = buf + offs + 1;
                         return(0);                  mandoc_escape(&cp, NULL, NULL);
                 if ( ! mdoc_action_post(mdoc))                  offs = cp - buf;
                         return(0);  
                 break;                  break;
           case '\t':
                   offs++;
                   break;
         default:          default:
                 break;                  break;
         }          }
   
         return(1);          /* Jump to the next non-whitespace word. */
 }  
   
           while (buf[offs] && ' ' == buf[offs])
                   offs++;
   
 static struct mdoc_node *          /*
 node_alloc(struct mdoc *mdoc, int line,           * Trailing whitespace.  Note that tabs are allowed to be passed
                 int pos, int tok, enum mdoc_type type)           * into the parser as "text", so we only warn about spaces here.
 {           */
         struct mdoc_node *p;  
   
         if (NULL == (p = calloc(1, sizeof(struct mdoc_node)))) {          if ('\0' == buf[offs] && ' ' == buf[offs - 1])
                 (void)mdoc_nerr(mdoc, mdoc->last, EMALLOC);                  mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse,
                 return(NULL);                      ln, offs - 1, NULL);
         }  
   
         p->sec = mdoc->lastsec;          /*
         p->line = line;           * If an initial macro or a list invocation, divert directly
         p->pos = pos;           * into macro processing.
         p->tok = tok;           */
         if (MDOC_TEXT != (p->type = type))  
                 assert(p->tok >= 0);  
   
         return(p);          if (NULL == mdoc->last || MDOC_It == tok || MDOC_El == tok) {
 }                  mdoc_macro(mdoc, tok, ln, sv, &offs, buf);
                   return(1);
           }
   
           n = mdoc->last;
 int  
 mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, int tok)  
 {  
         struct mdoc_node *p;  
   
         p = node_alloc(mdoc, line, pos, tok, MDOC_TAIL);  
         if (NULL == p)  
                 return(0);  
         return(node_append(mdoc, p));  
 }  
   
   
 int  
 mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, int tok)  
 {  
         struct mdoc_node *p;  
   
         assert(mdoc->first);  
         assert(mdoc->last);          assert(mdoc->last);
   
         p = node_alloc(mdoc, line, pos, tok, MDOC_HEAD);          /*
         if (NULL == p)           * If the first macro of a `Bl -column', open an `It' block
                 return(0);           * context around the parsed macro.
         return(node_append(mdoc, p));           */
 }  
   
           if (n->tok == MDOC_Bl && n->type == ROFFT_BODY &&
               n->end == ENDBODY_NOT && n->norm->Bl.type == LIST_column) {
                   mdoc->flags |= MDOC_FREECOL;
                   mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf);
                   return(1);
           }
   
 int          /*
 mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, int tok)           * If we're following a block-level `It' within a `Bl -column'
 {           * context (perhaps opened in the above block or in ptext()),
         struct mdoc_node *p;           * then open an `It' block context around the parsed macro.
            */
   
         p = node_alloc(mdoc, line, pos, tok, MDOC_BODY);          if (n->tok == MDOC_It && n->type == ROFFT_BLOCK &&
         if (NULL == p)              NULL != n->parent &&
                 return(0);              MDOC_Bl == n->parent->tok &&
         return(node_append(mdoc, p));              LIST_column == n->parent->norm->Bl.type) {
 }                  mdoc->flags |= MDOC_FREECOL;
                   mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf);
                   return(1);
           }
   
           /* Normal processing of a macro. */
   
 int          mdoc_macro(mdoc, tok, ln, sv, &offs, buf);
 mdoc_block_alloc(struct mdoc *mdoc, int line, int pos,  
                 int tok, struct mdoc_arg *args)  
 {  
         struct mdoc_node *p;  
   
         p = node_alloc(mdoc, line, pos, tok, MDOC_BLOCK);          /* In quick mode (for mandocdb), abort after the NAME section. */
         if (NULL == p)  
                 return(0);  
         p->args = args;  
         if (p->args)  
                 (args->refcnt)++;  
         return(node_append(mdoc, p));  
 }  
   
           if (mdoc->quick && MDOC_Sh == tok &&
               SEC_NAME != mdoc->last->sec)
                   return(2);
   
 int          return(1);
 mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos,  
                 int tok, struct mdoc_arg *args)  
 {  
         struct mdoc_node *p;  
   
         p = node_alloc(mdoc, line, pos, tok, MDOC_ELEM);  
         if (NULL == p)  
                 return(0);  
         p->args = args;  
         if (p->args)  
                 (args->refcnt)++;  
         return(node_append(mdoc, p));  
 }  }
   
   enum mdelim
 int  mdoc_isdelim(const char *p)
 mdoc_word_alloc(struct mdoc *mdoc,  
                 int line, int pos, const char *word)  
 {  {
         struct mdoc_node *p;  
   
         p = node_alloc(mdoc, line, pos, -1, MDOC_TEXT);          if ('\0' == p[0])
         if (NULL == p)                  return(DELIM_NONE);
                 return(0);  
         if (NULL == (p->string = strdup(word))) {  
                 (void)mdoc_nerr(mdoc, mdoc->last, EMALLOC);  
                 return(0);  
         }  
   
         return(node_append(mdoc, p));          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);
   
 void          if (0 == strcmp(p + 1, "."))
 mdoc_node_free(struct mdoc_node *p)                  return(DELIM_CLOSE);
 {          if (0 == strcmp(p + 1, "fR|\\fP"))
                   return(DELIM_MIDDLE);
   
         if (p->parent)          return(DELIM_NONE);
                 p->parent->nchild--;  
         if (p->string)  
                 free(p->string);  
         if (p->args)  
                 mdoc_argv_free(p->args);  
         free(p);  
 }  }
   
   
 void  void
 mdoc_node_freelist(struct mdoc_node *p)  mdoc_deroff(char **dest, const struct roff_node *n)
 {  {
           char    *cp;
           size_t   sz;
   
         if (p->child)          if (n->type != ROFFT_TEXT) {
                 mdoc_node_freelist(p->child);                  for (n = n->child; n; n = n->next)
         if (p->next)                          mdoc_deroff(dest, n);
                 mdoc_node_freelist(p->next);                  return;
   
         assert(0 == p->nchild);  
         mdoc_node_free(p);  
 }  
   
   
 /*  
  * Parse free-form text, that is, a line that does not begin with the  
  * control character.  
  */  
 static int  
 parsetext(struct mdoc *m, int line, char *buf)  
 {  
   
         if (SEC_NONE == m->lastnamed)  
                 return(mdoc_perr(m, line, 0, ETEXTPROL));  
   
         if (0 == buf[0] && ! (MDOC_LITERAL & m->flags))  
                 return(mdoc_perr(m, line, 0, ENOBLANK));  
   
         if ( ! mdoc_word_alloc(m, line, 0, buf))  
                 return(0);  
   
         m->next = MDOC_NEXT_SIBLING;  
         return(1);  
 }  
   
   
 static int  
 macrowarn(struct mdoc *m, int ln, const char *buf)  
 {  
         if ( ! (MDOC_IGN_MACRO & m->pflags))  
                 return(mdoc_verr(m, ln, 1,  
                                 "unknown macro: %s%s",  
                                 buf, strlen(buf) > 3 ? "..." : ""));  
         return(mdoc_vwarn(m, ln, 1, "unknown macro: %s%s",  
                                 buf, strlen(buf) > 3 ? "..." : ""));  
 }  
   
   
 /*  
  * Parse a macro line, that is, a line beginning with the control  
  * character.  
  */  
 int  
 parsemacro(struct mdoc *m, int ln, char *buf)  
 {  
         int               i, c;  
         char              mac[5];  
   
         /* Empty lines are ignored. */  
   
         if (0 == buf[1])  
                 return(1);  
   
         if (' ' == buf[1]) {  
                 i = 2;  
                 while (buf[i] && ' ' == buf[i])  
                         i++;  
                 if (0 == buf[i])  
                         return(1);  
                 return(mdoc_perr(m, ln, 1, ESPACE));  
         }          }
   
         /* Copy the first word into a nil-terminated buffer. */          /* Skip leading whitespace. */
   
         for (i = 1; i < 5; i++) {          for (cp = n->string; '\0' != *cp; cp++)
                 if (0 == (mac[i - 1] = buf[i]))                  if (0 == isspace((unsigned char)*cp))
                         break;                          break;
                 else if (' ' == buf[i])  
                         break;  
         }  
   
         mac[i - 1] = 0;          /* Skip trailing whitespace. */
   
         if (i == 5 || i <= 2) {          for (sz = strlen(cp); sz; sz--)
                 if ( ! macrowarn(m, ln, mac))                  if (0 == isspace((unsigned char)cp[sz-1]))
                         goto err;                          break;
                 return(1);  
         }  
   
         if (MDOC_MAX == (c = mdoc_hash_find(m->htab, mac))) {  
                 if ( ! macrowarn(m, ln, mac))  
                         goto err;  
                 return(1);  
         }  
   
         /* The macro is sane.  Jump to the next word. */          /* Skip empty strings. */
   
         while (buf[i] && ' ' == buf[i])          if (0 == sz)
                 i++;                  return;
   
         /* Begin recursive parse sequence. */          if (NULL == *dest) {
                   *dest = mandoc_strndup(cp, sz);
                   return;
           }
   
         if ( ! mdoc_macro(m, c, ln, 1, &i, buf))          mandoc_asprintf(&cp, "%s %*s", *dest, (int)sz, cp);
                 goto err;          free(*dest);
           *dest = cp;
         return(1);  
   
 err:    /* Error out. */  
   
         m->flags |= MDOC_HALT;  
         return(0);  
 }  }
Legend:
Removed from v.1.88  
changed lines
  Added in v.1.250
CVSweb