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

Diff for /mandoc/mdoc.c between version 1.154 and 1.268

version 1.154, 2010/07/01 22:56:17 version 1.268, 2017/08/11 16:56:21
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@bsd.lv>   * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
    * Copyright (c) 2010, 2012-2017 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.
  */   */
 #ifdef HAVE_CONFIG_H  
 #include "config.h"  #include "config.h"
 #endif  
   
 #include <sys/types.h>  #include <sys/types.h>
   
Line 28 
Line 27 
 #include <string.h>  #include <string.h>
 #include <time.h>  #include <time.h>
   
   #include "mandoc_aux.h"
 #include "mandoc.h"  #include "mandoc.h"
 #include "regs.h"  #include "roff.h"
 #include "libmdoc.h"  #include "mdoc.h"
 #include "libmandoc.h"  #include "libmandoc.h"
   #include "roff_int.h"
   #include "libmdoc.h"
   
 const   char *const __mdoc_macronames[MDOC_MAX] = {  const   char *const __mdoc_argnames[MDOC_ARG_MAX] = {
         "Ap",           "Dd",           "Dt",           "Os",  
         "Sh",           "Ss",           "Pp",           "D1",  
         "Dl",           "Bd",           "Ed",           "Bl",  
         "El",           "It",           "Ad",           "An",  
         "Ar",           "Cd",           "Cm",           "Dv",  
         "Er",           "Ev",           "Ex",           "Fa",  
         "Fd",           "Fl",           "Fn",           "Ft",  
         "Ic",           "In",           "Li",           "Nd",  
         "Nm",           "Op",           "Ot",           "Pa",  
         "Rv",           "St",           "Va",           "Vt",  
         /* LINTED */  
         "Xr",           "%A",           "%B",           "%D",  
         /* LINTED */  
         "%I",           "%J",           "%N",           "%O",  
         /* LINTED */  
         "%P",           "%R",           "%T",           "%V",  
         "Ac",           "Ao",           "Aq",           "At",  
         "Bc",           "Bf",           "Bo",           "Bq",  
         "Bsx",          "Bx",           "Db",           "Dc",  
         "Do",           "Dq",           "Ec",           "Ef",  
         "Em",           "Eo",           "Fx",           "Ms",  
         "No",           "Ns",           "Nx",           "Ox",  
         "Pc",           "Pf",           "Po",           "Pq",  
         "Qc",           "Ql",           "Qo",           "Qq",  
         "Re",           "Rs",           "Sc",           "So",  
         "Sq",           "Sm",           "Sx",           "Sy",  
         "Tn",           "Ux",           "Xc",           "Xo",  
         "Fo",           "Fc",           "Oo",           "Oc",  
         "Bk",           "Ek",           "Bt",           "Hf",  
         "Fr",           "Ud",           "Lb",           "Lp",  
         "Lk",           "Mt",           "Brq",          "Bro",  
         /* LINTED */  
         "Brc",          "%C",           "Es",           "En",  
         /* LINTED */  
         "Dx",           "%Q",           "br",           "sp",  
         /* LINTED */  
         "%U",           "Ta"  
         };  
   
 const   char *const __mdoc_argnames[MDOC_ARG_MAX] = {  
         "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",               "centered"          "symbolic",             "nested",               "centered"
         };  };
   
 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  int               mdoc_ptext(struct roff_man *, int, char *, int);
 static  void              mdoc_node_unlink(struct mdoc *,  static  int               mdoc_pmacro(struct roff_man *, int, char *, int);
                                 struct mdoc_node *);  
 static  void              mdoc_free1(struct mdoc *);  
 static  void              mdoc_alloc1(struct mdoc *);  
 static  struct mdoc_node *node_alloc(struct mdoc *, int, int,  
                                 enum mdoct, enum mdoc_type);  
 static  int               node_append(struct mdoc *,  
                                 struct mdoc_node *);  
 static  int               mdoc_ptext(struct mdoc *, int, char *, int);  
 static  int               mdoc_pmacro(struct mdoc *, int, char *, int);  
 static  int               macrowarn(struct mdoc *, int,  
                                 const char *, int);  
   
   
 const struct mdoc_node *  
 mdoc_node(const struct mdoc *m)  
 {  
   
         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);  
         if (mdoc->meta.msec)  
                 free(mdoc->meta.msec);  
 }  
   
   
 /*  
  * Allocate all volatile resources (parse tree, meta-data, fields).  
  */  
 static void  
 mdoc_alloc1(struct mdoc *mdoc)  
 {  
   
         memset(&mdoc->meta, 0, sizeof(struct mdoc_meta));  
         mdoc->flags = 0;  
         mdoc->lastnamed = mdoc->lastsec = SEC_NONE;  
         mdoc->last = mandoc_calloc(1, sizeof(struct mdoc_node));  
         mdoc->first = mdoc->last;  
         mdoc->last->type = MDOC_ROOT;  
         mdoc->next = MDOC_NEXT_CHILD;  
 }  
   
   
 /*  
  * Free up volatile resources (see mdoc_free1()) then re-initialises the  
  * data with mdoc_alloc1().  After invocation, parse data has been reset  
  * and the parser is ready for re-invocation on a new tree; however,  
  * cross-parse non-volatile data is kept intact.  
  */  
 void  
 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_free1(mdoc);  
         free(mdoc);  
 }  
   
   
 /*  
  * Allocate volatile and non-volatile parse resources.  
  */  
 struct mdoc *  
 mdoc_alloc(struct regset *regs, void *data,  
                 int pflags, mandocmsg msg)  
 {  
         struct mdoc     *p;  
   
         p = mandoc_calloc(1, sizeof(struct mdoc));  
   
         p->msg = msg;  
         p->data = data;  
         p->pflags = pflags;  
         p->regs = regs;  
   
         mdoc_hash_init();  
         mdoc_alloc1(p);  
         return(p);  
 }  
   
   
 /*  
  * Climb back up the parse tree, validating open scopes.  Mostly calls  
  * through to macro_end() in macro.c.  
  */  
 int  
 mdoc_endparse(struct mdoc *m)  
 {  
   
         if (MDOC_HALT & m->flags)  
                 return(0);  
         else if (mdoc_macroend(m))  
                 return(1);  
         m->flags |= MDOC_HALT;  
         return(0);  
 }  
   
   
 /*  
  * Main parse routine.  Parses a single line -- really just hands off to   * Main parse routine.  Parses a single line -- really just hands off to
  * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()).   * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()).
  */   */
 int  int
 mdoc_parseln(struct mdoc *m, int ln, char *buf, int offs)  mdoc_parseln(struct roff_man *mdoc, int ln, char *buf, int offs)
 {  {
   
         if (MDOC_HALT & m->flags)          if (mdoc->last->type != ROFFT_EQN || ln > mdoc->last->line)
                 return(0);                  mdoc->flags |= MDOC_NEWLINE;
   
         m->flags |= MDOC_NEWLINE;  
   
         /*          /*
          * Let the roff nS register switch SYNOPSIS mode early,           * Let the roff nS register switch SYNOPSIS mode early,
          * such that the parser knows at all times           * such that the parser knows at all times
          * whether this mode is on or off.           * whether this mode is on or off.
          * Note that this mode is also switched by the Sh macro.           * Note that this mode is also switched by the Sh macro.
          */           */
         if (m->regs->regs[(int)REG_nS].set) {          if (roff_getreg(mdoc->roff, "nS"))
                 if (m->regs->regs[(int)REG_nS].v.u)                  mdoc->flags |= MDOC_SYNOPSIS;
                         m->flags |= MDOC_SYNOPSIS;          else
                 else                  mdoc->flags &= ~MDOC_SYNOPSIS;
                         m->flags &= ~MDOC_SYNOPSIS;  
         }  
   
         return(('.' == buf[offs] || '\'' == buf[offs]) ?          return roff_getcontrol(mdoc->roff, buf, &offs) ?
                         mdoc_pmacro(m, ln, buf, offs) :              mdoc_pmacro(mdoc, ln, buf, offs) :
                         mdoc_ptext(m, ln, buf, offs));              mdoc_ptext(mdoc, ln, buf, offs);
 }  }
   
   void
 int  
 mdoc_vmsg(struct mdoc *mdoc, enum mandocerr t,  
                 int ln, int pos, const char *fmt, ...)  
 {  
         char             buf[256];  
         va_list          ap;  
   
         va_start(ap, fmt);  
         vsnprintf(buf, sizeof(buf) - 1, fmt, ap);  
         va_end(ap);  
   
         return((*mdoc->msg)(t, mdoc->data, ln, pos, buf));  
 }  
   
   
 int  
 mdoc_macro(MACRO_PROT_ARGS)  mdoc_macro(MACRO_PROT_ARGS)
 {  {
         assert(tok < MDOC_MAX);          assert(tok >= MDOC_Dd && tok < MDOC_MAX);
           (*mdoc_macros[tok].fp)(mdoc, tok, line, ppos, pos, buf);
         /* If we're in the body, deny prologue calls. */  
   
         if (MDOC_PROLOGUE & mdoc_macros[tok].flags &&  
                         MDOC_PBODY & m->flags)  
                 return(mdoc_pmsg(m, line, ppos, MANDOCERR_BADBODY));  
   
         /* If we're in the prologue, deny "body" macros.  */  
   
         if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) &&  
                         ! (MDOC_PBODY & m->flags)) {  
                 if ( ! mdoc_pmsg(m, line, ppos, MANDOCERR_BADPROLOG))  
                         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, line, ppos, pos, buf));  
 }  }
   
   void
 static int  mdoc_tail_alloc(struct roff_man *mdoc, int line, int pos, enum roff_tok tok)
 node_append(struct mdoc *mdoc, struct mdoc_node *p)  
 {  {
           struct roff_node *p;
   
         assert(mdoc->last);          p = roff_node_alloc(mdoc, line, pos, ROFFT_TAIL, tok);
         assert(mdoc->first);          roff_node_append(mdoc, p);
         assert(MDOC_ROOT != p->type);          mdoc->next = ROFF_NEXT_CHILD;
   
         switch (mdoc->next) {  
         case (MDOC_NEXT_SIBLING):  
                 mdoc->last->next = p;  
                 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++;  
   
         if ( ! mdoc_valid_pre(mdoc, p))  
                 return(0);  
         if ( ! mdoc_action_pre(mdoc, p))  
                 return(0);  
   
         switch (p->type) {  
         case (MDOC_HEAD):  
                 assert(MDOC_BLOCK == p->parent->type);  
                 p->parent->head = p;  
                 break;  
         case (MDOC_TAIL):  
                 assert(MDOC_BLOCK == p->parent->type);  
                 p->parent->tail = p;  
                 break;  
         case (MDOC_BODY):  
                 if (p->end)  
                         break;  
                 assert(MDOC_BLOCK == p->parent->type);  
                 p->parent->body = p;  
                 break;  
         default:  
                 break;  
         }  
   
         mdoc->last = p;  
   
         switch (p->type) {  
         case (MDOC_TEXT):  
                 if ( ! mdoc_valid_post(mdoc))  
                         return(0);  
                 if ( ! mdoc_action_post(mdoc))  
                         return(0);  
                 break;  
         default:  
                 break;  
         }  
   
         return(1);  
 }  }
   
   struct roff_node *
 static struct mdoc_node *  mdoc_endbody_alloc(struct roff_man *mdoc, int line, int pos,
 node_alloc(struct mdoc *m, int line, int pos,      enum roff_tok tok, struct roff_node *body)
                 enum mdoct tok, enum mdoc_type type)  
 {  {
         struct mdoc_node *p;          struct roff_node *p;
   
         p = mandoc_calloc(1, sizeof(struct mdoc_node));          body->flags |= NODE_ENDED;
         p->sec = m->lastsec;          body->parent->flags |= NODE_ENDED;
         p->line = line;          p = roff_node_alloc(mdoc, line, pos, ROFFT_BODY, tok);
         p->pos = pos;          p->body = body;
         p->tok = tok;          p->norm = body->norm;
         p->type = type;          p->end = ENDBODY_SPACE;
           roff_node_append(mdoc, p);
         /* Flag analysis. */          mdoc->next = ROFF_NEXT_SIBLING;
           return p;
         if (MDOC_SYNOPSIS & m->flags)  
                 p->flags |= MDOC_SYNPRETTY;  
         else  
                 p->flags &= ~MDOC_SYNPRETTY;  
         if (MDOC_NEWLINE & m->flags)  
                 p->flags |= MDOC_LINE;  
         m->flags &= ~MDOC_NEWLINE;  
   
         return(p);  
 }  }
   
   struct roff_node *
 int  mdoc_block_alloc(struct roff_man *mdoc, int line, int pos,
 mdoc_tail_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)      enum roff_tok tok, struct mdoc_arg *args)
 {  {
         struct mdoc_node *p;          struct roff_node *p;
   
         p = node_alloc(m, line, pos, tok, MDOC_TAIL);          p = roff_node_alloc(mdoc, line, pos, ROFFT_BLOCK, tok);
         if ( ! node_append(m, p))  
                 return(0);  
         m->next = MDOC_NEXT_CHILD;  
         return(1);  
 }  
   
   
 int  
 mdoc_head_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)  
 {  
         struct mdoc_node *p;  
   
         assert(m->first);  
         assert(m->last);  
   
         p = node_alloc(m, line, pos, tok, MDOC_HEAD);  
         if ( ! node_append(m, p))  
                 return(0);  
         m->next = MDOC_NEXT_CHILD;  
         return(1);  
 }  
   
   
 int  
 mdoc_body_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)  
 {  
         struct mdoc_node *p;  
   
         p = node_alloc(m, line, pos, tok, MDOC_BODY);  
         if ( ! node_append(m, p))  
                 return(0);  
         m->next = MDOC_NEXT_CHILD;  
         return(1);  
 }  
   
   
 int  
 mdoc_endbody_alloc(struct mdoc *m, int line, int pos, enum mdoct tok,  
                 struct mdoc_node *body, enum mdoc_endbody end)  
 {  
         struct mdoc_node *p;  
   
         p = node_alloc(m, line, pos, tok, MDOC_BODY);  
         p->pending = body;  
         p->end = end;  
         if ( ! node_append(m, p))  
                 return(0);  
         m->next = MDOC_NEXT_SIBLING;  
         return(1);  
 }  
   
   
 int  
 mdoc_block_alloc(struct mdoc *m, int line, int pos,  
                 enum mdoct tok, struct mdoc_arg *args)  
 {  
         struct mdoc_node *p;  
   
         p = node_alloc(m, line, pos, tok, MDOC_BLOCK);  
         p->args = args;          p->args = args;
         if (p->args)          if (p->args)
                 (args->refcnt)++;                  (args->refcnt)++;
         if ( ! node_append(m, p))  
                 return(0);          switch (tok) {
         m->next = MDOC_NEXT_CHILD;          case MDOC_Bd:
         return(1);          case MDOC_Bf:
           case MDOC_Bl:
           case MDOC_En:
           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
 int  mdoc_elem_alloc(struct roff_man *mdoc, int line, int pos,
 mdoc_elem_alloc(struct mdoc *m, int line, int pos,       enum roff_tok tok, struct mdoc_arg *args)
                 enum mdoct tok, struct mdoc_arg *args)  
 {  {
         struct mdoc_node *p;          struct roff_node *p;
   
         p = node_alloc(m, line, pos, tok, MDOC_ELEM);          p = roff_node_alloc(mdoc, line, pos, ROFFT_ELEM, tok);
         p->args = args;          p->args = args;
         if (p->args)          if (p->args)
                 (args->refcnt)++;                  (args->refcnt)++;
         if ( ! node_append(m, p))  
                 return(0);  
         m->next = MDOC_NEXT_CHILD;  
         return(1);  
 }  
   
           switch (tok) {
 int          case MDOC_An:
 mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p)                  p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
 {                  break;
         struct mdoc_node *n;          default:
         size_t            sv, len;                  break;
   
         len = strlen(p);  
   
         n = node_alloc(m, line, pos, MDOC_MAX, MDOC_TEXT);  
         n->string = mandoc_malloc(len + 1);  
         sv = strlcpy(n->string, p, len + 1);  
   
         /* Prohibit truncation. */  
         assert(sv < len + 1);  
   
         if ( ! node_append(m, n))  
                 return(0);  
   
         m->next = MDOC_NEXT_SIBLING;  
         return(1);  
 }  
   
   
 /* FIXME: put in mdoc_node_delete(). */  
 void  
 mdoc_node_free(struct mdoc_node *p)  
 {  
   
         if (MDOC_Bd == p->tok && MDOC_BLOCK == p->type)  
                 if (p->data.Bd)  
                         free(p->data.Bd);  
         if (MDOC_Bl == p->tok && MDOC_BLOCK == p->type)  
                 if (p->data.Bl)  
                         free(p->data.Bl);  
   
         if (p->string)  
                 free(p->string);  
         if (p->args)  
                 mdoc_argv_free(p->args);  
         free(p);  
 }  
   
   
 static void  
 mdoc_node_unlink(struct mdoc *m, 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;  
         }          }
           roff_node_append(mdoc, p);
         /* Adjust parse point, if applicable. */          mdoc->next = ROFF_NEXT_CHILD;
   
         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_delete(struct mdoc *m, struct mdoc_node *p)  mdoc_node_relink(struct roff_man *mdoc, struct roff_node *p)
 {  {
   
         while (p->child) {          roff_node_unlink(mdoc, p);
                 assert(p->nchild);          p->prev = p->next = NULL;
                 mdoc_node_delete(m, p->child);          roff_node_append(mdoc, p);
         }  
         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   * Parse free-form text, that is, a line that does not begin with the
  * control character.   * control character.
  */   */
 static int  static int
 mdoc_ptext(struct mdoc *m, int line, char *buf, int offs)  mdoc_ptext(struct roff_man *mdoc, int line, char *buf, int offs)
 {  {
           struct roff_node *n;
           const char       *cp, *sp;
         char             *c, *ws, *end;          char             *c, *ws, *end;
         struct mdoc_node *n;  
   
         /* Ignore bogus comments. */          n = mdoc->last;
   
         if ('\\' == buf[offs] &&  
                         '.' == buf[offs + 1] &&  
                         '"' == buf[offs + 2])  
                 return(mdoc_pmsg(m, line, offs, MANDOCERR_BADCOMMENT));  
   
         /* No text before an initial macro. */  
   
         if (SEC_NONE == m->lastnamed)  
                 return(mdoc_pmsg(m, line, offs, MANDOCERR_NOTEXT));  
   
         assert(m->last);  
         n = m->last;  
   
         /*          /*
          * Divert directly to list processing if we're encountering a           * If a column list contains plain text, assume an implicit item
          * columnar MDOC_BLOCK with or without a prior MDOC_BLOCK entry           * macro.  This can happen one or more times at the beginning
          * (a MDOC_BODY means it's already open, in which case we should           * of such a list, intermixed with non-It mdoc macros and with
          * process within its context in the normal way).           * nodes generated on the roff level, for example by tbl.
          */           */
   
         if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&          if ((n->tok == MDOC_Bl && n->type == ROFFT_BODY &&
                         LIST_column == n->data.Bl->type) {               n->end == ENDBODY_NOT && n->norm->Bl.type == LIST_column) ||
                 /* `Bl' is open without any children. */              (n->parent != NULL && n->parent->tok == MDOC_Bl &&
                 m->flags |= MDOC_FREECOL;               n->parent->norm->Bl.type == LIST_column)) {
                 return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf));                  mdoc->flags |= MDOC_FREECOL;
                   mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf);
                   return 1;
         }          }
   
         if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&  
                         NULL != n->parent &&  
                         MDOC_Bl == n->parent->tok &&  
                         LIST_column == n->parent->data.Bl->type) {  
                 /* `Bl' has block-level `It' children. */  
                 m->flags |= MDOC_FREECOL;  
                 return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf));  
         }  
   
         /*          /*
          * Search for the beginning of unescaped trailing whitespace (ws)           * Search for the beginning of unescaped trailing whitespace (ws)
          * and for the first character not to be output (end).           * and for the first character not to be output (end).
Line 642  mdoc_ptext(struct mdoc *m, int line, char *buf, int of
Line 209  mdoc_ptext(struct mdoc *m, int line, char *buf, int of
         ws = NULL;          ws = NULL;
         for (c = end = buf + offs; *c; c++) {          for (c = end = buf + offs; *c; c++) {
                 switch (*c) {                  switch (*c) {
                 case '-':  
                         if (mandoc_hyph(buf + offs, c))  
                                 *c = ASCII_HYPH;  
                         ws = NULL;  
                         break;  
                 case ' ':                  case ' ':
                         if (NULL == ws)                          if (NULL == ws)
                                 ws = c;                                  ws = c;
Line 663  mdoc_ptext(struct mdoc *m, int line, char *buf, int of
Line 225  mdoc_ptext(struct mdoc *m, int line, char *buf, int of
                          * Strip trailing tabs in literal context only;                           * Strip trailing tabs in literal context only;
                          * outside, they affect the next line.                           * outside, they affect the next line.
                          */                           */
                         if (MDOC_LITERAL & m->flags)                          if (MDOC_LITERAL & mdoc->flags)
                                 continue;                                  continue;
                         break;                          break;
                 case '\\':                  case '\\':
