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

Diff for /mandoc/man_macro.c between version 1.44 and 1.81

version 1.44, 2010/05/15 22:44:04 version 1.81, 2014/03/30 19:47:48
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) 2012, 2013 Ingo Schwarze <schwarze@openbsd.org>
    * Copyright (c) 2013 Franco Fichtner <franco@lastsummer.de>
  *   *
  * 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
Line 23 
Line 25 
 #include <stdlib.h>  #include <stdlib.h>
 #include <string.h>  #include <string.h>
   
   #include "man.h"
   #include "mandoc.h"
   #include "libmandoc.h"
 #include "libman.h"  #include "libman.h"
   
 enum    rew {  enum    rew {
Line 35  static int   blk_close(MACRO_PROT_ARGS);
Line 40  static int   blk_close(MACRO_PROT_ARGS);
 static  int              blk_exp(MACRO_PROT_ARGS);  static  int              blk_exp(MACRO_PROT_ARGS);
 static  int              blk_imp(MACRO_PROT_ARGS);  static  int              blk_imp(MACRO_PROT_ARGS);
 static  int              in_line_eoln(MACRO_PROT_ARGS);  static  int              in_line_eoln(MACRO_PROT_ARGS);
   static  int              man_args(struct man *, int,
                                   int *, char *, char **);
   
 static  int              rew_scope(enum man_type,  static  int              rew_scope(enum man_type,
                                 struct man *, enum mant);                                  struct man *, enum mant);
Line 42  static enum rew  rew_dohalt(enum mant, enum man_type, 
Line 49  static enum rew  rew_dohalt(enum mant, enum man_type, 
                                 const struct man_node *);                                  const struct man_node *);
 static  enum rew         rew_block(enum mant, enum man_type,  static  enum rew         rew_block(enum mant, enum man_type,
                                 const struct man_node *);                                  const struct man_node *);
 static  int              rew_warn(struct man *,  static  void             rew_warn(struct man *,
                                 struct man_node *, enum merr);                                  struct man_node *, enum mandocerr);
   
 const   struct man_macro __man_macros[MAN_MAX] = {  const   struct man_macro __man_macros[MAN_MAX] = {
         { in_line_eoln, MAN_NSCOPED }, /* br */          { in_line_eoln, MAN_NSCOPED }, /* br */
         { in_line_eoln, 0 }, /* TH */          { in_line_eoln, MAN_BSCOPE }, /* TH */
         { blk_imp, MAN_SCOPED }, /* SH */          { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SH */
         { blk_imp, MAN_SCOPED }, /* SS */          { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SS */
         { blk_imp, MAN_SCOPED | MAN_FSCOPED }, /* TP */          { blk_imp, MAN_BSCOPE | MAN_SCOPED | MAN_FSCOPED }, /* TP */
         { blk_imp, 0 }, /* LP */          { blk_imp, MAN_BSCOPE }, /* LP */
         { blk_imp, 0 }, /* PP */          { blk_imp, MAN_BSCOPE }, /* PP */
         { blk_imp, 0 }, /* P */          { blk_imp, MAN_BSCOPE }, /* P */
         { blk_imp, 0 }, /* IP */          { blk_imp, MAN_BSCOPE }, /* IP */
         { blk_imp, 0 }, /* HP */          { blk_imp, MAN_BSCOPE }, /* HP */
         { in_line_eoln, MAN_SCOPED }, /* SM */          { in_line_eoln, MAN_SCOPED }, /* SM */
         { in_line_eoln, MAN_SCOPED }, /* SB */          { in_line_eoln, MAN_SCOPED }, /* SB */
         { in_line_eoln, 0 }, /* BI */          { in_line_eoln, 0 }, /* BI */
Line 68  const struct man_macro __man_macros[MAN_MAX] = {
Line 75  const struct man_macro __man_macros[MAN_MAX] = {
         { in_line_eoln, 0 }, /* IR */          { in_line_eoln, 0 }, /* IR */
         { in_line_eoln, 0 }, /* RI */          { in_line_eoln, 0 }, /* RI */
         { in_line_eoln, MAN_NSCOPED }, /* na */          { in_line_eoln, MAN_NSCOPED }, /* na */
         { in_line_eoln, 0 }, /* i */  
         { in_line_eoln, MAN_NSCOPED }, /* sp */          { in_line_eoln, MAN_NSCOPED }, /* sp */
         { in_line_eoln, 0 }, /* nf */          { in_line_eoln, MAN_BSCOPE }, /* nf */
         { in_line_eoln, 0 }, /* fi */          { in_line_eoln, MAN_BSCOPE }, /* fi */
         { in_line_eoln, 0 }, /* r */  
         { blk_close, 0 }, /* RE */          { blk_close, 0 }, /* RE */
         { blk_exp, MAN_EXPLICIT }, /* RS */          { blk_exp, MAN_BSCOPE | MAN_EXPLICIT }, /* RS */
         { in_line_eoln, 0 }, /* DT */          { in_line_eoln, 0 }, /* DT */
         { in_line_eoln, 0 }, /* UC */          { in_line_eoln, 0 }, /* UC */
         { in_line_eoln, 0 }, /* PD */          { in_line_eoln, 0 }, /* PD */
         { in_line_eoln, MAN_NSCOPED }, /* Sp */          { in_line_eoln, 0 }, /* AT */
         { in_line_eoln, 0 }, /* Vb */          { in_line_eoln, 0 }, /* in */
         { in_line_eoln, 0 }, /* Ve */          { in_line_eoln, 0 }, /* ft */
           { in_line_eoln, 0 }, /* OP */
           { in_line_eoln, MAN_BSCOPE }, /* EX */
           { in_line_eoln, MAN_BSCOPE }, /* EE */
           { blk_exp, MAN_BSCOPE | MAN_EXPLICIT }, /* UR */
           { blk_close, 0 }, /* UE */
           { in_line_eoln, 0 }, /* ll */
 };  };
   
 const   struct man_macro * const man_macros = __man_macros;  const   struct man_macro * const man_macros = __man_macros;
Line 89  const struct man_macro * const man_macros = __man_macr
Line 100  const struct man_macro * const man_macros = __man_macr
 /*  /*
  * Warn when "n" is an explicit non-roff macro.   * Warn when "n" is an explicit non-roff macro.
  */   */
 static int  static void
 rew_warn(struct man *m, struct man_node *n, enum merr er)  rew_warn(struct man *man, struct man_node *n, enum mandocerr er)
 {  {
   
         if (er == WERRMAX || MAN_BLOCK != n->type)          if (er == MANDOCERR_MAX || MAN_BLOCK != n->type)
                 return(1);                  return;
         if (MAN_VALID & n->flags)          if (MAN_VALID & n->flags)
                 return(1);                  return;
         if ( ! (MAN_EXPLICIT & man_macros[n->tok].flags))          if ( ! (MAN_EXPLICIT & man_macros[n->tok].flags))
                 return(1);                  return;
         return(man_nwarn(m, n, er));  
           assert(er < MANDOCERR_FATAL);
           man_nmsg(man, n, er);
 }  }
   
   
 /*  /*
  * Rewind scope.  If a code "er" != WERRMAX has been provided, it will   * Rewind scope.  If a code "er" != MANDOCERR_MAX has been provided, it
  * be used if an explicit block scope is being closed out.   * will be used if an explicit block scope is being closed out.
  */   */
 int  int
 man_unscope(struct man *m, const struct man_node *n, enum merr er)  man_unscope(struct man *man, const struct man_node *to,
                   enum mandocerr er)
 {  {
           struct man_node *n;
   
         assert(n);          assert(to);
   
           man->next = MAN_NEXT_SIBLING;
   
         /* LINTED */          /* LINTED */
         while (m->last != n) {          while (man->last != to) {
                 if ( ! rew_warn(m, m->last, er))                  /*
                    * Save the parent here, because we may delete the
                    * man->last node in the post-validation phase and reset
                    * it to man->last->parent, causing a step in the closing
                    * out to be lost.
                    */
                   n = man->last->parent;
                   rew_warn(man, man->last, er);
                   if ( ! man_valid_post(man))
                         return(0);                          return(0);
                 if ( ! man_valid_post(m))                  man->last = n;
                         return(0);                  assert(man->last);
                 if ( ! man_action_post(m))  
                         return(0);  
                 m->last = m->last->parent;  
                 assert(m->last);  
         }          }
   
         if ( ! rew_warn(m, m->last, er))          rew_warn(man, man->last, er);
           if ( ! man_valid_post(man))
                 return(0);                  return(0);
         if ( ! man_valid_post(m))  
                 return(0);  
         if ( ! man_action_post(m))  
                 return(0);  
   
         m->next = MAN_ROOT == m->last->type ?  
                 MAN_NEXT_CHILD : MAN_NEXT_SIBLING;  
   
         return(1);          return(1);
 }  }
   
Line 175  rew_dohalt(enum mant tok, enum man_type type, const st
Line 190  rew_dohalt(enum mant tok, enum man_type type, const st
                 return(REW_NOHALT);                  return(REW_NOHALT);
   
         /* First: rewind to ourselves. */          /* First: rewind to ourselves. */
         if (type == n->type && tok == n->tok)          if (type == n->type && tok == n->tok) {
                 return(REW_REWIND);                  if (MAN_EXPLICIT & man_macros[n->tok].flags)
                           return(REW_HALT);
                   else
                           return(REW_REWIND);
           }
   
         /*          /*
          * Next follow the implicit scope-smashings as defined by man.7:           * Next follow the implicit scope-smashings as defined by man.7:
Line 192  rew_dohalt(enum mant tok, enum man_type type, const st
Line 211  rew_dohalt(enum mant tok, enum man_type type, const st
                         return(c);                          return(c);
                 break;                  break;
         case (MAN_RS):          case (MAN_RS):
                   /* Preserve empty paragraphs before RS. */
                   if (0 == n->nchild && (MAN_P == n->tok ||
                       MAN_PP == n->tok || MAN_LP == n->tok))
                           return(REW_HALT);
                 /* Rewind to a subsection, if a block. */                  /* Rewind to a subsection, if a block. */
                 if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))                  if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
                         return(c);                          return(c);
Line 222  rew_dohalt(enum mant tok, enum man_type type, const st
Line 245  rew_dohalt(enum mant tok, enum man_type type, const st
  * scopes.  When a scope is closed, it must be validated and actioned.   * scopes.  When a scope is closed, it must be validated and actioned.
  */   */
 static int  static int
 rew_scope(enum man_type type, struct man *m, enum mant tok)  rew_scope(enum man_type type, struct man *man, enum mant tok)
 {  {
         struct man_node *n;          struct man_node *n;
         enum rew         c;          enum rew         c;
   
         /* LINTED */          /* LINTED */
         for (n = m->last; n; n = n->parent) {          for (n = man->last; n; n = n->parent) {
                 /*                  /*
                  * Whether we should stop immediately (REW_HALT), stop                   * Whether we should stop immediately (REW_HALT), stop
                  * and rewind until this point (REW_REWIND), or keep                   * and rewind until this point (REW_REWIND), or keep
Line 247  rew_scope(enum man_type type, struct man *m, enum mant
Line 270  rew_scope(enum man_type type, struct man *m, enum mant
          */           */
         assert(n);          assert(n);
   
         return(man_unscope(m, n, WERRMAX));          return(man_unscope(man, n, MANDOCERR_MAX));
 }  }
   
   
Line 265  blk_close(MACRO_PROT_ARGS)
Line 288  blk_close(MACRO_PROT_ARGS)
         case (MAN_RE):          case (MAN_RE):
                 ntok = MAN_RS;                  ntok = MAN_RS;
                 break;                  break;
           case (MAN_UE):
                   ntok = MAN_UR;
                   break;
         default:          default:
                 abort();                  abort();
                 /* NOTREACHED */                  /* NOTREACHED */
         }          }
   
         for (nn = m->last->parent; nn; nn = nn->parent)          for (nn = man->last->parent; nn; nn = nn->parent)
                 if (ntok == nn->tok)                  if (ntok == nn->tok && MAN_BLOCK == nn->type)
                         break;                          break;
   
         if (NULL == nn)          if (NULL == nn) {
                 if ( ! man_pwarn(m, line, ppos, WNOSCOPE))                  man_pmsg(man, line, ppos, MANDOCERR_NOSCOPE);
                   if ( ! rew_scope(MAN_BLOCK, man, MAN_PP))
                         return(0);                          return(0);
           } else
                   man_unscope(man, nn, MANDOCERR_MAX);
   
         if ( ! rew_scope(MAN_BODY, m, ntok))  
                 return(0);  
         if ( ! rew_scope(MAN_BLOCK, m, ntok))  
                 return(0);  
   
         return(1);          return(1);
 }  }
   
   
   /* ARGSUSED */
 int  int
 blk_exp(MACRO_PROT_ARGS)  blk_exp(MACRO_PROT_ARGS)
 {  {
         int              w, la;          struct man_node *n;
           int              la;
         char            *p;          char            *p;
   
         /*          /* Close out prior implicit scopes. */
          * Close out prior scopes.  "Regular" explicit macros cannot be  
          * nested, but we allow roff macros to be placed just about  
          * anywhere.  
          */  
   
         if ( ! rew_scope(MAN_BODY, m, tok))          if ( ! rew_scope(MAN_BLOCK, man, tok))
                 return(0);                  return(0);
         if ( ! rew_scope(MAN_BLOCK, m, tok))  
                 return(0);  
   
         if ( ! man_block_alloc(m, line, ppos, tok))          if ( ! man_block_alloc(man, line, ppos, tok))
                 return(0);                  return(0);
         if ( ! man_head_alloc(m, line, ppos, tok))          if ( ! man_head_alloc(man, line, ppos, tok))
                 return(0);                  return(0);
   
         for (;;) {          for (;;) {
                 la = *pos;                  la = *pos;
                 w = man_args(m, line, pos, buf, &p);                  if ( ! man_args(man, line, pos, buf, &p))
   
                 if (-1 == w)  
                         return(0);  
                 if (0 == w)  
                         break;                          break;
                   if ( ! man_word_alloc(man, line, la, p))
                 if ( ! man_word_alloc(m, line, la, p))  
                         return(0);                          return(0);
         }          }
   
         assert(m);          assert(man);
         assert(tok != MAN_MAX);          assert(tok != MAN_MAX);
   
         if ( ! rew_scope(MAN_HEAD, m, tok))          for (n = man->last; n; n = n->parent) {
                 return(0);                  if (n->tok != tok)
         return(man_body_alloc(m, line, ppos, tok));                          continue;
                   assert(MAN_HEAD == n->type);
                   man_unscope(man, n, MANDOCERR_MAX);
                   break;
           }
   
           return(man_body_alloc(man, line, ppos, tok));
 }  }
   
   
Line 338  blk_exp(MACRO_PROT_ARGS)
Line 359  blk_exp(MACRO_PROT_ARGS)
  * scopes, such as `SH' closing out an `SS', are defined in the rew   * scopes, such as `SH' closing out an `SS', are defined in the rew
  * routines.   * routines.
  */   */
   /* ARGSUSED */
 int  int
 blk_imp(MACRO_PROT_ARGS)  blk_imp(MACRO_PROT_ARGS)
 {  {
         int              w, la;          int              la;
         char            *p;          char            *p;
         struct man_node *n;          struct man_node *n;
   
         /* Close out prior scopes. */          /* Close out prior scopes. */
   
         if ( ! rew_scope(MAN_BODY, m, tok))          if ( ! rew_scope(MAN_BODY, man, tok))
                 return(0);                  return(0);
         if ( ! rew_scope(MAN_BLOCK, m, tok))          if ( ! rew_scope(MAN_BLOCK, man, tok))
                 return(0);                  return(0);
   
         /* Allocate new block & head scope. */          /* Allocate new block & head scope. */
   
         if ( ! man_block_alloc(m, line, ppos, tok))          if ( ! man_block_alloc(man, line, ppos, tok))
                 return(0);                  return(0);
         if ( ! man_head_alloc(m, line, ppos, tok))          if ( ! man_head_alloc(man, line, ppos, tok))
                 return(0);                  return(0);
   
         n = m->last;          n = man->last;
   
         /* Add line arguments. */          /* Add line arguments. */
   
         for (;;) {          for (;;) {
                 la = *pos;                  la = *pos;
                 w = man_args(m, line, pos, buf, &p);                  if ( ! man_args(man, line, pos, buf, &p))
   
                 if (-1 == w)  
                         return(0);  
                 if (0 == w)  
                         break;                          break;
                   if ( ! man_word_alloc(man, line, la, p))
                 if ( ! man_word_alloc(m, line, la, p))  
                         return(0);                          return(0);
         }          }
   
Line 381  blk_imp(MACRO_PROT_ARGS)
Line 398  blk_imp(MACRO_PROT_ARGS)
         if (MAN_SCOPED & man_macros[tok].flags) {          if (MAN_SCOPED & man_macros[tok].flags) {
                 /* If we're forcing scope (`TP'), keep it open. */                  /* If we're forcing scope (`TP'), keep it open. */
                 if (MAN_FSCOPED & man_macros[tok].flags) {                  if (MAN_FSCOPED & man_macros[tok].flags) {
                         m->flags |= MAN_BLINE;                          man->flags |= MAN_BLINE;
                         return(1);                          return(1);
                 } else if (n == m->last) {                  } else if (n == man->last) {
                         m->flags |= MAN_BLINE;                          man->flags |= MAN_BLINE;
                         return(1);                          return(1);
                 }                  }
         }          }
   
         if ( ! rew_scope(MAN_HEAD, m, tok))          if ( ! rew_scope(MAN_HEAD, man, tok))
                 return(0);                  return(0);
         return(man_body_alloc(m, line, ppos, tok));          return(man_body_alloc(man, line, ppos, tok));
 }  }
   
   
   /* ARGSUSED */
 int  int
 in_line_eoln(MACRO_PROT_ARGS)  in_line_eoln(MACRO_PROT_ARGS)
 {  {
         int              w, la;          int              la;
         char            *p;          char            *p;
         struct man_node *n;          struct man_node *n;
   
         if ( ! man_elem_alloc(m, line, ppos, tok))          if ( ! man_elem_alloc(man, line, ppos, tok))
                 return(0);                  return(0);
   
         n = m->last;          n = man->last;
   
         for (;;) {          for (;;) {
                 la = *pos;                  la = *pos;
                 w = man_args(m, line, pos, buf, &p);                  if ( ! man_args(man, line, pos, buf, &p))
   
                 if (-1 == w)  
                         return(0);  
                 if (0 == w)  
                         break;                          break;
                 if ( ! man_word_alloc(m, line, la, p))                  if ( ! man_word_alloc(man, line, la, p))
                         return(0);                          return(0);
         }          }
   
         /*          /*
            * Append MAN_EOS in case the last snipped argument
            * ends with a dot, e.g. `.IR syslog (3).'
            */
   
           if (n != man->last &&
               mandoc_eos(man->last->string, strlen(man->last->string)))
                   man->last->flags |= MAN_EOS;
   
           /*
          * If no arguments are specified and this is MAN_SCOPED (i.e.,           * If no arguments are specified and this is MAN_SCOPED (i.e.,
          * next-line scoped), then set our mode to indicate that we're           * next-line scoped), then set our mode to indicate that we're
          * waiting for terms to load into our context.           * waiting for terms to load into our context.
          */           */
   
         if (n == m->last && MAN_SCOPED & man_macros[tok].flags) {          if (n == man->last && MAN_SCOPED & man_macros[tok].flags) {
                 assert( ! (MAN_NSCOPED & man_macros[tok].flags));                  assert( ! (MAN_NSCOPED & man_macros[tok].flags));
                 m->flags |= MAN_ELINE;                  man->flags |= MAN_ELINE;
                 return(1);                  return(1);
         }          }
   
Line 435  in_line_eoln(MACRO_PROT_ARGS)
Line 458  in_line_eoln(MACRO_PROT_ARGS)
   
         if (MAN_NSCOPED & man_macros[tok].flags) {          if (MAN_NSCOPED & man_macros[tok].flags) {
                 assert( ! (MAN_SCOPED & man_macros[tok].flags));                  assert( ! (MAN_SCOPED & man_macros[tok].flags));
                 m->flags |= MAN_ILINE;                  man->flags |= MAN_ILINE;
         }          }
   
           assert(MAN_ROOT != man->last->type);
           man->next = MAN_NEXT_SIBLING;
   
         /*          /*
          * Rewind our element scope.  Note that when TH is pruned, we'll           * Rewind our element scope.  Note that when TH is pruned, we'll
Line 444  in_line_eoln(MACRO_PROT_ARGS)
Line 470  in_line_eoln(MACRO_PROT_ARGS)
          * its sibling.           * its sibling.
          */           */
   
         for ( ; m->last; m->last = m->last->parent) {          for ( ; man->last; man->last = man->last->parent) {
                 if (m->last == n)                  if (man->last == n)
                         break;                          break;
                 if (m->last->type == MAN_ROOT)                  if (man->last->type == MAN_ROOT)
                         break;                          break;
                 if ( ! man_valid_post(m))                  if ( ! man_valid_post(man))
                         return(0);                          return(0);
                 if ( ! man_action_post(m))  
                         return(0);  
         }          }
   
         assert(m->last);          assert(man->last);
   
         /*          /*
          * Same here regarding whether we're back at the root.           * Same here regarding whether we're back at the root.
          */           */
   
         if (m->last->type != MAN_ROOT && ! man_valid_post(m))          if (man->last->type != MAN_ROOT && ! man_valid_post(man))
                 return(0);                  return(0);
         if (m->last->type != MAN_ROOT && ! man_action_post(m))  
                 return(0);  
   
         m->next = MAN_ROOT == m->last->type ?  
                 MAN_NEXT_CHILD : MAN_NEXT_SIBLING;  
   
         return(1);          return(1);
 }  }
   
   
 int  int
 man_macroend(struct man *m)  man_macroend(struct man *man)
 {  {
   
         return(man_unscope(m, m->first, WEXITSCOPE));          return(man_unscope(man, man->first, MANDOCERR_SCOPEEXIT));
 }  }
   
   static int
   man_args(struct man *man, int line, int *pos, char *buf, char **v)
   {
           char     *start;
   
           assert(*pos);
           *v = start = buf + *pos;
           assert(' ' != *start);
   
           if ('\0' == *start)
                   return(0);
   
           *v = mandoc_getarg(man->parse, v, line, pos);
           return(1);
   }
Legend:
Removed from v.1.44  
changed lines
  Added in v.1.81
CVSweb