Line 680  mdoc_ptext(struct mdoc *m, int line, char *buf, int of
Line 242  mdoc_ptext(struct mdoc *m, int line, char *buf, int of
         *end = '\0';          *end = '\0';
   
         if (ws)          if (ws)
                 if ( ! mdoc_pmsg(m, line, (int)(ws-buf), MANDOCERR_EOLNSPACE))                  mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse,
                         return(0);                      line, (int)(ws-buf), NULL);
   
         if ('\0' == buf[offs] && ! (MDOC_LITERAL & m->flags)) {          /*
                 if ( ! mdoc_pmsg(m, line, (int)(c-buf), MANDOCERR_NOBLANKLN))           * Blank lines are allowed in no-fill mode
                         return(0);           * and cancel preceding \c,
            * but add a single vertical space elsewhere.
            */
   
                 /*          if (buf[offs] == '\0' && ! (mdoc->flags & MDOC_LITERAL)) {
                  * Insert a `Pp' in the case of a blank line.  Technically,                  switch (mdoc->last->type) {
                  * blank lines aren't allowed, but enough manuals assume this                  case ROFFT_TEXT:
                  * behaviour that we want to work around it.                          sp = mdoc->last->string;
                  */                          cp = end = strchr(sp, '\0') - 2;
                 if ( ! mdoc_elem_alloc(m, line, offs, MDOC_Pp, NULL))                          if (cp < sp || cp[0] != '\\' || cp[1] != 'c')
                         return(0);                                  break;
                           while (cp > sp && cp[-1] == '\\')
                 m->next = MDOC_NEXT_SIBLING;                                  cp--;
                 return(1);                          if ((end - cp) % 2)
                                   break;
                           *end = '\0';
                           return 1;
                   default:
                           break;
                   }
                   mandoc_msg(MANDOCERR_FI_BLANK, mdoc->parse,
                       line, (int)(c - buf), NULL);
                   roff_elem_alloc(mdoc, line, offs, ROFF_sp);
                   mdoc->last->flags |= NODE_VALID | NODE_ENDED;
                   mdoc->next = ROFF_NEXT_SIBLING;
                   return 1;
         }          }
   
         if ( ! mdoc_word_alloc(m, line, offs, buf+offs))          roff_word_alloc(mdoc, line, offs, buf+offs);
                 return(0);  
   
         if (MDOC_LITERAL & m->flags)          if (mdoc->flags & MDOC_LITERAL)
                 return(1);                  return 1;
   
         /*          /*
          * End-of-sentence check.  If the last character is an unescaped           * End-of-sentence check.  If the last character is an unescaped
Line 714  mdoc_ptext(struct mdoc *m, int line, char *buf, int of
Line 289  mdoc_ptext(struct mdoc *m, int line, char *buf, int of
         assert(buf < end);          assert(buf < end);
   
         if (mandoc_eos(buf+offs, (size_t)(end-buf-offs)))          if (mandoc_eos(buf+offs, (size_t)(end-buf-offs)))
                 m->last->flags |= MDOC_EOS;                  mdoc->last->flags |= NODE_EOS;
   
         return(1);          for (c = buf + offs; c != NULL; c = strchr(c + 1, '.')) {
 }                  if (c - buf < offs + 2)
                           continue;
                   if (end - c < 3)
                           break;
                   if (c[1] != ' ' ||
                       isalnum((unsigned char)c[-2]) == 0 ||
                       isalnum((unsigned char)c[-1]) == 0 ||
                       (c[-2] == 'n' && c[-1] == 'c') ||
                       (c[-2] == 'v' && c[-1] == 's'))
                           continue;
                   c += 2;
                   if (*c == ' ')
                           c++;
                   if (*c == ' ')
                           c++;
                   if (isupper((unsigned char)(*c)))
                           mandoc_msg(MANDOCERR_EOS, mdoc->parse,
                               line, (int)(c - buf), NULL);
           }
   
           return 1;
 static int  
 macrowarn(struct mdoc *m, int ln, const char *buf, int offs)  
 {  
         int              rc;  
   
         rc = mdoc_vmsg(m, MANDOCERR_MACRO, ln, offs,  
                         "unknown macro: %s%s",  
                         buf, strlen(buf) > 3 ? "..." : "");  
   
         /* FIXME: logic should be in driver. */  
         /* FIXME: broken, will error out and not omit a message. */  
         return(MDOC_IGN_MACRO & m->pflags ? rc : 0);  
 }  }
   
   
 /*  /*
  * 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
 mdoc_pmacro(struct mdoc *m, int ln, char *buf, int offs)  mdoc_pmacro(struct roff_man *mdoc, int ln, char *buf, int offs)
 {  {
         enum mdoct        tok;          struct roff_node *n;
         int               i, j, sv;          const char       *cp;
         char              mac[5];          size_t            sz;
         struct mdoc_node *n;          enum roff_tok     tok;
           int               sv;
   
         /* Empty lines are ignored. */          /* Determine the line macro. */
   
         offs++;          sv = offs;
           tok = TOKEN_NONE;
         if ('\0' == buf[offs])          for (sz = 0; sz < 4 && strchr(" \t\\", buf[offs]) == NULL; sz++)
                 return(1);                  offs++;
           if (sz == 2 || sz == 3)
         i = offs;                  tok = roffhash_find(mdoc->mdocmac, buf + sv, sz);
           if (tok == TOKEN_NONE) {
         /* Accept whitespace after the initial control char. */                  mandoc_msg(MANDOCERR_MACRO, mdoc->parse,
                       ln, sv, buf + sv - 1);
         if (' ' == buf[i]) {                  return 1;
                 i++;  
                 while (buf[i] && ' ' == buf[i])  
                         i++;  
                 if ('\0' == buf[i])  
                         return(1);  
         }          }
   
         sv = i;          /* Skip a leading escape sequence or tab. */
   
         /* Copy the first word into a nil-terminated buffer. */          switch (buf[offs]) {
           case '\\':
         for (j = 0; j < 4; j++, i++) {                  cp = buf + offs + 1;
                 if ('\0' == (mac[j] = buf[i]))                  mandoc_escape(&cp, NULL, NULL);
                         break;                  offs = cp - buf;
                 else if (' ' == buf[i])                  break;
                         break;          case '\t':
                   offs++;
                 /* Check for invalid characters. */                  break;
           default:
                 if (isgraph((u_char)buf[i]))                  break;
                         continue;  
                 if ( ! mdoc_pmsg(m, ln, i, MANDOCERR_BADCHAR))  
                         return(0);  
                 i--;  
         }          }
   
         mac[j] = '\0';          /* Jump to the next non-whitespace word. */
   
         if (j == 4 || j < 2) {          while (buf[offs] == ' ')
                 if ( ! macrowarn(m, ln, mac, sv))                  offs++;
                         goto err;  
                 return(1);  
         }  
   
         if (MDOC_MAX == (tok = mdoc_hash_find(mac))) {  
                 if ( ! macrowarn(m, ln, mac, sv))  
                         goto err;  
                 return(1);  
         }  
   
         /* The macro is sane.  Jump to the next word. */          /*
   
         while (buf[i] && ' ' == buf[i])  
                 i++;  
   
         /*  
          * Trailing whitespace.  Note that tabs are allowed to be passed           * Trailing whitespace.  Note that tabs are allowed to be passed
          * into the parser as "text", so we only warn about spaces here.           * into the parser as "text", so we only warn about spaces here.
          */           */
   
         if ('\0' == buf[i] && ' ' == buf[i - 1])          if ('\0' == buf[offs] && ' ' == buf[offs - 1])
                 if ( ! mdoc_pmsg(m, ln, i - 1, MANDOCERR_EOLNSPACE))                  mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse,
                         goto err;                      ln, offs - 1, NULL);
   
         /*          /*
          * If an initial macro or a list invocation, divert directly           * If an initial macro or a list invocation, divert directly
          * into macro processing.           * into macro processing.
          */           */
   
         if (NULL == m->last || MDOC_It == tok || MDOC_El == tok) {          n = mdoc->last;
                 if ( ! mdoc_macro(m, tok, ln, sv, &i, buf))          if (n == NULL || tok == MDOC_It || tok == MDOC_El) {
                         goto err;                  mdoc_macro(mdoc, tok, ln, sv, &offs, buf);
                 return(1);                  return 1;
         }          }
   
         n = m->last;  
         assert(m->last);  
   
         /*          /*
          * If the first macro of a `Bl -column', open an `It' block           * If a column list contains a non-It macro, assume an implicit
          * context around the parsed macro.           * item macro.  This can happen one or more times at the
            * beginning of such a list, intermixed with text lines and
            * with nodes generated on the roff level, for example by tbl.
          */           */
   
         if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&          if ((n->tok == MDOC_Bl && n->type == ROFFT_BODY &&
                         LIST_column == n->data.Bl->type) {               n->end == ENDBODY_NOT && n->norm->Bl.type == LIST_column) ||
                 m->flags |= MDOC_FREECOL;              (n->parent != NULL && n->parent->tok == MDOC_Bl &&
                 if ( ! mdoc_macro(m, MDOC_It, ln, sv, &sv, buf))               n->parent->norm->Bl.type == LIST_column)) {
                         goto err;                  mdoc->flags |= MDOC_FREECOL;
                 return(1);                  mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf);
                   return 1;
         }          }
   
         /*          /* Normal processing of a macro. */
          * If we're following a block-level `It' within a `Bl -column'  
          * context (perhaps opened in the above block or in ptext()),  
          * then open an `It' block context around the parsed macro.  
          */  
   
         if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&          mdoc_macro(mdoc, tok, ln, sv, &offs, buf);
                         NULL != n->parent &&  
                         MDOC_Bl == n->parent->tok &&  
                         LIST_column == n->parent->data.Bl->type) {  
                 m->flags |= MDOC_FREECOL;  
                 if ( ! mdoc_macro(m, MDOC_It, ln, sv, &sv, buf))  
                         goto err;  
                 return(1);  
         }  
   
         /* Normal processing of a macro. */          /* In quick mode (for mandocdb), abort after the NAME section. */
   
         if ( ! mdoc_macro(m, tok, ln, sv, &i, buf))          if (mdoc->quick && MDOC_Sh == tok &&
                 goto err;              SEC_NAME != mdoc->last->sec)
                   return 2;
   
         return(1);          return 1;
   }
   
 err:    /* Error out. */  enum mdelim
   mdoc_isdelim(const char *p)
   {
   
         m->flags |= MDOC_HALT;          if ('\0' == p[0])
         return(0);                  return DELIM_NONE;
   
           if ('\0' == p[1])
                   switch (p[0]) {
                   case '(':
                   case '[':
                           return DELIM_OPEN;
                   case '|':
                           return DELIM_MIDDLE;
                   case '.':
                   case ',':
                   case ';':
                   case ':':
                   case '?':
                   case '!':
                   case ')':
                   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;
 }  }
   
   void
   mdoc_validate(struct roff_man *mdoc)
   {
   
           mdoc->last = mdoc->first;
           mdoc_node_validate(mdoc);
           mdoc_state_reset(mdoc);
   }
Legend:
Removed from v.1.154  
changed lines
  Added in v.1.268
CVSweb